Completed
Push — update/user-tos-package ( 614cab...ed76e3 )
by
unknown
07:30
created

class.jetpack.php (62 issues)

Upgrade to new PHP Analysis Engine

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

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

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

Loading history...
492
	 */
493
	static function update_active_modules( $modules ) {
494
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
495
		$active_modules       = self::get_active_modules();
496
		$new_active_modules   = array_diff( $modules, $current_modules );
497
		$new_inactive_modules = array_diff( $active_modules, $modules );
498
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
499
		$reindexed_modules    = array_values( $new_current_modules );
500
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
501
502
		foreach ( $new_active_modules as $module ) {
503
			/**
504
			 * Fires when a specific module is activated.
505
			 *
506
			 * @since 1.9.0
507
			 *
508
			 * @param string $module Module slug.
509
			 * @param boolean $success whether the module was activated. @since 4.2
510
			 */
511
			do_action( 'jetpack_activate_module', $module, $success );
512
			/**
513
			 * Fires when a module is activated.
514
			 * The dynamic part of the filter, $module, is the module slug.
515
			 *
516
			 * @since 1.9.0
517
			 *
518
			 * @param string $module Module slug.
519
			 */
520
			do_action( "jetpack_activate_module_$module", $module );
521
		}
522
523
		foreach ( $new_inactive_modules as $module ) {
524
			/**
525
			 * Fired after a module has been deactivated.
526
			 *
527
			 * @since 4.2.0
528
			 *
529
			 * @param string $module Module slug.
530
			 * @param boolean $success whether the module was deactivated.
531
			 */
532
			do_action( 'jetpack_deactivate_module', $module, $success );
533
			/**
534
			 * Fires when a module is deactivated.
535
			 * The dynamic part of the filter, $module, is the module slug.
536
			 *
537
			 * @since 1.9.0
538
			 *
539
			 * @param string $module Module slug.
540
			 */
541
			do_action( "jetpack_deactivate_module_$module", $module );
542
		}
543
544
		return $success;
545
	}
546
547
	static function delete_active_modules() {
548
		self::update_active_modules( array() );
549
	}
550
551
	/**
552
	 * Constructor.  Initializes WordPress hooks
553
	 */
554
	private function __construct() {
555
		/*
556
		 * Check for and alert any deprecated hooks
557
		 */
558
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
559
560
		/*
561
		 * Enable enhanced handling of previewing sites in Calypso
562
		 */
563
		if ( self::is_active() ) {
564
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
565
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
566
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
567
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
568
		}
569
570
		add_action( 'plugins_loaded', array( $this, 'after_plugins_loaded' )  );
571
572
		add_filter(
573
			'jetpack_connection_secret_generator',
574
			function( $callable ) {
575
				return function() {
576
					return wp_generate_password( 32, false );
577
				};
578
			}
579
		);
580
581
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
582
583
		$this->connection_manager = new Connection_Manager();
584
		$this->connection_manager->init();
585
586
		/*
587
		 * Load things that should only be in Network Admin.
588
		 *
589
		 * For now blow away everything else until a more full
590
		 * understanding of what is needed at the network level is
591
		 * available
592
		 */
593
		if ( is_multisite() ) {
594
			$network = Jetpack_Network::init();
595
			$network->set_connection( $this->connection_manager );
596
		}
597
598
		add_filter(
599
			'jetpack_signature_check_token',
600
			array( __CLASS__, 'verify_onboarding_token' ),
601
			10,
602
			3
603
		);
604
605
		/**
606
		 * Prepare Gutenberg Editor functionality
607
		 */
608
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
609
		Jetpack_Gutenberg::init();
610
		Jetpack_Gutenberg::load_independent_blocks();
611
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
612
613
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
614
615
		// Unlink user before deleting the user from WP.com.
616
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
617
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
618
619
		// Initialize remote file upload request handlers.
620
		$this->add_remote_request_handlers();
621
622
		if ( self::is_active() ) {
623
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
624
625
			Jetpack_Heartbeat::init();
626
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
627
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
628
				Jetpack_Search_Performance_Logger::init();
629
			}
630
		}
631
632
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
633
634
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
635
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
636
637
		add_action( 'admin_init', array( $this, 'admin_init' ) );
638
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
639
640
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
641
642
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
643
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
644
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
645
646
		// returns HTTPS support status
647
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
648
649
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
650
651
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
652
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
653
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
654
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
655
656
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
657
658
		/**
659
		 * These actions run checks to load additional files.
660
		 * They check for external files or plugins, so they need to run as late as possible.
661
		 */
662
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
663
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
664
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
665
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
666
667
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
668
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
669
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
670
671
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
672
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
673
674
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
675
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
676
677
		// A filter to control all just in time messages
678
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
679
680
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
681
682
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
683
		// We should make sure to only do this for front end links.
684
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
685
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
686
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
687
688
			// we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
689
			// so they point moderation links on emails to Calypso
690
			jetpack_require_lib( 'functions.wp-notify' );
691
		}
692
693
		// Hide edit post link if mobile app.
694
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
695
			add_filter( 'edit_post_link', '__return_empty_string' );
696
		}
697
698
		// Update the Jetpack plan from API on heartbeats
699
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
700
701
		/**
702
		 * This is the hack to concatenate all css files into one.
703
		 * For description and reasoning see the implode_frontend_css method
704
		 *
705
		 * Super late priority so we catch all the registered styles
706
		 */
707
		if ( ! is_admin() ) {
708
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
709
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
710
		}
711
712
		/**
713
		 * These are sync actions that we need to keep track of for jitms
714
		 */
715
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
716
717
		// Actually push the stats on shutdown.
718
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
719
			add_action( 'shutdown', array( $this, 'push_stats' ) );
720
		}
721
722
		/*
723
		 * Load some scripts asynchronously.
724
		 */
725
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
726
	}
727
	/**
728
	 * Runs after all the plugins have loaded but before init.
729
	 */
730
	function after_plugins_loaded() {
731
732
		$terms_of_service = new Terms_Of_Service();
733
		$tracking = new \Automattic\Jetpack\Plugin\Tracking();
734
		if ( $terms_of_service->has_agreed() ) {
735
			add_action( 'init', array( $tracking, 'init' ) );
736
		} else {
737
			/**
738
			 * Initialize tracking right after the user agrees to the terms of service.
739
			 */
740
			add_action( 'jetpack_agreed_to_terms_of_service', array( $tracking, 'init' ) );
741
		}
742
	}
743
744
	/**
745
	 * Sets up the XMLRPC request handlers.
746
	 *
747
	 * @deprecated since 7.7.0
748
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
749
	 *
750
	 * @param Array                 $request_params Incoming request parameters.
751
	 * @param Boolean               $is_active      Whether the connection is currently active.
752
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
753
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
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...
754
	 */
755
	public function setup_xmlrpc_handlers(
756
		$request_params,
757
		$is_active,
758
		$is_signed,
759
		Jetpack_XMLRPC_Server $xmlrpc_server = null
760
	) {
761
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
762
		return $this->connection_manager->setup_xmlrpc_handlers(
763
			$request_params,
764
			$is_active,
765
			$is_signed,
766
			$xmlrpc_server
767
		);
768
	}
769
770
	/**
771
	 * Initialize REST API registration connector.
772
	 *
773
	 * @deprecated since 7.7.0
774
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
775
	 */
776
	public function initialize_rest_api_registration_connector() {
777
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
778
		$this->connection_manager->initialize_rest_api_registration_connector();
779
	}
780
781
	/**
782
	 * This is ported over from the manage module, which has been deprecated and baked in here.
783
	 *
784
	 * @param $domains
785
	 */
786
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
787
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
788
	}
789
790
	/**
791
	 * Return $domains, with 'wordpress.com' appended.
792
	 * This is ported over from the manage module, which has been deprecated and baked in here.
793
	 *
794
	 * @param $domains
795
	 * @return array
796
	 */
797
	function allow_wpcom_domain( $domains ) {
798
		if ( empty( $domains ) ) {
799
			$domains = array();
800
		}
801
		$domains[] = 'wordpress.com';
802
		return array_unique( $domains );
803
	}
804
805
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
806
		$post = get_post( $post_id );
807
808
		if ( empty( $post ) ) {
809
			return $default_url;
810
		}
811
812
		$post_type = $post->post_type;
813
814
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
815
		// https://en.support.wordpress.com/custom-post-types/
816
		$allowed_post_types = array(
817
			'post'                => 'post',
818
			'page'                => 'page',
819
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
820
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
821
		);
822
823
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
824
			return $default_url;
825
		}
826
827
		$path_prefix = $allowed_post_types[ $post_type ];
828
829
		$site_slug = self::build_raw_urls( get_home_url() );
830
831
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
832
	}
833
834
	function point_edit_comment_links_to_calypso( $url ) {
835
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
836
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
The variable $query_args does not exist. Did you forget to declare it?

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2240
2241
		if ( $redirect ) {
2242
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2243
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2244
				$page = $_GET['page'];
2245
			}
2246
2247
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2248
			exit;
2249
		}
2250
	}
2251
2252
	/**
2253
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2254
	 * Make sure to tuck away module "library" files in a sub-directory.
2255
	 */
2256
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2257
		static $modules = null;
2258
2259
		if ( ! isset( $modules ) ) {
2260
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2261
			// Use the cache if we're on the front-end and it's available...
2262
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2263
				$modules = $available_modules_option[ JETPACK__VERSION ];
2264
			} else {
2265
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2266
2267
				$modules = array();
2268
2269
				foreach ( $files as $file ) {
2270
					if ( ! $headers = self::get_module( $file ) ) {
2271
						continue;
2272
					}
2273
2274
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2275
				}
2276
2277
				Jetpack_Options::update_option(
2278
					'available_modules',
2279
					array(
2280
						JETPACK__VERSION => $modules,
2281
					)
2282
				);
2283
			}
2284
		}
2285
2286
		/**
2287
		 * Filters the array of modules available to be activated.
2288
		 *
2289
		 * @since 2.4.0
2290
		 *
2291
		 * @param array $modules Array of available modules.
2292
		 * @param string $min_version Minimum version number required to use modules.
2293
		 * @param string $max_version Maximum version number required to use modules.
2294
		 */
