Completed
Push — update/recurring-payments-use-... ( 5d3385...c82a4d )
by
unknown
23:39 queued 16:08
created

Jetpack::jetpack_jitm_ajax_callback()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

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

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

Loading history...
492
	 */
493
	static function update_active_modules( $modules ) {
494
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
495
		$active_modules       = self::get_active_modules();
496
		$new_active_modules   = array_diff( $modules, $current_modules );
497
		$new_inactive_modules = array_diff( $active_modules, $modules );
498
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
499
		$reindexed_modules    = array_values( $new_current_modules );
500
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
501
502
		foreach ( $new_active_modules as $module ) {
503
			/**
504
			 * Fires when a specific module is activated.
505
			 *
506
			 * @since 1.9.0
507
			 *
508
			 * @param string $module Module slug.
509
			 * @param boolean $success whether the module was activated. @since 4.2
510
			 */
511
			do_action( 'jetpack_activate_module', $module, $success );
512
			/**
513
			 * Fires when a module is activated.
514
			 * The dynamic part of the filter, $module, is the module slug.
515
			 *
516
			 * @since 1.9.0
517
			 *
518
			 * @param string $module Module slug.
519
			 */
520
			do_action( "jetpack_activate_module_$module", $module );
521
		}
522
523
		foreach ( $new_inactive_modules as $module ) {
524
			/**
525
			 * Fired after a module has been deactivated.
526
			 *
527
			 * @since 4.2.0
528
			 *
529
			 * @param string $module Module slug.
530
			 * @param boolean $success whether the module was deactivated.
531
			 */
532
			do_action( 'jetpack_deactivate_module', $module, $success );
533
			/**
534
			 * Fires when a module is deactivated.
535
			 * The dynamic part of the filter, $module, is the module slug.
536
			 *
537
			 * @since 1.9.0
538
			 *
539
			 * @param string $module Module slug.
540
			 */
541
			do_action( "jetpack_deactivate_module_$module", $module );
542
		}
543
544
		return $success;
545
	}
546
547
	static function delete_active_modules() {
548
		self::update_active_modules( array() );
549
	}
550
551
	/**
552
	 * Constructor.  Initializes WordPress hooks
553
	 */
554
	private function __construct() {
555
		/*
556
		 * Check for and alert any deprecated hooks
557
		 */
558
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
559
560
		/*
561
		 * Enable enhanced handling of previewing sites in Calypso
562
		 */
563
		if ( self::is_active() ) {
564
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
565
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
566
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
567
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
568
		}
569
570
		if ( self::jetpack_tos_agreed() ) {
571
			$tracking = new Automattic\Jetpack\Plugin\Tracking();
572
			add_action( 'init', array( $tracking, 'init' ) );
573
		}
574
575
		add_filter(
576
			'jetpack_connection_secret_generator',
577
			function( $callable ) {
578
				return function() {
579
					return wp_generate_password( 32, false );
580
				};
581
			}
582
		);
583
584
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
585
586
		$this->connection_manager = new Connection_Manager();
587
		$this->connection_manager->init();
588
589
		/*
590
		 * Load things that should only be in Network Admin.
591
		 *
592
		 * For now blow away everything else until a more full
593
		 * understanding of what is needed at the network level is
594
		 * available
595
		 */
596
		if ( is_multisite() ) {
597
			$network = Jetpack_Network::init();
598
			$network->set_connection( $this->connection_manager );
599
		}
600
601
		add_filter(
602
			'jetpack_signature_check_token',
603
			array( __CLASS__, 'verify_onboarding_token' ),
604
			10,
605
			3
606
		);
607
608
		/**
609
		 * Prepare Gutenberg Editor functionality
610
		 */
611
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
612
		Jetpack_Gutenberg::init();
613
		Jetpack_Gutenberg::load_independent_blocks();
614
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
615
616
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
617
618
		// Unlink user before deleting the user from WP.com.
619
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
620
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
621
622
		// Initialize remote file upload request handlers.
623
		$this->add_remote_request_handlers();
624
625
		if ( self::is_active() ) {
626
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
627
628
			Jetpack_Heartbeat::init();
629
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
630
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
631
				Jetpack_Search_Performance_Logger::init();
632
			}
633
		}
634
635
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
636
637
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
638
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
639
640
		add_action( 'admin_init', array( $this, 'admin_init' ) );
641
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
642
643
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
644
645
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
646
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
647
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
648
649
		// returns HTTPS support status
650
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
651
652
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
653
654
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
655
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
656
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
657
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
658
659
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
660
661
		/**
662
		 * These actions run checks to load additional files.
663
		 * They check for external files or plugins, so they need to run as late as possible.
664
		 */
665
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
666
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
667
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
668
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
669
670
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
671
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
672
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
673
674
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
675
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
676
677
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
678
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
679
680
		// A filter to control all just in time messages
681
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
682
683
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
684
685
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
686
		// We should make sure to only do this for front end links.
687
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
688
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
689
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
690
691
			// we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
692
			// so they point moderation links on emails to Calypso
693
			jetpack_require_lib( 'functions.wp-notify' );
694
		}
695
696
		// Hide edit post link if mobile app.
697
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
698
			add_filter( 'edit_post_link', '__return_empty_string' );
699
		}
700
701
		// Update the Jetpack plan from API on heartbeats
702
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
703
704
		/**
705
		 * This is the hack to concatenate all css files into one.
706
		 * For description and reasoning see the implode_frontend_css method
707
		 *
708
		 * Super late priority so we catch all the registered styles
709
		 */
710
		if ( ! is_admin() ) {
711
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
712
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
713
		}
714
715
		/**
716
		 * These are sync actions that we need to keep track of for jitms
717
		 */
718
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
719
720
		// Actually push the stats on shutdown.
721
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
722
			add_action( 'shutdown', array( $this, 'push_stats' ) );
723
		}
724
725
		/*
726
		 * Load some scripts asynchronously.
727
		 */
728
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
729
	}
730
731
	/**
732
	 * Sets up the XMLRPC request handlers.
733
	 *
734
	 * @deprecated since 7.7.0
735
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
736
	 *
737
	 * @param Array                 $request_params Incoming request parameters.
738
	 * @param Boolean               $is_active      Whether the connection is currently active.
739
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
740
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

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...
741
	 */
742
	public function setup_xmlrpc_handlers(
743
		$request_params,
744
		$is_active,
745
		$is_signed,
746
		Jetpack_XMLRPC_Server $xmlrpc_server = null
747
	) {
748
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
749
		return $this->connection_manager->setup_xmlrpc_handlers(
750
			$request_params,
751
			$is_active,
752
			$is_signed,
753
			$xmlrpc_server
754
		);
755
	}
756
757
	/**
758
	 * Initialize REST API registration connector.
759
	 *
760
	 * @deprecated since 7.7.0
761
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
762
	 */
763
	public function initialize_rest_api_registration_connector() {
764
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
765
		$this->connection_manager->initialize_rest_api_registration_connector();
766
	}
767
768
	/**
769
	 * This is ported over from the manage module, which has been deprecated and baked in here.
770
	 *
771
	 * @param $domains
772
	 */
773
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
774
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
775
	}
776
777
	/**
778
	 * Return $domains, with 'wordpress.com' appended.
779
	 * This is ported over from the manage module, which has been deprecated and baked in here.
780
	 *
781
	 * @param $domains
782
	 * @return array
783
	 */
784
	function allow_wpcom_domain( $domains ) {
785
		if ( empty( $domains ) ) {
786
			$domains = array();
787
		}
788
		$domains[] = 'wordpress.com';
789
		return array_unique( $domains );
790
	}
791
792
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
793
		$post = get_post( $post_id );
794
795
		if ( empty( $post ) ) {
796
			return $default_url;
797
		}
798
799
		$post_type = $post->post_type;
800
801
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
802
		// https://en.support.wordpress.com/custom-post-types/
803
		$allowed_post_types = array(
804
			'post'                => 'post',
805
			'page'                => 'page',
806
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
807
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
808
		);
809
810
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
811
			return $default_url;
812
		}
813
814
		$path_prefix = $allowed_post_types[ $post_type ];
815
816
		$site_slug = self::build_raw_urls( get_home_url() );
817
818
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
819
	}
820
821
	function point_edit_comment_links_to_calypso( $url ) {
822
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
823
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

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

Loading history...
824
		return esc_url(
825
			sprintf(
826
				'https://wordpress.com/comment/%s/%d',
827
				self::build_raw_urls( get_home_url() ),
828
				$query_args['amp;c']
829
			)
830
		);
831
	}
832
833
	function jetpack_track_last_sync_callback( $params ) {
834
		/**
835
		 * Filter to turn off jitm caching
836
		 *
837
		 * @since 5.4.0
838
		 *
839
		 * @param bool false Whether to cache just in time messages
840
		 */
841
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
842
			return $params;
843
		}
844
845
		if ( is_array( $params ) && isset( $params[0] ) ) {
846
			$option = $params[0];
847
			if ( 'active_plugins' === $option ) {
848
				// use the cache if we can, but not terribly important if it gets evicted
849
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
850
			}
851
		}
852
853
		return $params;
854
	}
855
856
	function jetpack_connection_banner_callback() {
857
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
858
859
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
860
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
861
			wp_send_json_success();
862
		}
863
864
		wp_die();
865
	}
866
867
	/**
868
	 * Removes all XML-RPC methods that are not `jetpack.*`.
869
	 * Only used in our alternate XML-RPC endpoint, where we want to
870
	 * ensure that Core and other plugins' methods are not exposed.
871
	 *
872
	 * @deprecated since 7.7.0
873
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
874
	 *
875
	 * @param array $methods A list of registered WordPress XMLRPC methods.
876
	 * @return array Filtered $methods
877
	 */
878
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
879
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
880
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
881
	}
882
883
	/**
884
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
885
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
886
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
887
	 * which is accessible via a different URI. Most of the below is copied directly
888
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
889
	 *
890
	 * @deprecated since 7.7.0
891
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
892
	 */
893
	public function alternate_xmlrpc() {
894
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
895
		$this->connection_manager->alternate_xmlrpc();
896
	}
897
898
	/**
899
	 * The callback for the JITM ajax requests.
900
	 *
901
	 * @deprecated since 7.9.0
902
	 */
903
	function jetpack_jitm_ajax_callback() {
904
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
905
	}
906
907
	/**
908
	 * If there are any stats that need to be pushed, but haven't been, push them now.
909
	 */
910
	function push_stats() {
911
		if ( ! empty( $this->stats ) ) {
912
			$this->do_stats( 'server_side' );
913
		}
914
	}
915
916
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
917
		switch ( $cap ) {
918
			case 'jetpack_connect':
919
			case 'jetpack_reconnect':
920
				if ( self::is_development_mode() ) {
921
					$caps = array( 'do_not_allow' );
922
					break;
923
				}
924
				/**
925
				 * Pass through. If it's not development mode, these should match disconnect.
926
				 * Let users disconnect if it's development mode, just in case things glitch.
927
				 */
928
			case 'jetpack_disconnect':
929
				/**
930
				 * In multisite, can individual site admins manage their own connection?
931
				 *
932
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
933
				 */
934
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
935
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
936
						/**
937
						 * We need to update the option name -- it's terribly unclear which
938
						 * direction the override goes.
939
						 *
940
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
941
						 */
942
						$caps = array( 'do_not_allow' );
943
						break;
944
					}
945
				}
946
947
				$caps = array( 'manage_options' );
948
				break;
949
			case 'jetpack_manage_modules':
950
			case 'jetpack_activate_modules':
951
			case 'jetpack_deactivate_modules':
952
				$caps = array( 'manage_options' );
953
				break;
954
			case 'jetpack_configure_modules':
955
				$caps = array( 'manage_options' );
956
				break;
957
			case 'jetpack_manage_autoupdates':
958
				$caps = array(
959
					'manage_options',
960
					'update_plugins',
961
				);
962
				break;
963
			case 'jetpack_network_admin_page':
964
			case 'jetpack_network_settings_page':
965
				$caps = array( 'manage_network_plugins' );
966
				break;
967
			case 'jetpack_network_sites_page':
968
				$caps = array( 'manage_sites' );
969
				break;
970
			case 'jetpack_admin_page':
971
				if ( self::is_development_mode() ) {
972
					$caps = array( 'manage_options' );
973
					break;
974
				} else {
975
					$caps = array( 'read' );
976
				}
977
				break;
978
			case 'jetpack_connect_user':
979
				if ( self::is_development_mode() ) {
980
					$caps = array( 'do_not_allow' );
981
					break;
982
				}
983
				$caps = array( 'read' );
984
				break;
985
		}
986
		return $caps;
987
	}
988
989
	/**
990
	 * Require a Jetpack authentication.
991
	 *
992
	 * @deprecated since 7.7.0
993
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
994
	 */
995
	public function require_jetpack_authentication() {
996
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
997
		$this->connection_manager->require_jetpack_authentication();
998
	}
999
1000
	/**
1001
	 * Load language files
1002
	 *
1003
	 * @action plugins_loaded
1004
	 */
1005
	public static function plugin_textdomain() {
1006
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1007
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1008
	}
1009
1010
	/**
1011
	 * Register assets for use in various modules and the Jetpack admin page.
1012
	 *
1013
	 * @uses wp_script_is, wp_register_script, plugins_url
1014
	 * @action wp_loaded
1015
	 * @return null
1016
	 */
1017
	public function register_assets() {
1018
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1019
			wp_register_script(
1020
				'spin',
1021
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1022
				false,
1023
				'1.3'
1024
			);
1025
		}
1026
1027 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1028
			wp_register_script(
1029
				'jquery.spin',
1030
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1031
				array( 'jquery', 'spin' ),
1032
				'1.3'
1033
			);
1034
		}
1035
1036 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1037
			wp_register_script(
1038
				'jetpack-gallery-settings',
1039
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1040
				array( 'media-views' ),
1041
				'20121225'
1042
			);
