Completed
Push — add/install-and-activate-plugi... ( 4939b5...cc9368 )
by Bernhard
41:13 queued 10:28
created

Jetpack::push_stats()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 3
nc 2
nop 0
dl 0
loc 5
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
	 * Whether the site is currently onboarding or not.
1564
	 * A site is considered as being onboarded if it currently has an onboarding token.
1565
	 *
1566
	 * @since 5.8
1567
	 *
1568
	 * @access public
1569
	 * @static
1570
	 *
1571
	 * @return bool True if the site is currently onboarding, false otherwise
1572
	 */
1573
	public static function is_onboarding() {
1574
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1575
	}
1576
1577
	/**
1578
	* Get Jetpack development mode notice text and notice class.
1579
	*
1580
	* Mirrors the checks made in Jetpack::is_development_mode
1581
	*
1582
	*/
1583
	public static function show_development_mode_notice() {
1584
		if ( Jetpack::is_development_mode() ) {
1585
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1586
				$notice = sprintf(
1587
					/* translators: %s is a URL */
1588
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1589
					'https://jetpack.com/support/development-mode/'
1590
				);
1591
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1592
				$notice = sprintf(
1593
					/* translators: %s is a URL */
1594
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1595
					'https://jetpack.com/support/development-mode/'
1596
				);
1597
			} else {
1598
				$notice = sprintf(
1599
					/* translators: %s is a URL */
1600
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1601
					'https://jetpack.com/support/development-mode/'
1602
				);
1603
			}
1604
1605
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1606
		}
1607
1608
		// Throw up a notice if using a development version and as for feedback.
1609
		if ( Jetpack::is_development_version() ) {
1610
			/* translators: %s is a URL */
1611
			$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/' );
1612
1613
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1614
		}
1615
		// Throw up a notice if using staging mode
1616
		if ( Jetpack::is_staging_site() ) {
1617
			/* translators: %s is a URL */
1618
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1619
1620
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1621
		}
1622
	}
1623
1624
	/**
1625
	 * Whether Jetpack's version maps to a public release, or a development version.
1626
	 */
1627
	public static function is_development_version() {
1628
		/**
1629
		 * Allows filtering whether this is a development version of Jetpack.
1630
		 *
1631
		 * This filter is especially useful for tests.
1632
		 *
1633
		 * @since 4.3.0
1634
		 *
1635
		 * @param bool $development_version Is this a develoment version of Jetpack?
1636
		 */
1637
		return (bool) apply_filters(
1638
			'jetpack_development_version',
1639
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1640
		);
1641
	}
1642
1643
	/**
1644
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1645
	 */
1646
	public static function is_user_connected( $user_id = false ) {
1647
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1648
		if ( ! $user_id ) {
1649
			return false;
1650
		}
1651
1652
		return (bool) Jetpack_Data::get_access_token( $user_id );
1653
	}
1654
1655
	/**
1656
	 * Get the wpcom user data of the current|specified connected user.
1657
	 */
1658
	public static function get_connected_user_data( $user_id = null ) {
1659
		if ( ! $user_id ) {
1660
			$user_id = get_current_user_id();
1661
		}
1662
1663
		$transient_key = "jetpack_connected_user_data_$user_id";
1664
1665
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1666
			return $cached_user_data;
1667
		}
1668
1669
		Jetpack::load_xml_rpc_client();
1670
		$xml = new Jetpack_IXR_Client( array(
1671
			'user_id' => $user_id,
1672
		) );
1673
		$xml->query( 'wpcom.getUser' );
1674
		if ( ! $xml->isError() ) {
1675
			$user_data = $xml->getResponse();
1676
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1677
			return $user_data;
1678
		}
1679
1680
		return false;
1681
	}
1682
1683
	/**
1684
	 * Get the wpcom email of the current|specified connected user.
1685
	 */
1686 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1687
		if ( ! $user_id ) {
1688
			$user_id = get_current_user_id();
1689
		}
1690
		Jetpack::load_xml_rpc_client();
1691
		$xml = new Jetpack_IXR_Client( array(
1692
			'user_id' => $user_id,
1693
		) );
1694
		$xml->query( 'wpcom.getUserEmail' );
1695
		if ( ! $xml->isError() ) {
1696
			return $xml->getResponse();
1697
		}
1698
		return false;
1699
	}
1700
1701
	/**
1702
	 * Get the wpcom email of the master user.
1703
	 */
1704
	public static function get_master_user_email() {
1705
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1706
		if ( $master_user_id ) {
1707
			return self::get_connected_user_email( $master_user_id );
1708
		}
1709
		return '';
1710
	}
1711
1712
	function current_user_is_connection_owner() {
1713
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1714
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1715
	}
1716
1717
	/**
1718
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1719
	 */
1720
	function extra_oembed_providers() {
1721
		// Cloudup: https://dev.cloudup.com/#oembed
1722
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1723
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1724
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1725
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1726
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1727
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1728
	}
1729
1730
	/**
1731
	 * Synchronize connected user role changes
1732
	 */
1733
	function user_role_change( $user_id ) {
1734
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1735
		Jetpack_Sync_Users::user_role_change( $user_id );
1736
	}
1737
1738
	/**
1739
	 * Loads the currently active modules.
1740
	 */
1741
	public static function load_modules() {
1742
		if (
1743
			! self::is_active()
1744
			&& ! self::is_development_mode()
1745
			&& (
1746
				! is_multisite()
1747
				|| ! get_site_option( 'jetpack_protect_active' )
1748
			)
1749
		) {
1750
			return;
1751
		}
1752
1753
		$version = Jetpack_Options::get_option( 'version' );
1754 View Code Duplication
		if ( ! $version ) {
1755
			$version = $old_version = JETPACK__VERSION . ':' . time();
1756
			/** This action is documented in class.jetpack.php */
1757
			do_action( 'updating_jetpack_version', $version, false );
1758
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1759
		}
1760
		list( $version ) = explode( ':', $version );
1761
1762
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1763
1764
		$modules_data = array();
1765
1766
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1767
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1768
			$updated_modules = array();
1769
			foreach ( $modules as $module ) {
1770
				$modules_data[ $module ] = Jetpack::get_module( $module );
1771
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1772
					continue;
1773
				}
1774
1775
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1776
					continue;
1777
				}
1778
1779
				$updated_modules[] = $module;
1780
			}
1781
1782
			$modules = array_diff( $modules, $updated_modules );
1783
		}
1784
1785
		$is_development_mode = Jetpack::is_development_mode();
1786
1787
		foreach ( $modules as $index => $module ) {
1788
			// If we're in dev mode, disable modules requiring a connection
1789
			if ( $is_development_mode ) {
1790
				// Prime the pump if we need to
1791
				if ( empty( $modules_data[ $module ] ) ) {
1792
					$modules_data[ $module ] = Jetpack::get_module( $module );
1793
				}
1794
				// If the module requires a connection, but we're in local mode, don't include it.
1795
				if ( $modules_data[ $module ]['requires_connection'] ) {
1796
					continue;
1797
				}
1798
			}
1799
1800
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1801
				continue;
1802
			}
1803
1804
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1805
				unset( $modules[ $index ] );
1806
				self::update_active_modules( array_values( $modules ) );
1807
				continue;
1808
			}
1809
1810
			/**
1811
			 * Fires when a specific module is loaded.
1812
			 * The dynamic part of the hook, $module, is the module slug.
1813
			 *
1814
			 * @since 1.1.0
1815
			 */
1816
			do_action( 'jetpack_module_loaded_' . $module );
1817
		}
1818
1819
		/**
1820
		 * Fires when all the modules are loaded.
1821
		 *
1822
		 * @since 1.1.0
1823
		 */
1824
		do_action( 'jetpack_modules_loaded' );
1825
1826
		// 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.
1827
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1828
	}
1829
1830
	/**
1831
	 * Check if Jetpack's REST API compat file should be included
1832
	 * @action plugins_loaded
1833
	 * @return null
1834
	 */
1835
	public function check_rest_api_compat() {
1836
		/**
1837
		 * Filters the list of REST API compat files to be included.
1838
		 *
1839
		 * @since 2.2.5
1840
		 *
1841
		 * @param array $args Array of REST API compat files to include.
1842
		 */
1843
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1844
1845
		if ( function_exists( 'bbpress' ) )
1846
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1847
1848
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1849
			require_once $_jetpack_rest_api_compat_include;
1850
	}
1851
1852
	/**
1853
	 * Gets all plugins currently active in values, regardless of whether they're
1854
	 * traditionally activated or network activated.
1855
	 *
1856
	 * @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...
1857
	 */
1858
	public static function get_active_plugins() {
1859
		$active_plugins = (array) get_option( 'active_plugins', array() );
1860
1861
		if ( is_multisite() ) {
1862
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1863
			// whereas active_plugins stores them in the values.
1864
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1865
			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...
1866
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1867
			}
1868
		}
1869
1870
		sort( $active_plugins );
1871
1872
		return array_unique( $active_plugins );
1873
	}
1874
1875
	/**
1876
	 * Gets and parses additional plugin data to send with the heartbeat data
1877
	 *
1878
	 * @since 3.8.1
1879
	 *
1880
	 * @return array Array of plugin data
1881
	 */
1882
	public static function get_parsed_plugin_data() {
1883
		if ( ! function_exists( 'get_plugins' ) ) {
1884
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1885
		}
1886
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1887
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1888
		$active_plugins = Jetpack::get_active_plugins();
1889
1890
		$plugins = array();
1891
		foreach ( $all_plugins as $path => $plugin_data ) {
1892
			$plugins[ $path ] = array(
1893
					'is_active' => in_array( $path, $active_plugins ),
1894
					'file'      => $path,
1895
					'name'      => $plugin_data['Name'],
1896
					'version'   => $plugin_data['Version'],
1897
					'author'    => $plugin_data['Author'],
1898
			);
1899
		}
1900
1901
		return $plugins;
1902
	}
1903
1904
	/**
1905
	 * Gets and parses theme data to send with the heartbeat data
1906
	 *
1907
	 * @since 3.8.1
1908
	 *
1909
	 * @return array Array of theme data
1910
	 */
1911
	public static function get_parsed_theme_data() {
1912
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1913
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1914
1915
		$themes = array();
1916
		foreach ( $all_themes as $slug => $theme_data ) {
1917
			$theme_headers = array();
1918
			foreach ( $header_keys as $header_key ) {
1919
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1920
			}
1921
1922
			$themes[ $slug ] = array(
1923
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1924
					'slug' => $slug,
1925
					'theme_root' => $theme_data->get_theme_root_uri(),
1926
					'parent' => $theme_data->parent(),
1927
					'headers' => $theme_headers
1928
			);
1929
		}
1930
1931
		return $themes;
1932
	}
1933
1934
	/**
1935
	 * Checks whether a specific plugin is active.
1936
	 *
1937
	 * We don't want to store these in a static variable, in case
1938
	 * there are switch_to_blog() calls involved.
1939
	 */
1940
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1941
		return in_array( $plugin, self::get_active_plugins() );
1942
	}
1943
1944
	/**
1945
	 * Check if Jetpack's Open Graph tags should be used.
1946
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1947
	 *
1948
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1949
	 * @action plugins_loaded
1950
	 * @return null
1951
	 */
1952
	public function check_open_graph() {
1953
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1954
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1955
		}
1956
1957
		$active_plugins = self::get_active_plugins();
1958
1959
		if ( ! empty( $active_plugins ) ) {
1960
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1961
				if ( in_array( $plugin, $active_plugins ) ) {
1962
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1963
					break;
1964
				}
1965
			}
1966
		}
1967
1968
		/**
1969
		 * Allow the addition of Open Graph Meta Tags to all pages.
1970
		 *
1971
		 * @since 2.0.3
1972
		 *
1973
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1974
		 */
1975
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1976
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1977
		}
1978
	}
1979
1980
	/**
1981
	 * Check if Jetpack's Twitter tags should be used.
1982
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1983
	 *
1984
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1985
	 * @action plugins_loaded
1986
	 * @return null
1987
	 */
1988
	public function check_twitter_tags() {
1989
1990
		$active_plugins = self::get_active_plugins();
1991
1992
		if ( ! empty( $active_plugins ) ) {
1993
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1994
				if ( in_array( $plugin, $active_plugins ) ) {
1995
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1996
					break;
1997
				}
1998
			}
1999
		}
2000
2001
		/**
2002
		 * Allow Twitter Card Meta tags to be disabled.
2003
		 *
2004
		 * @since 2.6.0
2005
		 *
2006
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2007
		 */
2008
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2009
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2010
		}
2011
	}
2012
2013
	/**
2014
	 * Allows plugins to submit security reports.
2015
 	 *
2016
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2017
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2018
	 * @param array   $args         See definitions above
2019
	 */
2020
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2021
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2022
	}
2023
2024
/* Jetpack Options API */
2025
2026
	public static function get_option_names( $type = 'compact' ) {
2027
		return Jetpack_Options::get_option_names( $type );
2028
	}
2029
2030
	/**
2031
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2032
 	 *
2033
	 * @param string $name    Option name
2034
	 * @param mixed  $default (optional)
2035
	 */
2036
	public static function get_option( $name, $default = false ) {
2037
		return Jetpack_Options::get_option( $name, $default );
2038
	}
2039
2040
	/**
2041
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2042
 	 *
2043
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2044
	 * @param string $name  Option name
2045
	 * @param mixed  $value Option value
2046
	 */
2047
	public static function update_option( $name, $value ) {
2048
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2049
		return Jetpack_Options::update_option( $name, $value );
2050
	}
2051
2052
	/**
2053
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2054
 	 *
2055
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2056
	 * @param array $array array( option name => option value, ... )
2057
	 */
2058
	public static function update_options( $array ) {
2059
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2060
		return Jetpack_Options::update_options( $array );
2061
	}
2062
2063
	/**
2064
	 * Deletes the given option.  May be passed multiple option names as an array.
2065
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2066
	 *
2067
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2068
	 * @param string|array $names
2069
	 */
2070
	public static function delete_option( $names ) {
2071
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2072
		return Jetpack_Options::delete_option( $names );
2073
	}
2074
2075
	/**
2076
	 * Enters a user token into the user_tokens option
2077
	 *
2078
	 * @param int $user_id
2079
	 * @param string $token
2080
	 * return bool
2081
	 */
2082
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2083
		// not designed for concurrent updates
2084
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2085
		if ( ! is_array( $user_tokens ) )
2086
			$user_tokens = array();
2087
		$user_tokens[$user_id] = $token;
2088
		if ( $is_master_user ) {
2089
			$master_user = $user_id;
2090
			$options     = compact( 'user_tokens', 'master_user' );
2091
		} else {
2092
			$options = compact( 'user_tokens' );
2093
		}
2094
		return Jetpack_Options::update_options( $options );
2095
	}
2096
2097
	/**
2098
	 * Returns an array of all PHP files in the specified absolute path.
2099
	 * Equivalent to glob( "$absolute_path/*.php" ).
2100
	 *
2101
	 * @param string $absolute_path The absolute path of the directory to search.
2102
	 * @return array Array of absolute paths to the PHP files.
2103
	 */
2104
	public static function glob_php( $absolute_path ) {
2105
		if ( function_exists( 'glob' ) ) {
2106
			return glob( "$absolute_path/*.php" );
2107
		}
2108
2109
		$absolute_path = untrailingslashit( $absolute_path );
2110
		$files = array();
2111
		if ( ! $dir = @opendir( $absolute_path ) ) {
2112
			return $files;
2113
		}
2114
2115
		while ( false !== $file = readdir( $dir ) ) {
2116
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2117
				continue;
2118
			}
2119
2120
			$file = "$absolute_path/$file";
2121
2122
			if ( ! is_file( $file ) ) {
2123
				continue;
2124
			}
2125
2126
			$files[] = $file;
2127
		}
2128
2129
		closedir( $dir );
2130
2131
		return $files;
2132
	}
2133
2134
	public static function activate_new_modules( $redirect = false ) {
2135
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2136
			return;
2137
		}
2138
2139
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2140 View Code Duplication
		if ( ! $jetpack_old_version ) {
2141
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2142
			/** This action is documented in class.jetpack.php */
2143
			do_action( 'updating_jetpack_version', $version, false );
2144
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2145
		}
2146
2147
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2148
2149
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2150
			return;
2151
		}
2152
2153
		$active_modules     = Jetpack::get_active_modules();
2154
		$reactivate_modules = array();
2155
		foreach ( $active_modules as $active_module ) {
2156
			$module = Jetpack::get_module( $active_module );
2157
			if ( ! isset( $module['changed'] ) ) {
2158
				continue;
2159
			}
2160
2161
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2162
				continue;
2163
			}
2164
2165
			$reactivate_modules[] = $active_module;
2166
			Jetpack::deactivate_module( $active_module );
2167
		}
2168
2169
		$new_version = JETPACK__VERSION . ':' . time();
2170
		/** This action is documented in class.jetpack.php */
2171
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2172
		Jetpack_Options::update_options(
2173
			array(
2174
				'version'     => $new_version,
2175
				'old_version' => $jetpack_old_version,
2176
			)
2177
		);
2178
2179
		Jetpack::state( 'message', 'modules_activated' );
2180
		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...
2181
2182
		if ( $redirect ) {
2183
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2184
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2185
				$page = $_GET['page'];
2186
			}
2187
2188
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2189
			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...
2190
		}
2191
	}
2192
2193
	/**
2194
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2195
	 * Make sure to tuck away module "library" files in a sub-directory.
2196
	 */
2197
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2198
		static $modules = null;
2199
2200
		if ( ! isset( $modules ) ) {
2201
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2202
			// Use the cache if we're on the front-end and it's available...
2203
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2204
				$modules = $available_modules_option[ JETPACK__VERSION ];
2205
			} else {
2206
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2207
2208
				$modules = array();
2209
2210
				foreach ( $files as $file ) {
2211
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2212
						continue;
2213
					}
2214
2215
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2216
				}
2217
2218
				Jetpack_Options::update_option( 'available_modules', array(
2219
					JETPACK__VERSION => $modules,
2220
				) );
2221
			}
2222
		}
2223
2224
		/**
2225
		 * Filters the array of modules available to be activated.
2226
		 *
2227
		 * @since 2.4.0
2228
		 *
2229
		 * @param array $modules Array of available modules.
2230
		 * @param string $min_version Minimum version number required to use modules.
2231
		 * @param string $max_version Maximum version number required to use modules.
2232
		 */
