Completed
Push — fix/package-release-script ( 8004a7...315d04 )
by
unknown
06:57
created

Jetpack::after_plugins_loaded()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 16

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 0
dl 0
loc 16
rs 9.7333
c 0
b 0
f 0
1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Partner;
10
use Automattic\Jetpack\Roles;
11
use Automattic\Jetpack\Status;
12
use Automattic\Jetpack\Sync\Functions;
13
use Automattic\Jetpack\Sync\Sender;
14
use Automattic\Jetpack\Sync\Users;
15
use Automattic\Jetpack\Terms_Of_Service;
16
use Automattic\Jetpack\Tracking;
17
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
18
19
/*
20
Options:
21
jetpack_options (array)
22
	An array of options.
23
	@see Jetpack_Options::get_option_names()
24
25
jetpack_register (string)
26
	Temporary verification secrets.
27
28
jetpack_activated (int)
29
	1: the plugin was activated normally
30
	2: the plugin was activated on this site because of a network-wide activation
31
	3: the plugin was auto-installed
32
	4: the plugin was manually disconnected (but is still installed)
33
34
jetpack_active_modules (array)
35
	Array of active module slugs.
36
37
jetpack_do_activate (bool)
38
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
39
*/
40
41
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
42
43
class Jetpack {
44
	public $xmlrpc_server = null;
45
46
	private $rest_authentication_status = null;
47
48
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
49
50
	/**
51
	 * @var array The handles of styles that are concatenated into jetpack.css.
52
	 *
53
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
54
	 */
55
	public $concatenated_style_handles = array(
56
		'jetpack-carousel',
57
		'grunion.css',
58
		'the-neverending-homepage',
59
		'jetpack_likes',
60
		'jetpack_related-posts',
61
		'sharedaddy',
62
		'jetpack-slideshow',
63
		'presentations',
64
		'quiz',
65
		'jetpack-subscriptions',
66
		'jetpack-responsive-videos-style',
67
		'jetpack-social-menu',
68
		'tiled-gallery',
69
		'jetpack_display_posts_widget',
70
		'gravatar-profile-widget',
71
		'goodreads-widget',
72
		'jetpack_social_media_icons_widget',
73
		'jetpack-top-posts-widget',
74
		'jetpack_image_widget',
75
		'jetpack-my-community-widget',
76
		'jetpack-authors-widget',
77
		'wordads',
78
		'eu-cookie-law-style',
79
		'flickr-widget-style',
80
		'jetpack-search-widget',
81
		'jetpack-simple-payments-widget-style',
82
		'jetpack-widget-social-icons-styles',
83
	);
84
85
	/**
86
	 * The handles of scripts that can be loaded asynchronously.
87
	 *
88
	 * @var array
89
	 */
90
	public $async_script_handles = array(
91
		'woocommerce-analytics',
92
	);
93
94
	/**
95
	 * Contains all assets that have had their URL rewritten to minified versions.
96
	 *
97
	 * @var array
98
	 */
99
	static $min_assets = array();
100
101
	public $plugins_to_deactivate = array(
102
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
103
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
104
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
105
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
106
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
107
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
108
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
109
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
110
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
111
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
112
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
113
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
114
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
115
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
116
	);
117
118
	/**
119
	 * Map of roles we care about, and their corresponding minimum capabilities.
120
	 *
121
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
122
	 *
123
	 * @access public
124
	 * @static
125
	 *
126
	 * @var array
127
	 */
128
	public static $capability_translations = array(
129
		'administrator' => 'manage_options',
130
		'editor'        => 'edit_others_posts',
131
		'author'        => 'publish_posts',
132
		'contributor'   => 'edit_posts',
133
		'subscriber'    => 'read',
134
	);
135
136
	/**
137
	 * Map of modules that have conflicts with plugins and should not be auto-activated
138
	 * if the plugins are active.  Used by filter_default_modules
139
	 *
140
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
141
	 * change `module-slug` and add this to your plugin:
142
	 *
143
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
144
	 * function my_jetpack_get_default_modules( $modules ) {
145
	 *     return array_diff( $modules, array( 'module-slug' ) );
146
	 * }
147
	 *
148
	 * @var array
149
	 */
150
	private $conflicting_plugins = array(
151
		'comments'           => array(
152
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
153
			'Disqus'                         => 'disqus-comment-system/disqus.php',
154
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
155
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
156
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
157
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
158
		),
159
		'comment-likes'      => array(
160
			'Epoch' => 'epoch/plugincore.php',
161
		),
162
		'contact-form'       => array(
163
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
164
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
165
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
166
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
167
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
168
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
169
		),
170
		'minileven'          => array(
171
			'WPtouch' => 'wptouch/wptouch.php',
172
		),
173
		'latex'              => array(
174
			'LaTeX for WordPress'     => 'latex/latex.php',
175
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
176
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
177
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
178
			'Enable Latex'            => 'enable-latex/enable-latex.php',
179
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
180
		),
181
		'protect'            => array(
182
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
183
			'Captcha'                           => 'captcha/captcha.php',
184
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
185
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
186
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
187
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
188
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
189
			'Security-protection'               => 'security-protection/security-protection.php',
190
			'Login Security'                    => 'login-security/login-security.php',
191
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
192
			'Wordfence Security'                => 'wordfence/wordfence.php',
193
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
194
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
195
		),
196
		'random-redirect'    => array(
197
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
198
		),
199
		'related-posts'      => array(
200
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
201
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
202
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
203
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
204
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
205
			'outbrain'                    => 'outbrain/outbrain.php',
206
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
207
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
208
		),
209
		'sharedaddy'         => array(
210
			'AddThis'     => 'addthis/addthis_social_widget.php',
211
			'Add To Any'  => 'add-to-any/add-to-any.php',
212
			'ShareThis'   => 'share-this/sharethis.php',
213
			'Shareaholic' => 'shareaholic/shareaholic.php',
214
		),
215
		'seo-tools'          => array(
216
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
217
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
218
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
219
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
220
			'The SEO Framework'              => 'autodescription/autodescription.php',
221
		),
222
		'verification-tools' => array(
223
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
224
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
225
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
226
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
227
			'The SEO Framework'              => 'autodescription/autodescription.php',
228
		),
229
		'widget-visibility'  => array(
230
			'Widget Logic'    => 'widget-logic/widget_logic.php',
231
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
232
		),
233
		'sitemaps'           => array(
234
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
235
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
236
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
237
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
238
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
239
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
240
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
241
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
242
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
243
			'The SEO Framework'                    => 'autodescription/autodescription.php',
244
			'Sitemap'                              => 'sitemap/sitemap.php',
245
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
246
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
247
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
248
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
249
		),
250
		'lazy-images'        => array(
251
			'Lazy Load'              => 'lazy-load/lazy-load.php',
252
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
253
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
254
		),
255
	);
256
257
	/**
258
	 * Plugins for which we turn off our Facebook OG Tags implementation.
259
	 *
260
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
261
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
262
	 *
263
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
264
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
265
	 */
266
	private $open_graph_conflicting_plugins = array(
267
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
268
		// 2 Click Social Media Buttons
269
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
270
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
271
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
272
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
273
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
274
		// Open Graph Meta Tags by Heateor
275
		'facebook/facebook.php',                                 // Facebook (official plugin)
276
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
277
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
278
		// Facebook Featured Image & OG Meta Tags
279
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
280
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
281
		// Facebook Open Graph Meta Tags for WordPress
282
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
283
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
284
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
285
		// Fedmich's Facebook Open Graph Meta
286
		'network-publisher/networkpub.php',                      // Network Publisher
287
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
288
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
289
		// NextScripts SNAP
290
		'og-tags/og-tags.php',                                   // OG Tags
291
		'opengraph/opengraph.php',                               // Open Graph
292
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
293
		// Open Graph Protocol Framework
294
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
295
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
296
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
297
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
298
		'sharepress/sharepress.php',                             // SharePress
299
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
300
		'social-discussions/social-discussions.php',             // Social Discussions
301
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
302
		'socialize/socialize.php',                               // Socialize
303
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
304
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
305
		// Tweet, Like, Google +1 and Share
306
		'wordbooker/wordbooker.php',                             // Wordbooker
307
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
308
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
309
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
310
		// WP Facebook Like Send & Open Graph Meta
311
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
312
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
313
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
314
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
315
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
316
	);
317
318
	/**
319
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
320
	 */
321
	private $twitter_cards_conflicting_plugins = array(
322
		// 'twitter/twitter.php',                       // The official one handles this on its own.
323
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
324
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
325
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
326
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
327
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
328
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
329
		'twitter-cards/twitter-cards.php',           // Twitter Cards
330
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
331
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
332
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
333
	);
334
335
	/**
336
	 * Message to display in admin_notice
337
	 *
338
	 * @var string
339
	 */
340
	public $message = '';
341
342
	/**
343
	 * Error to display in admin_notice
344
	 *
345
	 * @var string
346
	 */
347
	public $error = '';
348
349
	/**
350
	 * Modules that need more privacy description.
351
	 *
352
	 * @var string
353
	 */
354
	public $privacy_checks = '';
355
356
	/**
357
	 * Stats to record once the page loads
358
	 *
359
	 * @var array
360
	 */
361
	public $stats = array();
362
363
	/**
364
	 * Jetpack_Sync object
365
	 */
366
	public $sync;
367
368
	/**
369
	 * Verified data for JSON authorization request
370
	 */
371
	public $json_api_authorization_request = array();
372
373
	/**
374
	 * @var Automattic\Jetpack\Connection\Manager
375
	 */
376
	protected $connection_manager;
377
378
	/**
379
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
380
	 */
381
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
382
383
	/**
384
	 * Holds the singleton instance of this class
385
	 *
386
	 * @since 2.3.3
387
	 * @var Jetpack
388
	 */
389
	static $instance = false;
390
391
	/**
392
	 * Singleton
393
	 *
394
	 * @static
395
	 */
396
	public static function init() {
397
		if ( ! self::$instance ) {
398
			self::$instance = new Jetpack();
399
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
400
		}
401
402
		return self::$instance;
403
	}
404
405
	/**
406
	 * Must never be called statically
407
	 */
408
	function plugin_upgrade() {
409
		if ( self::is_active() ) {
410
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
411
			if ( JETPACK__VERSION != $version ) {
412
				// Prevent multiple upgrades at once - only a single process should trigger
413
				// an upgrade to avoid stampedes
414
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
415
					return;
416
				}
417
418
				// Set a short lock to prevent multiple instances of the upgrade
419
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
420
421
				// check which active modules actually exist and remove others from active_modules list
422
				$unfiltered_modules = self::get_active_modules();
423
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
424
				if ( array_diff( $unfiltered_modules, $modules ) ) {
425
					self::update_active_modules( $modules );
426
				}
427
428
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
429
430
				// Upgrade to 4.3.0
431
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
432
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
433
				}
434
435
				// Make sure Markdown for posts gets turned back on
436
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
437
					update_option( 'wpcom_publish_posts_with_markdown', true );
438
				}
439
440
				if ( did_action( 'wp_loaded' ) ) {
441
					self::upgrade_on_load();
442
				} else {
443
					add_action(
444
						'wp_loaded',
445
						array( __CLASS__, 'upgrade_on_load' )
446
					);
447
				}
448
			}
449
		}
450
	}
451
452
	/**
453
	 * Runs upgrade routines that need to have modules loaded.
454
	 */
455
	static function upgrade_on_load() {
456
457
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
458
		// This can happen in case Jetpack has been just upgraded and is
459
		// being initialized late during the page load. In this case we wait
460
		// until the next proper admin page load with Jetpack active.
461
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
462
			delete_transient( self::$plugin_upgrade_lock_key );
463
464
			return;
465
		}
466
467
		self::maybe_set_version_option();
468
469
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
470
			Jetpack_Widget_Conditions::migrate_post_type_rules();
471
		}
472
473
		if (
474
			class_exists( 'Jetpack_Sitemap_Manager' )
475
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
476
		) {
477
			do_action( 'jetpack_sitemaps_purge_data' );
478
		}
479
480
		// Delete old stats cache
481
		delete_option( 'jetpack_restapi_stats_cache' );
482
483
		delete_transient( self::$plugin_upgrade_lock_key );
484
	}
485
486
	/**
487
	 * Saves all the currently active modules to options.
488
	 * Also fires Action hooks for each newly activated and deactivated module.
489
	 *
490
	 * @param $modules Array Array of active modules to be saved in options.
491
	 *
492
	 * @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...
493
	 */
494
	static function update_active_modules( $modules ) {
495
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
496
		$active_modules       = self::get_active_modules();
497
		$new_active_modules   = array_diff( $modules, $current_modules );
498
		$new_inactive_modules = array_diff( $active_modules, $modules );
499
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
500
		$reindexed_modules    = array_values( $new_current_modules );
501
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
502
503
		foreach ( $new_active_modules as $module ) {
504
			/**
505
			 * Fires when a specific module is activated.
506
			 *
507
			 * @since 1.9.0
508
			 *
509
			 * @param string $module Module slug.
510
			 * @param boolean $success whether the module was activated. @since 4.2
511
			 */
512
			do_action( 'jetpack_activate_module', $module, $success );
513
			/**
514
			 * Fires when a module is activated.
515
			 * The dynamic part of the filter, $module, is the module slug.
516
			 *
517
			 * @since 1.9.0
518
			 *
519
			 * @param string $module Module slug.
520
			 */
521
			do_action( "jetpack_activate_module_$module", $module );
522
		}
523
524
		foreach ( $new_inactive_modules as $module ) {
525
			/**
526
			 * Fired after a module has been deactivated.
527
			 *
528
			 * @since 4.2.0
529
			 *
530
			 * @param string $module Module slug.
531
			 * @param boolean $success whether the module was deactivated.
532
			 */
533
			do_action( 'jetpack_deactivate_module', $module, $success );
534
			/**
535
			 * Fires when a module is deactivated.
536
			 * The dynamic part of the filter, $module, is the module slug.
537
			 *
538
			 * @since 1.9.0
539
			 *
540
			 * @param string $module Module slug.
541
			 */
542
			do_action( "jetpack_deactivate_module_$module", $module );
543
		}
544
545
		return $success;
546
	}
547
548
	static function delete_active_modules() {
549
		self::update_active_modules( array() );
550
	}
551
552
	/**
553
	 * Constructor.  Initializes WordPress hooks
554
	 */
555
	private function __construct() {
556
		/*
557
		 * Check for and alert any deprecated hooks
558
		 */
559
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
560
561
		add_action( 'plugins_loaded', array( $this, 'configure' ), 1 );
562
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
563
564
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
565
566
		add_filter(
567
			'jetpack_signature_check_token',
568
			array( __CLASS__, 'verify_onboarding_token' ),
569
			10,
570
			3
571
		);
572
573
		/**
574
		 * Prepare Gutenberg Editor functionality
575
		 */
576
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
577
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
578
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
579
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
580
581
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
582
583
		// Unlink user before deleting the user from WP.com.
584
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
585
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
586
587
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
588
589
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
590
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
591
592
		add_action( 'admin_init', array( $this, 'admin_init' ) );
593
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
594
595
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
596
597
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
598
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
599
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
600
601
		// returns HTTPS support status
602
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
603
604
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
605
606
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
607
608
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
609
610
		/**
611
		 * These actions run checks to load additional files.
612
		 * They check for external files or plugins, so they need to run as late as possible.
613
		 */
614
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
615
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
616
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
617
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
618
619
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
620
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
621
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
622
623
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
624
625
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
626
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
627
628
		// A filter to control all just in time messages
629
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
630
631
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
632
633
		// Hide edit post link if mobile app.
634
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
635
			add_filter( 'edit_post_link', '__return_empty_string' );
636
		}
637
638
		// Update the Jetpack plan from API on heartbeats
639
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
640
641
		/**
642
		 * This is the hack to concatenate all css files into one.
643
		 * For description and reasoning see the implode_frontend_css method
644
		 *
645
		 * Super late priority so we catch all the registered styles
646
		 */
647
		if ( ! is_admin() ) {
648
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
649
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
650
		}
651
652
		/**
653
		 * These are sync actions that we need to keep track of for jitms
654
		 */
655
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
656
657
		// Actually push the stats on shutdown.
658
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
659
			add_action( 'shutdown', array( $this, 'push_stats' ) );
660
		}
661
662
		/*
663
		 * Load some scripts asynchronously.
664
		 */
665
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
666
667
		// Actions for Manager::authorize().
668
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
669
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
670
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
671
672
		// Filters for the Manager::get_token() urls and request body.
673
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
674
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
675
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
676
	}
677
678
	/**
679
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
680
	 * Config object.
681
	 */
682
	public function configure() {
683
		$config = new Config();
684
685
		foreach (
686
			array(
687
				'connection',
688
				'sync',
689
				'tracking',
690
				'tos',
691
			)
692
			as $feature
693
		) {
694
			$config->ensure( $feature );
695
		}
696
697
		if ( is_admin() ) {
698
			$config->ensure( 'jitm' );
699
		}
700
701
		$this->connection_manager = new Connection_Manager();
702
703
		/*
704
		 * Load things that should only be in Network Admin.
705
		 *
706
		 * For now blow away everything else until a more full
707
		 * understanding of what is needed at the network level is
708
		 * available
709
		 */
710
		if ( is_multisite() ) {
711
			$network = Jetpack_Network::init();
712
			$network->set_connection( $this->connection_manager );
713
		}
714
715
		if ( $this->connection_manager->is_active() ) {
716
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
717
718
			Jetpack_Heartbeat::init();
719
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
720
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
721
				Jetpack_Search_Performance_Logger::init();
722
			}
723
		}
724
725
		// Initialize remote file upload request handlers.
726
		$this->add_remote_request_handlers();
727
728
		/*
729
		 * Enable enhanced handling of previewing sites in Calypso
730
		 */
731
		if ( self::is_active() ) {
732
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
733
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
734
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
735
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
736
		}
737
738
		/*
739
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
740
		 * We should make sure to only do this for front end links.
741
		 */
742
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
743
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
744
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
745
746
			/*
747
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
748
			 * so they point moderation links on emails to Calypso.
749
			 */
750
			jetpack_require_lib( 'functions.wp-notify' );
751
		}
752
753
	}
754
755
	/**
756
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
757
	 * initialization code.
758
	 *
759
	 * @action plugins_loaded
760
	 */
761
	public function late_initialization() {
762
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
763
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
764
765
		Partner::init();
766
767
		/**
768
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
769
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
770
		 *
771
		 * @since 8.1.0
772
		 *
773
		 * @param Jetpack $jetpack the main plugin class object.
774
		 */
775
		do_action( 'jetpack_loaded', $this );
776
777
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
778
	}
779
780
	/**
781
	 * Sets up the XMLRPC request handlers.
782
	 *
783
	 * @deprecated since 7.7.0
784
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
785
	 *
786
	 * @param Array                 $request_params Incoming request parameters.
787
	 * @param Boolean               $is_active      Whether the connection is currently active.
788
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
789
	 * @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...
790
	 */
791
	public function setup_xmlrpc_handlers(
792
		$request_params,
793
		$is_active,
794
		$is_signed,
795
		Jetpack_XMLRPC_Server $xmlrpc_server = null
796
	) {
797
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
798
		return $this->connection_manager->setup_xmlrpc_handlers(
799
			$request_params,
800
			$is_active,
801
			$is_signed,
802
			$xmlrpc_server
803
		);
804
	}
805
806
	/**
807
	 * Initialize REST API registration connector.
808
	 *
809
	 * @deprecated since 7.7.0
810
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
811
	 */
812
	public function initialize_rest_api_registration_connector() {
813
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
814
		$this->connection_manager->initialize_rest_api_registration_connector();
815
	}
816
817
	/**
818
	 * This is ported over from the manage module, which has been deprecated and baked in here.
819
	 *
820
	 * @param $domains
821
	 */
822
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
823
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
824
	}
825
826
	/**
827
	 * Return $domains, with 'wordpress.com' appended.
828
	 * This is ported over from the manage module, which has been deprecated and baked in here.
829
	 *
830
	 * @param $domains
831
	 * @return array
832
	 */
833
	function allow_wpcom_domain( $domains ) {
834
		if ( empty( $domains ) ) {
835
			$domains = array();
836
		}
837
		$domains[] = 'wordpress.com';
838
		return array_unique( $domains );
839
	}
840
841
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
842
		$post = get_post( $post_id );
843
844
		if ( empty( $post ) ) {
845
			return $default_url;
846
		}
847
848
		$post_type = $post->post_type;
849
850
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
851
		// https://en.support.wordpress.com/custom-post-types/
852
		$allowed_post_types = array(
853
			'post'                => 'post',
854
			'page'                => 'page',
855
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
856
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
857
		);
858
859
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
860
			return $default_url;
861
		}
862
863
		$path_prefix = $allowed_post_types[ $post_type ];
864
865
		$site_slug = self::build_raw_urls( get_home_url() );
866
867
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
868
	}
869
870
	function point_edit_comment_links_to_calypso( $url ) {
871
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
872
		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...
873
		return esc_url(
874
			sprintf(
875
				'https://wordpress.com/comment/%s/%d',
876
				self::build_raw_urls( get_home_url() ),
877
				$query_args['amp;c']
878
			)
879
		);
880
	}
881
882
	function jetpack_track_last_sync_callback( $params ) {
883
		/**
884
		 * Filter to turn off jitm caching
885
		 *
886
		 * @since 5.4.0
887
		 *
888
		 * @param bool false Whether to cache just in time messages
889
		 */
890
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
891
			return $params;
892
		}
893
894
		if ( is_array( $params ) && isset( $params[0] ) ) {
895
			$option = $params[0];
896
			if ( 'active_plugins' === $option ) {
897
				// use the cache if we can, but not terribly important if it gets evicted
898
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
899
			}
900
		}
901
902
		return $params;
903
	}
904
905
	function jetpack_connection_banner_callback() {
906
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
907
908
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
909
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
910
			wp_send_json_success();
911
		}
912
913
		wp_die();
914
	}
915
916
	/**
917
	 * Removes all XML-RPC methods that are not `jetpack.*`.
918
	 * Only used in our alternate XML-RPC endpoint, where we want to
919
	 * ensure that Core and other plugins' methods are not exposed.
920
	 *
921
	 * @deprecated since 7.7.0
922
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
923
	 *
924
	 * @param array $methods A list of registered WordPress XMLRPC methods.
925
	 * @return array Filtered $methods
926
	 */
927
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
928
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
929
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
930
	}
931
932
	/**
933
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
934
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
935
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
936
	 * which is accessible via a different URI. Most of the below is copied directly
937
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
938
	 *
939
	 * @deprecated since 7.7.0
940
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
941
	 */
942
	public function alternate_xmlrpc() {
943
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
944
		$this->connection_manager->alternate_xmlrpc();
945
	}
946
947
	/**
948
	 * The callback for the JITM ajax requests.
949
	 *
950
	 * @deprecated since 7.9.0
951
	 */
952
	function jetpack_jitm_ajax_callback() {
953
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
954
	}
955
956
	/**
957
	 * If there are any stats that need to be pushed, but haven't been, push them now.
958
	 */
959
	function push_stats() {
960
		if ( ! empty( $this->stats ) ) {
961
			$this->do_stats( 'server_side' );
962
		}
963
	}
964
965
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
966
		$is_development_mode = ( new Status() )->is_development_mode();