2295
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2296
2297
		if ( ! $min_version && ! $max_version ) {
2298
			return array_keys( $mods );
2299
		}
2300
2301
		$r = array();
2302
		foreach ( $mods as $slug => $introduced ) {
2303
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2304
				continue;
2305
			}
2306
2307
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2308
				continue;
2309
			}
2310
2311
			$r[] = $slug;
2312
		}
2313
2314
		return $r;
2315
	}
2316
2317
	/**
2318
	 * Default modules loaded on activation.
2319
	 */
2320
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2321
		$return = array();
2322
2323
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2324
			$module_data = self::get_module( $module );
2325
2326
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2327
				case 'yes':
2328
					$return[] = $module;
2329
					break;
2330
				case 'public':
2331
					if ( Jetpack_Options::get_option( 'public' ) ) {
2332
						$return[] = $module;
2333
					}
2334
					break;
2335
				case 'no':
2336
				default:
2337
					break;
2338
			}
2339
		}
2340
		/**
2341
		 * Filters the array of default modules.
2342
		 *
2343
		 * @since 2.5.0
2344
		 *
2345
		 * @param array $return Array of default modules.
2346
		 * @param string $min_version Minimum version number required to use modules.
2347
		 * @param string $max_version Maximum version number required to use modules.
2348
		 */
2349
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2350
	}
2351
2352
	/**
2353
	 * Checks activated modules during auto-activation to determine
2354
	 * if any of those modules are being deprecated.  If so, close
2355
	 * them out, and add any replacement modules.
2356
	 *
2357
	 * Runs at priority 99 by default.
2358
	 *
2359
	 * This is run late, so that it can still activate a module if
2360
	 * the new module is a replacement for another that the user
2361
	 * currently has active, even if something at the normal priority
2362
	 * would kibosh everything.
2363
	 *
2364
	 * @since 2.6
2365
	 * @uses jetpack_get_default_modules filter
2366
	 * @param array $modules
2367
	 * @return array
2368
	 */
2369
	function handle_deprecated_modules( $modules ) {
2370
		$deprecated_modules = array(
2371
			'debug'            => null,  // Closed out and moved to the debugger library.
2372
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2373
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2374
		);
2375
2376
		// Don't activate SSO if they never completed activating WPCC.
2377
		if ( self::is_module_active( 'wpcc' ) ) {
2378
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2379
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2380
				$deprecated_modules['wpcc'] = null;
2381
			}
2382
		}
2383
2384
		foreach ( $deprecated_modules as $module => $replacement ) {
2385
			if ( self::is_module_active( $module ) ) {
2386
				self::deactivate_module( $module );
2387
				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...
2388
					$modules[] = $replacement;
2389
				}
2390
			}
2391
		}
2392
2393
		return array_unique( $modules );
2394
	}
2395
2396
	/**
2397
	 * Checks activated plugins during auto-activation to determine
2398
	 * if any of those plugins are in the list with a corresponding module
2399
	 * that is not compatible with the plugin. The module will not be allowed
2400
	 * to auto-activate.
2401
	 *
2402
	 * @since 2.6
2403
	 * @uses jetpack_get_default_modules filter
2404
	 * @param array $modules
2405
	 * @return array
2406
	 */
2407
	function filter_default_modules( $modules ) {
2408
2409
		$active_plugins = self::get_active_plugins();
2410
2411
		if ( ! empty( $active_plugins ) ) {
2412
2413
			// For each module we'd like to auto-activate...
2414
			foreach ( $modules as $key => $module ) {
2415
				// If there are potential conflicts for it...
2416
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2417
					// For each potential conflict...
2418
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2419
						// If that conflicting plugin is active...
2420
						if ( in_array( $plugin, $active_plugins ) ) {
2421
							// Remove that item from being auto-activated.
2422
							unset( $modules[ $key ] );
2423
						}
2424
					}
2425
				}
2426
			}
2427
		}
2428
2429
		return $modules;
2430
	}
2431
2432
	/**
2433
	 * Extract a module's slug from its full path.
2434
	 */
2435
	public static function get_module_slug( $file ) {
2436
		return str_replace( '.php', '', basename( $file ) );
2437
	}
2438
2439
	/**
2440
	 * Generate a module's path from its slug.
2441
	 */
2442
	public static function get_module_path( $slug ) {
2443
		/**
2444
		 * Filters the path of a modules.
2445
		 *
2446
		 * @since 7.4.0
2447
		 *
2448
		 * @param array $return The absolute path to a module's root php file
2449
		 * @param string $slug The module slug
2450
		 */
2451
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2452
	}
2453
2454
	/**
2455
	 * Load module data from module file. Headers differ from WordPress
2456
	 * plugin headers to avoid them being identified as standalone
2457
	 * plugins on the WordPress plugins page.
2458
	 */
2459
	public static function get_module( $module ) {
2460
		$headers = array(
2461
			'name'                      => 'Module Name',
2462
			'description'               => 'Module Description',
2463
			'sort'                      => 'Sort Order',
2464
			'recommendation_order'      => 'Recommendation Order',
2465
			'introduced'                => 'First Introduced',
2466
			'changed'                   => 'Major Changes In',
2467
			'deactivate'                => 'Deactivate',
2468
			'free'                      => 'Free',
2469
			'requires_connection'       => 'Requires Connection',
2470
			'auto_activate'             => 'Auto Activate',
2471
			'module_tags'               => 'Module Tags',
2472
			'feature'                   => 'Feature',
2473
			'additional_search_queries' => 'Additional Search Queries',
2474
			'plan_classes'              => 'Plans',
2475
		);
2476
2477
		$file = self::get_module_path( self::get_module_slug( $module ) );
2478
2479
		$mod = self::get_file_data( $file, $headers );
2480
		if ( empty( $mod['name'] ) ) {
2481
			return false;
2482
		}
2483
2484
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2485
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2486
		$mod['deactivate']           = empty( $mod['deactivate'] );
2487
		$mod['free']                 = empty( $mod['free'] );
2488
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2489
2490
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2491
			$mod['auto_activate'] = 'No';
2492
		} else {
2493
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2494
		}
2495
2496
		if ( $mod['module_tags'] ) {
2497
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2498
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2499
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2500
		} else {
2501
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2502
		}
2503
2504 View Code Duplication
		if ( $mod['plan_classes'] ) {
2505
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2506
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2507
		} else {
2508
			$mod['plan_classes'] = array( 'free' );
2509
		}
2510
2511 View Code Duplication
		if ( $mod['feature'] ) {
2512
			$mod['feature'] = explode( ',', $mod['feature'] );
2513
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2514
		} else {
2515
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2516
		}
2517
2518
		/**
2519
		 * Filters the feature array on a module.
2520
		 *
2521
		 * This filter allows you to control where each module is filtered: Recommended,
2522
		 * and the default "Other" listing.
2523
		 *
2524
		 * @since 3.5.0
2525
		 *
2526
		 * @param array   $mod['feature'] The areas to feature this module:
2527
		 *     'Recommended' shows on the main Jetpack admin screen.
2528
		 *     'Other' should be the default if no other value is in the array.
2529
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2530
		 * @param array   $mod All the currently assembled module data.
2531
		 */
2532
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2533
2534
		/**
2535
		 * Filter the returned data about a module.
2536
		 *
2537
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2538
		 * so please be careful.
2539
		 *
2540
		 * @since 3.6.0
2541
		 *
2542
		 * @param array   $mod    The details of the requested module.
2543
		 * @param string  $module The slug of the module, e.g. sharedaddy
2544
		 * @param string  $file   The path to the module source file.
2545
		 */
2546
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2547
	}
2548
2549
	/**
2550
	 * Like core's get_file_data implementation, but caches the result.
2551
	 */
2552
	public static function get_file_data( $file, $headers ) {
2553
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2554
		$file_name = basename( $file );
2555
2556
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2557
2558
		$file_data_option = get_transient( $cache_key );
2559
2560
		if ( ! is_array( $file_data_option ) ) {
2561
			delete_transient( $cache_key );
2562
			$file_data_option = false;
2563
		}
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( ' . self::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, self::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
		self::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 = null,
2781
		$send_state_messages = null
2782
	) {
2783
		$jetpack = self::init();
2784
2785
		if ( is_null( $redirect ) ) {
2786
			if (
2787
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2788
			||
2789
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2790
			||
2791
				( defined( 'WP_CLI' ) && WP_CLI )
2792
			||
2793
				( defined( 'DOING_CRON' ) && DOING_CRON )
2794
			||
2795
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2796
			) {
2797
				$redirect = false;
2798
			} elseif ( is_admin() ) {
2799
				$redirect = true;
2800
			} else {
2801
				$redirect = false;
2802
			}
2803
		}
2804
2805
		if ( is_null( $send_state_messages ) ) {
2806
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2807
		}
2808
2809
		$modules = self::get_default_modules( $min_version, $max_version );
2810
		$modules = array_merge( $other_modules, $modules );
2811
2812
		// Look for standalone plugins and disable if active.
2813
2814
		$to_deactivate = array();
2815
		foreach ( $modules as $module ) {
2816
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2817
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2818
			}
2819
		}
2820
2821
		$deactivated = array();
2822
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2823
			list( $probable_file, $probable_title ) = $deactivate_me;
2824
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2825
				$deactivated[] = $module;
2826
			}
2827
		}
2828
2829
		if ( $deactivated ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

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

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

Loading history...
2830
			if ( $send_state_messages ) {
2831
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2832
			}
2833
2834
			if ( $redirect ) {
2835
				$url = add_query_arg(
2836
					array(
2837
						'action'   => 'activate_default_modules',
2838
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2839
					),
2840
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2841
				);
2842
				wp_safe_redirect( $url );
2843
				exit;
2844
			}
2845
		}
2846
2847
		/**
2848
		 * Fires before default modules are activated.
2849
		 *
2850
		 * @since 1.9.0
2851
		 *
2852
		 * @param string $min_version Minimum version number required to use modules.
2853
		 * @param string $max_version Maximum version number required to use modules.
2854
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2855
		 */
2856
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2857
2858
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2859
		if ( $send_state_messages ) {
2860
			self::restate();
2861
			self::catch_errors( true );
2862
		}