2233
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2234
2235
		if ( ! $min_version && ! $max_version ) {
2236
			return array_keys( $mods );
2237
		}
2238
2239
		$r = array();
2240
		foreach ( $mods as $slug => $introduced ) {
2241
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2242
				continue;
2243
			}
2244
2245
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2246
				continue;
2247
			}
2248
2249
			$r[] = $slug;
2250
		}
2251
2252
		return $r;
2253
	}
2254
2255
	/**
2256
	 * Default modules loaded on activation.
2257
	 */
2258
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2259
		$return = array();
2260
2261
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2262
			$module_data = Jetpack::get_module( $module );
2263
2264
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2265
				case 'yes' :
2266
					$return[] = $module;
2267
					break;
2268
				case 'public' :
2269
					if ( Jetpack_Options::get_option( 'public' ) ) {
2270
						$return[] = $module;
2271
					}
2272
					break;
2273
				case 'no' :
2274
				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...
2275
					break;
2276
			}
2277
		}
2278
		/**
2279
		 * Filters the array of default modules.
2280
		 *
2281
		 * @since 2.5.0
2282
		 *
2283
		 * @param array $return Array of default modules.
2284
		 * @param string $min_version Minimum version number required to use modules.
2285
		 * @param string $max_version Maximum version number required to use modules.
2286
		 */
2287
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2288
	}
2289
2290
	/**
2291
	 * Checks activated modules during auto-activation to determine
2292
	 * if any of those modules are being deprecated.  If so, close
2293
	 * them out, and add any replacement modules.
2294
	 *
2295
	 * Runs at priority 99 by default.
2296
	 *
2297
	 * This is run late, so that it can still activate a module if
2298
	 * the new module is a replacement for another that the user
2299
	 * currently has active, even if something at the normal priority
2300
	 * would kibosh everything.
2301
	 *
2302
	 * @since 2.6
2303
	 * @uses jetpack_get_default_modules filter
2304
	 * @param array $modules
2305
	 * @return array
2306
	 */
2307
	function handle_deprecated_modules( $modules ) {
2308
		$deprecated_modules = array(
2309
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2310
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2311
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2312
		);
2313
2314
		// Don't activate SSO if they never completed activating WPCC.
2315
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2316
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2317
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2318
				$deprecated_modules['wpcc'] = null;
2319
			}
2320
		}
2321
2322
		foreach ( $deprecated_modules as $module => $replacement ) {
2323
			if ( Jetpack::is_module_active( $module ) ) {
2324
				self::deactivate_module( $module );
2325
				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...
2326
					$modules[] = $replacement;
2327
				}
2328
			}
2329
		}
2330
2331
		return array_unique( $modules );
2332
	}
2333
2334
	/**
2335
	 * Checks activated plugins during auto-activation to determine
2336
	 * if any of those plugins are in the list with a corresponding module
2337
	 * that is not compatible with the plugin. The module will not be allowed
2338
	 * to auto-activate.
2339
	 *
2340
	 * @since 2.6
2341
	 * @uses jetpack_get_default_modules filter
2342
	 * @param array $modules
2343
	 * @return array
2344
	 */
2345
	function filter_default_modules( $modules ) {
2346
2347
		$active_plugins = self::get_active_plugins();
2348
2349
		if ( ! empty( $active_plugins ) ) {
2350
2351
			// For each module we'd like to auto-activate...
2352
			foreach ( $modules as $key => $module ) {
2353
				// If there are potential conflicts for it...
2354
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2355
					// For each potential conflict...
2356
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2357
						// If that conflicting plugin is active...
2358
						if ( in_array( $plugin, $active_plugins ) ) {
2359
							// Remove that item from being auto-activated.
2360
							unset( $modules[ $key ] );
2361
						}
2362
					}
2363
				}
2364
			}
2365
		}
2366
2367
		return $modules;
2368
	}
2369
2370
	/**
2371
	 * Extract a module's slug from its full path.
2372
	 */
2373
	public static function get_module_slug( $file ) {
2374
		return str_replace( '.php', '', basename( $file ) );
2375
	}
2376
2377
	/**
2378
	 * Generate a module's path from its slug.
2379
	 */
2380
	public static function get_module_path( $slug ) {
2381
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2382
	}
2383
2384
	/**
2385
	 * Load module data from module file. Headers differ from WordPress
2386
	 * plugin headers to avoid them being identified as standalone
2387
	 * plugins on the WordPress plugins page.
2388
	 */
2389
	public static function get_module( $module ) {
2390
		$headers = array(
2391
			'name'                      => 'Module Name',
2392
			'description'               => 'Module Description',
2393
			'jumpstart_desc'            => 'Jumpstart Description',
2394
			'sort'                      => 'Sort Order',
2395
			'recommendation_order'      => 'Recommendation Order',
2396
			'introduced'                => 'First Introduced',
2397
			'changed'                   => 'Major Changes In',
2398
			'deactivate'                => 'Deactivate',
2399
			'free'                      => 'Free',
2400
			'requires_connection'       => 'Requires Connection',
2401
			'auto_activate'             => 'Auto Activate',
2402
			'module_tags'               => 'Module Tags',
2403
			'feature'                   => 'Feature',
2404
			'additional_search_queries' => 'Additional Search Queries',
2405
		);
2406
2407
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2408
2409
		$mod = Jetpack::get_file_data( $file, $headers );
2410
		if ( empty( $mod['name'] ) ) {
2411
			return false;
2412
		}
2413
2414
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2415
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2416
		$mod['deactivate']              = empty( $mod['deactivate'] );
2417
		$mod['free']                    = empty( $mod['free'] );
2418
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2419
2420
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2421
			$mod['auto_activate'] = 'No';
2422
		} else {
2423
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2424
		}
2425
2426
		if ( $mod['module_tags'] ) {
2427
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2428
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2429
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2430
		} else {
2431
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2432
		}
2433
2434
		if ( $mod['feature'] ) {
2435
			$mod['feature'] = explode( ',', $mod['feature'] );
2436
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2437
		} else {
2438
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2439
		}
2440
2441
		/**
2442
		 * Filters the feature array on a module.
2443
		 *
2444
		 * This filter allows you to control where each module is filtered: Recommended,
2445
		 * Jumpstart, and the default "Other" listing.
2446
		 *
2447
		 * @since 3.5.0
2448
		 *
2449
		 * @param array   $mod['feature'] The areas to feature this module:
2450
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2451
		 *     'Recommended' shows on the main Jetpack admin screen.
2452
		 *     'Other' should be the default if no other value is in the array.
2453
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2454
		 * @param array   $mod All the currently assembled module data.
2455
		 */
2456
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2457
2458
		/**
2459
		 * Filter the returned data about a module.
2460
		 *
2461
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2462
		 * so please be careful.
2463
		 *
2464
		 * @since 3.6.0
2465
		 *
2466
		 * @param array   $mod    The details of the requested module.
2467
		 * @param string  $module The slug of the module, e.g. sharedaddy
2468
		 * @param string  $file   The path to the module source file.
2469
		 */
2470
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2471
	}
2472
2473
	/**
2474
	 * Like core's get_file_data implementation, but caches the result.
2475
	 */
2476
	public static function get_file_data( $file, $headers ) {
2477
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2478
		$file_name = basename( $file );
2479
2480
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2481
2482
		$file_data_option = get_transient( $cache_key );
2483
2484
		if ( false === $file_data_option ) {
2485
			$file_data_option = array();
2486
		}
2487
2488
		$key           = md5( $file_name . serialize( $headers ) );
2489
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2490
2491
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2492
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2493
			return $file_data_option[ $key ];
2494
		}
2495
2496
		$data = get_file_data( $file, $headers );
2497
2498
		$file_data_option[ $key ] = $data;
2499
2500
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2501
2502
		return $data;
2503
	}
2504
2505
2506
	/**
2507
	 * Return translated module tag.
2508
	 *
2509
	 * @param string $tag Tag as it appears in each module heading.
2510
	 *
2511
	 * @return mixed
2512
	 */
2513
	public static function translate_module_tag( $tag ) {
2514
		return jetpack_get_module_i18n_tag( $tag );
2515
	}
2516
2517
	/**
2518
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2519
	 *
2520
	 * @since 3.9.2
2521
	 *
2522
	 * @param array $modules
2523
	 *
2524
	 * @return string|void
2525
	 */
2526
	public static function get_translated_modules( $modules ) {
2527
		foreach ( $modules as $index => $module ) {
2528
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2529
			if ( isset( $module['name'] ) ) {
2530
				$modules[ $index ]['name'] = $i18n_module['name'];
2531
			}
2532
			if ( isset( $module['description'] ) ) {
2533
				$modules[ $index ]['description'] = $i18n_module['description'];
2534
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2535
			}
2536
		}
2537
		return $modules;
2538
	}
2539
2540
	/**
2541
	 * Get a list of activated modules as an array of module slugs.
2542
	 */
2543
	public static function get_active_modules() {
2544
		$active = Jetpack_Options::get_option( 'active_modules' );
2545
2546
		if ( ! is_array( $active ) ) {
2547
			$active = array();
2548
		}
2549
2550
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2551
			$active[] = 'vaultpress';
2552
		} else {
2553
			$active = array_diff( $active, array( 'vaultpress' ) );
2554
		}
2555
2556
		//If protect is active on the main site of a multisite, it should be active on all sites.
2557
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2558
			$active[] = 'protect';
2559
		}
2560
2561
		return array_unique( $active );
2562
	}
2563
2564
	/**
2565
	 * Check whether or not a Jetpack module is active.
2566
	 *
2567
	 * @param string $module The slug of a Jetpack module.
2568
	 * @return bool
2569
	 *
2570
	 * @static
2571
	 */
2572
	public static function is_module_active( $module ) {
2573
		return in_array( $module, self::get_active_modules() );
2574
	}
2575
2576
	public static function is_module( $module ) {
2577
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2578
	}
2579
2580
	/**
2581
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2582
	 *
2583
	 * @param bool $catch True to start catching, False to stop.
2584
	 *
2585
	 * @static
2586
	 */
2587
	public static function catch_errors( $catch ) {
2588
		static $display_errors, $error_reporting;
2589
2590
		if ( $catch ) {
2591
			$display_errors  = @ini_set( 'display_errors', 1 );
2592
			$error_reporting = @error_reporting( E_ALL );
2593
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2594
		} else {
2595
			@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...
2596
			@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...
2597
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2598
		}
2599
	}
2600
2601
	/**
2602
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2603
	 */
2604
	public static function catch_errors_on_shutdown() {
2605
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2606
	}
2607
2608
	/**
2609
	 * Rewrite any string to make paths easier to read.
2610
	 *
2611
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2612
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2613
	 *
2614
	 * @param $string
2615
	 * @return mixed
2616
	 */
2617
	public static function alias_directories( $string ) {
2618
		// ABSPATH has a trailing slash.
2619
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2620
		// WP_CONTENT_DIR does not have a trailing slash.
2621
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2622
2623
		return $string;
2624
	}
2625
2626
	public static function activate_default_modules(
2627
		$min_version = false,
2628
		$max_version = false,
2629
		$other_modules = array(),
2630
		$redirect = true,
2631
		$send_state_messages = true
2632
	) {
2633
		$jetpack = Jetpack::init();
2634
2635
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2636
		$modules = array_merge( $other_modules, $modules );
2637
2638
		// Look for standalone plugins and disable if active.
2639
2640
		$to_deactivate = array();
2641
		foreach ( $modules as $module ) {
2642
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2643
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2644
			}
2645
		}
2646
2647
		$deactivated = array();
2648
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2649
			list( $probable_file, $probable_title ) = $deactivate_me;
2650
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2651
				$deactivated[] = $module;
2652
			}
2653
		}
2654
2655
		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...
2656
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2657
2658
			$url = add_query_arg(
2659
				array(
2660
					'action'   => 'activate_default_modules',
2661
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2662
				),
2663
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2664
			);
2665
			wp_safe_redirect( $url );
2666
			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...
2667
		}
2668
2669
		/**
2670
		 * Fires before default modules are activated.
2671
		 *
2672
		 * @since 1.9.0
2673
		 *
2674
		 * @param string $min_version Minimum version number required to use modules.
2675
		 * @param string $max_version Maximum version number required to use modules.
2676
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2677
		 */
2678
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2679
2680
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2681
		Jetpack::restate();
2682
		Jetpack::catch_errors( true );
2683
2684
		$active = Jetpack::get_active_modules();
2685
2686
		foreach ( $modules as $module ) {
2687
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2688
				$active[] = $module;
2689
				self::update_active_modules( $active );
2690
				continue;
2691
			}
2692
2693
			if ( $send_state_messages && in_array( $module, $active ) ) {
2694
				$module_info = Jetpack::get_module( $module );
2695 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2696
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2697
					if ( $active_state = Jetpack::state( $state ) ) {
2698
						$active_state = explode( ',', $active_state );
2699
					} else {
2700
						$active_state = array();
2701
					}
2702
					$active_state[] = $module;
2703
					Jetpack::state( $state, implode( ',', $active_state ) );
2704
				}
2705
				continue;
2706
			}
2707
2708
			$file = Jetpack::get_module_path( $module );
2709
			if ( ! file_exists( $file ) ) {
2710
				continue;
2711
			}
2712
2713
			// we'll override this later if the plugin can be included without fatal error
2714
			if ( $redirect ) {
2715
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2716
			}
2717
2718
			if ( $send_state_messages ) {
2719
				Jetpack::state( 'error', 'module_activation_failed' );
2720
				Jetpack::state( 'module', $module );
2721
			}
2722
2723
			ob_start();
2724
			require $file;
2725
2726
			$active[] = $module;
2727
2728 View Code Duplication
			if ( $send_state_messages ) {
2729
2730
				$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...
2731
				if ( $active_state = Jetpack::state( $state ) ) {
2732
					$active_state = explode( ',', $active_state );
2733
				} else {
2734
					$active_state = array();
2735
				}
2736
				$active_state[] = $module;
2737
				Jetpack::state( $state, implode( ',', $active_state ) );
2738
			}
2739
2740
			Jetpack::update_active_modules( $active );
2741
2742
			ob_end_clean();
2743
		}
2744
2745
		if ( $send_state_messages ) {
2746
			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...
2747
			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...
2748
		}
2749
2750
		Jetpack::catch_errors( false );
2751
		/**
2752
		 * Fires when default modules are activated.
2753
		 *
2754
		 * @since 1.9.0
2755
		 *
2756
		 * @param string $min_version Minimum version number required to use modules.
2757
		 * @param string $max_version Maximum version number required to use modules.
2758
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2759
		 */
2760
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2761
	}
2762
2763
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2764
		/**
2765
		 * Fires before a module is activated.
2766
		 *
2767
		 * @since 2.6.0
2768
		 *
2769
		 * @param string $module Module slug.
2770
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2771
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2772
		 */
2773
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2774
2775
		$jetpack = Jetpack::init();
2776
2777
		if ( ! strlen( $module ) )
2778
			return false;
2779
2780
		if ( ! Jetpack::is_module( $module ) )
2781
			return false;
2782
2783
		// If it's already active, then don't do it again
2784
		$active = Jetpack::get_active_modules();
2785
		foreach ( $active as $act ) {
2786
			if ( $act == $module )
2787
				return true;
2788
		}
2789
2790
		$module_data = Jetpack::get_module( $module );
2791
2792
		if ( ! Jetpack::is_active() ) {
2793
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2794
				return false;
2795
2796
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2797
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2798
				return false;
2799
		}
2800
2801
		// Check and see if the old plugin is active
2802
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2803
			// Deactivate the old plugin
2804
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2805
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2806
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2807
				Jetpack::state( 'deactivated_plugins', $module );
2808
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2809
				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...
2810
			}
2811
		}
2812
2813
		// Protect won't work with mis-configured IPs
2814
		if ( 'protect' === $module ) {
2815
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2816
			if ( ! jetpack_protect_get_ip() ) {
2817
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2818
				return false;
2819
			}
2820
		}
2821
2822
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2823
		Jetpack::state( 'module', $module );
2824
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2825
2826
		Jetpack::catch_errors( true );
2827
		ob_start();
2828
		require Jetpack::get_module_path( $module );
2829
		/** This action is documented in class.jetpack.php */
2830
		do_action( 'jetpack_activate_module', $module );
2831
		$active[] = $module;
2832
		Jetpack::update_active_modules( $active );
2833
2834
		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...
2835
		ob_end_clean();
2836
		Jetpack::catch_errors( false );
2837
2838
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2839 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2840
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2841
2842
			//Jump start is being dismissed send data to MC Stats
2843
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2844
2845
			$jetpack->do_stats( 'server_side' );
2846
		}
2847
2848
		if ( $redirect ) {
2849
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2850
		}
2851
		if ( $exit ) {
2852
			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...
2853
		}
2854
		return true;
2855
	}
2856
2857
	function activate_module_actions( $module ) {
2858
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2859
	}
2860
2861
	public static function deactivate_module( $module ) {
2862
		/**
2863
		 * Fires when a module is deactivated.
2864
		 *
2865
		 * @since 1.9.0
2866
		 *
2867
		 * @param string $module Module slug.
2868
		 */
2869
		do_action( 'jetpack_pre_deactivate_module', $module );
2870
2871
		$jetpack = Jetpack::init();
2872
2873
		$active = Jetpack::get_active_modules();
2874
		$new    = array_filter( array_diff( $active, (array) $module ) );
2875
2876
		// A flag for Jump Start so it's not shown again.
2877 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2878
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2879
2880
			//Jump start is being dismissed send data to MC Stats
2881
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2882
2883
			$jetpack->do_stats( 'server_side' );
2884
		}
2885
2886
		return self::update_active_modules( $new );
2887
	}
2888
2889
	public static function enable_module_configurable( $module ) {
2890
		$module = Jetpack::get_module_slug( $module );
2891
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2892
	}
2893
2894
	public static function module_configuration_url( $module ) {
2895
		$module = Jetpack::get_module_slug( $module );
2896
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2897
	}
2898
2899
	public static function module_configuration_load( $module, $method ) {
2900
		$module = Jetpack::get_module_slug( $module );
2901
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2902
	}
2903
2904
	public static function module_configuration_head( $module, $method ) {
2905
		$module = Jetpack::get_module_slug( $module );
2906
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2907
	}
2908
2909
	public static function module_configuration_screen( $module, $method ) {
2910
		$module = Jetpack::get_module_slug( $module );
2911
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2912
	}
