Completed
Push — gm-17/payment-widget ( cb2702...55e70e )
by
unknown
13:32 queued 03:19
created

Jetpack::get_activation_source()   C

Complexity

Conditions 14
Paths 38

Size

Total Lines 49
Code Lines 35

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 14
eloc 35
nc 38
nop 1
dl 0
loc 49
rs 5.1329
c 0
b 0
f 0

How to fix   Complexity   

Long Method

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

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

Commonly applied refactorings include:

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