Completed
Push — try/connection-package-fix ( ca4cdd )
by
unknown
07:17
created

class.jetpack.php (72 issues)

Upgrade to new PHP Analysis Engine

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

Loading history...
2684
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2685
2686
			$url = add_query_arg(
2687
				array(
2688
					'action'   => 'activate_default_modules',
2689
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2690
				),
2691
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2692
			);
2693
			wp_safe_redirect( $url );
2694
			exit;
2695
		}
2696
2697
		/**
2698
		 * Fires before default modules are activated.
2699
		 *
2700
		 * @since 1.9.0
2701
		 *
2702
		 * @param string $min_version Minimum version number required to use modules.
2703
		 * @param string $max_version Maximum version number required to use modules.
2704
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2705
		 */
2706
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2707
2708
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2709
		if ( $send_state_messages ) {
2710
			Jetpack::restate();
2711
			Jetpack::catch_errors( true );
2712
		}
2713
2714
		$active = Jetpack::get_active_modules();
2715
2716
		foreach ( $modules as $module ) {
2717
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2718
				$active[] = $module;
2719
				self::update_active_modules( $active );
2720
				continue;
2721
			}
2722
2723
			if ( $send_state_messages && in_array( $module, $active ) ) {
2724
				$module_info = Jetpack::get_module( $module );
2725 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2726
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2727
					if ( $active_state = Jetpack::state( $state ) ) {
2728
						$active_state = explode( ',', $active_state );
2729
					} else {
2730
						$active_state = array();
2731
					}
2732
					$active_state[] = $module;
2733
					Jetpack::state( $state, implode( ',', $active_state ) );
2734
				}
2735
				continue;
2736
			}
2737
2738
			$file = Jetpack::get_module_path( $module );
2739
			if ( ! file_exists( $file ) ) {
2740
				continue;
2741
			}
2742
2743
			// we'll override this later if the plugin can be included without fatal error
2744
			if ( $redirect ) {
2745
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2746
			}
2747
2748
			if ( $send_state_messages ) {
2749
				Jetpack::state( 'error', 'module_activation_failed' );
2750
				Jetpack::state( 'module', $module );
2751
			}
2752
2753
			ob_start();
2754
			require_once $file;
2755
2756
			$active[] = $module;
2757
2758 View Code Duplication
			if ( $send_state_messages ) {
2759
2760
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2761
				if ( $active_state = Jetpack::state( $state ) ) {
2762
					$active_state = explode( ',', $active_state );
2763
				} else {
2764
					$active_state = array();
2765
				}
2766
				$active_state[] = $module;
2767
				Jetpack::state( $state, implode( ',', $active_state ) );
2768
			}
2769
2770
			Jetpack::update_active_modules( $active );
2771
2772
			ob_end_clean();
2773
		}
2774
2775
		if ( $send_state_messages ) {
2776
			Jetpack::state( 'error', false );
0 ignored issues
show
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2778
		}
2779
2780
		Jetpack::catch_errors( false );
2781
		/**
2782
		 * Fires when default modules are activated.
2783
		 *
2784
		 * @since 1.9.0
2785
		 *
2786
		 * @param string $min_version Minimum version number required to use modules.
2787
		 * @param string $max_version Maximum version number required to use modules.
2788
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2789
		 */
2790
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2791
	}
2792
2793
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2794
		/**
2795
		 * Fires before a module is activated.
2796
		 *
2797
		 * @since 2.6.0
2798
		 *
2799
		 * @param string $module Module slug.
2800
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2801
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2802
		 */
2803
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2804
2805
		$jetpack = Jetpack::init();
2806
2807
		if ( ! strlen( $module ) )
2808
			return false;
2809
2810
		if ( ! Jetpack::is_module( $module ) )
2811
			return false;
2812
2813
		// If it's already active, then don't do it again
2814
		$active = Jetpack::get_active_modules();
2815
		foreach ( $active as $act ) {
2816
			if ( $act == $module )
2817
				return true;
2818
		}
2819
2820
		$module_data = Jetpack::get_module( $module );
2821
2822
		if ( ! Jetpack::is_active() ) {
2823
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2824
				return false;
2825
2826
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2827
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2828
				return false;
2829
		}
2830
2831
		// Check and see if the old plugin is active
2832
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2833
			// Deactivate the old plugin
2834
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2835
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2836
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2837
				Jetpack::state( 'deactivated_plugins', $module );
2838
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2839
				exit;
2840
			}
2841
		}
2842
2843
		// Protect won't work with mis-configured IPs
2844
		if ( 'protect' === $module ) {
2845
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2846
			if ( ! jetpack_protect_get_ip() ) {
2847
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2848
				return false;
2849
			}
2850
		}
2851
2852
		if ( ! Jetpack_Plan::supports( $module ) ) {
2853
			return false;
2854
		}
2855
2856
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2857
		Jetpack::state( 'module', $module );
2858
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2859
2860
		Jetpack::catch_errors( true );
2861
		ob_start();
2862
		require Jetpack::get_module_path( $module );
2863
		/** This action is documented in class.jetpack.php */
2864
		do_action( 'jetpack_activate_module', $module );
2865
		$active[] = $module;
2866
		Jetpack::update_active_modules( $active );
2867
2868
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2869
		ob_end_clean();
2870
		Jetpack::catch_errors( false );
2871
2872
		if ( $redirect ) {
2873
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2874
		}
2875
		if ( $exit ) {
2876
			exit;
2877
		}
2878
		return true;
2879
	}
2880
2881
	function activate_module_actions( $module ) {
2882
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2883
	}
2884
2885
	public static function deactivate_module( $module ) {
2886
		/**
2887
		 * Fires when a module is deactivated.
2888
		 *
2889
		 * @since 1.9.0
2890
		 *
2891
		 * @param string $module Module slug.
2892
		 */
2893
		do_action( 'jetpack_pre_deactivate_module', $module );
2894
2895
		$jetpack = Jetpack::init();
0 ignored issues
show
$jetpack is not used, you could remove the assignment.

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

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

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

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

Loading history...
2896
2897
		$active = Jetpack::get_active_modules();
2898
		$new    = array_filter( array_diff( $active, (array) $module ) );
2899
2900
		return self::update_active_modules( $new );
2901
	}
2902
2903
	public static function enable_module_configurable( $module ) {
2904
		$module = Jetpack::get_module_slug( $module );
2905
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2906
	}
2907
2908
	/**
2909
	 * Composes a module configure URL. It uses Jetpack settings search as default value
2910
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
2911
	 *
2912
	 * @param string $module Module slug
2913
	 * @return string $url module configuration URL
2914
	 */
2915
	public static function module_configuration_url( $module ) {
2916
		$module = Jetpack::get_module_slug( $module );
2917
		$default_url =  Jetpack::admin_url() . "#/settings?term=$module";
2918
		/**
2919
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
2920
		 *
2921
		 * @since 6.9.0
2922
		 *
2923
		 * @param string $default_url Default url, which redirects to jetpack settings page.
2924
		 */
2925
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
2926
2927
		return $url;
2928
	}
