Completed
Push — update/fusion-whitelist1 ( 305e29 )
by
unknown
11:45
created

class.jetpack.php (65 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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
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
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
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
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
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
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
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 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1027
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1028
			return 'en_US';
1029
		}
1030
1031
		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
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 ( ! isset( $module ) || ! is_array( $module ) ) {
1519
				continue;
1520
			}
1521
			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
1522
				$supports[] = $module_slug;
1523
			}
1524
		}
1525
1526
		$plan['supports'] = $supports;
1527
1528
		$active_plan_cache = $plan;
1529
1530
		return $plan;
1531
	}
1532
1533
	/**
1534
	 * Determine whether the active plan supports a particular feature
1535
	 *
1536
	 * @uses Jetpack::get_active_plan()
1537
	 *
1538
	 * @access public
1539
	 * @static
1540
	 *
1541
	 * @return bool True if plan supports feature, false if not
1542
	 */
1543
	public static function active_plan_supports( $feature ) {
1544
		$plan = Jetpack::get_active_plan();
1545
1546
		if ( in_array( $feature, $plan['supports'] ) ) {
1547
			return true;
1548
		}
1549
1550
		return false;
1551
	}
1552
1553
	/**
1554
	 * Is Jetpack in development (offline) mode?
1555
	 */
1556
	public static function is_development_mode() {
1557
		$development_mode = false;
1558
1559
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1560
			$development_mode = JETPACK_DEV_DEBUG;
1561
		} elseif ( $site_url = site_url() ) {
1562
			$development_mode = false === strpos( $site_url, '.' );
1563
		}
1564
1565
		/**
1566
		 * Filters Jetpack's development mode.
1567
		 *
1568
		 * @see https://jetpack.com/support/development-mode/
1569
		 *
1570
		 * @since 2.2.1
1571
		 *
1572
		 * @param bool $development_mode Is Jetpack's development mode active.
1573
		 */
1574
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1575
		return $development_mode;
1576
	}
1577
1578
	/**
1579
	 * Whether the site is currently onboarding or not.
1580
	 * A site is considered as being onboarded if it currently has an onboarding token.
1581
	 *
1582
	 * @since 5.8
1583
	 *
1584
	 * @access public
1585
	 * @static
1586
	 *
1587
	 * @return bool True if the site is currently onboarding, false otherwise
1588
	 */
1589
	public static function is_onboarding() {
1590
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1591
	}
1592
1593
	/**
1594
	* Get Jetpack development mode notice text and notice class.
1595
	*
1596
	* Mirrors the checks made in Jetpack::is_development_mode
1597
	*
1598
	*/
1599
	public static function show_development_mode_notice() {
1600
		if ( Jetpack::is_development_mode() ) {
1601
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1602
				$notice = sprintf(
1603
					/* translators: %s is a URL */
1604
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1605
					'https://jetpack.com/support/development-mode/'
1606
				);
1607
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1608
				$notice = sprintf(
1609
					/* translators: %s is a URL */
1610
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1611
					'https://jetpack.com/support/development-mode/'
1612
				);
1613
			} else {
1614
				$notice = sprintf(
1615
					/* translators: %s is a URL */
1616
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1617
					'https://jetpack.com/support/development-mode/'
1618
				);
1619
			}
1620
1621
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1622
		}
1623
1624
		// Throw up a notice if using a development version and as for feedback.
1625
		if ( Jetpack::is_development_version() ) {
1626
			/* translators: %s is a URL */
1627
			$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/' );
1628
1629
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1630
		}
1631
		// Throw up a notice if using staging mode
1632
		if ( Jetpack::is_staging_site() ) {
1633
			/* translators: %s is a URL */
1634
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1635
1636
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1637
		}
1638
	}
1639
1640
	/**
1641
	 * Whether Jetpack's version maps to a public release, or a development version.
1642
	 */
1643
	public static function is_development_version() {
1644
		/**
1645
		 * Allows filtering whether this is a development version of Jetpack.
1646
		 *
1647
		 * This filter is especially useful for tests.
1648
		 *
1649
		 * @since 4.3.0
1650
		 *
1651
		 * @param bool $development_version Is this a develoment version of Jetpack?
1652
		 */
1653
		return (bool) apply_filters(
1654
			'jetpack_development_version',
1655
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1656
		);
1657
	}
1658
1659
	/**
1660
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1661
	 */
1662
	public static function is_user_connected( $user_id = false ) {
1663
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1664
		if ( ! $user_id ) {
1665
			return false;
1666
		}
1667
1668
		return (bool) Jetpack_Data::get_access_token( $user_id );
1669
	}
1670
1671
	/**
1672
	 * Get the wpcom user data of the current|specified connected user.
1673
	 */
1674
	public static function get_connected_user_data( $user_id = null ) {
1675
		if ( ! $user_id ) {
1676
			$user_id = get_current_user_id();
1677
		}
1678
1679
		$transient_key = "jetpack_connected_user_data_$user_id";
1680
1681
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1682
			return $cached_user_data;
1683
		}
1684
1685
		Jetpack::load_xml_rpc_client();
1686
		$xml = new Jetpack_IXR_Client( array(
1687
			'user_id' => $user_id,
1688
		) );
1689
		$xml->query( 'wpcom.getUser' );
1690
		if ( ! $xml->isError() ) {
1691
			$user_data = $xml->getResponse();
1692
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1693
			return $user_data;
1694
		}
1695
1696
		return false;
1697
	}
1698
1699
	/**
1700
	 * Get the wpcom email of the current|specified connected user.
1701
	 */
1702 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1703
		if ( ! $user_id ) {
1704
			$user_id = get_current_user_id();
1705
		}
1706
		Jetpack::load_xml_rpc_client();
1707
		$xml = new Jetpack_IXR_Client( array(
1708
			'user_id' => $user_id,
1709
		) );
1710
		$xml->query( 'wpcom.getUserEmail' );
1711
		if ( ! $xml->isError() ) {
1712
			return $xml->getResponse();
1713
		}
1714
		return false;
1715
	}
1716
1717
	/**
1718
	 * Get the wpcom email of the master user.
1719
	 */
1720
	public static function get_master_user_email() {
1721
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1722
		if ( $master_user_id ) {
1723
			return self::get_connected_user_email( $master_user_id );
1724
		}
1725
		return '';
1726
	}
1727
1728
	function current_user_is_connection_owner() {
1729
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1730
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1731
	}
1732
1733
	/**
1734
	 * Gets current user IP address.
1735
	 *
1736
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1737
	 *
1738
	 * @return string                  Current user IP address.
1739
	 */
1740
	public static function current_user_ip( $check_all_headers = false ) {
1741
		if ( $check_all_headers ) {
1742
			foreach ( array(
1743
				'HTTP_CF_CONNECTING_IP',
1744
				'HTTP_CLIENT_IP',
1745
				'HTTP_X_FORWARDED_FOR',
1746
				'HTTP_X_FORWARDED',
1747
				'HTTP_X_CLUSTER_CLIENT_IP',
1748
				'HTTP_FORWARDED_FOR',
1749
				'HTTP_FORWARDED',
1750
				'HTTP_VIA',
1751
			) as $key ) {
1752
				if ( ! empty( $_SERVER[ $key ] ) ) {
1753
					return $_SERVER[ $key ];
1754
				}
1755
			}
1756
		}
1757
1758
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1759
	}
1760
1761
	/**
1762
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1763
	 */
1764
	function extra_oembed_providers() {
1765
		// Cloudup: https://dev.cloudup.com/#oembed
1766
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1767
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1768
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1769
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1770
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1771
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1772
	}
1773
1774
	/**
1775
	 * Synchronize connected user role changes
1776
	 */
1777
	function user_role_change( $user_id ) {
1778
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1779
		Jetpack_Sync_Users::user_role_change( $user_id );
1780
	}
1781
1782
	/**
1783
	 * Loads the currently active modules.
1784
	 */
1785
	public static function load_modules() {
1786
		if (
1787
			! self::is_active()
1788
			&& ! self::is_development_mode()
1789
			&& ! self::is_onboarding()
1790
			&& (
1791
				! is_multisite()
1792
				|| ! get_site_option( 'jetpack_protect_active' )
1793
			)
1794
		) {
1795
			return;
1796
		}
1797
1798
		$version = Jetpack_Options::get_option( 'version' );
1799 View Code Duplication
		if ( ! $version ) {
1800
			$version = $old_version = JETPACK__VERSION . ':' . time();
1801
			/** This action is documented in class.jetpack.php */
1802
			do_action( 'updating_jetpack_version', $version, false );
1803
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1804
		}
1805
		list( $version ) = explode( ':', $version );
1806
1807
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1808
1809
		$modules_data = array();
1810
1811
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1812
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1813
			$updated_modules = array();
1814
			foreach ( $modules as $module ) {
1815
				$modules_data[ $module ] = Jetpack::get_module( $module );
1816
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1817
					continue;
1818
				}
1819
1820
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1821
					continue;
1822
				}
1823
1824
				$updated_modules[] = $module;
1825
			}
1826
1827
			$modules = array_diff( $modules, $updated_modules );
1828
		}
1829
1830
		$is_development_mode = Jetpack::is_development_mode();
1831
1832
		foreach ( $modules as $index => $module ) {
1833
			// If we're in dev mode, disable modules requiring a connection
1834
			if ( $is_development_mode ) {
1835
				// Prime the pump if we need to
1836
				if ( empty( $modules_data[ $module ] ) ) {
1837
					$modules_data[ $module ] = Jetpack::get_module( $module );
1838
				}
1839
				// If the module requires a connection, but we're in local mode, don't include it.
1840
				if ( $modules_data[ $module ]['requires_connection'] ) {
1841
					continue;
1842
				}
1843
			}
1844
1845
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1846
				continue;
1847
			}
1848
1849
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1850
				unset( $modules[ $index ] );
1851
				self::update_active_modules( array_values( $modules ) );
1852
				continue;
1853
			}
1854
1855
			/**
1856
			 * Fires when a specific module is loaded.
1857
			 * The dynamic part of the hook, $module, is the module slug.
1858
			 *
1859
			 * @since 1.1.0
1860
			 */
1861
			do_action( 'jetpack_module_loaded_' . $module );
1862
		}
1863
1864
		/**
1865
		 * Fires when all the modules are loaded.
1866
		 *
1867
		 * @since 1.1.0
1868
		 */
1869
		do_action( 'jetpack_modules_loaded' );
1870
1871
		// 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.
1872
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1873
	}
1874
1875
	/**
1876
	 * Check if Jetpack's REST API compat file should be included
1877
	 * @action plugins_loaded
1878
	 * @return null
1879
	 */
1880
	public function check_rest_api_compat() {
1881
		/**
1882
		 * Filters the list of REST API compat files to be included.
1883
		 *
1884
		 * @since 2.2.5
1885
		 *
1886
		 * @param array $args Array of REST API compat files to include.
1887
		 */
1888
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1889
1890
		if ( function_exists( 'bbpress' ) )
1891
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1892
1893
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1894
			require_once $_jetpack_rest_api_compat_include;
1895
	}
1896
1897
	/**
1898
	 * Gets all plugins currently active in values, regardless of whether they're
1899
	 * traditionally activated or network activated.
1900
	 *
1901
	 * @todo Store the result in core's object cache maybe?
0 ignored issues
show
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...
1902
	 */
1903
	public static function get_active_plugins() {
1904
		$active_plugins = (array) get_option( 'active_plugins', array() );
1905
1906
		if ( is_multisite() ) {
1907
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1908
			// whereas active_plugins stores them in the values.
1909
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1910
			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...
1911
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1912
			}
1913
		}
1914
1915
		sort( $active_plugins );
1916
1917
		return array_unique( $active_plugins );
1918
	}
1919
1920
	/**
1921
	 * Gets and parses additional plugin data to send with the heartbeat data
1922
	 *
1923
	 * @since 3.8.1
1924
	 *
1925
	 * @return array Array of plugin data
1926
	 */
1927
	public static function get_parsed_plugin_data() {
1928
		if ( ! function_exists( 'get_plugins' ) ) {
1929
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1930
		}
1931
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1932
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1933
		$active_plugins = Jetpack::get_active_plugins();
1934
1935
		$plugins = array();
1936
		foreach ( $all_plugins as $path => $plugin_data ) {
1937
			$plugins[ $path ] = array(
1938
					'is_active' => in_array( $path, $active_plugins ),
1939
					'file'      => $path,
1940
					'name'      => $plugin_data['Name'],
1941
					'version'   => $plugin_data['Version'],
1942
					'author'    => $plugin_data['Author'],
1943
			);
1944
		}
1945
1946
		return $plugins;
1947
	}
1948
1949
	/**
1950
	 * Gets and parses theme data to send with the heartbeat data
1951
	 *
1952
	 * @since 3.8.1
1953
	 *
1954
	 * @return array Array of theme data
1955
	 */
1956
	public static function get_parsed_theme_data() {
1957
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1958
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1959
1960
		$themes = array();
1961
		foreach ( $all_themes as $slug => $theme_data ) {
1962
			$theme_headers = array();
1963
			foreach ( $header_keys as $header_key ) {
1964
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1965
			}
1966
1967
			$themes[ $slug ] = array(
1968
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1969
					'slug' => $slug,
1970
					'theme_root' => $theme_data->get_theme_root_uri(),
1971
					'parent' => $theme_data->parent(),
1972
					'headers' => $theme_headers
1973
			);
1974
		}
1975
1976
		return $themes;
1977
	}
1978
1979
	/**
1980
	 * Checks whether a specific plugin is active.
1981
	 *
1982
	 * We don't want to store these in a static variable, in case
1983
	 * there are switch_to_blog() calls involved.
1984
	 */
1985
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1986
		return in_array( $plugin, self::get_active_plugins() );
1987
	}
1988
1989
	/**
1990
	 * Check if Jetpack's Open Graph tags should be used.
1991
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1992
	 *
1993
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1994
	 * @action plugins_loaded
1995
	 * @return null
1996
	 */
1997
	public function check_open_graph() {
1998
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1999
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2000
		}
2001
2002
		$active_plugins = self::get_active_plugins();
2003
2004
		if ( ! empty( $active_plugins ) ) {
2005
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2006
				if ( in_array( $plugin, $active_plugins ) ) {
2007
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2008
					break;
2009
				}
2010
			}
2011
		}
2012
2013
		/**
2014
		 * Allow the addition of Open Graph Meta Tags to all pages.
2015
		 *
2016
		 * @since 2.0.3
2017
		 *
2018
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2019
		 */
2020
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2021
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2022
		}
2023
	}
2024
2025
	/**
2026
	 * Check if Jetpack's Twitter tags should be used.
2027
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2028
	 *
2029
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2030
	 * @action plugins_loaded
2031
	 * @return null
2032
	 */
2033
	public function check_twitter_tags() {
2034
2035
		$active_plugins = self::get_active_plugins();
2036
2037
		if ( ! empty( $active_plugins ) ) {
2038
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2039
				if ( in_array( $plugin, $active_plugins ) ) {
2040
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2041
					break;
2042
				}
2043
			}
2044
		}
2045
2046
		/**
2047
		 * Allow Twitter Card Meta tags to be disabled.
2048
		 *
2049
		 * @since 2.6.0
2050
		 *
2051
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2052
		 */
2053
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2054
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2055
		}
2056
	}
2057
2058
	/**
2059
	 * Allows plugins to submit security reports.
2060
 	 *
2061
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2062
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2063
	 * @param array   $args         See definitions above
2064
	 */
2065
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2066
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2067
	}
2068
2069
/* Jetpack Options API */
2070
2071
	public static function get_option_names( $type = 'compact' ) {
2072
		return Jetpack_Options::get_option_names( $type );
2073
	}
2074
2075
	/**
2076
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2077
 	 *
2078
	 * @param string $name    Option name
2079
	 * @param mixed  $default (optional)
2080
	 */
2081
	public static function get_option( $name, $default = false ) {
2082
		return Jetpack_Options::get_option( $name, $default );
2083
	}
2084
2085
	/**
2086
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2087
 	 *
2088
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2089
	 * @param string $name  Option name
2090
	 * @param mixed  $value Option value
2091
	 */
2092
	public static function update_option( $name, $value ) {
2093
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2094
		return Jetpack_Options::update_option( $name, $value );
2095
	}
2096
2097
	/**
2098
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2099
 	 *
2100
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2101
	 * @param array $array array( option name => option value, ... )
2102
	 */
2103
	public static function update_options( $array ) {
2104
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2105
		return Jetpack_Options::update_options( $array );
2106
	}
2107
2108
	/**
2109
	 * Deletes the given option.  May be passed multiple option names as an array.
2110
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2111
	 *
2112
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2113
	 * @param string|array $names
2114
	 */
2115
	public static function delete_option( $names ) {
2116
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2117
		return Jetpack_Options::delete_option( $names );
2118
	}
2119
2120
	/**
2121
	 * Enters a user token into the user_tokens option
2122
	 *
2123
	 * @param int $user_id
2124
	 * @param string $token
2125
	 * return bool
2126
	 */
2127
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2128
		// not designed for concurrent updates
2129
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2130
		if ( ! is_array( $user_tokens ) )
2131
			$user_tokens = array();
2132
		$user_tokens[$user_id] = $token;
2133
		if ( $is_master_user ) {
2134
			$master_user = $user_id;
2135
			$options     = compact( 'user_tokens', 'master_user' );
2136
		} else {
2137
			$options = compact( 'user_tokens' );
2138
		}
2139
		return Jetpack_Options::update_options( $options );
2140
	}
2141
2142
	/**
2143
	 * Returns an array of all PHP files in the specified absolute path.
2144
	 * Equivalent to glob( "$absolute_path/*.php" ).
2145
	 *
2146
	 * @param string $absolute_path The absolute path of the directory to search.
2147
	 * @return array Array of absolute paths to the PHP files.
2148
	 */
2149
	public static function glob_php( $absolute_path ) {
2150
		if ( function_exists( 'glob' ) ) {
2151
			return glob( "$absolute_path/*.php" );
2152
		}
2153
2154
		$absolute_path = untrailingslashit( $absolute_path );
2155
		$files = array();
2156
		if ( ! $dir = @opendir( $absolute_path ) ) {
2157
			return $files;
2158
		}
2159
2160
		while ( false !== $file = readdir( $dir ) ) {
2161
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2162
				continue;
2163
			}
2164
2165
			$file = "$absolute_path/$file";
2166
2167
			if ( ! is_file( $file ) ) {
2168
				continue;
2169
			}
2170
2171
			$files[] = $file;
2172
		}
2173
2174
		closedir( $dir );
2175
2176
		return $files;
2177
	}
2178
2179
	public static function activate_new_modules( $redirect = false ) {
2180
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2181
			return;
2182
		}
2183
2184
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2185 View Code Duplication
		if ( ! $jetpack_old_version ) {
2186
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2187
			/** This action is documented in class.jetpack.php */
2188
			do_action( 'updating_jetpack_version', $version, false );
2189
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2190
		}
2191
2192
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2193
2194
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2195
			return;
2196
		}
