Completed
Push — fix/later-init-for-jitms ( e975aa...33896f )
by
unknown
08:27
created

Jetpack::dismiss_jetpack_notice()   C

Complexity

Conditions 15
Paths 13

Size

Total Lines 74
Code Lines 38

Duplication

Lines 30
Ratio 40.54 %

Importance

Changes 0
Metric Value
cc 15
eloc 38
nc 13
nop 0
dl 30
loc 74
rs 5.3685
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css
37
	 */
38
	public $concatenated_style_handles = array(
39
		'jetpack-carousel',
40
		'grunion.css',
41
		'the-neverending-homepage',
42
		'jetpack_likes',
43
		'jetpack_related-posts',
44
		'sharedaddy',
45
		'jetpack-slideshow',
46
		'presentations',
47
		'jetpack-subscriptions',
48
		'jetpack-responsive-videos-style',
49
		'jetpack-social-menu',
50
		'tiled-gallery',
51
		'jetpack_display_posts_widget',
52
		'gravatar-profile-widget',
53
		'goodreads-widget',
54
		'jetpack_social_media_icons_widget',
55
		'jetpack-top-posts-widget',
56
		'jetpack_image_widget',
57
		'jetpack-my-community-widget',
58
		'wordads',
59
		'eu-cookie-law-style',
60
		'flickr-widget-style',
61
	);
62
63
	/**
64
	 * Contains all assets that have had their URL rewritten to minified versions.
65
	 *
66
	 * @var array
67
	 */
68
	static $min_assets = array();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $min_assets.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
69
70
	public $plugins_to_deactivate = array(
71
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
72
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
73
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
74
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
75
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
76
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
77
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
78
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
79
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
80
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
81
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
82
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
83
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
84
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
85
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
86
	);
87
88
	static $capability_translations = array(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
89
		'administrator' => 'manage_options',
90
		'editor'        => 'edit_others_posts',
91
		'author'        => 'publish_posts',
92
		'contributor'   => 'edit_posts',
93
		'subscriber'    => 'read',
94
	);
95
96
	/**
97
	 * Map of modules that have conflicts with plugins and should not be auto-activated
98
	 * if the plugins are active.  Used by filter_default_modules
99
	 *
100
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
101
	 * change `module-slug` and add this to your plugin:
102
	 *
103
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
104
	 * function my_jetpack_get_default_modules( $modules ) {
105
	 *     return array_diff( $modules, array( 'module-slug' ) );
106
	 * }
107
	 *
108
	 * @var array
109
	 */
110
	private $conflicting_plugins = array(
111
		'comments'          => array(
112
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
113
			'Disqus'                               => 'disqus-comment-system/disqus.php',
114
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
115
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
116
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
117
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
118
		),
119
		'comment-likes' => array(
120
			'Epoch'                                => 'epoch/plugincore.php',
121
		),
122
		'contact-form'      => array(
123
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
124
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
125
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
126
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
127
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
128
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
129
		),
130
		'minileven'         => array(
131
			'WPtouch'                              => 'wptouch/wptouch.php',
132
		),
133
		'latex'             => array(
134
			'LaTeX for WordPress'                  => 'latex/latex.php',
135
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
136
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
137
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
138
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
139
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
140
		),
141
		'protect'           => array(
142
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
143
			'Captcha'                              => 'captcha/captcha.php',
144
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
145
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
146
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
147
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
148
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
149
			'Security-protection'                  => 'security-protection/security-protection.php',
150
			'Login Security'                       => 'login-security/login-security.php',
151
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
152
			'Wordfence Security'                   => 'wordfence/wordfence.php',
153
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
154
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
155
		),
156
		'random-redirect'   => array(
157
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
158
		),
159
		'related-posts'     => array(
160
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
161
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
162
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
163
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
164
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
165
			'outbrain'                             => 'outbrain/outbrain.php',
166
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
167
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
168
		),
169
		'sharedaddy'        => array(
170
			'AddThis'                              => 'addthis/addthis_social_widget.php',
171
			'Add To Any'                           => 'add-to-any/add-to-any.php',
172
			'ShareThis'                            => 'share-this/sharethis.php',
173
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
174
		),
175
		'seo-tools' => array(
176
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
177
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
178
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
179
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
180
		),
181
		'verification-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
		),