1043
		}
1044
1045 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1046
			wp_register_script(
1047
				'jetpack-twitter-timeline',
1048
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1049
				array( 'jquery' ),
1050
				'4.0.0',
1051
				true
1052
			);
1053
		}
1054
1055
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1056
			wp_register_script(
1057
				'jetpack-facebook-embed',
1058
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1059
				array( 'jquery' ),
1060
				null,
1061
				true
1062
			);
1063
1064
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1065
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1066
			if ( ! is_numeric( $fb_app_id ) ) {
1067
				$fb_app_id = '';
1068
			}
1069
			wp_localize_script(
1070
				'jetpack-facebook-embed',
1071
				'jpfbembed',
1072
				array(
1073
					'appid'  => $fb_app_id,
1074
					'locale' => $this->get_locale(),
1075
				)
1076
			);
1077
		}
1078
1079
		/**
1080
		 * As jetpack_register_genericons is by default fired off a hook,
1081
		 * the hook may have already fired by this point.
1082
		 * So, let's just trigger it manually.
1083
		 */
1084
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1085
		jetpack_register_genericons();
1086
1087
		/**
1088
		 * Register the social logos
1089
		 */
1090
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1091
		jetpack_register_social_logos();
1092
1093 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1094
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1095
		}
1096
	}
1097
1098
	/**
1099
	 * Guess locale from language code.
1100
	 *
1101
	 * @param string $lang Language code.
1102
	 * @return string|bool
1103
	 */
1104 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1105
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1106
			return 'en_US';
1107
		}
1108
1109
		if ( ! class_exists( 'GP_Locales' ) ) {
1110
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1111
				return false;
1112
			}
1113
1114
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1115
		}
1116
1117
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1118
			// WP.com: get_locale() returns 'it'
1119
			$locale = GP_Locales::by_slug( $lang );
1120
		} else {
1121
			// Jetpack: get_locale() returns 'it_IT';
1122
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1123
		}
1124
1125
		if ( ! $locale ) {
1126
			return false;
1127
		}
1128
1129
		if ( empty( $locale->facebook_locale ) ) {
1130
			if ( empty( $locale->wp_locale ) ) {
1131
				return false;
1132
			} else {
1133
				// Facebook SDK is smart enough to fall back to en_US if a
1134
				// locale isn't supported. Since supported Facebook locales
1135
				// can fall out of sync, we'll attempt to use the known
1136
				// wp_locale value and rely on said fallback.
1137
				return $locale->wp_locale;
1138
			}
1139
		}
1140
1141
		return $locale->facebook_locale;
1142
	}
1143
1144
	/**
1145
	 * Get the locale.
1146
	 *
1147
	 * @return string|bool
1148
	 */
1149
	function get_locale() {
1150
		$locale = $this->guess_locale_from_lang( get_locale() );
1151
1152
		if ( ! $locale ) {
1153
			$locale = 'en_US';
1154
		}
1155
1156
		return $locale;
1157
	}
1158
1159
	/**
1160
	 * Device Pixels support
1161
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1162
	 */
1163
	function devicepx() {
1164
		if ( self::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1165
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1166
		}
1167
	}
1168
1169
	/**
1170
	 * Return the network_site_url so that .com knows what network this site is a part of.
1171
	 *
1172
	 * @param  bool $option
1173
	 * @return string
1174
	 */
1175
	public function jetpack_main_network_site_option( $option ) {
1176
		return network_site_url();
1177
	}
1178
	/**
1179
	 * Network Name.
1180
	 */
1181
	static function network_name( $option = null ) {
1182
		global $current_site;
1183
		return $current_site->site_name;
1184
	}
1185
	/**
1186
	 * Does the network allow new user and site registrations.
1187
	 *
1188
	 * @return string
1189
	 */
1190
	static function network_allow_new_registrations( $option = null ) {
1191
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1192
	}
1193
	/**
1194
	 * Does the network allow admins to add new users.
1195
	 *
1196
	 * @return boolian
1197
	 */
1198
	static function network_add_new_users( $option = null ) {
1199
		return (bool) get_site_option( 'add_new_users' );
1200
	}
1201
	/**
1202
	 * File upload psace left per site in MB.
1203
	 *  -1 means NO LIMIT.
1204
	 *
1205
	 * @return number
1206
	 */
1207
	static function network_site_upload_space( $option = null ) {
1208
		// value in MB
1209
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1210
	}
1211
1212
	/**
1213
	 * Network allowed file types.
1214
	 *
1215
	 * @return string
1216
	 */
1217
	static function network_upload_file_types( $option = null ) {
1218
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1219
	}
1220
1221
	/**
1222
	 * Maximum file upload size set by the network.
1223
	 *
1224
	 * @return number
1225
	 */
1226
	static function network_max_upload_file_size( $option = null ) {
1227
		// value in KB
1228
		return get_site_option( 'fileupload_maxk', 300 );
1229
	}
1230
1231
	/**
1232
	 * Lets us know if a site allows admins to manage the network.
1233
	 *
1234
	 * @return array
1235
	 */
1236
	static function network_enable_administration_menus( $option = null ) {
1237
		return get_site_option( 'menu_items' );
1238
	}
1239
1240
	/**
1241
	 * If a user has been promoted to or demoted from admin, we need to clear the
1242
	 * jetpack_other_linked_admins transient.
1243
	 *
1244
	 * @since 4.3.2
1245
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1246
	 *
1247
	 * @param int    $user_id   The user ID whose role changed.
1248
	 * @param string $role      The new role.
1249
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3128
		}
3129
3130
		// For firing one-off events (notices) immediately after activation
3131
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3132
3133
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3134
3135
		self::plugin_initialize();
3136
	}
3137
3138
	public static function get_activation_source( $referer_url ) {
3139
3140
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3141
			return array( 'wp-cli', null );
3142
		}
3143
3144
		$referer = parse_url( $referer_url );
3145
3146
		$source_type  = 'unknown';
3147
		$source_query = null;
3148
3149
		if ( ! is_array( $referer ) ) {
3150
			return array( $source_type, $source_query );
3151
		}
3152
3153
		$plugins_path         = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3154
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3155
3156
		if ( isset( $referer['query'] ) ) {
3157
			parse_str( $referer['query'], $query_parts );
3158
		} else {
3159
			$query_parts = array();
3160
		}
3161
3162
		if ( $plugins_path === $referer['path'] ) {
3163
			$source_type = 'list';
3164
		} elseif ( $plugins_install_path === $referer['path'] ) {
3165
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3166
			switch ( $tab ) {
3167
				case 'popular':
3168
					$source_type = 'popular';
3169
					break;
3170
				case 'recommended':
3171
					$source_type = 'recommended';
3172
					break;
3173
				case 'favorites':
3174
					$source_type = 'favorites';
3175
					break;
3176
				case 'search':
3177
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3178
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3179
					break;
3180
				default:
3181
					$source_type = 'featured';
3182
			}
3183
		}
3184
3185
		return array( $source_type, $source_query );
3186
	}
3187
3188
	/**
3189
	 * Runs before bumping version numbers up to a new version
3190
	 *
3191
	 * @param  string $version    Version:timestamp
3192
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3193
	 * @return null              [description]
3194
	 */
3195
	public static function do_version_bump( $version, $old_version ) {
3196
		if ( ! $old_version ) { // For new sites
3197
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3198
		}
3199
	}
3200
3201
	/**
3202
	 * Sets the internal version number and activation state.
3203
	 *
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
		self::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
	 *
3227
	 * @static
3228
	 */
3229
	public static function plugin_deactivation() {
3230
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3231
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3232
			Jetpack_Network::init()->deactivate();
3233
		} else {
3234
			self::disconnect( false );
3235
			// Jetpack_Heartbeat::init()->deactivate();
3236
		}
3237
	}
3238
3239
	/**
3240
	 * Disconnects from the Jetpack servers.
3241
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3242
	 *
3243
	 * @static
3244
	 */
3245
	public static function disconnect( $update_activated_state = true ) {
3246
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3247
		$connection = self::connection();
3248
		$connection->clean_nonces( true );
3249
3250
		// If the site is in an IDC because sync is not allowed,
3251
		// let's make sure to not disconnect the production site.
3252
		if ( ! self::validate_sync_error_idc_option() ) {
3253
			$tracking = new Tracking();
3254
			$tracking->record_user_event( 'disconnect_site', array() );
3255
3256
			$xml = new Jetpack_IXR_Client();
3257
			$xml->query( 'jetpack.deregister', get_current_user_id() );
3258
		}
3259
3260
		Jetpack_Options::delete_option(
3261
			array(
3262
				'blog_token',
3263
				'user_token',
3264
				'user_tokens',
3265
				'master_user',
3266
				'time_diff',
3267
				'fallback_no_verify_ssl_certs',
3268
			)
3269
		);
3270
3271
		Jetpack_IDC::clear_all_idc_options();
3272
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3273
3274
		if ( $update_activated_state ) {
3275
			Jetpack_Options::update_option( 'activated', 4 );
3276
		}
3277
3278
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3279
			// Check then record unique disconnection if site has never been disconnected previously
3280
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3281
				$jetpack_unique_connection['disconnected'] = 1;
3282
			} else {
3283
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3284
					// track unique disconnect
3285
					$jetpack = self::init();
3286
3287
					$jetpack->stat( 'connections', 'unique-disconnect' );
3288
					$jetpack->do_stats( 'server_side' );
3289
				}
3290
				// increment number of times disconnected
3291
				$jetpack_unique_connection['disconnected'] += 1;
3292
			}
3293
3294
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3295
		}
3296
3297
		// Delete cached connected user data
3298
		$transient_key = 'jetpack_connected_user_data_' . get_current_user_id();
3299
		delete_transient( $transient_key );
3300
3301
		// Delete all the sync related data. Since it could be taking up space.
3302
		Sender::get_instance()->uninstall();
3303
3304
		// Disable the Heartbeat cron
3305
		Jetpack_Heartbeat::init()->deactivate();
3306
	}
3307
3308
	/**
3309
	 * Unlinks the current user from the linked WordPress.com user.
3310
	 *
3311
	 * @deprecated since 7.7
3312
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3313
	 *
3314
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|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...
3315
	 * @return Boolean Whether the disconnection of the user was successful.
3316
	 */
3317
	public static function unlink_user( $user_id = null ) {
3318
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3319
		return Connection_Manager::disconnect_user( $user_id );
3320
	}
3321
3322
	/**
3323
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3324
	 */
3325
	public static function try_registration() {
3326
		// The user has agreed to the TOS at some point by now.
3327
		Jetpack_Options::update_option( 'tos_agreed', true );
3328
3329
		// Let's get some testing in beta versions and such.
3330
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3331
			// Before attempting to connect, let's make sure that the domains are viable.
3332
			$domains_to_check = array_unique(
3333
				array(
3334
					'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3335
					'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3336
				)
3337
			);
3338
			foreach ( $domains_to_check as $domain ) {
3339
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
Security Bug introduced by
It seems like $domain defined by $domain on line 3338 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...
3340
				if ( is_wp_error( $result ) ) {
3341
					return $result;
3342
				}
3343
			}
3344
		}
3345
3346
		$result = self::register();
3347
3348
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3349
		if ( ! $result || is_wp_error( $result ) ) {
3350
			return $result;
3351
		} else {
3352
			return true;
3353
		}
3354
	}
3355
3356
	/**
3357
	 * Tracking an internal event log. Try not to put too much chaff in here.
3358
	 *
3359
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3360
	 */
3361
	public static function log( $code, $data = null ) {
3362
		// only grab the latest 200 entries
3363
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3364
3365
		// Append our event to the log
3366
		$log_entry = array(
3367
			'time'    => time(),
3368
			'user_id' => get_current_user_id(),
3369
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3370
			'code'    => $code,
3371
		);
3372
		// Don't bother storing it unless we've got some.
3373
		if ( ! is_null( $data ) ) {
3374
			$log_entry['data'] = $data;
3375
		}
3376
		$log[] = $log_entry;
3377
3378
		// Try add_option first, to make sure it's not autoloaded.
3379
		// @todo: Add an add_option method to Jetpack_Options
3380
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3381
			Jetpack_Options::update_option( 'log', $log );
3382
		}
3383
3384
		/**
3385
		 * Fires when Jetpack logs an internal event.
3386
		 *
3387
		 * @since 3.0.0
3388
		 *
3389
		 * @param array $log_entry {
3390
		 *  Array of details about the log entry.
3391
		 *
3392
		 *  @param string time Time of the event.
3393
		 *  @param int user_id ID of the user who trigerred the event.
3394
		 *  @param int blog_id Jetpack Blog ID.
3395
		 *  @param string code Unique name for the event.
3396
		 *  @param string data Data about the event.
3397
		 * }
3398
		 */
3399
		do_action( 'jetpack_log_entry', $log_entry );
3400
	}
3401
3402
	/**
3403
	 * Get the internal event log.
3404
	 *
3405
	 * @param $event (string) - only return the specific log events
3406
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3407
	 *
3408
	 * @return array of log events || WP_Error for invalid params
3409
	 */