2197
2198
		$active_modules     = Jetpack::get_active_modules();
2199
		$reactivate_modules = array();
2200
		foreach ( $active_modules as $active_module ) {
2201
			$module = Jetpack::get_module( $active_module );
2202
			if ( ! isset( $module['changed'] ) ) {
2203
				continue;
2204
			}
2205
2206
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2207
				continue;
2208
			}
2209
2210
			$reactivate_modules[] = $active_module;
2211
			Jetpack::deactivate_module( $active_module );
2212
		}
2213
2214
		$new_version = JETPACK__VERSION . ':' . time();
2215
		/** This action is documented in class.jetpack.php */
2216
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2217
		Jetpack_Options::update_options(
2218
			array(
2219
				'version'     => $new_version,
2220
				'old_version' => $jetpack_old_version,
2221
			)
2222
		);
2223
2224
		Jetpack::state( 'message', 'modules_activated' );
2225
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
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...
2226
2227
		if ( $redirect ) {
2228
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2229
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2230
				$page = $_GET['page'];
2231
			}
2232
2233
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2234
			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...
2235
		}
2236
	}
2237
2238
	/**
2239
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2240
	 * Make sure to tuck away module "library" files in a sub-directory.
2241
	 */
2242
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2243
		static $modules = null;
2244
2245
		if ( ! isset( $modules ) ) {
2246
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2247
			// Use the cache if we're on the front-end and it's available...
2248
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2249
				$modules = $available_modules_option[ JETPACK__VERSION ];
2250
			} else {
2251
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2252
2253
				$modules = array();
2254
2255
				foreach ( $files as $file ) {
2256
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2257
						continue;
2258
					}
2259
2260
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2261
				}
2262
2263
				Jetpack_Options::update_option( 'available_modules', array(
2264
					JETPACK__VERSION => $modules,
2265
				) );
2266
			}
2267
		}
2268
2269
		/**
2270
		 * Filters the array of modules available to be activated.
2271
		 *
2272
		 * @since 2.4.0
2273
		 *
2274
		 * @param array $modules Array of available modules.
2275
		 * @param string $min_version Minimum version number required to use modules.
2276
		 * @param string $max_version Maximum version number required to use modules.
2277
		 */
2278
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2279
2280
		if ( ! $min_version && ! $max_version ) {
2281
			return array_keys( $mods );
2282
		}
2283
2284
		$r = array();
2285
		foreach ( $mods as $slug => $introduced ) {
2286
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2287
				continue;
2288
			}
2289
2290
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2291
				continue;
2292
			}
2293
2294
			$r[] = $slug;
2295
		}
2296
2297
		return $r;
2298
	}
2299
2300
	/**
2301
	 * Default modules loaded on activation.
2302
	 */
2303
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2304
		$return = array();
2305
2306
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2307
			$module_data = Jetpack::get_module( $module );
2308
2309
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2310
				case 'yes' :
2311
					$return[] = $module;
2312
					break;
2313
				case 'public' :
2314
					if ( Jetpack_Options::get_option( 'public' ) ) {
2315
						$return[] = $module;
2316
					}
2317
					break;
2318
				case 'no' :
2319
				default :
0 ignored issues
show
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...
2320
					break;
2321
			}
2322
		}
2323
		/**
2324
		 * Filters the array of default modules.
2325
		 *
2326
		 * @since 2.5.0
2327
		 *
2328
		 * @param array $return Array of default modules.
2329
		 * @param string $min_version Minimum version number required to use modules.
2330
		 * @param string $max_version Maximum version number required to use modules.
2331
		 */
2332
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2333
	}
2334
2335
	/**
2336
	 * Checks activated modules during auto-activation to determine
2337
	 * if any of those modules are being deprecated.  If so, close
2338
	 * them out, and add any replacement modules.
2339
	 *
2340
	 * Runs at priority 99 by default.
2341
	 *
2342
	 * This is run late, so that it can still activate a module if
2343
	 * the new module is a replacement for another that the user
2344
	 * currently has active, even if something at the normal priority
2345
	 * would kibosh everything.
2346
	 *
2347
	 * @since 2.6
2348
	 * @uses jetpack_get_default_modules filter
2349
	 * @param array $modules
2350
	 * @return array
2351
	 */
2352
	function handle_deprecated_modules( $modules ) {
2353
		$deprecated_modules = array(
2354
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2355
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2356
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2357
		);
2358
2359
		// Don't activate SSO if they never completed activating WPCC.
2360
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2361
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2362
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2363
				$deprecated_modules['wpcc'] = null;
2364
			}
2365
		}
2366
2367
		foreach ( $deprecated_modules as $module => $replacement ) {
2368
			if ( Jetpack::is_module_active( $module ) ) {
2369
				self::deactivate_module( $module );
2370
				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...
2371
					$modules[] = $replacement;
2372
				}
2373
			}
2374
		}
2375
2376
		return array_unique( $modules );
2377
	}
2378
2379
	/**
2380
	 * Checks activated plugins during auto-activation to determine
2381
	 * if any of those plugins are in the list with a corresponding module
2382
	 * that is not compatible with the plugin. The module will not be allowed
2383
	 * to auto-activate.
2384
	 *
2385
	 * @since 2.6
2386
	 * @uses jetpack_get_default_modules filter
2387
	 * @param array $modules
2388
	 * @return array
2389
	 */
2390
	function filter_default_modules( $modules ) {
2391
2392
		$active_plugins = self::get_active_plugins();
2393
2394
		if ( ! empty( $active_plugins ) ) {
2395
2396
			// For each module we'd like to auto-activate...
2397
			foreach ( $modules as $key => $module ) {
2398
				// If there are potential conflicts for it...
2399
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2400
					// For each potential conflict...
2401
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2402
						// If that conflicting plugin is active...
2403
						if ( in_array( $plugin, $active_plugins ) ) {
2404
							// Remove that item from being auto-activated.
2405
							unset( $modules[ $key ] );
2406
						}
2407
					}
2408
				}
2409
			}
2410
		}
2411
2412
		return $modules;
2413
	}
2414
2415
	/**
2416
	 * Extract a module's slug from its full path.
2417
	 */
2418
	public static function get_module_slug( $file ) {
2419
		return str_replace( '.php', '', basename( $file ) );
2420
	}
2421
2422
	/**
2423
	 * Generate a module's path from its slug.
2424
	 */
2425
	public static function get_module_path( $slug ) {
2426
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2427
	}
2428
2429
	/**
2430
	 * Load module data from module file. Headers differ from WordPress
2431
	 * plugin headers to avoid them being identified as standalone
2432
	 * plugins on the WordPress plugins page.
2433
	 */
2434
	public static function get_module( $module ) {
2435
		$headers = array(
2436
			'name'                      => 'Module Name',
2437
			'description'               => 'Module Description',
2438
			'jumpstart_desc'            => 'Jumpstart Description',
2439
			'sort'                      => 'Sort Order',
2440
			'recommendation_order'      => 'Recommendation Order',
2441
			'introduced'                => 'First Introduced',
2442
			'changed'                   => 'Major Changes In',
2443
			'deactivate'                => 'Deactivate',
2444
			'free'                      => 'Free',
2445
			'requires_connection'       => 'Requires Connection',
2446
			'auto_activate'             => 'Auto Activate',
2447
			'module_tags'               => 'Module Tags',
2448
			'feature'                   => 'Feature',
2449
			'additional_search_queries' => 'Additional Search Queries',
2450
			'plan_classes'              => 'Plans',
2451
		);
2452
2453
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2454
2455
		$mod = Jetpack::get_file_data( $file, $headers );
2456
		if ( empty( $mod['name'] ) ) {
2457
			return false;
2458
		}
2459
2460
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2461
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2462
		$mod['deactivate']              = empty( $mod['deactivate'] );
2463
		$mod['free']                    = empty( $mod['free'] );
2464
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2465
2466
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2467
			$mod['auto_activate'] = 'No';
2468
		} else {
2469
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2470
		}
2471
2472
		if ( $mod['module_tags'] ) {
2473
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2474
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2475
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2476
		} else {
2477
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2478
		}
2479
2480 View Code Duplication
		if ( $mod['plan_classes'] ) {
2481
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2482
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2483
		} else {
2484
			$mod['plan_classes'] = array( 'free' );
2485
		}
2486
2487 View Code Duplication
		if ( $mod['feature'] ) {
2488
			$mod['feature'] = explode( ',', $mod['feature'] );
2489
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2490
		} else {
2491
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2492
		}
2493
2494
		/**
2495
		 * Filters the feature array on a module.
2496
		 *
2497
		 * This filter allows you to control where each module is filtered: Recommended,
2498
		 * Jumpstart, and the default "Other" listing.
2499
		 *
2500
		 * @since 3.5.0
2501
		 *
2502
		 * @param array   $mod['feature'] The areas to feature this module:
2503
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2504
		 *     'Recommended' shows on the main Jetpack admin screen.
2505
		 *     'Other' should be the default if no other value is in the array.
2506
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2507
		 * @param array   $mod All the currently assembled module data.
2508
		 */
2509
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2510
2511
		/**
2512
		 * Filter the returned data about a module.
2513
		 *
2514
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2515
		 * so please be careful.
2516
		 *
2517
		 * @since 3.6.0
2518
		 *
2519
		 * @param array   $mod    The details of the requested module.
2520
		 * @param string  $module The slug of the module, e.g. sharedaddy
2521
		 * @param string  $file   The path to the module source file.
2522
		 */
2523
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2524
	}
2525
2526
	/**
2527
	 * Like core's get_file_data implementation, but caches the result.
2528
	 */
2529
	public static function get_file_data( $file, $headers ) {
2530
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2531
		$file_name = basename( $file );
2532
2533
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2534
2535
		$file_data_option = get_transient( $cache_key );
2536
2537
		if ( false === $file_data_option ) {
2538
			$file_data_option = array();
2539
		}
2540
2541
		$key           = md5( $file_name . serialize( $headers ) );
2542
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2543
2544
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2545
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2546
			return $file_data_option[ $key ];
2547
		}
2548
2549
		$data = get_file_data( $file, $headers );
2550
2551
		$file_data_option[ $key ] = $data;
2552
2553
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2554
2555
		return $data;
2556
	}
2557
2558
2559
	/**
2560
	 * Return translated module tag.
2561
	 *
2562
	 * @param string $tag Tag as it appears in each module heading.
2563
	 *
2564
	 * @return mixed
2565
	 */
2566
	public static function translate_module_tag( $tag ) {
2567
		return jetpack_get_module_i18n_tag( $tag );
2568
	}
2569
2570
	/**
2571
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2572
	 *
2573
	 * @since 3.9.2
2574
	 *
2575
	 * @param array $modules
2576
	 *
2577
	 * @return string|void
2578
	 */
2579
	public static function get_translated_modules( $modules ) {
2580
		foreach ( $modules as $index => $module ) {
2581
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2582
			if ( isset( $module['name'] ) ) {
2583
				$modules[ $index ]['name'] = $i18n_module['name'];
2584
			}
2585
			if ( isset( $module['description'] ) ) {
2586
				$modules[ $index ]['description'] = $i18n_module['description'];
2587
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2588
			}
2589
		}
2590
		return $modules;
2591
	}
2592
2593
	/**
2594
	 * Get a list of activated modules as an array of module slugs.
2595
	 */
2596
	public static function get_active_modules() {
2597
		$active = Jetpack_Options::get_option( 'active_modules' );
2598
2599
		if ( ! is_array( $active ) ) {
2600
			$active = array();
2601
		}
2602
2603
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2604
			$active[] = 'vaultpress';
2605
		} else {
2606
			$active = array_diff( $active, array( 'vaultpress' ) );
2607
		}
2608
2609
		//If protect is active on the main site of a multisite, it should be active on all sites.
2610
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2611
			$active[] = 'protect';
2612
		}
2613
2614
		/**
2615
		 * Allow filtering of the active modules.
2616
		 *
2617
		 * Gives theme and plugin developers the power to alter the modules that
2618
		 * are activated on the fly.
2619
		 *
2620
		 * @since 5.8.0
2621
		 *
2622
		 * @param array $active Array of active module slugs.
2623
		 */
2624
		$active = apply_filters( 'jetpack_active_modules', $active );
2625
2626
		return array_unique( $active );
2627
	}
2628
2629
	/**
2630
	 * Check whether or not a Jetpack module is active.
2631
	 *
2632
	 * @param string $module The slug of a Jetpack module.
2633
	 * @return bool
2634
	 *
2635
	 * @static
2636
	 */
2637
	public static function is_module_active( $module ) {
2638
		return in_array( $module, self::get_active_modules() );
2639
	}
2640
2641
	public static function is_module( $module ) {
2642
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2643
	}
2644
2645
	/**
2646
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2647
	 *
2648
	 * @param bool $catch True to start catching, False to stop.
2649
	 *
2650
	 * @static
2651
	 */
2652
	public static function catch_errors( $catch ) {
2653
		static $display_errors, $error_reporting;
2654
2655
		if ( $catch ) {
2656
			$display_errors  = @ini_set( 'display_errors', 1 );
2657
			$error_reporting = @error_reporting( E_ALL );
2658
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2659
		} else {
2660
			@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...
2661
			@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...
2662
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2663
		}
2664
	}
2665
2666
	/**
2667
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2668
	 */
2669
	public static function catch_errors_on_shutdown() {
2670
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2671
	}
2672
2673
	/**
2674
	 * Rewrite any string to make paths easier to read.
2675
	 *
2676
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2677
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2678
	 *
2679
	 * @param $string
2680
	 * @return mixed
2681
	 */
2682
	public static function alias_directories( $string ) {
2683
		// ABSPATH has a trailing slash.
2684
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2685
		// WP_CONTENT_DIR does not have a trailing slash.
2686
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2687
2688
		return $string;
2689
	}
2690
2691
	public static function activate_default_modules(
2692
		$min_version = false,
2693
		$max_version = false,
2694
		$other_modules = array(),
2695
		$redirect = true,
2696
		$send_state_messages = true
2697
	) {
2698
		$jetpack = Jetpack::init();
2699
2700
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2701
		$modules = array_merge( $other_modules, $modules );
2702
2703
		// Look for standalone plugins and disable if active.
2704
2705
		$to_deactivate = array();
2706
		foreach ( $modules as $module ) {
2707
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2708
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2709
			}
2710
		}
2711
2712
		$deactivated = array();
2713
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2714
			list( $probable_file, $probable_title ) = $deactivate_me;
2715
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2716
				$deactivated[] = $module;
2717
			}
2718
		}
2719
2720
		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...
2721
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2722
2723
			$url = add_query_arg(
2724
				array(
2725
					'action'   => 'activate_default_modules',
2726
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2727
				),
2728
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2729
			);
2730
			wp_safe_redirect( $url );
2731
			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...
2732
		}
2733
2734
		/**
2735
		 * Fires before default modules are activated.
2736
		 *
2737
		 * @since 1.9.0
2738
		 *
2739
		 * @param string $min_version Minimum version number required to use modules.
2740
		 * @param string $max_version Maximum version number required to use modules.
2741
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2742
		 */
2743
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2744
2745
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2746
		Jetpack::restate();
2747
		Jetpack::catch_errors( true );
2748
2749
		$active = Jetpack::get_active_modules();
2750
2751
		foreach ( $modules as $module ) {
2752
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2753
				$active[] = $module;
2754
				self::update_active_modules( $active );
2755
				continue;
2756
			}
2757
2758
			if ( $send_state_messages && in_array( $module, $active ) ) {
2759
				$module_info = Jetpack::get_module( $module );
2760 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2761
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2762
					if ( $active_state = Jetpack::state( $state ) ) {
2763
						$active_state = explode( ',', $active_state );
2764
					} else {
2765
						$active_state = array();
2766
					}
2767
					$active_state[] = $module;
2768
					Jetpack::state( $state, implode( ',', $active_state ) );
2769
				}
2770
				continue;
2771
			}
2772
2773
			$file = Jetpack::get_module_path( $module );
2774
			if ( ! file_exists( $file ) ) {
2775
				continue;
2776
			}
2777
2778
			// we'll override this later if the plugin can be included without fatal error
2779
			if ( $redirect ) {
2780
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2781
			}
2782
2783
			if ( $send_state_messages ) {
2784
				Jetpack::state( 'error', 'module_activation_failed' );
2785
				Jetpack::state( 'module', $module );
2786
			}
2787
2788
			ob_start();
2789
			require $file;
2790
2791
			$active[] = $module;
2792
2793 View Code Duplication
			if ( $send_state_messages ) {
2794
2795
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
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...
2796
				if ( $active_state = Jetpack::state( $state ) ) {
2797
					$active_state = explode( ',', $active_state );
2798
				} else {
2799
					$active_state = array();
2800
				}
2801
				$active_state[] = $module;
2802
				Jetpack::state( $state, implode( ',', $active_state ) );
2803
			}
2804
2805
			Jetpack::update_active_modules( $active );
2806
2807
			ob_end_clean();
2808
		}
2809
2810
		if ( $send_state_messages ) {
2811
			Jetpack::state( 'error', false );
0 ignored issues
show
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...
2812
			Jetpack::state( 'module', false );
0 ignored issues
show
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...
2813
		}
2814
2815
		Jetpack::catch_errors( false );
2816
		/**
2817
		 * Fires when default modules are activated.
2818
		 *
2819
		 * @since 1.9.0
2820
		 *
2821
		 * @param string $min_version Minimum version number required to use modules.
2822
		 * @param string $max_version Maximum version number required to use modules.
2823
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2824
		 */
2825
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2826
	}
2827
2828
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2829
		/**
2830
		 * Fires before a module is activated.
2831
		 *
2832
		 * @since 2.6.0
2833
		 *
2834
		 * @param string $module Module slug.
2835
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2836
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2837
		 */
2838
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2839
2840
		$jetpack = Jetpack::init();
2841
2842
		if ( ! strlen( $module ) )
2843
			return false;
2844
2845
		if ( ! Jetpack::is_module( $module ) )
2846
			return false;
2847
2848
		// If it's already active, then don't do it again
2849
		$active = Jetpack::get_active_modules();
2850
		foreach ( $active as $act ) {
2851
			if ( $act == $module )
2852
				return true;
2853
		}
2854
2855
		$module_data = Jetpack::get_module( $module );
2856
2857
		if ( ! Jetpack::is_active() ) {
2858
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2859
				return false;
2860
2861
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2862
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2863
				return false;
2864
		}
2865
2866
		// Check and see if the old plugin is active
2867
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2868
			// Deactivate the old plugin
2869
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2870
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2871
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2872
				Jetpack::state( 'deactivated_plugins', $module );
2873
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2874
				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...
2875
			}
2876
		}
2877
2878
		// Protect won't work with mis-configured IPs
2879
		if ( 'protect' === $module ) {
2880
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2881
			if ( ! jetpack_protect_get_ip() ) {
2882
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2883
				return false;
2884
			}
2885
		}
2886
2887
		$plan = Jetpack::get_active_plan();
2888
2889
		if ( ! in_array( $module, $plan['supports'] ) ) {
2890
			return false;
2891
		}