2913
2914
	public static function module_configuration_activation_screen( $module, $method ) {
2915
		$module = Jetpack::get_module_slug( $module );
2916
		add_action( 'display_activate_module_setting_' . $module, $method );
2917
	}
2918
2919
/* Installation */
2920
2921
	public static function bail_on_activation( $message, $deactivate = true ) {
2922
?>
2923
<!doctype html>
2924
<html>
2925
<head>
2926
<meta charset="<?php bloginfo( 'charset' ); ?>">
2927
<style>
2928
* {
2929
	text-align: center;
2930
	margin: 0;
2931
	padding: 0;
2932
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2933
}
2934
p {
2935
	margin-top: 1em;
2936
	font-size: 18px;
2937
}
2938
</style>
2939
<body>
2940
<p><?php echo esc_html( $message ); ?></p>
2941
</body>
2942
</html>
2943
<?php
2944
		if ( $deactivate ) {
2945
			$plugins = get_option( 'active_plugins' );
2946
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2947
			$update  = false;
2948
			foreach ( $plugins as $i => $plugin ) {
2949
				if ( $plugin === $jetpack ) {
2950
					$plugins[$i] = false;
2951
					$update = true;
2952
				}
2953
			}
2954
2955
			if ( $update ) {
2956
				update_option( 'active_plugins', array_filter( $plugins ) );
2957
			}
2958
		}
2959
		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...
2960
	}
2961
2962
	/**
2963
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2964
	 * @static
2965
	 */
2966
	public static function plugin_activation( $network_wide ) {
2967
		Jetpack_Options::update_option( 'activated', 1 );
2968
2969
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2970
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2971
		}
2972
2973
		if ( $network_wide )
2974
			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...
2975
2976
		// For firing one-off events (notices) immediately after activation
2977
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2978
2979
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2980
2981
		Jetpack::plugin_initialize();
2982
	}
2983
2984
	public static function get_activation_source( $referer_url ) {
2985
2986
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2987
			return array( 'wp-cli', null );
2988
		}
2989
2990
		$referer = parse_url( $referer_url );
2991
2992
		$source_type = 'unknown';
2993
		$source_query = null;
2994
2995
		if ( ! is_array( $referer ) ) {
2996
			return array( $source_type, $source_query );
2997
		}
2998
2999
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3000
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3001
3002
		if ( isset( $referer['query'] ) ) {
3003
			parse_str( $referer['query'], $query_parts );
3004
		} else {
3005
			$query_parts = array();
3006
		}
3007
3008
		if ( $plugins_path === $referer['path'] ) {
3009
			$source_type = 'list';
3010
		} elseif ( $plugins_install_path === $referer['path'] ) {
3011
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3012
			switch( $tab ) {
3013
				case 'popular':
3014
					$source_type = 'popular';
3015
					break;
3016
				case 'recommended':
3017
					$source_type = 'recommended';
3018
					break;
3019
				case 'favorites':
3020
					$source_type = 'favorites';
3021
					break;
3022
				case 'search':
3023
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3024
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3025
					break;
3026
				default:
3027
					$source_type = 'featured';
3028
			}
3029
		}
3030
3031
		return array( $source_type, $source_query );
3032
	}
3033
3034
	/**
3035
	 * Runs before bumping version numbers up to a new version
3036
	 * @param  string $version    Version:timestamp
3037
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3038
	 * @return null              [description]
3039
	 */
3040
	public static function do_version_bump( $version, $old_version ) {
3041
3042
		if ( ! $old_version ) { // For new sites
3043
			// Setting up jetpack manage
3044
			Jetpack::activate_manage();
3045
		}
3046
	}
3047
3048
	/**
3049
	 * Sets the internal version number and activation state.
3050
	 * @static
3051
	 */
3052
	public static function plugin_initialize() {
3053
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3054
			Jetpack_Options::update_option( 'activated', 2 );
3055
		}
3056
3057 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3058
			$version = $old_version = JETPACK__VERSION . ':' . time();
3059
			/** This action is documented in class.jetpack.php */
3060
			do_action( 'updating_jetpack_version', $version, false );
3061
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3062
		}
3063
3064
		Jetpack::load_modules();
3065
3066
		Jetpack_Options::delete_option( 'do_activate' );
3067
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3068
	}
3069
3070
	/**
3071
	 * Removes all connection options
3072
	 * @static
3073
	 */
3074
	public static function plugin_deactivation( ) {
3075
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3076
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3077
			Jetpack_Network::init()->deactivate();
3078
		} else {
3079
			Jetpack::disconnect( false );
3080
			//Jetpack_Heartbeat::init()->deactivate();
3081
		}
3082
	}
3083
3084
	/**
3085
	 * Disconnects from the Jetpack servers.
3086
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3087
	 * @static
3088
	 */
3089
	public static function disconnect( $update_activated_state = true ) {
3090
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3091
		Jetpack::clean_nonces( true );
3092
3093
		// If the site is in an IDC because sync is not allowed,
3094
		// let's make sure to not disconnect the production site.
3095
		if ( ! self::validate_sync_error_idc_option() ) {
3096
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3097
			Jetpack::load_xml_rpc_client();
3098
			$xml = new Jetpack_IXR_Client();
3099
			$xml->query( 'jetpack.deregister' );
3100
		}
3101
3102
		Jetpack_Options::delete_option(
3103
			array(
3104
				'blog_token',
3105
				'user_token',
3106
				'user_tokens',
3107
				'master_user',
3108
				'time_diff',
3109
				'fallback_no_verify_ssl_certs',
3110
			)
3111
		);
3112
3113
		Jetpack_IDC::clear_all_idc_options();
3114
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3115
3116
		if ( $update_activated_state ) {
3117
			Jetpack_Options::update_option( 'activated', 4 );
3118
		}
3119
3120
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3121
			// Check then record unique disconnection if site has never been disconnected previously
3122
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3123
				$jetpack_unique_connection['disconnected'] = 1;
3124
			} else {
3125
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3126
					//track unique disconnect
3127
					$jetpack = Jetpack::init();
3128
3129
					$jetpack->stat( 'connections', 'unique-disconnect' );
3130
					$jetpack->do_stats( 'server_side' );
3131
				}
3132
				// increment number of times disconnected
3133
				$jetpack_unique_connection['disconnected'] += 1;
3134
			}
3135
3136
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3137
		}
3138
3139
		// Delete cached connected user data
3140
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3141
		delete_transient( $transient_key );
3142
3143
		// Delete all the sync related data. Since it could be taking up space.
3144
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3145
		Jetpack_Sync_Sender::get_instance()->uninstall();
3146
3147
		// Disable the Heartbeat cron
3148
		Jetpack_Heartbeat::init()->deactivate();
3149
	}
3150
3151
	/**
3152
	 * Unlinks the current user from the linked WordPress.com user
3153
	 */
3154
	public static function unlink_user( $user_id = null ) {
3155
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3156
			return false;
3157
3158
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3159
3160
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3161
			return false;
3162
3163
		if ( ! isset( $tokens[ $user_id ] ) )
3164
			return false;
3165
3166
		Jetpack::load_xml_rpc_client();
3167
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3168
		$xml->query( 'jetpack.unlink_user', $user_id );
3169
3170
		unset( $tokens[ $user_id ] );
3171
3172
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3173
3174
		/**
3175
		 * Fires after the current user has been unlinked from WordPress.com.
3176
		 *
3177
		 * @since 4.1.0
3178
		 *
3179
		 * @param int $user_id The current user's ID.
3180
		 */
3181
		do_action( 'jetpack_unlinked_user', $user_id );
3182
3183
		return true;
3184
	}
3185
3186
	/**
3187
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3188
	 */
3189
	public static function try_registration() {
3190
		// Let's get some testing in beta versions and such.
3191
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3192
			// Before attempting to connect, let's make sure that the domains are viable.
3193
			$domains_to_check = array_unique( array(
3194
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3195
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3196
			) );
3197
			foreach ( $domains_to_check as $domain ) {
3198
				$result = Jetpack_Data::is_usable_domain( $domain );
3199
				if ( is_wp_error( $result ) ) {
3200
					return $result;
3201
				}
3202
			}
3203
		}
3204
3205
		$result = Jetpack::register();
3206
3207
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3208
		if ( ! $result || is_wp_error( $result ) ) {
3209
			return $result;
3210
		} else {
3211
			return true;
3212
		}
3213
	}
3214
3215
	/**
3216
	 * Tracking an internal event log. Try not to put too much chaff in here.
3217
	 *
3218
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3219
	 */
3220
	public static function log( $code, $data = null ) {
3221
		// only grab the latest 200 entries
3222
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3223
3224
		// Append our event to the log
3225
		$log_entry = array(
3226
			'time'    => time(),
3227
			'user_id' => get_current_user_id(),
3228
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3229
			'code'    => $code,
3230
		);
3231
		// Don't bother storing it unless we've got some.
3232
		if ( ! is_null( $data ) ) {
3233
			$log_entry['data'] = $data;
3234
		}
3235
		$log[] = $log_entry;
3236
3237
		// Try add_option first, to make sure it's not autoloaded.
3238
		// @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...
3239
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3240
			Jetpack_Options::update_option( 'log', $log );
3241
		}
3242
3243
		/**
3244
		 * Fires when Jetpack logs an internal event.
3245
		 *
3246
		 * @since 3.0.0
3247
		 *
3248
		 * @param array $log_entry {
3249
		 *	Array of details about the log entry.
3250
		 *
3251
		 *	@param string time Time of the event.
3252
		 *	@param int user_id ID of the user who trigerred the event.
3253
		 *	@param int blog_id Jetpack Blog ID.
3254
		 *	@param string code Unique name for the event.
3255
		 *	@param string data Data about the event.
3256
		 * }
3257
		 */
3258
		do_action( 'jetpack_log_entry', $log_entry );
3259
	}
3260
3261
	/**
3262
	 * Get the internal event log.
3263
	 *
3264
	 * @param $event (string) - only return the specific log events
3265
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3266
	 *
3267
	 * @return array of log events || WP_Error for invalid params
3268
	 */
3269
	public static function get_log( $event = false, $num = false ) {
3270
		if ( $event && ! is_string( $event ) ) {
3271
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3272
		}
3273
3274
		if ( $num && ! is_numeric( $num ) ) {
3275
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3276
		}
3277
3278
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3279
3280
		// If nothing set - act as it did before, otherwise let's start customizing the output
3281
		if ( ! $num && ! $event ) {
3282
			return $entire_log;
3283
		} else {
3284
			$entire_log = array_reverse( $entire_log );
3285
		}
3286
3287
		$custom_log_output = array();
3288
3289
		if ( $event ) {
3290
			foreach ( $entire_log as $log_event ) {
3291
				if ( $event == $log_event[ 'code' ] ) {
3292
					$custom_log_output[] = $log_event;
3293
				}
3294
			}
3295
		} else {
3296
			$custom_log_output = $entire_log;
3297
		}
3298
3299
		if ( $num ) {
3300
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3301
		}
3302
3303
		return $custom_log_output;
3304
	}
3305
3306
	/**
3307
	 * Log modification of important settings.
3308
	 */
3309
	public static function log_settings_change( $option, $old_value, $value ) {
3310
		switch( $option ) {
3311
			case 'jetpack_sync_non_public_post_stati':
3312
				self::log( $option, $value );
3313
				break;
3314
		}
3315
	}
3316
3317
	/**
3318
	 * Return stat data for WPCOM sync
3319
	 */
3320
	public static function get_stat_data( $encode = true, $extended = true ) {
3321
		$data = Jetpack_Heartbeat::generate_stats_array();
3322
3323
		if ( $extended ) {
3324
			$additional_data = self::get_additional_stat_data();
3325
			$data = array_merge( $data, $additional_data );
3326
		}
3327
3328
		if ( $encode ) {
3329
			return json_encode( $data );
3330
		}
3331
3332
		return $data;
3333
	}
3334
3335
	/**
3336
	 * Get additional stat data to sync to WPCOM
3337
	 */
3338
	public static function get_additional_stat_data( $prefix = '' ) {
3339
		$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...
3340
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3341
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3342
		$return["{$prefix}site-count"]     = 0;
3343
3344
		if ( function_exists( 'get_blog_count' ) ) {
3345
			$return["{$prefix}site-count"] = get_blog_count();
3346
		}
3347
		return $return;
3348
	}
3349
3350
	private static function get_site_user_count() {
3351
		global $wpdb;
3352
3353
		if ( function_exists( 'wp_is_large_network' ) ) {
3354
			if ( wp_is_large_network( 'users' ) ) {
3355
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3356
			}
3357
		}
3358 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3359
			// It wasn't there, so regenerate the data and save the transient
3360
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3361
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3362
		}
3363
		return $user_count;
3364
	}
3365
3366
	/* Admin Pages */
3367
3368
	function admin_init() {
3369
		// If the plugin is not connected, display a connect message.
3370
		if (
3371
			// the plugin was auto-activated and needs its candy
3372
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3373
		||
3374
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3375
			! Jetpack_Options::get_option( 'activated' )
3376
		) {
3377
			Jetpack::plugin_initialize();
3378
		}
3379
3380
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3381
			Jetpack_Connection_Banner::init();
3382
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3383
			// Upgrade: 1.1 -> 1.1.1
3384
			// Check and see if host can verify the Jetpack servers' SSL certificate
3385
			$args = array();
3386
			Jetpack_Client::_wp_remote_request(
3387
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3388
				$args,
3389
				true
3390
			);
3391
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3392
			// Show the notice on the Dashboard only for now
3393
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3394
		}
3395
3396
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3397
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3398
		}
3399
3400
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3401
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3402
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3403
3404
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3405
			// Artificially throw errors in certain whitelisted cases during plugin activation
3406
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3407
		}
3408
3409
		// Jetpack Manage Activation Screen from .com
3410
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3411
3412
		// Add custom column in wp-admin/users.php to show whether user is linked.
3413
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3414
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3415
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3416
	}
3417
3418
	function admin_body_class( $admin_body_class = '' ) {
3419
		$classes = explode( ' ', trim( $admin_body_class ) );
3420
3421
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3422
3423
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3424
		return " $admin_body_class ";
3425
	}
3426
3427
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3428
		return $admin_body_class . ' jetpack-pagestyles ';
3429
	}
3430
3431
	/**
3432
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3433
	 *
3434
	 * @return null
3435
	 */
3436
	function prepare_manage_jetpack_notice() {
3437
3438
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3439
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3440
	}
3441
3442
	function manage_activate_screen() {
3443
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3444
	}
3445
	/**
3446
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3447
	 * This function artificially throws errors for such cases (whitelisted).
3448
	 *
3449
	 * @param string $plugin The activated plugin.
3450
	 */
3451
	function throw_error_on_activate_plugin( $plugin ) {
3452
		$active_modules = Jetpack::get_active_modules();
3453
3454
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3455
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3456
			$throw = false;
3457
3458
			// Try and make sure it really was the stats plugin
3459
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3460
				if ( 'stats.php' == basename( $plugin ) ) {
3461
					$throw = true;
3462
				}
3463
			} else {
3464
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3465
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3466
					$throw = true;
3467
				}
3468
			}
3469
3470
			if ( $throw ) {
3471
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3472
			}
3473
		}
3474
	}
3475
3476
	function intercept_plugin_error_scrape_init() {
3477
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3478
	}
3479
3480
	function intercept_plugin_error_scrape( $action, $result ) {
3481
		if ( ! $result ) {
3482
			return;
3483
		}
3484
3485
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3486
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3487
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3488
			}
3489
		}
3490
	}
3491
3492
	function add_remote_request_handlers() {
3493
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3494
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3495
	}
3496
3497
	function remote_request_handlers() {
3498
		$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...
3499
3500
		switch ( current_filter() ) {
3501
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3502
			$response = $this->upload_handler();
3503
			break;
3504
3505
		case 'wp_ajax_nopriv_jetpack_update_file' :
3506
			$response = $this->upload_handler( true );
3507
			break;
3508
		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...
3509
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3510
			break;
3511
		}
3512
3513
		if ( ! $response ) {
3514
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3515
		}
3516
3517
		if ( is_wp_error( $response ) ) {
3518
			$status_code       = $response->get_error_data();
3519
			$error             = $response->get_error_code();
3520
			$error_description = $response->get_error_message();
3521
3522
			if ( ! is_int( $status_code ) ) {
3523
				$status_code = 400;
3524
			}
3525
3526
			status_header( $status_code );
3527
			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...
3528
		}
3529
3530
		status_header( 200 );
3531
		if ( true === $response ) {
3532
			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...
3533
		}
3534
3535
		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...
3536
	}
3537
3538
	/**
3539
	 * Uploads a file gotten from the global $_FILES.
3540
	 * If `$update_media_item` is true and `post_id` is defined
3541
	 * the attachment file of the media item (gotten through of the post_id)
3542
	 * will be updated instead of add a new one.
3543
	 *
3544
	 * @param  boolean $update_media_item - update media attachment
3545
	 * @return array - An array describing the uploadind files process
3546
	 */
3547
	function upload_handler( $update_media_item = false ) {
3548
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3549
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3550
		}
3551
3552
		$user = wp_authenticate( '', '' );
3553
		if ( ! $user || is_wp_error( $user ) ) {
3554
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3555
		}
3556
3557
		wp_set_current_user( $user->ID );
3558
3559
		if ( ! current_user_can( 'upload_files' ) ) {
3560
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3561
		}
3562
3563
		if ( empty( $_FILES ) ) {
3564
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3565
		}
3566
3567
		foreach ( array_keys( $_FILES ) as $files_key ) {
3568
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3569
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3570
			}
3571
		}
3572
3573
		$media_keys = array_keys( $_FILES['media'] );
3574
3575
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3576
		if ( ! $token || is_wp_error( $token ) ) {
3577
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3578
		}
3579
3580
		$uploaded_files = array();
3581
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3582
		unset( $GLOBALS['post'] );
3583
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3584
			$file = array();
3585
			foreach ( $media_keys as $media_key ) {
3586
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3587
			}
3588
3589
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3590
3591
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3592
			if ( $hmac_provided !== $hmac_file ) {
3593
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3594
				continue;
3595
			}
3596
3597
			$_FILES['.jetpack.upload.'] = $file;
3598
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3599
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3600
				$post_id = 0;
3601
			}
3602
3603
			if ( $update_media_item ) {
3604
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3605
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3606
				}
