Completed
Push — fix/protect-math-fallback-text ( 3d091a...354abb )
by
unknown
08:00
created

Jetpack::upload_handler()   F

Complexity

Conditions 24
Paths 383

Size

Total Lines 122

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 24
nc 383
nop 1
dl 0
loc 122
rs 0.8366
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css
37
	 */
38
	public $concatenated_style_handles = array(
39
		'jetpack-carousel',
40
		'grunion.css',
41
		'the-neverending-homepage',
42
		'jetpack_likes',
43
		'jetpack_related-posts',
44
		'sharedaddy',
45
		'jetpack-slideshow',
46
		'presentations',
47
		'jetpack-subscriptions',
48
		'jetpack-responsive-videos-style',
49
		'jetpack-social-menu',
50
		'tiled-gallery',
51
		'jetpack_display_posts_widget',
52
		'gravatar-profile-widget',
53
		'goodreads-widget',
54
		'jetpack_social_media_icons_widget',
55
		'jetpack-top-posts-widget',
56
		'jetpack_image_widget',
57
		'jetpack-my-community-widget',
58
		'wordads',
59
		'eu-cookie-law-style',
60
		'flickr-widget-style',
61
		'jetpack-search-widget',
62
		'jetpack-simple-payments-widget-style',
63
	);
64
65
	/**
66
	 * Contains all assets that have had their URL rewritten to minified versions.
67
	 *
68
	 * @var array
69
	 */
70
	static $min_assets = array();
71
72
	public $plugins_to_deactivate = array(
73
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
74
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
75
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
76
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
77
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
78
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
79
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
80
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
81
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
82
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
83
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
84
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
85
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
86
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
87
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
88
	);
89
90
	static $capability_translations = array(
91
		'administrator' => 'manage_options',
92
		'editor'        => 'edit_others_posts',
93
		'author'        => 'publish_posts',
94
		'contributor'   => 'edit_posts',
95
		'subscriber'    => 'read',
96
	);
97
98
	/**
99
	 * Map of modules that have conflicts with plugins and should not be auto-activated
100
	 * if the plugins are active.  Used by filter_default_modules
101
	 *
102
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
103
	 * change `module-slug` and add this to your plugin:
104
	 *
105
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
106
	 * function my_jetpack_get_default_modules( $modules ) {
107
	 *     return array_diff( $modules, array( 'module-slug' ) );
108
	 * }
109
	 *
110
	 * @var array
111
	 */
112
	private $conflicting_plugins = array(
113
		'comments'          => array(
114
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
115
			'Disqus'                               => 'disqus-comment-system/disqus.php',
116
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
117
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
118
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
119
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
120
		),
121
		'comment-likes' => array(
122
			'Epoch'                                => 'epoch/plugincore.php',
123
		),
124
		'contact-form'      => array(
125
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
126
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
127
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
128
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
129
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
130
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
131
		),
132
		'minileven'         => array(
133
			'WPtouch'                              => 'wptouch/wptouch.php',
134
		),
135
		'latex'             => array(
136
			'LaTeX for WordPress'                  => 'latex/latex.php',
137
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
138
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
139
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
140
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
141
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
142
		),
143
		'protect'           => array(
144
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
145
			'Captcha'                              => 'captcha/captcha.php',
146
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
147
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
148
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
149
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
150
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
151
			'Security-protection'                  => 'security-protection/security-protection.php',
152
			'Login Security'                       => 'login-security/login-security.php',
153
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
154
			'Wordfence Security'                   => 'wordfence/wordfence.php',
155
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
156
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
157
		),
158
		'random-redirect'   => array(
159
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
160
		),
161
		'related-posts'     => array(
162
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
163
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
164
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
165
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
166
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
167
			'outbrain'                             => 'outbrain/outbrain.php',
168
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
169
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
170
		),
171
		'sharedaddy'        => array(
172
			'AddThis'                              => 'addthis/addthis_social_widget.php',
173
			'Add To Any'                           => 'add-to-any/add-to-any.php',
174
			'ShareThis'                            => 'share-this/sharethis.php',
175
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
176
		),
177
		'seo-tools' => array(
178
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
179
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
180
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
181
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
182
			'The SEO Framework'                    => 'autodescription/autodescription.php',
183
		),
184
		'verification-tools' => array(
185
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
186
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
187
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
188
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
189
			'The SEO Framework'                    => 'autodescription/autodescription.php',
190
		),
191
		'widget-visibility' => array(
192
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
193
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
194
		),
195
		'sitemaps' => array(
196
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
197
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
198
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
199
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
200
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
201
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
202
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
203
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
204
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
205
			'The SEO Framework'                    => 'autodescription/autodescription.php',
206
			'Sitemap'                              => 'sitemap/sitemap.php',
207
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
208
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
209
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
210
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
211
		),
212
		'lazy-images' => array(
213
			'Lazy Load'              => 'lazy-load/lazy-load.php',
214
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
215
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
216
		),
217
	);
218
219
	/**
220
	 * Plugins for which we turn off our Facebook OG Tags implementation.
221
	 *
222
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
223
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
224
	 *
225
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
226
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
227
	 */
228
	private $open_graph_conflicting_plugins = array(
229
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
230
		                                                         // 2 Click Social Media Buttons
231
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
232
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
233
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
234
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
235
		                                                         // Open Graph Meta Tags by Heateor
236
		'facebook/facebook.php',                                 // Facebook (official plugin)
237
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
238
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
239
		                                                         // Facebook Featured Image & OG Meta Tags
240
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
241
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
242
		                                                         // Facebook Open Graph Meta Tags for WordPress
243
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
244
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
245
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
246
		                                                         // Fedmich's Facebook Open Graph Meta
247
		'network-publisher/networkpub.php',                      // Network Publisher
248
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
249
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
250
		                                                         // NextScripts SNAP
251
		'og-tags/og-tags.php',                                   // OG Tags
252
		'opengraph/opengraph.php',                               // Open Graph
253
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
254
		                                                         // Open Graph Protocol Framework
255
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
256
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
257
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
258
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
259
		'sharepress/sharepress.php',                             // SharePress
260
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
261
		'social-discussions/social-discussions.php',             // Social Discussions
262
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
263
		'socialize/socialize.php',                               // Socialize
264
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
265
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
266
		                                                         // Tweet, Like, Google +1 and Share
267
		'wordbooker/wordbooker.php',                             // Wordbooker
268
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
269
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
270
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
271
		                                                         // WP Facebook Like Send & Open Graph Meta
272
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
273
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
274
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
275
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
276
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
277
	);
278
279
	/**
280
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
281
	 */
282
	private $twitter_cards_conflicting_plugins = array(
283
	//	'twitter/twitter.php',                       // The official one handles this on its own.
284
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
285
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
286
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
287
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
288
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
289
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
290
		'twitter-cards/twitter-cards.php',           // Twitter Cards
291
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
292
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
293
	);
294
295
	/**
296
	 * Message to display in admin_notice
297
	 * @var string
298
	 */
299
	public $message = '';
300
301
	/**
302
	 * Error to display in admin_notice
303
	 * @var string
304
	 */
305
	public $error = '';
306
307
	/**
308
	 * Modules that need more privacy description.
309
	 * @var string
310
	 */
311
	public $privacy_checks = '';
312
313
	/**
314
	 * Stats to record once the page loads
315
	 *
316
	 * @var array
317
	 */
318
	public $stats = array();
319
320
	/**
321
	 * Jetpack_Sync object
322
	 */
323
	public $sync;
324
325
	/**
326
	 * Verified data for JSON authorization request
327
	 */
328
	public $json_api_authorization_request = array();
329
330
	/**
331
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
332
	 */
333
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
334
335
	/**
336
	 * Holds the singleton instance of this class
337
	 * @since 2.3.3
338
	 * @var Jetpack
339
	 */
340
	static $instance = false;
341
342
	/**
343
	 * Singleton
344
	 * @static
345
	 */
346
	public static function init() {
347
		if ( ! self::$instance ) {
348
			self::$instance = new Jetpack;
349
350
			self::$instance->plugin_upgrade();
351
		}
352
353
		return self::$instance;
354
	}
355
356
	/**
357
	 * Must never be called statically
358
	 */
359
	function plugin_upgrade() {
360
		if ( Jetpack::is_active() ) {
361
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
362
			if ( JETPACK__VERSION != $version ) {
363
				// Prevent multiple upgrades at once - only a single process should trigger
364
				// an upgrade to avoid stampedes
365
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
366
					return;
367
				}
368
369
				// Set a short lock to prevent multiple instances of the upgrade
370
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
371
372
				// check which active modules actually exist and remove others from active_modules list
373
				$unfiltered_modules = Jetpack::get_active_modules();
374
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
375
				if ( array_diff( $unfiltered_modules, $modules ) ) {
376
					Jetpack::update_active_modules( $modules );
377
				}
378
379
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
380
381
				// Upgrade to 4.3.0
382
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
383
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
384
				}
385
386
				// Make sure Markdown for posts gets turned back on
387
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
388
					update_option( 'wpcom_publish_posts_with_markdown', true );
389
				}
390
391
				if ( did_action( 'wp_loaded' ) ) {
392
					self::upgrade_on_load();
393
				} else {
394
					add_action(
395
						'wp_loaded',
396
						array( __CLASS__, 'upgrade_on_load' )
397
					);
398
				}
399
			}
400
		}
401
	}
402
403
	/**
404
	 * Runs upgrade routines that need to have modules loaded.
405
	 */
406
	static function upgrade_on_load() {
407
408
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
409
		// This can happen in case Jetpack has been just upgraded and is
410
		// being initialized late during the page load. In this case we wait
411
		// until the next proper admin page load with Jetpack active.
412
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
413
			delete_transient( self::$plugin_upgrade_lock_key );
414
415
			return;
416
		}
417
418
		Jetpack::maybe_set_version_option();
419
420
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
421
			Jetpack_Widget_Conditions::migrate_post_type_rules();
422
		}
423
424
		if (
425
			class_exists( 'Jetpack_Sitemap_Manager' )
426
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
427
		) {
428
			do_action( 'jetpack_sitemaps_purge_data' );
429
		}
430
431
		delete_transient( self::$plugin_upgrade_lock_key );
432
	}
433
434
	static function activate_manage( ) {
435
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
436
			self::activate_module( 'manage', false, false );
437
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
438
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
439
		}
440
	}
441
442
	static function update_active_modules( $modules ) {
443
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
444
445
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
446
447
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
448
			$new_active_modules = array_diff( $modules, $current_modules );
449
			foreach( $new_active_modules as $module ) {
450
				/**
451
				 * Fires when a specific module is activated.
452
				 *
453
				 * @since 1.9.0
454
				 *
455
				 * @param string $module Module slug.
456
				 * @param boolean $success whether the module was activated. @since 4.2
457
				 */
458
				do_action( 'jetpack_activate_module', $module, $success );
459
460
				/**
461
				 * Fires when a module is activated.
462
				 * The dynamic part of the filter, $module, is the module slug.
463
				 *
464
				 * @since 1.9.0
465
				 *
466
				 * @param string $module Module slug.
467
				 */
468
				do_action( "jetpack_activate_module_$module", $module );
469
			}
470
471
			$new_deactive_modules = array_diff( $current_modules, $modules );
472
			foreach( $new_deactive_modules as $module ) {
473
				/**
474
				 * Fired after a module has been deactivated.
475
				 *
476
				 * @since 4.2.0
477
				 *
478
				 * @param string $module Module slug.
479
				 * @param boolean $success whether the module was deactivated.
480
				 */
481
				do_action( 'jetpack_deactivate_module', $module, $success );
482
				/**
483
				 * Fires when a module is deactivated.
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_deactivate_module_$module", $module );
491
			}
492
		}
493
494
		return $success;
495
	}
496
497
	static function delete_active_modules() {
498
		self::update_active_modules( array() );
499
	}
500
501
	/**
502
	 * Constructor.  Initializes WordPress hooks
503
	 */
504
	private function __construct() {
505
		/*
506
		 * Check for and alert any deprecated hooks
507
		 */
508
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
509
510
		/*
511
		 * Enable enhanced handling of previewing sites in Calypso
512
		 */
513
		if ( Jetpack::is_active() ) {
514
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
515
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
516
		}
517
518
		/*
519
		 * Load things that should only be in Network Admin.
520
		 *
521
		 * For now blow away everything else until a more full
522
		 * understanding of what is needed at the network level is
523
		 * available
524
		 */
525
		if( is_multisite() ) {
526
			Jetpack_Network::init();
527
		}
528
529
		// Load Gutenberg editor blocks
530
		add_action( 'init', array( $this, 'load_jetpack_gutenberg' ) );
531
532
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
533
534
		// Unlink user before deleting the user from .com
535
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
536
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
537
538
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
539
			@ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
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...
540
541
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
542
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
543
544
			$this->require_jetpack_authentication();
545
546
			if ( Jetpack::is_active() ) {
547
				// Hack to preserve $HTTP_RAW_POST_DATA
548
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
549
550
				$signed = $this->verify_xml_rpc_signature();
551 View Code Duplication
				if ( $signed && ! is_wp_error( $signed ) ) {
552
					// The actual API methods.
553
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
554
				} else {
555
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
556
					// active Jetpack connection, so that additional users can link their account.
557
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
558
				}
559 View Code Duplication
			} else {
560
				// The bootstrap API methods.
561
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
562
				$signed = $this->verify_xml_rpc_signature();
563
				if ( $signed && ! is_wp_error( $signed ) ) {
564
					// the jetpack Provision method is available for blog-token-signed requests
565
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
566
				}
567
			}
568
569
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
570
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
571
		} elseif (
572
			is_admin() &&
573
			isset( $_POST['action'] ) && (
574
				'jetpack_upload_file' == $_POST['action'] ||
575
				'jetpack_update_file' == $_POST['action']
576
			)
577
		) {
578
			$this->require_jetpack_authentication();
579
			$this->add_remote_request_handlers();
580
		} else {
581
			if ( Jetpack::is_active() ) {
582
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
583
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
584
			}
585
		}
586
587
		if ( Jetpack::is_active() ) {
588
			Jetpack_Heartbeat::init();
589
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
590
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
591
				Jetpack_Search_Performance_Logger::init();
592
			}
593
		}
594
595
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
596
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
597
598
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
599
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
600
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
601
		}
602
603
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
604
605
		add_action( 'admin_init', array( $this, 'admin_init' ) );
606
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
607
608
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
609
610
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
611
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
612
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
613
614
		// returns HTTPS support status
615
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
616
617
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
618
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
619
620
		// JITM AJAX callback function
621
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
622
623
		// Universal ajax callback for all tracking events triggered via js
624
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
625
626
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
627
628
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
629
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
630
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
631
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
632
633
		// gutenberg locale
634
		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_gutenberg_locale' ) );
635
636
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
637
638
		/**
639
		 * These actions run checks to load additional files.
640
		 * They check for external files or plugins, so they need to run as late as possible.
641
		 */
642
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
643
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
644
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
645
646
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
647
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
648
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
649
650
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
651
652
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
653
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
654
655
		// A filter to control all just in time messages
656
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
657
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
658
659
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
660
		// We should make sure to only do this for front end links.
661
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
662
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
663
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
664
665
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
666
			//so they point moderation links on emails to Calypso
667
			jetpack_require_lib( 'functions.wp-notify' );
668
		}
669
670
		// Update the Jetpack plan from API on heartbeats
671
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
672
673
		/**
674
		 * This is the hack to concatenate all css files into one.
675
		 * For description and reasoning see the implode_frontend_css method
676
		 *
677
		 * Super late priority so we catch all the registered styles
678
		 */
679
		if( !is_admin() ) {
680
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
681
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
682
		}
683
684
		/**
685
		 * These are sync actions that we need to keep track of for jitms
686
		 */
687
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
688
689
		// Actually push the stats on shutdown.
690
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
691
			add_action( 'shutdown', array( $this, 'push_stats' ) );
692
		}
693
	}
694
695
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
696
		$post = get_post( $post_id );
697
698
		if ( empty( $post ) ) {
699
			return $default_url;
700
		}
701
702
		$post_type = $post->post_type;
703
704
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
705
		// https://en.support.wordpress.com/custom-post-types/
706
		$allowed_post_types = array(
707
			'post' => 'post',
708
			'page' => 'page',
709
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
710
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
711
		);
712
713
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
714
			return $default_url;
715
		}
716
717
		$path_prefix = $allowed_post_types[ $post_type ];
718
719
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
720
721
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
722
	}
723
724
	function point_edit_comment_links_to_calypso( $url ) {
725
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
726
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

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

Loading history...
727
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
728
			Jetpack::build_raw_urls( get_home_url() ),
729
			$query_args['amp;c']
730
		) );
731
	}
732
733
	function jetpack_track_last_sync_callback( $params ) {
734
		/**
735
		 * Filter to turn off jitm caching
736
		 *
737
		 * @since 5.4.0
738
		 *
739
		 * @param bool false Whether to cache just in time messages
740
		 */
741
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
742
			return $params;
743
		}
744
745
		if ( is_array( $params ) && isset( $params[0] ) ) {
746
			$option = $params[0];
747
			if ( 'active_plugins' === $option ) {
748
				// use the cache if we can, but not terribly important if it gets evicted
749
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
750
			}
751
		}
752
753
		return $params;
754
	}
755
756
	function jetpack_connection_banner_callback() {
757
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
758
759
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
760
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
761
			wp_send_json_success();
762
		}
763
764
		wp_die();
765
	}
766
767
	function jetpack_admin_ajax_tracks_callback() {
768
		// Check for nonce
769
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
770
			wp_die( 'Permissions check failed.' );
771
		}
772
773
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
774
			wp_die( 'No valid event name or type.' );
775
		}
776
777
		$tracks_data = array();
778
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
779
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
780
				$tracks_data = $_REQUEST['tracksEventProp'];
781
			} else {
782
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
783
			}
784
		}
785
786
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
787
		wp_send_json_success();
788
		wp_die();
789
	}
790
791
	/**
792
	 * The callback for the JITM ajax requests.
793
	 */
794
	function jetpack_jitm_ajax_callback() {
795
		// Check for nonce
796
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
797
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
798
		}
799
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
800
			$module_slug = $_REQUEST['jitmModule'];
801
			Jetpack::log( 'activate', $module_slug );
802
			Jetpack::activate_module( $module_slug, false, false );
803
			Jetpack::state( 'message', 'no_message' );
804
805
			//A Jetpack module is being activated through a JITM, track it
806
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
807
			$this->do_stats( 'server_side' );
808
809
			wp_send_json_success();
810
		}
811
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
812
			// get the hide_jitm options array
813
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
814
			$module_slug = $_REQUEST['jitmModule'];