967
		switch ( $cap ) {
968
			case 'jetpack_connect':
969
			case 'jetpack_reconnect':
970
				if ( $is_development_mode ) {
971
					$caps = array( 'do_not_allow' );
972
					break;
973
				}
974
				/**
975
				 * Pass through. If it's not development mode, these should match disconnect.
976
				 * Let users disconnect if it's development mode, just in case things glitch.
977
				 */
978
			case 'jetpack_disconnect':
979
				/**
980
				 * In multisite, can individual site admins manage their own connection?
981
				 *
982
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
983
				 */
984
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
985
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
986
						/**
987
						 * We need to update the option name -- it's terribly unclear which
988
						 * direction the override goes.
989
						 *
990
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
991
						 */
992
						$caps = array( 'do_not_allow' );
993
						break;
994
					}
995
				}
996
997
				$caps = array( 'manage_options' );
998
				break;
999
			case 'jetpack_manage_modules':
1000
			case 'jetpack_activate_modules':
1001
			case 'jetpack_deactivate_modules':
1002
				$caps = array( 'manage_options' );
1003
				break;
1004
			case 'jetpack_configure_modules':
1005
				$caps = array( 'manage_options' );
1006
				break;
1007
			case 'jetpack_manage_autoupdates':
1008
				$caps = array(
1009
					'manage_options',
1010
					'update_plugins',
1011
				);
1012
				break;
1013
			case 'jetpack_network_admin_page':
1014
			case 'jetpack_network_settings_page':
1015
				$caps = array( 'manage_network_plugins' );
1016
				break;
1017
			case 'jetpack_network_sites_page':
1018
				$caps = array( 'manage_sites' );
1019
				break;
1020
			case 'jetpack_admin_page':
1021
				if ( $is_development_mode ) {
1022
					$caps = array( 'manage_options' );
1023
					break;
1024
				} else {
1025
					$caps = array( 'read' );
1026
				}
1027
				break;
1028
			case 'jetpack_connect_user':
1029
				if ( $is_development_mode ) {
1030
					$caps = array( 'do_not_allow' );
1031
					break;
1032
				}
1033
				$caps = array( 'read' );
1034
				break;
1035
		}
1036
		return $caps;
1037
	}
1038
1039
	/**
1040
	 * Require a Jetpack authentication.
1041
	 *
1042
	 * @deprecated since 7.7.0
1043
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1044
	 */
1045
	public function require_jetpack_authentication() {
1046
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1047
		$this->connection_manager->require_jetpack_authentication();
1048
	}
1049
1050
	/**
1051
	 * Load language files
1052
	 *
1053
	 * @action plugins_loaded
1054
	 */
1055
	public static function plugin_textdomain() {
1056
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1057
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1058
	}
1059
1060
	/**
1061
	 * Register assets for use in various modules and the Jetpack admin page.
1062
	 *
1063
	 * @uses wp_script_is, wp_register_script, plugins_url
1064
	 * @action wp_loaded
1065
	 * @return null
1066
	 */
1067
	public function register_assets() {
1068
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1069
			wp_register_script(
1070
				'spin',
1071
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1072
				false,
1073
				'1.3'
1074
			);
1075
		}
1076
1077 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1078
			wp_register_script(
1079
				'jquery.spin',
1080
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1081
				array( 'jquery', 'spin' ),
1082
				'1.3'
1083
			);
1084
		}
1085
1086 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1087
			wp_register_script(
1088
				'jetpack-gallery-settings',
1089
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1090
				array( 'media-views' ),
1091
				'20121225'
1092
			);
1093
		}
1094
1095 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1096
			wp_register_script(
1097
				'jetpack-twitter-timeline',
1098
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1099
				array( 'jquery' ),
1100
				'4.0.0',
1101
				true
1102
			);
1103
		}
1104
1105
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1106
			wp_register_script(
1107
				'jetpack-facebook-embed',
1108
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1109
				array( 'jquery' ),
1110
				null,
1111
				true
1112
			);
1113
1114
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1115
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1116
			if ( ! is_numeric( $fb_app_id ) ) {
1117
				$fb_app_id = '';
1118
			}
1119
			wp_localize_script(
1120
				'jetpack-facebook-embed',
1121
				'jpfbembed',
1122
				array(
1123
					'appid'  => $fb_app_id,
1124
					'locale' => $this->get_locale(),
1125
				)
1126
			);
1127
		}
1128
1129
		/**
1130
		 * As jetpack_register_genericons is by default fired off a hook,
1131
		 * the hook may have already fired by this point.
1132
		 * So, let's just trigger it manually.
1133
		 */
1134
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1135
		jetpack_register_genericons();
1136
1137
		/**
1138
		 * Register the social logos
1139
		 */
1140
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1141
		jetpack_register_social_logos();
1142
1143 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1144
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1145
		}
1146
	}
1147
1148
	/**
1149
	 * Guess locale from language code.
1150
	 *
1151
	 * @param string $lang Language code.
1152
	 * @return string|bool
1153
	 */
1154 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1155
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1156
			return 'en_US';
1157
		}
1158
1159
		if ( ! class_exists( 'GP_Locales' ) ) {
1160
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1161
				return false;
1162
			}
1163
1164
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1165
		}
1166
1167
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1168
			// WP.com: get_locale() returns 'it'
1169
			$locale = GP_Locales::by_slug( $lang );
1170
		} else {
1171
			// Jetpack: get_locale() returns 'it_IT';
1172
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1173
		}
1174
1175
		if ( ! $locale ) {
1176
			return false;
1177
		}
1178
1179
		if ( empty( $locale->facebook_locale ) ) {
1180
			if ( empty( $locale->wp_locale ) ) {
1181
				return false;
1182
			} else {
1183
				// Facebook SDK is smart enough to fall back to en_US if a
1184
				// locale isn't supported. Since supported Facebook locales
1185
				// can fall out of sync, we'll attempt to use the known
1186
				// wp_locale value and rely on said fallback.
1187
				return $locale->wp_locale;
1188
			}
1189
		}
1190
1191
		return $locale->facebook_locale;
1192
	}
1193
1194
	/**
1195
	 * Get the locale.
1196
	 *
1197
	 * @return string|bool
1198
	 */
1199
	function get_locale() {
1200
		$locale = $this->guess_locale_from_lang( get_locale() );
1201
1202
		if ( ! $locale ) {
1203
			$locale = 'en_US';
1204
		}
1205
1206
		return $locale;
1207
	}
1208
1209
	/**
1210
	 * Return the network_site_url so that .com knows what network this site is a part of.
1211
	 *
1212
	 * @param  bool $option
1213
	 * @return string
1214
	 */
1215
	public function jetpack_main_network_site_option( $option ) {
1216
		return network_site_url();
1217
	}
1218
	/**
1219
	 * Network Name.
1220
	 */
1221
	static function network_name( $option = null ) {
1222
		global $current_site;
1223
		return $current_site->site_name;
1224
	}
1225
	/**
1226
	 * Does the network allow new user and site registrations.
1227
	 *
1228
	 * @return string
1229
	 */
1230
	static function network_allow_new_registrations( $option = null ) {
1231
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1232
	}
1233
	/**
1234
	 * Does the network allow admins to add new users.
1235
	 *
1236
	 * @return boolian
1237
	 */
1238
	static function network_add_new_users( $option = null ) {
1239
		return (bool) get_site_option( 'add_new_users' );
1240
	}
1241
	/**
1242
	 * File upload psace left per site in MB.
1243
	 *  -1 means NO LIMIT.
1244
	 *
1245
	 * @return number
1246
	 */
1247
	static function network_site_upload_space( $option = null ) {
1248
		// value in MB
1249
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1250
	}
1251
1252
	/**
1253
	 * Network allowed file types.
1254
	 *
1255
	 * @return string
1256
	 */
1257
	static function network_upload_file_types( $option = null ) {
1258
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1259
	}
1260
1261
	/**
1262
	 * Maximum file upload size set by the network.
1263
	 *
1264
	 * @return number
1265
	 */
1266
	static function network_max_upload_file_size( $option = null ) {
1267
		// value in KB
1268
		return get_site_option( 'fileupload_maxk', 300 );
1269
	}
1270
1271
	/**
1272
	 * Lets us know if a site allows admins to manage the network.
1273
	 *
1274
	 * @return array
1275
	 */
1276
	static function network_enable_administration_menus( $option = null ) {
1277
		return get_site_option( 'menu_items' );
1278
	}
1279
1280
	/**
1281
	 * If a user has been promoted to or demoted from admin, we need to clear the
1282
	 * jetpack_other_linked_admins transient.
1283
	 *
1284
	 * @since 4.3.2
1285
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1286
	 *
1287
	 * @param int    $user_id   The user ID whose role changed.
1288
	 * @param string $role      The new role.
1289
	 * @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...
1290
	 */
1291
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1292
		if ( 'administrator' == $role
1293
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1294
			|| is_null( $old_roles )
1295
		) {
1296
			delete_transient( 'jetpack_other_linked_admins' );
1297
		}
1298
	}
1299
1300
	/**
1301
	 * Checks to see if there are any other users available to become primary
1302
	 * Users must both:
1303
	 * - Be linked to wpcom
1304
	 * - Be an admin
1305
	 *
1306
	 * @return mixed False if no other users are linked, Int if there are.
1307
	 */
1308
	static function get_other_linked_admins() {
1309
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1310
1311
		if ( false === $other_linked_users ) {
1312
			$admins = get_users( array( 'role' => 'administrator' ) );
1313
			if ( count( $admins ) > 1 ) {
1314
				$available = array();
1315
				foreach ( $admins as $admin ) {
1316
					if ( self::is_user_connected( $admin->ID ) ) {
1317
						$available[] = $admin->ID;
1318
					}
1319
				}
1320
1321
				$count_connected_admins = count( $available );
1322
				if ( count( $available ) > 1 ) {
1323
					$other_linked_users = $count_connected_admins;
1324
				} else {
1325
					$other_linked_users = 0;
1326
				}
1327
			} else {
1328
				$other_linked_users = 0;
1329
			}
1330
1331
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1332
		}
1333
1334
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1335
	}
1336
1337
	/**
1338
	 * Return whether we are dealing with a multi network setup or not.
1339
	 * The reason we are type casting this is because we want to avoid the situation where
1340
	 * the result is false since when is_main_network_option return false it cases
1341
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1342
	 * database which could be set to anything as opposed to what this function returns.
1343
	 *
1344
	 * @param  bool $option
1345
	 *
1346
	 * @return boolean
1347
	 */
1348
	public function is_main_network_option( $option ) {
1349
		// return '1' or ''
1350
		return (string) (bool) self::is_multi_network();
1351
	}
1352
1353
	/**
1354
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1355
	 *
1356
	 * @param  string $option
1357
	 * @return boolean
1358
	 */
1359
	public function is_multisite( $option ) {
1360
		return (string) (bool) is_multisite();
1361
	}
1362
1363
	/**
1364
	 * Implemented since there is no core is multi network function
1365
	 * Right now there is no way to tell if we which network is the dominant network on the system
1366
	 *
1367
	 * @since  3.3
1368
	 * @return boolean
1369
	 */
1370 View Code Duplication
	public static function is_multi_network() {
1371
		global  $wpdb;
1372
1373
		// if we don't have a multi site setup no need to do any more
1374
		if ( ! is_multisite() ) {
1375
			return false;
1376
		}
1377
1378
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1379
		if ( $num_sites > 1 ) {
1380
			return true;
1381
		} else {
1382
			return false;
1383
		}
1384
	}
1385
1386
	/**
1387
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1388
	 *
1389
	 * @return null
1390
	 */
1391
	function update_jetpack_main_network_site_option() {
1392
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1393
	}
1394
	/**
1395
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1396
	 */
1397
	function update_jetpack_network_settings() {
1398
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1399
		// Only sync this info for the main network site.
1400
	}
1401
1402
	/**
1403
	 * Get back if the current site is single user site.
1404
	 *
1405
	 * @return bool
1406
	 */
1407 View Code Duplication
	public static function is_single_user_site() {
1408
		global $wpdb;
1409
1410
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1411
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1412
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1413
		}
1414
		return 1 === (int) $some_users;
1415
	}
1416
1417
	/**
1418
	 * Returns true if the site has file write access false otherwise.
1419
	 *
1420
	 * @return string ( '1' | '0' )
1421
	 **/
1422
	public static function file_system_write_access() {
1423
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1424
			require_once ABSPATH . 'wp-admin/includes/file.php';
1425
		}
1426
1427
		require_once ABSPATH . 'wp-admin/includes/template.php';
1428
1429
		$filesystem_method = get_filesystem_method();
1430
		if ( $filesystem_method === 'direct' ) {
1431
			return 1;
1432
		}
1433
1434
		ob_start();
1435
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1436
		ob_end_clean();
1437
		if ( $filesystem_credentials_are_stored ) {
1438
			return 1;
1439
		}
1440
		return 0;
1441
	}
1442
1443
	/**
1444
	 * Finds out if a site is using a version control system.
1445
	 *
1446
	 * @return string ( '1' | '0' )
1447
	 **/
1448
	public static function is_version_controlled() {
1449
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1450
		return (string) (int) Functions::is_version_controlled();
1451
	}
1452
1453
	/**
1454
	 * Determines whether the current theme supports featured images or not.
1455
	 *
1456
	 * @return string ( '1' | '0' )
1457
	 */
1458
	public static function featured_images_enabled() {
1459
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1460
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1461
	}
1462
1463
	/**
1464
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1465
	 *
1466
	 * @deprecated 4.7 use get_avatar_url instead.
1467
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1468
	 * @param int               $size Size of the avatar image
1469
	 * @param string            $default URL to a default image to use if no avatar is available
1470
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1471
	 *
1472
	 * @return array
1473
	 */
1474
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1475
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1476
		return get_avatar_url(
1477
			$id_or_email,
1478
			array(
1479
				'size'          => $size,
1480
				'default'       => $default,
1481
				'force_default' => $force_display,
1482
			)
1483
		);
1484
	}
1485
1486
	/**
1487
	 * jetpack_updates is saved in the following schema:
1488
	 *
1489
	 * array (
1490
	 *      'plugins'                       => (int) Number of plugin updates available.
1491
	 *      'themes'                        => (int) Number of theme updates available.
1492
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1493
	 *      'translations'                  => (int) Number of translation updates available.
1494
	 *      'total'                         => (int) Total of all available updates.
1495
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1496
	 * )
1497
	 *
1498
	 * @return array
1499
	 */
1500
	public static function get_updates() {
1501
		$update_data = wp_get_update_data();
1502
1503
		// Stores the individual update counts as well as the total count.
1504
		if ( isset( $update_data['counts'] ) ) {
1505
			$updates = $update_data['counts'];
1506
		}
1507
1508
		// If we need to update WordPress core, let's find the latest version number.
1509 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1510
			$cur = get_preferred_from_update_core();
1511
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1512
				$updates['wp_update_version'] = $cur->current;
1513
			}
1514
		}
1515
		return isset( $updates ) ? $updates : array();
1516
	}
1517
1518
	public static function get_update_details() {
1519
		$update_details = array(
1520
			'update_core'    => get_site_transient( 'update_core' ),
1521
			'update_plugins' => get_site_transient( 'update_plugins' ),
1522
			'update_themes'  => get_site_transient( 'update_themes' ),
1523
		);
1524
		return $update_details;
1525
	}
1526
1527
	public static function refresh_update_data() {
1528
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1529
1530
	}
1531
1532
	public static function refresh_theme_data() {
1533
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1534
	}
1535
1536
	/**
1537
	 * Is Jetpack active?
1538
	 */
1539
	public static function is_active() {
1540
		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...
1541
	}
1542
1543
	/**
1544
	 * Make an API call to WordPress.com for plan status
1545
	 *
1546
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1547
	 *
1548
	 * @return bool True if plan is updated, false if no update
1549
	 */
1550
	public static function refresh_active_plan_from_wpcom() {
1551
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1552
		return Jetpack_Plan::refresh_from_wpcom();
1553
	}
1554
1555
	/**
1556
	 * Get the plan that this Jetpack site is currently using
1557
	 *
1558
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1559
	 * @return array Active Jetpack plan details.
1560
	 */
1561
	public static function get_active_plan() {
1562
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1563
		return Jetpack_Plan::get();
1564
	}
1565
1566
	/**
1567
	 * Determine whether the active plan supports a particular feature
1568
	 *
1569
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1570
	 * @return bool True if plan supports feature, false if not.
1571
	 */
1572
	public static function active_plan_supports( $feature ) {
1573
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1574
		return Jetpack_Plan::supports( $feature );
1575
	}
1576
1577
	/**
1578
	 * Deprecated: Is Jetpack in development (offline) mode?
1579
	 *
1580
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1581
	 * and themes still use it, and we do not want to flood them with notices.
1582
	 *
1583
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1584
	 *
1585
	 * @deprecated since 8.0.
1586
	 */
1587
	public static function is_development_mode() {
1588
		return ( new Status() )->is_development_mode();
1589
	}
1590
1591
	/**
1592
	 * Whether the site is currently onboarding or not.
1593
	 * A site is considered as being onboarded if it currently has an onboarding token.
1594
	 *
1595
	 * @since 5.8
1596
	 *
1597
	 * @access public
1598
	 * @static
1599
	 *
1600
	 * @return bool True if the site is currently onboarding, false otherwise
1601
	 */
1602
	public static function is_onboarding() {
1603
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1604
	}
1605
1606
	/**
1607
	 * Determines reason for Jetpack development mode.
1608
	 */
1609
	public static function development_mode_trigger_text() {
1610
		if ( ! ( new Status() )->is_development_mode() ) {
1611
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1612
		}
1613
1614
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1615
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1616
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1617
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1618
		} else {
1619
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1620
		}
1621
1622
		return $notice;
1623
1624
	}
1625
	/**
1626
	 * Get Jetpack development mode notice text and notice class.
1627
	 *
1628
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1629
	 */
1630
	public static function show_development_mode_notice() {
1631 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1632
			$notice = sprintf(
1633
				/* translators: %s is a URL */
1634
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1635
				'https://jetpack.com/support/development-mode/'
1636
			);
1637
1638
			$notice .= ' ' . self::development_mode_trigger_text();
1639
1640
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1641
		}
1642
1643
		// Throw up a notice if using a development version and as for feedback.
1644
		if ( self::is_development_version() ) {
1645
			/* translators: %s is a URL */
1646
			$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/' );
1647
1648
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1649
		}
1650
		// Throw up a notice if using staging mode
1651
		if ( ( new Status() )->is_staging_site() ) {
1652
			/* translators: %s is a URL */
1653
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1654
1655
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1656
		}
1657
	}
1658
1659
	/**
1660
	 * Whether Jetpack's version maps to a public release, or a development version.
1661
	 */
1662
	public static function is_development_version() {
1663
		/**
1664
		 * Allows filtering whether this is a development version of Jetpack.
1665
		 *
1666
		 * This filter is especially useful for tests.
1667
		 *
1668
		 * @since 4.3.0
1669
		 *
1670
		 * @param bool $development_version Is this a develoment version of Jetpack?
1671
		 */
1672
		return (bool) apply_filters(
1673
			'jetpack_development_version',
1674
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1675
		);
1676
	}
1677
1678
	/**
1679
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1680
	 */
1681
	public static function is_user_connected( $user_id = false ) {
1682
		return self::connection()->is_user_connected( $user_id );
1683
	}
1684
1685
	/**
1686
	 * Get the wpcom user data of the current|specified connected user.
1687
	 */
1688 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1689
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1690
		if ( ! $user_id ) {
1691
			$user_id = get_current_user_id();
1692
		}
1693
1694
		$transient_key = "jetpack_connected_user_data_$user_id";
1695
1696
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1697
			return $cached_user_data;
1698
		}
1699
1700
		$xml = new Jetpack_IXR_Client(
1701
			array(
1702
				'user_id' => $user_id,
1703
			)
1704
		);
1705
		$xml->query( 'wpcom.getUser' );
1706
		if ( ! $xml->isError() ) {
1707
			$user_data = $xml->getResponse();
1708
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1709
			return $user_data;
1710
		}
1711
1712
		return false;
1713
	}
1714
1715
	/**
1716
	 * Get the wpcom email of the current|specified connected user.
1717
	 */
1718 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1719
		if ( ! $user_id ) {
1720
			$user_id = get_current_user_id();
1721
		}
1722
1723
		$xml = new Jetpack_IXR_Client(
1724
			array(
1725
				'user_id' => $user_id,
1726
			)
1727
		);
1728
		$xml->query( 'wpcom.getUserEmail' );
1729
		if ( ! $xml->isError() ) {
1730
			return $xml->getResponse();
1731
		}
1732
		return false;
1733
	}
1734
1735
	/**
1736
	 * Get the wpcom email of the master user.
1737
	 */
1738
	public static function get_master_user_email() {
1739
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1740
		if ( $master_user_id ) {
1741
			return self::get_connected_user_email( $master_user_id );
1742
		}
1743
		return '';
1744
	}
1745
1746
	/**
1747
	 * Whether the current user is the connection owner.
1748
	 *
1749
	 * @deprecated since 7.7
1750
	 *
1751
	 * @return bool Whether the current user is the connection owner.
1752
	 */
1753
	public function current_user_is_connection_owner() {
1754
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1755
		return self::connection()->is_connection_owner();
1756
	}
1757
1758
	/**
1759
	 * Gets current user IP address.
1760
	 *
1761
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1762
	 *
1763
	 * @return string                  Current user IP address.
1764
	 */
1765
	public static function current_user_ip( $check_all_headers = false ) {
1766
		if ( $check_all_headers ) {
1767
			foreach ( array(
1768
				'HTTP_CF_CONNECTING_IP',
1769
				'HTTP_CLIENT_IP',
1770
				'HTTP_X_FORWARDED_FOR',
1771
				'HTTP_X_FORWARDED',
1772
				'HTTP_X_CLUSTER_CLIENT_IP',
1773
				'HTTP_FORWARDED_FOR',
1774
				'HTTP_FORWARDED',
1775
				'HTTP_VIA',
1776
			) as $key ) {
1777
				if ( ! empty( $_SERVER[ $key ] ) ) {
1778
					return $_SERVER[ $key ];
1779
				}
1780
			}
1781
		}
1782
1783
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1784
	}
1785
1786
	/**
1787
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1788
	 */
1789
	function extra_oembed_providers() {
1790
		// Cloudup: https://dev.cloudup.com/#oembed
1791
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1792
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1793
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1794
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1795
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1796
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1797
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1798
	}
1799
1800
	/**
1801
	 * Synchronize connected user role changes
1802
	 */
1803
	function user_role_change( $user_id ) {
1804
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1805
		Users::user_role_change( $user_id );
1806
	}
1807
1808
	/**
1809
	 * Loads the currently active modules.
1810
	 */
1811
	public static function load_modules() {
1812
		$is_development_mode = ( new Status() )->is_development_mode();
1813
		if (
1814
			! self::is_active()
1815
			&& ! $is_development_mode
1816
			&& ! self::is_onboarding()
1817
			&& (
1818
				! is_multisite()
1819
				|| ! get_site_option( 'jetpack_protect_active' )
1820
			)
1821
		) {
1822
			return;
1823
		}
1824
1825
		$version = Jetpack_Options::get_option( 'version' );
1826 View Code Duplication
		if ( ! $version ) {
1827
			$version = $old_version = JETPACK__VERSION . ':' . time();
1828
			/** This action is documented in class.jetpack.php */
1829
			do_action( 'updating_jetpack_version', $version, false );
1830
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1831
		}
1832
		list( $version ) = explode( ':', $version );
1833
1834
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1835
1836
		$modules_data = array();
1837
1838
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1839
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1840
			$updated_modules = array();
1841
			foreach ( $modules as $module ) {
1842
				$modules_data[ $module ] = self::get_module( $module );
1843
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1844
					continue;
1845
				}
1846
1847
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1848
					continue;
1849
				}