2863
2864
		$active = self::get_active_modules();
2865
2866
		foreach ( $modules as $module ) {
2867
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2868
				$active[] = $module;
2869
				self::update_active_modules( $active );
2870
				continue;
2871
			}
2872
2873
			if ( $send_state_messages && in_array( $module, $active ) ) {
2874
				$module_info = self::get_module( $module );
2875 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2876
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2877
					if ( $active_state = self::state( $state ) ) {
2878
						$active_state = explode( ',', $active_state );
2879
					} else {
2880
						$active_state = array();
2881
					}
2882
					$active_state[] = $module;
2883
					self::state( $state, implode( ',', $active_state ) );
2884
				}
2885
				continue;
2886
			}
2887
2888
			$file = self::get_module_path( $module );
2889
			if ( ! file_exists( $file ) ) {
2890
				continue;
2891
			}
2892
2893
			// we'll override this later if the plugin can be included without fatal error
2894
			if ( $redirect ) {
2895
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2896
			}
2897
2898
			if ( $send_state_messages ) {
2899
				self::state( 'error', 'module_activation_failed' );
2900
				self::state( 'module', $module );
2901
			}
2902
2903
			ob_start();
2904
			require_once $file;
2905
2906
			$active[] = $module;
2907
2908 View Code Duplication
			if ( $send_state_messages ) {
2909
2910
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2911
				if ( $active_state = self::state( $state ) ) {
2912
					$active_state = explode( ',', $active_state );
2913
				} else {
2914
					$active_state = array();
2915
				}
2916
				$active_state[] = $module;
2917
				self::state( $state, implode( ',', $active_state ) );
2918
			}
2919
2920
			self::update_active_modules( $active );
2921
2922
			ob_end_clean();
2923
		}
2924
2925
		if ( $send_state_messages ) {
2926
			self::state( 'error', false );
0 ignored issues
show
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3141
		}
3142
3143
		// For firing one-off events (notices) immediately after activation
3144
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3145
3146
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3147
3148
		self::plugin_initialize();
3149
	}
3150
3151
	public static function get_activation_source( $referer_url ) {
3152
3153
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3154
			return array( 'wp-cli', null );
3155
		}
3156
3157
		$referer = wp_parse_url( $referer_url );
3158
3159
		$source_type  = 'unknown';
3160
		$source_query = null;
3161
3162
		if ( ! is_array( $referer ) ) {
3163
			return array( $source_type, $source_query );
3164
		}
3165
3166
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3167
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3168
3169
		if ( isset( $referer['query'] ) ) {
3170
			parse_str( $referer['query'], $query_parts );
3171
		} else {
3172
			$query_parts = array();
3173
		}
3174
3175
		if ( $plugins_path === $referer['path'] ) {
3176
			$source_type = 'list';
3177
		} elseif ( $plugins_install_path === $referer['path'] ) {
3178
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3179
			switch ( $tab ) {
3180
				case 'popular':
3181
					$source_type = 'popular';
3182
					break;
3183
				case 'recommended':
3184
					$source_type = 'recommended';
3185
					break;
3186
				case 'favorites':
3187
					$source_type = 'favorites';
3188
					break;
3189
				case 'search':
3190
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3191
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3192
					break;
3193
				default:
3194
					$source_type = 'featured';
3195
			}
3196
		}
3197
3198
		return array( $source_type, $source_query );
3199
	}
3200
3201
	/**
3202
	 * Runs before bumping version numbers up to a new version
3203
	 *
3204
	 * @param  string $version    Version:timestamp
3205
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3206
	 * @return null              [description]
3207
	 */
3208
	public static function do_version_bump( $version, $old_version ) {
3209
		if ( ! $old_version ) { // For new sites
3210
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3211
		}
3212
	}
3213
3214
	/**
3215
	 * Sets the internal version number and activation state.
3216
	 *
3217
	 * @static
3218
	 */
3219
	public static function plugin_initialize() {
3220
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3221
			Jetpack_Options::update_option( 'activated', 2 );
3222
		}
3223
3224 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3225
			$version = $old_version = JETPACK__VERSION . ':' . time();
3226
			/** This action is documented in class.jetpack.php */
3227
			do_action( 'updating_jetpack_version', $version, false );
3228
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3229
		}
3230
3231
		self::load_modules();
3232
3233
		Jetpack_Options::delete_option( 'do_activate' );
3234
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3235
	}
3236
3237
	/**
3238
	 * Removes all connection options
3239
	 *
3240
	 * @static
3241
	 */
3242
	public static function plugin_deactivation() {
3243
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3244
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3245
			Jetpack_Network::init()->deactivate();
3246
		} else {
3247
			self::disconnect( false );
3248
			// Jetpack_Heartbeat::init()->deactivate();
3249
		}
3250
	}
3251
3252
	/**
3253
	 * Disconnects from the Jetpack servers.
3254
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3255
	 *
3256
	 * @static
3257
	 */
3258
	public static function disconnect( $update_activated_state = true ) {
3259
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3260
		$connection = self::connection();
3261
		$connection->clean_nonces( true );
3262
3263
		// If the site is in an IDC because sync is not allowed,
3264
		// let's make sure to not disconnect the production site.
3265
		if ( ! self::validate_sync_error_idc_option() ) {
3266
			$tracking = new Tracking();
3267
			$tracking->record_user_event( 'disconnect_site', array() );
3268
3269
			$xml = new Jetpack_IXR_Client();
3270
			$xml->query( 'jetpack.deregister', get_current_user_id() );
3271
		}
3272
3273
		Jetpack_Options::delete_option(
3274
			array(
3275
				'blog_token',
3276
				'user_token',
3277
				'user_tokens',
3278
				'master_user',
3279
				'time_diff',
3280
				'fallback_no_verify_ssl_certs',
3281
			)
3282
		);
3283
3284
		Jetpack_IDC::clear_all_idc_options();
3285
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3286
3287
		if ( $update_activated_state ) {
3288
			Jetpack_Options::update_option( 'activated', 4 );
3289
		}
3290
3291
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3292
			// Check then record unique disconnection if site has never been disconnected previously
3293
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3294
				$jetpack_unique_connection['disconnected'] = 1;
3295
			} else {
3296
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3297
					// track unique disconnect
3298
					$jetpack = self::init();
3299
3300
					$jetpack->stat( 'connections', 'unique-disconnect' );
3301
					$jetpack->do_stats( 'server_side' );
3302
				}
3303
				// increment number of times disconnected
3304
				$jetpack_unique_connection['disconnected'] += 1;
3305
			}
3306
3307
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3308
		}
3309
3310
		// Delete cached connected user data
3311
		$transient_key = 'jetpack_connected_user_data_' . get_current_user_id();
3312
		delete_transient( $transient_key );
3313
3314
		// Delete all the sync related data. Since it could be taking up space.
3315
		Sender::get_instance()->uninstall();
3316
3317
		// Disable the Heartbeat cron
3318
		Jetpack_Heartbeat::init()->deactivate();
3319
	}
3320
3321
	/**
3322
	 * Unlinks the current user from the linked WordPress.com user.
3323
	 *
3324
	 * @deprecated since 7.7
3325
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3326
	 *
3327
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
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...
3328
	 * @return Boolean Whether the disconnection of the user was successful.
3329
	 */
3330
	public static function unlink_user( $user_id = null ) {
3331
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3332
		return Connection_Manager::disconnect_user( $user_id );
3333
	}
3334
3335
	/**
3336
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3337
	 */
3338
	public static function try_registration() {
3339
		$terms_of_service = new Terms_Of_Service();
3340
		// The user has agreed to the TOS at some point by now.
3341
		$terms_of_service->agree();
3342
3343
		// Let's get some testing in beta versions and such.
3344
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3345
			// Before attempting to connect, let's make sure that the domains are viable.
3346
			$domains_to_check = array_unique(
3347
				array(
3348
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3349
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3350
				)
3351
			);
3352
			foreach ( $domains_to_check as $domain ) {
3353
				$result = self::connection()->is_usable_domain( $domain );
3354
				if ( is_wp_error( $result ) ) {
3355
					return $result;
3356
				}
3357
			}
3358
		}
3359
3360
		$result = self::register();
3361
3362
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3363
		if ( ! $result || is_wp_error( $result ) ) {
3364
			return $result;
3365
		} else {
3366
			return true;
3367
		}
3368
	}
3369
3370
	/**
3371
	 * Tracking an internal event log. Try not to put too much chaff in here.
3372
	 *
3373
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3374
	 */
3375
	public static function log( $code, $data = null ) {
3376
		// only grab the latest 200 entries
3377
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3378
3379
		// Append our event to the log
3380
		$log_entry = array(
3381
			'time'    => time(),
3382
			'user_id' => get_current_user_id(),
3383
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3384
			'code'    => $code,
3385
		);
3386
		// Don't bother storing it unless we've got some.
3387
		if ( ! is_null( $data ) ) {
3388
			$log_entry['data'] = $data;
3389
		}
3390
		$log[] = $log_entry;
3391
3392
		// Try add_option first, to make sure it's not autoloaded.
3393
		// @todo: Add an add_option method to Jetpack_Options
3394
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3395
			Jetpack_Options::update_option( 'log', $log );
3396
		}
3397
3398
		/**
3399
		 * Fires when Jetpack logs an internal event.
3400
		 *
3401
		 * @since 3.0.0
3402
		 *
3403
		 * @param array $log_entry {
3404
		 *  Array of details about the log entry.
3405
		 *
3406
		 *  @param string time Time of the event.
3407
		 *  @param int user_id ID of the user who trigerred the event.
3408
		 *  @param int blog_id Jetpack Blog ID.
3409
		 *  @param string code Unique name for the event.
3410
		 *  @param string data Data about the event.
3411
		 * }
3412
		 */
3413
		do_action( 'jetpack_log_entry', $log_entry );
3414
	}
3415
3416
	/**
3417
	 * Get the internal event log.
3418
	 *
3419
	 * @param $event (string) - only return the specific log events
3420
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3421
	 *
3422
	 * @return array of log events || WP_Error for invalid params
3423
	 */
