Completed
Push — add/notification-on-plan-upgra... ( 77a3fc )
by
unknown
08:20 queued 14s
created

Jetpack::translate_current_user_to_role()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 6
rs 10
c 0
b 0
f 0
1
<?php
2
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Connection\Client;
5
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
6
use Automattic\Jetpack\Connection\REST_Connector as REST_Connector;
7
use Automattic\Jetpack\Connection\XMLRPC_Connector as XMLRPC_Connector;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Roles;
10
use Automattic\Jetpack\Sync\Functions;
11
use Automattic\Jetpack\Sync\Sender;
12
use Automattic\Jetpack\Sync\Users;
13
use Automattic\Jetpack\Tracking;
14
use Automattic\Jetpack\Assets;
15
16
/*
17
Options:
18
jetpack_options (array)
19
	An array of options.
20
	@see Jetpack_Options::get_option_names()
21
22
jetpack_register (string)
23
	Temporary verification secrets.
24
25
jetpack_activated (int)
26
	1: the plugin was activated normally
27
	2: the plugin was activated on this site because of a network-wide activation
28
	3: the plugin was auto-installed
29
	4: the plugin was manually disconnected (but is still installed)
30
31
jetpack_active_modules (array)
32
	Array of active module slugs.
33
34
jetpack_do_activate (bool)
35
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
36
*/
37
38
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
39
40
class Jetpack {
41
	public $xmlrpc_server = null;
42
43
	private $rest_authentication_status = null;
44
45
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
46
47
	private $tracking;
48
49
	/**
50
	 * @var array The handles of styles that are concatenated into jetpack.css.
51
	 *
52
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
53
	 */
54
	public $concatenated_style_handles = array(
55
		'jetpack-carousel',
56
		'grunion.css',
57
		'the-neverending-homepage',
58
		'jetpack_likes',
59
		'jetpack_related-posts',
60
		'sharedaddy',
61
		'jetpack-slideshow',
62
		'presentations',
63
		'quiz',
64
		'jetpack-subscriptions',
65
		'jetpack-responsive-videos-style',
66
		'jetpack-social-menu',
67
		'tiled-gallery',
68
		'jetpack_display_posts_widget',
69
		'gravatar-profile-widget',
70
		'goodreads-widget',
71
		'jetpack_social_media_icons_widget',
72
		'jetpack-top-posts-widget',
73
		'jetpack_image_widget',
74
		'jetpack-my-community-widget',
75
		'jetpack-authors-widget',
76
		'wordads',
77
		'eu-cookie-law-style',
78
		'flickr-widget-style',
79
		'jetpack-search-widget',
80
		'jetpack-simple-payments-widget-style',
81
		'jetpack-widget-social-icons-styles',
82
	);
83
84
	/**
85
	 * The handles of scripts that can be loaded asynchronously.
86
	 *
87
	 * @var array
88
	 */
89
	public $async_script_handles = array(
90
		'woocommerce-analytics',
91
	);
92
93
	/**
94
	 * Contains all assets that have had their URL rewritten to minified versions.
95
	 *
96
	 * @var array
97
	 */
98
	static $min_assets = array();
99
100
	public $plugins_to_deactivate = array(
101
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
102
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
103
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
104
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
105
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
106
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
107
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
108
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
109
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
110
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
111
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
112
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
113
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
114
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
115
	);
116
117
	/**
118
	 * Map of roles we care about, and their corresponding minimum capabilities.
119
	 *
120
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
121
	 *
122
	 * @access public
123
	 * @static
124
	 *
125
	 * @var array
126
	 */
127
	public static $capability_translations = array(
128
		'administrator' => 'manage_options',
129
		'editor'        => 'edit_others_posts',
130
		'author'        => 'publish_posts',
131
		'contributor'   => 'edit_posts',
132
		'subscriber'    => 'read',
133
	);
134
135
	/**
136
	 * Map of modules that have conflicts with plugins and should not be auto-activated
137
	 * if the plugins are active.  Used by filter_default_modules
138
	 *
139
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
140
	 * change `module-slug` and add this to your plugin:
141
	 *
142
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
143
	 * function my_jetpack_get_default_modules( $modules ) {
144
	 *     return array_diff( $modules, array( 'module-slug' ) );
145
	 * }
146
	 *
147
	 * @var array
148
	 */
149
	private $conflicting_plugins = array(
150
		'comments'          => array(
151
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
152
			'Disqus'                               => 'disqus-comment-system/disqus.php',
153
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
154
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
155
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
156
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
157
		),
158
		'comment-likes' => array(
159
			'Epoch'                                => 'epoch/plugincore.php',
160
		),
161
		'contact-form'      => array(
162
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
163
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
164
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
165
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
166
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
167
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
168
		),
169
		'minileven'         => array(
170
			'WPtouch'                              => 'wptouch/wptouch.php',
171
		),
172
		'latex'             => array(
173
			'LaTeX for WordPress'                  => 'latex/latex.php',
174
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
175
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
176
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
177
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
178
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
179
		),
180
		'protect'           => array(
181
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
182
			'Captcha'                              => 'captcha/captcha.php',
183
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
184
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
185
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
186
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
187
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
188
			'Security-protection'                  => 'security-protection/security-protection.php',
189
			'Login Security'                       => 'login-security/login-security.php',
190
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
191
			'Wordfence Security'                   => 'wordfence/wordfence.php',
192
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
193
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
194
		),
195
		'random-redirect'   => array(
196
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
197
		),
198
		'related-posts'     => array(
199
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
200
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
201
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
202
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
203
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
204
			'outbrain'                             => 'outbrain/outbrain.php',
205
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
206
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
207
		),
208
		'sharedaddy'        => array(
209
			'AddThis'                              => 'addthis/addthis_social_widget.php',
210
			'Add To Any'                           => 'add-to-any/add-to-any.php',
211
			'ShareThis'                            => 'share-this/sharethis.php',
212
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
213
		),
214
		'seo-tools' => array(
215
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
216
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
217
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
218
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
219
			'The SEO Framework'                    => 'autodescription/autodescription.php',
220
		),
221
		'verification-tools' => array(
222
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
223
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
224
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
225
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
226
			'The SEO Framework'                    => 'autodescription/autodescription.php',
227
		),
228
		'widget-visibility' => array(
229
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
230
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
231
		),
232
		'sitemaps' => array(
233
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
234
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
235
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
236
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
237
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
238
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
239
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
240
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
241
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
242
			'The SEO Framework'                    => 'autodescription/autodescription.php',
243
			'Sitemap'                              => 'sitemap/sitemap.php',
244
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
245
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
246
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
247
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
248
		),
249
		'lazy-images' => array(
250
			'Lazy Load'              => 'lazy-load/lazy-load.php',
251
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
252
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
253
		),
254
	);
255
256
	/**
257
	 * Plugins for which we turn off our Facebook OG Tags implementation.
258
	 *
259
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
260
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
261
	 *
262
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
263
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
264
	 */
265
	private $open_graph_conflicting_plugins = array(
266
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
267
		                                                         // 2 Click Social Media Buttons
268
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
269
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
270
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
271
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
272
		                                                         // Open Graph Meta Tags by Heateor
273
		'facebook/facebook.php',                                 // Facebook (official plugin)
274
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
275
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
276
		                                                         // Facebook Featured Image & OG Meta Tags
277
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
278
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
279
		                                                         // Facebook Open Graph Meta Tags for WordPress
280
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
281
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
282
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
283
		                                                         // Fedmich's Facebook Open Graph Meta
284
		'network-publisher/networkpub.php',                      // Network Publisher
285
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
286
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
287
		                                                         // NextScripts SNAP
288
		'og-tags/og-tags.php',                                   // OG Tags
289
		'opengraph/opengraph.php',                               // Open Graph
290
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
291
		                                                         // Open Graph Protocol Framework
292
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
293
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
294
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
295
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
296
		'sharepress/sharepress.php',                             // SharePress
297
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
298
		'social-discussions/social-discussions.php',             // Social Discussions
299
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
300
		'socialize/socialize.php',                               // Socialize
301
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
302
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
303
		                                                         // Tweet, Like, Google +1 and Share
304
		'wordbooker/wordbooker.php',                             // Wordbooker
305
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
306
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
307
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
308
		                                                         // WP Facebook Like Send & Open Graph Meta
309
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
310
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
311
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
312
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
313
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
314
	);
315
316
	/**
317
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
318
	 */
319
	private $twitter_cards_conflicting_plugins = array(
320
	//	'twitter/twitter.php',                       // The official one handles this on its own.
321
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
322
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
323
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
324
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
325
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
326
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
327
		'twitter-cards/twitter-cards.php',           // Twitter Cards
328
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
329
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
330
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
331
	);
332
333
	/**
334
	 * Message to display in admin_notice
335
	 * @var string
336
	 */
337
	public $message = '';
338
339
	/**
340
	 * Error to display in admin_notice
341
	 * @var string
342
	 */
343
	public $error = '';
344
345
	/**
346
	 * Modules that need more privacy description.
347
	 * @var string
348
	 */
349
	public $privacy_checks = '';
350
351
	/**
352
	 * Stats to record once the page loads
353
	 *
354
	 * @var array
355
	 */
356
	public $stats = array();
357
358
	/**
359
	 * Jetpack_Sync object
360
	 */
361
	public $sync;
362
363
	/**
364
	 * Verified data for JSON authorization request
365
	 */
366
	public $json_api_authorization_request = array();
367
368
	/**
369
	 * @var \Automattic\Jetpack\Connection\Manager
370
	 */
371
	protected $connection_manager;
372
373
	/**
374
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
375
	 */
376
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
377
378
	/**
379
	 * Holds the singleton instance of this class
380
	 * @since 2.3.3
381
	 * @var Jetpack
382
	 */
383
	static $instance = false;
384
385
	/**
386
	 * Singleton
387
	 * @static
388
	 */
389
	public static function init() {
390
		if ( ! self::$instance ) {
391
			self::$instance = new Jetpack;
392
393
			self::$instance->plugin_upgrade();
394
		}
395
396
		return self::$instance;
397
	}
398
399
	/**
400
	 * Must never be called statically
401
	 */
402
	function plugin_upgrade() {
403
		if ( Jetpack::is_active() ) {
404
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
405
			if ( JETPACK__VERSION != $version ) {
406
				// Prevent multiple upgrades at once - only a single process should trigger
407
				// an upgrade to avoid stampedes
408
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
409
					return;
410
				}
411
412
				// Set a short lock to prevent multiple instances of the upgrade
413
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
414
415
				// check which active modules actually exist and remove others from active_modules list
416
				$unfiltered_modules = Jetpack::get_active_modules();
417
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
418
				if ( array_diff( $unfiltered_modules, $modules ) ) {
419
					Jetpack::update_active_modules( $modules );
420
				}
421
422
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
423
424
				// Upgrade to 4.3.0
425
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
426
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
427
				}
428
429
				// Make sure Markdown for posts gets turned back on
430
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
431
					update_option( 'wpcom_publish_posts_with_markdown', true );
432
				}
433
434
				if ( did_action( 'wp_loaded' ) ) {
435
					self::upgrade_on_load();
436
				} else {
437
					add_action(
438
						'wp_loaded',
439
						array( __CLASS__, 'upgrade_on_load' )
440
					);
441
				}
442
			}
443
		}
444
	}
445
446
	/**
447
	 * Runs upgrade routines that need to have modules loaded.
448
	 */
449
	static function upgrade_on_load() {
450
451
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
452
		// This can happen in case Jetpack has been just upgraded and is
453
		// being initialized late during the page load. In this case we wait
454
		// until the next proper admin page load with Jetpack active.
455
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
456
			delete_transient( self::$plugin_upgrade_lock_key );
457
458
			return;
459
		}
460
461
		Jetpack::maybe_set_version_option();
462
463
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
464
			Jetpack_Widget_Conditions::migrate_post_type_rules();
465
		}
466
467
		if (
468
			class_exists( 'Jetpack_Sitemap_Manager' )
469
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
470
		) {
471
			do_action( 'jetpack_sitemaps_purge_data' );
472
		}
473
474
		// Delete old stats cache
475
		delete_option( 'jetpack_restapi_stats_cache' );
476
477
		delete_transient( self::$plugin_upgrade_lock_key );
478
	}
479
480
	/**
481
	 * Saves all the currently active modules to options.
482
	 * Also fires Action hooks for each newly activated and deactivated module.
483
	 *
484
	 * @param $modules Array Array of active modules to be saved in options.
485
	 *
486
	 * @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...
487
	 */
488
	static function update_active_modules( $modules ) {
489
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
490
		$active_modules       = Jetpack::get_active_modules();
491
		$new_active_modules   = array_diff( $modules, $current_modules );
492
		$new_inactive_modules = array_diff( $active_modules, $modules );
493
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
494
		$reindexed_modules    = array_values( $new_current_modules );
495
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
496
497
		foreach ( $new_active_modules as $module ) {
498
			/**
499
			 * Fires when a specific module is activated.
500
			 *
501
			 * @since 1.9.0
502
			 *
503
			 * @param string $module Module slug.
504
			 * @param boolean $success whether the module was activated. @since 4.2
505
			 */
506
			do_action( 'jetpack_activate_module', $module, $success );
507
			/**
508
			 * Fires when a module is activated.
509
			 * The dynamic part of the filter, $module, is the module slug.
510
			 *
511
			 * @since 1.9.0
512
			 *
513
			 * @param string $module Module slug.
514
			 */
515
			do_action( "jetpack_activate_module_$module", $module );
516
		}
517
518
		foreach ( $new_inactive_modules as $module ) {
519
			/**
520
			 * Fired after a module has been deactivated.
521
			 *
522
			 * @since 4.2.0
523
			 *
524
			 * @param string $module Module slug.
525
			 * @param boolean $success whether the module was deactivated.
526
			 */
527
			do_action( 'jetpack_deactivate_module', $module, $success );
528
			/**
529
			 * Fires when a module is deactivated.
530
			 * The dynamic part of the filter, $module, is the module slug.
531
			 *
532
			 * @since 1.9.0
533
			 *
534
			 * @param string $module Module slug.
535
			 */
536
			do_action( "jetpack_deactivate_module_$module", $module );
537
		}
538
539
		return $success;
540
	}
541
542
	static function delete_active_modules() {
543
		self::update_active_modules( array() );
544
	}
545
546
	/**
547
	 * Constructor.  Initializes WordPress hooks
548
	 */
549
	private function __construct() {
550
		/*
551
		 * Check for and alert any deprecated hooks
552
		 */
553
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
554
555
		/*
556
		 * Enable enhanced handling of previewing sites in Calypso
557
		 */
558
		if ( Jetpack::is_active() ) {
559
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
560
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
561
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
562
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
563
		}
564
565
		if ( self::jetpack_tos_agreed() ) {
566
			$tracking = new Automattic\Jetpack\Plugin\Tracking();
567
			add_action( 'init', array( $tracking, 'init' ) );
568
		}
569
570
571
		add_filter( 'jetpack_connection_secret_generator', function( $callable ) {
572
			return function() {
573
				return wp_generate_password( 32, false );
574
			};
575
		} );
576
577
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
578
579
		$this->connection_manager = new Connection_Manager();
580
		$this->connection_manager->init();
581
582
		/*
583
		 * Load things that should only be in Network Admin.
584
		 *
585
		 * For now blow away everything else until a more full
586
		 * understanding of what is needed at the network level is
587
		 * available
588
		 */
589
		if ( is_multisite() ) {
590
			$network = Jetpack_Network::init();
591
			$network->set_connection( $this->connection_manager );
592
		}
593
594
		add_filter(
595
			'jetpack_signature_check_token',
596
			array( __CLASS__, 'verify_onboarding_token' ),
597
			10,
598
			3
599
		);
600
601
		/**
602
		 * Prepare Gutenberg Editor functionality
603
		 */
604
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
605
		Jetpack_Gutenberg::init();
606
		Jetpack_Gutenberg::load_independent_blocks();
607
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
608
609
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
610
611
		// Unlink user before deleting the user from WP.com.
612
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
613
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
614
615
		// Initialize remote file upload request handlers.
616
		$this->add_remote_request_handlers();
617
618
		if ( Jetpack::is_active() ) {
619
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
620
621
			Jetpack_Heartbeat::init();
622
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
623
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
624
				Jetpack_Search_Performance_Logger::init();
625
			}
626
		}
627
628
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
629
630
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
631
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
632
633
		add_action( 'admin_init', array( $this, 'admin_init' ) );
634
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
635
636
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
637
638
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
639
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
640
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
641
642
		// returns HTTPS support status
643
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
644
645
		// JITM AJAX callback function
646
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
647
648
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
649
650
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
651
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
652
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
653
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
654
655
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
656
657
		/**
658
		 * These actions run checks to load additional files.
659
		 * They check for external files or plugins, so they need to run as late as possible.
660
		 */
661
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
662
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
663
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
664
665
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
666
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
667
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
668
669
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
670
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
671
672
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
673
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
674
675
		// A filter to control all just in time messages
676
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
677
678
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
679
680
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
681
		// We should make sure to only do this for front end links.
682
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
683
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
684
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
685
686
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
687
			//so they point moderation links on emails to Calypso
688
			jetpack_require_lib( 'functions.wp-notify' );
689
		}
690
691
		// Hide edit post link if mobile app.
692
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
693
			add_filter( 'edit_post_link', '__return_empty_string' );
694
		}
695
696
		// Update the Jetpack plan from API on heartbeats
697
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
698
699
		/**
700
		 * This is the hack to concatenate all css files into one.
701
		 * For description and reasoning see the implode_frontend_css method
702
		 *
703
		 * Super late priority so we catch all the registered styles
704
		 */
705
		if( !is_admin() ) {
706
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
707
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
708
		}
709
710
711
		/**
712
		 * These are sync actions that we need to keep track of for jitms
713
		 */
714
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
715
716
		// Actually push the stats on shutdown.
717
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
718
			add_action( 'shutdown', array( $this, 'push_stats' ) );
719
		}
720
721
		/*
722
		 * Load some scripts asynchronously.
723
		 */
724
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
725
	}
726
727
	/**
728
	 * Sets up the XMLRPC request handlers.
729
	 *
730
	 * @deprecated since 7.7.0
731
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
732
	 *
733
	 * @param Array                 $request_params Incoming request parameters.
734
	 * @param Boolean               $is_active      Whether the connection is currently active.
735
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
736
	 * @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...
737
	 */
738
	public function setup_xmlrpc_handlers(
739
		$request_params,
740
		$is_active,
741
		$is_signed,
742
		Jetpack_XMLRPC_Server $xmlrpc_server = null
743
	) {
744
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
745
		return $this->connection_manager->setup_xmlrpc_handlers(
746
			$request_params,
747
			$is_active,
748
			$is_signed,
749
			$xmlrpc_server
750
		);
751
	}
752
753
	/**
754
	 * Initialize REST API registration connector.
755
	 *
756
	 * @deprecated since 7.7.0
757
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
758
	 */
759
	public function initialize_rest_api_registration_connector() {
760
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
761
		$this->connection_manager->initialize_rest_api_registration_connector();
762
	}
763
764
	/**
765
	 * This is ported over from the manage module, which has been deprecated and baked in here.
766
	 *
767
	 * @param $domains
768
	 */
769
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
770
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
771
	}
772
773
	/**
774
	 * Return $domains, with 'wordpress.com' appended.
775
	 * This is ported over from the manage module, which has been deprecated and baked in here.
776
	 *
777
	 * @param $domains
778
	 * @return array
779
	 */
780
	function allow_wpcom_domain( $domains ) {
781
		if ( empty( $domains ) ) {
782
			$domains = array();
783
		}
784
		$domains[] = 'wordpress.com';
785
		return array_unique( $domains );
786
	}
787
788
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
789
		$post = get_post( $post_id );
790
791
		if ( empty( $post ) ) {
792
			return $default_url;
793
		}
794
795
		$post_type = $post->post_type;
796
797
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
798
		// https://en.support.wordpress.com/custom-post-types/
799
		$allowed_post_types = array(
800
			'post' => 'post',
801
			'page' => 'page',
802
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
803
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
804
		);