3607
3608
				$media_array = $_FILES['media'];
3609
3610
				$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...
3611
				$file_array['type'] = $media_array['type'][0];
3612
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3613
				$file_array['error'] = $media_array['error'][0];
3614
				$file_array['size'] = $media_array['size'][0];
3615
3616
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3617
3618
				if ( is_wp_error( $edited_media_item ) ) {
3619
					return $edited_media_item;
3620
				}
3621
3622
				$response = (object) array(
3623
					'id'   => (string) $post_id,
3624
					'file' => (string) $edited_media_item->post_title,
3625
					'url'  => (string) wp_get_attachment_url( $post_id ),
3626
					'type' => (string) $edited_media_item->post_mime_type,
3627
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3628
				);
3629
3630
				return (array) array( $response );
3631
			}
3632
3633
			$attachment_id = media_handle_upload(
3634
				'.jetpack.upload.',
3635
				$post_id,
3636
				array(),
3637
				array(
3638
					'action' => 'jetpack_upload_file',
3639
				)
3640
			);
3641
3642
			if ( ! $attachment_id ) {
3643
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3644
			} elseif ( is_wp_error( $attachment_id ) ) {
3645
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3646
			} else {
3647
				$attachment = get_post( $attachment_id );
3648
				$uploaded_files[$index] = (object) array(
3649
					'id'   => (string) $attachment_id,
3650
					'file' => $attachment->post_title,
3651
					'url'  => wp_get_attachment_url( $attachment_id ),
3652
					'type' => $attachment->post_mime_type,
3653
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3654
				);
3655
				// Zip files uploads are not supported unless they are done for installation purposed
3656
				// lets delete them in case something goes wrong in this whole process
3657
				if ( 'application/zip' === $attachment->post_mime_type ) {
3658
					// Schedule a cleanup for 2 hours from now in case of failed install.
3659
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3660
				}
3661
			}
3662
		}
3663
		if ( ! is_null( $global_post ) ) {
3664
			$GLOBALS['post'] = $global_post;
3665
		}
3666
3667
		return $uploaded_files;
3668
	}
3669
3670
	/**
3671
	 * Add help to the Jetpack page
3672
	 *
3673
	 * @since Jetpack (1.2.3)
3674
	 * @return false if not the Jetpack page
3675
	 */
3676
	function admin_help() {
3677
		$current_screen = get_current_screen();
3678
3679
		// Overview
3680
		$current_screen->add_help_tab(
3681
			array(
3682
				'id'		=> 'home',
3683
				'title'		=> __( 'Home', 'jetpack' ),
3684
				'content'	=>
3685
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3686
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3687
					'<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>',
3688
			)
3689
		);
3690
3691
		// Screen Content
3692
		if ( current_user_can( 'manage_options' ) ) {
3693
			$current_screen->add_help_tab(
3694
				array(
3695
					'id'		=> 'settings',
3696
					'title'		=> __( 'Settings', 'jetpack' ),
3697
					'content'	=>
3698
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3699
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3700
						'<ol>' .
3701
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3702
							'<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>' .
3703
						'</ol>' .
3704
						'<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>'
3705
				)
3706
			);
3707
		}
3708
3709
		// Help Sidebar
3710
		$current_screen->set_help_sidebar(
3711
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3712
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3713
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3714
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3715
		);
3716
	}
3717
3718
	function admin_menu_css() {
3719
		wp_enqueue_style( 'jetpack-icons' );
3720
	}
3721
3722
	function admin_menu_order() {
3723
		return true;
3724
	}
3725
3726 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3727
		$jp_menu_order = array();
3728
3729
		foreach ( $menu_order as $index => $item ) {
3730
			if ( $item != 'jetpack' ) {
3731
				$jp_menu_order[] = $item;
3732
			}
3733
3734
			if ( $index == 0 ) {
3735
				$jp_menu_order[] = 'jetpack';
3736
			}
3737
		}
3738
3739
		return $jp_menu_order;
3740
	}
3741
3742
	function admin_head() {
3743 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3744
			/** This action is documented in class.jetpack-admin-page.php */
3745
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3746
	}
3747
3748
	function admin_banner_styles() {
3749
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3750
3751 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3752
			wp_register_style(
3753
				'jetpack-dops-style',
3754
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3755
				array(),
3756
				JETPACK__VERSION
3757
			);
3758
		}
3759
3760
		wp_enqueue_style(
3761
			'jetpack',
3762
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3763
			array( 'jetpack-dops-style' ),
3764
			 JETPACK__VERSION . '-20121016'
3765
		);
3766
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3767
		wp_style_add_data( 'jetpack', 'suffix', $min );
3768
	}
3769
3770
	function plugin_action_links( $actions ) {
3771
3772
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3773
3774
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3775
			return array_merge(
3776
				$jetpack_home,
3777
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3778
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3779
				$actions
3780
				);
3781
			}
3782
3783
		return array_merge( $jetpack_home, $actions );
3784
	}
3785
3786
	/**
3787
	 * This is the first banner
3788
	 * It should be visible only to user that can update the option
3789
	 * Are not connected
3790
	 *
3791
	 * @return null
3792
	 */
3793
	function admin_jetpack_manage_notice() {
3794
		$screen = get_current_screen();
3795
3796
		// Don't show the connect notice on the jetpack settings page.
3797
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3798
			return;
3799
		}
3800
3801
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3802
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3803
		/**
3804
		 * I think it would be great to have different wordsing depending on where you are
3805
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3806
		 * etc..
3807
		 */
3808
3809
		?>
3810
		<div id="message" class="updated jp-banner">
3811
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3812
				<div class="jp-banner__description-container">
3813
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3814
					<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>
3815
					<p class="jp-banner__button-container">
3816
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3817
						<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>
3818
					</p>
3819
				</div>
3820
		</div>
3821
		<?php
3822
	}
3823
3824
	/**
3825
	 * Returns the url that the user clicks to remove the notice for the big banner
3826
	 * @return string
3827
	 */
3828
	function opt_out_jetpack_manage_url() {
3829
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3830
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3831
	}
3832
	/**
3833
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3834
	 * @return string
3835
	 */
3836
	function opt_in_jetpack_manage_url() {
3837
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3838
	}
3839
3840
	function opt_in_jetpack_manage_notice() {
3841
		?>
3842
		<div class="wrap">
3843
			<div id="message" class="jetpack-message is-opt-in">
3844
				<?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' ); ?>
3845
			</div>
3846
		</div>
3847
		<?php
3848
3849
	}
3850
	/**
3851
	 * Determines whether to show the notice of not true = display notice
3852
	 * @return bool
3853
	 */
3854
	function can_display_jetpack_manage_notice() {
3855
		// never display the notice to users that can't do anything about it anyways
3856
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3857
			return false;
3858
3859
		// don't display if we are in development more
3860
		if( Jetpack::is_development_mode() ) {
3861
			return false;
3862
		}
3863
		// don't display if the site is private
3864
		if(  ! Jetpack_Options::get_option( 'public' ) )
3865
			return false;
3866
3867
		/**
3868
		 * Should the Jetpack Remote Site Management notice be displayed.
3869
		 *
3870
		 * @since 3.3.0
3871
		 *
3872
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3873
		 */
3874
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3875
	}
3876
3877
	/*
3878
	 * Registration flow:
3879
	 * 1 - ::admin_page_load() action=register
3880
	 * 2 - ::try_registration()
3881
	 * 3 - ::register()
3882
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3883
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3884
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3885
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3886
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3887
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3888
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3889
	 *       jetpack_id, jetpack_secret, jetpack_public
3890
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3891
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3892
	 * 5 - user logs in with WP.com account
3893
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3894
	 *		- Jetpack_Client_Server::authorize()
3895
	 *		- Jetpack_Client_Server::get_token()
3896
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3897
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3898
	 *			- which responds with access_token, token_type, scope
3899
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3900
	 *		- Jetpack::activate_default_modules()
3901
	 *     		- Deactivates deprecated plugins
3902
	 *     		- Activates all default modules
3903
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3904
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3905
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3906
	 *     Done!
3907
	 */
3908
3909
	/**
3910
	 * Handles the page load events for the Jetpack admin page
3911
	 */
3912
	function admin_page_load() {
3913
		$error = false;
3914
3915
		// Make sure we have the right body class to hook stylings for subpages off of.
3916
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3917
3918
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3919
			// Should only be used in intermediate redirects to preserve state across redirects
3920
			Jetpack::restate();
3921
		}
3922
3923
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3924
			// User clicked in the iframe to link their accounts
3925
			if ( ! Jetpack::is_user_connected() ) {
3926
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3927
				if ( isset( $_GET['notes_iframe'] ) )
3928
					$connect_url .= '&notes_iframe';
3929
				wp_redirect( $connect_url );
3930
				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...
3931
			} else {
3932
				if ( ! isset( $_GET['calypso_env'] ) ) {
3933
					Jetpack::state( 'message', 'already_authorized' );
3934
					wp_safe_redirect( Jetpack::admin_url() );
3935
					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...
3936
				} else {
3937
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3938
					$connect_url .= '&already_authorized=true';
3939
					wp_redirect( $connect_url );
3940
					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...
3941
				}
3942
			}
3943
		}
3944
3945
3946
		if ( isset( $_GET['action'] ) ) {
3947
			switch ( $_GET['action'] ) {
3948
			case 'authorize':
3949
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3950
					Jetpack::state( 'message', 'already_authorized' );
3951
					wp_safe_redirect( Jetpack::admin_url() );
3952
					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...
3953
				}
3954
				Jetpack::log( 'authorize' );
3955
				$client_server = new Jetpack_Client_Server;
3956
				$client_server->client_authorize();
3957
				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...
3958
			case 'register' :
3959
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3960
					$error = 'cheatin';
3961
					break;
3962
				}
3963
				check_admin_referer( 'jetpack-register' );
3964
				Jetpack::log( 'register' );
3965
				Jetpack::maybe_set_version_option();
3966
				$registered = Jetpack::try_registration();
3967
				if ( is_wp_error( $registered ) ) {
3968
					$error = $registered->get_error_code();
3969
					Jetpack::state( 'error', $error );
3970
					Jetpack::state( 'error', $registered->get_error_message() );
3971
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3972
						'error_code' => $error,
3973
						'error_message' => $registered->get_error_message()
3974
					) );
3975
					break;
3976
				}
3977
3978
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3979
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3980
3981
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3982
					'from' => $from
3983
				) );
3984
3985
				$url = $this->build_connect_url( true, $redirect, $from );
3986
3987
				if ( ! empty( $_GET['onboarding'] ) ) {
3988
					$url = add_query_arg( 'onboarding', sanitize_key( $_GET['onboarding'] ), $url );
3989
				}
3990
3991
				wp_redirect( $url );
3992
				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...
3993
			case 'activate' :
3994
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3995
					$error = 'cheatin';
3996
					break;
3997
				}
3998
3999
				$module = stripslashes( $_GET['module'] );
4000
				check_admin_referer( "jetpack_activate-$module" );
4001
				Jetpack::log( 'activate', $module );
4002
				Jetpack::activate_module( $module );
4003
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4004
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4005
				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...
4006
			case 'activate_default_modules' :
4007
				check_admin_referer( 'activate_default_modules' );
4008
				Jetpack::log( 'activate_default_modules' );
4009
				Jetpack::restate();
4010
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4011
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4012
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4013
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4014
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4015
				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...
4016
			case 'disconnect' :
4017
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4018
					$error = 'cheatin';
4019
					break;
4020
				}
4021
4022
				check_admin_referer( 'jetpack-disconnect' );
4023
				Jetpack::log( 'disconnect' );
4024
				Jetpack::disconnect();
4025
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4026
				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...
4027
			case 'reconnect' :
4028
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4029
					$error = 'cheatin';
4030
					break;
4031
				}
4032
4033
				check_admin_referer( 'jetpack-reconnect' );
4034
				Jetpack::log( 'reconnect' );
4035
				$this->disconnect();
4036
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4037
				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...
4038 View Code Duplication
			case 'deactivate' :
4039
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4040
					$error = 'cheatin';
4041
					break;
4042
				}
4043
4044
				$modules = stripslashes( $_GET['module'] );
4045
				check_admin_referer( "jetpack_deactivate-$modules" );
4046
				foreach ( explode( ',', $modules ) as $module ) {
4047
					Jetpack::log( 'deactivate', $module );
4048
					Jetpack::deactivate_module( $module );
4049
					Jetpack::state( 'message', 'module_deactivated' );
4050
				}
4051
				Jetpack::state( 'module', $modules );
4052
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4053
				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...
4054
			case 'unlink' :
4055
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4056
				check_admin_referer( 'jetpack-unlink' );
4057
				Jetpack::log( 'unlink' );
4058
				$this->unlink_user();
4059
				Jetpack::state( 'message', 'unlinked' );
4060
				if ( 'sub-unlink' == $redirect ) {
4061
					wp_safe_redirect( admin_url() );
4062
				} else {
4063
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4064
				}
4065
				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...
4066
			case 'onboard' :
4067
				if ( ! current_user_can( 'manage_options' ) ) {
4068
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4069
				} else {
4070
					Jetpack::create_onboarding_token();
4071
					$url = $this->build_connect_url( true );
4072
4073
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4074
						$url = add_query_arg( 'onboarding', $token, $url );
4075
					}
4076
4077
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4078
					if ( $calypso_env ) {
4079
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4080
					}
4081
4082
					wp_redirect( $url );
4083
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
4084
				}
4085
				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...
4086
			default:
4087
				/**
4088
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4089
				 *
4090
				 * @since 2.6.0
4091
				 *
4092
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4093
				 */
4094
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4095
			}
4096
		}
4097
4098
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4099
			self::activate_new_modules( true );
4100
		}
4101
4102
		$message_code = Jetpack::state( 'message' );
4103
		if ( Jetpack::state( 'optin-manage' ) ) {
4104
			$activated_manage = $message_code;
4105
			$message_code = 'jetpack-manage';
4106
		}
4107
4108
		switch ( $message_code ) {
4109
		case 'jetpack-manage':
4110
			$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>';
4111
			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...
4112
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4113
			}
4114
			break;
4115
4116
		}
4117
4118
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4119
4120
		if ( ! empty( $deactivated_plugins ) ) {
4121
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4122
			$deactivated_titles  = array();
4123
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4124
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4125
					continue;
4126
				}
4127
4128
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4129
			}
4130
4131
			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...
4132
				if ( $this->message ) {
4133
					$this->message .= "<br /><br />\n";
4134
				}
4135
4136
				$this->message .= wp_sprintf(
4137
					_n(
4138
						'Jetpack contains the most recent version of the old %l plugin.',
4139
						'Jetpack contains the most recent versions of the old %l plugins.',
4140
						count( $deactivated_titles ),
4141
						'jetpack'
4142
					),
4143
					$deactivated_titles
4144
				);
4145
4146
				$this->message .= "<br />\n";
4147
4148
				$this->message .= _n(
4149
					'The old version has been deactivated and can be removed from your site.',
4150
					'The old versions have been deactivated and can be removed from your site.',
4151
					count( $deactivated_titles ),
4152
					'jetpack'
4153
				);
4154
			}
4155
		}
4156
4157
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4158
4159
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4160
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4161
		}
4162
4163 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4164
			/**
4165
			 * Fires when a module configuration page is loaded.
4166
			 * The dynamic part of the hook is the configure parameter from the URL.
4167
			 *
4168
			 * @since 1.1.0
4169
			 */
4170
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4171
		}
4172
4173
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4174
	}
4175
4176
	function admin_notices() {
4177
4178
		if ( $this->error ) {
4179
?>
4180
<div id="message" class="jetpack-message jetpack-err">
4181
	<div class="squeezer">
4182
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4183
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4184
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4185
<?php	endif; ?>
4186
	</div>
4187
</div>
4188
<?php
4189
		}
4190
4191
		if ( $this->message ) {
4192
?>
4193
<div id="message" class="jetpack-message">
4194
	<div class="squeezer">
4195
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4196
	</div>
4197
</div>
4198
<?php
4199
		}
4200
4201
		if ( $this->privacy_checks ) :
4202
			$module_names = $module_slugs = array();
4203
4204
			$privacy_checks = explode( ',', $this->privacy_checks );
4205
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4206
			foreach ( $privacy_checks as $module_slug ) {
4207
				$module = Jetpack::get_module( $module_slug );
4208
				if ( ! $module ) {
4209
					continue;
4210
				}
4211
4212
				$module_slugs[] = $module_slug;
4213
				$module_names[] = "<strong>{$module['name']}</strong>";
4214
			}
4215
4216
			$module_slugs = join( ',', $module_slugs );
4217
?>
4218
<div id="message" class="jetpack-message jetpack-err">
4219
	<div class="squeezer">
4220
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4221
		<p><?php
4222
			echo wp_kses(
4223
				wptexturize(
4224
					wp_sprintf(
4225
						_nx(
4226
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4227
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4228
							count( $privacy_checks ),
4229
							'%l = list of Jetpack module/feature names',
4230
							'jetpack'
4231
						),
4232
						$module_names
4233
					)
4234
				),
4235
				array( 'strong' => true )
4236
			);
4237
4238
			echo "\n<br />\n";
4239
4240
			echo wp_kses(
4241
				sprintf(
4242
					_nx(
4243
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4244
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4245
						count( $privacy_checks ),
4246
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4247
						'jetpack'
4248
					),
4249
					wp_nonce_url(
4250
						Jetpack::admin_url(
4251
							array(
4252
								'page'   => 'jetpack',
4253
								'action' => 'deactivate',
4254
								'module' => urlencode( $module_slugs ),
4255
							)
4256
						),
4257
						"jetpack_deactivate-$module_slugs"
4258
					),
4259
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4260
				),
4261
				array( 'a' => array( 'href' => true, 'title' => true ) )
4262
			);
4263
		?></p>
4264
	</div>
4265
</div>
4266
<?php endif;
4267
	// only display the notice if the other stuff is not there
4268
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4269
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4270
			$this->opt_in_jetpack_manage_notice();
4271
		}
4272
	}
4273
4274
	/**
4275
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4276
	 */
4277
	function stat( $group, $detail ) {
4278
		if ( ! isset( $this->stats[ $group ] ) )
4279
			$this->stats[ $group ] = array();
4280
		$this->stats[ $group ][] = $detail;
4281
	}
4282
4283
	/**
4284
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4285
	 */