3424
	public static function get_log( $event = false, $num = false ) {
3425
		if ( $event && ! is_string( $event ) ) {
3426
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
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...
3427
		}
3428
3429
		if ( $num && ! is_numeric( $num ) ) {
3430
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
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...
3431
		}
3432
3433
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3434
3435
		// If nothing set - act as it did before, otherwise let's start customizing the output
3436
		if ( ! $num && ! $event ) {
3437
			return $entire_log;
3438
		} else {
3439
			$entire_log = array_reverse( $entire_log );
3440
		}
3441
3442
		$custom_log_output = array();
3443
3444
		if ( $event ) {
3445
			foreach ( $entire_log as $log_event ) {
3446
				if ( $event == $log_event['code'] ) {
3447
					$custom_log_output[] = $log_event;
3448
				}
3449
			}
3450
		} else {
3451
			$custom_log_output = $entire_log;
3452
		}
3453
3454
		if ( $num ) {
3455
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3456
		}
3457
3458
		return $custom_log_output;
3459
	}
3460
3461
	/**
3462
	 * Log modification of important settings.
3463
	 */
3464
	public static function log_settings_change( $option, $old_value, $value ) {
3465
		switch ( $option ) {
3466
			case 'jetpack_sync_non_public_post_stati':
3467
				self::log( $option, $value );
3468
				break;
3469
		}
3470
	}
3471
3472
	/**
3473
	 * Return stat data for WPCOM sync
3474
	 */
3475
	public static function get_stat_data( $encode = true, $extended = true ) {
3476
		$data = Jetpack_Heartbeat::generate_stats_array();
3477
3478
		if ( $extended ) {
3479
			$additional_data = self::get_additional_stat_data();
3480
			$data            = array_merge( $data, $additional_data );
3481
		}
3482
3483
		if ( $encode ) {
3484
			return json_encode( $data );
3485
		}
3486
3487
		return $data;
3488
	}
3489
3490
	/**
3491
	 * Get additional stat data to sync to WPCOM
3492
	 */
3493
	public static function get_additional_stat_data( $prefix = '' ) {
3494
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

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

Let’s take a look at an example:

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

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

    // do something with $myArray
}

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

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

Loading history...
3495
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3496
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3497
		$return[ "{$prefix}site-count" ]    = 0;
3498
3499
		if ( function_exists( 'get_blog_count' ) ) {
3500
			$return[ "{$prefix}site-count" ] = get_blog_count();
3501
		}
3502
		return $return;
3503
	}
3504
3505
	private static function get_site_user_count() {
3506
		global $wpdb;
3507
3508
		if ( function_exists( 'wp_is_large_network' ) ) {
3509
			if ( wp_is_large_network( 'users' ) ) {
3510
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3511
			}
3512
		}
3513
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3514
			// It wasn't there, so regenerate the data and save the transient
3515
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3516
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3517
		}
3518
		return $user_count;
3519
	}
3520
3521
	/* Admin Pages */
3522
3523
	function admin_init() {
3524
		// If the plugin is not connected, display a connect message.
3525
		if (
3526
			// the plugin was auto-activated and needs its candy
3527
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3528
		||
3529
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3530
			! Jetpack_Options::get_option( 'activated' )
3531
		) {
3532
			self::plugin_initialize();
3533
		}
3534
3535
		if ( ! self::is_active() && ! self::is_development_mode() ) {
3536
			Jetpack_Connection_Banner::init();
3537
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3538
			// Upgrade: 1.1 -> 1.1.1
3539
			// Check and see if host can verify the Jetpack servers' SSL certificate
3540
			$args       = array();
3541
			$connection = self::connection();
3542
			Client::_wp_remote_request(
3543
				self::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3544
				$args,
3545
				true
3546
			);
3547
		}
3548
3549
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3550
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3551
		}
3552
3553
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3554
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3555
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3556
3557
		if ( self::is_active() || self::is_development_mode() ) {
3558
			// Artificially throw errors in certain whitelisted cases during plugin activation
3559
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3560
		}
3561
3562
		// Add custom column in wp-admin/users.php to show whether user is linked.
3563
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3564
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3565
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3566
	}
3567
3568
	function admin_body_class( $admin_body_class = '' ) {
3569
		$classes = explode( ' ', trim( $admin_body_class ) );
3570
3571
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3572
3573
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3574
		return " $admin_body_class ";
3575
	}
3576
3577
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3578
		return $admin_body_class . ' jetpack-pagestyles ';
3579
	}
3580
3581
	/**
3582
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3583
	 * This function artificially throws errors for such cases (whitelisted).
3584
	 *
3585
	 * @param string $plugin The activated plugin.
3586
	 */
3587
	function throw_error_on_activate_plugin( $plugin ) {
3588
		$active_modules = self::get_active_modules();
3589
3590
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3591
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3592
			$throw = false;
3593
3594
			// Try and make sure it really was the stats plugin
3595
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3596
				if ( 'stats.php' == basename( $plugin ) ) {
3597
					$throw = true;
3598
				}
3599
			} else {
3600
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3601
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3602
					$throw = true;
3603
				}
3604
			}
3605
3606
			if ( $throw ) {
3607
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3608
			}
3609
		}
3610
	}
3611
3612
	function intercept_plugin_error_scrape_init() {
3613
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3614
	}
3615
3616
	function intercept_plugin_error_scrape( $action, $result ) {
3617
		if ( ! $result ) {
3618
			return;
3619
		}
3620
3621
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3622
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3623
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3624
			}
3625
		}
3626
	}
3627
3628
	/**
3629
	 * Register the remote file upload request handlers, if needed.
3630
	 *
3631
	 * @access public
3632
	 */
3633
	public function add_remote_request_handlers() {
3634
		// Remote file uploads are allowed only via AJAX requests.
3635
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3636
			return;
3637
		}
3638
3639
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3640
		$remote_request_actions = array(
3641
			'jetpack_upload_file',
3642
			'jetpack_update_file',
3643
		);
3644
3645
		// phpcs:ignore WordPress.Security.NonceVerification
3646
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3647
			return;
3648
		}
3649
3650
		// Require Jetpack authentication for the remote file upload AJAX requests.
3651
		$this->connection_manager->require_jetpack_authentication();
3652
3653
		// Register the remote file upload AJAX handlers.
3654
		foreach ( $remote_request_actions as $action ) {
3655
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3656
		}
3657
	}
3658
3659
	/**
3660
	 * Handler for Jetpack remote file uploads.
3661
	 *
3662
	 * @access public
3663
	 */
3664
	public function remote_request_handlers() {
3665
		$action = current_filter();
0 ignored issues
show
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3666
3667
		switch ( current_filter() ) {
3668
			case 'wp_ajax_nopriv_jetpack_upload_file':
3669
				$response = $this->upload_handler();
3670
				break;
3671
3672
			case 'wp_ajax_nopriv_jetpack_update_file':
3673
				$response = $this->upload_handler( true );
3674
				break;
3675
			default:
3676
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
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...
3677
				break;
3678
		}
3679
3680
		if ( ! $response ) {
3681
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
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...
3682
		}
3683
3684
		if ( is_wp_error( $response ) ) {
3685
			$status_code       = $response->get_error_data();
0 ignored issues
show
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...
3686
			$error             = $response->get_error_code();
0 ignored issues
show
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...
3687
			$error_description = $response->get_error_message();
0 ignored issues
show
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...
3688
3689
			if ( ! is_int( $status_code ) ) {
3690
				$status_code = 400;
3691
			}
3692
3693
			status_header( $status_code );
3694
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3695
		}
3696
3697
		status_header( 200 );
3698
		if ( true === $response ) {
3699
			exit;
3700
		}
3701
3702
		die( json_encode( (object) $response ) );
3703
	}
3704
3705
	/**
3706
	 * Uploads a file gotten from the global $_FILES.
3707
	 * If `$update_media_item` is true and `post_id` is defined
3708
	 * the attachment file of the media item (gotten through of the post_id)
3709
	 * will be updated instead of add a new one.
3710
	 *
3711
	 * @param  boolean $update_media_item - update media attachment
3712
	 * @return array - An array describing the uploadind files process
3713
	 */
3714
	function upload_handler( $update_media_item = false ) {
3715
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3716
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
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...
3717
		}
3718
3719
		$user = wp_authenticate( '', '' );
3720
		if ( ! $user || is_wp_error( $user ) ) {
3721
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
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...
3722
		}
3723
3724
		wp_set_current_user( $user->ID );
3725
3726
		if ( ! current_user_can( 'upload_files' ) ) {
3727
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
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...
3728
		}
3729
3730
		if ( empty( $_FILES ) ) {
3731
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
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...
3732
		}
3733
3734
		foreach ( array_keys( $_FILES ) as $files_key ) {
3735
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3736
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
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...
3737
			}
3738
		}
3739
3740
		$media_keys = array_keys( $_FILES['media'] );
3741
3742
		$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...
3743
		if ( ! $token || is_wp_error( $token ) ) {
3744
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
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...
3745
		}
3746
3747
		$uploaded_files = array();
3748
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3749
		unset( $GLOBALS['post'] );
3750
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3751
			$file = array();
3752
			foreach ( $media_keys as $media_key ) {
3753
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3754
			}
3755
3756
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3757
3758
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3759
			if ( $hmac_provided !== $hmac_file ) {
3760
				$uploaded_files[ $index ] = (object) array(
3761
					'error'             => 'invalid_hmac',
3762
					'error_description' => 'The corresponding HMAC for this file does not match',
3763
				);
3764
				continue;
3765
			}
3766
3767
			$_FILES['.jetpack.upload.'] = $file;
3768
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3769
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3770
				$post_id = 0;
3771
			}
3772
3773
			if ( $update_media_item ) {
3774
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3775
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
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...
3776
				}
3777
3778
				$media_array = $_FILES['media'];
3779
3780
				$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...
3781
				$file_array['type']     = $media_array['type'][0];
3782
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3783
				$file_array['error']    = $media_array['error'][0];
3784
				$file_array['size']     = $media_array['size'][0];
3785
3786
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3787
3788
				if ( is_wp_error( $edited_media_item ) ) {
3789
					return $edited_media_item;
3790
				}