805
806
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
807
			return $default_url;
808
		}
809
810
		$path_prefix = $allowed_post_types[ $post_type ];
811
812
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
813
814
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
815
	}
816
817
	function point_edit_comment_links_to_calypso( $url ) {
818
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
819
		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...
820
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
821
			Jetpack::build_raw_urls( get_home_url() ),
822
			$query_args['amp;c']
823
		) );
824
	}
825
826
	function jetpack_track_last_sync_callback( $params ) {
827
		/**
828
		 * Filter to turn off jitm caching
829
		 *
830
		 * @since 5.4.0
831
		 *
832
		 * @param bool false Whether to cache just in time messages
833
		 */
834
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
835
			return $params;
836
		}
837
838
		if ( is_array( $params ) && isset( $params[0] ) ) {
839
			$option = $params[0];
840
			if ( 'active_plugins' === $option ) {
841
				// use the cache if we can, but not terribly important if it gets evicted
842
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
843
			}
844
		}
845
846
		return $params;
847
	}
848
849
	function jetpack_connection_banner_callback() {
850
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
851
852
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
853
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
854
			wp_send_json_success();
855
		}
856
857
		wp_die();
858
	}
859
860
	/**
861
	 * Removes all XML-RPC methods that are not `jetpack.*`.
862
	 * Only used in our alternate XML-RPC endpoint, where we want to
863
	 * ensure that Core and other plugins' methods are not exposed.
864
	 *
865
	 * @deprecated since 7.7.0
866
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
867
	 *
868
	 * @param array $methods A list of registered WordPress XMLRPC methods.
869
	 * @return array Filtered $methods
870
	 */
871
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
872
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
873
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
874
	}
875
876
	/**
877
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
878
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
879
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
880
	 * which is accessible via a different URI. Most of the below is copied directly
881
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
882
	 *
883
	 * @deprecated since 7.7.0
884
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
885
	 */
886
	public function alternate_xmlrpc() {
887
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
888
		$this->connection_manager->alternate_xmlrpc();
889
	}
890
891
	/**
892
	 * The callback for the JITM ajax requests.
893
	 */
894
	function jetpack_jitm_ajax_callback() {
895
		// Check for nonce
896
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
897
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
898
		}
899
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
900
			$module_slug = $_REQUEST['jitmModule'];
901
			Jetpack::log( 'activate', $module_slug );
902
			Jetpack::activate_module( $module_slug, false, false );
903
			Jetpack::state( 'message', 'no_message' );
904
905
			//A Jetpack module is being activated through a JITM, track it
906
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
907
			$this->do_stats( 'server_side' );
908
909
			wp_send_json_success();
910
		}
911
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
912
			// get the hide_jitm options array
913
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
914
			$module_slug = $_REQUEST['jitmModule'];
915
916
			if( ! $jetpack_hide_jitm ) {
917
				$jetpack_hide_jitm = array(
918
					$module_slug => 'hide'
919
				);
920
			} else {
921
				$jetpack_hide_jitm[$module_slug] = 'hide';
922
			}
923
924
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
925
926
			//jitm is being dismissed forever, track it
927
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
928
			$this->do_stats( 'server_side' );
929
930
			wp_send_json_success();
931
		}
932 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
933
			$module_slug = $_REQUEST['jitmModule'];
934
935
			// User went to WordPress.com, track this
936
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
937
			$this->do_stats( 'server_side' );
938
939
			wp_send_json_success();
940
		}
941 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
942
			$track = $_REQUEST['jitmModule'];
943
944
			// User is viewing JITM, track it.
945
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
946
			$this->do_stats( 'server_side' );
947
948
			wp_send_json_success();
949
		}
950
	}
951
952
	/**
953
	 * If there are any stats that need to be pushed, but haven't been, push them now.
954
	 */
955
	function push_stats() {
956
		if ( ! empty( $this->stats ) ) {
957
			$this->do_stats( 'server_side' );
958
		}
959
	}
960
961
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
962
		switch( $cap ) {
963
			case 'jetpack_connect' :
964
			case 'jetpack_reconnect' :
965
				if ( Jetpack::is_development_mode() ) {
966
					$caps = array( 'do_not_allow' );
967
					break;
968
				}
969
				/**
970
				 * Pass through. If it's not development mode, these should match disconnect.
971
				 * Let users disconnect if it's development mode, just in case things glitch.
972
				 */
973
			case 'jetpack_disconnect' :
974
				/**
975
				 * In multisite, can individual site admins manage their own connection?
976
				 *
977
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
978
				 */
979
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
980
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
981
						/**
982
						 * We need to update the option name -- it's terribly unclear which
983
						 * direction the override goes.
984
						 *
985
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
986
						 */
987
						$caps = array( 'do_not_allow' );
988
						break;
989
					}
990
				}
991
992
				$caps = array( 'manage_options' );
993
				break;
994
			case 'jetpack_manage_modules' :
995
			case 'jetpack_activate_modules' :
996
			case 'jetpack_deactivate_modules' :
997
				$caps = array( 'manage_options' );
998
				break;
999
			case 'jetpack_configure_modules' :
1000
				$caps = array( 'manage_options' );
1001
				break;
1002
			case 'jetpack_manage_autoupdates' :
1003
				$caps = array(
1004
					'manage_options',
1005
					'update_plugins',
1006
				);
1007
				break;
1008
			case 'jetpack_network_admin_page':
1009
			case 'jetpack_network_settings_page':
1010
				$caps = array( 'manage_network_plugins' );
1011
				break;
1012
			case 'jetpack_network_sites_page':
1013
				$caps = array( 'manage_sites' );
1014
				break;
1015
			case 'jetpack_admin_page' :
1016
				if ( Jetpack::is_development_mode() ) {
1017
					$caps = array( 'manage_options' );
1018
					break;
1019
				} else {
1020
					$caps = array( 'read' );
1021
				}
1022
				break;
1023
			case 'jetpack_connect_user' :
1024
				if ( Jetpack::is_development_mode() ) {
1025
					$caps = array( 'do_not_allow' );
1026
					break;
1027
				}
1028
				$caps = array( 'read' );
1029
				break;
1030
		}
1031
		return $caps;
1032
	}
1033
1034
	/**
1035
	 * Require a Jetpack authentication.
1036
	 *
1037
	 * @deprecated since 7.7.0
1038
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1039
	 */
1040
	public function require_jetpack_authentication() {
1041
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1042
		$this->connection_manager->require_jetpack_authentication();
1043
	}
1044
1045
	/**
1046
	 * Load language files
1047
	 * @action plugins_loaded
1048
	 */
1049
	public static function plugin_textdomain() {
1050
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1051
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1052
	}
1053
1054
	/**
1055
	 * Register assets for use in various modules and the Jetpack admin page.
1056
	 *
1057
	 * @uses wp_script_is, wp_register_script, plugins_url
1058
	 * @action wp_loaded
1059
	 * @return null
1060
	 */
1061
	public function register_assets() {
1062
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1063
			wp_register_script(
1064
				'spin',
1065
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1066
				false,
1067
				'1.3'
1068
			);
1069
		}
1070
1071 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1072
			wp_register_script(
1073
				'jquery.spin',
1074
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1075
				array( 'jquery', 'spin' ),
1076
				'1.3'
1077
			);
1078
		}
1079
1080 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1081
			wp_register_script(
1082
				'jetpack-gallery-settings',
1083
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1084
				array( 'media-views' ),
1085
				'20121225'
1086
			);
1087
		}
1088
1089 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1090
			wp_register_script(
1091
				'jetpack-twitter-timeline',
1092
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1093
				array( 'jquery' ),
1094
				'4.0.0',
1095
				true
1096
			);
1097
		}
1098
1099
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1100
			wp_register_script(
1101
				'jetpack-facebook-embed',
1102
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1103
				array( 'jquery' ),
1104
				null,
1105
				true
1106
			);
1107
1108
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1109
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1110
			if ( ! is_numeric( $fb_app_id ) ) {
1111
				$fb_app_id = '';
1112
			}
1113
			wp_localize_script(
1114
				'jetpack-facebook-embed',
1115
				'jpfbembed',
1116
				array(
1117
					'appid' => $fb_app_id,
1118
					'locale' => $this->get_locale(),
1119
				)
1120
			);
1121
		}
1122
1123
		/**
1124
		 * As jetpack_register_genericons is by default fired off a hook,
1125
		 * the hook may have already fired by this point.
1126
		 * So, let's just trigger it manually.
1127
		 */
1128
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1129
		jetpack_register_genericons();
1130
1131
		/**
1132
		 * Register the social logos
1133
		 */
1134
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1135
		jetpack_register_social_logos();
1136
1137 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1138
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1139
	}
1140
1141
	/**
1142
	 * Guess locale from language code.
1143
	 *
1144
	 * @param string $lang Language code.
1145
	 * @return string|bool
1146
	 */
1147 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1148
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1149
			return 'en_US';
1150
		}
1151
1152
		if ( ! class_exists( 'GP_Locales' ) ) {
1153
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1154
				return false;
1155
			}
1156
1157
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1158
		}
1159
1160
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1161
			// WP.com: get_locale() returns 'it'
1162
			$locale = GP_Locales::by_slug( $lang );
1163
		} else {
1164
			// Jetpack: get_locale() returns 'it_IT';
1165
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1166
		}
1167
1168
		if ( ! $locale ) {
1169
			return false;
1170
		}
1171
1172
		if ( empty( $locale->facebook_locale ) ) {
1173
			if ( empty( $locale->wp_locale ) ) {
1174
				return false;
1175
			} else {
1176
				// Facebook SDK is smart enough to fall back to en_US if a
1177
				// locale isn't supported. Since supported Facebook locales
1178
				// can fall out of sync, we'll attempt to use the known
1179
				// wp_locale value and rely on said fallback.
1180
				return $locale->wp_locale;
1181
			}
1182
		}
1183
1184
		return $locale->facebook_locale;
1185
	}
1186
1187
	/**
1188
	 * Get the locale.
1189
	 *
1190
	 * @return string|bool
1191
	 */
1192
	function get_locale() {
1193
		$locale = $this->guess_locale_from_lang( get_locale() );
1194
1195
		if ( ! $locale ) {
1196
			$locale = 'en_US';
1197
		}
1198
1199
		return $locale;
1200
	}
1201
1202
	/**
1203
	 * Device Pixels support
1204
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1205
	 */
1206
	function devicepx() {
1207
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1208
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1209
		}
1210
	}
1211
1212
	/**
1213
	 * Return the network_site_url so that .com knows what network this site is a part of.
1214
	 * @param  bool $option
1215
	 * @return string
1216
	 */
1217
	public function jetpack_main_network_site_option( $option ) {
1218
		return network_site_url();
1219
	}
1220
	/**
1221
	 * Network Name.
1222
	 */
1223
	static function network_name( $option = null ) {
1224
		global $current_site;
1225
		return $current_site->site_name;
1226
	}
1227
	/**
1228
	 * Does the network allow new user and site registrations.
1229
	 * @return string
1230
	 */
1231
	static function network_allow_new_registrations( $option = null ) {
1232
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1233
	}
1234
	/**
1235
	 * Does the network allow admins to add new users.
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
	 * @return number
1245
	 */
1246
	static function network_site_upload_space( $option = null ) {
1247
		// value in MB
1248
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1249
	}
1250
1251
	/**
1252
	 * Network allowed file types.
1253
	 * @return string
1254
	 */
1255
	static function network_upload_file_types( $option = null ) {
1256
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1257
	}
1258
1259
	/**
1260
	 * Maximum file upload size set by the network.
1261
	 * @return number
1262
	 */
1263
	static function network_max_upload_file_size( $option = null ) {
1264
		// value in KB
1265
		return get_site_option( 'fileupload_maxk', 300 );
1266
	}
1267
1268
	/**
1269
	 * Lets us know if a site allows admins to manage the network.
1270
	 * @return array
1271
	 */
1272
	static function network_enable_administration_menus( $option = null ) {
1273
		return get_site_option( 'menu_items' );
1274
	}
1275
1276
	/**
1277
	 * If a user has been promoted to or demoted from admin, we need to clear the
1278
	 * jetpack_other_linked_admins transient.
1279
	 *
1280
	 * @since 4.3.2
1281
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1282
	 *
1283
	 * @param int    $user_id   The user ID whose role changed.
1284
	 * @param string $role      The new role.
1285
	 * @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...
1286
	 */
1287
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1288
		if ( 'administrator' == $role
1289
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1290
			|| is_null( $old_roles )
1291
		) {
1292
			delete_transient( 'jetpack_other_linked_admins' );
1293
		}
1294
	}
1295
1296
	/**
1297
	 * Checks to see if there are any other users available to become primary
1298
	 * Users must both:
1299
	 * - Be linked to wpcom
1300
	 * - Be an admin
1301
	 *
1302
	 * @return mixed False if no other users are linked, Int if there are.
1303
	 */
1304
	static function get_other_linked_admins() {
1305
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1306
1307
		if ( false === $other_linked_users ) {
1308
			$admins = get_users( array( 'role' => 'administrator' ) );
1309
			if ( count( $admins ) > 1 ) {
1310
				$available = array();
1311
				foreach ( $admins as $admin ) {
1312
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1313
						$available[] = $admin->ID;
1314
					}
1315
				}
1316
1317
				$count_connected_admins = count( $available );
1318
				if ( count( $available ) > 1 ) {
1319
					$other_linked_users = $count_connected_admins;
1320
				} else {
1321
					$other_linked_users = 0;
1322
				}
1323
			} else {
1324
				$other_linked_users = 0;
1325
			}
1326
1327
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1328
		}
1329
1330
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1331
	}
1332
1333
	/**
1334
	 * Return whether we are dealing with a multi network setup or not.
1335
	 * The reason we are type casting this is because we want to avoid the situation where
1336
	 * the result is false since when is_main_network_option return false it cases
1337
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1338
	 * database which could be set to anything as opposed to what this function returns.
1339
	 * @param  bool  $option
1340
	 *
1341
	 * @return boolean
1342
	 */
1343
	public function is_main_network_option( $option ) {
1344
		// return '1' or ''
1345
		return (string) (bool) Jetpack::is_multi_network();
1346
	}
1347
1348
	/**
1349
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1350
	 *
1351
	 * @param  string  $option
1352
	 * @return boolean
1353
	 */
1354
	public function is_multisite( $option ) {
1355
		return (string) (bool) is_multisite();
1356
	}
1357
1358
	/**
1359
	 * Implemented since there is no core is multi network function
1360
	 * Right now there is no way to tell if we which network is the dominant network on the system
1361
	 *
1362
	 * @since  3.3
1363
	 * @return boolean
1364
	 */
1365 View Code Duplication
	public static function is_multi_network() {
1366
		global  $wpdb;
1367
1368
		// if we don't have a multi site setup no need to do any more
1369
		if ( ! is_multisite() ) {
1370
			return false;
1371
		}
1372
1373
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1374
		if ( $num_sites > 1 ) {
1375
			return true;
1376
		} else {
1377
			return false;
1378
		}
1379
	}
1380
1381
	/**
1382
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1383
	 * @return null
1384
	 */
1385
	function update_jetpack_main_network_site_option() {
1386
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1387
	}
1388
	/**
1389
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1390
	 *
1391
	 */
1392
	function update_jetpack_network_settings() {
1393
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1394
		// Only sync this info for the main network site.
1395
	}
1396
1397
	/**
1398
	 * Get back if the current site is single user site.
1399
	 *
1400
	 * @return bool
1401
	 */
1402 View Code Duplication
	public static function is_single_user_site() {
1403
		global $wpdb;
1404
1405
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1406
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1407
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1408
		}
1409
		return 1 === (int) $some_users;
1410
	}
1411
1412
	/**
1413
	 * Returns true if the site has file write access false otherwise.
1414
	 * @return string ( '1' | '0' )
1415
	 **/
1416
	public static function file_system_write_access() {
1417
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1418
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1419
		}
1420
1421
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1422
1423
		$filesystem_method = get_filesystem_method();
1424
		if ( $filesystem_method === 'direct' ) {
1425
			return 1;
1426
		}
1427
1428
		ob_start();
1429
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1430
		ob_end_clean();
1431
		if ( $filesystem_credentials_are_stored ) {
1432
			return 1;
1433
		}
1434
		return 0;
1435
	}
1436
1437
	/**
1438
	 * Finds out if a site is using a version control system.
1439
	 * @return string ( '1' | '0' )
1440
	 **/
1441
	public static function is_version_controlled() {
1442
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1443
		return (string) (int) Functions::is_version_controlled();
1444
	}
1445
1446
	/**
1447
	 * Determines whether the current theme supports featured images or not.
1448
	 * @return string ( '1' | '0' )
1449
	 */
1450
	public static function featured_images_enabled() {
1451
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1452
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1453
	}
1454
1455
	/**
1456
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1457
	 *
1458
	 * @deprecated 4.7 use get_avatar_url instead.
1459
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1460
	 * @param int $size Size of the avatar image
1461
	 * @param string $default URL to a default image to use if no avatar is available
1462
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1463
	 *
1464
	 * @return array
1465
	 */
1466
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1467
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1468
		return get_avatar_url( $id_or_email, array(
1469
			'size' => $size,
1470
			'default' => $default,
1471
			'force_default' => $force_display,
1472
		) );
1473
	}
1474
1475
	/**
1476
	 * jetpack_updates is saved in the following schema:
1477
	 *
1478
	 * array (
1479
	 *      'plugins'                       => (int) Number of plugin updates available.
1480
	 *      'themes'                        => (int) Number of theme updates available.
1481
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1482
	 *      'translations'                  => (int) Number of translation updates available.
1483
	 *      'total'                         => (int) Total of all available updates.
1484
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1485
	 * )
1486
	 * @return array
1487
	 */
1488
	public static function get_updates() {
1489
		$update_data = wp_get_update_data();
1490
1491
		// Stores the individual update counts as well as the total count.
1492
		if ( isset( $update_data['counts'] ) ) {
1493
			$updates = $update_data['counts'];
1494
		}
1495
1496
		// If we need to update WordPress core, let's find the latest version number.
1497 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1498
			$cur = get_preferred_from_update_core();
1499
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1500
				$updates['wp_update_version'] = $cur->current;
1501
			}
1502
		}
1503
		return isset( $updates ) ? $updates : array();
1504
	}
1505
1506
	public static function get_update_details() {
1507
		$update_details = array(
1508
			'update_core' => get_site_transient( 'update_core' ),
1509
			'update_plugins' => get_site_transient( 'update_plugins' ),
1510
			'update_themes' => get_site_transient( 'update_themes' ),
1511
		);
1512
		return $update_details;
1513
	}
1514
1515
	public static function refresh_update_data() {
1516
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1517
1518
	}
1519
1520
	public static function refresh_theme_data() {
1521
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1522
	}
1523
1524
	/**
1525
	 * Is Jetpack active?
1526
	 */
1527
	public static function is_active() {
1528
		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...
1529
	}
1530
1531
	/**
1532
	 * Make an API call to WordPress.com for plan status
1533
	 *
1534
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1535
	 *
1536
	 * @return bool True if plan is updated, false if no update
1537
	 */
1538
	public static function refresh_active_plan_from_wpcom() {
1539
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1540
		return Jetpack_Plan::refresh_from_wpcom();
1541
	}
1542
1543
	/**
1544
	 * Get the plan that this Jetpack site is currently using
1545
	 *
1546
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1547
	 * @return array Active Jetpack plan details.
1548
	 */
1549
	public static function get_active_plan() {
1550
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1551
		return Jetpack_Plan::get();
1552
	}
1553
1554
	/**
1555
	 * Determine whether the active plan supports a particular feature
1556
	 *
1557
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1558
	 * @return bool True if plan supports feature, false if not.
1559
	 */
1560
	public static function active_plan_supports( $feature ) {
1561
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1562
		return Jetpack_Plan::supports( $feature );
1563
	}
1564
1565
	/**
1566
	 * Is Jetpack in development (offline) mode?
1567
	 */