3410
	public static function get_log( $event = false, $num = false ) {
3411
		if ( $event && ! is_string( $event ) ) {
3412
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3413
		}
3414
3415
		if ( $num && ! is_numeric( $num ) ) {
3416
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('Second param must be...c or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3417
		}
3418
3419
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3420
3421
		// If nothing set - act as it did before, otherwise let's start customizing the output
3422
		if ( ! $num && ! $event ) {
3423
			return $entire_log;
3424
		} else {
3425
			$entire_log = array_reverse( $entire_log );
3426
		}
3427
3428
		$custom_log_output = array();
3429
3430
		if ( $event ) {
3431
			foreach ( $entire_log as $log_event ) {
3432
				if ( $event == $log_event['code'] ) {
3433
					$custom_log_output[] = $log_event;
3434
				}
3435
			}
3436
		} else {
3437
			$custom_log_output = $entire_log;
3438
		}
3439
3440
		if ( $num ) {
3441
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3442
		}
3443
3444
		return $custom_log_output;
3445
	}
3446
3447
	/**
3448
	 * Log modification of important settings.
3449
	 */
3450
	public static function log_settings_change( $option, $old_value, $value ) {
3451
		switch ( $option ) {
3452
			case 'jetpack_sync_non_public_post_stati':
3453
				self::log( $option, $value );
3454
				break;
3455
		}
3456
	}
3457
3458
	/**
3459
	 * Return stat data for WPCOM sync
3460
	 */
3461
	public static function get_stat_data( $encode = true, $extended = true ) {
3462
		$data = Jetpack_Heartbeat::generate_stats_array();
3463
3464
		if ( $extended ) {
3465
			$additional_data = self::get_additional_stat_data();
3466
			$data            = array_merge( $data, $additional_data );
3467
		}
3468
3469
		if ( $encode ) {
3470
			return json_encode( $data );
3471
		}
3472
3473
		return $data;
3474
	}
3475
3476
	/**
3477
	 * Get additional stat data to sync to WPCOM
3478
	 */
3479
	public static function get_additional_stat_data( $prefix = '' ) {
3480
		$return[ "{$prefix}themes" ]        = self::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...
3481
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3482
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3483
		$return[ "{$prefix}site-count" ]    = 0;
3484
3485
		if ( function_exists( 'get_blog_count' ) ) {
3486
			$return[ "{$prefix}site-count" ] = get_blog_count();
3487
		}
3488
		return $return;
3489
	}
3490
3491
	private static function get_site_user_count() {
3492
		global $wpdb;
3493
3494
		if ( function_exists( 'wp_is_large_network' ) ) {
3495
			if ( wp_is_large_network( 'users' ) ) {
3496
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3497
			}
3498
		}
3499
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3500
			// It wasn't there, so regenerate the data and save the transient
3501
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3502
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3503
		}
3504
		return $user_count;
3505
	}
3506
3507
	/* Admin Pages */
3508
3509
	function admin_init() {
3510
		// If the plugin is not connected, display a connect message.
3511
		if (
3512
			// the plugin was auto-activated and needs its candy
3513
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3514
		||
3515
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3516
			! Jetpack_Options::get_option( 'activated' )
3517
		) {
3518
			self::plugin_initialize();
3519
		}
3520
3521
		if ( ! self::is_active() && ! self::is_development_mode() ) {
3522
			Jetpack_Connection_Banner::init();
3523
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3524
			// Upgrade: 1.1 -> 1.1.1
3525
			// Check and see if host can verify the Jetpack servers' SSL certificate
3526
			$args       = array();
3527
			$connection = self::connection();
3528
			Client::_wp_remote_request(
3529
				self::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3530
				$args,
3531
				true
3532
			);
3533
		}
3534
3535
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3536
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3537
		}
3538
3539
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3540
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3541
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3542
3543
		if ( self::is_active() || self::is_development_mode() ) {
3544
			// Artificially throw errors in certain whitelisted cases during plugin activation
3545
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3546
		}
3547
3548
		// Add custom column in wp-admin/users.php to show whether user is linked.
3549
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3550
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3551
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3552
	}
3553
3554
	function admin_body_class( $admin_body_class = '' ) {
3555
		$classes = explode( ' ', trim( $admin_body_class ) );
3556
3557
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3558
3559
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3560
		return " $admin_body_class ";
3561
	}
3562
3563
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3564
		return $admin_body_class . ' jetpack-pagestyles ';
3565
	}
3566
3567
	/**
3568
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3569
	 * This function artificially throws errors for such cases (whitelisted).
3570
	 *
3571
	 * @param string $plugin The activated plugin.
3572
	 */
3573
	function throw_error_on_activate_plugin( $plugin ) {
3574
		$active_modules = self::get_active_modules();
3575
3576
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3577
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3578
			$throw = false;
3579
3580
			// Try and make sure it really was the stats plugin
3581
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3582
				if ( 'stats.php' == basename( $plugin ) ) {
3583
					$throw = true;
3584
				}
3585
			} else {
3586
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3587
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3588
					$throw = true;
3589
				}
3590
			}
3591
3592
			if ( $throw ) {
3593
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3594
			}
3595
		}
3596
	}
3597
3598
	function intercept_plugin_error_scrape_init() {
3599
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3600
	}
3601
3602
	function intercept_plugin_error_scrape( $action, $result ) {
3603
		if ( ! $result ) {
3604
			return;
3605
		}
3606
3607
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3608
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3609
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3610
			}
3611
		}
3612
	}
3613
3614
	/**
3615
	 * Register the remote file upload request handlers, if needed.
3616
	 *
3617
	 * @access public
3618
	 */
3619
	public function add_remote_request_handlers() {
3620
		// Remote file uploads are allowed only via AJAX requests.
3621
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3622
			return;
3623
		}
3624
3625
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3626
		$remote_request_actions = array(
3627
			'jetpack_upload_file',
3628
			'jetpack_update_file',
3629
		);
3630
3631
		// phpcs:ignore WordPress.Security.NonceVerification
3632
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3633
			return;
3634
		}
3635
3636
		// Require Jetpack authentication for the remote file upload AJAX requests.
3637
		$this->connection_manager->require_jetpack_authentication();
3638
3639
		// Register the remote file upload AJAX handlers.
3640
		foreach ( $remote_request_actions as $action ) {
3641
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3642
		}
3643
	}
3644
3645
	/**
3646
	 * Handler for Jetpack remote file uploads.
3647
	 *
3648
	 * @access public
3649
	 */
3650
	public function remote_request_handlers() {
3651
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3652
3653
		switch ( current_filter() ) {
3654
			case 'wp_ajax_nopriv_jetpack_upload_file':
3655
				$response = $this->upload_handler();
3656
				break;
3657
3658
			case 'wp_ajax_nopriv_jetpack_update_file':
3659
				$response = $this->upload_handler( true );
3660
				break;
3661
			default:
3662
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_handler'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3663
				break;
3664
		}
3665
3666
		if ( ! $response ) {
3667
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3668
		}
3669
3670
		if ( is_wp_error( $response ) ) {
3671
			$status_code       = $response->get_error_data();
0 ignored issues
show
Bug introduced by
The method get_error_data() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3672
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3673
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3674
3675
			if ( ! is_int( $status_code ) ) {
3676
				$status_code = 400;
3677
			}
3678
3679
			status_header( $status_code );
3680
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3681
		}
3682
3683
		status_header( 200 );
3684
		if ( true === $response ) {
3685
			exit;
3686
		}
3687
3688
		die( json_encode( (object) $response ) );
3689
	}
3690
3691
	/**
3692
	 * Uploads a file gotten from the global $_FILES.
3693
	 * If `$update_media_item` is true and `post_id` is defined
3694
	 * the attachment file of the media item (gotten through of the post_id)
3695
	 * will be updated instead of add a new one.
3696
	 *
3697
	 * @param  boolean $update_media_item - update media attachment
3698
	 * @return array - An array describing the uploadind files process
3699
	 */
3700
	function upload_handler( $update_media_item = false ) {
3701
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3702
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 405.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3703
		}
3704
3705
		$user = wp_authenticate( '', '' );
3706
		if ( ! $user || is_wp_error( $user ) ) {
3707
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3708
		}
3709
3710
		wp_set_current_user( $user->ID );
3711
3712
		if ( ! current_user_can( 'upload_files' ) ) {
3713
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3714
		}
3715
3716
		if ( empty( $_FILES ) ) {
3717
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3718
		}
3719
3720
		foreach ( array_keys( $_FILES ) as $files_key ) {
3721
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3722
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_hmac'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3723
			}
3724
		}
3725
3726
		$media_keys = array_keys( $_FILES['media'] );
3727
3728
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::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...
3729
		if ( ! $token || is_wp_error( $token ) ) {
3730
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3731
		}
3732
3733
		$uploaded_files = array();
3734
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3735
		unset( $GLOBALS['post'] );
3736
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3737
			$file = array();
3738
			foreach ( $media_keys as $media_key ) {
3739
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3740
			}
3741
3742
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3743
3744
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3745
			if ( $hmac_provided !== $hmac_file ) {
3746
				$uploaded_files[ $index ] = (object) array(
3747
					'error'             => 'invalid_hmac',
3748
					'error_description' => 'The corresponding HMAC for this file does not match',
3749
				);
3750
				continue;
3751
			}
3752
3753
			$_FILES['.jetpack.upload.'] = $file;
3754
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3755
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3756
				$post_id = 0;
3757
			}
3758
3759
			if ( $update_media_item ) {
3760
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3761
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'invalid_input'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3762
				}
3763
3764
				$media_array = $_FILES['media'];
3765
3766
				$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...
3767
				$file_array['type']     = $media_array['type'][0];
3768
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3769
				$file_array['error']    = $media_array['error'][0];
3770
				$file_array['size']     = $media_array['size'][0];
3771
3772
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3773
3774
				if ( is_wp_error( $edited_media_item ) ) {
3775
					return $edited_media_item;
3776
				}
3777
3778
				$response = (object) array(
3779
					'id'   => (string) $post_id,
3780
					'file' => (string) $edited_media_item->post_title,
3781
					'url'  => (string) wp_get_attachment_url( $post_id ),
3782
					'type' => (string) $edited_media_item->post_mime_type,
3783
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3784
				);
3785
3786
				return (array) array( $response );
3787
			}
3788
3789
			$attachment_id = media_handle_upload(
3790
				'.jetpack.upload.',
3791
				$post_id,
3792
				array(),
3793
				array(
3794
					'action' => 'jetpack_upload_file',
3795
				)
3796
			);
3797
3798
			if ( ! $attachment_id ) {
3799
				$uploaded_files[ $index ] = (object) array(
3800
					'error'             => 'unknown',
3801
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3802
				);
3803
			} elseif ( is_wp_error( $attachment_id ) ) {
3804
				$uploaded_files[ $index ] = (object) array(
3805
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3806
					'error_description' => $attachment_id->get_error_message(),
3807
				);
3808
			} else {
3809
				$attachment               = get_post( $attachment_id );
3810
				$uploaded_files[ $index ] = (object) array(
3811
					'id'   => (string) $attachment_id,
3812
					'file' => $attachment->post_title,
3813
					'url'  => wp_get_attachment_url( $attachment_id ),
3814
					'type' => $attachment->post_mime_type,
3815
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3816
				);
3817
				// Zip files uploads are not supported unless they are done for installation purposed
3818
				// lets delete them in case something goes wrong in this whole process
3819
				if ( 'application/zip' === $attachment->post_mime_type ) {
3820
					// Schedule a cleanup for 2 hours from now in case of failed install.
3821
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3822
				}
3823
			}
3824
		}
3825
		if ( ! is_null( $global_post ) ) {
3826
			$GLOBALS['post'] = $global_post;
3827
		}
3828
3829
		return $uploaded_files;
3830
	}
3831
3832
	/**
3833
	 * Add help to the Jetpack page
3834
	 *
3835
	 * @since Jetpack (1.2.3)
3836
	 * @return false if not the Jetpack page
3837
	 */
3838
	function admin_help() {
3839
		$current_screen = get_current_screen();
3840
3841
		// Overview
3842
		$current_screen->add_help_tab(
3843
			array(
3844
				'id'      => 'home',
3845
				'title'   => __( 'Home', 'jetpack' ),
3846
				'content' =>
3847
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3848
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3849
					'<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>',
3850
			)
3851
		);
3852
3853
		// Screen Content
3854
		if ( current_user_can( 'manage_options' ) ) {
3855
			$current_screen->add_help_tab(
3856
				array(
3857
					'id'      => 'settings',
3858
					'title'   => __( 'Settings', 'jetpack' ),
3859
					'content' =>
3860
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3861
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3862
						'<ol>' .
3863
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3864
							'<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>' .
3865
						'</ol>' .
3866
						'<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>',
3867
				)
3868
			);
3869
		}
3870
3871
		// Help Sidebar
3872
		$current_screen->set_help_sidebar(
3873
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3874
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3875
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3876
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3877
		);
3878
	}
3879
3880
	function admin_menu_css() {
3881
		wp_enqueue_style( 'jetpack-icons' );
3882
	}
3883
3884
	function admin_menu_order() {
3885
		return true;
3886
	}
3887
3888 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3889
		$jp_menu_order = array();
3890
3891
		foreach ( $menu_order as $index => $item ) {
3892
			if ( $item != 'jetpack' ) {
3893
				$jp_menu_order[] = $item;
3894
			}
3895
3896
			if ( $index == 0 ) {
3897
				$jp_menu_order[] = 'jetpack';
3898
			}
3899
		}
3900
3901
		return $jp_menu_order;
3902
	}
3903
3904
	function admin_banner_styles() {
3905
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3906
3907
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3908
			wp_register_style(
3909
				'jetpack-dops-style',
3910
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3911
				array(),
3912
				JETPACK__VERSION
3913
			);
3914
		}
3915
3916
		wp_enqueue_style(
3917
			'jetpack',
3918
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3919
			array( 'jetpack-dops-style' ),
3920
			JETPACK__VERSION . '-20121016'
3921
		);
3922
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3923
		wp_style_add_data( 'jetpack', 'suffix', $min );
3924
	}
3925
3926
	function plugin_action_links( $actions ) {
3927
3928
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3929
3930
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || self::is_development_mode() ) ) {
3931
			return array_merge(
3932
				$jetpack_home,
3933
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3934
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3935
				$actions
3936
			);
3937
		}
3938
3939
		return array_merge( $jetpack_home, $actions );
3940
	}
