Completed
Push — update/ads-css ( 15ea64...33b47e )
by
unknown
23:45 queued 15:29
created

Jetpack::is_rewind_enabled()   B

Complexity

Conditions 6
Paths 8

Size

Total Lines 19
Code Lines 14

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 6
eloc 14
nc 8
nop 0
dl 0
loc 19
rs 8.8571
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 and page links to Calypso instead of WP-Admin.
640
		// We should make sure to only do this for front end links.
641
		if ( Jetpack_Options::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
642
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_links_to_calypso' ), 1, 2 );
643
		}
644
645
		// Update the Jetpack plan from API on heartbeats
646
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
647
648
		/**
649
		 * This is the hack to concatinate all css files into one.
650
		 * For description and reasoning see the implode_frontend_css method
651
		 *
652
		 * Super late priority so we catch all the registered styles
653
		 */
654
		if( !is_admin() ) {
655
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
656
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
657
		}
658
659
		/**
660
		 * These are sync actions that we need to keep track of for jitms
661
		 */
662
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
663
664
		// Actually push the stats on shutdown.
665
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
666
			add_action( 'shutdown', array( $this, 'push_stats' ) );
667
		}
668
	}
669
670
	function point_edit_links_to_calypso( $default_url, $post_id ) {
671
		$post = get_post( $post_id );
672
673
		if ( empty( $post ) ) {
674
			return $default_url;
675
		}
676
677
		$post_type = $post->post_type;
678
679
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
680
		// https://en.support.wordpress.com/custom-post-types/
681
		$allowed_post_types = array(
682
			'post' => 'post',
683
			'page' => 'page',
684
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
685
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
686
		);
687
688
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
689
			return $default_url;
690
		}
691
692
		$path_prefix = $allowed_post_types[ $post_type ];
693
694
		$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...
695
696
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
697
	}
698
699
	function jetpack_track_last_sync_callback( $params ) {
700
		/**
701
		 * Filter to turn off jitm caching
702
		 *
703
		 * @since 5.4.0
704
		 *
705
		 * @param bool false Whether to cache just in time messages
706
		 */
707
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
708
			return $params;
709
		}
710
711
		if ( is_array( $params ) && isset( $params[0] ) ) {
712
			$option = $params[0];
713
			if ( 'active_plugins' === $option ) {
714
				// use the cache if we can, but not terribly important if it gets evicted
715
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
716
			}
717
		}
718
719
		return $params;
720
	}
721
722
	function jetpack_connection_banner_callback() {
723
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
724
725
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
726
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
727
			wp_send_json_success();
728
		}
729
730
		wp_die();
731
	}
732
733
	function jetpack_admin_ajax_tracks_callback() {
734
		// Check for nonce
735
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
736
			wp_die( 'Permissions check failed.' );
737
		}
738
739
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
740
			wp_die( 'No valid event name or type.' );
741
		}
742
743
		$tracks_data = array();
744
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
745
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
746
				$tracks_data = $_REQUEST['tracksEventProp'];
747
			} else {
748
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
749
			}
750
		}
751
752
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
753
		wp_send_json_success();
754
		wp_die();
755
	}
756
757
	/**
758
	 * The callback for the JITM ajax requests.
759
	 */
760
	function jetpack_jitm_ajax_callback() {
761
		// Check for nonce
762
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
763
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
764
		}
765
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
766
			$module_slug = $_REQUEST['jitmModule'];
767
			Jetpack::log( 'activate', $module_slug );
768
			Jetpack::activate_module( $module_slug, false, false );
769
			Jetpack::state( 'message', 'no_message' );
770
771
			//A Jetpack module is being activated through a JITM, track it
772
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
773
			$this->do_stats( 'server_side' );
774
775
			wp_send_json_success();
776
		}
777
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
778
			// get the hide_jitm options array
779
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
780
			$module_slug = $_REQUEST['jitmModule'];
781
782
			if( ! $jetpack_hide_jitm ) {
783
				$jetpack_hide_jitm = array(
784
					$module_slug => 'hide'
785
				);
786
			} else {
787
				$jetpack_hide_jitm[$module_slug] = 'hide';
788
			}
789
790
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
791
792
			//jitm is being dismissed forever, track it
793
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
794
			$this->do_stats( 'server_side' );
795
796
			wp_send_json_success();
797
		}
798 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
799
			$module_slug = $_REQUEST['jitmModule'];
800
801
			// User went to WordPress.com, track this
802
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
803
			$this->do_stats( 'server_side' );
804
805
			wp_send_json_success();
806
		}
807 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
808
			$track = $_REQUEST['jitmModule'];
809
810
			// User is viewing JITM, track it.
811
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
812
			$this->do_stats( 'server_side' );
813
814
			wp_send_json_success();
815
		}
816
	}
817
818
	/**
819
	 * If there are any stats that need to be pushed, but haven't been, push them now.
820
	 */
821
	function push_stats() {
822
		if ( ! empty( $this->stats ) ) {
823
			$this->do_stats( 'server_side' );
824
		}
825
	}
826
827
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
828
		switch( $cap ) {
829
			case 'jetpack_connect' :
830
			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...
831
				if ( Jetpack::is_development_mode() ) {
832
					$caps = array( 'do_not_allow' );
833
					break;
834
				}
835
				/**
836
				 * Pass through. If it's not development mode, these should match disconnect.
837
				 * Let users disconnect if it's development mode, just in case things glitch.
838
				 */
839
			case 'jetpack_disconnect' :
840
				/**
841
				 * In multisite, can individual site admins manage their own connection?
842
				 *
843
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
844
				 */
845
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
846
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
847
						/**
848
						 * We need to update the option name -- it's terribly unclear which
849
						 * direction the override goes.
850
						 *
851
						 * @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...
852
						 */
853
						$caps = array( 'do_not_allow' );
854
						break;
855
					}
856
				}
857
858
				$caps = array( 'manage_options' );
859
				break;
860
			case 'jetpack_manage_modules' :
861
			case 'jetpack_activate_modules' :
862
			case 'jetpack_deactivate_modules' :
863
				$caps = array( 'manage_options' );
864
				break;
865
			case 'jetpack_configure_modules' :
866
				$caps = array( 'manage_options' );
867
				break;
868
			case 'jetpack_network_admin_page':
869
			case 'jetpack_network_settings_page':
870
				$caps = array( 'manage_network_plugins' );
871
				break;
872
			case 'jetpack_network_sites_page':
873
				$caps = array( 'manage_sites' );
874
				break;
875
			case 'jetpack_admin_page' :
876
				if ( Jetpack::is_development_mode() ) {
877
					$caps = array( 'manage_options' );
878
					break;
879
				} else {
880
					$caps = array( 'read' );
881
				}
882
				break;
883
			case 'jetpack_connect_user' :
884
				if ( Jetpack::is_development_mode() ) {
885
					$caps = array( 'do_not_allow' );
886
					break;
887
				}
888
				$caps = array( 'read' );
889
				break;
890
		}
891
		return $caps;
892
	}
893
894
	function require_jetpack_authentication() {
895
		// Don't let anyone authenticate
896
		$_COOKIE = array();
897
		remove_all_filters( 'authenticate' );
898
		remove_all_actions( 'wp_login_failed' );
899
900
		if ( Jetpack::is_active() ) {
901
			// Allow Jetpack authentication
902
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
903
		}
904
	}
905
906
	/**
907
	 * Load language files
908
	 * @action plugins_loaded
909
	 */
910
	public static function plugin_textdomain() {
911
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
912
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
913
	}
914
915
	/**
916
	 * Register assets for use in various modules and the Jetpack admin page.
917
	 *
918
	 * @uses wp_script_is, wp_register_script, plugins_url
919
	 * @action wp_loaded
920
	 * @return null
921
	 */
922
	public function register_assets() {
923
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
924
			wp_register_script(
925
				'spin',
926
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
927
				false,
928
				'1.3'
929
			);
930
		}
931
932
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
933
			wp_register_script(
934
				'jquery.spin',
935
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
936
				array( 'jquery', 'spin' ),
937
				'1.3'
938
			);
939
		}
940
941 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
942
			wp_register_script(
943
				'jetpack-gallery-settings',
944
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
945
				array( 'media-views' ),
946
				'20121225'
947
			);
948
		}
949
950
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
951
			wp_register_script(
952
				'jetpack-twitter-timeline',
953
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
954
				array( 'jquery' ),
955
				'4.0.0',
956
				true
957
			);
958
		}
959
960
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
961
			wp_register_script(
962
				'jetpack-facebook-embed',
963
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
964
				array( 'jquery' ),
965
				null,
966
				true
967
			);
968
969
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
970
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
971
			if ( ! is_numeric( $fb_app_id ) ) {
972
				$fb_app_id = '';
973
			}
974
			wp_localize_script(
975
				'jetpack-facebook-embed',
976
				'jpfbembed',
977
				array(
978
					'appid' => $fb_app_id,
979
					'locale' => $this->get_locale(),
980
				)
981
			);
982
		}
983
984
		/**
985
		 * As jetpack_register_genericons is by default fired off a hook,
986
		 * the hook may have already fired by this point.
987
		 * So, let's just trigger it manually.
988
		 */
989
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
990
		jetpack_register_genericons();
991
992
		/**
993
		 * Register the social logos
994
		 */
995
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
996
		jetpack_register_social_logos();
997
998 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
999
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1000
	}
1001
1002
	/**
1003
	 * Guess locale from language code.
1004
	 *
1005
	 * @param string $lang Language code.
1006
	 * @return string|bool
1007
	 */
1008
	function guess_locale_from_lang( $lang ) {
1009
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1010
			return 'en_US';
1011
		}
1012
1013 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1014
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1015
				return false;
1016
			}
1017
1018
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1019
		}
1020
1021
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1022
			// WP.com: get_locale() returns 'it'
1023
			$locale = GP_Locales::by_slug( $lang );
1024
		} else {
1025
			// Jetpack: get_locale() returns 'it_IT';
1026
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1027
		}
1028
1029
		if ( ! $locale ) {
1030
			return false;
1031
		}
1032
1033
		if ( empty( $locale->facebook_locale ) ) {
1034
			if ( empty( $locale->wp_locale ) ) {
1035
				return false;
1036
			} else {
1037
				// Facebook SDK is smart enough to fall back to en_US if a
1038
				// locale isn't supported. Since supported Facebook locales
1039
				// can fall out of sync, we'll attempt to use the known
1040
				// wp_locale value and rely on said fallback.
1041
				return $locale->wp_locale;
1042
			}
1043
		}
1044
1045
		return $locale->facebook_locale;
1046
	}
1047
1048
	/**
1049
	 * Get the locale.
1050
	 *
1051
	 * @return string|bool
1052
	 */
1053
	function get_locale() {
1054
		$locale = $this->guess_locale_from_lang( get_locale() );
1055
1056
		if ( ! $locale ) {
1057
			$locale = 'en_US';
1058
		}
1059
1060
		return $locale;
1061
	}
1062
1063
	/**
1064
	 * Device Pixels support
1065
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1066
	 */
1067
	function devicepx() {
1068
		if ( Jetpack::is_active() ) {
1069
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1070
		}
1071
	}
1072
1073
	/**
1074
	 * Return the network_site_url so that .com knows what network this site is a part of.
1075
	 * @param  bool $option
1076
	 * @return string
1077
	 */
1078
	public function jetpack_main_network_site_option( $option ) {
1079
		return network_site_url();
1080
	}
1081
	/**
1082
	 * Network Name.
1083
	 */