1568 View Code Duplication
	public static function is_development_mode() {
1569
		$development_mode = false;
1570
1571
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1572
			$development_mode = JETPACK_DEV_DEBUG;
1573
		} elseif ( $site_url = site_url() ) {
1574
			$development_mode = false === strpos( $site_url, '.' );
1575
		}
1576
1577
		/**
1578
		 * Filters Jetpack's development mode.
1579
		 *
1580
		 * @see https://jetpack.com/support/development-mode/
1581
		 *
1582
		 * @since 2.2.1
1583
		 *
1584
		 * @param bool $development_mode Is Jetpack's development mode active.
1585
		 */
1586
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1587
		return $development_mode;
1588
	}
1589
1590
	/**
1591
	 * Whether the site is currently onboarding or not.
1592
	 * A site is considered as being onboarded if it currently has an onboarding token.
1593
	 *
1594
	 * @since 5.8
1595
	 *
1596
	 * @access public
1597
	 * @static
1598
	 *
1599
	 * @return bool True if the site is currently onboarding, false otherwise
1600
	 */
1601
	public static function is_onboarding() {
1602
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1603
	}
1604
1605
	/**
1606
	 * Determines reason for Jetpack development mode.
1607
	 */
1608
	public static function development_mode_trigger_text() {
1609
		if ( ! Jetpack::is_development_mode() ) {
1610
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1611
		}
1612
1613
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1614
			$notice =  __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1615
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1616
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1617
		} else {
1618
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1619
		}
1620
1621
		return $notice;
1622
1623
	}
1624
	/**
1625
	* Get Jetpack development mode notice text and notice class.
1626
	*
1627
	* Mirrors the checks made in Jetpack::is_development_mode
1628
	*
1629
	*/
1630
	public static function show_development_mode_notice() {
1631 View Code Duplication
		if ( Jetpack::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 .= ' ' . Jetpack::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 ( Jetpack::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 ( Jetpack::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( array(
1701
			'user_id' => $user_id,
1702
		) );
1703
		$xml->query( 'wpcom.getUser' );
1704
		if ( ! $xml->isError() ) {
1705
			$user_data = $xml->getResponse();
1706
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1707
			return $user_data;
1708
		}
1709
1710
		return false;
1711
	}
1712
1713
	/**
1714
	 * Get the wpcom email of the current|specified connected user.
1715
	 */
1716 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1717
		if ( ! $user_id ) {
1718
			$user_id = get_current_user_id();
1719
		}
1720
1721
		$xml = new Jetpack_IXR_Client( array(
1722
			'user_id' => $user_id,
1723
		) );
1724
		$xml->query( 'wpcom.getUserEmail' );
1725
		if ( ! $xml->isError() ) {
1726
			return $xml->getResponse();
1727
		}
1728
		return false;
1729
	}
1730
1731
	/**
1732
	 * Get the wpcom email of the master user.
1733
	 */
1734
	public static function get_master_user_email() {
1735
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1736
		if ( $master_user_id ) {
1737
			return self::get_connected_user_email( $master_user_id );
1738
		}
1739
		return '';
1740
	}
1741
1742
	/**
1743
	 * Whether the current user is the connection owner.
1744
	 *
1745
	 * @deprecated since 7.7
1746
	 *
1747
	 * @return bool Whether the current user is the connection owner.
1748
	 */
1749
	public function current_user_is_connection_owner() {
1750
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1751
		return self::connection()->is_connection_owner();
1752
	}
1753
1754
	/**
1755
	 * Gets current user IP address.
1756
	 *
1757
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1758
	 *
1759
	 * @return string                  Current user IP address.
1760
	 */
1761
	public static function current_user_ip( $check_all_headers = false ) {
1762
		if ( $check_all_headers ) {
1763
			foreach ( array(
1764
				'HTTP_CF_CONNECTING_IP',
1765
				'HTTP_CLIENT_IP',
1766
				'HTTP_X_FORWARDED_FOR',
1767
				'HTTP_X_FORWARDED',
1768
				'HTTP_X_CLUSTER_CLIENT_IP',
1769
				'HTTP_FORWARDED_FOR',
1770
				'HTTP_FORWARDED',
1771
				'HTTP_VIA',
1772
			) as $key ) {
1773
				if ( ! empty( $_SERVER[ $key ] ) ) {
1774
					return $_SERVER[ $key ];
1775
				}
1776
			}
1777
		}
1778
1779
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1780
	}
1781
1782
	/**
1783
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1784
	 */
1785
	function extra_oembed_providers() {
1786
		// Cloudup: https://dev.cloudup.com/#oembed
1787
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1788
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1789
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1790
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1791
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1792
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1793
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1794
	}
1795
1796
	/**
1797
	 * Synchronize connected user role changes
1798
	 */
1799
	function user_role_change( $user_id ) {
1800
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1801
		Users::user_role_change( $user_id );
1802
	}
1803
1804
	/**
1805
	 * Loads the currently active modules.
1806
	 */
1807
	public static function load_modules() {
1808
		if (
1809
			! self::is_active()
1810
			&& ! self::is_development_mode()
1811
			&& ! self::is_onboarding()
1812
			&& (
1813
				! is_multisite()
1814
				|| ! get_site_option( 'jetpack_protect_active' )
1815
			)
1816
		) {
1817
			return;
1818
		}
1819
1820
		$version = Jetpack_Options::get_option( 'version' );
1821 View Code Duplication
		if ( ! $version ) {
1822
			$version = $old_version = JETPACK__VERSION . ':' . time();
1823
			/** This action is documented in class.jetpack.php */
1824
			do_action( 'updating_jetpack_version', $version, false );
1825
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1826
		}
1827
		list( $version ) = explode( ':', $version );
1828
1829
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1830
1831
		$modules_data = array();
1832
1833
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1834
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1835
			$updated_modules = array();
1836
			foreach ( $modules as $module ) {
1837
				$modules_data[ $module ] = Jetpack::get_module( $module );
1838
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1839
					continue;
1840
				}
1841
1842
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1843
					continue;
1844
				}
1845
1846
				$updated_modules[] = $module;
1847
			}
1848
1849
			$modules = array_diff( $modules, $updated_modules );
1850
		}
1851
1852
		$is_development_mode = Jetpack::is_development_mode();
1853
1854
		foreach ( $modules as $index => $module ) {
1855
			// If we're in dev mode, disable modules requiring a connection
1856
			if ( $is_development_mode ) {
1857
				// Prime the pump if we need to
1858
				if ( empty( $modules_data[ $module ] ) ) {
1859
					$modules_data[ $module ] = Jetpack::get_module( $module );
1860
				}
1861
				// If the module requires a connection, but we're in local mode, don't include it.
1862
				if ( $modules_data[ $module ]['requires_connection'] ) {
1863
					continue;
1864
				}
1865
			}
1866
1867
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1868
				continue;
1869
			}
1870
1871
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1872
				unset( $modules[ $index ] );
1873
				self::update_active_modules( array_values( $modules ) );
1874
				continue;
1875
			}
1876
1877
			/**
1878
			 * Fires when a specific module is loaded.
1879
			 * The dynamic part of the hook, $module, is the module slug.
1880
			 *
1881
			 * @since 1.1.0
1882
			 */
1883
			do_action( 'jetpack_module_loaded_' . $module );
1884
		}
1885
1886
		/**
1887
		 * Fires when all the modules are loaded.
1888
		 *
1889
		 * @since 1.1.0
1890
		 */
1891
		do_action( 'jetpack_modules_loaded' );
1892
1893
		// 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.
1894
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1895
	}
1896
1897
	/**
1898
	 * Check if Jetpack's REST API compat file should be included
1899
	 * @action plugins_loaded
1900
	 * @return null
1901
	 */
1902
	public function check_rest_api_compat() {
1903
		/**
1904
		 * Filters the list of REST API compat files to be included.
1905
		 *
1906
		 * @since 2.2.5
1907
		 *
1908
		 * @param array $args Array of REST API compat files to include.
1909
		 */
1910
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1911
1912
		if ( function_exists( 'bbpress' ) )
1913
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1914
1915
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1916
			require_once $_jetpack_rest_api_compat_include;
1917
	}
1918
1919
	/**
1920
	 * Gets all plugins currently active in values, regardless of whether they're
1921
	 * traditionally activated or network activated.
1922
	 *
1923
	 * @todo Store the result in core's object cache maybe?
1924
	 */
1925
	public static function get_active_plugins() {
1926
		$active_plugins = (array) get_option( 'active_plugins', array() );
1927
1928
		if ( is_multisite() ) {
1929
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1930
			// whereas active_plugins stores them in the values.
1931
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1932
			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...
1933
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1934
			}
1935
		}
1936
1937
		sort( $active_plugins );
1938
1939
		return array_unique( $active_plugins );
1940
	}
1941
1942
	/**
1943
	 * Gets and parses additional plugin data to send with the heartbeat data
1944
	 *
1945
	 * @since 3.8.1
1946
	 *
1947
	 * @return array Array of plugin data
1948
	 */
1949
	public static function get_parsed_plugin_data() {
1950
		if ( ! function_exists( 'get_plugins' ) ) {
1951
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1952
		}
1953
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1954
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1955
		$active_plugins = Jetpack::get_active_plugins();
1956
1957
		$plugins = array();
1958
		foreach ( $all_plugins as $path => $plugin_data ) {
1959
			$plugins[ $path ] = array(
1960
					'is_active' => in_array( $path, $active_plugins ),
1961
					'file'      => $path,
1962
					'name'      => $plugin_data['Name'],
1963
					'version'   => $plugin_data['Version'],
1964
					'author'    => $plugin_data['Author'],
1965
			);
1966
		}
1967
1968
		return $plugins;
1969
	}
1970
1971
	/**
1972
	 * Gets and parses theme data to send with the heartbeat data
1973
	 *
1974
	 * @since 3.8.1
1975
	 *
1976
	 * @return array Array of theme data
1977
	 */
1978
	public static function get_parsed_theme_data() {
1979
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1980
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1981
1982
		$themes = array();
1983
		foreach ( $all_themes as $slug => $theme_data ) {
1984
			$theme_headers = array();
1985
			foreach ( $header_keys as $header_key ) {
1986
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1987
			}
1988
1989
			$themes[ $slug ] = array(
1990
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1991
					'slug' => $slug,
1992
					'theme_root' => $theme_data->get_theme_root_uri(),
1993
					'parent' => $theme_data->parent(),
1994
					'headers' => $theme_headers
1995
			);
1996
		}
1997
1998
		return $themes;
1999
	}
2000
2001
	/**
2002
	 * Checks whether a specific plugin is active.
2003
	 *
2004
	 * We don't want to store these in a static variable, in case
2005
	 * there are switch_to_blog() calls involved.
2006
	 */
2007
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2008
		return in_array( $plugin, self::get_active_plugins() );
2009
	}
2010
2011
	/**
2012
	 * Check if Jetpack's Open Graph tags should be used.
2013
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2014
	 *
2015
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2016
	 * @action plugins_loaded
2017
	 * @return null
2018
	 */
2019
	public function check_open_graph() {
2020
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2021
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2022
		}
2023
2024
		$active_plugins = self::get_active_plugins();
2025
2026
		if ( ! empty( $active_plugins ) ) {
2027
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2028
				if ( in_array( $plugin, $active_plugins ) ) {
2029
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2030
					break;
2031
				}
2032
			}
2033
		}
2034
2035
		/**
2036
		 * Allow the addition of Open Graph Meta Tags to all pages.
2037
		 *
2038
		 * @since 2.0.3
2039
		 *
2040
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2041
		 */
2042
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2043
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2044
		}
2045
	}
2046
2047
	/**
2048
	 * Check if Jetpack's Twitter tags should be used.
2049
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2050
	 *
2051
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2052
	 * @action plugins_loaded
2053
	 * @return null
2054
	 */
2055
	public function check_twitter_tags() {
2056
2057
		$active_plugins = self::get_active_plugins();
2058
2059
		if ( ! empty( $active_plugins ) ) {
2060
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2061
				if ( in_array( $plugin, $active_plugins ) ) {
2062
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2063
					break;
2064
				}
2065
			}
2066
		}
2067
2068
		/**
2069
		 * Allow Twitter Card Meta tags to be disabled.
2070
		 *
2071
		 * @since 2.6.0
2072
		 *
2073
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2074
		 */
2075
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2076
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2077
		}
2078
	}
2079
2080
	/**
2081
	 * Allows plugins to submit security reports.
2082
 	 *
2083
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2084
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2085
	 * @param array   $args         See definitions above
2086
	 */
2087
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2088
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2089
	}
2090
2091
/* Jetpack Options API */
2092
2093
	public static function get_option_names( $type = 'compact' ) {
2094
		return Jetpack_Options::get_option_names( $type );
2095
	}
2096
2097
	/**
2098
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2099
 	 *
2100
	 * @param string $name    Option name
2101
	 * @param mixed  $default (optional)
2102
	 */
2103
	public static function get_option( $name, $default = false ) {
2104
		return Jetpack_Options::get_option( $name, $default );
2105
	}
2106
2107
	/**
2108
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2109
 	 *
2110
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2111
	 * @param string $name  Option name
2112
	 * @param mixed  $value Option value
2113
	 */
2114
	public static function update_option( $name, $value ) {
2115
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2116
		return Jetpack_Options::update_option( $name, $value );
2117
	}
2118
2119
	/**
2120
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2121
 	 *
2122
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2123
	 * @param array $array array( option name => option value, ... )
2124
	 */
2125
	public static function update_options( $array ) {
2126
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2127
		return Jetpack_Options::update_options( $array );
2128
	}
2129
2130
	/**
2131
	 * Deletes the given option.  May be passed multiple option names as an array.
2132
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2133
	 *
2134
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2135
	 * @param string|array $names
2136
	 */
2137
	public static function delete_option( $names ) {
2138
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2139
		return Jetpack_Options::delete_option( $names );
2140
	}
2141
2142
	/**
2143
	 * Enters a user token into the user_tokens option
2144
	 *
2145
	 * @param int $user_id
2146
	 * @param string $token
2147
	 * return bool
2148
	 */
2149
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2150
		// not designed for concurrent updates
2151
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2152
		if ( ! is_array( $user_tokens ) )
2153
			$user_tokens = array();
2154
		$user_tokens[$user_id] = $token;
2155
		if ( $is_master_user ) {
2156
			$master_user = $user_id;
2157
			$options     = compact( 'user_tokens', 'master_user' );
2158
		} else {
2159
			$options = compact( 'user_tokens' );
2160
		}
2161
		return Jetpack_Options::update_options( $options );
2162
	}
2163
2164
	/**
2165
	 * Returns an array of all PHP files in the specified absolute path.
2166
	 * Equivalent to glob( "$absolute_path/*.php" ).
2167
	 *
2168
	 * @param string $absolute_path The absolute path of the directory to search.
2169
	 * @return array Array of absolute paths to the PHP files.
2170
	 */
2171
	public static function glob_php( $absolute_path ) {
2172
		if ( function_exists( 'glob' ) ) {
2173
			return glob( "$absolute_path/*.php" );
2174
		}
2175
2176
		$absolute_path = untrailingslashit( $absolute_path );
2177
		$files = array();
2178
		if ( ! $dir = @opendir( $absolute_path ) ) {
2179
			return $files;
2180
		}
2181
2182
		while ( false !== $file = readdir( $dir ) ) {
2183
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2184
				continue;
2185
			}
2186
2187
			$file = "$absolute_path/$file";
2188
2189
			if ( ! is_file( $file ) ) {
2190
				continue;
2191
			}
2192
2193
			$files[] = $file;
2194
		}
2195
2196
		closedir( $dir );
2197
2198
		return $files;
2199
	}
2200
2201
	public static function activate_new_modules( $redirect = false ) {
2202
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2203
			return;
2204
		}
2205
2206
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2207 View Code Duplication
		if ( ! $jetpack_old_version ) {
2208
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2209
			/** This action is documented in class.jetpack.php */
2210
			do_action( 'updating_jetpack_version', $version, false );
2211
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2212
		}
2213
2214
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2215
2216
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2217
			return;
2218
		}
2219
2220
		$active_modules     = Jetpack::get_active_modules();
2221
		$reactivate_modules = array();
2222
		foreach ( $active_modules as $active_module ) {
2223
			$module = Jetpack::get_module( $active_module );
2224
			if ( ! isset( $module['changed'] ) ) {
2225
				continue;
2226
			}
2227
2228
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2229
				continue;
2230
			}
2231
2232
			$reactivate_modules[] = $active_module;
2233
			Jetpack::deactivate_module( $active_module );
2234
		}
2235
2236
		$new_version = JETPACK__VERSION . ':' . time();
2237
		/** This action is documented in class.jetpack.php */
2238
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2239
		Jetpack_Options::update_options(
2240
			array(
2241
				'version'     => $new_version,
2242
				'old_version' => $jetpack_old_version,
2243
			)
2244
		);
2245
2246
		Jetpack::state( 'message', 'modules_activated' );
2247
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

Loading history...
2806
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2807
2808
			$url = add_query_arg(
2809
				array(
2810
					'action'   => 'activate_default_modules',
2811
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2812
				),
2813
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2814
			);
2815
			wp_safe_redirect( $url );
2816
			exit;
2817
		}
2818
2819
		/**
2820
		 * Fires before default modules are activated.
2821
		 *
2822
		 * @since 1.9.0
2823
		 *
2824
		 * @param string $min_version Minimum version number required to use modules.
2825
		 * @param string $max_version Maximum version number required to use modules.
2826
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2827
		 */
2828
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2829
2830
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2831
		if ( $send_state_messages ) {
2832
			Jetpack::restate();
2833
			Jetpack::catch_errors( true );
2834
		}
2835
2836
		$active = Jetpack::get_active_modules();
2837
2838
		foreach ( $modules as $module ) {
2839
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2840
				$active[] = $module;
2841
				self::update_active_modules( $active );
2842
				continue;
2843
			}
2844
2845
			if ( $send_state_messages && in_array( $module, $active ) ) {
2846
				$module_info = Jetpack::get_module( $module );
2847 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2848
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2849
					if ( $active_state = Jetpack::state( $state ) ) {
2850
						$active_state = explode( ',', $active_state );
2851
					} else {
2852
						$active_state = array();
2853
					}
2854
					$active_state[] = $module;
2855
					Jetpack::state( $state, implode( ',', $active_state ) );
2856
				}
2857
				continue;
2858
			}
2859
2860
			$file = Jetpack::get_module_path( $module );
2861
			if ( ! file_exists( $file ) ) {
2862
				continue;
2863
			}
2864
2865
			// we'll override this later if the plugin can be included without fatal error
2866
			if ( $redirect ) {
2867
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2868
			}
2869
2870
			if ( $send_state_messages ) {
2871
				Jetpack::state( 'error', 'module_activation_failed' );
2872
				Jetpack::state( 'module', $module );
2873
			}
2874
2875
			ob_start();
2876
			require_once $file;
2877
2878
			$active[] = $module;
2879
2880 View Code Duplication
			if ( $send_state_messages ) {
2881
2882
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2883
				if ( $active_state = Jetpack::state( $state ) ) {
2884
					$active_state = explode( ',', $active_state );
2885
				} else {
2886
					$active_state = array();
2887
				}
2888
				$active_state[] = $module;
2889
				Jetpack::state( $state, implode( ',', $active_state ) );
2890
			}
2891
2892
			Jetpack::update_active_modules( $active );
2893
2894
			ob_end_clean();
2895
		}
2896
2897
		if ( $send_state_messages ) {
2898
			Jetpack::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2991
		ob_end_clean();
2992
		Jetpack::catch_errors( false );
2993
2994
		if ( $redirect ) {
2995
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2996
		}
2997
		if ( $exit ) {
2998
			exit;
2999
		}
3000
		return true;
3001
	}
3002
3003
	function activate_module_actions( $module ) {
3004
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3005
	}
