Completed
Push — update/jpc-register-support-on... ( aa2311 )
by Marin
11:37
created

Jetpack::catch_errors()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 13
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 10
nc 2
nop 1
dl 0
loc 13
rs 9.4285
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
	);
62
63
	/**
64
	 * Contains all assets that have had their URL rewritten to minified versions.
65
	 *
66
	 * @var array
67
	 */
68
	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...
69
70
	public $plugins_to_deactivate = array(
71
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
72
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
73
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
74
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
75
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
76
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
77
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
78
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
79
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
80
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
81
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
82
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
83
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
84
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
85
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
86
	);
87
88
	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...
89
		'administrator' => 'manage_options',
90
		'editor'        => 'edit_others_posts',
91
		'author'        => 'publish_posts',
92
		'contributor'   => 'edit_posts',
93
		'subscriber'    => 'read',
94
	);
95
96
	/**
97
	 * Map of modules that have conflicts with plugins and should not be auto-activated
98
	 * if the plugins are active.  Used by filter_default_modules
99
	 *
100
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
101
	 * change `module-slug` and add this to your plugin:
102
	 *
103
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
104
	 * function my_jetpack_get_default_modules( $modules ) {
105
	 *     return array_diff( $modules, array( 'module-slug' ) );
106
	 * }
107
	 *
108
	 * @var array
109
	 */
110
	private $conflicting_plugins = array(
111
		'comments'          => array(
112
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
113
			'Disqus'                               => 'disqus-comment-system/disqus.php',
114
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
115
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
116
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
117
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
118
		),
119
		'comment-likes' => array(
120
			'Epoch'                                => 'epoch/plugincore.php',
121
		),
122
		'contact-form'      => array(
123
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
124
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
125
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
126
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
127
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
128
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
129
		),
130
		'minileven'         => array(
131
			'WPtouch'                              => 'wptouch/wptouch.php',
132
		),
133
		'latex'             => array(
134
			'LaTeX for WordPress'                  => 'latex/latex.php',
135
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
136
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
137
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
138
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
139
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
140
		),
141
		'protect'           => array(
142
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
143
			'Captcha'                              => 'captcha/captcha.php',
144
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
145
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
146
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
147
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
148
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
149
			'Security-protection'                  => 'security-protection/security-protection.php',
150
			'Login Security'                       => 'login-security/login-security.php',
151
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
152
			'Wordfence Security'                   => 'wordfence/wordfence.php',
153
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
154
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
155
		),
156
		'random-redirect'   => array(
157
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
158
		),
159
		'related-posts'     => array(
160
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
161
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
162
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
163
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
164
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
165
			'outbrain'                             => 'outbrain/outbrain.php',
166
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
167
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
168
		),
169
		'sharedaddy'        => array(
170
			'AddThis'                              => 'addthis/addthis_social_widget.php',
171
			'Add To Any'                           => 'add-to-any/add-to-any.php',
172
			'ShareThis'                            => 'share-this/sharethis.php',
173
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
174
		),
175
		'seo-tools' => array(
176
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
177
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
178
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
179
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
180
		),
181
		'verification-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
		),
187
		'widget-visibility' => array(
188
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
189
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
190
		),
191
		'sitemaps' => array(
192
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
193
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
194
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
195
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
196
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
197
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
198
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
199
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
200
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
201
			'Sitemap'                              => 'sitemap/sitemap.php',
202
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
203
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
204
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
205
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
206
		),
207
		'lazy-images' => array(
208
			'Lazy Load'              => 'lazy-load/lazy-load.php',
209
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
210
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
211
		),
212
	);
213
214
	/**
215
	 * Plugins for which we turn off our Facebook OG Tags implementation.
216
	 *
217
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
218
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
219
	 *
220
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
221
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
222
	 */
223
	private $open_graph_conflicting_plugins = array(
224
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
225
		                                                         // 2 Click Social Media Buttons
226
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
227
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
228
		'autodescription/autodescription.php',                   // The SEO Framework
229
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
230
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
231
		                                                         // Open Graph Meta Tags by Heateor
232
		'facebook/facebook.php',                                 // Facebook (official plugin)
233
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
234
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
235
		                                                         // Facebook Featured Image & OG Meta Tags
236
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
237
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
238
		                                                         // Facebook Open Graph Meta Tags for WordPress
239
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
240
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
241
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
242
		                                                         // Fedmich's Facebook Open Graph Meta
243
		'network-publisher/networkpub.php',                      // Network Publisher
244
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
245
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
246
		                                                         // NextScripts SNAP
247
		'og-tags/og-tags.php',                                   // OG Tags
248
		'opengraph/opengraph.php',                               // Open Graph
249
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
250
		                                                         // Open Graph Protocol Framework
251
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
252
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
253
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
254
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
255
		'sharepress/sharepress.php',                             // SharePress
256
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
257
		'social-discussions/social-discussions.php',             // Social Discussions
258
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
259
		'socialize/socialize.php',                               // Socialize
260
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
261
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
262
		                                                         // Tweet, Like, Google +1 and Share
263
		'wordbooker/wordbooker.php',                             // Wordbooker
264
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
265
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
266
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
267
		                                                         // WP Facebook Like Send & Open Graph Meta
268
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
269
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
270
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
271
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
272
	);
273
274
	/**
275
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
276
	 */
277
	private $twitter_cards_conflicting_plugins = array(
278
	//	'twitter/twitter.php',                       // The official one handles this on its own.
279
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
280
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
281
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
282
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
283
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
284
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
285
		'twitter-cards/twitter-cards.php',           // Twitter Cards
286
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
287
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
288
	);
289
290
	/**
291
	 * Message to display in admin_notice
292
	 * @var string
293
	 */
294
	public $message = '';
295
296
	/**
297
	 * Error to display in admin_notice
298
	 * @var string
299
	 */
300
	public $error = '';
301
302
	/**
303
	 * Modules that need more privacy description.
304
	 * @var string
305
	 */
306
	public $privacy_checks = '';
307
308
	/**
309
	 * Stats to record once the page loads
310
	 *
311
	 * @var array
312
	 */
313
	public $stats = array();
314
315
	/**
316
	 * Jetpack_Sync object
317
	 */
318
	public $sync;
319
320
	/**
321
	 * Verified data for JSON authorization request
322
	 */
323
	public $json_api_authorization_request = array();
324
325
	/**
326
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
327
	 */
328
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
329
330
	/**
331
	 * Holds the singleton instance of this class
332
	 * @since 2.3.3
333
	 * @var Jetpack
334
	 */
335
	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...
336
337
	/**
338
	 * Singleton
339
	 * @static
340
	 */
341
	public static function init() {
342
		if ( ! self::$instance ) {
343
			self::$instance = new Jetpack;
344
345
			self::$instance->plugin_upgrade();
346
		}
347
348
		return self::$instance;
349
	}
350
351
	/**
352
	 * Must never be called statically
353
	 */
354
	function plugin_upgrade() {
355
		if ( Jetpack::is_active() ) {
356
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
357
			if ( JETPACK__VERSION != $version ) {
358
				// Prevent multiple upgrades at once - only a single process should trigger
359
				// an upgrade to avoid stampedes
360
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
361
					return;
362
				}
363
364
				// Set a short lock to prevent multiple instances of the upgrade
365
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
366
367
				// check which active modules actually exist and remove others from active_modules list
368
				$unfiltered_modules = Jetpack::get_active_modules();
369
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
370
				if ( array_diff( $unfiltered_modules, $modules ) ) {
371
					Jetpack::update_active_modules( $modules );
372
				}
373
374
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
375
376
				// Upgrade to 4.3.0
377
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
378
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
379
				}
380
381
				// Make sure Markdown for posts gets turned back on
382
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
383
					update_option( 'wpcom_publish_posts_with_markdown', true );
384
				}
385
386
				if ( did_action( 'wp_loaded' ) ) {
387
					self::upgrade_on_load();
388
				} else {
389
					add_action(
390
						'wp_loaded',
391
						array( __CLASS__, 'upgrade_on_load' )
392
					);
393
				}
394
			}
395
		}
396
	}
397
398
	/**
399
	 * Runs upgrade routines that need to have modules loaded.
400
	 */
401
	static function upgrade_on_load() {
402
403
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
404
		// This can happen in case Jetpack has been just upgraded and is
405
		// being initialized late during the page load. In this case we wait
406
		// until the next proper admin page load with Jetpack active.
407
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
408
			delete_transient( self::$plugin_upgrade_lock_key );
409
410
			return;
411
		}
412
413
		Jetpack::maybe_set_version_option();
414
415
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
416
			Jetpack_Widget_Conditions::migrate_post_type_rules();
417
		}
418
419
		if (
420
			class_exists( 'Jetpack_Sitemap_Manager' )
421
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
422
		) {
423
			do_action( 'jetpack_sitemaps_purge_data' );
424
		}
425
426
		delete_transient( self::$plugin_upgrade_lock_key );
427
	}
428
429
	static function activate_manage( ) {
430
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
431
			self::activate_module( 'manage', false, false );
432
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
433
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
434
		}
435
	}
436
437
	static function update_active_modules( $modules ) {
438
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
439
440
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
441
442
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
443
			$new_active_modules = array_diff( $modules, $current_modules );
444
			foreach( $new_active_modules as $module ) {
445
				/**
446
				 * Fires when a specific module is activated.
447
				 *
448
				 * @since 1.9.0
449
				 *
450
				 * @param string $module Module slug.
451
				 * @param boolean $success whether the module was activated. @since 4.2
452
				 */
453
				do_action( 'jetpack_activate_module', $module, $success );
454
455
				/**
456
				 * Fires when a module is activated.
457
				 * The dynamic part of the filter, $module, is the module slug.
458
				 *
459
				 * @since 1.9.0
460
				 *
461
				 * @param string $module Module slug.
462
				 */
463
				do_action( "jetpack_activate_module_$module", $module );
464
			}
465
466
			$new_deactive_modules = array_diff( $current_modules, $modules );
467
			foreach( $new_deactive_modules as $module ) {
468
				/**
469
				 * Fired after a module has been deactivated.
470
				 *
471
				 * @since 4.2.0
472
				 *
473
				 * @param string $module Module slug.
474
				 * @param boolean $success whether the module was deactivated.
475
				 */
476
				do_action( 'jetpack_deactivate_module', $module, $success );
477
				/**
478
				 * Fires when a module is deactivated.
479
				 * The dynamic part of the filter, $module, is the module slug.
480
				 *
481
				 * @since 1.9.0
482
				 *
483
				 * @param string $module Module slug.
484
				 */
485
				do_action( "jetpack_deactivate_module_$module", $module );
486
			}
487
		}
488
489
		return $success;
490
	}
491
492
	static function delete_active_modules() {
493
		self::update_active_modules( array() );
494
	}
495
496
	/**
497
	 * Constructor.  Initializes WordPress hooks
498
	 */
499
	private function __construct() {
500
		/*
501
		 * Check for and alert any deprecated hooks
502
		 */
503
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
504
505
		/*
506
		 * Enable enhanced handling of previewing sites in Calypso
507
		 */
508
		if ( Jetpack::is_active() ) {
509
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
510
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
511
		}
512
513
		/*
514
		 * Load things that should only be in Network Admin.
515
		 *
516
		 * For now blow away everything else until a more full
517
		 * understanding of what is needed at the network level is
518
		 * available
519
		 */
520
		if( is_multisite() ) {
521
			Jetpack_Network::init();
522
		}
523
524
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
525
526
		// Unlink user before deleting the user from .com
527
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
528
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
529
530
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
531
			@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...
532
533
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
534
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
535
536
			$this->require_jetpack_authentication();
537
538
			if ( Jetpack::is_active() ) {
539
				// Hack to preserve $HTTP_RAW_POST_DATA
540
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
541
542
				$signed = $this->verify_xml_rpc_signature();
543
				if ( $signed && ! is_wp_error( $signed ) ) {
544
					// The actual API methods.
545
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
546
				} else {
547
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
548
					// active Jetpack connection, so that additional users can link their account.
549
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
550
				}
551
			} else {
552
				// The bootstrap API methods.
553
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
554
			}
555
556
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
557
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
558
		} elseif (
559
			is_admin() &&
560
			isset( $_POST['action'] ) && (
561
				'jetpack_upload_file' == $_POST['action'] ||
562
				'jetpack_update_file' == $_POST['action']
563
			)
564
		) {
565
			$this->require_jetpack_authentication();
566
			$this->add_remote_request_handlers();
567
		} else {
568
			if ( Jetpack::is_active() ) {
569
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
570
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
571
			}
572
		}
573
574
		if ( Jetpack::is_active() ) {
575
			Jetpack_Heartbeat::init();
576
		}
577
578
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
579
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
580
581
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
582
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
583
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
584
		}
585
586
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
587
588
		add_action( 'admin_init', array( $this, 'admin_init' ) );
589
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
590
591
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
592
593
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
594
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
595
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
596
597
		// returns HTTPS support status
598
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
599
600
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
601
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
602
603
		// JITM AJAX callback function
604
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
605
606
		// Universal ajax callback for all tracking events triggered via js
607
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
608
609
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
610
611
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
612
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
613
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
614
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
615
616
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
617
618
		/**
619
		 * These actions run checks to load additional files.
620
		 * They check for external files or plugins, so they need to run as late as possible.
621
		 */
622
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
623
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
624
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
625
626
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
627
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
628
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
629
630
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
631
632
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
633
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
634
635
		// A filter to control all just in time messages
636
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
637
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
638
639
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
640
		// We should make sure to only do this for front end links.
641
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
642
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
643
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
644
		}
645
646
		// Update the Jetpack plan from API on heartbeats
647
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
648
649
		/**
650
		 * This is the hack to concatinate all css files into one.
651
		 * For description and reasoning see the implode_frontend_css method
652
		 *
653
		 * Super late priority so we catch all the registered styles
654
		 */
655
		if( !is_admin() ) {
656
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
657
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
658
		}
659
660
		/**
661
		 * These are sync actions that we need to keep track of for jitms
662
		 */
663
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
664
665
		// Actually push the stats on shutdown.
666
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
667
			add_action( 'shutdown', array( $this, 'push_stats' ) );
668
		}
669
	}
670
671
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
672
		$post = get_post( $post_id );
673
674
		if ( empty( $post ) ) {
675
			return $default_url;
676
		}
677
678
		$post_type = $post->post_type;
679
680
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
681
		// https://en.support.wordpress.com/custom-post-types/
682
		$allowed_post_types = array(
683
			'post' => 'post',
684
			'page' => 'page',
685
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
686
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
687
		);
688
689
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
690
			return $default_url;
691
		}
692
693
		$path_prefix = $allowed_post_types[ $post_type ];
694
695
		$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...
696
697
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
698
	}
699
700
	function point_edit_comment_links_to_calypso( $url ) {
701
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
702
		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...
703
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d?action=edit',
704
			Jetpack::build_raw_urls( get_home_url() ),
705
			$query_args['amp;c']
706
		) );
707
	}
708
709
	function jetpack_track_last_sync_callback( $params ) {
710
		/**
711
		 * Filter to turn off jitm caching
712
		 *
713
		 * @since 5.4.0
714
		 *
715
		 * @param bool false Whether to cache just in time messages
716
		 */
717
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
718
			return $params;
719
		}
720
721
		if ( is_array( $params ) && isset( $params[0] ) ) {
722
			$option = $params[0];
723
			if ( 'active_plugins' === $option ) {
724
				// use the cache if we can, but not terribly important if it gets evicted
725
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
726
			}
727
		}
728
729
		return $params;
730
	}
731
732
	function jetpack_connection_banner_callback() {
733
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
734
735
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
736
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
737
			wp_send_json_success();
738
		}
739
740
		wp_die();
741
	}
742
743
	function jetpack_admin_ajax_tracks_callback() {
744
		// Check for nonce
745
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
746
			wp_die( 'Permissions check failed.' );
747
		}
748
749
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
750
			wp_die( 'No valid event name or type.' );
751
		}
752
753
		$tracks_data = array();
754
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
755
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
756
				$tracks_data = $_REQUEST['tracksEventProp'];
757
			} else {
758
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
759
			}
760
		}
761
762
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
763
		wp_send_json_success();
764
		wp_die();
765
	}
766
767
	/**
768
	 * The callback for the JITM ajax requests.
769
	 */
770
	function jetpack_jitm_ajax_callback() {
771
		// Check for nonce
772
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
773
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
774
		}
775
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
776
			$module_slug = $_REQUEST['jitmModule'];
777
			Jetpack::log( 'activate', $module_slug );
778
			Jetpack::activate_module( $module_slug, false, false );
779
			Jetpack::state( 'message', 'no_message' );
780
781
			//A Jetpack module is being activated through a JITM, track it
782
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
783
			$this->do_stats( 'server_side' );
784
785
			wp_send_json_success();
786
		}
787
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
788
			// get the hide_jitm options array
789
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
790
			$module_slug = $_REQUEST['jitmModule'];
791
792
			if( ! $jetpack_hide_jitm ) {
793
				$jetpack_hide_jitm = array(
794
					$module_slug => 'hide'
795
				);
796
			} else {
797
				$jetpack_hide_jitm[$module_slug] = 'hide';
798
			}
799
800
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
801
802
			//jitm is being dismissed forever, track it
803
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
804
			$this->do_stats( 'server_side' );
805
806
			wp_send_json_success();
807
		}
808 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
809
			$module_slug = $_REQUEST['jitmModule'];
810
811
			// User went to WordPress.com, track this
812
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
813
			$this->do_stats( 'server_side' );
814
815
			wp_send_json_success();
816
		}
817 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
818
			$track = $_REQUEST['jitmModule'];
819
820
			// User is viewing JITM, track it.
821
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
822
			$this->do_stats( 'server_side' );
823
824
			wp_send_json_success();
825
		}
826
	}
827
828
	/**
829
	 * If there are any stats that need to be pushed, but haven't been, push them now.
830
	 */
831
	function push_stats() {
832
		if ( ! empty( $this->stats ) ) {
833
			$this->do_stats( 'server_side' );
834
		}
835
	}
836
837
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
838
		switch( $cap ) {
839
			case 'jetpack_connect' :
840
			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...
841
				if ( Jetpack::is_development_mode() ) {
842
					$caps = array( 'do_not_allow' );
843
					break;
844
				}
845
				/**
846
				 * Pass through. If it's not development mode, these should match disconnect.
847
				 * Let users disconnect if it's development mode, just in case things glitch.
848
				 */
849
			case 'jetpack_disconnect' :
850
				/**
851
				 * In multisite, can individual site admins manage their own connection?
852
				 *
853
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
854
				 */
855
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
856
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
857
						/**
858
						 * We need to update the option name -- it's terribly unclear which
859
						 * direction the override goes.
860
						 *
861
						 * @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...
862
						 */
863
						$caps = array( 'do_not_allow' );
864
						break;
865
					}
866
				}
867
868
				$caps = array( 'manage_options' );
869
				break;
870
			case 'jetpack_manage_modules' :
871
			case 'jetpack_activate_modules' :
872
			case 'jetpack_deactivate_modules' :
873
				$caps = array( 'manage_options' );
874
				break;
875
			case 'jetpack_configure_modules' :
876
				$caps = array( 'manage_options' );
877
				break;
878
			case 'jetpack_network_admin_page':
879
			case 'jetpack_network_settings_page':
880
				$caps = array( 'manage_network_plugins' );
881
				break;
882
			case 'jetpack_network_sites_page':
883
				$caps = array( 'manage_sites' );
884
				break;
885
			case 'jetpack_admin_page' :
886
				if ( Jetpack::is_development_mode() ) {
887
					$caps = array( 'manage_options' );
888
					break;
889
				} else {
890
					$caps = array( 'read' );
891
				}
892
				break;
893
			case 'jetpack_connect_user' :
894
				if ( Jetpack::is_development_mode() ) {
895
					$caps = array( 'do_not_allow' );
896
					break;
897
				}
898
				$caps = array( 'read' );
899
				break;
900
		}
901
		return $caps;
902
	}
903
904
	function require_jetpack_authentication() {
905
		// Don't let anyone authenticate
906
		$_COOKIE = array();
907
		remove_all_filters( 'authenticate' );
908
		remove_all_actions( 'wp_login_failed' );
909
910
		if ( Jetpack::is_active() ) {
911
			// Allow Jetpack authentication
912
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
913
		}
914
	}
915
916
	/**
917
	 * Load language files
918
	 * @action plugins_loaded
919
	 */
920
	public static function plugin_textdomain() {
921
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
922
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
923
	}
924
925
	/**
926
	 * Register assets for use in various modules and the Jetpack admin page.
927
	 *
928
	 * @uses wp_script_is, wp_register_script, plugins_url
929
	 * @action wp_loaded
930
	 * @return null
931
	 */
932
	public function register_assets() {
933
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
934
			wp_register_script(
935
				'spin',
936
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
937
				false,
938
				'1.3'
939
			);
940
		}
941
942
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
943
			wp_register_script(
944
				'jquery.spin',
945
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
946
				array( 'jquery', 'spin' ),
947
				'1.3'
948
			);
949
		}
950
951 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
952
			wp_register_script(
953
				'jetpack-gallery-settings',
954
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
955
				array( 'media-views' ),
956
				'20121225'
957
			);
958
		}
959
960
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
961
			wp_register_script(
962
				'jetpack-twitter-timeline',
963
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
964
				array( 'jquery' ),
965
				'4.0.0',
966
				true
967
			);
968
		}
969
970
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
971
			wp_register_script(
972
				'jetpack-facebook-embed',
973
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
974
				array( 'jquery' ),
975
				null,
976
				true
977
			);
978
979
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
980
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
981
			if ( ! is_numeric( $fb_app_id ) ) {
982
				$fb_app_id = '';
983
			}
984
			wp_localize_script(
985
				'jetpack-facebook-embed',
986
				'jpfbembed',
987
				array(
988
					'appid' => $fb_app_id,
989
					'locale' => $this->get_locale(),
990
				)
991
			);
992
		}
993
994
		/**
995
		 * As jetpack_register_genericons is by default fired off a hook,
996
		 * the hook may have already fired by this point.
997
		 * So, let's just trigger it manually.
998
		 */
999
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1000
		jetpack_register_genericons();
1001
1002
		/**
1003
		 * Register the social logos
1004
		 */
1005
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1006
		jetpack_register_social_logos();
1007
1008 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1009
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1010
	}
1011
1012
	/**
1013
	 * Guess locale from language code.
1014
	 *
1015
	 * @param string $lang Language code.
1016
	 * @return string|bool
1017
	 */
1018
	function guess_locale_from_lang( $lang ) {
1019
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1020
			return 'en_US';
1021
		}
1022
1023 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1024
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1025
				return false;
1026
			}
1027
1028
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1029
		}
1030
1031
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1032
			// WP.com: get_locale() returns 'it'
1033
			$locale = GP_Locales::by_slug( $lang );
1034
		} else {
1035
			// Jetpack: get_locale() returns 'it_IT';
1036
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1037
		}