1850
1851
				$updated_modules[] = $module;
1852
			}
1853
1854
			$modules = array_diff( $modules, $updated_modules );
1855
		}
1856
1857
		foreach ( $modules as $index => $module ) {
1858
			// If we're in dev mode, disable modules requiring a connection
1859
			if ( $is_development_mode ) {
1860
				// Prime the pump if we need to
1861
				if ( empty( $modules_data[ $module ] ) ) {
1862
					$modules_data[ $module ] = self::get_module( $module );
1863
				}
1864
				// If the module requires a connection, but we're in local mode, don't include it.
1865
				if ( $modules_data[ $module ]['requires_connection'] ) {
1866
					continue;
1867
				}
1868
			}
1869
1870
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1871
				continue;
1872
			}
1873
1874
			if ( ! include_once self::get_module_path( $module ) ) {
1875
				unset( $modules[ $index ] );
1876
				self::update_active_modules( array_values( $modules ) );
1877
				continue;
1878
			}
1879
1880
			/**
1881
			 * Fires when a specific module is loaded.
1882
			 * The dynamic part of the hook, $module, is the module slug.
1883
			 *
1884
			 * @since 1.1.0
1885
			 */
1886
			do_action( 'jetpack_module_loaded_' . $module );
1887
		}
1888
1889
		/**
1890
		 * Fires when all the modules are loaded.
1891
		 *
1892
		 * @since 1.1.0
1893
		 */
1894
		do_action( 'jetpack_modules_loaded' );
1895
1896
		// Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
1897
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1898
	}
1899
1900
	/**
1901
	 * Check if Jetpack's REST API compat file should be included
1902
	 *
1903
	 * @action plugins_loaded
1904
	 * @return null
1905
	 */
1906
	public function check_rest_api_compat() {
1907
		/**
1908
		 * Filters the list of REST API compat files to be included.
1909
		 *
1910
		 * @since 2.2.5
1911
		 *
1912
		 * @param array $args Array of REST API compat files to include.
1913
		 */
1914
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1915
1916
		if ( function_exists( 'bbpress' ) ) {
1917
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1918
		}
1919
1920
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1921
			require_once $_jetpack_rest_api_compat_include;
1922
		}
1923
	}
1924
1925
	/**
1926
	 * Gets all plugins currently active in values, regardless of whether they're
1927
	 * traditionally activated or network activated.
1928
	 *
1929
	 * @todo Store the result in core's object cache maybe?
1930
	 */
1931
	public static function get_active_plugins() {
1932
		$active_plugins = (array) get_option( 'active_plugins', array() );
1933
1934
		if ( is_multisite() ) {
1935
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1936
			// whereas active_plugins stores them in the values.
1937
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1938
			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...
1939
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1940
			}
1941
		}
1942
1943
		sort( $active_plugins );
1944
1945
		return array_unique( $active_plugins );
1946
	}
1947
1948
	/**
1949
	 * Gets and parses additional plugin data to send with the heartbeat data
1950
	 *
1951
	 * @since 3.8.1
1952
	 *
1953
	 * @return array Array of plugin data
1954
	 */
1955
	public static function get_parsed_plugin_data() {
1956
		if ( ! function_exists( 'get_plugins' ) ) {
1957
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1958
		}
1959
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1960
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1961
		$active_plugins = self::get_active_plugins();
1962
1963
		$plugins = array();
1964
		foreach ( $all_plugins as $path => $plugin_data ) {
1965
			$plugins[ $path ] = array(
1966
				'is_active' => in_array( $path, $active_plugins ),
1967
				'file'      => $path,
1968
				'name'      => $plugin_data['Name'],
1969
				'version'   => $plugin_data['Version'],
1970
				'author'    => $plugin_data['Author'],
1971
			);
1972
		}
1973
1974
		return $plugins;
1975
	}
1976
1977
	/**
1978
	 * Gets and parses theme data to send with the heartbeat data
1979
	 *
1980
	 * @since 3.8.1
1981
	 *
1982
	 * @return array Array of theme data
1983
	 */
1984
	public static function get_parsed_theme_data() {
1985
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1986
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1987
1988
		$themes = array();
1989
		foreach ( $all_themes as $slug => $theme_data ) {
1990
			$theme_headers = array();
1991
			foreach ( $header_keys as $header_key ) {
1992
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1993
			}
1994
1995
			$themes[ $slug ] = array(
1996
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
1997
				'slug'            => $slug,
1998
				'theme_root'      => $theme_data->get_theme_root_uri(),
1999
				'parent'          => $theme_data->parent(),
2000
				'headers'         => $theme_headers,
2001
			);
2002
		}
2003
2004
		return $themes;
2005
	}
2006
2007
	/**
2008
	 * Checks whether a specific plugin is active.
2009
	 *
2010
	 * We don't want to store these in a static variable, in case
2011
	 * there are switch_to_blog() calls involved.
2012
	 */
2013
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2014
		return in_array( $plugin, self::get_active_plugins() );
2015
	}
2016
2017
	/**
2018
	 * Check if Jetpack's Open Graph tags should be used.
2019
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2020
	 *
2021
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2022
	 * @action plugins_loaded
2023
	 * @return null
2024
	 */
2025
	public function check_open_graph() {
2026
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2027
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2028
		}
2029
2030
		$active_plugins = self::get_active_plugins();
2031
2032
		if ( ! empty( $active_plugins ) ) {
2033
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2034
				if ( in_array( $plugin, $active_plugins ) ) {
2035
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2036
					break;
2037
				}
2038
			}
2039
		}
2040
2041
		/**
2042
		 * Allow the addition of Open Graph Meta Tags to all pages.
2043
		 *
2044
		 * @since 2.0.3
2045
		 *
2046
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2047
		 */
2048
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2049
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2050
		}
2051
	}
2052
2053
	/**
2054
	 * Check if Jetpack's Twitter tags should be used.
2055
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2056
	 *
2057
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2058
	 * @action plugins_loaded
2059
	 * @return null
2060
	 */
2061
	public function check_twitter_tags() {
2062
2063
		$active_plugins = self::get_active_plugins();
2064
2065
		if ( ! empty( $active_plugins ) ) {
2066
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2067
				if ( in_array( $plugin, $active_plugins ) ) {
2068
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2069
					break;
2070
				}
2071
			}
2072
		}
2073
2074
		/**
2075
		 * Allow Twitter Card Meta tags to be disabled.
2076
		 *
2077
		 * @since 2.6.0
2078
		 *
2079
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2080
		 */
2081
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2082
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2083
		}
2084
	}
2085
2086
	/**
2087
	 * Allows plugins to submit security reports.
2088
	 *
2089
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2090
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2091
	 * @param array  $args         See definitions above
2092
	 */
2093
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2094
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2095
	}
2096
2097
	/* Jetpack Options API */
2098
2099
	public static function get_option_names( $type = 'compact' ) {
2100
		return Jetpack_Options::get_option_names( $type );
2101
	}
2102
2103
	/**
2104
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2105
	 *
2106
	 * @param string $name    Option name
2107
	 * @param mixed  $default (optional)
2108
	 */
2109
	public static function get_option( $name, $default = false ) {
2110
		return Jetpack_Options::get_option( $name, $default );
2111
	}
2112
2113
	/**
2114
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2115
	 *
2116
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2117
	 * @param string $name  Option name
2118
	 * @param mixed  $value Option value
2119
	 */
2120
	public static function update_option( $name, $value ) {
2121
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2122
		return Jetpack_Options::update_option( $name, $value );
2123
	}
2124
2125
	/**
2126
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2127
	 *
2128
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2129
	 * @param array $array array( option name => option value, ... )
2130
	 */
2131
	public static function update_options( $array ) {
2132
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2133
		return Jetpack_Options::update_options( $array );
2134
	}
2135
2136
	/**
2137
	 * Deletes the given option.  May be passed multiple option names as an array.
2138
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2139
	 *
2140
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2141
	 * @param string|array $names
2142
	 */
2143
	public static function delete_option( $names ) {
2144
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2145
		return Jetpack_Options::delete_option( $names );
2146
	}
2147
2148
	/**
2149
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2150
	 *
2151
	 * Enters a user token into the user_tokens option
2152
	 *
2153
	 * @param int    $user_id The user id.
2154
	 * @param string $token The user token.
2155
	 * @param bool   $is_master_user Whether the user is the master user.
2156
	 * @return bool
2157
	 */
2158
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2159
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2160
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2161
	}
2162
2163
	/**
2164
	 * Returns an array of all PHP files in the specified absolute path.
2165
	 * Equivalent to glob( "$absolute_path/*.php" ).
2166
	 *
2167
	 * @param string $absolute_path The absolute path of the directory to search.
2168
	 * @return array Array of absolute paths to the PHP files.
2169
	 */
2170
	public static function glob_php( $absolute_path ) {
2171
		if ( function_exists( 'glob' ) ) {
2172
			return glob( "$absolute_path/*.php" );
2173
		}
2174
2175
		$absolute_path = untrailingslashit( $absolute_path );
2176
		$files         = array();
2177
		if ( ! $dir = @opendir( $absolute_path ) ) {
2178
			return $files;
2179
		}
2180
2181
		while ( false !== $file = readdir( $dir ) ) {
2182
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2183
				continue;
2184
			}
2185
2186
			$file = "$absolute_path/$file";
2187
2188
			if ( ! is_file( $file ) ) {
2189
				continue;
2190
			}
2191
2192
			$files[] = $file;
2193
		}
2194
2195
		closedir( $dir );
2196
2197
		return $files;
2198
	}
2199
2200
	public static function activate_new_modules( $redirect = false ) {
2201
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2202
			return;
2203
		}
2204
2205
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2206 View Code Duplication
		if ( ! $jetpack_old_version ) {
2207
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2208
			/** This action is documented in class.jetpack.php */
2209
			do_action( 'updating_jetpack_version', $version, false );
2210
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2211
		}
2212
2213
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2214
2215
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2216
			return;
2217
		}
2218
2219
		$active_modules     = self::get_active_modules();
2220
		$reactivate_modules = array();
2221
		foreach ( $active_modules as $active_module ) {
2222
			$module = self::get_module( $active_module );
2223
			if ( ! isset( $module['changed'] ) ) {
2224
				continue;
2225
			}
2226
2227
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2228
				continue;
2229
			}
2230
2231
			$reactivate_modules[] = $active_module;
2232
			self::deactivate_module( $active_module );
2233
		}
2234
2235
		$new_version = JETPACK__VERSION . ':' . time();
2236
		/** This action is documented in class.jetpack.php */
2237
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2238
		Jetpack_Options::update_options(
2239
			array(
2240
				'version'     => $new_version,
2241
				'old_version' => $jetpack_old_version,
2242
			)
2243
		);
2244
2245
		self::state( 'message', 'modules_activated' );
2246
		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...
2247
2248
		if ( $redirect ) {
2249
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2250
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2251
				$page = $_GET['page'];
2252
			}
2253
2254
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2255
			exit;
2256
		}
2257
	}
2258
2259
	/**
2260
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2261
	 * Make sure to tuck away module "library" files in a sub-directory.
2262
	 */
2263
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2264
		static $modules = null;
2265
2266
		if ( ! isset( $modules ) ) {
2267
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2268
			// Use the cache if we're on the front-end and it's available...
2269
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2270
				$modules = $available_modules_option[ JETPACK__VERSION ];
2271
			} else {
2272
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2273
2274
				$modules = array();
2275
2276
				foreach ( $files as $file ) {
2277
					if ( ! $headers = self::get_module( $file ) ) {
2278
						continue;
2279
					}
2280
2281
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2282
				}
2283
2284
				Jetpack_Options::update_option(
2285
					'available_modules',
2286
					array(
2287
						JETPACK__VERSION => $modules,
2288
					)
2289
				);
2290
			}
2291
		}
2292
2293
		/**
2294
		 * Filters the array of modules available to be activated.
2295
		 *
2296
		 * @since 2.4.0
2297
		 *
2298
		 * @param array $modules Array of available modules.
2299
		 * @param string $min_version Minimum version number required to use modules.
2300
		 * @param string $max_version Maximum version number required to use modules.
2301
		 */
2302
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2303
2304
		if ( ! $min_version && ! $max_version ) {
2305
			return array_keys( $mods );
2306
		}
2307
2308
		$r = array();
2309
		foreach ( $mods as $slug => $introduced ) {
2310
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2311
				continue;
2312
			}
2313
2314
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2315
				continue;
2316
			}
2317
2318
			$r[] = $slug;
2319
		}
2320
2321
		return $r;
2322
	}
2323
2324
	/**
2325
	 * Default modules loaded on activation.
2326
	 */
2327
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2328
		$return = array();
2329
2330
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2331
			$module_data = self::get_module( $module );
2332
2333
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2334
				case 'yes':
2335
					$return[] = $module;
2336
					break;
2337
				case 'public':
2338
					if ( Jetpack_Options::get_option( 'public' ) ) {
2339
						$return[] = $module;
2340
					}
2341
					break;
2342
				case 'no':
2343
				default:
2344
					break;
2345
			}
2346
		}
2347
		/**
2348
		 * Filters the array of default modules.
2349
		 *
2350
		 * @since 2.5.0
2351
		 *
2352
		 * @param array $return Array of default modules.
2353
		 * @param string $min_version Minimum version number required to use modules.
2354
		 * @param string $max_version Maximum version number required to use modules.
2355
		 */
2356
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2357
	}
2358
2359
	/**
2360
	 * Checks activated modules during auto-activation to determine
2361
	 * if any of those modules are being deprecated.  If so, close
2362
	 * them out, and add any replacement modules.
2363
	 *
2364
	 * Runs at priority 99 by default.
2365
	 *
2366
	 * This is run late, so that it can still activate a module if
2367
	 * the new module is a replacement for another that the user
2368
	 * currently has active, even if something at the normal priority
2369
	 * would kibosh everything.
2370
	 *
2371
	 * @since 2.6
2372
	 * @uses jetpack_get_default_modules filter
2373
	 * @param array $modules
2374
	 * @return array
2375
	 */
2376
	function handle_deprecated_modules( $modules ) {
2377
		$deprecated_modules = array(
2378
			'debug'            => null,  // Closed out and moved to the debugger library.
2379
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2380
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2381
		);
2382
2383
		// Don't activate SSO if they never completed activating WPCC.
2384
		if ( self::is_module_active( 'wpcc' ) ) {
2385
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2386
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2387
				$deprecated_modules['wpcc'] = null;
2388
			}
2389
		}
2390
2391
		foreach ( $deprecated_modules as $module => $replacement ) {
2392
			if ( self::is_module_active( $module ) ) {
2393
				self::deactivate_module( $module );
2394
				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...
2395
					$modules[] = $replacement;
2396
				}
2397
			}
2398
		}
2399
2400
		return array_unique( $modules );
2401
	}
2402
2403
	/**
2404
	 * Checks activated plugins during auto-activation to determine
2405
	 * if any of those plugins are in the list with a corresponding module
2406
	 * that is not compatible with the plugin. The module will not be allowed
2407
	 * to auto-activate.
2408
	 *
2409
	 * @since 2.6
2410
	 * @uses jetpack_get_default_modules filter
2411
	 * @param array $modules
2412
	 * @return array
2413
	 */
2414
	function filter_default_modules( $modules ) {
2415
2416
		$active_plugins = self::get_active_plugins();
2417
2418
		if ( ! empty( $active_plugins ) ) {
2419
2420
			// For each module we'd like to auto-activate...
2421
			foreach ( $modules as $key => $module ) {
2422
				// If there are potential conflicts for it...
2423
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2424
					// For each potential conflict...
2425
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2426
						// If that conflicting plugin is active...
2427
						if ( in_array( $plugin, $active_plugins ) ) {
2428
							// Remove that item from being auto-activated.
2429
							unset( $modules[ $key ] );
2430
						}
2431
					}
2432
				}
2433
			}
2434
		}
2435
2436
		return $modules;
2437
	}
2438
2439
	/**
2440
	 * Extract a module's slug from its full path.
2441
	 */
2442
	public static function get_module_slug( $file ) {
2443
		return str_replace( '.php', '', basename( $file ) );
2444
	}
2445
2446
	/**
2447
	 * Generate a module's path from its slug.
2448
	 */
2449
	public static function get_module_path( $slug ) {
2450
		/**
2451
		 * Filters the path of a modules.
2452
		 *
2453
		 * @since 7.4.0
2454
		 *
2455
		 * @param array $return The absolute path to a module's root php file
2456
		 * @param string $slug The module slug
2457
		 */
2458
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2459
	}
2460
2461
	/**
2462
	 * Load module data from module file. Headers differ from WordPress
2463
	 * plugin headers to avoid them being identified as standalone
2464
	 * plugins on the WordPress plugins page.
2465
	 */
2466
	public static function get_module( $module ) {
2467
		$headers = array(
2468
			'name'                      => 'Module Name',
2469
			'description'               => 'Module Description',
2470
			'sort'                      => 'Sort Order',
2471
			'recommendation_order'      => 'Recommendation Order',
2472
			'introduced'                => 'First Introduced',
2473
			'changed'                   => 'Major Changes In',
2474
			'deactivate'                => 'Deactivate',
2475
			'free'                      => 'Free',
2476
			'requires_connection'       => 'Requires Connection',
2477
			'auto_activate'             => 'Auto Activate',
2478
			'module_tags'               => 'Module Tags',
2479
			'feature'                   => 'Feature',
2480
			'additional_search_queries' => 'Additional Search Queries',
2481
			'plan_classes'              => 'Plans',
2482
		);
2483
2484
		$file = self::get_module_path( self::get_module_slug( $module ) );
2485
2486
		$mod = self::get_file_data( $file, $headers );
2487
		if ( empty( $mod['name'] ) ) {
2488
			return false;
2489
		}
2490
2491
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2492
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2493
		$mod['deactivate']           = empty( $mod['deactivate'] );
2494
		$mod['free']                 = empty( $mod['free'] );
2495
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2496
2497
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2498
			$mod['auto_activate'] = 'No';
2499
		} else {
2500
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2501
		}
2502
2503
		if ( $mod['module_tags'] ) {
2504
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2505
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2506
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2507
		} else {
2508
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2509
		}
2510
2511 View Code Duplication
		if ( $mod['plan_classes'] ) {
2512
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2513
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2514
		} else {
2515
			$mod['plan_classes'] = array( 'free' );
2516
		}
2517
2518 View Code Duplication
		if ( $mod['feature'] ) {
2519
			$mod['feature'] = explode( ',', $mod['feature'] );
2520
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2521
		} else {
2522
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2523
		}
2524
2525
		/**
2526
		 * Filters the feature array on a module.
2527
		 *
2528
		 * This filter allows you to control where each module is filtered: Recommended,
2529
		 * and the default "Other" listing.
2530
		 *
2531
		 * @since 3.5.0
2532
		 *
2533
		 * @param array   $mod['feature'] The areas to feature this module:
2534
		 *     'Recommended' shows on the main Jetpack admin screen.
2535
		 *     'Other' should be the default if no other value is in the array.
2536
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2537
		 * @param array   $mod All the currently assembled module data.
2538
		 */
2539
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2540
2541
		/**
2542
		 * Filter the returned data about a module.
2543
		 *
2544
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2545
		 * so please be careful.
2546
		 *
2547
		 * @since 3.6.0
2548
		 *
2549
		 * @param array   $mod    The details of the requested module.
2550
		 * @param string  $module The slug of the module, e.g. sharedaddy
2551
		 * @param string  $file   The path to the module source file.
2552
		 */
2553
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2554
	}
2555
2556
	/**
2557
	 * Like core's get_file_data implementation, but caches the result.
2558
	 */
2559
	public static function get_file_data( $file, $headers ) {
2560
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2561
		$file_name = basename( $file );
2562
2563
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2564
2565
		$file_data_option = get_transient( $cache_key );
2566
2567
		if ( ! is_array( $file_data_option ) ) {
2568
			delete_transient( $cache_key );
2569
			$file_data_option = false;
2570
		}
2571
2572
		if ( false === $file_data_option ) {
2573
			$file_data_option = array();
2574
		}
2575
2576
		$key           = md5( $file_name . serialize( $headers ) );
2577
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2578
2579
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2580
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2581
			return $file_data_option[ $key ];
2582
		}
2583
2584
		$data = get_file_data( $file, $headers );
2585
2586
		$file_data_option[ $key ] = $data;
2587
2588
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2589
2590
		return $data;
2591
	}
2592
2593
2594
	/**
2595
	 * Return translated module tag.
2596
	 *
2597
	 * @param string $tag Tag as it appears in each module heading.
2598
	 *
2599
	 * @return mixed
2600
	 */
2601
	public static function translate_module_tag( $tag ) {
2602
		return jetpack_get_module_i18n_tag( $tag );
2603
	}
2604
2605
	/**
2606
	 * Get i18n strings as a JSON-encoded string
2607
	 *
2608
	 * @return string The locale as JSON
2609
	 */
2610
	public static function get_i18n_data_json() {
2611
2612
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2613
		// JSON files with the file they should be included for. This is an md5
2614
		// of '_inc/build/admin.js'.
2615
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2616
2617
		$i18n_json =
2618
				   JETPACK__PLUGIN_DIR
2619
				   . 'languages/json/jetpack-'
2620
				   . get_user_locale()
2621
				   . '-'
2622
				   . $path_md5
2623
				   . '.json';
2624
2625
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2626
			$locale_data = @file_get_contents( $i18n_json );
2627
			if ( $locale_data ) {
2628
				return $locale_data;
2629
			}
2630
		}
2631
2632
		// Return valid empty Jed locale
2633
		return '{ "locale_data": { "messages": { "": {} } } }';
2634
	}
2635
2636
	/**
2637
	 * Add locale data setup to wp-i18n
2638
	 *
2639
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2640
	 *
2641
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2642
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2643
	 *
2644
	 * This method provides a safe way to request the setup multiple times but add the script at
2645
	 * most once.
2646
	 *
2647
	 * @since 6.7.0
2648
	 *
2649
	 * @return void
2650
	 */
2651
	public static function setup_wp_i18n_locale_data() {
2652
		static $script_added = false;
2653
		if ( ! $script_added ) {
2654
			$script_added = true;
2655
			wp_add_inline_script(
2656
				'wp-i18n',
2657
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2658
			);
2659
		}
2660
	}
2661
2662
	/**
2663
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2664
	 *
2665
	 * @since 3.9.2
2666
	 *
2667
	 * @param array $modules
2668
	 *
2669
	 * @return string|void
2670
	 */
2671
	public static function get_translated_modules( $modules ) {
2672
		foreach ( $modules as $index => $module ) {
2673
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2674
			if ( isset( $module['name'] ) ) {
2675
				$modules[ $index ]['name'] = $i18n_module['name'];
2676
			}
2677
			if ( isset( $module['description'] ) ) {
2678
				$modules[ $index ]['description']       = $i18n_module['description'];
2679
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2680
			}
2681
		}
2682
		return $modules;
2683
	}
2684
2685
	/**
2686
	 * Get a list of activated modules as an array of module slugs.
2687
	 */
2688
	public static function get_active_modules() {
2689
		$active = Jetpack_Options::get_option( 'active_modules' );
2690
2691
		if ( ! is_array( $active ) ) {
2692
			$active = array();
2693
		}
2694
2695
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2696
			$active[] = 'vaultpress';
2697
		} else {
2698
			$active = array_diff( $active, array( 'vaultpress' ) );
2699
		}
2700
2701
		// If protect is active on the main site of a multisite, it should be active on all sites.
2702
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2703
			$active[] = 'protect';