3941
3942
	/*
3943
	 * Registration flow:
3944
	 * 1 - ::admin_page_load() action=register
3945
	 * 2 - ::try_registration()
3946
	 * 3 - ::register()
3947
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3948
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3949
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3950
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3951
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3952
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3953
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3954
	 *       jetpack_id, jetpack_secret, jetpack_public
3955
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3956
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3957
	 * 5 - user logs in with WP.com account
3958
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3959
	 *		- Jetpack_Client_Server::authorize()
3960
	 *		- Jetpack_Client_Server::get_token()
3961
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3962
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3963
	 *			- which responds with access_token, token_type, scope
3964
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3965
	 *		- Jetpack::activate_default_modules()
3966
	 *     		- Deactivates deprecated plugins
3967
	 *     		- Activates all default modules
3968
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3969
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3970
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3971
	 *     Done!
3972
	 */
3973
3974
	/**
3975
	 * Handles the page load events for the Jetpack admin page
3976
	 */
3977
	function admin_page_load() {
3978
		$error = false;
3979
3980
		// Make sure we have the right body class to hook stylings for subpages off of.
3981
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3982
3983
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3984
			// Should only be used in intermediate redirects to preserve state across redirects
3985
			self::restate();
3986
		}
3987
3988
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3989
			// @todo: Add validation against a known whitelist
3990
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3991
			// User clicked in the iframe to link their accounts
3992
			if ( ! self::is_user_connected() ) {
3993
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3994
3995
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3996
				$connect_url = $this->build_connect_url( true, $redirect, $from );
3997
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3998
3999
				if ( isset( $_GET['notes_iframe'] ) ) {
4000
					$connect_url .= '&notes_iframe';
4001
				}
4002
				wp_redirect( $connect_url );
4003
				exit;
4004
			} else {
4005
				if ( ! isset( $_GET['calypso_env'] ) ) {
4006
					self::state( 'message', 'already_authorized' );
4007
					wp_safe_redirect( self::admin_url() );
4008
					exit;
4009
				} else {
4010
					$connect_url  = $this->build_connect_url( true, false, $from );
4011
					$connect_url .= '&already_authorized=true';
4012
					wp_redirect( $connect_url );
4013
					exit;
4014
				}
4015
			}
4016
		}
4017
4018
		if ( isset( $_GET['action'] ) ) {
4019
			switch ( $_GET['action'] ) {
4020
				case 'authorize':
4021
					if ( self::is_active() && self::is_user_connected() ) {
4022
						self::state( 'message', 'already_authorized' );
4023
						wp_safe_redirect( self::admin_url() );
4024
						exit;
4025
					}
4026
					self::log( 'authorize' );
4027
					$client_server = new Jetpack_Client_Server();
4028
					$client_server->client_authorize();
4029
					exit;
4030
				case 'register':
4031
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4032
						$error = 'cheatin';
4033
						break;
4034
					}
4035
					check_admin_referer( 'jetpack-register' );
4036
					self::log( 'register' );
4037
					self::maybe_set_version_option();
4038
					$registered = self::try_registration();
4039 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4040
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4041
						self::state( 'error', $error );
4042
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4043
4044
						/**
4045
						 * Jetpack registration Error.
4046
						 *
4047
						 * @since 7.5.0
4048
						 *
4049
						 * @param string|int $error The error code.
4050
						 * @param \WP_Error $registered The error object.
4051
						 */
4052
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4053
						break;
4054
					}
4055
4056
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4057
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4058
4059
					/**
4060
					 * Jetpack registration Success.
4061
					 *
4062
					 * @since 7.5.0
4063
					 *
4064
					 * @param string $from 'from' GET parameter;
4065
					 */
4066
					do_action( 'jetpack_connection_register_success', $from );
4067
4068
					$url = $this->build_connect_url( true, $redirect, $from );
4069
4070
					if ( ! empty( $_GET['onboarding'] ) ) {
4071
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4072
					}
4073
4074
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4075
						$url = add_query_arg( 'auth_approved', 'true', $url );
4076
					}
4077
4078
					wp_redirect( $url );
4079
					exit;
4080
				case 'activate':
4081
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4082
						$error = 'cheatin';
4083
						break;
4084
					}
4085
4086
					$module = stripslashes( $_GET['module'] );
4087
					check_admin_referer( "jetpack_activate-$module" );
4088
					self::log( 'activate', $module );
4089
					if ( ! self::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression self::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...
4090
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4091
					}
4092
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4093
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4094
					exit;
4095
				case 'activate_default_modules':
4096
					check_admin_referer( 'activate_default_modules' );
4097
					self::log( 'activate_default_modules' );
4098
					self::restate();
4099
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4100
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4101
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4102
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4103
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4104
					exit;
4105
				case 'disconnect':
4106
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4107
						$error = 'cheatin';
4108
						break;
4109
					}
4110
4111
					check_admin_referer( 'jetpack-disconnect' );
4112
					self::log( 'disconnect' );
4113
					self::disconnect();
4114
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4115
					exit;
4116
				case 'reconnect':
4117
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4118
						$error = 'cheatin';
4119
						break;
4120
					}
4121
4122
					check_admin_referer( 'jetpack-reconnect' );
4123
					self::log( 'reconnect' );
4124
					$this->disconnect();
4125
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4126
					exit;
4127 View Code Duplication
				case 'deactivate':
4128
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4129
						$error = 'cheatin';
4130
						break;
4131
					}
4132
4133
					$modules = stripslashes( $_GET['module'] );
4134
					check_admin_referer( "jetpack_deactivate-$modules" );
4135
					foreach ( explode( ',', $modules ) as $module ) {
4136
						self::log( 'deactivate', $module );
4137
						self::deactivate_module( $module );
4138
						self::state( 'message', 'module_deactivated' );
4139
					}
4140
					self::state( 'module', $modules );
4141
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4142
					exit;
4143
				case 'unlink':
4144
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4145
					check_admin_referer( 'jetpack-unlink' );
4146
					self::log( 'unlink' );
4147
					Connection_Manager::disconnect_user();
4148
					self::state( 'message', 'unlinked' );
4149
					if ( 'sub-unlink' == $redirect ) {
4150
						wp_safe_redirect( admin_url() );
4151
					} else {
4152
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4153
					}
4154
					exit;
4155
				case 'onboard':
4156
					if ( ! current_user_can( 'manage_options' ) ) {
4157
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4158
					} else {
4159
						self::create_onboarding_token();
4160
						$url = $this->build_connect_url( true );
4161
4162
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4163
							$url = add_query_arg( 'onboarding', $token, $url );
4164
						}
4165
4166
						$calypso_env = $this->get_calypso_env();
4167
						if ( ! empty( $calypso_env ) ) {
4168
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4169
						}
4170
4171
						wp_redirect( $url );
4172
						exit;
4173
					}
4174
					exit;
4175
				default:
4176
					/**
4177
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4178
					 *
4179
					 * @since 2.6.0
4180
					 *
4181
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4182
					 */
4183
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4184
			}
4185
		}
4186
4187
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4188
			self::activate_new_modules( true );
4189
		}
4190
4191
		$message_code = self::state( 'message' );
4192
		if ( self::state( 'optin-manage' ) ) {
4193
			$activated_manage = $message_code;
4194
			$message_code     = 'jetpack-manage';
4195
		}
4196
4197
		switch ( $message_code ) {
4198
			case 'jetpack-manage':
4199
				$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>';
4200
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4201
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4202
				}
4203
				break;
4204
4205
		}
4206
4207
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4208
4209
		if ( ! empty( $deactivated_plugins ) ) {
4210
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4211
			$deactivated_titles  = array();
4212
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4213
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4214
					continue;
4215
				}
4216
4217
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4218
			}
4219
4220
			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...
4221
				if ( $this->message ) {
4222
					$this->message .= "<br /><br />\n";
4223
				}
4224
4225
				$this->message .= wp_sprintf(
4226
					_n(
4227
						'Jetpack contains the most recent version of the old %l plugin.',
4228
						'Jetpack contains the most recent versions of the old %l plugins.',
4229
						count( $deactivated_titles ),
4230
						'jetpack'
4231
					),
4232
					$deactivated_titles
4233
				);
4234
4235
				$this->message .= "<br />\n";
4236
4237
				$this->message .= _n(
4238
					'The old version has been deactivated and can be removed from your site.',
4239
					'The old versions have been deactivated and can be removed from your site.',
4240
					count( $deactivated_titles ),
4241
					'jetpack'
4242
				);
4243
			}
4244
		}
4245
4246
		$this->privacy_checks = self::state( 'privacy_checks' );
4247
4248
		if ( $this->message || $this->error || $this->privacy_checks ) {
4249
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4250
		}
4251
4252
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4253
	}
4254
4255
	function admin_notices() {
4256
4257
		if ( $this->error ) {
4258
			?>
4259
<div id="message" class="jetpack-message jetpack-err">
4260
	<div class="squeezer">
4261
		<h2>
4262
			<?php
4263
			echo wp_kses(
4264
				$this->error,
4265
				array(
4266
					'a'      => array( 'href' => array() ),
4267
					'small'  => true,
4268
					'code'   => true,
4269
					'strong' => true,
4270
					'br'     => true,
4271
					'b'      => true,
4272
				)
4273
			);
4274
			?>
4275
			</h2>
4276
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4277
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4278
<?php	endif; ?>
4279
	</div>
4280
</div>
4281
			<?php
4282
		}
4283
4284
		if ( $this->message ) {
4285
			?>
4286
<div id="message" class="jetpack-message">
4287
	<div class="squeezer">
4288
		<h2>
4289
			<?php
4290
			echo wp_kses(
4291
				$this->message,
4292
				array(
4293
					'strong' => array(),
4294
					'a'      => array( 'href' => true ),
4295
					'br'     => true,
4296
				)
4297
			);
4298
			?>
4299
			</h2>
4300
	</div>
4301
</div>
4302
			<?php
4303
		}
4304
4305
		if ( $this->privacy_checks ) :
4306
			$module_names = $module_slugs = array();
4307
4308
			$privacy_checks = explode( ',', $this->privacy_checks );
4309
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4310
			foreach ( $privacy_checks as $module_slug ) {
4311
				$module = self::get_module( $module_slug );
4312
				if ( ! $module ) {
4313
					continue;
4314
				}
4315
4316
				$module_slugs[] = $module_slug;
4317
				$module_names[] = "<strong>{$module['name']}</strong>";
4318
			}
4319
4320
			$module_slugs = join( ',', $module_slugs );
4321
			?>
4322
<div id="message" class="jetpack-message jetpack-err">
4323
	<div class="squeezer">
4324
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4325
		<p>
4326
			<?php
4327
			echo wp_kses(
4328
				wptexturize(
4329
					wp_sprintf(
4330
						_nx(
4331
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4332
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4333
							count( $privacy_checks ),
4334
							'%l = list of Jetpack module/feature names',
4335
							'jetpack'
4336
						),
4337
						$module_names
4338
					)
4339
				),
4340
				array( 'strong' => true )
4341
			);
4342
4343
			echo "\n<br />\n";
4344
4345
			echo wp_kses(
4346
				sprintf(
4347
					_nx(
4348
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4349
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4350
						count( $privacy_checks ),
4351
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4352
						'jetpack'
4353
					),
4354
					wp_nonce_url(
4355
						self::admin_url(
4356
							array(
4357
								'page'   => 'jetpack',
4358
								'action' => 'deactivate',
4359
								'module' => urlencode( $module_slugs ),
4360
							)
4361
						),
4362
						"jetpack_deactivate-$module_slugs"
4363
					),
4364
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4365
				),
4366
				array(
4367
					'a' => array(
4368
						'href'  => true,
4369
						'title' => true,
4370
					),
4371
				)
4372
			);
4373
			?>
4374
		</p>
4375
	</div>
4376
</div>
4377
			<?php
4378
endif;
4379
	}
4380
4381
	/**
4382
	 * We can't always respond to a signed XML-RPC request with a
4383
	 * helpful error message. In some circumstances, doing so could
4384
	 * leak information.
4385
	 *
4386
	 * Instead, track that the error occurred via a Jetpack_Option,
4387
	 * and send that data back in the heartbeat.
4388
	 * All this does is increment a number, but it's enough to find
4389
	 * trends.
4390
	 *
4391
	 * @param WP_Error $xmlrpc_error The error produced during
4392
	 *                               signature validation.
4393
	 */
4394
	function track_xmlrpc_error( $xmlrpc_error ) {
4395
		$code = is_wp_error( $xmlrpc_error )
4396
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4397
			: 'should-not-happen';
4398
4399
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4400
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4401
			// No need to update the option if we already have
4402
			// this code stored.
4403
			return;
4404
		}
4405
		$xmlrpc_errors[ $code ] = true;
4406
4407
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4408
	}
4409
4410
	/**
4411
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4412
	 */
4413
	function stat( $group, $detail ) {
4414
		if ( ! isset( $this->stats[ $group ] ) ) {
4415
			$this->stats[ $group ] = array();
4416
		}
4417
		$this->stats[ $group ][] = $detail;
4418
	}
4419
4420
	/**
4421
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4422
	 */
4423
	function do_stats( $method = '' ) {
4424
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4425
			foreach ( $this->stats as $group => $stats ) {
4426
				if ( is_array( $stats ) && count( $stats ) ) {
4427
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4428
					if ( 'server_side' === $method ) {
4429
						self::do_server_side_stat( $args );
4430
					} else {
4431
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4432
					}
4433
				}
4434
				unset( $this->stats[ $group ] );
4435
			}
4436
		}
4437
	}
4438
4439
	/**
4440
	 * Runs stats code for a one-off, server-side.
4441
	 *
4442
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4443
	 *
4444
	 * @return bool If it worked.
4445
	 */
4446
	static function do_server_side_stat( $args ) {
4447
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4448
		if ( is_wp_error( $response ) ) {
4449
			return false;
4450
		}
4451
4452
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4453
			return false;
4454
		}
4455
4456
		return true;
4457
	}
4458
4459
	/**
4460
	 * Builds the stats url.
4461
	 *
4462
	 * @param $args array|string The arguments to append to the URL.
4463
	 *
4464
	 * @return string The URL to be pinged.
4465
	 */