187
		'widget-visibility' => array(
188
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
189
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
190
		),
191
		'sitemaps' => array(
192
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
193
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
194
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
195
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
196
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
197
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
198
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
199
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
200
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
201
			'Sitemap'                              => 'sitemap/sitemap.php',
202
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
203
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
204
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
205
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
206
		),
207
	);
208
209
	/**
210
	 * Plugins for which we turn off our Facebook OG Tags implementation.
211
	 *
212
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
213
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
214
	 *
215
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
216
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
217
	 */
218
	private $open_graph_conflicting_plugins = array(
219
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
220
		                                                         // 2 Click Social Media Buttons
221
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
222
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
223
		'autodescription/autodescription.php',                   // The SEO Framework
224
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
225
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
226
		                                                         // Open Graph Meta Tags by Heateor
227
		'facebook/facebook.php',                                 // Facebook (official plugin)
228
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
229
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
230
		                                                         // Facebook Featured Image & OG Meta Tags
231
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
232
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
233
		                                                         // Facebook Open Graph Meta Tags for WordPress
234
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
235
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
236
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
237
		                                                         // Fedmich's Facebook Open Graph Meta
238
		'network-publisher/networkpub.php',                      // Network Publisher
239
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
240
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
241
		                                                         // NextScripts SNAP
242
		'og-tags/og-tags.php',                                   // OG Tags
243
		'opengraph/opengraph.php',                               // Open Graph
244
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
245
		                                                         // Open Graph Protocol Framework
246
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
247
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
248
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
249
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
250
		'sharepress/sharepress.php',                             // SharePress
251
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
252
		'social-discussions/social-discussions.php',             // Social Discussions
253
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
254
		'socialize/socialize.php',                               // Socialize
255
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
256
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
257
		                                                         // Tweet, Like, Google +1 and Share
258
		'wordbooker/wordbooker.php',                             // Wordbooker
259
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
260
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
261
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
262
		                                                         // WP Facebook Like Send & Open Graph Meta
263
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
264
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
265
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
266
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
267
	);
268
269
	/**
270
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
271
	 */
272
	private $twitter_cards_conflicting_plugins = array(
273
	//	'twitter/twitter.php',                       // The official one handles this on its own.
274
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
275
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
276
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
277
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
278
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
279
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
280
		'twitter-cards/twitter-cards.php',           // Twitter Cards
281
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
282
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
283
	);
284
285
	/**
286
	 * Message to display in admin_notice
287
	 * @var string
288
	 */
289
	public $message = '';
290
291
	/**
292
	 * Error to display in admin_notice
293
	 * @var string
294
	 */
295
	public $error = '';
296
297
	/**
298
	 * Modules that need more privacy description.
299
	 * @var string
300
	 */
301
	public $privacy_checks = '';
302
303
	/**
304
	 * Stats to record once the page loads
305
	 *
306
	 * @var array
307
	 */
308
	public $stats = array();
309
310
	/**
311
	 * Jetpack_Sync object
312
	 */
313
	public $sync;
314
315
	/**
316
	 * Verified data for JSON authorization request
317
	 */
318
	public $json_api_authorization_request = array();
319
320
	/**
321
	 * Holds the singleton instance of this class
322
	 * @since 2.3.3
323
	 * @var Jetpack
324
	 */
325
	static $instance = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
326
327
	/**
328
	 * Singleton
329
	 * @static
330
	 */
331
	public static function init() {
332
		if ( ! self::$instance ) {
333
			self::$instance = new Jetpack;
334
335
			self::$instance->plugin_upgrade();
336
		}
337
338
		return self::$instance;
339
	}
