Completed
Push — branch-6.4-built ( 1f37b5...535e79 )
by
unknown
14:17 queued 05:13
created

Jetpack::calyps_url()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 4
nop 2
dl 0
loc 15
rs 9.7666
c 0
b 0
f 0
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();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $min_assets.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
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(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
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;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
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
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
530
531
		// Unlink user before deleting the user from .com
532
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
533
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
534
535
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
536
			@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...
537
538
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
539
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
540
541
			$this->require_jetpack_authentication();
542
543
			if ( Jetpack::is_active() ) {
544
				// Hack to preserve $HTTP_RAW_POST_DATA
545
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
546
547
				$signed = $this->verify_xml_rpc_signature();
548 View Code Duplication
				if ( $signed && ! is_wp_error( $signed ) ) {
549
					// The actual API methods.
550
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
551
				} else {
552
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
553
					// active Jetpack connection, so that additional users can link their account.
554
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
555
				}
556 View Code Duplication
			} else {
557
				// The bootstrap API methods.
558
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
559
				$signed = $this->verify_xml_rpc_signature();
560
				if ( $signed && ! is_wp_error( $signed ) ) {
561
					// the jetpack Provision method is available for blog-token-signed requests
562
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
563
				}
564
			}
565
566
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
567
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
568
		} elseif (
569
			is_admin() &&
570
			isset( $_POST['action'] ) && (
571
				'jetpack_upload_file' == $_POST['action'] ||
572
				'jetpack_update_file' == $_POST['action']
573
			)
574
		) {
575
			$this->require_jetpack_authentication();
576
			$this->add_remote_request_handlers();
577
		} else {
578
			if ( Jetpack::is_active() ) {
579
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
580
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
581
			}
582
		}
583
584
		if ( Jetpack::is_active() ) {
585
			Jetpack_Heartbeat::init();
586
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
587
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
588
				Jetpack_Search_Performance_Logger::init();
589
			}
590
		}
591
592
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
593
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
594
595
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
596
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
597
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
598
		}
599
600
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
601
602
		add_action( 'admin_init', array( $this, 'admin_init' ) );
603
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
604
605
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
606
607
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
608
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
609
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
610
611
		// returns HTTPS support status
612
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
613
614
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
615
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
616
617
		// JITM AJAX callback function
618
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
619
620
		// Universal ajax callback for all tracking events triggered via js
621
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
622
623
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
624
625
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
626
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
627
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
628
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
629
630
		// gutenberg locale
631
		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_gutenberg_locale' ) );
632
633
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
634
635
		/**
636
		 * These actions run checks to load additional files.
637
		 * They check for external files or plugins, so they need to run as late as possible.
638
		 */
639
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
640
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
641
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
642
643
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
644
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
645
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
646
647
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
648
649
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
650
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
651
652
		// A filter to control all just in time messages
653
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
654
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
655
656
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
657
		// We should make sure to only do this for front end links.
658
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
659
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
660
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
661
662
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
663
			//so they point moderation links on emails to Calypso
664
			jetpack_require_lib( 'functions.wp-notify' );
665
		}
666
667
		// Update the Jetpack plan from API on heartbeats
668
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
669
670
		/**
671
		 * This is the hack to concatenate all css files into one.
672
		 * For description and reasoning see the implode_frontend_css method
673
		 *
674
		 * Super late priority so we catch all the registered styles
675
		 */
676
		if( !is_admin() ) {
677
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
678
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
679
		}
680
681
		/**
682
		 * These are sync actions that we need to keep track of for jitms
683
		 */
684
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
685
686
		// Actually push the stats on shutdown.
687
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
688
			add_action( 'shutdown', array( $this, 'push_stats' ) );
689
		}
690
	}
691
692
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
693
		$post = get_post( $post_id );
694
695
		if ( empty( $post ) ) {
696
			return $default_url;
697
		}
698
699
		$post_type = $post->post_type;
700
701
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
702
		// https://en.support.wordpress.com/custom-post-types/
703
		$allowed_post_types = array(
704
			'post' => 'post',
705
			'page' => 'page',
706
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
707
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
708
		);
709
710
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
711
			return $default_url;
712
		}
713
714
		$path_prefix = $allowed_post_types[ $post_type ];
715
716
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 2 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
717
718
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
719
	}
720
721
	function point_edit_comment_links_to_calypso( $url ) {
722
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
723
		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...
724
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
725
			Jetpack::build_raw_urls( get_home_url() ),
726
			$query_args['amp;c']
727
		) );
728
	}
729
730
	function jetpack_track_last_sync_callback( $params ) {
731
		/**
732
		 * Filter to turn off jitm caching
733
		 *
734
		 * @since 5.4.0
735
		 *
736
		 * @param bool false Whether to cache just in time messages
737
		 */
738
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
739
			return $params;
740
		}
741
742
		if ( is_array( $params ) && isset( $params[0] ) ) {
743
			$option = $params[0];
744
			if ( 'active_plugins' === $option ) {
745
				// use the cache if we can, but not terribly important if it gets evicted
746
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
747
			}
748
		}
749
750
		return $params;
751
	}
752
753
	function jetpack_connection_banner_callback() {
754
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
755
756
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
757
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
758
			wp_send_json_success();
759
		}
760
761
		wp_die();
762
	}
763
764
	function jetpack_admin_ajax_tracks_callback() {
765
		// Check for nonce
766
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
767
			wp_die( 'Permissions check failed.' );
768
		}
769
770
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
771
			wp_die( 'No valid event name or type.' );
772
		}
773
774
		$tracks_data = array();
775
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
776
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
777
				$tracks_data = $_REQUEST['tracksEventProp'];
778
			} else {
779
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
780
			}
781
		}
782
783
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
784
		wp_send_json_success();
785
		wp_die();
786
	}
787
788
	/**
789
	 * The callback for the JITM ajax requests.
790
	 */
791
	function jetpack_jitm_ajax_callback() {
792
		// Check for nonce
793
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
794
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
795
		}
796
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
797
			$module_slug = $_REQUEST['jitmModule'];
798
			Jetpack::log( 'activate', $module_slug );
799
			Jetpack::activate_module( $module_slug, false, false );
800
			Jetpack::state( 'message', 'no_message' );
801
802
			//A Jetpack module is being activated through a JITM, track it
803
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
804
			$this->do_stats( 'server_side' );
805
806
			wp_send_json_success();
807
		}
808
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
809
			// get the hide_jitm options array
810
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
811
			$module_slug = $_REQUEST['jitmModule'];
812
813
			if( ! $jetpack_hide_jitm ) {
814
				$jetpack_hide_jitm = array(
815
					$module_slug => 'hide'
816
				);
817
			} else {
818
				$jetpack_hide_jitm[$module_slug] = 'hide';
819
			}
820
821
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
822
823
			//jitm is being dismissed forever, track it
824
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
825
			$this->do_stats( 'server_side' );
826
827
			wp_send_json_success();
828
		}
829 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
830
			$module_slug = $_REQUEST['jitmModule'];
831
832
			// User went to WordPress.com, track this
833
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
834
			$this->do_stats( 'server_side' );
835
836
			wp_send_json_success();
837
		}
838 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
839
			$track = $_REQUEST['jitmModule'];
840
841
			// User is viewing JITM, track it.
842
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
843
			$this->do_stats( 'server_side' );
844
845
			wp_send_json_success();
846
		}
847
	}
848
849
	/**
850
	 * If there are any stats that need to be pushed, but haven't been, push them now.
851
	 */
852
	function push_stats() {
853
		if ( ! empty( $this->stats ) ) {
854
			$this->do_stats( 'server_side' );
855
		}
856
	}
857
858
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
859
		switch( $cap ) {
860
			case 'jetpack_connect' :
861
			case 'jetpack_reconnect' :
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
862
				if ( Jetpack::is_development_mode() ) {
863
					$caps = array( 'do_not_allow' );
864
					break;
865
				}
866
				/**
867
				 * Pass through. If it's not development mode, these should match disconnect.
868
				 * Let users disconnect if it's development mode, just in case things glitch.
869
				 */
870
			case 'jetpack_disconnect' :
871
				/**
872
				 * In multisite, can individual site admins manage their own connection?
873
				 *
874
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
875
				 */
876
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
877
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
878
						/**
879
						 * We need to update the option name -- it's terribly unclear which
880
						 * direction the override goes.
881
						 *
882
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
883
						 */
884
						$caps = array( 'do_not_allow' );
885
						break;
886
					}
887
				}
888
889
				$caps = array( 'manage_options' );
890
				break;
891
			case 'jetpack_manage_modules' :
892
			case 'jetpack_activate_modules' :
893
			case 'jetpack_deactivate_modules' :
894
				$caps = array( 'manage_options' );
895
				break;
896
			case 'jetpack_configure_modules' :
897
				$caps = array( 'manage_options' );
898
				break;
899
			case 'jetpack_network_admin_page':
900
			case 'jetpack_network_settings_page':
901
				$caps = array( 'manage_network_plugins' );
902
				break;
903
			case 'jetpack_network_sites_page':
904
				$caps = array( 'manage_sites' );
905
				break;
906
			case 'jetpack_admin_page' :
907
				if ( Jetpack::is_development_mode() ) {
908
					$caps = array( 'manage_options' );
909
					break;
910
				} else {
911
					$caps = array( 'read' );
912
				}
913
				break;
914
			case 'jetpack_connect_user' :
915
				if ( Jetpack::is_development_mode() ) {
916
					$caps = array( 'do_not_allow' );
917
					break;
918
				}
919
				$caps = array( 'read' );
920
				break;
921
		}
922
		return $caps;
923
	}
924
925
	function require_jetpack_authentication() {
926
		// Don't let anyone authenticate
927
		$_COOKIE = array();
928
		remove_all_filters( 'authenticate' );
929
		remove_all_actions( 'wp_login_failed' );
930
931
		if ( Jetpack::is_active() ) {
932
			// Allow Jetpack authentication
933
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
934
		}
935
	}
936
937
	/**
938
	 * Load language files
939
	 * @action plugins_loaded
940
	 */
941
	public static function plugin_textdomain() {
942
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
943
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
944
	}
945
946
	/**
947
	 * Register assets for use in various modules and the Jetpack admin page.
948
	 *
949
	 * @uses wp_script_is, wp_register_script, plugins_url
950
	 * @action wp_loaded
951
	 * @return null
952
	 */
953
	public function register_assets() {
954
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
955
			wp_register_script(
956
				'spin',
957
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
958
				false,
959
				'1.3'
960
			);
961
		}
962
963
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
964
			wp_register_script(
965
				'jquery.spin',
966
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
967
				array( 'jquery', 'spin' ),
968
				'1.3'
969
			);
970
		}
971
972 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
973
			wp_register_script(
974
				'jetpack-gallery-settings',
975
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
976
				array( 'media-views' ),
977
				'20121225'
978
			);
979
		}
980
981
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
982
			wp_register_script(
983
				'jetpack-twitter-timeline',
984
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
985
				array( 'jquery' ),
986
				'4.0.0',
987
				true
988
			);
989
		}
990
991
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
992
			wp_register_script(
993
				'jetpack-facebook-embed',
994
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
995
				array( 'jquery' ),
996
				null,
997
				true
998
			);
999
1000
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1001
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1002
			if ( ! is_numeric( $fb_app_id ) ) {
1003
				$fb_app_id = '';
1004
			}
1005
			wp_localize_script(
1006
				'jetpack-facebook-embed',
1007
				'jpfbembed',
1008
				array(
1009
					'appid' => $fb_app_id,
1010
					'locale' => $this->get_locale(),
1011
				)
1012
			);
1013
		}
1014
1015
		/**
1016
		 * As jetpack_register_genericons is by default fired off a hook,
1017
		 * the hook may have already fired by this point.
1018
		 * So, let's just trigger it manually.
1019
		 */
1020
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1021
		jetpack_register_genericons();
1022
1023
		/**
1024
		 * Register the social logos
1025
		 */
1026
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1027
		jetpack_register_social_logos();
1028
1029 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1030
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1031
	}
1032
1033
	/**
1034
	 * Guess locale from language code.
1035
	 *
1036
	 * @param string $lang Language code.
1037
	 * @return string|bool
1038
	 */
1039 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1040
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1041
			return 'en_US';
1042
		}
1043
1044
		if ( ! class_exists( 'GP_Locales' ) ) {
1045
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1046
				return false;
1047
			}
1048
1049
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1050
		}
1051
1052
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1053
			// WP.com: get_locale() returns 'it'
1054
			$locale = GP_Locales::by_slug( $lang );
1055
		} else {
1056
			// Jetpack: get_locale() returns 'it_IT';
1057
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1058
		}
1059
1060
		if ( ! $locale ) {
1061
			return false;
1062
		}
1063
1064
		if ( empty( $locale->facebook_locale ) ) {
1065
			if ( empty( $locale->wp_locale ) ) {
1066
				return false;
1067
			} else {
1068
				// Facebook SDK is smart enough to fall back to en_US if a
1069
				// locale isn't supported. Since supported Facebook locales
1070
				// can fall out of sync, we'll attempt to use the known
1071
				// wp_locale value and rely on said fallback.
1072
				return $locale->wp_locale;
1073
			}
1074
		}
1075
1076
		return $locale->facebook_locale;
1077
	}
1078
1079
	/**
1080
	 * Get the locale.
1081
	 *
1082
	 * @return string|bool
1083
	 */
1084
	function get_locale() {
1085
		$locale = $this->guess_locale_from_lang( get_locale() );
1086
1087
		if ( ! $locale ) {
1088
			$locale = 'en_US';
1089
		}
1090
1091
		return $locale;
1092
	}
1093
1094
	/**
1095
	 * Device Pixels support
1096
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1097
	 */
1098
	function devicepx() {
1099
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1100
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1101
		}
1102
	}
1103
1104
	/**
1105
	 * Return the network_site_url so that .com knows what network this site is a part of.
1106
	 * @param  bool $option
1107
	 * @return string
1108
	 */
1109
	public function jetpack_main_network_site_option( $option ) {
1110
		return network_site_url();
1111
	}
1112
	/**
1113
	 * Network Name.
1114
	 */
1115
	static function network_name( $option = null ) {
1116
		global $current_site;
1117
		return $current_site->site_name;
1118
	}
1119
	/**
1120
	 * Does the network allow new user and site registrations.
1121
	 * @return string
1122
	 */
1123
	static function network_allow_new_registrations( $option = null ) {
1124
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1125
	}
1126
	/**
1127
	 * Does the network allow admins to add new users.
1128
	 * @return boolian
1129
	 */
1130
	static function network_add_new_users( $option = null ) {
1131
		return (bool) get_site_option( 'add_new_users' );
1132
	}
1133
	/**
1134
	 * File upload psace left per site in MB.
1135
	 *  -1 means NO LIMIT.
1136
	 * @return number
1137
	 */
1138
	static function network_site_upload_space( $option = null ) {
1139
		// value in MB
1140
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1141
	}
1142
1143
	/**
1144
	 * Network allowed file types.
1145
	 * @return string
1146
	 */
1147
	static function network_upload_file_types( $option = null ) {
1148
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1149
	}
1150
1151
	/**
1152
	 * Maximum file upload size set by the network.
1153
	 * @return number
1154
	 */
1155
	static function network_max_upload_file_size( $option = null ) {
1156
		// value in KB
1157
		return get_site_option( 'fileupload_maxk', 300 );
1158
	}
1159
1160
	/**
1161
	 * Lets us know if a site allows admins to manage the network.
1162
	 * @return array
1163
	 */
1164
	static function network_enable_administration_menus( $option = null ) {
1165
		return get_site_option( 'menu_items' );
1166
	}
1167
1168
	/**
1169
	 * If a user has been promoted to or demoted from admin, we need to clear the
1170
	 * jetpack_other_linked_admins transient.
1171
	 *
1172
	 * @since 4.3.2
1173
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1174
	 *
1175
	 * @param int    $user_id   The user ID whose role changed.
1176
	 * @param string $role      The new role.
1177
	 * @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...
1178
	 */
1179
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1180
		if ( 'administrator' == $role
1181
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1182
			|| is_null( $old_roles )
1183
		) {
1184
			delete_transient( 'jetpack_other_linked_admins' );
1185
		}
1186
	}
1187
1188
	/**
1189
	 * Checks to see if there are any other users available to become primary
1190
	 * Users must both:
1191
	 * - Be linked to wpcom
1192
	 * - Be an admin
1193
	 *
1194
	 * @return mixed False if no other users are linked, Int if there are.
1195
	 */
1196
	static function get_other_linked_admins() {
1197
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1198
1199
		if ( false === $other_linked_users ) {
1200
			$admins = get_users( array( 'role' => 'administrator' ) );
1201
			if ( count( $admins ) > 1 ) {
1202
				$available = array();
1203
				foreach ( $admins as $admin ) {
1204
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1205
						$available[] = $admin->ID;
1206
					}
1207
				}
1208
1209
				$count_connected_admins = count( $available );
1210
				if ( count( $available ) > 1 ) {
1211
					$other_linked_users = $count_connected_admins;
1212
				} else {
1213
					$other_linked_users = 0;
1214
				}
1215
			} else {
1216
				$other_linked_users = 0;
1217
			}
1218
1219
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1220
		}
1221
1222
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1223
	}
1224
1225
	/**
1226
	 * Return whether we are dealing with a multi network setup or not.
1227
	 * The reason we are type casting this is because we want to avoid the situation where
1228
	 * the result is false since when is_main_network_option return false it cases
1229
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1230
	 * database which could be set to anything as opposed to what this function returns.
1231
	 * @param  bool  $option
1232
	 *
1233
	 * @return boolean
1234
	 */
1235
	public function is_main_network_option( $option ) {
1236
		// return '1' or ''
1237
		return (string) (bool) Jetpack::is_multi_network();
1238
	}
1239
1240
	/**
1241
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1242
	 *
1243
	 * @param  string  $option
1244
	 * @return boolean
1245
	 */
1246
	public function is_multisite( $option ) {
1247
		return (string) (bool) is_multisite();
1248
	}
1249
1250
	/**
1251
	 * Implemented since there is no core is multi network function
1252
	 * Right now there is no way to tell if we which network is the dominant network on the system
1253
	 *
1254
	 * @since  3.3
1255
	 * @return boolean
1256
	 */
1257
	public static function is_multi_network() {
1258
		global  $wpdb;
1259
1260
		// if we don't have a multi site setup no need to do any more
1261
		if ( ! is_multisite() ) {
1262
			return false;
1263
		}
1264
1265
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1266
		if ( $num_sites > 1 ) {
1267
			return true;
1268
		} else {
1269
			return false;
1270
		}
1271
	}
1272
1273
	/**
1274
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1275
	 * @return null
1276
	 */
1277
	function update_jetpack_main_network_site_option() {
1278
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1279
	}
1280
	/**
1281
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1282
	 *
1283
	 */
1284
	function update_jetpack_network_settings() {
1285
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1286
		// Only sync this info for the main network site.
1287
	}
1288
1289
	/**
1290
	 * Get back if the current site is single user site.
1291
	 *
1292
	 * @return bool
1293
	 */
1294
	public static function is_single_user_site() {
1295
		global $wpdb;
1296
1297 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1298
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1299
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1300
		}
1301
		return 1 === (int) $some_users;
1302
	}
1303
1304
	/**
1305
	 * Returns true if the site has file write access false otherwise.
1306
	 * @return string ( '1' | '0' )
1307
	 **/
