Completed
Push — try/record-discovery-term ( ff5b1f )
by
unknown
10:43 queued 02:52
created

Jetpack::disconnect()   B

Complexity

Conditions 6
Paths 16

Size

Total Lines 61
Code Lines 35

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 6
eloc 35
nc 16
nop 1
dl 0
loc 61
rs 8.6806
c 0
b 0
f 0

How to fix   Long Method   

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

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

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

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