2704
		}
2705
2706
		/**
2707
		 * Allow filtering of the active modules.
2708
		 *
2709
		 * Gives theme and plugin developers the power to alter the modules that
2710
		 * are activated on the fly.
2711
		 *
2712
		 * @since 5.8.0
2713
		 *
2714
		 * @param array $active Array of active module slugs.
2715
		 */
2716
		$active = apply_filters( 'jetpack_active_modules', $active );
2717
2718
		return array_unique( $active );
2719
	}
2720
2721
	/**
2722
	 * Check whether or not a Jetpack module is active.
2723
	 *
2724
	 * @param string $module The slug of a Jetpack module.
2725
	 * @return bool
2726
	 *
2727
	 * @static
2728
	 */
2729
	public static function is_module_active( $module ) {
2730
		return in_array( $module, self::get_active_modules() );
2731
	}
2732
2733
	public static function is_module( $module ) {
2734
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2735
	}
2736
2737
	/**
2738
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2739
	 *
2740
	 * @param bool $catch True to start catching, False to stop.
2741
	 *
2742
	 * @static
2743
	 */
2744
	public static function catch_errors( $catch ) {
2745
		static $display_errors, $error_reporting;
2746
2747
		if ( $catch ) {
2748
			$display_errors  = @ini_set( 'display_errors', 1 );
2749
			$error_reporting = @error_reporting( E_ALL );
2750
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2751
		} else {
2752
			@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...
2753
			@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...
2754
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2755
		}
2756
	}
2757
2758
	/**
2759
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2760
	 */
2761
	public static function catch_errors_on_shutdown() {
2762
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2763
	}
2764
2765
	/**
2766
	 * Rewrite any string to make paths easier to read.
2767
	 *
2768
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2769
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2770
	 *
2771
	 * @param $string
2772
	 * @return mixed
2773
	 */
2774
	public static function alias_directories( $string ) {
2775
		// ABSPATH has a trailing slash.
2776
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2777
		// WP_CONTENT_DIR does not have a trailing slash.
2778
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2779
2780
		return $string;
2781
	}
2782
2783
	public static function activate_default_modules(
2784
		$min_version = false,
2785
		$max_version = false,
2786
		$other_modules = array(),
2787
		$redirect = null,
2788
		$send_state_messages = null
2789
	) {
2790
		$jetpack = self::init();
2791
2792
		if ( is_null( $redirect ) ) {
2793
			if (
2794
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2795
			||
2796
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2797
			||
2798
				( defined( 'WP_CLI' ) && WP_CLI )
2799
			||
2800
				( defined( 'DOING_CRON' ) && DOING_CRON )
2801
			||
2802
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2803
			) {
2804
				$redirect = false;
2805
			} elseif ( is_admin() ) {
2806
				$redirect = true;
2807
			} else {
2808
				$redirect = false;
2809
			}
2810
		}
2811
2812
		if ( is_null( $send_state_messages ) ) {
2813
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2814
		}
2815
2816
		$modules = self::get_default_modules( $min_version, $max_version );
2817
		$modules = array_merge( $other_modules, $modules );
2818
2819
		// Look for standalone plugins and disable if active.
2820
2821
		$to_deactivate = array();
2822
		foreach ( $modules as $module ) {
2823
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2824
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2825
			}
2826
		}
2827
2828
		$deactivated = array();
2829
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2830
			list( $probable_file, $probable_title ) = $deactivate_me;
2831
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2832
				$deactivated[] = $module;
2833
			}
2834
		}
2835
2836
		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...
2837
			if ( $send_state_messages ) {
2838
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2839
			}
2840
2841
			if ( $redirect ) {
2842
				$url = add_query_arg(
2843
					array(
2844
						'action'   => 'activate_default_modules',
2845
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2846
					),
2847
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2848
				);
2849
				wp_safe_redirect( $url );
2850
				exit;
2851
			}
2852
		}
2853
2854
		/**
2855
		 * Fires before default modules are activated.
2856
		 *
2857
		 * @since 1.9.0
2858
		 *
2859
		 * @param string $min_version Minimum version number required to use modules.
2860
		 * @param string $max_version Maximum version number required to use modules.
2861
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2862
		 */
2863
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2864
2865
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2866
		if ( $send_state_messages ) {
2867
			self::restate();
2868
			self::catch_errors( true );
2869
		}
2870
2871
		$active = self::get_active_modules();
2872
2873
		foreach ( $modules as $module ) {
2874
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2875
				$active[] = $module;
2876
				self::update_active_modules( $active );
2877
				continue;
2878
			}
2879
2880
			if ( $send_state_messages && in_array( $module, $active ) ) {
2881
				$module_info = self::get_module( $module );
2882 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2883
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2884
					if ( $active_state = self::state( $state ) ) {
2885
						$active_state = explode( ',', $active_state );
2886
					} else {
2887
						$active_state = array();
2888
					}
2889
					$active_state[] = $module;
2890
					self::state( $state, implode( ',', $active_state ) );
2891
				}
2892
				continue;
2893
			}
2894
2895
			$file = self::get_module_path( $module );
2896
			if ( ! file_exists( $file ) ) {
2897
				continue;
2898
			}
2899
2900
			// we'll override this later if the plugin can be included without fatal error
2901
			if ( $redirect ) {
2902
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2903
			}
2904
2905
			if ( $send_state_messages ) {
2906
				self::state( 'error', 'module_activation_failed' );
2907
				self::state( 'module', $module );
2908
			}
2909
2910
			ob_start();
2911
			require_once $file;
2912
2913
			$active[] = $module;
2914
2915 View Code Duplication
			if ( $send_state_messages ) {
2916
2917
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2918
				if ( $active_state = self::state( $state ) ) {
2919
					$active_state = explode( ',', $active_state );
2920
				} else {
2921
					$active_state = array();
2922
				}
2923
				$active_state[] = $module;
2924
				self::state( $state, implode( ',', $active_state ) );
2925
			}
2926
2927
			self::update_active_modules( $active );
2928
2929
			ob_end_clean();
2930
		}
2931
2932
		if ( $send_state_messages ) {
2933
			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...
2934
			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...
2935
		}
2936
2937
		self::catch_errors( false );
2938
		/**
2939
		 * Fires when default modules are activated.
2940
		 *
2941
		 * @since 1.9.0
2942
		 *
2943
		 * @param string $min_version Minimum version number required to use modules.
2944
		 * @param string $max_version Maximum version number required to use modules.
2945
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2946
		 */
2947
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2948
	}
2949
2950
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2951
		/**
2952
		 * Fires before a module is activated.
2953
		 *
2954
		 * @since 2.6.0
2955
		 *
2956
		 * @param string $module Module slug.
2957
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2958
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2959
		 */
2960
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2961
2962
		$jetpack = self::init();
2963
2964
		if ( ! strlen( $module ) ) {
2965
			return false;
2966
		}
2967
2968
		if ( ! self::is_module( $module ) ) {
2969
			return false;
2970
		}
2971
2972
		// If it's already active, then don't do it again
2973
		$active = self::get_active_modules();
2974
		foreach ( $active as $act ) {
2975
			if ( $act == $module ) {
2976
				return true;
2977
			}
2978
		}
2979
2980
		$module_data = self::get_module( $module );
2981
2982
		$is_development_mode = ( new Status() )->is_development_mode();
2983
		if ( ! self::is_active() ) {
2984
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
2985
				return false;
2986
			}
2987
2988
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2989
			if ( $is_development_mode && $module_data['requires_connection'] ) {
2990
				return false;
2991
			}
2992
		}
2993
2994
		// Check and see if the old plugin is active
2995
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2996
			// Deactivate the old plugin
2997
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2998
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2999
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3000
				self::state( 'deactivated_plugins', $module );
3001
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3002
				exit;
3003
			}
3004
		}
3005
3006
		// Protect won't work with mis-configured IPs
3007
		if ( 'protect' === $module ) {
3008
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3009
			if ( ! jetpack_protect_get_ip() ) {
3010
				self::state( 'message', 'protect_misconfigured_ip' );
3011
				return false;
3012
			}
3013
		}
3014
3015
		if ( ! Jetpack_Plan::supports( $module ) ) {
3016
			return false;
3017
		}
3018
3019
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3020
		self::state( 'module', $module );
3021
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3022
3023
		self::catch_errors( true );
3024
		ob_start();
3025
		require self::get_module_path( $module );
3026
		/** This action is documented in class.jetpack.php */
3027
		do_action( 'jetpack_activate_module', $module );
3028
		$active[] = $module;
3029
		self::update_active_modules( $active );
3030
3031
		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...
3032
		ob_end_clean();
3033
		self::catch_errors( false );
3034
3035
		if ( $redirect ) {
3036
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3037
		}
3038
		if ( $exit ) {
3039
			exit;
3040
		}
3041
		return true;
3042
	}
3043
3044
	function activate_module_actions( $module ) {
3045
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3046
	}
3047
3048
	public static function deactivate_module( $module ) {
3049
		/**
3050
		 * Fires when a module is deactivated.
3051
		 *
3052
		 * @since 1.9.0
3053
		 *
3054
		 * @param string $module Module slug.
3055
		 */
3056
		do_action( 'jetpack_pre_deactivate_module', $module );
3057
3058
		$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...
3059
3060
		$active = self::get_active_modules();
3061
		$new    = array_filter( array_diff( $active, (array) $module ) );
3062
3063
		return self::update_active_modules( $new );
3064
	}
3065
3066
	public static function enable_module_configurable( $module ) {
3067
		$module = self::get_module_slug( $module );
3068
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3069
	}
3070
3071
	/**
3072
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3073
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3074
	 *
3075
	 * @param string $module Module slug
3076
	 * @return string $url module configuration URL
3077
	 */
3078
	public static function module_configuration_url( $module ) {
3079
		$module      = self::get_module_slug( $module );
3080
		$default_url = self::admin_url() . "#/settings?term=$module";
3081
		/**
3082
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3083
		 *
3084
		 * @since 6.9.0
3085
		 *
3086
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3087
		 */
3088
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3089
3090
		return $url;
3091
	}
3092
3093
	/* Installation */
3094
	public static function bail_on_activation( $message, $deactivate = true ) {
3095
		?>
3096
<!doctype html>
3097
<html>
3098
<head>
3099
<meta charset="<?php bloginfo( 'charset' ); ?>">
3100
<style>
3101
* {
3102
	text-align: center;
3103
	margin: 0;
3104
	padding: 0;
3105
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3106
}
3107
p {
3108
	margin-top: 1em;
3109
	font-size: 18px;
3110
}
3111
</style>
3112
<body>
3113
<p><?php echo esc_html( $message ); ?></p>
3114
</body>
3115
</html>
3116
		<?php
3117
		if ( $deactivate ) {
3118
			$plugins = get_option( 'active_plugins' );
3119
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3120
			$update  = false;
3121
			foreach ( $plugins as $i => $plugin ) {
3122
				if ( $plugin === $jetpack ) {
3123
					$plugins[ $i ] = false;
3124
					$update        = true;
3125
				}
3126
			}
3127
3128
			if ( $update ) {
3129
				update_option( 'active_plugins', array_filter( $plugins ) );
3130
			}
3131
		}
3132
		exit;
3133
	}
3134
3135
	/**
3136
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3137
	 *
3138
	 * @static
3139
	 */
3140
	public static function plugin_activation( $network_wide ) {
3141
		Jetpack_Options::update_option( 'activated', 1 );
3142
3143
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3144
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3145
		}
3146
3147
		if ( $network_wide ) {
3148
			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...
3149
		}
3150
3151
		// For firing one-off events (notices) immediately after activation
3152
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3153
3154
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3155
3156
		self::plugin_initialize();
3157
	}
3158
3159
	public static function get_activation_source( $referer_url ) {
3160
3161
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3162
			return array( 'wp-cli', null );
3163
		}
3164
3165
		$referer = wp_parse_url( $referer_url );
3166
3167
		$source_type  = 'unknown';
3168
		$source_query = null;
3169
3170
		if ( ! is_array( $referer ) ) {
3171
			return array( $source_type, $source_query );
3172
		}
3173
3174
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3175
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3176
3177
		if ( isset( $referer['query'] ) ) {
3178
			parse_str( $referer['query'], $query_parts );
3179
		} else {
3180
			$query_parts = array();
3181
		}
3182
3183
		if ( $plugins_path === $referer['path'] ) {
3184
			$source_type = 'list';
3185
		} elseif ( $plugins_install_path === $referer['path'] ) {
3186
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3187
			switch ( $tab ) {
3188
				case 'popular':
3189
					$source_type = 'popular';
3190
					break;
3191
				case 'recommended':
3192
					$source_type = 'recommended';
3193
					break;
3194
				case 'favorites':
3195
					$source_type = 'favorites';
3196
					break;
3197
				case 'search':
3198
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3199
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3200
					break;
3201
				default:
3202
					$source_type = 'featured';
3203
			}
3204
		}
3205
3206
		return array( $source_type, $source_query );
3207
	}
3208
3209
	/**
3210
	 * Runs before bumping version numbers up to a new version
3211
	 *
3212
	 * @param  string $version    Version:timestamp
3213
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3214
	 * @return null              [description]
3215
	 */
3216
	public static function do_version_bump( $version, $old_version ) {
3217
		if ( ! $old_version ) { // For new sites
3218
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3219
		}
3220
	}
3221
3222
	/**
3223
	 * Sets the internal version number and activation state.
3224
	 *
3225
	 * @static
3226
	 */
3227
	public static function plugin_initialize() {
3228
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3229
			Jetpack_Options::update_option( 'activated', 2 );
3230
		}
3231
3232 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3233
			$version = $old_version = JETPACK__VERSION . ':' . time();
3234
			/** This action is documented in class.jetpack.php */
3235
			do_action( 'updating_jetpack_version', $version, false );
3236
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3237
		}
3238
3239
		self::load_modules();
3240
3241
		Jetpack_Options::delete_option( 'do_activate' );
3242
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3243
	}
3244
3245
	/**
3246
	 * Removes all connection options
3247
	 *
3248
	 * @static
3249
	 */
3250
	public static function plugin_deactivation() {
3251
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3252
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3253
			Jetpack_Network::init()->deactivate();
3254
		} else {
3255
			self::disconnect( false );
3256
			// Jetpack_Heartbeat::init()->deactivate();
3257
		}
3258
	}
3259
3260
	/**
3261
	 * Disconnects from the Jetpack servers.
3262
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3263
	 *
3264
	 * @static
3265
	 */
3266
	public static function disconnect( $update_activated_state = true ) {
3267
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3268
		$connection = self::connection();
3269
		$connection->clean_nonces( true );
3270
3271
		// If the site is in an IDC because sync is not allowed,
3272
		// let's make sure to not disconnect the production site.
3273
		if ( ! self::validate_sync_error_idc_option() ) {
3274
			$tracking = new Tracking();
3275
			$tracking->record_user_event( 'disconnect_site', array() );
3276
3277
			$connection->disconnect_site_wpcom();
3278
		}
3279
3280
		$connection->delete_all_connection_tokens();
3281
		Jetpack_IDC::clear_all_idc_options();
3282
3283
		if ( $update_activated_state ) {
3284
			Jetpack_Options::update_option( 'activated', 4 );
3285
		}
3286
3287
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3288
			// Check then record unique disconnection if site has never been disconnected previously
3289
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3290
				$jetpack_unique_connection['disconnected'] = 1;
3291
			} else {
3292
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3293
					// track unique disconnect
3294
					$jetpack = self::init();
3295
3296
					$jetpack->stat( 'connections', 'unique-disconnect' );
3297
					$jetpack->do_stats( 'server_side' );
3298
				}
3299
				// increment number of times disconnected
3300
				$jetpack_unique_connection['disconnected'] += 1;
3301
			}
3302
3303
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3304
		}
3305
3306
		// Delete all the sync related data. Since it could be taking up space.
3307
		Sender::get_instance()->uninstall();
3308
3309
		// Disable the Heartbeat cron
3310
		Jetpack_Heartbeat::init()->deactivate();
3311
	}
3312
3313
	/**
3314
	 * Unlinks the current user from the linked WordPress.com user.
3315
	 *
3316
	 * @deprecated since 7.7
3317
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3318
	 *
3319
	 * @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...
3320
	 * @return Boolean Whether the disconnection of the user was successful.
3321
	 */
3322
	public static function unlink_user( $user_id = null ) {
3323
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3324
		return Connection_Manager::disconnect_user( $user_id );
3325
	}
3326
3327
	/**
3328
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3329
	 */
3330
	public static function try_registration() {
3331
		$terms_of_service = new Terms_Of_Service();
3332
		// The user has agreed to the TOS at some point by now.
3333
		$terms_of_service->agree();
3334
3335
		// Let's get some testing in beta versions and such.
3336
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3337
			// Before attempting to connect, let's make sure that the domains are viable.
3338
			$domains_to_check = array_unique(
3339
				array(
3340
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3341
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3342
				)
3343
			);
3344
			foreach ( $domains_to_check as $domain ) {
3345
				$result = self::connection()->is_usable_domain( $domain );
3346
				if ( is_wp_error( $result ) ) {
3347
					return $result;
3348
				}
3349
			}
3350
		}
3351
3352
		$result = self::register();
3353
3354
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3355
		if ( ! $result || is_wp_error( $result ) ) {
3356
			return $result;
3357
		} else {
3358
			return true;
3359
		}
3360
	}
3361
3362
	/**
3363
	 * Tracking an internal event log. Try not to put too much chaff in here.
3364
	 *
3365
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3366
	 */
3367
	public static function log( $code, $data = null ) {
3368
		// only grab the latest 200 entries
3369
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3370
3371
		// Append our event to the log
3372
		$log_entry = array(
3373
			'time'    => time(),
3374
			'user_id' => get_current_user_id(),
3375
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3376
			'code'    => $code,
3377
		);
3378
		// Don't bother storing it unless we've got some.
3379
		if ( ! is_null( $data ) ) {
3380
			$log_entry['data'] = $data;
3381
		}
3382
		$log[] = $log_entry;
3383
3384
		// Try add_option first, to make sure it's not autoloaded.
3385
		// @todo: Add an add_option method to Jetpack_Options
3386
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3387
			Jetpack_Options::update_option( 'log', $log );
3388
		}
3389
3390
		/**
3391
		 * Fires when Jetpack logs an internal event.
3392
		 *
3393
		 * @since 3.0.0
3394
		 *
3395
		 * @param array $log_entry {
3396
		 *  Array of details about the log entry.
3397
		 *
3398
		 *  @param string time Time of the event.
3399
		 *  @param int user_id ID of the user who trigerred the event.
3400
		 *  @param int blog_id Jetpack Blog ID.
3401
		 *  @param string code Unique name for the event.
3402
		 *  @param string data Data about the event.
3403
		 * }
3404
		 */
3405
		do_action( 'jetpack_log_entry', $log_entry );
3406
	}
3407
3408
	/**
3409
	 * Get the internal event log.
3410
	 *
3411
	 * @param $event (string) - only return the specific log events
3412
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3413
	 *
3414
	 * @return array of log events || WP_Error for invalid params
3415
	 */
3416
	public static function get_log( $event = false, $num = false ) {
3417
		if ( $event && ! is_string( $event ) ) {
3418
			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...
3419
		}
3420
3421
		if ( $num && ! is_numeric( $num ) ) {
3422
			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...
3423
		}
3424
3425
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3426
3427
		// If nothing set - act as it did before, otherwise let's start customizing the output
3428
		if ( ! $num && ! $event ) {
3429
			return $entire_log;
3430
		} else {
3431
			$entire_log = array_reverse( $entire_log );
3432
		}
3433
3434
		$custom_log_output = array();
3435
3436
		if ( $event ) {
3437
			foreach ( $entire_log as $log_event ) {
3438
				if ( $event == $log_event['code'] ) {
3439
					$custom_log_output[] = $log_event;
3440
				}
3441
			}
3442
		} else {
3443
			$custom_log_output = $entire_log;
3444
		}
3445
3446
		if ( $num ) {
3447
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3448
		}
3449
3450
		return $custom_log_output;
3451
	}
3452
3453
	/**
3454
	 * Log modification of important settings.
3455
	 */
3456
	public static function log_settings_change( $option, $old_value, $value ) {
3457
		switch ( $option ) {
3458
			case 'jetpack_sync_non_public_post_stati':
3459
				self::log( $option, $value );
3460
				break;
3461
		}
3462
	}
3463
3464
	/**
3465
	 * Return stat data for WPCOM sync
3466
	 */
3467
	public static function get_stat_data( $encode = true, $extended = true ) {
3468
		$data = Jetpack_Heartbeat::generate_stats_array();
3469
3470
		if ( $extended ) {
3471
			$additional_data = self::get_additional_stat_data();
3472
			$data            = array_merge( $data, $additional_data );
3473
		}
3474
3475
		if ( $encode ) {
3476
			return json_encode( $data );
3477
		}
3478
3479
		return $data;
3480
	}
3481
3482
	/**
3483
	 * Get additional stat data to sync to WPCOM
3484
	 */
3485
	public static function get_additional_stat_data( $prefix = '' ) {
3486
		$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...
3487
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3488
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3489
		$return[ "{$prefix}site-count" ]    = 0;
3490
3491
		if ( function_exists( 'get_blog_count' ) ) {
3492
			$return[ "{$prefix}site-count" ] = get_blog_count();
3493
		}
3494
		return $return;
3495
	}
3496
3497
	private static function get_site_user_count() {
3498
		global $wpdb;
3499
3500
		if ( function_exists( 'wp_is_large_network' ) ) {
3501
			if ( wp_is_large_network( 'users' ) ) {
3502
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3503
			}
3504
		}
3505
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3506
			// It wasn't there, so regenerate the data and save the transient
3507
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3508
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3509
		}
3510
		return $user_count;
3511
	}
3512
3513
	/* Admin Pages */
3514
3515
	function admin_init() {
3516
		// If the plugin is not connected, display a connect message.
3517
		if (
3518
			// the plugin was auto-activated and needs its candy
3519
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3520
		||
3521
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3522
			! Jetpack_Options::get_option( 'activated' )
3523
		) {
3524
			self::plugin_initialize();
3525
		}
3526
3527
		$is_development_mode = ( new Status() )->is_development_mode();
3528
		if ( ! self::is_active() && ! $is_development_mode ) {
3529
			Jetpack_Connection_Banner::init();
3530
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3531
			// Upgrade: 1.1 -> 1.1.1
3532
			// Check and see if host can verify the Jetpack servers' SSL certificate
3533
			$args       = array();
3534
			$connection = self::connection();
3535
			Client::_wp_remote_request(
3536
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3537
				$args,
3538
				true
3539
			);
3540
		}
3541
3542
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3543
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3544
		}
3545
3546
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3547
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3548
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3549
3550
		if ( self::is_active() || $is_development_mode ) {
3551
			// Artificially throw errors in certain whitelisted cases during plugin activation
3552
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3553
		}
3554
3555
		// Add custom column in wp-admin/users.php to show whether user is linked.
3556
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3557
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3558
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3559
	}
3560
3561
	function admin_body_class( $admin_body_class = '' ) {
3562
		$classes = explode( ' ', trim( $admin_body_class ) );
3563
3564
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3565
3566
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3567
		return " $admin_body_class ";
3568
	}
3569
3570
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3571
		return $admin_body_class . ' jetpack-pagestyles ';
3572
	}
3573
3574
	/**
3575
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3576
	 * This function artificially throws errors for such cases (whitelisted).
3577
	 *
3578
	 * @param string $plugin The activated plugin.
3579
	 */