3006
3007
	public static function deactivate_module( $module ) {
3008
		/**
3009
		 * Fires when a module is deactivated.
3010
		 *
3011
		 * @since 1.9.0
3012
		 *
3013
		 * @param string $module Module slug.
3014
		 */
3015
		do_action( 'jetpack_pre_deactivate_module', $module );
3016
3017
		$jetpack = Jetpack::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

Consider the follow example

<?php

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

    return false;
}

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

Loading history...
3312
				if ( is_wp_error( $result ) ) {
3313
					return $result;
3314
				}
3315
			}
3316
		}
3317
3318
		$result = Jetpack::register();
3319
3320
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3321
		if ( ! $result || is_wp_error( $result ) ) {
3322
			return $result;
3323
		} else {
3324
			return true;
3325
		}
3326
	}
3327
3328
	/**
3329
	 * Tracking an internal event log. Try not to put too much chaff in here.
3330
	 *
3331
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3332
	 */
3333
	public static function log( $code, $data = null ) {
3334
		// only grab the latest 200 entries
3335
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3336
3337
		// Append our event to the log
3338
		$log_entry = array(
3339
			'time'    => time(),
3340
			'user_id' => get_current_user_id(),
3341
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3342
			'code'    => $code,
3343
		);
3344
		// Don't bother storing it unless we've got some.
3345
		if ( ! is_null( $data ) ) {
3346
			$log_entry['data'] = $data;
3347
		}
3348
		$log[] = $log_entry;
3349
3350
		// Try add_option first, to make sure it's not autoloaded.
3351
		// @todo: Add an add_option method to Jetpack_Options
3352
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3353
			Jetpack_Options::update_option( 'log', $log );
3354
		}
3355
3356
		/**
3357
		 * Fires when Jetpack logs an internal event.
3358
		 *
3359
		 * @since 3.0.0
3360
		 *
3361
		 * @param array $log_entry {
3362
		 *	Array of details about the log entry.
3363
		 *
3364
		 *	@param string time Time of the event.
3365
		 *	@param int user_id ID of the user who trigerred the event.
3366
		 *	@param int blog_id Jetpack Blog ID.
3367
		 *	@param string code Unique name for the event.
3368
		 *	@param string data Data about the event.
3369
		 * }
3370
		 */
3371
		do_action( 'jetpack_log_entry', $log_entry );
3372
	}
3373
3374
	/**
3375
	 * Get the internal event log.
3376
	 *
3377
	 * @param $event (string) - only return the specific log events
3378
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3379
	 *
3380
	 * @return array of log events || WP_Error for invalid params
3381
	 */
3382
	public static function get_log( $event = false, $num = false ) {
3383
		if ( $event && ! is_string( $event ) ) {
3384
			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...
3385
		}
3386
3387
		if ( $num && ! is_numeric( $num ) ) {
3388
			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...
3389
		}
3390
3391
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3392
3393
		// If nothing set - act as it did before, otherwise let's start customizing the output
3394
		if ( ! $num && ! $event ) {
3395
			return $entire_log;
3396
		} else {
3397
			$entire_log = array_reverse( $entire_log );
3398
		}
3399
3400
		$custom_log_output = array();
3401
3402
		if ( $event ) {
3403
			foreach ( $entire_log as $log_event ) {
3404
				if ( $event == $log_event[ 'code' ] ) {
3405
					$custom_log_output[] = $log_event;
3406
				}
3407
			}
3408
		} else {
3409
			$custom_log_output = $entire_log;
3410
		}
3411
3412
		if ( $num ) {
3413
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3414
		}
3415
3416
		return $custom_log_output;
3417
	}
3418
3419
	/**
3420
	 * Log modification of important settings.
3421
	 */
3422
	public static function log_settings_change( $option, $old_value, $value ) {
3423
		switch( $option ) {
3424
			case 'jetpack_sync_non_public_post_stati':
3425
				self::log( $option, $value );
3426
				break;
3427
		}
3428
	}
3429
3430
	/**
3431
	 * Return stat data for WPCOM sync
3432
	 */
3433
	public static function get_stat_data( $encode = true, $extended = true ) {
3434
		$data = Jetpack_Heartbeat::generate_stats_array();
3435
3436
		if ( $extended ) {
3437
			$additional_data = self::get_additional_stat_data();
3438
			$data = array_merge( $data, $additional_data );
3439
		}
3440
3441
		if ( $encode ) {
3442
			return json_encode( $data );
3443
		}
3444
3445
		return $data;
3446
	}
3447
3448
	/**
3449
	 * Get additional stat data to sync to WPCOM
3450
	 */
3451
	public static function get_additional_stat_data( $prefix = '' ) {
3452
		$return["{$prefix}themes"]         = Jetpack::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3453
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3454
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3455
		$return["{$prefix}site-count"]     = 0;
3456
3457
		if ( function_exists( 'get_blog_count' ) ) {
3458
			$return["{$prefix}site-count"] = get_blog_count();
3459
		}
3460
		return $return;
3461
	}
3462
3463
	private static function get_site_user_count() {
3464
		global $wpdb;
3465
3466
		if ( function_exists( 'wp_is_large_network' ) ) {
3467
			if ( wp_is_large_network( 'users' ) ) {
3468
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3469
			}
3470
		}
3471
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3472
			// It wasn't there, so regenerate the data and save the transient
3473
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3474
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3475
		}
3476
		return $user_count;
3477
	}
3478
3479
	/* Admin Pages */
3480
3481
	function admin_init() {
3482
		// If the plugin is not connected, display a connect message.
3483
		if (
3484
			// the plugin was auto-activated and needs its candy
3485
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3486
		||
3487
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3488
			! Jetpack_Options::get_option( 'activated' )
3489
		) {
3490
			Jetpack::plugin_initialize();
3491
		}
3492
3493
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3494
			Jetpack_Connection_Banner::init();
3495
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3496
			// Upgrade: 1.1 -> 1.1.1
3497
			// Check and see if host can verify the Jetpack servers' SSL certificate
3498
			$args = array();
3499
			$connection = self::connection();
3500
			Client::_wp_remote_request(
3501
				Jetpack::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3502
				$args,
3503
				true
3504
			);
3505
		}
3506
3507
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3508
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3509
		}
3510
3511
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3512
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3513
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3514
3515
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3516
			// Artificially throw errors in certain whitelisted cases during plugin activation
3517
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3518
		}
3519
3520
		// Add custom column in wp-admin/users.php to show whether user is linked.
3521
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3522
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3523
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3524
	}
3525
3526
	function admin_body_class( $admin_body_class = '' ) {
3527
		$classes = explode( ' ', trim( $admin_body_class ) );
3528
3529
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3530
3531
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3532
		return " $admin_body_class ";
3533
	}
3534
3535
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3536
		return $admin_body_class . ' jetpack-pagestyles ';
3537
	}
3538
3539
	/**
3540
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3541
	 * This function artificially throws errors for such cases (whitelisted).
3542
	 *
3543
	 * @param string $plugin The activated plugin.
3544
	 */
3545
	function throw_error_on_activate_plugin( $plugin ) {
3546
		$active_modules = Jetpack::get_active_modules();
3547
3548
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3549
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3550
			$throw = false;
3551
3552
			// Try and make sure it really was the stats plugin
3553
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3554
				if ( 'stats.php' == basename( $plugin ) ) {
3555
					$throw = true;
3556
				}
3557
			} else {
3558
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3559
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3560
					$throw = true;
3561
				}
3562
			}
3563
3564
			if ( $throw ) {
3565
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3566
			}
3567
		}
3568
	}
3569
3570
	function intercept_plugin_error_scrape_init() {
3571
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3572
	}
3573
3574
	function intercept_plugin_error_scrape( $action, $result ) {
3575
		if ( ! $result ) {
3576
			return;
3577
		}
3578
3579
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3580
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3581
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3582
			}
3583
		}
3584
	}
3585
3586
	/**
3587
	 * Register the remote file upload request handlers, if needed.
3588
	 *
3589
	 * @access public
3590
	 */
3591
	public function add_remote_request_handlers() {
3592
		// Remote file uploads are allowed only via AJAX requests.
3593
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3594
			return;
3595
		}
3596
3597
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3598
		$remote_request_actions = array(
3599
			'jetpack_upload_file',
3600
			'jetpack_update_file',
3601
		);
3602
3603
		// phpcs:ignore WordPress.Security.NonceVerification
3604
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3605
			return;
3606
		}
3607
3608
		// Require Jetpack authentication for the remote file upload AJAX requests.
3609
		$this->connection_manager->require_jetpack_authentication();
3610
3611
		// Register the remote file upload AJAX handlers.
3612
		foreach ( $remote_request_actions as $action ) {
3613
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3614
		}
3615
	}
3616
3617
	/**
3618
	 * Handler for Jetpack remote file uploads.
3619
	 *
3620
	 * @access public
3621
	 */
3622
	public function remote_request_handlers() {
3623
		$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...
3624
3625
		switch ( current_filter() ) {
3626
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3627
			$response = $this->upload_handler();
3628
			break;
3629
3630
		case 'wp_ajax_nopriv_jetpack_update_file' :
3631
			$response = $this->upload_handler( true );
3632
			break;
3633
		default :
3634
			$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...
3635
			break;
3636
		}
3637
3638
		if ( ! $response ) {
3639
			$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...
3640
		}
3641
3642
		if ( is_wp_error( $response ) ) {
3643
			$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...
3644
			$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...
3645
			$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...
3646
3647
			if ( ! is_int( $status_code ) ) {
3648
				$status_code = 400;
3649
			}
3650
3651
			status_header( $status_code );
3652
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3653
		}
3654
3655
		status_header( 200 );
3656
		if ( true === $response ) {
3657
			exit;
3658
		}
3659
3660
		die( json_encode( (object) $response ) );
3661
	}
3662
3663
	/**
3664
	 * Uploads a file gotten from the global $_FILES.
3665
	 * If `$update_media_item` is true and `post_id` is defined
3666
	 * the attachment file of the media item (gotten through of the post_id)
3667
	 * will be updated instead of add a new one.
3668
	 *
3669
	 * @param  boolean $update_media_item - update media attachment
3670
	 * @return array - An array describing the uploadind files process
3671
	 */
3672
	function upload_handler( $update_media_item = false ) {
3673
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3674
			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...
3675
		}
3676
3677
		$user = wp_authenticate( '', '' );
3678
		if ( ! $user || is_wp_error( $user ) ) {
3679
			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...
3680
		}
3681
3682
		wp_set_current_user( $user->ID );
3683
3684
		if ( ! current_user_can( 'upload_files' ) ) {
3685
			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...
3686
		}
3687
3688
		if ( empty( $_FILES ) ) {
3689
			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...
3690
		}
3691
3692
		foreach ( array_keys( $_FILES ) as $files_key ) {
3693
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3694
				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...
3695
			}
3696
		}
3697
3698
		$media_keys = array_keys( $_FILES['media'] );
3699
3700
		$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...
3701
		if ( ! $token || is_wp_error( $token ) ) {
3702
			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...
3703
		}
3704
3705
		$uploaded_files = array();
3706
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3707
		unset( $GLOBALS['post'] );
3708
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3709
			$file = array();
3710
			foreach ( $media_keys as $media_key ) {
3711
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3712
			}
3713
3714
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3715
3716
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3717
			if ( $hmac_provided !== $hmac_file ) {
3718
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3719
				continue;
3720
			}
3721
3722
			$_FILES['.jetpack.upload.'] = $file;
3723
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3724
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3725
				$post_id = 0;
3726
			}
3727
3728
			if ( $update_media_item ) {
3729
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3730
					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...
3731
				}
3732
3733
				$media_array = $_FILES['media'];
3734
3735
				$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...
3736
				$file_array['type'] = $media_array['type'][0];
3737
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3738
				$file_array['error'] = $media_array['error'][0];
3739
				$file_array['size'] = $media_array['size'][0];
3740
3741
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3742
3743
				if ( is_wp_error( $edited_media_item ) ) {
3744
					return $edited_media_item;
3745
				}
3746
3747
				$response = (object) array(
3748
					'id'   => (string) $post_id,
3749
					'file' => (string) $edited_media_item->post_title,
3750
					'url'  => (string) wp_get_attachment_url( $post_id ),
3751
					'type' => (string) $edited_media_item->post_mime_type,
3752
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3753
				);
3754
3755
				return (array) array( $response );
3756
			}
3757
3758
			$attachment_id = media_handle_upload(
3759
				'.jetpack.upload.',
3760
				$post_id,
3761
				array(),
3762
				array(
3763
					'action' => 'jetpack_upload_file',
3764
				)
3765
			);
3766
3767
			if ( ! $attachment_id ) {
3768
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3769
			} elseif ( is_wp_error( $attachment_id ) ) {
3770
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3771
			} else {
3772
				$attachment = get_post( $attachment_id );
3773
				$uploaded_files[$index] = (object) array(
3774
					'id'   => (string) $attachment_id,
3775
					'file' => $attachment->post_title,
3776
					'url'  => wp_get_attachment_url( $attachment_id ),
3777
					'type' => $attachment->post_mime_type,
3778
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3779
				);
3780
				// Zip files uploads are not supported unless they are done for installation purposed
3781
				// lets delete them in case something goes wrong in this whole process
3782
				if ( 'application/zip' === $attachment->post_mime_type ) {
3783
					// Schedule a cleanup for 2 hours from now in case of failed install.
3784
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3785
				}
3786
			}
3787
		}
3788
		if ( ! is_null( $global_post ) ) {
3789
			$GLOBALS['post'] = $global_post;
3790
		}
3791
3792
		return $uploaded_files;
3793
	}
3794
3795
	/**
3796
	 * Add help to the Jetpack page
3797
	 *
3798
	 * @since Jetpack (1.2.3)
3799
	 * @return false if not the Jetpack page
3800
	 */
3801
	function admin_help() {
3802
		$current_screen = get_current_screen();
3803
3804
		// Overview
3805
		$current_screen->add_help_tab(
3806
			array(
3807
				'id'		=> 'home',
3808
				'title'		=> __( 'Home', 'jetpack' ),
3809
				'content'	=>
3810
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3811
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3812
					'<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>',
3813
			)
3814
		);
3815
3816
		// Screen Content
3817
		if ( current_user_can( 'manage_options' ) ) {
3818
			$current_screen->add_help_tab(
3819
				array(
3820
					'id'		=> 'settings',
3821
					'title'		=> __( 'Settings', 'jetpack' ),
3822
					'content'	=>
3823
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3824
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3825
						'<ol>' .
3826
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3827
							'<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>' .
3828
						'</ol>' .
3829
						'<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>'
3830
				)
3831
			);
3832
		}
3833
3834
		// Help Sidebar
3835
		$current_screen->set_help_sidebar(
3836
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3837
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3838
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3839
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3840
		);
3841
	}
3842
3843
	function admin_menu_css() {
3844
		wp_enqueue_style( 'jetpack-icons' );
3845
	}
3846
3847
	function admin_menu_order() {
3848
		return true;
3849
	}
3850
3851 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3852
		$jp_menu_order = array();
3853
3854
		foreach ( $menu_order as $index => $item ) {
3855
			if ( $item != 'jetpack' ) {
3856
				$jp_menu_order[] = $item;
3857
			}
3858
3859
			if ( $index == 0 ) {
3860
				$jp_menu_order[] = 'jetpack';
3861
			}
3862
		}
3863
3864
		return $jp_menu_order;
3865
	}
3866
3867
	function admin_banner_styles() {
3868
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3869
3870
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3871
			wp_register_style(
3872
				'jetpack-dops-style',
3873
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3874
				array(),
3875
				JETPACK__VERSION
3876
			);
3877
		}
3878
3879
		wp_enqueue_style(
3880
			'jetpack',
3881
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3882
			array( 'jetpack-dops-style' ),
3883
			 JETPACK__VERSION . '-20121016'
3884
		);
3885
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3886
		wp_style_add_data( 'jetpack', 'suffix', $min );
3887
	}
3888
3889
	function plugin_action_links( $actions ) {
3890
3891
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3892
3893
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3894
			return array_merge(
3895
				$jetpack_home,
3896
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3897
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3898
				$actions
3899
				);
3900
			}
3901
3902
		return array_merge( $jetpack_home, $actions );
3903
	}
3904
3905
	/*
3906
	 * Registration flow:
3907
	 * 1 - ::admin_page_load() action=register
3908
	 * 2 - ::try_registration()
3909
	 * 3 - ::register()
3910
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3911
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3912
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3913
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3914
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3915
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3916
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3917
	 *       jetpack_id, jetpack_secret, jetpack_public
3918
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3919
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3920
	 * 5 - user logs in with WP.com account
3921
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3922
	 *		- Jetpack_Client_Server::authorize()
3923
	 *		- Jetpack_Client_Server::get_token()
3924
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3925
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3926
	 *			- which responds with access_token, token_type, scope
3927
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3928
	 *		- Jetpack::activate_default_modules()
3929
	 *     		- Deactivates deprecated plugins
3930
	 *     		- Activates all default modules
3931
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3932
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3933
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3934
	 *     Done!
3935
	 */
3936
3937
	/**
3938
	 * Handles the page load events for the Jetpack admin page
3939
	 */
3940
	function admin_page_load() {
3941
		$error = false;
3942
3943
		// Make sure we have the right body class to hook stylings for subpages off of.
3944
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3945
3946
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3947
			// Should only be used in intermediate redirects to preserve state across redirects
3948
			Jetpack::restate();
3949
		}
3950
3951
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3952
			// @todo: Add validation against a known whitelist
3953
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3954
			// User clicked in the iframe to link their accounts
3955
			if ( ! Jetpack::is_user_connected() ) {
3956
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3957
3958
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3959
				$connect_url = $this->build_connect_url( true, $redirect, $from );
3960
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3961
3962
				if ( isset( $_GET['notes_iframe'] ) )
3963
					$connect_url .= '&notes_iframe';
3964
				wp_redirect( $connect_url );
3965
				exit;
3966
			} else {
3967
				if ( ! isset( $_GET['calypso_env'] ) ) {
3968
					Jetpack::state( 'message', 'already_authorized' );
3969
					wp_safe_redirect( Jetpack::admin_url() );
3970
					exit;
3971
				} else {
3972
					$connect_url = $this->build_connect_url( true, false, $from );
3973
					$connect_url .= '&already_authorized=true';
3974
					wp_redirect( $connect_url );
3975
					exit;
3976
				}
3977
			}
3978
		}
3979
3980
3981
		if ( isset( $_GET['action'] ) ) {
3982
			switch ( $_GET['action'] ) {
3983
			case 'authorize':
3984
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3985
					Jetpack::state( 'message', 'already_authorized' );
3986
					wp_safe_redirect( Jetpack::admin_url() );
3987
					exit;
3988
				}
3989
				Jetpack::log( 'authorize' );
3990
				$client_server = new Jetpack_Client_Server;
3991
				$client_server->client_authorize();
3992
				exit;
3993
			case 'register' :
3994
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3995
					$error = 'cheatin';
3996
					break;
3997
				}
3998
				check_admin_referer( 'jetpack-register' );
3999
				Jetpack::log( 'register' );
4000
				Jetpack::maybe_set_version_option();
4001
				$registered = Jetpack::try_registration();
4002
				if ( is_wp_error( $registered ) ) {
4003
					$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...
4004
					Jetpack::state( 'error', $error );
4005
					Jetpack::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...
4006
4007
					/**
4008
					 * Jetpack registration Error.
4009
					 *
4010
					 * @since 7.5.0
4011
					 *
4012
					 * @param string|int $error The error code.
4013
					 * @param \WP_Error $registered The error object.
4014
					 */
4015
					do_action( 'jetpack_connection_register_fail', $error, $registered );
4016
					break;
4017
				}
4018
4019
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4020
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4021
4022
				/**
4023
				 * Jetpack registration Success.
4024
				 *
4025
				 * @since 7.5.0
4026
				 *
4027
				 * @param string $from 'from' GET parameter;
4028
				 */
4029
				do_action( 'jetpack_connection_register_success', $from );
4030
4031
				$url = $this->build_connect_url( true, $redirect, $from );
4032
4033
				if ( ! empty( $_GET['onboarding'] ) ) {
4034
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4035
				}
4036
4037
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4038
					$url = add_query_arg( 'auth_approved', 'true', $url );