1084
	static function network_name( $option = null ) {
1085
		global $current_site;
1086
		return $current_site->site_name;
1087
	}
1088
	/**
1089
	 * Does the network allow new user and site registrations.
1090
	 * @return string
1091
	 */
1092
	static function network_allow_new_registrations( $option = null ) {
1093
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1094
	}
1095
	/**
1096
	 * Does the network allow admins to add new users.
1097
	 * @return boolian
1098
	 */
1099
	static function network_add_new_users( $option = null ) {
1100
		return (bool) get_site_option( 'add_new_users' );
1101
	}
1102
	/**
1103
	 * File upload psace left per site in MB.
1104
	 *  -1 means NO LIMIT.
1105
	 * @return number
1106
	 */
1107
	static function network_site_upload_space( $option = null ) {
1108
		// value in MB
1109
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1110
	}
1111
1112
	/**
1113
	 * Network allowed file types.
1114
	 * @return string
1115
	 */
1116
	static function network_upload_file_types( $option = null ) {
1117
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1118
	}
1119
1120
	/**
1121
	 * Maximum file upload size set by the network.
1122
	 * @return number
1123
	 */
1124
	static function network_max_upload_file_size( $option = null ) {
1125
		// value in KB
1126
		return get_site_option( 'fileupload_maxk', 300 );
1127
	}
1128
1129
	/**
1130
	 * Lets us know if a site allows admins to manage the network.
1131
	 * @return array
1132
	 */
1133
	static function network_enable_administration_menus( $option = null ) {
1134
		return get_site_option( 'menu_items' );
1135
	}
1136
1137
	/**
1138
	 * If a user has been promoted to or demoted from admin, we need to clear the
1139
	 * jetpack_other_linked_admins transient.
1140
	 *
1141
	 * @since 4.3.2
1142
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1143
	 *
1144
	 * @param int    $user_id   The user ID whose role changed.
1145
	 * @param string $role      The new role.
1146
	 * @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...
1147
	 */
1148
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1149
		if ( 'administrator' == $role
1150
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1151
			|| is_null( $old_roles )
1152
		) {
1153
			delete_transient( 'jetpack_other_linked_admins' );
1154
		}
1155
	}
1156
1157
	/**
1158
	 * Checks to see if there are any other users available to become primary
1159
	 * Users must both:
1160
	 * - Be linked to wpcom
1161
	 * - Be an admin
1162
	 *
1163
	 * @return mixed False if no other users are linked, Int if there are.
1164
	 */
1165
	static function get_other_linked_admins() {
1166
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1167
1168
		if ( false === $other_linked_users ) {
1169
			$admins = get_users( array( 'role' => 'administrator' ) );
1170
			if ( count( $admins ) > 1 ) {
1171
				$available = array();
1172
				foreach ( $admins as $admin ) {
1173
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1174
						$available[] = $admin->ID;
1175
					}
1176
				}
1177
1178
				$count_connected_admins = count( $available );
1179
				if ( count( $available ) > 1 ) {
1180
					$other_linked_users = $count_connected_admins;
1181
				} else {
1182
					$other_linked_users = 0;
1183
				}
1184
			} else {
1185
				$other_linked_users = 0;
1186
			}
1187
1188
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1189
		}
1190
1191
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1192
	}
1193
1194
	/**
1195
	 * Return whether we are dealing with a multi network setup or not.
1196
	 * The reason we are type casting this is because we want to avoid the situation where
1197
	 * the result is false since when is_main_network_option return false it cases
1198
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1199
	 * database which could be set to anything as opposed to what this function returns.
1200
	 * @param  bool  $option
1201
	 *
1202
	 * @return boolean
1203
	 */
1204
	public function is_main_network_option( $option ) {
1205
		// return '1' or ''
1206
		return (string) (bool) Jetpack::is_multi_network();
1207
	}
1208
1209
	/**
1210
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1211
	 *
1212
	 * @param  string  $option
1213
	 * @return boolean
1214
	 */
1215
	public function is_multisite( $option ) {
1216
		return (string) (bool) is_multisite();
1217
	}
1218
1219
	/**
1220
	 * Implemented since there is no core is multi network function
1221
	 * Right now there is no way to tell if we which network is the dominant network on the system
1222
	 *
1223
	 * @since  3.3
1224
	 * @return boolean
1225
	 */
1226
	public static function is_multi_network() {
1227
		global  $wpdb;
1228
1229
		// if we don't have a multi site setup no need to do any more
1230
		if ( ! is_multisite() ) {
1231
			return false;
1232
		}
1233
1234
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1235
		if ( $num_sites > 1 ) {
1236
			return true;
1237
		} else {
1238
			return false;
1239
		}
1240
	}
1241
1242
	/**
1243
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1244
	 * @return null
1245
	 */
1246
	function update_jetpack_main_network_site_option() {
1247
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1248
	}
1249
	/**
1250
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1251
	 *
1252
	 */
1253
	function update_jetpack_network_settings() {
1254
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1255
		// Only sync this info for the main network site.
1256
	}
1257
1258
	/**
1259
	 * Get back if the current site is single user site.
1260
	 *
1261
	 * @return bool
1262
	 */
1263
	public static function is_single_user_site() {
1264
		global $wpdb;
1265
1266 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1267
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1268
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1269
		}
1270
		return 1 === (int) $some_users;
1271
	}
1272
1273
	/**
1274
	 * Returns true if the site has file write access false otherwise.
1275
	 * @return string ( '1' | '0' )
1276
	 **/
1277
	public static function file_system_write_access() {
1278
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1279
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1280
		}
1281
1282
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1283
1284
		$filesystem_method = get_filesystem_method();
1285
		if ( $filesystem_method === 'direct' ) {
1286
			return 1;
1287
		}
1288
1289
		ob_start();
1290
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1291
		ob_end_clean();
1292
		if ( $filesystem_credentials_are_stored ) {
1293
			return 1;
1294
		}
1295
		return 0;
1296
	}
1297
1298
	/**
1299
	 * Finds out if a site is using a version control system.
1300
	 * @return string ( '1' | '0' )
1301
	 **/
1302
	public static function is_version_controlled() {
1303
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1304
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1305
	}
1306
1307
	/**
1308
	 * Determines whether the current theme supports featured images or not.
1309
	 * @return string ( '1' | '0' )
1310
	 */
1311
	public static function featured_images_enabled() {
1312
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1313
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1314
	}
1315
1316
	/**
1317
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1318
	 *
1319
	 * @deprecated 4.7 use get_avatar_url instead.
1320
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1321
	 * @param int $size Size of the avatar image
1322
	 * @param string $default URL to a default image to use if no avatar is available
1323
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1324
	 *
1325
	 * @return array
1326
	 */
1327
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1328
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1329
		return get_avatar_url( $id_or_email, array(
1330
			'size' => $size,
1331
			'default' => $default,
1332
			'force_default' => $force_display,
1333
		) );
1334
	}
1335
1336
	/**
1337
	 * jetpack_updates is saved in the following schema:
1338
	 *
1339
	 * array (
1340
	 *      'plugins'                       => (int) Number of plugin updates available.
1341
	 *      'themes'                        => (int) Number of theme updates available.
1342
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1343
	 *      'translations'                  => (int) Number of translation updates available.
1344
	 *      'total'                         => (int) Total of all available updates.
1345
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1346
	 * )
1347
	 * @return array
1348
	 */
1349
	public static function get_updates() {
1350
		$update_data = wp_get_update_data();
1351
1352
		// Stores the individual update counts as well as the total count.
1353
		if ( isset( $update_data['counts'] ) ) {
1354
			$updates = $update_data['counts'];
1355
		}
1356
1357
		// If we need to update WordPress core, let's find the latest version number.
1358 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1359
			$cur = get_preferred_from_update_core();
1360
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1361
				$updates['wp_update_version'] = $cur->current;
1362
			}
1363
		}
1364
		return isset( $updates ) ? $updates : array();
1365
	}
1366
1367
	public static function get_update_details() {
1368
		$update_details = array(
1369
			'update_core' => get_site_transient( 'update_core' ),
1370
			'update_plugins' => get_site_transient( 'update_plugins' ),
1371
			'update_themes' => get_site_transient( 'update_themes' ),
1372
		);
1373
		return $update_details;
1374
	}
1375
1376
	public static function refresh_update_data() {
1377
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1378
1379
	}
1380
1381
	public static function refresh_theme_data() {
1382
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1383
	}
1384
1385
	/**
1386
	 * Is Jetpack active?
1387
	 */
1388
	public static function is_active() {
1389
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1390
	}
1391
1392
	/**
1393
	 * Make an API call to WordPress.com for plan status
1394
	 *
1395
	 * @uses Jetpack_Options::get_option()
1396
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1397
	 * @uses update_option()
1398
	 *
1399
	 * @access public
1400
	 * @static
1401
	 *
1402
	 * @return bool True if plan is updated, false if no update
1403
	 */
1404
	public static function refresh_active_plan_from_wpcom() {
1405
		// Make the API request
1406
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1407
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1408
1409
		// Bail if there was an error or malformed response
1410
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1411
			return false;
1412
		}
1413
1414
		// Decode the results
1415
		$results = json_decode( $response['body'], true );
1416
1417
		// Bail if there were no results or plan details returned
1418
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1419
			return false;
1420
		}
1421
1422
		// Store the option and return true if updated
1423
		return update_option( 'jetpack_active_plan', $results['plan'] );
1424
	}
1425
1426
	/**
1427
	 * Get the plan that this Jetpack site is currently using
1428
	 *
1429
	 * @uses get_option()
1430
	 *
1431
	 * @access public
1432
	 * @static
1433
	 *
1434
	 * @return array Active Jetpack plan details
1435
	 */
1436
	public static function get_active_plan() {
1437
		$plan = get_option( 'jetpack_active_plan', array() );
1438
1439
		// Set the default options
1440
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1441
			$plan = wp_parse_args( $plan, array(
1442
				'product_slug' => 'jetpack_free',
1443
				'supports'     => array(),
1444
				'class'        => 'free',
1445
			) );
1446
		}
1447
1448
		// Define what paid modules are supported by personal plans
1449
		$personal_plans = array(
1450
			'jetpack_personal',
1451
			'jetpack_personal_monthly',
1452
			'personal-bundle',
1453
		);
1454
1455
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1456
			$plan['supports'] = array(
1457
				'akismet',
1458
			);
1459
			$plan['class'] = 'personal';
1460
		}
1461
1462
		// Define what paid modules are supported by premium plans
1463
		$premium_plans = array(
1464
			'jetpack_premium',
1465
			'jetpack_premium_monthly',
1466
			'value_bundle',
1467
		);
1468
1469
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1470
			$plan['supports'] = array(
1471
				'videopress',
1472
				'akismet',
1473
				'vaultpress',
1474
				'wordads',
1475
			);
1476
			$plan['class'] = 'premium';
1477
		}
1478
1479
		// Define what paid modules are supported by professional plans
1480
		$business_plans = array(
1481
			'jetpack_business',
1482
			'jetpack_business_monthly',
1483
			'business-bundle',
1484
			'vip',
1485
		);
1486
1487
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1488
			$plan['supports'] = array(
1489
				'videopress',
1490
				'akismet',
1491
				'vaultpress',
1492
				'seo-tools',
1493
				'google-analytics',
1494
				'wordads',
1495
				'search',
1496
			);
1497
			$plan['class'] = 'business';
1498
		}
1499
1500
		// Make sure we have an array here in the event database data is stale
