Completed
Push — fix/inline-module-enable-plan-... ( 66c1a8...61746a )
by
unknown
24:35 queued 15:19
created

Jetpack::get_module()   F

Complexity

Conditions 11
Paths 257

Size

Total Lines 91
Code Lines 48

Duplication

Lines 12
Ratio 13.19 %

Importance

Changes 0
Metric Value
cc 11
eloc 48
nc 257
nop 1
dl 12
loc 91
rs 3.8181
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
		'jetpack-search-widget'
62
	);
63
64
	/**
65
	 * Contains all assets that have had their URL rewritten to minified versions.
66
	 *
67
	 * @var array
68
	 */
69
	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...
70
71
	public $plugins_to_deactivate = array(
72
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
73
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
74
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
75
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
76
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
77
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
78
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
79
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
80
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
81
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
82
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
83
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
84
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
85
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
86
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
87
	);
88
89
	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...
90
		'administrator' => 'manage_options',
91
		'editor'        => 'edit_others_posts',
92
		'author'        => 'publish_posts',
93
		'contributor'   => 'edit_posts',
94
		'subscriber'    => 'read',
95
	);
96
97
	/**
98
	 * Map of modules that have conflicts with plugins and should not be auto-activated
99
	 * if the plugins are active.  Used by filter_default_modules
100
	 *
101
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
102
	 * change `module-slug` and add this to your plugin:
103
	 *
104
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
105
	 * function my_jetpack_get_default_modules( $modules ) {
106
	 *     return array_diff( $modules, array( 'module-slug' ) );
107
	 * }
108
	 *
109
	 * @var array
110
	 */
111
	private $conflicting_plugins = array(
112
		'comments'          => array(
113
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
114
			'Disqus'                               => 'disqus-comment-system/disqus.php',
115
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
116
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
117
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
118
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
119
		),
120
		'comment-likes' => array(
121
			'Epoch'                                => 'epoch/plugincore.php',
122
		),
123
		'contact-form'      => array(
124
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
125
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
126
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
127
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
128
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
129
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
130
		),
131
		'minileven'         => array(
132
			'WPtouch'                              => 'wptouch/wptouch.php',
133
		),
134
		'latex'             => array(
135
			'LaTeX for WordPress'                  => 'latex/latex.php',
136
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
137
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
138
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
139
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
140
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
141
		),
142
		'protect'           => array(
143
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
144
			'Captcha'                              => 'captcha/captcha.php',
145
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
146
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
147
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
148
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
149
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
150
			'Security-protection'                  => 'security-protection/security-protection.php',
151
			'Login Security'                       => 'login-security/login-security.php',
152
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
153
			'Wordfence Security'                   => 'wordfence/wordfence.php',
154
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
155
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
156
		),
157
		'random-redirect'   => array(
158
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
159
		),
160
		'related-posts'     => array(
161
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
162
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
163
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
164
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
165
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
166
			'outbrain'                             => 'outbrain/outbrain.php',
167
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
168
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
169
		),
170
		'sharedaddy'        => array(
171
			'AddThis'                              => 'addthis/addthis_social_widget.php',
172
			'Add To Any'                           => 'add-to-any/add-to-any.php',
173
			'ShareThis'                            => 'share-this/sharethis.php',
174
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
175
		),
176
		'seo-tools' => array(
177
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
178
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
179
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
180
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
181
		),
182
		'verification-tools' => array(
183
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
184
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
185
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
186
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
187
		),
188
		'widget-visibility' => array(
189
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
190
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
191
		),
192
		'sitemaps' => array(
193
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
194
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
195
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
196
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
197
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
198
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
199
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
200
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
201
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
202
			'Sitemap'                              => 'sitemap/sitemap.php',
203
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
204
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
205
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
206
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
207
		),
208
		'lazy-images' => array(
209
			'Lazy Load'              => 'lazy-load/lazy-load.php',
210
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
211
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
212
		),
213
	);
214
215
	/**
216
	 * Plugins for which we turn off our Facebook OG Tags implementation.
217
	 *
218
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
219
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
220
	 *
221
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
222
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
223
	 */