2929
2930
/* Installation */
2931
	public static function bail_on_activation( $message, $deactivate = true ) {
2932
?>
2933
<!doctype html>
2934
<html>
2935
<head>
2936
<meta charset="<?php bloginfo( 'charset' ); ?>">
2937
<style>
2938
* {
2939
	text-align: center;
2940
	margin: 0;
2941
	padding: 0;
2942
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2943
}
2944
p {
2945
	margin-top: 1em;
2946
	font-size: 18px;
2947
}
2948
</style>
2949
<body>
2950
<p><?php echo esc_html( $message ); ?></p>
2951
</body>
2952
</html>
2953
<?php
2954
		if ( $deactivate ) {
2955
			$plugins = get_option( 'active_plugins' );
2956
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2957
			$update  = false;
2958
			foreach ( $plugins as $i => $plugin ) {
2959
				if ( $plugin === $jetpack ) {
2960
					$plugins[$i] = false;
2961
					$update = true;
2962
				}
2963
			}
2964
2965
			if ( $update ) {
2966
				update_option( 'active_plugins', array_filter( $plugins ) );
2967
			}
2968
		}
2969
		exit;
2970
	}
2971
2972
	/**
2973
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2974
	 * @static
2975
	 */
2976
	public static function plugin_activation( $network_wide ) {
2977
		Jetpack_Options::update_option( 'activated', 1 );
2978
2979
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2980
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2981
		}
2982
2983
		if ( $network_wide )
2984
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2985
2986
		// For firing one-off events (notices) immediately after activation
2987
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2988
2989
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2990
2991
		Jetpack::plugin_initialize();
2992
	}
2993
2994
	public static function get_activation_source( $referer_url ) {
2995
2996
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2997
			return array( 'wp-cli', null );
2998
		}
2999
3000
		$referer = parse_url( $referer_url );
3001
3002
		$source_type = 'unknown';
3003
		$source_query = null;
3004
3005
		if ( ! is_array( $referer ) ) {
3006
			return array( $source_type, $source_query );
3007
		}
3008
3009
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3010
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3011
3012
		if ( isset( $referer['query'] ) ) {
3013
			parse_str( $referer['query'], $query_parts );
3014
		} else {
3015
			$query_parts = array();
3016
		}
3017
3018
		if ( $plugins_path === $referer['path'] ) {
3019
			$source_type = 'list';
3020
		} elseif ( $plugins_install_path === $referer['path'] ) {
3021
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3022
			switch( $tab ) {
3023
				case 'popular':
3024
					$source_type = 'popular';
3025
					break;
3026
				case 'recommended':
3027
					$source_type = 'recommended';
3028
					break;
3029
				case 'favorites':
3030
					$source_type = 'favorites';
3031
					break;
3032
				case 'search':
3033
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3034
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3035
					break;
3036
				default:
3037
					$source_type = 'featured';
3038
			}
3039
		}
3040
3041
		return array( $source_type, $source_query );
3042
	}
3043
3044
	/**
3045
	 * Runs before bumping version numbers up to a new version
3046
	 * @param  string $version    Version:timestamp
3047
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3048
	 * @return null              [description]
3049
	 */
3050
	public static function do_version_bump( $version, $old_version ) {
3051
		if ( ! $old_version ) { // For new sites
3052
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3053
		}
3054
	}
3055
3056
	/**
3057
	 * Sets the internal version number and activation state.
3058
	 * @static
3059
	 */
3060
	public static function plugin_initialize() {
3061
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3062
			Jetpack_Options::update_option( 'activated', 2 );
3063
		}
3064
3065 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3066
			$version = $old_version = JETPACK__VERSION . ':' . time();
3067
			/** This action is documented in class.jetpack.php */
3068
			do_action( 'updating_jetpack_version', $version, false );
3069
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3070
		}
3071
3072
		Jetpack::load_modules();
3073
3074
		Jetpack_Options::delete_option( 'do_activate' );
3075
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3076
	}
3077
3078
	/**
3079
	 * Removes all connection options
3080
	 * @static
3081
	 */
3082
	public static function plugin_deactivation( ) {
3083
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3084
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3085
			Jetpack_Network::init()->deactivate();
3086
		} else {
3087
			Jetpack::disconnect( false );
3088
			//Jetpack_Heartbeat::init()->deactivate();
3089
		}
3090
	}
3091
3092
	/**
3093
	 * Disconnects from the Jetpack servers.
3094
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3095
	 * @static
3096
	 */
3097
	public static function disconnect( $update_activated_state = true ) {
3098
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3099
		Jetpack::clean_nonces( true );
3100
3101
		// If the site is in an IDC because sync is not allowed,
3102
		// let's make sure to not disconnect the production site.
3103
		if ( ! self::validate_sync_error_idc_option() ) {
3104
			$tracking = new Tracking();
3105
			$tracking->record_user_event( 'disconnect_site', array() );
3106
			Jetpack::load_xml_rpc_client();
3107
			$xml = new Jetpack_IXR_Client();
3108
			$xml->query( 'jetpack.deregister' );
3109
		}
3110
3111
		Jetpack_Options::delete_option(
3112
			array(
3113
				'blog_token',
3114
				'user_token',
3115
				'user_tokens',
3116
				'master_user',
3117
				'time_diff',
3118
				'fallback_no_verify_ssl_certs',
3119
			)
3120
		);
3121
3122
		Jetpack_IDC::clear_all_idc_options();
3123
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3124
3125
		if ( $update_activated_state ) {
3126
			Jetpack_Options::update_option( 'activated', 4 );
3127
		}
3128
3129
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3130
			// Check then record unique disconnection if site has never been disconnected previously
3131
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3132
				$jetpack_unique_connection['disconnected'] = 1;
3133
			} else {
3134
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3135
					//track unique disconnect
3136
					$jetpack = Jetpack::init();
3137
3138
					$jetpack->stat( 'connections', 'unique-disconnect' );
3139
					$jetpack->do_stats( 'server_side' );
3140
				}
3141
				// increment number of times disconnected
3142
				$jetpack_unique_connection['disconnected'] += 1;
3143
			}
3144
3145
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3146
		}
3147
3148
		// Delete cached connected user data
3149
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3150
		delete_transient( $transient_key );
3151
3152
		// Delete all the sync related data. Since it could be taking up space.
3153
		Sender::get_instance()->uninstall();
3154
3155
		// Disable the Heartbeat cron
3156
		Jetpack_Heartbeat::init()->deactivate();
3157
	}
3158
3159
	/**
3160
	 * Unlinks the current user from the linked WordPress.com user
3161
	 */
3162
	public static function unlink_user( $user_id = null ) {
3163
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3164
			return false;
3165
3166
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3167
3168
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3169
			return false;
3170
3171
		if ( ! isset( $tokens[ $user_id ] ) )
3172
			return false;
3173
3174
		Jetpack::load_xml_rpc_client();
3175
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3176
		$xml->query( 'jetpack.unlink_user', $user_id );
3177
3178
		unset( $tokens[ $user_id ] );
3179
3180
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3181
3182
		/**
3183
		 * Fires after the current user has been unlinked from WordPress.com.
3184
		 *
3185
		 * @since 4.1.0
3186
		 *
3187
		 * @param int $user_id The current user's ID.
3188
		 */
3189
		do_action( 'jetpack_unlinked_user', $user_id );
3190
3191
		return true;
3192
	}