815
816
			if( ! $jetpack_hide_jitm ) {
817
				$jetpack_hide_jitm = array(
818
					$module_slug => 'hide'
819
				);
820
			} else {
821
				$jetpack_hide_jitm[$module_slug] = 'hide';
822
			}
823
824
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
825
826
			//jitm is being dismissed forever, track it
827
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
828
			$this->do_stats( 'server_side' );
829
830
			wp_send_json_success();
831
		}
832 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
833
			$module_slug = $_REQUEST['jitmModule'];
834
835
			// User went to WordPress.com, track this
836
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
837
			$this->do_stats( 'server_side' );
838
839
			wp_send_json_success();
840
		}
841 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
842
			$track = $_REQUEST['jitmModule'];
843
844
			// User is viewing JITM, track it.
845
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
846
			$this->do_stats( 'server_side' );
847
848
			wp_send_json_success();
849
		}
850
	}
851
852
	/**
853
	 * If there are any stats that need to be pushed, but haven't been, push them now.
854
	 */
855
	function push_stats() {
856
		if ( ! empty( $this->stats ) ) {
857
			$this->do_stats( 'server_side' );
858
		}
859
	}
860
861
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
862
		switch( $cap ) {
863
			case 'jetpack_connect' :
864
			case 'jetpack_reconnect' :
865
				if ( Jetpack::is_development_mode() ) {
866
					$caps = array( 'do_not_allow' );
867
					break;
868
				}
869
				/**
870
				 * Pass through. If it's not development mode, these should match disconnect.
871
				 * Let users disconnect if it's development mode, just in case things glitch.
872
				 */
873
			case 'jetpack_disconnect' :
874
				/**
875
				 * In multisite, can individual site admins manage their own connection?
876
				 *
877
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
878
				 */
879
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
880
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
881
						/**
882
						 * We need to update the option name -- it's terribly unclear which
883
						 * direction the override goes.
884
						 *
885
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
886
						 */
887
						$caps = array( 'do_not_allow' );
888
						break;
889
					}
890
				}
891
892
				$caps = array( 'manage_options' );
893
				break;
894
			case 'jetpack_manage_modules' :
895
			case 'jetpack_activate_modules' :
896
			case 'jetpack_deactivate_modules' :
897
				$caps = array( 'manage_options' );
898
				break;
899
			case 'jetpack_configure_modules' :
900
				$caps = array( 'manage_options' );
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
	function require_jetpack_authentication() {
929
		// Don't let anyone authenticate
930
		$_COOKIE = array();
931
		remove_all_filters( 'authenticate' );
932
		remove_all_actions( 'wp_login_failed' );
933
934
		if ( Jetpack::is_active() ) {
935
			// Allow Jetpack authentication
936
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
937
		}
938
	}
939
940
	/**
941
	 * Load language files
942
	 * @action plugins_loaded
943
	 */
944
	public static function plugin_textdomain() {
945
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
946
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
947
	}
948
949
	/**
950
	 * Register assets for use in various modules and the Jetpack admin page.
951
	 *
952
	 * @uses wp_script_is, wp_register_script, plugins_url
953
	 * @action wp_loaded
954
	 * @return null
955
	 */
956
	public function register_assets() {
957
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
958
			wp_register_script(
959
				'spin',
960
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
961
				false,
962
				'1.3'
963
			);
964
		}
965
966
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
967
			wp_register_script(
968
				'jquery.spin',
969
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
970
				array( 'jquery', 'spin' ),
971
				'1.3'
972
			);
973
		}
974
975 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
976
			wp_register_script(
977
				'jetpack-gallery-settings',
978
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
979
				array( 'media-views' ),
980
				'20121225'
981
			);
982
		}
983
984
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
985
			wp_register_script(
986
				'jetpack-twitter-timeline',
987
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
988
				array( 'jquery' ),
989
				'4.0.0',
990
				true
991
			);
992
		}
993
994
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
995
			wp_register_script(
996
				'jetpack-facebook-embed',
997
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
998
				array( 'jquery' ),
999
				null,
1000
				true
1001
			);
1002
1003
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1004
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1005
			if ( ! is_numeric( $fb_app_id ) ) {
1006
				$fb_app_id = '';
1007
			}
1008
			wp_localize_script(
1009
				'jetpack-facebook-embed',
1010
				'jpfbembed',
1011
				array(
1012
					'appid' => $fb_app_id,
1013
					'locale' => $this->get_locale(),
1014
				)
1015
			);
1016
		}
1017
1018
		/**
1019
		 * As jetpack_register_genericons is by default fired off a hook,
1020
		 * the hook may have already fired by this point.
1021
		 * So, let's just trigger it manually.
1022
		 */
1023
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1024
		jetpack_register_genericons();
1025
1026
		/**
1027
		 * Register the social logos
1028
		 */
1029
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1030
		jetpack_register_social_logos();
1031
1032 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1033
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1034
	}
1035
1036
	/**
1037
	 * Guess locale from language code.
1038
	 *
1039
	 * @param string $lang Language code.
1040
	 * @return string|bool
1041
	 */
1042 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1043
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1044
			return 'en_US';
1045
		}
1046
1047
		if ( ! class_exists( 'GP_Locales' ) ) {
1048
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1049
				return false;
1050
			}
1051
1052
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1053
		}
1054
1055
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1056
			// WP.com: get_locale() returns 'it'
1057
			$locale = GP_Locales::by_slug( $lang );
1058
		} else {
1059
			// Jetpack: get_locale() returns 'it_IT';
1060
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1061
		}
1062
1063
		if ( ! $locale ) {
1064
			return false;
1065
		}
1066
1067
		if ( empty( $locale->facebook_locale ) ) {
1068
			if ( empty( $locale->wp_locale ) ) {
1069
				return false;
1070
			} else {
1071
				// Facebook SDK is smart enough to fall back to en_US if a
1072
				// locale isn't supported. Since supported Facebook locales
1073
				// can fall out of sync, we'll attempt to use the known
1074
				// wp_locale value and rely on said fallback.
1075
				return $locale->wp_locale;
1076
			}
1077
		}
1078
1079
		return $locale->facebook_locale;
1080
	}
1081
1082
	/**
1083
	 * Get the locale.
1084
	 *
1085
	 * @return string|bool
1086
	 */
1087
	function get_locale() {
1088
		$locale = $this->guess_locale_from_lang( get_locale() );
1089
1090
		if ( ! $locale ) {
1091
			$locale = 'en_US';
1092
		}
1093
1094
		return $locale;
1095
	}
1096
1097
	/**
1098
	 * Device Pixels support
1099
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1100
	 */
1101
	function devicepx() {
1102
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1103
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1104
		}
1105
	}
1106
1107
	/**
1108
	 * Return the network_site_url so that .com knows what network this site is a part of.
1109
	 * @param  bool $option
1110
	 * @return string
1111
	 */
1112
	public function jetpack_main_network_site_option( $option ) {
1113
		return network_site_url();
1114
	}
1115
	/**
1116
	 * Network Name.
1117
	 */
1118
	static function network_name( $option = null ) {
1119
		global $current_site;
1120
		return $current_site->site_name;
1121
	}
1122
	/**
1123
	 * Does the network allow new user and site registrations.
1124
	 * @return string
1125
	 */
1126
	static function network_allow_new_registrations( $option = null ) {
1127
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1128
	}
1129
	/**
1130
	 * Does the network allow admins to add new users.
1131
	 * @return boolian
1132
	 */
1133
	static function network_add_new_users( $option = null ) {
1134
		return (bool) get_site_option( 'add_new_users' );
1135
	}
1136
	/**
1137
	 * File upload psace left per site in MB.
1138
	 *  -1 means NO LIMIT.
1139
	 * @return number
1140
	 */
1141
	static function network_site_upload_space( $option = null ) {
1142
		// value in MB
1143
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1144
	}
1145
1146
	/**
1147
	 * Network allowed file types.
1148
	 * @return string
1149
	 */
1150
	static function network_upload_file_types( $option = null ) {
1151
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1152
	}
1153
1154
	/**
1155
	 * Maximum file upload size set by the network.
1156
	 * @return number
1157
	 */
1158
	static function network_max_upload_file_size( $option = null ) {
1159
		// value in KB
1160
		return get_site_option( 'fileupload_maxk', 300 );
1161
	}
1162
1163
	/**
1164
	 * Lets us know if a site allows admins to manage the network.
1165
	 * @return array
1166
	 */
1167
	static function network_enable_administration_menus( $option = null ) {
1168
		return get_site_option( 'menu_items' );
1169
	}
1170
1171
	/**
1172
	 * If a user has been promoted to or demoted from admin, we need to clear the
1173
	 * jetpack_other_linked_admins transient.
1174
	 *
1175
	 * @since 4.3.2
1176
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1177
	 *
1178
	 * @param int    $user_id   The user ID whose role changed.
1179
	 * @param string $role      The new role.
1180
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2967
		ob_end_clean();
2968
		Jetpack::catch_errors( false );
2969
2970
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2971 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2972
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2973
2974
			//Jump start is being dismissed send data to MC Stats
2975
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2976
2977
			$jetpack->do_stats( 'server_side' );
2978
		}
2979
2980
		if ( $redirect ) {
2981
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2982
		}
2983
		if ( $exit ) {
2984
			exit;
2985
		}
2986
		return true;
2987
	}
2988
2989
	function activate_module_actions( $module ) {
2990
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2991
	}
2992
2993
	public static function deactivate_module( $module ) {
2994
		/**
2995
		 * Fires when a module is deactivated.
2996
		 *
2997
		 * @since 1.9.0
2998
		 *
2999
		 * @param string $module Module slug.
3000
		 */
3001
		do_action( 'jetpack_pre_deactivate_module', $module );
3002
3003
		$jetpack = Jetpack::init();
3004
3005
		$active = Jetpack::get_active_modules();
3006
		$new    = array_filter( array_diff( $active, (array) $module ) );
3007
3008
		// A flag for Jump Start so it's not shown again.
3009 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
3010
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3011
3012
			//Jump start is being dismissed send data to MC Stats
3013
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
3014
3015
			$jetpack->do_stats( 'server_side' );
3016
		}
3017
3018
		return self::update_active_modules( $new );
3019
	}
3020
3021
	public static function enable_module_configurable( $module ) {
3022
		$module = Jetpack::get_module_slug( $module );
3023
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3024
	}
3025
3026
	public static function module_configuration_url( $module ) {
3027
		$module = Jetpack::get_module_slug( $module );
3028
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
3029
	}
3030
3031
	public static function module_configuration_load( $module, $method ) {
3032
		$module = Jetpack::get_module_slug( $module );
3033
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
3034
	}
3035
3036
	public static function module_configuration_head( $module, $method ) {
3037
		$module = Jetpack::get_module_slug( $module );
3038
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
3039
	}
3040
3041
	public static function module_configuration_screen( $module, $method ) {
3042
		$module = Jetpack::get_module_slug( $module );
3043
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
3044
	}
3045
3046
	public static function module_configuration_activation_screen( $module, $method ) {
3047
		$module = Jetpack::get_module_slug( $module );
3048
		add_action( 'display_activate_module_setting_' . $module, $method );
3049
	}
3050
3051
/* Installation */
3052
3053
	public static function bail_on_activation( $message, $deactivate = true ) {
3054
?>
3055
<!doctype html>
3056
<html>
3057
<head>
3058
<meta charset="<?php bloginfo( 'charset' ); ?>">
3059
<style>
3060
* {
3061
	text-align: center;
3062
	margin: 0;
3063
	padding: 0;
3064
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3065
}
3066
p {
3067
	margin-top: 1em;
3068
	font-size: 18px;
3069
}
3070
</style>
3071
<body>
3072
<p><?php echo esc_html( $message ); ?></p>
3073
</body>
3074
</html>
3075
<?php
3076
		if ( $deactivate ) {
3077
			$plugins = get_option( 'active_plugins' );
3078
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3079
			$update  = false;
3080
			foreach ( $plugins as $i => $plugin ) {
3081
				if ( $plugin === $jetpack ) {
3082
					$plugins[$i] = false;
3083
					$update = true;
3084
				}
3085
			}
3086
3087
			if ( $update ) {
3088
				update_option( 'active_plugins', array_filter( $plugins ) );
3089
			}
3090
		}
3091
		exit;
3092
	}
3093
3094
	/**
3095
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3096
	 * @static
3097
	 */
3098
	public static function plugin_activation( $network_wide ) {
3099
		Jetpack_Options::update_option( 'activated', 1 );
3100
3101
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3102
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3103
		}
3104
3105
		if ( $network_wide )
3106
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3107
3108
		// For firing one-off events (notices) immediately after activation
3109
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3110
3111
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3112
3113
		Jetpack::plugin_initialize();
3114
	}
3115
3116
	public static function get_activation_source( $referer_url ) {
3117
3118
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3119
			return array( 'wp-cli', null );
3120
		}
3121
3122
		$referer = parse_url( $referer_url );
3123
3124
		$source_type = 'unknown';
3125
		$source_query = null;
3126
3127
		if ( ! is_array( $referer ) ) {
3128
			return array( $source_type, $source_query );
3129
		}
3130
3131
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3132
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3133
3134
		if ( isset( $referer['query'] ) ) {
3135
			parse_str( $referer['query'], $query_parts );
3136
		} else {
3137
			$query_parts = array();
3138
		}
3139
3140
		if ( $plugins_path === $referer['path'] ) {
3141
			$source_type = 'list';
3142
		} elseif ( $plugins_install_path === $referer['path'] ) {
3143
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3144
			switch( $tab ) {
3145
				case 'popular':
3146
					$source_type = 'popular';
3147
					break;
3148
				case 'recommended':
3149
					$source_type = 'recommended';
3150
					break;
3151
				case 'favorites':
3152
					$source_type = 'favorites';
3153
					break;
3154
				case 'search':
3155
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3156
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3157
					break;
3158
				default:
3159
					$source_type = 'featured';
3160
			}
3161
		}
3162
3163
		return array( $source_type, $source_query );
3164
	}
3165
3166
	/**
3167
	 * Runs before bumping version numbers up to a new version
3168
	 * @param  string $version    Version:timestamp
3169
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3170
	 * @return null              [description]
3171
	 */
3172
	public static function do_version_bump( $version, $old_version ) {
3173
3174
		if ( ! $old_version ) { // For new sites
3175
			// Setting up jetpack manage
3176
			Jetpack::activate_manage();
3177
		}
3178
	}
3179
3180
	/**
3181
	 * Sets the internal version number and activation state.
3182
	 * @static
3183
	 */
3184
	public static function plugin_initialize() {
3185
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3186
			Jetpack_Options::update_option( 'activated', 2 );
3187
		}
3188
3189 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3190
			$version = $old_version = JETPACK__VERSION . ':' . time();
3191
			/** This action is documented in class.jetpack.php */
3192
			do_action( 'updating_jetpack_version', $version, false );
3193
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3194
		}
3195
3196
		Jetpack::load_modules();
3197
3198
		Jetpack_Options::delete_option( 'do_activate' );
3199
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3200
	}
3201
3202
	/**
3203
	 * Removes all connection options
3204
	 * @static
3205
	 */
3206
	public static function plugin_deactivation( ) {
3207
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3208
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3209
			Jetpack_Network::init()->deactivate();
3210
		} else {
3211
			Jetpack::disconnect( false );
3212
			//Jetpack_Heartbeat::init()->deactivate();
3213
		}
3214
	}
3215
3216
	/**
3217
	 * Disconnects from the Jetpack servers.
3218
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3219
	 * @static
3220
	 */
3221
	public static function disconnect( $update_activated_state = true ) {
3222
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3223
		Jetpack::clean_nonces( true );
3224
3225
		// If the site is in an IDC because sync is not allowed,
3226
		// let's make sure to not disconnect the production site.
3227
		if ( ! self::validate_sync_error_idc_option() ) {
3228
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3229
			Jetpack::load_xml_rpc_client();
3230
			$xml = new Jetpack_IXR_Client();
3231
			$xml->query( 'jetpack.deregister' );
3232
		}
3233
3234
		Jetpack_Options::delete_option(
3235
			array(
3236
				'blog_token',
3237
				'user_token',
3238
				'user_tokens',
3239
				'master_user',
3240
				'time_diff',
3241
				'fallback_no_verify_ssl_certs',
3242
			)
3243
		);
3244
3245
		Jetpack_IDC::clear_all_idc_options();
3246
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3247
3248
		if ( $update_activated_state ) {
3249
			Jetpack_Options::update_option( 'activated', 4 );
3250
		}
3251
3252
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3253
			// Check then record unique disconnection if site has never been disconnected previously
3254
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3255
				$jetpack_unique_connection['disconnected'] = 1;
3256
			} else {
3257
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3258
					//track unique disconnect
3259
					$jetpack = Jetpack::init();
3260
3261
					$jetpack->stat( 'connections', 'unique-disconnect' );
3262
					$jetpack->do_stats( 'server_side' );
3263
				}
3264
				// increment number of times disconnected
3265
				$jetpack_unique_connection['disconnected'] += 1;
3266
			}
3267
3268
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3269
		}
3270
3271
		// Delete cached connected user data
3272
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3273
		delete_transient( $transient_key );
3274
3275
		// Delete all the sync related data. Since it could be taking up space.
3276
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3277
		Jetpack_Sync_Sender::get_instance()->uninstall();
3278
3279
		// Disable the Heartbeat cron
3280
		Jetpack_Heartbeat::init()->deactivate();
3281
	}
3282
3283
	/**
3284
	 * Unlinks the current user from the linked WordPress.com user
3285
	 */
3286
	public static function unlink_user( $user_id = null ) {
3287
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3288
			return false;
3289
3290
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3291
3292
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3293
			return false;
3294
3295
		if ( ! isset( $tokens[ $user_id ] ) )
3296
			return false;
3297
3298
		Jetpack::load_xml_rpc_client();
3299
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3300
		$xml->query( 'jetpack.unlink_user', $user_id );
3301
3302
		unset( $tokens[ $user_id ] );
3303
3304
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3305
3306
		/**
3307
		 * Fires after the current user has been unlinked from WordPress.com.
3308
		 *
3309
		 * @since 4.1.0
3310
		 *
3311
		 * @param int $user_id The current user's ID.
3312
		 */
3313
		do_action( 'jetpack_unlinked_user', $user_id );
3314
3315
		return true;
3316
	}
3317
3318
	/**
3319
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3320
	 */
3321
	public static function try_registration() {
3322
		// The user has agreed to the TOS at some point by now.
3323
		Jetpack_Options::update_option( 'tos_agreed', true );
3324
3325
		// Let's get some testing in beta versions and such.
3326
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3327
			// Before attempting to connect, let's make sure that the domains are viable.
3328
			$domains_to_check = array_unique( array(
3329
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3330
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3331
			) );
3332
			foreach ( $domains_to_check as $domain ) {
3333
				$result = Jetpack_Data::is_usable_domain( $domain );
3334
				if ( is_wp_error( $result ) ) {
3335
					return $result;
3336
				}
3337
			}
3338
		}