224
	private $open_graph_conflicting_plugins = array(
225
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
226
		                                                         // 2 Click Social Media Buttons
227
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
228
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
229
		'autodescription/autodescription.php',                   // The SEO Framework
230
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
231
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
232
		                                                         // Open Graph Meta Tags by Heateor
233
		'facebook/facebook.php',                                 // Facebook (official plugin)
234
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
235
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
236
		                                                         // Facebook Featured Image & OG Meta Tags
237
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
238
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
239
		                                                         // Facebook Open Graph Meta Tags for WordPress
240
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
241
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
242
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
243
		                                                         // Fedmich's Facebook Open Graph Meta
244
		'network-publisher/networkpub.php',                      // Network Publisher
245
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
246
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
247
		                                                         // NextScripts SNAP
248
		'og-tags/og-tags.php',                                   // OG Tags
249
		'opengraph/opengraph.php',                               // Open Graph
250
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
251
		                                                         // Open Graph Protocol Framework
252
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
253
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
254
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
255
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
256
		'sharepress/sharepress.php',                             // SharePress
257
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
258
		'social-discussions/social-discussions.php',             // Social Discussions
259
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
260
		'socialize/socialize.php',                               // Socialize
261
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
262
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
263
		                                                         // Tweet, Like, Google +1 and Share
264
		'wordbooker/wordbooker.php',                             // Wordbooker
265
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
266
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
267
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
268
		                                                         // WP Facebook Like Send & Open Graph Meta
269
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
270
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
271
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
272
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
273
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
274
	);
275
276
	/**
277
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
278
	 */
279
	private $twitter_cards_conflicting_plugins = array(
280
	//	'twitter/twitter.php',                       // The official one handles this on its own.
281
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
282
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
283
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
284
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
285
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
286
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
287
		'twitter-cards/twitter-cards.php',           // Twitter Cards
288
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
289
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
290
	);
291
292
	/**
293
	 * Message to display in admin_notice
294
	 * @var string
295
	 */
296
	public $message = '';
297
298
	/**
299
	 * Error to display in admin_notice
300
	 * @var string
301
	 */
302
	public $error = '';
303
304
	/**
305
	 * Modules that need more privacy description.
306
	 * @var string
307
	 */
308
	public $privacy_checks = '';
309
310
	/**
311
	 * Stats to record once the page loads
312
	 *
313
	 * @var array
314
	 */
315
	public $stats = array();
316
317
	/**
318
	 * Jetpack_Sync object
319
	 */
320
	public $sync;
321
322
	/**
323
	 * Verified data for JSON authorization request
324
	 */
325
	public $json_api_authorization_request = array();
326
327
	/**
328
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
329
	 */
330
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
331
332
	/**
333
	 * Holds the singleton instance of this class
334
	 * @since 2.3.3
335
	 * @var Jetpack
336
	 */
337
	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...
338
339
	/**
340
	 * Singleton
341
	 * @static
342
	 */
343
	public static function init() {
344
		if ( ! self::$instance ) {
345
			self::$instance = new Jetpack;
346
347
			self::$instance->plugin_upgrade();
348
		}
349
350
		return self::$instance;
351
	}
352
353
	/**
354
	 * Must never be called statically
355
	 */
356
	function plugin_upgrade() {
357
		if ( Jetpack::is_active() ) {
358
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
359
			if ( JETPACK__VERSION != $version ) {
360
				// Prevent multiple upgrades at once - only a single process should trigger
361
				// an upgrade to avoid stampedes
362
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
363
					return;
364
				}
365
366
				// Set a short lock to prevent multiple instances of the upgrade
367
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
368
369
				// check which active modules actually exist and remove others from active_modules list
370
				$unfiltered_modules = Jetpack::get_active_modules();
371
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
372
				if ( array_diff( $unfiltered_modules, $modules ) ) {
373
					Jetpack::update_active_modules( $modules );
374
				}
375
376
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
377
378
				// Upgrade to 4.3.0
379
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
380
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
381
				}
382
383
				// Make sure Markdown for posts gets turned back on
384
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
385
					update_option( 'wpcom_publish_posts_with_markdown', true );
386
				}
387
388
				if ( did_action( 'wp_loaded' ) ) {
389
					self::upgrade_on_load();
390
				} else {
391
					add_action(
392
						'wp_loaded',
393
						array( __CLASS__, 'upgrade_on_load' )
394
					);
395
				}
396
			}
397
		}
398
	}
399
400
	/**
401
	 * Runs upgrade routines that need to have modules loaded.
402
	 */
403
	static function upgrade_on_load() {
404
405
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
406
		// This can happen in case Jetpack has been just upgraded and is
407
		// being initialized late during the page load. In this case we wait
408
		// until the next proper admin page load with Jetpack active.
409
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
410
			delete_transient( self::$plugin_upgrade_lock_key );
411
412
			return;
413
		}