3193
3194
	/**
3195
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3196
	 */
3197
	public static function try_registration() {
3198
		// The user has agreed to the TOS at some point by now.
3199
		Jetpack_Options::update_option( 'tos_agreed', true );
3200
3201
		// Let's get some testing in beta versions and such.
3202
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3203
			// Before attempting to connect, let's make sure that the domains are viable.
3204
			$domains_to_check = array_unique( array(
3205
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3206
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3207
			) );
3208
			foreach ( $domains_to_check as $domain ) {
3209
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
It seems like $domain defined by $domain on line 3208 can also be of type false; however, Automattic\Jetpack\Conne...ger::is_usable_domain() does only seem to accept string, did you maybe forget to handle an error condition?

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

Consider the follow example

<?php

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

    return false;
}

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

Loading history...
3210
				if ( is_wp_error( $result ) ) {
3211
					return $result;
3212
				}
3213
			}
3214
		}
3215
3216
		$result = Jetpack::register();
3217
3218
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3219
		if ( ! $result || is_wp_error( $result ) ) {
3220
			return $result;
3221
		} else {
3222
			return true;
3223
		}
3224
	}
3225
3226
	/**
3227
	 * Tracking an internal event log. Try not to put too much chaff in here.
3228
	 *
3229
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3230
	 */
3231
	public static function log( $code, $data = null ) {
3232
		// only grab the latest 200 entries
3233
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3234
3235
		// Append our event to the log
3236
		$log_entry = array(
3237
			'time'    => time(),
3238
			'user_id' => get_current_user_id(),
3239
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3240
			'code'    => $code,
3241
		);
3242
		// Don't bother storing it unless we've got some.
3243
		if ( ! is_null( $data ) ) {
3244
			$log_entry['data'] = $data;
3245
		}
3246
		$log[] = $log_entry;
3247
3248
		// Try add_option first, to make sure it's not autoloaded.
3249
		// @todo: Add an add_option method to Jetpack_Options
3250
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3251
			Jetpack_Options::update_option( 'log', $log );
3252
		}
3253
3254
		/**
3255
		 * Fires when Jetpack logs an internal event.
3256
		 *
3257
		 * @since 3.0.0
3258
		 *
3259
		 * @param array $log_entry {
3260
		 *	Array of details about the log entry.
3261
		 *
3262
		 *	@param string time Time of the event.
3263
		 *	@param int user_id ID of the user who trigerred the event.
3264
		 *	@param int blog_id Jetpack Blog ID.
3265
		 *	@param string code Unique name for the event.
3266
		 *	@param string data Data about the event.
3267
		 * }
3268
		 */
3269
		do_action( 'jetpack_log_entry', $log_entry );
3270
	}
3271
3272
	/**
3273
	 * Get the internal event log.
3274
	 *
3275
	 * @param $event (string) - only return the specific log events
3276
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3277
	 *
3278
	 * @return array of log events || WP_Error for invalid params
3279
	 */
3280
	public static function get_log( $event = false, $num = false ) {
3281
		if ( $event && ! is_string( $event ) ) {
3282
			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...
3283
		}
3284
3285
		if ( $num && ! is_numeric( $num ) ) {
3286
			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...
3287
		}
3288
3289
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3290
3291
		// If nothing set - act as it did before, otherwise let's start customizing the output
3292
		if ( ! $num && ! $event ) {
3293
			return $entire_log;
3294
		} else {
3295
			$entire_log = array_reverse( $entire_log );
3296
		}
3297
3298
		$custom_log_output = array();
3299
3300
		if ( $event ) {
3301
			foreach ( $entire_log as $log_event ) {
3302
				if ( $event == $log_event[ 'code' ] ) {
3303
					$custom_log_output[] = $log_event;
3304
				}
3305
			}
3306
		} else {
3307
			$custom_log_output = $entire_log;
3308
		}
3309
3310
		if ( $num ) {
3311
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3312
		}
3313
3314
		return $custom_log_output;
3315
	}
3316
3317
	/**
3318
	 * Log modification of important settings.
3319
	 */
3320
	public static function log_settings_change( $option, $old_value, $value ) {
3321
		switch( $option ) {
3322
			case 'jetpack_sync_non_public_post_stati':
3323
				self::log( $option, $value );
3324
				break;
3325
		}
3326
	}
3327
3328
	/**
3329
	 * Return stat data for WPCOM sync
3330
	 */
3331
	public static function get_stat_data( $encode = true, $extended = true ) {
3332
		$data = Jetpack_Heartbeat::generate_stats_array();
3333
3334
		if ( $extended ) {
3335
			$additional_data = self::get_additional_stat_data();
3336
			$data = array_merge( $data, $additional_data );
3337
		}
3338
3339
		if ( $encode ) {
3340
			return json_encode( $data );
3341
		}
3342
3343
		return $data;
3344
	}
3345
3346
	/**
3347
	 * Get additional stat data to sync to WPCOM
3348
	 */
3349
	public static function get_additional_stat_data( $prefix = '' ) {
3350
		$return["{$prefix}themes"]         = Jetpack::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

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

Let’s take a look at an example:

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

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

    // do something with $myArray
}

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

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

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

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

$a = canBeFalseAndNull();

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

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
3919
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
3920
				}
3921
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3922
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3923
				exit;
3924
			case 'activate_default_modules' :
3925
				check_admin_referer( 'activate_default_modules' );
3926
				Jetpack::log( 'activate_default_modules' );
3927
				Jetpack::restate();
3928
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3929
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3930
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3931
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3932
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3933
				exit;
3934
			case 'disconnect' :
3935
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3936
					$error = 'cheatin';
3937
					break;
3938
				}
3939
3940
				check_admin_referer( 'jetpack-disconnect' );
3941
				Jetpack::log( 'disconnect' );
3942
				Jetpack::disconnect();
3943
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3944
				exit;
3945
			case 'reconnect' :
3946
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3947
					$error = 'cheatin';
3948
					break;
3949
				}
3950
3951
				check_admin_referer( 'jetpack-reconnect' );
3952
				Jetpack::log( 'reconnect' );
3953
				$this->disconnect();
3954
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3955
				exit;
3956 View Code Duplication
			case 'deactivate' :
3957
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3958
					$error = 'cheatin';
3959
					break;
3960
				}
3961
3962
				$modules = stripslashes( $_GET['module'] );
3963
				check_admin_referer( "jetpack_deactivate-$modules" );
3964
				foreach ( explode( ',', $modules ) as $module ) {
3965
					Jetpack::log( 'deactivate', $module );
3966
					Jetpack::deactivate_module( $module );
3967
					Jetpack::state( 'message', 'module_deactivated' );
3968
				}
3969
				Jetpack::state( 'module', $modules );
3970
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3971
				exit;
3972
			case 'unlink' :
3973
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3974
				check_admin_referer( 'jetpack-unlink' );
3975
				Jetpack::log( 'unlink' );