3791
3792
				$response = (object) array(
3793
					'id'   => (string) $post_id,
3794
					'file' => (string) $edited_media_item->post_title,
3795
					'url'  => (string) wp_get_attachment_url( $post_id ),
3796
					'type' => (string) $edited_media_item->post_mime_type,
3797
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3798
				);
3799
3800
				return (array) array( $response );
3801
			}
3802
3803
			$attachment_id = media_handle_upload(
3804
				'.jetpack.upload.',
3805
				$post_id,
3806
				array(),
3807
				array(
3808
					'action' => 'jetpack_upload_file',
3809
				)
3810
			);
3811
3812
			if ( ! $attachment_id ) {
3813
				$uploaded_files[ $index ] = (object) array(
3814
					'error'             => 'unknown',
3815
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3816
				);
3817
			} elseif ( is_wp_error( $attachment_id ) ) {
3818
				$uploaded_files[ $index ] = (object) array(
3819
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3820
					'error_description' => $attachment_id->get_error_message(),
3821
				);
3822
			} else {
3823
				$attachment               = get_post( $attachment_id );
3824
				$uploaded_files[ $index ] = (object) array(
3825
					'id'   => (string) $attachment_id,
3826
					'file' => $attachment->post_title,
3827
					'url'  => wp_get_attachment_url( $attachment_id ),
3828
					'type' => $attachment->post_mime_type,
3829
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3830
				);
3831
				// Zip files uploads are not supported unless they are done for installation purposed
3832
				// lets delete them in case something goes wrong in this whole process
3833
				if ( 'application/zip' === $attachment->post_mime_type ) {
3834
					// Schedule a cleanup for 2 hours from now in case of failed install.
3835
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3836
				}
3837
			}
3838
		}
3839
		if ( ! is_null( $global_post ) ) {
3840
			$GLOBALS['post'] = $global_post;
3841
		}
3842
3843
		return $uploaded_files;
3844
	}
3845
3846
	/**
3847
	 * Add help to the Jetpack page
3848
	 *
3849
	 * @since Jetpack (1.2.3)
3850
	 * @return false if not the Jetpack page
3851
	 */
3852
	function admin_help() {
3853
		$current_screen = get_current_screen();
3854
3855
		// Overview
3856
		$current_screen->add_help_tab(
3857
			array(
3858
				'id'      => 'home',
3859
				'title'   => __( 'Home', 'jetpack' ),
3860
				'content' =>
3861
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3862
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3863
					'<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>',
3864
			)
3865
		);
3866
3867
		// Screen Content
3868
		if ( current_user_can( 'manage_options' ) ) {
3869
			$current_screen->add_help_tab(
3870
				array(
3871
					'id'      => 'settings',
3872
					'title'   => __( 'Settings', 'jetpack' ),
3873
					'content' =>
3874
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3875
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3876
						'<ol>' .
3877
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3878
							'<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>' .
3879
						'</ol>' .
3880
						'<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>',
3881
				)
3882
			);
3883
		}
3884
3885
		// Help Sidebar
3886
		$current_screen->set_help_sidebar(
3887
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3888
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3889
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3890
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3891
		);
3892
	}
3893
3894
	function admin_menu_css() {
3895
		wp_enqueue_style( 'jetpack-icons' );
3896
	}
3897
3898
	function admin_menu_order() {
3899
		return true;
3900
	}
3901
3902 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3903
		$jp_menu_order = array();
3904
3905
		foreach ( $menu_order as $index => $item ) {
3906
			if ( $item != 'jetpack' ) {
3907
				$jp_menu_order[] = $item;
3908
			}
3909
3910
			if ( $index == 0 ) {
3911
				$jp_menu_order[] = 'jetpack';
3912
			}
3913
		}
3914
3915
		return $jp_menu_order;
3916
	}
3917
3918
	function admin_banner_styles() {
3919
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3920
3921
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3922
			wp_register_style(
3923
				'jetpack-dops-style',
3924
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3925
				array(),
3926
				JETPACK__VERSION
3927
			);
3928
		}
3929
3930
		wp_enqueue_style(
3931
			'jetpack',
3932
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3933
			array( 'jetpack-dops-style' ),
3934
			JETPACK__VERSION . '-20121016'
3935
		);
3936
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3937
		wp_style_add_data( 'jetpack', 'suffix', $min );
3938
	}
3939
3940
	function plugin_action_links( $actions ) {
3941
3942
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3943
3944
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || self::is_development_mode() ) ) {
3945
			return array_merge(
3946
				$jetpack_home,
3947
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3948
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3949
				$actions
3950
			);
3951
		}
3952
3953
		return array_merge( $jetpack_home, $actions );
3954
	}
3955
3956
	/*
3957
	 * Registration flow:
3958
	 * 1 - ::admin_page_load() action=register
3959
	 * 2 - ::try_registration()
3960
	 * 3 - ::register()
3961
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3962
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3963
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3964
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3965
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3966
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3967
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3968
	 *       jetpack_id, jetpack_secret, jetpack_public
3969
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3970
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3971
	 * 5 - user logs in with WP.com account
3972
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3973
	 *		- Jetpack_Client_Server::authorize()
3974
	 *		- Jetpack_Client_Server::get_token()
3975
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3976
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3977
	 *			- which responds with access_token, token_type, scope
3978
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3979
	 *		- Jetpack::activate_default_modules()
3980
	 *     		- Deactivates deprecated plugins
3981
	 *     		- Activates all default modules
3982
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3983
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3984
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3985
	 *     Done!
3986
	 */
3987
3988
	/**
3989
	 * Handles the page load events for the Jetpack admin page
3990
	 */
3991
	function admin_page_load() {
3992
		$error = false;
3993
3994
		// Make sure we have the right body class to hook stylings for subpages off of.
3995
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3996
3997
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3998
			// Should only be used in intermediate redirects to preserve state across redirects
3999
			self::restate();
4000
		}
4001
4002
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4003
			// @todo: Add validation against a known whitelist
4004
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4005
			// User clicked in the iframe to link their accounts
4006
			if ( ! self::is_user_connected() ) {
4007
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4008
4009
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4010
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4011
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4012
4013
				if ( isset( $_GET['notes_iframe'] ) ) {
4014
					$connect_url .= '&notes_iframe';
4015
				}
4016
				wp_redirect( $connect_url );
4017
				exit;
4018
			} else {
4019
				if ( ! isset( $_GET['calypso_env'] ) ) {
4020
					self::state( 'message', 'already_authorized' );
4021
					wp_safe_redirect( self::admin_url() );
4022
					exit;
4023
				} else {
4024
					$connect_url  = $this->build_connect_url( true, false, $from );
4025
					$connect_url .= '&already_authorized=true';
4026
					wp_redirect( $connect_url );
4027
					exit;
4028
				}
4029
			}
4030
		}
4031
4032
		if ( isset( $_GET['action'] ) ) {
4033
			switch ( $_GET['action'] ) {
4034
				case 'authorize':
4035
					if ( self::is_active() && self::is_user_connected() ) {
4036
						self::state( 'message', 'already_authorized' );
4037
						wp_safe_redirect( self::admin_url() );
4038
						exit;
4039
					}
4040
					self::log( 'authorize' );
4041
					$client_server = new Jetpack_Client_Server();
4042
					$client_server->client_authorize();
4043
					exit;
4044
				case 'register':
4045
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4046
						$error = 'cheatin';
4047
						break;
4048
					}
4049
					check_admin_referer( 'jetpack-register' );
4050
					self::log( 'register' );
4051
					self::maybe_set_version_option();
4052
					$registered = self::try_registration();
4053 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4054
						$error = $registered->get_error_code();
0 ignored issues
show
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...
4055
						self::state( 'error', $error );
4056
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
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...
4057
4058
						/**
4059
						 * Jetpack registration Error.
4060
						 *
4061
						 * @since 7.5.0
4062
						 *
4063
						 * @param string|int $error The error code.
4064
						 * @param \WP_Error $registered The error object.
4065
						 */
4066
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4067
						break;
4068
					}
4069
4070
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4071
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4072
4073
					/**
4074
					 * Jetpack registration Success.
4075
					 *
4076
					 * @since 7.5.0
4077
					 *
4078
					 * @param string $from 'from' GET parameter;
4079
					 */
4080
					do_action( 'jetpack_connection_register_success', $from );
4081
4082
					$url = $this->build_connect_url( true, $redirect, $from );
4083
4084
					if ( ! empty( $_GET['onboarding'] ) ) {
4085
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4086
					}
4087
4088
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4089
						$url = add_query_arg( 'auth_approved', 'true', $url );
4090
					}
4091
4092
					wp_redirect( $url );
4093
					exit;
4094
				case 'activate':
4095
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4096
						$error = 'cheatin';
4097
						break;
4098
					}
4099
4100
					$module = stripslashes( $_GET['module'] );
4101
					check_admin_referer( "jetpack_activate-$module" );
4102
					self::log( 'activate', $module );
4103
					if ( ! self::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression self::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

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

$a = canBeFalseAndNull();

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

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4104
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4105
					}
4106
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4107
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4108
					exit;
4109
				case 'activate_default_modules':
4110
					check_admin_referer( 'activate_default_modules' );
4111
					self::log( 'activate_default_modules' );
4112
					self::restate();
4113
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4114
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4115
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4116
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4117
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4118
					exit;
4119
				case 'disconnect':
4120
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4121
						$error = 'cheatin';
4122
						break;
4123
					}
4124
4125
					check_admin_referer( 'jetpack-disconnect' );
4126
					self::log( 'disconnect' );
4127
					self::disconnect();
4128
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4129
					exit;
4130
				case 'reconnect':
4131
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4132
						$error = 'cheatin';
4133
						break;
4134
					}
4135
4136
					check_admin_referer( 'jetpack-reconnect' );
4137
					self::log( 'reconnect' );
4138
					$this->disconnect();
4139
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4140
					exit;
4141 View Code Duplication
				case 'deactivate':
4142
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4143
						$error = 'cheatin';
4144
						break;
4145
					}
4146
4147
					$modules = stripslashes( $_GET['module'] );
4148
					check_admin_referer( "jetpack_deactivate-$modules" );