3580
	function throw_error_on_activate_plugin( $plugin ) {
3581
		$active_modules = self::get_active_modules();
3582
3583
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3584
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3585
			$throw = false;
3586
3587
			// Try and make sure it really was the stats plugin
3588
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3589
				if ( 'stats.php' == basename( $plugin ) ) {
3590
					$throw = true;
3591
				}
3592
			} else {
3593
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3594
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3595
					$throw = true;
3596
				}
3597
			}
3598
3599
			if ( $throw ) {
3600
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3601
			}
3602
		}
3603
	}
3604
3605
	function intercept_plugin_error_scrape_init() {
3606
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3607
	}
3608
3609
	function intercept_plugin_error_scrape( $action, $result ) {
3610
		if ( ! $result ) {
3611
			return;
3612
		}
3613
3614
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3615
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3616
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3617
			}
3618
		}
3619
	}
3620
3621
	/**
3622
	 * Register the remote file upload request handlers, if needed.
3623
	 *
3624
	 * @access public
3625
	 */
3626
	public function add_remote_request_handlers() {
3627
		// Remote file uploads are allowed only via AJAX requests.
3628
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3629
			return;
3630
		}
3631
3632
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3633
		$remote_request_actions = array(
3634
			'jetpack_upload_file',
3635
			'jetpack_update_file',
3636
		);
3637
3638
		// phpcs:ignore WordPress.Security.NonceVerification
3639
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3640
			return;
3641
		}
3642
3643
		// Require Jetpack authentication for the remote file upload AJAX requests.
3644
		$this->connection_manager->require_jetpack_authentication();
3645
3646
		// Register the remote file upload AJAX handlers.
3647
		foreach ( $remote_request_actions as $action ) {
3648
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3649
		}
3650
	}
3651
3652
	/**
3653
	 * Handler for Jetpack remote file uploads.
3654
	 *
3655
	 * @access public
3656
	 */
3657
	public function remote_request_handlers() {
3658
		$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...
3659
3660
		switch ( current_filter() ) {
3661
			case 'wp_ajax_nopriv_jetpack_upload_file':
3662
				$response = $this->upload_handler();
3663
				break;
3664
3665
			case 'wp_ajax_nopriv_jetpack_update_file':
3666
				$response = $this->upload_handler( true );
3667
				break;
3668
			default:
3669
				$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...
3670
				break;
3671
		}
3672
3673
		if ( ! $response ) {
3674
			$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...
3675
		}
3676
3677
		if ( is_wp_error( $response ) ) {
3678
			$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...
3679
			$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...
3680
			$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...
3681
3682
			if ( ! is_int( $status_code ) ) {
3683
				$status_code = 400;
3684
			}
3685
3686
			status_header( $status_code );
3687
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3688
		}
3689
3690
		status_header( 200 );
3691
		if ( true === $response ) {
3692
			exit;
3693
		}
3694
3695
		die( json_encode( (object) $response ) );
3696
	}
3697
3698
	/**
3699
	 * Uploads a file gotten from the global $_FILES.
3700
	 * If `$update_media_item` is true and `post_id` is defined
3701
	 * the attachment file of the media item (gotten through of the post_id)
3702
	 * will be updated instead of add a new one.
3703
	 *
3704
	 * @param  boolean $update_media_item - update media attachment
3705
	 * @return array - An array describing the uploadind files process
3706
	 */
3707
	function upload_handler( $update_media_item = false ) {
3708
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3709
			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...
3710
		}
3711
3712
		$user = wp_authenticate( '', '' );
3713
		if ( ! $user || is_wp_error( $user ) ) {
3714
			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...
3715
		}
3716
3717
		wp_set_current_user( $user->ID );
3718
3719
		if ( ! current_user_can( 'upload_files' ) ) {
3720
			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...
3721
		}
3722
3723
		if ( empty( $_FILES ) ) {
3724
			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...
3725
		}
3726
3727
		foreach ( array_keys( $_FILES ) as $files_key ) {
3728
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3729
				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...
3730
			}
3731
		}
3732
3733
		$media_keys = array_keys( $_FILES['media'] );
3734
3735
		$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...
3736
		if ( ! $token || is_wp_error( $token ) ) {
3737
			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...
3738
		}
3739
3740
		$uploaded_files = array();
3741
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3742
		unset( $GLOBALS['post'] );
3743
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3744
			$file = array();
3745
			foreach ( $media_keys as $media_key ) {
3746
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3747
			}
3748
3749
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3750
3751
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3752
			if ( $hmac_provided !== $hmac_file ) {
3753
				$uploaded_files[ $index ] = (object) array(
3754
					'error'             => 'invalid_hmac',
3755
					'error_description' => 'The corresponding HMAC for this file does not match',
3756
				);
3757
				continue;
3758
			}
3759
3760
			$_FILES['.jetpack.upload.'] = $file;
3761
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3762
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3763
				$post_id = 0;
3764
			}
3765
3766
			if ( $update_media_item ) {
3767
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3768
					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...
3769
				}
3770
3771
				$media_array = $_FILES['media'];
3772
3773
				$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...
3774
				$file_array['type']     = $media_array['type'][0];
3775
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3776
				$file_array['error']    = $media_array['error'][0];
3777
				$file_array['size']     = $media_array['size'][0];
3778
3779
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3780
3781
				if ( is_wp_error( $edited_media_item ) ) {
3782
					return $edited_media_item;
3783
				}
3784
3785
				$response = (object) array(
3786
					'id'   => (string) $post_id,
3787
					'file' => (string) $edited_media_item->post_title,
3788
					'url'  => (string) wp_get_attachment_url( $post_id ),
3789
					'type' => (string) $edited_media_item->post_mime_type,
3790
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3791
				);
3792
3793
				return (array) array( $response );
3794
			}
3795
3796
			$attachment_id = media_handle_upload(
3797
				'.jetpack.upload.',
3798
				$post_id,
3799
				array(),
3800
				array(
3801
					'action' => 'jetpack_upload_file',
3802
				)
3803
			);
3804
3805
			if ( ! $attachment_id ) {
3806
				$uploaded_files[ $index ] = (object) array(
3807
					'error'             => 'unknown',
3808
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3809
				);
3810
			} elseif ( is_wp_error( $attachment_id ) ) {
3811
				$uploaded_files[ $index ] = (object) array(
3812
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3813
					'error_description' => $attachment_id->get_error_message(),
3814
				);
3815
			} else {
3816
				$attachment               = get_post( $attachment_id );
3817
				$uploaded_files[ $index ] = (object) array(
3818
					'id'   => (string) $attachment_id,
3819
					'file' => $attachment->post_title,
3820
					'url'  => wp_get_attachment_url( $attachment_id ),
3821
					'type' => $attachment->post_mime_type,
3822
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3823
				);
3824
				// Zip files uploads are not supported unless they are done for installation purposed
3825
				// lets delete them in case something goes wrong in this whole process
3826
				if ( 'application/zip' === $attachment->post_mime_type ) {
3827
					// Schedule a cleanup for 2 hours from now in case of failed install.
3828
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3829
				}
3830
			}
3831
		}
3832
		if ( ! is_null( $global_post ) ) {
3833
			$GLOBALS['post'] = $global_post;
3834
		}
3835
3836
		return $uploaded_files;
3837
	}
3838
3839
	/**
3840
	 * Add help to the Jetpack page
3841
	 *
3842
	 * @since Jetpack (1.2.3)
3843
	 * @return false if not the Jetpack page
3844
	 */
3845
	function admin_help() {
3846
		$current_screen = get_current_screen();
3847
3848
		// Overview
3849
		$current_screen->add_help_tab(
3850
			array(
3851
				'id'      => 'home',
3852
				'title'   => __( 'Home', 'jetpack' ),
3853
				'content' =>
3854
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3855
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3856
					'<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>',
3857
			)
3858
		);
3859
3860
		// Screen Content
3861
		if ( current_user_can( 'manage_options' ) ) {
3862
			$current_screen->add_help_tab(
3863
				array(
3864
					'id'      => 'settings',
3865
					'title'   => __( 'Settings', 'jetpack' ),
3866
					'content' =>
3867
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3868
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3869
						'<ol>' .
3870
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3871
							'<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>' .
3872
						'</ol>' .
3873
						'<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>',
3874
				)
3875
			);
3876
		}
3877
3878
		// Help Sidebar
3879
		$current_screen->set_help_sidebar(
3880
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3881
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3882
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3883
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3884
		);
3885
	}
3886
3887
	function admin_menu_css() {
3888
		wp_enqueue_style( 'jetpack-icons' );
3889
	}
3890
3891
	function admin_menu_order() {
3892
		return true;
3893
	}
3894
3895 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3896
		$jp_menu_order = array();
3897
3898
		foreach ( $menu_order as $index => $item ) {
3899
			if ( $item != 'jetpack' ) {
3900
				$jp_menu_order[] = $item;
3901
			}
3902
3903
			if ( $index == 0 ) {
3904
				$jp_menu_order[] = 'jetpack';
3905
			}
3906
		}
3907
3908
		return $jp_menu_order;
3909
	}
3910
3911
	function admin_banner_styles() {
3912
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3913
3914 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3915
			wp_register_style(
3916
				'jetpack-dops-style',
3917
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3918
				array(),
3919
				JETPACK__VERSION
3920
			);
3921
		}
3922
3923
		wp_enqueue_style(
3924
			'jetpack',
3925
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3926
			array( 'jetpack-dops-style' ),
3927
			JETPACK__VERSION . '-20121016'
3928
		);
3929
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3930
		wp_style_add_data( 'jetpack', 'suffix', $min );
3931
	}
3932
3933
	function plugin_action_links( $actions ) {
3934
3935
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3936
3937
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3938
			return array_merge(
3939
				$jetpack_home,
3940
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3941
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3942
				$actions
3943
			);
3944
		}
3945
3946
		return array_merge( $jetpack_home, $actions );
3947
	}
3948
3949
	/*
3950
	 * Registration flow:
3951
	 * 1 - ::admin_page_load() action=register
3952
	 * 2 - ::try_registration()
3953
	 * 3 - ::register()
3954
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3955
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3956
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3957
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3958
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3959
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3960
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3961
	 *       jetpack_id, jetpack_secret, jetpack_public
3962
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3963
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3964
	 * 5 - user logs in with WP.com account
3965
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3966
	 *		- Manager::authorize()
3967
	 *		- Manager::get_token()
3968
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3969
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3970
	 *			- which responds with access_token, token_type, scope
3971
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
3972
	 *		- Jetpack::activate_default_modules()
3973
	 *     		- Deactivates deprecated plugins
3974
	 *     		- Activates all default modules
3975
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3976
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3977
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3978
	 *     Done!
3979
	 */
3980
3981
	/**
3982
	 * Handles the page load events for the Jetpack admin page
3983
	 */
3984
	function admin_page_load() {
3985
		$error = false;
3986
3987
		// Make sure we have the right body class to hook stylings for subpages off of.
3988
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3989
3990
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3991
			// Should only be used in intermediate redirects to preserve state across redirects
3992
			self::restate();
3993
		}
3994
3995
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3996
			// @todo: Add validation against a known whitelist
3997
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3998
			// User clicked in the iframe to link their accounts
3999
			if ( ! self::is_user_connected() ) {
4000
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4001
4002
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4003
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4004
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4005
4006
				if ( isset( $_GET['notes_iframe'] ) ) {
4007
					$connect_url .= '&notes_iframe';
4008
				}
4009
				wp_redirect( $connect_url );
4010
				exit;
4011
			} else {
4012
				if ( ! isset( $_GET['calypso_env'] ) ) {
4013
					self::state( 'message', 'already_authorized' );
4014
					wp_safe_redirect( self::admin_url() );
4015
					exit;
4016
				} else {
4017
					$connect_url  = $this->build_connect_url( true, false, $from );
4018
					$connect_url .= '&already_authorized=true';
4019
					wp_redirect( $connect_url );
4020
					exit;
4021
				}
4022
			}
4023
		}
4024
4025
		if ( isset( $_GET['action'] ) ) {
4026
			switch ( $_GET['action'] ) {
4027
				case 'authorize':
4028
					if ( self::is_active() && self::is_user_connected() ) {
4029
						self::state( 'message', 'already_authorized' );
4030
						wp_safe_redirect( self::admin_url() );
4031
						exit;
4032
					}
4033
					self::log( 'authorize' );
4034
					$client_server = new Jetpack_Client_Server();
4035
					$client_server->client_authorize();
4036
					exit;
4037
				case 'register':
4038
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4039
						$error = 'cheatin';
4040
						break;
4041
					}
4042
					check_admin_referer( 'jetpack-register' );
4043
					self::log( 'register' );
4044
					self::maybe_set_version_option();
4045
					$registered = self::try_registration();
4046 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4047
						$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...
4048
						self::state( 'error', $error );
4049
						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...
4050
4051
						/**
4052
						 * Jetpack registration Error.
4053
						 *
4054
						 * @since 7.5.0
4055
						 *
4056
						 * @param string|int $error The error code.
4057
						 * @param \WP_Error $registered The error object.
4058
						 */
4059
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4060
						break;
4061
					}
4062
4063
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4064
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4065
4066
					/**
4067
					 * Jetpack registration Success.
4068
					 *
4069
					 * @since 7.5.0
4070
					 *
4071
					 * @param string $from 'from' GET parameter;
4072
					 */
4073
					do_action( 'jetpack_connection_register_success', $from );
4074
4075
					$url = $this->build_connect_url( true, $redirect, $from );
4076
4077
					if ( ! empty( $_GET['onboarding'] ) ) {
4078
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4079
					}
4080
4081
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4082
						$url = add_query_arg( 'auth_approved', 'true', $url );
4083
					}
4084
4085
					wp_redirect( $url );
4086
					exit;
4087
				case 'activate':
4088
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4089
						$error = 'cheatin';
4090
						break;
4091
					}
4092
4093
					$module = stripslashes( $_GET['module'] );
4094
					check_admin_referer( "jetpack_activate-$module" );
4095
					self::log( 'activate', $module );
4096
					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...
4097
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4098
					}
4099
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4100
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4101
					exit;
4102
				case 'activate_default_modules':
4103
					check_admin_referer( 'activate_default_modules' );
4104
					self::log( 'activate_default_modules' );
4105
					self::restate();
4106
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4107
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4108
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4109
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4110
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4111
					exit;
4112
				case 'disconnect':
4113
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4114
						$error = 'cheatin';
4115
						break;
4116
					}
4117
4118
					check_admin_referer( 'jetpack-disconnect' );
4119
					self::log( 'disconnect' );
4120
					self::disconnect();
4121
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4122
					exit;
4123
				case 'reconnect':
4124
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4125
						$error = 'cheatin';
4126
						break;
4127
					}
4128
4129
					check_admin_referer( 'jetpack-reconnect' );
4130
					self::log( 'reconnect' );
4131
					$this->disconnect();
4132
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4133
					exit;
4134 View Code Duplication
				case 'deactivate':
4135
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4136
						$error = 'cheatin';
4137
						break;
4138
					}
4139
4140
					$modules = stripslashes( $_GET['module'] );
4141
					check_admin_referer( "jetpack_deactivate-$modules" );
4142
					foreach ( explode( ',', $modules ) as $module ) {
4143
						self::log( 'deactivate', $module );
4144
						self::deactivate_module( $module );
4145
						self::state( 'message', 'module_deactivated' );
4146
					}
4147
					self::state( 'module', $modules );
4148
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4149
					exit;
4150
				case 'unlink':
4151
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4152
					check_admin_referer( 'jetpack-unlink' );
4153
					self::log( 'unlink' );
4154
					Connection_Manager::disconnect_user();
4155
					self::state( 'message', 'unlinked' );
4156
					if ( 'sub-unlink' == $redirect ) {
4157
						wp_safe_redirect( admin_url() );
4158
					} else {
4159
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4160
					}
4161
					exit;
4162
				case 'onboard':
4163
					if ( ! current_user_can( 'manage_options' ) ) {
4164
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4165
					} else {
4166
						self::create_onboarding_token();
4167
						$url = $this->build_connect_url( true );
4168
4169
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4170
							$url = add_query_arg( 'onboarding', $token, $url );
4171
						}
4172
4173
						$calypso_env = $this->get_calypso_env();
4174
						if ( ! empty( $calypso_env ) ) {
4175
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4176
						}
4177
4178
						wp_redirect( $url );
4179
						exit;
4180
					}
4181
					exit;
4182
				default:
4183
					/**
4184
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4185
					 *
4186
					 * @since 2.6.0
4187
					 *
4188
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4189
					 */
4190
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4191
			}
4192
		}
4193
4194
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4195
			self::activate_new_modules( true );
4196
		}
4197
4198
		$message_code = self::state( 'message' );
4199
		if ( self::state( 'optin-manage' ) ) {
4200
			$activated_manage = $message_code;
4201
			$message_code     = 'jetpack-manage';
4202
		}
4203
4204
		switch ( $message_code ) {
4205
			case 'jetpack-manage':
4206
				$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>';
4207
				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...
4208
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4209
				}
4210
				break;
4211
4212
		}
4213
4214
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4215
4216
		if ( ! empty( $deactivated_plugins ) ) {
4217
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4218
			$deactivated_titles  = array();
4219
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4220
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4221
					continue;
4222
				}
4223
4224
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4225
			}
4226
4227
			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...
4228
				if ( $this->message ) {
4229
					$this->message .= "<br /><br />\n";
4230
				}
4231
4232
				$this->message .= wp_sprintf(
4233
					_n(
4234
						'Jetpack contains the most recent version of the old %l plugin.',
4235
						'Jetpack contains the most recent versions of the old %l plugins.',
4236
						count( $deactivated_titles ),
4237
						'jetpack'
4238
					),
4239
					$deactivated_titles
4240
				);
4241
4242
				$this->message .= "<br />\n";
4243
4244
				$this->message .= _n(
4245
					'The old version has been deactivated and can be removed from your site.',
4246
					'The old versions have been deactivated and can be removed from your site.',
4247
					count( $deactivated_titles ),
4248
					'jetpack'
4249
				);
4250
			}
4251
		}
4252
4253
		$this->privacy_checks = self::state( 'privacy_checks' );
4254
4255
		if ( $this->message || $this->error || $this->privacy_checks ) {
4256
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4257
		}
4258
4259
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4260
	}
4261
4262
	function admin_notices() {
4263
4264
		if ( $this->error ) {
4265
			?>
4266
<div id="message" class="jetpack-message jetpack-err">
4267
	<div class="squeezer">
4268
		<h2>
4269
			<?php
4270
			echo wp_kses(
4271
				$this->error,
4272
				array(
4273
					'a'      => array( 'href' => array() ),
4274
					'small'  => true,
4275
					'code'   => true,
4276
					'strong' => true,
4277
					'br'     => true,
4278
					'b'      => true,
4279
				)
4280
			);
4281
			?>
4282
			</h2>
4283
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4284
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4285
<?php	endif; ?>
4286
	</div>
4287
</div>
4288
			<?php
4289
		}
4290
4291
		if ( $this->message ) {
4292
			?>
4293
<div id="message" class="jetpack-message">
4294
	<div class="squeezer">
4295
		<h2>
4296
			<?php
4297
			echo wp_kses(
4298
				$this->message,
4299
				array(
4300
					'strong' => array(),
4301
					'a'      => array( 'href' => true ),
4302
					'br'     => true,
4303
				)
4304
			);
4305
			?>
4306
			</h2>
4307
	</div>
4308
</div>
4309
			<?php
4310
		}
4311
4312
		if ( $this->privacy_checks ) :
4313
			$module_names = $module_slugs = array();
4314
4315
			$privacy_checks = explode( ',', $this->privacy_checks );
4316
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4317
			foreach ( $privacy_checks as $module_slug ) {
4318
				$module = self::get_module( $module_slug );
4319
				if ( ! $module ) {
4320
					continue;
4321
				}
4322
4323
				$module_slugs[] = $module_slug;
4324
				$module_names[] = "<strong>{$module['name']}</strong>";
4325
			}
4326
4327
			$module_slugs = join( ',', $module_slugs );
4328
			?>
4329
<div id="message" class="jetpack-message jetpack-err">
4330
	<div class="squeezer">
4331
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4332
		<p>
4333
			<?php
4334
			echo wp_kses(
4335
				wptexturize(
4336
					wp_sprintf(
4337
						_nx(
4338
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4339
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4340
							count( $privacy_checks ),
4341
							'%l = list of Jetpack module/feature names',
4342
							'jetpack'
4343
						),
4344
						$module_names
4345
					)
4346
				),
4347
				array( 'strong' => true )
4348
			);
4349
4350
			echo "\n<br />\n";
4351
4352
			echo wp_kses(
4353
				sprintf(
4354
					_nx(
4355
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4356
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4357
						count( $privacy_checks ),
4358
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4359
						'jetpack'
4360
					),
4361
					wp_nonce_url(
4362
						self::admin_url(
4363
							array(
4364
								'page'   => 'jetpack',
4365
								'action' => 'deactivate',
4366
								'module' => urlencode( $module_slugs ),
4367
							)
4368
						),
4369
						"jetpack_deactivate-$module_slugs"
4370
					),
4371
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4372
				),
4373
				array(
4374
					'a' => array(
4375
						'href'  => true,
4376
						'title' => true,
4377
					),
4378
				)
4379
			);
4380
			?>
4381
		</p>
4382
	</div>
4383
</div>
4384
			<?php
4385
endif;
4386
	}
4387
4388
	/**
4389
	 * We can't always respond to a signed XML-RPC request with a
4390
	 * helpful error message. In some circumstances, doing so could
4391
	 * leak information.
4392
	 *
4393
	 * Instead, track that the error occurred via a Jetpack_Option,
4394
	 * and send that data back in the heartbeat.
4395
	 * All this does is increment a number, but it's enough to find
4396
	 * trends.
4397
	 *
4398
	 * @param WP_Error $xmlrpc_error The error produced during
4399
	 *                               signature validation.
4400
	 */
4401
	function track_xmlrpc_error( $xmlrpc_error ) {
4402
		$code = is_wp_error( $xmlrpc_error )
4403
			? $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...
4404
			: 'should-not-happen';
4405
4406
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4407
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4408
			// No need to update the option if we already have
4409
			// this code stored.
4410
			return;
4411
		}
4412
		$xmlrpc_errors[ $code ] = true;
4413
4414
		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...
4415
	}
4416
4417
	/**
4418
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4419
	 */
4420
	function stat( $group, $detail ) {
4421
		if ( ! isset( $this->stats[ $group ] ) ) {
4422
			$this->stats[ $group ] = array();
4423
		}
4424
		$this->stats[ $group ][] = $detail;
4425
	}
4426
4427
	/**
4428
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4429
	 */
4430
	function do_stats( $method = '' ) {
4431
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4432
			foreach ( $this->stats as $group => $stats ) {
4433
				if ( is_array( $stats ) && count( $stats ) ) {
4434
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4435
					if ( 'server_side' === $method ) {
4436
						self::do_server_side_stat( $args );
4437
					} else {
4438
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4439
					}
4440
				}
4441
				unset( $this->stats[ $group ] );
4442
			}
4443
		}
4444
	}
4445
4446
	/**
4447
	 * Runs stats code for a one-off, server-side.
4448
	 *
4449
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4450
	 *
4451
	 * @return bool If it worked.
4452
	 */
4453
	static function do_server_side_stat( $args ) {
4454
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4455
		if ( is_wp_error( $response ) ) {
4456
			return false;
4457
		}
4458
4459
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4460
			return false;
4461
		}
4462
4463
		return true;
4464
	}