3976
				$this->unlink_user();
3977
				Jetpack::state( 'message', 'unlinked' );
3978
				if ( 'sub-unlink' == $redirect ) {
3979
					wp_safe_redirect( admin_url() );
3980
				} else {
3981
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3982
				}
3983
				exit;
3984
			case 'onboard' :
3985
				if ( ! current_user_can( 'manage_options' ) ) {
3986
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3987
				} else {
3988
					Jetpack::create_onboarding_token();
3989
					$url = $this->build_connect_url( true );
3990
3991
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
3992
						$url = add_query_arg( 'onboarding', $token, $url );
3993
					}
3994
3995
					$calypso_env = $this->get_calypso_env();
3996
					if ( ! empty( $calypso_env ) ) {
3997
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
3998
					}
3999
4000
					wp_redirect( $url );
4001
					exit;
4002
				}
4003
				exit;
4004
			default:
4005
				/**
4006
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4007
				 *
4008
				 * @since 2.6.0
4009
				 *
4010
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4011
				 */
4012
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4013
			}
4014
		}
4015
4016
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4017
			self::activate_new_modules( true );
4018
		}
4019
4020
		$message_code = Jetpack::state( 'message' );
4021
		if ( Jetpack::state( 'optin-manage' ) ) {
4022
			$activated_manage = $message_code;
4023
			$message_code = 'jetpack-manage';
4024
		}
4025
4026
		switch ( $message_code ) {
4027
		case 'jetpack-manage':
4028
			$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>';
4029
			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...
4030
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4031
			}
4032
			break;
4033
4034
		}
4035
4036
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4037
4038
		if ( ! empty( $deactivated_plugins ) ) {
4039
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4040
			$deactivated_titles  = array();
4041
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4042
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4043
					continue;
4044
				}
4045
4046
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4047
			}
4048
4049
			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...
4050
				if ( $this->message ) {
4051
					$this->message .= "<br /><br />\n";
4052
				}
4053
4054
				$this->message .= wp_sprintf(
4055
					_n(
4056
						'Jetpack contains the most recent version of the old %l plugin.',
4057
						'Jetpack contains the most recent versions of the old %l plugins.',
4058
						count( $deactivated_titles ),
4059
						'jetpack'
4060
					),
4061
					$deactivated_titles
4062
				);
4063
4064
				$this->message .= "<br />\n";
4065
4066
				$this->message .= _n(
4067
					'The old version has been deactivated and can be removed from your site.',
4068
					'The old versions have been deactivated and can be removed from your site.',
4069
					count( $deactivated_titles ),
4070
					'jetpack'
4071
				);
4072
			}
4073
		}
4074
4075
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4076
4077
		if ( $this->message || $this->error || $this->privacy_checks ) {
4078
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4079
		}
4080
4081
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4082
	}
4083
4084
	function admin_notices() {
4085
4086
		if ( $this->error ) {
4087
?>
4088
<div id="message" class="jetpack-message jetpack-err">
4089
	<div class="squeezer">
4090
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4091
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4092
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4093
<?php	endif; ?>
4094
	</div>
4095
</div>
4096
<?php
4097
		}
4098
4099
		if ( $this->message ) {
4100
?>
4101
<div id="message" class="jetpack-message">
4102
	<div class="squeezer">
4103
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4104
	</div>
4105
</div>
4106
<?php
4107
		}
4108
4109
		if ( $this->privacy_checks ) :
4110
			$module_names = $module_slugs = array();
4111
4112
			$privacy_checks = explode( ',', $this->privacy_checks );
4113
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4114
			foreach ( $privacy_checks as $module_slug ) {
4115
				$module = Jetpack::get_module( $module_slug );
4116
				if ( ! $module ) {
4117
					continue;
4118
				}
4119
4120
				$module_slugs[] = $module_slug;
4121
				$module_names[] = "<strong>{$module['name']}</strong>";
4122
			}
4123
4124
			$module_slugs = join( ',', $module_slugs );
4125
?>
4126
<div id="message" class="jetpack-message jetpack-err">
4127
	<div class="squeezer">
4128
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4129
		<p><?php
4130
			echo wp_kses(
4131
				wptexturize(
4132
					wp_sprintf(
4133
						_nx(
4134
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4135
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4136
							count( $privacy_checks ),
4137
							'%l = list of Jetpack module/feature names',
4138
							'jetpack'
4139
						),
4140
						$module_names
4141
					)
4142
				),
4143
				array( 'strong' => true )
4144
			);
4145
4146
			echo "\n<br />\n";
4147
4148
			echo wp_kses(
4149
				sprintf(
4150
					_nx(
4151
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4152
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4153
						count( $privacy_checks ),
4154
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4155
						'jetpack'
4156
					),
4157
					wp_nonce_url(
4158
						Jetpack::admin_url(
4159
							array(
4160
								'page'   => 'jetpack',
4161
								'action' => 'deactivate',
4162
								'module' => urlencode( $module_slugs ),
4163
							)
4164
						),
4165
						"jetpack_deactivate-$module_slugs"
4166
					),
4167
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4168
				),
4169
				array( 'a' => array( 'href' => true, 'title' => true ) )
4170
			);
4171
		?></p>
4172
	</div>
4173
</div>
4174
<?php endif;
4175
	}
4176
4177
	/**
4178
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4179
	 */
4180
	function stat( $group, $detail ) {
4181
		if ( ! isset( $this->stats[ $group ] ) )
4182
			$this->stats[ $group ] = array();
4183
		$this->stats[ $group ][] = $detail;
4184
	}
4185
4186
	/**
4187
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4188
	 */
4189
	function do_stats( $method = '' ) {
4190
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4191
			foreach ( $this->stats as $group => $stats ) {
4192
				if ( is_array( $stats ) && count( $stats ) ) {
4193
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4194
					if ( 'server_side' === $method ) {
4195
						self::do_server_side_stat( $args );
4196
					} else {
4197
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4198
					}
4199
				}
4200
				unset( $this->stats[ $group ] );
4201
			}
4202
		}
4203
	}
4204
4205
	/**
4206
	 * Runs stats code for a one-off, server-side.
4207
	 *
4208
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4209
	 *
4210
	 * @return bool If it worked.
4211
	 */
4212
	static function do_server_side_stat( $args ) {
4213
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4214
		if ( is_wp_error( $response ) )
4215
			return false;
4216
4217
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4218
			return false;
4219
4220
		return true;
4221
	}
4222
4223
	/**
4224
	 * Builds the stats url.
4225
	 *
4226
	 * @param $args array|string The arguments to append to the URL.
4227
	 *
4228
	 * @return string The URL to be pinged.
4229
	 */
4230
	static function build_stats_url( $args ) {
4231
		$defaults = array(
4232
			'v'    => 'wpcom2',
4233
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4234
		);
4235
		$args     = wp_parse_args( $args, $defaults );
4236
		/**
4237
		 * Filter the URL used as the Stats tracking pixel.
4238
		 *
4239
		 * @since 2.3.2
4240
		 *
4241
		 * @param string $url Base URL used as the Stats tracking pixel.
4242
		 */
4243
		$base_url = apply_filters(
4244
			'jetpack_stats_base_url',
4245
			'https://pixel.wp.com/g.gif'
4246
		);
4247
		$url      = add_query_arg( $args, $base_url );
4248
		return $url;
4249
	}