4149
					foreach ( explode( ',', $modules ) as $module ) {
4150
						self::log( 'deactivate', $module );
4151
						self::deactivate_module( $module );
4152
						self::state( 'message', 'module_deactivated' );
4153
					}
4154
					self::state( 'module', $modules );
4155
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4156
					exit;
4157
				case 'unlink':
4158
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4159
					check_admin_referer( 'jetpack-unlink' );
4160
					self::log( 'unlink' );
4161
					Connection_Manager::disconnect_user();
4162
					self::state( 'message', 'unlinked' );
4163
					if ( 'sub-unlink' == $redirect ) {
4164
						wp_safe_redirect( admin_url() );
4165
					} else {
4166
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4167
					}
4168
					exit;
4169
				case 'onboard':
4170
					if ( ! current_user_can( 'manage_options' ) ) {
4171
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4172
					} else {
4173
						self::create_onboarding_token();
4174
						$url = $this->build_connect_url( true );
4175
4176
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4177
							$url = add_query_arg( 'onboarding', $token, $url );
4178
						}
4179
4180
						$calypso_env = $this->get_calypso_env();
4181
						if ( ! empty( $calypso_env ) ) {
4182
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4183
						}
4184
4185
						wp_redirect( $url );
4186
						exit;
4187
					}
4188
					exit;
4189
				default:
4190
					/**
4191
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4192
					 *
4193
					 * @since 2.6.0
4194
					 *
4195
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4196
					 */
4197
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4198
			}
4199
		}
4200
4201
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4202
			self::activate_new_modules( true );
4203
		}
4204
4205
		$message_code = self::state( 'message' );
4206
		if ( self::state( 'optin-manage' ) ) {
4207
			$activated_manage = $message_code;
4208
			$message_code     = 'jetpack-manage';
4209
		}
4210
4211
		switch ( $message_code ) {
4212
			case 'jetpack-manage':
4213
				$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>';
4214
				if ( $activated_manage ) {
0 ignored issues
show
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4422
	}
4423
4424
	/**
4425
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4426
	 */
4427
	function stat( $group, $detail ) {
4428
		if ( ! isset( $this->stats[ $group ] ) ) {
4429
			$this->stats[ $group ] = array();
4430
		}
4431
		$this->stats[ $group ][] = $detail;
4432
	}
4433
4434
	/**
4435
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4436
	 */
4437
	function do_stats( $method = '' ) {
4438
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4439
			foreach ( $this->stats as $group => $stats ) {
4440
				if ( is_array( $stats ) && count( $stats ) ) {
4441
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4442
					if ( 'server_side' === $method ) {
4443
						self::do_server_side_stat( $args );
4444
					} else {
4445
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4446
					}
4447
				}
4448
				unset( $this->stats[ $group ] );
4449
			}
4450
		}
4451
	}
4452
4453
	/**
4454
	 * Runs stats code for a one-off, server-side.
4455
	 *
4456
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4457
	 *
4458
	 * @return bool If it worked.
4459
	 */
4460
	static function do_server_side_stat( $args ) {
4461
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4462
		if ( is_wp_error( $response ) ) {
4463
			return false;
4464
		}
4465
4466
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4467
			return false;
4468
		}
4469
4470
		return true;
4471
	}
4472
4473
	/**
4474
	 * Builds the stats url.
4475
	 *
4476
	 * @param $args array|string The arguments to append to the URL.
4477
	 *
4478
	 * @return string The URL to be pinged.
4479
	 */
4480
	static function build_stats_url( $args ) {
4481
		$defaults = array(
4482
			'v'    => 'wpcom2',
4483
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4484
		);
4485
		$args     = wp_parse_args( $args, $defaults );
4486
		/**
4487
		 * Filter the URL used as the Stats tracking pixel.
4488
		 *
4489
		 * @since 2.3.2
4490
		 *
4491
		 * @param string $url Base URL used as the Stats tracking pixel.
4492
		 */
4493
		$base_url = apply_filters(
4494
			'jetpack_stats_base_url',
4495
			'https://pixel.wp.com/g.gif'
4496
		);
4497
		$url      = add_query_arg( $args, $base_url );
4498
		return $url;
4499
	}
4500
4501
	/**
4502
	 * Get the role of the current user.
4503
	 *
4504
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4505
	 *
4506
	 * @access public
4507
	 * @static
4508
	 *
4509
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4510
	 */
4511
	public static function translate_current_user_to_role() {
4512
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4513
4514
		$roles = new Roles();
4515
		return $roles->translate_current_user_to_role();
4516
	}
4517
4518
	/**
4519
	 * Get the role of a particular user.
4520
	 *
4521
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4522
	 *
4523
	 * @access public
4524
	 * @static
4525
	 *
4526
	 * @param \WP_User $user User object.
4527
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4528
	 */
4529
	public static function translate_user_to_role( $user ) {
4530
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4531
4532
		$roles = new Roles();
4533
		return $roles->translate_user_to_role( $user );
4534
	}
4535
4536
	/**
4537
	 * Get the minimum capability for a role.
4538
	 *
4539
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4540
	 *
4541
	 * @access public
4542
	 * @static
4543
	 *
4544
	 * @param string $role Role name.
4545
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4546
	 */
4547
	public static function translate_role_to_cap( $role ) {
4548
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4549
4550
		$roles = new Roles();
4551
		return $roles->translate_role_to_cap( $role );
4552
	}
4553
4554
	/**
4555
	 * Sign a user role with the master access token.
4556
	 * If not specified, will default to the current user.
4557
	 *
4558
	 * @deprecated since 7.7
4559
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4560
	 *
4561
	 * @access public
4562
	 * @static
4563
	 *
4564
	 * @param string $role    User role.
4565
	 * @param int    $user_id ID of the user.
0 ignored issues
show
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...
4566
	 * @return string Signed user role.
4567
	 */
4568
	public static function sign_role( $role, $user_id = null ) {
4569
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4570
		return self::connection()->sign_role( $role, $user_id );
4571
	}
4572
4573
	/**
4574
	 * Builds a URL to the Jetpack connection auth page
4575
	 *
4576
	 * @since 3.9.5
4577
	 *
4578
	 * @param bool        $raw If true, URL will not be escaped.
4579
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4580
	 *                              If string, will be a custom redirect.
4581
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4582
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4583
	 *
4584
	 * @return string Connect URL
4585
	 */
4586
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4587
		$site_id    = Jetpack_Options::get_option( 'id' );
4588
		$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...
4589
4590
		if ( $register || ! $blog_token || ! $site_id ) {
4591
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4592
4593
			if ( ! empty( $redirect ) ) {
4594
				$url = add_query_arg(
4595
					'redirect',
4596
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4597
					$url
4598
				);
4599
			}
4600
4601
			if ( is_network_admin() ) {
4602
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4603
			}
4604
4605
			$calypso_env = self::get_calypso_env();
4606
4607
			if ( ! empty( $calypso_env ) ) {
4608
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4609
			}
4610
		} else {
4611
4612
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4613
			// because otherwise this logic can get us in to a loop.
4614
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4615
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4616
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4617
4618
				$response = Client::wpcom_json_api_request_as_blog(
4619
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4620
					'1.1'
4621
				);
4622
4623
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4624
4625
					// Generating a register URL instead to refresh the existing token
4626
					return $this->build_connect_url( $raw, $redirect, $from, true );
4627
				}
4628
			}
4629
4630
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
It seems like $redirect defined by parameter $redirect on line 4586 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...
4631
		}
4632
4633
		if ( $from ) {
4634
			$url = add_query_arg( 'from', $from, $url );
4635
		}
4636
4637
		// Ensure that class to get the affiliate code is loaded
4638
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4639
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4640
		}
4641
		// Get affiliate code and add it to the URL
4642
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4643
4644
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4645
	}
4646
4647
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4648
		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4649
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4650
		}
4651
4652
		$roles       = new Roles();
4653
		$role        = $roles->translate_current_user_to_role();
4654
		$signed_role = self::connection()->sign_role( $role );
4655
4656
		$user = wp_get_current_user();
4657
4658
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4659
		$redirect           = $redirect
4660
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4661
			: $jetpack_admin_page;
4662
4663
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4664
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4665
		}
4666
4667
		$secrets = self::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4668
4669
		/**
4670
		 * Filter the type of authorization.
4671
		 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4672
		 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4673
		 *
4674
		 * @since 4.3.3
4675
		 *
4676
		 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4677
		 */
4678
		$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4679
4680
		$tracks          = new Tracking();
4681
		$tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4682
4683
		$args = urlencode_deep(
4684
			array(
4685
				'response_type' => 'code',
4686
				'client_id'     => Jetpack_Options::get_option( 'id' ),
4687
				'redirect_uri'  => add_query_arg(
4688
					array(
4689
						'action'   => 'authorize',
4690
						'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4691
						'redirect' => urlencode( $redirect ),
4692
					),
4693
					esc_url( admin_url( 'admin.php?page=jetpack' ) )
4694
				),
4695
				'state'         => $user->ID,
4696
				'scope'         => $signed_role,
4697
				'user_email'    => $user->user_email,
4698
				'user_login'    => $user->user_login,
4699
				'is_active'     => self::is_active(),
4700
				'jp_version'    => JETPACK__VERSION,
4701
				'auth_type'     => $auth_type,
4702
				'secret'        => $secrets['secret_1'],
4703
				'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4704
				'blogname'      => get_option( 'blogname' ),
4705
				'site_url'      => site_url(),
4706
				'home_url'      => home_url(),
4707
				'site_icon'     => get_site_icon_url(),
4708
				'site_lang'     => get_locale(),
4709
				'_ui'           => $tracks_identity['_ui'],
4710
				'_ut'           => $tracks_identity['_ut'],
4711
				'site_created'  => self::connection()->get_assumed_site_creation_date(),
4712
			)
4713
		);
4714
4715
		self::apply_activation_source_to_args( $args );
4716
4717
		$connection = self::connection();
4718
4719
		$calypso_env = self::get_calypso_env();
4720
4721
		if ( ! empty( $calypso_env ) ) {
4722
			$args['calypso_env'] = $calypso_env;
4723
		}