1501
		if ( ! isset( $plan['supports'] ) ) {
1502
			$plan['supports'] = array();
1503
		}
1504
1505
		return $plan;
1506
	}
1507
1508
	/**
1509
	 * Determine whether the active plan supports a particular feature
1510
	 *
1511
	 * @uses Jetpack::get_active_plan()
1512
	 *
1513
	 * @access public
1514
	 * @static
1515
	 *
1516
	 * @return bool True if plan supports feature, false if not
1517
	 */
1518
	public static function active_plan_supports( $feature ) {
1519
		$plan = Jetpack::get_active_plan();
1520
1521
		if ( in_array( $feature, $plan['supports'] ) ) {
1522
			return true;
1523
		}
1524
1525
		return false;
1526
	}
1527
1528
	/**
1529
	 * Is Jetpack in development (offline) mode?
1530
	 */
1531
	public static function is_development_mode() {
1532
		$development_mode = false;
1533
1534
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1535
			$development_mode = JETPACK_DEV_DEBUG;
1536
		} elseif ( $site_url = site_url() ) {
1537
			$development_mode = false === strpos( $site_url, '.' );
1538
		}
1539
1540
		/**
1541
		 * Filters Jetpack's development mode.
1542
		 *
1543
		 * @see https://jetpack.com/support/development-mode/
1544
		 *
1545
		 * @since 2.2.1
1546
		 *
1547
		 * @param bool $development_mode Is Jetpack's development mode active.
1548
		 */
1549
		return apply_filters( 'jetpack_development_mode', $development_mode );
1550
	}
1551
1552
	/**
1553
	* Get Jetpack development mode notice text and notice class.
1554
	*
1555
	* Mirrors the checks made in Jetpack::is_development_mode
1556
	*
1557
	*/
1558
	public static function show_development_mode_notice() {
1559
		if ( Jetpack::is_development_mode() ) {
1560
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1561
				$notice = sprintf(
1562
					/* translators: %s is a URL */
1563
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1564
					'https://jetpack.com/support/development-mode/'
1565
				);
1566
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1567
				$notice = sprintf(
1568
					/* translators: %s is a URL */
1569
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1570
					'https://jetpack.com/support/development-mode/'
1571
				);
1572
			} else {
1573
				$notice = sprintf(
1574
					/* translators: %s is a URL */
1575
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1576
					'https://jetpack.com/support/development-mode/'
1577
				);
1578
			}
1579
1580
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1581
		}
1582
1583
		// Throw up a notice if using a development version and as for feedback.
1584
		if ( Jetpack::is_development_version() ) {
1585
			/* translators: %s is a URL */
1586
			$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/' );
1587
1588
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1589
		}
1590
		// Throw up a notice if using staging mode
1591
		if ( Jetpack::is_staging_site() ) {
1592
			/* translators: %s is a URL */
1593
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1594
1595
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1596
		}
1597
	}
1598
1599
	/**
1600
	 * Whether Jetpack's version maps to a public release, or a development version.
1601
	 */
1602
	public static function is_development_version() {
1603
		/**
1604
		 * Allows filtering whether this is a development version of Jetpack.
1605
		 *
1606
		 * This filter is especially useful for tests.
1607
		 *
1608
		 * @since 4.3.0
1609
		 *
1610
		 * @param bool $development_version Is this a develoment version of Jetpack?
1611
		 */
1612
		return (bool) apply_filters(
1613
			'jetpack_development_version',
1614
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1615
		);
1616
	}
1617
1618
	/**
1619
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1620
	 */
1621
	public static function is_user_connected( $user_id = false ) {
1622
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1623
		if ( ! $user_id ) {
1624
			return false;
1625
		}
1626
1627
		return (bool) Jetpack_Data::get_access_token( $user_id );
1628
	}
1629
1630
	/**
1631
	 * Get the wpcom user data of the current|specified connected user.
1632
	 */
1633
	public static function get_connected_user_data( $user_id = null ) {
1634
		if ( ! $user_id ) {
1635
			$user_id = get_current_user_id();
1636
		}
1637
1638
		$transient_key = "jetpack_connected_user_data_$user_id";
1639
1640
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1641
			return $cached_user_data;
1642
		}
1643
1644
		Jetpack::load_xml_rpc_client();
1645
		$xml = new Jetpack_IXR_Client( array(
1646
			'user_id' => $user_id,
1647
		) );
1648
		$xml->query( 'wpcom.getUser' );
1649
		if ( ! $xml->isError() ) {
1650
			$user_data = $xml->getResponse();
1651
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1652
			return $user_data;
1653
		}
1654
1655
		return false;
1656
	}
1657
1658
	/**
1659
	 * Get the wpcom email of the current|specified connected user.
1660
	 */
1661 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1662
		if ( ! $user_id ) {
1663
			$user_id = get_current_user_id();
1664
		}
1665
		Jetpack::load_xml_rpc_client();
1666
		$xml = new Jetpack_IXR_Client( array(
1667
			'user_id' => $user_id,
1668
		) );
1669
		$xml->query( 'wpcom.getUserEmail' );
1670
		if ( ! $xml->isError() ) {
1671
			return $xml->getResponse();
1672
		}
1673
		return false;
1674
	}
1675
1676
	/**
1677
	 * Get the wpcom email of the master user.
1678
	 */
1679
	public static function get_master_user_email() {
1680
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1681
		if ( $master_user_id ) {
1682
			return self::get_connected_user_email( $master_user_id );
1683
		}
1684
		return '';
1685
	}
1686
1687
	function current_user_is_connection_owner() {
1688
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1689
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1690
	}
1691
1692
	/**
1693
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1694
	 */
1695
	function extra_oembed_providers() {
1696
		// Cloudup: https://dev.cloudup.com/#oembed
1697
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1698
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1699
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1700
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1701
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1702
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1703
	}
1704
1705
	/**
1706
	 * Synchronize connected user role changes
1707
	 */
1708
	function user_role_change( $user_id ) {
1709
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1710
		Jetpack_Sync_Users::user_role_change( $user_id );
1711
	}
1712
1713
	/**
1714
	 * Loads the currently active modules.
1715
	 */
1716
	public static function load_modules() {
1717
		if (
1718
			! self::is_active()
1719
			&& ! self::is_development_mode()
1720
			&& (
1721
				! is_multisite()
1722
				|| ! get_site_option( 'jetpack_protect_active' )
1723
			)
1724
		) {
1725
			return;
1726
		}
1727
1728
		$version = Jetpack_Options::get_option( 'version' );
1729 View Code Duplication
		if ( ! $version ) {
1730
			$version = $old_version = JETPACK__VERSION . ':' . time();
1731
			/** This action is documented in class.jetpack.php */
1732
			do_action( 'updating_jetpack_version', $version, false );
1733
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1734
		}
1735
		list( $version ) = explode( ':', $version );
1736
1737
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1738
1739
		$modules_data = array();
1740
1741
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1742
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1743
			$updated_modules = array();
1744
			foreach ( $modules as $module ) {
1745
				$modules_data[ $module ] = Jetpack::get_module( $module );
1746
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1747
					continue;
1748
				}
1749
1750
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1751
					continue;
1752
				}
1753
1754
				$updated_modules[] = $module;
1755
			}
1756
1757
			$modules = array_diff( $modules, $updated_modules );
1758
		}
1759
1760
		$is_development_mode = Jetpack::is_development_mode();
1761
1762
		foreach ( $modules as $index => $module ) {
1763
			// If we're in dev mode, disable modules requiring a connection
1764
			if ( $is_development_mode ) {
1765
				// Prime the pump if we need to
1766
				if ( empty( $modules_data[ $module ] ) ) {
1767
					$modules_data[ $module ] = Jetpack::get_module( $module );
1768
				}
1769
				// If the module requires a connection, but we're in local mode, don't include it.
1770
				if ( $modules_data[ $module ]['requires_connection'] ) {
1771
					continue;
1772
				}
1773
			}
1774
1775
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1776
				continue;
1777
			}
1778
1779
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1780
				unset( $modules[ $index ] );
1781
				self::update_active_modules( array_values( $modules ) );
1782
				continue;
1783
			}
1784
1785
			/**
1786
			 * Fires when a specific module is loaded.
1787
			 * The dynamic part of the hook, $module, is the module slug.
1788
			 *
1789
			 * @since 1.1.0
1790
			 */
1791
			do_action( 'jetpack_module_loaded_' . $module );
1792
		}
1793
1794
		/**
1795
		 * Fires when all the modules are loaded.
1796
		 *
1797
		 * @since 1.1.0
1798
		 */
1799
		do_action( 'jetpack_modules_loaded' );
1800
1801
		// 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.
1802
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1803
	}
1804
1805
	/**
1806
	 * Check if Jetpack's REST API compat file should be included
1807
	 * @action plugins_loaded
1808
	 * @return null
1809
	 */
1810
	public function check_rest_api_compat() {
1811
		/**
1812
		 * Filters the list of REST API compat files to be included.
1813
		 *
1814
		 * @since 2.2.5
1815
		 *
1816
		 * @param array $args Array of REST API compat files to include.
1817
		 */
1818
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1819
1820
		if ( function_exists( 'bbpress' ) )
1821
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1822
1823
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1824
			require_once $_jetpack_rest_api_compat_include;
1825
	}
1826
1827
	/**
1828
	 * Gets all plugins currently active in values, regardless of whether they're
1829
	 * traditionally activated or network activated.
1830
	 *
1831
	 * @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...
1832
	 */
1833
	public static function get_active_plugins() {
1834
		$active_plugins = (array) get_option( 'active_plugins', array() );
1835
1836
		if ( is_multisite() ) {
1837
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1838
			// whereas active_plugins stores them in the values.
1839
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1840
			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...
1841
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1842
			}
1843
		}
1844
1845
		sort( $active_plugins );
1846
1847
		return array_unique( $active_plugins );
1848
	}
1849
1850
	/**
1851
	 * Gets and parses additional plugin data to send with the heartbeat data
1852
	 *
1853
	 * @since 3.8.1
1854
	 *
1855
	 * @return array Array of plugin data
1856
	 */
1857
	public static function get_parsed_plugin_data() {
1858
		if ( ! function_exists( 'get_plugins' ) ) {
1859
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1860
		}
1861
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1862
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1863
		$active_plugins = Jetpack::get_active_plugins();
1864
1865
		$plugins = array();
1866
		foreach ( $all_plugins as $path => $plugin_data ) {
1867
			$plugins[ $path ] = array(
1868
					'is_active' => in_array( $path, $active_plugins ),
1869
					'file'      => $path,
1870
					'name'      => $plugin_data['Name'],
1871
					'version'   => $plugin_data['Version'],
1872
					'author'    => $plugin_data['Author'],
1873
			);
1874
		}
1875
1876
		return $plugins;
1877
	}
1878
1879
	/**
1880
	 * Gets and parses theme data to send with the heartbeat data
1881
	 *
1882
	 * @since 3.8.1
1883
	 *
1884
	 * @return array Array of theme data
1885
	 */
1886
	public static function get_parsed_theme_data() {
1887
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1888
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1889
1890
		$themes = array();
1891
		foreach ( $all_themes as $slug => $theme_data ) {
1892
			$theme_headers = array();
1893
			foreach ( $header_keys as $header_key ) {
1894
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1895
			}
1896
1897
			$themes[ $slug ] = array(
1898
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1899
					'slug' => $slug,
1900
					'theme_root' => $theme_data->get_theme_root_uri(),
1901
					'parent' => $theme_data->parent(),
1902
					'headers' => $theme_headers
1903
			);
1904
		}
1905
1906
		return $themes;
1907
	}