414
415
		Jetpack::maybe_set_version_option();
416
417
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
418
			Jetpack_Widget_Conditions::migrate_post_type_rules();
419
		}
420
421
		if (
422
			class_exists( 'Jetpack_Sitemap_Manager' )
423
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
424
		) {
425
			do_action( 'jetpack_sitemaps_purge_data' );
426
		}
427
428
		delete_transient( self::$plugin_upgrade_lock_key );
429
	}
430
431
	static function activate_manage( ) {
432
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
433
			self::activate_module( 'manage', false, false );
434
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
435
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
436
		}
437
	}
438
439
	static function update_active_modules( $modules ) {
440
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
441
442
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
443
444
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
445
			$new_active_modules = array_diff( $modules, $current_modules );
446
			foreach( $new_active_modules as $module ) {
447
				/**
448
				 * Fires when a specific module is activated.
449
				 *
450
				 * @since 1.9.0
451
				 *
452
				 * @param string $module Module slug.
453
				 * @param boolean $success whether the module was activated. @since 4.2
454
				 */
455
				do_action( 'jetpack_activate_module', $module, $success );
456
457
				/**
458
				 * Fires when a module is activated.
459
				 * The dynamic part of the filter, $module, is the module slug.
460
				 *
461
				 * @since 1.9.0
462
				 *
463
				 * @param string $module Module slug.
464
				 */
465
				do_action( "jetpack_activate_module_$module", $module );
466
			}
467
468
			$new_deactive_modules = array_diff( $current_modules, $modules );
469
			foreach( $new_deactive_modules as $module ) {
470
				/**
471
				 * Fired after a module has been deactivated.
472
				 *
473
				 * @since 4.2.0
474
				 *
475
				 * @param string $module Module slug.
476
				 * @param boolean $success whether the module was deactivated.
477
				 */
478
				do_action( 'jetpack_deactivate_module', $module, $success );
479
				/**
480
				 * Fires when a module is deactivated.
481
				 * The dynamic part of the filter, $module, is the module slug.
482
				 *
483
				 * @since 1.9.0
484
				 *
485
				 * @param string $module Module slug.
486
				 */
487
				do_action( "jetpack_deactivate_module_$module", $module );
488
			}
489
		}
490
491
		return $success;
492
	}
493
494
	static function delete_active_modules() {
495
		self::update_active_modules( array() );
496
	}
497
498
	/**
499
	 * Constructor.  Initializes WordPress hooks
500
	 */
501
	private function __construct() {
502
		/*
503
		 * Check for and alert any deprecated hooks
504
		 */
505
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
506
507
		/*
508
		 * Enable enhanced handling of previewing sites in Calypso
509
		 */
510
		if ( Jetpack::is_active() ) {
511
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
512
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
513
		}
514
515
		/*
516
		 * Load things that should only be in Network Admin.
517
		 *
518
		 * For now blow away everything else until a more full
519
		 * understanding of what is needed at the network level is
520
		 * available
521
		 */
522
		if( is_multisite() ) {
523
			Jetpack_Network::init();
524
		}
525
526
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
527
528
		// Unlink user before deleting the user from .com
529
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
530
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
531
532
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
533
			@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...
534
535
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
536
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
537
538
			$this->require_jetpack_authentication();
539
540
			if ( Jetpack::is_active() ) {
541
				// Hack to preserve $HTTP_RAW_POST_DATA
542
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
543
544
				$signed = $this->verify_xml_rpc_signature();
545
				if ( $signed && ! is_wp_error( $signed ) ) {
546
					// The actual API methods.
547
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
548
				} else {
549
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
550
					// active Jetpack connection, so that additional users can link their account.
551
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
552
				}
553
			} else {
554
				// The bootstrap API methods.
555
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
556
			}
557
558
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
559
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
560
		} elseif (
561
			is_admin() &&
562
			isset( $_POST['action'] ) && (
563
				'jetpack_upload_file' == $_POST['action'] ||
564
				'jetpack_update_file' == $_POST['action']
565
			)
566
		) {
567
			$this->require_jetpack_authentication();
568
			$this->add_remote_request_handlers();
569
		} else {
570
			if ( Jetpack::is_active() ) {
571
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
572
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
573
			}
574
		}
575
576
		if ( Jetpack::is_active() ) {
577
			Jetpack_Heartbeat::init();
578
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
579
			Jetpack_Search_Performance_Logger::init();
580
		}