3339
3340
		$result = Jetpack::register();
3341
3342
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3343
		if ( ! $result || is_wp_error( $result ) ) {
3344
			return $result;
3345
		} else {
3346
			return true;
3347
		}
3348
	}
3349
3350
	/**
3351
	 * Tracking an internal event log. Try not to put too much chaff in here.
3352
	 *
3353
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3354
	 */
3355
	public static function log( $code, $data = null ) {
3356
		// only grab the latest 200 entries
3357
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3358
3359
		// Append our event to the log
3360
		$log_entry = array(
3361
			'time'    => time(),
3362
			'user_id' => get_current_user_id(),
3363
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3364
			'code'    => $code,
3365
		);
3366
		// Don't bother storing it unless we've got some.
3367
		if ( ! is_null( $data ) ) {
3368
			$log_entry['data'] = $data;
3369
		}
3370
		$log[] = $log_entry;
3371
3372
		// Try add_option first, to make sure it's not autoloaded.
3373
		// @todo: Add an add_option method to Jetpack_Options
3374
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3375
			Jetpack_Options::update_option( 'log', $log );
3376
		}
3377
3378
		/**
3379
		 * Fires when Jetpack logs an internal event.
3380
		 *
3381
		 * @since 3.0.0
3382
		 *
3383
		 * @param array $log_entry {
3384
		 *	Array of details about the log entry.
3385
		 *
3386
		 *	@param string time Time of the event.
3387
		 *	@param int user_id ID of the user who trigerred the event.
3388
		 *	@param int blog_id Jetpack Blog ID.
3389
		 *	@param string code Unique name for the event.
3390
		 *	@param string data Data about the event.
3391
		 * }
3392
		 */
3393
		do_action( 'jetpack_log_entry', $log_entry );
3394
	}
3395
3396
	/**
3397
	 * Get the internal event log.
3398
	 *
3399
	 * @param $event (string) - only return the specific log events
3400
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3401
	 *
3402
	 * @return array of log events || WP_Error for invalid params
3403
	 */
3404
	public static function get_log( $event = false, $num = false ) {
3405
		if ( $event && ! is_string( $event ) ) {
3406
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3407
		}
3408
3409
		if ( $num && ! is_numeric( $num ) ) {
3410
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3411
		}
3412
3413
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3414
3415
		// If nothing set - act as it did before, otherwise let's start customizing the output
3416
		if ( ! $num && ! $event ) {
3417
			return $entire_log;
3418
		} else {
3419
			$entire_log = array_reverse( $entire_log );
3420
		}
3421
3422
		$custom_log_output = array();
3423
3424
		if ( $event ) {
3425
			foreach ( $entire_log as $log_event ) {
3426
				if ( $event == $log_event[ 'code' ] ) {
3427
					$custom_log_output[] = $log_event;
3428
				}
3429
			}
3430
		} else {
3431
			$custom_log_output = $entire_log;
3432
		}
3433
3434
		if ( $num ) {
3435
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3436
		}
3437
3438
		return $custom_log_output;
3439
	}
3440
3441
	/**
3442
	 * Log modification of important settings.
3443
	 */
3444
	public static function log_settings_change( $option, $old_value, $value ) {
3445
		switch( $option ) {
3446
			case 'jetpack_sync_non_public_post_stati':
3447
				self::log( $option, $value );
3448
				break;
3449
		}
3450
	}
3451
3452
	/**
3453
	 * Return stat data for WPCOM sync
3454
	 */
3455
	public static function get_stat_data( $encode = true, $extended = true ) {
3456
		$data = Jetpack_Heartbeat::generate_stats_array();
3457
3458
		if ( $extended ) {
3459
			$additional_data = self::get_additional_stat_data();
3460
			$data = array_merge( $data, $additional_data );
3461
		}
3462
3463
		if ( $encode ) {
3464
			return json_encode( $data );
3465
		}
3466
3467
		return $data;
3468
	}
3469
3470
	/**
3471
	 * Get additional stat data to sync to WPCOM
3472
	 */
3473
	public static function get_additional_stat_data( $prefix = '' ) {
3474
		$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...
3475
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3476
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3477
		$return["{$prefix}site-count"]     = 0;
3478
3479
		if ( function_exists( 'get_blog_count' ) ) {
3480
			$return["{$prefix}site-count"] = get_blog_count();
3481
		}
3482
		return $return;
3483
	}
3484
3485
	private static function get_site_user_count() {
3486
		global $wpdb;
3487
3488
		if ( function_exists( 'wp_is_large_network' ) ) {
3489
			if ( wp_is_large_network( 'users' ) ) {
3490
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3491
			}
3492
		}
3493 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3494
			// It wasn't there, so regenerate the data and save the transient
3495
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3496
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3497
		}
3498
		return $user_count;
3499
	}
3500
3501
	/* Admin Pages */
3502
3503
	function admin_init() {
3504
		// If the plugin is not connected, display a connect message.
3505
		if (
3506
			// the plugin was auto-activated and needs its candy
3507
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3508
		||
3509
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3510
			! Jetpack_Options::get_option( 'activated' )
3511
		) {
3512
			Jetpack::plugin_initialize();
3513
		}
3514
3515
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3516
			Jetpack_Connection_Banner::init();
3517
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3518
			// Upgrade: 1.1 -> 1.1.1
3519
			// Check and see if host can verify the Jetpack servers' SSL certificate
3520
			$args = array();
3521
			Jetpack_Client::_wp_remote_request(
3522
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3523
				$args,
3524
				true
3525
			);
3526
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3527
			// Show the notice on the Dashboard only for now
3528
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3529
		}
3530
3531
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3532
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3533
		}
3534
3535
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3536
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3537
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3538
3539
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3540
			// Artificially throw errors in certain whitelisted cases during plugin activation
3541
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3542
		}
3543
3544
		// Jetpack Manage Activation Screen from .com
3545
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3546
3547
		// Add custom column in wp-admin/users.php to show whether user is linked.
3548
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3549
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3550
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3551
	}
3552
3553
	function admin_body_class( $admin_body_class = '' ) {
3554
		$classes = explode( ' ', trim( $admin_body_class ) );
3555
3556
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3557
3558
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3559
		return " $admin_body_class ";
3560
	}
3561
3562
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3563
		return $admin_body_class . ' jetpack-pagestyles ';
3564
	}
3565
3566
	/**
3567
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3568
	 *
3569
	 * @return null
3570
	 */
3571
	function prepare_manage_jetpack_notice() {
3572
3573
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3574
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3575
	}
3576
3577
	function manage_activate_screen() {
3578
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3579
	}
3580
	/**
3581
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3582
	 * This function artificially throws errors for such cases (whitelisted).
3583
	 *
3584
	 * @param string $plugin The activated plugin.
3585
	 */
3586
	function throw_error_on_activate_plugin( $plugin ) {
3587
		$active_modules = Jetpack::get_active_modules();
3588
3589
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3590
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3591
			$throw = false;
3592
3593
			// Try and make sure it really was the stats plugin
3594
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3595
				if ( 'stats.php' == basename( $plugin ) ) {
3596
					$throw = true;
3597
				}
3598
			} else {
3599
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3600
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3601
					$throw = true;
3602
				}
3603
			}
3604
3605
			if ( $throw ) {
3606
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3607
			}
3608
		}
3609
	}
3610
3611
	function intercept_plugin_error_scrape_init() {
3612
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3613
	}
3614
3615
	function intercept_plugin_error_scrape( $action, $result ) {
3616
		if ( ! $result ) {
3617
			return;
3618
		}
3619
3620
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3621
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3622
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3623
			}
3624
		}
3625
	}
3626
3627
	function add_remote_request_handlers() {
3628
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3629
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3630
	}
3631
3632
	function remote_request_handlers() {
3633
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3634
3635
		switch ( current_filter() ) {
3636
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3637
			$response = $this->upload_handler();
3638
			break;
3639
3640
		case 'wp_ajax_nopriv_jetpack_update_file' :
3641
			$response = $this->upload_handler( true );
3642
			break;
3643
		default :
3644
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3645
			break;
3646
		}
3647
3648
		if ( ! $response ) {
3649
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3650
		}
3651
3652
		if ( is_wp_error( $response ) ) {
3653
			$status_code       = $response->get_error_data();
3654
			$error             = $response->get_error_code();
3655
			$error_description = $response->get_error_message();
3656
3657
			if ( ! is_int( $status_code ) ) {
3658
				$status_code = 400;
3659
			}
3660
3661
			status_header( $status_code );
3662
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3663
		}
3664
3665
		status_header( 200 );
3666
		if ( true === $response ) {
3667
			exit;
3668
		}
3669
3670
		die( json_encode( (object) $response ) );
3671
	}
3672
3673
	/**
3674
	 * Uploads a file gotten from the global $_FILES.
3675
	 * If `$update_media_item` is true and `post_id` is defined
3676
	 * the attachment file of the media item (gotten through of the post_id)
3677
	 * will be updated instead of add a new one.
3678
	 *
3679
	 * @param  boolean $update_media_item - update media attachment
3680
	 * @return array - An array describing the uploadind files process
3681
	 */
3682
	function upload_handler( $update_media_item = false ) {
3683
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3684
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3685
		}
3686
3687
		$user = wp_authenticate( '', '' );
3688
		if ( ! $user || is_wp_error( $user ) ) {
3689
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3690
		}
3691
3692
		wp_set_current_user( $user->ID );
3693
3694
		if ( ! current_user_can( 'upload_files' ) ) {
3695
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3696
		}
3697
3698
		if ( empty( $_FILES ) ) {
3699
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3700
		}
3701
3702
		foreach ( array_keys( $_FILES ) as $files_key ) {
3703
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3704
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3705
			}
3706
		}
3707
3708
		$media_keys = array_keys( $_FILES['media'] );
3709
3710
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3711
		if ( ! $token || is_wp_error( $token ) ) {
3712
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3713
		}
3714
3715
		$uploaded_files = array();
3716
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3717
		unset( $GLOBALS['post'] );
3718
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3719
			$file = array();
3720
			foreach ( $media_keys as $media_key ) {
3721
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3722
			}
3723
3724
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3725
3726
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3727
			if ( $hmac_provided !== $hmac_file ) {
3728
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3729
				continue;
3730
			}
3731
3732
			$_FILES['.jetpack.upload.'] = $file;
3733
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3734
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3735
				$post_id = 0;
3736
			}
3737
3738
			if ( $update_media_item ) {
3739
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3740
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3741
				}
3742
3743
				$media_array = $_FILES['media'];
3744
3745
				$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...
3746
				$file_array['type'] = $media_array['type'][0];
3747
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3748
				$file_array['error'] = $media_array['error'][0];
3749
				$file_array['size'] = $media_array['size'][0];
3750
3751
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3752
3753
				if ( is_wp_error( $edited_media_item ) ) {
3754
					return $edited_media_item;
3755
				}
3756
3757
				$response = (object) array(
3758
					'id'   => (string) $post_id,
3759
					'file' => (string) $edited_media_item->post_title,
3760
					'url'  => (string) wp_get_attachment_url( $post_id ),
3761
					'type' => (string) $edited_media_item->post_mime_type,
3762
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3763
				);
3764
3765
				return (array) array( $response );
3766
			}
3767
3768
			$attachment_id = media_handle_upload(
3769
				'.jetpack.upload.',
3770
				$post_id,
3771
				array(),
3772
				array(
3773
					'action' => 'jetpack_upload_file',
3774
				)
3775
			);
3776
3777
			if ( ! $attachment_id ) {
3778
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3779
			} elseif ( is_wp_error( $attachment_id ) ) {
3780
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3781
			} else {
3782
				$attachment = get_post( $attachment_id );
3783
				$uploaded_files[$index] = (object) array(
3784
					'id'   => (string) $attachment_id,
3785
					'file' => $attachment->post_title,
3786
					'url'  => wp_get_attachment_url( $attachment_id ),
3787
					'type' => $attachment->post_mime_type,
3788
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3789
				);
3790
				// Zip files uploads are not supported unless they are done for installation purposed
3791
				// lets delete them in case something goes wrong in this whole process
3792
				if ( 'application/zip' === $attachment->post_mime_type ) {
3793
					// Schedule a cleanup for 2 hours from now in case of failed install.
3794
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3795
				}
3796
			}
3797
		}
3798
		if ( ! is_null( $global_post ) ) {
3799
			$GLOBALS['post'] = $global_post;
3800
		}
3801
3802
		return $uploaded_files;
3803
	}
3804
3805
	/**
3806
	 * Add help to the Jetpack page
3807
	 *
3808
	 * @since Jetpack (1.2.3)
3809
	 * @return false if not the Jetpack page
3810
	 */
3811
	function admin_help() {
3812
		$current_screen = get_current_screen();
3813
3814
		// Overview
3815
		$current_screen->add_help_tab(
3816
			array(
3817
				'id'		=> 'home',
3818
				'title'		=> __( 'Home', 'jetpack' ),
3819
				'content'	=>
3820
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3821
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3822
					'<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>',
3823
			)
3824
		);
3825
3826
		// Screen Content
3827
		if ( current_user_can( 'manage_options' ) ) {
3828
			$current_screen->add_help_tab(
3829
				array(
3830
					'id'		=> 'settings',
3831
					'title'		=> __( 'Settings', 'jetpack' ),
3832
					'content'	=>
3833
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3834
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3835
						'<ol>' .
3836
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3837
							'<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>' .
3838
						'</ol>' .
3839
						'<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>'
3840
				)
3841
			);
3842
		}
3843
3844
		// Help Sidebar
3845
		$current_screen->set_help_sidebar(
3846
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3847
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3848
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3849
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3850
		);
3851
	}
3852
3853
	function admin_menu_css() {
3854
		wp_enqueue_style( 'jetpack-icons' );
3855
	}
3856
3857
	function admin_menu_order() {
3858
		return true;
3859
	}
3860
3861
	function enqueue_gutenberg_locale() {
3862
		wp_add_inline_script(
3863
			'wp-i18n',
3864
			'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
3865
		);
3866
	}
3867
3868 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3869
		$jp_menu_order = array();
3870
3871
		foreach ( $menu_order as $index => $item ) {
3872
			if ( $item != 'jetpack' ) {
3873
				$jp_menu_order[] = $item;
3874
			}
3875
3876
			if ( $index == 0 ) {
3877
				$jp_menu_order[] = 'jetpack';
3878
			}
3879
		}
3880
3881
		return $jp_menu_order;
3882
	}
3883
3884
	function admin_head() {
3885 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3886
			/** This action is documented in class.jetpack-admin-page.php */
3887
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3888
	}
3889
3890
	function admin_banner_styles() {
3891
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3892
3893
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3894
			wp_register_style(
3895
				'jetpack-dops-style',
3896
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3897
				array(),
3898
				JETPACK__VERSION
3899
			);
3900
		}
3901
3902
		wp_enqueue_style(
3903
			'jetpack',
3904
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3905
			array( 'jetpack-dops-style' ),
3906
			 JETPACK__VERSION . '-20121016'
3907
		);
3908
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3909
		wp_style_add_data( 'jetpack', 'suffix', $min );
3910
	}
3911
3912
	function plugin_action_links( $actions ) {
3913
3914
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3915
3916
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3917
			return array_merge(
3918
				$jetpack_home,
3919
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3920
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3921
				$actions
3922
				);
3923
			}
3924
3925
		return array_merge( $jetpack_home, $actions );
3926
	}
3927
3928
	/**
3929
	 * This is the first banner
3930
	 * It should be visible only to user that can update the option
3931
	 * Are not connected
3932
	 *
3933
	 * @return null
3934
	 */
3935
	function admin_jetpack_manage_notice() {
3936
		$screen = get_current_screen();
3937
3938
		// Don't show the connect notice on the jetpack settings page.
3939
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3940
			return;
3941
		}
3942
3943
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3944
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3945
		/**
3946
		 * I think it would be great to have different wordsing depending on where you are
3947
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3948
		 * etc..
3949
		 */
3950
3951
		?>
3952
		<div id="message" class="updated jp-banner">
3953
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3954
				<div class="jp-banner__description-container">
3955
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3956
					<p class="jp-banner__description"><?php printf( __( 'Manage multiple Jetpack enabled sites from one single dashboard at wordpress.com. Allows all existing, connected Administrators to modify your site.', 'jetpack' ), 'https://jetpack.com/support/site-management' ); ?></p>
3957
					<p class="jp-banner__button-container">
3958
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3959
						<a href="https://jetpack.com/support/site-management" class="button" target="_blank" title="<?php esc_attr_e( 'Learn more about Jetpack Manage on Jetpack.com', 'jetpack' ); ?>"><?php _e( 'Learn more', 'jetpack' ); ?></a>
3960
					</p>
3961
				</div>
3962
		</div>
3963
		<?php
3964
	}
3965
3966
	/**
3967
	 * Returns the url that the user clicks to remove the notice for the big banner
3968
	 * @return string
3969
	 */
3970
	function opt_out_jetpack_manage_url() {
3971
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3972
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3973
	}
3974
	/**
3975
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3976
	 * @return string
3977
	 */
3978
	function opt_in_jetpack_manage_url() {
3979
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3980
	}
3981
3982
	function opt_in_jetpack_manage_notice() {
3983
		?>
3984
		<div class="wrap">
3985
			<div id="message" class="jetpack-message is-opt-in">
3986
				<?php echo sprintf( __( '<p><a href="%1$s" title="Opt in to WordPress.com Site Management" >Activate Site Management</a> to manage multiple sites from our centralized dashboard at wordpress.com/sites. <a href="%2$s" target="_blank">Learn more</a>.</p><a href="%1$s" class="jp-button">Activate Now</a>', 'jetpack' ), $this->opt_in_jetpack_manage_url(), 'https://jetpack.com/support/site-management' ); ?>
3987
			</div>
3988
		</div>
3989
		<?php
3990
3991
	}
3992
	/**
3993
	 * Determines whether to show the notice of not true = display notice
3994
	 * @return bool
3995
	 */
3996
	function can_display_jetpack_manage_notice() {
3997
		// never display the notice to users that can't do anything about it anyways
3998
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3999
			return false;
4000
4001
		// don't display if we are in development more
4002
		if( Jetpack::is_development_mode() ) {
4003
			return false;
4004
		}
4005
		// don't display if the site is private
4006
		if(  ! Jetpack_Options::get_option( 'public' ) )
4007
			return false;
4008
4009
		/**
4010
		 * Should the Jetpack Remote Site Management notice be displayed.
4011
		 *
4012
		 * @since 3.3.0
4013
		 *
4014
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
4015
		 */
4016
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
4017
	}