4286
	function do_stats( $method = '' ) {
4287
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4288
			foreach ( $this->stats as $group => $stats ) {
4289
				if ( is_array( $stats ) && count( $stats ) ) {
4290
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4291
					if ( 'server_side' === $method ) {
4292
						self::do_server_side_stat( $args );
4293
					} else {
4294
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4295
					}
4296
				}
4297
				unset( $this->stats[ $group ] );
4298
			}
4299
		}
4300
	}
4301
4302
	/**
4303
	 * Runs stats code for a one-off, server-side.
4304
	 *
4305
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4306
	 *
4307
	 * @return bool If it worked.
4308
	 */
4309
	static function do_server_side_stat( $args ) {
4310
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4311
		if ( is_wp_error( $response ) )
4312
			return false;
4313
4314
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4315
			return false;
4316
4317
		return true;
4318
	}
4319
4320
	/**
4321
	 * Builds the stats url.
4322
	 *
4323
	 * @param $args array|string The arguments to append to the URL.
4324
	 *
4325
	 * @return string The URL to be pinged.
4326
	 */
4327
	static function build_stats_url( $args ) {
4328
		$defaults = array(
4329
			'v'    => 'wpcom2',
4330
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4331
		);
4332
		$args     = wp_parse_args( $args, $defaults );
4333
		/**
4334
		 * Filter the URL used as the Stats tracking pixel.
4335
		 *
4336
		 * @since 2.3.2
4337
		 *
4338
		 * @param string $url Base URL used as the Stats tracking pixel.
4339
		 */
4340
		$base_url = apply_filters(
4341
			'jetpack_stats_base_url',
4342
			'https://pixel.wp.com/g.gif'
4343
		);
4344
		$url      = add_query_arg( $args, $base_url );
4345
		return $url;
4346
	}
4347
4348
	static function translate_current_user_to_role() {
4349
		foreach ( self::$capability_translations as $role => $cap ) {
4350
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4351
				return $role;
4352
			}
4353
		}
4354
4355
		return false;
4356
	}
4357
4358
	static function translate_user_to_role( $user ) {
4359
		foreach ( self::$capability_translations as $role => $cap ) {
4360
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4361
				return $role;
4362
			}
4363
		}
4364
4365
		return false;
4366
    }
4367
4368
	static function translate_role_to_cap( $role ) {
4369
		if ( ! isset( self::$capability_translations[$role] ) ) {
4370
			return false;
4371
		}
4372
4373
		return self::$capability_translations[$role];
4374
	}
4375
4376
	static function sign_role( $role, $user_id = null ) {
4377
		if ( empty( $user_id ) ) {
4378
			$user_id = (int) get_current_user_id();
4379
		}
4380
4381
		if ( ! $user_id  ) {
4382
			return false;
4383
		}
4384
4385
		$token = Jetpack_Data::get_access_token();
4386
		if ( ! $token || is_wp_error( $token ) ) {
4387
			return false;
4388
		}
4389
4390
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4391
	}
4392
4393
4394
	/**
4395
	 * Builds a URL to the Jetpack connection auth page
4396
	 *
4397
	 * @since 3.9.5
4398
	 *
4399
	 * @param bool $raw If true, URL will not be escaped.
4400
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4401
	 *                              If string, will be a custom redirect.
4402
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4403
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4404
	 *
4405
	 * @return string Connect URL
4406
	 */
4407
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4408
		$site_id = Jetpack_Options::get_option( 'id' );
4409
		$token = Jetpack_Options::get_option( 'blog_token' );
4410
4411
		if ( $register || ! $token || ! $site_id ) {
4412
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4413
4414
			if ( ! empty( $redirect ) ) {
4415
				$url = add_query_arg(
4416
					'redirect',
4417
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4418
					$url
4419
				);
4420
			}
4421
4422
			if( is_network_admin() ) {
4423
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4424
			}
4425
		} else {
4426
4427
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4428
			// because otherwise this logic can get us in to a loop.
4429
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4430
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4431
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4432
4433
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4434
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4435
					'1.1'
4436
				);
4437
4438
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4439
					// Generating a register URL instead to refresh the existing token
4440
					return $this->build_connect_url( $raw, $redirect, $from, true );
4441
				}
4442
			}
4443
4444
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4445
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4446
			}
4447
4448
			$role = self::translate_current_user_to_role();
4449
			$signed_role = self::sign_role( $role );
4450
4451
			$user = wp_get_current_user();
4452
4453
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4454
			$redirect = $redirect
4455
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4456
				: $jetpack_admin_page;
4457
4458
			if( isset( $_REQUEST['is_multisite'] ) ) {
4459
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4460
			}
4461
4462
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4463
4464
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4465
				? get_site_icon_url()
4466
				: false;
4467
4468
			/**
4469
			 * Filter the type of authorization.
4470
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4471
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4472
			 *
4473
			 * @since 4.3.3
4474
			 *
4475
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4476
			 */
4477
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4478
4479
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4480
4481
			$args = urlencode_deep(
4482
				array(
4483
					'response_type' => 'code',
4484
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4485
					'redirect_uri'  => add_query_arg(
4486
						array(
4487
							'action'   => 'authorize',
4488
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4489
							'redirect' => urlencode( $redirect ),
4490
						),
4491
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4492
					),
4493
					'state'         => $user->ID,
4494
					'scope'         => $signed_role,
4495
					'user_email'    => $user->user_email,
4496
					'user_login'    => $user->user_login,
4497
					'is_active'     => Jetpack::is_active(),
4498
					'jp_version'    => JETPACK__VERSION,
4499
					'auth_type'     => $auth_type,
4500
					'secret'        => $secrets['secret_1'],
4501
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4502
					'blogname'      => get_option( 'blogname' ),
4503
					'site_url'      => site_url(),
4504
					'home_url'      => home_url(),
4505
					'site_icon'     => $site_icon,
4506
					'site_lang'     => get_locale(),
4507
					'_ui'           => $tracks_identity['_ui'],
4508
					'_ut'           => $tracks_identity['_ut']
4509
				)
4510
			);
4511
4512
			self::apply_activation_source_to_args( $args );
4513
4514
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4515
		}
4516
4517
		if ( $from ) {
4518
			$url = add_query_arg( 'from', $from, $url );
4519
		}
4520
4521
4522
		if ( isset( $_GET['calypso_env'] ) ) {
4523
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4524
		}
4525
4526
		return $raw ? $url : esc_url( $url );
4527
	}
4528
4529
	public static function apply_activation_source_to_args( &$args ) {
4530
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4531
4532
		if ( $activation_source_name ) {
4533
			$args['_as'] = urlencode( $activation_source_name );
4534
		}
4535
4536
		if ( $activation_source_keyword ) {
4537
			$args['_ak'] = urlencode( $activation_source_keyword );
4538
		}
4539
	}
4540
4541
	function build_reconnect_url( $raw = false ) {
4542
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4543
		return $raw ? $url : esc_url( $url );
4544
	}
4545
4546
	public static function admin_url( $args = null ) {
4547
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4548
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4549
		return $url;
4550
	}
4551
4552
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4553
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4554
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4555
	}
4556
4557
	function dismiss_jetpack_notice() {
4558
4559
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4560
			return;
4561
		}
4562
4563
		switch( $_GET['jetpack-notice'] ) {
4564
			case 'dismiss':
4565
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4566
4567
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4568
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4569
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4570
				}
4571
				break;
4572 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...
4573
4574
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4575
					// Don't show the banner again
4576
4577
					Jetpack_Options::update_option( 'dismissed_manage_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 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...
4588
4589
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4590
					// Don't show the banner again
4591
4592
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4593
					// redirect back to the page that had the notice
4594
					if ( wp_get_referer() ) {
4595
						wp_safe_redirect( wp_get_referer() );
4596
					} else {
4597
						// Take me to Jetpack
4598
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4599
					}
4600
				}
4601
				break;
4602
			case 'jetpack-manage-opt-in':
4603
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4604
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4605
4606
					$redirection_url = Jetpack::admin_url();
4607
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4608
4609
					// Don't redirect form the Jetpack Setting Page
4610
					$referer_parsed = parse_url ( wp_get_referer() );
4611
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4612
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4613
						// Take the user to Jetpack home except when on the setting page
4614
						$redirection_url = wp_get_referer();
4615
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4616
					}
4617
					// Also update the JSON API FULL MANAGEMENT Option
4618
					Jetpack::activate_module( 'manage', false, false );
4619
4620
					// Special Message when option in.
4621
					Jetpack::state( 'optin-manage', 'true' );
4622
					// Activate the Module if not activated already
4623
4624
					// Redirect properly
4625
					wp_safe_redirect( $redirection_url );
4626
4627
				}
4628
				break;
4629
		}
4630
	}
4631
4632
	public static function admin_screen_configure_module( $module_id ) {
4633
4634
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4635
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4636
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4637
				/**
4638
				 * Fires to diplay a custom module activation screen.
4639
				 *
4640
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4641
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4642
				 *
4643
				 * @module manage
4644
				 *
4645
				 * @since 3.8.0
4646
				 *
4647
				 * @param int $module_id Module ID.
4648
				 */
4649
				do_action( 'display_activate_module_setting_' . $module_id );
4650
			} else {
4651
				self::display_activate_module_link( $module_id );
4652
			}
4653
4654
			return false;
4655
		} ?>
4656
4657
		<div id="jp-settings-screen" style="position: relative">
4658
			<h3>
4659
			<?php
4660
				$module = Jetpack::get_module( $module_id );
4661
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4662
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4663
			?>
4664
			</h3>
4665
			<?php
4666
				/**
4667
				 * Fires within the displayed message when a feature configuation is updated.
4668
				 *
4669
				 * @since 3.4.0
4670
				 *
4671
				 * @param int $module_id Module ID.
4672
				 */
4673
				do_action( 'jetpack_notices_update_settings', $module_id );
4674
				/**
4675
				 * Fires when a feature configuation screen is loaded.
4676
				 * The dynamic part of the hook, $module_id, is the module ID.
4677
				 *
4678
				 * @since 1.1.0
4679
				 */
4680
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4681
			?>
4682
		</div><?php
4683
	}
4684
4685
	/**
4686
	 * Display link to activate the module to see the settings screen.
4687
	 * @param  string $module_id
4688
	 * @return null
4689
	 */
4690
	public static function display_activate_module_link( $module_id ) {
4691
4692
		$info =  Jetpack::get_module( $module_id );
4693
		$extra = '';
4694
		$activate_url = wp_nonce_url(
4695
				Jetpack::admin_url(
4696
					array(
4697
						'page'   => 'jetpack',
4698
						'action' => 'activate',
4699
						'module' => $module_id,
4700
					)
4701
				),
4702
				"jetpack_activate-$module_id"
4703
			);
4704
4705
		?>
4706
4707
		<div class="wrap configure-module">
4708
			<div id="jp-settings-screen">
4709
				<?php
4710
				if ( $module_id == 'json-api' ) {
4711
4712
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4713
4714
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4715
4716
					$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' );
4717
4718
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4719
				} ?>
4720
4721
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4722
				<div class="narrow">
4723
					<p><?php echo  $info['description']; ?></p>
4724
					<?php if( $extra ) { ?>
4725
					<p><?php echo esc_html( $extra ); ?></p>
4726
					<?php } ?>
4727
					<p>
4728
						<?php
4729
						if( wp_get_referer() ) {
4730
							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() );
4731
						} else {
4732
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4733
						} ?>
4734
					</p>
4735
				</div>
4736
4737
			</div>
4738
		</div>
4739
4740
		<?php
4741
	}
4742
4743
	public static function sort_modules( $a, $b ) {
4744
		if ( $a['sort'] == $b['sort'] )
4745
			return 0;
4746
4747
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4748
	}
4749
4750
	function ajax_recheck_ssl() {
4751
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4752
		$result = Jetpack::permit_ssl( true );
4753
		wp_send_json( array(
4754
			'enabled' => $result,
4755
			'message' => get_transient( 'jetpack_https_test_message' )
4756
		) );
4757
	}
4758
4759
/* Client API */
4760
4761
	/**
4762
	 * Returns the requested Jetpack API URL
4763
	 *
4764
	 * @return string
4765
	 */
4766
	public static function api_url( $relative_url ) {
4767
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4768
	}
4769
4770
	/**
4771
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4772
	 */
4773
	public static function fix_url_for_bad_hosts( $url ) {
4774
		if ( 0 !== strpos( $url, 'https://' ) ) {
4775
			return $url;
4776
		}
4777
4778
		switch ( JETPACK_CLIENT__HTTPS ) {
4779
			case 'ALWAYS' :
4780
				return $url;
4781
			case 'NEVER' :
4782
				return set_url_scheme( $url, 'http' );
4783
			// default : case 'AUTO' :
4784
		}
4785
4786
		// we now return the unmodified SSL URL by default, as a security precaution
4787
		return $url;
4788
	}
4789
4790
	/**
4791
	 * Create a random secret for validating onboarding payload
4792
	 *
4793
	 * @return string Secret token
4794
	 */
4795
	public static function create_onboarding_token() {
4796
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4797
			$token = wp_generate_password( 32, false );
4798
			Jetpack_Options::update_option( 'onboarding', $token );
4799
		}
4800
4801
		return $token;
4802
	}
4803
4804
	/**
4805
	 * Remove the onboarding token
4806
	 *
4807
	 * @return bool True on success, false on failure
4808
	 */
4809
	public static function invalidate_onboarding_token() {
4810
		return Jetpack_Options::delete_option( 'onboarding' );
4811
	}
4812
4813
	/**
4814
	 * Validate an onboarding token for a specific action
4815
	 *
4816
	 * @return boolean True if token/action pair is accepted, false if not
4817
	 */
4818
	public static function validate_onboarding_token_action( $token, $action ) {
4819
		// Compare tokens, bail if tokens do not match
4820
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4821
			return false;
4822
		}
4823
4824
		// List of valid actions we can take
4825
		$valid_actions = array(
4826
			'/jetpack/v4/settings',
4827
		);
4828
4829
		// Whitelist the action
4830
		if ( ! in_array( $action, $valid_actions ) ) {
4831
			return false;
4832
		}
4833
4834
		return true;
4835
	}
4836
4837
	/**
4838
	 * Checks to see if the URL is using SSL to connect with Jetpack
4839
	 *
4840
	 * @since 2.3.3
4841
	 * @return boolean
4842
	 */
4843
	public static function permit_ssl( $force_recheck = false ) {
4844
		// Do some fancy tests to see if ssl is being supported
4845
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4846
			$message = '';
4847
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4848
				$ssl = 0;
4849
			} else {
4850
				switch ( JETPACK_CLIENT__HTTPS ) {
4851
					case 'NEVER':
4852
						$ssl = 0;
4853
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4854
						break;
4855
					case 'ALWAYS':
4856
					case 'AUTO':
4857
					default:
4858
						$ssl = 1;
4859
						break;
4860
				}
4861
4862
				// If it's not 'NEVER', test to see
4863
				if ( $ssl ) {
4864
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4865
						$ssl = 0;
4866
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4867
					} else {
4868
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4869
						if ( is_wp_error( $response ) ) {
4870
							$ssl = 0;
4871
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4872
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4873
							$ssl = 0;
4874
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4875
						}
4876
					}
4877
				}
4878
			}
4879
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4880
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4881
		}
4882
4883
		return (bool) $ssl;
4884
	}
4885
4886
	/*
4887
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4888
	 */
4889
	public function alert_auto_ssl_fail() {
4890
		if ( ! current_user_can( 'manage_options' ) )
4891
			return;
4892
4893
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4894
		?>
4895
4896
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4897
			<div class="jp-banner__content">
4898
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4899
				<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>
4900
				<p>
4901
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4902
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4903
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4904
				</p>
4905
				<p>
4906
					<?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' ),
4907
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4908
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4909
				</p>
4910
			</div>
4911
		</div>
4912
		<style>
4913
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4914
		</style>
4915
		<script type="text/javascript">
4916
			jQuery( document ).ready( function( $ ) {
4917
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4918
					var $this = $( this );
4919
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4920
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4921
					e.preventDefault();
4922
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4923
					$.post( ajaxurl, data )
4924
					  .done( function( response ) {
4925
					  	if ( response.enabled ) {
4926
					  		$( '#jetpack-ssl-warning' ).hide();
4927
					  	} else {
4928
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4929
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4930
					  	}
4931
					  }.bind( $this ) );
4932
				} );
4933
			} );
4934
		</script>
4935
4936
		<?php
4937
	}
4938
4939
	/**
4940
	 * Returns the Jetpack XML-RPC API
4941
	 *
4942
	 * @return string
4943
	 */
4944
	public static function xmlrpc_api_url() {
4945
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4946
		return untrailingslashit( $base ) . '/xmlrpc.php';
4947
	}
4948
4949
	/**
4950
	 * Creates two secret tokens and the end of life timestamp for them.
4951
	 *
4952
	 * Note these tokens are unique per call, NOT static per site for connecting.
4953
	 *
4954
	 * @since 2.6
4955
	 * @return array
4956
	 */
4957
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4958
		if ( ! $user_id ) {
4959
			$user_id = get_current_user_id();
4960
		}
4961
4962
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4963
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4964
4965
		if (
4966
			isset( $secrets[ $secret_name ] ) &&
4967
			$secrets[ $secret_name ]['exp'] > time()
4968
		) {
4969
			return $secrets[ $secret_name ];
4970
		}
4971
4972
		$secret_value = array(
4973
			'secret_1'  => wp_generate_password( 32, false ),
4974
			'secret_2'  => wp_generate_password( 32, false ),
4975
			'exp'       => time() + $exp,
4976
		);
4977
4978
		$secrets[ $secret_name ] = $secret_value;
4979
4980
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4981
		return $secrets[ $secret_name ];
4982
	}
4983
4984
	public static function get_secrets( $action, $user_id ) {
4985
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4986
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4987
4988
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4989
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4990
		}
4991
4992
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4993
			self::delete_secrets( $action, $user_id );
4994
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4995
		}
4996
4997
		return $secrets[ $secret_name ];
4998
	}
4999
5000
	public static function delete_secrets( $action, $user_id ) {
5001
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5002
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5003
		if ( isset( $secrets[ $secret_name ] ) ) {
5004
			unset( $secrets[ $secret_name ] );
5005
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5006
		}
5007
	}