1308
	public static function file_system_write_access() {
1309
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1310
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1311
		}
1312
1313
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1314
1315
		$filesystem_method = get_filesystem_method();
1316
		if ( $filesystem_method === 'direct' ) {
1317
			return 1;
1318
		}
1319
1320
		ob_start();
1321
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1322
		ob_end_clean();
1323
		if ( $filesystem_credentials_are_stored ) {
1324
			return 1;
1325
		}
1326
		return 0;
1327
	}
1328
1329
	/**
1330
	 * Finds out if a site is using a version control system.
1331
	 * @return string ( '1' | '0' )
1332
	 **/
1333
	public static function is_version_controlled() {
1334
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1335
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1336
	}
1337
1338
	/**
1339
	 * Determines whether the current theme supports featured images or not.
1340
	 * @return string ( '1' | '0' )
1341
	 */
1342
	public static function featured_images_enabled() {
1343
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1344
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1345
	}
1346
1347
	/**
1348
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1349
	 *
1350
	 * @deprecated 4.7 use get_avatar_url instead.
1351
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1352
	 * @param int $size Size of the avatar image
1353
	 * @param string $default URL to a default image to use if no avatar is available
1354
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1355
	 *
1356
	 * @return array
1357
	 */
1358
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1359
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1360
		return get_avatar_url( $id_or_email, array(
1361
			'size' => $size,
1362
			'default' => $default,
1363
			'force_default' => $force_display,
1364
		) );
1365
	}
1366
1367
	/**
1368
	 * jetpack_updates is saved in the following schema:
1369
	 *
1370
	 * array (
1371
	 *      'plugins'                       => (int) Number of plugin updates available.
1372
	 *      'themes'                        => (int) Number of theme updates available.
1373
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1374
	 *      'translations'                  => (int) Number of translation updates available.
1375
	 *      'total'                         => (int) Total of all available updates.
1376
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1377
	 * )
1378
	 * @return array
1379
	 */
1380
	public static function get_updates() {
1381
		$update_data = wp_get_update_data();
1382
1383
		// Stores the individual update counts as well as the total count.
1384
		if ( isset( $update_data['counts'] ) ) {
1385
			$updates = $update_data['counts'];
1386
		}
1387
1388
		// If we need to update WordPress core, let's find the latest version number.
1389 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1390
			$cur = get_preferred_from_update_core();
1391
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1392
				$updates['wp_update_version'] = $cur->current;
1393
			}
1394
		}
1395
		return isset( $updates ) ? $updates : array();
1396
	}
1397
1398
	public static function get_update_details() {
1399
		$update_details = array(
1400
			'update_core' => get_site_transient( 'update_core' ),
1401
			'update_plugins' => get_site_transient( 'update_plugins' ),
1402
			'update_themes' => get_site_transient( 'update_themes' ),
1403
		);
1404
		return $update_details;
1405
	}
1406
1407
	public static function refresh_update_data() {
1408
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1409
1410
	}
1411
1412
	public static function refresh_theme_data() {
1413
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1414
	}
1415
1416
	/**
1417
	 * Is Jetpack active?
1418
	 */
1419
	public static function is_active() {
1420
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1421
	}
1422
1423
	/**
1424
	 * Make an API call to WordPress.com for plan status
1425
	 *
1426
	 * @uses Jetpack_Options::get_option()
1427
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1428
	 * @uses update_option()
1429
	 *
1430
	 * @access public
1431
	 * @static
1432
	 *
1433
	 * @return bool True if plan is updated, false if no update
1434
	 */
1435
	public static function refresh_active_plan_from_wpcom() {
1436
		// Make the API request
1437
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1438
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1439
1440
		// Bail if there was an error or malformed response
1441
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1442
			return false;
1443
		}
1444
1445
		// Decode the results
1446
		$results = json_decode( $response['body'], true );
1447
1448
		// Bail if there were no results or plan details returned
1449
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1450
			return false;
1451
		}
1452
1453
		// Store the option and return true if updated
1454
		return update_option( 'jetpack_active_plan', $results['plan'] );
1455
	}
1456
1457
	/**
1458
	 * Get the plan that this Jetpack site is currently using
1459
	 *
1460
	 * @uses get_option()
1461
	 *
1462
	 * @access public
1463
	 * @static
1464
	 *
1465
	 * @return array Active Jetpack plan details
1466
	 */
1467
	public static function get_active_plan() {
1468
		global $active_plan_cache;
1469
1470
		// this can be expensive to compute so we cache for the duration of a request
1471
		if ( is_array( $active_plan_cache ) && ! empty( $active_plan_cache ) ) {
1472
			return $active_plan_cache;
1473
		}
1474
1475
		$plan = get_option( 'jetpack_active_plan', array() );
1476
1477
		// Set the default options
1478
		$plan = wp_parse_args( $plan, array(
1479
			'product_slug' => 'jetpack_free',
1480
			'class'        => 'free',
1481
			'features'     => array(
1482
				'active' => array()
1483
			),
1484
		) );
1485
1486
		$supports = array();
1487
1488
		// Define what paid modules are supported by personal plans
1489
		$personal_plans = array(
1490
			'jetpack_personal',
1491
			'jetpack_personal_monthly',
1492
			'personal-bundle',
1493
			'personal-bundle-2y',
1494
		);
1495
1496
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1497
			// special support value, not a module but a separate plugin
1498
			$supports[] = 'akismet';
1499
			$plan['class'] = 'personal';
1500
		}
1501
1502
		// Define what paid modules are supported by premium plans
1503
		$premium_plans = array(
1504
			'jetpack_premium',
1505
			'jetpack_premium_monthly',
1506
			'value_bundle',
1507
			'value_bundle-2y',
1508
		);
1509
1510 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1511
			$supports[] = 'akismet';
1512
			$supports[] = 'simple-payments';
1513
			$supports[] = 'vaultpress';
1514
			$plan['class'] = 'premium';
1515
		}
1516
1517
		// Define what paid modules are supported by professional plans
1518
		$business_plans = array(
1519
			'jetpack_business',
1520
			'jetpack_business_monthly',
1521
			'business-bundle',
1522
			'business-bundle-2y',
1523
			'vip',
1524
		);
1525
1526 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1527
			$supports[] = 'akismet';
1528
			$supports[] = 'simple-payments';
1529
			$supports[] = 'vaultpress';
1530
			$plan['class'] = 'business';
1531
		}
1532
1533
		// get available features
1534
		foreach ( self::get_available_modules() as $module_slug ) {
1535
			$module = self::get_module( $module_slug );
1536
			if ( ! isset( $module ) || ! is_array( $module ) ) {
1537
				continue;
1538
			}
1539
			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
1540
				$supports[] = $module_slug;
1541
			}
1542
		}
1543
1544
		$plan['supports'] = $supports;
1545
1546
		$active_plan_cache = $plan;
1547
1548
		return $plan;
1549
	}
1550
1551
	/**
1552
	 * Determine whether the active plan supports a particular feature
1553
	 *
1554
	 * @uses Jetpack::get_active_plan()
1555
	 *
1556
	 * @access public
1557
	 * @static
1558
	 *
1559
	 * @return bool True if plan supports feature, false if not
1560
	 */
1561
	public static function active_plan_supports( $feature ) {
1562
		$plan = Jetpack::get_active_plan();
1563
1564
		// Manually mapping WordPress.com features to Jetpack module slugs
1565
		foreach ( $plan['features']['active'] as $wpcom_feature ) {
1566
			switch ( $wpcom_feature ) {
1567
				case 'wordads-jetpack';
0 ignored issues
show
Coding Style introduced by
case statements should be defined using a colon.

As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next break.

There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages.

switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
1568
1569
				// WordAds are supported for this site
1570
				if ( 'wordads' === $feature ) {
1571
					return true;
1572
				}
1573
				break;
1574
			}
1575
		}
1576
1577
		if (
1578
			in_array( $feature, $plan['supports'] )
1579
			|| in_array( $feature, $plan['features']['active'] )
1580
		) {
1581
			return true;
1582
		}
1583
1584
		return false;
1585
	}
1586
1587
	/**
1588
	 * Is Jetpack in development (offline) mode?
1589
	 */
1590
	public static function is_development_mode() {
1591
		$development_mode = false;
1592
1593
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1594
			$development_mode = JETPACK_DEV_DEBUG;
1595
		} elseif ( $site_url = site_url() ) {
1596
			$development_mode = false === strpos( $site_url, '.' );
1597
		}
1598
1599
		/**
1600
		 * Filters Jetpack's development mode.
1601
		 *
1602
		 * @see https://jetpack.com/support/development-mode/
1603
		 *
1604
		 * @since 2.2.1
1605
		 *
1606
		 * @param bool $development_mode Is Jetpack's development mode active.
1607
		 */
1608
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1609
		return $development_mode;
1610
	}
1611
1612
	/**
1613
	 * Whether the site is currently onboarding or not.
1614
	 * A site is considered as being onboarded if it currently has an onboarding token.
1615
	 *
1616
	 * @since 5.8
1617
	 *
1618
	 * @access public
1619
	 * @static
1620
	 *
1621
	 * @return bool True if the site is currently onboarding, false otherwise
1622
	 */
1623
	public static function is_onboarding() {
1624
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1625
	}
1626
1627
	/**
1628
	* Get Jetpack development mode notice text and notice class.
1629
	*
1630
	* Mirrors the checks made in Jetpack::is_development_mode
1631
	*
1632
	*/
1633
	public static function show_development_mode_notice() {
1634
		if ( Jetpack::is_development_mode() ) {
1635
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1636
				$notice = sprintf(
1637
					/* translators: %s is a URL */
1638
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1639
					'https://jetpack.com/support/development-mode/'
1640
				);
1641
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1642
				$notice = sprintf(
1643
					/* translators: %s is a URL */
1644
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1645
					'https://jetpack.com/support/development-mode/'
1646
				);
1647
			} else {
1648
				$notice = sprintf(
1649
					/* translators: %s is a URL */
1650
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1651
					'https://jetpack.com/support/development-mode/'
1652
				);
1653
			}
1654
1655
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1656
		}
1657
1658
		// Throw up a notice if using a development version and as for feedback.
1659
		if ( Jetpack::is_development_version() ) {
1660
			/* translators: %s is a URL */
1661
			$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/' );
1662
1663
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1664
		}
1665
		// Throw up a notice if using staging mode
1666
		if ( Jetpack::is_staging_site() ) {
1667
			/* translators: %s is a URL */
1668
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1669
1670
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1671
		}
1672
	}
1673
1674
	/**
1675
	 * Whether Jetpack's version maps to a public release, or a development version.
1676
	 */
1677
	public static function is_development_version() {
1678
		/**
1679
		 * Allows filtering whether this is a development version of Jetpack.
1680
		 *
1681
		 * This filter is especially useful for tests.
1682
		 *
1683
		 * @since 4.3.0
1684
		 *
1685
		 * @param bool $development_version Is this a develoment version of Jetpack?
1686
		 */
1687
		return (bool) apply_filters(
1688
			'jetpack_development_version',
1689
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1690
		);
1691
	}
1692
1693
	/**
1694
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1695
	 */
1696
	public static function is_user_connected( $user_id = false ) {
1697
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1698
		if ( ! $user_id ) {
1699
			return false;
1700
		}
1701
1702
		return (bool) Jetpack_Data::get_access_token( $user_id );
1703
	}
1704
1705
	/**
1706
	 * Get the wpcom user data of the current|specified connected user.
1707
	 */
1708
	public static function get_connected_user_data( $user_id = null ) {
1709
		if ( ! $user_id ) {
1710
			$user_id = get_current_user_id();
1711
		}
1712
1713
		$transient_key = "jetpack_connected_user_data_$user_id";
1714
1715
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1716
			return $cached_user_data;
1717
		}
1718
1719
		Jetpack::load_xml_rpc_client();
1720
		$xml = new Jetpack_IXR_Client( array(
1721
			'user_id' => $user_id,
1722
		) );
1723
		$xml->query( 'wpcom.getUser' );
1724
		if ( ! $xml->isError() ) {
1725
			$user_data = $xml->getResponse();
1726
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1727
			return $user_data;
1728
		}
1729
1730
		return false;
1731
	}
1732
1733
	/**
1734
	 * Get the wpcom email of the current|specified connected user.
1735
	 */
1736 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1737
		if ( ! $user_id ) {
1738
			$user_id = get_current_user_id();
1739
		}
1740
		Jetpack::load_xml_rpc_client();
1741
		$xml = new Jetpack_IXR_Client( array(
1742
			'user_id' => $user_id,
1743
		) );
1744
		$xml->query( 'wpcom.getUserEmail' );
1745
		if ( ! $xml->isError() ) {
1746
			return $xml->getResponse();
1747
		}
1748
		return false;
1749
	}
1750
1751
	/**
1752
	 * Get the wpcom email of the master user.
1753
	 */
1754
	public static function get_master_user_email() {
1755
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1756
		if ( $master_user_id ) {
1757
			return self::get_connected_user_email( $master_user_id );
1758
		}
1759
		return '';
1760
	}
1761
1762
	function current_user_is_connection_owner() {
1763
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1764
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1765
	}
1766
1767
	/**
1768
	 * Gets current user IP address.
1769
	 *
1770
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1771
	 *
1772
	 * @return string                  Current user IP address.
1773
	 */
1774
	public static function current_user_ip( $check_all_headers = false ) {
1775
		if ( $check_all_headers ) {
1776
			foreach ( array(
1777
				'HTTP_CF_CONNECTING_IP',
1778
				'HTTP_CLIENT_IP',
1779
				'HTTP_X_FORWARDED_FOR',
1780
				'HTTP_X_FORWARDED',
1781
				'HTTP_X_CLUSTER_CLIENT_IP',
1782
				'HTTP_FORWARDED_FOR',
1783
				'HTTP_FORWARDED',
1784
				'HTTP_VIA',
1785
			) as $key ) {
1786
				if ( ! empty( $_SERVER[ $key ] ) ) {
1787
					return $_SERVER[ $key ];
1788
				}
1789
			}
1790
		}
1791
1792
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1793
	}
1794
1795
	/**
1796
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1797
	 */
1798
	function extra_oembed_providers() {
1799
		// Cloudup: https://dev.cloudup.com/#oembed
1800
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1801
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1802
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1803
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1804
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1805
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1806
	}
1807
1808
	/**
1809
	 * Synchronize connected user role changes
1810
	 */
1811
	function user_role_change( $user_id ) {
1812
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1813
		Jetpack_Sync_Users::user_role_change( $user_id );
1814
	}
1815
1816
	/**
1817
	 * Loads the currently active modules.
1818
	 */
1819
	public static function load_modules() {
1820
		if (
1821
			! self::is_active()
1822
			&& ! self::is_development_mode()
1823
			&& ! self::is_onboarding()
1824
			&& (
1825
				! is_multisite()
1826
				|| ! get_site_option( 'jetpack_protect_active' )
1827
			)
1828
		) {
1829
			return;
1830
		}
1831
1832
		$version = Jetpack_Options::get_option( 'version' );
1833 View Code Duplication
		if ( ! $version ) {
1834
			$version = $old_version = JETPACK__VERSION . ':' . time();
1835
			/** This action is documented in class.jetpack.php */
1836
			do_action( 'updating_jetpack_version', $version, false );
1837
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1838
		}
1839
		list( $version ) = explode( ':', $version );
1840
1841
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1842
1843
		$modules_data = array();
1844
1845
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1846
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1847
			$updated_modules = array();
1848
			foreach ( $modules as $module ) {
1849
				$modules_data[ $module ] = Jetpack::get_module( $module );
1850
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1851
					continue;
1852
				}
1853
1854
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1855
					continue;
1856
				}
1857
1858
				$updated_modules[] = $module;
1859
			}
1860
1861
			$modules = array_diff( $modules, $updated_modules );
1862
		}
1863
1864
		$is_development_mode = Jetpack::is_development_mode();
1865
1866
		foreach ( $modules as $index => $module ) {
1867
			// If we're in dev mode, disable modules requiring a connection
1868
			if ( $is_development_mode ) {
1869
				// Prime the pump if we need to
1870
				if ( empty( $modules_data[ $module ] ) ) {
1871
					$modules_data[ $module ] = Jetpack::get_module( $module );
1872
				}
1873
				// If the module requires a connection, but we're in local mode, don't include it.
1874
				if ( $modules_data[ $module ]['requires_connection'] ) {
1875
					continue;
1876
				}
1877
			}
1878
1879
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1880
				continue;
1881
			}
1882
1883
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1884
				unset( $modules[ $index ] );
1885
				self::update_active_modules( array_values( $modules ) );
1886
				continue;
1887
			}
1888
1889
			/**
1890
			 * Fires when a specific module is loaded.
1891
			 * The dynamic part of the hook, $module, is the module slug.
1892
			 *
1893
			 * @since 1.1.0
1894
			 */
1895
			do_action( 'jetpack_module_loaded_' . $module );
1896
		}
1897
1898
		/**
1899
		 * Fires when all the modules are loaded.
1900
		 *
1901
		 * @since 1.1.0
1902
		 */
1903
		do_action( 'jetpack_modules_loaded' );
1904
1905
		// 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.
1906
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1907
	}
1908
1909
	/**
1910
	 * Check if Jetpack's REST API compat file should be included
1911
	 * @action plugins_loaded
1912
	 * @return null
1913
	 */
1914
	public function check_rest_api_compat() {
1915
		/**
1916
		 * Filters the list of REST API compat files to be included.
1917
		 *
1918
		 * @since 2.2.5
1919
		 *
1920
		 * @param array $args Array of REST API compat files to include.
1921
		 */
1922
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1923
1924
		if ( function_exists( 'bbpress' ) )
1925
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1926
1927
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1928
			require_once $_jetpack_rest_api_compat_include;
1929
	}
1930
1931
	/**
1932
	 * Gets all plugins currently active in values, regardless of whether they're
1933
	 * traditionally activated or network activated.
1934
	 *
1935
	 * @todo Store the result in core's object cache maybe?
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
1936
	 */
1937
	public static function get_active_plugins() {
1938
		$active_plugins = (array) get_option( 'active_plugins', array() );
1939
1940
		if ( is_multisite() ) {
1941
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1942
			// whereas active_plugins stores them in the values.
1943
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1944
			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...
1945
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1946
			}
1947
		}
1948
1949
		sort( $active_plugins );
1950
1951
		return array_unique( $active_plugins );
1952
	}
1953
1954
	/**
1955
	 * Gets and parses additional plugin data to send with the heartbeat data
1956
	 *
1957
	 * @since 3.8.1
1958
	 *
1959
	 * @return array Array of plugin data
1960
	 */
1961
	public static function get_parsed_plugin_data() {
1962
		if ( ! function_exists( 'get_plugins' ) ) {
1963
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1964
		}
1965
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1966
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1967
		$active_plugins = Jetpack::get_active_plugins();
1968
1969
		$plugins = array();
1970
		foreach ( $all_plugins as $path => $plugin_data ) {
1971
			$plugins[ $path ] = array(
1972
					'is_active' => in_array( $path, $active_plugins ),
1973
					'file'      => $path,
1974
					'name'      => $plugin_data['Name'],
1975
					'version'   => $plugin_data['Version'],
1976
					'author'    => $plugin_data['Author'],
1977
			);
1978
		}
1979
1980
		return $plugins;
1981
	}