581
582
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
583
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
584
585
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
586
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
587
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
588
		}
589
590
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
591
592
		add_action( 'admin_init', array( $this, 'admin_init' ) );
593
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
594
595
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
596
597
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
598
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
599
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
600
601
		// returns HTTPS support status
602
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
603
604
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
605
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
606
607
		// JITM AJAX callback function
608
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
609
610
		// Universal ajax callback for all tracking events triggered via js
611
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
612
613
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
614
615
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
616
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
617
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
618
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
619
620
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
621
622
		/**
623
		 * These actions run checks to load additional files.
624
		 * They check for external files or plugins, so they need to run as late as possible.
625
		 */
626
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
627
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
628
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
629
630
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
631
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
632
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
633
634
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
635
636
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
637
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
638
639
		// A filter to control all just in time messages
640
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
641
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
642
643
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
644
		// We should make sure to only do this for front end links.
645
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
646
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
647
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
648
649
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
650
			//so they point moderation links on emails to Calypso
651
			jetpack_require_lib( 'functions.wp-notify' );
652
		}
653
654
		// Update the Jetpack plan from API on heartbeats
655
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
656
657
		/**
658
		 * This is the hack to concatinate all css files into one.
659
		 * For description and reasoning see the implode_frontend_css method
660
		 *
661
		 * Super late priority so we catch all the registered styles
662
		 */
663
		if( !is_admin() ) {
664
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
665
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
666
		}
667
668
		/**
669
		 * These are sync actions that we need to keep track of for jitms
670
		 */
671
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
672
673
		// Actually push the stats on shutdown.
674
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
675
			add_action( 'shutdown', array( $this, 'push_stats' ) );
676
		}
677
	}
678
679
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
680
		$post = get_post( $post_id );
681
682
		if ( empty( $post ) ) {
683
			return $default_url;
684
		}
685
686
		$post_type = $post->post_type;
687
688
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
689
		// https://en.support.wordpress.com/custom-post-types/
690
		$allowed_post_types = array(
691
			'post' => 'post',
692
			'page' => 'page',
693
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
694
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
695
		);
696
697
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
698
			return $default_url;
699
		}
700
701
		$path_prefix = $allowed_post_types[ $post_type ];
702
703
		$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...
704
705
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
706
	}
707
708
	function point_edit_comment_links_to_calypso( $url ) {
709
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
710
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

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

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

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

Loading history...
3989
				}
3990
			}
3991
		}
3992
3993
3994
		if ( isset( $_GET['action'] ) ) {
3995
			switch ( $_GET['action'] ) {
3996
			case 'authorize':
3997
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3998
					Jetpack::state( 'message', 'already_authorized' );
3999
					wp_safe_redirect( Jetpack::admin_url() );
4000
					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...
4001
				}
4002
				Jetpack::log( 'authorize' );
4003
				$client_server = new Jetpack_Client_Server;
4004
				$client_server->client_authorize();
4005
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
4006
			case 'register' :
4007
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4008
					$error = 'cheatin';
4009
					break;
4010
				}
4011
				check_admin_referer( 'jetpack-register' );
4012
				Jetpack::log( 'register' );
4013
				Jetpack::maybe_set_version_option();
4014
				$registered = Jetpack::try_registration();
4015
				if ( is_wp_error( $registered ) ) {
4016
					$error = $registered->get_error_code();
4017
					Jetpack::state( 'error', $error );
4018
					Jetpack::state( 'error', $registered->get_error_message() );
4019
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4020
						'error_code' => $error,
4021
						'error_message' => $registered->get_error_message()
4022
					) );
4023
					break;
4024
				}
4025
4026
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4027
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4028
4029
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4030
					'from' => $from
4031
				) );
4032
4033
				$url = $this->build_connect_url( true, $redirect, $from );
4034
4035
				if ( ! empty( $_GET['onboarding'] ) ) {
4036
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4037
				}
4038
4039
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4040
					$url = add_query_arg( 'auth_approved', 'true', $url );
4041
				}
4042
4043
				wp_redirect( $url );
4044
				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...
4045
			case 'activate' :
4046
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4047
					$error = 'cheatin';
4048
					break;
4049
				}
4050
4051
				$module = stripslashes( $_GET['module'] );
4052
				check_admin_referer( "jetpack_activate-$module" );
4053
				Jetpack::log( 'activate', $module );
4054
				if ( ! Jetpack::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Jetpack::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

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