4466
	static function build_stats_url( $args ) {
4467
		$defaults = array(
4468
			'v'    => 'wpcom2',
4469
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4470
		);
4471
		$args     = wp_parse_args( $args, $defaults );
4472
		/**
4473
		 * Filter the URL used as the Stats tracking pixel.
4474
		 *
4475
		 * @since 2.3.2
4476
		 *
4477
		 * @param string $url Base URL used as the Stats tracking pixel.
4478
		 */
4479
		$base_url = apply_filters(
4480
			'jetpack_stats_base_url',
4481
			'https://pixel.wp.com/g.gif'
4482
		);
4483
		$url      = add_query_arg( $args, $base_url );
4484
		return $url;
4485
	}
4486
4487
	/**
4488
	 * Get the role of the current user.
4489
	 *
4490
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4491
	 *
4492
	 * @access public
4493
	 * @static
4494
	 *
4495
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4496
	 */
4497
	public static function translate_current_user_to_role() {
4498
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4499
4500
		$roles = new Roles();
4501
		return $roles->translate_current_user_to_role();
4502
	}
4503
4504
	/**
4505
	 * Get the role of a particular user.
4506
	 *
4507
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4508
	 *
4509
	 * @access public
4510
	 * @static
4511
	 *
4512
	 * @param \WP_User $user User object.
4513
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4514
	 */
4515
	public static function translate_user_to_role( $user ) {
4516
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4517
4518
		$roles = new Roles();
4519
		return $roles->translate_user_to_role( $user );
4520
	}
4521
4522
	/**
4523
	 * Get the minimum capability for a role.
4524
	 *
4525
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4526
	 *
4527
	 * @access public
4528
	 * @static
4529
	 *
4530
	 * @param string $role Role name.
4531
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4532
	 */
4533
	public static function translate_role_to_cap( $role ) {
4534
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4535
4536
		$roles = new Roles();
4537
		return $roles->translate_role_to_cap( $role );
4538
	}
4539
4540
	/**
4541
	 * Sign a user role with the master access token.
4542
	 * If not specified, will default to the current user.
4543
	 *
4544
	 * @deprecated since 7.7
4545
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4546
	 *
4547
	 * @access public
4548
	 * @static
4549
	 *
4550
	 * @param string $role    User role.
4551
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|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...
4552
	 * @return string Signed user role.
4553
	 */
4554
	public static function sign_role( $role, $user_id = null ) {
4555
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4556
		return self::connection()->sign_role( $role, $user_id );
4557
	}
4558
4559
	/**
4560
	 * Builds a URL to the Jetpack connection auth page
4561
	 *
4562
	 * @since 3.9.5
4563
	 *
4564
	 * @param bool        $raw If true, URL will not be escaped.
4565
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4566
	 *                              If string, will be a custom redirect.
4567
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4568
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4569
	 *
4570
	 * @return string Connect URL
4571
	 */
4572
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4573
		$site_id    = Jetpack_Options::get_option( 'id' );
4574
		$blog_token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::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...
4575
4576
		if ( $register || ! $blog_token || ! $site_id ) {
4577
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4578
4579
			if ( ! empty( $redirect ) ) {
4580
				$url = add_query_arg(
4581
					'redirect',
4582
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4583
					$url
4584
				);
4585
			}
4586
4587
			if ( is_network_admin() ) {
4588
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4589
			}
4590
4591
			$calypso_env = self::get_calypso_env();
4592
4593
			if ( ! empty( $calypso_env ) ) {
4594
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4595
			}
4596
		} else {
4597
4598
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4599
			// because otherwise this logic can get us in to a loop.
4600
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4601
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4602
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4603
4604
				$response = Client::wpcom_json_api_request_as_blog(
4605
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4606
					'1.1'
4607
				);
4608
4609
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4610
4611
					// Generating a register URL instead to refresh the existing token
4612
					return $this->build_connect_url( $raw, $redirect, $from, true );
4613
				}
4614
			}
4615
4616
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4572 can also be of type string; however, Jetpack::build_authorize_url() does only seem to accept boolean, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
4617
		}
4618
4619
		if ( $from ) {
4620
			$url = add_query_arg( 'from', $from, $url );
4621
		}
4622
4623
		// Ensure that class to get the affiliate code is loaded
4624
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4625
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4626
		}
4627
		// Get affiliate code and add it to the URL
4628
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4629
4630
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4631
	}
4632
4633
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4634
		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4635
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4636
		}
4637
4638
		$roles       = new Roles();
4639
		$role        = $roles->translate_current_user_to_role();
4640
		$signed_role = self::connection()->sign_role( $role );
4641
4642
		$user = wp_get_current_user();
4643
4644
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4645
		$redirect           = $redirect
4646
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4647
			: $jetpack_admin_page;
4648
4649
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4650
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4651
		}
4652
4653
		$secrets = self::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4654
4655
		/**
4656
		 * Filter the type of authorization.
4657
		 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4658
		 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4659
		 *
4660
		 * @since 4.3.3
4661
		 *
4662
		 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4663
		 */
4664
		$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4665
4666
		$tracks          = new Tracking();
4667
		$tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4668
4669
		$args = urlencode_deep(
4670
			array(
4671
				'response_type' => 'code',
4672
				'client_id'     => Jetpack_Options::get_option( 'id' ),
4673
				'redirect_uri'  => add_query_arg(
4674
					array(
4675
						'action'   => 'authorize',
4676
						'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4677
						'redirect' => urlencode( $redirect ),
4678
					),
4679
					esc_url( admin_url( 'admin.php?page=jetpack' ) )
4680
				),
4681
				'state'         => $user->ID,
4682
				'scope'         => $signed_role,
4683
				'user_email'    => $user->user_email,
4684
				'user_login'    => $user->user_login,
4685
				'is_active'     => self::is_active(),
4686
				'jp_version'    => JETPACK__VERSION,
4687
				'auth_type'     => $auth_type,
4688
				'secret'        => $secrets['secret_1'],
4689
				'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4690
				'blogname'      => get_option( 'blogname' ),
4691
				'site_url'      => site_url(),
4692
				'home_url'      => home_url(),
4693
				'site_icon'     => get_site_icon_url(),
4694
				'site_lang'     => get_locale(),
4695
				'_ui'           => $tracks_identity['_ui'],
4696
				'_ut'           => $tracks_identity['_ut'],
4697
				'site_created'  => self::connection()->get_assumed_site_creation_date(),
4698
			)
4699
		);
4700
4701
		self::apply_activation_source_to_args( $args );
4702
4703
		$connection = self::connection();
4704
4705
		$calypso_env = self::get_calypso_env();
4706
4707
		if ( ! empty( $calypso_env ) ) {
4708
			$args['calypso_env'] = $calypso_env;
4709
		}
4710
4711
		$api_url = $iframe ? $connection->api_url( 'authorize_iframe' ) : $connection->api_url( 'authorize' );
4712
4713
		return add_query_arg( $args, $api_url );
4714
	}
4715
4716
	/**
4717
	 * Get our assumed site creation date.
4718
	 * Calculated based on the earlier date of either:
4719
	 * - Earliest admin user registration date.
4720
	 * - Earliest date of post of any post type.
4721
	 *
4722
	 * @since 7.2.0
4723
	 * @deprecated since 7.8.0
4724
	 *
4725
	 * @return string Assumed site creation date and time.
4726
	 */
4727
	public static function get_assumed_site_creation_date() {
4728
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4729
		return self::connection()->get_assumed_site_creation_date();
4730
	}
4731
4732 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4733
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4734
4735
		if ( $activation_source_name ) {
4736
			$args['_as'] = urlencode( $activation_source_name );
4737
		}
4738
4739
		if ( $activation_source_keyword ) {
4740
			$args['_ak'] = urlencode( $activation_source_keyword );
4741
		}
4742
	}
4743
4744
	function build_reconnect_url( $raw = false ) {
4745
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4746
		return $raw ? $url : esc_url( $url );
4747
	}
4748
4749
	public static function admin_url( $args = null ) {
4750
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4751
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4752
		return $url;
4753
	}
4754
4755
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4756
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4757
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4758
	}
4759
4760
	function dismiss_jetpack_notice() {
4761
4762
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4763
			return;
4764
		}
4765
4766
		switch ( $_GET['jetpack-notice'] ) {
4767
			case 'dismiss':
4768
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4769
4770
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4771
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4772
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4773
				}
4774
				break;
4775
		}
4776
	}
4777
4778
	public static function sort_modules( $a, $b ) {
4779
		if ( $a['sort'] == $b['sort'] ) {
4780
			return 0;
4781
		}
4782
4783
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4784
	}
4785
4786
	function ajax_recheck_ssl() {
4787
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4788
		$result = self::permit_ssl( true );
4789
		wp_send_json(
4790
			array(
4791
				'enabled' => $result,
4792
				'message' => get_transient( 'jetpack_https_test_message' ),
4793
			)
4794
		);
4795
	}
4796
4797
	/* Client API */
4798
4799
	/**
4800
	 * Returns the requested Jetpack API URL
4801
	 *
4802
	 * @deprecated since 7.7
4803
	 * @return string
4804
	 */
4805
	public static function api_url( $relative_url ) {
4806
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4807
		$connection = self::connection();
4808
		return $connection->api_url( $relative_url );
4809
	}
4810
4811
	/**
4812
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4813
	 */
4814
	public static function fix_url_for_bad_hosts( $url ) {
4815
		if ( 0 !== strpos( $url, 'https://' ) ) {
4816
			return $url;
4817
		}
4818
4819
		switch ( JETPACK_CLIENT__HTTPS ) {
4820
			case 'ALWAYS':
4821
				return $url;
4822
			case 'NEVER':
4823
				return set_url_scheme( $url, 'http' );
4824
			// default : case 'AUTO' :
4825
		}
4826
4827
		// we now return the unmodified SSL URL by default, as a security precaution
4828
		return $url;
4829
	}
4830
4831
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4832
		// Default to a blog token.
4833
		$token_type = 'blog';
4834
4835
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4836
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4837
			if ( ! empty( $_GET['onboarding'] ) ) {
4838
				$jpo = $_GET;
4839
			} else {
4840
				$jpo = json_decode( $request_data, true );
4841
			}
4842
4843
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4844
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4845
4846
			if (
4847
				isset( $jpo_user )
4848
				&& isset( $jpo_token )
4849
				&& is_email( $jpo_user )
4850
				&& ctype_alnum( $jpo_token )
4851
				&& isset( $_GET['rest_route'] )
4852
				&& self::validate_onboarding_token_action(
4853
					$jpo_token,
4854
					$_GET['rest_route']
4855
				)
4856
			) {
4857
				$jp_user = get_user_by( 'email', $jpo_user );
4858
				if ( is_a( $jp_user, 'WP_User' ) ) {
4859
					wp_set_current_user( $jp_user->ID );
4860
					$user_can = is_multisite()
4861
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4862
						: current_user_can( 'manage_options' );
4863
					if ( $user_can ) {
4864
						$token_type              = 'user';
4865
						$token->external_user_id = $jp_user->ID;
4866
					}
4867
				}
4868
			}
4869
4870
			$token_data['type']    = $token_type;
4871
			$token_data['user_id'] = $token->external_user_id;
4872
		}
4873
4874
		return $token_data;
4875
	}
4876
4877
	/**
4878
	 * Create a random secret for validating onboarding payload
4879
	 *
4880
	 * @return string Secret token
4881
	 */
4882
	public static function create_onboarding_token() {
4883
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4884
			$token = wp_generate_password( 32, false );
4885
			Jetpack_Options::update_option( 'onboarding', $token );
4886
		}
4887
4888
		return $token;
4889
	}
4890
4891
	/**
4892
	 * Remove the onboarding token
4893
	 *
4894
	 * @return bool True on success, false on failure
4895
	 */
4896
	public static function invalidate_onboarding_token() {
4897
		return Jetpack_Options::delete_option( 'onboarding' );
4898
	}
4899
4900
	/**
4901
	 * Validate an onboarding token for a specific action
4902
	 *
4903
	 * @return boolean True if token/action pair is accepted, false if not
4904
	 */
4905
	public static function validate_onboarding_token_action( $token, $action ) {
4906
		// Compare tokens, bail if tokens do not match
4907
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4908
			return false;
4909
		}
4910
4911
		// List of valid actions we can take
4912
		$valid_actions = array(
4913
			'/jetpack/v4/settings',
4914
		);
4915
4916
		// Whitelist the action
4917
		if ( ! in_array( $action, $valid_actions ) ) {
4918
			return false;
4919
		}
4920
4921
		return true;
4922
	}
4923
4924
	/**
4925
	 * Checks to see if the URL is using SSL to connect with Jetpack
4926
	 *
4927
	 * @since 2.3.3
4928
	 * @return boolean
4929
	 */
4930
	public static function permit_ssl( $force_recheck = false ) {
4931
		// Do some fancy tests to see if ssl is being supported
4932
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4933
			$message = '';
4934
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4935
				$ssl = 0;
4936
			} else {
4937
				switch ( JETPACK_CLIENT__HTTPS ) {
4938
					case 'NEVER':
4939
						$ssl     = 0;
4940
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4941
						break;
4942
					case 'ALWAYS':
4943
					case 'AUTO':
4944
					default:
4945
						$ssl = 1;
4946
						break;
4947
				}
4948
4949
				// If it's not 'NEVER', test to see
4950
				if ( $ssl ) {
4951
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4952
						$ssl     = 0;
4953
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4954
					} else {
4955
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4956
						if ( is_wp_error( $response ) ) {
4957
							$ssl     = 0;
4958
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4959
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4960
							$ssl     = 0;
4961
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4962
						}
4963
					}
4964
				}
4965
			}
4966
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4967
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4968
		}
4969
4970
		return (bool) $ssl;
4971
	}
4972
4973
	/*
4974
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4975
	 */