1982
1983
	/**
1984
	 * Gets and parses theme data to send with the heartbeat data
1985
	 *
1986
	 * @since 3.8.1
1987
	 *
1988
	 * @return array Array of theme data
1989
	 */
1990
	public static function get_parsed_theme_data() {
1991
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1992
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1993
1994
		$themes = array();
1995
		foreach ( $all_themes as $slug => $theme_data ) {
1996
			$theme_headers = array();
1997
			foreach ( $header_keys as $header_key ) {
1998
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1999
			}
2000
2001
			$themes[ $slug ] = array(
2002
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
2003
					'slug' => $slug,
2004
					'theme_root' => $theme_data->get_theme_root_uri(),
2005
					'parent' => $theme_data->parent(),
2006
					'headers' => $theme_headers
2007
			);
2008
		}
2009
2010
		return $themes;
2011
	}
2012
2013
	/**
2014
	 * Checks whether a specific plugin is active.
2015
	 *
2016
	 * We don't want to store these in a static variable, in case
2017
	 * there are switch_to_blog() calls involved.
2018
	 */
2019
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2020
		return in_array( $plugin, self::get_active_plugins() );
2021
	}
2022
2023
	/**
2024
	 * Check if Jetpack's Open Graph tags should be used.
2025
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2026
	 *
2027
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2028
	 * @action plugins_loaded
2029
	 * @return null
2030
	 */
2031
	public function check_open_graph() {
2032
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2033
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2034
		}
2035
2036
		$active_plugins = self::get_active_plugins();
2037
2038
		if ( ! empty( $active_plugins ) ) {
2039
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2040
				if ( in_array( $plugin, $active_plugins ) ) {
2041
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2042
					break;
2043
				}
2044
			}
2045
		}
2046
2047
		/**
2048
		 * Allow the addition of Open Graph Meta Tags to all pages.
2049
		 *
2050
		 * @since 2.0.3
2051
		 *
2052
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2053
		 */
2054
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2055
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2056
		}
2057
	}
2058
2059
	/**
2060
	 * Check if Jetpack's Twitter tags should be used.
2061
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2062
	 *
2063
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2064
	 * @action plugins_loaded
2065
	 * @return null
2066
	 */
2067
	public function check_twitter_tags() {
2068
2069
		$active_plugins = self::get_active_plugins();
2070
2071
		if ( ! empty( $active_plugins ) ) {
2072
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2073
				if ( in_array( $plugin, $active_plugins ) ) {
2074
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2075
					break;
2076
				}
2077
			}
2078
		}
2079
2080
		/**
2081
		 * Allow Twitter Card Meta tags to be disabled.
2082
		 *
2083
		 * @since 2.6.0
2084
		 *
2085
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2086
		 */
2087
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2088
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2089
		}
2090
	}
2091
2092
	/**
2093
	 * Allows plugins to submit security reports.
2094
 	 *
2095
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2096
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2097
	 * @param array   $args         See definitions above
2098
	 */
2099
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2100
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2101
	}
2102
2103
/* Jetpack Options API */
2104
2105
	public static function get_option_names( $type = 'compact' ) {
2106
		return Jetpack_Options::get_option_names( $type );
2107
	}
2108
2109
	/**
2110
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2111
 	 *
2112
	 * @param string $name    Option name
2113
	 * @param mixed  $default (optional)
2114
	 */
2115
	public static function get_option( $name, $default = false ) {
2116
		return Jetpack_Options::get_option( $name, $default );
2117
	}
2118
2119
	/**
2120
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2121
 	 *
2122
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2123
	 * @param string $name  Option name
2124
	 * @param mixed  $value Option value
2125
	 */
2126
	public static function update_option( $name, $value ) {
2127
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2128
		return Jetpack_Options::update_option( $name, $value );
2129
	}
2130
2131
	/**
2132
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2133
 	 *
2134
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2135
	 * @param array $array array( option name => option value, ... )
2136
	 */
2137
	public static function update_options( $array ) {
2138
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2139
		return Jetpack_Options::update_options( $array );
2140
	}
2141
2142
	/**
2143
	 * Deletes the given option.  May be passed multiple option names as an array.
2144
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2145
	 *
2146
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2147
	 * @param string|array $names
2148
	 */
2149
	public static function delete_option( $names ) {
2150
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2151
		return Jetpack_Options::delete_option( $names );
2152
	}
2153
2154
	/**
2155
	 * Enters a user token into the user_tokens option
2156
	 *
2157
	 * @param int $user_id
2158
	 * @param string $token
2159
	 * return bool
2160
	 */
2161
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2162
		// not designed for concurrent updates
2163
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2164
		if ( ! is_array( $user_tokens ) )
2165
			$user_tokens = array();
2166
		$user_tokens[$user_id] = $token;
2167
		if ( $is_master_user ) {
2168
			$master_user = $user_id;
2169
			$options     = compact( 'user_tokens', 'master_user' );
2170
		} else {
2171
			$options = compact( 'user_tokens' );
2172
		}
2173
		return Jetpack_Options::update_options( $options );
2174
	}
2175
2176
	/**
2177
	 * Returns an array of all PHP files in the specified absolute path.
2178
	 * Equivalent to glob( "$absolute_path/*.php" ).
2179
	 *
2180
	 * @param string $absolute_path The absolute path of the directory to search.
2181
	 * @return array Array of absolute paths to the PHP files.
2182
	 */
2183
	public static function glob_php( $absolute_path ) {
2184
		if ( function_exists( 'glob' ) ) {
2185
			return glob( "$absolute_path/*.php" );
2186
		}
2187
2188
		$absolute_path = untrailingslashit( $absolute_path );
2189
		$files = array();
2190
		if ( ! $dir = @opendir( $absolute_path ) ) {
2191
			return $files;
2192
		}
2193
2194
		while ( false !== $file = readdir( $dir ) ) {
2195
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2196
				continue;
2197
			}
2198
2199
			$file = "$absolute_path/$file";
2200
2201
			if ( ! is_file( $file ) ) {
2202
				continue;
2203
			}
2204
2205
			$files[] = $file;
2206
		}
2207
2208
		closedir( $dir );
2209
2210
		return $files;
2211
	}
2212
2213
	public static function activate_new_modules( $redirect = false ) {
2214
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2215
			return;
2216
		}
2217
2218
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2219 View Code Duplication
		if ( ! $jetpack_old_version ) {
2220
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2221
			/** This action is documented in class.jetpack.php */
2222
			do_action( 'updating_jetpack_version', $version, false );
2223
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2224
		}
2225
2226
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2227
2228
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2229
			return;
2230
		}
2231
2232
		$active_modules     = Jetpack::get_active_modules();
2233
		$reactivate_modules = array();
2234
		foreach ( $active_modules as $active_module ) {
2235
			$module = Jetpack::get_module( $active_module );
2236
			if ( ! isset( $module['changed'] ) ) {
2237
				continue;
2238
			}
2239
2240
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2241
				continue;
2242
			}
2243
2244
			$reactivate_modules[] = $active_module;
2245
			Jetpack::deactivate_module( $active_module );
2246
		}
2247
2248
		$new_version = JETPACK__VERSION . ':' . time();
2249
		/** This action is documented in class.jetpack.php */
2250
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2251
		Jetpack_Options::update_options(
2252
			array(
2253
				'version'     => $new_version,
2254
				'old_version' => $jetpack_old_version,
2255
			)
2256
		);
2257
2258
		Jetpack::state( 'message', 'modules_activated' );
2259
		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...
2260
2261
		if ( $redirect ) {
2262
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2263
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2264
				$page = $_GET['page'];
2265
			}
2266
2267
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2268
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_new_modules() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2269
		}
2270
	}
2271
2272
	/**
2273
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2274
	 * Make sure to tuck away module "library" files in a sub-directory.
2275
	 */
2276
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2277
		static $modules = null;
2278
2279
		if ( ! isset( $modules ) ) {
2280
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2281
			// Use the cache if we're on the front-end and it's available...
2282
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2283
				$modules = $available_modules_option[ JETPACK__VERSION ];
2284
			} else {
2285
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2286
2287
				$modules = array();
2288
2289
				foreach ( $files as $file ) {
2290
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2291
						continue;
2292
					}
2293
2294
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2295
				}
2296
2297
				Jetpack_Options::update_option( 'available_modules', array(
2298
					JETPACK__VERSION => $modules,
2299
				) );
2300
			}
2301
		}
2302
2303
		/**
2304
		 * Filters the array of modules available to be activated.
2305
		 *
2306
		 * @since 2.4.0
2307
		 *
2308
		 * @param array $modules Array of available modules.
2309
		 * @param string $min_version Minimum version number required to use modules.
2310
		 * @param string $max_version Maximum version number required to use modules.
2311
		 */
2312
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2313
2314
		if ( ! $min_version && ! $max_version ) {
2315
			return array_keys( $mods );
2316
		}
2317
2318
		$r = array();
2319
		foreach ( $mods as $slug => $introduced ) {
2320
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2321
				continue;
2322
			}
2323
2324
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2325
				continue;
2326
			}
2327
2328
			$r[] = $slug;
2329
		}
2330
2331
		return $r;
2332
	}
2333
2334
	/**
2335
	 * Default modules loaded on activation.
2336
	 */
2337
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2338
		$return = array();
2339
2340
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2341
			$module_data = Jetpack::get_module( $module );
2342
2343
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2344
				case 'yes' :
2345
					$return[] = $module;
2346
					break;
2347
				case 'public' :
2348
					if ( Jetpack_Options::get_option( 'public' ) ) {
2349
						$return[] = $module;
2350
					}
2351
					break;
2352
				case 'no' :
2353
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2354
					break;
2355
			}
2356
		}
2357
		/**
2358
		 * Filters the array of default modules.
2359
		 *
2360
		 * @since 2.5.0
2361
		 *
2362
		 * @param array $return Array of default modules.
2363
		 * @param string $min_version Minimum version number required to use modules.
2364
		 * @param string $max_version Maximum version number required to use modules.
2365
		 */
2366
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2367
	}
2368
2369
	/**
2370
	 * Checks activated modules during auto-activation to determine
2371
	 * if any of those modules are being deprecated.  If so, close
2372
	 * them out, and add any replacement modules.
2373
	 *
2374
	 * Runs at priority 99 by default.
2375
	 *
2376
	 * This is run late, so that it can still activate a module if
2377
	 * the new module is a replacement for another that the user
2378
	 * currently has active, even if something at the normal priority
2379
	 * would kibosh everything.
2380
	 *
2381
	 * @since 2.6
2382
	 * @uses jetpack_get_default_modules filter
2383
	 * @param array $modules
2384
	 * @return array
2385
	 */
2386
	function handle_deprecated_modules( $modules ) {
2387
		$deprecated_modules = array(
2388
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2389
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2390
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2391
		);
2392
2393
		// Don't activate SSO if they never completed activating WPCC.
2394
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2395
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2396
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2397
				$deprecated_modules['wpcc'] = null;
2398
			}
2399
		}
2400
2401
		foreach ( $deprecated_modules as $module => $replacement ) {
2402
			if ( Jetpack::is_module_active( $module ) ) {
2403
				self::deactivate_module( $module );
2404
				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...
2405
					$modules[] = $replacement;
2406
				}
2407
			}
2408
		}
2409
2410
		return array_unique( $modules );
2411
	}
2412
2413
	/**
2414
	 * Checks activated plugins during auto-activation to determine
2415
	 * if any of those plugins are in the list with a corresponding module
2416
	 * that is not compatible with the plugin. The module will not be allowed
2417
	 * to auto-activate.
2418
	 *
2419
	 * @since 2.6
2420
	 * @uses jetpack_get_default_modules filter
2421
	 * @param array $modules
2422
	 * @return array
2423
	 */
2424
	function filter_default_modules( $modules ) {
2425
2426
		$active_plugins = self::get_active_plugins();
2427
2428
		if ( ! empty( $active_plugins ) ) {
2429
2430
			// For each module we'd like to auto-activate...
2431
			foreach ( $modules as $key => $module ) {
2432
				// If there are potential conflicts for it...
2433
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2434
					// For each potential conflict...
2435
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2436
						// If that conflicting plugin is active...
2437
						if ( in_array( $plugin, $active_plugins ) ) {
2438
							// Remove that item from being auto-activated.
2439
							unset( $modules[ $key ] );
2440
						}
2441
					}
2442
				}
2443
			}
2444
		}
2445
2446
		return $modules;
2447
	}
2448
2449
	/**
2450
	 * Extract a module's slug from its full path.
2451
	 */
2452
	public static function get_module_slug( $file ) {
2453
		return str_replace( '.php', '', basename( $file ) );
2454
	}
2455
2456
	/**
2457
	 * Generate a module's path from its slug.
2458
	 */
2459
	public static function get_module_path( $slug ) {
2460
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2461
	}
2462
2463
	/**
2464
	 * Load module data from module file. Headers differ from WordPress
2465
	 * plugin headers to avoid them being identified as standalone
2466
	 * plugins on the WordPress plugins page.
2467
	 */
2468
	public static function get_module( $module ) {
2469
		$headers = array(
2470
			'name'                      => 'Module Name',
2471
			'description'               => 'Module Description',
2472
			'jumpstart_desc'            => 'Jumpstart Description',
2473
			'sort'                      => 'Sort Order',
2474
			'recommendation_order'      => 'Recommendation Order',
2475
			'introduced'                => 'First Introduced',
2476
			'changed'                   => 'Major Changes In',
2477
			'deactivate'                => 'Deactivate',
2478
			'free'                      => 'Free',
2479
			'requires_connection'       => 'Requires Connection',
2480
			'auto_activate'             => 'Auto Activate',
2481
			'module_tags'               => 'Module Tags',
2482
			'feature'                   => 'Feature',
2483
			'additional_search_queries' => 'Additional Search Queries',
2484
			'plan_classes'              => 'Plans',
2485
		);
2486
2487
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2488
2489
		$mod = Jetpack::get_file_data( $file, $headers );
2490
		if ( empty( $mod['name'] ) ) {
2491
			return false;
2492
		}
2493
2494
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2495
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2496
		$mod['deactivate']              = empty( $mod['deactivate'] );
2497
		$mod['free']                    = empty( $mod['free'] );
2498
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2499
2500
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2501
			$mod['auto_activate'] = 'No';
2502
		} else {
2503
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2504
		}
2505
2506
		if ( $mod['module_tags'] ) {
2507
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2508
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2509
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2510
		} else {
2511
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2512
		}
2513
2514 View Code Duplication
		if ( $mod['plan_classes'] ) {
2515
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2516
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2517
		} else {
2518
			$mod['plan_classes'] = array( 'free' );
2519
		}
2520
2521 View Code Duplication
		if ( $mod['feature'] ) {
2522
			$mod['feature'] = explode( ',', $mod['feature'] );
2523
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2524
		} else {
2525
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2526
		}
2527
2528
		/**
2529
		 * Filters the feature array on a module.
2530
		 *
2531
		 * This filter allows you to control where each module is filtered: Recommended,
2532
		 * Jumpstart, and the default "Other" listing.
2533
		 *
2534
		 * @since 3.5.0
2535
		 *
2536
		 * @param array   $mod['feature'] The areas to feature this module:
2537
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2538
		 *     'Recommended' shows on the main Jetpack admin screen.
2539
		 *     'Other' should be the default if no other value is in the array.
2540
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2541
		 * @param array   $mod All the currently assembled module data.
2542
		 */
2543
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2544
2545
		/**
2546
		 * Filter the returned data about a module.
2547
		 *
2548
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2549
		 * so please be careful.
2550
		 *
2551
		 * @since 3.6.0
2552
		 *
2553
		 * @param array   $mod    The details of the requested module.
2554
		 * @param string  $module The slug of the module, e.g. sharedaddy
2555
		 * @param string  $file   The path to the module source file.
2556
		 */
2557
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2558
	}
2559
2560
	/**
2561
	 * Like core's get_file_data implementation, but caches the result.
2562
	 */
2563
	public static function get_file_data( $file, $headers ) {
2564
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2565
		$file_name = basename( $file );
2566
2567
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2568
2569
		$file_data_option = get_transient( $cache_key );
2570
2571
		if ( false === $file_data_option ) {
2572
			$file_data_option = array();
2573
		}
2574
2575
		$key           = md5( $file_name . serialize( $headers ) );
2576
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2577
2578
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2579
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2580
			return $file_data_option[ $key ];
2581
		}
2582
2583
		$data = get_file_data( $file, $headers );
2584
2585
		$file_data_option[ $key ] = $data;
2586
2587
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2588
2589
		return $data;
2590
	}
2591
2592
2593
	/**
2594
	 * Return translated module tag.
2595
	 *
2596
	 * @param string $tag Tag as it appears in each module heading.
2597
	 *
2598
	 * @return mixed
2599
	 */
2600
	public static function translate_module_tag( $tag ) {
2601
		return jetpack_get_module_i18n_tag( $tag );
2602
	}
2603
2604
	/**
2605
	 * Get i18n strings as a JSON-encoded string
2606
	 *
2607
	 * @return string The locale as JSON
2608
	 */
2609
	public static function get_i18n_data_json() {
2610
		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . jetpack_get_user_locale() . '.json';
2611
2612
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2613
			$locale_data = @file_get_contents( $i18n_json );
2614
			if ( $locale_data ) {
2615
				return $locale_data;
2616
			}
2617
		}
2618
2619
		// Return valid empty Jed locale
2620
		return json_encode( array(
2621
			'' => array(
2622
				'domain' => 'jetpack',
2623
				'lang'   => is_admin() ? get_user_locale() : get_locale(),
2624
			),
2625
		) );
2626
	}
2627
2628
	/**
2629
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2630
	 *
2631
	 * @since 3.9.2
2632
	 *
2633
	 * @param array $modules
2634
	 *
2635
	 * @return string|void
2636
	 */
2637
	public static function get_translated_modules( $modules ) {
2638
		foreach ( $modules as $index => $module ) {
2639
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2640
			if ( isset( $module['name'] ) ) {
2641
				$modules[ $index ]['name'] = $i18n_module['name'];
2642
			}
2643
			if ( isset( $module['description'] ) ) {
2644
				$modules[ $index ]['description'] = $i18n_module['description'];
2645
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2646
			}
2647
		}
2648
		return $modules;
2649
	}
2650
2651
	/**
2652
	 * Get a list of activated modules as an array of module slugs.
2653
	 */
2654
	public static function get_active_modules() {
2655
		$active = Jetpack_Options::get_option( 'active_modules' );
2656
2657
		if ( ! is_array( $active ) ) {
2658
			$active = array();
2659
		}
2660
2661
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2662
			$active[] = 'vaultpress';
2663
		} else {
2664
			$active = array_diff( $active, array( 'vaultpress' ) );
2665
		}
2666
2667
		//If protect is active on the main site of a multisite, it should be active on all sites.
2668
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2669
			$active[] = 'protect';
2670
		}
2671
2672
		/**
2673
		 * Allow filtering of the active modules.
2674
		 *
2675
		 * Gives theme and plugin developers the power to alter the modules that
2676
		 * are activated on the fly.
2677
		 *
2678
		 * @since 5.8.0
2679
		 *
2680
		 * @param array $active Array of active module slugs.
2681
		 */
2682
		$active = apply_filters( 'jetpack_active_modules', $active );
2683
2684
		return array_unique( $active );
2685
	}
2686
2687
	/**
2688
	 * Check whether or not a Jetpack module is active.
2689
	 *
2690
	 * @param string $module The slug of a Jetpack module.
2691
	 * @return bool
2692
	 *
2693
	 * @static
2694
	 */