4018
4019
	/*
4020
	 * Registration flow:
4021
	 * 1 - ::admin_page_load() action=register
4022
	 * 2 - ::try_registration()
4023
	 * 3 - ::register()
4024
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4025
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4026
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4027
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4028
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4029
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4030
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4031
	 *       jetpack_id, jetpack_secret, jetpack_public
4032
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4033
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4034
	 * 5 - user logs in with WP.com account
4035
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4036
	 *		- Jetpack_Client_Server::authorize()
4037
	 *		- Jetpack_Client_Server::get_token()
4038
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4039
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4040
	 *			- which responds with access_token, token_type, scope
4041
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
4042
	 *		- Jetpack::activate_default_modules()
4043
	 *     		- Deactivates deprecated plugins
4044
	 *     		- Activates all default modules
4045
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4046
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4047
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4048
	 *     Done!
4049
	 */
4050
4051
	/**
4052
	 * Handles the page load events for the Jetpack admin page
4053
	 */
4054
	function admin_page_load() {
4055
		$error = false;
4056
4057
		// Make sure we have the right body class to hook stylings for subpages off of.
4058
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
4059
4060
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4061
			// Should only be used in intermediate redirects to preserve state across redirects
4062
			Jetpack::restate();
4063
		}
4064
4065
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4066
			// User clicked in the iframe to link their accounts
4067
			if ( ! Jetpack::is_user_connected() ) {
4068
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4069
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4070
4071
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4072
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4073
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4074
4075
				if ( isset( $_GET['notes_iframe'] ) )
4076
					$connect_url .= '&notes_iframe';
4077
				wp_redirect( $connect_url );
4078
				exit;
4079
			} else {
4080
				if ( ! isset( $_GET['calypso_env'] ) ) {
4081
					Jetpack::state( 'message', 'already_authorized' );
4082
					wp_safe_redirect( Jetpack::admin_url() );
4083
					exit;
4084
				} else {
4085
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4086
					$connect_url .= '&already_authorized=true';
4087
					wp_redirect( $connect_url );
4088
					exit;
4089
				}
4090
			}
4091
		}
4092
4093
4094
		if ( isset( $_GET['action'] ) ) {
4095
			switch ( $_GET['action'] ) {
4096
			case 'authorize':
4097
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4098
					Jetpack::state( 'message', 'already_authorized' );
4099
					wp_safe_redirect( Jetpack::admin_url() );
4100
					exit;
4101
				}
4102
				Jetpack::log( 'authorize' );
4103
				$client_server = new Jetpack_Client_Server;
4104
				$client_server->client_authorize();
4105
				exit;
4106
			case 'register' :
4107
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4108
					$error = 'cheatin';
4109
					break;
4110
				}
4111
				check_admin_referer( 'jetpack-register' );
4112
				Jetpack::log( 'register' );
4113
				Jetpack::maybe_set_version_option();
4114
				$registered = Jetpack::try_registration();
4115
				if ( is_wp_error( $registered ) ) {
4116
					$error = $registered->get_error_code();
4117
					Jetpack::state( 'error', $error );
4118
					Jetpack::state( 'error', $registered->get_error_message() );
4119
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4120
						'error_code' => $error,
4121
						'error_message' => $registered->get_error_message()
4122
					) );
4123
					break;
4124
				}
4125
4126
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4127
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4128
4129
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4130
					'from' => $from
4131
				) );
4132
4133
				$url = $this->build_connect_url( true, $redirect, $from );
4134
4135
				if ( ! empty( $_GET['onboarding'] ) ) {
4136
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4137
				}
4138
4139
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4140
					$url = add_query_arg( 'auth_approved', 'true', $url );
4141
				}
4142
4143
				wp_redirect( $url );
4144
				exit;
4145
			case 'activate' :
4146
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4147
					$error = 'cheatin';
4148
					break;
4149
				}
4150
4151
				$module = stripslashes( $_GET['module'] );
4152
				check_admin_referer( "jetpack_activate-$module" );
4153
				Jetpack::log( 'activate', $module );
4154
				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...
4155
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4156
				}
4157
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4158
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4159
				exit;
4160
			case 'activate_default_modules' :
4161
				check_admin_referer( 'activate_default_modules' );
4162
				Jetpack::log( 'activate_default_modules' );
4163
				Jetpack::restate();
4164
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4165
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4166
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4167
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4168
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4169
				exit;
4170
			case 'disconnect' :
4171
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4172
					$error = 'cheatin';
4173
					break;
4174
				}
4175
4176
				check_admin_referer( 'jetpack-disconnect' );
4177
				Jetpack::log( 'disconnect' );
4178
				Jetpack::disconnect();
4179
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4180
				exit;
4181
			case 'reconnect' :
4182
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4183
					$error = 'cheatin';
4184
					break;
4185
				}
4186
4187
				check_admin_referer( 'jetpack-reconnect' );
4188
				Jetpack::log( 'reconnect' );
4189
				$this->disconnect();
4190
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4191
				exit;
4192 View Code Duplication
			case 'deactivate' :
4193
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4194
					$error = 'cheatin';
4195
					break;
4196
				}
4197
4198
				$modules = stripslashes( $_GET['module'] );
4199
				check_admin_referer( "jetpack_deactivate-$modules" );
4200
				foreach ( explode( ',', $modules ) as $module ) {
4201
					Jetpack::log( 'deactivate', $module );
4202
					Jetpack::deactivate_module( $module );
4203
					Jetpack::state( 'message', 'module_deactivated' );
4204
				}
4205
				Jetpack::state( 'module', $modules );
4206
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4207
				exit;
4208
			case 'unlink' :
4209
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4210
				check_admin_referer( 'jetpack-unlink' );
4211
				Jetpack::log( 'unlink' );
4212
				$this->unlink_user();
4213
				Jetpack::state( 'message', 'unlinked' );
4214
				if ( 'sub-unlink' == $redirect ) {
4215
					wp_safe_redirect( admin_url() );
4216
				} else {
4217
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4218
				}
4219
				exit;
4220
			case 'onboard' :
4221
				if ( ! current_user_can( 'manage_options' ) ) {
4222
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4223
				} else {
4224
					Jetpack::create_onboarding_token();
4225
					$url = $this->build_connect_url( true );
4226
4227
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4228
						$url = add_query_arg( 'onboarding', $token, $url );
4229
					}
4230
4231
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4232
					if ( $calypso_env ) {
4233
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4234
					}
4235
4236
					wp_redirect( $url );
4237
					exit;
4238
				}
4239
				exit;
4240
			default:
4241
				/**
4242
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4243
				 *
4244
				 * @since 2.6.0
4245
				 *
4246
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4247
				 */
4248
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4249
			}
4250
		}
4251
4252
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4253
			self::activate_new_modules( true );
4254
		}
4255
4256
		$message_code = Jetpack::state( 'message' );
4257
		if ( Jetpack::state( 'optin-manage' ) ) {
4258
			$activated_manage = $message_code;
4259
			$message_code = 'jetpack-manage';
4260
		}
4261
4262
		switch ( $message_code ) {
4263
		case 'jetpack-manage':
4264
			$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>';
4265
			if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4266
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4267
			}
4268
			break;
4269
4270
		}
4271
4272
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4273
4274
		if ( ! empty( $deactivated_plugins ) ) {
4275
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4276
			$deactivated_titles  = array();
4277
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4278
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4279
					continue;
4280
				}
4281
4282
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4283
			}
4284
4285
			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...
4286
				if ( $this->message ) {
4287
					$this->message .= "<br /><br />\n";
4288
				}
4289
4290
				$this->message .= wp_sprintf(
4291
					_n(
4292
						'Jetpack contains the most recent version of the old %l plugin.',
4293
						'Jetpack contains the most recent versions of the old %l plugins.',
4294
						count( $deactivated_titles ),
4295
						'jetpack'
4296
					),
4297
					$deactivated_titles
4298
				);
4299
4300
				$this->message .= "<br />\n";
4301
4302
				$this->message .= _n(
4303
					'The old version has been deactivated and can be removed from your site.',
4304
					'The old versions have been deactivated and can be removed from your site.',
4305
					count( $deactivated_titles ),
4306
					'jetpack'
4307
				);
4308
			}
4309
		}
4310
4311
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4312
4313
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4314
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4315
		}
4316
4317 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4318
			/**
4319
			 * Fires when a module configuration page is loaded.
4320
			 * The dynamic part of the hook is the configure parameter from the URL.
4321
			 *
4322
			 * @since 1.1.0
4323
			 */
4324
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4325
		}
4326
4327
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4328
	}
4329
4330
	function admin_notices() {
4331
4332
		if ( $this->error ) {
4333
?>
4334
<div id="message" class="jetpack-message jetpack-err">
4335
	<div class="squeezer">
4336
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4337
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4338
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4339
<?php	endif; ?>
4340
	</div>
4341
</div>
4342
<?php
4343
		}
4344
4345
		if ( $this->message ) {
4346
?>
4347
<div id="message" class="jetpack-message">
4348
	<div class="squeezer">
4349
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4350
	</div>
4351
</div>
4352
<?php
4353
		}
4354
4355
		if ( $this->privacy_checks ) :
4356
			$module_names = $module_slugs = array();
4357
4358
			$privacy_checks = explode( ',', $this->privacy_checks );
4359
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4360
			foreach ( $privacy_checks as $module_slug ) {
4361
				$module = Jetpack::get_module( $module_slug );
4362
				if ( ! $module ) {
4363
					continue;
4364
				}
4365
4366
				$module_slugs[] = $module_slug;
4367
				$module_names[] = "<strong>{$module['name']}</strong>";
4368
			}
4369
4370
			$module_slugs = join( ',', $module_slugs );
4371
?>
4372
<div id="message" class="jetpack-message jetpack-err">
4373
	<div class="squeezer">
4374
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4375
		<p><?php
4376
			echo wp_kses(
4377
				wptexturize(
4378
					wp_sprintf(
4379
						_nx(
4380
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4381
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4382
							count( $privacy_checks ),
4383
							'%l = list of Jetpack module/feature names',
4384
							'jetpack'
4385
						),
4386
						$module_names
4387
					)
4388
				),
4389
				array( 'strong' => true )
4390
			);
4391
4392
			echo "\n<br />\n";
4393
4394
			echo wp_kses(
4395
				sprintf(
4396
					_nx(
4397
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4398
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4399
						count( $privacy_checks ),
4400
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4401
						'jetpack'
4402
					),
4403
					wp_nonce_url(
4404
						Jetpack::admin_url(
4405
							array(
4406
								'page'   => 'jetpack',
4407
								'action' => 'deactivate',
4408
								'module' => urlencode( $module_slugs ),
4409
							)
4410
						),
4411
						"jetpack_deactivate-$module_slugs"
4412
					),
4413
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4414
				),
4415
				array( 'a' => array( 'href' => true, 'title' => true ) )
4416
			);
4417
		?></p>
4418
	</div>
4419
</div>
4420
<?php endif;
4421
	// only display the notice if the other stuff is not there
4422
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4423
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4424
			$this->opt_in_jetpack_manage_notice();
4425
		}
4426
	}
4427
4428
	/**
4429
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4430
	 */
4431
	function stat( $group, $detail ) {
4432
		if ( ! isset( $this->stats[ $group ] ) )
4433
			$this->stats[ $group ] = array();
4434
		$this->stats[ $group ][] = $detail;
4435
	}
4436
4437
	/**
4438
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4439
	 */
4440
	function do_stats( $method = '' ) {
4441
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4442
			foreach ( $this->stats as $group => $stats ) {
4443
				if ( is_array( $stats ) && count( $stats ) ) {
4444
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4445
					if ( 'server_side' === $method ) {
4446
						self::do_server_side_stat( $args );
4447
					} else {
4448
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4449
					}
4450
				}
4451
				unset( $this->stats[ $group ] );
4452
			}
4453
		}
4454
	}
4455
4456
	/**
4457
	 * Runs stats code for a one-off, server-side.
4458
	 *
4459
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4460
	 *
4461
	 * @return bool If it worked.
4462
	 */
4463
	static function do_server_side_stat( $args ) {
4464
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4465
		if ( is_wp_error( $response ) )
4466
			return false;
4467
4468
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4469
			return false;
4470
4471
		return true;
4472
	}
4473
4474
	/**
4475
	 * Builds the stats url.
4476
	 *
4477
	 * @param $args array|string The arguments to append to the URL.
4478
	 *
4479
	 * @return string The URL to be pinged.
4480
	 */
4481
	static function build_stats_url( $args ) {
4482
		$defaults = array(
4483
			'v'    => 'wpcom2',
4484
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4485
		);
4486
		$args     = wp_parse_args( $args, $defaults );
4487
		/**
4488
		 * Filter the URL used as the Stats tracking pixel.
4489
		 *
4490
		 * @since 2.3.2
4491
		 *
4492
		 * @param string $url Base URL used as the Stats tracking pixel.
4493
		 */
4494
		$base_url = apply_filters(
4495
			'jetpack_stats_base_url',
4496
			'https://pixel.wp.com/g.gif'
4497
		);
4498
		$url      = add_query_arg( $args, $base_url );
4499
		return $url;
4500
	}
4501
4502
	static function translate_current_user_to_role() {
4503
		foreach ( self::$capability_translations as $role => $cap ) {
4504
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4505
				return $role;
4506
			}
4507
		}
4508
4509
		return false;
4510
	}
4511
4512
	static function translate_user_to_role( $user ) {
4513
		foreach ( self::$capability_translations as $role => $cap ) {
4514
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4515
				return $role;
4516
			}
4517
		}
4518
4519
		return false;
4520
    }
4521
4522
	static function translate_role_to_cap( $role ) {
4523
		if ( ! isset( self::$capability_translations[$role] ) ) {
4524
			return false;
4525
		}
4526
4527
		return self::$capability_translations[$role];
4528
	}
4529
4530
	static function sign_role( $role, $user_id = null ) {
4531
		if ( empty( $user_id ) ) {
4532
			$user_id = (int) get_current_user_id();
4533
		}
4534
4535
		if ( ! $user_id  ) {
4536
			return false;
4537
		}
4538
4539
		$token = Jetpack_Data::get_access_token();
4540
		if ( ! $token || is_wp_error( $token ) ) {
4541
			return false;
4542
		}
4543
4544
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4545
	}
4546
4547
4548
	/**
4549
	 * Builds a URL to the Jetpack connection auth page
4550
	 *
4551
	 * @since 3.9.5
4552
	 *
4553
	 * @param bool $raw If true, URL will not be escaped.
4554
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4555
	 *                              If string, will be a custom redirect.
4556
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4557
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4558
	 *
4559
	 * @return string Connect URL
4560
	 */
4561
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4562
		$site_id = Jetpack_Options::get_option( 'id' );
4563
		$token = Jetpack_Options::get_option( 'blog_token' );
4564
4565
		if ( $register || ! $token || ! $site_id ) {
4566
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4567
4568
			if ( ! empty( $redirect ) ) {
4569
				$url = add_query_arg(
4570
					'redirect',
4571
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4572
					$url
4573
				);
4574
			}
4575
4576
			if( is_network_admin() ) {
4577
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4578
			}
4579
		} else {
4580
4581
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4582
			// because otherwise this logic can get us in to a loop.
4583
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4584
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4585
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4586
4587
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4588
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4589
					'1.1'
4590
				);
4591
4592
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4593
					// Generating a register URL instead to refresh the existing token
4594
					return $this->build_connect_url( $raw, $redirect, $from, true );
4595
				}
4596
			}
4597
4598
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4599
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4600
			}
4601
4602
			$role = self::translate_current_user_to_role();
4603
			$signed_role = self::sign_role( $role );
4604
4605
			$user = wp_get_current_user();
4606
4607
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4608
			$redirect = $redirect
4609
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4610
				: $jetpack_admin_page;
4611
4612
			if( isset( $_REQUEST['is_multisite'] ) ) {
4613
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4614
			}
4615
4616
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4617
4618
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4619
				? get_site_icon_url()
4620
				: false;
4621
4622
			/**
4623
			 * Filter the type of authorization.
4624
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4625
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4626
			 *
4627
			 * @since 4.3.3
4628
			 *
4629
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4630
			 */
4631
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4632
4633
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4634
4635
			$args = urlencode_deep(
4636
				array(
4637
					'response_type' => 'code',
4638
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4639
					'redirect_uri'  => add_query_arg(
4640
						array(
4641
							'action'   => 'authorize',
4642
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4643
							'redirect' => urlencode( $redirect ),
4644
						),
4645
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4646
					),
4647
					'state'         => $user->ID,
4648
					'scope'         => $signed_role,
4649
					'user_email'    => $user->user_email,
4650
					'user_login'    => $user->user_login,
4651
					'is_active'     => Jetpack::is_active(),
4652
					'jp_version'    => JETPACK__VERSION,
4653
					'auth_type'     => $auth_type,
4654
					'secret'        => $secrets['secret_1'],
4655
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4656
					'blogname'      => get_option( 'blogname' ),
4657
					'site_url'      => site_url(),
4658
					'home_url'      => home_url(),
4659
					'site_icon'     => $site_icon,
4660
					'site_lang'     => get_locale(),
4661
					'_ui'           => $tracks_identity['_ui'],
4662
					'_ut'           => $tracks_identity['_ut']
4663
				)
4664
			);
4665
4666
			self::apply_activation_source_to_args( $args );
4667
4668
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4669
		}
4670
4671
		if ( $from ) {
4672
			$url = add_query_arg( 'from', $from, $url );
4673
		}
4674
4675
4676
		if ( isset( $_GET['calypso_env'] ) ) {
4677
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4678
		}
4679
4680
		return $raw ? $url : esc_url( $url );
4681
	}
4682
4683
	public static function apply_activation_source_to_args( &$args ) {
4684
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4685
4686
		if ( $activation_source_name ) {
4687
			$args['_as'] = urlencode( $activation_source_name );
4688
		}
4689
4690
		if ( $activation_source_keyword ) {
4691
			$args['_ak'] = urlencode( $activation_source_keyword );
4692
		}
4693
	}
4694
4695
	function build_reconnect_url( $raw = false ) {
4696
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4697
		return $raw ? $url : esc_url( $url );
4698
	}
4699
4700
	public static function admin_url( $args = null ) {
4701
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4702
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4703
		return $url;
4704
	}
4705
4706
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4707
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4708
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4709
	}
4710
4711
	function dismiss_jetpack_notice() {
4712
4713
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4714
			return;
4715
		}