4250
4251
	static function translate_current_user_to_role() {
4252
		foreach ( self::$capability_translations as $role => $cap ) {
4253
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4254
				return $role;
4255
			}
4256
		}
4257
4258
		return false;
4259
	}
4260
4261
	static function translate_user_to_role( $user ) {
4262
		foreach ( self::$capability_translations as $role => $cap ) {
4263
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4264
				return $role;
4265
			}
4266
		}
4267
4268
		return false;
4269
    }
4270
4271
	static function translate_role_to_cap( $role ) {
4272
		if ( ! isset( self::$capability_translations[$role] ) ) {
4273
			return false;
4274
		}
4275
4276
		return self::$capability_translations[$role];
4277
	}
4278
4279
	static function sign_role( $role, $user_id = null ) {
4280
		if ( empty( $user_id ) ) {
4281
			$user_id = (int) get_current_user_id();
4282
		}
4283
4284
		if ( ! $user_id  ) {
4285
			return false;
4286
		}
4287
4288
		$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...
4289
		if ( ! $token || is_wp_error( $token ) ) {
4290
			return false;
4291
		}
4292
4293
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4294
	}
4295
4296
4297
	/**
4298
	 * Builds a URL to the Jetpack connection auth page
4299
	 *
4300
	 * @since 3.9.5
4301
	 *
4302
	 * @param bool $raw If true, URL will not be escaped.
4303
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4304
	 *                              If string, will be a custom redirect.
4305
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4306
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4307
	 *
4308
	 * @return string Connect URL
4309
	 */
4310
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4311
		$site_id = Jetpack_Options::get_option( 'id' );
4312
		$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...
4313
4314
		if ( $register || ! $blog_token || ! $site_id ) {
4315
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4316
4317
			if ( ! empty( $redirect ) ) {
4318
				$url = add_query_arg(
4319
					'redirect',
4320
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4321
					$url
4322
				);
4323
			}
4324
4325
			if( is_network_admin() ) {
4326
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4327
			}
4328
		} else {
4329
4330
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4331
			// because otherwise this logic can get us in to a loop.
4332
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4333
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4334
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4335
4336
				$response = Client::wpcom_json_api_request_as_blog(
4337
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4338
					'1.1'
4339
				);
4340
4341
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4342
4343
					// Generating a register URL instead to refresh the existing token
4344
					return $this->build_connect_url( $raw, $redirect, $from, true );
4345
				}
4346
			}
4347
4348
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4349
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4350
			}
4351
4352
			$role = self::translate_current_user_to_role();
4353
			$signed_role = self::sign_role( $role );
4354
4355
			$user = wp_get_current_user();
4356
4357
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4358
			$redirect = $redirect
4359
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4360
				: $jetpack_admin_page;
4361
4362
			if( isset( $_REQUEST['is_multisite'] ) ) {
4363
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4364
			}
4365
4366
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4367
4368
			/**
4369
			 * Filter the type of authorization.
4370
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4371
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4372
			 *
4373
			 * @since 4.3.3
4374
			 *
4375
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4376
			 */
4377
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4378
4379
4380
			$tracks = new Tracking();
4381
			$tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4382
4383
			$args = urlencode_deep(
4384
				array(
4385
					'response_type' => 'code',
4386
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4387
					'redirect_uri'  => add_query_arg(
4388
						array(
4389
							'action'   => 'authorize',
4390
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4391
							'redirect' => urlencode( $redirect ),
4392
						),
4393
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4394
					),
4395
					'state'         => $user->ID,
4396
					'scope'         => $signed_role,
4397
					'user_email'    => $user->user_email,
4398
					'user_login'    => $user->user_login,
4399
					'is_active'     => Jetpack::is_active(),
4400
					'jp_version'    => JETPACK__VERSION,
4401
					'auth_type'     => $auth_type,
4402
					'secret'        => $secrets['secret_1'],
4403
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4404
					'blogname'      => get_option( 'blogname' ),
4405
					'site_url'      => site_url(),
4406
					'home_url'      => home_url(),
4407
					'site_icon'     => get_site_icon_url(),
4408
					'site_lang'     => get_locale(),
4409
					'_ui'           => $tracks_identity['_ui'],
4410
					'_ut'           => $tracks_identity['_ut'],
4411
					'site_created'  => Jetpack::get_assumed_site_creation_date(),
4412
				)
4413
			);
4414
4415
			self::apply_activation_source_to_args( $args );
4416
4417
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4418
		}
4419
4420
		if ( $from ) {
4421
			$url = add_query_arg( 'from', $from, $url );
4422
		}
4423
4424
		// Ensure that class to get the affiliate code is loaded
4425
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4426
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4427
		}
4428
		// Get affiliate code and add it to the URL
4429
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4430
4431
		$calypso_env = $this->get_calypso_env();
4432
4433
		if ( ! empty( $calypso_env ) ) {
4434
			$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4435
		}
4436
4437
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4438
	}
4439
4440
	/**
4441
	 * Get our assumed site creation date.
4442
	 * Calculated based on the earlier date of either:
4443
	 * - Earliest admin user registration date.
4444
	 * - Earliest date of post of any post type.
4445
	 *
4446
	 * @since 7.2.0
4447
	 *
4448
	 * @return string Assumed site creation date and time.
4449
	 */
4450 View Code Duplication
	public static function get_assumed_site_creation_date() {
4451
		$earliest_registered_users = get_users( array(
4452
			'role'    => 'administrator',
4453
			'orderby' => 'user_registered',
4454
			'order'   => 'ASC',
4455
			'fields'  => array( 'user_registered' ),
4456
			'number'  => 1,
4457
		) );
4458
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
4459
4460
		$earliest_posts = get_posts( array(
4461
			'posts_per_page' => 1,
4462
			'post_type'      => 'any',
4463
			'post_status'    => 'any',
4464
			'orderby'        => 'date',
4465
			'order'          => 'ASC',
4466
		) );
4467
4468
		// If there are no posts at all, we'll count only on user registration date.
4469
		if ( $earliest_posts ) {
4470
			$earliest_post_date = $earliest_posts[0]->post_date;
4471
		} else {
4472
			$earliest_post_date = PHP_INT_MAX;
4473
		}
4474
4475
		return min( $earliest_registration_date, $earliest_post_date );
4476
	}
4477
4478 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4479
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4480
4481
		if ( $activation_source_name ) {
4482
			$args['_as'] = urlencode( $activation_source_name );
4483
		}
4484
4485
		if ( $activation_source_keyword ) {
4486
			$args['_ak'] = urlencode( $activation_source_keyword );
4487
		}
4488
	}
4489
4490
	function build_reconnect_url( $raw = false ) {
4491
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4492
		return $raw ? $url : esc_url( $url );
4493
	}
4494
4495
	public static function admin_url( $args = null ) {
4496
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4497
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4498
		return $url;
4499
	}
4500
4501
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4502
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4503
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4504
	}