4724
4725
		$api_url = $iframe ? $connection->api_url( 'authorize_iframe' ) : $connection->api_url( 'authorize' );
4726
4727
		return add_query_arg( $args, $api_url );
4728
	}
4729
4730
	/**
4731
	 * Get our assumed site creation date.
4732
	 * Calculated based on the earlier date of either:
4733
	 * - Earliest admin user registration date.
4734
	 * - Earliest date of post of any post type.
4735
	 *
4736
	 * @since 7.2.0
4737
	 * @deprecated since 7.8.0
4738
	 *
4739
	 * @return string Assumed site creation date and time.
4740
	 */
4741
	public static function get_assumed_site_creation_date() {
4742
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4743
		return self::connection()->get_assumed_site_creation_date();
4744
	}
4745
4746 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4747
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4748
4749
		if ( $activation_source_name ) {
4750
			$args['_as'] = urlencode( $activation_source_name );
4751
		}
4752
4753
		if ( $activation_source_keyword ) {
4754
			$args['_ak'] = urlencode( $activation_source_keyword );
4755
		}
4756
	}
4757
4758
	function build_reconnect_url( $raw = false ) {
4759
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4760
		return $raw ? $url : esc_url( $url );
4761
	}
4762
4763
	public static function admin_url( $args = null ) {
4764
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4765
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4766
		return $url;
4767
	}
4768
4769
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4770
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4771
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4772
	}
4773
4774
	function dismiss_jetpack_notice() {
4775
4776
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4777
			return;
4778
		}
4779
4780
		switch ( $_GET['jetpack-notice'] ) {
4781
			case 'dismiss':
4782
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4783
4784
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4785
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4786
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4787
				}
4788
				break;
4789
		}
4790
	}
4791
4792
	public static function sort_modules( $a, $b ) {
4793
		if ( $a['sort'] == $b['sort'] ) {
4794
			return 0;
4795
		}
4796
4797
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4798
	}
4799
4800
	function ajax_recheck_ssl() {
4801
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4802
		$result = self::permit_ssl( true );
4803
		wp_send_json(
4804
			array(
4805
				'enabled' => $result,
4806
				'message' => get_transient( 'jetpack_https_test_message' ),
4807
			)
4808
		);
4809
	}
4810
4811
	/* Client API */
4812
4813
	/**
4814
	 * Returns the requested Jetpack API URL
4815
	 *
4816
	 * @deprecated since 7.7
4817
	 * @return string
4818
	 */
4819
	public static function api_url( $relative_url ) {
4820
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4821
		$connection = self::connection();
4822
		return $connection->api_url( $relative_url );
4823
	}
4824
4825
	/**
4826
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4827
	 */
4828
	public static function fix_url_for_bad_hosts( $url ) {
4829
		if ( 0 !== strpos( $url, 'https://' ) ) {
4830
			return $url;
4831
		}
4832
4833
		switch ( JETPACK_CLIENT__HTTPS ) {
4834
			case 'ALWAYS':
4835
				return $url;
4836
			case 'NEVER':
4837
				return set_url_scheme( $url, 'http' );
4838
			// default : case 'AUTO' :
4839
		}
4840
4841
		// we now return the unmodified SSL URL by default, as a security precaution
4842
		return $url;
4843
	}
4844
4845
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4846
		// Default to a blog token.
4847
		$token_type = 'blog';
4848
4849
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4850
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4851
			if ( ! empty( $_GET['onboarding'] ) ) {
4852
				$jpo = $_GET;
4853
			} else {
4854
				$jpo = json_decode( $request_data, true );
4855
			}
4856
4857
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4858
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4859
4860
			if (
4861
				isset( $jpo_user )
4862
				&& isset( $jpo_token )
4863
				&& is_email( $jpo_user )
4864
				&& ctype_alnum( $jpo_token )
4865
				&& isset( $_GET['rest_route'] )
4866
				&& self::validate_onboarding_token_action(
4867
					$jpo_token,
4868
					$_GET['rest_route']
4869
				)
4870
			) {
4871
				$jp_user = get_user_by( 'email', $jpo_user );
4872
				if ( is_a( $jp_user, 'WP_User' ) ) {
4873
					wp_set_current_user( $jp_user->ID );
4874
					$user_can = is_multisite()
4875
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4876
						: current_user_can( 'manage_options' );
4877
					if ( $user_can ) {
4878
						$token_type              = 'user';
4879
						$token->external_user_id = $jp_user->ID;
4880
					}
4881
				}
4882
			}
4883
4884
			$token_data['type']    = $token_type;
4885
			$token_data['user_id'] = $token->external_user_id;
4886
		}
4887
4888
		return $token_data;
4889
	}
4890
4891
	/**
4892
	 * Create a random secret for validating onboarding payload
4893
	 *
4894
	 * @return string Secret token
4895
	 */
4896
	public static function create_onboarding_token() {
4897
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4898
			$token = wp_generate_password( 32, false );
4899
			Jetpack_Options::update_option( 'onboarding', $token );
4900
		}
4901
4902
		return $token;
4903
	}
4904
4905
	/**
4906
	 * Remove the onboarding token
4907
	 *
4908
	 * @return bool True on success, false on failure
4909
	 */
4910
	public static function invalidate_onboarding_token() {
4911
		return Jetpack_Options::delete_option( 'onboarding' );
4912
	}
4913
4914
	/**
4915
	 * Validate an onboarding token for a specific action
4916
	 *
4917
	 * @return boolean True if token/action pair is accepted, false if not
4918
	 */
4919
	public static function validate_onboarding_token_action( $token, $action ) {
4920
		// Compare tokens, bail if tokens do not match
4921
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4922
			return false;
4923
		}
4924
4925
		// List of valid actions we can take
4926
		$valid_actions = array(
4927
			'/jetpack/v4/settings',
4928
		);
4929
4930
		// Whitelist the action
4931
		if ( ! in_array( $action, $valid_actions ) ) {
4932
			return false;
4933
		}
4934
4935
		return true;
4936
	}
4937
4938
	/**
4939
	 * Checks to see if the URL is using SSL to connect with Jetpack
4940
	 *
4941
	 * @since 2.3.3
4942
	 * @return boolean
4943
	 */
4944
	public static function permit_ssl( $force_recheck = false ) {
4945
		// Do some fancy tests to see if ssl is being supported
4946
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4947
			$message = '';
4948
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4949
				$ssl = 0;
4950
			} else {
4951
				switch ( JETPACK_CLIENT__HTTPS ) {
4952
					case 'NEVER':
4953
						$ssl     = 0;
4954
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4955
						break;
4956
					case 'ALWAYS':
4957
					case 'AUTO':
4958
					default:
4959
						$ssl = 1;
4960
						break;
4961
				}
4962
4963
				// If it's not 'NEVER', test to see
4964
				if ( $ssl ) {
4965
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4966
						$ssl     = 0;
4967
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4968
					} else {
4969
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4970
						if ( is_wp_error( $response ) ) {
4971
							$ssl     = 0;
4972
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4973
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4974
							$ssl     = 0;
4975
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4976
						}
4977
					}
4978
				}
4979
			}
4980
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4981
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4982
		}
4983
4984
		return (bool) $ssl;
4985
	}
4986
4987
	/*
4988
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4989
	 */
4990
	public function alert_auto_ssl_fail() {
4991
		if ( ! current_user_can( 'manage_options' ) ) {
4992
			return;
4993
		}
4994
4995
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4996
		?>
4997
4998
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4999
			<div class="jp-banner__content">
5000
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5001
				<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>
5002
				<p>
5003
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5004
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5005
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5006
				</p>
5007
				<p>
5008
					<?php
5009
					printf(
5010
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5011
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5012
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5013
					);
5014
					?>
5015
				</p>
5016
			</div>
5017
		</div>
5018
		<style>
5019
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5020
		</style>
5021
		<script type="text/javascript">
5022
			jQuery( document ).ready( function( $ ) {
5023
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5024
					var $this = $( this );
5025
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5026
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5027
					e.preventDefault();
5028
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5029
					$.post( ajaxurl, data )
5030
					  .done( function( response ) {
5031
						  if ( response.enabled ) {
5032
							  $( '#jetpack-ssl-warning' ).hide();
5033
						  } else {
5034
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5035
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5036
						  }
5037
					  }.bind( $this ) );
5038
				} );
5039
			} );
5040
		</script>
5041
5042
		<?php
5043
	}
5044
5045
	/**
5046
	 * Returns the Jetpack XML-RPC API
5047
	 *
5048
	 * @return string
5049
	 */
5050
	public static function xmlrpc_api_url() {
5051
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5052
		return untrailingslashit( $base ) . '/xmlrpc.php';
5053
	}
5054
5055
	public static function connection() {
5056
		return self::init()->connection_manager;
5057
	}
5058
5059
	/**
5060
	 * Creates two secret tokens and the end of life timestamp for them.
5061
	 *
5062
	 * Note these tokens are unique per call, NOT static per site for connecting.
5063
	 *
5064
	 * @since 2.6
5065
	 * @return array
5066
	 */
5067
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5068
		if ( false === $user_id ) {
5069
			$user_id = get_current_user_id();
5070
		}
5071
5072
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5073
	}
5074
5075
	public static function get_secrets( $action, $user_id ) {
5076
		$secrets = self::connection()->get_secrets( $action, $user_id );
5077
5078
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5079
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
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...
5080
		}
5081
5082
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5083
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
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...
5084
		}
5085
5086
		return $secrets;
5087
	}
5088
5089
	/**
5090
	 * @deprecated 7.5 Use Connection_Manager instead.
5091
	 *
5092
	 * @param $action
5093
	 * @param $user_id
5094
	 */
5095
	public static function delete_secrets( $action, $user_id ) {
5096
		return self::connection()->delete_secrets( $action, $user_id );
5097
	}
5098
5099
	/**
5100
	 * Builds the timeout limit for queries talking with the wpcom servers.
5101
	 *
5102
	 * Based on local php max_execution_time in php.ini
5103
	 *
5104
	 * @since 2.6
5105
	 * @return int
5106
	 * @deprecated
5107
	 **/
5108
	public function get_remote_query_timeout_limit() {
5109
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5110
		return self::get_max_execution_time();
5111
	}