2695
	public static function is_module_active( $module ) {
2696
		return in_array( $module, self::get_active_modules() );
2697
	}
2698
2699
	public static function is_module( $module ) {
2700
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2701
	}
2702
2703
	/**
2704
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2705
	 *
2706
	 * @param bool $catch True to start catching, False to stop.
2707
	 *
2708
	 * @static
2709
	 */
2710
	public static function catch_errors( $catch ) {
2711
		static $display_errors, $error_reporting;
2712
2713
		if ( $catch ) {
2714
			$display_errors  = @ini_set( 'display_errors', 1 );
2715
			$error_reporting = @error_reporting( E_ALL );
2716
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2717
		} else {
2718
			@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...
2719
			@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...
2720
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2721
		}
2722
	}
2723
2724
	/**
2725
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2726
	 */
2727
	public static function catch_errors_on_shutdown() {
2728
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2729
	}
2730
2731
	/**
2732
	 * Rewrite any string to make paths easier to read.
2733
	 *
2734
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2735
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2736
	 *
2737
	 * @param $string
2738
	 * @return mixed
2739
	 */
2740
	public static function alias_directories( $string ) {
2741
		// ABSPATH has a trailing slash.
2742
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2743
		// WP_CONTENT_DIR does not have a trailing slash.
2744
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2745
2746
		return $string;
2747
	}
2748
2749
	public static function activate_default_modules(
2750
		$min_version = false,
2751
		$max_version = false,
2752
		$other_modules = array(),
2753
		$redirect = true,
2754
		$send_state_messages = true
2755
	) {
2756
		$jetpack = Jetpack::init();
2757
2758
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2759
		$modules = array_merge( $other_modules, $modules );
2760
2761
		// Look for standalone plugins and disable if active.
2762
2763
		$to_deactivate = array();
2764
		foreach ( $modules as $module ) {
2765
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2766
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2767
			}
2768
		}
2769
2770
		$deactivated = array();
2771
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2772
			list( $probable_file, $probable_title ) = $deactivate_me;
2773
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2774
				$deactivated[] = $module;
2775
			}
2776
		}
2777
2778
		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...
2779
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2780
2781
			$url = add_query_arg(
2782
				array(
2783
					'action'   => 'activate_default_modules',
2784
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2785
				),
2786
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2787
			);
2788
			wp_safe_redirect( $url );
2789
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_default_modules() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2790
		}
2791
2792
		/**
2793
		 * Fires before default modules are activated.
2794
		 *
2795
		 * @since 1.9.0
2796
		 *
2797
		 * @param string $min_version Minimum version number required to use modules.
2798
		 * @param string $max_version Maximum version number required to use modules.
2799
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2800
		 */
2801
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2802
2803
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2804
		Jetpack::restate();
2805
		Jetpack::catch_errors( true );
2806
2807
		$active = Jetpack::get_active_modules();
2808
2809
		foreach ( $modules as $module ) {
2810
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2811
				$active[] = $module;
2812
				self::update_active_modules( $active );
2813
				continue;
2814
			}
2815
2816
			if ( $send_state_messages && in_array( $module, $active ) ) {
2817
				$module_info = Jetpack::get_module( $module );
2818 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2819
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2820
					if ( $active_state = Jetpack::state( $state ) ) {
2821
						$active_state = explode( ',', $active_state );
2822
					} else {
2823
						$active_state = array();
2824
					}
2825
					$active_state[] = $module;
2826
					Jetpack::state( $state, implode( ',', $active_state ) );
2827
				}
2828
				continue;
2829
			}
2830
2831
			$file = Jetpack::get_module_path( $module );
2832
			if ( ! file_exists( $file ) ) {
2833
				continue;
2834
			}
2835
2836
			// we'll override this later if the plugin can be included without fatal error
2837
			if ( $redirect ) {
2838
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2839
			}
2840
2841
			if ( $send_state_messages ) {
2842
				Jetpack::state( 'error', 'module_activation_failed' );
2843
				Jetpack::state( 'module', $module );
2844
			}
2845
2846
			ob_start();
2847
			require_once $file;
2848
2849
			$active[] = $module;
2850
2851 View Code Duplication
			if ( $send_state_messages ) {
2852
2853
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
2854
				if ( $active_state = Jetpack::state( $state ) ) {
2855
					$active_state = explode( ',', $active_state );
2856
				} else {
2857
					$active_state = array();
2858
				}
2859
				$active_state[] = $module;
2860
				Jetpack::state( $state, implode( ',', $active_state ) );
2861
			}
2862
2863
			Jetpack::update_active_modules( $active );
2864
2865
			ob_end_clean();
2866
		}
2867
2868
		if ( $send_state_messages ) {
2869
			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...
2870
			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...
2871
		}
2872
2873
		Jetpack::catch_errors( false );
2874
		/**
2875
		 * Fires when default modules are activated.
2876
		 *
2877
		 * @since 1.9.0
2878
		 *
2879
		 * @param string $min_version Minimum version number required to use modules.
2880
		 * @param string $max_version Maximum version number required to use modules.
2881
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2882
		 */
2883
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2884
	}
2885
2886
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2887
		/**
2888
		 * Fires before a module is activated.
2889
		 *
2890
		 * @since 2.6.0
2891
		 *
2892
		 * @param string $module Module slug.
2893
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2894
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2895
		 */
2896
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2897
2898
		$jetpack = Jetpack::init();
2899
2900
		if ( ! strlen( $module ) )
2901
			return false;
2902
2903
		if ( ! Jetpack::is_module( $module ) )
2904
			return false;
2905
2906
		// If it's already active, then don't do it again
2907
		$active = Jetpack::get_active_modules();
2908
		foreach ( $active as $act ) {
2909
			if ( $act == $module )
2910
				return true;
2911
		}
2912
2913
		$module_data = Jetpack::get_module( $module );
2914
2915
		if ( ! Jetpack::is_active() ) {
2916
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2917
				return false;
2918
2919
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2920
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2921
				return false;
2922
		}
2923
2924
		// Check and see if the old plugin is active
2925
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2926
			// Deactivate the old plugin
2927
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2928
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2929
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2930
				Jetpack::state( 'deactivated_plugins', $module );
2931
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2932
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2933
			}
2934
		}
2935
2936
		// Protect won't work with mis-configured IPs
2937
		if ( 'protect' === $module ) {
2938
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2939
			if ( ! jetpack_protect_get_ip() ) {
2940
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2941
				return false;
2942
			}
2943
		}
2944
2945
		if ( ! Jetpack::active_plan_supports( $module ) ) {
2946
			return false;
2947
		}
2948
2949
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2950
		Jetpack::state( 'module', $module );
2951
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2952
2953
		Jetpack::catch_errors( true );
2954
		ob_start();
2955
		require Jetpack::get_module_path( $module );
2956
		/** This action is documented in class.jetpack.php */
2957
		do_action( 'jetpack_activate_module', $module );
2958
		$active[] = $module;
2959
		Jetpack::update_active_modules( $active );
2960
2961
		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...
2962
		ob_end_clean();
2963
		Jetpack::catch_errors( false );
2964
2965
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2966 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2967
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2968
2969
			//Jump start is being dismissed send data to MC Stats
2970
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2971
2972
			$jetpack->do_stats( 'server_side' );
2973
		}
2974
2975
		if ( $redirect ) {
2976
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2977
		}
2978
		if ( $exit ) {
2979
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2980
		}
2981
		return true;
2982
	}
2983
2984
	function activate_module_actions( $module ) {
2985
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2986
	}
2987
2988
	public static function deactivate_module( $module ) {
2989
		/**
2990
		 * Fires when a module is deactivated.
2991
		 *
2992
		 * @since 1.9.0
2993
		 *
2994
		 * @param string $module Module slug.
2995
		 */
2996
		do_action( 'jetpack_pre_deactivate_module', $module );
2997
2998
		$jetpack = Jetpack::init();
2999
3000
		$active = Jetpack::get_active_modules();
3001
		$new    = array_filter( array_diff( $active, (array) $module ) );
3002
3003
		// A flag for Jump Start so it's not shown again.
3004 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
3005
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3006
3007
			//Jump start is being dismissed send data to MC Stats
3008
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
3009
3010
			$jetpack->do_stats( 'server_side' );
3011
		}
3012
3013
		return self::update_active_modules( $new );
3014
	}
3015
3016
	public static function enable_module_configurable( $module ) {
3017
		$module = Jetpack::get_module_slug( $module );
3018
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3019
	}
3020
3021
	public static function module_configuration_url( $module ) {
3022
		$module = Jetpack::get_module_slug( $module );
3023
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
3024
	}
3025
3026
	public static function module_configuration_load( $module, $method ) {
3027
		$module = Jetpack::get_module_slug( $module );
3028
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
3029
	}
3030
3031
	public static function module_configuration_head( $module, $method ) {
3032
		$module = Jetpack::get_module_slug( $module );
3033
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
3034
	}
3035
3036
	public static function module_configuration_screen( $module, $method ) {
3037
		$module = Jetpack::get_module_slug( $module );
3038
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
3039
	}
3040
3041
	public static function module_configuration_activation_screen( $module, $method ) {
3042
		$module = Jetpack::get_module_slug( $module );
3043
		add_action( 'display_activate_module_setting_' . $module, $method );
3044
	}
3045
3046
/* Installation */
3047
3048
	public static function bail_on_activation( $message, $deactivate = true ) {
3049
?>
3050
<!doctype html>
3051
<html>
3052
<head>
3053
<meta charset="<?php bloginfo( 'charset' ); ?>">
3054
<style>
3055
* {
3056
	text-align: center;
3057
	margin: 0;
3058
	padding: 0;
3059
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3060
}
3061
p {
3062
	margin-top: 1em;
3063
	font-size: 18px;
3064
}
3065
</style>
3066
<body>
3067
<p><?php echo esc_html( $message ); ?></p>
3068
</body>
3069
</html>
3070
<?php
3071
		if ( $deactivate ) {
3072
			$plugins = get_option( 'active_plugins' );
3073
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3074
			$update  = false;
3075
			foreach ( $plugins as $i => $plugin ) {
3076
				if ( $plugin === $jetpack ) {
3077
					$plugins[$i] = false;
3078
					$update = true;
3079
				}
3080
			}
3081
3082
			if ( $update ) {
3083
				update_option( 'active_plugins', array_filter( $plugins ) );
3084
			}
3085
		}
3086
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method bail_on_activation() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

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

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
3639
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3640
			break;
3641
		}
3642
3643
		if ( ! $response ) {
3644
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3645
		}
3646
3647
		if ( is_wp_error( $response ) ) {
3648
			$status_code       = $response->get_error_data();
3649
			$error             = $response->get_error_code();
3650
			$error_description = $response->get_error_message();
3651
3652
			if ( ! is_int( $status_code ) ) {
3653
				$status_code = 400;
3654
			}
3655
3656
			status_header( $status_code );
3657
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3658
		}
3659
3660
		status_header( 200 );
3661
		if ( true === $response ) {
3662
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3663
		}
3664
3665
		die( json_encode( (object) $response ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

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

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4074
			} else {
4075
				if ( ! isset( $_GET['calypso_env'] ) ) {
4076
					Jetpack::state( 'message', 'already_authorized' );
4077
					wp_safe_redirect( Jetpack::admin_url() );
4078
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4079
				} else {
4080
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4081
					$connect_url .= '&already_authorized=true';
4082
					wp_redirect( $connect_url );
4083
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4084
				}
4085
			}
4086
		}
4087
4088
4089
		if ( isset( $_GET['action'] ) ) {
4090
			switch ( $_GET['action'] ) {
4091
			case 'authorize':
4092
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4093
					Jetpack::state( 'message', 'already_authorized' );
4094
					wp_safe_redirect( Jetpack::admin_url() );
4095
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4096
				}
4097
				Jetpack::log( 'authorize' );
4098
				$client_server = new Jetpack_Client_Server;
4099
				$client_server->client_authorize();
4100
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4101
			case 'register' :
4102
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4103
					$error = 'cheatin';
4104
					break;
4105
				}
4106
				check_admin_referer( 'jetpack-register' );
4107
				Jetpack::log( 'register' );
4108
				Jetpack::maybe_set_version_option();
4109
				$registered = Jetpack::try_registration();
4110
				if ( is_wp_error( $registered ) ) {
4111
					$error = $registered->get_error_code();
4112
					Jetpack::state( 'error', $error );
4113
					Jetpack::state( 'error', $registered->get_error_message() );
4114
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4115
						'error_code' => $error,
4116
						'error_message' => $registered->get_error_message()
4117
					) );
4118
					break;
4119
				}
4120
4121
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4122
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4123
4124
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4125
					'from' => $from
4126
				) );
4127
4128
				$url = $this->build_connect_url( true, $redirect, $from );
4129
4130
				if ( ! empty( $_GET['onboarding'] ) ) {
4131
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4132
				}
4133
4134
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4135
					$url = add_query_arg( 'auth_approved', 'true', $url );
4136
				}
4137
4138
				wp_redirect( $url );
4139
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4140
			case 'activate' :
4141
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4142
					$error = 'cheatin';
4143
					break;
4144
				}
4145
4146
				$module = stripslashes( $_GET['module'] );
4147
				check_admin_referer( "jetpack_activate-$module" );
4148
				Jetpack::log( 'activate', $module );
4149
				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...
4150
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4151
				}
4152
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4153
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4154
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4155
			case 'activate_default_modules' :
4156
				check_admin_referer( 'activate_default_modules' );
4157
				Jetpack::log( 'activate_default_modules' );
4158
				Jetpack::restate();
4159
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4160
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4161
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4162
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4163
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4164
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4165
			case 'disconnect' :
4166
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4167
					$error = 'cheatin';
4168
					break;
4169
				}
4170
4171
				check_admin_referer( 'jetpack-disconnect' );
4172
				Jetpack::log( 'disconnect' );
4173
				Jetpack::disconnect();
4174
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4175
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4176
			case 'reconnect' :
4177
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4178
					$error = 'cheatin';
4179
					break;
4180
				}
4181
4182
				check_admin_referer( 'jetpack-reconnect' );
4183
				Jetpack::log( 'reconnect' );
4184
				$this->disconnect();
4185
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4186
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4187 View Code Duplication
			case 'deactivate' :
4188
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4189
					$error = 'cheatin';
4190
					break;
4191
				}
4192
4193
				$modules = stripslashes( $_GET['module'] );
4194
				check_admin_referer( "jetpack_deactivate-$modules" );
4195
				foreach ( explode( ',', $modules ) as $module ) {
4196
					Jetpack::log( 'deactivate', $module );
4197
					Jetpack::deactivate_module( $module );
4198
					Jetpack::state( 'message', 'module_deactivated' );
4199
				}
4200
				Jetpack::state( 'module', $modules );
4201
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4202
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4203
			case 'unlink' :
4204
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4205
				check_admin_referer( 'jetpack-unlink' );
4206
				Jetpack::log( 'unlink' );
4207
				$this->unlink_user();
4208
				Jetpack::state( 'message', 'unlinked' );
4209
				if ( 'sub-unlink' == $redirect ) {
4210
					wp_safe_redirect( admin_url() );
4211
				} else {
4212
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4213
				}
4214
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4215
			case 'onboard' :
4216
				if ( ! current_user_can( 'manage_options' ) ) {
4217
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4218
				} else {
4219
					Jetpack::create_onboarding_token();
4220
					$url = $this->build_connect_url( true );
4221
4222
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4223
						$url = add_query_arg( 'onboarding', $token, $url );
4224
					}
4225
4226
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4227
					if ( $calypso_env ) {
4228
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4229
					}
4230
4231
					wp_redirect( $url );
4232
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4233
				}
4234
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4235
			default:
4236
				/**
4237
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4238
				 *
4239
				 * @since 2.6.0
4240
				 *
4241
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4242
				 */
4243
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4244
			}
4245
		}
4246
4247
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4248
			self::activate_new_modules( true );
4249
		}
4250
4251
		$message_code = Jetpack::state( 'message' );
4252
		if ( Jetpack::state( 'optin-manage' ) ) {
4253
			$activated_manage = $message_code;
4254
			$message_code = 'jetpack-manage';
4255
		}
4256
4257
		switch ( $message_code ) {
4258
		case 'jetpack-manage':
4259
			$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>';
4260
			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...
4261
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4262
			}
4263
			break;
4264
4265
		}
4266
4267
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4268
4269
		if ( ! empty( $deactivated_plugins ) ) {
4270
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4271
			$deactivated_titles  = array();
4272
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4273
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4274
					continue;
4275
				}
4276
4277
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4278
			}
4279
4280
			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...
4281
				if ( $this->message ) {
4282
					$this->message .= "<br /><br />\n";
4283
				}
4284
4285
				$this->message .= wp_sprintf(
4286
					_n(
4287
						'Jetpack contains the most recent version of the old %l plugin.',
4288
						'Jetpack contains the most recent versions of the old %l plugins.',
4289
						count( $deactivated_titles ),
4290
						'jetpack'
4291
					),
4292
					$deactivated_titles
4293
				);
4294
4295
				$this->message .= "<br />\n";
4296
4297
				$this->message .= _n(
4298
					'The old version has been deactivated and can be removed from your site.',
4299
					'The old versions have been deactivated and can be removed from your site.',
4300
					count( $deactivated_titles ),
4301
					'jetpack'
4302
				);
4303
			}
4304
		}
4305
4306
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4307
4308
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4309
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4310
		}
4311
4312 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4313
			/**
4314
			 * Fires when a module configuration page is loaded.
4315
			 * The dynamic part of the hook is the configure parameter from the URL.
4316
			 *
4317
			 * @since 1.1.0
4318
			 */
4319
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4320
		}
4321
4322
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4323
	}
4324
4325
	function admin_notices() {
4326
4327
		if ( $this->error ) {
4328
?>
4329
<div id="message" class="jetpack-message jetpack-err">
4330
	<div class="squeezer">
4331
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4332
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4333
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4334
<?php	endif; ?>
4335
	</div>
4336
</div>
4337
<?php
4338
		}
4339
4340
		if ( $this->message ) {
4341
?>
4342
<div id="message" class="jetpack-message">
4343
	<div class="squeezer">
4344
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4345
	</div>
4346
</div>
4347
<?php
4348
		}
4349
4350
		if ( $this->privacy_checks ) :
4351
			$module_names = $module_slugs = array();
4352
4353
			$privacy_checks = explode( ',', $this->privacy_checks );
4354
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4355
			foreach ( $privacy_checks as $module_slug ) {
4356
				$module = Jetpack::get_module( $module_slug );
4357
				if ( ! $module ) {
4358
					continue;
4359
				}
4360
4361
				$module_slugs[] = $module_slug;
4362
				$module_names[] = "<strong>{$module['name']}</strong>";
4363
			}
4364
4365
			$module_slugs = join( ',', $module_slugs );
4366
?>
4367
<div id="message" class="jetpack-message jetpack-err">
4368
	<div class="squeezer">
4369
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4370
		<p><?php
4371
			echo wp_kses(
4372
				wptexturize(
4373
					wp_sprintf(
4374
						_nx(
4375
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4376
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4377
							count( $privacy_checks ),
4378
							'%l = list of Jetpack module/feature names',
4379
							'jetpack'
4380
						),
4381
						$module_names
4382
					)
4383
				),
4384
				array( 'strong' => true )
4385
			);
4386
4387
			echo "\n<br />\n";
4388
4389
			echo wp_kses(
4390
				sprintf(
4391
					_nx(
4392
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4393
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4394
						count( $privacy_checks ),
4395
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4396
						'jetpack'
4397
					),
4398
					wp_nonce_url(
4399
						Jetpack::admin_url(
4400
							array(
4401
								'page'   => 'jetpack',
4402
								'action' => 'deactivate',
4403
								'module' => urlencode( $module_slugs ),
4404
							)
4405
						),
4406
						"jetpack_deactivate-$module_slugs"
4407
					),
4408
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4409
				),
4410
				array( 'a' => array( 'href' => true, 'title' => true ) )
4411
			);
4412
		?></p>
4413
	</div>
4414
</div>
4415
<?php endif;
4416
	// only display the notice if the other stuff is not there
4417
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4418
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4419
			$this->opt_in_jetpack_manage_notice();
4420
		}