1908
1909
	/**
1910
	 * Checks whether a specific plugin is active.
1911
	 *
1912
	 * We don't want to store these in a static variable, in case
1913
	 * there are switch_to_blog() calls involved.
1914
	 */
1915
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1916
		return in_array( $plugin, self::get_active_plugins() );
1917
	}
1918
1919
	/**
1920
	 * Check if Jetpack's Open Graph tags should be used.
1921
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1922
	 *
1923
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1924
	 * @action plugins_loaded
1925
	 * @return null
1926
	 */
1927
	public function check_open_graph() {
1928
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1929
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1930
		}
1931
1932
		$active_plugins = self::get_active_plugins();
1933
1934
		if ( ! empty( $active_plugins ) ) {
1935
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1936
				if ( in_array( $plugin, $active_plugins ) ) {
1937
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1938
					break;
1939
				}
1940
			}
1941
		}
1942
1943
		/**
1944
		 * Allow the addition of Open Graph Meta Tags to all pages.
1945
		 *
1946
		 * @since 2.0.3
1947
		 *
1948
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1949
		 */
1950
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1951
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1952
		}
1953
	}
1954
1955
	/**
1956
	 * Check if Jetpack's Twitter tags should be used.
1957
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1958
	 *
1959
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1960
	 * @action plugins_loaded
1961
	 * @return null
1962
	 */
1963
	public function check_twitter_tags() {
1964
1965
		$active_plugins = self::get_active_plugins();
1966
1967
		if ( ! empty( $active_plugins ) ) {
1968
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1969
				if ( in_array( $plugin, $active_plugins ) ) {
1970
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1971
					break;
1972
				}
1973
			}
1974
		}
1975
1976
		/**
1977
		 * Allow Twitter Card Meta tags to be disabled.
1978
		 *
1979
		 * @since 2.6.0
1980
		 *
1981
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1982
		 */
1983
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1984
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1985
		}
1986
	}
1987
1988
	/**
1989
	 * Allows plugins to submit security reports.
1990
 	 *
1991
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1992
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1993
	 * @param array   $args         See definitions above
1994
	 */
1995
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1996
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1997
	}
1998
1999
/* Jetpack Options API */
2000
2001
	public static function get_option_names( $type = 'compact' ) {
2002
		return Jetpack_Options::get_option_names( $type );
2003
	}
2004
2005
	/**
2006
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2007
 	 *
2008
	 * @param string $name    Option name
2009
	 * @param mixed  $default (optional)
2010
	 */
2011
	public static function get_option( $name, $default = false ) {
2012
		return Jetpack_Options::get_option( $name, $default );
2013
	}
2014
2015
	/**
2016
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2017
 	 *
2018
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2019
	 * @param string $name  Option name
2020
	 * @param mixed  $value Option value
2021
	 */
2022
	public static function update_option( $name, $value ) {
2023
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2024
		return Jetpack_Options::update_option( $name, $value );
2025
	}
2026
2027
	/**
2028
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2029
 	 *
2030
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2031
	 * @param array $array array( option name => option value, ... )
2032
	 */
2033
	public static function update_options( $array ) {
2034
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2035
		return Jetpack_Options::update_options( $array );
2036
	}
2037
2038
	/**
2039
	 * Deletes the given option.  May be passed multiple option names as an array.
2040
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2041
	 *
2042
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2043
	 * @param string|array $names
2044
	 */
2045
	public static function delete_option( $names ) {
2046
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2047
		return Jetpack_Options::delete_option( $names );
2048
	}
2049
2050
	/**
2051
	 * Enters a user token into the user_tokens option
2052
	 *
2053
	 * @param int $user_id
2054
	 * @param string $token
2055
	 * return bool
2056
	 */
2057
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2058
		// not designed for concurrent updates
2059
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2060
		if ( ! is_array( $user_tokens ) )
2061
			$user_tokens = array();
2062
		$user_tokens[$user_id] = $token;
2063
		if ( $is_master_user ) {
2064
			$master_user = $user_id;
2065
			$options     = compact( 'user_tokens', 'master_user' );
2066
		} else {
2067
			$options = compact( 'user_tokens' );
2068
		}
2069
		return Jetpack_Options::update_options( $options );
2070
	}
2071
2072
	/**
2073
	 * Returns an array of all PHP files in the specified absolute path.
2074
	 * Equivalent to glob( "$absolute_path/*.php" ).
2075
	 *
2076
	 * @param string $absolute_path The absolute path of the directory to search.
2077
	 * @return array Array of absolute paths to the PHP files.
2078
	 */
2079
	public static function glob_php( $absolute_path ) {
2080
		if ( function_exists( 'glob' ) ) {
2081
			return glob( "$absolute_path/*.php" );
2082
		}
2083
2084
		$absolute_path = untrailingslashit( $absolute_path );
2085
		$files = array();
2086
		if ( ! $dir = @opendir( $absolute_path ) ) {
2087
			return $files;
2088
		}
2089
2090
		while ( false !== $file = readdir( $dir ) ) {
2091
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2092
				continue;
2093
			}
2094
2095
			$file = "$absolute_path/$file";
2096
2097
			if ( ! is_file( $file ) ) {
2098
				continue;
2099
			}
2100
2101
			$files[] = $file;
2102
		}
2103
2104
		closedir( $dir );
2105
2106
		return $files;
2107
	}
2108
2109
	public static function activate_new_modules( $redirect = false ) {
2110
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2111
			return;
2112
		}
2113
2114
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2115 View Code Duplication
		if ( ! $jetpack_old_version ) {
2116
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2117
			/** This action is documented in class.jetpack.php */
2118
			do_action( 'updating_jetpack_version', $version, false );
2119
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2120
		}
2121
2122
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2123
2124
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2125
			return;
2126
		}
2127
2128
		$active_modules     = Jetpack::get_active_modules();
2129
		$reactivate_modules = array();
2130
		foreach ( $active_modules as $active_module ) {
2131
			$module = Jetpack::get_module( $active_module );
2132
			if ( ! isset( $module['changed'] ) ) {
2133
				continue;
2134
			}
2135
2136
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2137
				continue;
2138
			}
2139
2140
			$reactivate_modules[] = $active_module;
2141
			Jetpack::deactivate_module( $active_module );
2142
		}
2143
2144
		$new_version = JETPACK__VERSION . ':' . time();
2145
		/** This action is documented in class.jetpack.php */
2146
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2147
		Jetpack_Options::update_options(
2148
			array(
2149
				'version'     => $new_version,
2150
				'old_version' => $jetpack_old_version,
2151
			)
2152
		);
2153
2154
		Jetpack::state( 'message', 'modules_activated' );
2155
		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...
2156
2157
		if ( $redirect ) {
2158
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2159
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2160
				$page = $_GET['page'];
2161
			}
2162
2163
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2164
			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...
2165
		}
2166
	}
2167
2168
	/**
2169
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2170
	 * Make sure to tuck away module "library" files in a sub-directory.
2171
	 */
2172
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2173
		static $modules = null;
2174
2175
		if ( ! isset( $modules ) ) {
2176
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2177
			// Use the cache if we're on the front-end and it's available...
2178
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2179
				$modules = $available_modules_option[ JETPACK__VERSION ];
2180
			} else {
2181
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2182
2183
				$modules = array();
2184
2185
				foreach ( $files as $file ) {
2186
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2187
						continue;
2188
					}
2189
2190
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2191
				}
2192
2193
				Jetpack_Options::update_option( 'available_modules', array(
2194
					JETPACK__VERSION => $modules,
2195
				) );
2196
			}
2197
		}
2198
2199
		/**
2200
		 * Filters the array of modules available to be activated.
2201
		 *
2202
		 * @since 2.4.0
2203
		 *
2204
		 * @param array $modules Array of available modules.
2205
		 * @param string $min_version Minimum version number required to use modules.
2206
		 * @param string $max_version Maximum version number required to use modules.
2207
		 */
2208
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2209
2210
		if ( ! $min_version && ! $max_version ) {
2211
			return array_keys( $mods );
2212
		}
2213
2214
		$r = array();
2215
		foreach ( $mods as $slug => $introduced ) {
2216
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2217
				continue;
2218
			}
2219
2220
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2221
				continue;
2222
			}
2223
2224
			$r[] = $slug;
2225
		}
2226
2227
		return $r;
2228
	}
2229
2230
	/**
2231
	 * Default modules loaded on activation.
2232
	 */
2233
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2234
		$return = array();
2235
2236
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2237
			$module_data = Jetpack::get_module( $module );
2238
2239
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2240
				case 'yes' :
2241
					$return[] = $module;
2242
					break;
2243
				case 'public' :
2244
					if ( Jetpack_Options::get_option( 'public' ) ) {
2245
						$return[] = $module;
2246
					}
2247
					break;
2248
				case 'no' :
2249
				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...
2250
					break;
2251
			}
2252
		}
2253
		/**
2254
		 * Filters the array of default modules.
2255
		 *
2256
		 * @since 2.5.0
2257
		 *
2258
		 * @param array $return Array of default modules.
2259
		 * @param string $min_version Minimum version number required to use modules.
2260
		 * @param string $max_version Maximum version number required to use modules.
2261
		 */
2262
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2263
	}
2264
2265
	/**
2266
	 * Checks activated modules during auto-activation to determine
2267
	 * if any of those modules are being deprecated.  If so, close
2268
	 * them out, and add any replacement modules.
2269
	 *
2270
	 * Runs at priority 99 by default.
2271
	 *
2272
	 * This is run late, so that it can still activate a module if
2273
	 * the new module is a replacement for another that the user
2274
	 * currently has active, even if something at the normal priority
2275
	 * would kibosh everything.
2276
	 *
2277
	 * @since 2.6
2278
	 * @uses jetpack_get_default_modules filter
2279
	 * @param array $modules
2280
	 * @return array
2281
	 */
2282
	function handle_deprecated_modules( $modules ) {
2283
		$deprecated_modules = array(
2284
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2285
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2286
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2287
		);
2288
2289
		// Don't activate SSO if they never completed activating WPCC.
2290
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2291
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2292
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2293
				$deprecated_modules['wpcc'] = null;
2294
			}
2295
		}
2296
2297
		foreach ( $deprecated_modules as $module => $replacement ) {
2298
			if ( Jetpack::is_module_active( $module ) ) {
2299
				self::deactivate_module( $module );
2300
				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...
2301
					$modules[] = $replacement;
2302
				}
2303
			}
2304
		}
2305
2306
		return array_unique( $modules );
2307
	}
2308
2309
	/**
2310
	 * Checks activated plugins during auto-activation to determine
2311
	 * if any of those plugins are in the list with a corresponding module
2312
	 * that is not compatible with the plugin. The module will not be allowed
2313
	 * to auto-activate.
2314
	 *
2315
	 * @since 2.6
2316
	 * @uses jetpack_get_default_modules filter
2317
	 * @param array $modules
2318
	 * @return array
2319
	 */
2320
	function filter_default_modules( $modules ) {
2321
2322
		$active_plugins = self::get_active_plugins();
2323
2324
		if ( ! empty( $active_plugins ) ) {
2325
2326
			// For each module we'd like to auto-activate...
2327
			foreach ( $modules as $key => $module ) {
2328
				// If there are potential conflicts for it...
2329
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2330
					// For each potential conflict...
2331
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2332
						// If that conflicting plugin is active...
2333
						if ( in_array( $plugin, $active_plugins ) ) {
2334
							// Remove that item from being auto-activated.
2335
							unset( $modules[ $key ] );
2336
						}
2337
					}
2338
				}
2339
			}