4505
4506
	function dismiss_jetpack_notice() {
4507
4508
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4509
			return;
4510
		}
4511
4512
		switch( $_GET['jetpack-notice'] ) {
4513
			case 'dismiss':
4514
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4515
4516
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4517
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4518
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4519
				}
4520
				break;
4521
			case 'jetpack-protect-multisite-opt-out':
4522
4523
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4524
					// Don't show the banner again
4525
4526
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4527
					// redirect back to the page that had the notice
4528
					if ( wp_get_referer() ) {
4529
						wp_safe_redirect( wp_get_referer() );
4530
					} else {
4531
						// Take me to Jetpack
4532
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4533
					}
4534
				}
4535
				break;
4536
		}
4537
	}
4538
4539
	public static function sort_modules( $a, $b ) {
4540
		if ( $a['sort'] == $b['sort'] )
4541
			return 0;
4542
4543
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4544
	}
4545
4546
	function ajax_recheck_ssl() {
4547
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4548
		$result = Jetpack::permit_ssl( true );
4549
		wp_send_json( array(
4550
			'enabled' => $result,
4551
			'message' => get_transient( 'jetpack_https_test_message' )
4552
		) );
4553
	}
4554
4555
/* Client API */
4556
4557
	/**
4558
	 * Returns the requested Jetpack API URL
4559
	 *
4560
	 * @return string
4561
	 */
4562
	public static function api_url( $relative_url ) {
4563
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4564
	}
4565
4566
	/**
4567
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4568
	 */
4569
	public static function fix_url_for_bad_hosts( $url ) {
4570
		if ( 0 !== strpos( $url, 'https://' ) ) {
4571
			return $url;
4572
		}
4573
4574
		switch ( JETPACK_CLIENT__HTTPS ) {
4575
			case 'ALWAYS' :
4576
				return $url;
4577
			case 'NEVER' :
4578
				return set_url_scheme( $url, 'http' );
4579
			// default : case 'AUTO' :
4580
		}
4581
4582
		// we now return the unmodified SSL URL by default, as a security precaution
4583
		return $url;
4584
	}
4585
4586
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4587
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4588
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4589
			if ( ! empty( $_GET['onboarding'] ) ) {
4590
				$jpo = $_GET;
4591
			} else {
4592
				$jpo = json_decode( $request_data, true );
4593
			}
4594
4595
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4596
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4597
4598
			if (
4599
				isset( $jpo_user )
4600
				&& isset( $jpo_token )
4601
				&& is_email( $jpo_user )
4602
				&& ctype_alnum( $jpo_token )
4603
				&& isset( $_GET['rest_route'] )
4604
				&& self::validate_onboarding_token_action(
4605
					$jpo_token,
4606
					$_GET['rest_route']
4607
				)
4608
			) {
4609
				$jpUser = get_user_by( 'email', $jpo_user );
4610
				if ( is_a( $jpUser, 'WP_User' ) ) {
4611
					wp_set_current_user( $jpUser->ID );
4612
					$user_can = is_multisite()
4613
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4614
						: current_user_can( 'manage_options' );
4615
					if ( $user_can ) {
4616
						$token_type = 'user';
4617
						$token->external_user_id = $jpUser->ID;
4618
					}
4619
				}
4620
			}
4621
4622
			return array(
4623
				'type'      => $token_type,
0 ignored issues
show
The variable $token_type 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...
4624
				'token_key' => $token_key,
0 ignored issues
show
The variable $token_key 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...
4625
				'user_id'   => $token->external_user_id,
4626
			);
4627
		}
4628
4629
		return $token_data;
4630
	}
4631
4632
	/**
4633
	 * Create a random secret for validating onboarding payload
4634
	 *
4635
	 * @return string Secret token
4636
	 */
4637
	public static function create_onboarding_token() {
4638
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4639
			$token = wp_generate_password( 32, false );
4640
			Jetpack_Options::update_option( 'onboarding', $token );
4641
		}
4642
4643
		return $token;
4644
	}
4645
4646
	/**
4647
	 * Remove the onboarding token
4648
	 *
4649
	 * @return bool True on success, false on failure
4650
	 */
4651
	public static function invalidate_onboarding_token() {
4652
		return Jetpack_Options::delete_option( 'onboarding' );
4653
	}
4654
4655
	/**
4656
	 * Validate an onboarding token for a specific action
4657
	 *
4658
	 * @return boolean True if token/action pair is accepted, false if not
4659
	 */
4660
	public static function validate_onboarding_token_action( $token, $action ) {
4661
		// Compare tokens, bail if tokens do not match
4662
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4663
			return false;
4664
		}
4665
4666
		// List of valid actions we can take
4667
		$valid_actions = array(
4668
			'/jetpack/v4/settings',
4669
		);
4670
4671
		// Whitelist the action
4672
		if ( ! in_array( $action, $valid_actions ) ) {
4673
			return false;
4674
		}
4675
4676
		return true;
4677
	}
4678
4679
	/**
4680
	 * Checks to see if the URL is using SSL to connect with Jetpack
4681
	 *
4682
	 * @since 2.3.3
4683
	 * @return boolean
4684
	 */
4685
	public static function permit_ssl( $force_recheck = false ) {
4686
		// Do some fancy tests to see if ssl is being supported
4687
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4688
			$message = '';
4689
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4690
				$ssl = 0;
4691
			} else {
4692
				switch ( JETPACK_CLIENT__HTTPS ) {
4693
					case 'NEVER':
4694
						$ssl = 0;
4695
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4696
						break;
4697
					case 'ALWAYS':
4698
					case 'AUTO':
4699
					default:
4700
						$ssl = 1;
4701
						break;
4702
				}
4703
4704
				// If it's not 'NEVER', test to see
4705
				if ( $ssl ) {
4706
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4707
						$ssl = 0;
4708
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4709
					} else {
4710
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4711
						if ( is_wp_error( $response ) ) {
4712
							$ssl = 0;
4713
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4714
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4715
							$ssl = 0;
4716
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4717
						}
4718
					}
4719
				}
4720
			}
4721
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4722
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4723
		}
4724
4725
		return (bool) $ssl;
4726
	}
4727
4728
	/*
4729
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4730
	 */
4731
	public function alert_auto_ssl_fail() {
4732
		if ( ! current_user_can( 'manage_options' ) )
4733
			return;
4734
4735
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4736
		?>
4737
4738
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4739
			<div class="jp-banner__content">
4740
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4741
				<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>
4742
				<p>
4743
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4744
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4745
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4746
				</p>
4747
				<p>
4748
					<?php printf( __( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
4749
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4750
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4751
				</p>
4752
			</div>
4753
		</div>
4754
		<style>
4755
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4756
		</style>
4757
		<script type="text/javascript">
4758
			jQuery( document ).ready( function( $ ) {
4759
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4760
					var $this = $( this );
4761
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4762
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4763
					e.preventDefault();
4764
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4765
					$.post( ajaxurl, data )
4766
					  .done( function( response ) {
4767
					  	if ( response.enabled ) {
4768
					  		$( '#jetpack-ssl-warning' ).hide();
4769
					  	} else {
4770
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4771
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4772
					  	}
4773
					  }.bind( $this ) );
4774
				} );
4775
			} );
4776
		</script>
4777
4778
		<?php
4779
	}