4421
	}
4422
4423
	/**
4424
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4425
	 */
4426
	function stat( $group, $detail ) {
4427
		if ( ! isset( $this->stats[ $group ] ) )
4428
			$this->stats[ $group ] = array();
4429
		$this->stats[ $group ][] = $detail;
4430
	}
4431
4432
	/**
4433
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4434
	 */
4435
	function do_stats( $method = '' ) {
4436
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4437
			foreach ( $this->stats as $group => $stats ) {
4438
				if ( is_array( $stats ) && count( $stats ) ) {
4439
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4440
					if ( 'server_side' === $method ) {
4441
						self::do_server_side_stat( $args );
4442
					} else {
4443
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4444
					}
4445
				}
4446
				unset( $this->stats[ $group ] );
4447
			}
4448
		}
4449
	}
4450
4451
	/**
4452
	 * Runs stats code for a one-off, server-side.
4453
	 *
4454
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4455
	 *
4456
	 * @return bool If it worked.
4457
	 */
4458
	static function do_server_side_stat( $args ) {
4459
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4460
		if ( is_wp_error( $response ) )
4461
			return false;
4462
4463
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4464
			return false;
4465
4466
		return true;
4467
	}
4468
4469
	/**
4470
	 * Builds the stats url.
4471
	 *
4472
	 * @param $args array|string The arguments to append to the URL.
4473
	 *
4474
	 * @return string The URL to be pinged.
4475
	 */
4476
	static function build_stats_url( $args ) {
4477
		$defaults = array(
4478
			'v'    => 'wpcom2',
4479
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4480
		);
4481
		$args     = wp_parse_args( $args, $defaults );
4482
		/**
4483
		 * Filter the URL used as the Stats tracking pixel.
4484
		 *
4485
		 * @since 2.3.2
4486
		 *
4487
		 * @param string $url Base URL used as the Stats tracking pixel.
4488
		 */
4489
		$base_url = apply_filters(
4490
			'jetpack_stats_base_url',
4491
			'https://pixel.wp.com/g.gif'
4492
		);
4493
		$url      = add_query_arg( $args, $base_url );
4494
		return $url;
4495
	}
4496
4497
	static function translate_current_user_to_role() {
4498
		foreach ( self::$capability_translations as $role => $cap ) {
4499
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4500
				return $role;
4501
			}
4502
		}
4503
4504
		return false;
4505
	}
4506
4507
	static function translate_user_to_role( $user ) {
4508
		foreach ( self::$capability_translations as $role => $cap ) {
4509
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4510
				return $role;
4511
			}
4512
		}
4513
4514
		return false;
4515
    }
4516
4517
	static function translate_role_to_cap( $role ) {
4518
		if ( ! isset( self::$capability_translations[$role] ) ) {
4519
			return false;
4520
		}
4521
4522
		return self::$capability_translations[$role];
4523
	}
4524
4525
	static function sign_role( $role, $user_id = null ) {
4526
		if ( empty( $user_id ) ) {
4527
			$user_id = (int) get_current_user_id();
4528
		}
4529
4530
		if ( ! $user_id  ) {
4531
			return false;
4532
		}
4533
4534
		$token = Jetpack_Data::get_access_token();
4535
		if ( ! $token || is_wp_error( $token ) ) {
4536
			return false;
4537
		}
4538
4539
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4540
	}
4541
4542
4543
	/**
4544
	 * Builds a URL to the Jetpack connection auth page
4545
	 *
4546
	 * @since 3.9.5
4547
	 *
4548
	 * @param bool $raw If true, URL will not be escaped.
4549
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4550
	 *                              If string, will be a custom redirect.
4551
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4552
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4553
	 *
4554
	 * @return string Connect URL
4555
	 */
4556
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4557
		$site_id = Jetpack_Options::get_option( 'id' );
4558
		$token = Jetpack_Options::get_option( 'blog_token' );
4559
4560
		if ( $register || ! $token || ! $site_id ) {
4561
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4562
4563
			if ( ! empty( $redirect ) ) {
4564
				$url = add_query_arg(
4565
					'redirect',
4566
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4567
					$url
4568
				);
4569
			}
4570
4571
			if( is_network_admin() ) {
4572
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4573
			}
4574
		} else {
4575
4576
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4577
			// because otherwise this logic can get us in to a loop.
4578
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4579
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4580
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4581
4582
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4583
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4584
					'1.1'
4585
				);
4586
4587
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4588
					// Generating a register URL instead to refresh the existing token
4589
					return $this->build_connect_url( $raw, $redirect, $from, true );
4590
				}
4591
			}
4592
4593
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4594
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4595
			}
4596
4597
			$role = self::translate_current_user_to_role();
4598
			$signed_role = self::sign_role( $role );
4599
4600
			$user = wp_get_current_user();
4601
4602
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4603
			$redirect = $redirect
4604
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4605
				: $jetpack_admin_page;
4606
4607
			if( isset( $_REQUEST['is_multisite'] ) ) {
4608
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4609
			}
4610
4611
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4612
4613
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4614
				? get_site_icon_url()
4615
				: false;
4616
4617
			/**
4618
			 * Filter the type of authorization.
4619
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4620
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4621
			 *
4622
			 * @since 4.3.3
4623
			 *
4624
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4625
			 */
4626
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4627
4628
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4629
4630
			$args = urlencode_deep(
4631
				array(
4632
					'response_type' => 'code',
4633
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4634
					'redirect_uri'  => add_query_arg(
4635
						array(
4636
							'action'   => 'authorize',
4637
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4638
							'redirect' => urlencode( $redirect ),
4639
						),
4640
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4641
					),
4642
					'state'         => $user->ID,
4643
					'scope'         => $signed_role,
4644
					'user_email'    => $user->user_email,
4645
					'user_login'    => $user->user_login,
4646
					'is_active'     => Jetpack::is_active(),
4647
					'jp_version'    => JETPACK__VERSION,
4648
					'auth_type'     => $auth_type,
4649
					'secret'        => $secrets['secret_1'],
4650
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4651
					'blogname'      => get_option( 'blogname' ),
4652
					'site_url'      => site_url(),
4653
					'home_url'      => home_url(),
4654
					'site_icon'     => $site_icon,
4655
					'site_lang'     => get_locale(),
4656
					'_ui'           => $tracks_identity['_ui'],
4657
					'_ut'           => $tracks_identity['_ut']
4658
				)
4659
			);
4660
4661
			self::apply_activation_source_to_args( $args );
4662
4663
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4664
		}
4665
4666
		if ( $from ) {
4667
			$url = add_query_arg( 'from', $from, $url );
4668
		}
4669
4670
4671
		if ( isset( $_GET['calypso_env'] ) ) {
4672
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4673
		}
4674
4675
		return $raw ? $url : esc_url( $url );
4676
	}
4677
4678
	public static function apply_activation_source_to_args( &$args ) {
4679
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4680
4681
		if ( $activation_source_name ) {
4682
			$args['_as'] = urlencode( $activation_source_name );
4683
		}
4684
4685
		if ( $activation_source_keyword ) {
4686
			$args['_ak'] = urlencode( $activation_source_keyword );
4687
		}
4688
	}
4689
4690
	function build_reconnect_url( $raw = false ) {
4691
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4692
		return $raw ? $url : esc_url( $url );
4693
	}
4694
4695
	public static function admin_url( $args = null ) {
4696
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4697
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4698
		return $url;
4699
	}
4700
4701
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4702
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4703
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4704
	}
4705
4706
	function dismiss_jetpack_notice() {
4707
4708
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4709
			return;
4710
		}
4711
4712
		switch( $_GET['jetpack-notice'] ) {
4713
			case 'dismiss':
4714
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4715
4716
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4717
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4718
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4719
				}
4720
				break;
4721 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4722
4723
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4724
					// Don't show the banner again
4725
4726
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4727
					// redirect back to the page that had the notice
4728
					if ( wp_get_referer() ) {
4729
						wp_safe_redirect( wp_get_referer() );
4730
					} else {
4731
						// Take me to Jetpack
4732
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4733
					}
4734
				}
4735
				break;
4736 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4737
4738
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4739
					// Don't show the banner again
4740
4741
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4742
					// redirect back to the page that had the notice
4743
					if ( wp_get_referer() ) {
4744
						wp_safe_redirect( wp_get_referer() );
4745
					} else {
4746
						// Take me to Jetpack
4747
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4748
					}
4749
				}
4750
				break;
4751
			case 'jetpack-manage-opt-in':
4752
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4753
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4754
4755
					$redirection_url = Jetpack::admin_url();
4756
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4757
4758
					// Don't redirect form the Jetpack Setting Page
4759
					$referer_parsed = parse_url ( wp_get_referer() );
4760
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4761
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4762
						// Take the user to Jetpack home except when on the setting page
4763
						$redirection_url = wp_get_referer();
4764
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4765
					}
4766
					// Also update the JSON API FULL MANAGEMENT Option
4767
					Jetpack::activate_module( 'manage', false, false );
4768
4769
					// Special Message when option in.
4770
					Jetpack::state( 'optin-manage', 'true' );
4771
					// Activate the Module if not activated already
4772
4773
					// Redirect properly
4774
					wp_safe_redirect( $redirection_url );
4775
4776
				}
4777
				break;
4778
		}
4779
	}
4780
4781
	public static function admin_screen_configure_module( $module_id ) {
4782
4783
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4784
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4785
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4786
				/**
4787
				 * Fires to diplay a custom module activation screen.
4788
				 *
4789
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4790
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4791
				 *
4792
				 * @module manage
4793
				 *
4794
				 * @since 3.8.0
4795
				 *
4796
				 * @param int $module_id Module ID.
4797
				 */
4798
				do_action( 'display_activate_module_setting_' . $module_id );
4799
			} else {
4800
				self::display_activate_module_link( $module_id );
4801
			}
4802
4803
			return false;
4804
		} ?>
4805
4806
		<div id="jp-settings-screen" style="position: relative">
4807
			<h3>
4808
			<?php
4809
				$module = Jetpack::get_module( $module_id );
4810
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4811
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4812
			?>
4813
			</h3>
4814
			<?php
4815
				/**
4816
				 * Fires within the displayed message when a feature configuation is updated.
4817
				 *
4818
				 * @since 3.4.0
4819
				 *
4820
				 * @param int $module_id Module ID.
4821
				 */
4822
				do_action( 'jetpack_notices_update_settings', $module_id );
4823
				/**
4824
				 * Fires when a feature configuation screen is loaded.
4825
				 * The dynamic part of the hook, $module_id, is the module ID.
4826
				 *
4827
				 * @since 1.1.0
4828
				 */
4829
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4830
			?>
4831
		</div><?php
4832
	}
4833
4834
	/**
4835
	 * Display link to activate the module to see the settings screen.
4836
	 * @param  string $module_id
4837
	 * @return null
4838
	 */
4839
	public static function display_activate_module_link( $module_id ) {
4840
4841
		$info =  Jetpack::get_module( $module_id );
4842
		$extra = '';
4843
		$activate_url = wp_nonce_url(
4844
				Jetpack::admin_url(
4845
					array(
4846
						'page'   => 'jetpack',
4847
						'action' => 'activate',
4848
						'module' => $module_id,
4849
					)
4850
				),
4851
				"jetpack_activate-$module_id"
4852
			);
4853
4854
		?>
4855
4856
		<div class="wrap configure-module">
4857
			<div id="jp-settings-screen">
4858
				<?php
4859
				if ( $module_id == 'json-api' ) {
4860
4861
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4862
4863
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4864
4865
					$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' );
4866
4867
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4868
				} ?>
4869
4870
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4871
				<div class="narrow">
4872
					<p><?php echo  $info['description']; ?></p>
4873
					<?php if( $extra ) { ?>
4874
					<p><?php echo esc_html( $extra ); ?></p>
4875
					<?php } ?>
4876
					<p>
4877
						<?php
4878
						if( wp_get_referer() ) {
4879
							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() );
4880
						} else {
4881
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4882
						} ?>
4883
					</p>
4884
				</div>
4885
4886
			</div>
4887
		</div>
4888
4889
		<?php
4890
	}
4891
4892
	public static function sort_modules( $a, $b ) {
4893
		if ( $a['sort'] == $b['sort'] )
4894
			return 0;
4895
4896
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4897
	}
4898
4899
	function ajax_recheck_ssl() {
4900
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4901
		$result = Jetpack::permit_ssl( true );
4902
		wp_send_json( array(
4903
			'enabled' => $result,
4904
			'message' => get_transient( 'jetpack_https_test_message' )
4905
		) );
4906
	}
4907
4908
/* Client API */
4909
4910
	/**
4911
	 * Returns the requested Jetpack API URL
4912
	 *
4913
	 * @return string
4914
	 */
4915
	public static function api_url( $relative_url ) {
4916
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4917
	}
4918
4919
	/**
4920
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4921
	 */
4922
	public static function fix_url_for_bad_hosts( $url ) {
4923
		if ( 0 !== strpos( $url, 'https://' ) ) {
4924
			return $url;
4925
		}
4926
4927
		switch ( JETPACK_CLIENT__HTTPS ) {
4928
			case 'ALWAYS' :
4929
				return $url;
4930
			case 'NEVER' :
4931
				return set_url_scheme( $url, 'http' );
4932
			// default : case 'AUTO' :
4933
		}
4934
4935
		// we now return the unmodified SSL URL by default, as a security precaution
4936
		return $url;
4937
	}
4938
4939
	/**
4940
	 * Create a random secret for validating onboarding payload
4941
	 *
4942
	 * @return string Secret token
4943
	 */
4944
	public static function create_onboarding_token() {
4945
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4946
			$token = wp_generate_password( 32, false );
4947
			Jetpack_Options::update_option( 'onboarding', $token );
4948
		}
4949
4950
		return $token;
4951
	}
4952
4953
	/**
4954
	 * Remove the onboarding token
4955
	 *
4956
	 * @return bool True on success, false on failure
4957
	 */
4958
	public static function invalidate_onboarding_token() {
4959
		return Jetpack_Options::delete_option( 'onboarding' );
4960
	}
4961
4962
	/**
4963
	 * Validate an onboarding token for a specific action
4964
	 *
4965
	 * @return boolean True if token/action pair is accepted, false if not
4966
	 */
4967
	public static function validate_onboarding_token_action( $token, $action ) {
4968
		// Compare tokens, bail if tokens do not match
4969
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
4970
			return false;
4971
		}
4972
4973
		// List of valid actions we can take
4974
		$valid_actions = array(
4975
			'/jetpack/v4/settings',
4976
		);
4977
4978
		// Whitelist the action
4979
		if ( ! in_array( $action, $valid_actions ) ) {
4980
			return false;
4981
		}
4982
4983
		return true;
4984
	}
4985
4986
	/**
4987
	 * Checks to see if the URL is using SSL to connect with Jetpack
4988
	 *
4989
	 * @since 2.3.3
4990
	 * @return boolean
4991
	 */
4992
	public static function permit_ssl( $force_recheck = false ) {
4993
		// Do some fancy tests to see if ssl is being supported
4994
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4995
			$message = '';
4996
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4997
				$ssl = 0;
4998
			} else {
4999
				switch ( JETPACK_CLIENT__HTTPS ) {
5000
					case 'NEVER':
5001
						$ssl = 0;
5002
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5003
						break;
5004
					case 'ALWAYS':
5005
					case 'AUTO':
5006
					default:
5007
						$ssl = 1;
5008
						break;
5009
				}
5010
5011
				// If it's not 'NEVER', test to see
5012
				if ( $ssl ) {
5013
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5014
						$ssl = 0;
5015
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5016
					} else {
5017
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5018
						if ( is_wp_error( $response ) ) {
5019
							$ssl = 0;
5020
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5021
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5022
							$ssl = 0;
5023
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5024
						}
5025
					}
5026
				}
5027
			}
5028
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5029
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5030
		}
5031
5032
		return (bool) $ssl;
5033
	}
5034
5035
	/*
5036
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5037
	 */
5038
	public function alert_auto_ssl_fail() {
5039
		if ( ! current_user_can( 'manage_options' ) )
5040
			return;
5041
5042
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5043
		?>
5044
5045
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5046
			<div class="jp-banner__content">
5047
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5048
				<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>
5049
				<p>
5050
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5051
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5052
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5053
				</p>
5054
				<p>
5055
					<?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' ),
5056
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
5057
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
5058
				</p>
5059
			</div>
5060
		</div>
5061
		<style>
5062
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5063
		</style>
5064
		<script type="text/javascript">
5065
			jQuery( document ).ready( function( $ ) {
5066
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5067
					var $this = $( this );
5068
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5069
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5070
					e.preventDefault();
5071
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5072
					$.post( ajaxurl, data )
5073
					  .done( function( response ) {
5074
					  	if ( response.enabled ) {
5075
					  		$( '#jetpack-ssl-warning' ).hide();
5076
					  	} else {
5077
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5078
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5079
					  	}
5080
					  }.bind( $this ) );
5081
				} );
5082
			} );
5083
		</script>
5084
5085
		<?php
5086
	}
5087
5088
	/**
5089
	 * Returns the Jetpack XML-RPC API
5090
	 *
5091
	 * @return string
5092
	 */
5093
	public static function xmlrpc_api_url() {
5094
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5095
		return untrailingslashit( $base ) . '/xmlrpc.php';
5096
	}
5097
5098
	/**
5099
	 * Creates two secret tokens and the end of life timestamp for them.
5100
	 *
5101
	 * Note these tokens are unique per call, NOT static per site for connecting.
5102
	 *
5103
	 * @since 2.6
5104
	 * @return array
5105
	 */
5106
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5107
		if ( ! $user_id ) {
5108
			$user_id = get_current_user_id();
5109
		}
5110
5111
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5112
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5113
5114
		if (
5115
			isset( $secrets[ $secret_name ] ) &&
5116
			$secrets[ $secret_name ]['exp'] > time()
5117
		) {
5118
			return $secrets[ $secret_name ];
5119
		}
5120
5121
		$secret_value = array(
5122
			'secret_1'  => wp_generate_password( 32, false ),
5123
			'secret_2'  => wp_generate_password( 32, false ),
5124
			'exp'       => time() + $exp,
5125
		);
5126
5127
		$secrets[ $secret_name ] = $secret_value;
5128
5129
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5130
		return $secrets[ $secret_name ];
5131
	}
5132
5133
	public static function get_secrets( $action, $user_id ) {
5134
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5135
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5136
5137
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5138
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5139
		}
5140
5141
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5142
			self::delete_secrets( $action, $user_id );