4039
				}
4040
4041
				wp_redirect( $url );
4042
				exit;
4043
			case 'activate' :
4044
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4045
					$error = 'cheatin';
4046
					break;
4047
				}
4048
4049
				$module = stripslashes( $_GET['module'] );
4050
				check_admin_referer( "jetpack_activate-$module" );
4051
				Jetpack::log( 'activate', $module );
4052
				if ( ! Jetpack::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Jetpack::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4053
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4054
				}
4055
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4056
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4057
				exit;
4058
			case 'activate_default_modules' :
4059
				check_admin_referer( 'activate_default_modules' );
4060
				Jetpack::log( 'activate_default_modules' );
4061
				Jetpack::restate();
4062
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4063
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4064
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4065
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4066
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4067
				exit;
4068
			case 'disconnect' :
4069
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4070
					$error = 'cheatin';
4071
					break;
4072
				}
4073
4074
				check_admin_referer( 'jetpack-disconnect' );
4075
				Jetpack::log( 'disconnect' );
4076
				Jetpack::disconnect();
4077
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4078
				exit;
4079
			case 'reconnect' :
4080
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4081
					$error = 'cheatin';
4082
					break;
4083
				}
4084
4085
				check_admin_referer( 'jetpack-reconnect' );
4086
				Jetpack::log( 'reconnect' );
4087
				$this->disconnect();
4088
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4089
				exit;
4090 View Code Duplication
			case 'deactivate' :
4091
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4092
					$error = 'cheatin';
4093
					break;
4094
				}
4095
4096
				$modules = stripslashes( $_GET['module'] );
4097
				check_admin_referer( "jetpack_deactivate-$modules" );
4098
				foreach ( explode( ',', $modules ) as $module ) {
4099
					Jetpack::log( 'deactivate', $module );
4100
					Jetpack::deactivate_module( $module );
4101
					Jetpack::state( 'message', 'module_deactivated' );
4102
				}
4103
				Jetpack::state( 'module', $modules );
4104
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4105
				exit;
4106
			case 'unlink' :
4107
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4108
				check_admin_referer( 'jetpack-unlink' );
4109
				Jetpack::log( 'unlink' );
4110
				Connection_Manager::disconnect_user();
4111
				Jetpack::state( 'message', 'unlinked' );
4112
				if ( 'sub-unlink' == $redirect ) {
4113
					wp_safe_redirect( admin_url() );
4114
				} else {
4115
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4116
				}
4117
				exit;
4118
			case 'onboard' :
4119
				if ( ! current_user_can( 'manage_options' ) ) {
4120
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4121
				} else {
4122
					Jetpack::create_onboarding_token();
4123
					$url = $this->build_connect_url( true );
4124
4125
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4126
						$url = add_query_arg( 'onboarding', $token, $url );
4127
					}
4128
4129
					$calypso_env = $this->get_calypso_env();
4130
					if ( ! empty( $calypso_env ) ) {
4131
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4132
					}
4133
4134
					wp_redirect( $url );
4135
					exit;
4136
				}
4137
				exit;
4138
			default:
4139
				/**
4140
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4141
				 *
4142
				 * @since 2.6.0
4143
				 *
4144
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4145
				 */
4146
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4147
			}
4148
		}
4149
4150
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4151
			self::activate_new_modules( true );
4152
		}
4153
4154
		$message_code = Jetpack::state( 'message' );
4155
		if ( Jetpack::state( 'optin-manage' ) ) {
4156
			$activated_manage = $message_code;
4157
			$message_code = 'jetpack-manage';
4158
		}
4159
4160
		switch ( $message_code ) {
4161
		case 'jetpack-manage':
4162
			$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), 'https://wordpress.com/sites' ) . '</strong>';
4163
			if ( $activated_manage ) {
0 ignored issues
show
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...
4164
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4165
			}
4166
			break;
4167
4168
		}
4169
4170
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4171
4172
		if ( ! empty( $deactivated_plugins ) ) {
4173
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4174
			$deactivated_titles  = array();
4175
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4176
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4177
					continue;
4178
				}
4179
4180
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4181
			}
4182
4183
			if ( $deactivated_titles ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated_titles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

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

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

Loading history...
4184
				if ( $this->message ) {
4185
					$this->message .= "<br /><br />\n";
4186
				}
4187
4188
				$this->message .= wp_sprintf(
4189
					_n(
4190
						'Jetpack contains the most recent version of the old %l plugin.',
4191
						'Jetpack contains the most recent versions of the old %l plugins.',
4192
						count( $deactivated_titles ),
4193
						'jetpack'
4194
					),
4195
					$deactivated_titles
4196
				);
4197
4198
				$this->message .= "<br />\n";
4199
4200
				$this->message .= _n(
4201
					'The old version has been deactivated and can be removed from your site.',
4202
					'The old versions have been deactivated and can be removed from your site.',
4203
					count( $deactivated_titles ),
4204
					'jetpack'
4205
				);
4206
			}
4207
		}
4208
4209
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4210
4211
		if ( $this->message || $this->error || $this->privacy_checks ) {
4212
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4213
		}
4214
4215
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4216
	}
4217
4218
	function admin_notices() {
4219
4220
		if ( $this->error ) {
4221
?>
4222
<div id="message" class="jetpack-message jetpack-err">
4223
	<div class="squeezer">
4224
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4225
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4226
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4227
<?php	endif; ?>
4228
	</div>
4229
</div>
4230
<?php
4231
		}
4232
4233
		if ( $this->message ) {
4234
?>
4235
<div id="message" class="jetpack-message">
4236
	<div class="squeezer">
4237
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4238
	</div>
4239
</div>
4240
<?php
4241
		}
4242
4243
		if ( $this->privacy_checks ) :
4244
			$module_names = $module_slugs = array();
4245
4246
			$privacy_checks = explode( ',', $this->privacy_checks );
4247
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4248
			foreach ( $privacy_checks as $module_slug ) {
4249
				$module = Jetpack::get_module( $module_slug );
4250
				if ( ! $module ) {
4251
					continue;
4252
				}
4253
4254
				$module_slugs[] = $module_slug;
4255
				$module_names[] = "<strong>{$module['name']}</strong>";
4256
			}
4257
4258
			$module_slugs = join( ',', $module_slugs );
4259
?>
4260
<div id="message" class="jetpack-message jetpack-err">
4261
	<div class="squeezer">
4262
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4263
		<p><?php
4264
			echo wp_kses(
4265
				wptexturize(
4266
					wp_sprintf(
4267
						_nx(
4268
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4269
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4270
							count( $privacy_checks ),
4271
							'%l = list of Jetpack module/feature names',
4272
							'jetpack'
4273
						),
4274
						$module_names
4275
					)
4276
				),
4277
				array( 'strong' => true )
4278
			);
4279
4280
			echo "\n<br />\n";
4281
4282
			echo wp_kses(
4283
				sprintf(
4284
					_nx(
4285
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4286
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4287
						count( $privacy_checks ),
4288
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4289
						'jetpack'
4290
					),
4291
					wp_nonce_url(
4292
						Jetpack::admin_url(
4293
							array(
4294
								'page'   => 'jetpack',
4295
								'action' => 'deactivate',
4296
								'module' => urlencode( $module_slugs ),
4297
							)
4298
						),
4299
						"jetpack_deactivate-$module_slugs"
4300
					),
4301
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4302
				),
4303
				array( 'a' => array( 'href' => true, 'title' => true ) )
4304
			);
4305
		?></p>
4306
	</div>
4307
</div>
4308
<?php endif;
4309
	}
4310
4311
	/**
4312
	 * We can't always respond to a signed XML-RPC request with a
4313
	 * helpful error message. In some circumstances, doing so could
4314
	 * leak information.
4315
	 *
4316
	 * Instead, track that the error occurred via a Jetpack_Option,
4317
	 * and send that data back in the heartbeat.
4318
	 * All this does is increment a number, but it's enough to find
4319
	 * trends.
4320
	 *
4321
	 * @param WP_Error $xmlrpc_error The error produced during
4322
	 *                               signature validation.
4323
	 */
4324
	function track_xmlrpc_error( $xmlrpc_error ) {
4325
		$code = is_wp_error( $xmlrpc_error )
4326
			? $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...
4327
			: 'should-not-happen';
4328
4329
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4330
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4331
			// No need to update the option if we already have
4332
			// this code stored.
4333
			return;
4334
		}
4335
		$xmlrpc_errors[ $code ] = true;
4336
4337
		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...
4338
	}
4339
4340
	/**
4341
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4342
	 */
4343
	function stat( $group, $detail ) {
4344
		if ( ! isset( $this->stats[ $group ] ) )
4345
			$this->stats[ $group ] = array();
4346
		$this->stats[ $group ][] = $detail;
4347
	}
4348
4349
	/**
4350
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4351
	 */
4352
	function do_stats( $method = '' ) {
4353
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4354
			foreach ( $this->stats as $group => $stats ) {
4355
				if ( is_array( $stats ) && count( $stats ) ) {
4356
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4357
					if ( 'server_side' === $method ) {
4358
						self::do_server_side_stat( $args );
4359
					} else {
4360
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4361
					}
4362
				}
4363
				unset( $this->stats[ $group ] );
4364
			}
4365
		}
4366
	}
4367
4368
	/**
4369
	 * Runs stats code for a one-off, server-side.
4370
	 *
4371
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4372
	 *
4373
	 * @return bool If it worked.
4374
	 */
4375
	static function do_server_side_stat( $args ) {
4376
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4377
		if ( is_wp_error( $response ) )
4378
			return false;
4379
4380
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4381
			return false;
4382
4383
		return true;
4384
	}
4385
4386
	/**
4387
	 * Builds the stats url.
4388
	 *
4389
	 * @param $args array|string The arguments to append to the URL.
4390
	 *
4391
	 * @return string The URL to be pinged.
4392
	 */
4393
	static function build_stats_url( $args ) {
4394
		$defaults = array(
4395
			'v'    => 'wpcom2',
4396
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4397
		);
4398
		$args     = wp_parse_args( $args, $defaults );
4399
		/**
4400
		 * Filter the URL used as the Stats tracking pixel.
4401
		 *
4402
		 * @since 2.3.2
4403
		 *
4404
		 * @param string $url Base URL used as the Stats tracking pixel.
4405
		 */
4406
		$base_url = apply_filters(
4407
			'jetpack_stats_base_url',
4408
			'https://pixel.wp.com/g.gif'
4409
		);
4410
		$url      = add_query_arg( $args, $base_url );
4411
		return $url;
4412
	}
4413
4414
	/**
4415
	 * Get the role of the current user.
4416
	 *
4417
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4418
	 *
4419
	 * @access public
4420
	 * @static
4421
	 *
4422
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4423
	 */
4424
	public static function translate_current_user_to_role() {
4425
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4426
4427
		$roles = new Roles();
4428
		return $roles->translate_current_user_to_role();
4429
	}
4430
4431
	/**
4432
	 * Get the role of a particular user.
4433
	 *
4434
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4435
	 *
4436
	 * @access public
4437
	 * @static
4438
	 *
4439
	 * @param \WP_User $user User object.
4440
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4441
	 */
4442
	public static function translate_user_to_role( $user ) {
4443
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4444
4445
		$roles = new Roles();
4446
		return $roles->translate_user_to_role( $user );
4447
	}
4448
4449
	/**
4450
	 * Get the minimum capability for a role.
4451
	 *
4452
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4453
	 *
4454
	 * @access public
4455
	 * @static
4456
	 *
4457
	 * @param string $role Role name.
4458
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4459
	 */
4460
	public static function translate_role_to_cap( $role ) {
4461
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4462
4463
		$roles = new Roles();
4464
		return $roles->translate_role_to_cap( $role );
4465
	}
4466
4467
	/**
4468
	 * Sign a user role with the master access token.
4469
	 * If not specified, will default to the current user.
4470
	 *
4471
	 * @deprecated since 7.7
4472
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4473
	 *
4474
	 * @access public
4475
	 * @static
4476
	 *
4477
	 * @param string $role    User role.
4478
	 * @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...
4479
	 * @return string Signed user role.
4480
	 */
4481
	public static function sign_role( $role, $user_id = null ) {
4482
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4483
		return self::connection()->sign_role( $role, $user_id );
4484
	}
4485
4486
	/**
4487
	 * Builds a URL to the Jetpack connection auth page
4488
	 *
4489
	 * @since 3.9.5
4490
	 *
4491
	 * @param bool $raw If true, URL will not be escaped.
4492
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4493
	 *                              If string, will be a custom redirect.
4494
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4495
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4496
	 *
4497
	 * @return string Connect URL
4498
	 */
4499
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4500
		$site_id = Jetpack_Options::get_option( 'id' );
4501
		$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...
4502
4503
		if ( $register || ! $blog_token || ! $site_id ) {
4504
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4505
4506
			if ( ! empty( $redirect ) ) {
4507
				$url = add_query_arg(
4508
					'redirect',
4509
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4510
					$url
4511
				);
4512
			}
4513
4514
			if( is_network_admin() ) {
4515
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4516
			}
4517
		} else {
4518
4519
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4520
			// because otherwise this logic can get us in to a loop.
4521
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4522
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4523
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4524
4525
				$response = Client::wpcom_json_api_request_as_blog(
4526
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4527
					'1.1'
4528
				);
4529
4530
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4531
4532
					// Generating a register URL instead to refresh the existing token
4533
					return $this->build_connect_url( $raw, $redirect, $from, true );
4534
				}
4535
			}
4536
4537
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4499 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...
4538
		}
4539
4540
		if ( $from ) {
4541
			$url = add_query_arg( 'from', $from, $url );
4542
		}
4543
4544
		// Ensure that class to get the affiliate code is loaded
4545
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4546
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4547
		}
4548
		// Get affiliate code and add it to the URL
4549
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4550
4551
		$calypso_env = $this->get_calypso_env();
4552
4553
		if ( ! empty( $calypso_env ) ) {
4554
			$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4555
		}
4556
4557
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4558
	}
4559
4560
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4561
		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4562
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4563
		}
4564
4565
		$roles       = new Roles();
4566
		$role        = $roles->translate_current_user_to_role();
4567
		$signed_role = self::connection()->sign_role( $role );
4568
4569
		$user = wp_get_current_user();
4570
4571
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4572
		$redirect = $redirect
4573
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4574
			: $jetpack_admin_page;
4575
4576
		if( isset( $_REQUEST['is_multisite'] ) ) {
4577
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4578
		}
4579
4580
		$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4581
4582
		/**
4583
		 * Filter the type of authorization.
4584
		 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4585
		 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4586
		 *
4587
		 * @since 4.3.3
4588
		 *
4589
		 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4590
		 */
4591
		$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4592
4593
4594
		$tracks = new Tracking();
4595
		$tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4596
4597
		$args = urlencode_deep(
4598
			array(
4599
				'response_type' => 'code',
4600
				'client_id'     => Jetpack_Options::get_option( 'id' ),
4601
				'redirect_uri'  => add_query_arg(
4602
					array(
4603
						'action'   => 'authorize',
4604
						'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4605
						'redirect' => urlencode( $redirect ),
4606
					),
4607
					esc_url( admin_url( 'admin.php?page=jetpack' ) )
4608
				),
4609
				'state'         => $user->ID,
4610
				'scope'         => $signed_role,
4611
				'user_email'    => $user->user_email,
4612
				'user_login'    => $user->user_login,
4613
				'is_active'     => Jetpack::is_active(),
4614
				'jp_version'    => JETPACK__VERSION,
4615
				'auth_type'     => $auth_type,
4616
				'secret'        => $secrets['secret_1'],
4617
				'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4618
				'blogname'      => get_option( 'blogname' ),
4619
				'site_url'      => site_url(),
4620
				'home_url'      => home_url(),
4621
				'site_icon'     => get_site_icon_url(),
4622
				'site_lang'     => get_locale(),
4623
				'_ui'           => $tracks_identity['_ui'],
4624
				'_ut'           => $tracks_identity['_ut'],
4625
				'site_created'  => Jetpack::get_assumed_site_creation_date(),
4626
			)
4627
		);
4628
4629
		self::apply_activation_source_to_args( $args );
4630
4631
		$connection = self::connection();
4632
4633
		$api_url = $iframe ? $connection->api_url( 'authorize_iframe' ) : $connection->api_url( 'authorize' );
4634
4635
		return add_query_arg( $args, $api_url );
4636
	}
4637
4638
	/**
4639
	 * Get our assumed site creation date.
4640
	 * Calculated based on the earlier date of either:
4641
	 * - Earliest admin user registration date.
4642
	 * - Earliest date of post of any post type.
4643
	 *
4644
	 * @since 7.2.0
4645
	 *
4646
	 * @return string Assumed site creation date and time.
4647
	 */
4648 View Code Duplication
	public static function get_assumed_site_creation_date() {
4649
		$earliest_registered_users = get_users( array(
4650
			'role'    => 'administrator',
4651
			'orderby' => 'user_registered',
4652
			'order'   => 'ASC',
4653
			'fields'  => array( 'user_registered' ),
4654
			'number'  => 1,
4655
		) );
4656
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
4657
4658
		$earliest_posts = get_posts( array(
4659
			'posts_per_page' => 1,
4660
			'post_type'      => 'any',
4661
			'post_status'    => 'any',
4662
			'orderby'        => 'date',
4663
			'order'          => 'ASC',
4664
		) );
4665
4666
		// If there are no posts at all, we'll count only on user registration date.
4667
		if ( $earliest_posts ) {
4668
			$earliest_post_date = $earliest_posts[0]->post_date;
4669
		} else {
4670
			$earliest_post_date = PHP_INT_MAX;
4671
		}
4672
4673
		return min( $earliest_registration_date, $earliest_post_date );
4674
	}
4675
4676 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4677
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4678
4679
		if ( $activation_source_name ) {
4680
			$args['_as'] = urlencode( $activation_source_name );
4681
		}
4682
4683
		if ( $activation_source_keyword ) {
4684
			$args['_ak'] = urlencode( $activation_source_keyword );
4685
		}
4686
	}
4687
4688
	function build_reconnect_url( $raw = false ) {
4689
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4690
		return $raw ? $url : esc_url( $url );
4691
	}
4692
4693
	public static function admin_url( $args = null ) {
4694
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4695
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4696
		return $url;
4697
	}
4698
4699
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4700
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4701
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4702
	}
4703
4704
	function dismiss_jetpack_notice() {
4705
4706
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4707
			return;
4708
		}
4709
4710
		switch( $_GET['jetpack-notice'] ) {
4711
			case 'dismiss':
4712
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4713
4714
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4715
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4716
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4717
				}
4718
				break;
4719
		}
4720
	}
4721
4722
	public static function sort_modules( $a, $b ) {
4723
		if ( $a['sort'] == $b['sort'] )
4724
			return 0;
4725
4726
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4727
	}
4728
4729
	function ajax_recheck_ssl() {
4730
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4731
		$result = Jetpack::permit_ssl( true );
4732
		wp_send_json( array(
4733
			'enabled' => $result,
4734
			'message' => get_transient( 'jetpack_https_test_message' )
4735
		) );
4736
	}
4737
4738
/* Client API */
4739
4740
	/**
4741
	 * Returns the requested Jetpack API URL
4742
	 *
4743
	 * @deprecated since 7.7
4744
	 * @return string
4745
	 */
4746
	public static function api_url( $relative_url ) {
4747
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4748
		$connection = self::connection();
4749
		return $connection->api_url( $relative_url );
4750
	}
4751
4752
	/**
4753
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4754
	 */
4755
	public static function fix_url_for_bad_hosts( $url ) {
4756
		if ( 0 !== strpos( $url, 'https://' ) ) {
4757
			return $url;
4758
		}
4759
4760
		switch ( JETPACK_CLIENT__HTTPS ) {
4761
			case 'ALWAYS' :
4762
				return $url;
4763
			case 'NEVER' :
4764
				return set_url_scheme( $url, 'http' );
4765
			// default : case 'AUTO' :
4766
		}
4767
4768
		// we now return the unmodified SSL URL by default, as a security precaution
4769
		return $url;
4770
	}