2340
		}
2341
2342
		return $modules;
2343
	}
2344
2345
	/**
2346
	 * Extract a module's slug from its full path.
2347
	 */
2348
	public static function get_module_slug( $file ) {
2349
		return str_replace( '.php', '', basename( $file ) );
2350
	}
2351
2352
	/**
2353
	 * Generate a module's path from its slug.
2354
	 */
2355
	public static function get_module_path( $slug ) {
2356
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2357
	}
2358
2359
	/**
2360
	 * Load module data from module file. Headers differ from WordPress
2361
	 * plugin headers to avoid them being identified as standalone
2362
	 * plugins on the WordPress plugins page.
2363
	 */
2364
	public static function get_module( $module ) {
2365
		$headers = array(
2366
			'name'                      => 'Module Name',
2367
			'description'               => 'Module Description',
2368
			'jumpstart_desc'            => 'Jumpstart Description',
2369
			'sort'                      => 'Sort Order',
2370
			'recommendation_order'      => 'Recommendation Order',
2371
			'introduced'                => 'First Introduced',
2372
			'changed'                   => 'Major Changes In',
2373
			'deactivate'                => 'Deactivate',
2374
			'free'                      => 'Free',
2375
			'requires_connection'       => 'Requires Connection',
2376
			'auto_activate'             => 'Auto Activate',
2377
			'module_tags'               => 'Module Tags',
2378
			'feature'                   => 'Feature',
2379
			'additional_search_queries' => 'Additional Search Queries',
2380
		);
2381
2382
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2383
2384
		$mod = Jetpack::get_file_data( $file, $headers );
2385
		if ( empty( $mod['name'] ) ) {
2386
			return false;
2387
		}
2388
2389
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2390
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2391
		$mod['deactivate']              = empty( $mod['deactivate'] );
2392
		$mod['free']                    = empty( $mod['free'] );
2393
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2394
2395
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2396
			$mod['auto_activate'] = 'No';
2397
		} else {
2398
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2399
		}
2400
2401
		if ( $mod['module_tags'] ) {
2402
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2403
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2404
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2405
		} else {
2406
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2407
		}
2408
2409
		if ( $mod['feature'] ) {
2410
			$mod['feature'] = explode( ',', $mod['feature'] );
2411
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2412
		} else {
2413
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2414
		}
2415
2416
		/**
2417
		 * Filters the feature array on a module.
2418
		 *
2419
		 * This filter allows you to control where each module is filtered: Recommended,
2420
		 * Jumpstart, and the default "Other" listing.
2421
		 *
2422
		 * @since 3.5.0
2423
		 *
2424
		 * @param array   $mod['feature'] The areas to feature this module:
2425
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2426
		 *     'Recommended' shows on the main Jetpack admin screen.
2427
		 *     'Other' should be the default if no other value is in the array.
2428
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2429
		 * @param array   $mod All the currently assembled module data.
2430
		 */
2431
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2432
2433
		/**
2434
		 * Filter the returned data about a module.
2435
		 *
2436
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2437
		 * so please be careful.
2438
		 *
2439
		 * @since 3.6.0
2440
		 *
2441
		 * @param array   $mod    The details of the requested module.
2442
		 * @param string  $module The slug of the module, e.g. sharedaddy
2443
		 * @param string  $file   The path to the module source file.
2444
		 */
2445
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2446
	}
2447
2448
	/**
2449
	 * Like core's get_file_data implementation, but caches the result.
2450
	 */
2451
	public static function get_file_data( $file, $headers ) {
2452
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2453
		$file_name = basename( $file );
2454
2455
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2456
2457
		$file_data_option = get_transient( $cache_key );
2458
2459
		if ( false === $file_data_option ) {
2460
			$file_data_option = array();
2461
		}
2462
2463
		$key           = md5( $file_name . serialize( $headers ) );
2464
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2465
2466
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2467
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2468
			return $file_data_option[ $key ];
2469
		}
2470
2471
		$data = get_file_data( $file, $headers );
2472
2473
		$file_data_option[ $key ] = $data;
2474
2475
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2476
2477
		return $data;
2478
	}
2479
2480
2481
	/**
2482
	 * Return translated module tag.
2483
	 *
2484
	 * @param string $tag Tag as it appears in each module heading.
2485
	 *
2486
	 * @return mixed
2487
	 */
2488
	public static function translate_module_tag( $tag ) {
2489
		return jetpack_get_module_i18n_tag( $tag );
2490
	}
2491
2492
	/**
2493
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2494
	 *
2495
	 * @since 3.9.2
2496
	 *
2497
	 * @param array $modules
2498
	 *
2499
	 * @return string|void
2500
	 */
2501
	public static function get_translated_modules( $modules ) {
2502
		foreach ( $modules as $index => $module ) {
2503
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2504
			if ( isset( $module['name'] ) ) {
2505
				$modules[ $index ]['name'] = $i18n_module['name'];
2506
			}
2507
			if ( isset( $module['description'] ) ) {
2508
				$modules[ $index ]['description'] = $i18n_module['description'];
2509
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2510
			}
2511
		}
2512
		return $modules;
2513
	}
2514
2515
	/**
2516
	 * Get a list of activated modules as an array of module slugs.
2517
	 */
2518
	public static function get_active_modules() {
2519
		$active = Jetpack_Options::get_option( 'active_modules' );
2520
2521
		if ( ! is_array( $active ) ) {
2522
			$active = array();
2523
		}
2524
2525
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2526
			$active[] = 'vaultpress';
2527
		} else {
2528
			$active = array_diff( $active, array( 'vaultpress' ) );
2529
		}
2530
2531
		//If protect is active on the main site of a multisite, it should be active on all sites.
2532
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2533
			$active[] = 'protect';
2534
		}
2535
2536
		return array_unique( $active );
2537
	}
2538
2539
	/**
2540
	 * Check whether or not a Jetpack module is active.
2541
	 *
2542
	 * @param string $module The slug of a Jetpack module.
2543
	 * @return bool
2544
	 *
2545
	 * @static
2546
	 */
2547
	public static function is_module_active( $module ) {
2548
		return in_array( $module, self::get_active_modules() );
2549
	}
2550
2551
	public static function is_module( $module ) {
2552
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2553
	}
2554
2555
	/**
2556
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2557
	 *
2558
	 * @param bool $catch True to start catching, False to stop.
2559
	 *
2560
	 * @static
2561
	 */
2562
	public static function catch_errors( $catch ) {
2563
		static $display_errors, $error_reporting;
2564
2565
		if ( $catch ) {
2566
			$display_errors  = @ini_set( 'display_errors', 1 );
2567
			$error_reporting = @error_reporting( E_ALL );
2568
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2569
		} else {
2570
			@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...
2571
			@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...
2572
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2573
		}
2574
	}
2575
2576
	/**
2577
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2578
	 */
2579
	public static function catch_errors_on_shutdown() {
2580
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2581
	}
2582
2583
	/**
2584
	 * Rewrite any string to make paths easier to read.
2585
	 *
2586
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2587
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2588
	 *
2589
	 * @param $string
2590
	 * @return mixed
2591
	 */
2592
	public static function alias_directories( $string ) {
2593
		// ABSPATH has a trailing slash.
2594
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2595
		// WP_CONTENT_DIR does not have a trailing slash.
2596
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2597
2598
		return $string;
2599
	}
2600
2601
	public static function activate_default_modules(
2602
		$min_version = false,
2603
		$max_version = false,
2604
		$other_modules = array(),
2605
		$redirect = true,
2606
		$send_state_messages = true
2607
	) {
2608
		$jetpack = Jetpack::init();
2609
2610
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2611
		$modules = array_merge( $other_modules, $modules );
2612
2613
		// Look for standalone plugins and disable if active.
2614
2615
		$to_deactivate = array();
2616
		foreach ( $modules as $module ) {
2617
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2618
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2619
			}
2620
		}
2621
2622
		$deactivated = array();
2623
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2624
			list( $probable_file, $probable_title ) = $deactivate_me;
2625
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2626
				$deactivated[] = $module;
2627
			}
2628
		}
2629
2630
		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...
2631
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2632
2633
			$url = add_query_arg(
2634
				array(
2635
					'action'   => 'activate_default_modules',
2636
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2637
				),
2638
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2639
			);
2640
			wp_safe_redirect( $url );
2641
			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...
2642
		}
2643
2644
		/**
2645
		 * Fires before default modules are activated.
2646
		 *
2647
		 * @since 1.9.0
2648
		 *
2649
		 * @param string $min_version Minimum version number required to use modules.
2650
		 * @param string $max_version Maximum version number required to use modules.
2651
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2652
		 */
2653
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2654
2655
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2656
		Jetpack::restate();
2657
		Jetpack::catch_errors( true );
2658
2659
		$active = Jetpack::get_active_modules();
2660
2661
		foreach ( $modules as $module ) {
2662
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2663
				$active[] = $module;
2664
				self::update_active_modules( $active );
2665
				continue;
2666
			}
2667
2668
			if ( $send_state_messages && in_array( $module, $active ) ) {
2669
				$module_info = Jetpack::get_module( $module );
2670 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2671
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2672
					if ( $active_state = Jetpack::state( $state ) ) {
2673
						$active_state = explode( ',', $active_state );
2674
					} else {
2675
						$active_state = array();
2676
					}
2677
					$active_state[] = $module;
2678
					Jetpack::state( $state, implode( ',', $active_state ) );
2679
				}
2680
				continue;
2681
			}
2682
2683
			$file = Jetpack::get_module_path( $module );
2684
			if ( ! file_exists( $file ) ) {
2685
				continue;
2686
			}
2687
2688
			// we'll override this later if the plugin can be included without fatal error
2689
			if ( $redirect ) {
2690
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2691
			}
2692
2693
			if ( $send_state_messages ) {
2694
				Jetpack::state( 'error', 'module_activation_failed' );
2695
				Jetpack::state( 'module', $module );
2696
			}
2697
2698
			ob_start();
2699
			require $file;
2700
2701
			$active[] = $module;
2702
2703 View Code Duplication
			if ( $send_state_messages ) {
2704
2705
				$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...
2706
				if ( $active_state = Jetpack::state( $state ) ) {
2707
					$active_state = explode( ',', $active_state );
2708
				} else {
2709
					$active_state = array();
2710
				}
2711
				$active_state[] = $module;
2712
				Jetpack::state( $state, implode( ',', $active_state ) );
2713
			}
2714
2715
			Jetpack::update_active_modules( $active );
2716
2717
			ob_end_clean();
2718
		}
2719
2720
		if ( $send_state_messages ) {
2721
			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...
2722
			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...
2723
		}
2724
2725
		Jetpack::catch_errors( false );
2726
		/**
2727
		 * Fires when default modules are activated.
2728
		 *
2729
		 * @since 1.9.0
2730
		 *
2731
		 * @param string $min_version Minimum version number required to use modules.
2732
		 * @param string $max_version Maximum version number required to use modules.
2733
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2734
		 */
2735
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2736
	}
2737
2738
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2739
		/**
2740
		 * Fires before a module is activated.
2741
		 *
2742
		 * @since 2.6.0
2743
		 *
2744
		 * @param string $module Module slug.
2745
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2746
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2747
		 */
2748
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2749
2750
		$jetpack = Jetpack::init();