4976
	public function alert_auto_ssl_fail() {
4977
		if ( ! current_user_can( 'manage_options' ) ) {
4978
			return;
4979
		}
4980
4981
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4982
		?>
4983
4984
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4985
			<div class="jp-banner__content">
4986
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4987
				<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>
4988
				<p>
4989
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4990
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4991
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4992
				</p>
4993
				<p>
4994
					<?php
4995
					printf(
4996
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
4997
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
4998
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
4999
					);
5000
					?>
5001
				</p>
5002
			</div>
5003
		</div>
5004
		<style>
5005
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5006
		</style>
5007
		<script type="text/javascript">
5008
			jQuery( document ).ready( function( $ ) {
5009
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5010
					var $this = $( this );
5011
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5012
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5013
					e.preventDefault();
5014
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5015
					$.post( ajaxurl, data )
5016
					  .done( function( response ) {
5017
						  if ( response.enabled ) {
5018
							  $( '#jetpack-ssl-warning' ).hide();
5019
						  } else {
5020
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5021
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5022
						  }
5023
					  }.bind( $this ) );
5024
				} );
5025
			} );
5026
		</script>
5027
5028
		<?php
5029
	}
5030
5031
	/**
5032
	 * Returns the Jetpack XML-RPC API
5033
	 *
5034
	 * @return string
5035
	 */
5036
	public static function xmlrpc_api_url() {
5037
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5038
		return untrailingslashit( $base ) . '/xmlrpc.php';
5039
	}
5040
5041
	public static function connection() {
5042
		return self::init()->connection_manager;
5043
	}
5044
5045
	/**
5046
	 * Creates two secret tokens and the end of life timestamp for them.
5047
	 *
5048
	 * Note these tokens are unique per call, NOT static per site for connecting.
5049
	 *
5050
	 * @since 2.6
5051
	 * @return array
5052
	 */
5053
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5054
		if ( false === $user_id ) {
5055
			$user_id = get_current_user_id();
5056
		}
5057
5058
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5059
	}
5060
5061
	public static function get_secrets( $action, $user_id ) {
5062
		$secrets = self::connection()->get_secrets( $action, $user_id );
5063
5064
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5065
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5066
		}
5067
5068
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5069
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5070
		}
5071
5072
		return $secrets;
5073
	}
5074
5075
	/**
5076
	 * @deprecated 7.5 Use Connection_Manager instead.
5077
	 *
5078
	 * @param $action
5079
	 * @param $user_id
5080
	 */
5081
	public static function delete_secrets( $action, $user_id ) {
5082
		return self::connection()->delete_secrets( $action, $user_id );
5083
	}
5084
5085
	/**
5086
	 * Builds the timeout limit for queries talking with the wpcom servers.
5087
	 *
5088
	 * Based on local php max_execution_time in php.ini
5089
	 *
5090
	 * @since 2.6
5091
	 * @return int
5092
	 * @deprecated
5093
	 **/
5094
	public function get_remote_query_timeout_limit() {
5095
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5096
		return self::get_max_execution_time();
5097
	}
5098
5099
	/**
5100
	 * Builds the timeout limit for queries talking with the wpcom servers.
5101
	 *
5102
	 * Based on local php max_execution_time in php.ini
5103
	 *
5104
	 * @since 5.4
5105
	 * @return int
5106
	 **/
5107
	public static function get_max_execution_time() {
5108
		$timeout = (int) ini_get( 'max_execution_time' );
5109
5110
		// Ensure exec time set in php.ini
5111
		if ( ! $timeout ) {
5112
			$timeout = 30;
5113
		}
5114
		return $timeout;
5115
	}
5116
5117
	/**
5118
	 * Sets a minimum request timeout, and returns the current timeout
5119
	 *
5120
	 * @since 5.4
5121
	 **/
5122 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5123
		$timeout = self::get_max_execution_time();
5124
		if ( $timeout < $min_timeout ) {
5125
			$timeout = $min_timeout;
5126
			set_time_limit( $timeout );
5127
		}
5128
		return $timeout;
5129
	}
5130
5131
	/**
5132
	 * Takes the response from the Jetpack register new site endpoint and
5133
	 * verifies it worked properly.
5134
	 *
5135
	 * @since 2.6
5136
	 * @deprecated since 7.7.0
5137
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5138
	 **/
5139
	public function validate_remote_register_response() {
5140
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5141
	}
5142
5143
	/**
5144
	 * @return bool|WP_Error
5145
	 */
5146
	public static function register() {
5147
		$tracking = new Tracking();
5148
		$tracking->record_user_event( 'jpc_register_begin' );
5149
5150
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5151
5152
		$connection   = self::connection();
5153
		$registration = $connection->register();
5154
5155
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5156
5157
		if ( ! $registration || is_wp_error( $registration ) ) {
5158
			return $registration;
5159
		}
5160
5161
		return true;
5162
	}
5163
5164
	/**
5165
	 * Filters the registration request body to include tracking properties.
5166
	 *
5167
	 * @param Array $properties
5168
	 * @return Array amended properties.
5169
	 */
5170
	public static function filter_register_request_body( $properties ) {
5171
		$tracking        = new Tracking();
5172
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5173
5174
		return array_merge(
5175
			$properties,
5176
			array(
5177
				'_ui' => $tracks_identity['_ui'],
5178
				'_ut' => $tracks_identity['_ut'],
5179
			)
5180
		);
5181
	}
5182
5183
	/**
5184
	 * If the db version is showing something other that what we've got now, bump it to current.
5185
	 *
5186
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

Loading history...
5187
	 */
5188
	public static function maybe_set_version_option() {
5189
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5190
		if ( JETPACK__VERSION != $version ) {
5191
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5192
5193
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5194
				/** This action is documented in class.jetpack.php */
5195
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5196
			}
5197
5198
			return true;
5199
		}
5200
		return false;
5201
	}
5202
5203
	/* Client Server API */
5204
5205
	/**
5206
	 * Loads the Jetpack XML-RPC client.
5207
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5208
	 *
5209
	 * @deprecated since 7.7.0
5210
	 */
5211
	public static function load_xml_rpc_client() {
5212
		// Removed the php notice that shows up in order to give time to Akismet and VaultPress time to update.
5213
		// _deprecated_function( __METHOD__, 'jetpack-7.7' );
5214
	}
5215
5216
	/**
5217
	 * Resets the saved authentication state in between testing requests.
5218
	 */
5219
	public function reset_saved_auth_state() {
5220
		$this->rest_authentication_status = null;
5221
		$this->connection_manager->reset_saved_auth_state();
5222
	}
5223
5224
	/**
5225
	 * Verifies the signature of the current request.
5226
	 *
5227
	 * @deprecated since 7.7.0
5228
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5229
	 *
5230
	 * @return false|array
5231
	 */
5232
	public function verify_xml_rpc_signature() {
5233
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5234
		return self::connection()->verify_xml_rpc_signature();
5235
	}
5236
5237
	/**
5238
	 * Verifies the signature of the current request.
5239
	 *
5240
	 * This function has side effects and should not be used. Instead,
5241
	 * use the memoized version `->verify_xml_rpc_signature()`.
5242
	 *
5243
	 * @deprecated since 7.7.0
5244
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5245
	 * @internal
5246
	 */
5247
	private function internal_verify_xml_rpc_signature() {
5248
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5249
	}
5250
5251
	/**
5252
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5253
	 *
5254
	 * @deprecated since 7.7.0
5255
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5256
	 *
5257
	 * @param \WP_User|mixed $user     User object if authenticated.
5258
	 * @param string         $username Username.
5259
	 * @param string         $password Password string.
5260
	 * @return \WP_User|mixed Authenticated user or error.
5261
	 */
5262
	public function authenticate_jetpack( $user, $username, $password ) {
5263
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5264
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5265
	}
5266
5267
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5268
	// Uses the existing XMLRPC request signing implementation.
5269
	function wp_rest_authenticate( $user ) {
5270
		if ( ! empty( $user ) ) {
5271
			// Another authentication method is in effect.
5272
			return $user;
5273
		}
5274
5275
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5276
			// Nothing to do for this authentication method.
5277
			return null;
5278
		}
5279
5280
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5281
			// Nothing to do for this authentication method.
5282
			return null;
5283
		}
5284
5285
		// Ensure that we always have the request body available.  At this
5286
		// point, the WP REST API code to determine the request body has not
5287
		// run yet.  That code may try to read from 'php://input' later, but
5288
		// this can only be done once per request in PHP versions prior to 5.6.
5289
		// So we will go ahead and perform this read now if needed, and save
5290
		// the request body where both the Jetpack signature verification code
5291
		// and the WP REST API code can see it.
5292
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5293
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5294
		}
5295
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5296
5297
		// Only support specific request parameters that have been tested and
5298
		// are known to work with signature verification.  A different method
5299
		// can be passed to the WP REST API via the '?_method=' parameter if
5300
		// needed.
5301
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5302
			$this->rest_authentication_status = new WP_Error(
5303
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5304
				__( 'This request method is not supported.', 'jetpack' ),
5305
				array( 'status' => 400 )
5306
			);
5307
			return null;
5308
		}
5309
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5310
			$this->rest_authentication_status = new WP_Error(
5311
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5312
				__( 'This request method does not support body parameters.', 'jetpack' ),
5313
				array( 'status' => 400 )
5314
			);
5315
			return null;
5316
		}
5317
5318
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5319
5320
		if (
5321
			$verified &&
5322
			isset( $verified['type'] ) &&
5323
			'user' === $verified['type'] &&
5324
			! empty( $verified['user_id'] )
5325
		) {
5326
			// Authentication successful.
5327
			$this->rest_authentication_status = true;
5328
			return $verified['user_id'];
5329
		}
5330
5331
		// Something else went wrong.  Probably a signature error.
5332
		$this->rest_authentication_status = new WP_Error(
5333
			'rest_invalid_signature',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5334
			__( 'The request is not signed correctly.', 'jetpack' ),
5335
			array( 'status' => 400 )
5336
		);
5337
		return null;
5338
	}
5339
5340
	/**
5341
	 * Report authentication status to the WP REST API.
5342
	 *
5343
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
5344
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5345
	 */
5346
	public function wp_rest_authentication_errors( $value ) {
5347
		if ( $value !== null ) {
5348
			return $value;
5349
		}
5350
		return $this->rest_authentication_status;
5351
	}
5352
5353
	/**
5354
	 * Add our nonce to this request.
5355
	 *
5356
	 * @deprecated since 7.7.0
5357
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5358
	 *
5359
	 * @param int    $timestamp Timestamp of the request.
5360
	 * @param string $nonce     Nonce string.
5361
	 */
5362
	public function add_nonce( $timestamp, $nonce ) {
5363
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5364
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5365
	}
5366
5367
	/**
5368
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5369
	 * Capture it here so we can verify the signature later.
5370
	 *
5371
	 * @deprecated since 7.7.0
5372
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5373
	 *
5374
	 * @param array $methods XMLRPC methods.
5375
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5376
	 */
5377
	public function xmlrpc_methods( $methods ) {
5378
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5379
		return $this->connection_manager->xmlrpc_methods( $methods );
5380
	}
5381
5382
	/**
5383
	 * Register additional public XMLRPC methods.
5384
	 *
5385
	 * @deprecated since 7.7.0
5386
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5387
	 *
5388
	 * @param array $methods Public XMLRPC methods.
5389
	 * @return array Public XMLRPC methods, with the getOptions one.
5390
	 */
5391
	public function public_xmlrpc_methods( $methods ) {
5392
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5393
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5394
	}
5395
5396
	/**
5397
	 * Handles a getOptions XMLRPC method call.
5398
	 *
5399
	 * @deprecated since 7.7.0
5400
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5401
	 *
5402
	 * @param array $args method call arguments.
5403
	 * @return array an amended XMLRPC server options array.
5404
	 */
5405
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5406
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5407
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
Bug introduced by
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5408
	}
5409
5410
	/**
5411
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5412
	 *
5413
	 * @deprecated since 7.7.0
5414
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5415
	 *
5416
	 * @param array $options Standard Core options.
5417
	 * @return array Amended options.
5418
	 */
5419
	public function xmlrpc_options( $options ) {
5420
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5421
		return $this->connection_manager->xmlrpc_options( $options );
5422
	}
5423
5424
	/**
5425
	 * Cleans nonces that were saved when calling ::add_nonce.
5426
	 *
5427
	 * @deprecated since 7.7.0
5428
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5429
	 *
5430
	 * @param bool $all whether to clean even non-expired nonces.
5431
	 */
5432
	public static function clean_nonces( $all = false ) {
5433
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5434
		return self::connection()->clean_nonces( $all );
5435
	}
5436
5437
	/**
5438
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5439
	 * SET: state( $key, $value );
5440
	 * GET: $value = state( $key );
5441
	 *
5442
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

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

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

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

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

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

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

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

Loading history...
5444
	 * @param bool   $restate private
5445
	 */
5446
	public static function state( $key = null, $value = null, $restate = false ) {
5447
		static $state = array();
5448
		static $path, $domain;
5449
		if ( ! isset( $path ) ) {
5450
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5451
			$admin_url = self::admin_url();
5452
			$bits      = wp_parse_url( $admin_url );
5453
5454
			if ( is_array( $bits ) ) {
5455
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5456
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5457
			} else {
5458
				$path = $domain = null;
5459
			}
5460
		}
5461
5462
		// Extract state from cookies and delete cookies
5463
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5464
			$yum = $_COOKIE['jetpackState'];
5465
			unset( $_COOKIE['jetpackState'] );
5466
			foreach ( $yum as $k => $v ) {
5467
				if ( strlen( $v ) ) {
5468
					$state[ $k ] = $v;
5469
				}
5470
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5471
			}
5472
		}
5473
5474
		if ( $restate ) {
5475
			foreach ( $state as $k => $v ) {
5476
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5477
			}
5478
			return;
5479
		}
5480
5481
		// Get a state variable