4465
4466
	/**
4467
	 * Builds the stats url.
4468
	 *
4469
	 * @param $args array|string The arguments to append to the URL.
4470
	 *
4471
	 * @return string The URL to be pinged.
4472
	 */
4473
	static function build_stats_url( $args ) {
4474
		$defaults = array(
4475
			'v'    => 'wpcom2',
4476
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4477
		);
4478
		$args     = wp_parse_args( $args, $defaults );
4479
		/**
4480
		 * Filter the URL used as the Stats tracking pixel.
4481
		 *
4482
		 * @since 2.3.2
4483
		 *
4484
		 * @param string $url Base URL used as the Stats tracking pixel.
4485
		 */
4486
		$base_url = apply_filters(
4487
			'jetpack_stats_base_url',
4488
			'https://pixel.wp.com/g.gif'
4489
		);
4490
		$url      = add_query_arg( $args, $base_url );
4491
		return $url;
4492
	}
4493
4494
	/**
4495
	 * Get the role of the current user.
4496
	 *
4497
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4498
	 *
4499
	 * @access public
4500
	 * @static
4501
	 *
4502
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4503
	 */
4504
	public static function translate_current_user_to_role() {
4505
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4506
4507
		$roles = new Roles();
4508
		return $roles->translate_current_user_to_role();
4509
	}
4510
4511
	/**
4512
	 * Get the role of a particular user.
4513
	 *
4514
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4515
	 *
4516
	 * @access public
4517
	 * @static
4518
	 *
4519
	 * @param \WP_User $user User object.
4520
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4521
	 */
4522
	public static function translate_user_to_role( $user ) {
4523
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4524
4525
		$roles = new Roles();
4526
		return $roles->translate_user_to_role( $user );
4527
	}
4528
4529
	/**
4530
	 * Get the minimum capability for a role.
4531
	 *
4532
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4533
	 *
4534
	 * @access public
4535
	 * @static
4536
	 *
4537
	 * @param string $role Role name.
4538
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4539
	 */
4540
	public static function translate_role_to_cap( $role ) {
4541
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4542
4543
		$roles = new Roles();
4544
		return $roles->translate_role_to_cap( $role );
4545
	}
4546
4547
	/**
4548
	 * Sign a user role with the master access token.
4549
	 * If not specified, will default to the current user.
4550
	 *
4551
	 * @deprecated since 7.7
4552
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4553
	 *
4554
	 * @access public
4555
	 * @static
4556
	 *
4557
	 * @param string $role    User role.
4558
	 * @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...
4559
	 * @return string Signed user role.
4560
	 */
4561
	public static function sign_role( $role, $user_id = null ) {
4562
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4563
		return self::connection()->sign_role( $role, $user_id );
4564
	}
4565
4566
	/**
4567
	 * Builds a URL to the Jetpack connection auth page
4568
	 *
4569
	 * @since 3.9.5
4570
	 *
4571
	 * @param bool        $raw If true, URL will not be escaped.
4572
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4573
	 *                              If string, will be a custom redirect.
4574
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4575
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4576
	 *
4577
	 * @return string Connect URL
4578
	 */
4579
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4580
		$site_id    = Jetpack_Options::get_option( 'id' );
4581
		$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...
4582
4583
		if ( $register || ! $blog_token || ! $site_id ) {
4584
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4585
4586
			if ( ! empty( $redirect ) ) {
4587
				$url = add_query_arg(
4588
					'redirect',
4589
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4590
					$url
4591
				);
4592
			}
4593
4594
			if ( is_network_admin() ) {
4595
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4596
			}
4597
4598
			$calypso_env = self::get_calypso_env();
4599
4600
			if ( ! empty( $calypso_env ) ) {
4601
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4602
			}
4603
		} else {
4604
4605
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4606
			// because otherwise this logic can get us in to a loop.
4607
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4608
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4609
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4610
4611
				$response = Client::wpcom_json_api_request_as_blog(
4612
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4613
					'1.1'
4614
				);
4615
4616
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4617
4618
					// Generating a register URL instead to refresh the existing token
4619
					return $this->build_connect_url( $raw, $redirect, $from, true );
4620
				}
4621
			}
4622
4623
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4579 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...
4624
		}
4625
4626
		if ( $from ) {
4627
			$url = add_query_arg( 'from', $from, $url );
4628
		}
4629
4630
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4631
		/**
4632
		 * Filter the URL used when connecting a user to a WordPress.com account.
4633
		 *
4634
		 * @since 8.1.0
4635
		 *
4636
		 * @param string $url Connection URL.
4637
		 * @param bool   $raw If true, URL will not be escaped.
4638
		 */
4639
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4640
	}
4641
4642
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4643
4644
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4645
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4646
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4647
4648
		if ( $iframe ) {
4649
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4650
		}
4651
4652
		$c8n = self::connection();
4653
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$redirect 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...
4654
4655
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4656
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4657
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4658
4659
		if ( $iframe ) {
4660
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4661
		}
4662
4663
		return $url;
4664
	}
4665
4666
	/**
4667
	 * Filters the connection URL parameter array.
4668
	 *
4669
	 * @param Array $args default URL parameters used by the package.
4670
	 * @return Array the modified URL arguments array.
4671
	 */
4672
	public static function filter_connect_request_body( $args ) {
4673
		if (
4674
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4675
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4676
		) {
4677
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4678
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4679
				? $gp_locale->slug
4680
				: '';
4681
		}
4682
4683
		$tracking        = new Tracking();
4684
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4685
4686
		$args = array_merge(
4687
			$args,
4688
			array(
4689
				'_ui' => $tracks_identity['_ui'],
4690
				'_ut' => $tracks_identity['_ut'],
4691
			)
4692
		);
4693
4694
		$calypso_env = self::get_calypso_env();
4695
4696
		if ( ! empty( $calypso_env ) ) {
4697
			$args['calypso_env'] = $calypso_env;
4698
		}
4699
4700
		return $args;
4701
	}
4702
4703
	/**
4704
	 * Filters the URL that will process the connection data. It can be different from the URL
4705
	 * that we send the user to after everything is done.
4706
	 *
4707
	 * @param String $processing_url the default redirect URL used by the package.
4708
	 * @return String the modified URL.
4709
	 */
4710
	public static function filter_connect_processing_url( $processing_url ) {
4711
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4712
		return $processing_url;
4713
	}
4714
4715
	/**
4716
	 * Filters the redirection URL that is used for connect requests. The redirect
4717
	 * URL should return the user back to the Jetpack console.
4718
	 *
4719
	 * @param String $redirect the default redirect URL used by the package.
4720
	 * @return String the modified URL.
4721
	 */
4722
	public static function filter_connect_redirect_url( $redirect ) {
4723
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4724
		$redirect           = $redirect
4725
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4726
			: $jetpack_admin_page;
4727
4728
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4729
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4730
		}
4731
4732
		return $redirect;
4733
	}
4734
4735
	/**
4736
	 * This action fires at the beginning of the Manager::authorize method.
4737
	 */
4738
	public static function authorize_starting() {
4739
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4740
		// Checking if site has been active/connected previously before recording unique connection.
4741
		if ( ! $jetpack_unique_connection ) {
4742
			// jetpack_unique_connection option has never been set.
4743
			$jetpack_unique_connection = array(
4744
				'connected'    => 0,
4745
				'disconnected' => 0,
4746
				'version'      => '3.6.1',
4747
			);
4748
4749
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4750
4751
			// Track unique connection.
4752
			$jetpack = self::init();
4753
4754
			$jetpack->stat( 'connections', 'unique-connection' );
4755
			$jetpack->do_stats( 'server_side' );
4756
		}
4757
4758
		// Increment number of times connected.
4759
		$jetpack_unique_connection['connected'] += 1;
4760
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4761
	}
4762
4763
	/**
4764
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4765
	 * linked.
4766
	 */
4767
	public static function authorize_ending_linked() {
4768
		// Don't activate anything since we are just connecting a user.
4769
		self::state( 'message', 'linked' );
4770
	}
4771
4772
	/**
4773
	 * This action fires at the end of the Manager::authorize method when the master user is
4774
	 * authorized.
4775
	 *
4776
	 * @param array $data The request data.
4777
	 */
4778
	public static function authorize_ending_authorized( $data ) {
4779
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4780
		self::invalidate_onboarding_token();
4781
4782
		// If redirect_uri is SSO, ensure SSO module is enabled.
4783
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4784
4785
		/** This filter is documented in class.jetpack-cli.php */
4786
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4787
4788
		$activate_sso = (
4789
			isset( $redirect_options['action'] ) &&
4790
			'jetpack-sso' === $redirect_options['action'] &&
4791
			$jetpack_start_enable_sso
4792
		);
4793
4794
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4795
4796
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4797
	}
4798
4799
	/**
4800
	 * Get our assumed site creation date.
4801
	 * Calculated based on the earlier date of either:
4802
	 * - Earliest admin user registration date.
4803
	 * - Earliest date of post of any post type.
4804
	 *
4805
	 * @since 7.2.0
4806
	 * @deprecated since 7.8.0
4807
	 *
4808
	 * @return string Assumed site creation date and time.
4809
	 */
4810
	public static function get_assumed_site_creation_date() {
4811
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4812
		return self::connection()->get_assumed_site_creation_date();
4813
	}
4814
4815 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4816
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4817
4818
		if ( $activation_source_name ) {
4819
			$args['_as'] = urlencode( $activation_source_name );
4820
		}
4821
4822
		if ( $activation_source_keyword ) {
4823
			$args['_ak'] = urlencode( $activation_source_keyword );
4824
		}
4825
	}
4826
4827
	function build_reconnect_url( $raw = false ) {
4828
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4829
		return $raw ? $url : esc_url( $url );
4830
	}
4831
4832
	public static function admin_url( $args = null ) {
4833
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4834
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4835
		return $url;
4836
	}
4837
4838
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4839
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4840
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4841
	}
4842
4843
	function dismiss_jetpack_notice() {
4844
4845
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4846
			return;
4847
		}
4848
4849
		switch ( $_GET['jetpack-notice'] ) {
4850
			case 'dismiss':
4851
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4852
4853
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4854
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4855
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4856
				}
4857
				break;
4858
		}
4859
	}
4860
4861
	public static function sort_modules( $a, $b ) {
4862
		if ( $a['sort'] == $b['sort'] ) {
4863
			return 0;
4864
		}
4865
4866
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4867
	}
4868
4869
	function ajax_recheck_ssl() {
4870
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4871
		$result = self::permit_ssl( true );
4872
		wp_send_json(
4873
			array(
4874
				'enabled' => $result,
4875
				'message' => get_transient( 'jetpack_https_test_message' ),
4876
			)
4877
		);
4878
	}
4879
4880
	/* Client API */
4881
4882
	/**
4883
	 * Returns the requested Jetpack API URL
4884
	 *
4885
	 * @deprecated since 7.7
4886
	 * @return string
4887
	 */
4888
	public static function api_url( $relative_url ) {
4889
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4890
		$connection = self::connection();
4891
		return $connection->api_url( $relative_url );
4892
	}
4893
4894
	/**
4895
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
4896
	 *
4897
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4898
	 */
4899
	public static function fix_url_for_bad_hosts( $url ) {
4900
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
4901
		return Connection_Utils::fix_url_for_bad_hosts( $url );
4902
	}
4903
4904
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4905
		// Default to a blog token.
4906
		$token_type = 'blog';
4907
4908
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4909
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4910
			if ( ! empty( $_GET['onboarding'] ) ) {
4911
				$jpo = $_GET;
4912
			} else {
4913
				$jpo = json_decode( $request_data, true );
4914
			}
4915
4916
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4917
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4918
4919
			if (
4920
				isset( $jpo_user )
4921
				&& isset( $jpo_token )
4922
				&& is_email( $jpo_user )
4923
				&& ctype_alnum( $jpo_token )
4924
				&& isset( $_GET['rest_route'] )
4925
				&& self::validate_onboarding_token_action(
4926
					$jpo_token,
4927
					$_GET['rest_route']
4928
				)
4929
			) {
4930
				$jp_user = get_user_by( 'email', $jpo_user );
4931
				if ( is_a( $jp_user, 'WP_User' ) ) {
4932
					wp_set_current_user( $jp_user->ID );
4933
					$user_can = is_multisite()
4934
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4935
						: current_user_can( 'manage_options' );
4936
					if ( $user_can ) {
4937
						$token_type              = 'user';
4938
						$token->external_user_id = $jp_user->ID;
4939
					}
4940
				}
4941
			}
4942
4943
			$token_data['type']    = $token_type;
4944
			$token_data['user_id'] = $token->external_user_id;
4945
		}
4946
4947
		return $token_data;
4948
	}
4949
4950
	/**
4951
	 * Create a random secret for validating onboarding payload
4952
	 *
4953
	 * @return string Secret token
4954
	 */
4955
	public static function create_onboarding_token() {
4956
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4957
			$token = wp_generate_password( 32, false );
4958
			Jetpack_Options::update_option( 'onboarding', $token );
4959
		}
4960
4961
		return $token;
4962
	}
4963
4964
	/**
4965
	 * Remove the onboarding token
4966
	 *
4967
	 * @return bool True on success, false on failure
4968
	 */
4969
	public static function invalidate_onboarding_token() {
4970
		return Jetpack_Options::delete_option( 'onboarding' );
4971
	}
4972
4973
	/**
4974
	 * Validate an onboarding token for a specific action
4975
	 *
4976
	 * @return boolean True if token/action pair is accepted, false if not
4977
	 */
4978
	public static function validate_onboarding_token_action( $token, $action ) {
4979
		// Compare tokens, bail if tokens do not match
4980
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4981
			return false;
4982
		}
4983
4984
		// List of valid actions we can take
4985
		$valid_actions = array(
4986
			'/jetpack/v4/settings',
4987
		);
4988
4989
		// Whitelist the action
4990
		if ( ! in_array( $action, $valid_actions ) ) {
4991
			return false;
4992
		}
4993
4994
		return true;
4995
	}
4996
4997
	/**
4998
	 * Checks to see if the URL is using SSL to connect with Jetpack
4999
	 *
5000
	 * @since 2.3.3
5001
	 * @return boolean
5002
	 */
5003
	public static function permit_ssl( $force_recheck = false ) {
5004
		// Do some fancy tests to see if ssl is being supported
5005
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5006
			$message = '';
5007
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5008
				$ssl = 0;
5009
			} else {
5010
				switch ( JETPACK_CLIENT__HTTPS ) {
5011
					case 'NEVER':
5012
						$ssl     = 0;
5013
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5014
						break;
5015
					case 'ALWAYS':
5016
					case 'AUTO':
5017
					default:
5018
						$ssl = 1;
5019
						break;
5020
				}
5021
5022
				// If it's not 'NEVER', test to see
5023
				if ( $ssl ) {
5024
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5025
						$ssl     = 0;
5026
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5027
					} else {
5028
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5029
						if ( is_wp_error( $response ) ) {
5030
							$ssl     = 0;
5031
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5032
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5033
							$ssl     = 0;
5034
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5035
						}
5036
					}
5037
				}
5038
			}
5039
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5040
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5041
		}
5042
5043
		return (bool) $ssl;
5044
	}
5045
5046
	/*
5047
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5048
	 */
5049
	public function alert_auto_ssl_fail() {
5050
		if ( ! current_user_can( 'manage_options' ) ) {
5051
			return;
5052
		}
5053
5054
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5055
		?>
5056
5057
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5058
			<div class="jp-banner__content">
5059
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5060
				<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>
5061
				<p>
5062
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5063
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5064
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5065
				</p>
5066
				<p>
5067
					<?php
5068
					printf(
5069
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5070
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5071
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5072
					);
5073
					?>
5074
				</p>
5075
			</div>
5076
		</div>
5077
		<style>
5078
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5079
		</style>
5080
		<script type="text/javascript">
5081
			jQuery( document ).ready( function( $ ) {
5082
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5083
					var $this = $( this );
5084
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5085
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5086
					e.preventDefault();
5087
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5088
					$.post( ajaxurl, data )
5089
					  .done( function( response ) {
5090
						  if ( response.enabled ) {
5091
							  $( '#jetpack-ssl-warning' ).hide();
5092
						  } else {
5093
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5094
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5095
						  }
5096
					  }.bind( $this ) );
5097
				} );
5098
			} );
5099
		</script>
5100
5101
		<?php
5102
	}
5103
5104
	/**
5105
	 * Returns the Jetpack XML-RPC API
5106
	 *
5107
	 * @deprecated 8.0 Use Connection_Manager instead.
5108
	 * @return string
5109
	 */
5110
	public static function xmlrpc_api_url() {
5111
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5112
		return self::connection()->xmlrpc_api_url();
5113
	}
5114
5115
	/**
5116
	 * Returns the connection manager object.
5117
	 *
5118
	 * @return Automattic\Jetpack\Connection\Manager
5119
	 */
5120
	public static function connection() {
5121
		return self::init()->connection_manager;
5122
	}
5123
5124
	/**
5125
	 * Creates two secret tokens and the end of life timestamp for them.
5126
	 *
5127
	 * Note these tokens are unique per call, NOT static per site for connecting.
5128
	 *
5129
	 * @since 2.6
5130
	 * @param String  $action  The action name.
5131
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be false|integer?

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...
5132
	 * @param Integer $exp     Expiration time in seconds.
5133
	 * @return array
5134
	 */
5135
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5136
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5137
	}
5138
5139
	public static function get_secrets( $action, $user_id ) {
5140
		$secrets = self::connection()->get_secrets( $action, $user_id );
5141
5142
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5143
			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...
5144
		}
5145
5146
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5147
			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...
5148
		}
5149
5150
		return $secrets;
5151
	}
5152
5153
	/**
5154
	 * @deprecated 7.5 Use Connection_Manager instead.
5155
	 *
5156
	 * @param $action
5157
	 * @param $user_id
5158
	 */
5159
	public static function delete_secrets( $action, $user_id ) {
5160
		return self::connection()->delete_secrets( $action, $user_id );
5161
	}
5162
5163
	/**
5164
	 * Builds the timeout limit for queries talking with the wpcom servers.
5165
	 *
5166
	 * Based on local php max_execution_time in php.ini
5167
	 *
5168
	 * @since 2.6
5169
	 * @return int
5170
	 * @deprecated
5171
	 **/
5172
	public function get_remote_query_timeout_limit() {
5173
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5174
		return self::get_max_execution_time();
5175
	}
5176
5177
	/**
5178
	 * Builds the timeout limit for queries talking with the wpcom servers.
5179
	 *
5180
	 * Based on local php max_execution_time in php.ini
5181
	 *
5182
	 * @since 5.4
5183
	 * @return int
5184
	 **/
5185
	public static function get_max_execution_time() {
5186
		$timeout = (int) ini_get( 'max_execution_time' );
5187
5188
		// Ensure exec time set in php.ini
5189
		if ( ! $timeout ) {
5190
			$timeout = 30;
5191
		}
5192
		return $timeout;
5193
	}
5194
5195
	/**
5196
	 * Sets a minimum request timeout, and returns the current timeout
5197
	 *
5198
	 * @since 5.4
5199
	 **/
5200 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5201
		$timeout = self::get_max_execution_time();
5202
		if ( $timeout < $min_timeout ) {
5203
			$timeout = $min_timeout;
5204
			set_time_limit( $timeout );
5205
		}
5206
		return $timeout;
5207
	}
5208
5209
	/**
5210
	 * Takes the response from the Jetpack register new site endpoint and
5211
	 * verifies it worked properly.
5212
	 *
5213
	 * @since 2.6
5214
	 * @deprecated since 7.7.0
5215
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5216
	 **/
5217
	public function validate_remote_register_response() {
5218
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5219
	}
5220
5221
	/**
5222
	 * @return bool|WP_Error
5223
	 */
5224
	public static function register() {
5225
		$tracking = new Tracking();
5226
		$tracking->record_user_event( 'jpc_register_begin' );
5227
5228
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5229
5230
		$connection   = self::connection();
5231
		$registration = $connection->register();
5232
5233
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5234
5235
		if ( ! $registration || is_wp_error( $registration ) ) {
5236
			return $registration;
5237
		}
5238
5239
		return true;
5240
	}
5241
5242
	/**
5243
	 * Filters the registration request body to include tracking properties.
5244
	 *
5245
	 * @param Array $properties
5246
	 * @return Array amended properties.
5247
	 */
5248 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5249
		$tracking        = new Tracking();
5250
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5251
5252
		return array_merge(
5253
			$properties,
5254
			array(
5255
				'_ui' => $tracks_identity['_ui'],
5256
				'_ut' => $tracks_identity['_ut'],
5257
			)
5258
		);
5259
	}
5260
5261
	/**
5262
	 * Filters the token request body to include tracking properties.
5263
	 *
5264
	 * @param Array $properties
5265
	 * @return Array amended properties.
5266
	 */
5267 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5268
		$tracking        = new Tracking();
5269
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5270
5271
		return array_merge(
5272
			$properties,
5273
			array(
5274
				'_ui' => $tracks_identity['_ui'],
5275
				'_ut' => $tracks_identity['_ut'],
5276
			)
5277
		);
5278
	}
5279
5280
	/**
5281
	 * If the db version is showing something other that what we've got now, bump it to current.
5282
	 *
5283
	 * @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...
5284
	 */
5285
	public static function maybe_set_version_option() {
5286
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5287
		if ( JETPACK__VERSION != $version ) {
5288
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5289
5290
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5291
				/** This action is documented in class.jetpack.php */
5292
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5293
			}
5294
5295
			return true;
5296
		}
5297
		return false;
5298
	}
5299
5300
	/* Client Server API */
5301
5302
	/**
5303
	 * Loads the Jetpack XML-RPC client.
5304
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5305
	 *
5306
	 * @deprecated since 7.7.0
5307
	 */
5308
	public static function load_xml_rpc_client() {
5309
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5310
	}
5311
5312
	/**
5313
	 * Resets the saved authentication state in between testing requests.
5314
	 */
5315
	public function reset_saved_auth_state() {
5316
		$this->rest_authentication_status = null;
5317
		$this->connection_manager->reset_saved_auth_state();
5318
	}
5319
5320
	/**
5321
	 * Verifies the signature of the current request.
5322
	 *
5323
	 * @deprecated since 7.7.0
5324
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5325
	 *
5326
	 * @return false|array
5327
	 */
5328
	public function verify_xml_rpc_signature() {
5329
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5330
		return self::connection()->verify_xml_rpc_signature();
5331
	}
5332
5333
	/**
5334
	 * Verifies the signature of the current request.
5335
	 *
5336
	 * This function has side effects and should not be used. Instead,
5337
	 * use the memoized version `->verify_xml_rpc_signature()`.
5338
	 *
5339
	 * @deprecated since 7.7.0
5340
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5341
	 * @internal
5342
	 */
5343
	private function internal_verify_xml_rpc_signature() {
5344
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5345
	}
5346
5347
	/**
5348
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5349
	 *
5350
	 * @deprecated since 7.7.0
5351
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5352
	 *
5353
	 * @param \WP_User|mixed $user     User object if authenticated.
5354
	 * @param string         $username Username.
5355
	 * @param string         $password Password string.
5356
	 * @return \WP_User|mixed Authenticated user or error.
5357
	 */
5358
	public function authenticate_jetpack( $user, $username, $password ) {
5359
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5360
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5361
	}
5362
5363
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5364
	// Uses the existing XMLRPC request signing implementation.
5365
	function wp_rest_authenticate( $user ) {
5366
		if ( ! empty( $user ) ) {
5367
			// Another authentication method is in effect.
5368
			return $user;
5369
		}
5370
5371
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5372
			// Nothing to do for this authentication method.
5373
			return null;
5374
		}