1038
1039
		if ( ! $locale ) {
1040
			return false;
1041
		}
1042
1043
		if ( empty( $locale->facebook_locale ) ) {
1044
			if ( empty( $locale->wp_locale ) ) {
1045
				return false;
1046
			} else {
1047
				// Facebook SDK is smart enough to fall back to en_US if a
1048
				// locale isn't supported. Since supported Facebook locales
1049
				// can fall out of sync, we'll attempt to use the known
1050
				// wp_locale value and rely on said fallback.
1051
				return $locale->wp_locale;
1052
			}
1053
		}
1054
1055
		return $locale->facebook_locale;
1056
	}
1057
1058
	/**
1059
	 * Get the locale.
1060
	 *
1061
	 * @return string|bool
1062
	 */
1063
	function get_locale() {
1064
		$locale = $this->guess_locale_from_lang( get_locale() );
1065
1066
		if ( ! $locale ) {
1067
			$locale = 'en_US';
1068
		}
1069
1070
		return $locale;
1071
	}
1072
1073
	/**
1074
	 * Device Pixels support
1075
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1076
	 */
1077
	function devicepx() {
1078
		if ( Jetpack::is_active() ) {
1079
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1080
		}
1081
	}
1082
1083
	/**
1084
	 * Return the network_site_url so that .com knows what network this site is a part of.
1085
	 * @param  bool $option
1086
	 * @return string
1087
	 */
1088
	public function jetpack_main_network_site_option( $option ) {
1089
		return network_site_url();
1090
	}
1091
	/**
1092
	 * Network Name.
1093
	 */
1094
	static function network_name( $option = null ) {
1095
		global $current_site;
1096
		return $current_site->site_name;
1097
	}
1098
	/**
1099
	 * Does the network allow new user and site registrations.
1100
	 * @return string
1101
	 */
1102
	static function network_allow_new_registrations( $option = null ) {
1103
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1104
	}
1105
	/**
1106
	 * Does the network allow admins to add new users.
1107
	 * @return boolian
1108
	 */
1109
	static function network_add_new_users( $option = null ) {
1110
		return (bool) get_site_option( 'add_new_users' );
1111
	}
1112
	/**
1113
	 * File upload psace left per site in MB.
1114
	 *  -1 means NO LIMIT.
1115
	 * @return number
1116
	 */
1117
	static function network_site_upload_space( $option = null ) {
1118
		// value in MB
1119
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1120
	}
1121
1122
	/**
1123
	 * Network allowed file types.
1124
	 * @return string
1125
	 */
1126
	static function network_upload_file_types( $option = null ) {
1127
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1128
	}
1129
1130
	/**
1131
	 * Maximum file upload size set by the network.
1132
	 * @return number
1133
	 */
1134
	static function network_max_upload_file_size( $option = null ) {
1135
		// value in KB
1136
		return get_site_option( 'fileupload_maxk', 300 );
1137
	}
1138
1139
	/**
1140
	 * Lets us know if a site allows admins to manage the network.
1141
	 * @return array
1142
	 */
1143
	static function network_enable_administration_menus( $option = null ) {
1144
		return get_site_option( 'menu_items' );
1145
	}
1146
1147
	/**
1148
	 * If a user has been promoted to or demoted from admin, we need to clear the
1149
	 * jetpack_other_linked_admins transient.
1150
	 *
1151
	 * @since 4.3.2
1152
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1153
	 *
1154
	 * @param int    $user_id   The user ID whose role changed.
1155
	 * @param string $role      The new role.
1156
	 * @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...
1157
	 */
1158
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1159
		if ( 'administrator' == $role
1160
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1161
			|| is_null( $old_roles )
1162
		) {
1163
			delete_transient( 'jetpack_other_linked_admins' );
1164
		}
1165
	}
1166
1167
	/**
1168
	 * Checks to see if there are any other users available to become primary
1169
	 * Users must both:
1170
	 * - Be linked to wpcom
1171
	 * - Be an admin
1172
	 *
1173
	 * @return mixed False if no other users are linked, Int if there are.
1174
	 */
1175
	static function get_other_linked_admins() {
1176
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1177
1178
		if ( false === $other_linked_users ) {
1179
			$admins = get_users( array( 'role' => 'administrator' ) );
1180
			if ( count( $admins ) > 1 ) {
1181
				$available = array();
1182
				foreach ( $admins as $admin ) {
1183
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1184
						$available[] = $admin->ID;
1185
					}
1186
				}
1187
1188
				$count_connected_admins = count( $available );
1189
				if ( count( $available ) > 1 ) {
1190
					$other_linked_users = $count_connected_admins;
1191
				} else {
1192
					$other_linked_users = 0;
1193
				}
1194
			} else {
1195
				$other_linked_users = 0;
1196
			}
1197
1198
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1199
		}
1200
1201
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1202
	}
1203
1204
	/**
1205
	 * Return whether we are dealing with a multi network setup or not.
1206
	 * The reason we are type casting this is because we want to avoid the situation where
1207
	 * the result is false since when is_main_network_option return false it cases
1208
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1209
	 * database which could be set to anything as opposed to what this function returns.
1210
	 * @param  bool  $option
1211
	 *
1212
	 * @return boolean
1213
	 */
1214
	public function is_main_network_option( $option ) {
1215
		// return '1' or ''
1216
		return (string) (bool) Jetpack::is_multi_network();
1217
	}
1218
1219
	/**
1220
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1221
	 *
1222
	 * @param  string  $option
1223
	 * @return boolean
1224
	 */
1225
	public function is_multisite( $option ) {
1226
		return (string) (bool) is_multisite();
1227
	}
1228
1229
	/**
1230
	 * Implemented since there is no core is multi network function
1231
	 * Right now there is no way to tell if we which network is the dominant network on the system
1232
	 *
1233
	 * @since  3.3
1234
	 * @return boolean
1235
	 */
1236
	public static function is_multi_network() {
1237
		global  $wpdb;
1238
1239
		// if we don't have a multi site setup no need to do any more
1240
		if ( ! is_multisite() ) {
1241
			return false;
1242
		}
1243
1244
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1245
		if ( $num_sites > 1 ) {
1246
			return true;
1247
		} else {
1248
			return false;
1249
		}
1250
	}
1251
1252
	/**
1253
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1254
	 * @return null
1255
	 */
1256
	function update_jetpack_main_network_site_option() {
1257
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1258
	}
1259
	/**
1260
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1261
	 *
1262
	 */
1263
	function update_jetpack_network_settings() {
1264
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1265
		// Only sync this info for the main network site.
1266
	}
1267
1268
	/**
1269
	 * Get back if the current site is single user site.
1270
	 *
1271
	 * @return bool
1272
	 */
1273
	public static function is_single_user_site() {
1274
		global $wpdb;
1275
1276 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1277
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1278
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1279
		}
1280
		return 1 === (int) $some_users;
1281
	}
1282
1283
	/**
1284
	 * Returns true if the site has file write access false otherwise.
1285
	 * @return string ( '1' | '0' )
1286
	 **/
1287
	public static function file_system_write_access() {
1288
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1289
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1290
		}
1291
1292
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1293
1294
		$filesystem_method = get_filesystem_method();
1295
		if ( $filesystem_method === 'direct' ) {
1296
			return 1;
1297
		}
1298
1299
		ob_start();
1300
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1301
		ob_end_clean();
1302
		if ( $filesystem_credentials_are_stored ) {
1303
			return 1;
1304
		}
1305
		return 0;
1306
	}
1307
1308
	/**
1309
	 * Finds out if a site is using a version control system.
1310
	 * @return string ( '1' | '0' )
1311
	 **/
1312
	public static function is_version_controlled() {
1313
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1314
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1315
	}
1316
1317
	/**
1318
	 * Determines whether the current theme supports featured images or not.
1319
	 * @return string ( '1' | '0' )
1320
	 */
1321
	public static function featured_images_enabled() {
1322
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1323
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1324
	}
1325
1326
	/**
1327
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1328
	 *
1329
	 * @deprecated 4.7 use get_avatar_url instead.
1330
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1331
	 * @param int $size Size of the avatar image
1332
	 * @param string $default URL to a default image to use if no avatar is available
1333
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1334
	 *
1335
	 * @return array
1336
	 */
1337
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1338
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1339
		return get_avatar_url( $id_or_email, array(
1340
			'size' => $size,
1341
			'default' => $default,
1342
			'force_default' => $force_display,
1343
		) );
1344
	}
1345
1346
	/**
1347
	 * jetpack_updates is saved in the following schema:
1348
	 *
1349
	 * array (
1350
	 *      'plugins'                       => (int) Number of plugin updates available.
1351
	 *      'themes'                        => (int) Number of theme updates available.
1352
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1353
	 *      'translations'                  => (int) Number of translation updates available.
1354
	 *      'total'                         => (int) Total of all available updates.
1355
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1356
	 * )
1357
	 * @return array
1358
	 */
1359
	public static function get_updates() {
1360
		$update_data = wp_get_update_data();
1361
1362
		// Stores the individual update counts as well as the total count.
1363
		if ( isset( $update_data['counts'] ) ) {
1364
			$updates = $update_data['counts'];
1365
		}
1366
1367
		// If we need to update WordPress core, let's find the latest version number.
1368 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1369
			$cur = get_preferred_from_update_core();
1370
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1371
				$updates['wp_update_version'] = $cur->current;
1372
			}
1373
		}
1374
		return isset( $updates ) ? $updates : array();
1375
	}
1376
1377
	public static function get_update_details() {
1378
		$update_details = array(
1379
			'update_core' => get_site_transient( 'update_core' ),
1380
			'update_plugins' => get_site_transient( 'update_plugins' ),
1381
			'update_themes' => get_site_transient( 'update_themes' ),
1382
		);
1383
		return $update_details;
1384
	}
1385
1386
	public static function refresh_update_data() {
1387
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1388
1389
	}
1390
1391
	public static function refresh_theme_data() {
1392
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1393
	}
1394
1395
	/**
1396
	 * Is Jetpack active?
1397
	 */
1398
	public static function is_active() {
1399
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1400
	}
1401
1402
	/**
1403
	 * Make an API call to WordPress.com for plan status
1404
	 *
1405
	 * @uses Jetpack_Options::get_option()
1406
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1407
	 * @uses update_option()
1408
	 *
1409
	 * @access public
1410
	 * @static
1411
	 *
1412
	 * @return bool True if plan is updated, false if no update
1413
	 */
1414
	public static function refresh_active_plan_from_wpcom() {
1415
		// Make the API request
1416
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1417
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1418
1419
		// Bail if there was an error or malformed response
1420
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1421
			return false;
1422
		}
1423
1424
		// Decode the results
1425
		$results = json_decode( $response['body'], true );
1426
1427
		// Bail if there were no results or plan details returned
1428
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1429
			return false;
1430
		}
1431
1432
		// Store the option and return true if updated
1433
		return update_option( 'jetpack_active_plan', $results['plan'] );
1434
	}
1435
1436
	/**
1437
	 * Get the plan that this Jetpack site is currently using
1438
	 *
1439
	 * @uses get_option()
1440
	 *
1441
	 * @access public
1442
	 * @static
1443
	 *
1444
	 * @return array Active Jetpack plan details
1445
	 */
1446
	public static function get_active_plan() {
1447
		$plan = get_option( 'jetpack_active_plan', array() );
1448
1449
		// Set the default options
1450
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1451
			$plan = wp_parse_args( $plan, array(
1452
				'product_slug' => 'jetpack_free',
1453
				'supports'     => array(),
1454
				'class'        => 'free',
1455
			) );
1456
		}
1457
1458
		// Define what paid modules are supported by personal plans
1459
		$personal_plans = array(
1460
			'jetpack_personal',
1461
			'jetpack_personal_monthly',
1462
			'personal-bundle',
1463
		);
1464
1465
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1466
			$plan['supports'] = array(
1467
				'akismet',
1468
			);
1469
			$plan['class'] = 'personal';
1470
		}
1471
1472
		// Define what paid modules are supported by premium plans
1473
		$premium_plans = array(
1474
			'jetpack_premium',
1475
			'jetpack_premium_monthly',
1476
			'value_bundle',
1477
		);
1478
1479
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1480
			$plan['supports'] = array(
1481
				'videopress',
1482
				'akismet',
1483
				'vaultpress',
1484
				'wordads',
1485
			);
1486
			$plan['class'] = 'premium';
1487
		}
1488
1489
		// Define what paid modules are supported by professional plans
1490
		$business_plans = array(
1491
			'jetpack_business',
1492
			'jetpack_business_monthly',
1493
			'business-bundle',
1494
			'vip',
1495
		);
1496
1497
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1498
			$plan['supports'] = array(
1499
				'videopress',
1500
				'akismet',
1501
				'vaultpress',
1502
				'seo-tools',
1503
				'google-analytics',
1504
				'wordads',
1505
				'search',
1506
			);
1507
			$plan['class'] = 'business';
1508
		}
1509
1510
		// Make sure we have an array here in the event database data is stale
1511
		if ( ! isset( $plan['supports'] ) ) {
1512
			$plan['supports'] = array();
1513
		}
1514
1515
		return $plan;
1516
	}
1517
1518
	/**
1519
	 * Determine whether the active plan supports a particular feature
1520
	 *
1521
	 * @uses Jetpack::get_active_plan()
1522
	 *
1523
	 * @access public
1524
	 * @static
1525
	 *
1526
	 * @return bool True if plan supports feature, false if not
1527
	 */
1528
	public static function active_plan_supports( $feature ) {
1529
		$plan = Jetpack::get_active_plan();
1530
1531
		if ( in_array( $feature, $plan['supports'] ) ) {
1532
			return true;
1533
		}
1534
1535
		return false;
1536
	}
1537
1538
	/**
1539
	 * Is Jetpack in development (offline) mode?
1540
	 */
1541
	public static function is_development_mode() {
1542
		$development_mode = false;
1543
1544
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1545
			$development_mode = JETPACK_DEV_DEBUG;
1546
		} elseif ( $site_url = site_url() ) {
1547
			$development_mode = false === strpos( $site_url, '.' );
1548
		}
1549
1550
		/**
1551
		 * Filters Jetpack's development mode.
1552
		 *
1553
		 * @see https://jetpack.com/support/development-mode/
1554
		 *
1555
		 * @since 2.2.1
1556
		 *
1557
		 * @param bool $development_mode Is Jetpack's development mode active.
1558
		 */
1559
		return apply_filters( 'jetpack_development_mode', $development_mode );
1560
	}
1561
1562
	/**
1563
	* Get Jetpack development mode notice text and notice class.
1564
	*
1565
	* Mirrors the checks made in Jetpack::is_development_mode
1566
	*
1567
	*/
1568
	public static function show_development_mode_notice() {
1569
		if ( Jetpack::is_development_mode() ) {
1570
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1571
				$notice = sprintf(
1572
					/* translators: %s is a URL */
1573
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1574
					'https://jetpack.com/support/development-mode/'
1575
				);
1576
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1577
				$notice = sprintf(
1578
					/* translators: %s is a URL */
1579
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1580
					'https://jetpack.com/support/development-mode/'
1581
				);
1582
			} else {
1583
				$notice = sprintf(
1584
					/* translators: %s is a URL */
1585
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1586
					'https://jetpack.com/support/development-mode/'
1587
				);
1588
			}
1589
1590
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1591
		}
1592
1593
		// Throw up a notice if using a development version and as for feedback.
1594
		if ( Jetpack::is_development_version() ) {
1595
			/* translators: %s is a URL */
1596
			$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/' );
1597
1598
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1599
		}
1600
		// Throw up a notice if using staging mode
1601
		if ( Jetpack::is_staging_site() ) {
1602
			/* translators: %s is a URL */
1603
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1604
1605
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1606
		}
1607
	}
1608
1609
	/**
1610
	 * Whether Jetpack's version maps to a public release, or a development version.
1611
	 */
1612
	public static function is_development_version() {
1613
		/**
1614
		 * Allows filtering whether this is a development version of Jetpack.
1615
		 *
1616
		 * This filter is especially useful for tests.
1617
		 *
1618
		 * @since 4.3.0
1619
		 *
1620
		 * @param bool $development_version Is this a develoment version of Jetpack?
1621
		 */
1622
		return (bool) apply_filters(
1623
			'jetpack_development_version',
1624
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1625
		);
1626
	}
1627
1628
	/**
1629
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1630
	 */
1631
	public static function is_user_connected( $user_id = false ) {
1632
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1633
		if ( ! $user_id ) {
1634
			return false;
1635
		}
1636
1637
		return (bool) Jetpack_Data::get_access_token( $user_id );
1638
	}
1639
1640
	/**
1641
	 * Get the wpcom user data of the current|specified connected user.
1642
	 */
1643
	public static function get_connected_user_data( $user_id = null ) {
1644
		if ( ! $user_id ) {
1645
			$user_id = get_current_user_id();
1646
		}
1647
1648
		$transient_key = "jetpack_connected_user_data_$user_id";
1649
1650
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1651
			return $cached_user_data;
1652
		}
1653
1654
		Jetpack::load_xml_rpc_client();
1655
		$xml = new Jetpack_IXR_Client( array(
1656
			'user_id' => $user_id,
1657
		) );
1658
		$xml->query( 'wpcom.getUser' );
1659
		if ( ! $xml->isError() ) {
1660
			$user_data = $xml->getResponse();
1661
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1662
			return $user_data;
1663
		}
1664
1665
		return false;
1666
	}
1667
1668
	/**
1669
	 * Get the wpcom email of the current|specified connected user.
1670
	 */
1671 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1672
		if ( ! $user_id ) {
1673
			$user_id = get_current_user_id();
1674
		}
1675
		Jetpack::load_xml_rpc_client();
1676
		$xml = new Jetpack_IXR_Client( array(
1677
			'user_id' => $user_id,
1678
		) );
1679
		$xml->query( 'wpcom.getUserEmail' );
1680
		if ( ! $xml->isError() ) {
1681
			return $xml->getResponse();
1682
		}
1683
		return false;
1684
	}
1685
1686
	/**
1687
	 * Get the wpcom email of the master user.
1688
	 */
1689
	public static function get_master_user_email() {
1690
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1691
		if ( $master_user_id ) {
1692
			return self::get_connected_user_email( $master_user_id );
1693
		}
1694
		return '';
1695
	}
1696
1697
	function current_user_is_connection_owner() {
1698
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1699
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1700
	}
1701
1702
	/**
1703
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1704
	 */
1705
	function extra_oembed_providers() {
1706
		// Cloudup: https://dev.cloudup.com/#oembed
1707
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1708
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1709
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1710
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1711
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1712
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1713
	}
1714
1715
	/**
1716
	 * Synchronize connected user role changes
1717
	 */
1718
	function user_role_change( $user_id ) {
1719
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1720
		Jetpack_Sync_Users::user_role_change( $user_id );
1721
	}
1722
1723
	/**
1724
	 * Loads the currently active modules.
1725
	 */
1726
	public static function load_modules() {
1727
		if (
1728
			! self::is_active()
1729
			&& ! self::is_development_mode()
1730
			&& (
1731
				! is_multisite()
1732
				|| ! get_site_option( 'jetpack_protect_active' )
1733
			)
1734
		) {
1735
			return;
1736
		}
1737
1738
		$version = Jetpack_Options::get_option( 'version' );
1739 View Code Duplication
		if ( ! $version ) {
1740
			$version = $old_version = JETPACK__VERSION . ':' . time();
1741
			/** This action is documented in class.jetpack.php */
1742
			do_action( 'updating_jetpack_version', $version, false );
1743
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1744
		}
1745
		list( $version ) = explode( ':', $version );
1746
1747
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1748
1749
		$modules_data = array();
1750
1751
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1752
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1753
			$updated_modules = array();
1754
			foreach ( $modules as $module ) {
1755
				$modules_data[ $module ] = Jetpack::get_module( $module );
1756
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1757
					continue;
1758
				}
1759
1760
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1761
					continue;
1762
				}
1763
1764
				$updated_modules[] = $module;
1765
			}
1766
1767
			$modules = array_diff( $modules, $updated_modules );
1768
		}
1769
1770
		$is_development_mode = Jetpack::is_development_mode();
1771
1772
		foreach ( $modules as $index => $module ) {
1773
			// If we're in dev mode, disable modules requiring a connection
1774
			if ( $is_development_mode ) {
1775
				// Prime the pump if we need to
1776
				if ( empty( $modules_data[ $module ] ) ) {
1777
					$modules_data[ $module ] = Jetpack::get_module( $module );
1778
				}
1779
				// If the module requires a connection, but we're in local mode, don't include it.
1780
				if ( $modules_data[ $module ]['requires_connection'] ) {
1781
					continue;
1782
				}
1783
			}
1784
1785
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1786
				continue;
1787
			}
1788
1789
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1790
				unset( $modules[ $index ] );
1791
				self::update_active_modules( array_values( $modules ) );
1792
				continue;
1793
			}
1794
1795
			/**
1796
			 * Fires when a specific module is loaded.
1797
			 * The dynamic part of the hook, $module, is the module slug.
1798
			 *
1799
			 * @since 1.1.0
1800
			 */
1801
			do_action( 'jetpack_module_loaded_' . $module );
1802
		}
1803
1804
		/**
1805
		 * Fires when all the modules are loaded.
1806
		 *
1807
		 * @since 1.1.0
1808
		 */
1809
		do_action( 'jetpack_modules_loaded' );
1810
1811
		// 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.
1812
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1813
	}
1814
1815
	/**
1816
	 * Check if Jetpack's REST API compat file should be included
1817
	 * @action plugins_loaded
1818
	 * @return null
1819
	 */
1820
	public function check_rest_api_compat() {
1821
		/**
1822
		 * Filters the list of REST API compat files to be included.
1823
		 *
1824
		 * @since 2.2.5
1825
		 *
1826
		 * @param array $args Array of REST API compat files to include.
1827
		 */
1828
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1829
1830
		if ( function_exists( 'bbpress' ) )
1831
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1832
1833
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1834
			require_once $_jetpack_rest_api_compat_include;
1835
	}
1836
1837
	/**
1838
	 * Gets all plugins currently active in values, regardless of whether they're
1839
	 * traditionally activated or network activated.
1840
	 *
1841
	 * @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...
1842
	 */
1843
	public static function get_active_plugins() {
1844
		$active_plugins = (array) get_option( 'active_plugins', array() );
1845
1846
		if ( is_multisite() ) {
1847
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1848
			// whereas active_plugins stores them in the values.
1849
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1850
			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...
1851
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1852
			}
1853
		}
1854
1855
		sort( $active_plugins );
1856
1857
		return array_unique( $active_plugins );
1858
	}
1859
1860
	/**
1861
	 * Gets and parses additional plugin data to send with the heartbeat data
1862
	 *
1863
	 * @since 3.8.1
1864
	 *
1865
	 * @return array Array of plugin data
1866
	 */