2751
2752
		if ( ! strlen( $module ) )
2753
			return false;
2754
2755
		if ( ! Jetpack::is_module( $module ) )
2756
			return false;
2757
2758
		// If it's already active, then don't do it again
2759
		$active = Jetpack::get_active_modules();
2760
		foreach ( $active as $act ) {
2761
			if ( $act == $module )
2762
				return true;
2763
		}
2764
2765
		$module_data = Jetpack::get_module( $module );
2766
2767
		if ( ! Jetpack::is_active() ) {
2768
			if ( !Jetpack::is_development_mode() )
2769
				return false;
2770
2771
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2772
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2773
				return false;
2774
		}
2775
2776
		// Check and see if the old plugin is active
2777
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2778
			// Deactivate the old plugin
2779
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2780
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2781
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2782
				Jetpack::state( 'deactivated_plugins', $module );
2783
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2784
				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...
2785
			}
2786
		}
2787
2788
		// Protect won't work with mis-configured IPs
2789
		if ( 'protect' === $module ) {
2790
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2791
			if ( ! jetpack_protect_get_ip() ) {
2792
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2793
				return false;
2794
			}
2795
		}
2796
2797
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2798
		Jetpack::state( 'module', $module );
2799
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2800
2801
		Jetpack::catch_errors( true );
2802
		ob_start();
2803
		require Jetpack::get_module_path( $module );
2804
		/** This action is documented in class.jetpack.php */
2805
		do_action( 'jetpack_activate_module', $module );
2806
		$active[] = $module;
2807
		Jetpack::update_active_modules( $active );
2808
2809
		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...
2810
		ob_end_clean();
2811
		Jetpack::catch_errors( false );
2812
2813
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2814 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2815
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2816
2817
			//Jump start is being dismissed send data to MC Stats
2818
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2819
2820
			$jetpack->do_stats( 'server_side' );
2821
		}
2822
2823
		if ( $redirect ) {
2824
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2825
		}
2826
		if ( $exit ) {
2827
			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...
2828
		}
2829
		return true;
2830
	}
2831
2832
	function activate_module_actions( $module ) {
2833
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2834
	}
2835
2836
	public static function deactivate_module( $module ) {
2837
		/**
2838
		 * Fires when a module is deactivated.
2839
		 *
2840
		 * @since 1.9.0
2841
		 *
2842
		 * @param string $module Module slug.
2843
		 */
2844
		do_action( 'jetpack_pre_deactivate_module', $module );
2845
2846
		$jetpack = Jetpack::init();
2847
2848
		$active = Jetpack::get_active_modules();
2849
		$new    = array_filter( array_diff( $active, (array) $module ) );
2850
2851
		// A flag for Jump Start so it's not shown again.
2852 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2853
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2854
2855
			//Jump start is being dismissed send data to MC Stats
2856
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2857
2858
			$jetpack->do_stats( 'server_side' );
2859
		}
2860
2861
		return self::update_active_modules( $new );
2862
	}
2863
2864
	public static function enable_module_configurable( $module ) {
2865
		$module = Jetpack::get_module_slug( $module );
2866
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2867
	}
2868
2869
	public static function module_configuration_url( $module ) {
2870
		$module = Jetpack::get_module_slug( $module );
2871
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2872
	}
2873
2874
	public static function module_configuration_load( $module, $method ) {
2875
		$module = Jetpack::get_module_slug( $module );
2876
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2877
	}
2878
2879
	public static function module_configuration_head( $module, $method ) {
2880
		$module = Jetpack::get_module_slug( $module );
2881
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2882
	}
2883
2884
	public static function module_configuration_screen( $module, $method ) {
2885
		$module = Jetpack::get_module_slug( $module );
2886
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2887
	}
2888
2889
	public static function module_configuration_activation_screen( $module, $method ) {
2890
		$module = Jetpack::get_module_slug( $module );
2891
		add_action( 'display_activate_module_setting_' . $module, $method );
2892
	}
2893
2894
/* Installation */
2895
2896
	public static function bail_on_activation( $message, $deactivate = true ) {
2897
?>
2898
<!doctype html>
2899
<html>
2900
<head>
2901
<meta charset="<?php bloginfo( 'charset' ); ?>">
2902
<style>
2903
* {
2904
	text-align: center;
2905
	margin: 0;
2906
	padding: 0;
2907
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2908
}
2909
p {
2910
	margin-top: 1em;
2911
	font-size: 18px;
2912
}
2913
</style>
2914
<body>
2915
<p><?php echo esc_html( $message ); ?></p>
2916
</body>
2917
</html>
2918
<?php
2919
		if ( $deactivate ) {
2920
			$plugins = get_option( 'active_plugins' );
2921
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2922
			$update  = false;
2923
			foreach ( $plugins as $i => $plugin ) {
2924
				if ( $plugin === $jetpack ) {
2925
					$plugins[$i] = false;
2926
					$update = true;
2927
				}
2928
			}
2929
2930
			if ( $update ) {
2931
				update_option( 'active_plugins', array_filter( $plugins ) );
2932
			}
2933
		}
2934
		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...
2935
	}
2936
2937
	/**
2938
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2939
	 * @static
2940
	 */
2941
	public static function plugin_activation( $network_wide ) {
2942
		Jetpack_Options::update_option( 'activated', 1 );
2943
2944
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2945
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2946
		}
2947
2948
		if ( $network_wide )
2949
			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...
2950
2951
		// For firing one-off events (notices) immediately after activation
2952
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2953
2954
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2955
2956
		Jetpack::plugin_initialize();
2957
	}
2958
2959
	public static function get_activation_source( $referer_url ) {
2960
2961
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2962
			return array( 'wp-cli', null );
2963
		}
2964
2965
		$referer = parse_url( $referer_url );
2966
2967
		$source_type = 'unknown';
2968
		$source_query = null;
2969
2970
		if ( ! is_array( $referer ) ) {
2971
			return array( $source_type, $source_query );
2972
		}
2973
2974
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
2975
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
2976
2977
		if ( isset( $referer['query'] ) ) {
2978
			parse_str( $referer['query'], $query_parts );
2979
		} else {
2980
			$query_parts = array();
2981
		}
2982
2983
		if ( $plugins_path === $referer['path'] ) {
2984
			$source_type = 'list';
2985
		} elseif ( $plugins_install_path === $referer['path'] ) {
2986
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
2987
			switch( $tab ) {
2988
				case 'popular':
2989
					$source_type = 'popular';
2990
					break;
2991
				case 'recommended':
2992
					$source_type = 'recommended';
2993
					break;
2994
				case 'favorites':
2995
					$source_type = 'favorites';
2996
					break;
2997
				case 'search':
2998
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
2999
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3000
					break;
3001
				default:
3002
					$source_type = 'featured';
3003
			}
3004
		}
3005
3006
		return array( $source_type, $source_query );
3007
	}
3008
3009
	/**
3010
	 * Runs before bumping version numbers up to a new version
3011
	 * @param  string $version    Version:timestamp
3012
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3013
	 * @return null              [description]
3014
	 */
3015
	public static function do_version_bump( $version, $old_version ) {
3016
3017
		if ( ! $old_version ) { // For new sites
3018
			// Setting up jetpack manage
3019
			Jetpack::activate_manage();
3020
		}
3021
	}
3022
3023
	/**
3024
	 * Sets the internal version number and activation state.
3025
	 * @static
3026
	 */
3027
	public static function plugin_initialize() {
3028
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3029
			Jetpack_Options::update_option( 'activated', 2 );
3030
		}
3031
3032 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3033
			$version = $old_version = JETPACK__VERSION . ':' . time();
3034
			/** This action is documented in class.jetpack.php */
3035
			do_action( 'updating_jetpack_version', $version, false );
3036
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3037
		}
3038
3039
		Jetpack::load_modules();
3040
3041
		Jetpack_Options::delete_option( 'do_activate' );
3042
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3043
	}
3044
3045
	/**
3046
	 * Removes all connection options
3047
	 * @static
3048
	 */
3049
	public static function plugin_deactivation( ) {
3050
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3051
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3052
			Jetpack_Network::init()->deactivate();
3053
		} else {
3054
			Jetpack::disconnect( false );
3055
			//Jetpack_Heartbeat::init()->deactivate();
3056
		}
3057
	}
3058
3059
	/**
3060
	 * Disconnects from the Jetpack servers.
3061
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3062
	 * @static
3063
	 */
3064
	public static function disconnect( $update_activated_state = true ) {
3065
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3066
		Jetpack::clean_nonces( true );
3067
3068
		// If the site is in an IDC because sync is not allowed,
3069
		// let's make sure to not disconnect the production site.
3070
		if ( ! self::validate_sync_error_idc_option() ) {
3071
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3072
			Jetpack::load_xml_rpc_client();
3073
			$xml = new Jetpack_IXR_Client();
3074
			$xml->query( 'jetpack.deregister' );
3075
		}
3076
3077
		Jetpack_Options::delete_option(
3078
			array(
3079
				'blog_token',
3080
				'user_token',
3081
				'user_tokens',
3082
				'master_user',
3083
				'time_diff',
3084
				'fallback_no_verify_ssl_certs',
3085
			)
3086
		);
3087
3088
		Jetpack_IDC::clear_all_idc_options();
3089
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3090
3091
		if ( $update_activated_state ) {
3092
			Jetpack_Options::update_option( 'activated', 4 );
3093
		}
3094
3095
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3096
			// Check then record unique disconnection if site has never been disconnected previously
3097
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3098
				$jetpack_unique_connection['disconnected'] = 1;
3099
			} else {
3100
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3101
					//track unique disconnect
3102
					$jetpack = Jetpack::init();
3103
3104
					$jetpack->stat( 'connections', 'unique-disconnect' );
3105
					$jetpack->do_stats( 'server_side' );
3106
				}
3107
				// increment number of times disconnected
3108
				$jetpack_unique_connection['disconnected'] += 1;
3109
			}
3110
3111
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3112
		}
3113
3114
		// Delete cached connected user data
3115
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3116
		delete_transient( $transient_key );
3117
3118
		// Delete all the sync related data. Since it could be taking up space.
3119
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3120
		Jetpack_Sync_Sender::get_instance()->uninstall();
3121
3122
		// Disable the Heartbeat cron
3123
		Jetpack_Heartbeat::init()->deactivate();
3124
	}
3125
3126
	/**
3127
	 * Unlinks the current user from the linked WordPress.com user
3128
	 */
3129
	public static function unlink_user( $user_id = null ) {
3130
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3131
			return false;
3132
3133
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3134
3135
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3136
			return false;
3137
3138
		if ( ! isset( $tokens[ $user_id ] ) )
3139
			return false;
3140
3141
		Jetpack::load_xml_rpc_client();
3142
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3143
		$xml->query( 'jetpack.unlink_user', $user_id );
3144
3145
		unset( $tokens[ $user_id ] );
3146
3147
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3148
3149
		/**
3150
		 * Fires after the current user has been unlinked from WordPress.com.
3151
		 *
3152
		 * @since 4.1.0
3153
		 *
3154
		 * @param int $user_id The current user's ID.
3155
		 */
3156
		do_action( 'jetpack_unlinked_user', $user_id );
3157
3158
		return true;
3159
	}
3160
3161
	/**
3162
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3163
	 */