4716
4717
		switch( $_GET['jetpack-notice'] ) {
4718
			case 'dismiss':
4719
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4720
4721
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4722
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4723
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4724
				}
4725
				break;
4726 View Code Duplication
			case 'jetpack-manage-opt-out':
4727
4728
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4729
					// Don't show the banner again
4730
4731
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4732
					// redirect back to the page that had the notice
4733
					if ( wp_get_referer() ) {
4734
						wp_safe_redirect( wp_get_referer() );
4735
					} else {
4736
						// Take me to Jetpack
4737
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4738
					}
4739
				}
4740
				break;
4741 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
4742
4743
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4744
					// Don't show the banner again
4745
4746
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4747
					// redirect back to the page that had the notice
4748
					if ( wp_get_referer() ) {
4749
						wp_safe_redirect( wp_get_referer() );
4750
					} else {
4751
						// Take me to Jetpack
4752
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4753
					}
4754
				}
4755
				break;
4756
			case 'jetpack-manage-opt-in':
4757
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4758
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4759
4760
					$redirection_url = Jetpack::admin_url();
4761
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4762
4763
					// Don't redirect form the Jetpack Setting Page
4764
					$referer_parsed = parse_url ( wp_get_referer() );
4765
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4766
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4767
						// Take the user to Jetpack home except when on the setting page
4768
						$redirection_url = wp_get_referer();
4769
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4770
					}
4771
					// Also update the JSON API FULL MANAGEMENT Option
4772
					Jetpack::activate_module( 'manage', false, false );
4773
4774
					// Special Message when option in.
4775
					Jetpack::state( 'optin-manage', 'true' );
4776
					// Activate the Module if not activated already
4777
4778
					// Redirect properly
4779
					wp_safe_redirect( $redirection_url );
4780
4781
				}
4782
				break;
4783
		}
4784
	}
4785
4786
	public static function admin_screen_configure_module( $module_id ) {
4787
4788
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4789
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4790
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4791
				/**
4792
				 * Fires to diplay a custom module activation screen.
4793
				 *
4794
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4795
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4796
				 *
4797
				 * @module manage
4798
				 *
4799
				 * @since 3.8.0
4800
				 *
4801
				 * @param int $module_id Module ID.
4802
				 */
4803
				do_action( 'display_activate_module_setting_' . $module_id );
4804
			} else {
4805
				self::display_activate_module_link( $module_id );
4806
			}
4807
4808
			return false;
4809
		} ?>
4810
4811
		<div id="jp-settings-screen" style="position: relative">
4812
			<h3>
4813
			<?php
4814
				$module = Jetpack::get_module( $module_id );
4815
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4816
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4817
			?>
4818
			</h3>
4819
			<?php
4820
				/**
4821
				 * Fires within the displayed message when a feature configuation is updated.
4822
				 *
4823
				 * @since 3.4.0
4824
				 *
4825
				 * @param int $module_id Module ID.
4826
				 */
4827
				do_action( 'jetpack_notices_update_settings', $module_id );
4828
				/**
4829
				 * Fires when a feature configuation screen is loaded.
4830
				 * The dynamic part of the hook, $module_id, is the module ID.
4831
				 *
4832
				 * @since 1.1.0
4833
				 */
4834
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4835
			?>
4836
		</div><?php
4837
	}
4838
4839
	/**
4840
	 * Display link to activate the module to see the settings screen.
4841
	 * @param  string $module_id
4842
	 * @return null
4843
	 */
4844
	public static function display_activate_module_link( $module_id ) {
4845
4846
		$info =  Jetpack::get_module( $module_id );
4847
		$extra = '';
4848
		$activate_url = wp_nonce_url(
4849
				Jetpack::admin_url(
4850
					array(
4851
						'page'   => 'jetpack',
4852
						'action' => 'activate',
4853
						'module' => $module_id,
4854
					)
4855
				),
4856
				"jetpack_activate-$module_id"
4857
			);
4858
4859
		?>
4860
4861
		<div class="wrap configure-module">
4862
			<div id="jp-settings-screen">
4863
				<?php
4864
				if ( $module_id == 'json-api' ) {
4865
4866
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4867
4868
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4869
4870
					$info['description'] = sprintf( __( 'Manage your multiple Jetpack sites from our centralized dashboard at wordpress.com/sites. <a href="%s" target="_blank">Learn more</a>.', 'jetpack' ), 'https://jetpack.com/support/site-management' );
4871
4872
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4873
				} ?>
4874
4875
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4876
				<div class="narrow">
4877
					<p><?php echo  $info['description']; ?></p>
4878
					<?php if( $extra ) { ?>
4879
					<p><?php echo esc_html( $extra ); ?></p>
4880
					<?php } ?>
4881
					<p>
4882
						<?php
4883
						if( wp_get_referer() ) {
4884
							printf( __( '<a class="button-primary" href="%s">Activate Now</a> or <a href="%s" >return to previous page</a>.', 'jetpack' ) , $activate_url, wp_get_referer() );
4885
						} else {
4886
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4887
						} ?>
4888
					</p>
4889
				</div>
4890
4891
			</div>
4892
		</div>
4893
4894
		<?php
4895
	}
4896
4897
	public static function sort_modules( $a, $b ) {
4898
		if ( $a['sort'] == $b['sort'] )
4899
			return 0;
4900
4901
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4902
	}
4903
4904
	function ajax_recheck_ssl() {
4905
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4906
		$result = Jetpack::permit_ssl( true );
4907
		wp_send_json( array(
4908
			'enabled' => $result,
4909
			'message' => get_transient( 'jetpack_https_test_message' )
4910
		) );
4911
	}
4912
4913
/* Client API */
4914
4915
	/**
4916
	 * Returns the requested Jetpack API URL
4917
	 *
4918
	 * @return string
4919
	 */
4920
	public static function api_url( $relative_url ) {
4921
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4922
	}
4923
4924
	/**
4925
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4926
	 */
4927
	public static function fix_url_for_bad_hosts( $url ) {
4928
		if ( 0 !== strpos( $url, 'https://' ) ) {
4929
			return $url;
4930
		}
4931
4932
		switch ( JETPACK_CLIENT__HTTPS ) {
4933
			case 'ALWAYS' :
4934
				return $url;
4935
			case 'NEVER' :
4936
				return set_url_scheme( $url, 'http' );
4937
			// default : case 'AUTO' :
4938
		}
4939
4940
		// we now return the unmodified SSL URL by default, as a security precaution
4941
		return $url;
4942
	}
4943
4944
	/**
4945
	 * Create a random secret for validating onboarding payload
4946
	 *
4947
	 * @return string Secret token
4948
	 */
4949
	public static function create_onboarding_token() {
4950
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4951
			$token = wp_generate_password( 32, false );
4952
			Jetpack_Options::update_option( 'onboarding', $token );
4953
		}
4954
4955
		return $token;
4956
	}
4957
4958
	/**
4959
	 * Remove the onboarding token
4960
	 *
4961
	 * @return bool True on success, false on failure
4962
	 */
4963
	public static function invalidate_onboarding_token() {
4964
		return Jetpack_Options::delete_option( 'onboarding' );
4965
	}
4966
4967
	/**
4968
	 * Validate an onboarding token for a specific action
4969
	 *
4970
	 * @return boolean True if token/action pair is accepted, false if not
4971
	 */
4972
	public static function validate_onboarding_token_action( $token, $action ) {
4973
		// Compare tokens, bail if tokens do not match
4974
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
4975
			return false;
4976
		}
4977
4978
		// List of valid actions we can take
4979
		$valid_actions = array(
4980
			'/jetpack/v4/settings',
4981
		);
4982
4983
		// Whitelist the action
4984
		if ( ! in_array( $action, $valid_actions ) ) {
4985
			return false;
4986
		}
4987
4988
		return true;
4989
	}
4990
4991
	/**
4992
	 * Checks to see if the URL is using SSL to connect with Jetpack
4993
	 *
4994
	 * @since 2.3.3
4995
	 * @return boolean
4996
	 */
4997
	public static function permit_ssl( $force_recheck = false ) {
4998
		// Do some fancy tests to see if ssl is being supported
4999
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5000
			$message = '';
5001
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5002
				$ssl = 0;
5003
			} else {
5004
				switch ( JETPACK_CLIENT__HTTPS ) {
5005
					case 'NEVER':
5006
						$ssl = 0;
5007
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5008
						break;
5009
					case 'ALWAYS':
5010
					case 'AUTO':
5011
					default:
5012
						$ssl = 1;
5013
						break;
5014
				}
5015
5016
				// If it's not 'NEVER', test to see
5017
				if ( $ssl ) {
5018
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5019
						$ssl = 0;
5020
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5021
					} else {
5022
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5023
						if ( is_wp_error( $response ) ) {
5024
							$ssl = 0;
5025
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5026
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5027
							$ssl = 0;
5028
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5029
						}
5030
					}
5031
				}
5032
			}
5033
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5034
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5035
		}
5036
5037
		return (bool) $ssl;
5038
	}
5039
5040
	/*
5041
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5042
	 */
5043
	public function alert_auto_ssl_fail() {
5044
		if ( ! current_user_can( 'manage_options' ) )
5045
			return;
5046
5047
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5048
		?>
5049
5050
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5051
			<div class="jp-banner__content">
5052
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5053
				<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>
5054
				<p>
5055
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5056
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5057
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5058
				</p>
5059
				<p>
5060
					<?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' ),
5061
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
5062
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
5063
				</p>
5064
			</div>
5065
		</div>
5066
		<style>
5067
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5068
		</style>
5069
		<script type="text/javascript">
5070
			jQuery( document ).ready( function( $ ) {
5071
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5072
					var $this = $( this );
5073
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5074
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5075
					e.preventDefault();
5076
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5077
					$.post( ajaxurl, data )
5078
					  .done( function( response ) {
5079
					  	if ( response.enabled ) {
5080
					  		$( '#jetpack-ssl-warning' ).hide();
5081
					  	} else {
5082
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5083
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5084
					  	}
5085
					  }.bind( $this ) );
5086
				} );
5087
			} );
5088
		</script>
5089
5090
		<?php
5091
	}
5092
5093
	/**
5094
	 * Returns the Jetpack XML-RPC API
5095
	 *
5096
	 * @return string
5097
	 */
5098
	public static function xmlrpc_api_url() {
5099
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5100
		return untrailingslashit( $base ) . '/xmlrpc.php';
5101
	}
5102
5103
	/**
5104
	 * Creates two secret tokens and the end of life timestamp for them.
5105
	 *
5106
	 * Note these tokens are unique per call, NOT static per site for connecting.
5107
	 *
5108
	 * @since 2.6
5109
	 * @return array
5110
	 */
5111
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5112
		if ( ! $user_id ) {
5113
			$user_id = get_current_user_id();
5114
		}
5115
5116
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5117
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5118
5119
		if (
5120
			isset( $secrets[ $secret_name ] ) &&
5121
			$secrets[ $secret_name ]['exp'] > time()
5122
		) {
5123
			return $secrets[ $secret_name ];
5124
		}
5125
5126
		$secret_value = array(
5127
			'secret_1'  => wp_generate_password( 32, false ),
5128
			'secret_2'  => wp_generate_password( 32, false ),
5129
			'exp'       => time() + $exp,
5130
		);
5131
5132
		$secrets[ $secret_name ] = $secret_value;
5133
5134
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5135
		return $secrets[ $secret_name ];
5136
	}
5137
5138
	public static function get_secrets( $action, $user_id ) {
5139
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5140
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5141
5142
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5143
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5144
		}
5145
5146
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5147
			self::delete_secrets( $action, $user_id );
5148
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5149
		}
5150
5151
		return $secrets[ $secret_name ];
5152
	}
5153
5154
	public static function delete_secrets( $action, $user_id ) {
5155
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5156
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5157
		if ( isset( $secrets[ $secret_name ] ) ) {
5158
			unset( $secrets[ $secret_name ] );
5159
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5160
		}
5161
	}
5162
5163
	/**
5164
	 * Builds the timeout limit for queries talking with the wpcom servers.
5165
	 *
5166
	 * Based on local php max_execution_time in php.ini
5167
	 *
5168
	 * @since 2.6
5169
	 * @return int
5170
	 * @deprecated
5171
	 **/
5172
	public function get_remote_query_timeout_limit() {
5173
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5174
		return Jetpack::get_max_execution_time();
5175
	}
5176
5177
	/**
5178
	 * Builds the timeout limit for queries talking with the wpcom servers.
5179
	 *
5180
	 * Based on local php max_execution_time in php.ini
5181
	 *
5182
	 * @since 5.4
5183
	 * @return int
5184
	 **/
5185
	public static function get_max_execution_time() {
5186
		$timeout = (int) ini_get( 'max_execution_time' );
5187
5188
		// Ensure exec time set in php.ini
5189
		if ( ! $timeout ) {
5190
			$timeout = 30;
5191
		}
5192
		return $timeout;
5193
	}
5194
5195
	/**
5196
	 * Sets a minimum request timeout, and returns the current timeout
5197
	 *
5198
	 * @since 5.4
5199
	 **/
5200
	public static function set_min_time_limit( $min_timeout ) {
5201
		$timeout = self::get_max_execution_time();
5202
		if ( $timeout < $min_timeout ) {
5203
			$timeout = $min_timeout;
5204
			set_time_limit( $timeout );
5205
		}
5206
		return $timeout;
5207
	}
5208
5209
5210
	/**
5211
	 * Takes the response from the Jetpack register new site endpoint and
5212
	 * verifies it worked properly.
5213
	 *
5214
	 * @since 2.6
5215
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5216
	 **/
5217
	public function validate_remote_register_response( $response ) {
5218
	  if ( is_wp_error( $response ) ) {
5219
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5220
		}
5221
5222
		$code   = wp_remote_retrieve_response_code( $response );
5223
		$entity = wp_remote_retrieve_body( $response );
5224
		if ( $entity )
5225
			$registration_response = json_decode( $entity );
5226
		else
5227
			$registration_response = false;
5228
5229
		$code_type = intval( $code / 100 );
5230
		if ( 5 == $code_type ) {
5231
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5232
		} elseif ( 408 == $code ) {
5233
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5234
		} elseif ( ! empty( $registration_response->error ) ) {
5235
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5236
				$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' );
5237
			} else {
5238
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5239
			}
5240
5241
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5242
		} elseif ( 200 != $code ) {
5243
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5244
		}
5245
5246
		// Jetpack ID error block
5247
		if ( empty( $registration_response->jetpack_id ) ) {
5248
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5249
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5250
			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 );
5251
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5252
			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 );
5253
		}
5254
5255
	    return $registration_response;
5256
	}
5257
	/**
5258
	 * @return bool|WP_Error
5259
	 */
5260
	public static function register() {
5261
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5262
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5263
		$secrets = Jetpack::generate_secrets( 'register' );
5264
5265 View Code Duplication
		if (
5266
			empty( $secrets['secret_1'] ) ||
5267
			empty( $secrets['secret_2'] ) ||
5268
			empty( $secrets['exp'] )
5269
		) {
5270
			return new Jetpack_Error( 'missing_secrets' );
5271
		}
5272
5273
		// better to try (and fail) to set a higher timeout than this system
5274
		// supports than to have register fail for more users than it should
5275
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5276
5277
		$gmt_offset = get_option( 'gmt_offset' );
5278
		if ( ! $gmt_offset ) {
5279
			$gmt_offset = 0;
5280
		}
5281
5282
		$stats_options = get_option( 'stats_options' );
5283
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5284
5285
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5286
5287
		$args = array(
5288
			'method'  => 'POST',
5289
			'body'    => array(
5290
				'siteurl'         => site_url(),
5291
				'home'            => home_url(),
5292
				'gmt_offset'      => $gmt_offset,
5293
				'timezone_string' => (string) get_option( 'timezone_string' ),
5294
				'site_name'       => (string) get_option( 'blogname' ),
5295
				'secret_1'        => $secrets['secret_1'],
5296
				'secret_2'        => $secrets['secret_2'],
5297
				'site_lang'       => get_locale(),
5298
				'timeout'         => $timeout,
5299
				'stats_id'        => $stats_id,
5300
				'state'           => get_current_user_id(),
5301
				'_ui'             => $tracks_identity['_ui'],
5302
				'_ut'             => $tracks_identity['_ut'],
5303
				'jetpack_version' => JETPACK__VERSION
5304
			),
5305
			'headers' => array(
5306
				'Accept' => 'application/json',
5307
			),
5308
			'timeout' => $timeout,
5309
		);
5310
5311
		self::apply_activation_source_to_args( $args['body'] );
5312
5313
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5314
5315
		// Make sure the response is valid and does not contain any Jetpack errors
5316
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5317
		if ( is_wp_error( $registration_details ) ) {
5318
			return $registration_details;
5319
		} elseif ( ! $registration_details ) {
5320
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5321
		}
5322
5323 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5324
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5325
		}
5326
5327
		if ( isset( $registration_details->jetpack_public ) ) {
5328
			$jetpack_public = (int) $registration_details->jetpack_public;
5329
		} else {
5330
			$jetpack_public = false;
5331
		}
5332
5333
		Jetpack_Options::update_options(
5334
			array(
5335
				'id'         => (int)    $registration_details->jetpack_id,
5336
				'blog_token' => (string) $registration_details->jetpack_secret,
5337
				'public'     => $jetpack_public,
5338
			)
5339
		);
5340
5341
		/**
5342
		 * Fires when a site is registered on WordPress.com.
5343
		 *
5344
		 * @since 3.7.0
5345
		 *
5346
		 * @param int $json->jetpack_id Jetpack Blog ID.
5347
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5348
		 * @param int|bool $jetpack_public Is the site public.
5349
		 */
5350
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5351
5352
		// Initialize Jump Start for the first and only time.
5353
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5354
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5355
5356
			$jetpack = Jetpack::init();
5357
5358
			$jetpack->stat( 'jumpstart', 'unique-views' );
5359
			$jetpack->do_stats( 'server_side' );
5360
		};
5361
5362
		return true;
5363
	}
5364
5365
	/**
5366
	 * If the db version is showing something other that what we've got now, bump it to current.
5367
	 *
5368
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

Loading history...
5369
	 */
5370
	public static function maybe_set_version_option() {
5371
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5372
		if ( JETPACK__VERSION != $version ) {
5373
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5374
5375
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5376
				/** This action is documented in class.jetpack.php */
5377
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5378
			}
5379
5380
			return true;
5381
		}
5382
		return false;
5383
	}
5384
5385
/* Client Server API */
5386
5387
	/**
5388
	 * Loads the Jetpack XML-RPC client
5389
	 */
5390
	public static function load_xml_rpc_client() {
5391
		require_once ABSPATH . WPINC . '/class-IXR.php';
5392
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5393
	}