5008
5009
	/**
5010
	 * Builds the timeout limit for queries talking with the wpcom servers.
5011
	 *
5012
	 * Based on local php max_execution_time in php.ini
5013
	 *
5014
	 * @since 2.6
5015
	 * @return int
5016
	 * @deprecated
5017
	 **/
5018
	public function get_remote_query_timeout_limit() {
5019
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5020
		return Jetpack::get_max_execution_time();
5021
	}
5022
5023
	/**
5024
	 * Builds the timeout limit for queries talking with the wpcom servers.
5025
	 *
5026
	 * Based on local php max_execution_time in php.ini
5027
	 *
5028
	 * @since 5.4
5029
	 * @return int
5030
	 **/
5031
	public static function get_max_execution_time() {
5032
		$timeout = (int) ini_get( 'max_execution_time' );
5033
5034
		// Ensure exec time set in php.ini
5035
		if ( ! $timeout ) {
5036
			$timeout = 30;
5037
		}
5038
		return $timeout;
5039
	}
5040
5041
	/**
5042
	 * Sets a minimum request timeout, and returns the current timeout
5043
	 *
5044
	 * @since 5.4
5045
	 **/
5046
	public static function set_min_time_limit( $min_timeout ) {
5047
		$timeout = self::get_max_execution_time();
5048
		if ( $timeout < $min_timeout ) {
5049
			$timeout = $min_timeout;
5050
			set_time_limit( $timeout );
5051
		}
5052
		return $timeout;
5053
	}
5054
5055
5056
	/**
5057
	 * Takes the response from the Jetpack register new site endpoint and
5058
	 * verifies it worked properly.
5059
	 *
5060
	 * @since 2.6
5061
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5062
	 **/
5063
	public function validate_remote_register_response( $response ) {
5064
	  if ( is_wp_error( $response ) ) {
5065
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5066
		}
5067
5068
		$code   = wp_remote_retrieve_response_code( $response );
5069
		$entity = wp_remote_retrieve_body( $response );
5070
		if ( $entity )
5071
			$registration_response = json_decode( $entity );
5072
		else
5073
			$registration_response = false;
5074
5075
		$code_type = intval( $code / 100 );
5076
		if ( 5 == $code_type ) {
5077
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5078
		} elseif ( 408 == $code ) {
5079
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5080
		} elseif ( ! empty( $registration_response->error ) ) {
5081
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5082
				$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' );
5083
			} else {
5084
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5085
			}
5086
5087
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5088
		} elseif ( 200 != $code ) {
5089
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5090
		}
5091
5092
		// Jetpack ID error block
5093
		if ( empty( $registration_response->jetpack_id ) ) {
5094
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5095
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5096
			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 );
5097
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5098
			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 );
5099
		}
5100
5101
	    return $registration_response;
5102
	}
5103
	/**
5104
	 * @return bool|WP_Error
5105
	 */
5106
	public static function register() {
5107
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5108
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5109
		$secrets = Jetpack::generate_secrets( 'register' );
5110
5111 View Code Duplication
		if (
5112
			empty( $secrets['secret_1'] ) ||
5113
			empty( $secrets['secret_2'] ) ||
5114
			empty( $secrets['exp'] )
5115
		) {
5116
			return new Jetpack_Error( 'missing_secrets' );
5117
		}
5118
5119
		// better to try (and fail) to set a higher timeout than this system
5120
		// supports than to have register fail for more users than it should
5121
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5122
5123
		$gmt_offset = get_option( 'gmt_offset' );
5124
		if ( ! $gmt_offset ) {
5125
			$gmt_offset = 0;
5126
		}
5127
5128
		$stats_options = get_option( 'stats_options' );
5129
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5130
5131
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5132
5133
		$args = array(
5134
			'method'  => 'POST',
5135
			'body'    => array(
5136
				'siteurl'         => site_url(),
5137
				'home'            => home_url(),
5138
				'gmt_offset'      => $gmt_offset,
5139
				'timezone_string' => (string) get_option( 'timezone_string' ),
5140
				'site_name'       => (string) get_option( 'blogname' ),
5141
				'secret_1'        => $secrets['secret_1'],
5142
				'secret_2'        => $secrets['secret_2'],
5143
				'site_lang'       => get_locale(),
5144
				'timeout'         => $timeout,
5145
				'stats_id'        => $stats_id,
5146
				'state'           => get_current_user_id(),
5147
				'_ui'             => $tracks_identity['_ui'],
5148
				'_ut'             => $tracks_identity['_ut'],
5149
				'jetpack_version' => JETPACK__VERSION
5150
			),
5151
			'headers' => array(
5152
				'Accept' => 'application/json',
5153
			),
5154
			'timeout' => $timeout,
5155
		);
5156
5157
		self::apply_activation_source_to_args( $args['body'] );
5158
5159
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5160
5161
		// Make sure the response is valid and does not contain any Jetpack errors
5162
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5163
		if ( is_wp_error( $registration_details ) ) {
5164
			return $registration_details;
5165
		} elseif ( ! $registration_details ) {
5166
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5167
		}
5168
5169 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5170
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5171
		}
5172
5173
		if ( isset( $registration_details->jetpack_public ) ) {
5174
			$jetpack_public = (int) $registration_details->jetpack_public;
5175
		} else {
5176
			$jetpack_public = false;
5177
		}
5178
5179
		Jetpack_Options::update_options(
5180
			array(
5181
				'id'         => (int)    $registration_details->jetpack_id,
5182
				'blog_token' => (string) $registration_details->jetpack_secret,
5183
				'public'     => $jetpack_public,
5184
			)
5185
		);
5186
5187
		/**
5188
		 * Fires when a site is registered on WordPress.com.
5189
		 *
5190
		 * @since 3.7.0
5191
		 *
5192
		 * @param int $json->jetpack_id Jetpack Blog ID.
5193
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5194
		 * @param int|bool $jetpack_public Is the site public.
5195
		 */
5196
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5197
5198
		// Initialize Jump Start for the first and only time.
5199
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5200
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5201
5202
			$jetpack = Jetpack::init();
5203
5204
			$jetpack->stat( 'jumpstart', 'unique-views' );
5205
			$jetpack->do_stats( 'server_side' );
5206
		};
5207
5208
		return true;
5209
	}
5210
5211
	/**
5212
	 * If the db version is showing something other that what we've got now, bump it to current.
5213
	 *
5214
	 * @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...
5215
	 */
5216
	public static function maybe_set_version_option() {
5217
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5218
		if ( JETPACK__VERSION != $version ) {
5219
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5220
5221
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5222
				/** This action is documented in class.jetpack.php */
5223
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5224
			}
5225
5226
			return true;
5227
		}
5228
		return false;
5229
	}
5230
5231
/* Client Server API */
5232
5233
	/**
5234
	 * Loads the Jetpack XML-RPC client
5235
	 */
5236
	public static function load_xml_rpc_client() {
5237
		require_once ABSPATH . WPINC . '/class-IXR.php';
5238
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5239
	}
5240
5241
	/**
5242
	 * Resets the saved authentication state in between testing requests.
5243
	 */
5244
	public function reset_saved_auth_state() {
5245
		$this->xmlrpc_verification = null;
5246
		$this->rest_authentication_status = null;
5247
	}
5248
5249
	function verify_xml_rpc_signature() {
5250
		if ( $this->xmlrpc_verification ) {
5251
			return $this->xmlrpc_verification;
5252
		}
5253
5254
		// It's not for us
5255
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5256
			return false;
5257
		}
5258
5259
		@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...
5260
		if (
5261
			empty( $token_key )
5262
		||
5263
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5264
		) {
5265
			return false;
5266
		}
5267
5268
		if ( '0' === $user_id ) {
5269
			$token_type = 'blog';
5270
			$user_id = 0;
5271
		} else {
5272
			$token_type = 'user';
5273
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5274
				return false;
5275
			}
5276
			$user_id = (int) $user_id;
5277
5278
			$user = new WP_User( $user_id );
5279
			if ( ! $user || ! $user->exists() ) {
5280
				return false;
5281
			}
5282
		}
5283
5284
		$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...
5285
		if ( ! $token ) {
5286
			return false;
5287
		}
5288
5289
		$token_check = "$token_key.";
5290
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5291
			return false;
5292
		}
5293
5294
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5295
5296
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5297
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5298
			$post_data   = $_POST;
5299
			$file_hashes = array();
5300
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5301
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5302
					continue;
5303
				}
5304
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5305
				$file_hashes[$post_data_key] = $post_data_value;
5306
			}
5307
5308
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5309
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5310
				$post_data[$post_data_key] = $post_data_value;
5311
			}
5312
5313
			ksort( $post_data );
5314
5315
			$body = http_build_query( stripslashes_deep( $post_data ) );
5316
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5317
			$body = file_get_contents( 'php://input' );
5318
		} else {
5319
			$body = null;
5320
		}
5321
5322
		$signature = $jetpack_signature->sign_current_request(
5323
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5324
		);
5325
5326
		if ( ! $signature ) {
5327
			return false;
5328
		} else if ( is_wp_error( $signature ) ) {
5329
			return $signature;
5330
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5331
			return false;
5332
		}
5333
5334
		$timestamp = (int) $_GET['timestamp'];
5335
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5336
5337
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5338
			return false;
5339
		}
5340
5341
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5342
		if ( isset( $this->HTTP_RAW_POST_DATA ) ) {
5343
			$jpo = json_decode( $this->HTTP_RAW_POST_DATA );
5344
			if (
5345
				isset( $jpo->onboarding ) &&
5346
				isset( $jpo->onboarding->jpUser ) && isset( $jpo->onboarding->token ) &&
5347
				is_email( $jpo->onboarding->jpUser ) && ctype_alnum( $jpo->onboarding->token ) &&
5348
				isset( $_GET['rest_route'] ) &&
5349
				self::validate_onboarding_token_action( $jpo->onboarding->token, $_GET['rest_route'] )
5350
			) {
5351
				$jpUser = get_user_by( 'email', $jpo->onboarding->jpUser );
5352
				if ( is_a( $jpUser, 'WP_User' ) ) {
5353
					wp_set_current_user( $jpUser->ID );
5354
					$user_can = is_multisite()
5355
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5356
						: current_user_can( 'manage_options' );
5357
					if ( $user_can ) {
5358
						$token_type = 'user';
5359
						$token->external_user_id = $jpUser->ID;
5360
					}
5361
				}
5362
			}
5363
		}
5364
5365
		$this->xmlrpc_verification = array(
5366
			'type'    => $token_type,
5367
			'user_id' => $token->external_user_id,
5368
		);
5369
5370
		return $this->xmlrpc_verification;
5371
	}
5372
5373
	/**
5374
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5375
	 */
5376
	function authenticate_jetpack( $user, $username, $password ) {
5377
		if ( is_a( $user, 'WP_User' ) ) {
5378
			return $user;
5379
		}
5380
5381
		$token_details = $this->verify_xml_rpc_signature();
5382
5383
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5384
			return $user;
5385
		}
5386
5387
		if ( 'user' !== $token_details['type'] ) {
5388
			return $user;
5389
		}
5390
5391
		if ( ! $token_details['user_id'] ) {
5392
			return $user;
5393
		}
5394
5395
		nocache_headers();
5396
5397
		return new WP_User( $token_details['user_id'] );
5398
	}
5399
5400
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5401
	// Uses the existing XMLRPC request signing implementation.
5402
	function wp_rest_authenticate( $user ) {
5403
		if ( ! empty( $user ) ) {
5404
			// Another authentication method is in effect.
5405
			return $user;
5406
		}
5407
5408
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5409
			// Nothing to do for this authentication method.
5410
			return null;
5411
		}
5412
5413
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5414
			// Nothing to do for this authentication method.
5415
			return null;
5416
		}
5417
5418
		// Ensure that we always have the request body available.  At this
5419
		// point, the WP REST API code to determine the request body has not
5420
		// run yet.  That code may try to read from 'php://input' later, but
5421
		// this can only be done once per request in PHP versions prior to 5.6.
5422
		// So we will go ahead and perform this read now if needed, and save
5423
		// the request body where both the Jetpack signature verification code
5424
		// and the WP REST API code can see it.
5425
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5426
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5427
		}
5428
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5429
5430
		// Only support specific request parameters that have been tested and
5431
		// are known to work with signature verification.  A different method
5432
		// can be passed to the WP REST API via the '?_method=' parameter if
5433
		// needed.
5434
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5435
			$this->rest_authentication_status = new WP_Error(
5436
				'rest_invalid_request',
5437
				__( 'This request method is not supported.', 'jetpack' ),
5438
				array( 'status' => 400 )
5439
			);
5440
			return null;
5441
		}
5442
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5443
			$this->rest_authentication_status = new WP_Error(
5444
				'rest_invalid_request',
5445
				__( 'This request method does not support body parameters.', 'jetpack' ),
5446
				array( 'status' => 400 )
5447
			);
5448
			return null;
5449
		}
5450
5451
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5452
			$content_type = $_SERVER['CONTENT_TYPE'];
5453
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5454
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5455
		}
5456
5457
		if (
5458
			isset( $content_type ) &&
5459
			$content_type !== 'application/x-www-form-urlencoded' &&
5460
			$content_type !== 'application/json'
5461
		) {
5462
			$this->rest_authentication_status = new WP_Error(
5463
				'rest_invalid_request',
5464
				__( 'This Content-Type is not supported.', 'jetpack' ),
5465
				array( 'status' => 400 )
5466
			);
5467
			return null;
5468
		}
5469
5470
		$verified = $this->verify_xml_rpc_signature();
5471
5472
		if ( is_wp_error( $verified ) ) {
5473
			$this->rest_authentication_status = $verified;
5474
			return null;
5475
		}
5476
5477
		if (
5478
			$verified &&
5479
			isset( $verified['type'] ) &&
5480
			'user' === $verified['type'] &&
5481
			! empty( $verified['user_id'] )
5482
		) {
5483
			// Authentication successful.
5484
			$this->rest_authentication_status = true;
5485
			return $verified['user_id'];
5486
		}
5487
5488
		// Something else went wrong.  Probably a signature error.
5489
		$this->rest_authentication_status = new WP_Error(
5490
			'rest_invalid_signature',
5491
			__( 'The request is not signed correctly.', 'jetpack' ),
5492
			array( 'status' => 400 )
5493
		);
5494
		return null;
5495
	}
5496
5497
	/**
5498
	 * Report authentication status to the WP REST API.
5499
	 *
5500
	 * @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...
5501
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5502
	 */
5503
	public function wp_rest_authentication_errors( $value ) {
5504
		if ( $value !== null ) {
5505
			return $value;
5506
		}
5507
		return $this->rest_authentication_status;
5508
	}
5509
5510
	function add_nonce( $timestamp, $nonce ) {
5511
		global $wpdb;
5512
		static $nonces_used_this_request = array();
5513
5514
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5515
			return $nonces_used_this_request["$timestamp:$nonce"];
5516
		}
5517
5518
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5519
		$timestamp = (int) $timestamp;
5520
		$nonce     = esc_sql( $nonce );
5521
5522
		// Raw query so we can avoid races: add_option will also update
5523
		$show_errors = $wpdb->show_errors( false );
5524
5525
		$old_nonce = $wpdb->get_row(
5526
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5527
		);
5528
5529
		if ( is_null( $old_nonce ) ) {
5530
			$return = $wpdb->query(
5531
				$wpdb->prepare(
5532
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5533
					"jetpack_nonce_{$timestamp}_{$nonce}",
5534
					time(),
5535
					'no'
5536
				)
5537
			);
5538
		} else {
5539
			$return = false;
5540
		}
5541
5542
		$wpdb->show_errors( $show_errors );
5543
5544
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5545
5546
		return $return;
5547
	}
5548
5549
	/**
5550
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5551
	 * Capture it here so we can verify the signature later.
5552
	 */
5553
	function xmlrpc_methods( $methods ) {
5554
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5555
		return $methods;
5556
	}
5557
5558
	function public_xmlrpc_methods( $methods ) {
5559
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5560
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5561
		}
5562
		return $methods;
5563
	}
5564
5565
	function jetpack_getOptions( $args ) {
5566
		global $wp_xmlrpc_server;
5567
5568
		$wp_xmlrpc_server->escape( $args );
5569
5570
		$username	= $args[1];
5571
		$password	= $args[2];
5572
5573
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5574
			return $wp_xmlrpc_server->error;
5575
		}
5576
5577
		$options = array();
5578
		$user_data = $this->get_connected_user_data();
5579
		if ( is_array( $user_data ) ) {
5580
			$options['jetpack_user_id'] = array(
5581
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5582
				'readonly'      => true,
5583
				'value'         => $user_data['ID'],
5584
			);
5585
			$options['jetpack_user_login'] = array(
5586
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5587
				'readonly'      => true,
5588
				'value'         => $user_data['login'],
5589
			);
5590
			$options['jetpack_user_email'] = array(
5591
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5592
				'readonly'      => true,
5593
				'value'         => $user_data['email'],
5594
			);
5595
			$options['jetpack_user_site_count'] = array(
5596
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5597
				'readonly'      => true,
5598
				'value'         => $user_data['site_count'],
5599
			);
5600
		}
5601
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5602
		$args = stripslashes_deep( $args );
5603
		return $wp_xmlrpc_server->wp_getOptions( $args );
5604
	}
5605
5606
	function xmlrpc_options( $options ) {
5607
		$jetpack_client_id = false;
5608
		if ( self::is_active() ) {
5609
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5610
		}
5611
		$options['jetpack_version'] = array(
5612
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5613
				'readonly'      => true,
5614
				'value'         => JETPACK__VERSION,
5615
		);
5616
5617
		$options['jetpack_client_id'] = array(
5618
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5619
				'readonly'      => true,
5620
				'value'         => $jetpack_client_id,
5621
		);
5622
		return $options;
5623
	}
5624
5625
	public static function clean_nonces( $all = false ) {
5626
		global $wpdb;
5627
5628
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5629
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5630
5631
		if ( true !== $all ) {
5632
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5633
			$sql_args[] = time() - 3600;
5634
		}
5635
5636
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5637
5638
		$sql = $wpdb->prepare( $sql, $sql_args );
5639
5640
		for ( $i = 0; $i < 1000; $i++ ) {
5641
			if ( ! $wpdb->query( $sql ) ) {
5642
				break;
5643
			}
5644
		}
5645
	}
5646
5647
	/**
5648
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5649
	 * SET: state( $key, $value );
5650
	 * GET: $value = state( $key );
5651
	 *
5652
	 * @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...
5653
	 * @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...
5654
	 * @param bool $restate private
5655
	 */