5143
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5144
		}
5145
5146
		return $secrets[ $secret_name ];
5147
	}
5148
5149
	public static function delete_secrets( $action, $user_id ) {
5150
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5151
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5152
		if ( isset( $secrets[ $secret_name ] ) ) {
5153
			unset( $secrets[ $secret_name ] );
5154
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5155
		}
5156
	}
5157
5158
	/**
5159
	 * Builds the timeout limit for queries talking with the wpcom servers.
5160
	 *
5161
	 * Based on local php max_execution_time in php.ini
5162
	 *
5163
	 * @since 2.6
5164
	 * @return int
5165
	 * @deprecated
5166
	 **/
5167
	public function get_remote_query_timeout_limit() {
5168
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5169
		return Jetpack::get_max_execution_time();
5170
	}
5171
5172
	/**
5173
	 * Builds the timeout limit for queries talking with the wpcom servers.
5174
	 *
5175
	 * Based on local php max_execution_time in php.ini
5176
	 *
5177
	 * @since 5.4
5178
	 * @return int
5179
	 **/
5180
	public static function get_max_execution_time() {
5181
		$timeout = (int) ini_get( 'max_execution_time' );
5182
5183
		// Ensure exec time set in php.ini
5184
		if ( ! $timeout ) {
5185
			$timeout = 30;
5186
		}
5187
		return $timeout;
5188
	}
5189
5190
	/**
5191
	 * Sets a minimum request timeout, and returns the current timeout
5192
	 *
5193
	 * @since 5.4
5194
	 **/
5195
	public static function set_min_time_limit( $min_timeout ) {
5196
		$timeout = self::get_max_execution_time();
5197
		if ( $timeout < $min_timeout ) {
5198
			$timeout = $min_timeout;
5199
			set_time_limit( $timeout );
5200
		}
5201
		return $timeout;
5202
	}
5203
5204
5205
	/**
5206
	 * Takes the response from the Jetpack register new site endpoint and
5207
	 * verifies it worked properly.
5208
	 *
5209
	 * @since 2.6
5210
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5211
	 **/
5212
	public function validate_remote_register_response( $response ) {
5213
	  if ( is_wp_error( $response ) ) {
5214
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5215
		}
5216
5217
		$code   = wp_remote_retrieve_response_code( $response );
5218
		$entity = wp_remote_retrieve_body( $response );
5219
		if ( $entity )
5220
			$registration_response = json_decode( $entity );
5221
		else
5222
			$registration_response = false;
5223
5224
		$code_type = intval( $code / 100 );
5225
		if ( 5 == $code_type ) {
5226
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5227
		} elseif ( 408 == $code ) {
5228
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5229
		} elseif ( ! empty( $registration_response->error ) ) {
5230
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5231
				$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' );
5232
			} else {
5233
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5234
			}
5235
5236
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5237
		} elseif ( 200 != $code ) {
5238
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5239
		}
5240
5241
		// Jetpack ID error block
5242
		if ( empty( $registration_response->jetpack_id ) ) {
5243
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5244
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5245
			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 );
5246
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5247
			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 );
5248
		}
5249
5250
	    return $registration_response;
5251
	}
5252
	/**
5253
	 * @return bool|WP_Error
5254
	 */
5255
	public static function register() {
5256
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5257
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5258
		$secrets = Jetpack::generate_secrets( 'register' );
5259
5260 View Code Duplication
		if (
5261
			empty( $secrets['secret_1'] ) ||
5262
			empty( $secrets['secret_2'] ) ||
5263
			empty( $secrets['exp'] )
5264
		) {
5265
			return new Jetpack_Error( 'missing_secrets' );
5266
		}
5267
5268
		// better to try (and fail) to set a higher timeout than this system
5269
		// supports than to have register fail for more users than it should
5270
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5271
5272
		$gmt_offset = get_option( 'gmt_offset' );
5273
		if ( ! $gmt_offset ) {
5274
			$gmt_offset = 0;
5275
		}
5276
5277
		$stats_options = get_option( 'stats_options' );
5278
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5279
5280
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5281
5282
		$args = array(
5283
			'method'  => 'POST',
5284
			'body'    => array(
5285
				'siteurl'         => site_url(),
5286
				'home'            => home_url(),
5287
				'gmt_offset'      => $gmt_offset,
5288
				'timezone_string' => (string) get_option( 'timezone_string' ),
5289
				'site_name'       => (string) get_option( 'blogname' ),
5290
				'secret_1'        => $secrets['secret_1'],
5291
				'secret_2'        => $secrets['secret_2'],
5292
				'site_lang'       => get_locale(),
5293
				'timeout'         => $timeout,
5294
				'stats_id'        => $stats_id,
5295
				'state'           => get_current_user_id(),
5296
				'_ui'             => $tracks_identity['_ui'],
5297
				'_ut'             => $tracks_identity['_ut'],
5298
				'jetpack_version' => JETPACK__VERSION
5299
			),
5300
			'headers' => array(
5301
				'Accept' => 'application/json',
5302
			),
5303
			'timeout' => $timeout,
5304
		);
5305
5306
		self::apply_activation_source_to_args( $args['body'] );
5307
5308
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5309
5310
		// Make sure the response is valid and does not contain any Jetpack errors
5311
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5312
		if ( is_wp_error( $registration_details ) ) {
5313
			return $registration_details;
5314
		} elseif ( ! $registration_details ) {
5315
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5316
		}
5317
5318 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5319
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5320
		}
5321
5322
		if ( isset( $registration_details->jetpack_public ) ) {
5323
			$jetpack_public = (int) $registration_details->jetpack_public;
5324
		} else {
5325
			$jetpack_public = false;
5326
		}
5327
5328
		Jetpack_Options::update_options(
5329
			array(
5330
				'id'         => (int)    $registration_details->jetpack_id,
5331
				'blog_token' => (string) $registration_details->jetpack_secret,
5332
				'public'     => $jetpack_public,
5333
			)
5334
		);
5335
5336
		/**
5337
		 * Fires when a site is registered on WordPress.com.
5338
		 *
5339
		 * @since 3.7.0
5340
		 *
5341
		 * @param int $json->jetpack_id Jetpack Blog ID.
5342
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5343
		 * @param int|bool $jetpack_public Is the site public.
5344
		 */
5345
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5346
5347
		// Initialize Jump Start for the first and only time.
5348
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5349
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5350
5351
			$jetpack = Jetpack::init();
5352
5353
			$jetpack->stat( 'jumpstart', 'unique-views' );
5354
			$jetpack->do_stats( 'server_side' );
5355
		};
5356
5357
		return true;
5358
	}
5359
5360
	/**
5361
	 * If the db version is showing something other that what we've got now, bump it to current.
5362
	 *
5363
	 * @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...
5364
	 */
5365
	public static function maybe_set_version_option() {
5366
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5367
		if ( JETPACK__VERSION != $version ) {
5368
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5369
5370
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5371
				/** This action is documented in class.jetpack.php */
5372
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5373
			}
5374
5375
			return true;
5376
		}
5377
		return false;
5378
	}
5379
5380
/* Client Server API */
5381
5382
	/**
5383
	 * Loads the Jetpack XML-RPC client
5384
	 */
5385
	public static function load_xml_rpc_client() {
5386
		require_once ABSPATH . WPINC . '/class-IXR.php';
5387
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5388
	}
5389
5390
	/**
5391
	 * Resets the saved authentication state in between testing requests.
5392
	 */
5393
	public function reset_saved_auth_state() {
5394
		$this->xmlrpc_verification = null;
5395
		$this->rest_authentication_status = null;
5396
	}
5397
5398
	function verify_xml_rpc_signature() {
5399
		if ( $this->xmlrpc_verification ) {
5400
			return $this->xmlrpc_verification;
5401
		}
5402
5403
		// It's not for us
5404
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5405
			return false;
5406
		}
5407
5408
		@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...
5409
		if (
5410
			empty( $token_key )
5411
		||
5412
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5413
		) {
5414
			return false;
5415
		}
5416
5417
		if ( '0' === $user_id ) {
5418
			$token_type = 'blog';
5419
			$user_id = 0;
5420
		} else {
5421
			$token_type = 'user';
5422
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5423
				return false;
5424
			}
5425
			$user_id = (int) $user_id;
5426
5427
			$user = new WP_User( $user_id );
5428
			if ( ! $user || ! $user->exists() ) {
5429
				return false;
5430
			}
5431
		}
5432
5433
		$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...
5434
		if ( ! $token ) {
5435
			return false;
5436
		}
5437
5438
		$token_check = "$token_key.";
5439
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
5440
			return false;
5441
		}
5442
5443
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5444
5445
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5446
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5447
			$post_data   = $_POST;
5448
			$file_hashes = array();
5449
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5450
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5451
					continue;
5452
				}
5453
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5454
				$file_hashes[$post_data_key] = $post_data_value;
5455
			}
5456
5457
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5458
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5459
				$post_data[$post_data_key] = $post_data_value;
5460
			}
5461
5462
			ksort( $post_data );
5463
5464
			$body = http_build_query( stripslashes_deep( $post_data ) );
5465
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5466
			$body = file_get_contents( 'php://input' );
5467
		} else {
5468
			$body = null;
5469
		}
5470
5471
		$signature = $jetpack_signature->sign_current_request(
5472
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5473
		);
5474
5475
		if ( ! $signature ) {
5476
			return false;
5477
		} else if ( is_wp_error( $signature ) ) {
5478
			return $signature;
5479
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
5480
			return false;
5481
		}
5482
5483
		$timestamp = (int) $_GET['timestamp'];
5484
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5485
5486
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5487
			return false;
5488
		}
5489
5490
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5491
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5492
			if ( ! empty( $_GET['onboarding'] ) ) {
5493
				$jpo = $_GET;
5494
			} else {
5495
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5496
			}
5497
5498
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5499
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5500
5501
			if (
5502
				isset( $jpo_user ) && isset( $jpo_token ) &&
5503
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5504
				isset( $_GET['rest_route'] ) &&
5505
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5506
			) {
5507
				$jpUser = get_user_by( 'email', $jpo_user );
5508
				if ( is_a( $jpUser, 'WP_User' ) ) {
5509
					wp_set_current_user( $jpUser->ID );
5510
					$user_can = is_multisite()
5511
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5512
						: current_user_can( 'manage_options' );
5513
					if ( $user_can ) {
5514
						$token_type = 'user';
5515
						$token->external_user_id = $jpUser->ID;
5516
					}
5517
				}
5518
			}
5519
		}
5520
5521
		$this->xmlrpc_verification = array(
5522
			'type'    => $token_type,
5523
			'user_id' => $token->external_user_id,
5524
		);
5525
5526
		return $this->xmlrpc_verification;
5527
	}
5528
5529
	/**
5530
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5531
	 */
5532
	function authenticate_jetpack( $user, $username, $password ) {
5533
		if ( is_a( $user, 'WP_User' ) ) {
5534
			return $user;
5535
		}
5536
5537
		$token_details = $this->verify_xml_rpc_signature();
5538
5539
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5540
			return $user;
5541
		}
5542
5543
		if ( 'user' !== $token_details['type'] ) {
5544
			return $user;
5545
		}
5546
5547
		if ( ! $token_details['user_id'] ) {
5548
			return $user;
5549
		}
5550
5551
		nocache_headers();
5552
5553
		return new WP_User( $token_details['user_id'] );
5554
	}
5555
5556
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5557
	// Uses the existing XMLRPC request signing implementation.
5558
	function wp_rest_authenticate( $user ) {
5559
		if ( ! empty( $user ) ) {
5560
			// Another authentication method is in effect.
5561
			return $user;
5562
		}
5563
5564
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5565
			// Nothing to do for this authentication method.
5566
			return null;
5567
		}
5568
5569
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5570
			// Nothing to do for this authentication method.
5571
			return null;
5572
		}
5573
5574
		// Ensure that we always have the request body available.  At this
5575
		// point, the WP REST API code to determine the request body has not
5576
		// run yet.  That code may try to read from 'php://input' later, but
5577
		// this can only be done once per request in PHP versions prior to 5.6.
5578
		// So we will go ahead and perform this read now if needed, and save
5579
		// the request body where both the Jetpack signature verification code
5580
		// and the WP REST API code can see it.
5581
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5582
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5583
		}
5584
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5585
5586
		// Only support specific request parameters that have been tested and
5587
		// are known to work with signature verification.  A different method
5588
		// can be passed to the WP REST API via the '?_method=' parameter if
5589
		// needed.
5590
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5591
			$this->rest_authentication_status = new WP_Error(
5592
				'rest_invalid_request',
5593
				__( 'This request method is not supported.', 'jetpack' ),
5594
				array( 'status' => 400 )
5595
			);
5596
			return null;
5597
		}
5598
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5599
			$this->rest_authentication_status = new WP_Error(
5600
				'rest_invalid_request',
5601
				__( 'This request method does not support body parameters.', 'jetpack' ),
5602
				array( 'status' => 400 )
5603
			);
5604
			return null;
5605
		}
5606
5607
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5608
			$content_type = $_SERVER['CONTENT_TYPE'];
5609
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5610
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5611
		}
5612
5613
		if (
5614
			isset( $content_type ) &&
5615
			$content_type !== 'application/x-www-form-urlencoded' &&
5616
			$content_type !== 'application/json'
5617
		) {
5618
			$this->rest_authentication_status = new WP_Error(
5619
				'rest_invalid_request',
5620
				__( 'This Content-Type is not supported.', 'jetpack' ),
5621
				array( 'status' => 400 )
5622
			);
5623
			return null;
5624
		}
5625
5626
		$verified = $this->verify_xml_rpc_signature();
5627
5628
		if ( is_wp_error( $verified ) ) {
5629
			$this->rest_authentication_status = $verified;
5630
			return null;
5631
		}
5632
5633
		if (
5634
			$verified &&
5635
			isset( $verified['type'] ) &&
5636
			'user' === $verified['type'] &&
5637
			! empty( $verified['user_id'] )
5638
		) {
5639
			// Authentication successful.
5640
			$this->rest_authentication_status = true;
5641
			return $verified['user_id'];
5642
		}
5643
5644
		// Something else went wrong.  Probably a signature error.
5645
		$this->rest_authentication_status = new WP_Error(
5646
			'rest_invalid_signature',
5647
			__( 'The request is not signed correctly.', 'jetpack' ),
5648
			array( 'status' => 400 )
5649
		);
5650
		return null;
5651
	}
5652
5653
	/**
5654
	 * Report authentication status to the WP REST API.
5655
	 *
5656
	 * @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...
5657
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5658
	 */
5659
	public function wp_rest_authentication_errors( $value ) {
5660
		if ( $value !== null ) {
5661
			return $value;
5662
		}
5663
		return $this->rest_authentication_status;
5664
	}
5665
5666
	function add_nonce( $timestamp, $nonce ) {
5667
		global $wpdb;
5668
		static $nonces_used_this_request = array();
5669
5670
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5671
			return $nonces_used_this_request["$timestamp:$nonce"];
5672
		}
5673
5674
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5675
		$timestamp = (int) $timestamp;
5676
		$nonce     = esc_sql( $nonce );
5677
5678
		// Raw query so we can avoid races: add_option will also update
5679
		$show_errors = $wpdb->show_errors( false );
5680
5681
		$old_nonce = $wpdb->get_row(
5682
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5683
		);
5684
5685
		if ( is_null( $old_nonce ) ) {
5686
			$return = $wpdb->query(
5687
				$wpdb->prepare(
5688
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5689
					"jetpack_nonce_{$timestamp}_{$nonce}",
5690
					time(),
5691
					'no'
5692
				)
5693
			);
5694
		} else {
5695
			$return = false;
5696
		}
5697
5698
		$wpdb->show_errors( $show_errors );
5699
5700
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5701
5702
		return $return;
5703
	}
5704
5705
	/**
5706
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5707
	 * Capture it here so we can verify the signature later.
5708
	 */
5709
	function xmlrpc_methods( $methods ) {
5710
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5711
		return $methods;
5712
	}
5713
5714
	function public_xmlrpc_methods( $methods ) {
5715
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5716
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5717
		}
5718
		return $methods;
5719
	}
5720
5721
	function jetpack_getOptions( $args ) {
5722
		global $wp_xmlrpc_server;
5723
5724
		$wp_xmlrpc_server->escape( $args );
5725
5726
		$username	= $args[1];
5727
		$password	= $args[2];
5728
5729
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5730
			return $wp_xmlrpc_server->error;
5731
		}
5732
5733
		$options = array();
5734
		$user_data = $this->get_connected_user_data();
5735
		if ( is_array( $user_data ) ) {
5736
			$options['jetpack_user_id'] = array(
5737
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5738
				'readonly'      => true,
5739
				'value'         => $user_data['ID'],
5740
			);
5741
			$options['jetpack_user_login'] = array(
5742
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5743
				'readonly'      => true,
5744
				'value'         => $user_data['login'],
5745
			);
5746
			$options['jetpack_user_email'] = array(
5747
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5748
				'readonly'      => true,
5749
				'value'         => $user_data['email'],
5750
			);
5751
			$options['jetpack_user_site_count'] = array(
5752
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5753
				'readonly'      => true,
5754
				'value'         => $user_data['site_count'],
5755
			);
5756
		}
5757
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5758
		$args = stripslashes_deep( $args );
5759
		return $wp_xmlrpc_server->wp_getOptions( $args );
5760
	}
5761
5762
	function xmlrpc_options( $options ) {
5763
		$jetpack_client_id = false;
5764
		if ( self::is_active() ) {
5765
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5766
		}
5767
		$options['jetpack_version'] = array(
5768
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5769
				'readonly'      => true,
5770
				'value'         => JETPACK__VERSION,
5771
		);
5772
5773
		$options['jetpack_client_id'] = array(
5774
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5775
				'readonly'      => true,
5776
				'value'         => $jetpack_client_id,
5777
		);
5778
		return $options;
5779
	}
5780
5781
	public static function clean_nonces( $all = false ) {
5782
		global $wpdb;
5783
5784
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5785
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5786
5787
		if ( true !== $all ) {
5788
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5789
			$sql_args[] = time() - 3600;
5790
		}
5791
5792
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5793
5794
		$sql = $wpdb->prepare( $sql, $sql_args );
5795
5796
		for ( $i = 0; $i < 1000; $i++ ) {
5797
			if ( ! $wpdb->query( $sql ) ) {
5798
				break;
5799
			}
5800
		}
5801
	}
5802
5803
	/**
5804
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5805
	 * SET: state( $key, $value );
5806
	 * GET: $value = state( $key );
5807
	 *
5808
	 * @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...
5809
	 * @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...
5810
	 * @param bool $restate private
5811
	 */
5812
	public static function state( $key = null, $value = null, $restate = false ) {
5813
		static $state = array();
5814
		static $path, $domain;
5815
		if ( ! isset( $path ) ) {
5816
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5817
			$admin_url = Jetpack::admin_url();
5818
			$bits      = parse_url( $admin_url );
5819
5820
			if ( is_array( $bits ) ) {
5821
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5822
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5823
			} else {
5824
				$path = $domain = null;
5825
			}
5826
		}
5827
5828
		// Extract state from cookies and delete cookies
5829
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5830
			$yum = $_COOKIE[ 'jetpackState' ];
5831
			unset( $_COOKIE[ 'jetpackState' ] );
5832
			foreach ( $yum as $k => $v ) {
5833
				if ( strlen( $v ) )
5834
					$state[ $k ] = $v;
5835
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5836
			}
5837
		}