1867
	public static function get_parsed_plugin_data() {
1868
		if ( ! function_exists( 'get_plugins' ) ) {
1869
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1870
		}
1871
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1872
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1873
		$active_plugins = Jetpack::get_active_plugins();
1874
1875
		$plugins = array();
1876
		foreach ( $all_plugins as $path => $plugin_data ) {
1877
			$plugins[ $path ] = array(
1878
					'is_active' => in_array( $path, $active_plugins ),
1879
					'file'      => $path,
1880
					'name'      => $plugin_data['Name'],
1881
					'version'   => $plugin_data['Version'],
1882
					'author'    => $plugin_data['Author'],
1883
			);
1884
		}
1885
1886
		return $plugins;
1887
	}
1888
1889
	/**
1890
	 * Gets and parses theme data to send with the heartbeat data
1891
	 *
1892
	 * @since 3.8.1
1893
	 *
1894
	 * @return array Array of theme data
1895
	 */
1896
	public static function get_parsed_theme_data() {
1897
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1898
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1899
1900
		$themes = array();
1901
		foreach ( $all_themes as $slug => $theme_data ) {
1902
			$theme_headers = array();
1903
			foreach ( $header_keys as $header_key ) {
1904
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1905
			}
1906
1907
			$themes[ $slug ] = array(
1908
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1909
					'slug' => $slug,
1910
					'theme_root' => $theme_data->get_theme_root_uri(),
1911
					'parent' => $theme_data->parent(),
1912
					'headers' => $theme_headers
1913
			);
1914
		}
1915
1916
		return $themes;
1917
	}
1918
1919
	/**
1920
	 * Checks whether a specific plugin is active.
1921
	 *
1922
	 * We don't want to store these in a static variable, in case
1923
	 * there are switch_to_blog() calls involved.
1924
	 */
1925
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1926
		return in_array( $plugin, self::get_active_plugins() );
1927
	}
1928
1929
	/**
1930
	 * Check if Jetpack's Open Graph tags should be used.
1931
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1932
	 *
1933
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1934
	 * @action plugins_loaded
1935
	 * @return null
1936
	 */
1937
	public function check_open_graph() {
1938
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1939
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1940
		}
1941
1942
		$active_plugins = self::get_active_plugins();
1943
1944
		if ( ! empty( $active_plugins ) ) {
1945
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1946
				if ( in_array( $plugin, $active_plugins ) ) {
1947
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1948
					break;
1949
				}
1950
			}
1951
		}
1952
1953
		/**
1954
		 * Allow the addition of Open Graph Meta Tags to all pages.
1955
		 *
1956
		 * @since 2.0.3
1957
		 *
1958
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1959
		 */
1960
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1961
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1962
		}
1963
	}
1964
1965
	/**
1966
	 * Check if Jetpack's Twitter tags should be used.
1967
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1968
	 *
1969
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1970
	 * @action plugins_loaded
1971
	 * @return null
1972
	 */
1973
	public function check_twitter_tags() {
1974
1975
		$active_plugins = self::get_active_plugins();
1976
1977
		if ( ! empty( $active_plugins ) ) {
1978
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1979
				if ( in_array( $plugin, $active_plugins ) ) {
1980
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1981
					break;
1982
				}
1983
			}
1984
		}
1985
1986
		/**
1987
		 * Allow Twitter Card Meta tags to be disabled.
1988
		 *
1989
		 * @since 2.6.0
1990
		 *
1991
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1992
		 */
1993
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1994
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1995
		}
1996
	}
1997
1998
	/**
1999
	 * Allows plugins to submit security reports.
2000
 	 *
2001
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2002
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2003
	 * @param array   $args         See definitions above
2004
	 */
2005
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2006
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2007
	}
2008
2009
/* Jetpack Options API */
2010
2011
	public static function get_option_names( $type = 'compact' ) {
2012
		return Jetpack_Options::get_option_names( $type );
2013
	}
2014
2015
	/**
2016
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2017
 	 *
2018
	 * @param string $name    Option name
2019
	 * @param mixed  $default (optional)
2020
	 */
2021
	public static function get_option( $name, $default = false ) {
2022
		return Jetpack_Options::get_option( $name, $default );
2023
	}
2024
2025
	/**
2026
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2027
 	 *
2028
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2029
	 * @param string $name  Option name
2030
	 * @param mixed  $value Option value
2031
	 */
2032
	public static function update_option( $name, $value ) {
2033
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2034
		return Jetpack_Options::update_option( $name, $value );
2035
	}
2036
2037
	/**
2038
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2039
 	 *
2040
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2041
	 * @param array $array array( option name => option value, ... )
2042
	 */
2043
	public static function update_options( $array ) {
2044
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2045
		return Jetpack_Options::update_options( $array );
2046
	}
2047
2048
	/**
2049
	 * Deletes the given option.  May be passed multiple option names as an array.
2050
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2051
	 *
2052
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2053
	 * @param string|array $names
2054
	 */
2055
	public static function delete_option( $names ) {
2056
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2057
		return Jetpack_Options::delete_option( $names );
2058
	}
2059
2060
	/**
2061
	 * Enters a user token into the user_tokens option
2062
	 *
2063
	 * @param int $user_id
2064
	 * @param string $token
2065
	 * return bool
2066
	 */
2067
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2068
		// not designed for concurrent updates
2069
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2070
		if ( ! is_array( $user_tokens ) )
2071
			$user_tokens = array();
2072
		$user_tokens[$user_id] = $token;
2073
		if ( $is_master_user ) {
2074
			$master_user = $user_id;
2075
			$options     = compact( 'user_tokens', 'master_user' );
2076
		} else {
2077
			$options = compact( 'user_tokens' );
2078
		}
2079
		return Jetpack_Options::update_options( $options );
2080
	}
2081
2082
	/**
2083
	 * Returns an array of all PHP files in the specified absolute path.
2084
	 * Equivalent to glob( "$absolute_path/*.php" ).
2085
	 *
2086
	 * @param string $absolute_path The absolute path of the directory to search.
2087
	 * @return array Array of absolute paths to the PHP files.
2088
	 */
2089
	public static function glob_php( $absolute_path ) {
2090
		if ( function_exists( 'glob' ) ) {
2091
			return glob( "$absolute_path/*.php" );
2092
		}
2093
2094
		$absolute_path = untrailingslashit( $absolute_path );
2095
		$files = array();
2096
		if ( ! $dir = @opendir( $absolute_path ) ) {
2097
			return $files;
2098
		}
2099
2100
		while ( false !== $file = readdir( $dir ) ) {
2101
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2102
				continue;
2103
			}
2104
2105
			$file = "$absolute_path/$file";
2106
2107
			if ( ! is_file( $file ) ) {
2108
				continue;
2109
			}
2110
2111
			$files[] = $file;
2112
		}
2113
2114
		closedir( $dir );
2115
2116
		return $files;
2117
	}
2118
2119
	public static function activate_new_modules( $redirect = false ) {
2120
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2121
			return;
2122
		}
2123
2124
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2125 View Code Duplication
		if ( ! $jetpack_old_version ) {
2126
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2127
			/** This action is documented in class.jetpack.php */
2128
			do_action( 'updating_jetpack_version', $version, false );
2129
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2130
		}
2131
2132
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2133
2134
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2135
			return;
2136
		}
2137
2138
		$active_modules     = Jetpack::get_active_modules();
2139
		$reactivate_modules = array();
2140
		foreach ( $active_modules as $active_module ) {
2141
			$module = Jetpack::get_module( $active_module );
2142
			if ( ! isset( $module['changed'] ) ) {
2143
				continue;
2144
			}
2145
2146
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2147
				continue;
2148
			}
2149
2150
			$reactivate_modules[] = $active_module;
2151
			Jetpack::deactivate_module( $active_module );
2152
		}
2153
2154
		$new_version = JETPACK__VERSION . ':' . time();
2155
		/** This action is documented in class.jetpack.php */
2156
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2157
		Jetpack_Options::update_options(
2158
			array(
2159
				'version'     => $new_version,
2160
				'old_version' => $jetpack_old_version,
2161
			)
2162
		);
2163
2164
		Jetpack::state( 'message', 'modules_activated' );
2165
		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...
2166
2167
		if ( $redirect ) {
2168
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2169
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2170
				$page = $_GET['page'];
2171
			}
2172
2173
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2174
			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...
2175
		}
2176
	}
2177
2178
	/**
2179
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2180
	 * Make sure to tuck away module "library" files in a sub-directory.
2181
	 */
2182
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2183
		static $modules = null;
2184
2185
		if ( ! isset( $modules ) ) {
2186
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2187
			// Use the cache if we're on the front-end and it's available...
2188
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2189
				$modules = $available_modules_option[ JETPACK__VERSION ];
2190
			} else {
2191
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2192
2193
				$modules = array();
2194
2195
				foreach ( $files as $file ) {
2196
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2197
						continue;
2198
					}
2199
2200
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2201
				}
2202
2203
				Jetpack_Options::update_option( 'available_modules', array(
2204
					JETPACK__VERSION => $modules,
2205
				) );
2206
			}
2207
		}
2208
2209
		/**
2210
		 * Filters the array of modules available to be activated.
2211
		 *
2212
		 * @since 2.4.0
2213
		 *
2214
		 * @param array $modules Array of available modules.
2215
		 * @param string $min_version Minimum version number required to use modules.
2216
		 * @param string $max_version Maximum version number required to use modules.
2217
		 */
2218
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2219
2220
		if ( ! $min_version && ! $max_version ) {
2221
			return array_keys( $mods );
2222
		}
2223
2224
		$r = array();
2225
		foreach ( $mods as $slug => $introduced ) {
2226
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2227
				continue;
2228
			}
2229
2230
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2231
				continue;
2232
			}
2233
2234
			$r[] = $slug;
2235
		}
2236
2237
		return $r;
2238
	}
2239
2240
	/**
2241
	 * Default modules loaded on activation.
2242
	 */
2243
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2244
		$return = array();
2245
2246
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2247
			$module_data = Jetpack::get_module( $module );
2248
2249
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2250
				case 'yes' :
2251
					$return[] = $module;
2252
					break;
2253
				case 'public' :
2254
					if ( Jetpack_Options::get_option( 'public' ) ) {
2255
						$return[] = $module;
2256
					}
2257
					break;
2258
				case 'no' :
2259
				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...
2260
					break;
2261
			}
2262
		}
2263
		/**
2264
		 * Filters the array of default modules.
2265
		 *
2266
		 * @since 2.5.0
2267
		 *
2268
		 * @param array $return Array of default modules.
2269
		 * @param string $min_version Minimum version number required to use modules.
2270
		 * @param string $max_version Maximum version number required to use modules.
2271
		 */
2272
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2273
	}
2274
2275
	/**
2276
	 * Checks activated modules during auto-activation to determine
2277
	 * if any of those modules are being deprecated.  If so, close
2278
	 * them out, and add any replacement modules.
2279
	 *
2280
	 * Runs at priority 99 by default.
2281
	 *
2282
	 * This is run late, so that it can still activate a module if
2283
	 * the new module is a replacement for another that the user
2284
	 * currently has active, even if something at the normal priority
2285
	 * would kibosh everything.
2286
	 *
2287
	 * @since 2.6
2288
	 * @uses jetpack_get_default_modules filter
2289
	 * @param array $modules
2290
	 * @return array
2291
	 */
2292
	function handle_deprecated_modules( $modules ) {
2293
		$deprecated_modules = array(
2294
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2295
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2296
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2297
		);
2298
2299
		// Don't activate SSO if they never completed activating WPCC.
2300
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2301
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2302
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2303
				$deprecated_modules['wpcc'] = null;
2304
			}
2305
		}
2306
2307
		foreach ( $deprecated_modules as $module => $replacement ) {
2308
			if ( Jetpack::is_module_active( $module ) ) {
2309
				self::deactivate_module( $module );
2310
				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...
2311
					$modules[] = $replacement;
2312
				}
2313
			}
2314
		}
2315
2316
		return array_unique( $modules );
2317
	}
2318
2319
	/**
2320
	 * Checks activated plugins during auto-activation to determine
2321
	 * if any of those plugins are in the list with a corresponding module
2322
	 * that is not compatible with the plugin. The module will not be allowed
2323
	 * to auto-activate.
2324
	 *
2325
	 * @since 2.6
2326
	 * @uses jetpack_get_default_modules filter
2327
	 * @param array $modules
2328
	 * @return array
2329
	 */
2330
	function filter_default_modules( $modules ) {
2331
2332
		$active_plugins = self::get_active_plugins();
2333
2334
		if ( ! empty( $active_plugins ) ) {
2335
2336
			// For each module we'd like to auto-activate...
2337
			foreach ( $modules as $key => $module ) {
2338
				// If there are potential conflicts for it...
2339
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2340
					// For each potential conflict...
2341
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2342
						// If that conflicting plugin is active...
2343
						if ( in_array( $plugin, $active_plugins ) ) {
2344
							// Remove that item from being auto-activated.
2345
							unset( $modules[ $key ] );
2346
						}
2347
					}
2348
				}
2349
			}
2350
		}
2351
2352
		return $modules;
2353
	}
2354
2355
	/**
2356
	 * Extract a module's slug from its full path.
2357
	 */
2358
	public static function get_module_slug( $file ) {
2359
		return str_replace( '.php', '', basename( $file ) );
2360
	}
2361
2362
	/**
2363
	 * Generate a module's path from its slug.
2364
	 */
2365
	public static function get_module_path( $slug ) {
2366
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2367
	}
2368
2369
	/**
2370
	 * Load module data from module file. Headers differ from WordPress
2371
	 * plugin headers to avoid them being identified as standalone
2372
	 * plugins on the WordPress plugins page.
2373
	 */
2374
	public static function get_module( $module ) {
2375
		$headers = array(
2376
			'name'                      => 'Module Name',
2377
			'description'               => 'Module Description',
2378
			'jumpstart_desc'            => 'Jumpstart Description',
2379
			'sort'                      => 'Sort Order',
2380
			'recommendation_order'      => 'Recommendation Order',
2381
			'introduced'                => 'First Introduced',
2382
			'changed'                   => 'Major Changes In',
2383
			'deactivate'                => 'Deactivate',
2384
			'free'                      => 'Free',
2385
			'requires_connection'       => 'Requires Connection',
2386
			'auto_activate'             => 'Auto Activate',
2387
			'module_tags'               => 'Module Tags',
2388
			'feature'                   => 'Feature',
2389
			'additional_search_queries' => 'Additional Search Queries',
2390
		);
2391
2392
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2393
2394
		$mod = Jetpack::get_file_data( $file, $headers );
2395
		if ( empty( $mod['name'] ) ) {
2396
			return false;
2397
		}
2398
2399
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2400
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2401
		$mod['deactivate']              = empty( $mod['deactivate'] );
2402
		$mod['free']                    = empty( $mod['free'] );
2403
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2404
2405
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2406
			$mod['auto_activate'] = 'No';
2407
		} else {
2408
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2409
		}
2410
2411
		if ( $mod['module_tags'] ) {
2412
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2413
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2414
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2415
		} else {
2416
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2417
		}
2418
2419
		if ( $mod['feature'] ) {
2420
			$mod['feature'] = explode( ',', $mod['feature'] );
2421
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2422
		} else {
2423
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2424
		}
2425
2426
		/**
2427
		 * Filters the feature array on a module.
2428
		 *
2429
		 * This filter allows you to control where each module is filtered: Recommended,
2430
		 * Jumpstart, and the default "Other" listing.
2431
		 *
2432
		 * @since 3.5.0
2433
		 *
2434
		 * @param array   $mod['feature'] The areas to feature this module:
2435
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2436
		 *     'Recommended' shows on the main Jetpack admin screen.
2437
		 *     'Other' should be the default if no other value is in the array.
2438
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2439
		 * @param array   $mod All the currently assembled module data.
2440
		 */
2441
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2442
2443
		/**
2444
		 * Filter the returned data about a module.
2445
		 *
2446
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2447
		 * so please be careful.
2448
		 *
2449
		 * @since 3.6.0
2450
		 *
2451
		 * @param array   $mod    The details of the requested module.
2452
		 * @param string  $module The slug of the module, e.g. sharedaddy
2453
		 * @param string  $file   The path to the module source file.
2454
		 */
2455
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2456
	}
2457
2458
	/**
2459
	 * Like core's get_file_data implementation, but caches the result.
2460
	 */
2461
	public static function get_file_data( $file, $headers ) {
2462
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2463
		$file_name = basename( $file );
2464
2465
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2466
2467
		$file_data_option = get_transient( $cache_key );
2468
2469
		if ( false === $file_data_option ) {
2470
			$file_data_option = array();
2471
		}
2472
2473
		$key           = md5( $file_name . serialize( $headers ) );
2474
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2475
2476
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2477
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2478
			return $file_data_option[ $key ];
2479
		}
2480
2481
		$data = get_file_data( $file, $headers );
2482
2483
		$file_data_option[ $key ] = $data;
2484
2485
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2486
2487
		return $data;
2488
	}
2489
2490
2491
	/**
2492
	 * Return translated module tag.
2493
	 *
2494
	 * @param string $tag Tag as it appears in each module heading.
2495
	 *
2496
	 * @return mixed
2497
	 */
2498
	public static function translate_module_tag( $tag ) {
2499
		return jetpack_get_module_i18n_tag( $tag );
2500
	}
2501
2502
	/**
2503
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2504
	 *
2505
	 * @since 3.9.2
2506
	 *
2507
	 * @param array $modules
2508
	 *
2509
	 * @return string|void
2510
	 */
2511
	public static function get_translated_modules( $modules ) {
2512
		foreach ( $modules as $index => $module ) {
2513
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2514
			if ( isset( $module['name'] ) ) {
2515
				$modules[ $index ]['name'] = $i18n_module['name'];
2516
			}
2517
			if ( isset( $module['description'] ) ) {
2518
				$modules[ $index ]['description'] = $i18n_module['description'];
2519
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2520
			}
2521
		}
2522
		return $modules;
2523
	}
2524
2525
	/**
2526
	 * Get a list of activated modules as an array of module slugs.
2527
	 */
2528
	public static function get_active_modules() {
2529
		$active = Jetpack_Options::get_option( 'active_modules' );
2530
2531
		if ( ! is_array( $active ) ) {
2532
			$active = array();
2533
		}
2534
2535
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2536
			$active[] = 'vaultpress';
2537
		} else {
2538
			$active = array_diff( $active, array( 'vaultpress' ) );
2539
		}
2540
2541
		//If protect is active on the main site of a multisite, it should be active on all sites.
2542
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2543
			$active[] = 'protect';
2544
		}
2545
2546
		return array_unique( $active );
2547
	}
2548
2549
	/**
2550
	 * Check whether or not a Jetpack module is active.
2551
	 *
2552
	 * @param string $module The slug of a Jetpack module.
2553
	 * @return bool
2554
	 *
2555
	 * @static
2556
	 */
2557
	public static function is_module_active( $module ) {
2558
		return in_array( $module, self::get_active_modules() );
2559
	}
2560
2561
	public static function is_module( $module ) {
2562
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2563
	}
2564
2565
	/**
2566
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2567
	 *
2568
	 * @param bool $catch True to start catching, False to stop.
2569
	 *
2570
	 * @static
2571
	 */
2572
	public static function catch_errors( $catch ) {
2573
		static $display_errors, $error_reporting;
2574
2575
		if ( $catch ) {
2576
			$display_errors  = @ini_set( 'display_errors', 1 );
2577
			$error_reporting = @error_reporting( E_ALL );
2578
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2579
		} else {
2580
			@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...
2581
			@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...
2582
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2583
		}
2584
	}
2585
2586
	/**
2587
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2588
	 */
2589
	public static function catch_errors_on_shutdown() {
2590
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2591
	}
2592
2593
	/**
2594
	 * Rewrite any string to make paths easier to read.
2595
	 *
2596
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2597
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2598
	 *
2599
	 * @param $string
2600
	 * @return mixed
2601
	 */
2602
	public static function alias_directories( $string ) {
2603
		// ABSPATH has a trailing slash.
2604
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2605
		// WP_CONTENT_DIR does not have a trailing slash.
2606
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2607
2608
		return $string;
2609
	}
2610
2611
	public static function activate_default_modules(
2612
		$min_version = false,
2613
		$max_version = false,
2614
		$other_modules = array(),
2615
		$redirect = true,
2616
		$send_state_messages = true
2617
	) {
2618
		$jetpack = Jetpack::init();
2619
2620
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2621
		$modules = array_merge( $other_modules, $modules );
2622
2623
		// Look for standalone plugins and disable if active.
2624
2625
		$to_deactivate = array();
2626
		foreach ( $modules as $module ) {
2627
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2628
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2629
			}
2630
		}
2631
2632
		$deactivated = array();
2633
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2634
			list( $probable_file, $probable_title ) = $deactivate_me;
2635
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2636
				$deactivated[] = $module;
2637
			}
2638
		}
2639
2640
		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...
2641
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2642
2643
			$url = add_query_arg(
2644
				array(
2645
					'action'   => 'activate_default_modules',
2646
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2647
				),
2648
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2649
			);
2650
			wp_safe_redirect( $url );
2651
			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...
2652
		}
2653
2654
		/**
2655
		 * Fires before default modules are activated.
2656
		 *
2657
		 * @since 1.9.0
2658
		 *
2659
		 * @param string $min_version Minimum version number required to use modules.
2660
		 * @param string $max_version Maximum version number required to use modules.
2661
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2662
		 */
2663
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2664
2665
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2666
		Jetpack::restate();
2667
		Jetpack::catch_errors( true );
2668
2669
		$active = Jetpack::get_active_modules();
2670
2671
		foreach ( $modules as $module ) {
2672
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2673
				$active[] = $module;
2674
				self::update_active_modules( $active );
2675
				continue;
2676
			}
2677
2678
			if ( $send_state_messages && in_array( $module, $active ) ) {
2679
				$module_info = Jetpack::get_module( $module );
2680 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2681
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2682
					if ( $active_state = Jetpack::state( $state ) ) {
2683
						$active_state = explode( ',', $active_state );
2684
					} else {
2685
						$active_state = array();
2686
					}
2687
					$active_state[] = $module;
2688
					Jetpack::state( $state, implode( ',', $active_state ) );
2689
				}
2690
				continue;
2691
			}
2692
2693
			$file = Jetpack::get_module_path( $module );
2694
			if ( ! file_exists( $file ) ) {
2695
				continue;
2696
			}
2697
2698
			// we'll override this later if the plugin can be included without fatal error
2699
			if ( $redirect ) {
2700
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2701
			}
2702
2703
			if ( $send_state_messages ) {
2704
				Jetpack::state( 'error', 'module_activation_failed' );
2705
				Jetpack::state( 'module', $module );
2706
			}
2707
2708
			ob_start();
2709
			require $file;
2710
2711
			$active[] = $module;
2712
2713 View Code Duplication
			if ( $send_state_messages ) {
2714
2715
				$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...
2716
				if ( $active_state = Jetpack::state( $state ) ) {
2717
					$active_state = explode( ',', $active_state );
2718
				} else {
2719
					$active_state = array();
2720
				}
2721
				$active_state[] = $module;
2722
				Jetpack::state( $state, implode( ',', $active_state ) );
2723
			}