4780
4781
	/**
4782
	 * Returns the Jetpack XML-RPC API
4783
	 *
4784
	 * @return string
4785
	 */
4786
	public static function xmlrpc_api_url() {
4787
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4788
		return untrailingslashit( $base ) . '/xmlrpc.php';
4789
	}
4790
4791
	public static function connection() {
4792
		return self::init()->connection_manager;
4793
	}
4794
4795
	/**
4796
	 * Creates two secret tokens and the end of life timestamp for them.
4797
	 *
4798
	 * Note these tokens are unique per call, NOT static per site for connecting.
4799
	 *
4800
	 * @since 2.6
4801
	 * @return array
4802
	 */
4803
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4804
		if ( false === $user_id ) {
4805
			$user_id = get_current_user_id();
4806
		}
4807
4808
		return self::connection()->generate_secrets( $action, $user_id, $exp );
4809
	}
4810
4811
	public static function get_secrets( $action, $user_id ) {
4812
		$secrets = self::connection()->get_secrets( $action, $user_id );
4813
4814
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
4815
			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...
4816
		}
4817
4818
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
4819
			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...
4820
		}
4821
4822
		return $secrets;
4823
	}
4824
4825
	/**
4826
	 * @deprecated 7.5 Use Connection_Manager instead.
4827
	 *
4828
	 * @param $action
4829
	 * @param $user_id
4830
	 */
4831
	public static function delete_secrets( $action, $user_id ) {
4832
		return self::connection()->delete_secrets( $action, $user_id );
4833
	}
4834
4835
	/**
4836
	 * Builds the timeout limit for queries talking with the wpcom servers.
4837
	 *
4838
	 * Based on local php max_execution_time in php.ini
4839
	 *
4840
	 * @since 2.6
4841
	 * @return int
4842
	 * @deprecated
4843
	 **/
4844
	public function get_remote_query_timeout_limit() {
4845
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4846
		return Jetpack::get_max_execution_time();
4847
	}
4848
4849
	/**
4850
	 * Builds the timeout limit for queries talking with the wpcom servers.
4851
	 *
4852
	 * Based on local php max_execution_time in php.ini
4853
	 *
4854
	 * @since 5.4
4855
	 * @return int
4856
	 **/
4857
	public static function get_max_execution_time() {
4858
		$timeout = (int) ini_get( 'max_execution_time' );
4859
4860
		// Ensure exec time set in php.ini
4861
		if ( ! $timeout ) {
4862
			$timeout = 30;
4863
		}
4864
		return $timeout;
4865
	}
4866
4867
	/**
4868
	 * Sets a minimum request timeout, and returns the current timeout
4869
	 *
4870
	 * @since 5.4
4871
	 **/
4872 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
4873
		$timeout = self::get_max_execution_time();
4874
		if ( $timeout < $min_timeout ) {
4875
			$timeout = $min_timeout;
4876
			set_time_limit( $timeout );
4877
		}
4878
		return $timeout;
4879
	}
4880
4881
4882
	/**
4883
	 * Takes the response from the Jetpack register new site endpoint and
4884
	 * verifies it worked properly.
4885
	 *
4886
	 * @since 2.6
4887
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4888
	 **/
4889
	public function validate_remote_register_response( $response ) {
4890
	  if ( is_wp_error( $response ) ) {
4891
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'register_http_request_failed'.

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...
4892
		}
4893
4894
		$code   = wp_remote_retrieve_response_code( $response );
4895
		$entity = wp_remote_retrieve_body( $response );
4896
		if ( $entity )
4897
			$registration_response = json_decode( $entity );
4898
		else
4899
			$registration_response = false;
4900
4901
		$code_type = intval( $code / 100 );
4902
		if ( 5 == $code_type ) {
4903
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'wpcom_5??'.

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...
4904
		} elseif ( 408 == $code ) {
4905
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'wpcom_408'.

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...
4906
		} elseif ( ! empty( $registration_response->error ) ) {
4907
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4908
				$error_description = __( "PHP's XML extension is not available. Jetpack requires the XML extension to communicate with WordPress.com. Please contact your hosting provider to enable PHP's XML extension.", 'jetpack' );
4909
			} else {
4910
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4911
			}
4912
4913
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with (string) $registration_response->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...
4914
		} elseif ( 200 != $code ) {
4915
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'wpcom_bad_response'.

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...
4916
		}
4917
4918
		// Jetpack ID error block
4919 View Code Duplication
		if ( empty( $registration_response->jetpack_id ) ) {
4920
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'jetpack_id'.

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...
4921
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4922
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'jetpack_id'.

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...
4923
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4924
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'jetpack_id'.

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...
4925
		}
4926
4927
	    return $registration_response;
4928
	}
4929
	/**
4930
	 * @return bool|WP_Error
4931
	 */
4932
	public static function register() {
4933
		$tracking = new Tracking();
4934
		$tracking->record_user_event( 'jpc_register_begin' );
4935
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4936
		$secrets = Jetpack::generate_secrets( 'register' );
4937
4938 View Code Duplication
		if (
4939
			empty( $secrets['secret_1'] ) ||
4940
			empty( $secrets['secret_2'] ) ||
4941
			empty( $secrets['exp'] )
4942
		) {
4943
			return new Jetpack_Error( 'missing_secrets' );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_secrets'.

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...
4944
		}
4945
4946
		// better to try (and fail) to set a higher timeout than this system
4947
		// supports than to have register fail for more users than it should
4948
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
4949
4950
		$gmt_offset = get_option( 'gmt_offset' );
4951
		if ( ! $gmt_offset ) {
4952
			$gmt_offset = 0;
4953
		}
4954
4955
		$stats_options = get_option( 'stats_options' );
4956
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4957
4958
		$tracks = new Tracking();
4959
		$tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4960
4961
		$args = array(
4962
			'method'  => 'POST',
4963
			'body'    => array(
4964
				'siteurl'         => site_url(),
4965
				'home'            => home_url(),
4966
				'gmt_offset'      => $gmt_offset,
4967
				'timezone_string' => (string) get_option( 'timezone_string' ),
4968
				'site_name'       => (string) get_option( 'blogname' ),
4969
				'secret_1'        => $secrets['secret_1'],
4970
				'secret_2'        => $secrets['secret_2'],
4971
				'site_lang'       => get_locale(),
4972
				'timeout'         => $timeout,
4973
				'stats_id'        => $stats_id,
4974
				'state'           => get_current_user_id(),
4975
				'_ui'             => $tracks_identity['_ui'],
4976
				'_ut'             => $tracks_identity['_ut'],
4977
				'site_created'    => Jetpack::get_assumed_site_creation_date(),
4978
				'jetpack_version' => JETPACK__VERSION
4979
			),
4980
			'headers' => array(
4981
				'Accept' => 'application/json',
4982
			),
4983
			'timeout' => $timeout,
4984
		);
4985
4986
		self::apply_activation_source_to_args( $args['body'] );
4987
4988
		$response = Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4989
4990
		// Make sure the response is valid and does not contain any Jetpack errors
4991
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4992
		if ( is_wp_error( $registration_details ) ) {
4993
			return $registration_details;
4994
		} elseif ( ! $registration_details ) {
4995
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
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...
4996
		}
4997
4998 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4999
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'jetpack_secret'.

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...
5000
		}