5838
5839
		if ( $restate ) {
5840
			foreach ( $state as $k => $v ) {
5841
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5842
			}
5843
			return;
5844
		}
5845
5846
		// Get a state variable
5847
		if ( isset( $key ) && ! isset( $value ) ) {
5848
			if ( array_key_exists( $key, $state ) )
5849
				return $state[ $key ];
5850
			return null;
5851
		}
5852
5853
		// Set a state variable
5854
		if ( isset ( $key ) && isset( $value ) ) {
5855
			if( is_array( $value ) && isset( $value[0] ) ) {
5856
				$value = $value[0];
5857
			}
5858
			$state[ $key ] = $value;
5859
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5860
		}
5861
	}
5862
5863
	public static function restate() {
5864
		Jetpack::state( null, null, true );
5865
	}
5866
5867
	public static function check_privacy( $file ) {
5868
		static $is_site_publicly_accessible = null;
5869
5870
		if ( is_null( $is_site_publicly_accessible ) ) {
5871
			$is_site_publicly_accessible = false;
5872
5873
			Jetpack::load_xml_rpc_client();
5874
			$rpc = new Jetpack_IXR_Client();
5875
5876
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5877
			if ( $success ) {
5878
				$response = $rpc->getResponse();
5879
				if ( $response ) {
5880
					$is_site_publicly_accessible = true;
5881
				}
5882
			}
5883
5884
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5885
		}
5886
5887
		if ( $is_site_publicly_accessible ) {
5888
			return;
5889
		}
5890
5891
		$module_slug = self::get_module_slug( $file );
5892
5893
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5894
		if ( ! $privacy_checks ) {
5895
			$privacy_checks = $module_slug;
5896
		} else {
5897
			$privacy_checks .= ",$module_slug";
5898
		}
5899
5900
		Jetpack::state( 'privacy_checks', $privacy_checks );
5901
	}
5902
5903
	/**
5904
	 * Helper method for multicall XMLRPC.
5905
	 */
5906
	public static function xmlrpc_async_call() {
5907
		global $blog_id;
5908
		static $clients = array();
5909
5910
		$client_blog_id = is_multisite() ? $blog_id : 0;
5911
5912
		if ( ! isset( $clients[$client_blog_id] ) ) {
5913
			Jetpack::load_xml_rpc_client();
5914
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5915
			if ( function_exists( 'ignore_user_abort' ) ) {
5916
				ignore_user_abort( true );
5917
			}
5918
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5919
		}
5920
5921
		$args = func_get_args();
5922
5923
		if ( ! empty( $args[0] ) ) {
5924
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5925
		} elseif ( is_multisite() ) {
5926
			foreach ( $clients as $client_blog_id => $client ) {
5927
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5928
					continue;
5929
				}
5930
5931
				$switch_success = switch_to_blog( $client_blog_id, true );
5932
				if ( ! $switch_success ) {
5933
					continue;
5934
				}
5935
5936
				flush();
5937
				$client->query();
5938
5939
				restore_current_blog();
5940
			}
5941
		} else {
5942
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5943
				flush();
5944
				$clients[0]->query();
5945
			}
5946
		}
5947
	}
5948
5949
	public static function staticize_subdomain( $url ) {
5950
5951
		// Extract hostname from URL
5952
		$host = parse_url( $url, PHP_URL_HOST );
5953
5954
		// Explode hostname on '.'
5955
		$exploded_host = explode( '.', $host );
5956
5957
		// Retrieve the name and TLD
5958
		if ( count( $exploded_host ) > 1 ) {
5959
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5960
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5961
			// Rebuild domain excluding subdomains
5962
			$domain = $name . '.' . $tld;
5963
		} else {
5964
			$domain = $host;
5965
		}
5966
		// Array of Automattic domains
5967
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5968
5969
		// Return $url if not an Automattic domain
5970
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5971
			return $url;
5972
		}
5973
5974
		if ( is_ssl() ) {
5975
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5976
		}
5977
5978
		srand( crc32( basename( $url ) ) );
5979
		$static_counter = rand( 0, 2 );
5980
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5981
5982
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5983
	}
5984
5985
/* JSON API Authorization */
5986
5987
	/**
5988
	 * Handles the login action for Authorizing the JSON API
5989
	 */
5990
	function login_form_json_api_authorization() {
5991
		$this->verify_json_api_authorization_request();
5992
5993
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5994
5995
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5996
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5997
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5998
	}
5999
6000
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6001
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6002
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6003
			return $url;
6004
		}
6005
6006
		$parsed_url = parse_url( $url );
6007
		$url = strtok( $url, '?' );
6008
		$url = "$url?{$_SERVER['QUERY_STRING']}";
6009
		if ( ! empty( $parsed_url['query'] ) )
6010
			$url .= "&{$parsed_url['query']}";
6011
6012
		return $url;
6013
	}
6014
6015
	// Make sure the POSTed request is handled by the same action
6016
	function preserve_action_in_login_form_for_json_api_authorization() {
6017
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6018
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6019
	}
6020
6021
	// If someone logs in to approve API access, store the Access Code in usermeta
6022
	function store_json_api_authorization_token( $user_login, $user ) {
6023
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6024
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6025
		$token = wp_generate_password( 32, false );
6026
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6027
	}
6028
6029
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6030
	function allow_wpcom_public_api_domain( $domains ) {
6031
		$domains[] = 'public-api.wordpress.com';
6032
		return $domains;
6033
	}
6034
6035
	// Add all wordpress.com environments to the safe redirect whitelist
6036
	function allow_wpcom_environments( $domains ) {
6037
		$domains[] = 'wordpress.com';
6038
		$domains[] = 'wpcalypso.wordpress.com';
6039
		$domains[] = 'horizon.wordpress.com';
6040
		$domains[] = 'calypso.localhost';
6041
		return $domains;
6042
	}
6043
6044
	// Add the Access Code details to the public-api.wordpress.com redirect
6045
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6046
		return add_query_arg(
6047
			urlencode_deep(
6048
				array(
6049
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6050
					'jetpack-user-id' => (int) $user->ID,
6051
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6052
				)
6053
			),
6054
			$redirect_to
6055
		);
6056
	}
6057
6058
6059
	/**
6060
	 * Verifies the request by checking the signature
6061
	 *
6062
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6063
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6064
	 *
6065
	 * @param null|array $environment
6066
	 */
6067
	function verify_json_api_authorization_request( $environment = null ) {
6068
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6069
6070
		$environment = is_null( $environment )
6071
			? $_REQUEST
6072
			: $environment;
6073
6074
		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...
6075
		$token = Jetpack_Data::get_access_token( $envUserId );
6076
		if ( ! $token || empty( $token->secret ) ) {
6077
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6078
		}
6079
6080
		$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' );
6081
6082
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6083
6084
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6085
			$signature = $jetpack_signature->sign_request(
6086
				$environment['token'],
6087
				$environment['timestamp'],
6088
				$environment['nonce'],
6089
				'',
6090
				'GET',
6091
				$environment['jetpack_json_api_original_query'],
6092
				null,
6093
				true
6094
			);
6095
		} else {
6096
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6097
		}
6098
6099
		if ( ! $signature ) {
6100
			wp_die( $die_error );
6101
		} else if ( is_wp_error( $signature ) ) {
6102
			wp_die( $die_error );
6103
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
6104
			if ( is_ssl() ) {
6105
				// 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
6106
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6107
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
6108
					wp_die( $die_error );
6109
				}
6110
			} else {
6111
				wp_die( $die_error );
6112
			}
6113
		}
6114
6115
		$timestamp = (int) $environment['timestamp'];
6116
		$nonce     = stripslashes( (string) $environment['nonce'] );
6117
6118
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6119
			// De-nonce the nonce, at least for 5 minutes.
6120
			// 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)
6121
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6122
			if ( $old_nonce_time < time() - 300 ) {
6123
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6124
			}
6125
		}
6126
6127
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6128
		$data_filters = array(
6129
			'state'        => 'opaque',
6130
			'client_id'    => 'int',
6131
			'client_title' => 'string',
6132
			'client_image' => 'url',
6133
		);
6134
6135
		foreach ( $data_filters as $key => $sanitation ) {
6136
			if ( ! isset( $data->$key ) ) {
6137
				wp_die( $die_error );
6138
			}
6139
6140
			switch ( $sanitation ) {
6141
			case 'int' :
6142
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6143
				break;
6144
			case 'opaque' :
6145
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6146
				break;
6147
			case 'string' :
6148
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6149
				break;
6150
			case 'url' :
6151
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6152
				break;
6153
			}
6154
		}
6155
6156
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6157
			wp_die( $die_error );
6158
		}
6159
	}
6160
6161
	function login_message_json_api_authorization( $message ) {
6162
		return '<p class="message">' . sprintf(
6163
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6164
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6165
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6166
	}
6167
6168
	/**
6169
	 * Get $content_width, but with a <s>twist</s> filter.
6170
	 */
6171
	public static function get_content_width() {
6172
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6173
		/**
6174
		 * Filter the Content Width value.
6175
		 *
6176
		 * @since 2.2.3
6177
		 *
6178
		 * @param string $content_width Content Width value.
6179
		 */
6180
		return apply_filters( 'jetpack_content_width', $content_width );
6181
	}
6182
6183
	/**
6184
	 * Pings the WordPress.com Mirror Site for the specified options.
6185
	 *
6186
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6187
	 *
6188
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6189
	 */
6190
	public function get_cloud_site_options( $option_names ) {
6191
		$option_names = array_filter( (array) $option_names, 'is_string' );
6192
6193
		Jetpack::load_xml_rpc_client();
6194
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6195
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6196
		if ( $xml->isError() ) {
6197
			return array(
6198
				'error_code' => $xml->getErrorCode(),
6199
				'error_msg'  => $xml->getErrorMessage(),
6200
			);
6201
		}
6202
		$cloud_site_options = $xml->getResponse();
6203
6204
		return $cloud_site_options;
6205
	}
6206
6207
	/**
6208
	 * Checks if the site is currently in an identity crisis.
6209
	 *
6210
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6211
	 */
6212
	public static function check_identity_crisis() {
6213
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6214
			return false;
6215
		}
6216
6217
		return Jetpack_Options::get_option( 'sync_error_idc' );
6218
	}
6219
6220
	/**
6221
	 * Checks whether the home and siteurl specifically are whitelisted
6222
	 * Written so that we don't have re-check $key and $value params every time
6223
	 * we want to check if this site is whitelisted, for example in footer.php
6224
	 *
6225
	 * @since  3.8.0
6226
	 * @return bool True = already whitelisted False = not whitelisted
6227
	 */
6228
	public static function is_staging_site() {
6229
		$is_staging = false;
6230
6231
		$known_staging = array(
6232
			'urls' => array(
6233
				'#\.staging\.wpengine\.com$#i', // WP Engine
6234
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6235
				),
6236
			'constants' => array(
6237
				'IS_WPE_SNAPSHOT',      // WP Engine
6238
				'KINSTA_DEV_ENV',       // Kinsta.com
6239
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6240
				'JETPACK_STAGING_MODE', // Generic
6241
				)
6242
			);
6243
		/**
6244
		 * Filters the flags of known staging sites.
6245
		 *
6246
		 * @since 3.9.0
6247
		 *
6248
		 * @param array $known_staging {
6249
		 *     An array of arrays that each are used to check if the current site is staging.
6250
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6251
		 *     @type array $constants PHP constants of known staging/developement environments.
6252
		 *  }
6253
		 */
6254
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6255
6256
		if ( isset( $known_staging['urls'] ) ) {
6257
			foreach ( $known_staging['urls'] as $url ){
6258
				if ( preg_match( $url, site_url() ) ) {
6259
					$is_staging = true;
6260
					break;
6261
				}
6262
			}
6263
		}
6264
6265
		if ( isset( $known_staging['constants'] ) ) {
6266
			foreach ( $known_staging['constants'] as $constant ) {
6267
				if ( defined( $constant ) && constant( $constant ) ) {
6268
					$is_staging = true;
6269
				}
6270
			}
6271
		}
6272
6273
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6274
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6275
			$is_staging = true;
6276
		}
6277
6278
		/**
6279
		 * Filters is_staging_site check.
6280
		 *
6281
		 * @since 3.9.0
6282
		 *
6283
		 * @param bool $is_staging If the current site is a staging site.
6284
		 */
6285
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6286
	}
6287
6288
	/**
6289
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6290
	 *
6291
	 * @since 4.4.0
6292
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6293
	 *
6294
	 * @return bool
6295
	 */
6296
	public static function validate_sync_error_idc_option() {
6297
		$is_valid = false;
6298
6299
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6300
		if ( false === $idc_allowed ) {
6301
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6302
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6303
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6304
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6305
				$transient_duration = HOUR_IN_SECONDS;
6306
			} else {
6307
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6308
				$idc_allowed = '1';
6309
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6310
			}
6311
6312
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6313
		}
6314
6315
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6316
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6317
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6318
			$local_options = self::get_sync_error_idc_option();
6319
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6320
				$is_valid = true;
6321
			}
6322
		}
6323
6324
		/**
6325
		 * Filters whether the sync_error_idc option is valid.
6326
		 *
6327
		 * @since 4.4.0
6328
		 *
6329
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6330
		 */
6331
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6332
6333
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6334
			// Since the option exists, and did not validate, delete it
6335
			Jetpack_Options::delete_option( 'sync_error_idc' );
6336
		}
6337
6338
		return $is_valid;
6339
	}
6340
6341
	/**
6342
	 * Normalizes a url by doing three things:
6343
	 *  - Strips protocol
6344
	 *  - Strips www
6345
	 *  - Adds a trailing slash
6346
	 *
6347
	 * @since 4.4.0
6348
	 * @param string $url
6349
	 * @return WP_Error|string
6350
	 */
6351
	public static function normalize_url_protocol_agnostic( $url ) {
6352
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6353
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6354
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6355
		}
6356
6357
		// Strip www and protocols
6358
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6359
		return $url;
6360
	}
6361
6362
	/**
6363
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6364
	 *
6365
	 * @since 4.4.0
6366
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6367
	 *
6368
	 * @param array $response
6369
	 * @return array Array of the local urls, wpcom urls, and error code
6370
	 */
6371
	public static function get_sync_error_idc_option( $response = array() ) {
6372
		// Since the local options will hit the database directly, store the values
6373
		// in a transient to allow for autoloading and caching on subsequent views.
6374
		$local_options = get_transient( 'jetpack_idc_local' );
6375
		if ( false === $local_options ) {
6376
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6377
			$local_options = array(
6378
				'home'    => Jetpack_Sync_Functions::home_url(),
6379
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6380
			);
6381
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6382
		}
6383
6384
		$options = array_merge( $local_options, $response );
6385
6386
		$returned_values = array();
6387
		foreach( $options as $key => $option ) {
6388
			if ( 'error_code' === $key ) {
6389
				$returned_values[ $key ] = $option;
6390
				continue;
6391
			}
6392
6393
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6394
				continue;
6395
			}
6396
6397
			$returned_values[ $key ] = $normalized_url;
6398
		}
6399
6400
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6401
6402
		return $returned_values;
6403
	}
6404
6405
	/**
6406
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6407
	 * If set to true, the site will be put into staging mode.
6408
	 *
6409
	 * @since 4.3.2
6410
	 * @return bool
6411
	 */
6412
	public static function sync_idc_optin() {
6413
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6414
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6415
		} else {
6416
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6417
		}
6418
6419
		/**
6420
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6421
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6422
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6423
		 *
6424
		 * @since 4.3.2
6425
		 *
6426
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6427
		 */
6428
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6429
	}
6430
6431
	/**
6432
	 * Maybe Use a .min.css stylesheet, maybe not.
6433
	 *
6434
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6435
	 */
6436
	public static function maybe_min_asset( $url, $path, $plugin ) {
6437
		// Short out on things trying to find actual paths.
6438
		if ( ! $path || empty( $plugin ) ) {
6439
			return $url;
6440
		}
6441
6442
		$path = ltrim( $path, '/' );
6443
6444
		// Strip out the abspath.
6445
		$base = dirname( plugin_basename( $plugin ) );
6446
6447
		// Short out on non-Jetpack assets.
6448
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6449
			return $url;
6450
		}
6451
6452
		// File name parsing.
6453
		$file              = "{$base}/{$path}";
6454
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6455
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6456
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6457
		$extension         = array_shift( $file_name_parts_r );
6458
6459
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6460
			// Already pointing at the minified version.
6461
			if ( 'min' === $file_name_parts_r[0] ) {
6462
				return $url;
6463
			}
6464
6465
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6466
			if ( file_exists( $min_full_path ) ) {
6467
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6468
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6469
				if ( 'css' === $extension ) {
6470
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6471
					self::$min_assets[ $key ] = $path;
6472
				}
6473
			}
6474
		}
6475
6476
		return $url;
6477
	}
6478
6479
	/**
6480
	 * If the asset is minified, let's flag .min as the suffix.
6481
	 *
6482
	 * Attached to `style_loader_src` filter.
6483
	 *
6484
	 * @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...
6485
	 * @param string $handle The registered handle of the script in question.
6486
	 * @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...
6487
	 */
6488
	public static function set_suffix_on_min( $src, $handle ) {
6489
		if ( false === strpos( $src, '.min.css' ) ) {
6490
			return $src;
6491
		}
6492
6493
		if ( ! empty( self::$min_assets ) ) {
6494
			foreach ( self::$min_assets as $file => $path ) {
6495
				if ( false !== strpos( $src, $file ) ) {
6496
					wp_style_add_data( $handle, 'suffix', '.min' );
6497
					return $src;
6498
				}
6499
			}
6500
		}
6501
6502
		return $src;
6503
	}
6504
6505
	/**
6506
	 * Maybe inlines a stylesheet.
6507
	 *
6508
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6509
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6510
	 *
6511
	 * Attached to `style_loader_tag` filter.
6512
	 *
6513
	 * @param string $tag The tag that would link to the external asset.
6514
	 * @param string $handle The registered handle of the script in question.
6515
	 *
6516
	 * @return string
6517
	 */
6518
	public static function maybe_inline_style( $tag, $handle ) {
6519
		global $wp_styles;
6520
		$item = $wp_styles->registered[ $handle ];
6521
6522
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6523
			return $tag;
6524
		}
6525
6526
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6527
			$href = $matches[1];
6528
			// Strip off query string
6529
			if ( $pos = strpos( $href, '?' ) ) {
6530
				$href = substr( $href, 0, $pos );
6531
			}
6532
			// Strip off fragment
6533
			if ( $pos = strpos( $href, '#' ) ) {
6534
				$href = substr( $href, 0, $pos );
6535
			}
6536
		} else {
6537
			return $tag;
6538
		}
6539
6540
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6541
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6542
			return $tag;
6543
		}
6544
6545
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6546
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6547
			// And this isn't the pass that actually deals with the RTL version...
6548
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6549
				// Short out, as the RTL version will deal with it in a moment.
6550
				return $tag;
6551
			}
6552
		}
6553
6554
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6555
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6556
		if ( $css ) {
6557
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6558
			if ( empty( $item->extra['after'] ) ) {
6559
				wp_add_inline_style( $handle, $css );
6560
			} else {
6561
				array_unshift( $item->extra['after'], $css );
6562
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6563
			}
6564
		}
6565
6566
		return $tag;
6567
	}