4771
4772
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4773
		// Default to a blog token.
4774
		$token_type = 'blog';
4775
4776
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4777
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4778
			if ( ! empty( $_GET['onboarding'] ) ) {
4779
				$jpo = $_GET;
4780
			} else {
4781
				$jpo = json_decode( $request_data, true );
4782
			}
4783
4784
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4785
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4786
4787
			if (
4788
				isset( $jpo_user )
4789
				&& isset( $jpo_token )
4790
				&& is_email( $jpo_user )
4791
				&& ctype_alnum( $jpo_token )
4792
				&& isset( $_GET['rest_route'] )
4793
				&& self::validate_onboarding_token_action(
4794
					$jpo_token,
4795
					$_GET['rest_route']
4796
				)
4797
			) {
4798
				$jp_user = get_user_by( 'email', $jpo_user );
4799
				if ( is_a( $jp_user, 'WP_User' ) ) {
4800
					wp_set_current_user( $jp_user->ID );
4801
					$user_can = is_multisite()
4802
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4803
						: current_user_can( 'manage_options' );
4804
					if ( $user_can ) {
4805
						$token_type = 'user';
4806
						$token->external_user_id = $jp_user->ID;
4807
					}
4808
				}
4809
			}
4810
4811
			$token_data['type']    = $token_type;
4812
			$token_data['user_id'] = $token->external_user_id;
4813
		}
4814
4815
		return $token_data;
4816
	}
4817
4818
	/**
4819
	 * Create a random secret for validating onboarding payload
4820
	 *
4821
	 * @return string Secret token
4822
	 */
4823
	public static function create_onboarding_token() {
4824
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4825
			$token = wp_generate_password( 32, false );
4826
			Jetpack_Options::update_option( 'onboarding', $token );
4827
		}
4828
4829
		return $token;
4830
	}
4831
4832
	/**
4833
	 * Remove the onboarding token
4834
	 *
4835
	 * @return bool True on success, false on failure
4836
	 */
4837
	public static function invalidate_onboarding_token() {
4838
		return Jetpack_Options::delete_option( 'onboarding' );
4839
	}
4840
4841
	/**
4842
	 * Validate an onboarding token for a specific action
4843
	 *
4844
	 * @return boolean True if token/action pair is accepted, false if not
4845
	 */
4846
	public static function validate_onboarding_token_action( $token, $action ) {
4847
		// Compare tokens, bail if tokens do not match
4848
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4849
			return false;
4850
		}
4851
4852
		// List of valid actions we can take
4853
		$valid_actions = array(
4854
			'/jetpack/v4/settings',
4855
		);
4856
4857
		// Whitelist the action
4858
		if ( ! in_array( $action, $valid_actions ) ) {
4859
			return false;
4860
		}
4861
4862
		return true;
4863
	}
4864
4865
	/**
4866
	 * Checks to see if the URL is using SSL to connect with Jetpack
4867
	 *
4868
	 * @since 2.3.3
4869
	 * @return boolean
4870
	 */
4871
	public static function permit_ssl( $force_recheck = false ) {
4872
		// Do some fancy tests to see if ssl is being supported
4873
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4874
			$message = '';
4875
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4876
				$ssl = 0;
4877
			} else {
4878
				switch ( JETPACK_CLIENT__HTTPS ) {
4879
					case 'NEVER':
4880
						$ssl = 0;
4881
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4882
						break;
4883
					case 'ALWAYS':
4884
					case 'AUTO':
4885
					default:
4886
						$ssl = 1;
4887
						break;
4888
				}
4889
4890
				// If it's not 'NEVER', test to see
4891
				if ( $ssl ) {
4892
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4893
						$ssl = 0;
4894
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4895
					} else {
4896
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4897
						if ( is_wp_error( $response ) ) {
4898
							$ssl = 0;
4899
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4900
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4901
							$ssl = 0;
4902
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4903
						}
4904
					}
4905
				}
4906
			}
4907
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4908
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4909
		}
4910
4911
		return (bool) $ssl;
4912
	}
4913
4914
	/*
4915
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4916
	 */
4917
	public function alert_auto_ssl_fail() {
4918
		if ( ! current_user_can( 'manage_options' ) )
4919
			return;
4920
4921
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4922
		?>
4923
4924
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4925
			<div class="jp-banner__content">
4926
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4927
				<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>
4928
				<p>
4929
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4930
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4931
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4932
				</p>
4933
				<p>
4934
					<?php printf( __( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
4935
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4936
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4937
				</p>
4938
			</div>
4939
		</div>
4940
		<style>
4941
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4942
		</style>
4943
		<script type="text/javascript">
4944
			jQuery( document ).ready( function( $ ) {
4945
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4946
					var $this = $( this );
4947
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4948
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4949
					e.preventDefault();
4950
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4951
					$.post( ajaxurl, data )
4952
					  .done( function( response ) {
4953
					  	if ( response.enabled ) {
4954
					  		$( '#jetpack-ssl-warning' ).hide();
4955
					  	} else {
4956
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4957
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4958
					  	}
4959
					  }.bind( $this ) );
4960
				} );
4961
			} );
4962
		</script>
4963
4964
		<?php
4965
	}
4966
4967
	/**
4968
	 * Returns the Jetpack XML-RPC API
4969
	 *
4970
	 * @return string
4971
	 */
4972
	public static function xmlrpc_api_url() {
4973
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4974
		return untrailingslashit( $base ) . '/xmlrpc.php';
4975
	}
4976
4977
	public static function connection() {
4978
		return self::init()->connection_manager;
4979
	}
4980
4981
	/**
4982
	 * Creates two secret tokens and the end of life timestamp for them.
4983
	 *
4984
	 * Note these tokens are unique per call, NOT static per site for connecting.
4985
	 *
4986
	 * @since 2.6
4987
	 * @return array
4988
	 */
4989
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4990
		if ( false === $user_id ) {
4991
			$user_id = get_current_user_id();
4992
		}
4993
4994
		return self::connection()->generate_secrets( $action, $user_id, $exp );
4995
	}
4996
4997
	public static function get_secrets( $action, $user_id ) {
4998
		$secrets = self::connection()->get_secrets( $action, $user_id );
4999
5000
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5001
			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...
5002
		}
5003
5004
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5005
			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...
5006
		}
5007
5008
		return $secrets;
5009
	}
5010
5011
	/**
5012
	 * @deprecated 7.5 Use Connection_Manager instead.
5013
	 *
5014
	 * @param $action
5015
	 * @param $user_id
5016
	 */
5017
	public static function delete_secrets( $action, $user_id ) {
5018
		return self::connection()->delete_secrets( $action, $user_id );
5019
	}
5020
5021
	/**
5022
	 * Builds the timeout limit for queries talking with the wpcom servers.
5023
	 *
5024
	 * Based on local php max_execution_time in php.ini
5025
	 *
5026
	 * @since 2.6
5027
	 * @return int
5028
	 * @deprecated
5029
	 **/
5030
	public function get_remote_query_timeout_limit() {
5031
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5032
		return Jetpack::get_max_execution_time();
5033
	}
5034
5035
	/**
5036
	 * Builds the timeout limit for queries talking with the wpcom servers.
5037
	 *
5038
	 * Based on local php max_execution_time in php.ini
5039
	 *
5040
	 * @since 5.4
5041
	 * @return int
5042
	 **/
5043
	public static function get_max_execution_time() {
5044
		$timeout = (int) ini_get( 'max_execution_time' );
5045
5046
		// Ensure exec time set in php.ini
5047
		if ( ! $timeout ) {
5048
			$timeout = 30;
5049
		}
5050
		return $timeout;
5051
	}
5052
5053
	/**
5054
	 * Sets a minimum request timeout, and returns the current timeout
5055
	 *
5056
	 * @since 5.4
5057
	 **/
5058 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5059
		$timeout = self::get_max_execution_time();
5060
		if ( $timeout < $min_timeout ) {
5061
			$timeout = $min_timeout;
5062
			set_time_limit( $timeout );
5063
		}
5064
		return $timeout;
5065
	}
5066
5067
	/**
5068
	 * Takes the response from the Jetpack register new site endpoint and
5069
	 * verifies it worked properly.
5070
	 *
5071
	 * @since 2.6
5072
	 * @deprecated since 7.7.0
5073
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5074
	 **/
5075
	public function validate_remote_register_response() {
5076
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5077
	}
5078
5079
	/**
5080
	 * @return bool|WP_Error
5081
	 */
5082
	public static function register() {
5083
		$tracking = new Tracking();
5084
		$tracking->record_user_event( 'jpc_register_begin' );
5085
5086
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5087
5088
		$connection = self::connection();
5089
		$registration = $connection->register();
5090
5091
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5092
5093
		if ( ! $registration || is_wp_error( $registration ) ) {
5094
			return $registration;
5095
		}
5096
5097
		return true;
5098
	}
5099
5100
	/**
5101
	 * Filters the registration request body to include tracking properties.
5102
	 *
5103
	 * @param Array $properties
5104
	 * @return Array amended properties.
5105
	 */
5106
	public static function filter_register_request_body( $properties ) {
5107
		$tracking = new Tracking();
5108
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5109
5110
		return array_merge(
5111
			$properties,
5112
			array(
5113
				'_ui' => $tracks_identity['_ui'],
5114
				'_ut' => $tracks_identity['_ut'],
5115
			)
5116
		);
5117
	}
5118
5119
	/**
5120
	 * If the db version is showing something other that what we've got now, bump it to current.
5121
	 *
5122
	 * @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...
5123
	 */
5124
	public static function maybe_set_version_option() {
5125
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5126
		if ( JETPACK__VERSION != $version ) {
5127
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5128
5129
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5130
				/** This action is documented in class.jetpack.php */
5131
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5132
			}
5133
5134
			return true;
5135
		}
5136
		return false;
5137
	}
5138
5139
/* Client Server API */
5140
5141
	/**
5142
	 * Loads the Jetpack XML-RPC client.
5143
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5144
	 *
5145
	 * @deprecated since 7.7.0
5146
	 */
5147
	public static function load_xml_rpc_client() {
5148
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5149
	}
5150
5151
	/**
5152
	 * Resets the saved authentication state in between testing requests.
5153
	 */
5154
	public function reset_saved_auth_state() {
5155
		$this->rest_authentication_status = null;
5156
		$this->connection_manager->reset_saved_auth_state();
5157
	}
5158
5159
	/**
5160
	 * Verifies the signature of the current request.
5161
	 *
5162
	 * @deprecated since 7.7.0
5163
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5164
	 *
5165
	 * @return false|array
5166
	 */
5167
	public function verify_xml_rpc_signature() {
5168
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5169
		return self::connection()->verify_xml_rpc_signature();
5170
	}
5171
5172
	/**
5173
	 * Verifies the signature of the current request.
5174
	 *
5175
	 * This function has side effects and should not be used. Instead,
5176
	 * use the memoized version `->verify_xml_rpc_signature()`.
5177
	 *
5178
	 * @deprecated since 7.7.0
5179
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5180
	 * @internal
5181
	 */
5182
	private function internal_verify_xml_rpc_signature() {
5183
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5184
	}
5185
5186
	/**
5187
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5188
	 *
5189
	 * @deprecated since 7.7.0
5190
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5191
	 *
5192
	 * @param \WP_User|mixed $user     User object if authenticated.
5193
	 * @param string         $username Username.
5194
	 * @param string         $password Password string.
5195
	 * @return \WP_User|mixed Authenticated user or error.
5196
	 */
5197
	public function authenticate_jetpack( $user, $username, $password ) {
5198
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5199
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5200
	}
5201
5202
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5203
	// Uses the existing XMLRPC request signing implementation.
5204
	function wp_rest_authenticate( $user ) {
5205
		if ( ! empty( $user ) ) {
5206
			// Another authentication method is in effect.
5207
			return $user;
5208
		}
5209
5210
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5211
			// Nothing to do for this authentication method.
5212
			return null;
5213
		}
5214
5215
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5216
			// Nothing to do for this authentication method.
5217
			return null;
5218
		}
5219
5220
		// Ensure that we always have the request body available.  At this
5221
		// point, the WP REST API code to determine the request body has not
5222
		// run yet.  That code may try to read from 'php://input' later, but
5223
		// this can only be done once per request in PHP versions prior to 5.6.
5224
		// So we will go ahead and perform this read now if needed, and save
5225
		// the request body where both the Jetpack signature verification code
5226
		// and the WP REST API code can see it.
5227
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5228
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5229
		}
5230
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5231
5232
		// Only support specific request parameters that have been tested and
5233
		// are known to work with signature verification.  A different method
5234
		// can be passed to the WP REST API via the '?_method=' parameter if
5235
		// needed.
5236
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5237
			$this->rest_authentication_status = new WP_Error(
5238
				'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...
5239
				__( 'This request method is not supported.', 'jetpack' ),
5240
				array( 'status' => 400 )
5241
			);
5242
			return null;
5243
		}
5244
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5245
			$this->rest_authentication_status = new WP_Error(
5246
				'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...
5247
				__( 'This request method does not support body parameters.', 'jetpack' ),
5248
				array( 'status' => 400 )
5249
			);
5250
			return null;
5251
		}
5252
5253
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5254
5255
		if (
5256
			$verified &&
5257
			isset( $verified['type'] ) &&
5258
			'user' === $verified['type'] &&
5259
			! empty( $verified['user_id'] )
5260
		) {
5261
			// Authentication successful.
5262
			$this->rest_authentication_status = true;
5263
			return $verified['user_id'];
5264
		}
5265
5266
		// Something else went wrong.  Probably a signature error.
5267
		$this->rest_authentication_status = new WP_Error(
5268
			'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...
5269
			__( 'The request is not signed correctly.', 'jetpack' ),
5270
			array( 'status' => 400 )
5271
		);
5272
		return null;
5273
	}
5274
5275
	/**
5276
	 * Report authentication status to the WP REST API.
5277
	 *
5278
	 * @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...
5279
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5280
	 */
5281
	public function wp_rest_authentication_errors( $value ) {
5282
		if ( $value !== null ) {
5283
			return $value;
5284
		}
5285
		return $this->rest_authentication_status;
5286
	}
5287
5288
	/**
5289
	 * Add our nonce to this request.
5290
	 *
5291
	 * @deprecated since 7.7.0
5292
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5293
	 *
5294
	 * @param int    $timestamp Timestamp of the request.
5295
	 * @param string $nonce     Nonce string.
5296
	 */
5297
	public function add_nonce( $timestamp, $nonce ) {
5298
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5299
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5300
	}
5301
5302
	/**
5303
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5304
	 * Capture it here so we can verify the signature later.
5305
	 *
5306
	 * @deprecated since 7.7.0
5307
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5308
	 *
5309
	 * @param array $methods XMLRPC methods.
5310
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5311
	 */
5312
	public function xmlrpc_methods( $methods ) {
5313
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5314
		return $this->connection_manager->xmlrpc_methods( $methods );
5315
	}
5316
5317
	/**
5318
	 * Register additional public XMLRPC methods.
5319
	 *
5320
	 * @deprecated since 7.7.0
5321
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5322
	 *
5323
	 * @param array $methods Public XMLRPC methods.
5324
	 * @return array Public XMLRPC methods, with the getOptions one.
5325
	 */
5326
	public function public_xmlrpc_methods( $methods ) {
5327
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5328
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5329
	}
5330
5331
	/**
5332
	 * Handles a getOptions XMLRPC method call.
5333
	 *
5334
	 * @deprecated since 7.7.0
5335
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5336
	 *
5337
	 * @param array $args method call arguments.
5338
	 * @return array an amended XMLRPC server options array.
5339
	 */
5340
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5341
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5342
		return $this->connection_manager->jetpack_getOptions( $args );
5343
	}
5344
5345
	/**
5346
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5347
	 *
5348
	 * @deprecated since 7.7.0
5349
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5350
	 *
5351
	 * @param array $options Standard Core options.
5352
	 * @return array Amended options.
5353
	 */
5354
	public function xmlrpc_options( $options ) {
5355
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5356
		return $this->connection_manager->xmlrpc_options( $options );
5357
	}
5358
5359
	/**
5360
	 * Cleans nonces that were saved when calling ::add_nonce.
5361
	 *
5362
	 * @deprecated since 7.7.0
5363
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5364
	 *
5365
	 * @param bool $all whether to clean even non-expired nonces.
5366
	 */
5367
	public static function clean_nonces( $all = false ) {
5368
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5369
		return self::connection()->clean_nonces( $all );
5370
	}
5371
5372
	/**
5373
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5374
	 * SET: state( $key, $value );
5375
	 * GET: $value = state( $key );
5376
	 *
5377
	 * @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...
5378
	 * @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...
5379
	 * @param bool $restate private
5380
	 */
5381
	public static function state( $key = null, $value = null, $restate = false ) {
5382
		static $state = array();
5383
		static $path, $domain;
5384
		if ( ! isset( $path ) ) {
5385
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5386
			$admin_url = Jetpack::admin_url();
5387
			$bits      = wp_parse_url( $admin_url );
5388
5389
			if ( is_array( $bits ) ) {
5390
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5391
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5392
			} else {
5393
				$path = $domain = null;
5394
			}
5395
		}
5396
5397
		// Extract state from cookies and delete cookies
5398
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5399
			$yum = $_COOKIE[ 'jetpackState' ];
5400
			unset( $_COOKIE[ 'jetpackState' ] );
5401
			foreach ( $yum as $k => $v ) {
5402
				if ( strlen( $v ) )
5403
					$state[ $k ] = $v;
5404
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5405
			}
5406
		}
5407
5408
		if ( $restate ) {
5409
			foreach ( $state as $k => $v ) {
5410
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5411
			}
5412
			return;
5413
		}
5414
5415
		// Get a state variable
5416
		if ( isset( $key ) && ! isset( $value ) ) {
5417
			if ( array_key_exists( $key, $state ) )
5418
				return $state[ $key ];
5419
			return null;
5420
		}
5421
5422
		// Set a state variable
5423
		if ( isset ( $key ) && isset( $value ) ) {
5424
			if( is_array( $value ) && isset( $value[0] ) ) {
5425
				$value = $value[0];
5426
			}
5427
			$state[ $key ] = $value;
5428
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5429
		}
5430
	}
5431
5432
	public static function restate() {
5433
		Jetpack::state( null, null, true );
5434
	}
5435
5436
	public static function check_privacy( $file ) {
5437
		static $is_site_publicly_accessible = null;
5438
5439
		if ( is_null( $is_site_publicly_accessible ) ) {
5440
			$is_site_publicly_accessible = false;
5441
5442
			$rpc = new Jetpack_IXR_Client();
5443
5444
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5445
			if ( $success ) {
5446
				$response = $rpc->getResponse();
5447
				if ( $response ) {
5448
					$is_site_publicly_accessible = true;
5449
				}
5450
			}
5451
5452
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5453
		}
5454
5455
		if ( $is_site_publicly_accessible ) {
5456
			return;
5457
		}
5458
5459
		$module_slug = self::get_module_slug( $file );
5460
5461
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5462
		if ( ! $privacy_checks ) {
5463
			$privacy_checks = $module_slug;
5464
		} else {
5465
			$privacy_checks .= ",$module_slug";
5466
		}
5467
5468
		Jetpack::state( 'privacy_checks', $privacy_checks );
5469
	}
5470
5471
	/**
5472
	 * Helper method for multicall XMLRPC.
5473
	 */
5474
	public static function xmlrpc_async_call() {
5475
		global $blog_id;
5476
		static $clients = array();
5477
5478
		$client_blog_id = is_multisite() ? $blog_id : 0;
5479
5480
		if ( ! isset( $clients[$client_blog_id] ) ) {
5481
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5482
			if ( function_exists( 'ignore_user_abort' ) ) {
5483
				ignore_user_abort( true );
5484
			}
5485
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5486
		}
5487
5488
		$args = func_get_args();
5489
5490
		if ( ! empty( $args[0] ) ) {
5491
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5492
		} elseif ( is_multisite() ) {
5493
			foreach ( $clients as $client_blog_id => $client ) {
5494
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5495
					continue;
5496
				}
5497
5498
				$switch_success = switch_to_blog( $client_blog_id, true );
5499
				if ( ! $switch_success ) {
5500
					continue;
5501
				}
5502
5503
				flush();
5504
				$client->query();
5505
5506
				restore_current_blog();
5507
			}
5508
		} else {
5509
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5510
				flush();
5511
				$clients[0]->query();
5512
			}