2892
2893
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2894
		Jetpack::state( 'module', $module );
2895
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2896
2897
		Jetpack::catch_errors( true );
2898
		ob_start();
2899
		require Jetpack::get_module_path( $module );
2900
		/** This action is documented in class.jetpack.php */
2901
		do_action( 'jetpack_activate_module', $module );
2902
		$active[] = $module;
2903
		Jetpack::update_active_modules( $active );
2904
2905
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
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...
2906
		ob_end_clean();
2907
		Jetpack::catch_errors( false );
2908
2909
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2910 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2911
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2912
2913
			//Jump start is being dismissed send data to MC Stats
2914
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2915
2916
			$jetpack->do_stats( 'server_side' );
2917
		}
2918
2919
		if ( $redirect ) {
2920
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2921
		}
2922
		if ( $exit ) {
2923
			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...
2924
		}
2925
		return true;
2926
	}
2927
2928
	function activate_module_actions( $module ) {
2929
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2930
	}
2931
2932
	public static function deactivate_module( $module ) {
2933
		/**
2934
		 * Fires when a module is deactivated.
2935
		 *
2936
		 * @since 1.9.0
2937
		 *
2938
		 * @param string $module Module slug.
2939
		 */
2940
		do_action( 'jetpack_pre_deactivate_module', $module );
2941
2942
		$jetpack = Jetpack::init();
2943
2944
		$active = Jetpack::get_active_modules();
2945
		$new    = array_filter( array_diff( $active, (array) $module ) );
2946
2947
		// A flag for Jump Start so it's not shown again.
2948 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2949
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2950
2951
			//Jump start is being dismissed send data to MC Stats
2952
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2953
2954
			$jetpack->do_stats( 'server_side' );
2955
		}
2956
2957
		return self::update_active_modules( $new );
2958
	}
2959
2960
	public static function enable_module_configurable( $module ) {
2961
		$module = Jetpack::get_module_slug( $module );
2962
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2963
	}
2964
2965
	public static function module_configuration_url( $module ) {
2966
		$module = Jetpack::get_module_slug( $module );
2967
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2968
	}
2969
2970
	public static function module_configuration_load( $module, $method ) {
2971
		$module = Jetpack::get_module_slug( $module );
2972
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2973
	}
2974
2975
	public static function module_configuration_head( $module, $method ) {
2976
		$module = Jetpack::get_module_slug( $module );
2977
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2978
	}
2979
2980
	public static function module_configuration_screen( $module, $method ) {
2981
		$module = Jetpack::get_module_slug( $module );
2982
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2983
	}
2984
2985
	public static function module_configuration_activation_screen( $module, $method ) {
2986
		$module = Jetpack::get_module_slug( $module );
2987
		add_action( 'display_activate_module_setting_' . $module, $method );
2988
	}
2989
2990
/* Installation */
2991
2992
	public static function bail_on_activation( $message, $deactivate = true ) {
2993
?>
2994
<!doctype html>
2995
<html>
2996
<head>
2997
<meta charset="<?php bloginfo( 'charset' ); ?>">
2998
<style>
2999
* {
3000
	text-align: center;
3001
	margin: 0;
3002
	padding: 0;
3003
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3004
}
3005
p {
3006
	margin-top: 1em;
3007
	font-size: 18px;
3008
}
3009
</style>
3010
<body>
3011
<p><?php echo esc_html( $message ); ?></p>
3012
</body>
3013
</html>
3014
<?php
3015
		if ( $deactivate ) {
3016
			$plugins = get_option( 'active_plugins' );
3017
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3018
			$update  = false;
3019
			foreach ( $plugins as $i => $plugin ) {
3020
				if ( $plugin === $jetpack ) {
3021
					$plugins[$i] = false;
3022
					$update = true;
3023
				}
3024
			}
3025
3026
			if ( $update ) {
3027
				update_option( 'active_plugins', array_filter( $plugins ) );
3028
			}
3029
		}
3030
		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...
3031
	}
3032
3033
	/**
3034
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3035
	 * @static
3036
	 */
3037
	public static function plugin_activation( $network_wide ) {
3038
		Jetpack_Options::update_option( 'activated', 1 );
3039
3040
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3041
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3042
		}
3043
3044
		if ( $network_wide )
3045
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
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...
3046
3047
		// For firing one-off events (notices) immediately after activation
3048
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3049
3050
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3051
3052
		Jetpack::plugin_initialize();
3053
	}
3054
3055
	public static function get_activation_source( $referer_url ) {
3056
3057
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3058
			return array( 'wp-cli', null );
3059
		}
3060
3061
		$referer = parse_url( $referer_url );
3062
3063
		$source_type = 'unknown';
3064
		$source_query = null;
3065
3066
		if ( ! is_array( $referer ) ) {
3067
			return array( $source_type, $source_query );
3068
		}
3069
3070
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3071
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3072
3073
		if ( isset( $referer['query'] ) ) {
3074
			parse_str( $referer['query'], $query_parts );
3075
		} else {
3076
			$query_parts = array();
3077
		}
3078
3079
		if ( $plugins_path === $referer['path'] ) {
3080
			$source_type = 'list';
3081
		} elseif ( $plugins_install_path === $referer['path'] ) {
3082
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3083
			switch( $tab ) {
3084
				case 'popular':
3085
					$source_type = 'popular';
3086
					break;
3087
				case 'recommended':
3088
					$source_type = 'recommended';
3089
					break;
3090
				case 'favorites':
3091
					$source_type = 'favorites';
3092
					break;
3093
				case 'search':
3094
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3095
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3096
					break;
3097
				default:
3098
					$source_type = 'featured';
3099
			}
3100
		}
3101
3102
		return array( $source_type, $source_query );
3103
	}
3104
3105
	/**
3106
	 * Runs before bumping version numbers up to a new version
3107
	 * @param  string $version    Version:timestamp
3108
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3109
	 * @return null              [description]
3110
	 */
3111
	public static function do_version_bump( $version, $old_version ) {
3112
3113
		if ( ! $old_version ) { // For new sites
3114
			// Setting up jetpack manage
3115
			Jetpack::activate_manage();
3116
		}
3117
	}
3118
3119
	/**
3120
	 * Sets the internal version number and activation state.
3121
	 * @static
3122
	 */
3123
	public static function plugin_initialize() {
3124
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3125
			Jetpack_Options::update_option( 'activated', 2 );
3126
		}
3127
3128 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3129
			$version = $old_version = JETPACK__VERSION . ':' . time();
3130
			/** This action is documented in class.jetpack.php */
3131
			do_action( 'updating_jetpack_version', $version, false );
3132
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3133
		}
3134
3135
		Jetpack::load_modules();
3136
3137
		Jetpack_Options::delete_option( 'do_activate' );
3138
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3139
	}
3140
3141
	/**
3142
	 * Removes all connection options
3143
	 * @static
3144
	 */
3145
	public static function plugin_deactivation( ) {
3146
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3147
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3148
			Jetpack_Network::init()->deactivate();
3149
		} else {
3150
			Jetpack::disconnect( false );
3151
			//Jetpack_Heartbeat::init()->deactivate();
3152
		}
3153
	}
3154
3155
	/**
3156
	 * Disconnects from the Jetpack servers.
3157
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3158
	 * @static
3159
	 */
3160
	public static function disconnect( $update_activated_state = true ) {
3161
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3162
		Jetpack::clean_nonces( true );
3163
3164
		// If the site is in an IDC because sync is not allowed,
3165
		// let's make sure to not disconnect the production site.
3166
		if ( ! self::validate_sync_error_idc_option() ) {
3167
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3168
			Jetpack::load_xml_rpc_client();
3169
			$xml = new Jetpack_IXR_Client();
3170
			$xml->query( 'jetpack.deregister' );
3171
		}
3172
3173
		Jetpack_Options::delete_option(
3174
			array(
3175
				'blog_token',
3176
				'user_token',
3177
				'user_tokens',
3178
				'master_user',
3179
				'time_diff',
3180
				'fallback_no_verify_ssl_certs',
3181
			)
3182
		);
3183
3184
		Jetpack_IDC::clear_all_idc_options();
3185
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3186
3187
		if ( $update_activated_state ) {
3188
			Jetpack_Options::update_option( 'activated', 4 );
3189
		}
3190
3191
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3192
			// Check then record unique disconnection if site has never been disconnected previously
3193
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3194
				$jetpack_unique_connection['disconnected'] = 1;
3195
			} else {
3196
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3197
					//track unique disconnect
3198
					$jetpack = Jetpack::init();
3199
3200
					$jetpack->stat( 'connections', 'unique-disconnect' );
3201
					$jetpack->do_stats( 'server_side' );
3202
				}
3203
				// increment number of times disconnected
3204
				$jetpack_unique_connection['disconnected'] += 1;
3205
			}
3206
3207
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3208
		}
3209
3210
		// Delete cached connected user data
3211
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3212
		delete_transient( $transient_key );
3213
3214
		// Delete all the sync related data. Since it could be taking up space.
3215
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3216
		Jetpack_Sync_Sender::get_instance()->uninstall();
3217
3218
		// Disable the Heartbeat cron
3219
		Jetpack_Heartbeat::init()->deactivate();
3220
	}
3221
3222
	/**
3223
	 * Unlinks the current user from the linked WordPress.com user
3224
	 */
3225
	public static function unlink_user( $user_id = null ) {
3226
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3227
			return false;
3228
3229
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3230
3231
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3232
			return false;
3233
3234
		if ( ! isset( $tokens[ $user_id ] ) )
3235
			return false;
3236
3237
		Jetpack::load_xml_rpc_client();
3238
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3239
		$xml->query( 'jetpack.unlink_user', $user_id );
3240
3241
		unset( $tokens[ $user_id ] );
3242
3243
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3244
3245
		/**
3246
		 * Fires after the current user has been unlinked from WordPress.com.
3247
		 *
3248
		 * @since 4.1.0
3249
		 *
3250
		 * @param int $user_id The current user's ID.
3251
		 */
3252
		do_action( 'jetpack_unlinked_user', $user_id );
3253
3254
		return true;
3255
	}
3256
3257
	/**
3258
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3259
	 */
3260
	public static function try_registration() {
3261
		// The user has agreed to the TOS at some point by now.
3262
		Jetpack_Options::update_option( 'tos_agreed', true );
3263
3264
		// Let's get some testing in beta versions and such.
3265
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3266
			// Before attempting to connect, let's make sure that the domains are viable.
3267
			$domains_to_check = array_unique( array(
3268
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3269
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3270
			) );
3271
			foreach ( $domains_to_check as $domain ) {
3272
				$result = Jetpack_Data::is_usable_domain( $domain );
3273
				if ( is_wp_error( $result ) ) {
3274
					return $result;
3275
				}
3276
			}
3277
		}
3278
3279
		$result = Jetpack::register();
3280
3281
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3282
		if ( ! $result || is_wp_error( $result ) ) {
3283
			return $result;
3284
		} else {
3285
			return true;
3286
		}
3287
	}
3288
3289
	/**
3290
	 * Tracking an internal event log. Try not to put too much chaff in here.
3291
	 *
3292
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3293
	 */
3294
	public static function log( $code, $data = null ) {
3295
		// only grab the latest 200 entries
3296
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3297
3298
		// Append our event to the log
3299
		$log_entry = array(
3300
			'time'    => time(),
3301
			'user_id' => get_current_user_id(),
3302
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3303
			'code'    => $code,
3304
		);
3305
		// Don't bother storing it unless we've got some.
3306
		if ( ! is_null( $data ) ) {
3307
			$log_entry['data'] = $data;
3308
		}
3309
		$log[] = $log_entry;
3310
3311
		// Try add_option first, to make sure it's not autoloaded.
3312
		// @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...
3313
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3314
			Jetpack_Options::update_option( 'log', $log );
3315
		}
3316
3317
		/**
3318
		 * Fires when Jetpack logs an internal event.
3319
		 *
3320
		 * @since 3.0.0
3321
		 *
3322
		 * @param array $log_entry {
3323
		 *	Array of details about the log entry.
3324
		 *
3325
		 *	@param string time Time of the event.
3326
		 *	@param int user_id ID of the user who trigerred the event.
3327
		 *	@param int blog_id Jetpack Blog ID.
3328
		 *	@param string code Unique name for the event.
3329
		 *	@param string data Data about the event.
3330
		 * }
3331
		 */
3332
		do_action( 'jetpack_log_entry', $log_entry );
3333
	}
3334
3335
	/**
3336
	 * Get the internal event log.
3337
	 *
3338
	 * @param $event (string) - only return the specific log events
3339
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3340
	 *
3341
	 * @return array of log events || WP_Error for invalid params
3342
	 */
3343
	public static function get_log( $event = false, $num = false ) {
3344
		if ( $event && ! is_string( $event ) ) {
3345
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3346
		}
3347
3348
		if ( $num && ! is_numeric( $num ) ) {
3349
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3350
		}
3351
3352
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3353
3354
		// If nothing set - act as it did before, otherwise let's start customizing the output
3355
		if ( ! $num && ! $event ) {
3356
			return $entire_log;
3357
		} else {
3358
			$entire_log = array_reverse( $entire_log );
3359
		}
3360
3361
		$custom_log_output = array();
3362
3363
		if ( $event ) {
3364
			foreach ( $entire_log as $log_event ) {
3365
				if ( $event == $log_event[ 'code' ] ) {
3366
					$custom_log_output[] = $log_event;
3367
				}
3368
			}
3369
		} else {
3370
			$custom_log_output = $entire_log;
3371
		}
3372
3373
		if ( $num ) {
3374
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3375
		}
3376
3377
		return $custom_log_output;
3378
	}
3379
3380
	/**
3381
	 * Log modification of important settings.
3382
	 */
3383
	public static function log_settings_change( $option, $old_value, $value ) {
3384
		switch( $option ) {
3385
			case 'jetpack_sync_non_public_post_stati':
3386
				self::log( $option, $value );
3387
				break;
3388
		}
3389
	}
3390
3391
	/**
3392
	 * Return stat data for WPCOM sync
3393
	 */
3394
	public static function get_stat_data( $encode = true, $extended = true ) {
3395
		$data = Jetpack_Heartbeat::generate_stats_array();
3396
3397
		if ( $extended ) {
3398
			$additional_data = self::get_additional_stat_data();
3399
			$data = array_merge( $data, $additional_data );
3400
		}
3401
3402
		if ( $encode ) {
3403
			return json_encode( $data );
3404
		}
3405
3406
		return $data;
3407
	}
3408
3409
	/**
3410
	 * Get additional stat data to sync to WPCOM
3411
	 */
3412
	public static function get_additional_stat_data( $prefix = '' ) {
3413
		$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...
3414
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3415
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3416
		$return["{$prefix}site-count"]     = 0;
3417
3418
		if ( function_exists( 'get_blog_count' ) ) {
3419
			$return["{$prefix}site-count"] = get_blog_count();
3420
		}
3421
		return $return;
3422
	}
3423
3424
	private static function get_site_user_count() {
3425
		global $wpdb;
3426
3427
		if ( function_exists( 'wp_is_large_network' ) ) {
3428
			if ( wp_is_large_network( 'users' ) ) {
3429
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3430
			}
3431
		}
3432 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3433
			// It wasn't there, so regenerate the data and save the transient
3434
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3435
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3436
		}
3437
		return $user_count;
3438
	}
3439
3440
	/* Admin Pages */
3441
3442
	function admin_init() {
3443
		// If the plugin is not connected, display a connect message.
3444
		if (
3445
			// the plugin was auto-activated and needs its candy
3446
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3447
		||
3448
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3449
			! Jetpack_Options::get_option( 'activated' )
3450
		) {
3451
			Jetpack::plugin_initialize();
3452
		}
3453
3454
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3455
			Jetpack_Connection_Banner::init();
3456
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3457
			// Upgrade: 1.1 -> 1.1.1
3458
			// Check and see if host can verify the Jetpack servers' SSL certificate
3459
			$args = array();
3460
			Jetpack_Client::_wp_remote_request(
3461
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3462
				$args,
3463
				true
3464
			);
3465
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3466
			// Show the notice on the Dashboard only for now
3467
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3468
		}
3469
3470
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3471
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3472
		}
3473
3474
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3475
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3476
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3477
3478
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3479
			// Artificially throw errors in certain whitelisted cases during plugin activation
3480
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3481
		}
3482
3483
		// Jetpack Manage Activation Screen from .com
3484
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3485
3486
		// Add custom column in wp-admin/users.php to show whether user is linked.
3487
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3488
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3489
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3490
	}
3491
3492
	function admin_body_class( $admin_body_class = '' ) {
3493
		$classes = explode( ' ', trim( $admin_body_class ) );
3494
3495
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3496
3497
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3498
		return " $admin_body_class ";
3499
	}
3500
3501
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3502
		return $admin_body_class . ' jetpack-pagestyles ';
3503
	}
3504
3505
	/**
3506
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3507
	 *
3508
	 * @return null
3509
	 */
3510
	function prepare_manage_jetpack_notice() {
3511
3512
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3513
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3514
	}
3515
3516
	function manage_activate_screen() {
3517
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3518
	}
3519
	/**
3520
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3521
	 * This function artificially throws errors for such cases (whitelisted).
3522
	 *
3523
	 * @param string $plugin The activated plugin.
3524
	 */
3525
	function throw_error_on_activate_plugin( $plugin ) {
3526
		$active_modules = Jetpack::get_active_modules();
3527
3528
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3529
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3530
			$throw = false;
3531
3532
			// Try and make sure it really was the stats plugin
3533
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3534
				if ( 'stats.php' == basename( $plugin ) ) {
3535
					$throw = true;
3536
				}
3537
			} else {
3538
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3539
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3540
					$throw = true;
3541
				}
3542
			}
3543
3544
			if ( $throw ) {
3545
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3546
			}
3547
		}
3548
	}
3549
3550
	function intercept_plugin_error_scrape_init() {
3551
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3552
	}
3553
3554
	function intercept_plugin_error_scrape( $action, $result ) {
3555
		if ( ! $result ) {
3556
			return;
3557
		}
3558
3559
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3560
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3561
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3562
			}
3563
		}
3564
	}
3565
3566
	function add_remote_request_handlers() {
3567
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3568
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3569
	}
3570
3571
	function remote_request_handlers() {
3572
		$action = current_filter();
0 ignored issues
show
$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...
3573
3574
		switch ( current_filter() ) {
3575
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3576
			$response = $this->upload_handler();
3577
			break;
3578
3579
		case 'wp_ajax_nopriv_jetpack_update_file' :
3580
			$response = $this->upload_handler( true );
3581
			break;
3582
		default :
0 ignored issues
show
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...
3583
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3584
			break;
3585
		}
3586
3587
		if ( ! $response ) {
3588
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3589
		}
3590
3591
		if ( is_wp_error( $response ) ) {
3592
			$status_code       = $response->get_error_data();
3593
			$error             = $response->get_error_code();
3594
			$error_description = $response->get_error_message();
3595
3596
			if ( ! is_int( $status_code ) ) {
3597
				$status_code = 400;
3598
			}
3599
3600
			status_header( $status_code );
3601
			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...
3602
		}
3603
3604
		status_header( 200 );
3605
		if ( true === $response ) {
3606
			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...
3607
		}
3608
3609
		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...
3610
	}