340
341
	/**
342
	 * Must never be called statically
343
	 */
344
	function plugin_upgrade() {
345
		if ( Jetpack::is_active() ) {
346
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
347
			if ( JETPACK__VERSION != $version ) {
348
349
				// check which active modules actually exist and remove others from active_modules list
350
				$unfiltered_modules = Jetpack::get_active_modules();
351
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
352
				if ( array_diff( $unfiltered_modules, $modules ) ) {
353
					Jetpack::update_active_modules( $modules );
354
				}
355
356
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
357
358
				// Upgrade to 4.3.0
359
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
360
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
361
				}
362
363
				// Make sure Markdown for posts gets turned back on
364
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
365
					update_option( 'wpcom_publish_posts_with_markdown', true );
366
				}
367
368
				if ( did_action( 'wp_loaded' ) ) {
369
					self::upgrade_on_load();
370
				} else {
371
					add_action(
372
						'wp_loaded',
373
						array( __CLASS__, 'upgrade_on_load' )
374
					);
375
				}
376
			}
377
		}
378
	}
379
380
	/**
381
	 * Runs upgrade routines that need to have modules loaded.
382
	 */
383
	static function upgrade_on_load() {
384
385
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
386
		// This can happen in case Jetpack has been just upgraded and is
387
		// being initialized late during the page load. In this case we wait
388
		// until the next proper admin page load with Jetpack active.
389
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
390
			return;
391
		}
392
393
		Jetpack::maybe_set_version_option();
394
395
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
396
			Jetpack_Widget_Conditions::migrate_post_type_rules();
397
		}
398
399
		if (
400
			class_exists( 'Jetpack_Sitemap_Manager' )
401
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
402
		) {
403
			do_action( 'jetpack_sitemaps_purge_data' );
404
		}
405
	}
406
407
	static function activate_manage( ) {
408
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
409
			self::activate_module( 'manage', false, false );
410
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
411
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
412
		}
413
	}
414
415
	static function update_active_modules( $modules ) {
416
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
417
418
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
419
420
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
421
			$new_active_modules = array_diff( $modules, $current_modules );
422
			foreach( $new_active_modules as $module ) {
423
				/**
424
				 * Fires when a specific module is activated.
425
				 *
426
				 * @since 1.9.0
427
				 *
428
				 * @param string $module Module slug.
429
				 * @param boolean $success whether the module was activated. @since 4.2
430
				 */
431
				do_action( 'jetpack_activate_module', $module, $success );
432
433
				/**
434
				 * Fires when a module is activated.
435
				 * The dynamic part of the filter, $module, is the module slug.
436
				 *
437
				 * @since 1.9.0
438
				 *
439
				 * @param string $module Module slug.
440
				 */
441
				do_action( "jetpack_activate_module_$module", $module );
442
			}
443
444
			$new_deactive_modules = array_diff( $current_modules, $modules );
445
			foreach( $new_deactive_modules as $module ) {
446
				/**
447
				 * Fired after a module has been deactivated.
448
				 *
449
				 * @since 4.2.0
450
				 *
451
				 * @param string $module Module slug.
452
				 * @param boolean $success whether the module was deactivated.
453
				 */
454
				do_action( 'jetpack_deactivate_module', $module, $success );
455
				/**
456
				 * Fires when a module is deactivated.
457
				 * The dynamic part of the filter, $module, is the module slug.
458
				 *
459
				 * @since 1.9.0
460
				 *
461
				 * @param string $module Module slug.
462
				 */
463
				do_action( "jetpack_deactivate_module_$module", $module );
464
			}
465
		}
466
467
		return $success;
468
	}
469
470
	static function delete_active_modules() {
471
		self::update_active_modules( array() );
472
	}
473
474
	/**
475
	 * Constructor.  Initializes WordPress hooks
476
	 */