5375
5376
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5377
			// Nothing to do for this authentication method.
5378
			return null;
5379
		}
5380
5381
		// Ensure that we always have the request body available.  At this
5382
		// point, the WP REST API code to determine the request body has not
5383
		// run yet.  That code may try to read from 'php://input' later, but
5384
		// this can only be done once per request in PHP versions prior to 5.6.
5385
		// So we will go ahead and perform this read now if needed, and save
5386
		// the request body where both the Jetpack signature verification code
5387
		// and the WP REST API code can see it.
5388
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5389
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5390
		}
5391
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5392
5393
		// Only support specific request parameters that have been tested and
5394
		// are known to work with signature verification.  A different method
5395
		// can be passed to the WP REST API via the '?_method=' parameter if
5396
		// needed.
5397
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5398
			$this->rest_authentication_status = new WP_Error(
5399
				'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...
5400
				__( 'This request method is not supported.', 'jetpack' ),
5401
				array( 'status' => 400 )
5402
			);
5403
			return null;
5404
		}
5405
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5406
			$this->rest_authentication_status = new WP_Error(
5407
				'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...
5408
				__( 'This request method does not support body parameters.', 'jetpack' ),
5409
				array( 'status' => 400 )
5410
			);
5411
			return null;
5412
		}
5413
5414
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5415
5416
		if (
5417
			$verified &&
5418
			isset( $verified['type'] ) &&
5419
			'user' === $verified['type'] &&
5420
			! empty( $verified['user_id'] )
5421
		) {
5422
			// Authentication successful.
5423
			$this->rest_authentication_status = true;
5424
			return $verified['user_id'];
5425
		}
5426
5427
		// Something else went wrong.  Probably a signature error.
5428
		$this->rest_authentication_status = new WP_Error(
5429
			'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...
5430
			__( 'The request is not signed correctly.', 'jetpack' ),
5431
			array( 'status' => 400 )
5432
		);
5433
		return null;
5434
	}
5435
5436
	/**
5437
	 * Report authentication status to the WP REST API.
5438
	 *
5439
	 * @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...
5440
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5441
	 */
5442
	public function wp_rest_authentication_errors( $value ) {
5443
		if ( $value !== null ) {
5444
			return $value;
5445
		}
5446
		return $this->rest_authentication_status;
5447
	}
5448
5449
	/**
5450
	 * Add our nonce to this request.
5451
	 *
5452
	 * @deprecated since 7.7.0
5453
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5454
	 *
5455
	 * @param int    $timestamp Timestamp of the request.
5456
	 * @param string $nonce     Nonce string.
5457
	 */
5458
	public function add_nonce( $timestamp, $nonce ) {
5459
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5460
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5461
	}
5462
5463
	/**
5464
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5465
	 * Capture it here so we can verify the signature later.
5466
	 *
5467
	 * @deprecated since 7.7.0
5468
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5469
	 *
5470
	 * @param array $methods XMLRPC methods.
5471
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5472
	 */
5473
	public function xmlrpc_methods( $methods ) {
5474
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5475
		return $this->connection_manager->xmlrpc_methods( $methods );
5476
	}
5477
5478
	/**
5479
	 * Register additional public XMLRPC methods.
5480
	 *
5481
	 * @deprecated since 7.7.0
5482
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5483
	 *
5484
	 * @param array $methods Public XMLRPC methods.
5485
	 * @return array Public XMLRPC methods, with the getOptions one.
5486
	 */
5487
	public function public_xmlrpc_methods( $methods ) {
5488
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5489
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5490
	}
5491
5492
	/**
5493
	 * Handles a getOptions XMLRPC method call.
5494
	 *
5495
	 * @deprecated since 7.7.0
5496
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5497
	 *
5498
	 * @param array $args method call arguments.
5499
	 * @return array an amended XMLRPC server options array.
5500
	 */
5501
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5502
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5503
		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...
5504
	}
5505
5506
	/**
5507
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5508
	 *
5509
	 * @deprecated since 7.7.0
5510
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5511
	 *
5512
	 * @param array $options Standard Core options.
5513
	 * @return array Amended options.
5514
	 */
5515
	public function xmlrpc_options( $options ) {
5516
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5517
		return $this->connection_manager->xmlrpc_options( $options );
5518
	}
5519
5520
	/**
5521
	 * Cleans nonces that were saved when calling ::add_nonce.
5522
	 *
5523
	 * @deprecated since 7.7.0
5524
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5525
	 *
5526
	 * @param bool $all whether to clean even non-expired nonces.
5527
	 */
5528
	public static function clean_nonces( $all = false ) {
5529
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5530
		return self::connection()->clean_nonces( $all );
5531
	}
5532
5533
	/**
5534
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5535
	 * SET: state( $key, $value );
5536
	 * GET: $value = state( $key );
5537
	 *
5538
	 * @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...
5539
	 * @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...
5540
	 * @param bool   $restate private
5541
	 */
5542
	public static function state( $key = null, $value = null, $restate = false ) {
5543
		static $state = array();
5544
		static $path, $domain;
5545
		if ( ! isset( $path ) ) {
5546
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5547
			$admin_url = self::admin_url();
5548
			$bits      = wp_parse_url( $admin_url );
5549
5550
			if ( is_array( $bits ) ) {
5551
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5552
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5553
			} else {
5554
				$path = $domain = null;
5555
			}
5556
		}
5557
5558
		// Extract state from cookies and delete cookies
5559
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5560
			$yum = $_COOKIE['jetpackState'];
5561
			unset( $_COOKIE['jetpackState'] );
5562
			foreach ( $yum as $k => $v ) {
5563
				if ( strlen( $v ) ) {
5564
					$state[ $k ] = $v;
5565
				}
5566
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5567
			}
5568
		}
5569
5570
		if ( $restate ) {
5571
			foreach ( $state as $k => $v ) {
5572
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5573
			}
5574
			return;
5575
		}
5576
5577
		// Get a state variable
5578
		if ( isset( $key ) && ! isset( $value ) ) {
5579
			if ( array_key_exists( $key, $state ) ) {
5580
				return $state[ $key ];
5581
			}
5582
			return null;
5583
		}
5584
5585
		// Set a state variable
5586
		if ( isset( $key ) && isset( $value ) ) {
5587
			if ( is_array( $value ) && isset( $value[0] ) ) {
5588
				$value = $value[0];
5589
			}
5590
			$state[ $key ] = $value;
5591
			if ( ! headers_sent() ) {
5592
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5593
			}
5594
		}
5595
	}
5596
5597
	public static function restate() {
5598
		self::state( null, null, true );
5599
	}
5600
5601
	public static function check_privacy( $file ) {
5602
		static $is_site_publicly_accessible = null;
5603
5604
		if ( is_null( $is_site_publicly_accessible ) ) {
5605
			$is_site_publicly_accessible = false;
5606
5607
			$rpc = new Jetpack_IXR_Client();
5608
5609
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5610
			if ( $success ) {
5611
				$response = $rpc->getResponse();
5612
				if ( $response ) {
5613
					$is_site_publicly_accessible = true;
5614
				}
5615
			}
5616
5617
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5618
		}
5619
5620
		if ( $is_site_publicly_accessible ) {
5621
			return;
5622
		}
5623
5624
		$module_slug = self::get_module_slug( $file );
5625
5626
		$privacy_checks = self::state( 'privacy_checks' );
5627
		if ( ! $privacy_checks ) {
5628
			$privacy_checks = $module_slug;
5629
		} else {
5630
			$privacy_checks .= ",$module_slug";
5631
		}
5632
5633
		self::state( 'privacy_checks', $privacy_checks );
5634
	}
5635
5636
	/**
5637
	 * Helper method for multicall XMLRPC.
5638
	 *
5639
	 * @param ...$args Args for the async_call.
5640
	 */
5641
	public static function xmlrpc_async_call( ...$args ) {
5642
		global $blog_id;
5643
		static $clients = array();
5644
5645
		$client_blog_id = is_multisite() ? $blog_id : 0;
5646
5647
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5648
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5649
			if ( function_exists( 'ignore_user_abort' ) ) {
5650
				ignore_user_abort( true );
5651
			}
5652
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5653
		}
5654
5655
		if ( ! empty( $args[0] ) ) {
5656
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5657
		} elseif ( is_multisite() ) {
5658
			foreach ( $clients as $client_blog_id => $client ) {
5659
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5660
					continue;
5661
				}
5662
5663
				$switch_success = switch_to_blog( $client_blog_id, true );
5664
				if ( ! $switch_success ) {
5665
					continue;
5666
				}
5667
5668
				flush();
5669
				$client->query();
5670
5671
				restore_current_blog();
5672
			}
5673
		} else {
5674
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5675
				flush();
5676
				$clients[0]->query();
5677
			}
5678
		}
5679
	}
5680
5681
	public static function staticize_subdomain( $url ) {
5682
5683
		// Extract hostname from URL
5684
		$host = wp_parse_url( $url, PHP_URL_HOST );
5685
5686
		// Explode hostname on '.'
5687
		$exploded_host = explode( '.', $host );
5688
5689
		// Retrieve the name and TLD
5690
		if ( count( $exploded_host ) > 1 ) {
5691
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5692
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5693
			// Rebuild domain excluding subdomains
5694
			$domain = $name . '.' . $tld;
5695
		} else {
5696
			$domain = $host;
5697
		}
5698
		// Array of Automattic domains
5699
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5700
5701
		// Return $url if not an Automattic domain
5702
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5703
			return $url;
5704
		}
5705
5706
		if ( is_ssl() ) {
5707
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5708
		}
5709
5710
		srand( crc32( basename( $url ) ) );
5711
		$static_counter = rand( 0, 2 );
5712
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5713
5714
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5715
	}
5716
5717
	/* JSON API Authorization */
5718
5719
	/**
5720
	 * Handles the login action for Authorizing the JSON API
5721
	 */
5722
	function login_form_json_api_authorization() {
5723
		$this->verify_json_api_authorization_request();
5724
5725
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5726
5727
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5728
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5729
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5730
	}
5731
5732
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5733
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5734
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5735
			return $url;
5736
		}
5737
5738
		$parsed_url = wp_parse_url( $url );
5739
		$url        = strtok( $url, '?' );
5740
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5741
		if ( ! empty( $parsed_url['query'] ) ) {
5742
			$url .= "&{$parsed_url['query']}";
5743
		}
5744
5745
		return $url;
5746
	}
5747
5748
	// Make sure the POSTed request is handled by the same action
5749
	function preserve_action_in_login_form_for_json_api_authorization() {
5750
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5751
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5752
	}
5753
5754
	// If someone logs in to approve API access, store the Access Code in usermeta
5755
	function store_json_api_authorization_token( $user_login, $user ) {
5756
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5757
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5758
		$token = wp_generate_password( 32, false );
5759
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5760
	}
5761
5762
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5763
	function allow_wpcom_public_api_domain( $domains ) {
5764
		$domains[] = 'public-api.wordpress.com';
5765
		return $domains;
5766
	}
5767
5768
	static function is_redirect_encoded( $redirect_url ) {
5769
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5770
	}
5771
5772
	// Add all wordpress.com environments to the safe redirect whitelist
5773
	function allow_wpcom_environments( $domains ) {
5774
		$domains[] = 'wordpress.com';
5775
		$domains[] = 'wpcalypso.wordpress.com';
5776
		$domains[] = 'horizon.wordpress.com';
5777
		$domains[] = 'calypso.localhost';
5778
		return $domains;
5779
	}
5780
5781
	// Add the Access Code details to the public-api.wordpress.com redirect
5782
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5783
		return add_query_arg(
5784
			urlencode_deep(
5785
				array(
5786
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5787
					'jetpack-user-id' => (int) $user->ID,
5788
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5789
				)
5790
			),
5791
			$redirect_to
5792
		);
5793
	}
5794
5795
5796
	/**
5797
	 * Verifies the request by checking the signature
5798
	 *
5799
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5800
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5801
	 *
5802
	 * @param null|array $environment
5803
	 */
5804
	function verify_json_api_authorization_request( $environment = null ) {
5805
		$environment = is_null( $environment )
5806
			? $_REQUEST
5807
			: $environment;
5808
5809
		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...
5810
		$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...
5811
		if ( ! $token || empty( $token->secret ) ) {
5812
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5813
		}
5814
5815
		$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' );
5816
5817
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5818
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5819
			/**
5820
			 * Jetpack authorisation request Error.
5821
			 *
5822
			 * @since 7.5.0
5823
			 */
5824
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5825
			$die_error = sprintf(
5826
				/* translators: %s is a URL */
5827
				__( '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' ),
5828
				'https://jetpack.com/support/double-encoding/'
5829
			);
5830
		}
5831
5832
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5833
5834
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5835
			$signature = $jetpack_signature->sign_request(
5836
				$environment['token'],
5837
				$environment['timestamp'],
5838
				$environment['nonce'],
5839
				'',
5840
				'GET',
5841
				$environment['jetpack_json_api_original_query'],
5842
				null,
5843
				true
5844
			);
5845
		} else {
5846
			$signature = $jetpack_signature->sign_current_request(
5847
				array(
5848
					'body'   => null,
5849
					'method' => 'GET',
5850
				)
5851
			);
5852
		}
5853
5854
		if ( ! $signature ) {
5855
			wp_die( $die_error );
5856
		} elseif ( is_wp_error( $signature ) ) {
5857
			wp_die( $die_error );
5858
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5859
			if ( is_ssl() ) {
5860
				// 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
5861
				$signature = $jetpack_signature->sign_current_request(
5862
					array(
5863
						'scheme' => 'http',
5864
						'body'   => null,
5865
						'method' => 'GET',
5866
					)
5867
				);
5868
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5869
					wp_die( $die_error );
5870
				}
5871
			} else {
5872
				wp_die( $die_error );
5873
			}
5874
		}
5875
5876
		$timestamp = (int) $environment['timestamp'];
5877
		$nonce     = stripslashes( (string) $environment['nonce'] );
5878
5879
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5880
			// De-nonce the nonce, at least for 5 minutes.
5881
			// 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)
5882
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5883
			if ( $old_nonce_time < time() - 300 ) {
5884
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5885
			}
5886
		}
5887
5888
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5889
		$data_filters = array(
5890
			'state'        => 'opaque',
5891
			'client_id'    => 'int',
5892
			'client_title' => 'string',
5893
			'client_image' => 'url',
5894
		);
5895
5896
		foreach ( $data_filters as $key => $sanitation ) {
5897
			if ( ! isset( $data->$key ) ) {
5898
				wp_die( $die_error );
5899
			}
5900
5901
			switch ( $sanitation ) {
5902
				case 'int':
5903
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5904
					break;
5905
				case 'opaque':
5906
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5907
					break;
5908
				case 'string':
5909
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5910
					break;
5911
				case 'url':
5912
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5913
					break;
5914
			}
5915
		}
5916
5917
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5918
			wp_die( $die_error );
5919
		}
5920
	}
5921
5922
	function login_message_json_api_authorization( $message ) {
5923
		return '<p class="message">' . sprintf(
5924
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5925
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5926
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5927
	}
5928
5929
	/**
5930
	 * Get $content_width, but with a <s>twist</s> filter.
5931
	 */
5932
	public static function get_content_width() {
5933
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5934
			? $GLOBALS['content_width']
5935
			: false;
5936
		/**
5937
		 * Filter the Content Width value.
5938
		 *
5939
		 * @since 2.2.3
5940
		 *
5941
		 * @param string $content_width Content Width value.
5942
		 */
5943
		return apply_filters( 'jetpack_content_width', $content_width );
5944
	}
5945
5946
	/**
5947
	 * Pings the WordPress.com Mirror Site for the specified options.
5948
	 *
5949
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5950
	 *
5951
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5952
	 */
5953
	public function get_cloud_site_options( $option_names ) {
5954
		$option_names = array_filter( (array) $option_names, 'is_string' );
5955
5956
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5957
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5958
		if ( $xml->isError() ) {
5959
			return array(
5960
				'error_code' => $xml->getErrorCode(),
5961
				'error_msg'  => $xml->getErrorMessage(),
5962
			);
5963
		}
5964
		$cloud_site_options = $xml->getResponse();
5965
5966
		return $cloud_site_options;
5967
	}
5968
5969
	/**
5970
	 * Checks if the site is currently in an identity crisis.
5971
	 *
5972
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5973
	 */
5974
	public static function check_identity_crisis() {
5975
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5976
			return false;
5977
		}
5978
5979
		return Jetpack_Options::get_option( 'sync_error_idc' );
5980
	}
5981
5982
	/**
5983
	 * Checks whether the home and siteurl specifically are whitelisted
5984
	 * Written so that we don't have re-check $key and $value params every time
5985
	 * we want to check if this site is whitelisted, for example in footer.php
5986
	 *
5987
	 * @since  3.8.0
5988
	 * @return bool True = already whitelisted False = not whitelisted
5989
	 */
5990
	public static function is_staging_site() {
5991
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
5992
		return ( new Status() )->is_staging_site();
5993
	}
5994
5995
	/**
5996
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5997
	 *
5998
	 * @since 4.4.0
5999
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6000
	 *
6001
	 * @return bool
6002
	 */
6003
	public static function validate_sync_error_idc_option() {
6004
		$is_valid = false;
6005
6006
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6007
		if ( false === $idc_allowed ) {
6008
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6009
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6010
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6011
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6012
				$transient_duration = HOUR_IN_SECONDS;
6013
			} else {
6014
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6015
				$idc_allowed        = '1';
6016
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6017
			}
6018
6019
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6020
		}
6021
6022
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6023
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6024
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6025
			$local_options = self::get_sync_error_idc_option();
6026
			// Ensure all values are set.
6027
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6028
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6029
					$is_valid = true;
6030
				}
6031
			}
6032
6033
		}
6034
6035
		/**
6036
		 * Filters whether the sync_error_idc option is valid.
6037
		 *
6038
		 * @since 4.4.0
6039
		 *
6040
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6041
		 */
6042
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6043
6044
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6045
			// Since the option exists, and did not validate, delete it
6046
			Jetpack_Options::delete_option( 'sync_error_idc' );
6047
		}
6048
6049
		return $is_valid;
6050
	}
6051
6052
	/**
6053
	 * Normalizes a url by doing three things:
6054
	 *  - Strips protocol
6055
	 *  - Strips www
6056
	 *  - Adds a trailing slash
6057
	 *
6058
	 * @since 4.4.0
6059
	 * @param string $url
6060
	 * @return WP_Error|string
6061
	 */
6062
	public static function normalize_url_protocol_agnostic( $url ) {
6063
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6064
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6065
			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...
6066
		}
6067
6068
		// Strip www and protocols
6069
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6070
		return $url;
6071
	}
6072
6073
	/**
6074
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6075
	 *
6076
	 * @since 4.4.0
6077
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6078
	 *
6079
	 * @param array $response
6080
	 * @return array Array of the local urls, wpcom urls, and error code
6081
	 */
6082
	public static function get_sync_error_idc_option( $response = array() ) {
6083
		// Since the local options will hit the database directly, store the values
6084
		// in a transient to allow for autoloading and caching on subsequent views.
6085
		$local_options = get_transient( 'jetpack_idc_local' );
6086
		if ( false === $local_options ) {
6087
			$local_options = array(
6088
				'home'    => Functions::home_url(),
6089
				'siteurl' => Functions::site_url(),
6090
			);
6091
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6092
		}
6093
6094
		$options = array_merge( $local_options, $response );
6095
6096
		$returned_values = array();
6097
		foreach ( $options as $key => $option ) {
6098
			if ( 'error_code' === $key ) {
6099
				$returned_values[ $key ] = $option;
6100
				continue;
6101
			}
6102
6103
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6104
				continue;
6105
			}
6106
6107
			$returned_values[ $key ] = $normalized_url;
6108
		}
6109
6110
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6111
6112
		return $returned_values;
6113
	}
6114
6115
	/**
6116
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6117
	 * If set to true, the site will be put into staging mode.
6118
	 *
6119
	 * @since 4.3.2
6120
	 * @return bool
6121
	 */
6122
	public static function sync_idc_optin() {
6123
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6124
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6125
		} else {
6126
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6127
		}
6128
6129
		/**
6130
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6131
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6132
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6133
		 *
6134
		 * @since 4.3.2
6135
		 *
6136
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6137
		 */
6138
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6139
	}
6140
6141
	/**
6142
	 * Maybe Use a .min.css stylesheet, maybe not.
6143
	 *
6144
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6145
	 */
6146
	public static function maybe_min_asset( $url, $path, $plugin ) {
6147
		// Short out on things trying to find actual paths.
6148
		if ( ! $path || empty( $plugin ) ) {
6149
			return $url;
6150
		}
6151
6152
		$path = ltrim( $path, '/' );
6153
6154
		// Strip out the abspath.
6155
		$base = dirname( plugin_basename( $plugin ) );
6156
6157
		// Short out on non-Jetpack assets.
6158
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6159
			return $url;
6160
		}
6161
6162
		// File name parsing.
6163
		$file              = "{$base}/{$path}";
6164
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6165
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6166
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6167
		$extension         = array_shift( $file_name_parts_r );
6168
6169
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6170
			// Already pointing at the minified version.
6171
			if ( 'min' === $file_name_parts_r[0] ) {
6172
				return $url;
6173
			}
6174
6175
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6176
			if ( file_exists( $min_full_path ) ) {
6177
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6178
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6179
				if ( 'css' === $extension ) {
6180
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6181
					self::$min_assets[ $key ] = $path;
6182
				}
6183
			}
6184
		}
6185
6186
		return $url;
6187
	}
6188
6189
	/**
6190
	 * If the asset is minified, let's flag .min as the suffix.
6191
	 *
6192
	 * Attached to `style_loader_src` filter.
6193
	 *
6194
	 * @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...
6195
	 * @param string $handle The registered handle of the script in question.
6196
	 * @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...
6197
	 */
6198
	public static function set_suffix_on_min( $src, $handle ) {
6199
		if ( false === strpos( $src, '.min.css' ) ) {
6200
			return $src;
6201
		}
6202
6203
		if ( ! empty( self::$min_assets ) ) {
6204
			foreach ( self::$min_assets as $file => $path ) {
6205
				if ( false !== strpos( $src, $file ) ) {
6206
					wp_style_add_data( $handle, 'suffix', '.min' );
6207
					return $src;
6208
				}
6209
			}
6210
		}
6211
6212
		return $src;
6213
	}
6214
6215
	/**
6216
	 * Maybe inlines a stylesheet.
6217
	 *
6218
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6219
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6220
	 *
6221
	 * Attached to `style_loader_tag` filter.
6222
	 *
6223
	 * @param string $tag The tag that would link to the external asset.
6224
	 * @param string $handle The registered handle of the script in question.
6225
	 *
6226
	 * @return string
6227
	 */
6228
	public static function maybe_inline_style( $tag, $handle ) {
6229
		global $wp_styles;
6230
		$item = $wp_styles->registered[ $handle ];
6231
6232
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6233
			return $tag;
6234
		}
6235
6236
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6237
			$href = $matches[1];
6238
			// Strip off query string
6239
			if ( $pos = strpos( $href, '?' ) ) {
6240
				$href = substr( $href, 0, $pos );
6241
			}
6242
			// Strip off fragment
6243
			if ( $pos = strpos( $href, '#' ) ) {
6244
				$href = substr( $href, 0, $pos );
6245
			}
6246
		} else {
6247
			return $tag;
6248
		}
6249
6250
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6251
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6252
			return $tag;
6253
		}
6254
6255
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6256
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6257
			// And this isn't the pass that actually deals with the RTL version...