2724
2725
			Jetpack::update_active_modules( $active );
2726
2727
			ob_end_clean();
2728
		}
2729
2730
		if ( $send_state_messages ) {
2731
			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...
2732
			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...
2733
		}
2734
2735
		Jetpack::catch_errors( false );
2736
		/**
2737
		 * Fires when default modules are activated.
2738
		 *
2739
		 * @since 1.9.0
2740
		 *
2741
		 * @param string $min_version Minimum version number required to use modules.
2742
		 * @param string $max_version Maximum version number required to use modules.
2743
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2744
		 */
2745
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2746
	}
2747
2748
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2749
		/**
2750
		 * Fires before a module is activated.
2751
		 *
2752
		 * @since 2.6.0
2753
		 *
2754
		 * @param string $module Module slug.
2755
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2756
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2757
		 */
2758
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2759
2760
		$jetpack = Jetpack::init();
2761
2762
		if ( ! strlen( $module ) )
2763
			return false;
2764
2765
		if ( ! Jetpack::is_module( $module ) )
2766
			return false;
2767
2768
		// If it's already active, then don't do it again
2769
		$active = Jetpack::get_active_modules();
2770
		foreach ( $active as $act ) {
2771
			if ( $act == $module )
2772
				return true;
2773
		}
2774
2775
		$module_data = Jetpack::get_module( $module );
2776
2777
		if ( ! Jetpack::is_active() ) {
2778
			if ( !Jetpack::is_development_mode() )
2779
				return false;
2780
2781
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2782
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2783
				return false;
2784
		}
2785
2786
		// Check and see if the old plugin is active
2787
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2788
			// Deactivate the old plugin
2789
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2790
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2791
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2792
				Jetpack::state( 'deactivated_plugins', $module );
2793
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2794
				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...
2795
			}
2796
		}
2797
2798
		// Protect won't work with mis-configured IPs
2799
		if ( 'protect' === $module ) {
2800
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2801
			if ( ! jetpack_protect_get_ip() ) {
2802
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2803
				return false;
2804
			}
2805
		}
2806
2807
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2808
		Jetpack::state( 'module', $module );
2809
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2810
2811
		Jetpack::catch_errors( true );
2812
		ob_start();
2813
		require Jetpack::get_module_path( $module );
2814
		/** This action is documented in class.jetpack.php */
2815
		do_action( 'jetpack_activate_module', $module );
2816
		$active[] = $module;
2817
		Jetpack::update_active_modules( $active );
2818
2819
		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...
2820
		ob_end_clean();
2821
		Jetpack::catch_errors( false );
2822
2823
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2824 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2825
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2826
2827
			//Jump start is being dismissed send data to MC Stats
2828
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2829
2830
			$jetpack->do_stats( 'server_side' );
2831
		}
2832
2833
		if ( $redirect ) {
2834
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2835
		}
2836
		if ( $exit ) {
2837
			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...
2838
		}
2839
		return true;
2840
	}
2841
2842
	function activate_module_actions( $module ) {
2843
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2844
	}
2845
2846
	public static function deactivate_module( $module ) {
2847
		/**
2848
		 * Fires when a module is deactivated.
2849
		 *
2850
		 * @since 1.9.0
2851
		 *
2852
		 * @param string $module Module slug.
2853
		 */
2854
		do_action( 'jetpack_pre_deactivate_module', $module );
2855
2856
		$jetpack = Jetpack::init();
2857
2858
		$active = Jetpack::get_active_modules();
2859
		$new    = array_filter( array_diff( $active, (array) $module ) );
2860
2861
		// A flag for Jump Start so it's not shown again.
2862 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2863
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2864
2865
			//Jump start is being dismissed send data to MC Stats
2866
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2867
2868
			$jetpack->do_stats( 'server_side' );
2869
		}
2870
2871
		return self::update_active_modules( $new );
2872
	}
2873
2874
	public static function enable_module_configurable( $module ) {
2875
		$module = Jetpack::get_module_slug( $module );
2876
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2877
	}
2878
2879
	public static function module_configuration_url( $module ) {
2880
		$module = Jetpack::get_module_slug( $module );
2881
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2882
	}
2883
2884
	public static function module_configuration_load( $module, $method ) {
2885
		$module = Jetpack::get_module_slug( $module );
2886
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2887
	}
2888
2889
	public static function module_configuration_head( $module, $method ) {
2890
		$module = Jetpack::get_module_slug( $module );
2891
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2892
	}
2893
2894
	public static function module_configuration_screen( $module, $method ) {
2895
		$module = Jetpack::get_module_slug( $module );
2896
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2897
	}
2898
2899
	public static function module_configuration_activation_screen( $module, $method ) {
2900
		$module = Jetpack::get_module_slug( $module );
2901
		add_action( 'display_activate_module_setting_' . $module, $method );
2902
	}
2903
2904
/* Installation */
2905
2906
	public static function bail_on_activation( $message, $deactivate = true ) {
2907
?>
2908
<!doctype html>
2909
<html>
2910
<head>
2911
<meta charset="<?php bloginfo( 'charset' ); ?>">
2912
<style>
2913
* {
2914
	text-align: center;
2915
	margin: 0;
2916
	padding: 0;
2917
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2918
}
2919
p {
2920
	margin-top: 1em;
2921
	font-size: 18px;
2922
}
2923
</style>
2924
<body>
2925
<p><?php echo esc_html( $message ); ?></p>
2926
</body>
2927
</html>
2928
<?php
2929
		if ( $deactivate ) {
2930
			$plugins = get_option( 'active_plugins' );
2931
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2932
			$update  = false;
2933
			foreach ( $plugins as $i => $plugin ) {
2934
				if ( $plugin === $jetpack ) {
2935
					$plugins[$i] = false;
2936
					$update = true;
2937
				}
2938
			}
2939
2940
			if ( $update ) {
2941
				update_option( 'active_plugins', array_filter( $plugins ) );
2942
			}
2943
		}
2944
		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...
2945
	}
2946
2947
	/**
2948
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2949
	 * @static
2950
	 */
2951
	public static function plugin_activation( $network_wide ) {
2952
		Jetpack_Options::update_option( 'activated', 1 );
2953
2954
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2955
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2956
		}
2957
2958
		if ( $network_wide )
2959
			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...
2960
2961
		// For firing one-off events (notices) immediately after activation
2962
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2963
2964
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2965
2966
		Jetpack::plugin_initialize();
2967
	}
2968
2969
	public static function get_activation_source( $referer_url ) {
2970
2971
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2972
			return array( 'wp-cli', null );
2973
		}
2974
2975
		$referer = parse_url( $referer_url );
2976
2977
		$source_type = 'unknown';
2978
		$source_query = null;
2979
2980
		if ( ! is_array( $referer ) ) {
2981
			return array( $source_type, $source_query );
2982
		}
2983
2984
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
2985
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
2986
2987
		if ( isset( $referer['query'] ) ) {
2988
			parse_str( $referer['query'], $query_parts );
2989
		} else {
2990
			$query_parts = array();
2991
		}
2992
2993
		if ( $plugins_path === $referer['path'] ) {
2994
			$source_type = 'list';
2995
		} elseif ( $plugins_install_path === $referer['path'] ) {
2996
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
2997
			switch( $tab ) {
2998
				case 'popular':
2999
					$source_type = 'popular';
3000
					break;
3001
				case 'recommended':
3002
					$source_type = 'recommended';
3003
					break;
3004
				case 'favorites':
3005
					$source_type = 'favorites';
3006
					break;
3007
				case 'search':
3008
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3009
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3010
					break;
3011
				default:
3012
					$source_type = 'featured';
3013
			}
3014
		}
3015
3016
		return array( $source_type, $source_query );
3017
	}
3018
3019
	/**
3020
	 * Runs before bumping version numbers up to a new version
3021
	 * @param  string $version    Version:timestamp
3022
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3023
	 * @return null              [description]
3024
	 */
3025
	public static function do_version_bump( $version, $old_version ) {
3026
3027
		if ( ! $old_version ) { // For new sites
3028
			// Setting up jetpack manage
3029
			Jetpack::activate_manage();
3030
		}
3031
	}
3032
3033
	/**
3034
	 * Sets the internal version number and activation state.
3035
	 * @static
3036
	 */
3037
	public static function plugin_initialize() {
3038
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3039
			Jetpack_Options::update_option( 'activated', 2 );
3040
		}
3041
3042 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3043
			$version = $old_version = JETPACK__VERSION . ':' . time();
3044
			/** This action is documented in class.jetpack.php */
3045
			do_action( 'updating_jetpack_version', $version, false );
3046
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3047
		}
3048
3049
		Jetpack::load_modules();
3050
3051
		Jetpack_Options::delete_option( 'do_activate' );
3052
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3053
	}
3054
3055
	/**
3056
	 * Removes all connection options
3057
	 * @static
3058
	 */
3059
	public static function plugin_deactivation( ) {
3060
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3061
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3062
			Jetpack_Network::init()->deactivate();
3063
		} else {
3064
			Jetpack::disconnect( false );
3065
			//Jetpack_Heartbeat::init()->deactivate();
3066
		}
3067
	}
3068
3069
	/**
3070
	 * Disconnects from the Jetpack servers.
3071
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3072
	 * @static
3073
	 */
3074
	public static function disconnect( $update_activated_state = true ) {
3075
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3076
		Jetpack::clean_nonces( true );
3077
3078
		// If the site is in an IDC because sync is not allowed,
3079
		// let's make sure to not disconnect the production site.
3080
		if ( ! self::validate_sync_error_idc_option() ) {
3081
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3082
			Jetpack::load_xml_rpc_client();
3083
			$xml = new Jetpack_IXR_Client();
3084
			$xml->query( 'jetpack.deregister' );
3085
		}
3086
3087
		Jetpack_Options::delete_option(
3088
			array(
3089
				'blog_token',
3090
				'user_token',
3091
				'user_tokens',
3092
				'master_user',
3093
				'time_diff',
3094
				'fallback_no_verify_ssl_certs',
3095
			)
3096
		);
3097
3098
		Jetpack_IDC::clear_all_idc_options();
3099
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3100
3101
		if ( $update_activated_state ) {
3102
			Jetpack_Options::update_option( 'activated', 4 );
3103
		}
3104
3105
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3106
			// Check then record unique disconnection if site has never been disconnected previously
3107
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3108
				$jetpack_unique_connection['disconnected'] = 1;
3109
			} else {
3110
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3111
					//track unique disconnect
3112
					$jetpack = Jetpack::init();
3113
3114
					$jetpack->stat( 'connections', 'unique-disconnect' );
3115
					$jetpack->do_stats( 'server_side' );
3116
				}
3117
				// increment number of times disconnected
3118
				$jetpack_unique_connection['disconnected'] += 1;
3119
			}
3120
3121
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3122
		}
3123
3124
		// Delete cached connected user data
3125
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3126
		delete_transient( $transient_key );
3127
3128
		// Delete all the sync related data. Since it could be taking up space.
3129
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3130
		Jetpack_Sync_Sender::get_instance()->uninstall();
3131
3132
		// Disable the Heartbeat cron
3133
		Jetpack_Heartbeat::init()->deactivate();
3134
	}
3135
3136
	/**
3137
	 * Unlinks the current user from the linked WordPress.com user
3138
	 */
3139
	public static function unlink_user( $user_id = null ) {
3140
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3141
			return false;
3142
3143
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3144
3145
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3146
			return false;
3147
3148
		if ( ! isset( $tokens[ $user_id ] ) )
3149
			return false;
3150
3151
		Jetpack::load_xml_rpc_client();
3152
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3153
		$xml->query( 'jetpack.unlink_user', $user_id );
3154
3155
		unset( $tokens[ $user_id ] );
3156
3157
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3158
3159
		/**
3160
		 * Fires after the current user has been unlinked from WordPress.com.
3161
		 *
3162
		 * @since 4.1.0
3163
		 *
3164
		 * @param int $user_id The current user's ID.
3165
		 */
3166
		do_action( 'jetpack_unlinked_user', $user_id );
3167
3168
		return true;
3169
	}
3170
3171
	/**
3172
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3173
	 */
3174
	public static function try_registration() {
3175
		// Let's get some testing in beta versions and such.
3176
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3177
			// Before attempting to connect, let's make sure that the domains are viable.
3178
			$domains_to_check = array_unique( array(
3179
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3180
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3181
			) );
3182
			foreach ( $domains_to_check as $domain ) {
3183
				$result = Jetpack_Data::is_usable_domain( $domain );
3184
				if ( is_wp_error( $result ) ) {
3185
					return $result;
3186
				}
3187
			}
3188
		}
3189
3190
		$result = Jetpack::register();
3191
3192
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3193
		if ( ! $result || is_wp_error( $result ) ) {
3194
			return $result;
3195
		} else {
3196
			return true;
3197
		}
3198
	}
3199
3200
	/**
3201
	 * Tracking an internal event log. Try not to put too much chaff in here.
3202
	 *
3203
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3204
	 */
3205
	public static function log( $code, $data = null ) {
3206
		// only grab the latest 200 entries
3207
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3208
3209
		// Append our event to the log
3210
		$log_entry = array(
3211
			'time'    => time(),
3212
			'user_id' => get_current_user_id(),
3213
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3214
			'code'    => $code,
3215
		);
3216
		// Don't bother storing it unless we've got some.
3217
		if ( ! is_null( $data ) ) {
3218
			$log_entry['data'] = $data;
3219
		}
3220
		$log[] = $log_entry;
3221
3222
		// Try add_option first, to make sure it's not autoloaded.
3223
		// @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...
3224
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3225
			Jetpack_Options::update_option( 'log', $log );
3226
		}
3227
3228
		/**
3229
		 * Fires when Jetpack logs an internal event.
3230
		 *
3231
		 * @since 3.0.0
3232
		 *
3233
		 * @param array $log_entry {
3234
		 *	Array of details about the log entry.
3235
		 *
3236
		 *	@param string time Time of the event.
3237
		 *	@param int user_id ID of the user who trigerred the event.
3238
		 *	@param int blog_id Jetpack Blog ID.
3239
		 *	@param string code Unique name for the event.
3240
		 *	@param string data Data about the event.
3241
		 * }
3242
		 */
3243
		do_action( 'jetpack_log_entry', $log_entry );
3244
	}
3245
3246
	/**
3247
	 * Get the internal event log.
3248
	 *
3249
	 * @param $event (string) - only return the specific log events
3250
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3251
	 *
3252
	 * @return array of log events || WP_Error for invalid params
3253
	 */
3254
	public static function get_log( $event = false, $num = false ) {
3255
		if ( $event && ! is_string( $event ) ) {
3256
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3257
		}
3258
3259
		if ( $num && ! is_numeric( $num ) ) {
3260
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3261
		}
3262
3263
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3264
3265
		// If nothing set - act as it did before, otherwise let's start customizing the output
3266
		if ( ! $num && ! $event ) {
3267
			return $entire_log;
3268
		} else {
3269
			$entire_log = array_reverse( $entire_log );
3270
		}
3271
3272
		$custom_log_output = array();
3273
3274
		if ( $event ) {
3275
			foreach ( $entire_log as $log_event ) {
3276
				if ( $event == $log_event[ 'code' ] ) {
3277
					$custom_log_output[] = $log_event;
3278
				}
3279
			}
3280
		} else {
3281
			$custom_log_output = $entire_log;
3282
		}
3283
3284
		if ( $num ) {
3285
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3286
		}
3287
3288
		return $custom_log_output;
3289
	}
3290
3291
	/**
3292
	 * Log modification of important settings.
3293
	 */
3294
	public static function log_settings_change( $option, $old_value, $value ) {
3295
		switch( $option ) {
3296
			case 'jetpack_sync_non_public_post_stati':
3297
				self::log( $option, $value );
3298
				break;
3299
		}
3300
	}
3301
3302
	/**
3303
	 * Return stat data for WPCOM sync
3304
	 */
3305
	public static function get_stat_data( $encode = true, $extended = true ) {
3306
		$data = Jetpack_Heartbeat::generate_stats_array();
3307
3308
		if ( $extended ) {
3309
			$additional_data = self::get_additional_stat_data();
3310
			$data = array_merge( $data, $additional_data );
3311
		}
3312
3313
		if ( $encode ) {
3314
			return json_encode( $data );
3315
		}
3316
3317
		return $data;
3318
	}
3319
3320
	/**
3321
	 * Get additional stat data to sync to WPCOM
3322
	 */
3323
	public static function get_additional_stat_data( $prefix = '' ) {
3324
		$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...
3325
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3326
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3327
		$return["{$prefix}site-count"]     = 0;
3328
3329
		if ( function_exists( 'get_blog_count' ) ) {
3330
			$return["{$prefix}site-count"] = get_blog_count();
3331
		}
3332
		return $return;
3333
	}
3334
3335
	private static function get_site_user_count() {
3336
		global $wpdb;
3337
3338
		if ( function_exists( 'wp_is_large_network' ) ) {
3339
			if ( wp_is_large_network( 'users' ) ) {
3340
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3341
			}
3342
		}
3343 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3344
			// It wasn't there, so regenerate the data and save the transient
3345
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3346
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3347
		}
3348
		return $user_count;
3349
	}
3350
3351
	/* Admin Pages */
3352
3353
	function admin_init() {
3354
		// If the plugin is not connected, display a connect message.
3355
		if (
3356
			// the plugin was auto-activated and needs its candy
3357
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3358
		||
3359
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3360
			! Jetpack_Options::get_option( 'activated' )
3361
		) {
3362
			Jetpack::plugin_initialize();
3363
		}
3364
3365
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3366
			Jetpack_Connection_Banner::init();
3367
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3368
			// Upgrade: 1.1 -> 1.1.1
3369
			// Check and see if host can verify the Jetpack servers' SSL certificate
3370
			$args = array();
3371
			Jetpack_Client::_wp_remote_request(
3372
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3373
				$args,
3374
				true
3375
			);
3376
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3377
			// Show the notice on the Dashboard only for now
3378
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3379
		}
3380
3381
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3382
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3383
		}
3384
3385
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3386
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3387
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3388
3389
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3390
			// Artificially throw errors in certain whitelisted cases during plugin activation
3391
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3392
		}
3393
3394
		// Jetpack Manage Activation Screen from .com
3395
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3396
3397
		// Add custom column in wp-admin/users.php to show whether user is linked.
3398
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3399
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3400
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3401
	}
3402
3403
	function admin_body_class( $admin_body_class = '' ) {
3404
		$classes = explode( ' ', trim( $admin_body_class ) );
3405
3406
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3407
3408
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3409
		return " $admin_body_class ";
3410
	}
3411
3412
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3413
		return $admin_body_class . ' jetpack-pagestyles ';
3414
	}
3415
3416
	/**
3417
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3418
	 *
3419
	 * @return null
3420
	 */
3421
	function prepare_manage_jetpack_notice() {
3422
3423
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3424
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3425
	}
3426
3427
	function manage_activate_screen() {
3428
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3429
	}
3430
	/**
3431
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3432
	 * This function artificially throws errors for such cases (whitelisted).
3433
	 *
3434
	 * @param string $plugin The activated plugin.
3435
	 */
3436
	function throw_error_on_activate_plugin( $plugin ) {
3437
		$active_modules = Jetpack::get_active_modules();
3438
3439
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3440
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3441
			$throw = false;
3442
3443
			// Try and make sure it really was the stats plugin
3444
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3445
				if ( 'stats.php' == basename( $plugin ) ) {
3446
					$throw = true;
3447
				}
3448
			} else {
3449
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3450
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3451
					$throw = true;
3452
				}
3453
			}
3454
3455
			if ( $throw ) {
3456
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3457
			}
3458
		}
3459
	}
3460
3461
	function intercept_plugin_error_scrape_init() {
3462
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3463
	}
3464
3465
	function intercept_plugin_error_scrape( $action, $result ) {
3466
		if ( ! $result ) {
3467
			return;
3468
		}
3469
3470
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3471
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3472
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3473
			}
3474
		}
3475
	}
3476
3477
	function add_remote_request_handlers() {
3478
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3479
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3480
	}
3481
3482
	function remote_request_handlers() {
3483
		$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...
3484
3485
		switch ( current_filter() ) {
3486
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3487
			$response = $this->upload_handler();
3488
			break;
3489
3490
		case 'wp_ajax_nopriv_jetpack_update_file' :
3491
			$response = $this->upload_handler( true );
3492
			break;
3493
		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...
3494
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3495
			break;
3496
		}
3497
3498
		if ( ! $response ) {
3499
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3500
		}
3501
3502
		if ( is_wp_error( $response ) ) {
3503
			$status_code       = $response->get_error_data();
3504
			$error             = $response->get_error_code();
3505
			$error_description = $response->get_error_message();
3506
3507
			if ( ! is_int( $status_code ) ) {
3508
				$status_code = 400;
3509
			}
3510
3511
			status_header( $status_code );
3512
			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...
3513
		}
3514
3515
		status_header( 200 );
3516
		if ( true === $response ) {
3517
			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...
3518
		}
3519
3520
		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...
3521
	}
3522
3523
	/**
3524
	 * Uploads a file gotten from the global $_FILES.
3525
	 * If `$update_media_item` is true and `post_id` is defined
3526
	 * the attachment file of the media item (gotten through of the post_id)
3527
	 * will be updated instead of add a new one.
3528
	 *
3529
	 * @param  boolean $update_media_item - update media attachment
3530
	 * @return array - An array describing the uploadind files process
3531
	 */
3532
	function upload_handler( $update_media_item = false ) {
3533
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3534
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3535
		}
3536
3537
		$user = wp_authenticate( '', '' );
3538
		if ( ! $user || is_wp_error( $user ) ) {
3539
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3540
		}
3541
3542
		wp_set_current_user( $user->ID );
3543
3544
		if ( ! current_user_can( 'upload_files' ) ) {
3545
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3546
		}
3547
3548
		if ( empty( $_FILES ) ) {
3549
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3550
		}
3551
3552
		foreach ( array_keys( $_FILES ) as $files_key ) {
3553
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3554
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3555
			}
3556
		}
3557
3558
		$media_keys = array_keys( $_FILES['media'] );
3559
3560
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3561
		if ( ! $token || is_wp_error( $token ) ) {
3562
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3563
		}
3564
3565
		$uploaded_files = array();
3566
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3567
		unset( $GLOBALS['post'] );
3568
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3569
			$file = array();
3570
			foreach ( $media_keys as $media_key ) {
3571
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3572
			}
3573
3574
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3575
3576
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3577
			if ( $hmac_provided !== $hmac_file ) {
3578
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3579
				continue;
3580
			}
3581
3582
			$_FILES['.jetpack.upload.'] = $file;
3583
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3584
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3585
				$post_id = 0;
3586
			}
3587
3588
			if ( $update_media_item ) {
3589
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3590
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3591
				}