477
	private function __construct() {
478
		/*
479
		 * Check for and alert any deprecated hooks
480
		 */
481
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
482
483
		/*
484
		 * Enable enhanced handling of previewing sites in Calypso
485
		 */
486
		if ( Jetpack::is_active() ) {
487
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
488
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
489
		}
490
491
		/*
492
		 * Load things that should only be in Network Admin.
493
		 *
494
		 * For now blow away everything else until a more full
495
		 * understanding of what is needed at the network level is
496
		 * available
497
		 */
498
		if( is_multisite() ) {
499
			Jetpack_Network::init();
500
		}
501
502
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
503
504
		// Unlink user before deleting the user from .com
505
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
506
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
507
508
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
509
			@ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
510
511
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
512
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
513
514
			$this->require_jetpack_authentication();
515
516
			if ( Jetpack::is_active() ) {
517
				// Hack to preserve $HTTP_RAW_POST_DATA
518
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
519
520
				$signed = $this->verify_xml_rpc_signature();
521
				if ( $signed && ! is_wp_error( $signed ) ) {
522
					// The actual API methods.
523
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
524
				} else {
525
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
526
					// active Jetpack connection, so that additional users can link their account.
527
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
528
				}
529
			} else {
530
				// The bootstrap API methods.
531
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
532
			}
533
534
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
535
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
536
		} elseif (
537
			is_admin() &&
538
			isset( $_POST['action'] ) && (
539
				'jetpack_upload_file' == $_POST['action'] ||
540
				'jetpack_update_file' == $_POST['action']
541
			)
542
		) {
543
			$this->require_jetpack_authentication();
544
			$this->add_remote_request_handlers();
545
		} else {
546
			if ( Jetpack::is_active() ) {
547
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
548
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
549
			}
550
		}
551
552
		if ( Jetpack::is_active() ) {
553
			Jetpack_Heartbeat::init();
554
		}
555
556
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
557
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
558
559
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
560
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
561
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
562
		}
563
564
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
565
566
		add_action( 'admin_init', array( $this, 'admin_init' ) );
567
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
568
569
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
570
571
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
572
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
573
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
574
575
		// returns HTTPS support status
576
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
577
578
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
579
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
580
581
		// JITM AJAX callback function
582
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
583
584
		// Universal ajax callback for all tracking events triggered via js
585
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
586
587
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
588
589
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
590
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
591
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
592
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
593
594
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
595
596
		/**
597
		 * These actions run checks to load additional files.
598
		 * They check for external files or plugins, so they need to run as late as possible.
599
		 */
600
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
601
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
602
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
603
604
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
605
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
606
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
607
608
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
609
610
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
611
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
612
613
		// A filter to control all just in time messages
614
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
615
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
616
617
		// If enabled, point edit post and page links to Calypso instead of WP-Admin.
618
		// We should make sure to only do this for front end links.
619
		if ( Jetpack_Options::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
620
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_links_to_calypso' ), 1, 2 );
621
		}
622
623
		// Update the Jetpack plan from API on heartbeats
624
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
625
626
		/**
627
		 * This is the hack to concatinate all css files into one.
628
		 * For description and reasoning see the implode_frontend_css method
629
		 *
630
		 * Super late priority so we catch all the registered styles
631
		 */
632
		if( !is_admin() ) {
633
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
634
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
635
		}
636
637
		/**
638
		 * These are sync actions that we need to keep track of for jitms
639
		 */
640
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
641
	}
642
643
	function point_edit_links_to_calypso( $default_url, $post_id ) {
644
		$post = get_post( $post_id );
645
646
		if ( empty( $post ) ) {
647
			return $default_url;
648
		}
649
650
		$post_type = $post->post_type;
651
652
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
653
		// https://en.support.wordpress.com/custom-post-types/
654
		$allowed_post_types = array(
655
			'post' => 'post',
656
			'page' => 'page',
657
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
658
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
659
		);
660
661
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
662
			return $default_url;
663
		}
664
665
		$path_prefix = $allowed_post_types[ $post_type ];
666
667
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 2 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

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

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

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

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