5656
	public static function state( $key = null, $value = null, $restate = false ) {
5657
		static $state = array();
5658
		static $path, $domain;
5659
		if ( ! isset( $path ) ) {
5660
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5661
			$admin_url = Jetpack::admin_url();
5662
			$bits      = parse_url( $admin_url );
5663
5664
			if ( is_array( $bits ) ) {
5665
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5666
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5667
			} else {
5668
				$path = $domain = null;
5669
			}
5670
		}
5671
5672
		// Extract state from cookies and delete cookies
5673
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5674
			$yum = $_COOKIE[ 'jetpackState' ];
5675
			unset( $_COOKIE[ 'jetpackState' ] );
5676
			foreach ( $yum as $k => $v ) {
5677
				if ( strlen( $v ) )
5678
					$state[ $k ] = $v;
5679
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5680
			}
5681
		}
5682
5683
		if ( $restate ) {
5684
			foreach ( $state as $k => $v ) {
5685
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5686
			}
5687
			return;
5688
		}
5689
5690
		// Get a state variable
5691
		if ( isset( $key ) && ! isset( $value ) ) {
5692
			if ( array_key_exists( $key, $state ) )
5693
				return $state[ $key ];
5694
			return null;
5695
		}
5696
5697
		// Set a state variable
5698
		if ( isset ( $key ) && isset( $value ) ) {
5699
			if( is_array( $value ) && isset( $value[0] ) ) {
5700
				$value = $value[0];
5701
			}
5702
			$state[ $key ] = $value;
5703
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5704
		}
5705
	}
5706
5707
	public static function restate() {
5708
		Jetpack::state( null, null, true );
5709
	}
5710
5711
	public static function check_privacy( $file ) {
5712
		static $is_site_publicly_accessible = null;
5713
5714
		if ( is_null( $is_site_publicly_accessible ) ) {
5715
			$is_site_publicly_accessible = false;
5716
5717
			Jetpack::load_xml_rpc_client();
5718
			$rpc = new Jetpack_IXR_Client();
5719
5720
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5721
			if ( $success ) {
5722
				$response = $rpc->getResponse();
5723
				if ( $response ) {
5724
					$is_site_publicly_accessible = true;
5725
				}
5726
			}
5727
5728
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5729
		}
5730
5731
		if ( $is_site_publicly_accessible ) {
5732
			return;
5733
		}
5734
5735
		$module_slug = self::get_module_slug( $file );
5736
5737
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5738
		if ( ! $privacy_checks ) {
5739
			$privacy_checks = $module_slug;
5740
		} else {
5741
			$privacy_checks .= ",$module_slug";
5742
		}
5743
5744
		Jetpack::state( 'privacy_checks', $privacy_checks );
5745
	}
5746
5747
	/**
5748
	 * Helper method for multicall XMLRPC.
5749
	 */
5750
	public static function xmlrpc_async_call() {
5751
		global $blog_id;
5752
		static $clients = array();
5753
5754
		$client_blog_id = is_multisite() ? $blog_id : 0;
5755
5756
		if ( ! isset( $clients[$client_blog_id] ) ) {
5757
			Jetpack::load_xml_rpc_client();
5758
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5759
			if ( function_exists( 'ignore_user_abort' ) ) {
5760
				ignore_user_abort( true );
5761
			}
5762
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5763
		}
5764
5765
		$args = func_get_args();
5766
5767
		if ( ! empty( $args[0] ) ) {
5768
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5769
		} elseif ( is_multisite() ) {
5770
			foreach ( $clients as $client_blog_id => $client ) {
5771
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5772
					continue;
5773
				}
5774
5775
				$switch_success = switch_to_blog( $client_blog_id, true );
5776
				if ( ! $switch_success ) {
5777
					continue;
5778
				}
5779
5780
				flush();
5781
				$client->query();
5782
5783
				restore_current_blog();
5784
			}
5785
		} else {
5786
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5787
				flush();
5788
				$clients[0]->query();
5789
			}
5790
		}
5791
	}
5792
5793
	public static function staticize_subdomain( $url ) {
5794
5795
		// Extract hostname from URL
5796
		$host = parse_url( $url, PHP_URL_HOST );
5797
5798
		// Explode hostname on '.'
5799
		$exploded_host = explode( '.', $host );
5800
5801
		// Retrieve the name and TLD
5802
		if ( count( $exploded_host ) > 1 ) {
5803
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5804
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5805
			// Rebuild domain excluding subdomains
5806
			$domain = $name . '.' . $tld;
5807
		} else {
5808
			$domain = $host;
5809
		}
5810
		// Array of Automattic domains
5811
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5812
5813
		// Return $url if not an Automattic domain
5814
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5815
			return $url;
5816
		}
5817
5818
		if ( is_ssl() ) {
5819
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5820
		}
5821
5822
		srand( crc32( basename( $url ) ) );
5823
		$static_counter = rand( 0, 2 );
5824
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5825
5826
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5827
	}
5828
5829
/* JSON API Authorization */
5830
5831
	/**
5832
	 * Handles the login action for Authorizing the JSON API
5833
	 */
5834
	function login_form_json_api_authorization() {
5835
		$this->verify_json_api_authorization_request();
5836
5837
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5838
5839
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5840
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5841
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5842
	}
5843
5844
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5845
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5846
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5847
			return $url;
5848
		}
5849
5850
		$parsed_url = parse_url( $url );
5851
		$url = strtok( $url, '?' );
5852
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5853
		if ( ! empty( $parsed_url['query'] ) )
5854
			$url .= "&{$parsed_url['query']}";
5855
5856
		return $url;
5857
	}
5858
5859
	// Make sure the POSTed request is handled by the same action
5860
	function preserve_action_in_login_form_for_json_api_authorization() {
5861
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5862
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5863
	}
5864
5865
	// If someone logs in to approve API access, store the Access Code in usermeta
5866
	function store_json_api_authorization_token( $user_login, $user ) {
5867
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5868
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5869
		$token = wp_generate_password( 32, false );
5870
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5871
	}
5872
5873
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5874
	function allow_wpcom_public_api_domain( $domains ) {
5875
		$domains[] = 'public-api.wordpress.com';
5876
		return $domains;
5877
	}
5878
5879
	// Add the Access Code details to the public-api.wordpress.com redirect
5880
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5881
		return add_query_arg(
5882
			urlencode_deep(
5883
				array(
5884
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5885
					'jetpack-user-id' => (int) $user->ID,
5886
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5887
				)
5888
			),
5889
			$redirect_to
5890
		);
5891
	}
5892
5893
5894
	/**
5895
	 * Verifies the request by checking the signature
5896
	 *
5897
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5898
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5899
	 *
5900
	 * @param null|array $environment
5901
	 */
5902
	function verify_json_api_authorization_request( $environment = null ) {
5903
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5904
5905
		$environment = is_null( $environment )
5906
			? $_REQUEST
5907
			: $environment;
5908
5909
		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...
5910
		$token = Jetpack_Data::get_access_token( $envUserId );
5911
		if ( ! $token || empty( $token->secret ) ) {
5912
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5913
		}
5914
5915
		$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' );
5916
5917
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5918
5919
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5920
			$signature = $jetpack_signature->sign_request(
5921
				$environment['token'],
5922
				$environment['timestamp'],
5923
				$environment['nonce'],
5924
				'',
5925
				'GET',
5926
				$environment['jetpack_json_api_original_query'],
5927
				null,
5928
				true
5929
			);
5930
		} else {
5931
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5932
		}
5933
5934
		if ( ! $signature ) {
5935
			wp_die( $die_error );
5936
		} else if ( is_wp_error( $signature ) ) {
5937
			wp_die( $die_error );
5938
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5939
			if ( is_ssl() ) {
5940
				// 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
5941
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5942
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5943
					wp_die( $die_error );
5944
				}
5945
			} else {
5946
				wp_die( $die_error );
5947
			}
5948
		}
5949
5950
		$timestamp = (int) $environment['timestamp'];
5951
		$nonce     = stripslashes( (string) $environment['nonce'] );
5952
5953
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5954
			// De-nonce the nonce, at least for 5 minutes.
5955
			// 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)
5956
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5957
			if ( $old_nonce_time < time() - 300 ) {
5958
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5959
			}
5960
		}
5961
5962
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5963
		$data_filters = array(
5964
			'state'        => 'opaque',
5965
			'client_id'    => 'int',
5966
			'client_title' => 'string',
5967
			'client_image' => 'url',
5968
		);
5969
5970
		foreach ( $data_filters as $key => $sanitation ) {
5971
			if ( ! isset( $data->$key ) ) {
5972
				wp_die( $die_error );
5973
			}
5974
5975
			switch ( $sanitation ) {
5976
			case 'int' :
5977
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5978
				break;
5979
			case 'opaque' :
5980
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5981
				break;
5982
			case 'string' :
5983
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5984
				break;
5985
			case 'url' :
5986
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5987
				break;
5988
			}
5989
		}
5990
5991
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5992
			wp_die( $die_error );
5993
		}
5994
	}
5995
5996
	function login_message_json_api_authorization( $message ) {
5997
		return '<p class="message">' . sprintf(
5998
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5999
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6000
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6001
	}
6002
6003
	/**
6004
	 * Get $content_width, but with a <s>twist</s> filter.
6005
	 */
6006
	public static function get_content_width() {
6007
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6008
		/**
6009
		 * Filter the Content Width value.
6010
		 *
6011
		 * @since 2.2.3
6012
		 *
6013
		 * @param string $content_width Content Width value.
6014
		 */
6015
		return apply_filters( 'jetpack_content_width', $content_width );
6016
	}
6017
6018
	/**
6019
	 * Pings the WordPress.com Mirror Site for the specified options.
6020
	 *
6021
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6022
	 *
6023
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6024
	 */
6025
	public function get_cloud_site_options( $option_names ) {
6026
		$option_names = array_filter( (array) $option_names, 'is_string' );
6027
6028
		Jetpack::load_xml_rpc_client();
6029
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6030
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6031
		if ( $xml->isError() ) {
6032
			return array(
6033
				'error_code' => $xml->getErrorCode(),
6034
				'error_msg'  => $xml->getErrorMessage(),
6035
			);
6036
		}
6037
		$cloud_site_options = $xml->getResponse();
6038
6039
		return $cloud_site_options;
6040
	}
6041
6042
	/**
6043
	 * Checks if the site is currently in an identity crisis.
6044
	 *
6045
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6046
	 */
6047
	public static function check_identity_crisis() {
6048
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6049
			return false;
6050
		}
6051
6052
		return Jetpack_Options::get_option( 'sync_error_idc' );
6053
	}
6054
6055
	/**
6056
	 * Checks whether the home and siteurl specifically are whitelisted
6057
	 * Written so that we don't have re-check $key and $value params every time
6058
	 * we want to check if this site is whitelisted, for example in footer.php
6059
	 *
6060
	 * @since  3.8.0
6061
	 * @return bool True = already whitelisted False = not whitelisted
6062
	 */
6063
	public static function is_staging_site() {
6064
		$is_staging = false;
6065
6066
		$known_staging = array(
6067
			'urls' => array(
6068
				'#\.staging\.wpengine\.com$#i', // WP Engine
6069
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6070
				),
6071
			'constants' => array(
6072
				'IS_WPE_SNAPSHOT',      // WP Engine
6073
				'KINSTA_DEV_ENV',       // Kinsta.com
6074
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6075
				'JETPACK_STAGING_MODE', // Generic
6076
				)
6077
			);
6078
		/**
6079
		 * Filters the flags of known staging sites.
6080
		 *
6081
		 * @since 3.9.0
6082
		 *
6083
		 * @param array $known_staging {
6084
		 *     An array of arrays that each are used to check if the current site is staging.
6085
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6086
		 *     @type array $constants PHP constants of known staging/developement environments.
6087
		 *  }
6088
		 */
6089
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6090
6091
		if ( isset( $known_staging['urls'] ) ) {
6092
			foreach ( $known_staging['urls'] as $url ){
6093
				if ( preg_match( $url, site_url() ) ) {
6094
					$is_staging = true;
6095
					break;
6096
				}
6097
			}
6098
		}
6099
6100
		if ( isset( $known_staging['constants'] ) ) {
6101
			foreach ( $known_staging['constants'] as $constant ) {
6102
				if ( defined( $constant ) && constant( $constant ) ) {
6103
					$is_staging = true;
6104
				}
6105
			}
6106
		}
6107
6108
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6109
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6110
			$is_staging = true;
6111
		}
6112
6113
		/**
6114
		 * Filters is_staging_site check.
6115
		 *
6116
		 * @since 3.9.0
6117
		 *
6118
		 * @param bool $is_staging If the current site is a staging site.
6119
		 */
6120
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6121
	}
6122
6123
	/**
6124
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6125
	 *
6126
	 * @since 4.4.0
6127
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6128
	 *
6129
	 * @return bool
6130
	 */
6131
	public static function validate_sync_error_idc_option() {
6132
		$is_valid = false;
6133
6134
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6135
		if ( false === $idc_allowed ) {
6136
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6137
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6138
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6139
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6140
				$transient_duration = HOUR_IN_SECONDS;
6141
			} else {
6142
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6143
				$idc_allowed = '1';
6144
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6145
			}
6146
6147
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6148
		}
6149
6150
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6151
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6152
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6153
			$local_options = self::get_sync_error_idc_option();
6154
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6155
				$is_valid = true;
6156
			}
6157
		}
6158
6159
		/**
6160
		 * Filters whether the sync_error_idc option is valid.
6161
		 *
6162
		 * @since 4.4.0
6163
		 *
6164
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6165
		 */
6166
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6167
6168
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6169
			// Since the option exists, and did not validate, delete it
6170
			Jetpack_Options::delete_option( 'sync_error_idc' );
6171
		}
6172
6173
		return $is_valid;
6174
	}
6175
6176
	/**
6177
	 * Normalizes a url by doing three things:
6178
	 *  - Strips protocol
6179
	 *  - Strips www
6180
	 *  - Adds a trailing slash
6181
	 *
6182
	 * @since 4.4.0
6183
	 * @param string $url
6184
	 * @return WP_Error|string
6185
	 */
6186
	public static function normalize_url_protocol_agnostic( $url ) {
6187
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6188
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6189
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6190
		}
6191
6192
		// Strip www and protocols
6193
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6194
		return $url;
6195
	}
6196
6197
	/**
6198
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6199
	 *
6200
	 * @since 4.4.0
6201
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6202
	 *
6203
	 * @param array $response
6204
	 * @return array Array of the local urls, wpcom urls, and error code
6205
	 */
6206
	public static function get_sync_error_idc_option( $response = array() ) {
6207
		// Since the local options will hit the database directly, store the values
6208
		// in a transient to allow for autoloading and caching on subsequent views.
6209
		$local_options = get_transient( 'jetpack_idc_local' );
6210
		if ( false === $local_options ) {
6211
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6212
			$local_options = array(
6213
				'home'    => Jetpack_Sync_Functions::home_url(),
6214
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6215
			);
6216
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6217
		}
6218
6219
		$options = array_merge( $local_options, $response );
6220
6221
		$returned_values = array();
6222
		foreach( $options as $key => $option ) {
6223
			if ( 'error_code' === $key ) {
6224
				$returned_values[ $key ] = $option;
6225
				continue;
6226
			}
6227
6228
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6229
				continue;
6230
			}
6231
6232
			$returned_values[ $key ] = $normalized_url;
6233
		}
6234
6235
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6236
6237
		return $returned_values;
6238
	}
6239
6240
	/**
6241
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6242
	 * If set to true, the site will be put into staging mode.
6243
	 *
6244
	 * @since 4.3.2
6245
	 * @return bool
6246
	 */
6247
	public static function sync_idc_optin() {
6248
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6249
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6250
		} else {
6251
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6252
		}
6253
6254
		/**
6255
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6256
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6257
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6258
		 *
6259
		 * @since 4.3.2
6260
		 *
6261
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6262
		 */
6263
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6264
	}
6265
6266
	/**
6267
	 * Maybe Use a .min.css stylesheet, maybe not.
6268
	 *
6269
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6270
	 */
6271
	public static function maybe_min_asset( $url, $path, $plugin ) {
6272
		// Short out on things trying to find actual paths.
6273
		if ( ! $path || empty( $plugin ) ) {
6274
			return $url;
6275
		}
6276
6277
		$path = ltrim( $path, '/' );
6278
6279
		// Strip out the abspath.
6280
		$base = dirname( plugin_basename( $plugin ) );
6281
6282
		// Short out on non-Jetpack assets.
6283
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6284
			return $url;
6285
		}
6286
6287
		// File name parsing.
6288
		$file              = "{$base}/{$path}";
6289
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6290
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6291
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6292
		$extension         = array_shift( $file_name_parts_r );
6293
6294
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6295
			// Already pointing at the minified version.
6296
			if ( 'min' === $file_name_parts_r[0] ) {
6297
				return $url;
6298
			}
6299
6300
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6301
			if ( file_exists( $min_full_path ) ) {
6302
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6303
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6304
				if ( 'css' === $extension ) {
6305
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6306
					self::$min_assets[ $key ] = $path;
6307
				}
6308
			}
6309
		}
6310
6311
		return $url;
6312
	}
6313
6314
	/**
6315
	 * If the asset is minified, let's flag .min as the suffix.
6316
	 *
6317
	 * Attached to `style_loader_src` filter.
6318
	 *
6319
	 * @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...
6320
	 * @param string $handle The registered handle of the script in question.
6321
	 * @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...
6322
	 */
6323
	public static function set_suffix_on_min( $src, $handle ) {
6324
		if ( false === strpos( $src, '.min.css' ) ) {
6325
			return $src;
6326
		}
6327
6328
		if ( ! empty( self::$min_assets ) ) {
6329
			foreach ( self::$min_assets as $file => $path ) {
6330
				if ( false !== strpos( $src, $file ) ) {
6331
					wp_style_add_data( $handle, 'suffix', '.min' );
6332
					return $src;
6333
				}
6334
			}
6335
		}
6336
6337
		return $src;
6338
	}
6339
6340
	/**
6341
	 * Maybe inlines a stylesheet.
6342
	 *
6343
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6344
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6345
	 *
6346
	 * Attached to `style_loader_tag` filter.
6347
	 *
6348
	 * @param string $tag The tag that would link to the external asset.
6349
	 * @param string $handle The registered handle of the script in question.
6350
	 *
6351
	 * @return string
6352
	 */