5482
		if ( isset( $key ) && ! isset( $value ) ) {
5483
			if ( array_key_exists( $key, $state ) ) {
5484
				return $state[ $key ];
5485
			}
5486
			return null;
5487
		}
5488
5489
		// Set a state variable
5490
		if ( isset( $key ) && isset( $value ) ) {
5491
			if ( is_array( $value ) && isset( $value[0] ) ) {
5492
				$value = $value[0];
5493
			}
5494
			$state[ $key ] = $value;
5495
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5496
		}
5497
	}
5498
5499
	public static function restate() {
5500
		self::state( null, null, true );
5501
	}
5502
5503
	public static function check_privacy( $file ) {
5504
		static $is_site_publicly_accessible = null;
5505
5506
		if ( is_null( $is_site_publicly_accessible ) ) {
5507
			$is_site_publicly_accessible = false;
5508
5509
			$rpc = new Jetpack_IXR_Client();
5510
5511
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5512
			if ( $success ) {
5513
				$response = $rpc->getResponse();
5514
				if ( $response ) {
5515
					$is_site_publicly_accessible = true;
5516
				}
5517
			}
5518
5519
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5520
		}
5521
5522
		if ( $is_site_publicly_accessible ) {
5523
			return;
5524
		}
5525
5526
		$module_slug = self::get_module_slug( $file );
5527
5528
		$privacy_checks = self::state( 'privacy_checks' );
5529
		if ( ! $privacy_checks ) {
5530
			$privacy_checks = $module_slug;
5531
		} else {
5532
			$privacy_checks .= ",$module_slug";
5533
		}
5534
5535
		self::state( 'privacy_checks', $privacy_checks );
5536
	}
5537
5538
	/**
5539
	 * Helper method for multicall XMLRPC.
5540
	 */
5541
	public static function xmlrpc_async_call() {
5542
		global $blog_id;
5543
		static $clients = array();
5544
5545
		$client_blog_id = is_multisite() ? $blog_id : 0;
5546
5547
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5548
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5549
			if ( function_exists( 'ignore_user_abort' ) ) {
5550
				ignore_user_abort( true );
5551
			}
5552
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5553
		}
5554
5555
		$args = func_get_args();
5556
5557
		if ( ! empty( $args[0] ) ) {
5558
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5559
		} elseif ( is_multisite() ) {
5560
			foreach ( $clients as $client_blog_id => $client ) {
5561
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5562
					continue;
5563
				}
5564
5565
				$switch_success = switch_to_blog( $client_blog_id, true );
5566
				if ( ! $switch_success ) {
5567
					continue;
5568
				}
5569
5570
				flush();
5571
				$client->query();
5572
5573
				restore_current_blog();
5574
			}
5575
		} else {
5576
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5577
				flush();
5578
				$clients[0]->query();
5579
			}
5580
		}
5581
	}
5582
5583
	public static function staticize_subdomain( $url ) {
5584
5585
		// Extract hostname from URL
5586
		$host = parse_url( $url, PHP_URL_HOST );
5587
5588
		// Explode hostname on '.'
5589
		$exploded_host = explode( '.', $host );
5590
5591
		// Retrieve the name and TLD
5592
		if ( count( $exploded_host ) > 1 ) {
5593
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5594
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5595
			// Rebuild domain excluding subdomains
5596
			$domain = $name . '.' . $tld;
5597
		} else {
5598
			$domain = $host;
5599
		}
5600
		// Array of Automattic domains
5601
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5602
5603
		// Return $url if not an Automattic domain
5604
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5605
			return $url;
5606
		}
5607
5608
		if ( is_ssl() ) {
5609
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5610
		}
5611
5612
		srand( crc32( basename( $url ) ) );
5613
		$static_counter = rand( 0, 2 );
5614
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5615
5616
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5617
	}
5618
5619
	/* JSON API Authorization */
5620
5621
	/**
5622
	 * Handles the login action for Authorizing the JSON API
5623
	 */
5624
	function login_form_json_api_authorization() {
5625
		$this->verify_json_api_authorization_request();
5626
5627
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5628
5629
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5630
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5631
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5632
	}
5633
5634
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5635
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5636
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5637
			return $url;
5638
		}
5639
5640
		$parsed_url = parse_url( $url );
5641
		$url        = strtok( $url, '?' );
5642
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5643
		if ( ! empty( $parsed_url['query'] ) ) {
5644
			$url .= "&{$parsed_url['query']}";
5645
		}
5646
5647
		return $url;
5648
	}
5649
5650
	// Make sure the POSTed request is handled by the same action
5651
	function preserve_action_in_login_form_for_json_api_authorization() {
5652
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5653
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5654
	}
5655
5656
	// If someone logs in to approve API access, store the Access Code in usermeta
5657
	function store_json_api_authorization_token( $user_login, $user ) {
5658
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5659
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5660
		$token = wp_generate_password( 32, false );
5661
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5662
	}
5663
5664
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5665
	function allow_wpcom_public_api_domain( $domains ) {
5666
		$domains[] = 'public-api.wordpress.com';
5667
		return $domains;
5668
	}
5669
5670
	static function is_redirect_encoded( $redirect_url ) {
5671
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5672
	}
5673
5674
	// Add all wordpress.com environments to the safe redirect whitelist
5675
	function allow_wpcom_environments( $domains ) {
5676
		$domains[] = 'wordpress.com';
5677
		$domains[] = 'wpcalypso.wordpress.com';
5678
		$domains[] = 'horizon.wordpress.com';
5679
		$domains[] = 'calypso.localhost';
5680
		return $domains;
5681
	}
5682
5683
	// Add the Access Code details to the public-api.wordpress.com redirect
5684
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5685
		return add_query_arg(
5686
			urlencode_deep(
5687
				array(
5688
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5689
					'jetpack-user-id' => (int) $user->ID,
5690
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5691
				)
5692
			),
5693
			$redirect_to
5694
		);
5695
	}
5696
5697
5698
	/**
5699
	 * Verifies the request by checking the signature
5700
	 *
5701
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5702
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5703
	 *
5704
	 * @param null|array $environment
5705
	 */
5706
	function verify_json_api_authorization_request( $environment = null ) {
5707
		$environment = is_null( $environment )
5708
			? $_REQUEST
5709
			: $environment;
5710
5711
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5712
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::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...
5713
		if ( ! $token || empty( $token->secret ) ) {
5714
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5715
		}
5716
5717
		$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' );
5718
5719
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5720
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5721
			/**
5722
			 * Jetpack authorisation request Error.
5723
			 *
5724
			 * @since 7.5.0
5725
			 */
5726
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5727
			$die_error = sprintf(
5728
				/* translators: %s is a URL */
5729
				__( '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' ),
5730
				'https://jetpack.com/support/double-encoding/'
5731
			);
5732
		}
5733
5734
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5735
5736
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5737
			$signature = $jetpack_signature->sign_request(
5738
				$environment['token'],
5739
				$environment['timestamp'],
5740
				$environment['nonce'],
5741
				'',
5742
				'GET',
5743
				$environment['jetpack_json_api_original_query'],
5744
				null,
5745
				true
5746
			);
5747
		} else {
5748
			$signature = $jetpack_signature->sign_current_request(
5749
				array(
5750
					'body'   => null,
5751
					'method' => 'GET',
5752
				)
5753
			);
5754
		}
5755
5756
		if ( ! $signature ) {
5757
			wp_die( $die_error );
5758
		} elseif ( is_wp_error( $signature ) ) {
5759
			wp_die( $die_error );
5760
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5761
			if ( is_ssl() ) {
5762
				// 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
5763
				$signature = $jetpack_signature->sign_current_request(
5764
					array(
5765
						'scheme' => 'http',
5766
						'body'   => null,
5767
						'method' => 'GET',
5768
					)
5769
				);
5770
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5771
					wp_die( $die_error );
5772
				}
5773
			} else {
5774
				wp_die( $die_error );
5775
			}
5776
		}
5777
5778
		$timestamp = (int) $environment['timestamp'];
5779
		$nonce     = stripslashes( (string) $environment['nonce'] );
5780
5781
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5782
			// De-nonce the nonce, at least for 5 minutes.
5783
			// 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)
5784
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5785
			if ( $old_nonce_time < time() - 300 ) {
5786
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5787
			}
5788
		}
5789
5790
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5791
		$data_filters = array(
5792
			'state'        => 'opaque',
5793
			'client_id'    => 'int',
5794
			'client_title' => 'string',
5795
			'client_image' => 'url',
5796
		);
5797
5798
		foreach ( $data_filters as $key => $sanitation ) {
5799
			if ( ! isset( $data->$key ) ) {
5800
				wp_die( $die_error );
5801
			}
5802
5803
			switch ( $sanitation ) {
5804
				case 'int':
5805
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5806
					break;
5807
				case 'opaque':
5808
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5809
					break;
5810
				case 'string':
5811
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5812
					break;
5813
				case 'url':
5814
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5815
					break;
5816
			}
5817
		}
5818
5819
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5820
			wp_die( $die_error );
5821
		}
5822
	}
5823
5824
	function login_message_json_api_authorization( $message ) {
5825
		return '<p class="message">' . sprintf(
5826
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5827
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5828
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5829
	}
5830
5831
	/**
5832
	 * Get $content_width, but with a <s>twist</s> filter.
5833
	 */
5834
	public static function get_content_width() {
5835
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5836
			? $GLOBALS['content_width']
5837
			: false;
5838
		/**
5839
		 * Filter the Content Width value.
5840
		 *
5841
		 * @since 2.2.3
5842
		 *
5843
		 * @param string $content_width Content Width value.
5844
		 */
5845
		return apply_filters( 'jetpack_content_width', $content_width );
5846
	}
5847
5848
	/**
5849
	 * Pings the WordPress.com Mirror Site for the specified options.
5850
	 *
5851
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5852
	 *
5853
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5854
	 */
5855
	public function get_cloud_site_options( $option_names ) {
5856
		$option_names = array_filter( (array) $option_names, 'is_string' );
5857
5858
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5859
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5860
		if ( $xml->isError() ) {
5861
			return array(
5862
				'error_code' => $xml->getErrorCode(),
5863
				'error_msg'  => $xml->getErrorMessage(),
5864
			);
5865
		}
5866
		$cloud_site_options = $xml->getResponse();
5867
5868
		return $cloud_site_options;
5869
	}
5870
5871
	/**
5872
	 * Checks if the site is currently in an identity crisis.
5873
	 *
5874
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5875
	 */
5876
	public static function check_identity_crisis() {
5877
		if ( ! self::is_active() || self::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5878
			return false;
5879
		}
5880
5881
		return Jetpack_Options::get_option( 'sync_error_idc' );
5882
	}
5883
5884
	/**
5885
	 * Checks whether the home and siteurl specifically are whitelisted
5886
	 * Written so that we don't have re-check $key and $value params every time
5887
	 * we want to check if this site is whitelisted, for example in footer.php
5888
	 *
5889
	 * @since  3.8.0
5890
	 * @return bool True = already whitelisted False = not whitelisted
5891
	 */
5892
	public static function is_staging_site() {
5893
		$is_staging = false;
5894
5895
		$known_staging = array(
5896
			'urls'      => array(
5897
				'#\.staging\.wpengine\.com$#i', // WP Engine
5898
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5899
				'#\.stage\.site$#i',            // DreamPress
5900
			),
5901
			'constants' => array(
5902
				'IS_WPE_SNAPSHOT',      // WP Engine
5903
				'KINSTA_DEV_ENV',       // Kinsta.com
5904
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5905
				'JETPACK_STAGING_MODE', // Generic
5906
			),
5907
		);
5908
		/**
5909
		 * Filters the flags of known staging sites.
5910
		 *
5911
		 * @since 3.9.0
5912
		 *
5913
		 * @param array $known_staging {
5914
		 *     An array of arrays that each are used to check if the current site is staging.
5915
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5916
		 *     @type array $constants PHP constants of known staging/developement environments.
5917
		 *  }
5918
		 */
5919
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5920
5921
		if ( isset( $known_staging['urls'] ) ) {
5922
			foreach ( $known_staging['urls'] as $url ) {
5923
				if ( preg_match( $url, site_url() ) ) {
5924
					$is_staging = true;
5925
					break;
5926
				}
5927
			}
5928
		}
5929
5930
		if ( isset( $known_staging['constants'] ) ) {
5931
			foreach ( $known_staging['constants'] as $constant ) {
5932
				if ( defined( $constant ) && constant( $constant ) ) {
5933
					$is_staging = true;
5934
				}
5935
			}
5936
		}
5937
5938
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5939
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5940
			$is_staging = true;
5941
		}
5942
5943
		/**
5944
		 * Filters is_staging_site check.
5945
		 *
5946
		 * @since 3.9.0
5947
		 *
5948
		 * @param bool $is_staging If the current site is a staging site.
5949
		 */
5950
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5951
	}
5952
5953
	/**
5954
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5955
	 *
5956
	 * @since 4.4.0
5957
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
5958
	 *
5959
	 * @return bool
5960
	 */
5961
	public static function validate_sync_error_idc_option() {
5962
		$is_valid = false;
5963
5964
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5965
		if ( false === $idc_allowed ) {
5966
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5967
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5968
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
5969
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
5970
				$transient_duration = HOUR_IN_SECONDS;
5971
			} else {
5972
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5973
				$idc_allowed        = '1';
5974
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5975
			}
5976
5977
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5978
		}
5979
5980
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5981
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5982
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5983
			$local_options = self::get_sync_error_idc_option();
5984
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5985
				$is_valid = true;
5986
			}
5987
		}
5988
5989
		/**
5990
		 * Filters whether the sync_error_idc option is valid.
5991
		 *
5992
		 * @since 4.4.0
5993
		 *
5994
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5995
		 */
5996
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5997
5998
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5999
			// Since the option exists, and did not validate, delete it
6000
			Jetpack_Options::delete_option( 'sync_error_idc' );
6001
		}