5513
		}
5514
	}
5515
5516
	public static function staticize_subdomain( $url ) {
5517
5518
		// Extract hostname from URL
5519
		$host = parse_url( $url, PHP_URL_HOST );
5520
5521
		// Explode hostname on '.'
5522
		$exploded_host = explode( '.', $host );
5523
5524
		// Retrieve the name and TLD
5525
		if ( count( $exploded_host ) > 1 ) {
5526
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5527
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5528
			// Rebuild domain excluding subdomains
5529
			$domain = $name . '.' . $tld;
5530
		} else {
5531
			$domain = $host;
5532
		}
5533
		// Array of Automattic domains
5534
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5535
5536
		// Return $url if not an Automattic domain
5537
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5538
			return $url;
5539
		}
5540
5541
		if ( is_ssl() ) {
5542
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5543
		}
5544
5545
		srand( crc32( basename( $url ) ) );
5546
		$static_counter = rand( 0, 2 );
5547
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5548
5549
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5550
	}
5551
5552
/* JSON API Authorization */
5553
5554
	/**
5555
	 * Handles the login action for Authorizing the JSON API
5556
	 */
5557
	function login_form_json_api_authorization() {
5558
		$this->verify_json_api_authorization_request();
5559
5560
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5561
5562
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5563
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5564
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5565
	}
5566
5567
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5568
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5569
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5570
			return $url;
5571
		}
5572
5573
		$parsed_url = parse_url( $url );
5574
		$url = strtok( $url, '?' );
5575
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5576
		if ( ! empty( $parsed_url['query'] ) )
5577
			$url .= "&{$parsed_url['query']}";
5578
5579
		return $url;
5580
	}
5581
5582
	// Make sure the POSTed request is handled by the same action
5583
	function preserve_action_in_login_form_for_json_api_authorization() {
5584
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5585
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5586
	}
5587
5588
	// If someone logs in to approve API access, store the Access Code in usermeta
5589
	function store_json_api_authorization_token( $user_login, $user ) {
5590
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5591
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5592
		$token = wp_generate_password( 32, false );
5593
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5594
	}
5595
5596
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5597
	function allow_wpcom_public_api_domain( $domains ) {
5598
		$domains[] = 'public-api.wordpress.com';
5599
		return $domains;
5600
	}
5601
5602
	static function is_redirect_encoded( $redirect_url ) {
5603
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5604
	}
5605
5606
	// Add all wordpress.com environments to the safe redirect whitelist
5607
	function allow_wpcom_environments( $domains ) {
5608
		$domains[] = 'wordpress.com';
5609
		$domains[] = 'wpcalypso.wordpress.com';
5610
		$domains[] = 'horizon.wordpress.com';
5611
		$domains[] = 'calypso.localhost';
5612
		return $domains;
5613
	}
5614
5615
	// Add the Access Code details to the public-api.wordpress.com redirect
5616
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5617
		return add_query_arg(
5618
			urlencode_deep(
5619
				array(
5620
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5621
					'jetpack-user-id' => (int) $user->ID,
5622
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5623
				)
5624
			),
5625
			$redirect_to
5626
		);
5627
	}
5628
5629
5630
	/**
5631
	 * Verifies the request by checking the signature
5632
	 *
5633
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5634
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5635
	 *
5636
	 * @param null|array $environment
5637
	 */
5638
	function verify_json_api_authorization_request( $environment = null ) {
5639
		$environment = is_null( $environment )
5640
			? $_REQUEST
5641
			: $environment;
5642
5643
		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...
5644
		$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...
5645
		if ( ! $token || empty( $token->secret ) ) {
5646
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5647
		}
5648
5649
		$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' );
5650
5651
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5652
		if ( Jetpack::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5653
			/**
5654
			 * Jetpack authorisation request Error.
5655
			 *
5656
			 * @since 7.5.0
5657
			 *
5658
			 */
5659
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5660
			$die_error = sprintf(
5661
				/* translators: %s is a URL */
5662
				__( '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' ),
5663
				'https://jetpack.com/support/double-encoding/'
5664
			);
5665
		}
5666
5667
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5668
5669
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5670
			$signature = $jetpack_signature->sign_request(
5671
				$environment['token'],
5672
				$environment['timestamp'],
5673
				$environment['nonce'],
5674
				'',
5675
				'GET',
5676
				$environment['jetpack_json_api_original_query'],
5677
				null,
5678
				true
5679
			);
5680
		} else {
5681
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5682
		}
5683
5684
		if ( ! $signature ) {
5685
			wp_die( $die_error );
5686
		} else if ( is_wp_error( $signature ) ) {
5687
			wp_die( $die_error );
5688
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5689
			if ( is_ssl() ) {
5690
				// 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
5691
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5692
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5693
					wp_die( $die_error );
5694
				}
5695
			} else {
5696
				wp_die( $die_error );
5697
			}
5698
		}
5699
5700
		$timestamp = (int) $environment['timestamp'];
5701
		$nonce     = stripslashes( (string) $environment['nonce'] );
5702
5703
		if ( ! $this->connection->add_nonce( $timestamp, $nonce ) ) {
0 ignored issues
show
Bug introduced by
The property connection does not seem to exist. Did you mean connection_manager?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
5704
			// De-nonce the nonce, at least for 5 minutes.
5705
			// 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)
5706
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5707
			if ( $old_nonce_time < time() - 300 ) {
5708
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5709
			}
5710
		}
5711
5712
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5713
		$data_filters = array(
5714
			'state'        => 'opaque',
5715
			'client_id'    => 'int',
5716
			'client_title' => 'string',
5717
			'client_image' => 'url',
5718
		);
5719
5720
		foreach ( $data_filters as $key => $sanitation ) {
5721
			if ( ! isset( $data->$key ) ) {
5722
				wp_die( $die_error );
5723
			}
5724
5725
			switch ( $sanitation ) {
5726
			case 'int' :
5727
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5728
				break;
5729
			case 'opaque' :
5730
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5731
				break;
5732
			case 'string' :
5733
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5734
				break;
5735
			case 'url' :
5736
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5737
				break;
5738
			}
5739
		}
5740
5741
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5742
			wp_die( $die_error );
5743
		}
5744
	}
5745
5746
	function login_message_json_api_authorization( $message ) {
5747
		return '<p class="message">' . sprintf(
5748
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5749
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5750
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5751
	}
5752
5753
	/**
5754
	 * Get $content_width, but with a <s>twist</s> filter.
5755
	 */
5756
	public static function get_content_width() {
5757
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5758
			? $GLOBALS['content_width']
5759
			: false;
5760
		/**
5761
		 * Filter the Content Width value.
5762
		 *
5763
		 * @since 2.2.3
5764
		 *
5765
		 * @param string $content_width Content Width value.
5766
		 */
5767
		return apply_filters( 'jetpack_content_width', $content_width );
5768
	}
5769
5770
	/**
5771
	 * Pings the WordPress.com Mirror Site for the specified options.
5772
	 *
5773
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5774
	 *
5775
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5776
	 */
5777
	public function get_cloud_site_options( $option_names ) {
5778
		$option_names = array_filter( (array) $option_names, 'is_string' );
5779
5780
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5781
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5782
		if ( $xml->isError() ) {
5783
			return array(
5784
				'error_code' => $xml->getErrorCode(),
5785
				'error_msg'  => $xml->getErrorMessage(),
5786
			);
5787
		}
5788
		$cloud_site_options = $xml->getResponse();
5789
5790
		return $cloud_site_options;
5791
	}
5792
5793
	/**
5794
	 * Checks if the site is currently in an identity crisis.
5795
	 *
5796
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5797
	 */
5798
	public static function check_identity_crisis() {
5799
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5800
			return false;
5801
		}
5802
5803
		return Jetpack_Options::get_option( 'sync_error_idc' );
5804
	}
5805
5806
	/**
5807
	 * Checks whether the home and siteurl specifically are whitelisted
5808
	 * Written so that we don't have re-check $key and $value params every time
5809
	 * we want to check if this site is whitelisted, for example in footer.php
5810
	 *
5811
	 * @since  3.8.0
5812
	 * @return bool True = already whitelisted False = not whitelisted
5813
	 */
5814
	public static function is_staging_site() {
5815
		$is_staging = false;
5816
5817
		$known_staging = array(
5818
			'urls' => array(
5819
				'#\.staging\.wpengine\.com$#i', // WP Engine
5820
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5821
				'#\.stage\.site$#i'             // DreamPress
5822
			),
5823
			'constants' => array(
5824
				'IS_WPE_SNAPSHOT',      // WP Engine
5825
				'KINSTA_DEV_ENV',       // Kinsta.com
5826
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5827
				'JETPACK_STAGING_MODE', // Generic
5828
			)
5829
		);
5830
		/**
5831
		 * Filters the flags of known staging sites.
5832
		 *
5833
		 * @since 3.9.0
5834
		 *
5835
		 * @param array $known_staging {
5836
		 *     An array of arrays that each are used to check if the current site is staging.
5837
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5838
		 *     @type array $constants PHP constants of known staging/developement environments.
5839
		 *  }
5840
		 */
5841
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5842
5843
		if ( isset( $known_staging['urls'] ) ) {
5844
			foreach ( $known_staging['urls'] as $url ){
5845
				if ( preg_match( $url, site_url() ) ) {
5846
					$is_staging = true;
5847
					break;
5848
				}
5849
			}
5850
		}
5851
5852
		if ( isset( $known_staging['constants'] ) ) {
5853
			foreach ( $known_staging['constants'] as $constant ) {
5854
				if ( defined( $constant ) && constant( $constant ) ) {
5855
					$is_staging = true;
5856
				}
5857
			}
5858
		}
5859
5860
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5861
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5862
			$is_staging = true;
5863
		}
5864
5865
		/**
5866
		 * Filters is_staging_site check.
5867
		 *
5868
		 * @since 3.9.0
5869
		 *
5870
		 * @param bool $is_staging If the current site is a staging site.
5871
		 */
5872
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5873
	}
5874
5875
	/**
5876
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5877
	 *
5878
	 * @since 4.4.0
5879
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
5880
	 *
5881
	 * @return bool
5882
	 */
5883
	public static function validate_sync_error_idc_option() {
5884
		$is_valid = false;
5885
5886
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5887
		if ( false === $idc_allowed ) {
5888
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5889
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5890
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5891
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5892
				$transient_duration = HOUR_IN_SECONDS;
5893
			} else {
5894
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5895
				$idc_allowed = '1';
5896
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5897
			}
5898
5899
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5900
		}
5901
5902
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5903
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5904
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5905
			$local_options = self::get_sync_error_idc_option();
5906
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5907
				$is_valid = true;
5908
			}
5909
		}
5910
5911
		/**
5912
		 * Filters whether the sync_error_idc option is valid.
5913
		 *
5914
		 * @since 4.4.0
5915
		 *
5916
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5917
		 */
5918
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5919
5920
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5921
			// Since the option exists, and did not validate, delete it
5922
			Jetpack_Options::delete_option( 'sync_error_idc' );
5923
		}
5924
5925
		return $is_valid;
5926
	}
5927
5928
	/**
5929
	 * Normalizes a url by doing three things:
5930
	 *  - Strips protocol
5931
	 *  - Strips www
5932
	 *  - Adds a trailing slash
5933
	 *
5934
	 * @since 4.4.0
5935
	 * @param string $url
5936
	 * @return WP_Error|string
5937
	 */
5938
	public static function normalize_url_protocol_agnostic( $url ) {
5939
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5940
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
5941
			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...
5942
		}
5943
5944
		// Strip www and protocols
5945
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5946
		return $url;
5947
	}
5948
5949
	/**
5950
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5951
	 *
5952
	 * @since 4.4.0
5953
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
5954
	 *
5955
	 * @param array $response
5956
	 * @return array Array of the local urls, wpcom urls, and error code
5957
	 */
5958
	public static function get_sync_error_idc_option( $response = array() ) {
5959
		// Since the local options will hit the database directly, store the values
5960
		// in a transient to allow for autoloading and caching on subsequent views.
5961
		$local_options = get_transient( 'jetpack_idc_local' );
5962
		if ( false === $local_options ) {
5963
			$local_options = array(
5964
				'home'    => Functions::home_url(),
5965
				'siteurl' => Functions::site_url(),
5966
			);
5967
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
5968
		}
5969
5970
		$options = array_merge( $local_options, $response );
5971
5972
		$returned_values = array();
5973
		foreach( $options as $key => $option ) {
5974
			if ( 'error_code' === $key ) {
5975
				$returned_values[ $key ] = $option;
5976
				continue;
5977
			}
5978
5979
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5980
				continue;
5981
			}
5982
5983
			$returned_values[ $key ] = $normalized_url;
5984
		}
5985
5986
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
5987
5988
		return $returned_values;
5989
	}
5990
5991
	/**
5992
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5993
	 * If set to true, the site will be put into staging mode.
5994
	 *
5995
	 * @since 4.3.2
5996
	 * @return bool
5997
	 */
5998
	public static function sync_idc_optin() {
5999
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6000
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6001
		} else {
6002
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6003
		}
6004
6005
		/**
6006
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6007
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6008
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6009
		 *
6010
		 * @since 4.3.2
6011
		 *
6012
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6013
		 */
6014
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6015
	}
6016
6017
	/**
6018
	 * Maybe Use a .min.css stylesheet, maybe not.
6019
	 *
6020
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6021
	 */
6022
	public static function maybe_min_asset( $url, $path, $plugin ) {
6023
		// Short out on things trying to find actual paths.
6024
		if ( ! $path || empty( $plugin ) ) {
6025
			return $url;
6026
		}
6027
6028
		$path = ltrim( $path, '/' );
6029
6030
		// Strip out the abspath.
6031
		$base = dirname( plugin_basename( $plugin ) );
6032
6033
		// Short out on non-Jetpack assets.
6034
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6035
			return $url;
6036
		}
6037
6038
		// File name parsing.
6039
		$file              = "{$base}/{$path}";
6040
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6041
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6042
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6043
		$extension         = array_shift( $file_name_parts_r );
6044
6045
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6046
			// Already pointing at the minified version.
6047
			if ( 'min' === $file_name_parts_r[0] ) {
6048
				return $url;
6049
			}
6050
6051
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6052
			if ( file_exists( $min_full_path ) ) {
6053
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6054
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6055
				if ( 'css' === $extension ) {
6056
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6057
					self::$min_assets[ $key ] = $path;
6058
				}
6059
			}
6060
		}
6061
6062
		return $url;
6063
	}
6064
6065
	/**
6066
	 * If the asset is minified, let's flag .min as the suffix.
6067
	 *
6068
	 * Attached to `style_loader_src` filter.
6069
	 *
6070
	 * @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...
6071
	 * @param string $handle The registered handle of the script in question.
6072
	 * @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...
6073
	 */
6074
	public static function set_suffix_on_min( $src, $handle ) {
6075
		if ( false === strpos( $src, '.min.css' ) ) {
6076
			return $src;
6077
		}
6078
6079
		if ( ! empty( self::$min_assets ) ) {
6080
			foreach ( self::$min_assets as $file => $path ) {
6081
				if ( false !== strpos( $src, $file ) ) {
6082
					wp_style_add_data( $handle, 'suffix', '.min' );
6083
					return $src;
6084
				}
6085
			}
6086
		}
6087
6088
		return $src;
6089
	}
6090
6091
	/**
6092
	 * Maybe inlines a stylesheet.
6093
	 *
6094
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6095
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6096
	 *
6097
	 * Attached to `style_loader_tag` filter.
6098
	 *
6099
	 * @param string $tag The tag that would link to the external asset.
6100
	 * @param string $handle The registered handle of the script in question.
6101
	 *
6102
	 * @return string
6103
	 */
6104
	public static function maybe_inline_style( $tag, $handle ) {
6105
		global $wp_styles;
6106
		$item = $wp_styles->registered[ $handle ];
6107
6108
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6109
			return $tag;
6110
		}
6111
6112
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6113
			$href = $matches[1];
6114
			// Strip off query string
6115
			if ( $pos = strpos( $href, '?' ) ) {
6116
				$href = substr( $href, 0, $pos );
6117
			}
6118
			// Strip off fragment
6119
			if ( $pos = strpos( $href, '#' ) ) {
6120
				$href = substr( $href, 0, $pos );
6121
			}
6122
		} else {
6123
			return $tag;
6124
		}
6125
6126
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6127
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6128
			return $tag;
6129
		}
6130
6131
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6132
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6133
			// And this isn't the pass that actually deals with the RTL version...
6134
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6135
				// Short out, as the RTL version will deal with it in a moment.
6136
				return $tag;
6137
			}
6138
		}
6139
6140
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6141
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6142
		if ( $css ) {
6143
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6144
			if ( empty( $item->extra['after'] ) ) {
6145
				wp_add_inline_style( $handle, $css );
6146
			} else {
6147
				array_unshift( $item->extra['after'], $css );
6148
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6149
			}
6150
		}
6151
6152
		return $tag;
6153
	}
6154
6155
	/**
6156
	 * Loads a view file from the views
6157
	 *
6158
	 * Data passed in with the $data parameter will be available in the
6159
	 * template file as $data['value']
6160
	 *
6161
	 * @param string $template - Template file to load
6162
	 * @param array $data - Any data to pass along to the template
6163
	 * @return boolean - If template file was found
6164
	 **/
6165
	public function load_view( $template, $data = array() ) {
6166
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6167
6168
		if( file_exists( $views_dir . $template ) ) {
6169
			require_once( $views_dir . $template );
6170
			return true;
6171
		}
6172
6173
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6174
		return false;
6175
	}
6176
6177
	/**
6178
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6179
	 */
6180
	public function deprecated_hooks() {
6181
		global $wp_filter;
6182
6183
		/*
6184
		 * Format:
6185
		 * deprecated_filter_name => replacement_name
6186
		 *
6187
		 * If there is no replacement, use null for replacement_name
6188
		 */
6189
		$deprecated_list = array(
6190
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6191
			'wpl_sharing_2014_1'                                     => null,
6192
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6193
			'jetpack_identity_crisis_options_to_check'               => null,
6194
			'update_option_jetpack_single_user_site'                 => null,
6195
			'audio_player_default_colors'                            => null,
6196
			'add_option_jetpack_featured_images_enabled'             => null,
6197
			'add_option_jetpack_update_details'                      => null,
6198
			'add_option_jetpack_updates'                             => null,
6199
			'add_option_jetpack_network_name'                        => null,
6200
			'add_option_jetpack_network_allow_new_registrations'     => null,
6201
			'add_option_jetpack_network_add_new_users'               => null,
6202
			'add_option_jetpack_network_site_upload_space'           => null,
6203
			'add_option_jetpack_network_upload_file_types'           => null,
6204
			'add_option_jetpack_network_enable_administration_menus' => null,
6205
			'add_option_jetpack_is_multi_site'                       => null,
6206
			'add_option_jetpack_is_main_network'                     => null,
6207
			'add_option_jetpack_main_network_site'                   => null,
6208
			'jetpack_sync_all_registered_options'                    => null,
6209
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6210
			'jetpack_is_post_mailable'                               => null,
6211
			'jetpack_seo_site_host'                                  => null,
6212
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6213
			'jetpack_holiday_snow_option_name'                       => null,
6214
			'jetpack_holiday_chance_of_snow'                         => null,
6215
			'jetpack_holiday_snow_js_url'                            => null,
6216
			'jetpack_is_holiday_snow_season'                         => null,
6217
			'jetpack_holiday_snow_option_updated'                    => null,
6218
			'jetpack_holiday_snowing'                                => null,
6219
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6220
			'jetpack_cache_plans'                                    => null,
6221
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6222
			'jetpack_lazy_images_skip_image_with_atttributes'        => 'jetpack_lazy_images_skip_image_with_attributes',
6223
			'jetpack_enable_site_verification'                       => null,
6224
			'can_display_jetpack_manage_notice'                      => null,
6225
			// Removed in Jetpack 7.3.0
6226
			'atd_load_scripts'                                       => null,
6227
			'atd_http_post_timeout'                                  => null,
6228
			'atd_http_post_error'                                    => null,
6229
			'atd_service_domain'                                     => null,
6230
			'jetpack_widget_authors_exclude'                         => 'jetpack_widget_authors_params',
6231
		);
6232
6233
		// This is a silly loop depth. Better way?
6234
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6235
			if ( has_action( $hook ) ) {
6236
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6237
					foreach( $values AS $hooked ) {
6238
						if ( is_callable( $hooked['function'] ) ) {
6239
							$function_name = 'an anonymous function';
6240
						} else {
6241
							$function_name = $hooked['function'];
6242
						}
6243
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6244
					}
6245
				}
6246
			}