3611
3612
	/**
3613
	 * Uploads a file gotten from the global $_FILES.
3614
	 * If `$update_media_item` is true and `post_id` is defined
3615
	 * the attachment file of the media item (gotten through of the post_id)
3616
	 * will be updated instead of add a new one.
3617
	 *
3618
	 * @param  boolean $update_media_item - update media attachment
3619
	 * @return array - An array describing the uploadind files process
3620
	 */
3621
	function upload_handler( $update_media_item = false ) {
3622
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3623
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3624
		}
3625
3626
		$user = wp_authenticate( '', '' );
3627
		if ( ! $user || is_wp_error( $user ) ) {
3628
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3629
		}
3630
3631
		wp_set_current_user( $user->ID );
3632
3633
		if ( ! current_user_can( 'upload_files' ) ) {
3634
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3635
		}
3636
3637
		if ( empty( $_FILES ) ) {
3638
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3639
		}
3640
3641
		foreach ( array_keys( $_FILES ) as $files_key ) {
3642
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3643
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3644
			}
3645
		}
3646
3647
		$media_keys = array_keys( $_FILES['media'] );
3648
3649
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3650
		if ( ! $token || is_wp_error( $token ) ) {
3651
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3652
		}
3653
3654
		$uploaded_files = array();
3655
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3656
		unset( $GLOBALS['post'] );
3657
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3658
			$file = array();
3659
			foreach ( $media_keys as $media_key ) {
3660
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3661
			}
3662
3663
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3664
3665
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3666
			if ( $hmac_provided !== $hmac_file ) {
3667
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3668
				continue;
3669
			}
3670
3671
			$_FILES['.jetpack.upload.'] = $file;
3672
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3673
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3674
				$post_id = 0;
3675
			}
3676
3677
			if ( $update_media_item ) {
3678
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3679
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3680
				}
3681
3682
				$media_array = $_FILES['media'];
3683
3684
				$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...
3685
				$file_array['type'] = $media_array['type'][0];
3686
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3687
				$file_array['error'] = $media_array['error'][0];
3688
				$file_array['size'] = $media_array['size'][0];
3689
3690
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3691
3692
				if ( is_wp_error( $edited_media_item ) ) {
3693
					return $edited_media_item;
3694
				}
3695
3696
				$response = (object) array(
3697
					'id'   => (string) $post_id,
3698
					'file' => (string) $edited_media_item->post_title,
3699
					'url'  => (string) wp_get_attachment_url( $post_id ),
3700
					'type' => (string) $edited_media_item->post_mime_type,
3701
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3702
				);
3703
3704
				return (array) array( $response );
3705
			}
3706
3707
			$attachment_id = media_handle_upload(
3708
				'.jetpack.upload.',
3709
				$post_id,
3710
				array(),
3711
				array(
3712
					'action' => 'jetpack_upload_file',
3713
				)
3714
			);
3715
3716
			if ( ! $attachment_id ) {
3717
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3718
			} elseif ( is_wp_error( $attachment_id ) ) {
3719
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3720
			} else {
3721
				$attachment = get_post( $attachment_id );
3722
				$uploaded_files[$index] = (object) array(
3723
					'id'   => (string) $attachment_id,
3724
					'file' => $attachment->post_title,
3725
					'url'  => wp_get_attachment_url( $attachment_id ),
3726
					'type' => $attachment->post_mime_type,
3727
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3728
				);
3729
				// Zip files uploads are not supported unless they are done for installation purposed
3730
				// lets delete them in case something goes wrong in this whole process
3731
				if ( 'application/zip' === $attachment->post_mime_type ) {
3732
					// Schedule a cleanup for 2 hours from now in case of failed install.
3733
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3734
				}
3735
			}
3736
		}
3737
		if ( ! is_null( $global_post ) ) {
3738
			$GLOBALS['post'] = $global_post;
3739
		}
3740
3741
		return $uploaded_files;
3742
	}
3743
3744
	/**
3745
	 * Add help to the Jetpack page
3746
	 *
3747
	 * @since Jetpack (1.2.3)
3748
	 * @return false if not the Jetpack page
3749
	 */
3750
	function admin_help() {
3751
		$current_screen = get_current_screen();
3752
3753
		// Overview
3754
		$current_screen->add_help_tab(
3755
			array(
3756
				'id'		=> 'home',
3757
				'title'		=> __( 'Home', 'jetpack' ),
3758
				'content'	=>
3759
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3760
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3761
					'<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>',
3762
			)
3763
		);
3764
3765
		// Screen Content
3766
		if ( current_user_can( 'manage_options' ) ) {
3767
			$current_screen->add_help_tab(
3768
				array(
3769
					'id'		=> 'settings',
3770
					'title'		=> __( 'Settings', 'jetpack' ),
3771
					'content'	=>
3772
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3773
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3774
						'<ol>' .
3775
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3776
							'<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>' .
3777
						'</ol>' .
3778
						'<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>'
3779
				)
3780
			);
3781
		}
3782
3783
		// Help Sidebar
3784
		$current_screen->set_help_sidebar(
3785
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3786
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3787
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3788
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3789
		);
3790
	}
3791
3792
	function admin_menu_css() {
3793
		wp_enqueue_style( 'jetpack-icons' );
3794
	}
3795
3796
	function admin_menu_order() {
3797
		return true;
3798
	}
3799
3800 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3801
		$jp_menu_order = array();
3802
3803
		foreach ( $menu_order as $index => $item ) {
3804
			if ( $item != 'jetpack' ) {
3805
				$jp_menu_order[] = $item;
3806
			}
3807
3808
			if ( $index == 0 ) {
3809
				$jp_menu_order[] = 'jetpack';
3810
			}
3811
		}
3812
3813
		return $jp_menu_order;
3814
	}
3815
3816
	function admin_head() {
3817 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3818
			/** This action is documented in class.jetpack-admin-page.php */
3819
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3820
	}
3821
3822
	function admin_banner_styles() {
3823
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3824
3825
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3826
			wp_register_style(
3827
				'jetpack-dops-style',
3828
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3829
				array(),
3830
				JETPACK__VERSION
3831
			);
3832
		}
3833
3834
		wp_enqueue_style(
3835
			'jetpack',
3836
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3837
			array( 'jetpack-dops-style' ),
3838
			 JETPACK__VERSION . '-20121016'
3839
		);
3840
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3841
		wp_style_add_data( 'jetpack', 'suffix', $min );
3842
	}
3843
3844
	function plugin_action_links( $actions ) {
3845
3846
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3847
3848
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3849
			return array_merge(
3850
				$jetpack_home,
3851
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3852
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3853
				$actions
3854
				);
3855
			}
3856
3857
		return array_merge( $jetpack_home, $actions );
3858
	}
3859
3860
	/**
3861
	 * This is the first banner
3862
	 * It should be visible only to user that can update the option
3863
	 * Are not connected
3864
	 *
3865
	 * @return null
3866
	 */
3867
	function admin_jetpack_manage_notice() {
3868
		$screen = get_current_screen();
3869
3870
		// Don't show the connect notice on the jetpack settings page.
3871
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3872
			return;
3873
		}
3874
3875
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3876
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3877
		/**
3878
		 * I think it would be great to have different wordsing depending on where you are
3879
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3880
		 * etc..
3881
		 */
3882
3883
		?>
3884
		<div id="message" class="updated jp-banner">
3885
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3886
				<div class="jp-banner__description-container">
3887
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3888
					<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>
3889
					<p class="jp-banner__button-container">
3890
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3891
						<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>
3892
					</p>
3893
				</div>
3894
		</div>
3895
		<?php
3896
	}
3897
3898
	/**
3899
	 * Returns the url that the user clicks to remove the notice for the big banner
3900
	 * @return string
3901
	 */
3902
	function opt_out_jetpack_manage_url() {
3903
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3904
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3905
	}
3906
	/**
3907
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3908
	 * @return string
3909
	 */
3910
	function opt_in_jetpack_manage_url() {
3911
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3912
	}
3913
3914
	function opt_in_jetpack_manage_notice() {
3915
		?>
3916
		<div class="wrap">
3917
			<div id="message" class="jetpack-message is-opt-in">
3918
				<?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' ); ?>
3919
			</div>
3920
		</div>
3921
		<?php
3922
3923
	}
3924
	/**
3925
	 * Determines whether to show the notice of not true = display notice
3926
	 * @return bool
3927
	 */
3928
	function can_display_jetpack_manage_notice() {
3929
		// never display the notice to users that can't do anything about it anyways
3930
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3931
			return false;
3932
3933
		// don't display if we are in development more
3934
		if( Jetpack::is_development_mode() ) {
3935
			return false;
3936
		}
3937
		// don't display if the site is private
3938
		if(  ! Jetpack_Options::get_option( 'public' ) )
3939
			return false;
3940
3941
		/**
3942
		 * Should the Jetpack Remote Site Management notice be displayed.
3943
		 *
3944
		 * @since 3.3.0
3945
		 *
3946
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3947
		 */
3948
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3949
	}
3950
3951
	/*
3952
	 * Registration flow:
3953
	 * 1 - ::admin_page_load() action=register
3954
	 * 2 - ::try_registration()
3955
	 * 3 - ::register()
3956
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3957
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3958
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3959
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3960
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3961
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3962
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3963
	 *       jetpack_id, jetpack_secret, jetpack_public
3964
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3965
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3966
	 * 5 - user logs in with WP.com account
3967
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3968
	 *		- Jetpack_Client_Server::authorize()
3969
	 *		- Jetpack_Client_Server::get_token()
3970
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3971
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3972
	 *			- which responds with access_token, token_type, scope
3973
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3974
	 *		- Jetpack::activate_default_modules()
3975
	 *     		- Deactivates deprecated plugins
3976
	 *     		- Activates all default modules
3977
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3978
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3979
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3980
	 *     Done!
3981
	 */
3982
3983
	/**
3984
	 * Handles the page load events for the Jetpack admin page
3985
	 */
3986
	function admin_page_load() {
3987
		$error = false;
3988
3989
		// Make sure we have the right body class to hook stylings for subpages off of.
3990
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3991
3992
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3993
			// Should only be used in intermediate redirects to preserve state across redirects
3994
			Jetpack::restate();
3995
		}
3996
3997
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3998
			// User clicked in the iframe to link their accounts
3999
			if ( ! Jetpack::is_user_connected() ) {
4000
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4001
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4002
4003
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4004
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4005
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4006
4007
				if ( isset( $_GET['notes_iframe'] ) )
4008
					$connect_url .= '&notes_iframe';
4009
				wp_redirect( $connect_url );
4010
				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...
4011
			} else {
4012
				if ( ! isset( $_GET['calypso_env'] ) ) {
4013
					Jetpack::state( 'message', 'already_authorized' );
4014
					wp_safe_redirect( Jetpack::admin_url() );
4015
					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...
4016
				} else {
4017
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4018
					$connect_url .= '&already_authorized=true';
4019
					wp_redirect( $connect_url );
4020
					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...
4021
				}
4022
			}
4023
		}
4024
4025
4026
		if ( isset( $_GET['action'] ) ) {
4027
			switch ( $_GET['action'] ) {
4028
			case 'authorize':
4029
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4030
					Jetpack::state( 'message', 'already_authorized' );
4031
					wp_safe_redirect( Jetpack::admin_url() );
4032
					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...
4033
				}
4034
				Jetpack::log( 'authorize' );
4035
				$client_server = new Jetpack_Client_Server;
4036
				$client_server->client_authorize();
4037
				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...
4038
			case 'register' :
4039
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4040
					$error = 'cheatin';
4041
					break;
4042
				}
4043
				check_admin_referer( 'jetpack-register' );
4044
				Jetpack::log( 'register' );
4045
				Jetpack::maybe_set_version_option();
4046
				$registered = Jetpack::try_registration();
4047
				if ( is_wp_error( $registered ) ) {
4048
					$error = $registered->get_error_code();
4049
					Jetpack::state( 'error', $error );
4050
					Jetpack::state( 'error', $registered->get_error_message() );
4051
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4052
						'error_code' => $error,
4053
						'error_message' => $registered->get_error_message()
4054
					) );
4055
					break;
4056
				}
4057
4058
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4059
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4060
4061
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4062
					'from' => $from
4063
				) );
4064
4065
				$url = $this->build_connect_url( true, $redirect, $from );
4066
4067
				if ( ! empty( $_GET['onboarding'] ) ) {
4068
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4069
				}
4070
4071
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4072
					$url = add_query_arg( 'auth_approved', 'true', $url );
4073
				}
4074
4075
				wp_redirect( $url );
4076
				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...
4077
			case 'activate' :
4078
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4079
					$error = 'cheatin';
4080
					break;
4081
				}
4082
4083
				$module = stripslashes( $_GET['module'] );
4084
				check_admin_referer( "jetpack_activate-$module" );
4085
				Jetpack::log( 'activate', $module );
4086
				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...
4087
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4088
				}
4089
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4090
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
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
			case 'activate_default_modules' :
4093
				check_admin_referer( 'activate_default_modules' );
4094
				Jetpack::log( 'activate_default_modules' );
4095
				Jetpack::restate();
4096
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4097
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4098
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4099
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4100
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4101
				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...
4102
			case 'disconnect' :
4103
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4104
					$error = 'cheatin';
4105
					break;
4106
				}
4107
4108
				check_admin_referer( 'jetpack-disconnect' );
4109
				Jetpack::log( 'disconnect' );
4110
				Jetpack::disconnect();
4111
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4112
				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...
4113
			case 'reconnect' :
4114
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4115
					$error = 'cheatin';
4116
					break;
4117
				}
4118
4119
				check_admin_referer( 'jetpack-reconnect' );
4120
				Jetpack::log( 'reconnect' );
4121
				$this->disconnect();
4122
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4123
				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...
4124 View Code Duplication
			case 'deactivate' :
4125
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4126
					$error = 'cheatin';
4127
					break;
4128
				}
4129
4130
				$modules = stripslashes( $_GET['module'] );
4131
				check_admin_referer( "jetpack_deactivate-$modules" );
4132
				foreach ( explode( ',', $modules ) as $module ) {
4133
					Jetpack::log( 'deactivate', $module );
4134
					Jetpack::deactivate_module( $module );
4135
					Jetpack::state( 'message', 'module_deactivated' );
4136
				}
4137
				Jetpack::state( 'module', $modules );
4138
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
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
			case 'unlink' :
4141
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4142
				check_admin_referer( 'jetpack-unlink' );
4143
				Jetpack::log( 'unlink' );
4144
				$this->unlink_user();
4145
				Jetpack::state( 'message', 'unlinked' );
4146
				if ( 'sub-unlink' == $redirect ) {
4147
					wp_safe_redirect( admin_url() );
4148
				} else {
4149
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4150
				}
4151
				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...
4152
			case 'onboard' :
4153
				if ( ! current_user_can( 'manage_options' ) ) {
4154
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4155
				} else {
4156
					Jetpack::create_onboarding_token();
4157
					$url = $this->build_connect_url( true );
4158
4159
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4160
						$url = add_query_arg( 'onboarding', $token, $url );
4161
					}
4162
4163
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4164
					if ( $calypso_env ) {
4165
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4166
					}
4167
4168
					wp_redirect( $url );
4169
					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...
4170
				}
4171
				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...
4172
			default:
4173
				/**
4174
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4175
				 *
4176
				 * @since 2.6.0
4177
				 *
4178
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4179
				 */
4180
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4181
			}
4182
		}
4183
4184
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4185
			self::activate_new_modules( true );
4186
		}
4187
4188
		$message_code = Jetpack::state( 'message' );
4189
		if ( Jetpack::state( 'optin-manage' ) ) {
4190
			$activated_manage = $message_code;
4191
			$message_code = 'jetpack-manage';
4192
		}
4193
4194
		switch ( $message_code ) {
4195
		case 'jetpack-manage':
4196
			$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>';
4197
			if ( $activated_manage ) {
0 ignored issues
show
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...
4198
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4199
			}
4200
			break;
4201
4202
		}
4203
4204
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4205
4206
		if ( ! empty( $deactivated_plugins ) ) {
4207
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4208
			$deactivated_titles  = array();
4209
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4210
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4211
					continue;
4212
				}
4213
4214
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4215
			}
4216
4217
			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...
4218
				if ( $this->message ) {
4219
					$this->message .= "<br /><br />\n";
4220
				}
4221
4222
				$this->message .= wp_sprintf(
4223
					_n(
4224
						'Jetpack contains the most recent version of the old %l plugin.',
4225
						'Jetpack contains the most recent versions of the old %l plugins.',
4226
						count( $deactivated_titles ),
4227
						'jetpack'
4228
					),
4229
					$deactivated_titles
4230
				);
4231
4232
				$this->message .= "<br />\n";
4233
4234
				$this->message .= _n(
4235
					'The old version has been deactivated and can be removed from your site.',
4236
					'The old versions have been deactivated and can be removed from your site.',
4237
					count( $deactivated_titles ),
4238
					'jetpack'
4239
				);
4240
			}
4241
		}
4242
4243
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4244
4245
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4246
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4247
		}
4248
4249 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4250
			/**
4251
			 * Fires when a module configuration page is loaded.
4252
			 * The dynamic part of the hook is the configure parameter from the URL.
4253
			 *
4254
			 * @since 1.1.0
4255
			 */
4256
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4257
		}
4258
4259
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4260
	}
4261
4262
	function admin_notices() {
4263
4264
		if ( $this->error ) {
4265
?>
4266
<div id="message" class="jetpack-message jetpack-err">
4267
	<div class="squeezer">
4268
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4269
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4270
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4271
<?php	endif; ?>
4272
	</div>
4273
</div>
4274
<?php
4275
		}
4276
4277
		if ( $this->message ) {
4278
?>
4279
<div id="message" class="jetpack-message">
4280
	<div class="squeezer">
4281
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4282
	</div>
4283
</div>
4284
<?php
4285
		}
4286
4287
		if ( $this->privacy_checks ) :
4288
			$module_names = $module_slugs = array();
4289
4290
			$privacy_checks = explode( ',', $this->privacy_checks );
4291
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4292
			foreach ( $privacy_checks as $module_slug ) {
4293
				$module = Jetpack::get_module( $module_slug );
4294
				if ( ! $module ) {
4295
					continue;
4296
				}
4297
4298
				$module_slugs[] = $module_slug;
4299
				$module_names[] = "<strong>{$module['name']}</strong>";
4300
			}
4301
4302
			$module_slugs = join( ',', $module_slugs );
4303
?>
4304
<div id="message" class="jetpack-message jetpack-err">
4305
	<div class="squeezer">
4306
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4307
		<p><?php
4308
			echo wp_kses(
4309
				wptexturize(
4310
					wp_sprintf(
4311
						_nx(
4312
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4313
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4314
							count( $privacy_checks ),
4315
							'%l = list of Jetpack module/feature names',
4316
							'jetpack'
4317
						),
4318
						$module_names
4319
					)
4320
				),
4321
				array( 'strong' => true )
4322
			);
4323
4324
			echo "\n<br />\n";
4325
4326
			echo wp_kses(
4327
				sprintf(
4328
					_nx(
4329
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4330
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4331
						count( $privacy_checks ),
4332
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4333
						'jetpack'
4334
					),
4335
					wp_nonce_url(
4336
						Jetpack::admin_url(
4337
							array(
4338
								'page'   => 'jetpack',
4339
								'action' => 'deactivate',
4340
								'module' => urlencode( $module_slugs ),
4341
							)
4342
						),
4343
						"jetpack_deactivate-$module_slugs"
4344
					),
4345
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4346
				),
4347
				array( 'a' => array( 'href' => true, 'title' => true ) )
4348
			);
4349
		?></p>
4350
	</div>
4351
</div>
4352
<?php endif;
4353
	// only display the notice if the other stuff is not there
4354
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4355
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4356
			$this->opt_in_jetpack_manage_notice();
4357
		}