5001
5002
		if ( isset( $registration_details->jetpack_public ) ) {
5003
			$jetpack_public = (int) $registration_details->jetpack_public;
5004
		} else {
5005
			$jetpack_public = false;
5006
		}
5007
5008
		Jetpack_Options::update_options(
5009
			array(
5010
				'id'         => (int)    $registration_details->jetpack_id,
5011
				'blog_token' => (string) $registration_details->jetpack_secret,
5012
				'public'     => $jetpack_public,
5013
			)
5014
		);
5015
5016
		/**
5017
		 * Fires when a site is registered on WordPress.com.
5018
		 *
5019
		 * @since 3.7.0
5020
		 *
5021
		 * @param int $json->jetpack_id Jetpack Blog ID.
5022
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5023
		 * @param int|bool $jetpack_public Is the site public.
5024
		 */
5025
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5026
5027
		// Initialize Jump Start for the first and only time.
5028
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5029
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5030
5031
			$jetpack = Jetpack::init();
5032
5033
			$jetpack->stat( 'jumpstart', 'unique-views' );
5034
			$jetpack->do_stats( 'server_side' );
5035
		};
5036
5037
		return true;
5038
	}
5039
5040
	/**
5041
	 * If the db version is showing something other that what we've got now, bump it to current.
5042
	 *
5043
	 * @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...
5044
	 */
5045
	public static function maybe_set_version_option() {
5046
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5047
		if ( JETPACK__VERSION != $version ) {
5048
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5049
5050
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5051
				/** This action is documented in class.jetpack.php */
5052
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5053
			}
5054
5055
			return true;
5056
		}
5057
		return false;
5058
	}
5059
5060
/* Client Server API */
5061
5062
	/**
5063
	 * Loads the Jetpack XML-RPC client
5064
	 */
5065
	public static function load_xml_rpc_client() {
5066
		require_once ABSPATH . WPINC . '/class-IXR.php';
5067
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5068
	}
5069
5070
	/**
5071
	 * Resets the saved authentication state in between testing requests.
5072
	 */
5073
	public function reset_saved_auth_state() {
5074
		$this->xmlrpc_verification = null;
5075
		$this->rest_authentication_status = null;
5076
	}
5077
5078
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5079
	// Uses the existing XMLRPC request signing implementation.
5080
	function wp_rest_authenticate( $user ) {
5081
		if ( ! empty( $user ) ) {
5082
			// Another authentication method is in effect.
5083
			return $user;
5084
		}
5085
5086
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5087
			// Nothing to do for this authentication method.
5088
			return null;
5089
		}
5090
5091
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5092
			// Nothing to do for this authentication method.
5093
			return null;
5094
		}
5095
5096
		// Ensure that we always have the request body available.  At this
5097
		// point, the WP REST API code to determine the request body has not
5098
		// run yet.  That code may try to read from 'php://input' later, but
5099
		// this can only be done once per request in PHP versions prior to 5.6.
5100
		// So we will go ahead and perform this read now if needed, and save
5101
		// the request body where both the Jetpack signature verification code
5102
		// and the WP REST API code can see it.
5103
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5104
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5105
		}
5106
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5107
5108
		// Only support specific request parameters that have been tested and
5109
		// are known to work with signature verification.  A different method
5110
		// can be passed to the WP REST API via the '?_method=' parameter if
5111
		// needed.
5112
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5113
			$this->rest_authentication_status = new WP_Error(
5114
				'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...
5115
				__( 'This request method is not supported.', 'jetpack' ),
5116
				array( 'status' => 400 )
5117
			);
5118
			return null;
5119
		}
5120
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5121
			$this->rest_authentication_status = new WP_Error(
5122
				'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...
5123
				__( 'This request method does not support body parameters.', 'jetpack' ),
5124
				array( 'status' => 400 )
5125
			);
5126
			return null;
5127
		}
5128
5129
		$verified = $this->verify_xml_rpc_signature();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack::verify_xml_rpc_signature() has been deprecated with message: use Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
6786
		} else {
6787
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
6788
		}
6789
6790
		// Since this is a fresh connection, be sure to clear out IDC options
6791
		Jetpack_IDC::clear_all_idc_options();
6792
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
6793
6794
		// Start nonce cleaner
6795
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
6796
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
6797
6798
		if ( $send_state_messages ) {
6799
			Jetpack::state( 'message', 'authorized' );
6800
		}
6801
	}
6802
6803
	/**
6804
	 * Returns a boolean for whether backups UI should be displayed or not.
6805
	 *
6806
	 * @return bool Should backups UI be displayed?
6807
	 */
6808
	public static function show_backups_ui() {
6809
		/**
6810
		 * Whether UI for backups should be displayed.
6811
		 *
6812
		 * @since 6.5.0
6813
		 *
6814
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
6815
		 */
6816
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
6817
	}
6818
6819
	/*
6820
	 * Deprecated manage functions
6821
	 */
6822
	function prepare_manage_jetpack_notice() {
6823
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6824
	}
6825
	function manage_activate_screen() {
6826
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6827
	}
6828
	function admin_jetpack_manage_notice() {
6829
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6830
	}
6831
	function opt_out_jetpack_manage_url() {
6832
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6833
	}
6834
	function opt_in_jetpack_manage_url() {
6835
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6836
	}
6837
	function opt_in_jetpack_manage_notice() {
6838
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6839
	}
6840
	function can_display_jetpack_manage_notice() {
6841
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
6842
	}
6843
6844
	/**
6845
	 * Clean leftoveruser meta.
6846
	 *
6847
	 * Delete Jetpack-related user meta when it is no longer needed.
6848
	 *
6849
	 * @since 7.3.0
6850
	 *
6851
	 * @param int $user_id User ID being updated.
6852
	 */
6853
	public static function user_meta_cleanup( $user_id ) {
6854
		$meta_keys = array(
6855
			// AtD removed from Jetpack 7.3
6856
			'AtD_options',
6857
			'AtD_check_when',
6858
			'AtD_guess_lang',
6859
			'AtD_ignored_phrases',
6860
		);
6861
6862
		foreach ( $meta_keys as $meta_key ) {
6863
			if ( get_user_meta( $user_id, $meta_key ) ) {
6864
				delete_user_meta( $user_id, $meta_key );
6865
			}
6866
		}
6867
	}
6868
6869
	function is_active_and_not_development_mode( $maybe ) {
6870
		if ( ! \Jetpack::is_active() || \Jetpack::is_development_mode() ) {
6871
			return false;
6872
		}
6873
		return true;
6874
	}
6875
6876
	/**
6877
	 * @deprecated use Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature
6878
	 */
6879
	public static function verify_xml_rpc_signature() {
6880
		return self::connection()->verify_xml_rpc_signature();
6881
	}
6882
}
6883