3592
3593
				$media_array = $_FILES['media'];
3594
3595
				$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...
3596
				$file_array['type'] = $media_array['type'][0];
3597
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3598
				$file_array['error'] = $media_array['error'][0];
3599
				$file_array['size'] = $media_array['size'][0];
3600
3601
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3602
3603
				if ( is_wp_error( $edited_media_item ) ) {
3604
					return $edited_media_item;
3605
				}
3606
3607
				$response = (object) array(
3608
					'id'   => (string) $post_id,
3609
					'file' => (string) $edited_media_item->post_title,
3610
					'url'  => (string) wp_get_attachment_url( $post_id ),
3611
					'type' => (string) $edited_media_item->post_mime_type,
3612
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3613
				);
3614
3615
				return (array) array( $response );
3616
			}
3617
3618
			$attachment_id = media_handle_upload(
3619
				'.jetpack.upload.',
3620
				$post_id,
3621
				array(),
3622
				array(
3623
					'action' => 'jetpack_upload_file',
3624
				)
3625
			);
3626
3627
			if ( ! $attachment_id ) {
3628
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3629
			} elseif ( is_wp_error( $attachment_id ) ) {
3630
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3631
			} else {
3632
				$attachment = get_post( $attachment_id );
3633
				$uploaded_files[$index] = (object) array(
3634
					'id'   => (string) $attachment_id,
3635
					'file' => $attachment->post_title,
3636
					'url'  => wp_get_attachment_url( $attachment_id ),
3637
					'type' => $attachment->post_mime_type,
3638
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3639
				);
3640
				// Zip files uploads are not supported unless they are done for installation purposed
3641
				// lets delete them in case something goes wrong in this whole process
3642
				if ( 'application/zip' === $attachment->post_mime_type ) {
3643
					// Schedule a cleanup for 2 hours from now in case of failed install.
3644
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3645
				}
3646
			}
3647
		}
3648
		if ( ! is_null( $global_post ) ) {
3649
			$GLOBALS['post'] = $global_post;
3650
		}
3651
3652
		return $uploaded_files;
3653
	}
3654
3655
	/**
3656
	 * Add help to the Jetpack page
3657
	 *
3658
	 * @since Jetpack (1.2.3)
3659
	 * @return false if not the Jetpack page
3660
	 */
3661
	function admin_help() {
3662
		$current_screen = get_current_screen();
3663
3664
		// Overview
3665
		$current_screen->add_help_tab(
3666
			array(
3667
				'id'		=> 'home',
3668
				'title'		=> __( 'Home', 'jetpack' ),
3669
				'content'	=>
3670
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3671
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3672
					'<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>',
3673
			)
3674
		);
3675
3676
		// Screen Content
3677
		if ( current_user_can( 'manage_options' ) ) {
3678
			$current_screen->add_help_tab(
3679
				array(
3680
					'id'		=> 'settings',
3681
					'title'		=> __( 'Settings', 'jetpack' ),
3682
					'content'	=>
3683
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3684
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3685
						'<ol>' .
3686
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3687
							'<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>' .
3688
						'</ol>' .
3689
						'<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>'
3690
				)
3691
			);
3692
		}
3693
3694
		// Help Sidebar
3695
		$current_screen->set_help_sidebar(
3696
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3697
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3698
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3699
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3700
		);
3701
	}
3702
3703
	function admin_menu_css() {
3704
		wp_enqueue_style( 'jetpack-icons' );
3705
	}
3706
3707
	function admin_menu_order() {
3708
		return true;
3709
	}
3710
3711 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3712
		$jp_menu_order = array();
3713
3714
		foreach ( $menu_order as $index => $item ) {
3715
			if ( $item != 'jetpack' ) {
3716
				$jp_menu_order[] = $item;
3717
			}
3718
3719
			if ( $index == 0 ) {
3720
				$jp_menu_order[] = 'jetpack';
3721
			}
3722
		}
3723
3724
		return $jp_menu_order;
3725
	}
3726
3727
	function admin_head() {
3728 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3729
			/** This action is documented in class.jetpack-admin-page.php */
3730
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3731
	}
3732
3733
	function admin_banner_styles() {
3734
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3735
3736 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3737
			wp_register_style(
3738
				'jetpack-dops-style',
3739
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3740
				array(),
3741
				JETPACK__VERSION
3742
			);
3743
		}
3744
3745
		wp_enqueue_style(
3746
			'jetpack',
3747
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3748
			array( 'jetpack-dops-style' ),
3749
			 JETPACK__VERSION . '-20121016'
3750
		);
3751
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3752
		wp_style_add_data( 'jetpack', 'suffix', $min );
3753
	}
3754
3755
	function plugin_action_links( $actions ) {
3756
3757
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3758
3759
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3760
			return array_merge(
3761
				$jetpack_home,
3762
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3763
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3764
				$actions
3765
				);
3766
			}
3767
3768
		return array_merge( $jetpack_home, $actions );
3769
	}
3770
3771
	/**
3772
	 * This is the first banner
3773
	 * It should be visible only to user that can update the option
3774
	 * Are not connected
3775
	 *
3776
	 * @return null
3777
	 */
3778
	function admin_jetpack_manage_notice() {
3779
		$screen = get_current_screen();
3780
3781
		// Don't show the connect notice on the jetpack settings page.
3782
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3783
			return;
3784
		}
3785
3786
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3787
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3788
		/**
3789
		 * I think it would be great to have different wordsing depending on where you are
3790
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3791
		 * etc..
3792
		 */
3793
3794
		?>
3795
		<div id="message" class="updated jp-banner">
3796
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3797
				<div class="jp-banner__description-container">
3798
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3799
					<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>
3800
					<p class="jp-banner__button-container">
3801
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3802
						<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>
3803
					</p>
3804
				</div>
3805
		</div>
3806
		<?php
3807
	}
3808
3809
	/**
3810
	 * Returns the url that the user clicks to remove the notice for the big banner
3811
	 * @return string
3812
	 */
3813
	function opt_out_jetpack_manage_url() {
3814
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3815
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3816
	}
3817
	/**
3818
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3819
	 * @return string
3820
	 */
3821
	function opt_in_jetpack_manage_url() {
3822
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3823
	}
3824
3825
	function opt_in_jetpack_manage_notice() {
3826
		?>
3827
		<div class="wrap">
3828
			<div id="message" class="jetpack-message is-opt-in">
3829
				<?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' ); ?>
3830
			</div>
3831
		</div>
3832
		<?php
3833
3834
	}
3835
	/**
3836
	 * Determines whether to show the notice of not true = display notice
3837
	 * @return bool
3838
	 */
3839
	function can_display_jetpack_manage_notice() {
3840
		// never display the notice to users that can't do anything about it anyways
3841
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3842
			return false;
3843
3844
		// don't display if we are in development more
3845
		if( Jetpack::is_development_mode() ) {
3846
			return false;
3847
		}
3848
		// don't display if the site is private
3849
		if(  ! Jetpack_Options::get_option( 'public' ) )
3850
			return false;
3851
3852
		/**
3853
		 * Should the Jetpack Remote Site Management notice be displayed.
3854
		 *
3855
		 * @since 3.3.0
3856
		 *
3857
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3858
		 */
3859
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3860
	}
3861
3862
	/*
3863
	 * Registration flow:
3864
	 * 1 - ::admin_page_load() action=register
3865
	 * 2 - ::try_registration()
3866
	 * 3 - ::register()
3867
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3868
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3869
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3870
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3871
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3872
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3873
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3874
	 *       jetpack_id, jetpack_secret, jetpack_public
3875
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3876
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3877
	 * 5 - user logs in with WP.com account
3878
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3879
	 *		- Jetpack_Client_Server::authorize()
3880
	 *		- Jetpack_Client_Server::get_token()
3881
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3882
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3883
	 *			- which responds with access_token, token_type, scope
3884
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3885
	 *		- Jetpack::activate_default_modules()
3886
	 *     		- Deactivates deprecated plugins
3887
	 *     		- Activates all default modules
3888
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3889
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3890
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3891
	 *     Done!
3892
	 */
3893
3894
	/**
3895
	 * Handles the page load events for the Jetpack admin page
3896
	 */
3897
	function admin_page_load() {
3898
		$error = false;
3899
3900
		// Make sure we have the right body class to hook stylings for subpages off of.
3901
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3902
3903
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3904
			// Should only be used in intermediate redirects to preserve state across redirects
3905
			Jetpack::restate();
3906
		}
3907
3908
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3909
			// User clicked in the iframe to link their accounts
3910
			if ( ! Jetpack::is_user_connected() ) {
3911
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3912
				if ( isset( $_GET['notes_iframe'] ) )
3913
					$connect_url .= '&notes_iframe';
3914
				wp_redirect( $connect_url );
3915
				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...
3916
			} else {
3917
				if ( ! isset( $_GET['calypso_env'] ) ) {
3918
					Jetpack::state( 'message', 'already_authorized' );
3919
					wp_safe_redirect( Jetpack::admin_url() );
3920
					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...
3921
				} else {
3922
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3923
					$connect_url .= '&already_authorized=true';
3924
					wp_redirect( $connect_url );
3925
					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...
3926
				}
3927
			}
3928
		}
3929
3930
3931
		if ( isset( $_GET['action'] ) ) {
3932
			switch ( $_GET['action'] ) {
3933
			case 'authorize':
3934
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3935
					Jetpack::state( 'message', 'already_authorized' );
3936
					wp_safe_redirect( Jetpack::admin_url() );
3937
					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...
3938
				}
3939
				Jetpack::log( 'authorize' );
3940
				$client_server = new Jetpack_Client_Server;
3941
				$client_server->client_authorize();
3942
				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...
3943
			case 'register' :
3944
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3945
					$error = 'cheatin';
3946
					break;
3947
				}
3948
				check_admin_referer( 'jetpack-register' );
3949
				Jetpack::log( 'register' );
3950
				Jetpack::maybe_set_version_option();
3951
				$registered = Jetpack::try_registration();
3952
				if ( is_wp_error( $registered ) ) {
3953
					$error = $registered->get_error_code();
3954
					Jetpack::state( 'error', $error );
3955
					Jetpack::state( 'error', $registered->get_error_message() );
3956
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3957
						'error_code' => $error,
3958
						'error_message' => $registered->get_error_message()
3959
					) );
3960
					break;
3961
				}
3962
3963
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3964
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3965
3966
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3967
					'from' => $from
3968
				) );
3969
3970
				$url = $this->build_connect_url( true, $redirect, $from );
3971
3972
				if ( ! empty( $_GET['onboarding'] ) ) {
3973
					$url = add_query_arg( 'onboarding', sanitize_key( $_GET['onboarding'] ), $url );
3974
				}
3975
3976
				wp_redirect( $url );
3977
				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...
3978
			case 'activate' :
3979
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3980
					$error = 'cheatin';
3981
					break;
3982
				}
3983
3984
				$module = stripslashes( $_GET['module'] );
3985
				check_admin_referer( "jetpack_activate-$module" );
3986
				Jetpack::log( 'activate', $module );
3987
				Jetpack::activate_module( $module );
3988
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3989
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3990
				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...
3991
			case 'activate_default_modules' :
3992
				check_admin_referer( 'activate_default_modules' );
3993
				Jetpack::log( 'activate_default_modules' );
3994
				Jetpack::restate();
3995
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3996
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3997
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3998
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3999
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4000
				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...
4001
			case 'disconnect' :
4002
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4003
					$error = 'cheatin';
4004
					break;
4005
				}
4006
4007
				check_admin_referer( 'jetpack-disconnect' );
4008
				Jetpack::log( 'disconnect' );
4009
				Jetpack::disconnect();
4010
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4011
				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...
4012
			case 'reconnect' :
4013
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4014
					$error = 'cheatin';
4015
					break;
4016
				}
4017
4018
				check_admin_referer( 'jetpack-reconnect' );
4019
				Jetpack::log( 'reconnect' );
4020
				$this->disconnect();
4021
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4022
				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...
4023 View Code Duplication
			case 'deactivate' :
4024
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4025
					$error = 'cheatin';
4026
					break;
4027
				}
4028
4029
				$modules = stripslashes( $_GET['module'] );
4030
				check_admin_referer( "jetpack_deactivate-$modules" );
4031
				foreach ( explode( ',', $modules ) as $module ) {
4032
					Jetpack::log( 'deactivate', $module );
4033
					Jetpack::deactivate_module( $module );
4034
					Jetpack::state( 'message', 'module_deactivated' );
4035
				}
4036
				Jetpack::state( 'module', $modules );
4037
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4038
				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...
4039
			case 'unlink' :
4040
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4041
				check_admin_referer( 'jetpack-unlink' );
4042
				Jetpack::log( 'unlink' );
4043
				$this->unlink_user();
4044
				Jetpack::state( 'message', 'unlinked' );
4045
				if ( 'sub-unlink' == $redirect ) {
4046
					wp_safe_redirect( admin_url() );
4047
				} else {
4048
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4049
				}
4050
				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...
4051
			case 'onboard' :
4052
				if ( ! current_user_can( 'manage_options' ) ) {
4053
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4054
				} else {
4055
					Jetpack::create_onboarding_token();
4056
					$url = $this->build_connect_url( true );
4057
4058
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4059
						$url = add_query_arg( 'onboarding', $token, $url );
4060
					}
4061
4062
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4063
					if ( $calypso_env ) {
4064
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4065
					}
4066
4067
					wp_redirect( $url );
4068
					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...
4069
				}
4070
				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...
4071
			default:
4072
				/**
4073
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4074
				 *
4075
				 * @since 2.6.0
4076
				 *
4077
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4078
				 */
4079
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4080
			}
4081
		}
4082
4083
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4084
			self::activate_new_modules( true );
4085
		}
4086
4087
		$message_code = Jetpack::state( 'message' );
4088
		if ( Jetpack::state( 'optin-manage' ) ) {
4089
			$activated_manage = $message_code;
4090
			$message_code = 'jetpack-manage';
4091
		}
4092
4093
		switch ( $message_code ) {
4094
		case 'jetpack-manage':
4095
			$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>';
4096
			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...
4097
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4098
			}
4099
			break;
4100
4101
		}
4102
4103
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4104
4105
		if ( ! empty( $deactivated_plugins ) ) {
4106
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4107
			$deactivated_titles  = array();
4108
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4109
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4110
					continue;
4111
				}
4112
4113
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4114
			}
4115
4116
			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...
4117
				if ( $this->message ) {
4118
					$this->message .= "<br /><br />\n";
4119
				}
4120
4121
				$this->message .= wp_sprintf(
4122
					_n(
4123
						'Jetpack contains the most recent version of the old %l plugin.',
4124
						'Jetpack contains the most recent versions of the old %l plugins.',
4125
						count( $deactivated_titles ),
4126
						'jetpack'
4127
					),
4128
					$deactivated_titles
4129
				);
4130
4131
				$this->message .= "<br />\n";
4132
4133
				$this->message .= _n(
4134
					'The old version has been deactivated and can be removed from your site.',
4135
					'The old versions have been deactivated and can be removed from your site.',
4136
					count( $deactivated_titles ),
4137
					'jetpack'
4138
				);
4139
			}
4140
		}
4141
4142
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4143
4144
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4145
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4146
		}
4147
4148 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4149
			/**
4150
			 * Fires when a module configuration page is loaded.
4151
			 * The dynamic part of the hook is the configure parameter from the URL.
4152
			 *
4153
			 * @since 1.1.0
4154
			 */
4155
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4156
		}
4157
4158
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4159
	}
4160
4161
	function admin_notices() {
4162
4163
		if ( $this->error ) {
4164
?>
4165
<div id="message" class="jetpack-message jetpack-err">
4166
	<div class="squeezer">
4167
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4168
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4169
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4170
<?php	endif; ?>
4171
	</div>
4172
</div>
4173
<?php
4174
		}
4175
4176
		if ( $this->message ) {
4177
?>
4178
<div id="message" class="jetpack-message">
4179
	<div class="squeezer">
4180
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4181
	</div>
4182
</div>
4183
<?php
4184
		}
4185
4186
		if ( $this->privacy_checks ) :
4187
			$module_names = $module_slugs = array();
4188
4189
			$privacy_checks = explode( ',', $this->privacy_checks );
4190
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4191
			foreach ( $privacy_checks as $module_slug ) {
4192
				$module = Jetpack::get_module( $module_slug );
4193
				if ( ! $module ) {
4194
					continue;
4195
				}
4196
4197
				$module_slugs[] = $module_slug;
4198
				$module_names[] = "<strong>{$module['name']}</strong>";
4199
			}
4200
4201
			$module_slugs = join( ',', $module_slugs );
4202
?>
4203
<div id="message" class="jetpack-message jetpack-err">
4204
	<div class="squeezer">
4205
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4206
		<p><?php
4207
			echo wp_kses(
4208
				wptexturize(
4209
					wp_sprintf(
4210
						_nx(
4211
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4212
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4213
							count( $privacy_checks ),
4214
							'%l = list of Jetpack module/feature names',
4215
							'jetpack'
4216
						),
4217
						$module_names
4218
					)
4219
				),
4220
				array( 'strong' => true )
4221
			);
4222
4223
			echo "\n<br />\n";
4224
4225
			echo wp_kses(
4226
				sprintf(
4227
					_nx(
4228
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4229
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4230
						count( $privacy_checks ),
4231
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4232
						'jetpack'
4233
					),
4234
					wp_nonce_url(
4235
						Jetpack::admin_url(
4236
							array(
4237
								'page'   => 'jetpack',
4238
								'action' => 'deactivate',
4239
								'module' => urlencode( $module_slugs ),
4240
							)
4241
						),
4242
						"jetpack_deactivate-$module_slugs"
4243
					),
4244
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4245
				),
4246
				array( 'a' => array( 'href' => true, 'title' => true ) )
4247
			);
4248
		?></p>
4249
	</div>
4250
</div>
4251
<?php endif;
4252
	// only display the notice if the other stuff is not there
4253
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4254
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4255
			$this->opt_in_jetpack_manage_notice();
4256
		}
4257
	}
4258
4259
	/**
4260
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4261
	 */
4262
	function stat( $group, $detail ) {
4263
		if ( ! isset( $this->stats[ $group ] ) )
4264
			$this->stats[ $group ] = array();
4265
		$this->stats[ $group ][] = $detail;
4266
	}
4267
4268
	/**
4269
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4270
	 */
4271
	function do_stats( $method = '' ) {
4272
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4273
			foreach ( $this->stats as $group => $stats ) {
4274
				if ( is_array( $stats ) && count( $stats ) ) {
4275
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4276
					if ( 'server_side' === $method ) {
4277
						self::do_server_side_stat( $args );
4278
					} else {
4279
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4280
					}
4281
				}
4282
				unset( $this->stats[ $group ] );
4283
			}
4284
		}
4285
	}
4286
4287
	/**
4288
	 * Runs stats code for a one-off, server-side.
4289
	 *
4290
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4291
	 *
4292
	 * @return bool If it worked.
4293
	 */
4294
	static function do_server_side_stat( $args ) {
4295
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4296
		if ( is_wp_error( $response ) )
4297
			return false;
4298
4299
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4300
			return false;
4301
4302
		return true;
4303
	}
4304
4305
	/**
4306
	 * Builds the stats url.
4307
	 *
4308
	 * @param $args array|string The arguments to append to the URL.
4309
	 *
4310
	 * @return string The URL to be pinged.
4311
	 */
4312
	static function build_stats_url( $args ) {
4313
		$defaults = array(
4314
			'v'    => 'wpcom2',
4315
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4316
		);
4317
		$args     = wp_parse_args( $args, $defaults );
4318
		/**
4319
		 * Filter the URL used as the Stats tracking pixel.
4320
		 *
4321
		 * @since 2.3.2
4322
		 *
4323
		 * @param string $url Base URL used as the Stats tracking pixel.
4324
		 */
4325
		$base_url = apply_filters(
4326
			'jetpack_stats_base_url',
4327
			'https://pixel.wp.com/g.gif'
4328
		);
4329
		$url      = add_query_arg( $args, $base_url );
4330
		return $url;
4331
	}
4332
4333
	static function translate_current_user_to_role() {
4334
		foreach ( self::$capability_translations as $role => $cap ) {
4335
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4336
				return $role;
4337
			}
4338
		}
4339
4340
		return false;
4341
	}
4342
4343
	static function translate_user_to_role( $user ) {
4344
		foreach ( self::$capability_translations as $role => $cap ) {
4345
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4346
				return $role;
4347
			}
4348
		}
4349
4350
		return false;
4351
    }
4352
4353
	static function translate_role_to_cap( $role ) {
4354
		if ( ! isset( self::$capability_translations[$role] ) ) {
4355
			return false;
4356
		}
4357
4358
		return self::$capability_translations[$role];
4359
	}
4360
4361
	static function sign_role( $role, $user_id = null ) {
4362
		if ( empty( $user_id ) ) {
4363
			$user_id = (int) get_current_user_id();
4364
		}
4365
4366
		if ( ! $user_id  ) {
4367
			return false;
4368
		}
4369
4370
		$token = Jetpack_Data::get_access_token();
4371
		if ( ! $token || is_wp_error( $token ) ) {
4372
			return false;
4373
		}
4374
4375
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4376
	}
4377
4378
4379
	/**
4380
	 * Builds a URL to the Jetpack connection auth page
4381
	 *
4382
	 * @since 3.9.5
4383
	 *
4384
	 * @param bool $raw If true, URL will not be escaped.
4385
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4386
	 *                              If string, will be a custom redirect.
4387
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4388
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4389
	 *
4390
	 * @return string Connect URL
4391
	 */
4392
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4393
		$site_id = Jetpack_Options::get_option( 'id' );
4394
		$token = Jetpack_Options::get_option( 'blog_token' );
4395
4396
		if ( $register || ! $token || ! $site_id ) {
4397
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4398
4399
			if ( ! empty( $redirect ) ) {
4400
				$url = add_query_arg(
4401
					'redirect',
4402
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4403
					$url
4404
				);
4405
			}
4406
4407
			if( is_network_admin() ) {
4408
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4409
			}
4410
		} else {
4411
4412
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4413
			// because otherwise this logic can get us in to a loop.
4414
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4415
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4416
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4417
4418
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4419
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4420
					'1.1'
4421
				);
4422
4423
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4424
					// Generating a register URL instead to refresh the existing token
4425
					return $this->build_connect_url( $raw, $redirect, $from, true );
4426
				}
4427
			}
4428
4429
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4430
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4431
			}
4432
4433
			$role = self::translate_current_user_to_role();
4434
			$signed_role = self::sign_role( $role );
4435
4436
			$user = wp_get_current_user();
4437
4438
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4439
			$redirect = $redirect
4440
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4441
				: $jetpack_admin_page;
4442
4443
			if( isset( $_REQUEST['is_multisite'] ) ) {
4444
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4445
			}
4446
4447
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4448
4449
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4450
				? get_site_icon_url()
4451
				: false;