4358
	}
4359
4360
	/**
4361
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4362
	 */
4363
	function stat( $group, $detail ) {
4364
		if ( ! isset( $this->stats[ $group ] ) )
4365
			$this->stats[ $group ] = array();
4366
		$this->stats[ $group ][] = $detail;
4367
	}
4368
4369
	/**
4370
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4371
	 */
4372
	function do_stats( $method = '' ) {
4373
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4374
			foreach ( $this->stats as $group => $stats ) {
4375
				if ( is_array( $stats ) && count( $stats ) ) {
4376
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4377
					if ( 'server_side' === $method ) {
4378
						self::do_server_side_stat( $args );
4379
					} else {
4380
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4381
					}
4382
				}
4383
				unset( $this->stats[ $group ] );
4384
			}
4385
		}
4386
	}
4387
4388
	/**
4389
	 * Runs stats code for a one-off, server-side.
4390
	 *
4391
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4392
	 *
4393
	 * @return bool If it worked.
4394
	 */
4395
	static function do_server_side_stat( $args ) {
4396
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4397
		if ( is_wp_error( $response ) )
4398
			return false;
4399
4400
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4401
			return false;
4402
4403
		return true;
4404
	}
4405
4406
	/**
4407
	 * Builds the stats url.
4408
	 *
4409
	 * @param $args array|string The arguments to append to the URL.
4410
	 *
4411
	 * @return string The URL to be pinged.
4412
	 */
4413
	static function build_stats_url( $args ) {
4414
		$defaults = array(
4415
			'v'    => 'wpcom2',
4416
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4417
		);
4418
		$args     = wp_parse_args( $args, $defaults );
4419
		/**
4420
		 * Filter the URL used as the Stats tracking pixel.
4421
		 *
4422
		 * @since 2.3.2
4423
		 *
4424
		 * @param string $url Base URL used as the Stats tracking pixel.
4425
		 */
4426
		$base_url = apply_filters(
4427
			'jetpack_stats_base_url',
4428
			'https://pixel.wp.com/g.gif'
4429
		);
4430
		$url      = add_query_arg( $args, $base_url );
4431
		return $url;
4432
	}
4433
4434
	static function translate_current_user_to_role() {
4435
		foreach ( self::$capability_translations as $role => $cap ) {
4436
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4437
				return $role;
4438
			}
4439
		}
4440
4441
		return false;
4442
	}
4443
4444
	static function translate_user_to_role( $user ) {
4445
		foreach ( self::$capability_translations as $role => $cap ) {
4446
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4447
				return $role;
4448
			}
4449
		}
4450
4451
		return false;
4452
    }
4453
4454
	static function translate_role_to_cap( $role ) {
4455
		if ( ! isset( self::$capability_translations[$role] ) ) {
4456
			return false;
4457
		}
4458
4459
		return self::$capability_translations[$role];
4460
	}
4461
4462
	static function sign_role( $role, $user_id = null ) {
4463
		if ( empty( $user_id ) ) {
4464
			$user_id = (int) get_current_user_id();
4465
		}
4466
4467
		if ( ! $user_id  ) {
4468
			return false;
4469
		}
4470
4471
		$token = Jetpack_Data::get_access_token();
4472
		if ( ! $token || is_wp_error( $token ) ) {
4473
			return false;
4474
		}
4475
4476
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4477
	}
4478
4479
4480
	/**
4481
	 * Builds a URL to the Jetpack connection auth page
4482
	 *
4483
	 * @since 3.9.5
4484
	 *
4485
	 * @param bool $raw If true, URL will not be escaped.
4486
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4487
	 *                              If string, will be a custom redirect.
4488
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4489
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4490
	 *
4491
	 * @return string Connect URL
4492
	 */
4493
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4494
		$site_id = Jetpack_Options::get_option( 'id' );
4495
		$token = Jetpack_Options::get_option( 'blog_token' );
4496
4497
		if ( $register || ! $token || ! $site_id ) {
4498
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4499
4500
			if ( ! empty( $redirect ) ) {
4501
				$url = add_query_arg(
4502
					'redirect',
4503
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4504
					$url
4505
				);
4506
			}
4507
4508
			if( is_network_admin() ) {
4509
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4510
			}
4511
		} else {
4512
4513
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4514
			// because otherwise this logic can get us in to a loop.
4515
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4516
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4517
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4518
4519
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4520
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4521
					'1.1'
4522
				);
4523
4524
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4525
					// Generating a register URL instead to refresh the existing token
4526
					return $this->build_connect_url( $raw, $redirect, $from, true );
4527
				}
4528
			}
4529
4530
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4531
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4532
			}
4533
4534
			$role = self::translate_current_user_to_role();
4535
			$signed_role = self::sign_role( $role );
4536
4537
			$user = wp_get_current_user();
4538
4539
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4540
			$redirect = $redirect
4541
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4542
				: $jetpack_admin_page;
4543
4544
			if( isset( $_REQUEST['is_multisite'] ) ) {
4545
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4546
			}
4547
4548
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4549
4550
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4551
				? get_site_icon_url()
4552
				: false;
4553
4554
			/**
4555
			 * Filter the type of authorization.
4556
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4557
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4558
			 *
4559
			 * @since 4.3.3
4560
			 *
4561
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4562
			 */
4563
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4564
4565
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4566
4567
			$args = urlencode_deep(
4568
				array(
4569
					'response_type' => 'code',
4570
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4571
					'redirect_uri'  => add_query_arg(
4572
						array(
4573
							'action'   => 'authorize',
4574
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4575
							'redirect' => urlencode( $redirect ),
4576
						),
4577
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4578
					),
4579
					'state'         => $user->ID,
4580
					'scope'         => $signed_role,
4581
					'user_email'    => $user->user_email,
4582
					'user_login'    => $user->user_login,
4583
					'is_active'     => Jetpack::is_active(),
4584
					'jp_version'    => JETPACK__VERSION,
4585
					'auth_type'     => $auth_type,
4586
					'secret'        => $secrets['secret_1'],
4587
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4588
					'blogname'      => get_option( 'blogname' ),
4589
					'site_url'      => site_url(),
4590
					'home_url'      => home_url(),
4591
					'site_icon'     => $site_icon,
4592
					'site_lang'     => get_locale(),
4593
					'_ui'           => $tracks_identity['_ui'],
4594
					'_ut'           => $tracks_identity['_ut']
4595
				)
4596
			);
4597
4598
			self::apply_activation_source_to_args( $args );
4599
4600
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4601
		}
4602
4603
		if ( $from ) {
4604
			$url = add_query_arg( 'from', $from, $url );
4605
		}
4606
4607
4608
		if ( isset( $_GET['calypso_env'] ) ) {
4609
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4610
		}
4611
4612
		return $raw ? $url : esc_url( $url );
4613
	}
4614
4615
	public static function apply_activation_source_to_args( &$args ) {
4616
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4617
4618
		if ( $activation_source_name ) {
4619
			$args['_as'] = urlencode( $activation_source_name );
4620
		}
4621
4622
		if ( $activation_source_keyword ) {
4623
			$args['_ak'] = urlencode( $activation_source_keyword );
4624
		}
4625
	}
4626
4627
	function build_reconnect_url( $raw = false ) {
4628
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4629
		return $raw ? $url : esc_url( $url );
4630
	}
4631
4632
	public static function admin_url( $args = null ) {
4633
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4634
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4635
		return $url;
4636
	}
4637
4638
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4639
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4640
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4641
	}
4642
4643
	function dismiss_jetpack_notice() {
4644
4645
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4646
			return;
4647
		}
4648
4649
		switch( $_GET['jetpack-notice'] ) {
4650
			case 'dismiss':
4651
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4652
4653
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4654
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4655
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4656
				}
4657
				break;
4658 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
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...
4659
4660
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4661
					// Don't show the banner again
4662
4663
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4664
					// redirect back to the page that had the notice
4665
					if ( wp_get_referer() ) {
4666
						wp_safe_redirect( wp_get_referer() );
4667
					} else {
4668
						// Take me to Jetpack
4669
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4670
					}
4671
				}
4672
				break;
4673 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
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...
4674
4675
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4676
					// Don't show the banner again
4677
4678
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4679
					// redirect back to the page that had the notice
4680
					if ( wp_get_referer() ) {
4681
						wp_safe_redirect( wp_get_referer() );
4682
					} else {
4683
						// Take me to Jetpack
4684
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4685
					}
4686
				}
4687
				break;
4688
			case 'jetpack-manage-opt-in':
4689
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4690
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4691
4692
					$redirection_url = Jetpack::admin_url();
4693
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4694
4695
					// Don't redirect form the Jetpack Setting Page
4696
					$referer_parsed = parse_url ( wp_get_referer() );
4697
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4698
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4699
						// Take the user to Jetpack home except when on the setting page
4700
						$redirection_url = wp_get_referer();
4701
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4702
					}
4703
					// Also update the JSON API FULL MANAGEMENT Option
4704
					Jetpack::activate_module( 'manage', false, false );
4705
4706
					// Special Message when option in.
4707
					Jetpack::state( 'optin-manage', 'true' );
4708
					// Activate the Module if not activated already
4709
4710
					// Redirect properly
4711
					wp_safe_redirect( $redirection_url );
4712
4713
				}
4714
				break;
4715
		}
4716
	}
4717
4718
	public static function admin_screen_configure_module( $module_id ) {
4719
4720
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4721
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4722
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4723
				/**
4724
				 * Fires to diplay a custom module activation screen.
4725
				 *
4726
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4727
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4728
				 *
4729
				 * @module manage
4730
				 *
4731
				 * @since 3.8.0
4732
				 *
4733
				 * @param int $module_id Module ID.
4734
				 */
4735
				do_action( 'display_activate_module_setting_' . $module_id );
4736
			} else {
4737
				self::display_activate_module_link( $module_id );
4738
			}
4739
4740
			return false;
4741
		} ?>
4742
4743
		<div id="jp-settings-screen" style="position: relative">
4744
			<h3>
4745
			<?php
4746
				$module = Jetpack::get_module( $module_id );
4747
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4748
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4749
			?>
4750
			</h3>
4751
			<?php
4752
				/**
4753
				 * Fires within the displayed message when a feature configuation is updated.
4754
				 *
4755
				 * @since 3.4.0
4756
				 *
4757
				 * @param int $module_id Module ID.
4758
				 */
4759
				do_action( 'jetpack_notices_update_settings', $module_id );
4760
				/**
4761
				 * Fires when a feature configuation screen is loaded.
4762
				 * The dynamic part of the hook, $module_id, is the module ID.
4763
				 *
4764
				 * @since 1.1.0
4765
				 */
4766
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4767
			?>
4768
		</div><?php
4769
	}
4770
4771
	/**
4772
	 * Display link to activate the module to see the settings screen.
4773
	 * @param  string $module_id
4774
	 * @return null
4775
	 */
4776
	public static function display_activate_module_link( $module_id ) {
4777
4778
		$info =  Jetpack::get_module( $module_id );
4779
		$extra = '';
4780
		$activate_url = wp_nonce_url(
4781
				Jetpack::admin_url(
4782
					array(
4783
						'page'   => 'jetpack',
4784
						'action' => 'activate',
4785
						'module' => $module_id,
4786
					)
4787
				),
4788
				"jetpack_activate-$module_id"
4789
			);
4790
4791
		?>
4792
4793
		<div class="wrap configure-module">
4794
			<div id="jp-settings-screen">
4795
				<?php
4796
				if ( $module_id == 'json-api' ) {
4797
4798
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4799
4800
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4801
4802
					$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' );
4803
4804
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4805
				} ?>
4806
4807
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4808
				<div class="narrow">
4809
					<p><?php echo  $info['description']; ?></p>
4810
					<?php if( $extra ) { ?>
4811
					<p><?php echo esc_html( $extra ); ?></p>
4812
					<?php } ?>
4813
					<p>
4814
						<?php
4815
						if( wp_get_referer() ) {
4816
							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() );
4817
						} else {
4818
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4819
						} ?>
4820
					</p>
4821
				</div>
4822
4823
			</div>
4824
		</div>
4825
4826
		<?php
4827
	}
4828
4829
	public static function sort_modules( $a, $b ) {
4830
		if ( $a['sort'] == $b['sort'] )
4831
			return 0;
4832
4833
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4834
	}
4835
4836
	function ajax_recheck_ssl() {
4837
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4838
		$result = Jetpack::permit_ssl( true );
4839
		wp_send_json( array(
4840
			'enabled' => $result,
4841
			'message' => get_transient( 'jetpack_https_test_message' )
4842
		) );
4843
	}
4844
4845
/* Client API */
4846
4847
	/**
4848
	 * Returns the requested Jetpack API URL
4849
	 *
4850
	 * @return string
4851
	 */
4852
	public static function api_url( $relative_url ) {
4853
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4854
	}
4855
4856
	/**
4857
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4858
	 */
4859
	public static function fix_url_for_bad_hosts( $url ) {
4860
		if ( 0 !== strpos( $url, 'https://' ) ) {
4861
			return $url;
4862
		}
4863
4864
		switch ( JETPACK_CLIENT__HTTPS ) {
4865
			case 'ALWAYS' :
4866
				return $url;
4867
			case 'NEVER' :
4868
				return set_url_scheme( $url, 'http' );
4869
			// default : case 'AUTO' :
4870
		}
4871
4872
		// we now return the unmodified SSL URL by default, as a security precaution
4873
		return $url;
4874
	}
4875
4876
	/**
4877
	 * Create a random secret for validating onboarding payload
4878
	 *
4879
	 * @return string Secret token
4880
	 */
4881
	public static function create_onboarding_token() {
4882
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4883
			$token = wp_generate_password( 32, false );
4884
			Jetpack_Options::update_option( 'onboarding', $token );
4885
		}
4886
4887
		return $token;
4888
	}
4889
4890
	/**
4891
	 * Remove the onboarding token
4892
	 *
4893
	 * @return bool True on success, false on failure
4894
	 */
4895
	public static function invalidate_onboarding_token() {
4896
		return Jetpack_Options::delete_option( 'onboarding' );
4897
	}
4898
4899
	/**
4900
	 * Validate an onboarding token for a specific action
4901
	 *
4902
	 * @return boolean True if token/action pair is accepted, false if not
4903
	 */
4904
	public static function validate_onboarding_token_action( $token, $action ) {
4905
		// Compare tokens, bail if tokens do not match
4906
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4907
			return false;
4908
		}
4909
4910
		// List of valid actions we can take
4911
		$valid_actions = array(
4912
			'/jetpack/v4/settings',
4913
		);
4914
4915
		// Whitelist the action
4916
		if ( ! in_array( $action, $valid_actions ) ) {
4917
			return false;
4918
		}
4919
4920
		return true;
4921
	}
4922
4923
	/**
4924
	 * Checks to see if the URL is using SSL to connect with Jetpack
4925
	 *
4926
	 * @since 2.3.3
4927
	 * @return boolean
4928
	 */
4929
	public static function permit_ssl( $force_recheck = false ) {
4930
		// Do some fancy tests to see if ssl is being supported
4931
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4932
			$message = '';
4933
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4934
				$ssl = 0;
4935
			} else {
4936
				switch ( JETPACK_CLIENT__HTTPS ) {
4937
					case 'NEVER':
4938
						$ssl = 0;
4939
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4940
						break;
4941
					case 'ALWAYS':
4942
					case 'AUTO':
4943
					default:
4944
						$ssl = 1;
4945
						break;
4946
				}
4947
4948
				// If it's not 'NEVER', test to see
4949
				if ( $ssl ) {
4950
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4951
						$ssl = 0;
4952
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4953
					} else {
4954
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4955
						if ( is_wp_error( $response ) ) {
4956
							$ssl = 0;
4957
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4958
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4959
							$ssl = 0;
4960
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4961
						}
4962
					}
4963
				}
4964
			}
4965
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4966
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4967
		}
4968
4969
		return (bool) $ssl;
4970
	}
4971
4972
	/*
4973
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4974
	 */
4975
	public function alert_auto_ssl_fail() {
4976
		if ( ! current_user_can( 'manage_options' ) )
4977
			return;
4978
4979
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4980
		?>
4981
4982
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4983
			<div class="jp-banner__content">
4984
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4985
				<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>
4986
				<p>
4987
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4988
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4989
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4990
				</p>
4991
				<p>
4992
					<?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' ),
4993
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4994
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4995
				</p>
4996
			</div>
4997
		</div>
4998
		<style>
4999
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5000
		</style>
5001
		<script type="text/javascript">
5002
			jQuery( document ).ready( function( $ ) {
5003
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5004
					var $this = $( this );
5005
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5006
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5007
					e.preventDefault();
5008
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5009
					$.post( ajaxurl, data )
5010
					  .done( function( response ) {
5011
					  	if ( response.enabled ) {
5012
					  		$( '#jetpack-ssl-warning' ).hide();
5013
					  	} else {
5014
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5015
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5016
					  	}
5017
					  }.bind( $this ) );
5018
				} );
5019
			} );
5020
		</script>
5021
5022
		<?php
5023
	}
5024
5025
	/**
5026
	 * Returns the Jetpack XML-RPC API
5027
	 *
5028
	 * @return string
5029
	 */
5030
	public static function xmlrpc_api_url() {
5031
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5032
		return untrailingslashit( $base ) . '/xmlrpc.php';
5033
	}
5034
5035
	/**
5036
	 * Creates two secret tokens and the end of life timestamp for them.
5037
	 *
5038
	 * Note these tokens are unique per call, NOT static per site for connecting.
5039
	 *
5040
	 * @since 2.6
5041
	 * @return array
5042
	 */
5043
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5044
		if ( ! $user_id ) {
5045
			$user_id = get_current_user_id();
5046
		}
5047
5048
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5049
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5050
5051
		if (
5052
			isset( $secrets[ $secret_name ] ) &&
5053
			$secrets[ $secret_name ]['exp'] > time()
5054
		) {
5055
			return $secrets[ $secret_name ];
5056
		}