5112
5113
	/**
5114
	 * Builds the timeout limit for queries talking with the wpcom servers.
5115
	 *
5116
	 * Based on local php max_execution_time in php.ini
5117
	 *
5118
	 * @since 5.4
5119
	 * @return int
5120
	 **/
5121
	public static function get_max_execution_time() {
5122
		$timeout = (int) ini_get( 'max_execution_time' );
5123
5124
		// Ensure exec time set in php.ini
5125
		if ( ! $timeout ) {
5126
			$timeout = 30;
5127
		}
5128
		return $timeout;
5129
	}
5130
5131
	/**
5132
	 * Sets a minimum request timeout, and returns the current timeout
5133
	 *
5134
	 * @since 5.4
5135
	 **/
5136 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5137
		$timeout = self::get_max_execution_time();
5138
		if ( $timeout < $min_timeout ) {
5139
			$timeout = $min_timeout;
5140
			set_time_limit( $timeout );
5141
		}
5142
		return $timeout;
5143
	}
5144
5145
	/**
5146
	 * Takes the response from the Jetpack register new site endpoint and
5147
	 * verifies it worked properly.
5148
	 *
5149
	 * @since 2.6
5150
	 * @deprecated since 7.7.0
5151
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5152
	 **/
5153
	public function validate_remote_register_response() {
5154
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5155
	}
5156
5157
	/**
5158
	 * @return bool|WP_Error
5159
	 */
5160
	public static function register() {
5161
		$tracking = new Tracking();
5162
		$tracking->record_user_event( 'jpc_register_begin' );
5163
5164
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5165
5166
		$connection   = self::connection();
5167
		$registration = $connection->register();
5168
5169
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5170
5171
		if ( ! $registration || is_wp_error( $registration ) ) {
5172
			return $registration;
5173
		}
5174
5175
		return true;
5176
	}
5177
5178
	/**
5179
	 * Filters the registration request body to include tracking properties.
5180
	 *
5181
	 * @param Array $properties
5182
	 * @return Array amended properties.
5183
	 */
5184
	public static function filter_register_request_body( $properties ) {
5185
		$tracking        = new Tracking();
5186
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5187
5188
		return array_merge(
5189
			$properties,
5190
			array(
5191
				'_ui' => $tracks_identity['_ui'],
5192
				'_ut' => $tracks_identity['_ut'],
5193
			)
5194
		);
5195
	}
5196
5197
	/**
5198
	 * If the db version is showing something other that what we've got now, bump it to current.
5199
	 *
5200
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

Loading history...
5201
	 */
5202
	public static function maybe_set_version_option() {
5203
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5204
		if ( JETPACK__VERSION != $version ) {
5205
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5206
5207
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5208
				/** This action is documented in class.jetpack.php */
5209
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5210
			}
5211
5212
			return true;
5213
		}
5214
		return false;
5215
	}
5216
5217
	/* Client Server API */
5218
5219
	/**
5220
	 * Loads the Jetpack XML-RPC client.
5221
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5222
	 *
5223
	 * @deprecated since 7.7.0
5224
	 */
5225
	public static function load_xml_rpc_client() {
5226
		// Removed the php notice that shows up in order to give time to Akismet and VaultPress time to update.
5227
		// _deprecated_function( __METHOD__, 'jetpack-7.7' );
5228
	}
5229
5230
	/**
5231
	 * Resets the saved authentication state in between testing requests.
5232
	 */
5233
	public function reset_saved_auth_state() {
5234
		$this->rest_authentication_status = null;
5235
		$this->connection_manager->reset_saved_auth_state();
5236
	}
5237
5238
	/**
5239
	 * Verifies the signature of the current request.
5240
	 *
5241
	 * @deprecated since 7.7.0
5242
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5243
	 *
5244
	 * @return false|array
5245
	 */
5246
	public function verify_xml_rpc_signature() {
5247
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5248
		return self::connection()->verify_xml_rpc_signature();
5249
	}
5250
5251
	/**
5252
	 * Verifies the signature of the current request.
5253
	 *
5254
	 * This function has side effects and should not be used. Instead,
5255
	 * use the memoized version `->verify_xml_rpc_signature()`.
5256
	 *
5257
	 * @deprecated since 7.7.0
5258
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5259
	 * @internal
5260
	 */
5261
	private function internal_verify_xml_rpc_signature() {
5262
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5263
	}
5264
5265
	/**
5266
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5267
	 *
5268
	 * @deprecated since 7.7.0
5269
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5270
	 *
5271
	 * @param \WP_User|mixed $user     User object if authenticated.
5272
	 * @param string         $username Username.
5273
	 * @param string         $password Password string.
5274
	 * @return \WP_User|mixed Authenticated user or error.
5275
	 */
5276
	public function authenticate_jetpack( $user, $username, $password ) {
5277
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5278
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5279
	}
5280
5281
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5282
	// Uses the existing XMLRPC request signing implementation.
5283
	function wp_rest_authenticate( $user ) {
5284
		if ( ! empty( $user ) ) {
5285
			// Another authentication method is in effect.
5286
			return $user;
5287
		}
5288
5289
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5290
			// Nothing to do for this authentication method.
5291
			return null;
5292
		}
5293
5294
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5295
			// Nothing to do for this authentication method.
5296
			return null;
5297
		}
5298
5299
		// Ensure that we always have the request body available.  At this
5300
		// point, the WP REST API code to determine the request body has not
5301
		// run yet.  That code may try to read from 'php://input' later, but
5302
		// this can only be done once per request in PHP versions prior to 5.6.
5303
		// So we will go ahead and perform this read now if needed, and save
5304
		// the request body where both the Jetpack signature verification code
5305
		// and the WP REST API code can see it.
5306
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5307
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5308
		}
5309
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5310
5311
		// Only support specific request parameters that have been tested and
5312
		// are known to work with signature verification.  A different method
5313
		// can be passed to the WP REST API via the '?_method=' parameter if
5314
		// needed.
5315
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5316
			$this->rest_authentication_status = new WP_Error(
5317
				'rest_invalid_request',
0 ignored issues
show
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...
5318
				__( 'This request method is not supported.', 'jetpack' ),
5319
				array( 'status' => 400 )
5320
			);
5321
			return null;
5322
		}
5323
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5324
			$this->rest_authentication_status = new WP_Error(
5325
				'rest_invalid_request',
0 ignored issues
show
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...
5326
				__( 'This request method does not support body parameters.', 'jetpack' ),
5327
				array( 'status' => 400 )
5328
			);
5329
			return null;
5330
		}
5331
5332
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5333
5334
		if (
5335
			$verified &&
5336
			isset( $verified['type'] ) &&
5337
			'user' === $verified['type'] &&
5338
			! empty( $verified['user_id'] )
5339
		) {
5340
			// Authentication successful.
5341
			$this->rest_authentication_status = true;
5342
			return $verified['user_id'];
5343
		}
5344
5345
		// Something else went wrong.  Probably a signature error.
5346
		$this->rest_authentication_status = new WP_Error(
5347
			'rest_invalid_signature',
0 ignored issues
show
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...
5348
			__( 'The request is not signed correctly.', 'jetpack' ),
5349
			array( 'status' => 400 )
5350
		);
5351
		return null;
5352
	}
5353
5354
	/**
5355
	 * Report authentication status to the WP REST API.
5356
	 *
5357
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
There is no parameter named $result. Was it maybe removed?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
6983
		} else {
6984
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
6985
		}
6986
6987
		// Since this is a fresh connection, be sure to clear out IDC options
6988
		Jetpack_IDC::clear_all_idc_options();
6989
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
6990
6991
		// Start nonce cleaner
6992
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
6993
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
6994
6995
		if ( $send_state_messages ) {
6996
			self::state( 'message', 'authorized' );
6997
		}
6998
	}
6999
7000
	/**
7001
	 * Returns a boolean for whether backups UI should be displayed or not.
7002
	 *
7003
	 * @return bool Should backups UI be displayed?
7004
	 */
7005
	public static function show_backups_ui() {
7006
		/**
7007
		 * Whether UI for backups should be displayed.
7008
		 *
7009
		 * @since 6.5.0
7010
		 *
7011
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7012
		 */
7013
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7014
	}
7015
7016
	/*
7017
	 * Deprecated manage functions
7018
	 */
7019
	function prepare_manage_jetpack_notice() {
7020
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7021
	}
7022
	function manage_activate_screen() {
7023
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7024
	}
7025
	function admin_jetpack_manage_notice() {
7026
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7027
	}
7028
	function opt_out_jetpack_manage_url() {
7029
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7030
	}
7031
	function opt_in_jetpack_manage_url() {
7032
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7033
	}
7034
	function opt_in_jetpack_manage_notice() {
7035
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7036
	}
7037
	function can_display_jetpack_manage_notice() {
7038
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7039
	}
7040
7041
	/**
7042
	 * Clean leftoveruser meta.
7043
	 *
7044
	 * Delete Jetpack-related user meta when it is no longer needed.
7045
	 *
7046
	 * @since 7.3.0
7047
	 *
7048
	 * @param int $user_id User ID being updated.
7049
	 */
7050
	public static function user_meta_cleanup( $user_id ) {
7051
		$meta_keys = array(
7052
			// AtD removed from Jetpack 7.3
7053
			'AtD_options',
7054
			'AtD_check_when',
7055
			'AtD_guess_lang',
7056
			'AtD_ignored_phrases',
7057
		);
7058
7059
		foreach ( $meta_keys as $meta_key ) {
7060
			if ( get_user_meta( $user_id, $meta_key ) ) {
7061
				delete_user_meta( $user_id, $meta_key );
7062
			}
7063
		}
7064
	}
7065
7066
	/**
7067
	 * Checks if a Jetpack site is both active and not in development.
7068
	 *
7069
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Jetpack::is_development_mode`.
7070
	 *
7071
	 * @return bool True if Jetpack is active and not in development.
7072
	 */
7073
	public static function is_active_and_not_development_mode() {
7074
		if ( ! self::is_active() || self::is_development_mode() ) {
7075
			return false;
7076
		}
7077
		return true;
7078
	}
7079
}
7080