6258
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6259
				// Short out, as the RTL version will deal with it in a moment.
6260
				return $tag;
6261
			}
6262
		}
6263
6264
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6265
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6266
		if ( $css ) {
6267
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6268
			if ( empty( $item->extra['after'] ) ) {
6269
				wp_add_inline_style( $handle, $css );
6270
			} else {
6271
				array_unshift( $item->extra['after'], $css );
6272
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6273
			}
6274
		}
6275
6276
		return $tag;
6277
	}
6278
6279
	/**
6280
	 * Loads a view file from the views
6281
	 *
6282
	 * Data passed in with the $data parameter will be available in the
6283
	 * template file as $data['value']
6284
	 *
6285
	 * @param string $template - Template file to load
6286
	 * @param array  $data - Any data to pass along to the template
6287
	 * @return boolean - If template file was found
6288
	 **/
6289
	public function load_view( $template, $data = array() ) {
6290
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6291
6292
		if ( file_exists( $views_dir . $template ) ) {
6293
			require_once $views_dir . $template;
6294
			return true;
6295
		}
6296
6297
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6298
		return false;
6299
	}
6300
6301
	/**
6302
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6303
	 */
6304
	public function deprecated_hooks() {
6305
		global $wp_filter;
6306
6307
		/*
6308
		 * Format:
6309
		 * deprecated_filter_name => replacement_name
6310
		 *
6311
		 * If there is no replacement, use null for replacement_name
6312
		 */
6313
		$deprecated_list = array(
6314
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6315
			'wpl_sharing_2014_1'                           => null,
6316
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6317
			'jetpack_identity_crisis_options_to_check'     => null,
6318
			'update_option_jetpack_single_user_site'       => null,
6319
			'audio_player_default_colors'                  => null,
6320
			'add_option_jetpack_featured_images_enabled'   => null,
6321
			'add_option_jetpack_update_details'            => null,
6322
			'add_option_jetpack_updates'                   => null,
6323
			'add_option_jetpack_network_name'              => null,
6324
			'add_option_jetpack_network_allow_new_registrations' => null,
6325
			'add_option_jetpack_network_add_new_users'     => null,
6326
			'add_option_jetpack_network_site_upload_space' => null,
6327
			'add_option_jetpack_network_upload_file_types' => null,
6328
			'add_option_jetpack_network_enable_administration_menus' => null,
6329
			'add_option_jetpack_is_multi_site'             => null,
6330
			'add_option_jetpack_is_main_network'           => null,
6331
			'add_option_jetpack_main_network_site'         => null,
6332
			'jetpack_sync_all_registered_options'          => null,
6333
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6334
			'jetpack_is_post_mailable'                     => null,
6335
			'jetpack_seo_site_host'                        => null,
6336
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6337
			'jetpack_holiday_snow_option_name'             => null,
6338
			'jetpack_holiday_chance_of_snow'               => null,
6339
			'jetpack_holiday_snow_js_url'                  => null,
6340
			'jetpack_is_holiday_snow_season'               => null,
6341
			'jetpack_holiday_snow_option_updated'          => null,
6342
			'jetpack_holiday_snowing'                      => null,
6343
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6344
			'jetpack_cache_plans'                          => null,
6345
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6346
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6347
			'jetpack_enable_site_verification'             => null,
6348
			'can_display_jetpack_manage_notice'            => null,
6349
			// Removed in Jetpack 7.3.0
6350
			'atd_load_scripts'                             => null,
6351
			'atd_http_post_timeout'                        => null,
6352
			'atd_http_post_error'                          => null,
6353
			'atd_service_domain'                           => null,
6354
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6355
			// Removed in Jetpack 7.9.0
6356
			'jetpack_pwa_manifest'                         => null,
6357
			'jetpack_pwa_background_color'                 => null,
6358
		);
6359
6360
		// This is a silly loop depth. Better way?
6361
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6362
			if ( has_action( $hook ) ) {
6363
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6364
					foreach ( $values as $hooked ) {
6365
						if ( is_callable( $hooked['function'] ) ) {
6366
							$function_name = 'an anonymous function';
6367
						} else {
6368
							$function_name = $hooked['function'];
6369
						}
6370
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6371
					}
6372
				}
6373
			}
6374
		}
6375
	}
6376
6377
	/**
6378
	 * Converts any url in a stylesheet, to the correct absolute url.
6379
	 *
6380
	 * Considerations:
6381
	 *  - Normal, relative URLs     `feh.png`
6382
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6383
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6384
	 *  - Absolute URLs             `http://domain.com/feh.png`
6385
	 *  - Domain root relative URLs `/feh.png`
6386
	 *
6387
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6388
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6389
	 *
6390
	 * @return mixed|string
6391
	 */
6392
	public static function absolutize_css_urls( $css, $css_file_url ) {
6393
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6394
		$css_dir = dirname( $css_file_url );
6395
		$p       = wp_parse_url( $css_dir );
6396
		$domain  = sprintf(
6397
			'%1$s//%2$s%3$s%4$s',
6398
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6399
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6400
			$p['host'],
6401
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6402
		);
6403
6404
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6405
			$find = $replace = array();
6406
			foreach ( $matches as $match ) {
6407
				$url = trim( $match['path'], "'\" \t" );
6408
6409
				// If this is a data url, we don't want to mess with it.
6410
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6411
					continue;
6412
				}
6413
6414
				// If this is an absolute or protocol-agnostic url,
6415
				// we don't want to mess with it.
6416
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6417
					continue;
6418
				}
6419
6420
				switch ( substr( $url, 0, 1 ) ) {
6421
					case '/':
6422
						$absolute = $domain . $url;
6423
						break;
6424
					default:
6425
						$absolute = $css_dir . '/' . $url;
6426
				}
6427
6428
				$find[]    = $match[0];
6429
				$replace[] = sprintf( 'url("%s")', $absolute );
6430
			}
6431
			$css = str_replace( $find, $replace, $css );
6432
		}
6433
6434
		return $css;
6435
	}
6436
6437
	/**
6438
	 * This methods removes all of the registered css files on the front end
6439
	 * from Jetpack in favor of using a single file. In effect "imploding"
6440
	 * all the files into one file.
6441
	 *
6442
	 * Pros:
6443
	 * - Uses only ONE css asset connection instead of 15
6444
	 * - Saves a minimum of 56k
6445
	 * - Reduces server load
6446
	 * - Reduces time to first painted byte
6447
	 *
6448
	 * Cons:
6449
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6450
	 *      should not cause any issues with themes.
6451
	 * - Plugins/themes dequeuing styles no longer do anything. See
6452
	 *      jetpack_implode_frontend_css filter for a workaround
6453
	 *
6454
	 * For some situations developers may wish to disable css imploding and
6455
	 * instead operate in legacy mode where each file loads seperately and
6456
	 * can be edited individually or dequeued. This can be accomplished with
6457
	 * the following line:
6458
	 *
6459
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6460
	 *
6461
	 * @since 3.2
6462
	 **/
6463
	public function implode_frontend_css( $travis_test = false ) {
6464
		$do_implode = true;
6465
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6466
			$do_implode = false;
6467
		}
6468
6469
		// Do not implode CSS when the page loads via the AMP plugin.
6470
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6471
			$do_implode = false;
6472
		}
6473
6474
		/**
6475
		 * Allow CSS to be concatenated into a single jetpack.css file.
6476
		 *
6477
		 * @since 3.2.0
6478
		 *
6479
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6480
		 */
6481
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6482
6483
		// Do not use the imploded file when default behavior was altered through the filter
6484
		if ( ! $do_implode ) {
6485
			return;
6486
		}
6487
6488
		// We do not want to use the imploded file in dev mode, or if not connected
6489
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6490
			if ( ! $travis_test ) {
6491
				return;
6492
			}
6493
		}
6494
6495
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6496
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6497
			return;
6498
		}
6499
6500
		/*
6501
		 * Now we assume Jetpack is connected and able to serve the single
6502
		 * file.
6503
		 *
6504
		 * In the future there will be a check here to serve the file locally
6505
		 * or potentially from the Jetpack CDN
6506
		 *
6507
		 * For now:
6508
		 * - Enqueue a single imploded css file
6509
		 * - Zero out the style_loader_tag for the bundled ones
6510
		 * - Be happy, drink scotch
6511
		 */
6512
6513
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6514
6515
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6516
6517
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6518
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6519
	}
6520
6521
	function concat_remove_style_loader_tag( $tag, $handle ) {
6522
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6523
			$tag = '';
6524
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6525
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6526
			}
6527
		}
6528
6529
		return $tag;
6530
	}
6531
6532
	/**
6533
	 * Add an async attribute to scripts that can be loaded asynchronously.
6534
	 * https://www.w3schools.com/tags/att_script_async.asp
6535
	 *
6536
	 * @since 7.7.0
6537
	 *
6538
	 * @param string $tag    The <script> tag for the enqueued script.
6539
	 * @param string $handle The script's registered handle.
6540
	 * @param string $src    The script's source URL.
6541
	 */
6542
	public function script_add_async( $tag, $handle, $src ) {
6543
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6544
			return preg_replace( '/^<script /i', '<script async ', $tag );
6545
		}
6546
6547
		return $tag;
6548
	}
6549
6550
	/*
6551
	 * Check the heartbeat data
6552
	 *
6553
	 * Organizes the heartbeat data by severity.  For example, if the site
6554
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6555
	 *
6556
	 * Data will be added to "caution" array, if it either:
6557
	 *  - Out of date Jetpack version
6558
	 *  - Out of date WP version
6559
	 *  - Out of date PHP version
6560
	 *
6561
	 * $return array $filtered_data
6562
	 */
6563
	public static function jetpack_check_heartbeat_data() {
6564
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6565
6566
		$good    = array();
6567
		$caution = array();
6568
		$bad     = array();
6569
6570
		foreach ( $raw_data as $stat => $value ) {
6571
6572
			// Check jetpack version
6573
			if ( 'version' == $stat ) {
6574
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6575
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6576
					continue;
6577
				}
6578
			}
6579
6580
			// Check WP version
6581
			if ( 'wp-version' == $stat ) {
6582
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6583
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6584
					continue;
6585
				}
6586
			}
6587
6588
			// Check PHP version
6589
			if ( 'php-version' == $stat ) {
6590
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6591
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6592
					continue;
6593
				}
6594
			}
6595
6596
			// Check ID crisis
6597
			if ( 'identitycrisis' == $stat ) {
6598
				if ( 'yes' == $value ) {
6599
					$bad[ $stat ] = $value;
6600
					continue;
6601
				}
6602
			}
6603
6604
			// The rest are good :)
6605
			$good[ $stat ] = $value;
6606
		}
6607
6608
		$filtered_data = array(
6609
			'good'    => $good,
6610
			'caution' => $caution,
6611
			'bad'     => $bad,
6612
		);
6613
6614
		return $filtered_data;
6615
	}
6616
6617
6618
	/*
6619
	 * This method is used to organize all options that can be reset
6620
	 * without disconnecting Jetpack.
6621
	 *
6622
	 * It is used in class.jetpack-cli.php to reset options
6623
	 *
6624
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6625
	 *
6626
	 * @return array of options to delete.
6627
	 */
6628
	public static function get_jetpack_options_for_reset() {
6629
		return Jetpack_Options::get_options_for_reset();
6630
	}
6631
6632
	/*
6633
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6634
	 * so we can bring them directly to their site in calypso.
6635
	 *
6636
	 * @param string | url
6637
	 * @return string | url without the guff
6638
	 */
6639
	public static function build_raw_urls( $url ) {
6640
		$strip_http = '/.*?:\/\//i';
6641
		$url        = preg_replace( $strip_http, '', $url );
6642
		$url        = str_replace( '/', '::', $url );
6643
		return $url;
6644
	}
6645
6646
	/**
6647
	 * Stores and prints out domains to prefetch for page speed optimization.
6648
	 *
6649
	 * @param mixed $new_urls
6650
	 */
6651
	public static function dns_prefetch( $new_urls = null ) {
6652
		static $prefetch_urls = array();
6653
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6654
			echo "\r\n";
6655
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6656
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6657
			}
6658
		} elseif ( ! empty( $new_urls ) ) {
6659
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6660
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6661
			}
6662
			foreach ( (array) $new_urls as $this_new_url ) {
6663
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6664
			}
6665
			$prefetch_urls = array_unique( $prefetch_urls );
6666
		}
6667
	}
6668
6669
	public function wp_dashboard_setup() {
6670
		if ( self::is_active() ) {
6671
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6672
		}
6673
6674
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6675
			$jetpack_logo = new Jetpack_Logo();
6676
			$widget_title = sprintf(
6677
				wp_kses(
6678
					/* translators: Placeholder is a Jetpack logo. */
6679
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6680
					array( 'span' => array() )
6681
				),
6682
				$jetpack_logo->get_jp_emblem( true )
6683
			);
6684
6685
			wp_add_dashboard_widget(
6686
				'jetpack_summary_widget',
6687
				$widget_title,
6688
				array( __CLASS__, 'dashboard_widget' )
6689
			);
6690
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6691
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6692
6693
			// If we're inactive and not in development mode, sort our box to the top.
6694
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6695
				global $wp_meta_boxes;
6696
6697
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6698
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6699
6700
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6701
			}
6702
		}
6703
	}
6704
6705
	/**
6706
	 * @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...
6707
	 * @return mixed
6708
	 */
6709
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6710
		if ( ! is_array( $sorted ) ) {
6711
			return $sorted;
6712
		}
6713
6714
		foreach ( $sorted as $box_context => $ids ) {
6715
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6716
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6717
				continue;
6718
			}
6719
6720
			$ids_array = explode( ',', $ids );
6721
			$key       = array_search( 'dashboard_stats', $ids_array );
6722
6723
			if ( false !== $key ) {
6724
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6725
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6726
				$sorted[ $box_context ] = implode( ',', $ids_array );
6727
				// We've found it, stop searching, and just return.
6728
				break;
6729
			}
6730
		}
6731
6732
		return $sorted;
6733
	}
6734
6735
	public static function dashboard_widget() {
6736
		/**
6737
		 * Fires when the dashboard is loaded.
6738
		 *
6739
		 * @since 3.4.0
6740
		 */
6741
		do_action( 'jetpack_dashboard_widget' );
6742
	}
6743
6744
	public static function dashboard_widget_footer() {
6745
		?>
6746
		<footer>
6747
6748
		<div class="protect">
6749
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6750
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6751
				<p class="blocked-count">
6752
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6753
				</p>
6754
				<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>
6755
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6756
				<a href="
6757
				<?php
6758
				echo esc_url(
6759
					wp_nonce_url(
6760
						self::admin_url(
6761
							array(
6762
								'action' => 'activate',
6763
								'module' => 'protect',
6764
							)
6765
						),
6766
						'jetpack_activate-protect'
6767
					)
6768
				);
6769
				?>
6770
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6771
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
6772
				</a>
6773
			<?php else : ?>
6774
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
6775
			<?php endif; ?>
6776
		</div>
6777
6778
		<div class="akismet">
6779
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
6780
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6781
				<p class="blocked-count">
6782
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
6783
				</p>
6784
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6785
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6786
				<a href="
6787
				<?php
6788
				echo esc_url(
6789
					wp_nonce_url(
6790
						add_query_arg(
6791
							array(
6792
								'action' => 'activate',
6793
								'plugin' => 'akismet/akismet.php',
6794
							),
6795
							admin_url( 'plugins.php' )
6796
						),
6797
						'activate-plugin_akismet/akismet.php'
6798
					)
6799
				);
6800
				?>
6801
							" class="button button-jetpack">
6802
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
6803
				</a>
6804
			<?php else : ?>
6805
				<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( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6806
			<?php endif; ?>
6807
		</div>
6808
6809
		</footer>
6810
		<?php
6811
	}
6812
6813
	/*
6814
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6815
	 */
6816
	function jetpack_icon_user_connected( $columns ) {
6817
		$columns['user_jetpack'] = '';
6818
		return $columns;
6819
	}
6820
6821
	/*
6822
	 * Show Jetpack icon if the user is linked.
6823
	 */
6824
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6825
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6826
			$jetpack_logo = new Jetpack_Logo();
6827
			$emblem_html  = sprintf(
6828
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6829
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6830
				$jetpack_logo->get_jp_emblem()
6831
			);
6832
			return $emblem_html;
6833
		}
6834
6835
		return $val;
6836
	}
6837
6838
	/*
6839
	 * Style the Jetpack user column
6840
	 */
6841
	function jetpack_user_col_style() {
6842
		global $current_screen;
6843
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6844
			?>
6845
			<style>
6846
				.fixed .column-user_jetpack {
6847
					width: 21px;
6848
				}
6849
				.jp-emblem-user-admin svg {
6850
					width: 20px;
6851
					height: 20px;
6852
				}
6853
				.jp-emblem-user-admin path {
6854
					fill: #00BE28;
6855
				}
6856
			</style>
6857
			<?php
6858
		}
6859
	}
6860
6861
	/**
6862
	 * Checks if Akismet is active and working.
6863
	 *
6864
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6865
	 * that implied usage of methods present since more recent version.
6866
	 * See https://github.com/Automattic/jetpack/pull/9585
6867
	 *
6868
	 * @since  5.1.0
6869
	 *
6870
	 * @return bool True = Akismet available. False = Aksimet not available.
6871
	 */
6872
	public static function is_akismet_active() {
6873
		static $status = null;
6874
6875
		if ( ! is_null( $status ) ) {
6876
			return $status;
6877
		}
6878
6879
		// Check if a modern version of Akismet is active.
6880
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6881
			$status = false;
6882
			return $status;
6883
		}
6884
6885
		// Make sure there is a key known to Akismet at all before verifying key.
6886
		$akismet_key = Akismet::get_api_key();
6887
		if ( ! $akismet_key ) {
6888
			$status = false;
6889
			return $status;
6890
		}
6891
6892
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6893
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6894
6895
		// 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.
6896
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6897
		// We cache the result of the Akismet key verification for ten minutes.
6898
		if ( ! $akismet_key_state || $recheck ) {
6899
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6900
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6901
		}
6902
6903
		$status = 'valid' === $akismet_key_state;
6904
6905
		return $status;
6906
	}
6907
6908
	/**
6909
	 * @deprecated
6910
	 *
6911
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6912
	 */
6913
	public static function is_function_in_backtrace() {
6914
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6915
	}
6916
6917
	/**
6918
	 * Given a minified path, and a non-minified path, will return
6919
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6920
	 *
6921
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6922
	 * root Jetpack directory.
6923
	 *
6924
	 * @since 5.6.0
6925
	 *
6926
	 * @param string $min_path
6927
	 * @param string $non_min_path
6928
	 * @return string The URL to the file
6929
	 */
6930
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6931
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6932
	}
6933
6934
	/**
6935
	 * Checks for whether Jetpack Backup & Scan is enabled.
6936
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6937
	 *
6938
	 * @return bool|int|mixed
6939
	 */
6940
	public static function is_rewind_enabled() {
6941
		if ( ! self::is_active() ) {
6942
			return false;
6943
		}
6944
6945
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6946
		if ( false === $rewind_enabled ) {
6947
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6948
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6949
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6950
				&& ! empty( $rewind_data['state'] )
6951
				&& 'active' === $rewind_data['state'] )
6952
				? 1
6953
				: 0;
6954
6955
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6956
		}
6957
		return $rewind_enabled;
6958
	}
6959
6960
	/**
6961
	 * Return Calypso environment value; used for developing Jetpack and pairing
6962
	 * it with different Calypso enrionments, such as localhost.
6963
	 *
6964
	 * @since 7.4.0
6965
	 *
6966
	 * @return string Calypso environment
6967
	 */
6968
	public static function get_calypso_env() {
6969
		if ( isset( $_GET['calypso_env'] ) ) {
6970
			return sanitize_key( $_GET['calypso_env'] );
6971
		}
6972
6973
		if ( getenv( 'CALYPSO_ENV' ) ) {
6974
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6975
		}
6976
6977
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
6978
			return sanitize_key( CALYPSO_ENV );
6979
		}
6980
6981
		return '';
6982
	}
6983
6984
	/**
6985
	 * Checks whether or not TOS has been agreed upon.
6986
	 * Will return true if a user has clicked to register, or is already connected.
6987
	 */
6988
	public static function jetpack_tos_agreed() {
6989
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
6990
6991
		$terms_of_service = new Terms_Of_Service();
6992
		return $terms_of_service->has_agreed();
6993
6994
	}
6995
6996
	/**
6997
	 * Handles activating default modules as well general cleanup for the new connection.
6998
	 *
6999
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7000
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7001
	 * @param boolean $send_state_messages          Whether to send state messages.
7002
	 * @return void
7003
	 */
7004
	public static function handle_post_authorization_actions(
7005
		$activate_sso = false,
7006
		$redirect_on_activation_error = false,
7007
		$send_state_messages = true
7008
	) {
7009
		$other_modules = $activate_sso
7010
			? array( 'sso' )
7011
			: array();
7012
7013
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7014
			self::delete_active_modules();
7015
7016
			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...
7017
		} else {
7018
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7019
		}
7020
7021
		// Since this is a fresh connection, be sure to clear out IDC options
7022
		Jetpack_IDC::clear_all_idc_options();
7023
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7024
7025
		// Start nonce cleaner
7026
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7027
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7028
7029
		if ( $send_state_messages ) {
7030
			self::state( 'message', 'authorized' );
7031
		}
7032
	}
7033
7034
	/**
7035
	 * Returns a boolean for whether backups UI should be displayed or not.
7036
	 *
7037
	 * @return bool Should backups UI be displayed?
7038
	 */
7039
	public static function show_backups_ui() {
7040
		/**
7041
		 * Whether UI for backups should be displayed.
7042
		 *
7043
		 * @since 6.5.0
7044
		 *
7045
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7046
		 */
7047
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7048
	}
7049
7050
	/*
7051
	 * Deprecated manage functions
7052
	 */
7053
	function prepare_manage_jetpack_notice() {
7054
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7055
	}
7056
	function manage_activate_screen() {
7057
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7058
	}
7059
	function admin_jetpack_manage_notice() {
7060
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7061
	}
7062
	function opt_out_jetpack_manage_url() {
7063
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7064
	}
7065
	function opt_in_jetpack_manage_url() {
7066
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7067
	}
7068
	function opt_in_jetpack_manage_notice() {
7069
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7070
	}
7071
	function can_display_jetpack_manage_notice() {
7072
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7073
	}
7074
7075
	/**
7076
	 * Clean leftoveruser meta.
7077
	 *
7078
	 * Delete Jetpack-related user meta when it is no longer needed.
7079
	 *
7080
	 * @since 7.3.0
7081
	 *
7082
	 * @param int $user_id User ID being updated.
7083
	 */
7084
	public static function user_meta_cleanup( $user_id ) {
7085
		$meta_keys = array(
7086
			// AtD removed from Jetpack 7.3
7087
			'AtD_options',
7088
			'AtD_check_when',
7089
			'AtD_guess_lang',
7090
			'AtD_ignored_phrases',
7091
		);
7092
7093
		foreach ( $meta_keys as $meta_key ) {
7094
			if ( get_user_meta( $user_id, $meta_key ) ) {
7095
				delete_user_meta( $user_id, $meta_key );
7096
			}
7097
		}
7098
	}
7099
7100
	/**
7101
	 * Checks if a Jetpack site is both active and not in development.
7102
	 *
7103
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7104
	 *
7105
	 * @return bool True if Jetpack is active and not in development.
7106
	 */
7107
	public static function is_active_and_not_development_mode() {
7108
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7109
			return false;
7110
		}
7111
		return true;
7112
	}
7113
}
7114