5394
5395
	/**
5396
	 * Resets the saved authentication state in between testing requests.
5397
	 */
5398
	public function reset_saved_auth_state() {
5399
		$this->xmlrpc_verification = null;
5400
		$this->rest_authentication_status = null;
5401
	}
5402
5403
	function verify_xml_rpc_signature() {
5404
		if ( $this->xmlrpc_verification ) {
5405
			return $this->xmlrpc_verification;
5406
		}
5407
5408
		// It's not for us
5409
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5410
			return false;
5411
		}
5412
5413
		@list( $token_key, $version, $user_id ) = explode( ':', $_GET['token'] );
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...
5414
		if (
5415
			empty( $token_key )
5416
		||
5417
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5418
		) {
5419
			return false;
5420
		}
5421
5422
		if ( '0' === $user_id ) {
5423
			$token_type = 'blog';
5424
			$user_id = 0;
5425
		} else {
5426
			$token_type = 'user';
5427
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5428
				return false;
5429
			}
5430
			$user_id = (int) $user_id;
5431
5432
			$user = new WP_User( $user_id );
5433
			if ( ! $user || ! $user->exists() ) {
5434
				return false;
5435
			}
5436
		}
5437
5438
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id 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...
5439
		if ( ! $token ) {
5440
			return false;
5441
		}
5442
5443
		$token_check = "$token_key.";
5444
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
5445
			return false;
5446
		}
5447
5448
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5449
5450
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5451
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5452
			$post_data   = $_POST;
5453
			$file_hashes = array();
5454
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5455
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5456
					continue;
5457
				}
5458
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5459
				$file_hashes[$post_data_key] = $post_data_value;
5460
			}
5461
5462
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5463
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5464
				$post_data[$post_data_key] = $post_data_value;
5465
			}
5466
5467
			ksort( $post_data );
5468
5469
			$body = http_build_query( stripslashes_deep( $post_data ) );
5470
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5471
			$body = file_get_contents( 'php://input' );
5472
		} else {
5473
			$body = null;
5474
		}
5475
5476
		$signature = $jetpack_signature->sign_current_request(
5477
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5478
		);
5479
5480
		if ( ! $signature ) {
5481
			return false;
5482
		} else if ( is_wp_error( $signature ) ) {
5483
			return $signature;
5484
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
5485
			return false;
5486
		}
5487
5488
		$timestamp = (int) $_GET['timestamp'];
5489
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5490
5491
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5492
			return false;
5493
		}
5494
5495
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5496
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5497
			if ( ! empty( $_GET['onboarding'] ) ) {
5498
				$jpo = $_GET;
5499
			} else {
5500
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5501
			}
5502
5503
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5504
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5505
5506
			if (
5507
				isset( $jpo_user ) && isset( $jpo_token ) &&
5508
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5509
				isset( $_GET['rest_route'] ) &&
5510
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5511
			) {
5512
				$jpUser = get_user_by( 'email', $jpo_user );
5513
				if ( is_a( $jpUser, 'WP_User' ) ) {
5514
					wp_set_current_user( $jpUser->ID );
5515
					$user_can = is_multisite()
5516
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5517
						: current_user_can( 'manage_options' );
5518
					if ( $user_can ) {
5519
						$token_type = 'user';
5520
						$token->external_user_id = $jpUser->ID;
5521
					}
5522
				}
5523
			}
5524
		}
5525
5526
		$this->xmlrpc_verification = array(
5527
			'type'    => $token_type,
5528
			'user_id' => $token->external_user_id,
5529
		);
5530
5531
		return $this->xmlrpc_verification;
5532
	}
5533
5534
	/**
5535
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5536
	 */
5537
	function authenticate_jetpack( $user, $username, $password ) {
5538
		if ( is_a( $user, 'WP_User' ) ) {
5539
			return $user;
5540
		}
5541
5542
		$token_details = $this->verify_xml_rpc_signature();
5543
5544
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5545
			return $user;
5546
		}
5547
5548
		if ( 'user' !== $token_details['type'] ) {
5549
			return $user;
5550
		}
5551
5552
		if ( ! $token_details['user_id'] ) {
5553
			return $user;
5554
		}
5555
5556
		nocache_headers();
5557
5558
		return new WP_User( $token_details['user_id'] );
5559
	}
5560
5561
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5562
	// Uses the existing XMLRPC request signing implementation.
5563
	function wp_rest_authenticate( $user ) {
5564
		if ( ! empty( $user ) ) {
5565
			// Another authentication method is in effect.
5566
			return $user;
5567
		}
5568
5569
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5570
			// Nothing to do for this authentication method.
5571
			return null;
5572
		}
5573
5574
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5575
			// Nothing to do for this authentication method.
5576
			return null;
5577
		}
5578
5579
		// Ensure that we always have the request body available.  At this
5580
		// point, the WP REST API code to determine the request body has not
5581
		// run yet.  That code may try to read from 'php://input' later, but
5582
		// this can only be done once per request in PHP versions prior to 5.6.
5583
		// So we will go ahead and perform this read now if needed, and save
5584
		// the request body where both the Jetpack signature verification code
5585
		// and the WP REST API code can see it.
5586
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5587
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5588
		}
5589
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5590
5591
		// Only support specific request parameters that have been tested and
5592
		// are known to work with signature verification.  A different method
5593
		// can be passed to the WP REST API via the '?_method=' parameter if
5594
		// needed.
5595
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5596
			$this->rest_authentication_status = new WP_Error(
5597
				'rest_invalid_request',
5598
				__( 'This request method is not supported.', 'jetpack' ),
5599
				array( 'status' => 400 )
5600
			);
5601
			return null;
5602
		}
5603
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5604
			$this->rest_authentication_status = new WP_Error(
5605
				'rest_invalid_request',
5606
				__( 'This request method does not support body parameters.', 'jetpack' ),
5607
				array( 'status' => 400 )
5608
			);
5609
			return null;
5610
		}
5611
5612
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5613
			$content_type = $_SERVER['CONTENT_TYPE'];
5614
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5615
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5616
		}
5617
5618
		if (
5619
			isset( $content_type ) &&
5620
			$content_type !== 'application/x-www-form-urlencoded' &&
5621
			$content_type !== 'application/json'
5622
		) {
5623
			$this->rest_authentication_status = new WP_Error(
5624
				'rest_invalid_request',
5625
				__( 'This Content-Type is not supported.', 'jetpack' ),
5626
				array( 'status' => 400 )
5627
			);
5628
			return null;
5629
		}
5630
5631
		$verified = $this->verify_xml_rpc_signature();
5632
5633
		if ( is_wp_error( $verified ) ) {
5634
			$this->rest_authentication_status = $verified;
5635
			return null;
5636
		}
5637
5638
		if (
5639
			$verified &&
5640
			isset( $verified['type'] ) &&
5641
			'user' === $verified['type'] &&
5642
			! empty( $verified['user_id'] )
5643
		) {
5644
			// Authentication successful.
5645
			$this->rest_authentication_status = true;
5646
			return $verified['user_id'];
5647
		}
5648
5649
		// Something else went wrong.  Probably a signature error.
5650
		$this->rest_authentication_status = new WP_Error(
5651
			'rest_invalid_signature',
5652
			__( 'The request is not signed correctly.', 'jetpack' ),
5653
			array( 'status' => 400 )
5654
		);
5655
		return null;
5656
	}
5657
5658
	/**
5659
	 * Report authentication status to the WP REST API.
5660
	 *
5661
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
5662
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5663
	 */
5664
	public function wp_rest_authentication_errors( $value ) {
5665
		if ( $value !== null ) {
5666
			return $value;
5667
		}
5668
		return $this->rest_authentication_status;
5669
	}
5670
5671
	function add_nonce( $timestamp, $nonce ) {
5672
		global $wpdb;
5673
		static $nonces_used_this_request = array();
5674
5675
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5676
			return $nonces_used_this_request["$timestamp:$nonce"];
5677
		}
5678
5679
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5680
		$timestamp = (int) $timestamp;
5681
		$nonce     = esc_sql( $nonce );
5682
5683
		// Raw query so we can avoid races: add_option will also update
5684
		$show_errors = $wpdb->show_errors( false );
5685
5686
		$old_nonce = $wpdb->get_row(
5687
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5688
		);
5689
5690
		if ( is_null( $old_nonce ) ) {
5691
			$return = $wpdb->query(
5692
				$wpdb->prepare(
5693
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5694
					"jetpack_nonce_{$timestamp}_{$nonce}",
5695
					time(),
5696
					'no'
5697
				)
5698
			);
5699
		} else {
5700
			$return = false;
5701
		}
5702
5703
		$wpdb->show_errors( $show_errors );
5704
5705
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5706
5707
		return $return;
5708
	}
5709
5710
	/**
5711
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5712
	 * Capture it here so we can verify the signature later.
5713
	 */
5714
	function xmlrpc_methods( $methods ) {
5715
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5716
		return $methods;
5717
	}
5718
5719
	function public_xmlrpc_methods( $methods ) {
5720
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5721
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5722
		}
5723
		return $methods;
5724
	}
5725
5726
	function jetpack_getOptions( $args ) {
5727
		global $wp_xmlrpc_server;
5728
5729
		$wp_xmlrpc_server->escape( $args );
5730
5731
		$username	= $args[1];
5732
		$password	= $args[2];
5733
5734
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5735
			return $wp_xmlrpc_server->error;
5736
		}
5737
5738
		$options = array();
5739
		$user_data = $this->get_connected_user_data();
5740
		if ( is_array( $user_data ) ) {
5741
			$options['jetpack_user_id'] = array(
5742
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5743
				'readonly'      => true,
5744
				'value'         => $user_data['ID'],
5745
			);
5746
			$options['jetpack_user_login'] = array(
5747
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5748
				'readonly'      => true,
5749
				'value'         => $user_data['login'],
5750
			);
5751
			$options['jetpack_user_email'] = array(
5752
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5753
				'readonly'      => true,
5754
				'value'         => $user_data['email'],
5755
			);
5756
			$options['jetpack_user_site_count'] = array(
5757
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5758
				'readonly'      => true,
5759
				'value'         => $user_data['site_count'],
5760
			);
5761
		}
5762
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5763
		$args = stripslashes_deep( $args );
5764
		return $wp_xmlrpc_server->wp_getOptions( $args );
5765
	}
5766
5767
	function xmlrpc_options( $options ) {
5768
		$jetpack_client_id = false;
5769
		if ( self::is_active() ) {
5770
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5771
		}
5772
		$options['jetpack_version'] = array(
5773
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5774
				'readonly'      => true,
5775
				'value'         => JETPACK__VERSION,
5776
		);
5777
5778
		$options['jetpack_client_id'] = array(
5779
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5780
				'readonly'      => true,
5781
				'value'         => $jetpack_client_id,
5782
		);
5783
		return $options;
5784
	}
5785
5786
	public static function clean_nonces( $all = false ) {
5787
		global $wpdb;
5788
5789
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5790
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5791
5792
		if ( true !== $all ) {
5793
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5794
			$sql_args[] = time() - 3600;
5795
		}
5796
5797
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5798
5799
		$sql = $wpdb->prepare( $sql, $sql_args );
5800
5801
		for ( $i = 0; $i < 1000; $i++ ) {
5802
			if ( ! $wpdb->query( $sql ) ) {
5803
				break;
5804
			}
5805
		}
5806
	}
5807
5808
	/**
5809
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5810
	 * SET: state( $key, $value );
5811
	 * GET: $value = state( $key );
5812
	 *
5813
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

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

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

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

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

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

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

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

Loading history...
5815
	 * @param bool $restate private
5816
	 */
5817
	public static function state( $key = null, $value = null, $restate = false ) {
5818
		static $state = array();
5819
		static $path, $domain;
5820
		if ( ! isset( $path ) ) {
5821
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5822
			$admin_url = Jetpack::admin_url();
5823
			$bits      = parse_url( $admin_url );
5824
5825
			if ( is_array( $bits ) ) {
5826
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5827
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5828
			} else {
5829
				$path = $domain = null;
5830
			}
5831
		}
5832
5833
		// Extract state from cookies and delete cookies
5834
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5835
			$yum = $_COOKIE[ 'jetpackState' ];
5836
			unset( $_COOKIE[ 'jetpackState' ] );
5837
			foreach ( $yum as $k => $v ) {
5838
				if ( strlen( $v ) )
5839
					$state[ $k ] = $v;
5840
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5841
			}
5842
		}
5843
5844
		if ( $restate ) {
5845
			foreach ( $state as $k => $v ) {
5846
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5847
			}
5848
			return;
5849
		}
5850
5851
		// Get a state variable
5852
		if ( isset( $key ) && ! isset( $value ) ) {
5853
			if ( array_key_exists( $key, $state ) )
5854
				return $state[ $key ];
5855
			return null;
5856
		}
5857
5858
		// Set a state variable
5859
		if ( isset ( $key ) && isset( $value ) ) {
5860
			if( is_array( $value ) && isset( $value[0] ) ) {
5861
				$value = $value[0];
5862
			}
5863
			$state[ $key ] = $value;
5864
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5865
		}
5866
	}
5867
5868
	public static function restate() {
5869
		Jetpack::state( null, null, true );
5870
	}
5871
5872
	public static function check_privacy( $file ) {
5873
		static $is_site_publicly_accessible = null;
5874
5875
		if ( is_null( $is_site_publicly_accessible ) ) {
5876
			$is_site_publicly_accessible = false;
5877
5878
			Jetpack::load_xml_rpc_client();
5879
			$rpc = new Jetpack_IXR_Client();
5880
5881
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5882
			if ( $success ) {
5883
				$response = $rpc->getResponse();
5884
				if ( $response ) {
5885
					$is_site_publicly_accessible = true;
5886
				}
5887
			}
5888
5889
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5890
		}
5891
5892
		if ( $is_site_publicly_accessible ) {
5893
			return;
5894
		}
5895
5896
		$module_slug = self::get_module_slug( $file );
5897
5898
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5899
		if ( ! $privacy_checks ) {
5900
			$privacy_checks = $module_slug;
5901
		} else {
5902
			$privacy_checks .= ",$module_slug";
5903
		}
5904
5905
		Jetpack::state( 'privacy_checks', $privacy_checks );
5906
	}
5907
5908
	/**
5909
	 * Helper method for multicall XMLRPC.
5910
	 */
5911
	public static function xmlrpc_async_call() {
5912
		global $blog_id;
5913
		static $clients = array();
5914
5915
		$client_blog_id = is_multisite() ? $blog_id : 0;
5916
5917
		if ( ! isset( $clients[$client_blog_id] ) ) {
5918
			Jetpack::load_xml_rpc_client();
5919
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5920
			if ( function_exists( 'ignore_user_abort' ) ) {
5921
				ignore_user_abort( true );
5922
			}
5923
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5924
		}
5925
5926
		$args = func_get_args();
5927
5928
		if ( ! empty( $args[0] ) ) {
5929
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5930
		} elseif ( is_multisite() ) {
5931
			foreach ( $clients as $client_blog_id => $client ) {
5932
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5933
					continue;
5934
				}
5935
5936
				$switch_success = switch_to_blog( $client_blog_id, true );
5937
				if ( ! $switch_success ) {
5938
					continue;
5939
				}
5940
5941
				flush();
5942
				$client->query();
5943
5944
				restore_current_blog();
5945
			}
5946
		} else {
5947
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5948
				flush();
5949
				$clients[0]->query();
5950
			}
5951
		}
5952
	}
5953
5954
	public static function staticize_subdomain( $url ) {
5955
5956
		// Extract hostname from URL
5957
		$host = parse_url( $url, PHP_URL_HOST );
5958
5959
		// Explode hostname on '.'
5960
		$exploded_host = explode( '.', $host );
5961
5962
		// Retrieve the name and TLD
5963
		if ( count( $exploded_host ) > 1 ) {
5964
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5965
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5966
			// Rebuild domain excluding subdomains
5967
			$domain = $name . '.' . $tld;
5968
		} else {
5969
			$domain = $host;
5970
		}
5971
		// Array of Automattic domains
5972
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5973
5974
		// Return $url if not an Automattic domain
5975
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5976
			return $url;
5977
		}
5978
5979
		if ( is_ssl() ) {
5980
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5981
		}
5982
5983
		srand( crc32( basename( $url ) ) );
5984
		$static_counter = rand( 0, 2 );
5985
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5986
5987
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5988
	}
5989
5990
/* JSON API Authorization */
5991
5992
	/**
5993
	 * Handles the login action for Authorizing the JSON API
5994
	 */
5995
	function login_form_json_api_authorization() {
5996
		$this->verify_json_api_authorization_request();
5997
5998
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5999
6000
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6001
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6002
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6003
	}
6004
6005
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6006
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6007
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6008
			return $url;
6009
		}
6010
6011
		$parsed_url = parse_url( $url );
6012
		$url = strtok( $url, '?' );
6013
		$url = "$url?{$_SERVER['QUERY_STRING']}";
6014
		if ( ! empty( $parsed_url['query'] ) )
6015
			$url .= "&{$parsed_url['query']}";
6016
6017
		return $url;
6018
	}
6019
6020
	// Make sure the POSTed request is handled by the same action
6021
	function preserve_action_in_login_form_for_json_api_authorization() {
6022
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6023
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6024
	}
6025
6026
	// If someone logs in to approve API access, store the Access Code in usermeta
6027
	function store_json_api_authorization_token( $user_login, $user ) {
6028
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6029
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6030
		$token = wp_generate_password( 32, false );
6031
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6032
	}
6033
6034
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6035
	function allow_wpcom_public_api_domain( $domains ) {
6036
		$domains[] = 'public-api.wordpress.com';
6037
		return $domains;
6038
	}
6039
6040
	// Add all wordpress.com environments to the safe redirect whitelist
6041
	function allow_wpcom_environments( $domains ) {
6042
		$domains[] = 'wordpress.com';
6043
		$domains[] = 'wpcalypso.wordpress.com';
6044
		$domains[] = 'horizon.wordpress.com';
6045
		$domains[] = 'calypso.localhost';
6046
		return $domains;
6047
	}
6048
6049
	// Add the Access Code details to the public-api.wordpress.com redirect
6050
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6051
		return add_query_arg(
6052
			urlencode_deep(
6053
				array(
6054
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6055
					'jetpack-user-id' => (int) $user->ID,
6056
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6057
				)
6058
			),
6059
			$redirect_to
6060
		);
6061
	}
6062
6063
6064
	/**
6065
	 * Verifies the request by checking the signature
6066
	 *
6067
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6068
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6069
	 *
6070
	 * @param null|array $environment
6071
	 */