5057
5058
		$secret_value = array(
5059
			'secret_1'  => wp_generate_password( 32, false ),
5060
			'secret_2'  => wp_generate_password( 32, false ),
5061
			'exp'       => time() + $exp,
5062
		);
5063
5064
		$secrets[ $secret_name ] = $secret_value;
5065
5066
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5067
		return $secrets[ $secret_name ];
5068
	}
5069
5070
	public static function get_secrets( $action, $user_id ) {
5071
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5072
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5073
5074
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5075
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5076
		}
5077
5078
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5079
			self::delete_secrets( $action, $user_id );
5080
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5081
		}
5082
5083
		return $secrets[ $secret_name ];
5084
	}
5085
5086
	public static function delete_secrets( $action, $user_id ) {
5087
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5088
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5089
		if ( isset( $secrets[ $secret_name ] ) ) {
5090
			unset( $secrets[ $secret_name ] );
5091
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5092
		}
5093
	}
5094
5095
	/**
5096
	 * Builds the timeout limit for queries talking with the wpcom servers.
5097
	 *
5098
	 * Based on local php max_execution_time in php.ini
5099
	 *
5100
	 * @since 2.6
5101
	 * @return int
5102
	 * @deprecated
5103
	 **/
5104
	public function get_remote_query_timeout_limit() {
5105
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5106
		return Jetpack::get_max_execution_time();
5107
	}
5108
5109
	/**
5110
	 * Builds the timeout limit for queries talking with the wpcom servers.
5111
	 *
5112
	 * Based on local php max_execution_time in php.ini
5113
	 *
5114
	 * @since 5.4
5115
	 * @return int
5116
	 **/
5117
	public static function get_max_execution_time() {
5118
		$timeout = (int) ini_get( 'max_execution_time' );
5119
5120
		// Ensure exec time set in php.ini
5121
		if ( ! $timeout ) {
5122
			$timeout = 30;
5123
		}
5124
		return $timeout;
5125
	}
5126
5127
	/**
5128
	 * Sets a minimum request timeout, and returns the current timeout
5129
	 *
5130
	 * @since 5.4
5131
	 **/
5132
	public static function set_min_time_limit( $min_timeout ) {
5133
		$timeout = self::get_max_execution_time();
5134
		if ( $timeout < $min_timeout ) {
5135
			$timeout = $min_timeout;
5136
			set_time_limit( $timeout );
5137
		}
5138
		return $timeout;
5139
	}
5140
5141
5142
	/**
5143
	 * Takes the response from the Jetpack register new site endpoint and
5144
	 * verifies it worked properly.
5145
	 *
5146
	 * @since 2.6
5147
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5148
	 **/
5149
	public function validate_remote_register_response( $response ) {
5150
	  if ( is_wp_error( $response ) ) {
5151
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5152
		}
5153
5154
		$code   = wp_remote_retrieve_response_code( $response );
5155
		$entity = wp_remote_retrieve_body( $response );
5156
		if ( $entity )
5157
			$registration_response = json_decode( $entity );
5158
		else
5159
			$registration_response = false;
5160
5161
		$code_type = intval( $code / 100 );
5162
		if ( 5 == $code_type ) {
5163
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5164
		} elseif ( 408 == $code ) {
5165
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5166
		} elseif ( ! empty( $registration_response->error ) ) {
5167
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5168
				$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' );
5169
			} else {
5170
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5171
			}
5172
5173
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5174
		} elseif ( 200 != $code ) {
5175
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5176
		}
5177
5178
		// Jetpack ID error block
5179
		if ( empty( $registration_response->jetpack_id ) ) {
5180
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5181
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5182
			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 );
5183
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5184
			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 );
5185
		}
5186
5187
	    return $registration_response;
5188
	}
5189
	/**
5190
	 * @return bool|WP_Error
5191
	 */
5192
	public static function register() {
5193
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5194
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5195
		$secrets = Jetpack::generate_secrets( 'register' );
5196
5197 View Code Duplication
		if (
5198
			empty( $secrets['secret_1'] ) ||
5199
			empty( $secrets['secret_2'] ) ||
5200
			empty( $secrets['exp'] )
5201
		) {
5202
			return new Jetpack_Error( 'missing_secrets' );
5203
		}
5204
5205
		// better to try (and fail) to set a higher timeout than this system
5206
		// supports than to have register fail for more users than it should
5207
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5208
5209
		$gmt_offset = get_option( 'gmt_offset' );
5210
		if ( ! $gmt_offset ) {
5211
			$gmt_offset = 0;
5212
		}
5213
5214
		$stats_options = get_option( 'stats_options' );
5215
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5216
5217
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5218
5219
		$args = array(
5220
			'method'  => 'POST',
5221
			'body'    => array(
5222
				'siteurl'         => site_url(),
5223
				'home'            => home_url(),
5224
				'gmt_offset'      => $gmt_offset,
5225
				'timezone_string' => (string) get_option( 'timezone_string' ),
5226
				'site_name'       => (string) get_option( 'blogname' ),
5227
				'secret_1'        => $secrets['secret_1'],
5228
				'secret_2'        => $secrets['secret_2'],
5229
				'site_lang'       => get_locale(),
5230
				'timeout'         => $timeout,
5231
				'stats_id'        => $stats_id,
5232
				'state'           => get_current_user_id(),
5233
				'_ui'             => $tracks_identity['_ui'],
5234
				'_ut'             => $tracks_identity['_ut'],
5235
				'jetpack_version' => JETPACK__VERSION
5236
			),
5237
			'headers' => array(
5238
				'Accept' => 'application/json',
5239
			),
5240
			'timeout' => $timeout,
5241
		);
5242
5243
		self::apply_activation_source_to_args( $args['body'] );
5244
5245
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5246
5247
		// Make sure the response is valid and does not contain any Jetpack errors
5248
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5249
		if ( is_wp_error( $registration_details ) ) {
5250
			return $registration_details;
5251
		} elseif ( ! $registration_details ) {
5252
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5253
		}
5254
5255 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5256
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5257
		}
5258
5259
		if ( isset( $registration_details->jetpack_public ) ) {
5260
			$jetpack_public = (int) $registration_details->jetpack_public;
5261
		} else {
5262
			$jetpack_public = false;
5263
		}
5264
5265
		Jetpack_Options::update_options(
5266
			array(
5267
				'id'         => (int)    $registration_details->jetpack_id,
5268
				'blog_token' => (string) $registration_details->jetpack_secret,
5269
				'public'     => $jetpack_public,
5270
			)
5271
		);
5272
5273
		/**
5274
		 * Fires when a site is registered on WordPress.com.
5275
		 *
5276
		 * @since 3.7.0
5277
		 *
5278
		 * @param int $json->jetpack_id Jetpack Blog ID.
5279
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5280
		 * @param int|bool $jetpack_public Is the site public.
5281
		 */
5282
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5283
5284
		// Initialize Jump Start for the first and only time.
5285
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5286
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5287
5288
			$jetpack = Jetpack::init();
5289
5290
			$jetpack->stat( 'jumpstart', 'unique-views' );
5291
			$jetpack->do_stats( 'server_side' );
5292
		};
5293
5294
		return true;
5295
	}
5296
5297
	/**
5298
	 * If the db version is showing something other that what we've got now, bump it to current.
5299
	 *
5300
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
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...
5301
	 */
5302
	public static function maybe_set_version_option() {
5303
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5304
		if ( JETPACK__VERSION != $version ) {
5305
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5306
5307
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5308
				/** This action is documented in class.jetpack.php */
5309
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5310
			}
5311
5312
			return true;
5313
		}
5314
		return false;
5315
	}
5316
5317
/* Client Server API */
5318
5319
	/**
5320
	 * Loads the Jetpack XML-RPC client
5321
	 */
5322
	public static function load_xml_rpc_client() {
5323
		require_once ABSPATH . WPINC . '/class-IXR.php';
5324
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5325
	}
5326
5327
	/**
5328
	 * Resets the saved authentication state in between testing requests.
5329
	 */
5330
	public function reset_saved_auth_state() {
5331
		$this->xmlrpc_verification = null;
5332
		$this->rest_authentication_status = null;
5333
	}
5334
5335
	function verify_xml_rpc_signature() {
5336
		if ( $this->xmlrpc_verification ) {
5337
			return $this->xmlrpc_verification;
5338
		}
5339
5340
		// It's not for us
5341
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5342
			return false;
5343
		}
5344
5345
		@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...
5346
		if (
5347
			empty( $token_key )
5348
		||
5349
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5350
		) {
5351
			return false;
5352
		}
5353
5354
		if ( '0' === $user_id ) {
5355
			$token_type = 'blog';
5356
			$user_id = 0;
5357
		} else {
5358
			$token_type = 'user';
5359
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5360
				return false;
5361
			}
5362
			$user_id = (int) $user_id;
5363
5364
			$user = new WP_User( $user_id );
5365
			if ( ! $user || ! $user->exists() ) {
5366
				return false;
5367
			}
5368
		}
5369
5370
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
$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...
5371
		if ( ! $token ) {
5372
			return false;
5373
		}
5374
5375
		$token_check = "$token_key.";
5376
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5377
			return false;
5378
		}
5379
5380
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5381
5382
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5383
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5384
			$post_data   = $_POST;
5385
			$file_hashes = array();
5386
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5387
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5388
					continue;
5389
				}
5390
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5391
				$file_hashes[$post_data_key] = $post_data_value;
5392
			}
5393
5394
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5395
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5396
				$post_data[$post_data_key] = $post_data_value;
5397
			}
5398
5399
			ksort( $post_data );
5400
5401
			$body = http_build_query( stripslashes_deep( $post_data ) );
5402
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5403
			$body = file_get_contents( 'php://input' );
5404
		} else {
5405
			$body = null;
5406
		}
5407
5408
		$signature = $jetpack_signature->sign_current_request(
5409
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5410
		);
5411
5412
		if ( ! $signature ) {
5413
			return false;
5414
		} else if ( is_wp_error( $signature ) ) {
5415
			return $signature;
5416
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5417
			return false;
5418
		}
5419
5420
		$timestamp = (int) $_GET['timestamp'];
5421
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5422
5423
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5424
			return false;
5425
		}
5426
5427
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5428
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5429
			if ( ! empty( $_GET['onboarding'] ) ) {
5430
				$jpo = $_GET;
5431
			} else {
5432
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5433
			}
5434
5435
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5436
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5437
5438
			if (
5439
				isset( $jpo_user ) && isset( $jpo_token ) &&
5440
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5441
				isset( $_GET['rest_route'] ) &&
5442
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5443
			) {
5444
				$jpUser = get_user_by( 'email', $jpo_user );
5445
				if ( is_a( $jpUser, 'WP_User' ) ) {
5446
					wp_set_current_user( $jpUser->ID );
5447
					$user_can = is_multisite()
5448
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5449
						: current_user_can( 'manage_options' );
5450
					if ( $user_can ) {
5451
						$token_type = 'user';
5452
						$token->external_user_id = $jpUser->ID;
5453
					}
5454
				}
5455
			}
5456
		}
5457
5458
		$this->xmlrpc_verification = array(
5459
			'type'    => $token_type,
5460
			'user_id' => $token->external_user_id,
5461
		);
5462
5463
		return $this->xmlrpc_verification;
5464
	}
5465
5466
	/**
5467
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5468
	 */
5469
	function authenticate_jetpack( $user, $username, $password ) {
5470
		if ( is_a( $user, 'WP_User' ) ) {
5471
			return $user;
5472
		}
5473
5474
		$token_details = $this->verify_xml_rpc_signature();
5475
5476
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5477
			return $user;
5478
		}
5479
5480
		if ( 'user' !== $token_details['type'] ) {
5481
			return $user;
5482
		}
5483
5484
		if ( ! $token_details['user_id'] ) {
5485
			return $user;
5486
		}
5487
5488
		nocache_headers();
5489
5490
		return new WP_User( $token_details['user_id'] );
5491
	}
5492
5493
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5494
	// Uses the existing XMLRPC request signing implementation.
5495
	function wp_rest_authenticate( $user ) {
5496
		if ( ! empty( $user ) ) {
5497
			// Another authentication method is in effect.
5498
			return $user;
5499
		}
5500
5501
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5502
			// Nothing to do for this authentication method.
5503
			return null;
5504
		}
5505
5506
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5507
			// Nothing to do for this authentication method.
5508
			return null;
5509
		}
5510
5511
		// Ensure that we always have the request body available.  At this
5512
		// point, the WP REST API code to determine the request body has not
5513
		// run yet.  That code may try to read from 'php://input' later, but
5514
		// this can only be done once per request in PHP versions prior to 5.6.
5515
		// So we will go ahead and perform this read now if needed, and save
5516
		// the request body where both the Jetpack signature verification code
5517
		// and the WP REST API code can see it.
5518
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5519
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5520
		}
5521
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5522
5523
		// Only support specific request parameters that have been tested and
5524
		// are known to work with signature verification.  A different method
5525
		// can be passed to the WP REST API via the '?_method=' parameter if
5526
		// needed.
5527
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5528
			$this->rest_authentication_status = new WP_Error(
5529
				'rest_invalid_request',
5530
				__( 'This request method is not supported.', 'jetpack' ),
5531
				array( 'status' => 400 )
5532
			);
5533
			return null;
5534
		}
5535
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5536
			$this->rest_authentication_status = new WP_Error(
5537
				'rest_invalid_request',
5538
				__( 'This request method does not support body parameters.', 'jetpack' ),
5539
				array( 'status' => 400 )
5540
			);
5541
			return null;
5542
		}
5543
5544
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5545
			$content_type = $_SERVER['CONTENT_TYPE'];
5546
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5547
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5548
		}
5549
5550
		if (
5551
			isset( $content_type ) &&
5552
			$content_type !== 'application/x-www-form-urlencoded' &&
5553
			$content_type !== 'application/json'
5554
		) {
5555
			$this->rest_authentication_status = new WP_Error(
5556
				'rest_invalid_request',
5557
				__( 'This Content-Type is not supported.', 'jetpack' ),
5558
				array( 'status' => 400 )
5559
			);
5560
			return null;
5561
		}
5562
5563
		$verified = $this->verify_xml_rpc_signature();
5564
5565
		if ( is_wp_error( $verified ) ) {
5566
			$this->rest_authentication_status = $verified;
5567
			return null;
5568
		}
5569
5570
		if (
5571
			$verified &&
5572
			isset( $verified['type'] ) &&
5573
			'user' === $verified['type'] &&
5574
			! empty( $verified['user_id'] )
5575
		) {
5576
			// Authentication successful.
5577
			$this->rest_authentication_status = true;
5578
			return $verified['user_id'];
5579
		}
5580
5581
		// Something else went wrong.  Probably a signature error.
5582
		$this->rest_authentication_status = new WP_Error(
5583
			'rest_invalid_signature',
5584
			__( 'The request is not signed correctly.', 'jetpack' ),
5585
			array( 'status' => 400 )
5586
		);
5587
		return null;
5588
	}
5589
5590
	/**
5591
	 * Report authentication status to the WP REST API.
5592
	 *
5593
	 * @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
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...
5594
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5595
	 */
5596
	public function wp_rest_authentication_errors( $value ) {
5597
		if ( $value !== null ) {
5598
			return $value;
5599
		}
5600
		return $this->rest_authentication_status;
5601
	}
5602
5603
	function add_nonce( $timestamp, $nonce ) {
5604
		global $wpdb;
5605
		static $nonces_used_this_request = array();
5606
5607
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5608
			return $nonces_used_this_request["$timestamp:$nonce"];
5609
		}
5610
5611
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5612
		$timestamp = (int) $timestamp;
5613
		$nonce     = esc_sql( $nonce );
5614
5615
		// Raw query so we can avoid races: add_option will also update
5616
		$show_errors = $wpdb->show_errors( false );
5617
5618
		$old_nonce = $wpdb->get_row(
5619
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5620
		);
5621
5622
		if ( is_null( $old_nonce ) ) {
5623
			$return = $wpdb->query(
5624
				$wpdb->prepare(
5625
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5626
					"jetpack_nonce_{$timestamp}_{$nonce}",
5627
					time(),
5628
					'no'
5629
				)
5630
			);
5631
		} else {
5632
			$return = false;
5633
		}
5634
5635
		$wpdb->show_errors( $show_errors );
5636
5637
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5638
5639
		return $return;
5640
	}
5641
5642
	/**
5643
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5644
	 * Capture it here so we can verify the signature later.
5645
	 */
5646
	function xmlrpc_methods( $methods ) {
5647
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5648
		return $methods;
5649
	}
5650
5651
	function public_xmlrpc_methods( $methods ) {
5652
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5653
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5654
		}
5655
		return $methods;
5656
	}
5657
5658
	function jetpack_getOptions( $args ) {
5659
		global $wp_xmlrpc_server;
5660
5661
		$wp_xmlrpc_server->escape( $args );
5662
5663
		$username	= $args[1];
5664
		$password	= $args[2];
5665
5666
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5667
			return $wp_xmlrpc_server->error;
5668
		}
5669
5670
		$options = array();
5671
		$user_data = $this->get_connected_user_data();
5672
		if ( is_array( $user_data ) ) {
5673
			$options['jetpack_user_id'] = array(
5674
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5675
				'readonly'      => true,
5676
				'value'         => $user_data['ID'],
5677
			);
5678
			$options['jetpack_user_login'] = array(
5679
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5680
				'readonly'      => true,
5681
				'value'         => $user_data['login'],
5682
			);
5683
			$options['jetpack_user_email'] = array(
5684
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5685
				'readonly'      => true,
5686
				'value'         => $user_data['email'],
5687
			);
5688
			$options['jetpack_user_site_count'] = array(
5689
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5690
				'readonly'      => true,
5691
				'value'         => $user_data['site_count'],
5692
			);
5693
		}
5694
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5695
		$args = stripslashes_deep( $args );
5696
		return $wp_xmlrpc_server->wp_getOptions( $args );
5697
	}
5698
5699
	function xmlrpc_options( $options ) {
5700
		$jetpack_client_id = false;
5701
		if ( self::is_active() ) {
5702
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5703
		}
5704
		$options['jetpack_version'] = array(
5705
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5706
				'readonly'      => true,
5707
				'value'         => JETPACK__VERSION,
5708
		);
5709
5710
		$options['jetpack_client_id'] = array(
5711
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5712
				'readonly'      => true,
5713
				'value'         => $jetpack_client_id,
5714
		);
5715
		return $options;
5716
	}
5717
5718
	public static function clean_nonces( $all = false ) {
5719
		global $wpdb;
5720
5721
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5722
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5723
5724
		if ( true !== $all ) {
5725
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5726
			$sql_args[] = time() - 3600;
5727
		}
5728
5729
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5730
5731
		$sql = $wpdb->prepare( $sql, $sql_args );
5732
5733
		for ( $i = 0; $i < 1000; $i++ ) {
5734
			if ( ! $wpdb->query( $sql ) ) {
5735
				break;
5736
			}
5737
		}
5738
	}