3164
	public static function try_registration() {
3165
		// Let's get some testing in beta versions and such.
3166
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3167
			// Before attempting to connect, let's make sure that the domains are viable.
3168
			$domains_to_check = array_unique( array(
3169
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3170
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3171
			) );
3172
			foreach ( $domains_to_check as $domain ) {
3173
				$result = Jetpack_Data::is_usable_domain( $domain );
3174
				if ( is_wp_error( $result ) ) {
3175
					return $result;
3176
				}
3177
			}
3178
		}
3179
3180
		$result = Jetpack::register();
3181
3182
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3183
		if ( ! $result || is_wp_error( $result ) ) {
3184
			return $result;
3185
		} else {
3186
			return true;
3187
		}
3188
	}
3189
3190
	/**
3191
	 * Tracking an internal event log. Try not to put too much chaff in here.
3192
	 *
3193
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3194
	 */
3195
	public static function log( $code, $data = null ) {
3196
		// only grab the latest 200 entries
3197
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3198
3199
		// Append our event to the log
3200
		$log_entry = array(
3201
			'time'    => time(),
3202
			'user_id' => get_current_user_id(),
3203
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3204
			'code'    => $code,
3205
		);
3206
		// Don't bother storing it unless we've got some.
3207
		if ( ! is_null( $data ) ) {
3208
			$log_entry['data'] = $data;
3209
		}
3210
		$log[] = $log_entry;
3211
3212
		// Try add_option first, to make sure it's not autoloaded.
3213
		// @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...
3214
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3215
			Jetpack_Options::update_option( 'log', $log );
3216
		}
3217
3218
		/**
3219
		 * Fires when Jetpack logs an internal event.
3220
		 *
3221
		 * @since 3.0.0
3222
		 *
3223
		 * @param array $log_entry {
3224
		 *	Array of details about the log entry.
3225
		 *
3226
		 *	@param string time Time of the event.
3227
		 *	@param int user_id ID of the user who trigerred the event.
3228
		 *	@param int blog_id Jetpack Blog ID.
3229
		 *	@param string code Unique name for the event.
3230
		 *	@param string data Data about the event.
3231
		 * }
3232
		 */
3233
		do_action( 'jetpack_log_entry', $log_entry );
3234
	}
3235
3236
	/**
3237
	 * Get the internal event log.
3238
	 *
3239
	 * @param $event (string) - only return the specific log events
3240
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3241
	 *
3242
	 * @return array of log events || WP_Error for invalid params
3243
	 */
3244
	public static function get_log( $event = false, $num = false ) {
3245
		if ( $event && ! is_string( $event ) ) {
3246
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3247
		}
3248
3249
		if ( $num && ! is_numeric( $num ) ) {
3250
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3251
		}
3252
3253
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3254
3255
		// If nothing set - act as it did before, otherwise let's start customizing the output
3256
		if ( ! $num && ! $event ) {
3257
			return $entire_log;
3258
		} else {
3259
			$entire_log = array_reverse( $entire_log );
3260
		}
3261
3262
		$custom_log_output = array();
3263
3264
		if ( $event ) {
3265
			foreach ( $entire_log as $log_event ) {
3266
				if ( $event == $log_event[ 'code' ] ) {
3267
					$custom_log_output[] = $log_event;
3268
				}
3269
			}
3270
		} else {
3271
			$custom_log_output = $entire_log;
3272
		}
3273
3274
		if ( $num ) {
3275
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3276
		}
3277
3278
		return $custom_log_output;
3279
	}
3280
3281
	/**
3282
	 * Log modification of important settings.
3283
	 */
3284
	public static function log_settings_change( $option, $old_value, $value ) {
3285
		switch( $option ) {
3286
			case 'jetpack_sync_non_public_post_stati':
3287
				self::log( $option, $value );
3288
				break;
3289
		}
3290
	}
3291
3292
	/**
3293
	 * Return stat data for WPCOM sync
3294
	 */
3295
	public static function get_stat_data( $encode = true, $extended = true ) {
3296
		$data = Jetpack_Heartbeat::generate_stats_array();
3297
3298
		if ( $extended ) {
3299
			$additional_data = self::get_additional_stat_data();
3300
			$data = array_merge( $data, $additional_data );
3301
		}
3302
3303
		if ( $encode ) {
3304
			return json_encode( $data );
3305
		}
3306
3307
		return $data;
3308
	}
3309
3310
	/**
3311
	 * Get additional stat data to sync to WPCOM
3312
	 */
3313
	public static function get_additional_stat_data( $prefix = '' ) {
3314
		$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...
3315
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3316
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3317
		$return["{$prefix}site-count"]     = 0;
3318
3319
		if ( function_exists( 'get_blog_count' ) ) {
3320
			$return["{$prefix}site-count"] = get_blog_count();
3321
		}
3322
		return $return;
3323
	}
3324
3325
	private static function get_site_user_count() {
3326
		global $wpdb;
3327
3328
		if ( function_exists( 'wp_is_large_network' ) ) {
3329
			if ( wp_is_large_network( 'users' ) ) {
3330
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3331
			}
3332
		}
3333 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3334
			// It wasn't there, so regenerate the data and save the transient
3335
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3336
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3337
		}
3338
		return $user_count;
3339
	}
3340
3341
	/* Admin Pages */
3342
3343
	function admin_init() {
3344
		// If the plugin is not connected, display a connect message.
3345
		if (
3346
			// the plugin was auto-activated and needs its candy
3347
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3348
		||
3349
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3350
			! Jetpack_Options::get_option( 'activated' )
3351
		) {
3352
			Jetpack::plugin_initialize();
3353
		}
3354
3355
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3356
			Jetpack_Connection_Banner::init();
3357
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3358
			// Upgrade: 1.1 -> 1.1.1
3359
			// Check and see if host can verify the Jetpack servers' SSL certificate
3360
			$args = array();
3361
			Jetpack_Client::_wp_remote_request(
3362
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3363
				$args,
3364
				true
3365
			);
3366
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3367
			// Show the notice on the Dashboard only for now
3368
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3369
		}
3370
3371
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3372
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3373
		}
3374
3375
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3376
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3377
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3378
3379
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3380
			// Artificially throw errors in certain whitelisted cases during plugin activation
3381
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3382
		}
3383
3384
		// Jetpack Manage Activation Screen from .com
3385
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3386
3387
		// Add custom column in wp-admin/users.php to show whether user is linked.
3388
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3389
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3390
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3391
	}
3392
3393
	function admin_body_class( $admin_body_class = '' ) {
3394
		$classes = explode( ' ', trim( $admin_body_class ) );
3395
3396
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3397
3398
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3399
		return " $admin_body_class ";
3400
	}
3401
3402
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3403
		return $admin_body_class . ' jetpack-pagestyles ';
3404
	}
3405
3406
	/**
3407
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3408
	 *
3409
	 * @return null
3410
	 */
3411
	function prepare_manage_jetpack_notice() {
3412
3413
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3414
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3415
	}
3416
3417
	function manage_activate_screen() {
3418
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3419
	}
3420
	/**
3421
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3422
	 * This function artificially throws errors for such cases (whitelisted).
3423
	 *
3424
	 * @param string $plugin The activated plugin.
3425
	 */
3426
	function throw_error_on_activate_plugin( $plugin ) {
3427
		$active_modules = Jetpack::get_active_modules();
3428
3429
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3430
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3431
			$throw = false;
3432
3433
			// Try and make sure it really was the stats plugin
3434
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3435
				if ( 'stats.php' == basename( $plugin ) ) {
3436
					$throw = true;
3437
				}
3438
			} else {
3439
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3440
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3441
					$throw = true;
3442
				}
3443
			}
3444
3445
			if ( $throw ) {
3446
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3447
			}
3448
		}
3449
	}
3450
3451
	function intercept_plugin_error_scrape_init() {
3452
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3453
	}
3454
3455
	function intercept_plugin_error_scrape( $action, $result ) {
3456
		if ( ! $result ) {
3457
			return;
3458
		}
3459
3460
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3461
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3462
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3463
			}
3464
		}
3465
	}
3466
3467
	function add_remote_request_handlers() {
3468
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3469
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3470
	}
3471
3472
	function remote_request_handlers() {
3473
		$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...
3474
3475
		switch ( current_filter() ) {
3476
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3477
			$response = $this->upload_handler();
3478
			break;
3479
3480
		case 'wp_ajax_nopriv_jetpack_update_file' :
3481
			$response = $this->upload_handler( true );
3482
			break;
3483
		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...
3484
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3485
			break;
3486
		}
3487
3488
		if ( ! $response ) {
3489
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3490
		}
3491
3492
		if ( is_wp_error( $response ) ) {
3493
			$status_code       = $response->get_error_data();
3494
			$error             = $response->get_error_code();
3495
			$error_description = $response->get_error_message();
3496
3497
			if ( ! is_int( $status_code ) ) {
3498
				$status_code = 400;
3499
			}
3500
3501
			status_header( $status_code );
3502
			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...
3503
		}
3504
3505
		status_header( 200 );
3506
		if ( true === $response ) {
3507
			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...
3508
		}
3509
3510
		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...
3511
	}
3512
3513
	/**
3514
	 * Uploads a file gotten from the global $_FILES.
3515
	 * If `$update_media_item` is true and `post_id` is defined
3516
	 * the attachment file of the media item (gotten through of the post_id)
3517
	 * will be updated instead of add a new one.
3518
	 *
3519
	 * @param  boolean $update_media_item - update media attachment
3520
	 * @return array - An array describing the uploadind files process
3521
	 */
3522
	function upload_handler( $update_media_item = false ) {
3523
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3524
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3525
		}
3526
3527
		$user = wp_authenticate( '', '' );
3528
		if ( ! $user || is_wp_error( $user ) ) {
3529
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3530
		}
3531
3532
		wp_set_current_user( $user->ID );
3533
3534
		if ( ! current_user_can( 'upload_files' ) ) {
3535
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3536
		}
3537
3538
		if ( empty( $_FILES ) ) {
3539
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3540
		}
3541
3542
		foreach ( array_keys( $_FILES ) as $files_key ) {
3543
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3544
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3545
			}
3546
		}
3547
3548
		$media_keys = array_keys( $_FILES['media'] );
3549
3550
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3551
		if ( ! $token || is_wp_error( $token ) ) {
3552
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3553
		}
3554
3555
		$uploaded_files = array();
3556
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3557
		unset( $GLOBALS['post'] );
3558
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3559
			$file = array();
3560
			foreach ( $media_keys as $media_key ) {
3561
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3562
			}
3563
3564
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3565
3566
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3567
			if ( $hmac_provided !== $hmac_file ) {
3568
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3569
				continue;
3570
			}
3571
3572
			$_FILES['.jetpack.upload.'] = $file;
3573
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3574
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3575
				$post_id = 0;
3576
			}
3577
3578
			if ( $update_media_item ) {
3579
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3580
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3581
				}
3582
3583
				$media_array = $_FILES['media'];
3584
3585
				$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...
3586
				$file_array['type'] = $media_array['type'][0];
3587
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3588
				$file_array['error'] = $media_array['error'][0];
3589
				$file_array['size'] = $media_array['size'][0];
3590
3591
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3592
3593
				if ( is_wp_error( $edited_media_item ) ) {
3594
					return $edited_media_item;
3595
				}
3596
3597
				$response = (object) array(
3598
					'id'   => (string) $post_id,
3599
					'file' => (string) $edited_media_item->post_title,
3600
					'url'  => (string) wp_get_attachment_url( $post_id ),
3601
					'type' => (string) $edited_media_item->post_mime_type,
3602
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3603
				);
3604
3605
				return (array) array( $response );
3606
			}