6568
6569
	/**
6570
	 * Loads a view file from the views
6571
	 *
6572
	 * Data passed in with the $data parameter will be available in the
6573
	 * template file as $data['value']
6574
	 *
6575
	 * @param string $template - Template file to load
6576
	 * @param array $data - Any data to pass along to the template
6577
	 * @return boolean - If template file was found
6578
	 **/
6579
	public function load_view( $template, $data = array() ) {
6580
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6581
6582
		if( file_exists( $views_dir . $template ) ) {
6583
			require_once( $views_dir . $template );
6584
			return true;
6585
		}
6586
6587
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6588
		return false;
6589
	}
6590
6591
	/**
6592
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6593
	 */
6594
	public function deprecated_hooks() {
6595
		global $wp_filter;
6596
6597
		/*
6598
		 * Format:
6599
		 * deprecated_filter_name => replacement_name
6600
		 *
6601
		 * If there is no replacement, use null for replacement_name
6602
		 */
6603
		$deprecated_list = array(
6604
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6605
			'wpl_sharing_2014_1'                                     => null,
6606
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6607
			'jetpack_identity_crisis_options_to_check'               => null,
6608
			'update_option_jetpack_single_user_site'                 => null,
6609
			'audio_player_default_colors'                            => null,
6610
			'add_option_jetpack_featured_images_enabled'             => null,
6611
			'add_option_jetpack_update_details'                      => null,
6612
			'add_option_jetpack_updates'                             => null,
6613
			'add_option_jetpack_network_name'                        => null,
6614
			'add_option_jetpack_network_allow_new_registrations'     => null,
6615
			'add_option_jetpack_network_add_new_users'               => null,
6616
			'add_option_jetpack_network_site_upload_space'           => null,
6617
			'add_option_jetpack_network_upload_file_types'           => null,
6618
			'add_option_jetpack_network_enable_administration_menus' => null,
6619
			'add_option_jetpack_is_multi_site'                       => null,
6620
			'add_option_jetpack_is_main_network'                     => null,
6621
			'add_option_jetpack_main_network_site'                   => null,
6622
			'jetpack_sync_all_registered_options'                    => null,
6623
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6624
			'jetpack_is_post_mailable'                               => null,
6625
			'jetpack_seo_site_host'                                  => null,
6626
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6627
			'jetpack_holiday_snow_option_name'                       => null,
6628
			'jetpack_holiday_chance_of_snow'                         => null,
6629
			'jetpack_holiday_snow_js_url'                            => null,
6630
			'jetpack_is_holiday_snow_season'                         => null,
6631
			'jetpack_holiday_snow_option_updated'                    => null,
6632
			'jetpack_holiday_snowing'                                => null,
6633
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6634
			'jetpack_cache_plans'                                    => null,
6635
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6636
		);
6637
6638
		// This is a silly loop depth. Better way?
6639
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6640
			if ( has_action( $hook ) ) {
6641
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6642
					foreach( $values AS $hooked ) {
6643
						if ( is_callable( $hooked['function'] ) ) {
6644
							$function_name = 'an anonymous function';
6645
						} else {
6646
							$function_name = $hooked['function'];
6647
						}
6648
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6649
					}
6650
				}
6651
			}
6652
		}
6653
	}
6654
6655
	/**
6656
	 * Converts any url in a stylesheet, to the correct absolute url.
6657
	 *
6658
	 * Considerations:
6659
	 *  - Normal, relative URLs     `feh.png`
6660
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6661
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6662
	 *  - Absolute URLs             `http://domain.com/feh.png`
6663
	 *  - Domain root relative URLs `/feh.png`
6664
	 *
6665
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6666
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6667
	 *
6668
	 * @return mixed|string
6669
	 */
6670
	public static function absolutize_css_urls( $css, $css_file_url ) {
6671
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6672
		$css_dir = dirname( $css_file_url );
6673
		$p       = parse_url( $css_dir );
6674
		$domain  = sprintf(
6675
					'%1$s//%2$s%3$s%4$s',
6676
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6677
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6678
					$p['host'],
6679
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6680
				);
6681
6682
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6683
			$find = $replace = array();
6684
			foreach ( $matches as $match ) {
6685
				$url = trim( $match['path'], "'\" \t" );
6686
6687
				// If this is a data url, we don't want to mess with it.
6688
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6689
					continue;
6690
				}
6691
6692
				// If this is an absolute or protocol-agnostic url,
6693
				// we don't want to mess with it.
6694
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6695
					continue;
6696
				}
6697
6698
				switch ( substr( $url, 0, 1 ) ) {
6699
					case '/':
6700
						$absolute = $domain . $url;
6701
						break;
6702
					default:
6703
						$absolute = $css_dir . '/' . $url;
6704
				}
6705
6706
				$find[]    = $match[0];
6707
				$replace[] = sprintf( 'url("%s")', $absolute );
6708
			}
6709
			$css = str_replace( $find, $replace, $css );
6710
		}
6711
6712
		return $css;
6713
	}
6714
6715
	/**
6716
	 * This methods removes all of the registered css files on the front end
6717
	 * from Jetpack in favor of using a single file. In effect "imploding"
6718
	 * all the files into one file.
6719
	 *
6720
	 * Pros:
6721
	 * - Uses only ONE css asset connection instead of 15
6722
	 * - Saves a minimum of 56k
6723
	 * - Reduces server load
6724
	 * - Reduces time to first painted byte
6725
	 *
6726
	 * Cons:
6727
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6728
	 *		should not cause any issues with themes.
6729
	 * - Plugins/themes dequeuing styles no longer do anything. See
6730
	 *		jetpack_implode_frontend_css filter for a workaround
6731
	 *
6732
	 * For some situations developers may wish to disable css imploding and
6733
	 * instead operate in legacy mode where each file loads seperately and
6734
	 * can be edited individually or dequeued. This can be accomplished with
6735
	 * the following line:
6736
	 *
6737
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6738
	 *
6739
	 * @since 3.2
6740
	 **/
6741
	public function implode_frontend_css( $travis_test = false ) {
6742
		$do_implode = true;
6743
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6744
			$do_implode = false;
6745
		}
6746
6747
		/**
6748
		 * Allow CSS to be concatenated into a single jetpack.css file.
6749
		 *
6750
		 * @since 3.2.0
6751
		 *
6752
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6753
		 */
6754
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6755
6756
		// Do not use the imploded file when default behaviour was altered through the filter
6757
		if ( ! $do_implode ) {
6758
			return;
6759
		}
6760
6761
		// We do not want to use the imploded file in dev mode, or if not connected
6762
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6763
			if ( ! $travis_test ) {
6764
				return;
6765
			}
6766
		}
6767
6768
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6769
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6770
			return;
6771
		}
6772
6773
		/*
6774
		 * Now we assume Jetpack is connected and able to serve the single
6775
		 * file.
6776
		 *
6777
		 * In the future there will be a check here to serve the file locally
6778
		 * or potentially from the Jetpack CDN
6779
		 *
6780
		 * For now:
6781
		 * - Enqueue a single imploded css file
6782
		 * - Zero out the style_loader_tag for the bundled ones
6783
		 * - Be happy, drink scotch
6784
		 */
6785
6786
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6787
6788
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6789
6790
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6791
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6792
	}
6793
6794
	function concat_remove_style_loader_tag( $tag, $handle ) {
6795
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6796
			$tag = '';
6797
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6798
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6799
			}
6800
		}
6801
6802
		return $tag;
6803
	}
6804
6805
	/*
6806
	 * Check the heartbeat data
6807
	 *
6808
	 * Organizes the heartbeat data by severity.  For example, if the site
6809
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6810
	 *
6811
	 * Data will be added to "caution" array, if it either:
6812
	 *  - Out of date Jetpack version
6813
	 *  - Out of date WP version
6814
	 *  - Out of date PHP version
6815
	 *
6816
	 * $return array $filtered_data
6817
	 */
6818
	public static function jetpack_check_heartbeat_data() {
6819
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6820
6821
		$good    = array();
6822
		$caution = array();
6823
		$bad     = array();
6824
6825
		foreach ( $raw_data as $stat => $value ) {
6826
6827
			// Check jetpack version
6828
			if ( 'version' == $stat ) {
6829
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6830
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6831
					continue;
6832
				}
6833
			}
6834
6835
			// Check WP version
6836
			if ( 'wp-version' == $stat ) {
6837
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6838
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6839
					continue;
6840
				}
6841
			}
6842
6843
			// Check PHP version
6844
			if ( 'php-version' == $stat ) {
6845
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6846
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6847
					continue;
6848
				}
6849
			}
6850
6851
			// Check ID crisis
6852
			if ( 'identitycrisis' == $stat ) {
6853
				if ( 'yes' == $value ) {
6854
					$bad[ $stat ] = $value;
6855
					continue;
6856
				}
6857
			}
6858
6859
			// The rest are good :)
6860
			$good[ $stat ] = $value;
6861
		}
6862
6863
		$filtered_data = array(
6864
			'good'    => $good,
6865
			'caution' => $caution,
6866
			'bad'     => $bad
6867
		);
6868
6869
		return $filtered_data;
6870
	}
6871
6872
6873
	/*
6874
	 * This method is used to organize all options that can be reset
6875
	 * without disconnecting Jetpack.
6876
	 *
6877
	 * It is used in class.jetpack-cli.php to reset options
6878
	 *
6879
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6880
	 *
6881
	 * @return array of options to delete.
6882
	 */
6883
	public static function get_jetpack_options_for_reset() {
6884
		return Jetpack_Options::get_options_for_reset();
6885
	}
6886
6887
	/**
6888
	 * Check if an option of a Jetpack module has been updated.
6889
	 *
6890
	 * If any module option has been updated before Jump Start has been dismissed,
6891
	 * update the 'jumpstart' option so we can hide Jump Start.
6892
	 *
6893
	 * @param string $option_name
6894
	 *
6895
	 * @return bool
6896
	 */
6897
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6898
		// Bail if Jump Start has already been dismissed
6899
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6900
			return false;
6901
		}
6902
6903
		$jetpack = Jetpack::init();
6904
6905
		// Manual build of module options
6906
		$option_names = self::get_jetpack_options_for_reset();
6907
6908
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6909
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6910
6911
			//Jump start is being dismissed send data to MC Stats
6912
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6913
6914
			$jetpack->do_stats( 'server_side' );
6915
		}
6916
6917
	}
6918
6919
	/*
6920
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6921
	 * so we can bring them directly to their site in calypso.
6922
	 *
6923
	 * @param string | url
6924
	 * @return string | url without the guff
6925
	 */
6926
	public static function build_raw_urls( $url ) {
6927
		$strip_http = '/.*?:\/\//i';
6928
		$url = preg_replace( $strip_http, '', $url  );
6929
		$url = str_replace( '/', '::', $url );
6930
		return $url;
6931
	}
6932
6933
	/**
6934
	 * Stores and prints out domains to prefetch for page speed optimization.
6935
	 *
6936
	 * @param mixed $new_urls
6937
	 */
6938
	public static function dns_prefetch( $new_urls = null ) {
6939
		static $prefetch_urls = array();
6940
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6941
			echo "\r\n";
6942
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6943
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6944
			}
6945
		} elseif ( ! empty( $new_urls ) ) {
6946
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6947
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6948
			}
6949
			foreach ( (array) $new_urls as $this_new_url ) {
6950
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6951
			}
6952
			$prefetch_urls = array_unique( $prefetch_urls );
6953
		}
6954
	}
6955
6956
	public function wp_dashboard_setup() {
6957
		if ( self::is_active() ) {
6958
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6959
		}
6960
6961
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6962
			wp_add_dashboard_widget(
6963
				'jetpack_summary_widget',
6964
				esc_html__( 'Site Stats', 'jetpack' ),
6965
				array( __CLASS__, 'dashboard_widget' )
6966
			);
6967
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6968
6969
			// If we're inactive and not in development mode, sort our box to the top.
6970
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6971
				global $wp_meta_boxes;
6972
6973
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6974
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6975
6976
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6977
			}
6978
		}
6979
	}
6980
6981
	/**
6982
	 * @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...
6983
	 * @return mixed
6984
	 */
6985
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6986
		if ( ! is_array( $sorted ) ) {
6987
			return $sorted;
6988
		}
6989
6990
		foreach ( $sorted as $box_context => $ids ) {
6991
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6992
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6993
				continue;
6994
			}
6995
6996
			$ids_array = explode( ',', $ids );
6997
			$key = array_search( 'dashboard_stats', $ids_array );
6998
6999
			if ( false !== $key ) {
7000
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7001
				$ids_array[ $key ] = 'jetpack_summary_widget';
7002
				$sorted[ $box_context ] = implode( ',', $ids_array );
7003
				// We've found it, stop searching, and just return.
7004
				break;
7005
			}
7006
		}
7007
7008
		return $sorted;
7009
	}
7010
7011
	public static function dashboard_widget() {
7012
		/**
7013
		 * Fires when the dashboard is loaded.
7014
		 *
7015
		 * @since 3.4.0
7016
		 */
7017
		do_action( 'jetpack_dashboard_widget' );
7018
	}
7019
7020
	public static function dashboard_widget_footer() {
7021
		?>
7022
		<footer>
7023
7024
		<div class="protect">
7025
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
7026
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
7027
				<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>
7028
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
7029
				<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' ); ?>">
7030
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
7031
				</a>
7032
			<?php else : ?>
7033
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
7034
			<?php endif; ?>
7035
		</div>
7036
7037
		<div class="akismet">
7038
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7039
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
7040
				<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>
7041
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7042
				<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">
7043
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
7044
				</a>
7045
			<?php else : ?>
7046
				<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>
7047
			<?php endif; ?>
7048
		</div>
7049
7050
		</footer>
7051
		<?php
7052
	}
7053
7054
	/**
7055
	 * Return string containing the Jetpack logo.
7056
	 *
7057
	 * @since 3.9.0
7058
	 *
7059
	 * @return string
7060
	 */
7061
	public static function get_jp_emblem() {
7062
		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>';
7063
	}
7064
7065
	/*
7066
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7067
	 */
7068
	function jetpack_icon_user_connected( $columns ) {
7069
		$columns['user_jetpack'] = '';
7070
		return $columns;
7071
	}
7072
7073
	/*
7074
	 * Show Jetpack icon if the user is linked.
7075
	 */
7076
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7077
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7078
			$emblem_html = sprintf(
7079
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7080
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7081
				Jetpack::get_jp_emblem()
7082
			);
7083
			return $emblem_html;
7084
		}
7085
7086
		return $val;
7087
	}
7088
7089
	/*
7090
	 * Style the Jetpack user column
7091
	 */
7092
	function jetpack_user_col_style() {
7093
		global $current_screen;
7094
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7095
			<style>
7096
				.fixed .column-user_jetpack {
7097
					width: 21px;
7098
				}
7099
				.jp-emblem-user-admin svg {
7100
					width: 20px;
7101
					height: 20px;
7102
				}
7103
				.jp-emblem-user-admin path {
7104
					fill: #00BE28;
7105
				}
7106
			</style>
7107
		<?php }
7108
	}
7109
7110
	/**
7111
	 * Checks if Akismet is active and working.
7112
	 *
7113
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7114
	 * that implied usage of methods present since more recent version.
7115
	 * See https://github.com/Automattic/jetpack/pull/9585
7116
	 *
7117
	 * @since  5.1.0
7118
	 *
7119
	 * @return bool True = Akismet available. False = Aksimet not available.
7120
	 */
7121
	public static function is_akismet_active() {
7122
		if ( method_exists( 'Akismet' , 'http_post' ) ) {
7123
			$akismet_key = Akismet::get_api_key();
7124
			if ( ! $akismet_key ) {
7125
				return false;
7126
			}
7127
			$cached_key_verification = get_transient( 'jetpack_akismet_key_is_valid' );
7128
7129
			// We cache the result of the Akismet key verification for ten minutes.
7130
			if ( in_array( $cached_key_verification, array( 'valid', 'invalid' ) ) ) {
7131
				$akismet_key_state = $cached_key_verification;
7132
			} else {
7133
				$akismet_key_state = Akismet::verify_key( $akismet_key );
7134
				if ( 'failed' === $akismet_key_state ) {
7135
					return false;
7136
				}
7137
				set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7138
			}
7139
7140
			return ( 'valid' === $akismet_key_state );
7141
		}
7142
		return false;
7143
	}
7144
7145
	/**
7146
	 * Checks if one or more function names is in debug_backtrace
7147
	 *
7148
	 * @param $names Mixed string name of function or array of string names of functions
7149
	 *
7150
	 * @return bool
7151
	 */
7152
	public static function is_function_in_backtrace( $names ) {
7153
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility
7154
		if ( ! is_array( $names ) ) {
7155
			$names = array( $names );
7156
		}
7157
		$names_as_keys = array_flip( $names );
7158
7159
		//Do check in constant O(1) time for PHP5.5+
7160
		if ( function_exists( 'array_column' ) ) {
7161
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility
7162
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7163
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7164
			return ! empty ( $intersection );
7165
		}
7166
7167
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7168
		foreach ( $backtrace as $call ) {
7169
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7170
				return true;
7171
			}
7172
		}
7173
		return false;
7174
	}
7175
7176
	/**
7177
	 * Given a minified path, and a non-minified path, will return
7178
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7179
	 *
7180
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7181
	 * root Jetpack directory.
7182
	 *
7183
	 * @since 5.6.0
7184
	 *
7185
	 * @param string $min_path
7186
	 * @param string $non_min_path
7187
	 * @return string The URL to the file
7188
	 */
7189
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7190
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7191
			? $non_min_path
7192
			: $min_path;
7193
7194
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7195
	}
7196
7197
	/**
7198
	 * Checks for whether Jetpack Rewind is enabled.
7199
	 * Will return true if the state of Rewind is anything except "unavailable".
7200
	 * @return bool|int|mixed
7201
	 */
7202
	public static function is_rewind_enabled() {
7203
		if ( ! Jetpack::is_active() ) {
7204
			return false;
7205
		}
7206
7207
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7208
		if ( false === $rewind_enabled ) {
7209
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7210
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7211
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7212
				&& ! empty( $rewind_data['state'] )
7213
				&& 'active' === $rewind_data['state'] )
7214
				? 1
7215
				: 0;
7216
7217
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7218
		}
7219
		return $rewind_enabled;
7220
	}
7221
7222
	/**
7223
	 * Checks whether or not TOS has been agreed upon.
7224
	 * Will return true if a user has clicked to register, or is already connected.
7225
	 */
7226
	public static function jetpack_tos_agreed() {
7227
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7228
	}
7229
7230
	/**
7231
	 * Handles activating default modules as well general cleanup for the new connection.
7232
	 *
7233
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7234
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7235
	 * @return void
7236
	 */
7237
	public static function handle_post_authorization_actions( $activate_sso = false, $redirect_on_activation_error = false ) {
7238
		$other_modules = $activate_sso
7239
			? array( 'sso' )
7240
			: array();
7241
7242 View Code Duplication
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7243
			Jetpack::delete_active_modules();
7244
7245
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, false );
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...
7246
		} else {
7247
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, false );
7248
		}
7249
7250
		// Since this is a fresh connection, be sure to clear out IDC options
7251
		Jetpack_IDC::clear_all_idc_options();
7252
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7253
7254
		// Start nonce cleaner
7255
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7256
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7257
7258
		Jetpack::state( 'message', 'authorized' );
7259
	}
7260
}
7261