5739
5740
	/**
5741
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5742
	 * SET: state( $key, $value );
5743
	 * GET: $value = state( $key );
5744
	 *
5745
	 * @param string $key
0 ignored issues
show
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...
5746
	 * @param string $value
0 ignored issues
show
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...
5747
	 * @param bool $restate private
5748
	 */
5749
	public static function state( $key = null, $value = null, $restate = false ) {
5750
		static $state = array();
5751
		static $path, $domain;
5752
		if ( ! isset( $path ) ) {
5753
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5754
			$admin_url = Jetpack::admin_url();
5755
			$bits      = parse_url( $admin_url );
5756
5757
			if ( is_array( $bits ) ) {
5758
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5759
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5760
			} else {
5761
				$path = $domain = null;
5762
			}
5763
		}
5764
5765
		// Extract state from cookies and delete cookies
5766
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5767
			$yum = $_COOKIE[ 'jetpackState' ];
5768
			unset( $_COOKIE[ 'jetpackState' ] );
5769
			foreach ( $yum as $k => $v ) {
5770
				if ( strlen( $v ) )
5771
					$state[ $k ] = $v;
5772
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5773
			}
5774
		}
5775
5776
		if ( $restate ) {
5777
			foreach ( $state as $k => $v ) {
5778
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5779
			}
5780
			return;
5781
		}
5782
5783
		// Get a state variable
5784
		if ( isset( $key ) && ! isset( $value ) ) {
5785
			if ( array_key_exists( $key, $state ) )
5786
				return $state[ $key ];
5787
			return null;
5788
		}
5789
5790
		// Set a state variable
5791
		if ( isset ( $key ) && isset( $value ) ) {
5792
			if( is_array( $value ) && isset( $value[0] ) ) {
5793
				$value = $value[0];
5794
			}
5795
			$state[ $key ] = $value;
5796
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5797
		}
5798
	}
5799
5800
	public static function restate() {
5801
		Jetpack::state( null, null, true );
5802
	}
5803
5804
	public static function check_privacy( $file ) {
5805
		static $is_site_publicly_accessible = null;
5806
5807
		if ( is_null( $is_site_publicly_accessible ) ) {
5808
			$is_site_publicly_accessible = false;
5809
5810
			Jetpack::load_xml_rpc_client();
5811
			$rpc = new Jetpack_IXR_Client();
5812
5813
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5814
			if ( $success ) {
5815
				$response = $rpc->getResponse();
5816
				if ( $response ) {
5817
					$is_site_publicly_accessible = true;
5818
				}
5819
			}
5820
5821
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5822
		}
5823
5824
		if ( $is_site_publicly_accessible ) {
5825
			return;
5826
		}
5827
5828
		$module_slug = self::get_module_slug( $file );
5829
5830
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5831
		if ( ! $privacy_checks ) {
5832
			$privacy_checks = $module_slug;
5833
		} else {
5834
			$privacy_checks .= ",$module_slug";
5835
		}
5836
5837
		Jetpack::state( 'privacy_checks', $privacy_checks );
5838
	}
5839
5840
	/**
5841
	 * Helper method for multicall XMLRPC.
5842
	 */
5843
	public static function xmlrpc_async_call() {
5844
		global $blog_id;
5845
		static $clients = array();
5846
5847
		$client_blog_id = is_multisite() ? $blog_id : 0;
5848
5849
		if ( ! isset( $clients[$client_blog_id] ) ) {
5850
			Jetpack::load_xml_rpc_client();
5851
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5852
			if ( function_exists( 'ignore_user_abort' ) ) {
5853
				ignore_user_abort( true );
5854
			}
5855
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5856
		}
5857
5858
		$args = func_get_args();
5859
5860
		if ( ! empty( $args[0] ) ) {
5861
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5862
		} elseif ( is_multisite() ) {
5863
			foreach ( $clients as $client_blog_id => $client ) {
5864
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5865
					continue;
5866
				}
5867
5868
				$switch_success = switch_to_blog( $client_blog_id, true );
5869
				if ( ! $switch_success ) {
5870
					continue;
5871
				}
5872
5873
				flush();
5874
				$client->query();
5875
5876
				restore_current_blog();
5877
			}
5878
		} else {
5879
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5880
				flush();
5881
				$clients[0]->query();
5882
			}
5883
		}
5884
	}
5885
5886
	public static function staticize_subdomain( $url ) {
5887
5888
		// Extract hostname from URL
5889
		$host = parse_url( $url, PHP_URL_HOST );
5890
5891
		// Explode hostname on '.'
5892
		$exploded_host = explode( '.', $host );
5893
5894
		// Retrieve the name and TLD
5895
		if ( count( $exploded_host ) > 1 ) {
5896
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5897
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5898
			// Rebuild domain excluding subdomains
5899
			$domain = $name . '.' . $tld;
5900
		} else {
5901
			$domain = $host;
5902
		}
5903
		// Array of Automattic domains
5904
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5905
5906
		// Return $url if not an Automattic domain
5907
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5908
			return $url;
5909
		}
5910
5911
		if ( is_ssl() ) {
5912
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5913
		}
5914
5915
		srand( crc32( basename( $url ) ) );
5916
		$static_counter = rand( 0, 2 );
5917
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5918
5919
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5920
	}
5921
5922
/* JSON API Authorization */
5923
5924
	/**
5925
	 * Handles the login action for Authorizing the JSON API
5926
	 */
5927
	function login_form_json_api_authorization() {
5928
		$this->verify_json_api_authorization_request();
5929
5930
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5931
5932
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5933
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5934
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5935
	}
5936
5937
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5938
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5939
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5940
			return $url;
5941
		}
5942
5943
		$parsed_url = parse_url( $url );
5944
		$url = strtok( $url, '?' );
5945
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5946
		if ( ! empty( $parsed_url['query'] ) )
5947
			$url .= "&{$parsed_url['query']}";
5948
5949
		return $url;
5950
	}
5951
5952
	// Make sure the POSTed request is handled by the same action
5953
	function preserve_action_in_login_form_for_json_api_authorization() {
5954
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5955
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5956
	}
5957
5958
	// If someone logs in to approve API access, store the Access Code in usermeta
5959
	function store_json_api_authorization_token( $user_login, $user ) {
5960
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5961
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5962
		$token = wp_generate_password( 32, false );
5963
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5964
	}
5965
5966
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5967
	function allow_wpcom_public_api_domain( $domains ) {
5968
		$domains[] = 'public-api.wordpress.com';
5969
		return $domains;
5970
	}
5971
5972
	// Add all wordpress.com environments to the safe redirect whitelist
5973
	function allow_wpcom_environments( $domains ) {
5974
		$domains[] = 'wordpress.com';
5975
		$domains[] = 'wpcalypso.wordpress.com';
5976
		$domains[] = 'horizon.wordpress.com';
5977
		$domains[] = 'calypso.localhost';
5978
		return $domains;
5979
	}
5980
5981
	// Add the Access Code details to the public-api.wordpress.com redirect
5982
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5983
		return add_query_arg(
5984
			urlencode_deep(
5985
				array(
5986
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5987
					'jetpack-user-id' => (int) $user->ID,
5988
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5989
				)
5990
			),
5991
			$redirect_to
5992
		);
5993
	}
5994
5995
5996
	/**
5997
	 * Verifies the request by checking the signature
5998
	 *
5999
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6000
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6001
	 *
6002
	 * @param null|array $environment
6003
	 */
6004
	function verify_json_api_authorization_request( $environment = null ) {
6005
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6006
6007
		$environment = is_null( $environment )
6008
			? $_REQUEST
6009
			: $environment;
6010
6011
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
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...
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...
6012
		$token = Jetpack_Data::get_access_token( $envUserId );
6013
		if ( ! $token || empty( $token->secret ) ) {
6014
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6015
		}
6016
6017
		$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' );
6018
6019
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6020
6021
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6022
			$signature = $jetpack_signature->sign_request(
6023
				$environment['token'],
6024
				$environment['timestamp'],
6025
				$environment['nonce'],
6026
				'',
6027
				'GET',
6028
				$environment['jetpack_json_api_original_query'],
6029
				null,
6030
				true
6031
			);
6032
		} else {
6033
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6034
		}
6035
6036
		if ( ! $signature ) {
6037
			wp_die( $die_error );
6038
		} else if ( is_wp_error( $signature ) ) {
6039
			wp_die( $die_error );
6040
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
6041
			if ( is_ssl() ) {
6042
				// 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
6043
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6044
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6045
					wp_die( $die_error );
6046
				}
6047
			} else {
6048
				wp_die( $die_error );
6049
			}
6050
		}
6051
6052
		$timestamp = (int) $environment['timestamp'];
6053
		$nonce     = stripslashes( (string) $environment['nonce'] );
6054
6055
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6056
			// De-nonce the nonce, at least for 5 minutes.
6057
			// 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)
6058
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6059
			if ( $old_nonce_time < time() - 300 ) {
6060
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6061
			}
6062
		}
6063
6064
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6065
		$data_filters = array(
6066
			'state'        => 'opaque',
6067
			'client_id'    => 'int',
6068
			'client_title' => 'string',
6069
			'client_image' => 'url',
6070
		);
6071
6072
		foreach ( $data_filters as $key => $sanitation ) {
6073
			if ( ! isset( $data->$key ) ) {
6074
				wp_die( $die_error );
6075
			}
6076
6077
			switch ( $sanitation ) {
6078
			case 'int' :
6079
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6080
				break;
6081
			case 'opaque' :
6082
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6083
				break;
6084
			case 'string' :
6085
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6086
				break;
6087
			case 'url' :
6088
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6089
				break;
6090
			}
6091
		}
6092
6093
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6094
			wp_die( $die_error );
6095
		}
6096
	}
6097
6098
	function login_message_json_api_authorization( $message ) {
6099
		return '<p class="message">' . sprintf(
6100
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6101
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6102
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6103
	}
6104
6105
	/**
6106
	 * Get $content_width, but with a <s>twist</s> filter.
6107
	 */
6108
	public static function get_content_width() {
6109
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6110
		/**
6111
		 * Filter the Content Width value.
6112
		 *
6113
		 * @since 2.2.3
6114
		 *
6115
		 * @param string $content_width Content Width value.
6116
		 */
6117
		return apply_filters( 'jetpack_content_width', $content_width );
6118
	}
6119
6120
	/**
6121
	 * Pings the WordPress.com Mirror Site for the specified options.
6122
	 *
6123
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6124
	 *
6125
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6126
	 */
6127
	public function get_cloud_site_options( $option_names ) {
6128
		$option_names = array_filter( (array) $option_names, 'is_string' );
6129
6130
		Jetpack::load_xml_rpc_client();
6131
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6132
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6133
		if ( $xml->isError() ) {
6134
			return array(
6135
				'error_code' => $xml->getErrorCode(),
6136
				'error_msg'  => $xml->getErrorMessage(),
6137
			);
6138
		}
6139
		$cloud_site_options = $xml->getResponse();
6140
6141
		return $cloud_site_options;
6142
	}
6143
6144
	/**
6145
	 * Checks if the site is currently in an identity crisis.
6146
	 *
6147
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6148
	 */
6149
	public static function check_identity_crisis() {
6150
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6151
			return false;
6152
		}
6153
6154
		return Jetpack_Options::get_option( 'sync_error_idc' );
6155
	}
6156
6157
	/**
6158
	 * Checks whether the home and siteurl specifically are whitelisted
6159
	 * Written so that we don't have re-check $key and $value params every time
6160
	 * we want to check if this site is whitelisted, for example in footer.php
6161
	 *
6162
	 * @since  3.8.0
6163
	 * @return bool True = already whitelisted False = not whitelisted
6164
	 */
6165
	public static function is_staging_site() {
6166
		$is_staging = false;
6167
6168
		$known_staging = array(
6169
			'urls' => array(
6170
				'#\.staging\.wpengine\.com$#i', // WP Engine
6171
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6172
				),
6173
			'constants' => array(
6174
				'IS_WPE_SNAPSHOT',      // WP Engine
6175
				'KINSTA_DEV_ENV',       // Kinsta.com
6176
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6177
				'JETPACK_STAGING_MODE', // Generic
6178
				)
6179
			);
6180
		/**
6181
		 * Filters the flags of known staging sites.
6182
		 *
6183
		 * @since 3.9.0
6184
		 *
6185
		 * @param array $known_staging {
6186
		 *     An array of arrays that each are used to check if the current site is staging.
6187
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6188
		 *     @type array $constants PHP constants of known staging/developement environments.
6189
		 *  }
6190
		 */
6191
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6192
6193
		if ( isset( $known_staging['urls'] ) ) {
6194
			foreach ( $known_staging['urls'] as $url ){
6195
				if ( preg_match( $url, site_url() ) ) {
6196
					$is_staging = true;
6197
					break;
6198
				}
6199
			}
6200
		}
6201
6202
		if ( isset( $known_staging['constants'] ) ) {
6203
			foreach ( $known_staging['constants'] as $constant ) {
6204
				if ( defined( $constant ) && constant( $constant ) ) {
6205
					$is_staging = true;
6206
				}
6207
			}
6208
		}
6209
6210
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6211
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6212
			$is_staging = true;
6213
		}
6214
6215
		/**
6216
		 * Filters is_staging_site check.
6217
		 *
6218
		 * @since 3.9.0
6219
		 *
6220
		 * @param bool $is_staging If the current site is a staging site.
6221
		 */
6222
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6223
	}
6224
6225
	/**
6226
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6227
	 *
6228
	 * @since 4.4.0
6229
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6230
	 *
6231
	 * @return bool
6232
	 */
6233
	public static function validate_sync_error_idc_option() {
6234
		$is_valid = false;
6235
6236
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6237
		if ( false === $idc_allowed ) {
6238
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6239
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6240
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6241
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6242
				$transient_duration = HOUR_IN_SECONDS;
6243
			} else {
6244
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6245
				$idc_allowed = '1';
6246
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6247
			}
6248
6249
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6250
		}
6251
6252
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6253
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6254
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6255
			$local_options = self::get_sync_error_idc_option();
6256
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6257
				$is_valid = true;
6258
			}
6259
		}
6260
6261
		/**
6262
		 * Filters whether the sync_error_idc option is valid.
6263
		 *
6264
		 * @since 4.4.0
6265
		 *
6266
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6267
		 */
6268
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6269
6270
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6271
			// Since the option exists, and did not validate, delete it
6272
			Jetpack_Options::delete_option( 'sync_error_idc' );
6273
		}
6274
6275
		return $is_valid;
6276
	}
6277
6278
	/**
6279
	 * Normalizes a url by doing three things:
6280
	 *  - Strips protocol
6281
	 *  - Strips www
6282
	 *  - Adds a trailing slash
6283
	 *
6284
	 * @since 4.4.0
6285
	 * @param string $url
6286
	 * @return WP_Error|string
6287
	 */
6288
	public static function normalize_url_protocol_agnostic( $url ) {
6289
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6290
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6291
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6292
		}
6293
6294
		// Strip www and protocols
6295
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6296
		return $url;
6297
	}
6298
6299
	/**
6300
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6301
	 *
6302
	 * @since 4.4.0
6303
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6304
	 *
6305
	 * @param array $response
6306
	 * @return array Array of the local urls, wpcom urls, and error code
6307
	 */
6308
	public static function get_sync_error_idc_option( $response = array() ) {
6309
		// Since the local options will hit the database directly, store the values
6310
		// in a transient to allow for autoloading and caching on subsequent views.
6311
		$local_options = get_transient( 'jetpack_idc_local' );
6312
		if ( false === $local_options ) {
6313
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6314
			$local_options = array(
6315
				'home'    => Jetpack_Sync_Functions::home_url(),
6316
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6317
			);
6318
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6319
		}
6320
6321
		$options = array_merge( $local_options, $response );
6322
6323
		$returned_values = array();
6324
		foreach( $options as $key => $option ) {
6325
			if ( 'error_code' === $key ) {
6326
				$returned_values[ $key ] = $option;
6327
				continue;
6328
			}
6329
6330
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6331
				continue;
6332
			}
6333
6334
			$returned_values[ $key ] = $normalized_url;
6335
		}
6336
6337
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6338
6339
		return $returned_values;
6340
	}
6341
6342
	/**
6343
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6344
	 * If set to true, the site will be put into staging mode.
6345
	 *
6346
	 * @since 4.3.2
6347
	 * @return bool
6348
	 */
6349
	public static function sync_idc_optin() {
6350
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6351
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6352
		} else {
6353
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6354
		}
6355
6356
		/**
6357
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6358
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6359
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6360
		 *
6361
		 * @since 4.3.2
6362
		 *
6363
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6364
		 */
6365
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6366
	}
6367
6368
	/**
6369
	 * Maybe Use a .min.css stylesheet, maybe not.
6370
	 *
6371
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6372
	 */
6373
	public static function maybe_min_asset( $url, $path, $plugin ) {
6374
		// Short out on things trying to find actual paths.
6375
		if ( ! $path || empty( $plugin ) ) {
6376
			return $url;
6377
		}
6378
6379
		$path = ltrim( $path, '/' );
6380
6381
		// Strip out the abspath.
6382
		$base = dirname( plugin_basename( $plugin ) );
6383
6384
		// Short out on non-Jetpack assets.
6385
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6386
			return $url;
6387
		}
6388
6389
		// File name parsing.
6390
		$file              = "{$base}/{$path}";
6391
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6392
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6393
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6394
		$extension         = array_shift( $file_name_parts_r );
6395
6396
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6397
			// Already pointing at the minified version.
6398
			if ( 'min' === $file_name_parts_r[0] ) {
6399
				return $url;
6400
			}
6401
6402
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6403
			if ( file_exists( $min_full_path ) ) {
6404
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6405
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6406
				if ( 'css' === $extension ) {
6407
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6408
					self::$min_assets[ $key ] = $path;
6409
				}
6410
			}
6411
		}
6412
6413
		return $url;
6414
	}
6415
6416
	/**
6417
	 * If the asset is minified, let's flag .min as the suffix.
6418
	 *
6419
	 * Attached to `style_loader_src` filter.
6420
	 *
6421
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
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...
6422
	 * @param string $handle The registered handle of the script in question.
6423
	 * @param string $href The url of the asset in question.
0 ignored issues
show
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...
6424
	 */
6425
	public static function set_suffix_on_min( $src, $handle ) {
6426
		if ( false === strpos( $src, '.min.css' ) ) {
6427
			return $src;
6428
		}
6429
6430
		if ( ! empty( self::$min_assets ) ) {
6431
			foreach ( self::$min_assets as $file => $path ) {
6432
				if ( false !== strpos( $src, $file ) ) {
6433
					wp_style_add_data( $handle, 'suffix', '.min' );
6434
					return $src;
6435
				}
6436
			}
6437
		}
6438
6439
		return $src;
6440
	}
6441
6442
	/**
6443
	 * Maybe inlines a stylesheet.
6444
	 *
6445
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6446
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6447
	 *
6448
	 * Attached to `style_loader_tag` filter.
6449
	 *
6450
	 * @param string $tag The tag that would link to the external asset.
6451
	 * @param string $handle The registered handle of the script in question.
6452
	 *
6453
	 * @return string
6454
	 */