6072
	function verify_json_api_authorization_request( $environment = null ) {
6073
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6074
6075
		$environment = is_null( $environment )
6076
			? $_REQUEST
6077
			: $environment;
6078
6079
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken 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...
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
6080
		$token = Jetpack_Data::get_access_token( $envUserId );
6081
		if ( ! $token || empty( $token->secret ) ) {
6082
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6083
		}
6084
6085
		$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' );
6086
6087
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6088
6089
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6090
			$signature = $jetpack_signature->sign_request(
6091
				$environment['token'],
6092
				$environment['timestamp'],
6093
				$environment['nonce'],
6094
				'',
6095
				'GET',
6096
				$environment['jetpack_json_api_original_query'],
6097
				null,
6098
				true
6099
			);
6100
		} else {
6101
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6102
		}
6103
6104
		if ( ! $signature ) {
6105
			wp_die( $die_error );
6106
		} else if ( is_wp_error( $signature ) ) {
6107
			wp_die( $die_error );
6108
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
6109
			if ( is_ssl() ) {
6110
				// 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
6111
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6112
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
6113
					wp_die( $die_error );
6114
				}
6115
			} else {
6116
				wp_die( $die_error );
6117
			}
6118
		}
6119
6120
		$timestamp = (int) $environment['timestamp'];
6121
		$nonce     = stripslashes( (string) $environment['nonce'] );
6122
6123
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6124
			// De-nonce the nonce, at least for 5 minutes.
6125
			// 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)
6126
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6127
			if ( $old_nonce_time < time() - 300 ) {
6128
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6129
			}
6130
		}
6131
6132
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6133
		$data_filters = array(
6134
			'state'        => 'opaque',
6135
			'client_id'    => 'int',
6136
			'client_title' => 'string',
6137
			'client_image' => 'url',
6138
		);
6139
6140
		foreach ( $data_filters as $key => $sanitation ) {
6141
			if ( ! isset( $data->$key ) ) {
6142
				wp_die( $die_error );
6143
			}
6144
6145
			switch ( $sanitation ) {
6146
			case 'int' :
6147
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6148
				break;
6149
			case 'opaque' :
6150
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6151
				break;
6152
			case 'string' :
6153
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6154
				break;
6155
			case 'url' :
6156
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6157
				break;
6158
			}
6159
		}
6160
6161
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6162
			wp_die( $die_error );
6163
		}
6164
	}
6165
6166
	function login_message_json_api_authorization( $message ) {
6167
		return '<p class="message">' . sprintf(
6168
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6169
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6170
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6171
	}
6172
6173
	/**
6174
	 * Get $content_width, but with a <s>twist</s> filter.
6175
	 */
6176
	public static function get_content_width() {
6177
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6178
		/**
6179
		 * Filter the Content Width value.
6180
		 *
6181
		 * @since 2.2.3
6182
		 *
6183
		 * @param string $content_width Content Width value.
6184
		 */
6185
		return apply_filters( 'jetpack_content_width', $content_width );
6186
	}
6187
6188
	/**
6189
	 * Pings the WordPress.com Mirror Site for the specified options.
6190
	 *
6191
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6192
	 *
6193
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6194
	 */
6195
	public function get_cloud_site_options( $option_names ) {
6196
		$option_names = array_filter( (array) $option_names, 'is_string' );
6197
6198
		Jetpack::load_xml_rpc_client();
6199
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6200
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6201
		if ( $xml->isError() ) {
6202
			return array(
6203
				'error_code' => $xml->getErrorCode(),
6204
				'error_msg'  => $xml->getErrorMessage(),
6205
			);
6206
		}
6207
		$cloud_site_options = $xml->getResponse();
6208
6209
		return $cloud_site_options;
6210
	}
6211
6212
	/**
6213
	 * Checks if the site is currently in an identity crisis.
6214
	 *
6215
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6216
	 */
6217
	public static function check_identity_crisis() {
6218
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6219
			return false;
6220
		}
6221
6222
		return Jetpack_Options::get_option( 'sync_error_idc' );
6223
	}
6224
6225
	/**
6226
	 * Checks whether the home and siteurl specifically are whitelisted
6227
	 * Written so that we don't have re-check $key and $value params every time
6228
	 * we want to check if this site is whitelisted, for example in footer.php
6229
	 *
6230
	 * @since  3.8.0
6231
	 * @return bool True = already whitelisted False = not whitelisted
6232
	 */
6233
	public static function is_staging_site() {
6234
		$is_staging = false;
6235
6236
		$known_staging = array(
6237
			'urls' => array(
6238
				'#\.staging\.wpengine\.com$#i', // WP Engine
6239
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6240
				),
6241
			'constants' => array(
6242
				'IS_WPE_SNAPSHOT',      // WP Engine
6243
				'KINSTA_DEV_ENV',       // Kinsta.com
6244
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6245
				'JETPACK_STAGING_MODE', // Generic
6246
				)
6247
			);
6248
		/**
6249
		 * Filters the flags of known staging sites.
6250
		 *
6251
		 * @since 3.9.0
6252
		 *
6253
		 * @param array $known_staging {
6254
		 *     An array of arrays that each are used to check if the current site is staging.
6255
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6256
		 *     @type array $constants PHP constants of known staging/developement environments.
6257
		 *  }
6258
		 */
6259
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6260
6261
		if ( isset( $known_staging['urls'] ) ) {
6262
			foreach ( $known_staging['urls'] as $url ){
6263
				if ( preg_match( $url, site_url() ) ) {
6264
					$is_staging = true;
6265
					break;
6266
				}
6267
			}
6268
		}
6269
6270
		if ( isset( $known_staging['constants'] ) ) {
6271
			foreach ( $known_staging['constants'] as $constant ) {
6272
				if ( defined( $constant ) && constant( $constant ) ) {
6273
					$is_staging = true;
6274
				}
6275
			}
6276
		}
6277
6278
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6279
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6280
			$is_staging = true;
6281
		}
6282
6283
		/**
6284
		 * Filters is_staging_site check.
6285
		 *
6286
		 * @since 3.9.0
6287
		 *
6288
		 * @param bool $is_staging If the current site is a staging site.
6289
		 */
6290
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6291
	}
6292
6293
	/**
6294
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6295
	 *
6296
	 * @since 4.4.0
6297
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6298
	 *
6299
	 * @return bool
6300
	 */
6301
	public static function validate_sync_error_idc_option() {
6302
		$is_valid = false;
6303
6304
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6305
		if ( false === $idc_allowed ) {
6306
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6307
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6308
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6309
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6310
				$transient_duration = HOUR_IN_SECONDS;
6311
			} else {
6312
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6313
				$idc_allowed = '1';
6314
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6315
			}
6316
6317
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6318
		}
6319
6320
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6321
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6322
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6323
			$local_options = self::get_sync_error_idc_option();
6324
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6325
				$is_valid = true;
6326
			}
6327
		}
6328
6329
		/**
6330
		 * Filters whether the sync_error_idc option is valid.
6331
		 *
6332
		 * @since 4.4.0
6333
		 *
6334
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6335
		 */
6336
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6337
6338
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6339
			// Since the option exists, and did not validate, delete it
6340
			Jetpack_Options::delete_option( 'sync_error_idc' );
6341
		}
6342
6343
		return $is_valid;
6344
	}
6345
6346
	/**
6347
	 * Normalizes a url by doing three things:
6348
	 *  - Strips protocol
6349
	 *  - Strips www
6350
	 *  - Adds a trailing slash
6351
	 *
6352
	 * @since 4.4.0
6353
	 * @param string $url
6354
	 * @return WP_Error|string
6355
	 */
6356
	public static function normalize_url_protocol_agnostic( $url ) {
6357
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6358
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6359
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6360
		}
6361
6362
		// Strip www and protocols
6363
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6364
		return $url;
6365
	}
6366
6367
	/**
6368
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6369
	 *
6370
	 * @since 4.4.0
6371
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6372
	 *
6373
	 * @param array $response
6374
	 * @return array Array of the local urls, wpcom urls, and error code
6375
	 */
6376
	public static function get_sync_error_idc_option( $response = array() ) {
6377
		// Since the local options will hit the database directly, store the values
6378
		// in a transient to allow for autoloading and caching on subsequent views.
6379
		$local_options = get_transient( 'jetpack_idc_local' );
6380
		if ( false === $local_options ) {
6381
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6382
			$local_options = array(
6383
				'home'    => Jetpack_Sync_Functions::home_url(),
6384
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6385
			);
6386
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6387
		}
6388
6389
		$options = array_merge( $local_options, $response );
6390
6391
		$returned_values = array();
6392
		foreach( $options as $key => $option ) {
6393
			if ( 'error_code' === $key ) {
6394
				$returned_values[ $key ] = $option;
6395
				continue;
6396
			}
6397
6398
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6399
				continue;
6400
			}
6401
6402
			$returned_values[ $key ] = $normalized_url;
6403
		}
6404
6405
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6406
6407
		return $returned_values;
6408
	}
6409
6410
	/**
6411
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6412
	 * If set to true, the site will be put into staging mode.
6413
	 *
6414
	 * @since 4.3.2
6415
	 * @return bool
6416
	 */
6417
	public static function sync_idc_optin() {
6418
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6419
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6420
		} else {
6421
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6422
		}
6423
6424
		/**
6425
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6426
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6427
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6428
		 *
6429
		 * @since 4.3.2
6430
		 *
6431
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6432
		 */
6433
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6434
	}
6435
6436
	/**
6437
	 * Maybe Use a .min.css stylesheet, maybe not.
6438
	 *
6439
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6440
	 */
6441
	public static function maybe_min_asset( $url, $path, $plugin ) {
6442
		// Short out on things trying to find actual paths.
6443
		if ( ! $path || empty( $plugin ) ) {
6444
			return $url;
6445
		}
6446
6447
		$path = ltrim( $path, '/' );
6448
6449
		// Strip out the abspath.
6450
		$base = dirname( plugin_basename( $plugin ) );
6451
6452
		// Short out on non-Jetpack assets.
6453
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6454
			return $url;
6455
		}
6456
6457
		// File name parsing.
6458
		$file              = "{$base}/{$path}";
6459
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6460
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6461
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6462
		$extension         = array_shift( $file_name_parts_r );
6463
6464
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6465
			// Already pointing at the minified version.
6466
			if ( 'min' === $file_name_parts_r[0] ) {
6467
				return $url;
6468
			}
6469
6470
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6471
			if ( file_exists( $min_full_path ) ) {
6472
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6473
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6474
				if ( 'css' === $extension ) {
6475
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6476
					self::$min_assets[ $key ] = $path;
6477
				}
6478
			}
6479
		}
6480
6481
		return $url;
6482
	}
6483
6484
	/**
6485
	 * If the asset is minified, let's flag .min as the suffix.
6486
	 *
6487
	 * Attached to `style_loader_src` filter.
6488
	 *
6489
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

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

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

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

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

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

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

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

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

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

Loading history...
6492
	 */
6493
	public static function set_suffix_on_min( $src, $handle ) {
6494
		if ( false === strpos( $src, '.min.css' ) ) {
6495
			return $src;
6496
		}
6497
6498
		if ( ! empty( self::$min_assets ) ) {
6499
			foreach ( self::$min_assets as $file => $path ) {
6500
				if ( false !== strpos( $src, $file ) ) {
6501
					wp_style_add_data( $handle, 'suffix', '.min' );
6502
					return $src;
6503
				}
6504
			}
6505
		}
6506
6507
		return $src;
6508
	}
6509
6510
	/**
6511
	 * Maybe inlines a stylesheet.
6512
	 *
6513
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6514
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6515
	 *
6516
	 * Attached to `style_loader_tag` filter.
6517
	 *
6518
	 * @param string $tag The tag that would link to the external asset.
6519
	 * @param string $handle The registered handle of the script in question.
6520
	 *
6521
	 * @return string
6522
	 */
6523
	public static function maybe_inline_style( $tag, $handle ) {
6524
		global $wp_styles;
6525
		$item = $wp_styles->registered[ $handle ];
6526
6527
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6528
			return $tag;
6529
		}
6530
6531
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6532
			$href = $matches[1];
6533
			// Strip off query string
6534
			if ( $pos = strpos( $href, '?' ) ) {
6535
				$href = substr( $href, 0, $pos );
6536
			}
6537
			// Strip off fragment
6538
			if ( $pos = strpos( $href, '#' ) ) {
6539
				$href = substr( $href, 0, $pos );
6540
			}
6541
		} else {
6542
			return $tag;
6543
		}
6544
6545
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6546
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6547
			return $tag;
6548
		}
6549
6550
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6551
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6552
			// And this isn't the pass that actually deals with the RTL version...
6553
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6554
				// Short out, as the RTL version will deal with it in a moment.
6555
				return $tag;
6556
			}
6557
		}
6558
6559
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6560
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6561
		if ( $css ) {
6562
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6563
			if ( empty( $item->extra['after'] ) ) {
6564
				wp_add_inline_style( $handle, $css );
6565
			} else {
6566
				array_unshift( $item->extra['after'], $css );
6567
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6568
			}
6569
		}
6570
6571
		return $tag;
6572
	}
6573
6574
	/**
6575
	 * Loads a view file from the views
6576
	 *
6577
	 * Data passed in with the $data parameter will be available in the
6578
	 * template file as $data['value']
6579
	 *
6580
	 * @param string $template - Template file to load
6581
	 * @param array $data - Any data to pass along to the template
6582
	 * @return boolean - If template file was found
6583
	 **/
6584
	public function load_view( $template, $data = array() ) {
6585
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6586
6587
		if( file_exists( $views_dir . $template ) ) {
6588
			require_once( $views_dir . $template );
6589
			return true;
6590
		}
6591
6592
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6593
		return false;
6594
	}
6595
6596
	/**
6597
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6598
	 */
6599
	public function deprecated_hooks() {
6600
		global $wp_filter;
6601
6602
		/*
6603
		 * Format:
6604
		 * deprecated_filter_name => replacement_name
6605
		 *
6606
		 * If there is no replacement, use null for replacement_name
6607
		 */
6608
		$deprecated_list = array(
6609
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6610
			'wpl_sharing_2014_1'                                     => null,
6611
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6612
			'jetpack_identity_crisis_options_to_check'               => null,
6613
			'update_option_jetpack_single_user_site'                 => null,
6614
			'audio_player_default_colors'                            => null,
6615
			'add_option_jetpack_featured_images_enabled'             => null,
6616
			'add_option_jetpack_update_details'                      => null,
6617
			'add_option_jetpack_updates'                             => null,
6618
			'add_option_jetpack_network_name'                        => null,
6619
			'add_option_jetpack_network_allow_new_registrations'     => null,
6620
			'add_option_jetpack_network_add_new_users'               => null,
6621
			'add_option_jetpack_network_site_upload_space'           => null,
6622
			'add_option_jetpack_network_upload_file_types'           => null,
6623
			'add_option_jetpack_network_enable_administration_menus' => null,
6624
			'add_option_jetpack_is_multi_site'                       => null,
6625
			'add_option_jetpack_is_main_network'                     => null,
6626
			'add_option_jetpack_main_network_site'                   => null,
6627
			'jetpack_sync_all_registered_options'                    => null,
6628
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6629
			'jetpack_is_post_mailable'                               => null,
6630
			'jetpack_seo_site_host'                                  => null,
6631
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6632
			'jetpack_holiday_snow_option_name'                       => null,
6633
			'jetpack_holiday_chance_of_snow'                         => null,
6634
			'jetpack_holiday_snow_js_url'                            => null,
6635
			'jetpack_is_holiday_snow_season'                         => null,
6636
			'jetpack_holiday_snow_option_updated'                    => null,
6637
			'jetpack_holiday_snowing'                                => null,
6638
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6639
			'jetpack_cache_plans'                                    => null,
6640
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6641
			'jetpack_lazy_images_skip_image_with_atttributes'        => 'jetpack_lazy_images_skip_image_with_attributes',
6642
			'jetpack_enable_site_verification'                       => null,
6643
		);
6644
6645
		// This is a silly loop depth. Better way?
6646
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6647
			if ( has_action( $hook ) ) {
6648
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6649
					foreach( $values AS $hooked ) {
6650
						if ( is_callable( $hooked['function'] ) ) {
6651
							$function_name = 'an anonymous function';
6652
						} else {
6653
							$function_name = $hooked['function'];
6654
						}
6655
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6656
					}
6657
				}
6658
			}
6659
		}
6660
	}
6661
6662
	/**
6663
	 * Converts any url in a stylesheet, to the correct absolute url.
6664
	 *
6665
	 * Considerations:
6666
	 *  - Normal, relative URLs     `feh.png`
6667
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6668
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6669
	 *  - Absolute URLs             `http://domain.com/feh.png`
6670
	 *  - Domain root relative URLs `/feh.png`
6671
	 *
6672
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6673
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6674
	 *
6675
	 * @return mixed|string
6676
	 */
6677
	public static function absolutize_css_urls( $css, $css_file_url ) {
6678
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6679
		$css_dir = dirname( $css_file_url );
6680
		$p       = parse_url( $css_dir );
6681
		$domain  = sprintf(
6682
					'%1$s//%2$s%3$s%4$s',
6683
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6684
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6685
					$p['host'],
6686
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6687
				);
6688
6689
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6690
			$find = $replace = array();
6691
			foreach ( $matches as $match ) {
6692
				$url = trim( $match['path'], "'\" \t" );
6693
6694
				// If this is a data url, we don't want to mess with it.
6695
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6696
					continue;
6697
				}
6698
6699
				// If this is an absolute or protocol-agnostic url,
6700
				// we don't want to mess with it.
6701
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6702
					continue;
6703
				}
6704
6705
				switch ( substr( $url, 0, 1 ) ) {
6706
					case '/':
6707
						$absolute = $domain . $url;
6708
						break;
6709
					default:
6710
						$absolute = $css_dir . '/' . $url;
6711
				}
6712
6713
				$find[]    = $match[0];
6714
				$replace[] = sprintf( 'url("%s")', $absolute );
6715
			}
6716
			$css = str_replace( $find, $replace, $css );
6717
		}
6718
6719
		return $css;
6720
	}
6721
6722
	/**
6723
	 * This methods removes all of the registered css files on the front end
6724
	 * from Jetpack in favor of using a single file. In effect "imploding"
6725
	 * all the files into one file.
6726
	 *
6727
	 * Pros:
6728
	 * - Uses only ONE css asset connection instead of 15
6729
	 * - Saves a minimum of 56k
6730
	 * - Reduces server load
6731
	 * - Reduces time to first painted byte
6732
	 *
6733
	 * Cons:
6734
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6735
	 *		should not cause any issues with themes.
6736
	 * - Plugins/themes dequeuing styles no longer do anything. See
6737
	 *		jetpack_implode_frontend_css filter for a workaround
6738
	 *
6739
	 * For some situations developers may wish to disable css imploding and
6740
	 * instead operate in legacy mode where each file loads seperately and
6741
	 * can be edited individually or dequeued. This can be accomplished with
6742
	 * the following line:
6743
	 *
6744
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6745
	 *
6746
	 * @since 3.2
6747
	 **/