6353
	public static function maybe_inline_style( $tag, $handle ) {
6354
		global $wp_styles;
6355
		$item = $wp_styles->registered[ $handle ];
6356
6357
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6358
			return $tag;
6359
		}
6360
6361
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6362
			$href = $matches[1];
6363
			// Strip off query string
6364
			if ( $pos = strpos( $href, '?' ) ) {
6365
				$href = substr( $href, 0, $pos );
6366
			}
6367
			// Strip off fragment
6368
			if ( $pos = strpos( $href, '#' ) ) {
6369
				$href = substr( $href, 0, $pos );
6370
			}
6371
		} else {
6372
			return $tag;
6373
		}
6374
6375
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6376
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6377
			return $tag;
6378
		}
6379
6380
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6381
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6382
			// And this isn't the pass that actually deals with the RTL version...
6383
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6384
				// Short out, as the RTL version will deal with it in a moment.
6385
				return $tag;
6386
			}
6387
		}
6388
6389
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6390
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6391
		if ( $css ) {
6392
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6393
			if ( empty( $item->extra['after'] ) ) {
6394
				wp_add_inline_style( $handle, $css );
6395
			} else {
6396
				array_unshift( $item->extra['after'], $css );
6397
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6398
			}
6399
		}
6400
6401
		return $tag;
6402
	}
6403
6404
	/**
6405
	 * Loads a view file from the views
6406
	 *
6407
	 * Data passed in with the $data parameter will be available in the
6408
	 * template file as $data['value']
6409
	 *
6410
	 * @param string $template - Template file to load
6411
	 * @param array $data - Any data to pass along to the template
6412
	 * @return boolean - If template file was found
6413
	 **/
6414
	public function load_view( $template, $data = array() ) {
6415
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6416
6417
		if( file_exists( $views_dir . $template ) ) {
6418
			require_once( $views_dir . $template );
6419
			return true;
6420
		}
6421
6422
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6423
		return false;
6424
	}
6425
6426
	/**
6427
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6428
	 */
6429
	public function deprecated_hooks() {
6430
		global $wp_filter;
6431
6432
		/*
6433
		 * Format:
6434
		 * deprecated_filter_name => replacement_name
6435
		 *
6436
		 * If there is no replacement, use null for replacement_name
6437
		 */
6438
		$deprecated_list = array(
6439
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6440
			'wpl_sharing_2014_1'                                     => null,
6441
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6442
			'jetpack_identity_crisis_options_to_check'               => null,
6443
			'update_option_jetpack_single_user_site'                 => null,
6444
			'audio_player_default_colors'                            => null,
6445
			'add_option_jetpack_featured_images_enabled'             => null,
6446
			'add_option_jetpack_update_details'                      => null,
6447
			'add_option_jetpack_updates'                             => null,
6448
			'add_option_jetpack_network_name'                        => null,
6449
			'add_option_jetpack_network_allow_new_registrations'     => null,
6450
			'add_option_jetpack_network_add_new_users'               => null,
6451
			'add_option_jetpack_network_site_upload_space'           => null,
6452
			'add_option_jetpack_network_upload_file_types'           => null,
6453
			'add_option_jetpack_network_enable_administration_menus' => null,
6454
			'add_option_jetpack_is_multi_site'                       => null,
6455
			'add_option_jetpack_is_main_network'                     => null,
6456
			'add_option_jetpack_main_network_site'                   => null,
6457
			'jetpack_sync_all_registered_options'                    => null,
6458
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6459
			'jetpack_is_post_mailable'                               => null,
6460
			'jetpack_seo_site_host'                                  => null,
6461
		);
6462
6463
		// This is a silly loop depth. Better way?
6464
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6465
			if ( has_action( $hook ) ) {
6466
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6467
					foreach( $values AS $hooked ) {
6468
						if ( is_callable( $hooked['function'] ) ) {
6469
							$function_name = 'an anonymous function';
6470
						} else {
6471
							$function_name = $hooked['function'];
6472
						}
6473
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6474
					}
6475
				}
6476
			}
6477
		}
6478
	}
6479
6480
	/**
6481
	 * Converts any url in a stylesheet, to the correct absolute url.
6482
	 *
6483
	 * Considerations:
6484
	 *  - Normal, relative URLs     `feh.png`
6485
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6486
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6487
	 *  - Absolute URLs             `http://domain.com/feh.png`
6488
	 *  - Domain root relative URLs `/feh.png`
6489
	 *
6490
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6491
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6492
	 *
6493
	 * @return mixed|string
6494
	 */
6495
	public static function absolutize_css_urls( $css, $css_file_url ) {
6496
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6497
		$css_dir = dirname( $css_file_url );
6498
		$p       = parse_url( $css_dir );
6499
		$domain  = sprintf(
6500
					'%1$s//%2$s%3$s%4$s',
6501
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6502
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6503
					$p['host'],
6504
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6505
				);
6506
6507
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6508
			$find = $replace = array();
6509
			foreach ( $matches as $match ) {
6510
				$url = trim( $match['path'], "'\" \t" );
6511
6512
				// If this is a data url, we don't want to mess with it.
6513
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6514
					continue;
6515
				}
6516
6517
				// If this is an absolute or protocol-agnostic url,
6518
				// we don't want to mess with it.
6519
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6520
					continue;
6521
				}
6522
6523
				switch ( substr( $url, 0, 1 ) ) {
6524
					case '/':
6525
						$absolute = $domain . $url;
6526
						break;
6527
					default:
6528
						$absolute = $css_dir . '/' . $url;
6529
				}
6530
6531
				$find[]    = $match[0];
6532
				$replace[] = sprintf( 'url("%s")', $absolute );
6533
			}
6534
			$css = str_replace( $find, $replace, $css );
6535
		}
6536
6537
		return $css;
6538
	}
6539
6540
	/**
6541
	 * This methods removes all of the registered css files on the front end
6542
	 * from Jetpack in favor of using a single file. In effect "imploding"
6543
	 * all the files into one file.
6544
	 *
6545
	 * Pros:
6546
	 * - Uses only ONE css asset connection instead of 15
6547
	 * - Saves a minimum of 56k
6548
	 * - Reduces server load
6549
	 * - Reduces time to first painted byte
6550
	 *
6551
	 * Cons:
6552
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6553
	 *		should not cause any issues with themes.
6554
	 * - Plugins/themes dequeuing styles no longer do anything. See
6555
	 *		jetpack_implode_frontend_css filter for a workaround
6556
	 *
6557
	 * For some situations developers may wish to disable css imploding and
6558
	 * instead operate in legacy mode where each file loads seperately and
6559
	 * can be edited individually or dequeued. This can be accomplished with
6560
	 * the following line:
6561
	 *
6562
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6563
	 *
6564
	 * @since 3.2
6565
	 **/
6566
	public function implode_frontend_css( $travis_test = false ) {
6567
		$do_implode = true;
6568
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6569
			$do_implode = false;
6570
		}
6571
6572
		/**
6573
		 * Allow CSS to be concatenated into a single jetpack.css file.
6574
		 *
6575
		 * @since 3.2.0
6576
		 *
6577
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6578
		 */
6579
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6580
6581
		// Do not use the imploded file when default behaviour was altered through the filter
6582
		if ( ! $do_implode ) {
6583
			return;
6584
		}
6585
6586
		// We do not want to use the imploded file in dev mode, or if not connected
6587
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6588
			if ( ! $travis_test ) {
6589
				return;
6590
			}
6591
		}
6592
6593
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6594
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6595
			return;
6596
		}
6597
6598
		/*
6599
		 * Now we assume Jetpack is connected and able to serve the single
6600
		 * file.
6601
		 *
6602
		 * In the future there will be a check here to serve the file locally
6603
		 * or potentially from the Jetpack CDN
6604
		 *
6605
		 * For now:
6606
		 * - Enqueue a single imploded css file
6607
		 * - Zero out the style_loader_tag for the bundled ones
6608
		 * - Be happy, drink scotch
6609
		 */
6610
6611
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6612
6613
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6614
6615
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6616
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6617
	}
6618
6619
	function concat_remove_style_loader_tag( $tag, $handle ) {
6620
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6621
			$tag = '';
6622
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6623
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6624
			}
6625
		}
6626
6627
		return $tag;
6628
	}
6629
6630
	/*
6631
	 * Check the heartbeat data
6632
	 *
6633
	 * Organizes the heartbeat data by severity.  For example, if the site
6634
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6635
	 *
6636
	 * Data will be added to "caution" array, if it either:
6637
	 *  - Out of date Jetpack version
6638
	 *  - Out of date WP version
6639
	 *  - Out of date PHP version
6640
	 *
6641
	 * $return array $filtered_data
6642
	 */
6643
	public static function jetpack_check_heartbeat_data() {
6644
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6645
6646
		$good    = array();
6647
		$caution = array();
6648
		$bad     = array();
6649
6650
		foreach ( $raw_data as $stat => $value ) {
6651
6652
			// Check jetpack version
6653
			if ( 'version' == $stat ) {
6654
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6655
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6656
					continue;
6657
				}
6658
			}
6659
6660
			// Check WP version
6661
			if ( 'wp-version' == $stat ) {
6662
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6663
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6664
					continue;
6665
				}
6666
			}
6667
6668
			// Check PHP version
6669
			if ( 'php-version' == $stat ) {
6670
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6671
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6672
					continue;
6673
				}
6674
			}
6675
6676
			// Check ID crisis
6677
			if ( 'identitycrisis' == $stat ) {
6678
				if ( 'yes' == $value ) {
6679
					$bad[ $stat ] = $value;
6680
					continue;
6681
				}
6682
			}
6683
6684
			// The rest are good :)
6685
			$good[ $stat ] = $value;
6686
		}
6687
6688
		$filtered_data = array(
6689
			'good'    => $good,
6690
			'caution' => $caution,
6691
			'bad'     => $bad
6692
		);
6693
6694
		return $filtered_data;
6695
	}
6696
6697
6698
	/*
6699
	 * This method is used to organize all options that can be reset
6700
	 * without disconnecting Jetpack.
6701
	 *
6702
	 * It is used in class.jetpack-cli.php to reset options
6703
	 *
6704
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6705
	 *
6706
	 * @return array of options to delete.
6707
	 */
6708
	public static function get_jetpack_options_for_reset() {
6709
		return Jetpack_Options::get_options_for_reset();
6710
	}
6711
6712
	/**
6713
	 * Check if an option of a Jetpack module has been updated.
6714
	 *
6715
	 * If any module option has been updated before Jump Start has been dismissed,
6716
	 * update the 'jumpstart' option so we can hide Jump Start.
6717
	 *
6718
	 * @param string $option_name
6719
	 *
6720
	 * @return bool
6721
	 */
6722
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6723
		// Bail if Jump Start has already been dismissed
6724
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6725
			return false;
6726
		}
6727
6728
		$jetpack = Jetpack::init();
6729
6730
		// Manual build of module options
6731
		$option_names = self::get_jetpack_options_for_reset();
6732
6733
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6734
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6735
6736
			//Jump start is being dismissed send data to MC Stats
6737
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6738
6739
			$jetpack->do_stats( 'server_side' );
6740
		}
6741
6742
	}
6743
6744
	/*
6745
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6746
	 * so we can bring them directly to their site in calypso.
6747
	 *
6748
	 * @param string | url
6749
	 * @return string | url without the guff
6750
	 */
6751
	public static function build_raw_urls( $url ) {
6752
		$strip_http = '/.*?:\/\//i';
6753
		$url = preg_replace( $strip_http, '', $url  );
6754
		$url = str_replace( '/', '::', $url );
6755
		return $url;
6756
	}
6757
6758
	/**
6759
	 * Stores and prints out domains to prefetch for page speed optimization.
6760
	 *
6761
	 * @param mixed $new_urls
6762
	 */
6763
	public static function dns_prefetch( $new_urls = null ) {
6764
		static $prefetch_urls = array();
6765
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6766
			echo "\r\n";
6767
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6768
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6769
			}
6770
		} elseif ( ! empty( $new_urls ) ) {
6771
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6772
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6773
			}
6774
			foreach ( (array) $new_urls as $this_new_url ) {
6775
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6776
			}
6777
			$prefetch_urls = array_unique( $prefetch_urls );
6778
		}
6779
	}
6780
6781
	public function wp_dashboard_setup() {
6782
		if ( self::is_active() ) {
6783
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6784
		}
6785
6786
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6787
			wp_add_dashboard_widget(
6788
				'jetpack_summary_widget',
6789
				esc_html__( 'Site Stats', 'jetpack' ),
6790
				array( __CLASS__, 'dashboard_widget' )
6791
			);
6792
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6793
6794
			// If we're inactive and not in development mode, sort our box to the top.
6795
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6796
				global $wp_meta_boxes;
6797
6798
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6799
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6800
6801
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6802
			}
6803
		}
6804
	}
6805
6806
	/**
6807
	 * @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...
6808
	 * @return mixed
6809
	 */
6810
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6811
		if ( ! is_array( $sorted ) ) {
6812
			return $sorted;
6813
		}
6814
6815
		foreach ( $sorted as $box_context => $ids ) {
6816
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6817
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6818
				continue;
6819
			}
6820
6821
			$ids_array = explode( ',', $ids );
6822
			$key = array_search( 'dashboard_stats', $ids_array );
6823
6824
			if ( false !== $key ) {
6825
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6826
				$ids_array[ $key ] = 'jetpack_summary_widget';
6827
				$sorted[ $box_context ] = implode( ',', $ids_array );
6828
				// We've found it, stop searching, and just return.
6829
				break;
6830
			}
6831
		}
6832
6833
		return $sorted;
6834
	}
6835
6836
	public static function dashboard_widget() {
6837
		/**
6838
		 * Fires when the dashboard is loaded.
6839
		 *
6840
		 * @since 3.4.0
6841
		 */
6842
		do_action( 'jetpack_dashboard_widget' );
6843
	}
6844
6845
	public static function dashboard_widget_footer() {
6846
		?>
6847
		<footer>
6848
6849
		<div class="protect">
6850
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6851
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6852
				<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>
6853
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6854
				<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' ); ?>">
6855
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6856
				</a>
6857
			<?php else : ?>
6858
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6859
			<?php endif; ?>
6860
		</div>
6861
6862
		<div class="akismet">
6863
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6864
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6865
				<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>
6866
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6867
				<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">
6868
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6869
				</a>
6870
			<?php else : ?>
6871
				<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>
6872
			<?php endif; ?>
6873
		</div>
6874
6875
		</footer>
6876
		<?php
6877
	}
6878
6879
	/**
6880
	 * Return string containing the Jetpack logo.
6881
	 *
6882
	 * @since 3.9.0
6883
	 *
6884
	 * @return string
6885
	 */
6886
	public static function get_jp_emblem() {
6887
		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>';
6888
	}
6889
6890
	/*
6891
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6892
	 */
6893
	function jetpack_icon_user_connected( $columns ) {
6894
		$columns['user_jetpack'] = '';
6895
		return $columns;
6896
	}
6897
6898
	/*
6899
	 * Show Jetpack icon if the user is linked.
6900
	 */
6901
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6902
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6903
			$emblem_html = sprintf(
6904
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6905
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6906
				Jetpack::get_jp_emblem()
6907
			);
6908
			return $emblem_html;
6909
		}
6910
6911
		return $val;
6912
	}
6913
6914
	/*
6915
	 * Style the Jetpack user column
6916
	 */
6917
	function jetpack_user_col_style() {
6918
		global $current_screen;
6919
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6920
			<style>
6921
				.fixed .column-user_jetpack {
6922
					width: 21px;
6923
				}
6924
				.jp-emblem-user-admin svg {
6925
					width: 20px;
6926
					height: 20px;
6927
				}
6928
				.jp-emblem-user-admin path {
6929
					fill: #00BE28;
6930
				}
6931
			</style>
6932
		<?php }
6933
	}
6934
6935
	/**
6936
	 * Checks if Akismet is active and working.
6937
	 *
6938
	 * @since  5.1.0
6939
	 * @return bool True = Akismet available. False = Aksimet not available.
6940
	 */
6941
	public static function is_akismet_active() {
6942
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6943
			return true;
6944
		}
6945
		return false;
6946
	}
6947
6948
	/**
6949
	 * Checks if one or more function names is in debug_backtrace
6950
	 *
6951
	 * @param $names Mixed string name of function or array of string names of functions
6952
	 *
6953
	 * @return bool
6954
	 */
6955
	public static function is_function_in_backtrace( $names ) {
6956
		$backtrace = debug_backtrace( false );
6957
		if ( ! is_array( $names ) ) {
6958
			$names = array( $names );
6959
		}
6960
		$names_as_keys = array_flip( $names );
6961
6962
		//Do check in constant O(1) time for PHP5.5+
6963
		if ( function_exists( 'array_column' ) ) {
6964
			$backtrace_functions = array_column( $backtrace, 'function' );
6965
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6966
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6967
			return ! empty ( $intersection );
6968
		}
6969
6970
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6971
		foreach ( $backtrace as $call ) {
6972
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6973
				return true;
6974
			}
6975
		}
6976
		return false;
6977
	}
6978
6979
	/**
6980
	 * Given a minified path, and a non-minified path, will return
6981
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6982
	 *
6983
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6984
	 * root Jetpack directory.
6985
	 *
6986
	 * @since 5.6.0
6987
	 *
6988
	 * @param string $min_path
6989
	 * @param string $non_min_path
6990
	 * @return string The URL to the file
6991
	 */
6992
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6993
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
6994
			? $non_min_path
6995
			: $min_path;
6996
6997
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6998
	}
6999
7000
	/**
7001
	 * Checks for whether Jetpack Rewind is enabled.
7002
	 * Will return true if the state of Rewind is anything except "unavailable".
7003
	 * @return bool|int|mixed
7004
	 */
7005
	public static function is_rewind_enabled() {
7006
		if ( ! Jetpack::is_active() ) {
7007
			return false;
7008
		}
7009
7010
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7011
		if ( false === $rewind_enabled ) {
7012
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7013
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7014
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7015
				&& ! empty( $rewind_data['state'] )
7016
				&& 'unavailable' !== $rewind_data['state'] )
7017
				? 1
7018
				: 0;
7019
7020
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7021
		}
7022
		return $rewind_enabled;
7023
	}
7024
}
7025