6247
		}
6248
	}
6249
6250
	/**
6251
	 * Converts any url in a stylesheet, to the correct absolute url.
6252
	 *
6253
	 * Considerations:
6254
	 *  - Normal, relative URLs     `feh.png`
6255
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6256
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6257
	 *  - Absolute URLs             `http://domain.com/feh.png`
6258
	 *  - Domain root relative URLs `/feh.png`
6259
	 *
6260
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6261
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6262
	 *
6263
	 * @return mixed|string
6264
	 */
6265
	public static function absolutize_css_urls( $css, $css_file_url ) {
6266
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6267
		$css_dir = dirname( $css_file_url );
6268
		$p       = parse_url( $css_dir );
6269
		$domain  = sprintf(
6270
					'%1$s//%2$s%3$s%4$s',
6271
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6272
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6273
					$p['host'],
6274
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6275
				);
6276
6277
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6278
			$find = $replace = array();
6279
			foreach ( $matches as $match ) {
6280
				$url = trim( $match['path'], "'\" \t" );
6281
6282
				// If this is a data url, we don't want to mess with it.
6283
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6284
					continue;
6285
				}
6286
6287
				// If this is an absolute or protocol-agnostic url,
6288
				// we don't want to mess with it.
6289
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6290
					continue;
6291
				}
6292
6293
				switch ( substr( $url, 0, 1 ) ) {
6294
					case '/':
6295
						$absolute = $domain . $url;
6296
						break;
6297
					default:
6298
						$absolute = $css_dir . '/' . $url;
6299
				}
6300
6301
				$find[]    = $match[0];
6302
				$replace[] = sprintf( 'url("%s")', $absolute );
6303
			}
6304
			$css = str_replace( $find, $replace, $css );
6305
		}
6306
6307
		return $css;
6308
	}
6309
6310
	/**
6311
	 * This methods removes all of the registered css files on the front end
6312
	 * from Jetpack in favor of using a single file. In effect "imploding"
6313
	 * all the files into one file.
6314
	 *
6315
	 * Pros:
6316
	 * - Uses only ONE css asset connection instead of 15
6317
	 * - Saves a minimum of 56k
6318
	 * - Reduces server load
6319
	 * - Reduces time to first painted byte
6320
	 *
6321
	 * Cons:
6322
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6323
	 *		should not cause any issues with themes.
6324
	 * - Plugins/themes dequeuing styles no longer do anything. See
6325
	 *		jetpack_implode_frontend_css filter for a workaround
6326
	 *
6327
	 * For some situations developers may wish to disable css imploding and
6328
	 * instead operate in legacy mode where each file loads seperately and
6329
	 * can be edited individually or dequeued. This can be accomplished with
6330
	 * the following line:
6331
	 *
6332
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6333
	 *
6334
	 * @since 3.2
6335
	 **/
6336
	public function implode_frontend_css( $travis_test = false ) {
6337
		$do_implode = true;
6338
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6339
			$do_implode = false;
6340
		}
6341
6342
		// Do not implode CSS when the page loads via the AMP plugin.
6343
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6344
			$do_implode = false;
6345
		}
6346
6347
		/**
6348
		 * Allow CSS to be concatenated into a single jetpack.css file.
6349
		 *
6350
		 * @since 3.2.0
6351
		 *
6352
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6353
		 */
6354
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6355
6356
		// Do not use the imploded file when default behavior was altered through the filter
6357
		if ( ! $do_implode ) {
6358
			return;
6359
		}
6360
6361
		// We do not want to use the imploded file in dev mode, or if not connected
6362
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6363
			if ( ! $travis_test ) {
6364
				return;
6365
			}
6366
		}
6367
6368
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6369
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6370
			return;
6371
		}
6372
6373
		/*
6374
		 * Now we assume Jetpack is connected and able to serve the single
6375
		 * file.
6376
		 *
6377
		 * In the future there will be a check here to serve the file locally
6378
		 * or potentially from the Jetpack CDN
6379
		 *
6380
		 * For now:
6381
		 * - Enqueue a single imploded css file
6382
		 * - Zero out the style_loader_tag for the bundled ones
6383
		 * - Be happy, drink scotch
6384
		 */
6385
6386
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6387
6388
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6389
6390
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6391
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6392
	}
6393
6394
	function concat_remove_style_loader_tag( $tag, $handle ) {
6395
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6396
			$tag = '';
6397
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6398
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6399
			}
6400
		}
6401
6402
		return $tag;
6403
	}
6404
6405
	/**
6406
	 * Add an async attribute to scripts that can be loaded asynchronously.
6407
	 * https://www.w3schools.com/tags/att_script_async.asp
6408
	 *
6409
	 * @since 7.7.0
6410
	 *
6411
	 * @param string $tag    The <script> tag for the enqueued script.
6412
	 * @param string $handle The script's registered handle.
6413
	 * @param string $src    The script's source URL.
6414
	 */
6415
	public function script_add_async( $tag, $handle, $src ) {
6416
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6417
			return preg_replace( '/^<script /i', '<script async ', $tag );
6418
		}
6419
6420
		return $tag;
6421
	}
6422
6423
	/*
6424
	 * Check the heartbeat data
6425
	 *
6426
	 * Organizes the heartbeat data by severity.  For example, if the site
6427
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6428
	 *
6429
	 * Data will be added to "caution" array, if it either:
6430
	 *  - Out of date Jetpack version
6431
	 *  - Out of date WP version
6432
	 *  - Out of date PHP version
6433
	 *
6434
	 * $return array $filtered_data
6435
	 */
6436
	public static function jetpack_check_heartbeat_data() {
6437
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6438
6439
		$good    = array();
6440
		$caution = array();
6441
		$bad     = array();
6442
6443
		foreach ( $raw_data as $stat => $value ) {
6444
6445
			// Check jetpack version
6446
			if ( 'version' == $stat ) {
6447
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6448
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6449
					continue;
6450
				}
6451
			}
6452
6453
			// Check WP version
6454
			if ( 'wp-version' == $stat ) {
6455
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6456
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6457
					continue;
6458
				}
6459
			}
6460
6461
			// Check PHP version
6462
			if ( 'php-version' == $stat ) {
6463
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6464
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6465
					continue;
6466
				}
6467
			}
6468
6469
			// Check ID crisis
6470
			if ( 'identitycrisis' == $stat ) {
6471
				if ( 'yes' == $value ) {
6472
					$bad[ $stat ] = $value;
6473
					continue;
6474
				}
6475
			}
6476
6477
			// The rest are good :)
6478
			$good[ $stat ] = $value;
6479
		}
6480
6481
		$filtered_data = array(
6482
			'good'    => $good,
6483
			'caution' => $caution,
6484
			'bad'     => $bad
6485
		);
6486
6487
		return $filtered_data;
6488
	}
6489
6490
6491
	/*
6492
	 * This method is used to organize all options that can be reset
6493
	 * without disconnecting Jetpack.
6494
	 *
6495
	 * It is used in class.jetpack-cli.php to reset options
6496
	 *
6497
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6498
	 *
6499
	 * @return array of options to delete.
6500
	 */
6501
	public static function get_jetpack_options_for_reset() {
6502
		return Jetpack_Options::get_options_for_reset();
6503
	}
6504
6505
	/*
6506
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6507
	 * so we can bring them directly to their site in calypso.
6508
	 *
6509
	 * @param string | url
6510
	 * @return string | url without the guff
6511
	 */
6512
	public static function build_raw_urls( $url ) {
6513
		$strip_http = '/.*?:\/\//i';
6514
		$url = preg_replace( $strip_http, '', $url  );
6515
		$url = str_replace( '/', '::', $url );
6516
		return $url;
6517
	}
6518
6519
	/**
6520
	 * Stores and prints out domains to prefetch for page speed optimization.
6521
	 *
6522
	 * @param mixed $new_urls
6523
	 */
6524
	public static function dns_prefetch( $new_urls = null ) {
6525
		static $prefetch_urls = array();
6526
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6527
			echo "\r\n";
6528
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6529
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6530
			}
6531
		} elseif ( ! empty( $new_urls ) ) {
6532
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6533
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6534
			}
6535
			foreach ( (array) $new_urls as $this_new_url ) {
6536
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6537
			}
6538
			$prefetch_urls = array_unique( $prefetch_urls );
6539
		}
6540
	}
6541
6542
	public function wp_dashboard_setup() {
6543
		if ( self::is_active() ) {
6544
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6545
		}
6546
6547
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6548
			$jetpack_logo = new Jetpack_Logo();
6549
			$widget_title = sprintf(
6550
				wp_kses(
6551
					/* translators: Placeholder is a Jetpack logo. */
6552
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6553
					array( 'span' => array() )
6554
				),
6555
				$jetpack_logo->get_jp_emblem( true )
6556
			);
6557
6558
			wp_add_dashboard_widget(
6559
				'jetpack_summary_widget',
6560
				$widget_title,
6561
				array( __CLASS__, 'dashboard_widget' )
6562
			);
6563
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6564
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6565
6566
			// If we're inactive and not in development mode, sort our box to the top.
6567
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6568
				global $wp_meta_boxes;
6569
6570
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6571
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6572
6573
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6574
			}
6575
		}
6576
	}
6577
6578
	/**
6579
	 * @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...
6580
	 * @return mixed
6581
	 */
6582
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6583
		if ( ! is_array( $sorted ) ) {
6584
			return $sorted;
6585
		}
6586
6587
		foreach ( $sorted as $box_context => $ids ) {
6588
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6589
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6590
				continue;
6591
			}
6592
6593
			$ids_array = explode( ',', $ids );
6594
			$key = array_search( 'dashboard_stats', $ids_array );
6595
6596
			if ( false !== $key ) {
6597
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6598
				$ids_array[ $key ] = 'jetpack_summary_widget';
6599
				$sorted[ $box_context ] = implode( ',', $ids_array );
6600
				// We've found it, stop searching, and just return.
6601
				break;
6602
			}
6603
		}
6604
6605
		return $sorted;
6606
	}
6607
6608
	public static function dashboard_widget() {
6609
		/**
6610
		 * Fires when the dashboard is loaded.
6611
		 *
6612
		 * @since 3.4.0
6613
		 */
6614
		do_action( 'jetpack_dashboard_widget' );
6615
	}
6616
6617
	public static function dashboard_widget_footer() {
6618
		?>
6619
		<footer>
6620
6621
		<div class="protect">
6622
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6623
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6624
				<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>
6625
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6626
				<a href="<?php echo esc_url( wp_nonce_url( Jetpack::admin_url( array( 'action' => 'activate', 'module' => 'protect' ) ), 'jetpack_activate-protect' ) ); ?>" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6627
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6628
				</a>
6629
			<?php else : ?>
6630
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6631
			<?php endif; ?>
6632
		</div>
6633
6634
		<div class="akismet">
6635
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6636
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6637
				<p><?php echo esc_html_x( 'Spam comments blocked by Akismet.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6638
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6639
				<a href="<?php echo esc_url( wp_nonce_url( add_query_arg( array( 'action' => 'activate', 'plugin' => 'akismet/akismet.php' ), admin_url( 'plugins.php' ) ), 'activate-plugin_akismet/akismet.php' ) ); ?>" class="button button-jetpack">
6640
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6641
				</a>
6642
			<?php else : ?>
6643
				<p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Akismet can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6644
			<?php endif; ?>
6645
		</div>
6646
6647
		</footer>
6648
		<?php
6649
	}
6650
6651
	/*
6652
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6653
	 */
6654
	function jetpack_icon_user_connected( $columns ) {
6655
		$columns['user_jetpack'] = '';
6656
		return $columns;
6657
	}
6658
6659
	/*
6660
	 * Show Jetpack icon if the user is linked.
6661
	 */
6662
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6663
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6664
			$jetpack_logo = new Jetpack_Logo();
6665
			$emblem_html = sprintf(
6666
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6667
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6668
				$jetpack_logo->get_jp_emblem()
6669
			);
6670
			return $emblem_html;
6671
		}
6672
6673
		return $val;
6674
	}
6675
6676
	/*
6677
	 * Style the Jetpack user column
6678
	 */
6679
	function jetpack_user_col_style() {
6680
		global $current_screen;
6681
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6682
			<style>
6683
				.fixed .column-user_jetpack {
6684
					width: 21px;
6685
				}
6686
				.jp-emblem-user-admin svg {
6687
					width: 20px;
6688
					height: 20px;
6689
				}
6690
				.jp-emblem-user-admin path {
6691
					fill: #00BE28;
6692
				}
6693
			</style>
6694
		<?php }
6695
	}
6696
6697
	/**
6698
	 * Checks if Akismet is active and working.
6699
	 *
6700
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6701
	 * that implied usage of methods present since more recent version.
6702
	 * See https://github.com/Automattic/jetpack/pull/9585
6703
	 *
6704
	 * @since  5.1.0
6705
	 *
6706
	 * @return bool True = Akismet available. False = Aksimet not available.
6707
	 */
6708
	public static function is_akismet_active() {
6709
		static $status = null;
6710
6711
		if ( ! is_null( $status ) ) {
6712
			return $status;
6713
		}
6714
6715
		// Check if a modern version of Akismet is active.
6716
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6717
			$status = false;
6718
			return $status;
6719
		}
6720
6721
		// Make sure there is a key known to Akismet at all before verifying key.
6722
		$akismet_key = Akismet::get_api_key();
6723
		if ( ! $akismet_key ) {
6724
			$status = false;
6725
			return $status;
6726
		}
6727
6728
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6729
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6730
6731
		// 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.
6732
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6733
		// We cache the result of the Akismet key verification for ten minutes.
6734
		if ( ! $akismet_key_state || $recheck ) {
6735
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6736
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6737
		}
6738
6739
		$status = 'valid' === $akismet_key_state;
6740
6741
		return $status;
6742
	}
6743
6744
	/**
6745
	 * @deprecated
6746
	 *
6747
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6748
	 */
6749
	public static function is_function_in_backtrace() {
6750
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6751
	}
6752
6753
	/**
6754
	 * Given a minified path, and a non-minified path, will return
6755
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6756
	 *
6757
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6758
	 * root Jetpack directory.
6759
	 *
6760
	 * @since 5.6.0
6761
	 *
6762
	 * @param string $min_path
6763
	 * @param string $non_min_path
6764
	 * @return string The URL to the file
6765
	 */
6766
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6767
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6768
	}
6769
6770
	/**
6771
	 * Checks for whether Jetpack Backup & Scan is enabled.
6772
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6773
	 * @return bool|int|mixed
6774
	 */
6775
	public static function is_rewind_enabled() {
6776
		if ( ! Jetpack::is_active() ) {
6777
			return false;
6778
		}
6779
6780
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6781
		if ( false === $rewind_enabled ) {
6782
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6783
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6784
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6785
				&& ! empty( $rewind_data['state'] )
6786
				&& 'active' === $rewind_data['state'] )
6787
				? 1
6788
				: 0;
6789
6790
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6791
		}
6792
		return $rewind_enabled;
6793
	}
6794
6795
	/**
6796
	 * Return Calypso environment value; used for developing Jetpack and pairing
6797
	 * it with different Calypso enrionments, such as localhost.
6798
	 *
6799
	 * @since 7.4.0
6800
	 *
6801
	 * @return string Calypso environment
6802
	 */
6803
	public static function get_calypso_env() {
6804
		if ( isset( $_GET['calypso_env'] ) ) {
6805
			return sanitize_key( $_GET['calypso_env'] );
6806
		}
6807
6808
		if ( getenv( 'CALYPSO_ENV' ) ) {
6809
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6810
		}
6811
6812
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
6813
			return sanitize_key( CALYPSO_ENV );
6814
		}
6815
6816
		return '';
6817
	}
6818
6819
	/**
6820
	 * Checks whether or not TOS has been agreed upon.
6821
	 * Will return true if a user has clicked to register, or is already connected.
6822
	 */
6823
	public static function jetpack_tos_agreed() {
6824
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
6825
	}
6826
6827
	/**
6828
	 * Handles activating default modules as well general cleanup for the new connection.
6829
	 *
6830
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
6831
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
6832
	 * @param boolean $send_state_messages          Whether to send state messages.
6833
	 * @return void
6834
	 */
6835
	public static function handle_post_authorization_actions(
6836
		$activate_sso = false,
6837
		$redirect_on_activation_error = false,
6838
		$send_state_messages = true
6839
	) {
6840
		$other_modules = $activate_sso
6841
			? array( 'sso' )
6842
			: array();
6843
6844
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
6845
			Jetpack::delete_active_modules();
6846
6847
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
6848
		} else {
6849
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
6850
		}
6851
6852
		// Since this is a fresh connection, be sure to clear out IDC options
6853
		Jetpack_IDC::clear_all_idc_options();
6854
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
6855
6856
		// Start nonce cleaner
6857
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
6858
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
6859
6860
		if ( $send_state_messages ) {
6861
			Jetpack::state( 'message', 'authorized' );
6862
		}
6863
	}
6864
6865
	/**
6866
	 * Returns a boolean for whether backups UI should be displayed or not.
6867
	 *
6868
	 * @return bool Should backups UI be displayed?
6869
	 */
6870
	public static function show_backups_ui() {
6871
		/**
6872
		 * Whether UI for backups should be displayed.
6873
		 *
6874
		 * @since 6.5.0
6875
		 *
6876
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
6877
		 */
6878
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
6879
	}
6880
6881
	/*
6882
	 * Deprecated manage functions
6883
	 */
6884
	function prepare_manage_jetpack_notice() {
6885
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6886
	}
6887
	function manage_activate_screen() {
6888
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6889
	}
6890
	function admin_jetpack_manage_notice() {
6891
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6892
	}
6893
	function opt_out_jetpack_manage_url() {
6894
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6895
	}
6896
	function opt_in_jetpack_manage_url() {
6897
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6898
	}
6899
	function opt_in_jetpack_manage_notice() {
6900
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6901
	}
6902
	function can_display_jetpack_manage_notice() {
6903
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6904
	}
6905
6906
	/**
6907
	 * Clean leftoveruser meta.
6908
	 *
6909
	 * Delete Jetpack-related user meta when it is no longer needed.
6910
	 *
6911
	 * @since 7.3.0
6912
	 *
6913
	 * @param int $user_id User ID being updated.
6914
	 */
6915
	public static function user_meta_cleanup( $user_id ) {
6916
		$meta_keys = array(
6917
			// AtD removed from Jetpack 7.3
6918
			'AtD_options',
6919
			'AtD_check_when',
6920
			'AtD_guess_lang',
6921
			'AtD_ignored_phrases',
6922
		);
6923
6924
		foreach ( $meta_keys as $meta_key ) {
6925
			if ( get_user_meta( $user_id, $meta_key ) ) {
6926
				delete_user_meta( $user_id, $meta_key );
6927
			}
6928
		}
6929
	}
6930
6931
	function is_active_and_not_development_mode( $maybe ) {
6932
		if ( ! \Jetpack::is_active() || \Jetpack::is_development_mode() ) {
6933
			return false;
6934
		}
6935
		return true;
6936
	}
6937
}
6938