6748
	public function implode_frontend_css( $travis_test = false ) {
6749
		$do_implode = true;
6750
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6751
			$do_implode = false;
6752
		}
6753
6754
		/**
6755
		 * Allow CSS to be concatenated into a single jetpack.css file.
6756
		 *
6757
		 * @since 3.2.0
6758
		 *
6759
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6760
		 */
6761
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6762
6763
		// Do not use the imploded file when default behaviour was altered through the filter
6764
		if ( ! $do_implode ) {
6765
			return;
6766
		}
6767
6768
		// We do not want to use the imploded file in dev mode, or if not connected
6769
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6770
			if ( ! $travis_test ) {
6771
				return;
6772
			}
6773
		}
6774
6775
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6776
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6777
			return;
6778
		}
6779
6780
		/*
6781
		 * Now we assume Jetpack is connected and able to serve the single
6782
		 * file.
6783
		 *
6784
		 * In the future there will be a check here to serve the file locally
6785
		 * or potentially from the Jetpack CDN
6786
		 *
6787
		 * For now:
6788
		 * - Enqueue a single imploded css file
6789
		 * - Zero out the style_loader_tag for the bundled ones
6790
		 * - Be happy, drink scotch
6791
		 */
6792
6793
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6794
6795
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6796
6797
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6798
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6799
	}
6800
6801
	function concat_remove_style_loader_tag( $tag, $handle ) {
6802
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6803
			$tag = '';
6804
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6805
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6806
			}
6807
		}
6808
6809
		return $tag;
6810
	}
6811
6812
	/*
6813
	 * Check the heartbeat data
6814
	 *
6815
	 * Organizes the heartbeat data by severity.  For example, if the site
6816
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6817
	 *
6818
	 * Data will be added to "caution" array, if it either:
6819
	 *  - Out of date Jetpack version
6820
	 *  - Out of date WP version
6821
	 *  - Out of date PHP version
6822
	 *
6823
	 * $return array $filtered_data
6824
	 */
6825
	public static function jetpack_check_heartbeat_data() {
6826
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6827
6828
		$good    = array();
6829
		$caution = array();
6830
		$bad     = array();
6831
6832
		foreach ( $raw_data as $stat => $value ) {
6833
6834
			// Check jetpack version
6835
			if ( 'version' == $stat ) {
6836
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6837
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6838
					continue;
6839
				}
6840
			}
6841
6842
			// Check WP version
6843
			if ( 'wp-version' == $stat ) {
6844
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6845
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6846
					continue;
6847
				}
6848
			}
6849
6850
			// Check PHP version
6851
			if ( 'php-version' == $stat ) {
6852
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6853
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6854
					continue;
6855
				}
6856
			}
6857
6858
			// Check ID crisis
6859
			if ( 'identitycrisis' == $stat ) {
6860
				if ( 'yes' == $value ) {
6861
					$bad[ $stat ] = $value;
6862
					continue;
6863
				}
6864
			}
6865
6866
			// The rest are good :)
6867
			$good[ $stat ] = $value;
6868
		}
6869
6870
		$filtered_data = array(
6871
			'good'    => $good,
6872
			'caution' => $caution,
6873
			'bad'     => $bad
6874
		);
6875
6876
		return $filtered_data;
6877
	}
6878
6879
6880
	/*
6881
	 * This method is used to organize all options that can be reset
6882
	 * without disconnecting Jetpack.
6883
	 *
6884
	 * It is used in class.jetpack-cli.php to reset options
6885
	 *
6886
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6887
	 *
6888
	 * @return array of options to delete.
6889
	 */
6890
	public static function get_jetpack_options_for_reset() {
6891
		return Jetpack_Options::get_options_for_reset();
6892
	}
6893
6894
	/**
6895
	 * Check if an option of a Jetpack module has been updated.
6896
	 *
6897
	 * If any module option has been updated before Jump Start has been dismissed,
6898
	 * update the 'jumpstart' option so we can hide Jump Start.
6899
	 *
6900
	 * @param string $option_name
6901
	 *
6902
	 * @return bool
6903
	 */
6904
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6905
		// Bail if Jump Start has already been dismissed
6906
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6907
			return false;
6908
		}
6909
6910
		$jetpack = Jetpack::init();
6911
6912
		// Manual build of module options
6913
		$option_names = self::get_jetpack_options_for_reset();
6914
6915
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6916
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6917
6918
			//Jump start is being dismissed send data to MC Stats
6919
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6920
6921
			$jetpack->do_stats( 'server_side' );
6922
		}
6923
6924
	}
6925
6926
	/*
6927
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6928
	 * so we can bring them directly to their site in calypso.
6929
	 *
6930
	 * @param string | url
6931
	 * @return string | url without the guff
6932
	 */
6933
	public static function build_raw_urls( $url ) {
6934
		$strip_http = '/.*?:\/\//i';
6935
		$url = preg_replace( $strip_http, '', $url  );
6936
		$url = str_replace( '/', '::', $url );
6937
		return $url;
6938
	}
6939
6940
	/**
6941
	 * Stores and prints out domains to prefetch for page speed optimization.
6942
	 *
6943
	 * @param mixed $new_urls
6944
	 */
6945
	public static function dns_prefetch( $new_urls = null ) {
6946
		static $prefetch_urls = array();
6947
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6948
			echo "\r\n";
6949
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6950
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6951
			}
6952
		} elseif ( ! empty( $new_urls ) ) {
6953
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6954
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6955
			}
6956
			foreach ( (array) $new_urls as $this_new_url ) {
6957
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6958
			}
6959
			$prefetch_urls = array_unique( $prefetch_urls );
6960
		}
6961
	}
6962
6963
	public function wp_dashboard_setup() {
6964
		if ( self::is_active() ) {
6965
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6966
		}
6967
6968
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6969
			wp_add_dashboard_widget(
6970
				'jetpack_summary_widget',
6971
				esc_html__( 'Site Stats', 'jetpack' ),
6972
				array( __CLASS__, 'dashboard_widget' )
6973
			);
6974
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6975
6976
			// If we're inactive and not in development mode, sort our box to the top.
6977
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6978
				global $wp_meta_boxes;
6979
6980
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6981
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6982
6983
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6984
			}
6985
		}
6986
	}
6987
6988
	/**
6989
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
6990
	 * @return mixed
6991
	 */
6992
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6993
		if ( ! is_array( $sorted ) ) {
6994
			return $sorted;
6995
		}
6996
6997
		foreach ( $sorted as $box_context => $ids ) {
6998
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6999
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7000
				continue;
7001
			}
7002
7003
			$ids_array = explode( ',', $ids );
7004
			$key = array_search( 'dashboard_stats', $ids_array );
7005
7006
			if ( false !== $key ) {
7007
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7008
				$ids_array[ $key ] = 'jetpack_summary_widget';
7009
				$sorted[ $box_context ] = implode( ',', $ids_array );
7010
				// We've found it, stop searching, and just return.
7011
				break;
7012
			}
7013
		}
7014
7015
		return $sorted;
7016
	}
7017
7018
	public static function dashboard_widget() {
7019
		/**
7020
		 * Fires when the dashboard is loaded.
7021
		 *
7022
		 * @since 3.4.0
7023
		 */
7024
		do_action( 'jetpack_dashboard_widget' );
7025
	}
7026
7027
	public static function dashboard_widget_footer() {
7028
		?>
7029
		<footer>
7030
7031
		<div class="protect">
7032
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
7033
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
7034
				<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>
7035
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
7036
				<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' ); ?>">
7037
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
7038
				</a>
7039
			<?php else : ?>
7040
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
7041
			<?php endif; ?>
7042
		</div>
7043
7044
		<div class="akismet">
7045
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7046
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
7047
				<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>
7048
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7049
				<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">
7050
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
7051
				</a>
7052
			<?php else : ?>
7053
				<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>
7054
			<?php endif; ?>
7055
		</div>
7056
7057
		</footer>
7058
		<?php
7059
	}
7060
7061
	/**
7062
	 * Return string containing the Jetpack logo.
7063
	 *
7064
	 * @since 3.9.0
7065
	 *
7066
	 * @return string
7067
	 */
7068
	public static function get_jp_emblem() {
7069
		return '<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 32 32"><path fill="#00BE28" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/></svg>';
7070
	}
7071
7072
	/*
7073
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7074
	 */
7075
	function jetpack_icon_user_connected( $columns ) {
7076
		$columns['user_jetpack'] = '';
7077
		return $columns;
7078
	}
7079
7080
	/*
7081
	 * Show Jetpack icon if the user is linked.
7082
	 */
7083
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7084
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7085
			$emblem_html = sprintf(
7086
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7087
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7088
				Jetpack::get_jp_emblem()
7089
			);
7090
			return $emblem_html;
7091
		}
7092
7093
		return $val;
7094
	}
7095
7096
	/*
7097
	 * Style the Jetpack user column
7098
	 */
7099
	function jetpack_user_col_style() {
7100
		global $current_screen;
7101
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7102
			<style>
7103
				.fixed .column-user_jetpack {
7104
					width: 21px;
7105
				}
7106
				.jp-emblem-user-admin svg {
7107
					width: 20px;
7108
					height: 20px;
7109
				}
7110
				.jp-emblem-user-admin path {
7111
					fill: #00BE28;
7112
				}
7113
			</style>
7114
		<?php }
7115
	}
7116
7117
	/**
7118
	 * Checks if Akismet is active and working.
7119
	 *
7120
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7121
	 * that implied usage of methods present since more recent version.
7122
	 * See https://github.com/Automattic/jetpack/pull/9585
7123
	 *
7124
	 * @since  5.1.0
7125
	 *
7126
	 * @return bool True = Akismet available. False = Aksimet not available.
7127
	 */
7128
	public static function is_akismet_active() {
7129
		if ( method_exists( 'Akismet' , 'http_post' ) ) {
7130
			$akismet_key = Akismet::get_api_key();
7131
			if ( ! $akismet_key ) {
7132
				return false;
7133
			}
7134
			$cached_key_verification = get_transient( 'jetpack_akismet_key_is_valid' );
7135
7136
			// We cache the result of the Akismet key verification for ten minutes.
7137
			if ( in_array( $cached_key_verification, array( 'valid', 'invalid' ) ) ) {
7138
				$akismet_key_state = $cached_key_verification;
7139
			} else {
7140
				$akismet_key_state = Akismet::verify_key( $akismet_key );
7141
				if ( 'failed' === $akismet_key_state ) {
7142
					return false;
7143
				}
7144
				set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7145
			}
7146
7147
			return ( 'valid' === $akismet_key_state );
7148
		}
7149
		return false;
7150
	}
7151
7152
	/**
7153
	 * Checks if one or more function names is in debug_backtrace
7154
	 *
7155
	 * @param $names Mixed string name of function or array of string names of functions
7156
	 *
7157
	 * @return bool
7158
	 */
7159
	public static function is_function_in_backtrace( $names ) {
7160
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility
7161
		if ( ! is_array( $names ) ) {
7162
			$names = array( $names );
7163
		}
7164
		$names_as_keys = array_flip( $names );
7165
7166
		//Do check in constant O(1) time for PHP5.5+
7167
		if ( function_exists( 'array_column' ) ) {
7168
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility
7169
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7170
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7171
			return ! empty ( $intersection );
7172
		}
7173
7174
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7175
		foreach ( $backtrace as $call ) {
7176
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7177
				return true;
7178
			}
7179
		}
7180
		return false;
7181
	}
7182
7183
	/**
7184
	 * Given a minified path, and a non-minified path, will return
7185
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7186
	 *
7187
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7188
	 * root Jetpack directory.
7189
	 *
7190
	 * @since 5.6.0
7191
	 *
7192
	 * @param string $min_path
7193
	 * @param string $non_min_path
7194
	 * @return string The URL to the file
7195
	 */
7196
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7197
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7198
			? $non_min_path
7199
			: $min_path;
7200
7201
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7202
	}
7203
7204
	/**
7205
	 * Checks for whether Jetpack Rewind is enabled.
7206
	 * Will return true if the state of Rewind is anything except "unavailable".
7207
	 * @return bool|int|mixed
7208
	 */
7209
	public static function is_rewind_enabled() {
7210
		if ( ! Jetpack::is_active() ) {
7211
			return false;
7212
		}
7213
7214
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7215
		if ( false === $rewind_enabled ) {
7216
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7217
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7218
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7219
				&& ! empty( $rewind_data['state'] )
7220
				&& 'active' === $rewind_data['state'] )
7221
				? 1
7222
				: 0;
7223
7224
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7225
		}
7226
		return $rewind_enabled;
7227
	}
7228
7229
	/**
7230
	 * Checks whether or not TOS has been agreed upon.
7231
	 * Will return true if a user has clicked to register, or is already connected.
7232
	 */
7233
	public static function jetpack_tos_agreed() {
7234
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7235
	}
7236
7237
	/**
7238
	 * Handles activating default modules as well general cleanup for the new connection.
7239
	 *
7240
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7241
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7242
	 * @param boolean $send_state_messages          Whether to send state messages.
7243
	 * @return void
7244
	 */
7245
	public static function handle_post_authorization_actions(
7246
		$activate_sso = false,
7247
		$redirect_on_activation_error = false,
7248
		$send_state_messages = true
7249
	) {
7250
		$other_modules = $activate_sso
7251
			? array( 'sso' )
7252
			: array();
7253
7254
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7255
			Jetpack::delete_active_modules();
7256
7257
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7258
		} else {
7259
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7260
		}
7261
7262
		// Since this is a fresh connection, be sure to clear out IDC options
7263
		Jetpack_IDC::clear_all_idc_options();
7264
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7265
7266
		// Start nonce cleaner
7267
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7268
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7269
7270
		if ( $send_state_messages ) {
7271
			Jetpack::state( 'message', 'authorized' );
7272
		}
7273
	}
7274
7275
	/**
7276
	 * Check if Gutenberg editor is available
7277
	 *
7278
	 * @since 6.5.0
7279
	 *
7280
	 * @return bool
7281
	 */
7282
	public static function is_gutenberg_available() {
7283
		return function_exists( 'register_block_type' );
7284
	}
7285
7286
	/**
7287
	 * Load Gutenberg editor blocks.
7288
	 *
7289
	 * This section meant for unstable phase of developing Jetpack's
7290
	 * Gutenberg extensions. If still around after Sep. 15, 2018 then
7291
	 * please file an issue to remove it; if nobody responds within one
7292
	 * week then please delete the code.
7293
	 *
7294
	 *
7295
	 * Loading blocks is disabled by default and enabled via filter:
7296
	 *   add_filter( 'jetpack_gutenberg', '__return_true', 10 );
7297
	 *
7298
	 * When enabled, blocks are loaded from CDN by default. To load locally instead:
7299
	 *   add_filter( 'jetpack_gutenberg_cdn', '__return_false', 10 );
7300
	 *
7301
	 * Note that when loaded locally, you need to build the files yourself:
7302
	 * - _inc/blocks/jetpack-editor.js
7303
	 * - _inc/blocks/jetpack-editor.css
7304
	 *
7305
	 * CDN cache is busted once a day or when Jetpack version changes. To customize it:
7306
	 *   add_filter( 'jetpack_gutenberg_cdn_cache_buster', function( $version ) { return time(); }, 10, 1 );
7307
	 *
7308
	 * @since 6.5.0
7309
	 *
7310
	 * @return void
7311
	 */
7312
	public static function load_jetpack_gutenberg() {
7313
		/**
7314
		 * Filter to turn on loading Gutenberg blocks
7315
		 *
7316
		 * @since 6.5.0
7317
		 *
7318
		 * @param bool false Whether to load Gutenberg blocks
7319
		 */
7320
		if ( ! Jetpack::is_gutenberg_available() || ! apply_filters( 'jetpack_gutenberg', false ) ) {
7321
			return;
7322
		}
7323
7324
		/**
7325
		 * Filter to turn off serving blocks via CDN
7326
		 *
7327
		 * @since 6.5.0
7328
		 *
7329
		 * @param bool true Whether to load Gutenberg blocks from CDN
7330
		 */
7331
		if ( apply_filters( 'jetpack_gutenberg_cdn', true ) ) {
7332
			$editor_script = 'https://s0.wp.com/wp-content/mu-plugins/jetpack/_inc/blocks/jetpack-editor.js';
7333
			$editor_style = 'https://s0.wp.com/wp-content/mu-plugins/jetpack/_inc/blocks/jetpack-editor.css';
7334
7335
			/**
7336
			 * Filter to modify cache busting for Gutenberg block assets loaded from CDN
7337
			 *
7338
			 * @since 6.5.0
7339
			 *
7340
			 * @param string
7341
			 */
7342
			$version = apply_filters( 'jetpack_gutenberg_cdn_cache_buster', sprintf( '%s-%s', gmdate( 'd-m-Y' ), JETPACK__VERSION ) );
7343
		} else {
7344
			$editor_script = plugins_url( '_inc/blocks/jetpack-editor.js', JETPACK__PLUGIN_FILE );
7345
			$editor_style = plugins_url( '_inc/blocks/jetpack-editor.css', JETPACK__PLUGIN_FILE );
7346
			$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . '_inc/blocks/jetpack-editor.js' ) : JETPACK__VERSION;
7347
		}
7348
7349
		wp_register_script(
7350
			'jetpack-blocks-editor',
7351
			$editor_script,
7352
			array(
7353
				'wp-blocks',
7354
				'wp-components',
7355
				'wp-compose',
7356
				'wp-data',
7357
				'wp-editor',
7358
				'wp-element',
7359
				'wp-i18n',
7360
				'wp-plugins',
7361
			),
7362
			$version
7363
		);
7364
7365
		wp_register_style(
7366
			'jetpack-blocks-editor',
7367
			$editor_style,
7368
			array(),
7369
			$version
7370
		);
7371
7372
		register_block_type( 'jetpack/blocks', array(
7373
				'editor_script' => 'jetpack-blocks-editor',
7374
				'editor_style'  => 'jetpack-blocks-editor',
7375
		) );
7376
	}
7377
7378
	/**
7379
	 * Returns a boolean for whether backups UI should be displayed or not.
7380
	 *
7381
	 * @return bool Should backups UI be displayed?
7382
	 */
7383
	public static function show_backups_ui() {
7384
		/**
7385
		 * Whether UI for backups should be displayed.
7386
		 *
7387
		 * @since 6.5.0
7388
		 *
7389
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7390
		 */
7391
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7392
	}
7393
}
7394