6002
6003
		return $is_valid;
6004
	}
6005
6006
	/**
6007
	 * Normalizes a url by doing three things:
6008
	 *  - Strips protocol
6009
	 *  - Strips www
6010
	 *  - Adds a trailing slash
6011
	 *
6012
	 * @since 4.4.0
6013
	 * @param string $url
6014
	 * @return WP_Error|string
6015
	 */
6016
	public static function normalize_url_protocol_agnostic( $url ) {
6017
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6018
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6019
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'cannot_parse_url'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
6020
		}
6021
6022
		// Strip www and protocols
6023
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6024
		return $url;
6025
	}
6026
6027
	/**
6028
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6029
	 *
6030
	 * @since 4.4.0
6031
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6032
	 *
6033
	 * @param array $response
6034
	 * @return array Array of the local urls, wpcom urls, and error code
6035
	 */
6036
	public static function get_sync_error_idc_option( $response = array() ) {
6037
		// Since the local options will hit the database directly, store the values
6038
		// in a transient to allow for autoloading and caching on subsequent views.
6039
		$local_options = get_transient( 'jetpack_idc_local' );
6040
		if ( false === $local_options ) {
6041
			$local_options = array(
6042
				'home'    => Functions::home_url(),
6043
				'siteurl' => Functions::site_url(),
6044
			);
6045
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6046
		}
6047
6048
		$options = array_merge( $local_options, $response );
6049
6050
		$returned_values = array();
6051
		foreach ( $options as $key => $option ) {
6052
			if ( 'error_code' === $key ) {
6053
				$returned_values[ $key ] = $option;
6054
				continue;
6055
			}
6056
6057
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6058
				continue;
6059
			}
6060
6061
			$returned_values[ $key ] = $normalized_url;
6062
		}
6063
6064
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6065
6066
		return $returned_values;
6067
	}
6068
6069
	/**
6070
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6071
	 * If set to true, the site will be put into staging mode.
6072
	 *
6073
	 * @since 4.3.2
6074
	 * @return bool
6075
	 */
6076
	public static function sync_idc_optin() {
6077
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6078
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6079
		} else {
6080
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6081
		}
6082
6083
		/**
6084
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6085
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6086
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6087
		 *
6088
		 * @since 4.3.2
6089
		 *
6090
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6091
		 */
6092
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6093
	}
6094
6095
	/**
6096
	 * Maybe Use a .min.css stylesheet, maybe not.
6097
	 *
6098
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6099
	 */
6100
	public static function maybe_min_asset( $url, $path, $plugin ) {
6101
		// Short out on things trying to find actual paths.
6102
		if ( ! $path || empty( $plugin ) ) {
6103
			return $url;
6104
		}
6105
6106
		$path = ltrim( $path, '/' );
6107
6108
		// Strip out the abspath.
6109
		$base = dirname( plugin_basename( $plugin ) );
6110
6111
		// Short out on non-Jetpack assets.
6112
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6113
			return $url;
6114
		}
6115
6116
		// File name parsing.
6117
		$file              = "{$base}/{$path}";
6118
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6119
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6120
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6121
		$extension         = array_shift( $file_name_parts_r );
6122
6123
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6124
			// Already pointing at the minified version.
6125
			if ( 'min' === $file_name_parts_r[0] ) {
6126
				return $url;
6127
			}
6128
6129
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6130
			if ( file_exists( $min_full_path ) ) {
6131
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6132
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6133
				if ( 'css' === $extension ) {
6134
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6135
					self::$min_assets[ $key ] = $path;
6136
				}
6137
			}
6138
		}
6139
6140
		return $url;
6141
	}
6142
6143
	/**
6144
	 * If the asset is minified, let's flag .min as the suffix.
6145
	 *
6146
	 * Attached to `style_loader_src` filter.
6147
	 *
6148
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
6661
	 * @return mixed
6662
	 */
6663
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6664
		if ( ! is_array( $sorted ) ) {
6665
			return $sorted;
6666
		}
6667
6668
		foreach ( $sorted as $box_context => $ids ) {
6669
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6670
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6671
				continue;
6672
			}
6673
6674
			$ids_array = explode( ',', $ids );
6675
			$key       = array_search( 'dashboard_stats', $ids_array );
6676
6677
			if ( false !== $key ) {
6678
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6679
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6680
				$sorted[ $box_context ] = implode( ',', $ids_array );
6681
				// We've found it, stop searching, and just return.
6682
				break;
6683
			}
6684
		}
6685
6686
		return $sorted;
6687
	}
6688
6689
	public static function dashboard_widget() {
6690
		/**
6691
		 * Fires when the dashboard is loaded.
6692
		 *
6693
		 * @since 3.4.0
6694
		 */
6695
		do_action( 'jetpack_dashboard_widget' );
6696
	}
6697
6698
	public static function dashboard_widget_footer() {
6699
		?>
6700
		<footer>
6701
6702
		<div class="protect">
6703
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6704
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6705
				<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>
6706
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6707
				<a href="
6708
				<?php
6709
				echo esc_url(
6710
					wp_nonce_url(
6711
						self::admin_url(
6712
							array(
6713
								'action' => 'activate',
6714
								'module' => 'protect',
6715
							)
6716
						),
6717
						'jetpack_activate-protect'
6718
					)
6719
				);
6720
				?>
6721
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6722
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6723
				</a>
6724
			<?php else : ?>
6725
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6726
			<?php endif; ?>
6727
		</div>
6728
6729
		<div class="akismet">
6730
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6731
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6732
				<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>
6733
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6734
				<a href="
6735
				<?php
6736
				echo esc_url(
6737
					wp_nonce_url(
6738
						add_query_arg(
6739
							array(
6740
								'action' => 'activate',
6741
								'plugin' => 'akismet/akismet.php',
6742
							),
6743
							admin_url( 'plugins.php' )
6744
						),
6745
						'activate-plugin_akismet/akismet.php'
6746
					)
6747
				);
6748
				?>
6749
							" class="button button-jetpack">
6750
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6751
				</a>
6752
			<?php else : ?>
6753
				<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>
6754
			<?php endif; ?>
6755
		</div>
6756
6757
		</footer>
6758
		<?php
6759
	}
6760
6761
	/*
6762
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6763
	 */
6764
	function jetpack_icon_user_connected( $columns ) {
6765
		$columns['user_jetpack'] = '';
6766
		return $columns;
6767
	}
6768
6769
	/*
6770
	 * Show Jetpack icon if the user is linked.
6771
	 */
6772
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6773
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6774
			$jetpack_logo = new Jetpack_Logo();
6775
			$emblem_html  = sprintf(
6776
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6777
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6778
				$jetpack_logo->get_jp_emblem()
6779
			);
6780
			return $emblem_html;
6781
		}
6782
6783
		return $val;
6784
	}
6785
6786
	/*
6787
	 * Style the Jetpack user column
6788
	 */
6789
	function jetpack_user_col_style() {
6790
		global $current_screen;
6791
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6792
			?>
6793
			<style>
6794
				.fixed .column-user_jetpack {
6795
					width: 21px;
6796
				}
6797
				.jp-emblem-user-admin svg {
6798
					width: 20px;
6799
					height: 20px;
6800
				}
6801
				.jp-emblem-user-admin path {
6802
					fill: #00BE28;
6803
				}
6804
			</style>
6805
			<?php
6806
		}
6807
	}
6808
6809
	/**
6810
	 * Checks if Akismet is active and working.
6811
	 *
6812
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6813
	 * that implied usage of methods present since more recent version.
6814
	 * See https://github.com/Automattic/jetpack/pull/9585
6815
	 *
6816
	 * @since  5.1.0
6817
	 *
6818
	 * @return bool True = Akismet available. False = Aksimet not available.
6819
	 */
6820
	public static function is_akismet_active() {
6821
		static $status = null;
6822
6823
		if ( ! is_null( $status ) ) {
6824
			return $status;
6825
		}
6826
6827
		// Check if a modern version of Akismet is active.
6828
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6829
			$status = false;
6830
			return $status;
6831
		}
6832
6833
		// Make sure there is a key known to Akismet at all before verifying key.
6834
		$akismet_key = Akismet::get_api_key();
6835
		if ( ! $akismet_key ) {
6836
			$status = false;
6837
			return $status;
6838
		}
6839
6840
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6841
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6842
6843
		// 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.
6844
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6845
		// We cache the result of the Akismet key verification for ten minutes.
6846
		if ( ! $akismet_key_state || $recheck ) {
6847
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6848
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6849
		}
6850
6851
		$status = 'valid' === $akismet_key_state;
6852
6853
		return $status;
6854
	}
6855
6856
	/**
6857
	 * @deprecated
6858
	 *
6859
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6860
	 */
6861
	public static function is_function_in_backtrace() {
6862
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6863
	}
6864
6865
	/**
6866
	 * Given a minified path, and a non-minified path, will return
6867
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6868
	 *
6869
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6870
	 * root Jetpack directory.
6871
	 *
6872
	 * @since 5.6.0
6873
	 *
6874
	 * @param string $min_path
6875
	 * @param string $non_min_path
6876
	 * @return string The URL to the file
6877
	 */
6878
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6879
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6880
	}
6881
6882
	/**
6883
	 * Checks for whether Jetpack Backup & Scan is enabled.
6884
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6885
	 *
6886
	 * @return bool|int|mixed
6887
	 */
6888
	public static function is_rewind_enabled() {
6889
		if ( ! self::is_active() ) {
6890
			return false;
6891
		}
6892
6893
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6894
		if ( false === $rewind_enabled ) {
6895
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6896
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6897
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6898
				&& ! empty( $rewind_data['state'] )
6899
				&& 'active' === $rewind_data['state'] )
6900
				? 1
6901
				: 0;
6902
6903
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6904
		}
6905
		return $rewind_enabled;
6906
	}
6907
6908
	/**
6909
	 * Return Calypso environment value; used for developing Jetpack and pairing
6910
	 * it with different Calypso enrionments, such as localhost.
6911
	 *
6912
	 * @since 7.4.0
6913
	 *
6914
	 * @return string Calypso environment
6915
	 */
6916
	public static function get_calypso_env() {
6917
		if ( isset( $_GET['calypso_env'] ) ) {
6918
			return sanitize_key( $_GET['calypso_env'] );
6919
		}
6920
6921
		if ( getenv( 'CALYPSO_ENV' ) ) {
6922
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6923
		}
6924
6925
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
6926
			return sanitize_key( CALYPSO_ENV );
6927
		}
6928
6929
		return '';
6930
	}
6931
6932
	/**
6933
	 * Checks whether or not TOS has been agreed upon.
6934
	 * Will return true if a user has clicked to register, or is already connected.
6935
	 */
6936
	public static function jetpack_tos_agreed() {
6937
		return Jetpack_Options::get_option( 'tos_agreed' ) || self::is_active();
6938
	}
6939
6940
	/**
6941
	 * Handles activating default modules as well general cleanup for the new connection.
6942
	 *
6943
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
6944
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
6945
	 * @param boolean $send_state_messages          Whether to send state messages.
6946
	 * @return void
6947
	 */
6948
	public static function handle_post_authorization_actions(
6949
		$activate_sso = false,
6950
		$redirect_on_activation_error = false,
6951
		$send_state_messages = true
6952
	) {
6953
		$other_modules = $activate_sso
6954
			? array( 'sso' )
6955
			: array();
6956
6957
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
6958
			self::delete_active_modules();
6959
6960
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
6961
		} else {
6962
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
6963
		}
6964
6965
		// Since this is a fresh connection, be sure to clear out IDC options
6966
		Jetpack_IDC::clear_all_idc_options();
6967
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
6968
6969
		// Start nonce cleaner
6970
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
6971
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
6972
6973
		if ( $send_state_messages ) {
6974
			self::state( 'message', 'authorized' );
6975
		}
6976
	}
6977
6978
	/**
6979
	 * Returns a boolean for whether backups UI should be displayed or not.
6980
	 *
6981
	 * @return bool Should backups UI be displayed?
6982
	 */
6983
	public static function show_backups_ui() {
6984
		/**
6985
		 * Whether UI for backups should be displayed.
6986
		 *
6987
		 * @since 6.5.0
6988
		 *
6989
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
6990
		 */
6991
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
6992
	}
6993
6994
	/*
6995
	 * Deprecated manage functions
6996
	 */
6997
	function prepare_manage_jetpack_notice() {
6998
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6999
	}
7000
	function manage_activate_screen() {
7001
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7002
	}
7003
	function admin_jetpack_manage_notice() {
7004
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7005
	}
7006
	function opt_out_jetpack_manage_url() {
7007
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7008
	}
7009
	function opt_in_jetpack_manage_url() {
7010
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7011
	}
7012
	function opt_in_jetpack_manage_notice() {
7013
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7014
	}
7015
	function can_display_jetpack_manage_notice() {
7016
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7017
	}
7018
7019
	/**
7020
	 * Clean leftoveruser meta.
7021
	 *
7022
	 * Delete Jetpack-related user meta when it is no longer needed.
7023
	 *
7024
	 * @since 7.3.0
7025
	 *
7026
	 * @param int $user_id User ID being updated.
7027
	 */
7028
	public static function user_meta_cleanup( $user_id ) {
7029
		$meta_keys = array(
7030
			// AtD removed from Jetpack 7.3
7031
			'AtD_options',
7032
			'AtD_check_when',
7033
			'AtD_guess_lang',
7034
			'AtD_ignored_phrases',
7035
		);
7036
7037
		foreach ( $meta_keys as $meta_key ) {
7038
			if ( get_user_meta( $user_id, $meta_key ) ) {
7039
				delete_user_meta( $user_id, $meta_key );
7040
			}
7041
		}
7042
	}
7043
7044
	function is_active_and_not_development_mode( $maybe ) {
7045
		if ( ! self::is_active() || self::is_development_mode() ) {
7046
			return false;
7047
		}
7048
		return true;
7049
	}
7050
}
7051