3607
3608
			$attachment_id = media_handle_upload(
3609
				'.jetpack.upload.',
3610
				$post_id,
3611
				array(),
3612
				array(
3613
					'action' => 'jetpack_upload_file',
3614
				)
3615
			);
3616
3617
			if ( ! $attachment_id ) {
3618
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3619
			} elseif ( is_wp_error( $attachment_id ) ) {
3620
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3621
			} else {
3622
				$attachment = get_post( $attachment_id );
3623
				$uploaded_files[$index] = (object) array(
3624
					'id'   => (string) $attachment_id,
3625
					'file' => $attachment->post_title,
3626
					'url'  => wp_get_attachment_url( $attachment_id ),
3627
					'type' => $attachment->post_mime_type,
3628
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3629
				);
3630
				// Zip files uploads are not supported unless they are done for installation purposed
3631
				// lets delete them in case something goes wrong in this whole process
3632
				if ( 'application/zip' === $attachment->post_mime_type ) {
3633
					// Schedule a cleanup for 2 hours from now in case of failed install.
3634
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3635
				}
3636
			}
3637
		}
3638
		if ( ! is_null( $global_post ) ) {
3639
			$GLOBALS['post'] = $global_post;
3640
		}
3641
3642
		return $uploaded_files;
3643
	}
3644
3645
	/**
3646
	 * Add help to the Jetpack page
3647
	 *
3648
	 * @since Jetpack (1.2.3)
3649
	 * @return false if not the Jetpack page
3650
	 */
3651
	function admin_help() {
3652
		$current_screen = get_current_screen();
3653
3654
		// Overview
3655
		$current_screen->add_help_tab(
3656
			array(
3657
				'id'		=> 'home',
3658
				'title'		=> __( 'Home', 'jetpack' ),
3659
				'content'	=>
3660
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3661
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3662
					'<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>',
3663
			)
3664
		);
3665
3666
		// Screen Content
3667
		if ( current_user_can( 'manage_options' ) ) {
3668
			$current_screen->add_help_tab(
3669
				array(
3670
					'id'		=> 'settings',
3671
					'title'		=> __( 'Settings', 'jetpack' ),
3672
					'content'	=>
3673
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3674
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3675
						'<ol>' .
3676
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3677
							'<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>' .
3678
						'</ol>' .
3679
						'<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>'
3680
				)
3681
			);
3682
		}
3683
3684
		// Help Sidebar
3685
		$current_screen->set_help_sidebar(
3686
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3687
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3688
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3689
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3690
		);
3691
	}
3692
3693
	function admin_menu_css() {
3694
		wp_enqueue_style( 'jetpack-icons' );
3695
	}
3696
3697
	function admin_menu_order() {
3698
		return true;
3699
	}
3700
3701 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3702
		$jp_menu_order = array();
3703
3704
		foreach ( $menu_order as $index => $item ) {
3705
			if ( $item != 'jetpack' ) {
3706
				$jp_menu_order[] = $item;
3707
			}
3708
3709
			if ( $index == 0 ) {
3710
				$jp_menu_order[] = 'jetpack';
3711
			}
3712
		}
3713
3714
		return $jp_menu_order;
3715
	}
3716
3717
	function admin_head() {
3718 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3719
			/** This action is documented in class.jetpack-admin-page.php */
3720
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3721
	}
3722
3723
	function admin_banner_styles() {
3724
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3725
3726 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3727
			wp_register_style(
3728
				'jetpack-dops-style',
3729
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3730
				array(),
3731
				JETPACK__VERSION
3732
			);
3733
		}
3734
3735
		wp_enqueue_style(
3736
			'jetpack',
3737
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3738
			array( 'jetpack-dops-style' ),
3739
			 JETPACK__VERSION . '-20121016'
3740
		);
3741
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3742
		wp_style_add_data( 'jetpack', 'suffix', $min );
3743
	}
3744
3745
	function plugin_action_links( $actions ) {
3746
3747
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3748
3749
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3750
			return array_merge(
3751
				$jetpack_home,
3752
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3753
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3754
				$actions
3755
				);
3756
			}
3757
3758
		return array_merge( $jetpack_home, $actions );
3759
	}
3760
3761
	/**
3762
	 * This is the first banner
3763
	 * It should be visible only to user that can update the option
3764
	 * Are not connected
3765
	 *
3766
	 * @return null
3767
	 */
3768
	function admin_jetpack_manage_notice() {
3769
		$screen = get_current_screen();
3770
3771
		// Don't show the connect notice on the jetpack settings page.
3772
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3773
			return;
3774
		}
3775
3776
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3777
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3778
		/**
3779
		 * I think it would be great to have different wordsing depending on where you are
3780
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3781
		 * etc..
3782
		 */
3783
3784
		?>
3785
		<div id="message" class="updated jp-banner">
3786
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3787
				<div class="jp-banner__description-container">
3788
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3789
					<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>
3790
					<p class="jp-banner__button-container">
3791
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3792
						<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>
3793
					</p>
3794
				</div>
3795
		</div>
3796
		<?php
3797
	}
3798
3799
	/**
3800
	 * Returns the url that the user clicks to remove the notice for the big banner
3801
	 * @return string
3802
	 */
3803
	function opt_out_jetpack_manage_url() {
3804
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3805
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3806
	}
3807
	/**
3808
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3809
	 * @return string
3810
	 */
3811
	function opt_in_jetpack_manage_url() {
3812
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3813
	}
3814
3815
	function opt_in_jetpack_manage_notice() {
3816
		?>
3817
		<div class="wrap">
3818
			<div id="message" class="jetpack-message is-opt-in">
3819
				<?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' ); ?>
3820
			</div>
3821
		</div>
3822
		<?php
3823
3824
	}
3825
	/**
3826
	 * Determines whether to show the notice of not true = display notice
3827
	 * @return bool
3828
	 */
3829
	function can_display_jetpack_manage_notice() {
3830
		// never display the notice to users that can't do anything about it anyways
3831
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3832
			return false;
3833
3834
		// don't display if we are in development more
3835
		if( Jetpack::is_development_mode() ) {
3836
			return false;
3837
		}
3838
		// don't display if the site is private
3839
		if(  ! Jetpack_Options::get_option( 'public' ) )
3840
			return false;
3841
3842
		/**
3843
		 * Should the Jetpack Remote Site Management notice be displayed.
3844
		 *
3845
		 * @since 3.3.0
3846
		 *
3847
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3848
		 */
3849
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3850
	}
3851
3852
	/*
3853
	 * Registration flow:
3854
	 * 1 - ::admin_page_load() action=register
3855
	 * 2 - ::try_registration()
3856
	 * 3 - ::register()
3857
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3858
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3859
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3860
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3861
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3862
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3863
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3864
	 *       jetpack_id, jetpack_secret, jetpack_public
3865
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3866
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3867
	 * 5 - user logs in with WP.com account
3868
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3869
	 *		- Jetpack_Client_Server::authorize()
3870
	 *		- Jetpack_Client_Server::get_token()
3871
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3872
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3873
	 *			- which responds with access_token, token_type, scope
3874
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3875
	 *		- Jetpack::activate_default_modules()
3876
	 *     		- Deactivates deprecated plugins
3877
	 *     		- Activates all default modules
3878
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3879
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3880
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3881
	 *     Done!
3882
	 */
3883
3884
	/**
3885
	 * Handles the page load events for the Jetpack admin page
3886
	 */
3887
	function admin_page_load() {
3888
		$error = false;
3889
3890
		// Make sure we have the right body class to hook stylings for subpages off of.
3891
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3892
3893
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3894
			// Should only be used in intermediate redirects to preserve state across redirects
3895
			Jetpack::restate();
3896
		}
3897
3898
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3899
			// User clicked in the iframe to link their accounts
3900
			if ( ! Jetpack::is_user_connected() ) {
3901
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3902
				if ( isset( $_GET['notes_iframe'] ) )
3903
					$connect_url .= '&notes_iframe';
3904
				wp_redirect( $connect_url );
3905
				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...
3906
			} else {
3907
				if ( ! isset( $_GET['calypso_env'] ) ) {
3908
					Jetpack::state( 'message', 'already_authorized' );
3909
					wp_safe_redirect( Jetpack::admin_url() );
3910
					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...
3911
				} else {
3912
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3913
					$connect_url .= '&already_authorized=true';
3914
					wp_redirect( $connect_url );
3915
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3916
				}
3917
			}
3918
		}
3919
3920
3921
		if ( isset( $_GET['action'] ) ) {
3922
			switch ( $_GET['action'] ) {
3923
			case 'authorize':
3924
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3925
					Jetpack::state( 'message', 'already_authorized' );
3926
					wp_safe_redirect( Jetpack::admin_url() );
3927
					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...
3928
				}
3929
				Jetpack::log( 'authorize' );
3930
				$client_server = new Jetpack_Client_Server;
3931
				$client_server->client_authorize();
3932
				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...
3933
			case 'register' :
3934
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3935
					$error = 'cheatin';
3936
					break;
3937
				}
3938
				check_admin_referer( 'jetpack-register' );
3939
				Jetpack::log( 'register' );
3940
				Jetpack::maybe_set_version_option();
3941
				$registered = Jetpack::try_registration();
3942
				if ( is_wp_error( $registered ) ) {
3943
					$error = $registered->get_error_code();
3944
					Jetpack::state( 'error', $error );
3945
					Jetpack::state( 'error', $registered->get_error_message() );
3946
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3947
						'error_code' => $error,
3948
						'error_message' => $registered->get_error_message()
3949
					) );
3950
					break;
3951
				}
3952
3953
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3954
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3955
3956
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3957
					'from' => $from
3958
				) );
3959
3960
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3961
				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...
3962
			case 'activate' :
3963
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3964
					$error = 'cheatin';
3965
					break;
3966
				}
3967
3968
				$module = stripslashes( $_GET['module'] );
3969
				check_admin_referer( "jetpack_activate-$module" );
3970
				Jetpack::log( 'activate', $module );
3971
				Jetpack::activate_module( $module );
3972
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3973
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3974
				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...
3975
			case 'activate_default_modules' :
3976
				check_admin_referer( 'activate_default_modules' );
3977
				Jetpack::log( 'activate_default_modules' );
3978
				Jetpack::restate();
3979
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3980
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3981
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3982
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3983
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3984
				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...
3985
			case 'disconnect' :
3986
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3987
					$error = 'cheatin';
3988
					break;
3989
				}
3990
3991
				check_admin_referer( 'jetpack-disconnect' );
3992
				Jetpack::log( 'disconnect' );
3993
				Jetpack::disconnect();
3994
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3995
				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...
3996
			case 'reconnect' :
3997
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3998
					$error = 'cheatin';
3999
					break;
4000
				}
4001
4002
				check_admin_referer( 'jetpack-reconnect' );
4003
				Jetpack::log( 'reconnect' );
4004
				$this->disconnect();
4005
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4006
				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...
4007 View Code Duplication
			case 'deactivate' :
4008
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4009
					$error = 'cheatin';
4010
					break;
4011
				}
4012
4013
				$modules = stripslashes( $_GET['module'] );
4014
				check_admin_referer( "jetpack_deactivate-$modules" );
4015
				foreach ( explode( ',', $modules ) as $module ) {
4016
					Jetpack::log( 'deactivate', $module );
4017
					Jetpack::deactivate_module( $module );
4018
					Jetpack::state( 'message', 'module_deactivated' );
4019
				}
4020
				Jetpack::state( 'module', $modules );
4021
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4022
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

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