6455
	public static function maybe_inline_style( $tag, $handle ) {
6456
		global $wp_styles;
6457
		$item = $wp_styles->registered[ $handle ];
6458
6459
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6460
			return $tag;
6461
		}
6462
6463
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6464
			$href = $matches[1];
6465
			// Strip off query string
6466
			if ( $pos = strpos( $href, '?' ) ) {
6467
				$href = substr( $href, 0, $pos );
6468
			}
6469
			// Strip off fragment
6470
			if ( $pos = strpos( $href, '#' ) ) {
6471
				$href = substr( $href, 0, $pos );
6472
			}
6473
		} else {
6474
			return $tag;
6475
		}
6476
6477
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6478
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6479
			return $tag;
6480
		}
6481
6482
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6483
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6484
			// And this isn't the pass that actually deals with the RTL version...
6485
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6486
				// Short out, as the RTL version will deal with it in a moment.
6487
				return $tag;
6488
			}
6489
		}
6490
6491
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6492
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6493
		if ( $css ) {
6494
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6495
			if ( empty( $item->extra['after'] ) ) {
6496
				wp_add_inline_style( $handle, $css );
6497
			} else {
6498
				array_unshift( $item->extra['after'], $css );
6499
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6500
			}
6501
		}
6502
6503
		return $tag;
6504
	}
6505
6506
	/**
6507
	 * Loads a view file from the views
6508
	 *
6509
	 * Data passed in with the $data parameter will be available in the
6510
	 * template file as $data['value']
6511
	 *
6512
	 * @param string $template - Template file to load
6513
	 * @param array $data - Any data to pass along to the template
6514
	 * @return boolean - If template file was found
6515
	 **/
6516
	public function load_view( $template, $data = array() ) {
6517
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6518
6519
		if( file_exists( $views_dir . $template ) ) {
6520
			require_once( $views_dir . $template );
6521
			return true;
6522
		}
6523
6524
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6525
		return false;
6526
	}
6527
6528
	/**
6529
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6530
	 */
6531
	public function deprecated_hooks() {
6532
		global $wp_filter;
6533
6534
		/*
6535
		 * Format:
6536
		 * deprecated_filter_name => replacement_name
6537
		 *
6538
		 * If there is no replacement, use null for replacement_name
6539
		 */
6540
		$deprecated_list = array(
6541
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6542
			'wpl_sharing_2014_1'                                     => null,
6543
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6544
			'jetpack_identity_crisis_options_to_check'               => null,
6545
			'update_option_jetpack_single_user_site'                 => null,
6546
			'audio_player_default_colors'                            => null,
6547
			'add_option_jetpack_featured_images_enabled'             => null,
6548
			'add_option_jetpack_update_details'                      => null,
6549
			'add_option_jetpack_updates'                             => null,
6550
			'add_option_jetpack_network_name'                        => null,
6551
			'add_option_jetpack_network_allow_new_registrations'     => null,
6552
			'add_option_jetpack_network_add_new_users'               => null,
6553
			'add_option_jetpack_network_site_upload_space'           => null,
6554
			'add_option_jetpack_network_upload_file_types'           => null,
6555
			'add_option_jetpack_network_enable_administration_menus' => null,
6556
			'add_option_jetpack_is_multi_site'                       => null,
6557
			'add_option_jetpack_is_main_network'                     => null,
6558
			'add_option_jetpack_main_network_site'                   => null,
6559
			'jetpack_sync_all_registered_options'                    => null,
6560
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6561
			'jetpack_is_post_mailable'                               => null,
6562
			'jetpack_seo_site_host'                                  => null,
6563
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6564
			'jetpack_holiday_snow_option_name'                       => null,
6565
			'jetpack_holiday_chance_of_snow'                         => null,
6566
			'jetpack_holiday_snow_js_url'                            => null,
6567
			'jetpack_is_holiday_snow_season'                         => null,
6568
			'jetpack_holiday_snow_option_updated'                    => null,
6569
			'jetpack_holiday_snowing'                                => null,
6570
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6571
		);
6572
6573
		// This is a silly loop depth. Better way?
6574
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6575
			if ( has_action( $hook ) ) {
6576
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6577
					foreach( $values AS $hooked ) {
6578
						if ( is_callable( $hooked['function'] ) ) {
6579
							$function_name = 'an anonymous function';
6580
						} else {
6581
							$function_name = $hooked['function'];
6582
						}
6583
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6584
					}
6585
				}
6586
			}
6587
		}
6588
	}
6589
6590
	/**
6591
	 * Converts any url in a stylesheet, to the correct absolute url.
6592
	 *
6593
	 * Considerations:
6594
	 *  - Normal, relative URLs     `feh.png`
6595
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6596
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6597
	 *  - Absolute URLs             `http://domain.com/feh.png`
6598
	 *  - Domain root relative URLs `/feh.png`
6599
	 *
6600
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6601
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6602
	 *
6603
	 * @return mixed|string
6604
	 */
6605
	public static function absolutize_css_urls( $css, $css_file_url ) {
6606
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6607
		$css_dir = dirname( $css_file_url );
6608
		$p       = parse_url( $css_dir );
6609
		$domain  = sprintf(
6610
					'%1$s//%2$s%3$s%4$s',
6611
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6612
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6613
					$p['host'],
6614
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6615
				);
6616
6617
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6618
			$find = $replace = array();
6619
			foreach ( $matches as $match ) {
6620
				$url = trim( $match['path'], "'\" \t" );
6621
6622
				// If this is a data url, we don't want to mess with it.
6623
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6624
					continue;
6625
				}
6626
6627
				// If this is an absolute or protocol-agnostic url,
6628
				// we don't want to mess with it.
6629
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6630
					continue;
6631
				}
6632
6633
				switch ( substr( $url, 0, 1 ) ) {
6634
					case '/':
6635
						$absolute = $domain . $url;
6636
						break;
6637
					default:
6638
						$absolute = $css_dir . '/' . $url;
6639
				}
6640
6641
				$find[]    = $match[0];
6642
				$replace[] = sprintf( 'url("%s")', $absolute );
6643
			}
6644
			$css = str_replace( $find, $replace, $css );
6645
		}
6646
6647
		return $css;
6648
	}
6649
6650
	/**
6651
	 * This methods removes all of the registered css files on the front end
6652
	 * from Jetpack in favor of using a single file. In effect "imploding"
6653
	 * all the files into one file.
6654
	 *
6655
	 * Pros:
6656
	 * - Uses only ONE css asset connection instead of 15
6657
	 * - Saves a minimum of 56k
6658
	 * - Reduces server load
6659
	 * - Reduces time to first painted byte
6660
	 *
6661
	 * Cons:
6662
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6663
	 *		should not cause any issues with themes.
6664
	 * - Plugins/themes dequeuing styles no longer do anything. See
6665
	 *		jetpack_implode_frontend_css filter for a workaround
6666
	 *
6667
	 * For some situations developers may wish to disable css imploding and
6668
	 * instead operate in legacy mode where each file loads seperately and
6669
	 * can be edited individually or dequeued. This can be accomplished with
6670
	 * the following line:
6671
	 *
6672
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6673
	 *
6674
	 * @since 3.2
6675
	 **/
6676
	public function implode_frontend_css( $travis_test = false ) {
6677
		$do_implode = true;
6678
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6679
			$do_implode = false;
6680
		}
6681
6682
		/**
6683
		 * Allow CSS to be concatenated into a single jetpack.css file.
6684
		 *
6685
		 * @since 3.2.0
6686
		 *
6687
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6688
		 */
6689
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6690
6691
		// Do not use the imploded file when default behaviour was altered through the filter
6692
		if ( ! $do_implode ) {
6693
			return;
6694
		}
6695
6696
		// We do not want to use the imploded file in dev mode, or if not connected
6697
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6698
			if ( ! $travis_test ) {
6699
				return;
6700
			}
6701
		}
6702
6703
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6704
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6705
			return;
6706
		}
6707
6708
		/*
6709
		 * Now we assume Jetpack is connected and able to serve the single
6710
		 * file.
6711
		 *
6712
		 * In the future there will be a check here to serve the file locally
6713
		 * or potentially from the Jetpack CDN
6714
		 *
6715
		 * For now:
6716
		 * - Enqueue a single imploded css file
6717
		 * - Zero out the style_loader_tag for the bundled ones
6718
		 * - Be happy, drink scotch
6719
		 */
6720
6721
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6722
6723
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6724
6725
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6726
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6727
	}
6728
6729
	function concat_remove_style_loader_tag( $tag, $handle ) {
6730
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6731
			$tag = '';
6732
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6733
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6734
			}
6735
		}
6736
6737
		return $tag;
6738
	}
6739
6740
	/*
6741
	 * Check the heartbeat data
6742
	 *
6743
	 * Organizes the heartbeat data by severity.  For example, if the site
6744
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6745
	 *
6746
	 * Data will be added to "caution" array, if it either:
6747
	 *  - Out of date Jetpack version
6748
	 *  - Out of date WP version
6749
	 *  - Out of date PHP version
6750
	 *
6751
	 * $return array $filtered_data
6752
	 */
6753
	public static function jetpack_check_heartbeat_data() {
6754
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6755
6756
		$good    = array();
6757
		$caution = array();
6758
		$bad     = array();
6759
6760
		foreach ( $raw_data as $stat => $value ) {
6761
6762
			// Check jetpack version
6763
			if ( 'version' == $stat ) {
6764
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6765
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6766
					continue;
6767
				}
6768
			}
6769
6770
			// Check WP version
6771
			if ( 'wp-version' == $stat ) {
6772
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6773
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6774
					continue;
6775
				}
6776
			}
6777
6778
			// Check PHP version
6779
			if ( 'php-version' == $stat ) {
6780
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6781
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6782
					continue;
6783
				}
6784
			}
6785
6786
			// Check ID crisis
6787
			if ( 'identitycrisis' == $stat ) {
6788
				if ( 'yes' == $value ) {
6789
					$bad[ $stat ] = $value;
6790
					continue;
6791
				}
6792
			}
6793
6794
			// The rest are good :)
6795
			$good[ $stat ] = $value;
6796
		}
6797
6798
		$filtered_data = array(
6799
			'good'    => $good,
6800
			'caution' => $caution,
6801
			'bad'     => $bad
6802
		);
6803
6804
		return $filtered_data;
6805
	}
6806
6807
6808
	/*
6809
	 * This method is used to organize all options that can be reset
6810
	 * without disconnecting Jetpack.
6811
	 *
6812
	 * It is used in class.jetpack-cli.php to reset options
6813
	 *
6814
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6815
	 *
6816
	 * @return array of options to delete.
6817
	 */
6818
	public static function get_jetpack_options_for_reset() {
6819
		return Jetpack_Options::get_options_for_reset();
6820
	}
6821
6822
	/**
6823
	 * Check if an option of a Jetpack module has been updated.
6824
	 *
6825
	 * If any module option has been updated before Jump Start has been dismissed,
6826
	 * update the 'jumpstart' option so we can hide Jump Start.
6827
	 *
6828
	 * @param string $option_name
6829
	 *
6830
	 * @return bool
6831
	 */
6832
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6833
		// Bail if Jump Start has already been dismissed
6834
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6835
			return false;
6836
		}
6837
6838
		$jetpack = Jetpack::init();
6839
6840
		// Manual build of module options
6841
		$option_names = self::get_jetpack_options_for_reset();
6842
6843
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6844
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6845
6846
			//Jump start is being dismissed send data to MC Stats
6847
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6848
6849
			$jetpack->do_stats( 'server_side' );
6850
		}
6851
6852
	}
6853
6854
	/*
6855
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6856
	 * so we can bring them directly to their site in calypso.
6857
	 *
6858
	 * @param string | url
6859
	 * @return string | url without the guff
6860
	 */
6861
	public static function build_raw_urls( $url ) {
6862
		$strip_http = '/.*?:\/\//i';
6863
		$url = preg_replace( $strip_http, '', $url  );
6864
		$url = str_replace( '/', '::', $url );
6865
		return $url;
6866
	}
6867
6868
	/**
6869
	 * Stores and prints out domains to prefetch for page speed optimization.
6870
	 *
6871
	 * @param mixed $new_urls
6872
	 */
6873
	public static function dns_prefetch( $new_urls = null ) {
6874
		static $prefetch_urls = array();
6875
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6876
			echo "\r\n";
6877
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6878
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6879
			}
6880
		} elseif ( ! empty( $new_urls ) ) {
6881
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6882
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6883
			}
6884
			foreach ( (array) $new_urls as $this_new_url ) {
6885
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6886
			}
6887
			$prefetch_urls = array_unique( $prefetch_urls );
6888
		}
6889
	}
6890
6891
	public function wp_dashboard_setup() {
6892
		if ( self::is_active() ) {
6893
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6894
		}
6895
6896
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6897
			wp_add_dashboard_widget(
6898
				'jetpack_summary_widget',
6899
				esc_html__( 'Site Stats', 'jetpack' ),
6900
				array( __CLASS__, 'dashboard_widget' )
6901
			);
6902
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6903
6904
			// If we're inactive and not in development mode, sort our box to the top.
6905
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6906
				global $wp_meta_boxes;
6907
6908
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6909
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6910
6911
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6912
			}
6913
		}
6914
	}
6915
6916
	/**
6917
	 * @param mixed $result Value for the user's option
0 ignored issues
show
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...
6918
	 * @return mixed
6919
	 */
6920
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6921
		if ( ! is_array( $sorted ) ) {
6922
			return $sorted;
6923
		}
6924
6925
		foreach ( $sorted as $box_context => $ids ) {
6926
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6927
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6928
				continue;
6929
			}
6930
6931
			$ids_array = explode( ',', $ids );
6932
			$key = array_search( 'dashboard_stats', $ids_array );
6933
6934
			if ( false !== $key ) {
6935
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6936
				$ids_array[ $key ] = 'jetpack_summary_widget';
6937
				$sorted[ $box_context ] = implode( ',', $ids_array );
6938
				// We've found it, stop searching, and just return.
6939
				break;
6940
			}
6941
		}
6942
6943
		return $sorted;
6944
	}
6945
6946
	public static function dashboard_widget() {
6947
		/**
6948
		 * Fires when the dashboard is loaded.
6949
		 *
6950
		 * @since 3.4.0
6951
		 */
6952
		do_action( 'jetpack_dashboard_widget' );
6953
	}
6954
6955
	public static function dashboard_widget_footer() {
6956
		?>
6957
		<footer>
6958
6959
		<div class="protect">
6960
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6961
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6962
				<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>
6963
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6964
				<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' ); ?>">
6965
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6966
				</a>
6967
			<?php else : ?>
6968
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6969
			<?php endif; ?>
6970
		</div>
6971
6972
		<div class="akismet">
6973
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6974
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6975
				<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>
6976
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6977
				<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">
6978
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6979
				</a>
6980
			<?php else : ?>
6981
				<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>
6982
			<?php endif; ?>
6983
		</div>
6984
6985
		</footer>
6986
		<?php
6987
	}
6988
6989
	/**
6990
	 * Return string containing the Jetpack logo.
6991
	 *
6992
	 * @since 3.9.0
6993
	 *
6994
	 * @return string
6995
	 */
6996
	public static function get_jp_emblem() {
6997
		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>';
6998
	}
6999
7000
	/*
7001
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7002
	 */
7003
	function jetpack_icon_user_connected( $columns ) {
7004
		$columns['user_jetpack'] = '';
7005
		return $columns;
7006
	}
7007
7008
	/*
7009
	 * Show Jetpack icon if the user is linked.
7010
	 */
7011
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7012
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7013
			$emblem_html = sprintf(
7014
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7015
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7016
				Jetpack::get_jp_emblem()
7017
			);
7018
			return $emblem_html;
7019
		}
7020
7021
		return $val;
7022
	}
7023
7024
	/*
7025
	 * Style the Jetpack user column
7026
	 */
7027
	function jetpack_user_col_style() {
7028
		global $current_screen;
7029
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7030
			<style>
7031
				.fixed .column-user_jetpack {
7032
					width: 21px;
7033
				}
7034
				.jp-emblem-user-admin svg {
7035
					width: 20px;
7036
					height: 20px;
7037
				}
7038
				.jp-emblem-user-admin path {
7039
					fill: #00BE28;
7040
				}
7041
			</style>
7042
		<?php }
7043
	}
7044
7045
	/**
7046
	 * Checks if Akismet is active and working.
7047
	 *
7048
	 * @since  5.1.0
7049
	 * @return bool True = Akismet available. False = Aksimet not available.
7050
	 */
7051
	public static function is_akismet_active() {
7052
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
7053
			return true;
7054
		}
7055
		return false;
7056
	}
7057
7058
	/**
7059
	 * Checks if one or more function names is in debug_backtrace
7060
	 *
7061
	 * @param $names Mixed string name of function or array of string names of functions
7062
	 *
7063
	 * @return bool
7064
	 */
7065
	public static function is_function_in_backtrace( $names ) {
7066
		$backtrace = debug_backtrace( false );
7067
		if ( ! is_array( $names ) ) {
7068
			$names = array( $names );
7069
		}
7070
		$names_as_keys = array_flip( $names );
7071
7072
		//Do check in constant O(1) time for PHP5.5+
7073
		if ( function_exists( 'array_column' ) ) {
7074
			$backtrace_functions = array_column( $backtrace, 'function' );
7075
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7076
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7077
			return ! empty ( $intersection );
7078
		}
7079
7080
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7081
		foreach ( $backtrace as $call ) {
7082
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7083
				return true;
7084
			}
7085
		}
7086
		return false;
7087
	}
7088
7089
	/**
7090
	 * Given a minified path, and a non-minified path, will return
7091
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7092
	 *
7093
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7094
	 * root Jetpack directory.
7095
	 *
7096
	 * @since 5.6.0
7097
	 *
7098
	 * @param string $min_path
7099
	 * @param string $non_min_path
7100
	 * @return string The URL to the file
7101
	 */
7102
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7103
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7104
			? $non_min_path
7105
			: $min_path;
7106
7107
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7108
	}
7109
7110
	/**
7111
	 * Checks for whether Jetpack Rewind is enabled.
7112
	 * Will return true if the state of Rewind is anything except "unavailable".
7113
	 * @return bool|int|mixed
7114
	 */
7115
	public static function is_rewind_enabled() {
7116
		if ( ! Jetpack::is_active() ) {
7117
			return false;
7118
		}
7119
7120
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7121
		if ( false === $rewind_enabled ) {
7122
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7123
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7124
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7125
				&& ! empty( $rewind_data['state'] )
7126
				&& 'active' === $rewind_data['state'] )
7127
				? 1
7128
				: 0;
7129
7130
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7131
		}
7132
		return $rewind_enabled;
7133
	}
7134
7135
	/**
7136
	 * Checks whether or not TOS has been agreed upon.
7137
	 * Will return true if a user has clicked to register, or is already connected.
7138
	 */
7139
	public static function jetpack_tos_agreed() {
7140
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7141
	}
7142
}
7143