4452
4453
			/**
4454
			 * Filter the type of authorization.
4455
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4456
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4457
			 *
4458
			 * @since 4.3.3
4459
			 *
4460
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4461
			 */
4462
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4463
4464
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4465
4466
			$args = urlencode_deep(
4467
				array(
4468
					'response_type' => 'code',
4469
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4470
					'redirect_uri'  => add_query_arg(
4471
						array(
4472
							'action'   => 'authorize',
4473
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4474
							'redirect' => urlencode( $redirect ),
4475
						),
4476
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4477
					),
4478
					'state'         => $user->ID,
4479
					'scope'         => $signed_role,
4480
					'user_email'    => $user->user_email,
4481
					'user_login'    => $user->user_login,
4482
					'is_active'     => Jetpack::is_active(),
4483
					'jp_version'    => JETPACK__VERSION,
4484
					'auth_type'     => $auth_type,
4485
					'secret'        => $secrets['secret_1'],
4486
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4487
					'blogname'      => get_option( 'blogname' ),
4488
					'site_url'      => site_url(),
4489
					'home_url'      => home_url(),
4490
					'site_icon'     => $site_icon,
4491
					'site_lang'     => get_locale(),
4492
					'_ui'           => $tracks_identity['_ui'],
4493
					'_ut'           => $tracks_identity['_ut']
4494
				)
4495
			);
4496
4497
			self::apply_activation_source_to_args( $args );
4498
4499
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4500
		}
4501
4502
		if ( $from ) {
4503
			$url = add_query_arg( 'from', $from, $url );
4504
		}
4505
4506
4507
		if ( isset( $_GET['calypso_env'] ) ) {
4508
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4509
		}
4510
4511
		return $raw ? $url : esc_url( $url );
4512
	}
4513
4514
	public static function apply_activation_source_to_args( &$args ) {
4515
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4516
4517
		if ( $activation_source_name ) {
4518
			$args['_as'] = urlencode( $activation_source_name );
4519
		}
4520
4521
		if ( $activation_source_keyword ) {
4522
			$args['_ak'] = urlencode( $activation_source_keyword );
4523
		}
4524
	}
4525
4526
	function build_reconnect_url( $raw = false ) {
4527
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4528
		return $raw ? $url : esc_url( $url );
4529
	}
4530
4531
	public static function admin_url( $args = null ) {
4532
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4533
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4534
		return $url;
4535
	}
4536
4537
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4538
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4539
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4540
	}
4541
4542
	function dismiss_jetpack_notice() {
4543
4544
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4545
			return;
4546
		}
4547
4548
		switch( $_GET['jetpack-notice'] ) {
4549
			case 'dismiss':
4550
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4551
4552
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4553
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4554
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4555
				}
4556
				break;
4557 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...
4558
4559
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4560
					// Don't show the banner again
4561
4562
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4563
					// redirect back to the page that had the notice
4564
					if ( wp_get_referer() ) {
4565
						wp_safe_redirect( wp_get_referer() );
4566
					} else {
4567
						// Take me to Jetpack
4568
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4569
					}
4570
				}
4571
				break;
4572 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...
4573
4574
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4575
					// Don't show the banner again
4576
4577
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4578
					// redirect back to the page that had the notice
4579
					if ( wp_get_referer() ) {
4580
						wp_safe_redirect( wp_get_referer() );
4581
					} else {
4582
						// Take me to Jetpack
4583
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4584
					}
4585
				}
4586
				break;
4587
			case 'jetpack-manage-opt-in':
4588
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4589
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4590
4591
					$redirection_url = Jetpack::admin_url();
4592
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4593
4594
					// Don't redirect form the Jetpack Setting Page
4595
					$referer_parsed = parse_url ( wp_get_referer() );
4596
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4597
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4598
						// Take the user to Jetpack home except when on the setting page
4599
						$redirection_url = wp_get_referer();
4600
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4601
					}
4602
					// Also update the JSON API FULL MANAGEMENT Option
4603
					Jetpack::activate_module( 'manage', false, false );
4604
4605
					// Special Message when option in.
4606
					Jetpack::state( 'optin-manage', 'true' );
4607
					// Activate the Module if not activated already
4608
4609
					// Redirect properly
4610
					wp_safe_redirect( $redirection_url );
4611
4612
				}
4613
				break;
4614
		}
4615
	}
4616
4617
	public static function admin_screen_configure_module( $module_id ) {
4618
4619
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4620
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4621
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4622
				/**
4623
				 * Fires to diplay a custom module activation screen.
4624
				 *
4625
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4626
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4627
				 *
4628
				 * @module manage
4629
				 *
4630
				 * @since 3.8.0
4631
				 *
4632
				 * @param int $module_id Module ID.
4633
				 */
4634
				do_action( 'display_activate_module_setting_' . $module_id );
4635
			} else {
4636
				self::display_activate_module_link( $module_id );
4637
			}
4638
4639
			return false;
4640
		} ?>
4641
4642
		<div id="jp-settings-screen" style="position: relative">
4643
			<h3>
4644
			<?php
4645
				$module = Jetpack::get_module( $module_id );
4646
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4647
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4648
			?>
4649
			</h3>
4650
			<?php
4651
				/**
4652
				 * Fires within the displayed message when a feature configuation is updated.
4653
				 *
4654
				 * @since 3.4.0
4655
				 *
4656
				 * @param int $module_id Module ID.
4657
				 */
4658
				do_action( 'jetpack_notices_update_settings', $module_id );
4659
				/**
4660
				 * Fires when a feature configuation screen is loaded.
4661
				 * The dynamic part of the hook, $module_id, is the module ID.
4662
				 *
4663
				 * @since 1.1.0
4664
				 */
4665
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4666
			?>
4667
		</div><?php
4668
	}
4669
4670
	/**
4671
	 * Display link to activate the module to see the settings screen.
4672
	 * @param  string $module_id
4673
	 * @return null
4674
	 */
4675
	public static function display_activate_module_link( $module_id ) {
4676
4677
		$info =  Jetpack::get_module( $module_id );
4678
		$extra = '';
4679
		$activate_url = wp_nonce_url(
4680
				Jetpack::admin_url(
4681
					array(
4682
						'page'   => 'jetpack',
4683
						'action' => 'activate',
4684
						'module' => $module_id,
4685
					)
4686
				),
4687
				"jetpack_activate-$module_id"
4688
			);
4689
4690
		?>
4691
4692
		<div class="wrap configure-module">
4693
			<div id="jp-settings-screen">
4694
				<?php
4695
				if ( $module_id == 'json-api' ) {
4696
4697
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4698
4699
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4700
4701
					$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' );
4702
4703
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4704
				} ?>
4705
4706
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4707
				<div class="narrow">
4708
					<p><?php echo  $info['description']; ?></p>
4709
					<?php if( $extra ) { ?>
4710
					<p><?php echo esc_html( $extra ); ?></p>
4711
					<?php } ?>
4712
					<p>
4713
						<?php
4714
						if( wp_get_referer() ) {
4715
							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() );
4716
						} else {
4717
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4718
						} ?>
4719
					</p>
4720
				</div>
4721
4722
			</div>
4723
		</div>
4724
4725
		<?php
4726
	}
4727
4728
	public static function sort_modules( $a, $b ) {
4729
		if ( $a['sort'] == $b['sort'] )
4730
			return 0;
4731
4732
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4733
	}
4734
4735
	function ajax_recheck_ssl() {
4736
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4737
		$result = Jetpack::permit_ssl( true );
4738
		wp_send_json( array(
4739
			'enabled' => $result,
4740
			'message' => get_transient( 'jetpack_https_test_message' )
4741
		) );
4742
	}
4743
4744
/* Client API */
4745
4746
	/**
4747
	 * Returns the requested Jetpack API URL
4748
	 *
4749
	 * @return string
4750
	 */
4751
	public static function api_url( $relative_url ) {
4752
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4753
	}
4754
4755
	/**
4756
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4757
	 */
4758
	public static function fix_url_for_bad_hosts( $url ) {
4759
		if ( 0 !== strpos( $url, 'https://' ) ) {
4760
			return $url;
4761
		}
4762
4763
		switch ( JETPACK_CLIENT__HTTPS ) {
4764
			case 'ALWAYS' :
4765
				return $url;
4766
			case 'NEVER' :
4767
				return set_url_scheme( $url, 'http' );
4768
			// default : case 'AUTO' :
4769
		}
4770
4771
		// we now return the unmodified SSL URL by default, as a security precaution
4772
		return $url;
4773
	}
4774
4775
	/**
4776
	 * Create a random secret for validating onboarding payload
4777
	 *
4778
	 * @return string Secret token
4779
	 */
4780
	public static function create_onboarding_token() {
4781
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4782
			$token = wp_generate_password( 32, false );
4783
			Jetpack_Options::update_option( 'onboarding', $token );
4784
		}
4785
4786
		return $token;
4787
	}
4788
4789
	/**
4790
	 * Remove the onboarding token
4791
	 *
4792
	 * @return bool True on success, false on failure
4793
	 */
4794
	public static function invalidate_onboarding_token() {
4795
		return Jetpack_Options::delete_option( 'onboarding' );
4796
	}
4797
4798
	/**
4799
	 * Validate an onboarding token for a specific action
4800
	 *
4801
	 * @return boolean True if token/action pair is accepted, false if not
4802
	 */
4803
	public static function validate_onboarding_token_action( $token, $action ) {
4804
		// Compare tokens, bail if tokens do not match
4805
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4806
			return false;
4807
		}
4808
4809
		// List of valid actions we can take
4810
		$valid_actions = array(
4811
			'/jetpack/v4/settings',
4812
		);
4813
4814
		// Whitelist the action
4815
		if ( ! in_array( $action, $valid_actions ) ) {
4816
			return false;
4817
		}
4818
4819
		return true;
4820
	}
4821
4822
	/**
4823
	 * Checks to see if the URL is using SSL to connect with Jetpack
4824
	 *
4825
	 * @since 2.3.3
4826
	 * @return boolean
4827
	 */
4828
	public static function permit_ssl( $force_recheck = false ) {
4829
		// Do some fancy tests to see if ssl is being supported
4830
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4831
			$message = '';
4832
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4833
				$ssl = 0;
4834
			} else {
4835
				switch ( JETPACK_CLIENT__HTTPS ) {
4836
					case 'NEVER':
4837
						$ssl = 0;
4838
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4839
						break;
4840
					case 'ALWAYS':
4841
					case 'AUTO':
4842
					default:
4843
						$ssl = 1;
4844
						break;
4845
				}
4846
4847
				// If it's not 'NEVER', test to see
4848
				if ( $ssl ) {
4849
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4850
						$ssl = 0;
4851
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4852
					} else {
4853
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4854
						if ( is_wp_error( $response ) ) {
4855
							$ssl = 0;
4856
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4857
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4858
							$ssl = 0;
4859
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4860
						}
4861
					}
4862
				}
4863
			}
4864
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4865
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4866
		}
4867
4868
		return (bool) $ssl;
4869
	}
4870
4871
	/*
4872
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4873
	 */
4874
	public function alert_auto_ssl_fail() {
4875
		if ( ! current_user_can( 'manage_options' ) )
4876
			return;
4877
4878
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4879
		?>
4880
4881
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4882
			<div class="jp-banner__content">
4883
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4884
				<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>
4885
				<p>
4886
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4887
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4888
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4889
				</p>
4890
				<p>
4891
					<?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' ),
4892
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4893
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4894
				</p>
4895
			</div>
4896
		</div>
4897
		<style>
4898
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4899
		</style>
4900
		<script type="text/javascript">
4901
			jQuery( document ).ready( function( $ ) {
4902
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4903
					var $this = $( this );
4904
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4905
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4906
					e.preventDefault();
4907
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4908
					$.post( ajaxurl, data )
4909
					  .done( function( response ) {
4910
					  	if ( response.enabled ) {
4911
					  		$( '#jetpack-ssl-warning' ).hide();
4912
					  	} else {
4913
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4914
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4915
					  	}
4916
					  }.bind( $this ) );
4917
				} );
4918
			} );
4919
		</script>
4920
4921
		<?php
4922
	}
4923
4924
	/**
4925
	 * Returns the Jetpack XML-RPC API
4926
	 *
4927
	 * @return string
4928
	 */
4929
	public static function xmlrpc_api_url() {
4930
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4931
		return untrailingslashit( $base ) . '/xmlrpc.php';
4932
	}
4933
4934
	/**
4935
	 * Creates two secret tokens and the end of life timestamp for them.
4936
	 *
4937
	 * Note these tokens are unique per call, NOT static per site for connecting.
4938
	 *
4939
	 * @since 2.6
4940
	 * @return array
4941
	 */
4942
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4943
		if ( ! $user_id ) {
4944
			$user_id = get_current_user_id();
4945
		}
4946
4947
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4948
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4949
4950
		if (
4951
			isset( $secrets[ $secret_name ] ) &&
4952
			$secrets[ $secret_name ]['exp'] > time()
4953
		) {
4954
			return $secrets[ $secret_name ];
4955
		}
4956
4957
		$secret_value = array(
4958
			'secret_1'  => wp_generate_password( 32, false ),
4959
			'secret_2'  => wp_generate_password( 32, false ),
4960
			'exp'       => time() + $exp,
4961
		);
4962
4963
		$secrets[ $secret_name ] = $secret_value;
4964
4965
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4966
		return $secrets[ $secret_name ];
4967
	}
4968
4969
	public static function get_secrets( $action, $user_id ) {
4970
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4971
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4972
4973
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4974
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4975
		}
4976
4977
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4978
			self::delete_secrets( $action, $user_id );
4979
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4980
		}
4981
4982
		return $secrets[ $secret_name ];
4983
	}
4984
4985
	public static function delete_secrets( $action, $user_id ) {
4986
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4987
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4988
		if ( isset( $secrets[ $secret_name ] ) ) {
4989
			unset( $secrets[ $secret_name ] );
4990
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4991
		}
4992
	}
4993
4994
	/**
4995
	 * Builds the timeout limit for queries talking with the wpcom servers.
4996
	 *
4997
	 * Based on local php max_execution_time in php.ini
4998
	 *
4999
	 * @since 2.6
5000
	 * @return int
5001
	 * @deprecated
5002
	 **/
5003
	public function get_remote_query_timeout_limit() {
5004
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5005
		return Jetpack::get_max_execution_time();
5006
	}
5007
5008
	/**
5009
	 * Builds the timeout limit for queries talking with the wpcom servers.
5010
	 *
5011
	 * Based on local php max_execution_time in php.ini
5012
	 *
5013
	 * @since 5.4
5014
	 * @return int
5015
	 **/
5016
	public static function get_max_execution_time() {
5017
		$timeout = (int) ini_get( 'max_execution_time' );
5018
5019
		// Ensure exec time set in php.ini
5020
		if ( ! $timeout ) {
5021
			$timeout = 30;
5022
		}
5023
		return $timeout;
5024
	}
5025
5026
	/**
5027
	 * Sets a minimum request timeout, and returns the current timeout
5028
	 *
5029
	 * @since 5.4
5030
	 **/
5031
	public static function set_min_time_limit( $min_timeout ) {
5032
		$timeout = self::get_max_execution_time();
5033
		if ( $timeout < $min_timeout ) {
5034
			$timeout = $min_timeout;
5035
			set_time_limit( $timeout );
5036
		}
5037
		return $timeout;
5038
	}
5039
5040
5041
	/**
5042
	 * Takes the response from the Jetpack register new site endpoint and
5043
	 * verifies it worked properly.
5044
	 *
5045
	 * @since 2.6
5046
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5047
	 **/
5048
	public function validate_remote_register_response( $response ) {
5049
	  if ( is_wp_error( $response ) ) {
5050
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5051
		}
5052
5053
		$code   = wp_remote_retrieve_response_code( $response );
5054
		$entity = wp_remote_retrieve_body( $response );
5055
		if ( $entity )
5056
			$registration_response = json_decode( $entity );
5057
		else
5058
			$registration_response = false;
5059
5060
		$code_type = intval( $code / 100 );
5061
		if ( 5 == $code_type ) {
5062
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5063
		} elseif ( 408 == $code ) {
5064
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5065
		} elseif ( ! empty( $registration_response->error ) ) {
5066
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5067
				$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' );
5068
			} else {
5069
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5070
			}
5071
5072
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5073
		} elseif ( 200 != $code ) {
5074
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5075
		}
5076
5077
		// Jetpack ID error block
5078
		if ( empty( $registration_response->jetpack_id ) ) {
5079
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5080
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5081
			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 );
5082
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5083
			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 );
5084
		}
5085
5086
	    return $registration_response;
5087
	}
5088
	/**
5089
	 * @return bool|WP_Error
5090
	 */
5091
	public static function register() {
5092
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5093
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5094
		$secrets = Jetpack::generate_secrets( 'register' );
5095
5096 View Code Duplication
		if (
5097
			empty( $secrets['secret_1'] ) ||
5098
			empty( $secrets['secret_2'] ) ||
5099
			empty( $secrets['exp'] )
5100
		) {
5101
			return new Jetpack_Error( 'missing_secrets' );
5102
		}
5103
5104
		// better to try (and fail) to set a higher timeout than this system
5105
		// supports than to have register fail for more users than it should
5106
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5107
5108
		$gmt_offset = get_option( 'gmt_offset' );
5109
		if ( ! $gmt_offset ) {
5110
			$gmt_offset = 0;
5111
		}
5112
5113
		$stats_options = get_option( 'stats_options' );
5114
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5115
5116
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5117
5118
		$args = array(
5119
			'method'  => 'POST',
5120
			'body'    => array(
5121
				'siteurl'         => site_url(),
5122
				'home'            => home_url(),
5123
				'gmt_offset'      => $gmt_offset,
5124
				'timezone_string' => (string) get_option( 'timezone_string' ),
5125
				'site_name'       => (string) get_option( 'blogname' ),
5126
				'secret_1'        => $secrets['secret_1'],
5127
				'secret_2'        => $secrets['secret_2'],
5128
				'site_lang'       => get_locale(),
5129
				'timeout'         => $timeout,
5130
				'stats_id'        => $stats_id,
5131
				'state'           => get_current_user_id(),
5132
				'_ui'             => $tracks_identity['_ui'],
5133
				'_ut'             => $tracks_identity['_ut'],
5134
				'jetpack_version' => JETPACK__VERSION
5135
			),
5136
			'headers' => array(
5137
				'Accept' => 'application/json',
5138
			),
5139
			'timeout' => $timeout,
5140
		);
5141
5142
		self::apply_activation_source_to_args( $args['body'] );
5143
5144
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5145
5146
		// Make sure the response is valid and does not contain any Jetpack errors
5147
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5148
		if ( is_wp_error( $registration_details ) ) {
5149
			return $registration_details;
5150
		} elseif ( ! $registration_details ) {
5151
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5152
		}
5153
5154 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5155
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5156
		}
5157
5158
		if ( isset( $registration_details->jetpack_public ) ) {
5159
			$jetpack_public = (int) $registration_details->jetpack_public;
5160
		} else {
5161
			$jetpack_public = false;
5162
		}
5163
5164
		Jetpack_Options::update_options(
5165
			array(
5166
				'id'         => (int)    $registration_details->jetpack_id,
5167
				'blog_token' => (string) $registration_details->jetpack_secret,
5168
				'public'     => $jetpack_public,
5169
			)
5170
		);
5171
5172
		/**
5173
		 * Fires when a site is registered on WordPress.com.
5174
		 *
5175
		 * @since 3.7.0
5176
		 *
5177
		 * @param int $json->jetpack_id Jetpack Blog ID.
5178
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5179
		 * @param int|bool $jetpack_public Is the site public.
5180
		 */
5181
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5182
5183
		// Initialize Jump Start for the first and only time.
5184
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5185
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5186
5187
			$jetpack = Jetpack::init();
5188
5189
			$jetpack->stat( 'jumpstart', 'unique-views' );
5190
			$jetpack->do_stats( 'server_side' );
5191
		};
5192
5193
		return true;
5194
	}
5195
5196
	/**
5197
	 * If the db version is showing something other that what we've got now, bump it to current.
5198
	 *
5199
	 * @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...
5200
	 */
5201
	public static function maybe_set_version_option() {
5202
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5203
		if ( JETPACK__VERSION != $version ) {
5204
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5205
5206
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5207
				/** This action is documented in class.jetpack.php */
5208
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5209
			}
5210
5211
			return true;
5212
		}
5213
		return false;
5214
	}
5215
5216
/* Client Server API */
5217
5218
	/**
5219
	 * Loads the Jetpack XML-RPC client
5220
	 */
5221
	public static function load_xml_rpc_client() {
5222
		require_once ABSPATH . WPINC . '/class-IXR.php';
5223
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5224
	}
5225
5226
	/**
5227
	 * Resets the saved authentication state in between testing requests.
5228
	 */
5229
	public function reset_saved_auth_state() {
5230
		$this->xmlrpc_verification = null;
5231
		$this->rest_authentication_status = null;
5232
	}
5233
5234
	function verify_xml_rpc_signature() {
5235
		if ( $this->xmlrpc_verification ) {
5236
			return $this->xmlrpc_verification;
5237
		}
5238
5239
		// It's not for us
5240
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5241
			return false;
5242
		}
5243
5244
		@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...
5245
		if (
5246
			empty( $token_key )
5247
		||
5248
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5249
		) {
5250
			return false;
5251
		}
5252
5253
		if ( '0' === $user_id ) {
5254
			$token_type = 'blog';
5255
			$user_id = 0;
5256
		} else {
5257
			$token_type = 'user';
5258
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5259
				return false;
5260
			}
5261
			$user_id = (int) $user_id;
5262
5263
			$user = new WP_User( $user_id );
5264
			if ( ! $user || ! $user->exists() ) {
5265
				return false;
5266
			}
5267
		}
5268
5269
		$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...
5270
		if ( ! $token ) {
5271
			return false;
5272
		}
5273
5274
		$token_check = "$token_key.";
5275
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5276
			return false;
5277
		}
5278
5279
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5280
5281
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5282
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5283
			$post_data   = $_POST;
5284
			$file_hashes = array();
5285
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5286
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5287
					continue;
5288
				}
5289
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5290
				$file_hashes[$post_data_key] = $post_data_value;
5291
			}
5292
5293
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5294
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5295
				$post_data[$post_data_key] = $post_data_value;
5296
			}
5297
5298
			ksort( $post_data );
5299
5300
			$body = http_build_query( stripslashes_deep( $post_data ) );
5301
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5302
			$body = file_get_contents( 'php://input' );
5303
		} else {
5304
			$body = null;
5305
		}
5306
5307
		$signature = $jetpack_signature->sign_current_request(
5308
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5309
		);
5310
5311
		if ( ! $signature ) {
5312
			return false;
5313
		} else if ( is_wp_error( $signature ) ) {
5314
			return $signature;
5315
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5316
			return false;
5317
		}
5318
5319
		$timestamp = (int) $_GET['timestamp'];
5320
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5321
5322
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5323
			return false;
5324
		}
5325
5326
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5327
		if ( isset( $this->HTTP_RAW_POST_DATA ) ) {
5328
			$jpo = json_decode( $this->HTTP_RAW_POST_DATA );
5329
			if (
5330
				isset( $jpo->onboarding ) &&
5331
				isset( $jpo->onboarding->jpUser ) && isset( $jpo->onboarding->token ) &&
5332
				is_email( $jpo->onboarding->jpUser ) && ctype_alnum( $jpo->onboarding->token ) &&
5333
				isset( $_GET['rest_route'] ) &&
5334
				self::validate_onboarding_token_action( $jpo->onboarding->token, $_GET['rest_route'] )
5335
			) {
5336
				$jpUser = get_user_by( 'email', $jpo->onboarding->jpUser );
5337
				if ( is_a( $jpUser, 'WP_User' ) ) {
5338
					wp_set_current_user( $jpUser->ID );
5339
					$user_can = is_multisite()
5340
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5341
						: current_user_can( 'manage_options' );
5342
					if ( $user_can ) {
5343
						$token_type = 'user';
5344
						$token->external_user_id = $jpUser->ID;
5345
					}
5346
				}
5347
			}
5348
		}
5349
5350
		$this->xmlrpc_verification = array(
5351
			'type'    => $token_type,
5352
			'user_id' => $token->external_user_id,
5353
		);
5354
5355
		return $this->xmlrpc_verification;
5356
	}
5357
5358
	/**
5359
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5360
	 */
5361
	function authenticate_jetpack( $user, $username, $password ) {
5362
		if ( is_a( $user, 'WP_User' ) ) {
5363
			return $user;
5364
		}
5365
5366
		$token_details = $this->verify_xml_rpc_signature();
5367
5368
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5369
			return $user;
5370
		}
5371
5372
		if ( 'user' !== $token_details['type'] ) {
5373
			return $user;
5374
		}
5375
5376
		if ( ! $token_details['user_id'] ) {
5377
			return $user;
5378
		}
5379
5380
		nocache_headers();
5381
5382
		return new WP_User( $token_details['user_id'] );
5383
	}
5384
5385
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5386
	// Uses the existing XMLRPC request signing implementation.
5387
	function wp_rest_authenticate( $user ) {
5388
		if ( ! empty( $user ) ) {
5389
			// Another authentication method is in effect.
5390
			return $user;
5391
		}
5392
5393
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5394
			// Nothing to do for this authentication method.
5395
			return null;
5396
		}
5397
5398
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5399
			// Nothing to do for this authentication method.
5400
			return null;
5401
		}
5402
5403
		// Ensure that we always have the request body available.  At this
5404
		// point, the WP REST API code to determine the request body has not
5405
		// run yet.  That code may try to read from 'php://input' later, but
5406
		// this can only be done once per request in PHP versions prior to 5.6.
5407
		// So we will go ahead and perform this read now if needed, and save
5408
		// the request body where both the Jetpack signature verification code
5409
		// and the WP REST API code can see it.
5410
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5411
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5412
		}
5413
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5414
5415
		// Only support specific request parameters that have been tested and
5416
		// are known to work with signature verification.  A different method
5417
		// can be passed to the WP REST API via the '?_method=' parameter if
5418
		// needed.
5419
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5420
			$this->rest_authentication_status = new WP_Error(
5421
				'rest_invalid_request',
5422
				__( 'This request method is not supported.', 'jetpack' ),
5423
				array( 'status' => 400 )
5424
			);
5425
			return null;
5426
		}
5427
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5428
			$this->rest_authentication_status = new WP_Error(
5429
				'rest_invalid_request',
5430
				__( 'This request method does not support body parameters.', 'jetpack' ),
5431
				array( 'status' => 400 )
5432
			);
5433
			return null;
5434
		}
5435
5436
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5437
			$content_type = $_SERVER['CONTENT_TYPE'];
5438
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5439
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5440
		}
5441
5442
		if (
5443
			isset( $content_type ) &&
5444
			$content_type !== 'application/x-www-form-urlencoded' &&
5445
			$content_type !== 'application/json'
5446
		) {
5447
			$this->rest_authentication_status = new WP_Error(
5448
				'rest_invalid_request',
5449
				__( 'This Content-Type is not supported.', 'jetpack' ),
5450
				array( 'status' => 400 )
5451
			);
5452
			return null;
5453
		}
5454
5455
		$verified = $this->verify_xml_rpc_signature();
5456
5457
		if ( is_wp_error( $verified ) ) {
5458
			$this->rest_authentication_status = $verified;
5459
			return null;
5460
		}
5461
5462
		if (
5463
			$verified &&
5464
			isset( $verified['type'] ) &&
5465
			'user' === $verified['type'] &&
5466
			! empty( $verified['user_id'] )
5467
		) {
5468
			// Authentication successful.
5469
			$this->rest_authentication_status = true;
5470
			return $verified['user_id'];
5471
		}
5472
5473
		// Something else went wrong.  Probably a signature error.
5474
		$this->rest_authentication_status = new WP_Error(
5475
			'rest_invalid_signature',
5476
			__( 'The request is not signed correctly.', 'jetpack' ),
5477
			array( 'status' => 400 )
5478
		);
5479
		return null;
5480
	}
5481
5482
	/**
5483
	 * Report authentication status to the WP REST API.
5484
	 *
5485
	 * @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...
5486
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5487
	 */
5488
	public function wp_rest_authentication_errors( $value ) {
5489
		if ( $value !== null ) {
5490
			return $value;
5491
		}
5492
		return $this->rest_authentication_status;
5493
	}
5494
5495
	function add_nonce( $timestamp, $nonce ) {
5496
		global $wpdb;
5497
		static $nonces_used_this_request = array();
5498
5499
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5500
			return $nonces_used_this_request["$timestamp:$nonce"];
5501
		}
5502
5503
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5504
		$timestamp = (int) $timestamp;
5505
		$nonce     = esc_sql( $nonce );
5506
5507
		// Raw query so we can avoid races: add_option will also update
5508
		$show_errors = $wpdb->show_errors( false );
5509
5510
		$old_nonce = $wpdb->get_row(
5511
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5512
		);
5513
5514
		if ( is_null( $old_nonce ) ) {
5515
			$return = $wpdb->query(
5516
				$wpdb->prepare(
5517
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5518
					"jetpack_nonce_{$timestamp}_{$nonce}",
5519
					time(),
5520
					'no'
5521
				)
5522
			);
5523
		} else {
5524
			$return = false;
5525
		}
5526
5527
		$wpdb->show_errors( $show_errors );
5528
5529
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5530
5531
		return $return;
5532
	}
5533
5534
	/**
5535
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5536
	 * Capture it here so we can verify the signature later.
5537
	 */
5538
	function xmlrpc_methods( $methods ) {
5539
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5540
		return $methods;
5541
	}
5542
5543
	function public_xmlrpc_methods( $methods ) {
5544
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5545
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5546
		}
5547
		return $methods;
5548
	}
5549
5550
	function jetpack_getOptions( $args ) {
5551
		global $wp_xmlrpc_server;
5552
5553
		$wp_xmlrpc_server->escape( $args );
5554
5555
		$username	= $args[1];
5556
		$password	= $args[2];
5557
5558
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5559
			return $wp_xmlrpc_server->error;
5560
		}
5561
5562
		$options = array();
5563
		$user_data = $this->get_connected_user_data();
5564
		if ( is_array( $user_data ) ) {
5565
			$options['jetpack_user_id'] = array(
5566
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5567
				'readonly'      => true,
5568
				'value'         => $user_data['ID'],
5569
			);
5570
			$options['jetpack_user_login'] = array(
5571
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5572
				'readonly'      => true,
5573
				'value'         => $user_data['login'],
5574
			);
5575
			$options['jetpack_user_email'] = array(
5576
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5577
				'readonly'      => true,
5578
				'value'         => $user_data['email'],
5579
			);
5580
			$options['jetpack_user_site_count'] = array(
5581
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5582
				'readonly'      => true,
5583
				'value'         => $user_data['site_count'],
5584
			);
5585
		}
5586
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5587
		$args = stripslashes_deep( $args );
5588
		return $wp_xmlrpc_server->wp_getOptions( $args );
5589
	}
5590
5591
	function xmlrpc_options( $options ) {
5592
		$jetpack_client_id = false;
5593
		if ( self::is_active() ) {
5594
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5595
		}
5596
		$options['jetpack_version'] = array(
5597
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5598
				'readonly'      => true,
5599
				'value'         => JETPACK__VERSION,
5600
		);
5601
5602
		$options['jetpack_client_id'] = array(
5603
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5604
				'readonly'      => true,
5605
				'value'         => $jetpack_client_id,
5606
		);
5607
		return $options;
5608
	}
5609
5610
	public static function clean_nonces( $all = false ) {
5611
		global $wpdb;
5612
5613
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5614
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5615
5616
		if ( true !== $all ) {
5617
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5618
			$sql_args[] = time() - 3600;
5619
		}
5620
5621
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5622
5623
		$sql = $wpdb->prepare( $sql, $sql_args );
5624
5625
		for ( $i = 0; $i < 1000; $i++ ) {
5626
			if ( ! $wpdb->query( $sql ) ) {
5627
				break;
5628
			}
5629
		}
5630
	}
5631
5632
	/**
5633
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5634
	 * SET: state( $key, $value );
5635
	 * GET: $value = state( $key );
5636
	 *
5637
	 * @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...
5638
	 * @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...
5639
	 * @param bool $restate private
5640
	 */
5641
	public static function state( $key = null, $value = null, $restate = false ) {
5642
		static $state = array();
5643
		static $path, $domain;
5644
		if ( ! isset( $path ) ) {
5645
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5646
			$admin_url = Jetpack::admin_url();
5647
			$bits      = parse_url( $admin_url );
5648
5649
			if ( is_array( $bits ) ) {
5650
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5651
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5652
			} else {
5653
				$path = $domain = null;
5654
			}
5655
		}
5656
5657
		// Extract state from cookies and delete cookies
5658
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5659
			$yum = $_COOKIE[ 'jetpackState' ];
5660
			unset( $_COOKIE[ 'jetpackState' ] );
5661
			foreach ( $yum as $k => $v ) {
5662
				if ( strlen( $v ) )
5663
					$state[ $k ] = $v;
5664
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5665
			}
5666
		}
5667
5668
		if ( $restate ) {
5669
			foreach ( $state as $k => $v ) {
5670
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5671
			}
5672
			return;
5673
		}
5674
5675
		// Get a state variable
5676
		if ( isset( $key ) && ! isset( $value ) ) {
5677
			if ( array_key_exists( $key, $state ) )
5678
				return $state[ $key ];
5679
			return null;
5680
		}
5681
5682
		// Set a state variable
5683
		if ( isset ( $key ) && isset( $value ) ) {
5684
			if( is_array( $value ) && isset( $value[0] ) ) {
5685
				$value = $value[0];
5686
			}
5687
			$state[ $key ] = $value;
5688
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5689
		}
5690
	}
5691
5692
	public static function restate() {
5693
		Jetpack::state( null, null, true );
5694
	}
5695
5696
	public static function check_privacy( $file ) {
5697
		static $is_site_publicly_accessible = null;
5698
5699
		if ( is_null( $is_site_publicly_accessible ) ) {
5700
			$is_site_publicly_accessible = false;
5701
5702
			Jetpack::load_xml_rpc_client();
5703
			$rpc = new Jetpack_IXR_Client();
5704
5705
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5706
			if ( $success ) {
5707
				$response = $rpc->getResponse();
5708
				if ( $response ) {
5709
					$is_site_publicly_accessible = true;
5710
				}
5711
			}
5712
5713
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5714
		}
5715
5716
		if ( $is_site_publicly_accessible ) {
5717
			return;
5718
		}
5719
5720
		$module_slug = self::get_module_slug( $file );
5721
5722
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5723
		if ( ! $privacy_checks ) {
5724
			$privacy_checks = $module_slug;
5725
		} else {
5726
			$privacy_checks .= ",$module_slug";
5727
		}
5728
5729
		Jetpack::state( 'privacy_checks', $privacy_checks );
5730
	}
5731
5732
	/**
5733
	 * Helper method for multicall XMLRPC.
5734
	 */
5735
	public static function xmlrpc_async_call() {
5736
		global $blog_id;
5737
		static $clients = array();
5738
5739
		$client_blog_id = is_multisite() ? $blog_id : 0;
5740
5741
		if ( ! isset( $clients[$client_blog_id] ) ) {
5742
			Jetpack::load_xml_rpc_client();
5743
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5744
			if ( function_exists( 'ignore_user_abort' ) ) {
5745
				ignore_user_abort( true );
5746
			}
5747
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5748
		}
5749
5750
		$args = func_get_args();
5751
5752
		if ( ! empty( $args[0] ) ) {
5753
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5754
		} elseif ( is_multisite() ) {
5755
			foreach ( $clients as $client_blog_id => $client ) {
5756
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5757
					continue;
5758
				}
5759
5760
				$switch_success = switch_to_blog( $client_blog_id, true );
5761
				if ( ! $switch_success ) {
5762
					continue;
5763
				}
5764
5765
				flush();
5766
				$client->query();
5767
5768
				restore_current_blog();
5769
			}
5770
		} else {
5771
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5772
				flush();
5773
				$clients[0]->query();
5774
			}
5775
		}
5776
	}
5777
5778
	public static function staticize_subdomain( $url ) {
5779
5780
		// Extract hostname from URL
5781
		$host = parse_url( $url, PHP_URL_HOST );
5782
5783
		// Explode hostname on '.'
5784
		$exploded_host = explode( '.', $host );
5785
5786
		// Retrieve the name and TLD
5787
		if ( count( $exploded_host ) > 1 ) {
5788
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5789
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5790
			// Rebuild domain excluding subdomains
5791
			$domain = $name . '.' . $tld;
5792
		} else {
5793
			$domain = $host;
5794
		}
5795
		// Array of Automattic domains
5796
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5797
5798
		// Return $url if not an Automattic domain
5799
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5800
			return $url;
5801
		}
5802
5803
		if ( is_ssl() ) {
5804
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5805
		}
5806
5807
		srand( crc32( basename( $url ) ) );
5808
		$static_counter = rand( 0, 2 );
5809
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5810
5811
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5812
	}
5813
5814
/* JSON API Authorization */
5815
5816
	/**
5817
	 * Handles the login action for Authorizing the JSON API
5818
	 */
5819
	function login_form_json_api_authorization() {
5820
		$this->verify_json_api_authorization_request();
5821
5822
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5823
5824
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5825
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5826
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5827
	}
5828
5829
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5830
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5831
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5832
			return $url;
5833
		}
5834
5835
		$parsed_url = parse_url( $url );
5836
		$url = strtok( $url, '?' );
5837
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5838
		if ( ! empty( $parsed_url['query'] ) )
5839
			$url .= "&{$parsed_url['query']}";
5840
5841
		return $url;
5842
	}
5843
5844
	// Make sure the POSTed request is handled by the same action
5845
	function preserve_action_in_login_form_for_json_api_authorization() {
5846
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5847
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5848
	}
5849
5850
	// If someone logs in to approve API access, store the Access Code in usermeta
5851
	function store_json_api_authorization_token( $user_login, $user ) {
5852
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5853
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5854
		$token = wp_generate_password( 32, false );
5855
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5856
	}
5857
5858
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5859
	function allow_wpcom_public_api_domain( $domains ) {
5860
		$domains[] = 'public-api.wordpress.com';
5861
		return $domains;
5862
	}
5863
5864
	// Add the Access Code details to the public-api.wordpress.com redirect
5865
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5866
		return add_query_arg(
5867
			urlencode_deep(
5868
				array(
5869
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5870
					'jetpack-user-id' => (int) $user->ID,
5871
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5872
				)
5873
			),
5874
			$redirect_to
5875
		);
5876
	}
5877
5878
5879
	/**
5880
	 * Verifies the request by checking the signature
5881
	 *
5882
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5883
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5884
	 *
5885
	 * @param null|array $environment
5886
	 */
5887
	function verify_json_api_authorization_request( $environment = null ) {
5888
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5889
5890
		$environment = is_null( $environment )
5891
			? $_REQUEST
5892
			: $environment;
5893
5894
		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...
5895
		$token = Jetpack_Data::get_access_token( $envUserId );
5896
		if ( ! $token || empty( $token->secret ) ) {
5897
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5898
		}
5899
5900
		$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' );
5901
5902
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5903
5904
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5905
			$signature = $jetpack_signature->sign_request(
5906
				$environment['token'],
5907
				$environment['timestamp'],
5908
				$environment['nonce'],
5909
				'',
5910
				'GET',
5911
				$environment['jetpack_json_api_original_query'],
5912
				null,
5913
				true
5914
			);
5915
		} else {
5916
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5917
		}
5918
5919
		if ( ! $signature ) {
5920
			wp_die( $die_error );
5921
		} else if ( is_wp_error( $signature ) ) {
5922
			wp_die( $die_error );
5923
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5924
			if ( is_ssl() ) {
5925
				// 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
5926
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5927
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5928
					wp_die( $die_error );
5929
				}
5930
			} else {
5931
				wp_die( $die_error );
5932
			}
5933
		}
5934
5935
		$timestamp = (int) $environment['timestamp'];
5936
		$nonce     = stripslashes( (string) $environment['nonce'] );
5937
5938
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5939
			// De-nonce the nonce, at least for 5 minutes.
5940
			// 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)
5941
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5942
			if ( $old_nonce_time < time() - 300 ) {
5943
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5944
			}
5945
		}
5946
5947
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5948
		$data_filters = array(
5949
			'state'        => 'opaque',
5950
			'client_id'    => 'int',
5951
			'client_title' => 'string',
5952
			'client_image' => 'url',
5953
		);
5954
5955
		foreach ( $data_filters as $key => $sanitation ) {
5956
			if ( ! isset( $data->$key ) ) {
5957
				wp_die( $die_error );
5958
			}
5959
5960
			switch ( $sanitation ) {
5961
			case 'int' :
5962
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5963
				break;
5964
			case 'opaque' :
5965
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5966
				break;
5967
			case 'string' :
5968
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5969
				break;
5970
			case 'url' :
5971
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5972
				break;
5973
			}
5974
		}
5975
5976
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5977
			wp_die( $die_error );
5978
		}
5979
	}
5980
5981
	function login_message_json_api_authorization( $message ) {
5982
		return '<p class="message">' . sprintf(
5983
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5984
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5985
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5986
	}
5987
5988
	/**
5989
	 * Get $content_width, but with a <s>twist</s> filter.
5990
	 */
5991
	public static function get_content_width() {
5992
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5993
		/**
5994
		 * Filter the Content Width value.
5995
		 *
5996
		 * @since 2.2.3
5997
		 *
5998
		 * @param string $content_width Content Width value.
5999
		 */
6000
		return apply_filters( 'jetpack_content_width', $content_width );
6001
	}
6002
6003
	/**
6004
	 * Pings the WordPress.com Mirror Site for the specified options.
6005
	 *
6006
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6007
	 *
6008
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6009
	 */
6010
	public function get_cloud_site_options( $option_names ) {
6011
		$option_names = array_filter( (array) $option_names, 'is_string' );
6012
6013
		Jetpack::load_xml_rpc_client();
6014
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6015
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6016
		if ( $xml->isError() ) {
6017
			return array(
6018
				'error_code' => $xml->getErrorCode(),
6019
				'error_msg'  => $xml->getErrorMessage(),
6020
			);
6021
		}
6022
		$cloud_site_options = $xml->getResponse();
6023
6024
		return $cloud_site_options;
6025
	}
6026
6027
	/**
6028
	 * Checks if the site is currently in an identity crisis.
6029
	 *
6030
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6031
	 */
6032
	public static function check_identity_crisis() {
6033
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6034
			return false;
6035
		}
6036
6037
		return Jetpack_Options::get_option( 'sync_error_idc' );
6038
	}
6039
6040
	/**
6041
	 * Checks whether the home and siteurl specifically are whitelisted
6042
	 * Written so that we don't have re-check $key and $value params every time
6043
	 * we want to check if this site is whitelisted, for example in footer.php
6044
	 *
6045
	 * @since  3.8.0
6046
	 * @return bool True = already whitelisted False = not whitelisted
6047
	 */
6048
	public static function is_staging_site() {
6049
		$is_staging = false;
6050
6051
		$known_staging = array(
6052
			'urls' => array(
6053
				'#\.staging\.wpengine\.com$#i', // WP Engine
6054
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6055
				),
6056
			'constants' => array(
6057
				'IS_WPE_SNAPSHOT',      // WP Engine
6058
				'KINSTA_DEV_ENV',       // Kinsta.com
6059
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6060
				'JETPACK_STAGING_MODE', // Generic
6061
				)
6062
			);
6063
		/**
6064
		 * Filters the flags of known staging sites.
6065
		 *
6066
		 * @since 3.9.0
6067
		 *
6068
		 * @param array $known_staging {
6069
		 *     An array of arrays that each are used to check if the current site is staging.
6070
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6071
		 *     @type array $constants PHP constants of known staging/developement environments.
6072
		 *  }
6073
		 */
6074
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6075
6076
		if ( isset( $known_staging['urls'] ) ) {
6077
			foreach ( $known_staging['urls'] as $url ){
6078
				if ( preg_match( $url, site_url() ) ) {
6079
					$is_staging = true;
6080
					break;
6081
				}
6082
			}
6083
		}
6084
6085
		if ( isset( $known_staging['constants'] ) ) {
6086
			foreach ( $known_staging['constants'] as $constant ) {
6087
				if ( defined( $constant ) && constant( $constant ) ) {
6088
					$is_staging = true;
6089
				}
6090
			}
6091
		}
6092
6093
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6094
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6095
			$is_staging = true;
6096
		}
6097
6098
		/**
6099
		 * Filters is_staging_site check.
6100
		 *
6101
		 * @since 3.9.0
6102
		 *
6103
		 * @param bool $is_staging If the current site is a staging site.
6104
		 */
6105
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6106
	}
6107
6108
	/**
6109
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6110
	 *
6111
	 * @since 4.4.0
6112
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6113
	 *
6114
	 * @return bool
6115
	 */
6116
	public static function validate_sync_error_idc_option() {
6117
		$is_valid = false;
6118
6119
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6120
		if ( false === $idc_allowed ) {
6121
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6122
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6123
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6124
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6125
				$transient_duration = HOUR_IN_SECONDS;
6126
			} else {
6127
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6128
				$idc_allowed = '1';
6129
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6130
			}
6131
6132
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6133
		}
6134
6135
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6136
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6137
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6138
			$local_options = self::get_sync_error_idc_option();
6139
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6140
				$is_valid = true;
6141
			}
6142
		}
6143
6144
		/**
6145
		 * Filters whether the sync_error_idc option is valid.
6146
		 *
6147
		 * @since 4.4.0
6148
		 *
6149
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6150
		 */
6151
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6152
6153
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6154
			// Since the option exists, and did not validate, delete it
6155
			Jetpack_Options::delete_option( 'sync_error_idc' );
6156
		}
6157
6158
		return $is_valid;
6159
	}
6160
6161
	/**
6162
	 * Normalizes a url by doing three things:
6163
	 *  - Strips protocol
6164
	 *  - Strips www
6165
	 *  - Adds a trailing slash
6166
	 *
6167
	 * @since 4.4.0
6168
	 * @param string $url
6169
	 * @return WP_Error|string
6170
	 */
6171
	public static function normalize_url_protocol_agnostic( $url ) {
6172
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6173
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6174
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6175
		}
6176
6177
		// Strip www and protocols
6178
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6179
		return $url;
6180
	}
6181
6182
	/**
6183
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6184
	 *
6185
	 * @since 4.4.0
6186
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6187
	 *
6188
	 * @param array $response
6189
	 * @return array Array of the local urls, wpcom urls, and error code
6190
	 */
6191
	public static function get_sync_error_idc_option( $response = array() ) {
6192
		// Since the local options will hit the database directly, store the values
6193
		// in a transient to allow for autoloading and caching on subsequent views.
6194
		$local_options = get_transient( 'jetpack_idc_local' );
6195
		if ( false === $local_options ) {
6196
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6197
			$local_options = array(
6198
				'home'    => Jetpack_Sync_Functions::home_url(),
6199
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6200
			);
6201
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6202
		}
6203
6204
		$options = array_merge( $local_options, $response );
6205
6206
		$returned_values = array();
6207
		foreach( $options as $key => $option ) {
6208
			if ( 'error_code' === $key ) {
6209
				$returned_values[ $key ] = $option;
6210
				continue;
6211
			}
6212
6213
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6214
				continue;
6215
			}
6216
6217
			$returned_values[ $key ] = $normalized_url;
6218
		}
6219
6220
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6221
6222
		return $returned_values;
6223
	}
6224
6225
	/**
6226
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6227
	 * If set to true, the site will be put into staging mode.
6228
	 *
6229
	 * @since 4.3.2
6230
	 * @return bool
6231
	 */
6232
	public static function sync_idc_optin() {
6233
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6234
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6235
		} else {
6236
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6237
		}
6238
6239
		/**
6240
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6241
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6242
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6243
		 *
6244
		 * @since 4.3.2
6245
		 *
6246
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6247
		 */
6248
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6249
	}
6250
6251
	/**
6252
	 * Maybe Use a .min.css stylesheet, maybe not.
6253
	 *
6254
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6255
	 */
6256
	public static function maybe_min_asset( $url, $path, $plugin ) {
6257
		// Short out on things trying to find actual paths.
6258
		if ( ! $path || empty( $plugin ) ) {
6259
			return $url;
6260
		}
6261
6262
		$path = ltrim( $path, '/' );
6263
6264
		// Strip out the abspath.
6265
		$base = dirname( plugin_basename( $plugin ) );
6266
6267
		// Short out on non-Jetpack assets.
6268
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6269
			return $url;
6270
		}
6271
6272
		// File name parsing.
6273
		$file              = "{$base}/{$path}";
6274
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6275
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6276
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6277
		$extension         = array_shift( $file_name_parts_r );
6278
6279
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6280
			// Already pointing at the minified version.
6281
			if ( 'min' === $file_name_parts_r[0] ) {
6282
				return $url;
6283
			}
6284
6285
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6286
			if ( file_exists( $min_full_path ) ) {
6287
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6288
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6289
				if ( 'css' === $extension ) {
6290
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6291
					self::$min_assets[ $key ] = $path;
6292
				}
6293
			}
6294
		}
6295
6296
		return $url;
6297
	}
6298
6299
	/**
6300
	 * If the asset is minified, let's flag .min as the suffix.
6301
	 *
6302
	 * Attached to `style_loader_src` filter.
6303
	 *
6304
	 * @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...
6305
	 * @param string $handle The registered handle of the script in question.
6306
	 * @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...
6307
	 */
6308
	public static function set_suffix_on_min( $src, $handle ) {
6309
		if ( false === strpos( $src, '.min.css' ) ) {
6310
			return $src;
6311
		}
6312
6313
		if ( ! empty( self::$min_assets ) ) {
6314
			foreach ( self::$min_assets as $file => $path ) {
6315
				if ( false !== strpos( $src, $file ) ) {
6316
					wp_style_add_data( $handle, 'suffix', '.min' );
6317
					return $src;
6318
				}
6319
			}
6320
		}
6321
6322
		return $src;
6323
	}
6324
6325
	/**
6326
	 * Maybe inlines a stylesheet.
6327
	 *
6328
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6329
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6330
	 *
6331
	 * Attached to `style_loader_tag` filter.
6332
	 *
6333
	 * @param string $tag The tag that would link to the external asset.
6334
	 * @param string $handle The registered handle of the script in question.
6335
	 *
6336
	 * @return string
6337
	 */
6338
	public static function maybe_inline_style( $tag, $handle ) {
6339
		global $wp_styles;
6340
		$item = $wp_styles->registered[ $handle ];
6341
6342
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6343
			return $tag;
6344
		}
6345
6346
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6347
			$href = $matches[1];
6348
			// Strip off query string
6349
			if ( $pos = strpos( $href, '?' ) ) {
6350
				$href = substr( $href, 0, $pos );
6351
			}
6352
			// Strip off fragment
6353
			if ( $pos = strpos( $href, '#' ) ) {
6354
				$href = substr( $href, 0, $pos );
6355
			}
6356
		} else {
6357
			return $tag;
6358
		}
6359
6360
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6361
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6362
			return $tag;
6363
		}
6364
6365
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6366
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6367
			// And this isn't the pass that actually deals with the RTL version...
6368
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6369
				// Short out, as the RTL version will deal with it in a moment.
6370
				return $tag;
6371
			}
6372
		}
6373
6374
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6375
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6376
		if ( $css ) {
6377
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6378
			if ( empty( $item->extra['after'] ) ) {
6379
				wp_add_inline_style( $handle, $css );
6380
			} else {
6381
				array_unshift( $item->extra['after'], $css );
6382
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6383
			}
6384
		}
6385
6386
		return $tag;
6387
	}
6388
6389
	/**
6390
	 * Loads a view file from the views
6391
	 *
6392
	 * Data passed in with the $data parameter will be available in the
6393
	 * template file as $data['value']
6394
	 *
6395
	 * @param string $template - Template file to load
6396
	 * @param array $data - Any data to pass along to the template
6397
	 * @return boolean - If template file was found
6398
	 **/
6399
	public function load_view( $template, $data = array() ) {
6400
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6401
6402
		if( file_exists( $views_dir . $template ) ) {
6403
			require_once( $views_dir . $template );
6404
			return true;
6405
		}
6406
6407
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6408
		return false;
6409
	}
6410
6411
	/**
6412
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6413
	 */
6414
	public function deprecated_hooks() {
6415
		global $wp_filter;
6416
6417
		/*
6418
		 * Format:
6419
		 * deprecated_filter_name => replacement_name
6420
		 *
6421
		 * If there is no replacement, use null for replacement_name
6422
		 */
6423
		$deprecated_list = array(
6424
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6425
			'wpl_sharing_2014_1'                                     => null,
6426
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6427
			'jetpack_identity_crisis_options_to_check'               => null,
6428
			'update_option_jetpack_single_user_site'                 => null,
6429
			'audio_player_default_colors'                            => null,
6430
			'add_option_jetpack_featured_images_enabled'             => null,
6431
			'add_option_jetpack_update_details'                      => null,
6432
			'add_option_jetpack_updates'                             => null,
6433
			'add_option_jetpack_network_name'                        => null,
6434
			'add_option_jetpack_network_allow_new_registrations'     => null,
6435
			'add_option_jetpack_network_add_new_users'               => null,
6436
			'add_option_jetpack_network_site_upload_space'           => null,
6437
			'add_option_jetpack_network_upload_file_types'           => null,
6438
			'add_option_jetpack_network_enable_administration_menus' => null,
6439
			'add_option_jetpack_is_multi_site'                       => null,
6440
			'add_option_jetpack_is_main_network'                     => null,
6441
			'add_option_jetpack_main_network_site'                   => null,
6442
			'jetpack_sync_all_registered_options'                    => null,
6443
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6444
			'jetpack_is_post_mailable'                               => null,
6445
			'jetpack_seo_site_host'                                  => null,
6446
		);
6447
6448
		// This is a silly loop depth. Better way?
6449
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6450
			if ( has_action( $hook ) ) {
6451
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6452
					foreach( $values AS $hooked ) {
6453
						if ( is_callable( $hooked['function'] ) ) {
6454
							$function_name = 'an anonymous function';
6455
						} else {
6456
							$function_name = $hooked['function'];
6457
						}
6458
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6459
					}
6460
				}
6461
			}
6462
		}
6463
	}
6464
6465
	/**
6466
	 * Converts any url in a stylesheet, to the correct absolute url.
6467
	 *
6468
	 * Considerations:
6469
	 *  - Normal, relative URLs     `feh.png`
6470
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6471
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6472
	 *  - Absolute URLs             `http://domain.com/feh.png`
6473
	 *  - Domain root relative URLs `/feh.png`
6474
	 *
6475
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6476
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6477
	 *
6478
	 * @return mixed|string
6479
	 */
6480
	public static function absolutize_css_urls( $css, $css_file_url ) {
6481
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6482
		$css_dir = dirname( $css_file_url );
6483
		$p       = parse_url( $css_dir );
6484
		$domain  = sprintf(
6485
					'%1$s//%2$s%3$s%4$s',
6486
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6487
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6488
					$p['host'],
6489
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6490
				);
6491
6492
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6493
			$find = $replace = array();
6494
			foreach ( $matches as $match ) {
6495
				$url = trim( $match['path'], "'\" \t" );
6496
6497
				// If this is a data url, we don't want to mess with it.
6498
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6499
					continue;
6500
				}
6501
6502
				// If this is an absolute or protocol-agnostic url,
6503
				// we don't want to mess with it.
6504
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6505
					continue;
6506
				}
6507
6508
				switch ( substr( $url, 0, 1 ) ) {
6509
					case '/':
6510
						$absolute = $domain . $url;
6511
						break;
6512
					default:
6513
						$absolute = $css_dir . '/' . $url;
6514
				}
6515
6516
				$find[]    = $match[0];
6517
				$replace[] = sprintf( 'url("%s")', $absolute );
6518
			}
6519
			$css = str_replace( $find, $replace, $css );
6520
		}
6521
6522
		return $css;
6523
	}
6524
6525
	/**
6526
	 * This methods removes all of the registered css files on the front end
6527
	 * from Jetpack in favor of using a single file. In effect "imploding"
6528
	 * all the files into one file.
6529
	 *
6530
	 * Pros:
6531
	 * - Uses only ONE css asset connection instead of 15
6532
	 * - Saves a minimum of 56k
6533
	 * - Reduces server load
6534
	 * - Reduces time to first painted byte
6535
	 *
6536
	 * Cons:
6537
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6538
	 *		should not cause any issues with themes.
6539
	 * - Plugins/themes dequeuing styles no longer do anything. See
6540
	 *		jetpack_implode_frontend_css filter for a workaround
6541
	 *
6542
	 * For some situations developers may wish to disable css imploding and
6543
	 * instead operate in legacy mode where each file loads seperately and
6544
	 * can be edited individually or dequeued. This can be accomplished with
6545
	 * the following line:
6546
	 *
6547
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6548
	 *
6549
	 * @since 3.2
6550
	 **/
6551
	public function implode_frontend_css( $travis_test = false ) {
6552
		$do_implode = true;
6553
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6554
			$do_implode = false;
6555
		}
6556
6557
		/**
6558
		 * Allow CSS to be concatenated into a single jetpack.css file.
6559
		 *
6560
		 * @since 3.2.0
6561
		 *
6562
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6563
		 */
6564
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6565
6566
		// Do not use the imploded file when default behaviour was altered through the filter
6567
		if ( ! $do_implode ) {
6568
			return;
6569
		}
6570
6571
		// We do not want to use the imploded file in dev mode, or if not connected
6572
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6573
			if ( ! $travis_test ) {
6574
				return;
6575
			}
6576
		}
6577
6578
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6579
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6580
			return;
6581
		}
6582
6583
		/*
6584
		 * Now we assume Jetpack is connected and able to serve the single
6585
		 * file.
6586
		 *
6587
		 * In the future there will be a check here to serve the file locally
6588
		 * or potentially from the Jetpack CDN
6589
		 *
6590
		 * For now:
6591
		 * - Enqueue a single imploded css file
6592
		 * - Zero out the style_loader_tag for the bundled ones
6593
		 * - Be happy, drink scotch
6594
		 */
6595
6596
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6597
6598
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6599
6600
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6601
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6602
	}
6603
6604
	function concat_remove_style_loader_tag( $tag, $handle ) {
6605
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6606
			$tag = '';
6607
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6608
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6609
			}
6610
		}
6611
6612
		return $tag;
6613
	}
6614
6615
	/*
6616
	 * Check the heartbeat data
6617
	 *
6618
	 * Organizes the heartbeat data by severity.  For example, if the site
6619
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6620
	 *
6621
	 * Data will be added to "caution" array, if it either:
6622
	 *  - Out of date Jetpack version
6623
	 *  - Out of date WP version
6624
	 *  - Out of date PHP version
6625
	 *
6626
	 * $return array $filtered_data
6627
	 */
6628
	public static function jetpack_check_heartbeat_data() {
6629
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6630
6631
		$good    = array();
6632
		$caution = array();
6633
		$bad     = array();
6634
6635
		foreach ( $raw_data as $stat => $value ) {
6636
6637
			// Check jetpack version
6638
			if ( 'version' == $stat ) {
6639
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6640
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6641
					continue;
6642
				}
6643
			}
6644
6645
			// Check WP version
6646
			if ( 'wp-version' == $stat ) {
6647
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6648
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6649
					continue;
6650
				}
6651
			}
6652
6653
			// Check PHP version
6654
			if ( 'php-version' == $stat ) {
6655
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6656
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6657
					continue;
6658
				}
6659
			}
6660
6661
			// Check ID crisis
6662
			if ( 'identitycrisis' == $stat ) {
6663
				if ( 'yes' == $value ) {
6664
					$bad[ $stat ] = $value;
6665
					continue;
6666
				}
6667
			}
6668
6669
			// The rest are good :)
6670
			$good[ $stat ] = $value;
6671
		}
6672
6673
		$filtered_data = array(
6674
			'good'    => $good,
6675
			'caution' => $caution,
6676
			'bad'     => $bad
6677
		);
6678
6679
		return $filtered_data;
6680
	}
6681
6682
6683
	/*
6684
	 * This method is used to organize all options that can be reset
6685
	 * without disconnecting Jetpack.
6686
	 *
6687
	 * It is used in class.jetpack-cli.php to reset options
6688
	 *
6689
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6690
	 *
6691
	 * @return array of options to delete.
6692
	 */
6693
	public static function get_jetpack_options_for_reset() {
6694
		return Jetpack_Options::get_options_for_reset();
6695
	}
6696
6697
	/**
6698
	 * Check if an option of a Jetpack module has been updated.
6699
	 *
6700
	 * If any module option has been updated before Jump Start has been dismissed,
6701
	 * update the 'jumpstart' option so we can hide Jump Start.
6702
	 *
6703
	 * @param string $option_name
6704
	 *
6705
	 * @return bool
6706
	 */
6707
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6708
		// Bail if Jump Start has already been dismissed
6709
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6710
			return false;
6711
		}
6712
6713
		$jetpack = Jetpack::init();
6714
6715
		// Manual build of module options
6716
		$option_names = self::get_jetpack_options_for_reset();
6717
6718
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6719
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6720
6721
			//Jump start is being dismissed send data to MC Stats
6722
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6723
6724
			$jetpack->do_stats( 'server_side' );
6725
		}
6726
6727
	}
6728
6729
	/*
6730
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6731
	 * so we can bring them directly to their site in calypso.
6732
	 *
6733
	 * @param string | url
6734
	 * @return string | url without the guff
6735
	 */
6736
	public static function build_raw_urls( $url ) {
6737
		$strip_http = '/.*?:\/\//i';
6738
		$url = preg_replace( $strip_http, '', $url  );
6739
		$url = str_replace( '/', '::', $url );
6740
		return $url;
6741
	}
6742
6743
	/**
6744
	 * Stores and prints out domains to prefetch for page speed optimization.
6745
	 *
6746
	 * @param mixed $new_urls
6747
	 */
6748
	public static function dns_prefetch( $new_urls = null ) {
6749
		static $prefetch_urls = array();
6750
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6751
			echo "\r\n";
6752
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6753
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6754
			}
6755
		} elseif ( ! empty( $new_urls ) ) {
6756
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6757
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6758
			}
6759
			foreach ( (array) $new_urls as $this_new_url ) {
6760
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6761
			}
6762
			$prefetch_urls = array_unique( $prefetch_urls );
6763
		}
6764
	}
6765
6766
	public function wp_dashboard_setup() {
6767
		if ( self::is_active() ) {
6768
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6769
		}
6770
6771
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6772
			wp_add_dashboard_widget(
6773
				'jetpack_summary_widget',
6774
				esc_html__( 'Site Stats', 'jetpack' ),
6775
				array( __CLASS__, 'dashboard_widget' )
6776
			);
6777
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6778
6779
			// If we're inactive and not in development mode, sort our box to the top.
6780
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6781
				global $wp_meta_boxes;
6782
6783
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6784
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6785
6786
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6787
			}
6788
		}
6789
	}
6790
6791
	/**
6792
	 * @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...
6793
	 * @return mixed
6794
	 */
6795
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6796
		if ( ! is_array( $sorted ) ) {
6797
			return $sorted;
6798
		}
6799
6800
		foreach ( $sorted as $box_context => $ids ) {
6801
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6802
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6803
				continue;
6804
			}
6805
6806
			$ids_array = explode( ',', $ids );
6807
			$key = array_search( 'dashboard_stats', $ids_array );
6808
6809
			if ( false !== $key ) {
6810
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6811
				$ids_array[ $key ] = 'jetpack_summary_widget';
6812
				$sorted[ $box_context ] = implode( ',', $ids_array );
6813
				// We've found it, stop searching, and just return.
6814
				break;
6815
			}
6816
		}
6817
6818
		return $sorted;
6819
	}
6820
6821
	public static function dashboard_widget() {
6822
		/**
6823
		 * Fires when the dashboard is loaded.
6824
		 *
6825
		 * @since 3.4.0
6826
		 */
6827
		do_action( 'jetpack_dashboard_widget' );
6828
	}
6829
6830
	public static function dashboard_widget_footer() {
6831
		?>
6832
		<footer>
6833
6834
		<div class="protect">
6835
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6836
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6837
				<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>
6838
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6839
				<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' ); ?>">
6840
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6841
				</a>
6842
			<?php else : ?>
6843
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6844
			<?php endif; ?>
6845
		</div>
6846
6847
		<div class="akismet">
6848
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6849
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6850
				<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>
6851
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6852
				<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">
6853
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6854
				</a>
6855
			<?php else : ?>
6856
				<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>
6857
			<?php endif; ?>
6858
		</div>
6859
6860
		</footer>
6861
		<?php
6862
	}
6863
6864
	/**
6865
	 * Return string containing the Jetpack logo.
6866
	 *
6867
	 * @since 3.9.0
6868
	 *
6869
	 * @return string
6870
	 */
6871
	public static function get_jp_emblem() {
6872
		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>';
6873
	}
6874
6875
	/*
6876
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6877
	 */
6878
	function jetpack_icon_user_connected( $columns ) {
6879
		$columns['user_jetpack'] = '';
6880
		return $columns;
6881
	}
6882
6883
	/*
6884
	 * Show Jetpack icon if the user is linked.
6885
	 */
6886
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6887
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6888
			$emblem_html = sprintf(
6889
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6890
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6891
				Jetpack::get_jp_emblem()
6892
			);
6893
			return $emblem_html;
6894
		}
6895
6896
		return $val;
6897
	}
6898
6899
	/*
6900
	 * Style the Jetpack user column
6901
	 */
6902
	function jetpack_user_col_style() {
6903
		global $current_screen;
6904
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6905
			<style>
6906
				.fixed .column-user_jetpack {
6907
					width: 21px;
6908
				}
6909
				.jp-emblem-user-admin svg {
6910
					width: 20px;
6911
					height: 20px;
6912
				}
6913
				.jp-emblem-user-admin path {
6914
					fill: #00BE28;
6915
				}
6916
			</style>
6917
		<?php }
6918
	}
6919
6920
	/**
6921
	 * Checks if Akismet is active and working.
6922
	 *
6923
	 * @since  5.1.0
6924
	 * @return bool True = Akismet available. False = Aksimet not available.
6925
	 */
6926
	public static function is_akismet_active() {
6927
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6928
			return true;
6929
		}
6930
		return false;
6931
	}
6932
6933
	/**
6934
	 * Checks if one or more function names is in debug_backtrace
6935
	 *
6936
	 * @param $names Mixed string name of function or array of string names of functions
6937
	 *
6938
	 * @return bool
6939
	 */
6940
	public static function is_function_in_backtrace( $names ) {
6941
		$backtrace = debug_backtrace( false );
6942
		if ( ! is_array( $names ) ) {
6943
			$names = array( $names );
6944
		}
6945
		$names_as_keys = array_flip( $names );
6946
6947
		//Do check in constant O(1) time for PHP5.5+
6948
		if ( function_exists( 'array_column' ) ) {
6949
			$backtrace_functions = array_column( $backtrace, 'function' );
6950
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6951
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6952
			return ! empty ( $intersection );
6953
		}
6954
6955
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6956
		foreach ( $backtrace as $call ) {
6957
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6958
				return true;
6959
			}
6960
		}
6961
		return false;
6962
	}
6963
6964
	/**
6965
	 * Given a minified path, and a non-minified path, will return
6966
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6967
	 *
6968
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6969
	 * root Jetpack directory.
6970
	 *
6971
	 * @since 5.6.0
6972
	 *
6973
	 * @param string $min_path
6974
	 * @param string $non_min_path
6975
	 * @return string The URL to the file
6976
	 */
6977
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6978
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
6979
			? $non_min_path
6980
			: $min_path;
6981
6982
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6983
	}
6984
6985
	/**
6986
	 * Checks for whether Jetpack Rewind is enabled.
6987
	 * Will return true if the state of Rewind is anything except "unavailable".
6988
	 * @return bool|int|mixed
6989
	 */
6990
	public static function is_rewind_enabled() {
6991
		if ( ! Jetpack::is_active() ) {
6992
			return false;
6993
		}
6994
6995
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6996
		if ( false === $rewind_enabled ) {
6997
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6998
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6999
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7000
				&& ! empty( $rewind_data['state'] )
7001
				&& 'unavailable' !== $rewind_data['state'] )
7002
				? 1
7003
				: 0;
7004
7005
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7006
		}
7007
		return $rewind_enabled;
7008
	}
7009
}
7010