Completed
Push — update/security-widget-languag... ( 75ac2c...0fa1b8 )
by
unknown
126:04 queued 116:11
created

Jetpack::get_update_details()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

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

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

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
704
705
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
706
	}
707
708
	function point_edit_comment_links_to_calypso( $url ) {
709
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
710
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

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

Loading history...
711
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
712
			Jetpack::build_raw_urls( get_home_url() ),
713
			$query_args['amp;c']
714
		) );
715
	}
716
717
	function jetpack_track_last_sync_callback( $params ) {
718
		/**
719
		 * Filter to turn off jitm caching
720
		 *
721
		 * @since 5.4.0
722
		 *
723
		 * @param bool false Whether to cache just in time messages
724
		 */
725
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
726
			return $params;
727
		}
728
729
		if ( is_array( $params ) && isset( $params[0] ) ) {
730
			$option = $params[0];
731
			if ( 'active_plugins' === $option ) {
732
				// use the cache if we can, but not terribly important if it gets evicted
733
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
734
			}
735
		}
736
737
		return $params;
738
	}
739
740
	function jetpack_connection_banner_callback() {
741
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
742
743
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
744
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
745
			wp_send_json_success();
746
		}
747
748
		wp_die();
749
	}
750
751
	function jetpack_admin_ajax_tracks_callback() {
752
		// Check for nonce
753
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
754
			wp_die( 'Permissions check failed.' );
755
		}
756
757
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
758
			wp_die( 'No valid event name or type.' );
759
		}
760
761
		$tracks_data = array();
762
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
763
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
764
				$tracks_data = $_REQUEST['tracksEventProp'];
765
			} else {
766
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
767
			}
768
		}
769
770
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
771
		wp_send_json_success();
772
		wp_die();
773
	}
774
775
	/**
776
	 * The callback for the JITM ajax requests.
777
	 */
778
	function jetpack_jitm_ajax_callback() {
779
		// Check for nonce
780
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
781
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
782
		}
783
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
784
			$module_slug = $_REQUEST['jitmModule'];
785
			Jetpack::log( 'activate', $module_slug );
786
			Jetpack::activate_module( $module_slug, false, false );
787
			Jetpack::state( 'message', 'no_message' );
788
789
			//A Jetpack module is being activated through a JITM, track it
790
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
791
			$this->do_stats( 'server_side' );
792
793
			wp_send_json_success();
794
		}
795
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
796
			// get the hide_jitm options array
797
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
798
			$module_slug = $_REQUEST['jitmModule'];
799
800
			if( ! $jetpack_hide_jitm ) {
801
				$jetpack_hide_jitm = array(
802
					$module_slug => 'hide'
803
				);
804
			} else {
805
				$jetpack_hide_jitm[$module_slug] = 'hide';
806
			}
807
808
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
809
810
			//jitm is being dismissed forever, track it
811
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
812
			$this->do_stats( 'server_side' );
813
814
			wp_send_json_success();
815
		}
816 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
817
			$module_slug = $_REQUEST['jitmModule'];
818
819
			// User went to WordPress.com, track this
820
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
821
			$this->do_stats( 'server_side' );
822
823
			wp_send_json_success();
824
		}
825 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
826
			$track = $_REQUEST['jitmModule'];
827
828
			// User is viewing JITM, track it.
829
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
830
			$this->do_stats( 'server_side' );
831
832
			wp_send_json_success();
833
		}
834
	}
835
836
	/**
837
	 * If there are any stats that need to be pushed, but haven't been, push them now.
838
	 */
839
	function push_stats() {
840
		if ( ! empty( $this->stats ) ) {
841
			$this->do_stats( 'server_side' );
842
		}
843
	}
844
845
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
846
		switch( $cap ) {
847
			case 'jetpack_connect' :
848
			case 'jetpack_reconnect' :
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
849
				if ( Jetpack::is_development_mode() ) {
850
					$caps = array( 'do_not_allow' );
851
					break;
852
				}
853
				/**
854
				 * Pass through. If it's not development mode, these should match disconnect.
855
				 * Let users disconnect if it's development mode, just in case things glitch.
856
				 */
857
			case 'jetpack_disconnect' :
858
				/**
859
				 * In multisite, can individual site admins manage their own connection?
860
				 *
861
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
862
				 */
863
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
864
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
865
						/**
866
						 * We need to update the option name -- it's terribly unclear which
867
						 * direction the override goes.
868
						 *
869
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
870
						 */
871
						$caps = array( 'do_not_allow' );
872
						break;
873
					}
874
				}
875
876
				$caps = array( 'manage_options' );
877
				break;
878
			case 'jetpack_manage_modules' :
879
			case 'jetpack_activate_modules' :
880
			case 'jetpack_deactivate_modules' :
881
				$caps = array( 'manage_options' );
882
				break;
883
			case 'jetpack_configure_modules' :
884
				$caps = array( 'manage_options' );
885
				break;
886
			case 'jetpack_network_admin_page':
887
			case 'jetpack_network_settings_page':
888
				$caps = array( 'manage_network_plugins' );
889
				break;
890
			case 'jetpack_network_sites_page':
891
				$caps = array( 'manage_sites' );
892
				break;
893
			case 'jetpack_admin_page' :
894
				if ( Jetpack::is_development_mode() ) {
895
					$caps = array( 'manage_options' );
896
					break;
897
				} else {
898
					$caps = array( 'read' );
899
				}
900
				break;
901
			case 'jetpack_connect_user' :
902
				if ( Jetpack::is_development_mode() ) {
903
					$caps = array( 'do_not_allow' );
904
					break;
905
				}
906
				$caps = array( 'read' );
907
				break;
908
		}
909
		return $caps;
910
	}
911
912
	function require_jetpack_authentication() {
913
		// Don't let anyone authenticate
914
		$_COOKIE = array();
915
		remove_all_filters( 'authenticate' );
916
		remove_all_actions( 'wp_login_failed' );
917
918
		if ( Jetpack::is_active() ) {
919
			// Allow Jetpack authentication
920
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
921
		}
922
	}
923
924
	/**
925
	 * Load language files
926
	 * @action plugins_loaded
927
	 */
928
	public static function plugin_textdomain() {
929
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
930
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
931
	}
932
933
	/**
934
	 * Register assets for use in various modules and the Jetpack admin page.
935
	 *
936
	 * @uses wp_script_is, wp_register_script, plugins_url
937
	 * @action wp_loaded
938
	 * @return null
939
	 */
940
	public function register_assets() {
941
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
942
			wp_register_script(
943
				'spin',
944
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
945
				false,
946
				'1.3'
947
			);
948
		}
949
950
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
951
			wp_register_script(
952
				'jquery.spin',
953
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
954
				array( 'jquery', 'spin' ),
955
				'1.3'
956
			);
957
		}
958
959 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
960
			wp_register_script(
961
				'jetpack-gallery-settings',
962
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
963
				array( 'media-views' ),
964
				'20121225'
965
			);
966
		}
967
968
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
969
			wp_register_script(
970
				'jetpack-twitter-timeline',
971
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
972
				array( 'jquery' ),
973
				'4.0.0',
974
				true
975
			);
976
		}
977
978
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
979
			wp_register_script(
980
				'jetpack-facebook-embed',
981
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
982
				array( 'jquery' ),
983
				null,
984
				true
985
			);
986
987
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
988
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
989
			if ( ! is_numeric( $fb_app_id ) ) {
990
				$fb_app_id = '';
991
			}
992
			wp_localize_script(
993
				'jetpack-facebook-embed',
994
				'jpfbembed',
995
				array(
996
					'appid' => $fb_app_id,
997
					'locale' => $this->get_locale(),
998
				)
999
			);
1000
		}
1001
1002
		/**
1003
		 * As jetpack_register_genericons is by default fired off a hook,
1004
		 * the hook may have already fired by this point.
1005
		 * So, let's just trigger it manually.
1006
		 */
1007
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1008
		jetpack_register_genericons();
1009
1010
		/**
1011
		 * Register the social logos
1012
		 */
1013
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1014
		jetpack_register_social_logos();
1015
1016 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1017
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1018
	}
1019
1020
	/**
1021
	 * Guess locale from language code.
1022
	 *
1023
	 * @param string $lang Language code.
1024
	 * @return string|bool
1025
	 */
1026
	function guess_locale_from_lang( $lang ) {
1027
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1028
			return 'en_US';
1029
		}
1030
1031 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1032
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1033
				return false;
1034
			}
1035
1036
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1037
		}
1038
1039
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1040
			// WP.com: get_locale() returns 'it'
1041
			$locale = GP_Locales::by_slug( $lang );
1042
		} else {
1043
			// Jetpack: get_locale() returns 'it_IT';
1044
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1045
		}
1046
1047
		if ( ! $locale ) {
1048
			return false;
1049
		}
1050
1051
		if ( empty( $locale->facebook_locale ) ) {
1052
			if ( empty( $locale->wp_locale ) ) {
1053
				return false;
1054
			} else {
1055
				// Facebook SDK is smart enough to fall back to en_US if a
1056
				// locale isn't supported. Since supported Facebook locales
1057
				// can fall out of sync, we'll attempt to use the known
1058
				// wp_locale value and rely on said fallback.
1059
				return $locale->wp_locale;
1060
			}
1061
		}
1062
1063
		return $locale->facebook_locale;
1064
	}
1065
1066
	/**
1067
	 * Get the locale.
1068
	 *
1069
	 * @return string|bool
1070
	 */
1071
	function get_locale() {
1072
		$locale = $this->guess_locale_from_lang( get_locale() );
1073
1074
		if ( ! $locale ) {
1075
			$locale = 'en_US';
1076
		}
1077
1078
		return $locale;
1079
	}
1080
1081
	/**
1082
	 * Device Pixels support
1083
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1084
	 */
1085
	function devicepx() {
1086
		if ( Jetpack::is_active() ) {
1087
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1088
		}
1089
	}
1090
1091
	/**
1092
	 * Return the network_site_url so that .com knows what network this site is a part of.
1093
	 * @param  bool $option
1094
	 * @return string
1095
	 */
1096
	public function jetpack_main_network_site_option( $option ) {
1097
		return network_site_url();
1098
	}
1099
	/**
1100
	 * Network Name.
1101
	 */
1102
	static function network_name( $option = null ) {
1103
		global $current_site;
1104
		return $current_site->site_name;
1105
	}
1106
	/**
1107
	 * Does the network allow new user and site registrations.
1108
	 * @return string
1109
	 */
1110
	static function network_allow_new_registrations( $option = null ) {
1111
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1112
	}
1113
	/**
1114
	 * Does the network allow admins to add new users.
1115
	 * @return boolian
1116
	 */
1117
	static function network_add_new_users( $option = null ) {
1118
		return (bool) get_site_option( 'add_new_users' );
1119
	}
1120
	/**
1121
	 * File upload psace left per site in MB.
1122
	 *  -1 means NO LIMIT.
1123
	 * @return number
1124
	 */
1125
	static function network_site_upload_space( $option = null ) {
1126
		// value in MB
1127
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1128
	}
1129
1130
	/**
1131
	 * Network allowed file types.
1132
	 * @return string
1133
	 */
1134
	static function network_upload_file_types( $option = null ) {
1135
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1136
	}
1137
1138
	/**
1139
	 * Maximum file upload size set by the network.
1140
	 * @return number
1141
	 */
1142
	static function network_max_upload_file_size( $option = null ) {
1143
		// value in KB
1144
		return get_site_option( 'fileupload_maxk', 300 );
1145
	}
1146
1147
	/**
1148
	 * Lets us know if a site allows admins to manage the network.
1149
	 * @return array
1150
	 */
1151
	static function network_enable_administration_menus( $option = null ) {
1152
		return get_site_option( 'menu_items' );
1153
	}
1154
1155
	/**
1156
	 * If a user has been promoted to or demoted from admin, we need to clear the
1157
	 * jetpack_other_linked_admins transient.
1158
	 *
1159
	 * @since 4.3.2
1160
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1161
	 *
1162
	 * @param int    $user_id   The user ID whose role changed.
1163
	 * @param string $role      The new role.
1164
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1165
	 */
1166
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1167
		if ( 'administrator' == $role
1168
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1169
			|| is_null( $old_roles )
1170
		) {
1171
			delete_transient( 'jetpack_other_linked_admins' );
1172
		}
1173
	}
1174
1175
	/**
1176
	 * Checks to see if there are any other users available to become primary
1177
	 * Users must both:
1178
	 * - Be linked to wpcom
1179
	 * - Be an admin
1180
	 *
1181
	 * @return mixed False if no other users are linked, Int if there are.
1182
	 */
1183
	static function get_other_linked_admins() {
1184
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1185
1186
		if ( false === $other_linked_users ) {
1187
			$admins = get_users( array( 'role' => 'administrator' ) );
1188
			if ( count( $admins ) > 1 ) {
1189
				$available = array();
1190
				foreach ( $admins as $admin ) {
1191
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1192
						$available[] = $admin->ID;
1193
					}
1194
				}
1195
1196
				$count_connected_admins = count( $available );
1197
				if ( count( $available ) > 1 ) {
1198
					$other_linked_users = $count_connected_admins;
1199
				} else {
1200
					$other_linked_users = 0;
1201
				}
1202
			} else {
1203
				$other_linked_users = 0;
1204
			}
1205
1206
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1207
		}
1208
1209
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1210
	}
1211
1212
	/**
1213
	 * Return whether we are dealing with a multi network setup or not.
1214
	 * The reason we are type casting this is because we want to avoid the situation where
1215
	 * the result is false since when is_main_network_option return false it cases
1216
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1217
	 * database which could be set to anything as opposed to what this function returns.
1218
	 * @param  bool  $option
1219
	 *
1220
	 * @return boolean
1221
	 */
1222
	public function is_main_network_option( $option ) {
1223
		// return '1' or ''
1224
		return (string) (bool) Jetpack::is_multi_network();
1225
	}
1226
1227
	/**
1228
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1229
	 *
1230
	 * @param  string  $option
1231
	 * @return boolean
1232
	 */
1233
	public function is_multisite( $option ) {
1234
		return (string) (bool) is_multisite();
1235
	}
1236
1237
	/**
1238
	 * Implemented since there is no core is multi network function
1239
	 * Right now there is no way to tell if we which network is the dominant network on the system
1240
	 *
1241
	 * @since  3.3
1242
	 * @return boolean
1243
	 */
1244
	public static function is_multi_network() {
1245
		global  $wpdb;
1246
1247
		// if we don't have a multi site setup no need to do any more
1248
		if ( ! is_multisite() ) {
1249
			return false;
1250
		}
1251
1252
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1253
		if ( $num_sites > 1 ) {
1254
			return true;
1255
		} else {
1256
			return false;
1257
		}
1258
	}
1259
1260
	/**
1261
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1262
	 * @return null
1263
	 */
1264
	function update_jetpack_main_network_site_option() {
1265
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1266
	}
1267
	/**
1268
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1269
	 *
1270
	 */
1271
	function update_jetpack_network_settings() {
1272
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1273
		// Only sync this info for the main network site.
1274
	}
1275
1276
	/**
1277
	 * Get back if the current site is single user site.
1278
	 *
1279
	 * @return bool
1280
	 */
1281
	public static function is_single_user_site() {
1282
		global $wpdb;
1283
1284 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1285
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1286
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1287
		}
1288
		return 1 === (int) $some_users;
1289
	}
1290
1291
	/**
1292
	 * Returns true if the site has file write access false otherwise.
1293
	 * @return string ( '1' | '0' )
1294
	 **/
1295
	public static function file_system_write_access() {
1296
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1297
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1298
		}
1299
1300
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1301
1302
		$filesystem_method = get_filesystem_method();
1303
		if ( $filesystem_method === 'direct' ) {
1304
			return 1;
1305
		}
1306
1307
		ob_start();
1308
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1309
		ob_end_clean();
1310
		if ( $filesystem_credentials_are_stored ) {
1311
			return 1;
1312
		}
1313
		return 0;
1314
	}
1315
1316
	/**
1317
	 * Finds out if a site is using a version control system.
1318
	 * @return string ( '1' | '0' )
1319
	 **/
1320
	public static function is_version_controlled() {
1321
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1322
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1323
	}
1324
1325
	/**
1326
	 * Determines whether the current theme supports featured images or not.
1327
	 * @return string ( '1' | '0' )
1328
	 */
1329
	public static function featured_images_enabled() {
1330
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1331
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1332
	}
1333
1334
	/**
1335
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1336
	 *
1337
	 * @deprecated 4.7 use get_avatar_url instead.
1338
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1339
	 * @param int $size Size of the avatar image
1340
	 * @param string $default URL to a default image to use if no avatar is available
1341
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1342
	 *
1343
	 * @return array
1344
	 */
1345
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1346
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1347
		return get_avatar_url( $id_or_email, array(
1348
			'size' => $size,
1349
			'default' => $default,
1350
			'force_default' => $force_display,
1351
		) );
1352
	}
1353
1354
	/**
1355
	 * jetpack_updates is saved in the following schema:
1356
	 *
1357
	 * array (
1358
	 *      'plugins'                       => (int) Number of plugin updates available.
1359
	 *      'themes'                        => (int) Number of theme updates available.
1360
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1361
	 *      'translations'                  => (int) Number of translation updates available.
1362
	 *      'total'                         => (int) Total of all available updates.
1363
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1364
	 * )
1365
	 * @return array
1366
	 */
1367
	public static function get_updates() {
1368
		$update_data = wp_get_update_data();
1369
1370
		// Stores the individual update counts as well as the total count.
1371
		if ( isset( $update_data['counts'] ) ) {
1372
			$updates = $update_data['counts'];
1373
		}
1374
1375
		// If we need to update WordPress core, let's find the latest version number.
1376 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1377
			$cur = get_preferred_from_update_core();
1378
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1379
				$updates['wp_update_version'] = $cur->current;
1380
			}
1381
		}
1382
		return isset( $updates ) ? $updates : array();
1383
	}
1384
1385
	public static function get_update_details() {
1386
		$update_details = array(
1387
			'update_core' => get_site_transient( 'update_core' ),
1388
			'update_plugins' => get_site_transient( 'update_plugins' ),
1389
			'update_themes' => get_site_transient( 'update_themes' ),
1390
		);
1391
		return $update_details;
1392
	}
1393
1394
	public static function refresh_update_data() {
1395
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1396
1397
	}
1398
1399
	public static function refresh_theme_data() {
1400
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1401
	}
1402
1403
	/**
1404
	 * Is Jetpack active?
1405
	 */
1406
	public static function is_active() {
1407
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1408
	}
1409
1410
	/**
1411
	 * Make an API call to WordPress.com for plan status
1412
	 *
1413
	 * @uses Jetpack_Options::get_option()
1414
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1415
	 * @uses update_option()
1416
	 *
1417
	 * @access public
1418
	 * @static
1419
	 *
1420
	 * @return bool True if plan is updated, false if no update
1421
	 */
1422
	public static function refresh_active_plan_from_wpcom() {
1423
		// Make the API request
1424
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1425
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1426
1427
		// Bail if there was an error or malformed response
1428
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1429
			return false;
1430
		}
1431
1432
		// Decode the results
1433
		$results = json_decode( $response['body'], true );
1434
1435
		// Bail if there were no results or plan details returned
1436
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1437
			return false;
1438
		}
1439
1440
		// Store the option and return true if updated
1441
		return update_option( 'jetpack_active_plan', $results['plan'] );
1442
	}
1443
1444
	/**
1445
	 * Get the plan that this Jetpack site is currently using
1446
	 *
1447
	 * @uses get_option()
1448
	 *
1449
	 * @access public
1450
	 * @static
1451
	 *
1452
	 * @return array Active Jetpack plan details
1453
	 */
1454
	public static function get_active_plan() {
1455
		global $active_plan_cache;
1456
1457
		// this can be expensive to compute so we cache for the duration of a request
1458
		if ( $active_plan_cache ) {
1459
			return $active_plan_cache;
1460
		}
1461
1462
		$plan = get_option( 'jetpack_active_plan', array() );
1463
1464
		// Set the default options
1465
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1466
			$plan = wp_parse_args( $plan, array(
1467
				'product_slug' => 'jetpack_free',
1468
				'supports'     => array(),
1469
				'class'        => 'free',
1470
			) );
1471
		}
1472
1473
		$supports = array();
1474
1475
		// Define what paid modules are supported by personal plans
1476
		$personal_plans = array(
1477
			'jetpack_personal',
1478
			'jetpack_personal_monthly',
1479
			'personal-bundle',
1480
		);
1481
1482
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1483
			// special support value, not a module but a separate plugin
1484
			$supports[] = 'akismet';
1485
			$plan['class'] = 'personal';
1486
		}
1487
1488
		// Define what paid modules are supported by premium plans
1489
		$premium_plans = array(
1490
			'jetpack_premium',
1491
			'jetpack_premium_monthly',
1492
			'value_bundle',
1493
		);
1494
1495 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1496
			$supports[] = 'akismet';
1497
			$supports[] = 'vaultpress';
1498
			$plan['class'] = 'premium';
1499
		}
1500
1501
		// Define what paid modules are supported by professional plans
1502
		$business_plans = array(
1503
			'jetpack_business',
1504
			'jetpack_business_monthly',
1505
			'business-bundle',
1506
			'vip',
1507
		);
1508
1509 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1510
			$supports[] = 'akismet';
1511
			$supports[] = 'vaultpress';
1512
			$plan['class'] = 'business';
1513
		}
1514
1515
		// get available features
1516
		foreach ( self::get_available_modules() as $module_slug ) {
1517
			$module = self::get_module( $module_slug );
1518
			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
1519
				$supports[] = $module_slug;
1520
			}
1521
		}
1522
1523
		$plan['supports'] = $supports;
1524
1525
		$active_plan_cache = $plan;
1526
1527
		return $plan;
1528
	}
1529
1530
	/**
1531
	 * Determine whether the active plan supports a particular feature
1532
	 *
1533
	 * @uses Jetpack::get_active_plan()
1534
	 *
1535
	 * @access public
1536
	 * @static
1537
	 *
1538
	 * @return bool True if plan supports feature, false if not
1539
	 */
1540
	public static function active_plan_supports( $feature ) {
1541
		$plan = Jetpack::get_active_plan();
1542
1543
		if ( in_array( $feature, $plan['supports'] ) ) {
1544
			return true;
1545
		}
1546
1547
		return false;
1548
	}
1549
1550
	/**
1551
	 * Is Jetpack in development (offline) mode?
1552
	 */
1553
	public static function is_development_mode() {
1554
		$development_mode = false;
1555
1556
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1557
			$development_mode = JETPACK_DEV_DEBUG;
1558
		} elseif ( $site_url = site_url() ) {
1559
			$development_mode = false === strpos( $site_url, '.' );
1560
		}
1561
1562
		/**
1563
		 * Filters Jetpack's development mode.
1564
		 *
1565
		 * @see https://jetpack.com/support/development-mode/
1566
		 *
1567
		 * @since 2.2.1
1568
		 *
1569
		 * @param bool $development_mode Is Jetpack's development mode active.
1570
		 */
1571
		return apply_filters( 'jetpack_development_mode', $development_mode );
1572
	}
1573
1574
	/**
1575
	 * Whether the site is currently onboarding or not.
1576
	 * A site is considered as being onboarded if it currently has an onboarding token.
1577
	 *
1578
	 * @since 5.8
1579
	 *
1580
	 * @access public
1581
	 * @static
1582
	 *
1583
	 * @return bool True if the site is currently onboarding, false otherwise
1584
	 */
1585
	public static function is_onboarding() {
1586
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1587
	}
1588
1589
	/**
1590
	* Get Jetpack development mode notice text and notice class.
1591
	*
1592
	* Mirrors the checks made in Jetpack::is_development_mode
1593
	*
1594
	*/
1595
	public static function show_development_mode_notice() {
1596
		if ( Jetpack::is_development_mode() ) {
1597
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1598
				$notice = sprintf(
1599
					/* translators: %s is a URL */
1600
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1601
					'https://jetpack.com/support/development-mode/'
1602
				);
1603
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1604
				$notice = sprintf(
1605
					/* translators: %s is a URL */
1606
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1607
					'https://jetpack.com/support/development-mode/'
1608
				);
1609
			} else {
1610
				$notice = sprintf(
1611
					/* translators: %s is a URL */
1612
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1613
					'https://jetpack.com/support/development-mode/'
1614
				);
1615
			}
1616
1617
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1618
		}
1619
1620
		// Throw up a notice if using a development version and as for feedback.
1621
		if ( Jetpack::is_development_version() ) {
1622
			/* translators: %s is a URL */
1623
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), 'https://jetpack.com/contact-support/beta-group/' );
1624
1625
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1626
		}
1627
		// Throw up a notice if using staging mode
1628
		if ( Jetpack::is_staging_site() ) {
1629
			/* translators: %s is a URL */
1630
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1631
1632
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1633
		}
1634
	}
1635
1636
	/**
1637
	 * Whether Jetpack's version maps to a public release, or a development version.
1638
	 */
1639
	public static function is_development_version() {
1640
		/**
1641
		 * Allows filtering whether this is a development version of Jetpack.
1642
		 *
1643
		 * This filter is especially useful for tests.
1644
		 *
1645
		 * @since 4.3.0
1646
		 *
1647
		 * @param bool $development_version Is this a develoment version of Jetpack?
1648
		 */
1649
		return (bool) apply_filters(
1650
			'jetpack_development_version',
1651
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1652
		);
1653
	}
1654
1655
	/**
1656
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1657
	 */
1658
	public static function is_user_connected( $user_id = false ) {
1659
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1660
		if ( ! $user_id ) {
1661
			return false;
1662
		}
1663
1664
		return (bool) Jetpack_Data::get_access_token( $user_id );
1665
	}
1666
1667
	/**
1668
	 * Get the wpcom user data of the current|specified connected user.
1669
	 */
1670
	public static function get_connected_user_data( $user_id = null ) {
1671
		if ( ! $user_id ) {
1672
			$user_id = get_current_user_id();
1673
		}
1674
1675
		$transient_key = "jetpack_connected_user_data_$user_id";
1676
1677
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1678
			return $cached_user_data;
1679
		}
1680
1681
		Jetpack::load_xml_rpc_client();
1682
		$xml = new Jetpack_IXR_Client( array(
1683
			'user_id' => $user_id,
1684
		) );
1685
		$xml->query( 'wpcom.getUser' );
1686
		if ( ! $xml->isError() ) {
1687
			$user_data = $xml->getResponse();
1688
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1689
			return $user_data;
1690
		}
1691
1692
		return false;
1693
	}
1694
1695
	/**
1696
	 * Get the wpcom email of the current|specified connected user.
1697
	 */
1698 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1699
		if ( ! $user_id ) {
1700
			$user_id = get_current_user_id();
1701
		}
1702
		Jetpack::load_xml_rpc_client();
1703
		$xml = new Jetpack_IXR_Client( array(
1704
			'user_id' => $user_id,
1705
		) );
1706
		$xml->query( 'wpcom.getUserEmail' );
1707
		if ( ! $xml->isError() ) {
1708
			return $xml->getResponse();
1709
		}
1710
		return false;
1711
	}
1712
1713
	/**
1714
	 * Get the wpcom email of the master user.
1715
	 */
1716
	public static function get_master_user_email() {
1717
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1718
		if ( $master_user_id ) {
1719
			return self::get_connected_user_email( $master_user_id );
1720
		}
1721
		return '';
1722
	}
1723
1724
	function current_user_is_connection_owner() {
1725
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1726
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1727
	}
1728
1729
	/**
1730
	 * Gets current user IP address.
1731
	 *
1732
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1733
	 *
1734
	 * @return string                  Current user IP address.
1735
	 */
1736
	public static function current_user_ip( $check_all_headers = false ) {
1737
		if ( $check_all_headers ) {
1738
			foreach ( array(
1739
				'HTTP_CF_CONNECTING_IP',
1740
				'HTTP_CLIENT_IP',
1741
				'HTTP_X_FORWARDED_FOR',
1742
				'HTTP_X_FORWARDED',
1743
				'HTTP_X_CLUSTER_CLIENT_IP',
1744
				'HTTP_FORWARDED_FOR',
1745
				'HTTP_FORWARDED',
1746
				'HTTP_VIA',
1747
			) as $key ) {
1748
				if ( ! empty( $_SERVER[ $key ] ) ) {
1749
					return $_SERVER[ $key ];
1750
				}
1751
			}
1752
		}
1753
1754
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1755
	}
1756
1757
	/**
1758
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1759
	 */
1760
	function extra_oembed_providers() {
1761
		// Cloudup: https://dev.cloudup.com/#oembed
1762
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1763
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1764
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1765
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1766
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1767
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1768
	}
1769
1770
	/**
1771
	 * Synchronize connected user role changes
1772
	 */
1773
	function user_role_change( $user_id ) {
1774
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1775
		Jetpack_Sync_Users::user_role_change( $user_id );
1776
	}
1777
1778
	/**
1779
	 * Loads the currently active modules.
1780
	 */
1781
	public static function load_modules() {
1782
		if (
1783
			! self::is_active()
1784
			&& ! self::is_development_mode()
1785
			&& ! self::is_onboarding()
1786
			&& (
1787
				! is_multisite()
1788
				|| ! get_site_option( 'jetpack_protect_active' )
1789
			)
1790
		) {
1791
			return;
1792
		}
1793
1794
		$version = Jetpack_Options::get_option( 'version' );
1795 View Code Duplication
		if ( ! $version ) {
1796
			$version = $old_version = JETPACK__VERSION . ':' . time();
1797
			/** This action is documented in class.jetpack.php */
1798
			do_action( 'updating_jetpack_version', $version, false );
1799
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1800
		}
1801
		list( $version ) = explode( ':', $version );
1802
1803
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1804
1805
		$modules_data = array();
1806
1807
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1808
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1809
			$updated_modules = array();
1810
			foreach ( $modules as $module ) {
1811
				$modules_data[ $module ] = Jetpack::get_module( $module );
1812
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1813
					continue;
1814
				}
1815
1816
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1817
					continue;
1818
				}
1819
1820
				$updated_modules[] = $module;
1821
			}
1822
1823
			$modules = array_diff( $modules, $updated_modules );
1824
		}
1825
1826
		$is_development_mode = Jetpack::is_development_mode();
1827
1828
		foreach ( $modules as $index => $module ) {
1829
			// If we're in dev mode, disable modules requiring a connection
1830
			if ( $is_development_mode ) {
1831
				// Prime the pump if we need to
1832
				if ( empty( $modules_data[ $module ] ) ) {
1833
					$modules_data[ $module ] = Jetpack::get_module( $module );
1834
				}
1835
				// If the module requires a connection, but we're in local mode, don't include it.
1836
				if ( $modules_data[ $module ]['requires_connection'] ) {
1837
					continue;
1838
				}
1839
			}
1840
1841
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1842
				continue;
1843
			}
1844
1845
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1846
				unset( $modules[ $index ] );
1847
				self::update_active_modules( array_values( $modules ) );
1848
				continue;
1849
			}
1850
1851
			/**
1852
			 * Fires when a specific module is loaded.
1853
			 * The dynamic part of the hook, $module, is the module slug.
1854
			 *
1855
			 * @since 1.1.0
1856
			 */
1857
			do_action( 'jetpack_module_loaded_' . $module );
1858
		}
1859
1860
		/**
1861
		 * Fires when all the modules are loaded.
1862
		 *
1863
		 * @since 1.1.0
1864
		 */
1865
		do_action( 'jetpack_modules_loaded' );
1866
1867
		// 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.
1868
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1869
	}
1870
1871
	/**
1872
	 * Check if Jetpack's REST API compat file should be included
1873
	 * @action plugins_loaded
1874
	 * @return null
1875
	 */
1876
	public function check_rest_api_compat() {
1877
		/**
1878
		 * Filters the list of REST API compat files to be included.
1879
		 *
1880
		 * @since 2.2.5
1881
		 *
1882
		 * @param array $args Array of REST API compat files to include.
1883
		 */
1884
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1885
1886
		if ( function_exists( 'bbpress' ) )
1887
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1888
1889
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1890
			require_once $_jetpack_rest_api_compat_include;
1891
	}
1892
1893
	/**
1894
	 * Gets all plugins currently active in values, regardless of whether they're
1895
	 * traditionally activated or network activated.
1896
	 *
1897
	 * @todo Store the result in core's object cache maybe?
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
1898
	 */
1899
	public static function get_active_plugins() {
1900
		$active_plugins = (array) get_option( 'active_plugins', array() );
1901
1902
		if ( is_multisite() ) {
1903
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1904
			// whereas active_plugins stores them in the values.
1905
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1906
			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...
1907
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1908
			}
1909
		}
1910
1911
		sort( $active_plugins );
1912
1913
		return array_unique( $active_plugins );
1914
	}
1915
1916
	/**
1917
	 * Gets and parses additional plugin data to send with the heartbeat data
1918
	 *
1919
	 * @since 3.8.1
1920
	 *
1921
	 * @return array Array of plugin data
1922
	 */
1923
	public static function get_parsed_plugin_data() {
1924
		if ( ! function_exists( 'get_plugins' ) ) {
1925
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1926
		}
1927
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1928
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1929
		$active_plugins = Jetpack::get_active_plugins();
1930
1931
		$plugins = array();
1932
		foreach ( $all_plugins as $path => $plugin_data ) {
1933
			$plugins[ $path ] = array(
1934
					'is_active' => in_array( $path, $active_plugins ),
1935
					'file'      => $path,
1936
					'name'      => $plugin_data['Name'],
1937
					'version'   => $plugin_data['Version'],
1938
					'author'    => $plugin_data['Author'],
1939
			);
1940
		}
1941
1942
		return $plugins;
1943
	}
1944
1945
	/**
1946
	 * Gets and parses theme data to send with the heartbeat data
1947
	 *
1948
	 * @since 3.8.1
1949
	 *
1950
	 * @return array Array of theme data
1951
	 */
1952
	public static function get_parsed_theme_data() {
1953
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1954
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1955
1956
		$themes = array();
1957
		foreach ( $all_themes as $slug => $theme_data ) {
1958
			$theme_headers = array();
1959
			foreach ( $header_keys as $header_key ) {
1960
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1961
			}
1962
1963
			$themes[ $slug ] = array(
1964
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1965
					'slug' => $slug,
1966
					'theme_root' => $theme_data->get_theme_root_uri(),
1967
					'parent' => $theme_data->parent(),
1968
					'headers' => $theme_headers
1969
			);
1970
		}
1971
1972
		return $themes;
1973
	}
1974
1975
	/**
1976
	 * Checks whether a specific plugin is active.
1977
	 *
1978
	 * We don't want to store these in a static variable, in case
1979
	 * there are switch_to_blog() calls involved.
1980
	 */
1981
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1982
		return in_array( $plugin, self::get_active_plugins() );
1983
	}
1984
1985
	/**
1986
	 * Check if Jetpack's Open Graph tags should be used.
1987
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1988
	 *
1989
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1990
	 * @action plugins_loaded
1991
	 * @return null
1992
	 */
1993
	public function check_open_graph() {
1994
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1995
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1996
		}
1997
1998
		$active_plugins = self::get_active_plugins();
1999
2000
		if ( ! empty( $active_plugins ) ) {
2001
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2002
				if ( in_array( $plugin, $active_plugins ) ) {
2003
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2004
					break;
2005
				}
2006
			}
2007
		}
2008
2009
		/**
2010
		 * Allow the addition of Open Graph Meta Tags to all pages.
2011
		 *
2012
		 * @since 2.0.3
2013
		 *
2014
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2015
		 */
2016
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2017
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2018
		}
2019
	}
2020
2021
	/**
2022
	 * Check if Jetpack's Twitter tags should be used.
2023
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2024
	 *
2025
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2026
	 * @action plugins_loaded
2027
	 * @return null
2028
	 */
2029
	public function check_twitter_tags() {
2030
2031
		$active_plugins = self::get_active_plugins();
2032
2033
		if ( ! empty( $active_plugins ) ) {
2034
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2035
				if ( in_array( $plugin, $active_plugins ) ) {
2036
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2037
					break;
2038
				}
2039
			}
2040
		}
2041
2042
		/**
2043
		 * Allow Twitter Card Meta tags to be disabled.
2044
		 *
2045
		 * @since 2.6.0
2046
		 *
2047
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2048
		 */
2049
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2050
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2051
		}
2052
	}
2053
2054
	/**
2055
	 * Allows plugins to submit security reports.
2056
 	 *
2057
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2058
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2059
	 * @param array   $args         See definitions above
2060
	 */
2061
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2062
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2063
	}
2064
2065
/* Jetpack Options API */
2066
2067
	public static function get_option_names( $type = 'compact' ) {
2068
		return Jetpack_Options::get_option_names( $type );
2069
	}
2070
2071
	/**
2072
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2073
 	 *
2074
	 * @param string $name    Option name
2075
	 * @param mixed  $default (optional)
2076
	 */
2077
	public static function get_option( $name, $default = false ) {
2078
		return Jetpack_Options::get_option( $name, $default );
2079
	}
2080
2081
	/**
2082
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2083
 	 *
2084
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2085
	 * @param string $name  Option name
2086
	 * @param mixed  $value Option value
2087
	 */
2088
	public static function update_option( $name, $value ) {
2089
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2090
		return Jetpack_Options::update_option( $name, $value );
2091
	}
2092
2093
	/**
2094
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2095
 	 *
2096
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2097
	 * @param array $array array( option name => option value, ... )
2098
	 */
2099
	public static function update_options( $array ) {
2100
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2101
		return Jetpack_Options::update_options( $array );
2102
	}
2103
2104
	/**
2105
	 * Deletes the given option.  May be passed multiple option names as an array.
2106
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2107
	 *
2108
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2109
	 * @param string|array $names
2110
	 */
2111
	public static function delete_option( $names ) {
2112
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2113
		return Jetpack_Options::delete_option( $names );
2114
	}
2115
2116
	/**
2117
	 * Enters a user token into the user_tokens option
2118
	 *
2119
	 * @param int $user_id
2120
	 * @param string $token
2121
	 * return bool
2122
	 */
2123
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2124
		// not designed for concurrent updates
2125
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2126
		if ( ! is_array( $user_tokens ) )
2127
			$user_tokens = array();
2128
		$user_tokens[$user_id] = $token;
2129
		if ( $is_master_user ) {
2130
			$master_user = $user_id;
2131
			$options     = compact( 'user_tokens', 'master_user' );
2132
		} else {
2133
			$options = compact( 'user_tokens' );
2134
		}
2135
		return Jetpack_Options::update_options( $options );
2136
	}
2137
2138
	/**
2139
	 * Returns an array of all PHP files in the specified absolute path.
2140
	 * Equivalent to glob( "$absolute_path/*.php" ).
2141
	 *
2142
	 * @param string $absolute_path The absolute path of the directory to search.
2143
	 * @return array Array of absolute paths to the PHP files.
2144
	 */
2145
	public static function glob_php( $absolute_path ) {
2146
		if ( function_exists( 'glob' ) ) {
2147
			return glob( "$absolute_path/*.php" );
2148
		}
2149
2150
		$absolute_path = untrailingslashit( $absolute_path );
2151
		$files = array();
2152
		if ( ! $dir = @opendir( $absolute_path ) ) {
2153
			return $files;
2154
		}
2155
2156
		while ( false !== $file = readdir( $dir ) ) {
2157
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2158
				continue;
2159
			}
2160
2161
			$file = "$absolute_path/$file";
2162
2163
			if ( ! is_file( $file ) ) {
2164
				continue;
2165
			}
2166
2167
			$files[] = $file;
2168
		}
2169
2170
		closedir( $dir );
2171
2172
		return $files;
2173
	}
2174
2175
	public static function activate_new_modules( $redirect = false ) {
2176
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2177
			return;
2178
		}
2179
2180
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2181 View Code Duplication
		if ( ! $jetpack_old_version ) {
2182
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2183
			/** This action is documented in class.jetpack.php */
2184
			do_action( 'updating_jetpack_version', $version, false );
2185
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2186
		}
2187
2188
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2189
2190
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2191
			return;
2192
		}
2193
2194
		$active_modules     = Jetpack::get_active_modules();
2195
		$reactivate_modules = array();
2196
		foreach ( $active_modules as $active_module ) {
2197
			$module = Jetpack::get_module( $active_module );
2198
			if ( ! isset( $module['changed'] ) ) {
2199
				continue;
2200
			}
2201
2202
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2203
				continue;
2204
			}
2205
2206
			$reactivate_modules[] = $active_module;
2207
			Jetpack::deactivate_module( $active_module );
2208
		}
2209
2210
		$new_version = JETPACK__VERSION . ':' . time();
2211
		/** This action is documented in class.jetpack.php */
2212
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2213
		Jetpack_Options::update_options(
2214
			array(
2215
				'version'     => $new_version,
2216
				'old_version' => $jetpack_old_version,
2217
			)
2218
		);
2219
2220
		Jetpack::state( 'message', 'modules_activated' );
2221
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2222
2223
		if ( $redirect ) {
2224
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2225
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2226
				$page = $_GET['page'];
2227
			}
2228
2229
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2230
			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...
2231
		}
2232
	}
2233
2234
	/**
2235
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2236
	 * Make sure to tuck away module "library" files in a sub-directory.
2237
	 */
2238
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2239
		static $modules = null;
2240
2241
		if ( ! isset( $modules ) ) {
2242
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2243
			// Use the cache if we're on the front-end and it's available...
2244
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2245
				$modules = $available_modules_option[ JETPACK__VERSION ];
2246
			} else {
2247
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2248
2249
				$modules = array();
2250
2251
				foreach ( $files as $file ) {
2252
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2253
						continue;
2254
					}
2255
2256
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2257
				}
2258
2259
				Jetpack_Options::update_option( 'available_modules', array(
2260
					JETPACK__VERSION => $modules,
2261
				) );
2262
			}
2263
		}
2264
2265
		/**
2266
		 * Filters the array of modules available to be activated.
2267
		 *
2268
		 * @since 2.4.0
2269
		 *
2270
		 * @param array $modules Array of available modules.
2271
		 * @param string $min_version Minimum version number required to use modules.
2272
		 * @param string $max_version Maximum version number required to use modules.
2273
		 */
2274
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2275
2276
		if ( ! $min_version && ! $max_version ) {
2277
			return array_keys( $mods );
2278
		}
2279
2280
		$r = array();
2281
		foreach ( $mods as $slug => $introduced ) {
2282
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2283
				continue;
2284
			}
2285
2286
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2287
				continue;
2288
			}
2289
2290
			$r[] = $slug;
2291
		}
2292
2293
		return $r;
2294
	}
2295
2296
	/**
2297
	 * Default modules loaded on activation.
2298
	 */
2299
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2300
		$return = array();
2301
2302
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2303
			$module_data = Jetpack::get_module( $module );
2304
2305
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2306
				case 'yes' :
2307
					$return[] = $module;
2308
					break;
2309
				case 'public' :
2310
					if ( Jetpack_Options::get_option( 'public' ) ) {
2311
						$return[] = $module;
2312
					}
2313
					break;
2314
				case 'no' :
2315
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2316
					break;
2317
			}
2318
		}
2319
		/**
2320
		 * Filters the array of default modules.
2321
		 *
2322
		 * @since 2.5.0
2323
		 *
2324
		 * @param array $return Array of default modules.
2325
		 * @param string $min_version Minimum version number required to use modules.
2326
		 * @param string $max_version Maximum version number required to use modules.
2327
		 */
2328
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2329
	}
2330
2331
	/**
2332
	 * Checks activated modules during auto-activation to determine
2333
	 * if any of those modules are being deprecated.  If so, close
2334
	 * them out, and add any replacement modules.
2335
	 *
2336
	 * Runs at priority 99 by default.
2337
	 *
2338
	 * This is run late, so that it can still activate a module if
2339
	 * the new module is a replacement for another that the user
2340
	 * currently has active, even if something at the normal priority
2341
	 * would kibosh everything.
2342
	 *
2343
	 * @since 2.6
2344
	 * @uses jetpack_get_default_modules filter
2345
	 * @param array $modules
2346
	 * @return array
2347
	 */
2348
	function handle_deprecated_modules( $modules ) {
2349
		$deprecated_modules = array(
2350
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2351
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2352
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2353
		);
2354
2355
		// Don't activate SSO if they never completed activating WPCC.
2356
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2357
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2358
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2359
				$deprecated_modules['wpcc'] = null;
2360
			}
2361
		}
2362
2363
		foreach ( $deprecated_modules as $module => $replacement ) {
2364
			if ( Jetpack::is_module_active( $module ) ) {
2365
				self::deactivate_module( $module );
2366
				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...
2367
					$modules[] = $replacement;
2368
				}
2369
			}
2370
		}
2371
2372
		return array_unique( $modules );
2373
	}
2374
2375
	/**
2376
	 * Checks activated plugins during auto-activation to determine
2377
	 * if any of those plugins are in the list with a corresponding module
2378
	 * that is not compatible with the plugin. The module will not be allowed
2379
	 * to auto-activate.
2380
	 *
2381
	 * @since 2.6
2382
	 * @uses jetpack_get_default_modules filter
2383
	 * @param array $modules
2384
	 * @return array
2385
	 */
2386
	function filter_default_modules( $modules ) {
2387
2388
		$active_plugins = self::get_active_plugins();
2389
2390
		if ( ! empty( $active_plugins ) ) {
2391
2392
			// For each module we'd like to auto-activate...
2393
			foreach ( $modules as $key => $module ) {
2394
				// If there are potential conflicts for it...
2395
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2396
					// For each potential conflict...
2397
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2398
						// If that conflicting plugin is active...
2399
						if ( in_array( $plugin, $active_plugins ) ) {
2400
							// Remove that item from being auto-activated.
2401
							unset( $modules[ $key ] );
2402
						}
2403
					}
2404
				}
2405
			}
2406
		}
2407
2408
		return $modules;
2409
	}
2410
2411
	/**
2412
	 * Extract a module's slug from its full path.
2413
	 */
2414
	public static function get_module_slug( $file ) {
2415
		return str_replace( '.php', '', basename( $file ) );
2416
	}
2417
2418
	/**
2419
	 * Generate a module's path from its slug.
2420
	 */
2421
	public static function get_module_path( $slug ) {
2422
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2423
	}
2424
2425
	/**
2426
	 * Load module data from module file. Headers differ from WordPress
2427
	 * plugin headers to avoid them being identified as standalone
2428
	 * plugins on the WordPress plugins page.
2429
	 */
2430
	public static function get_module( $module ) {
2431
		$headers = array(
2432
			'name'                      => 'Module Name',
2433
			'description'               => 'Module Description',
2434
			'jumpstart_desc'            => 'Jumpstart Description',
2435
			'sort'                      => 'Sort Order',
2436
			'recommendation_order'      => 'Recommendation Order',
2437
			'introduced'                => 'First Introduced',
2438
			'changed'                   => 'Major Changes In',
2439
			'deactivate'                => 'Deactivate',
2440
			'free'                      => 'Free',
2441
			'requires_connection'       => 'Requires Connection',
2442
			'auto_activate'             => 'Auto Activate',
2443
			'module_tags'               => 'Module Tags',
2444
			'feature'                   => 'Feature',
2445
			'additional_search_queries' => 'Additional Search Queries',
2446
			'plan_classes'              => 'Plans',
2447
		);
2448
2449
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2450
2451
		$mod = Jetpack::get_file_data( $file, $headers );
2452
		if ( empty( $mod['name'] ) ) {
2453
			return false;
2454
		}
2455
2456
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2457
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2458
		$mod['deactivate']              = empty( $mod['deactivate'] );
2459
		$mod['free']                    = empty( $mod['free'] );
2460
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2461
2462
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2463
			$mod['auto_activate'] = 'No';
2464
		} else {
2465
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2466
		}
2467
2468
		if ( $mod['module_tags'] ) {
2469
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2470
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2471
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2472
		} else {
2473
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2474
		}
2475
2476 View Code Duplication
		if ( $mod['plan_classes'] ) {
2477
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2478
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2479
		} else {
2480
			$mod['plan_classes'] = array( 'free' );
2481
		}
2482
2483 View Code Duplication
		if ( $mod['feature'] ) {
2484
			$mod['feature'] = explode( ',', $mod['feature'] );
2485
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2486
		} else {
2487
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2488
		}
2489
2490
		/**
2491
		 * Filters the feature array on a module.
2492
		 *
2493
		 * This filter allows you to control where each module is filtered: Recommended,
2494
		 * Jumpstart, and the default "Other" listing.
2495
		 *
2496
		 * @since 3.5.0
2497
		 *
2498
		 * @param array   $mod['feature'] The areas to feature this module:
2499
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2500
		 *     'Recommended' shows on the main Jetpack admin screen.
2501
		 *     'Other' should be the default if no other value is in the array.
2502
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2503
		 * @param array   $mod All the currently assembled module data.
2504
		 */
2505
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2506
2507
		/**
2508
		 * Filter the returned data about a module.
2509
		 *
2510
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2511
		 * so please be careful.
2512
		 *
2513
		 * @since 3.6.0
2514
		 *
2515
		 * @param array   $mod    The details of the requested module.
2516
		 * @param string  $module The slug of the module, e.g. sharedaddy
2517
		 * @param string  $file   The path to the module source file.
2518
		 */
2519
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2520
	}
2521
2522
	/**
2523
	 * Like core's get_file_data implementation, but caches the result.
2524
	 */
2525
	public static function get_file_data( $file, $headers ) {
2526
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2527
		$file_name = basename( $file );
2528
2529
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2530
2531
		$file_data_option = get_transient( $cache_key );
2532
2533
		if ( false === $file_data_option ) {
2534
			$file_data_option = array();
2535
		}
2536
2537
		$key           = md5( $file_name . serialize( $headers ) );
2538
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2539
2540
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2541
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2542
			return $file_data_option[ $key ];
2543
		}
2544
2545
		$data = get_file_data( $file, $headers );
2546
2547
		$file_data_option[ $key ] = $data;
2548
2549
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2550
2551
		return $data;
2552
	}
2553
2554
2555
	/**
2556
	 * Return translated module tag.
2557
	 *
2558
	 * @param string $tag Tag as it appears in each module heading.
2559
	 *
2560
	 * @return mixed
2561
	 */
2562
	public static function translate_module_tag( $tag ) {
2563
		return jetpack_get_module_i18n_tag( $tag );
2564
	}
2565
2566
	/**
2567
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2568
	 *
2569
	 * @since 3.9.2
2570
	 *
2571
	 * @param array $modules
2572
	 *
2573
	 * @return string|void
2574
	 */
2575
	public static function get_translated_modules( $modules ) {
2576
		foreach ( $modules as $index => $module ) {
2577
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2578
			if ( isset( $module['name'] ) ) {
2579
				$modules[ $index ]['name'] = $i18n_module['name'];
2580
			}
2581
			if ( isset( $module['description'] ) ) {
2582
				$modules[ $index ]['description'] = $i18n_module['description'];
2583
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2584
			}
2585
		}
2586
		return $modules;
2587
	}
2588
2589
	/**
2590
	 * Get a list of activated modules as an array of module slugs.
2591
	 */
2592
	public static function get_active_modules() {
2593
		$active = Jetpack_Options::get_option( 'active_modules' );
2594
2595
		if ( ! is_array( $active ) ) {
2596
			$active = array();
2597
		}
2598
2599
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2600
			$active[] = 'vaultpress';
2601
		} else {
2602
			$active = array_diff( $active, array( 'vaultpress' ) );
2603
		}
2604
2605
		//If protect is active on the main site of a multisite, it should be active on all sites.
2606
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2607
			$active[] = 'protect';
2608
		}
2609
2610
		/**
2611
		 * Allow filtering of the active modules.
2612
		 *
2613
		 * Gives theme and plugin developers the power to alter the modules that
2614
		 * are activated on the fly.
2615
		 *
2616
		 * @since 5.8.0
2617
		 *
2618
		 * @param array $active Array of active module slugs.
2619
		 */
2620
		$active = apply_filters( 'jetpack_active_modules', $active );
2621
2622
		return array_unique( $active );
2623
	}
2624
2625
	/**
2626
	 * Check whether or not a Jetpack module is active.
2627
	 *
2628
	 * @param string $module The slug of a Jetpack module.
2629
	 * @return bool
2630
	 *
2631
	 * @static
2632
	 */
2633
	public static function is_module_active( $module ) {
2634
		return in_array( $module, self::get_active_modules() );
2635
	}
2636
2637
	public static function is_module( $module ) {
2638
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2639
	}
2640
2641
	/**
2642
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2643
	 *
2644
	 * @param bool $catch True to start catching, False to stop.
2645
	 *
2646
	 * @static
2647
	 */
2648
	public static function catch_errors( $catch ) {
2649
		static $display_errors, $error_reporting;
2650
2651
		if ( $catch ) {
2652
			$display_errors  = @ini_set( 'display_errors', 1 );
2653
			$error_reporting = @error_reporting( E_ALL );
2654
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2655
		} else {
2656
			@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...
2657
			@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...
2658
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2659
		}
2660
	}
2661
2662
	/**
2663
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2664
	 */
2665
	public static function catch_errors_on_shutdown() {
2666
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2667
	}
2668
2669
	/**
2670
	 * Rewrite any string to make paths easier to read.
2671
	 *
2672
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2673
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2674
	 *
2675
	 * @param $string
2676
	 * @return mixed
2677
	 */
2678
	public static function alias_directories( $string ) {
2679
		// ABSPATH has a trailing slash.
2680
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2681
		// WP_CONTENT_DIR does not have a trailing slash.
2682
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2683
2684
		return $string;
2685
	}
2686
2687
	public static function activate_default_modules(
2688
		$min_version = false,
2689
		$max_version = false,
2690
		$other_modules = array(),
2691
		$redirect = true,
2692
		$send_state_messages = true
2693
	) {
2694
		$jetpack = Jetpack::init();
2695
2696
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2697
		$modules = array_merge( $other_modules, $modules );
2698
2699
		// Look for standalone plugins and disable if active.
2700
2701
		$to_deactivate = array();
2702
		foreach ( $modules as $module ) {
2703
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2704
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2705
			}
2706
		}
2707
2708
		$deactivated = array();
2709
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2710
			list( $probable_file, $probable_title ) = $deactivate_me;
2711
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2712
				$deactivated[] = $module;
2713
			}
2714
		}
2715
2716
		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...
2717
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2718
2719
			$url = add_query_arg(
2720
				array(
2721
					'action'   => 'activate_default_modules',
2722
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2723
				),
2724
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2725
			);
2726
			wp_safe_redirect( $url );
2727
			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...
2728
		}
2729
2730
		/**
2731
		 * Fires before default modules are activated.
2732
		 *
2733
		 * @since 1.9.0
2734
		 *
2735
		 * @param string $min_version Minimum version number required to use modules.
2736
		 * @param string $max_version Maximum version number required to use modules.
2737
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2738
		 */
2739
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2740
2741
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2742
		Jetpack::restate();
2743
		Jetpack::catch_errors( true );
2744
2745
		$active = Jetpack::get_active_modules();
2746
2747
		foreach ( $modules as $module ) {
2748
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2749
				$active[] = $module;
2750
				self::update_active_modules( $active );
2751
				continue;
2752
			}
2753
2754
			if ( $send_state_messages && in_array( $module, $active ) ) {
2755
				$module_info = Jetpack::get_module( $module );
2756 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2757
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2758
					if ( $active_state = Jetpack::state( $state ) ) {
2759
						$active_state = explode( ',', $active_state );
2760
					} else {
2761
						$active_state = array();
2762
					}
2763
					$active_state[] = $module;
2764
					Jetpack::state( $state, implode( ',', $active_state ) );
2765
				}
2766
				continue;
2767
			}
2768
2769
			$file = Jetpack::get_module_path( $module );
2770
			if ( ! file_exists( $file ) ) {
2771
				continue;
2772
			}
2773
2774
			// we'll override this later if the plugin can be included without fatal error
2775
			if ( $redirect ) {
2776
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2777
			}
2778
2779
			if ( $send_state_messages ) {
2780
				Jetpack::state( 'error', 'module_activation_failed' );
2781
				Jetpack::state( 'module', $module );
2782
			}
2783
2784
			ob_start();
2785
			require $file;
2786
2787
			$active[] = $module;
2788
2789 View Code Duplication
			if ( $send_state_messages ) {
2790
2791
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
2792
				if ( $active_state = Jetpack::state( $state ) ) {
2793
					$active_state = explode( ',', $active_state );
2794
				} else {
2795
					$active_state = array();
2796
				}
2797
				$active_state[] = $module;
2798
				Jetpack::state( $state, implode( ',', $active_state ) );
2799
			}
2800
2801
			Jetpack::update_active_modules( $active );
2802
2803
			ob_end_clean();
2804
		}
2805
2806
		if ( $send_state_messages ) {
2807
			Jetpack::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2808
			Jetpack::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2809
		}
2810
2811
		Jetpack::catch_errors( false );
2812
		/**
2813
		 * Fires when default modules are activated.
2814
		 *
2815
		 * @since 1.9.0
2816
		 *
2817
		 * @param string $min_version Minimum version number required to use modules.
2818
		 * @param string $max_version Maximum version number required to use modules.
2819
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2820
		 */
2821
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2822
	}
2823
2824
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2825
		/**
2826
		 * Fires before a module is activated.
2827
		 *
2828
		 * @since 2.6.0
2829
		 *
2830
		 * @param string $module Module slug.
2831
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2832
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2833
		 */
2834
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2835
2836
		$jetpack = Jetpack::init();
2837
2838
		if ( ! strlen( $module ) )
2839
			return false;
2840
2841
		if ( ! Jetpack::is_module( $module ) )
2842
			return false;
2843
2844
		// If it's already active, then don't do it again
2845
		$active = Jetpack::get_active_modules();
2846
		foreach ( $active as $act ) {
2847
			if ( $act == $module )
2848
				return true;
2849
		}
2850
2851
		$module_data = Jetpack::get_module( $module );
2852
2853
		if ( ! Jetpack::is_active() ) {
2854
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2855
				return false;
2856
2857
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2858
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2859
				return false;
2860
		}
2861
2862
		// Check and see if the old plugin is active
2863
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2864
			// Deactivate the old plugin
2865
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2866
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2867
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2868
				Jetpack::state( 'deactivated_plugins', $module );
2869
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2870
				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...
2871
			}
2872
		}
2873
2874
		// Protect won't work with mis-configured IPs
2875
		if ( 'protect' === $module ) {
2876
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2877
			if ( ! jetpack_protect_get_ip() ) {
2878
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2879
				return false;
2880
			}
2881
		}
2882
2883
		$plan = Jetpack::get_active_plan();
2884
2885
		if ( ! in_array( $module, $plan['supports'] ) ) {
2886
			return false;
2887
		}
2888
2889
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2890
		Jetpack::state( 'module', $module );
2891
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2892
2893
		Jetpack::catch_errors( true );
2894
		ob_start();
2895
		require Jetpack::get_module_path( $module );
2896
		/** This action is documented in class.jetpack.php */
2897
		do_action( 'jetpack_activate_module', $module );
2898
		$active[] = $module;
2899
		Jetpack::update_active_modules( $active );
2900
2901
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2902
		ob_end_clean();
2903
		Jetpack::catch_errors( false );
2904
2905
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2906 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2907
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2908
2909
			//Jump start is being dismissed send data to MC Stats
2910
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2911
2912
			$jetpack->do_stats( 'server_side' );
2913
		}
2914
2915
		if ( $redirect ) {
2916
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2917
		}
2918
		if ( $exit ) {
2919
			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...
2920
		}
2921
		return true;
2922
	}
2923
2924
	function activate_module_actions( $module ) {
2925
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2926
	}
2927
2928
	public static function deactivate_module( $module ) {
2929
		/**
2930
		 * Fires when a module is deactivated.
2931
		 *
2932
		 * @since 1.9.0
2933
		 *
2934
		 * @param string $module Module slug.
2935
		 */
2936
		do_action( 'jetpack_pre_deactivate_module', $module );
2937
2938
		$jetpack = Jetpack::init();
2939
2940
		$active = Jetpack::get_active_modules();
2941
		$new    = array_filter( array_diff( $active, (array) $module ) );
2942
2943
		// A flag for Jump Start so it's not shown again.
2944 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2945
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2946
2947
			//Jump start is being dismissed send data to MC Stats
2948
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2949
2950
			$jetpack->do_stats( 'server_side' );
2951
		}
2952
2953
		return self::update_active_modules( $new );
2954
	}
2955
2956
	public static function enable_module_configurable( $module ) {
2957
		$module = Jetpack::get_module_slug( $module );
2958
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2959
	}
2960
2961
	public static function module_configuration_url( $module ) {
2962
		$module = Jetpack::get_module_slug( $module );
2963
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2964
	}
2965
2966
	public static function module_configuration_load( $module, $method ) {
2967
		$module = Jetpack::get_module_slug( $module );
2968
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2969
	}
2970
2971
	public static function module_configuration_head( $module, $method ) {
2972
		$module = Jetpack::get_module_slug( $module );
2973
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2974
	}
2975
2976
	public static function module_configuration_screen( $module, $method ) {
2977
		$module = Jetpack::get_module_slug( $module );
2978
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2979
	}
2980
2981
	public static function module_configuration_activation_screen( $module, $method ) {
2982
		$module = Jetpack::get_module_slug( $module );
2983
		add_action( 'display_activate_module_setting_' . $module, $method );
2984
	}
2985
2986
/* Installation */
2987
2988
	public static function bail_on_activation( $message, $deactivate = true ) {
2989
?>
2990
<!doctype html>
2991
<html>
2992
<head>
2993
<meta charset="<?php bloginfo( 'charset' ); ?>">
2994
<style>
2995
* {
2996
	text-align: center;
2997
	margin: 0;
2998
	padding: 0;
2999
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3000
}
3001
p {
3002
	margin-top: 1em;
3003
	font-size: 18px;
3004
}
3005
</style>
3006
<body>
3007
<p><?php echo esc_html( $message ); ?></p>
3008
</body>
3009
</html>
3010
<?php
3011
		if ( $deactivate ) {
3012
			$plugins = get_option( 'active_plugins' );
3013
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3014
			$update  = false;
3015
			foreach ( $plugins as $i => $plugin ) {
3016
				if ( $plugin === $jetpack ) {
3017
					$plugins[$i] = false;
3018
					$update = true;
3019
				}
3020
			}
3021
3022
			if ( $update ) {
3023
				update_option( 'active_plugins', array_filter( $plugins ) );
3024
			}
3025
		}
3026
		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...
3027
	}
3028
3029
	/**
3030
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3031
	 * @static
3032
	 */
3033
	public static function plugin_activation( $network_wide ) {
3034
		Jetpack_Options::update_option( 'activated', 1 );
3035
3036
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3037
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3038
		}
3039
3040
		if ( $network_wide )
3041
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3042
3043
		// For firing one-off events (notices) immediately after activation
3044
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3045
3046
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3047
3048
		Jetpack::plugin_initialize();
3049
	}
3050
3051
	public static function get_activation_source( $referer_url ) {
3052
3053
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3054
			return array( 'wp-cli', null );
3055
		}
3056
3057
		$referer = parse_url( $referer_url );
3058
3059
		$source_type = 'unknown';
3060
		$source_query = null;
3061
3062
		if ( ! is_array( $referer ) ) {
3063
			return array( $source_type, $source_query );
3064
		}
3065
3066
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3067
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3068
3069
		if ( isset( $referer['query'] ) ) {
3070
			parse_str( $referer['query'], $query_parts );
3071
		} else {
3072
			$query_parts = array();
3073
		}
3074
3075
		if ( $plugins_path === $referer['path'] ) {
3076
			$source_type = 'list';
3077
		} elseif ( $plugins_install_path === $referer['path'] ) {
3078
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3079
			switch( $tab ) {
3080
				case 'popular':
3081
					$source_type = 'popular';
3082
					break;
3083
				case 'recommended':
3084
					$source_type = 'recommended';
3085
					break;
3086
				case 'favorites':
3087
					$source_type = 'favorites';
3088
					break;
3089
				case 'search':
3090
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3091
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3092
					break;
3093
				default:
3094
					$source_type = 'featured';
3095
			}
3096
		}
3097
3098
		return array( $source_type, $source_query );
3099
	}
3100
3101
	/**
3102
	 * Runs before bumping version numbers up to a new version
3103
	 * @param  string $version    Version:timestamp
3104
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3105
	 * @return null              [description]
3106
	 */
3107
	public static function do_version_bump( $version, $old_version ) {
3108
3109
		if ( ! $old_version ) { // For new sites
3110
			// Setting up jetpack manage
3111
			Jetpack::activate_manage();
3112
		}
3113
	}
3114
3115
	/**
3116
	 * Sets the internal version number and activation state.
3117
	 * @static
3118
	 */
3119
	public static function plugin_initialize() {
3120
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3121
			Jetpack_Options::update_option( 'activated', 2 );
3122
		}
3123
3124 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3125
			$version = $old_version = JETPACK__VERSION . ':' . time();
3126
			/** This action is documented in class.jetpack.php */
3127
			do_action( 'updating_jetpack_version', $version, false );
3128
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3129
		}
3130
3131
		Jetpack::load_modules();
3132
3133
		Jetpack_Options::delete_option( 'do_activate' );
3134
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3135
	}
3136
3137
	/**
3138
	 * Removes all connection options
3139
	 * @static
3140
	 */
3141
	public static function plugin_deactivation( ) {
3142
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3143
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3144
			Jetpack_Network::init()->deactivate();
3145
		} else {
3146
			Jetpack::disconnect( false );
3147
			//Jetpack_Heartbeat::init()->deactivate();
3148
		}
3149
	}
3150
3151
	/**
3152
	 * Disconnects from the Jetpack servers.
3153
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3154
	 * @static
3155
	 */
3156
	public static function disconnect( $update_activated_state = true ) {
3157
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3158
		Jetpack::clean_nonces( true );
3159
3160
		// If the site is in an IDC because sync is not allowed,
3161
		// let's make sure to not disconnect the production site.
3162
		if ( ! self::validate_sync_error_idc_option() ) {
3163
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3164
			Jetpack::load_xml_rpc_client();
3165
			$xml = new Jetpack_IXR_Client();
3166
			$xml->query( 'jetpack.deregister' );
3167
		}
3168
3169
		Jetpack_Options::delete_option(
3170
			array(
3171
				'blog_token',
3172
				'user_token',
3173
				'user_tokens',
3174
				'master_user',
3175
				'time_diff',
3176
				'fallback_no_verify_ssl_certs',
3177
			)
3178
		);
3179
3180
		Jetpack_IDC::clear_all_idc_options();
3181
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3182
3183
		if ( $update_activated_state ) {
3184
			Jetpack_Options::update_option( 'activated', 4 );
3185
		}
3186
3187
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3188
			// Check then record unique disconnection if site has never been disconnected previously
3189
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3190
				$jetpack_unique_connection['disconnected'] = 1;
3191
			} else {
3192
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3193
					//track unique disconnect
3194
					$jetpack = Jetpack::init();
3195
3196
					$jetpack->stat( 'connections', 'unique-disconnect' );
3197
					$jetpack->do_stats( 'server_side' );
3198
				}
3199
				// increment number of times disconnected
3200
				$jetpack_unique_connection['disconnected'] += 1;
3201
			}
3202
3203
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3204
		}
3205
3206
		// Delete cached connected user data
3207
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3208
		delete_transient( $transient_key );
3209
3210
		// Delete all the sync related data. Since it could be taking up space.
3211
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3212
		Jetpack_Sync_Sender::get_instance()->uninstall();
3213
3214
		// Disable the Heartbeat cron
3215
		Jetpack_Heartbeat::init()->deactivate();
3216
	}
3217
3218
	/**
3219
	 * Unlinks the current user from the linked WordPress.com user
3220
	 */
3221
	public static function unlink_user( $user_id = null ) {
3222
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3223
			return false;
3224
3225
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3226
3227
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3228
			return false;
3229
3230
		if ( ! isset( $tokens[ $user_id ] ) )
3231
			return false;
3232
3233
		Jetpack::load_xml_rpc_client();
3234
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3235
		$xml->query( 'jetpack.unlink_user', $user_id );
3236
3237
		unset( $tokens[ $user_id ] );
3238
3239
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3240
3241
		/**
3242
		 * Fires after the current user has been unlinked from WordPress.com.
3243
		 *
3244
		 * @since 4.1.0
3245
		 *
3246
		 * @param int $user_id The current user's ID.
3247
		 */
3248
		do_action( 'jetpack_unlinked_user', $user_id );
3249
3250
		return true;
3251
	}
3252
3253
	/**
3254
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3255
	 */
3256
	public static function try_registration() {
3257
		// The user has agreed to the TOS at some point by now.
3258
		Jetpack_Options::update_option( 'tos_agreed', true );
3259
3260
		// Let's get some testing in beta versions and such.
3261
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3262
			// Before attempting to connect, let's make sure that the domains are viable.
3263
			$domains_to_check = array_unique( array(
3264
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3265
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3266
			) );
3267
			foreach ( $domains_to_check as $domain ) {
3268
				$result = Jetpack_Data::is_usable_domain( $domain );
3269
				if ( is_wp_error( $result ) ) {
3270
					return $result;
3271
				}
3272
			}
3273
		}
3274
3275
		$result = Jetpack::register();
3276
3277
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3278
		if ( ! $result || is_wp_error( $result ) ) {
3279
			return $result;
3280
		} else {
3281
			return true;
3282
		}
3283
	}
3284
3285
	/**
3286
	 * Tracking an internal event log. Try not to put too much chaff in here.
3287
	 *
3288
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3289
	 */
3290
	public static function log( $code, $data = null ) {
3291
		// only grab the latest 200 entries
3292
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3293
3294
		// Append our event to the log
3295
		$log_entry = array(
3296
			'time'    => time(),
3297
			'user_id' => get_current_user_id(),
3298
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3299
			'code'    => $code,
3300
		);
3301
		// Don't bother storing it unless we've got some.
3302
		if ( ! is_null( $data ) ) {
3303
			$log_entry['data'] = $data;
3304
		}
3305
		$log[] = $log_entry;
3306
3307
		// Try add_option first, to make sure it's not autoloaded.
3308
		// @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...
3309
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3310
			Jetpack_Options::update_option( 'log', $log );
3311
		}
3312
3313
		/**
3314
		 * Fires when Jetpack logs an internal event.
3315
		 *
3316
		 * @since 3.0.0
3317
		 *
3318
		 * @param array $log_entry {
3319
		 *	Array of details about the log entry.
3320
		 *
3321
		 *	@param string time Time of the event.
3322
		 *	@param int user_id ID of the user who trigerred the event.
3323
		 *	@param int blog_id Jetpack Blog ID.
3324
		 *	@param string code Unique name for the event.
3325
		 *	@param string data Data about the event.
3326
		 * }
3327
		 */
3328
		do_action( 'jetpack_log_entry', $log_entry );
3329
	}
3330
3331
	/**
3332
	 * Get the internal event log.
3333
	 *
3334
	 * @param $event (string) - only return the specific log events
3335
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3336
	 *
3337
	 * @return array of log events || WP_Error for invalid params
3338
	 */
3339
	public static function get_log( $event = false, $num = false ) {
3340
		if ( $event && ! is_string( $event ) ) {
3341
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3342
		}
3343
3344
		if ( $num && ! is_numeric( $num ) ) {
3345
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3346
		}
3347
3348
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3349
3350
		// If nothing set - act as it did before, otherwise let's start customizing the output
3351
		if ( ! $num && ! $event ) {
3352
			return $entire_log;
3353
		} else {
3354
			$entire_log = array_reverse( $entire_log );
3355
		}
3356
3357
		$custom_log_output = array();
3358
3359
		if ( $event ) {
3360
			foreach ( $entire_log as $log_event ) {
3361
				if ( $event == $log_event[ 'code' ] ) {
3362
					$custom_log_output[] = $log_event;
3363
				}
3364
			}
3365
		} else {
3366
			$custom_log_output = $entire_log;
3367
		}
3368
3369
		if ( $num ) {
3370
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3371
		}
3372
3373
		return $custom_log_output;
3374
	}
3375
3376
	/**
3377
	 * Log modification of important settings.
3378
	 */
3379
	public static function log_settings_change( $option, $old_value, $value ) {
3380
		switch( $option ) {
3381
			case 'jetpack_sync_non_public_post_stati':
3382
				self::log( $option, $value );
3383
				break;
3384
		}
3385
	}
3386
3387
	/**
3388
	 * Return stat data for WPCOM sync
3389
	 */
3390
	public static function get_stat_data( $encode = true, $extended = true ) {
3391
		$data = Jetpack_Heartbeat::generate_stats_array();
3392
3393
		if ( $extended ) {
3394
			$additional_data = self::get_additional_stat_data();
3395
			$data = array_merge( $data, $additional_data );
3396
		}
3397
3398
		if ( $encode ) {
3399
			return json_encode( $data );
3400
		}
3401
3402
		return $data;
3403
	}
3404
3405
	/**
3406
	 * Get additional stat data to sync to WPCOM
3407
	 */
3408
	public static function get_additional_stat_data( $prefix = '' ) {
3409
		$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...
3410
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3411
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3412
		$return["{$prefix}site-count"]     = 0;
3413
3414
		if ( function_exists( 'get_blog_count' ) ) {
3415
			$return["{$prefix}site-count"] = get_blog_count();
3416
		}
3417
		return $return;
3418
	}
3419
3420
	private static function get_site_user_count() {
3421
		global $wpdb;
3422
3423
		if ( function_exists( 'wp_is_large_network' ) ) {
3424
			if ( wp_is_large_network( 'users' ) ) {
3425
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3426
			}
3427
		}
3428 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3429
			// It wasn't there, so regenerate the data and save the transient
3430
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3431
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3432
		}
3433
		return $user_count;
3434
	}
3435
3436
	/* Admin Pages */
3437
3438
	function admin_init() {
3439
		// If the plugin is not connected, display a connect message.
3440
		if (
3441
			// the plugin was auto-activated and needs its candy
3442
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3443
		||
3444
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3445
			! Jetpack_Options::get_option( 'activated' )
3446
		) {
3447
			Jetpack::plugin_initialize();
3448
		}
3449
3450
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3451
			Jetpack_Connection_Banner::init();
3452
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3453
			// Upgrade: 1.1 -> 1.1.1
3454
			// Check and see if host can verify the Jetpack servers' SSL certificate
3455
			$args = array();
3456
			Jetpack_Client::_wp_remote_request(
3457
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3458
				$args,
3459
				true
3460
			);
3461
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3462
			// Show the notice on the Dashboard only for now
3463
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3464
		}
3465
3466
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3467
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3468
		}
3469
3470
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3471
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3472
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3473
3474
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3475
			// Artificially throw errors in certain whitelisted cases during plugin activation
3476
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3477
		}
3478
3479
		// Jetpack Manage Activation Screen from .com
3480
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3481
3482
		// Add custom column in wp-admin/users.php to show whether user is linked.
3483
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3484
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3485
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3486
	}
3487
3488
	function admin_body_class( $admin_body_class = '' ) {
3489
		$classes = explode( ' ', trim( $admin_body_class ) );
3490
3491
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3492
3493
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3494
		return " $admin_body_class ";
3495
	}
3496
3497
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3498
		return $admin_body_class . ' jetpack-pagestyles ';
3499
	}
3500
3501
	/**
3502
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3503
	 *
3504
	 * @return null
3505
	 */
3506
	function prepare_manage_jetpack_notice() {
3507
3508
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3509
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3510
	}
3511
3512
	function manage_activate_screen() {
3513
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3514
	}
3515
	/**
3516
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3517
	 * This function artificially throws errors for such cases (whitelisted).
3518
	 *
3519
	 * @param string $plugin The activated plugin.
3520
	 */
3521
	function throw_error_on_activate_plugin( $plugin ) {
3522
		$active_modules = Jetpack::get_active_modules();
3523
3524
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3525
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3526
			$throw = false;
3527
3528
			// Try and make sure it really was the stats plugin
3529
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3530
				if ( 'stats.php' == basename( $plugin ) ) {
3531
					$throw = true;
3532
				}
3533
			} else {
3534
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3535
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3536
					$throw = true;
3537
				}
3538
			}
3539
3540
			if ( $throw ) {
3541
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3542
			}
3543
		}
3544
	}
3545
3546
	function intercept_plugin_error_scrape_init() {
3547
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3548
	}
3549
3550
	function intercept_plugin_error_scrape( $action, $result ) {
3551
		if ( ! $result ) {
3552
			return;
3553
		}
3554
3555
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3556
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3557
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3558
			}
3559
		}
3560
	}
3561
3562
	function add_remote_request_handlers() {
3563
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3564
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3565
	}
3566
3567
	function remote_request_handlers() {
3568
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3569
3570
		switch ( current_filter() ) {
3571
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3572
			$response = $this->upload_handler();
3573
			break;
3574
3575
		case 'wp_ajax_nopriv_jetpack_update_file' :
3576
			$response = $this->upload_handler( true );
3577
			break;
3578
		default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
3579
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3580
			break;
3581
		}
3582
3583
		if ( ! $response ) {
3584
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3585
		}
3586
3587
		if ( is_wp_error( $response ) ) {
3588
			$status_code       = $response->get_error_data();
3589
			$error             = $response->get_error_code();
3590
			$error_description = $response->get_error_message();
3591
3592
			if ( ! is_int( $status_code ) ) {
3593
				$status_code = 400;
3594
			}
3595
3596
			status_header( $status_code );
3597
			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...
3598
		}
3599
3600
		status_header( 200 );
3601
		if ( true === $response ) {
3602
			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...
3603
		}
3604
3605
		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...
3606
	}
3607
3608
	/**
3609
	 * Uploads a file gotten from the global $_FILES.
3610
	 * If `$update_media_item` is true and `post_id` is defined
3611
	 * the attachment file of the media item (gotten through of the post_id)
3612
	 * will be updated instead of add a new one.
3613
	 *
3614
	 * @param  boolean $update_media_item - update media attachment
3615
	 * @return array - An array describing the uploadind files process
3616
	 */
3617
	function upload_handler( $update_media_item = false ) {
3618
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3619
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3620
		}
3621
3622
		$user = wp_authenticate( '', '' );
3623
		if ( ! $user || is_wp_error( $user ) ) {
3624
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3625
		}
3626
3627
		wp_set_current_user( $user->ID );
3628
3629
		if ( ! current_user_can( 'upload_files' ) ) {
3630
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3631
		}
3632
3633
		if ( empty( $_FILES ) ) {
3634
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3635
		}
3636
3637
		foreach ( array_keys( $_FILES ) as $files_key ) {
3638
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3639
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3640
			}
3641
		}
3642
3643
		$media_keys = array_keys( $_FILES['media'] );
3644
3645
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3646
		if ( ! $token || is_wp_error( $token ) ) {
3647
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3648
		}
3649
3650
		$uploaded_files = array();
3651
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3652
		unset( $GLOBALS['post'] );
3653
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3654
			$file = array();
3655
			foreach ( $media_keys as $media_key ) {
3656
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3657
			}
3658
3659
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3660
3661
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3662
			if ( $hmac_provided !== $hmac_file ) {
3663
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3664
				continue;
3665
			}
3666
3667
			$_FILES['.jetpack.upload.'] = $file;
3668
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3669
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3670
				$post_id = 0;
3671
			}
3672
3673
			if ( $update_media_item ) {
3674
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3675
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3676
				}
3677
3678
				$media_array = $_FILES['media'];
3679
3680
				$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...
3681
				$file_array['type'] = $media_array['type'][0];
3682
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3683
				$file_array['error'] = $media_array['error'][0];
3684
				$file_array['size'] = $media_array['size'][0];
3685
3686
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3687
3688
				if ( is_wp_error( $edited_media_item ) ) {
3689
					return $edited_media_item;
3690
				}
3691
3692
				$response = (object) array(
3693
					'id'   => (string) $post_id,
3694
					'file' => (string) $edited_media_item->post_title,
3695
					'url'  => (string) wp_get_attachment_url( $post_id ),
3696
					'type' => (string) $edited_media_item->post_mime_type,
3697
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3698
				);
3699
3700
				return (array) array( $response );
3701
			}
3702
3703
			$attachment_id = media_handle_upload(
3704
				'.jetpack.upload.',
3705
				$post_id,
3706
				array(),
3707
				array(
3708
					'action' => 'jetpack_upload_file',
3709
				)
3710
			);
3711
3712
			if ( ! $attachment_id ) {
3713
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3714
			} elseif ( is_wp_error( $attachment_id ) ) {
3715
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3716
			} else {
3717
				$attachment = get_post( $attachment_id );
3718
				$uploaded_files[$index] = (object) array(
3719
					'id'   => (string) $attachment_id,
3720
					'file' => $attachment->post_title,
3721
					'url'  => wp_get_attachment_url( $attachment_id ),
3722
					'type' => $attachment->post_mime_type,
3723
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3724
				);
3725
				// Zip files uploads are not supported unless they are done for installation purposed
3726
				// lets delete them in case something goes wrong in this whole process
3727
				if ( 'application/zip' === $attachment->post_mime_type ) {
3728
					// Schedule a cleanup for 2 hours from now in case of failed install.
3729
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3730
				}
3731
			}
3732
		}
3733
		if ( ! is_null( $global_post ) ) {
3734
			$GLOBALS['post'] = $global_post;
3735
		}
3736
3737
		return $uploaded_files;
3738
	}
3739
3740
	/**
3741
	 * Add help to the Jetpack page
3742
	 *
3743
	 * @since Jetpack (1.2.3)
3744
	 * @return false if not the Jetpack page
3745
	 */
3746
	function admin_help() {
3747
		$current_screen = get_current_screen();
3748
3749
		// Overview
3750
		$current_screen->add_help_tab(
3751
			array(
3752
				'id'		=> 'home',
3753
				'title'		=> __( 'Home', 'jetpack' ),
3754
				'content'	=>
3755
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3756
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3757
					'<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>',
3758
			)
3759
		);
3760
3761
		// Screen Content
3762
		if ( current_user_can( 'manage_options' ) ) {
3763
			$current_screen->add_help_tab(
3764
				array(
3765
					'id'		=> 'settings',
3766
					'title'		=> __( 'Settings', 'jetpack' ),
3767
					'content'	=>
3768
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3769
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3770
						'<ol>' .
3771
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3772
							'<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>' .
3773
						'</ol>' .
3774
						'<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>'
3775
				)
3776
			);
3777
		}
3778
3779
		// Help Sidebar
3780
		$current_screen->set_help_sidebar(
3781
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3782
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3783
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3784
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3785
		);
3786
	}
3787
3788
	function admin_menu_css() {
3789
		wp_enqueue_style( 'jetpack-icons' );
3790
	}
3791
3792
	function admin_menu_order() {
3793
		return true;
3794
	}
3795
3796 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3797
		$jp_menu_order = array();
3798
3799
		foreach ( $menu_order as $index => $item ) {
3800
			if ( $item != 'jetpack' ) {
3801
				$jp_menu_order[] = $item;
3802
			}
3803
3804
			if ( $index == 0 ) {
3805
				$jp_menu_order[] = 'jetpack';
3806
			}
3807
		}
3808
3809
		return $jp_menu_order;
3810
	}
3811
3812
	function admin_head() {
3813 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3814
			/** This action is documented in class.jetpack-admin-page.php */
3815
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3816
	}
3817
3818
	function admin_banner_styles() {
3819
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3820
3821 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3822
			wp_register_style(
3823
				'jetpack-dops-style',
3824
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3825
				array(),
3826
				JETPACK__VERSION
3827
			);
3828
		}
3829
3830
		wp_enqueue_style(
3831
			'jetpack',
3832
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3833
			array( 'jetpack-dops-style' ),
3834
			 JETPACK__VERSION . '-20121016'
3835
		);
3836
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3837
		wp_style_add_data( 'jetpack', 'suffix', $min );
3838
	}
3839
3840
	function plugin_action_links( $actions ) {
3841
3842
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3843
3844
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3845
			return array_merge(
3846
				$jetpack_home,
3847
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3848
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3849
				$actions
3850
				);
3851
			}
3852
3853
		return array_merge( $jetpack_home, $actions );
3854
	}
3855
3856
	/**
3857
	 * This is the first banner
3858
	 * It should be visible only to user that can update the option
3859
	 * Are not connected
3860
	 *
3861
	 * @return null
3862
	 */
3863
	function admin_jetpack_manage_notice() {
3864
		$screen = get_current_screen();
3865
3866
		// Don't show the connect notice on the jetpack settings page.
3867
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3868
			return;
3869
		}
3870
3871
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3872
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3873
		/**
3874
		 * I think it would be great to have different wordsing depending on where you are
3875
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3876
		 * etc..
3877
		 */
3878
3879
		?>
3880
		<div id="message" class="updated jp-banner">
3881
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3882
				<div class="jp-banner__description-container">
3883
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3884
					<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>
3885
					<p class="jp-banner__button-container">
3886
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3887
						<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>
3888
					</p>
3889
				</div>
3890
		</div>
3891
		<?php
3892
	}
3893
3894
	/**
3895
	 * Returns the url that the user clicks to remove the notice for the big banner
3896
	 * @return string
3897
	 */
3898
	function opt_out_jetpack_manage_url() {
3899
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3900
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3901
	}
3902
	/**
3903
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3904
	 * @return string
3905
	 */
3906
	function opt_in_jetpack_manage_url() {
3907
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3908
	}
3909
3910
	function opt_in_jetpack_manage_notice() {
3911
		?>
3912
		<div class="wrap">
3913
			<div id="message" class="jetpack-message is-opt-in">
3914
				<?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' ); ?>
3915
			</div>
3916
		</div>
3917
		<?php
3918
3919
	}
3920
	/**
3921
	 * Determines whether to show the notice of not true = display notice
3922
	 * @return bool
3923
	 */
3924
	function can_display_jetpack_manage_notice() {
3925
		// never display the notice to users that can't do anything about it anyways
3926
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3927
			return false;
3928
3929
		// don't display if we are in development more
3930
		if( Jetpack::is_development_mode() ) {
3931
			return false;
3932
		}
3933
		// don't display if the site is private
3934
		if(  ! Jetpack_Options::get_option( 'public' ) )
3935
			return false;
3936
3937
		/**
3938
		 * Should the Jetpack Remote Site Management notice be displayed.
3939
		 *
3940
		 * @since 3.3.0
3941
		 *
3942
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3943
		 */
3944
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3945
	}
3946
3947
	/*
3948
	 * Registration flow:
3949
	 * 1 - ::admin_page_load() action=register
3950
	 * 2 - ::try_registration()
3951
	 * 3 - ::register()
3952
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3953
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3954
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3955
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3956
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3957
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3958
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3959
	 *       jetpack_id, jetpack_secret, jetpack_public
3960
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3961
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3962
	 * 5 - user logs in with WP.com account
3963
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3964
	 *		- Jetpack_Client_Server::authorize()
3965
	 *		- Jetpack_Client_Server::get_token()
3966
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3967
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3968
	 *			- which responds with access_token, token_type, scope
3969
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3970
	 *		- Jetpack::activate_default_modules()
3971
	 *     		- Deactivates deprecated plugins
3972
	 *     		- Activates all default modules
3973
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3974
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3975
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3976
	 *     Done!
3977
	 */
3978
3979
	/**
3980
	 * Handles the page load events for the Jetpack admin page
3981
	 */
3982
	function admin_page_load() {
3983
		$error = false;
3984
3985
		// Make sure we have the right body class to hook stylings for subpages off of.
3986
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3987
3988
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3989
			// Should only be used in intermediate redirects to preserve state across redirects
3990
			Jetpack::restate();
3991
		}
3992
3993
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3994
			// User clicked in the iframe to link their accounts
3995
			if ( ! Jetpack::is_user_connected() ) {
3996
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3997
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3998
3999
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4000
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4001
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4002
4003
				if ( isset( $_GET['notes_iframe'] ) )
4004
					$connect_url .= '&notes_iframe';
4005
				wp_redirect( $connect_url );
4006
				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...
4007
			} else {
4008
				if ( ! isset( $_GET['calypso_env'] ) ) {
4009
					Jetpack::state( 'message', 'already_authorized' );
4010
					wp_safe_redirect( Jetpack::admin_url() );
4011
					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...
4012
				} else {
4013
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4014
					$connect_url .= '&already_authorized=true';
4015
					wp_redirect( $connect_url );
4016
					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...
4017
				}
4018
			}
4019
		}
4020
4021
4022
		if ( isset( $_GET['action'] ) ) {
4023
			switch ( $_GET['action'] ) {
4024
			case 'authorize':
4025
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4026
					Jetpack::state( 'message', 'already_authorized' );
4027
					wp_safe_redirect( Jetpack::admin_url() );
4028
					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...
4029
				}
4030
				Jetpack::log( 'authorize' );
4031
				$client_server = new Jetpack_Client_Server;
4032
				$client_server->client_authorize();
4033
				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...
4034
			case 'register' :
4035
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4036
					$error = 'cheatin';
4037
					break;
4038
				}
4039
				check_admin_referer( 'jetpack-register' );
4040
				Jetpack::log( 'register' );
4041
				Jetpack::maybe_set_version_option();
4042
				$registered = Jetpack::try_registration();
4043
				if ( is_wp_error( $registered ) ) {
4044
					$error = $registered->get_error_code();
4045
					Jetpack::state( 'error', $error );
4046
					Jetpack::state( 'error', $registered->get_error_message() );
4047
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4048
						'error_code' => $error,
4049
						'error_message' => $registered->get_error_message()
4050
					) );
4051
					break;
4052
				}
4053
4054
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4055
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4056
4057
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4058
					'from' => $from
4059
				) );
4060
4061
				$url = $this->build_connect_url( true, $redirect, $from );
4062
4063
				if ( ! empty( $_GET['onboarding'] ) ) {
4064
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4065
				}
4066
4067
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4068
					$url = add_query_arg( 'auth_approved', 'true', $url );
4069
				}
4070
4071
				wp_redirect( $url );
4072
				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...
4073
			case 'activate' :
4074
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4075
					$error = 'cheatin';
4076
					break;
4077
				}
4078
4079
				$module = stripslashes( $_GET['module'] );
4080
				check_admin_referer( "jetpack_activate-$module" );
4081
				Jetpack::log( 'activate', $module );
4082
				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...
4083
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4084
				}
4085
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4086
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4087
				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...
4088
			case 'activate_default_modules' :
4089
				check_admin_referer( 'activate_default_modules' );
4090
				Jetpack::log( 'activate_default_modules' );
4091
				Jetpack::restate();
4092
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4093
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4094
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4095
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4096
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4097
				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...
4098
			case 'disconnect' :
4099
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4100
					$error = 'cheatin';
4101
					break;
4102
				}
4103
4104
				check_admin_referer( 'jetpack-disconnect' );
4105
				Jetpack::log( 'disconnect' );
4106
				Jetpack::disconnect();
4107
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4108
				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...
4109
			case 'reconnect' :
4110
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4111
					$error = 'cheatin';
4112
					break;
4113
				}
4114
4115
				check_admin_referer( 'jetpack-reconnect' );
4116
				Jetpack::log( 'reconnect' );
4117
				$this->disconnect();
4118
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4119
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
4120 View Code Duplication
			case 'deactivate' :
4121
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4122
					$error = 'cheatin';
4123
					break;
4124
				}
4125
4126
				$modules = stripslashes( $_GET['module'] );
4127
				check_admin_referer( "jetpack_deactivate-$modules" );
4128
				foreach ( explode( ',', $modules ) as $module ) {
4129
					Jetpack::log( 'deactivate', $module );
4130
					Jetpack::deactivate_module( $module );
4131
					Jetpack::state( 'message', 'module_deactivated' );
4132
				}
4133
				Jetpack::state( 'module', $modules );
4134
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4135
				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...
4136
			case 'unlink' :
4137
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4138
				check_admin_referer( 'jetpack-unlink' );
4139
				Jetpack::log( 'unlink' );
4140
				$this->unlink_user();
4141
				Jetpack::state( 'message', 'unlinked' );
4142
				if ( 'sub-unlink' == $redirect ) {
4143
					wp_safe_redirect( admin_url() );
4144
				} else {
4145
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4146
				}
4147
				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...
4148
			case 'onboard' :
4149
				if ( ! current_user_can( 'manage_options' ) ) {
4150
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4151
				} else {
4152
					Jetpack::create_onboarding_token();
4153
					$url = $this->build_connect_url( true );
4154
4155
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4156
						$url = add_query_arg( 'onboarding', $token, $url );
4157
					}
4158
4159
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4160
					if ( $calypso_env ) {
4161
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4162
					}
4163
4164
					wp_redirect( $url );
4165
					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...
4166
				}
4167
				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...
4168
			default:
4169
				/**
4170
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4171
				 *
4172
				 * @since 2.6.0
4173
				 *
4174
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4175
				 */
4176
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4177
			}
4178
		}
4179
4180
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4181
			self::activate_new_modules( true );
4182
		}
4183
4184
		$message_code = Jetpack::state( 'message' );
4185
		if ( Jetpack::state( 'optin-manage' ) ) {
4186
			$activated_manage = $message_code;
4187
			$message_code = 'jetpack-manage';
4188
		}
4189
4190
		switch ( $message_code ) {
4191
		case 'jetpack-manage':
4192
			$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>';
4193
			if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4194
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4195
			}
4196
			break;
4197
4198
		}
4199
4200
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4201
4202
		if ( ! empty( $deactivated_plugins ) ) {
4203
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4204
			$deactivated_titles  = array();
4205
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4206
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4207
					continue;
4208
				}
4209
4210
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4211
			}
4212
4213
			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...
4214
				if ( $this->message ) {
4215
					$this->message .= "<br /><br />\n";
4216
				}
4217
4218
				$this->message .= wp_sprintf(
4219
					_n(
4220
						'Jetpack contains the most recent version of the old %l plugin.',
4221
						'Jetpack contains the most recent versions of the old %l plugins.',
4222
						count( $deactivated_titles ),
4223
						'jetpack'
4224
					),
4225
					$deactivated_titles
4226
				);
4227
4228
				$this->message .= "<br />\n";
4229
4230
				$this->message .= _n(
4231
					'The old version has been deactivated and can be removed from your site.',
4232
					'The old versions have been deactivated and can be removed from your site.',
4233
					count( $deactivated_titles ),
4234
					'jetpack'
4235
				);
4236
			}
4237
		}
4238
4239
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4240
4241
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4242
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4243
		}
4244
4245 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4246
			/**
4247
			 * Fires when a module configuration page is loaded.
4248
			 * The dynamic part of the hook is the configure parameter from the URL.
4249
			 *
4250
			 * @since 1.1.0
4251
			 */
4252
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4253
		}
4254
4255
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4256
	}
4257
4258
	function admin_notices() {
4259
4260
		if ( $this->error ) {
4261
?>
4262
<div id="message" class="jetpack-message jetpack-err">
4263
	<div class="squeezer">
4264
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4265
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4266
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4267
<?php	endif; ?>
4268
	</div>
4269
</div>
4270
<?php
4271
		}
4272
4273
		if ( $this->message ) {
4274
?>
4275
<div id="message" class="jetpack-message">
4276
	<div class="squeezer">
4277
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4278
	</div>
4279
</div>
4280
<?php
4281
		}
4282
4283
		if ( $this->privacy_checks ) :
4284
			$module_names = $module_slugs = array();
4285
4286
			$privacy_checks = explode( ',', $this->privacy_checks );
4287
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4288
			foreach ( $privacy_checks as $module_slug ) {
4289
				$module = Jetpack::get_module( $module_slug );
4290
				if ( ! $module ) {
4291
					continue;
4292
				}
4293
4294
				$module_slugs[] = $module_slug;
4295
				$module_names[] = "<strong>{$module['name']}</strong>";
4296
			}
4297
4298
			$module_slugs = join( ',', $module_slugs );
4299
?>
4300
<div id="message" class="jetpack-message jetpack-err">
4301
	<div class="squeezer">
4302
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4303
		<p><?php
4304
			echo wp_kses(
4305
				wptexturize(
4306
					wp_sprintf(
4307
						_nx(
4308
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4309
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4310
							count( $privacy_checks ),
4311
							'%l = list of Jetpack module/feature names',
4312
							'jetpack'
4313
						),
4314
						$module_names
4315
					)
4316
				),
4317
				array( 'strong' => true )
4318
			);
4319
4320
			echo "\n<br />\n";
4321
4322
			echo wp_kses(
4323
				sprintf(
4324
					_nx(
4325
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4326
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4327
						count( $privacy_checks ),
4328
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4329
						'jetpack'
4330
					),
4331
					wp_nonce_url(
4332
						Jetpack::admin_url(
4333
							array(
4334
								'page'   => 'jetpack',
4335
								'action' => 'deactivate',
4336
								'module' => urlencode( $module_slugs ),
4337
							)
4338
						),
4339
						"jetpack_deactivate-$module_slugs"
4340
					),
4341
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4342
				),
4343
				array( 'a' => array( 'href' => true, 'title' => true ) )
4344
			);
4345
		?></p>
4346
	</div>
4347
</div>
4348
<?php endif;
4349
	// only display the notice if the other stuff is not there
4350
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4351
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4352
			$this->opt_in_jetpack_manage_notice();
4353
		}
4354
	}
4355
4356
	/**
4357
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4358
	 */
4359
	function stat( $group, $detail ) {
4360
		if ( ! isset( $this->stats[ $group ] ) )
4361
			$this->stats[ $group ] = array();
4362
		$this->stats[ $group ][] = $detail;
4363
	}
4364
4365
	/**
4366
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4367
	 */
4368
	function do_stats( $method = '' ) {
4369
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4370
			foreach ( $this->stats as $group => $stats ) {
4371
				if ( is_array( $stats ) && count( $stats ) ) {
4372
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4373
					if ( 'server_side' === $method ) {
4374
						self::do_server_side_stat( $args );
4375
					} else {
4376
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4377
					}
4378
				}
4379
				unset( $this->stats[ $group ] );
4380
			}
4381
		}
4382
	}
4383
4384
	/**
4385
	 * Runs stats code for a one-off, server-side.
4386
	 *
4387
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4388
	 *
4389
	 * @return bool If it worked.
4390
	 */
4391
	static function do_server_side_stat( $args ) {
4392
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4393
		if ( is_wp_error( $response ) )
4394
			return false;
4395
4396
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4397
			return false;
4398
4399
		return true;
4400
	}
4401
4402
	/**
4403
	 * Builds the stats url.
4404
	 *
4405
	 * @param $args array|string The arguments to append to the URL.
4406
	 *
4407
	 * @return string The URL to be pinged.
4408
	 */
4409
	static function build_stats_url( $args ) {
4410
		$defaults = array(
4411
			'v'    => 'wpcom2',
4412
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4413
		);
4414
		$args     = wp_parse_args( $args, $defaults );
4415
		/**
4416
		 * Filter the URL used as the Stats tracking pixel.
4417
		 *
4418
		 * @since 2.3.2
4419
		 *
4420
		 * @param string $url Base URL used as the Stats tracking pixel.
4421
		 */
4422
		$base_url = apply_filters(
4423
			'jetpack_stats_base_url',
4424
			'https://pixel.wp.com/g.gif'
4425
		);
4426
		$url      = add_query_arg( $args, $base_url );
4427
		return $url;
4428
	}
4429
4430
	static function translate_current_user_to_role() {
4431
		foreach ( self::$capability_translations as $role => $cap ) {
4432
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4433
				return $role;
4434
			}
4435
		}
4436
4437
		return false;
4438
	}
4439
4440
	static function translate_user_to_role( $user ) {
4441
		foreach ( self::$capability_translations as $role => $cap ) {
4442
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4443
				return $role;
4444
			}
4445
		}
4446
4447
		return false;
4448
    }
4449
4450
	static function translate_role_to_cap( $role ) {
4451
		if ( ! isset( self::$capability_translations[$role] ) ) {
4452
			return false;
4453
		}
4454
4455
		return self::$capability_translations[$role];
4456
	}
4457
4458
	static function sign_role( $role, $user_id = null ) {
4459
		if ( empty( $user_id ) ) {
4460
			$user_id = (int) get_current_user_id();
4461
		}
4462
4463
		if ( ! $user_id  ) {
4464
			return false;
4465
		}
4466
4467
		$token = Jetpack_Data::get_access_token();
4468
		if ( ! $token || is_wp_error( $token ) ) {
4469
			return false;
4470
		}
4471
4472
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4473
	}
4474
4475
4476
	/**
4477
	 * Builds a URL to the Jetpack connection auth page
4478
	 *
4479
	 * @since 3.9.5
4480
	 *
4481
	 * @param bool $raw If true, URL will not be escaped.
4482
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4483
	 *                              If string, will be a custom redirect.
4484
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4485
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4486
	 *
4487
	 * @return string Connect URL
4488
	 */
4489
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4490
		$site_id = Jetpack_Options::get_option( 'id' );
4491
		$token = Jetpack_Options::get_option( 'blog_token' );
4492
4493
		if ( $register || ! $token || ! $site_id ) {
4494
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4495
4496
			if ( ! empty( $redirect ) ) {
4497
				$url = add_query_arg(
4498
					'redirect',
4499
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4500
					$url
4501
				);
4502
			}
4503
4504
			if( is_network_admin() ) {
4505
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4506
			}
4507
		} else {
4508
4509
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4510
			// because otherwise this logic can get us in to a loop.
4511
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4512
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4513
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4514
4515
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4516
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4517
					'1.1'
4518
				);
4519
4520
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4521
					// Generating a register URL instead to refresh the existing token
4522
					return $this->build_connect_url( $raw, $redirect, $from, true );
4523
				}
4524
			}
4525
4526
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4527
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4528
			}
4529
4530
			$role = self::translate_current_user_to_role();
4531
			$signed_role = self::sign_role( $role );
4532
4533
			$user = wp_get_current_user();
4534
4535
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4536
			$redirect = $redirect
4537
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4538
				: $jetpack_admin_page;
4539
4540
			if( isset( $_REQUEST['is_multisite'] ) ) {
4541
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4542
			}
4543
4544
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4545
4546
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4547
				? get_site_icon_url()
4548
				: false;
4549
4550
			/**
4551
			 * Filter the type of authorization.
4552
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4553
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4554
			 *
4555
			 * @since 4.3.3
4556
			 *
4557
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4558
			 */
4559
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4560
4561
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4562
4563
			$args = urlencode_deep(
4564
				array(
4565
					'response_type' => 'code',
4566
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4567
					'redirect_uri'  => add_query_arg(
4568
						array(
4569
							'action'   => 'authorize',
4570
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4571
							'redirect' => urlencode( $redirect ),
4572
						),
4573
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4574
					),
4575
					'state'         => $user->ID,
4576
					'scope'         => $signed_role,
4577
					'user_email'    => $user->user_email,
4578
					'user_login'    => $user->user_login,
4579
					'is_active'     => Jetpack::is_active(),
4580
					'jp_version'    => JETPACK__VERSION,
4581
					'auth_type'     => $auth_type,
4582
					'secret'        => $secrets['secret_1'],
4583
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4584
					'blogname'      => get_option( 'blogname' ),
4585
					'site_url'      => site_url(),
4586
					'home_url'      => home_url(),
4587
					'site_icon'     => $site_icon,
4588
					'site_lang'     => get_locale(),
4589
					'_ui'           => $tracks_identity['_ui'],
4590
					'_ut'           => $tracks_identity['_ut']
4591
				)
4592
			);
4593
4594
			self::apply_activation_source_to_args( $args );
4595
4596
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4597
		}
4598
4599
		if ( $from ) {
4600
			$url = add_query_arg( 'from', $from, $url );
4601
		}
4602
4603
4604
		if ( isset( $_GET['calypso_env'] ) ) {
4605
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4606
		}
4607
4608
		return $raw ? $url : esc_url( $url );
4609
	}
4610
4611
	public static function apply_activation_source_to_args( &$args ) {
4612
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4613
4614
		if ( $activation_source_name ) {
4615
			$args['_as'] = urlencode( $activation_source_name );
4616
		}
4617
4618
		if ( $activation_source_keyword ) {
4619
			$args['_ak'] = urlencode( $activation_source_keyword );
4620
		}
4621
	}
4622
4623
	function build_reconnect_url( $raw = false ) {
4624
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4625
		return $raw ? $url : esc_url( $url );
4626
	}
4627
4628
	public static function admin_url( $args = null ) {
4629
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4630
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4631
		return $url;
4632
	}
4633
4634
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4635
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4636
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4637
	}
4638
4639
	function dismiss_jetpack_notice() {
4640
4641
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4642
			return;
4643
		}
4644
4645
		switch( $_GET['jetpack-notice'] ) {
4646
			case 'dismiss':
4647
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4648
4649
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4650
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4651
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4652
				}
4653
				break;
4654 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4655
4656
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4657
					// Don't show the banner again
4658
4659
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4660
					// redirect back to the page that had the notice
4661
					if ( wp_get_referer() ) {
4662
						wp_safe_redirect( wp_get_referer() );
4663
					} else {
4664
						// Take me to Jetpack
4665
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4666
					}
4667
				}
4668
				break;
4669 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4670
4671
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4672
					// Don't show the banner again
4673
4674
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4675
					// redirect back to the page that had the notice
4676
					if ( wp_get_referer() ) {
4677
						wp_safe_redirect( wp_get_referer() );
4678
					} else {
4679
						// Take me to Jetpack
4680
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4681
					}
4682
				}
4683
				break;
4684
			case 'jetpack-manage-opt-in':
4685
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4686
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4687
4688
					$redirection_url = Jetpack::admin_url();
4689
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4690
4691
					// Don't redirect form the Jetpack Setting Page
4692
					$referer_parsed = parse_url ( wp_get_referer() );
4693
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4694
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4695
						// Take the user to Jetpack home except when on the setting page
4696
						$redirection_url = wp_get_referer();
4697
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4698
					}
4699
					// Also update the JSON API FULL MANAGEMENT Option
4700
					Jetpack::activate_module( 'manage', false, false );
4701
4702
					// Special Message when option in.
4703
					Jetpack::state( 'optin-manage', 'true' );
4704
					// Activate the Module if not activated already
4705
4706
					// Redirect properly
4707
					wp_safe_redirect( $redirection_url );
4708
4709
				}
4710
				break;
4711
		}
4712
	}
4713
4714
	public static function admin_screen_configure_module( $module_id ) {
4715
4716
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4717
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4718
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4719
				/**
4720
				 * Fires to diplay a custom module activation screen.
4721
				 *
4722
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4723
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4724
				 *
4725
				 * @module manage
4726
				 *
4727
				 * @since 3.8.0
4728
				 *
4729
				 * @param int $module_id Module ID.
4730
				 */
4731
				do_action( 'display_activate_module_setting_' . $module_id );
4732
			} else {
4733
				self::display_activate_module_link( $module_id );
4734
			}
4735
4736
			return false;
4737
		} ?>
4738
4739
		<div id="jp-settings-screen" style="position: relative">
4740
			<h3>
4741
			<?php
4742
				$module = Jetpack::get_module( $module_id );
4743
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4744
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4745
			?>
4746
			</h3>
4747
			<?php
4748
				/**
4749
				 * Fires within the displayed message when a feature configuation is updated.
4750
				 *
4751
				 * @since 3.4.0
4752
				 *
4753
				 * @param int $module_id Module ID.
4754
				 */
4755
				do_action( 'jetpack_notices_update_settings', $module_id );
4756
				/**
4757
				 * Fires when a feature configuation screen is loaded.
4758
				 * The dynamic part of the hook, $module_id, is the module ID.
4759
				 *
4760
				 * @since 1.1.0
4761
				 */
4762
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4763
			?>
4764
		</div><?php
4765
	}
4766
4767
	/**
4768
	 * Display link to activate the module to see the settings screen.
4769
	 * @param  string $module_id
4770
	 * @return null
4771
	 */
4772
	public static function display_activate_module_link( $module_id ) {
4773
4774
		$info =  Jetpack::get_module( $module_id );
4775
		$extra = '';
4776
		$activate_url = wp_nonce_url(
4777
				Jetpack::admin_url(
4778
					array(
4779
						'page'   => 'jetpack',
4780
						'action' => 'activate',
4781
						'module' => $module_id,
4782
					)
4783
				),
4784
				"jetpack_activate-$module_id"
4785
			);
4786
4787
		?>
4788
4789
		<div class="wrap configure-module">
4790
			<div id="jp-settings-screen">
4791
				<?php
4792
				if ( $module_id == 'json-api' ) {
4793
4794
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4795
4796
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4797
4798
					$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' );
4799
4800
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4801
				} ?>
4802
4803
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4804
				<div class="narrow">
4805
					<p><?php echo  $info['description']; ?></p>
4806
					<?php if( $extra ) { ?>
4807
					<p><?php echo esc_html( $extra ); ?></p>
4808
					<?php } ?>
4809
					<p>
4810
						<?php
4811
						if( wp_get_referer() ) {
4812
							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() );
4813
						} else {
4814
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4815
						} ?>
4816
					</p>
4817
				</div>
4818
4819
			</div>
4820
		</div>
4821
4822
		<?php
4823
	}
4824
4825
	public static function sort_modules( $a, $b ) {
4826
		if ( $a['sort'] == $b['sort'] )
4827
			return 0;
4828
4829
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4830
	}
4831
4832
	function ajax_recheck_ssl() {
4833
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4834
		$result = Jetpack::permit_ssl( true );
4835
		wp_send_json( array(
4836
			'enabled' => $result,
4837
			'message' => get_transient( 'jetpack_https_test_message' )
4838
		) );
4839
	}
4840
4841
/* Client API */
4842
4843
	/**
4844
	 * Returns the requested Jetpack API URL
4845
	 *
4846
	 * @return string
4847
	 */
4848
	public static function api_url( $relative_url ) {
4849
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4850
	}
4851
4852
	/**
4853
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4854
	 */
4855
	public static function fix_url_for_bad_hosts( $url ) {
4856
		if ( 0 !== strpos( $url, 'https://' ) ) {
4857
			return $url;
4858
		}
4859
4860
		switch ( JETPACK_CLIENT__HTTPS ) {
4861
			case 'ALWAYS' :
4862
				return $url;
4863
			case 'NEVER' :
4864
				return set_url_scheme( $url, 'http' );
4865
			// default : case 'AUTO' :
4866
		}
4867
4868
		// we now return the unmodified SSL URL by default, as a security precaution
4869
		return $url;
4870
	}
4871
4872
	/**
4873
	 * Create a random secret for validating onboarding payload
4874
	 *
4875
	 * @return string Secret token
4876
	 */
4877
	public static function create_onboarding_token() {
4878
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4879
			$token = wp_generate_password( 32, false );
4880
			Jetpack_Options::update_option( 'onboarding', $token );
4881
		}
4882
4883
		return $token;
4884
	}
4885
4886
	/**
4887
	 * Remove the onboarding token
4888
	 *
4889
	 * @return bool True on success, false on failure
4890
	 */
4891
	public static function invalidate_onboarding_token() {
4892
		return Jetpack_Options::delete_option( 'onboarding' );
4893
	}
4894
4895
	/**
4896
	 * Validate an onboarding token for a specific action
4897
	 *
4898
	 * @return boolean True if token/action pair is accepted, false if not
4899
	 */
4900
	public static function validate_onboarding_token_action( $token, $action ) {
4901
		// Compare tokens, bail if tokens do not match
4902
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4903
			return false;
4904
		}
4905
4906
		// List of valid actions we can take
4907
		$valid_actions = array(
4908
			'/jetpack/v4/settings',
4909
		);
4910
4911
		// Whitelist the action
4912
		if ( ! in_array( $action, $valid_actions ) ) {
4913
			return false;
4914
		}
4915
4916
		return true;
4917
	}
4918
4919
	/**
4920
	 * Checks to see if the URL is using SSL to connect with Jetpack
4921
	 *
4922
	 * @since 2.3.3
4923
	 * @return boolean
4924
	 */
4925
	public static function permit_ssl( $force_recheck = false ) {
4926
		// Do some fancy tests to see if ssl is being supported
4927
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4928
			$message = '';
4929
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4930
				$ssl = 0;
4931
			} else {
4932
				switch ( JETPACK_CLIENT__HTTPS ) {
4933
					case 'NEVER':
4934
						$ssl = 0;
4935
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4936
						break;
4937
					case 'ALWAYS':
4938
					case 'AUTO':
4939
					default:
4940
						$ssl = 1;
4941
						break;
4942
				}
4943
4944
				// If it's not 'NEVER', test to see
4945
				if ( $ssl ) {
4946
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4947
						$ssl = 0;
4948
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4949
					} else {
4950
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4951
						if ( is_wp_error( $response ) ) {
4952
							$ssl = 0;
4953
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4954
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4955
							$ssl = 0;
4956
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4957
						}
4958
					}
4959
				}
4960
			}
4961
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4962
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4963
		}
4964
4965
		return (bool) $ssl;
4966
	}
4967
4968
	/*
4969
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4970
	 */
4971
	public function alert_auto_ssl_fail() {
4972
		if ( ! current_user_can( 'manage_options' ) )
4973
			return;
4974
4975
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4976
		?>
4977
4978
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4979
			<div class="jp-banner__content">
4980
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4981
				<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>
4982
				<p>
4983
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4984
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4985
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4986
				</p>
4987
				<p>
4988
					<?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' ),
4989
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4990
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4991
				</p>
4992
			</div>
4993
		</div>
4994
		<style>
4995
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4996
		</style>
4997
		<script type="text/javascript">
4998
			jQuery( document ).ready( function( $ ) {
4999
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5000
					var $this = $( this );
5001
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5002
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5003
					e.preventDefault();
5004
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5005
					$.post( ajaxurl, data )
5006
					  .done( function( response ) {
5007
					  	if ( response.enabled ) {
5008
					  		$( '#jetpack-ssl-warning' ).hide();
5009
					  	} else {
5010
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5011
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5012
					  	}
5013
					  }.bind( $this ) );
5014
				} );
5015
			} );
5016
		</script>
5017
5018
		<?php
5019
	}
5020
5021
	/**
5022
	 * Returns the Jetpack XML-RPC API
5023
	 *
5024
	 * @return string
5025
	 */
5026
	public static function xmlrpc_api_url() {
5027
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5028
		return untrailingslashit( $base ) . '/xmlrpc.php';
5029
	}
5030
5031
	/**
5032
	 * Creates two secret tokens and the end of life timestamp for them.
5033
	 *
5034
	 * Note these tokens are unique per call, NOT static per site for connecting.
5035
	 *
5036
	 * @since 2.6
5037
	 * @return array
5038
	 */
5039
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5040
		if ( ! $user_id ) {
5041
			$user_id = get_current_user_id();
5042
		}
5043
5044
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5045
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5046
5047
		if (
5048
			isset( $secrets[ $secret_name ] ) &&
5049
			$secrets[ $secret_name ]['exp'] > time()
5050
		) {
5051
			return $secrets[ $secret_name ];
5052
		}
5053
5054
		$secret_value = array(
5055
			'secret_1'  => wp_generate_password( 32, false ),
5056
			'secret_2'  => wp_generate_password( 32, false ),
5057
			'exp'       => time() + $exp,
5058
		);
5059
5060
		$secrets[ $secret_name ] = $secret_value;
5061
5062
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5063
		return $secrets[ $secret_name ];
5064
	}
5065
5066
	public static function get_secrets( $action, $user_id ) {
5067
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5068
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5069
5070
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5071
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5072
		}
5073
5074
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5075
			self::delete_secrets( $action, $user_id );
5076
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5077
		}
5078
5079
		return $secrets[ $secret_name ];
5080
	}
5081
5082
	public static function delete_secrets( $action, $user_id ) {
5083
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5084
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5085
		if ( isset( $secrets[ $secret_name ] ) ) {
5086
			unset( $secrets[ $secret_name ] );
5087
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5088
		}
5089
	}
5090
5091
	/**
5092
	 * Builds the timeout limit for queries talking with the wpcom servers.
5093
	 *
5094
	 * Based on local php max_execution_time in php.ini
5095
	 *
5096
	 * @since 2.6
5097
	 * @return int
5098
	 * @deprecated
5099
	 **/
5100
	public function get_remote_query_timeout_limit() {
5101
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5102
		return Jetpack::get_max_execution_time();
5103
	}
5104
5105
	/**
5106
	 * Builds the timeout limit for queries talking with the wpcom servers.
5107
	 *
5108
	 * Based on local php max_execution_time in php.ini
5109
	 *
5110
	 * @since 5.4
5111
	 * @return int
5112
	 **/
5113
	public static function get_max_execution_time() {
5114
		$timeout = (int) ini_get( 'max_execution_time' );
5115
5116
		// Ensure exec time set in php.ini
5117
		if ( ! $timeout ) {
5118
			$timeout = 30;
5119
		}
5120
		return $timeout;
5121
	}
5122
5123
	/**
5124
	 * Sets a minimum request timeout, and returns the current timeout
5125
	 *
5126
	 * @since 5.4
5127
	 **/
5128
	public static function set_min_time_limit( $min_timeout ) {
5129
		$timeout = self::get_max_execution_time();
5130
		if ( $timeout < $min_timeout ) {
5131
			$timeout = $min_timeout;
5132
			set_time_limit( $timeout );
5133
		}
5134
		return $timeout;
5135
	}
5136
5137
5138
	/**
5139
	 * Takes the response from the Jetpack register new site endpoint and
5140
	 * verifies it worked properly.
5141
	 *
5142
	 * @since 2.6
5143
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5144
	 **/
5145
	public function validate_remote_register_response( $response ) {
5146
	  if ( is_wp_error( $response ) ) {
5147
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5148
		}
5149
5150
		$code   = wp_remote_retrieve_response_code( $response );
5151
		$entity = wp_remote_retrieve_body( $response );
5152
		if ( $entity )
5153
			$registration_response = json_decode( $entity );
5154
		else
5155
			$registration_response = false;
5156
5157
		$code_type = intval( $code / 100 );
5158
		if ( 5 == $code_type ) {
5159
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5160
		} elseif ( 408 == $code ) {
5161
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5162
		} elseif ( ! empty( $registration_response->error ) ) {
5163
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5164
				$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' );
5165
			} else {
5166
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5167
			}
5168
5169
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5170
		} elseif ( 200 != $code ) {
5171
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5172
		}
5173
5174
		// Jetpack ID error block
5175
		if ( empty( $registration_response->jetpack_id ) ) {
5176
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5177
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5178
			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 );
5179
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5180
			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 );
5181
		}
5182
5183
	    return $registration_response;
5184
	}
5185
	/**
5186
	 * @return bool|WP_Error
5187
	 */
5188
	public static function register() {
5189
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5190
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5191
		$secrets = Jetpack::generate_secrets( 'register' );
5192
5193 View Code Duplication
		if (
5194
			empty( $secrets['secret_1'] ) ||
5195
			empty( $secrets['secret_2'] ) ||
5196
			empty( $secrets['exp'] )
5197
		) {
5198
			return new Jetpack_Error( 'missing_secrets' );
5199
		}
5200
5201
		// better to try (and fail) to set a higher timeout than this system
5202
		// supports than to have register fail for more users than it should
5203
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5204
5205
		$gmt_offset = get_option( 'gmt_offset' );
5206
		if ( ! $gmt_offset ) {
5207
			$gmt_offset = 0;
5208
		}
5209
5210
		$stats_options = get_option( 'stats_options' );
5211
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5212
5213
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5214
5215
		$args = array(
5216
			'method'  => 'POST',
5217
			'body'    => array(
5218
				'siteurl'         => site_url(),
5219
				'home'            => home_url(),
5220
				'gmt_offset'      => $gmt_offset,
5221
				'timezone_string' => (string) get_option( 'timezone_string' ),
5222
				'site_name'       => (string) get_option( 'blogname' ),
5223
				'secret_1'        => $secrets['secret_1'],
5224
				'secret_2'        => $secrets['secret_2'],
5225
				'site_lang'       => get_locale(),
5226
				'timeout'         => $timeout,
5227
				'stats_id'        => $stats_id,
5228
				'state'           => get_current_user_id(),
5229
				'_ui'             => $tracks_identity['_ui'],
5230
				'_ut'             => $tracks_identity['_ut'],
5231
				'jetpack_version' => JETPACK__VERSION
5232
			),
5233
			'headers' => array(
5234
				'Accept' => 'application/json',
5235
			),
5236
			'timeout' => $timeout,
5237
		);
5238
5239
		self::apply_activation_source_to_args( $args['body'] );
5240
5241
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5242
5243
		// Make sure the response is valid and does not contain any Jetpack errors
5244
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5245
		if ( is_wp_error( $registration_details ) ) {
5246
			return $registration_details;
5247
		} elseif ( ! $registration_details ) {
5248
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5249
		}
5250
5251 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5252
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5253
		}
5254
5255
		if ( isset( $registration_details->jetpack_public ) ) {
5256
			$jetpack_public = (int) $registration_details->jetpack_public;
5257
		} else {
5258
			$jetpack_public = false;
5259
		}
5260
5261
		Jetpack_Options::update_options(
5262
			array(
5263
				'id'         => (int)    $registration_details->jetpack_id,
5264
				'blog_token' => (string) $registration_details->jetpack_secret,
5265
				'public'     => $jetpack_public,
5266
			)
5267
		);
5268
5269
		/**
5270
		 * Fires when a site is registered on WordPress.com.
5271
		 *
5272
		 * @since 3.7.0
5273
		 *
5274
		 * @param int $json->jetpack_id Jetpack Blog ID.
5275
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5276
		 * @param int|bool $jetpack_public Is the site public.
5277
		 */
5278
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5279
5280
		// Initialize Jump Start for the first and only time.
5281
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5282
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5283
5284
			$jetpack = Jetpack::init();
5285
5286
			$jetpack->stat( 'jumpstart', 'unique-views' );
5287
			$jetpack->do_stats( 'server_side' );
5288
		};
5289
5290
		return true;
5291
	}
5292
5293
	/**
5294
	 * If the db version is showing something other that what we've got now, bump it to current.
5295
	 *
5296
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
5297
	 */
5298
	public static function maybe_set_version_option() {
5299
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5300
		if ( JETPACK__VERSION != $version ) {
5301
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5302
5303
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5304
				/** This action is documented in class.jetpack.php */
5305
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5306
			}
5307
5308
			return true;
5309
		}
5310
		return false;
5311
	}
5312
5313
/* Client Server API */
5314
5315
	/**
5316
	 * Loads the Jetpack XML-RPC client
5317
	 */
5318
	public static function load_xml_rpc_client() {
5319
		require_once ABSPATH . WPINC . '/class-IXR.php';
5320
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5321
	}
5322
5323
	/**
5324
	 * Resets the saved authentication state in between testing requests.
5325
	 */
5326
	public function reset_saved_auth_state() {
5327
		$this->xmlrpc_verification = null;
5328
		$this->rest_authentication_status = null;
5329
	}
5330
5331
	function verify_xml_rpc_signature() {
5332
		if ( $this->xmlrpc_verification ) {
5333
			return $this->xmlrpc_verification;
5334
		}
5335
5336
		// It's not for us
5337
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5338
			return false;
5339
		}
5340
5341
		@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...
5342
		if (
5343
			empty( $token_key )
5344
		||
5345
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5346
		) {
5347
			return false;
5348
		}
5349
5350
		if ( '0' === $user_id ) {
5351
			$token_type = 'blog';
5352
			$user_id = 0;
5353
		} else {
5354
			$token_type = 'user';
5355
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5356
				return false;
5357
			}
5358
			$user_id = (int) $user_id;
5359
5360
			$user = new WP_User( $user_id );
5361
			if ( ! $user || ! $user->exists() ) {
5362
				return false;
5363
			}
5364
		}
5365
5366
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type integer, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
5367
		if ( ! $token ) {
5368
			return false;
5369
		}
5370
5371
		$token_check = "$token_key.";
5372
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5373
			return false;
5374
		}
5375
5376
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5377
5378
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5379
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5380
			$post_data   = $_POST;
5381
			$file_hashes = array();
5382
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5383
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5384
					continue;
5385
				}
5386
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5387
				$file_hashes[$post_data_key] = $post_data_value;
5388
			}
5389
5390
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5391
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5392
				$post_data[$post_data_key] = $post_data_value;
5393
			}
5394
5395
			ksort( $post_data );
5396
5397
			$body = http_build_query( stripslashes_deep( $post_data ) );
5398
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5399
			$body = file_get_contents( 'php://input' );
5400
		} else {
5401
			$body = null;
5402
		}
5403
5404
		$signature = $jetpack_signature->sign_current_request(
5405
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5406
		);
5407
5408
		if ( ! $signature ) {
5409
			return false;
5410
		} else if ( is_wp_error( $signature ) ) {
5411
			return $signature;
5412
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5413
			return false;
5414
		}
5415
5416
		$timestamp = (int) $_GET['timestamp'];
5417
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5418
5419
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5420
			return false;
5421
		}
5422
5423
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5424
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5425
			if ( ! empty( $_GET['onboarding'] ) ) {
5426
				$jpo = $_GET;
5427
			} else {
5428
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5429
			}
5430
5431
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5432
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5433
5434
			if (
5435
				isset( $jpo_user ) && isset( $jpo_token ) &&
5436
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5437
				isset( $_GET['rest_route'] ) &&
5438
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5439
			) {
5440
				$jpUser = get_user_by( 'email', $jpo_user );
5441
				if ( is_a( $jpUser, 'WP_User' ) ) {
5442
					wp_set_current_user( $jpUser->ID );
5443
					$user_can = is_multisite()
5444
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5445
						: current_user_can( 'manage_options' );
5446
					if ( $user_can ) {
5447
						$token_type = 'user';
5448
						$token->external_user_id = $jpUser->ID;
5449
					}
5450
				}
5451
			}
5452
		}
5453
5454
		$this->xmlrpc_verification = array(
5455
			'type'    => $token_type,
5456
			'user_id' => $token->external_user_id,
5457
		);
5458
5459
		return $this->xmlrpc_verification;
5460
	}
5461
5462
	/**
5463
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5464
	 */
5465
	function authenticate_jetpack( $user, $username, $password ) {
5466
		if ( is_a( $user, 'WP_User' ) ) {
5467
			return $user;
5468
		}
5469
5470
		$token_details = $this->verify_xml_rpc_signature();
5471
5472
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5473
			return $user;
5474
		}
5475
5476
		if ( 'user' !== $token_details['type'] ) {
5477
			return $user;
5478
		}
5479
5480
		if ( ! $token_details['user_id'] ) {
5481
			return $user;
5482
		}
5483
5484
		nocache_headers();
5485
5486
		return new WP_User( $token_details['user_id'] );
5487
	}
5488
5489
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5490
	// Uses the existing XMLRPC request signing implementation.
5491
	function wp_rest_authenticate( $user ) {
5492
		if ( ! empty( $user ) ) {
5493
			// Another authentication method is in effect.
5494
			return $user;
5495
		}
5496
5497
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5498
			// Nothing to do for this authentication method.
5499
			return null;
5500
		}
5501
5502
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5503
			// Nothing to do for this authentication method.
5504
			return null;
5505
		}
5506
5507
		// Ensure that we always have the request body available.  At this
5508
		// point, the WP REST API code to determine the request body has not
5509
		// run yet.  That code may try to read from 'php://input' later, but
5510
		// this can only be done once per request in PHP versions prior to 5.6.
5511
		// So we will go ahead and perform this read now if needed, and save
5512
		// the request body where both the Jetpack signature verification code
5513
		// and the WP REST API code can see it.
5514
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5515
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5516
		}
5517
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5518
5519
		// Only support specific request parameters that have been tested and
5520
		// are known to work with signature verification.  A different method
5521
		// can be passed to the WP REST API via the '?_method=' parameter if
5522
		// needed.
5523
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5524
			$this->rest_authentication_status = new WP_Error(
5525
				'rest_invalid_request',
5526
				__( 'This request method is not supported.', 'jetpack' ),
5527
				array( 'status' => 400 )
5528
			);
5529
			return null;
5530
		}
5531
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5532
			$this->rest_authentication_status = new WP_Error(
5533
				'rest_invalid_request',
5534
				__( 'This request method does not support body parameters.', 'jetpack' ),
5535
				array( 'status' => 400 )
5536
			);
5537
			return null;
5538
		}
5539
5540
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5541
			$content_type = $_SERVER['CONTENT_TYPE'];
5542
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5543
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5544
		}
5545
5546
		if (
5547
			isset( $content_type ) &&
5548
			$content_type !== 'application/x-www-form-urlencoded' &&
5549
			$content_type !== 'application/json'
5550
		) {
5551
			$this->rest_authentication_status = new WP_Error(
5552
				'rest_invalid_request',
5553
				__( 'This Content-Type is not supported.', 'jetpack' ),
5554
				array( 'status' => 400 )
5555
			);
5556
			return null;
5557
		}
5558
5559
		$verified = $this->verify_xml_rpc_signature();
5560
5561
		if ( is_wp_error( $verified ) ) {
5562
			$this->rest_authentication_status = $verified;
5563
			return null;
5564
		}
5565
5566
		if (
5567
			$verified &&
5568
			isset( $verified['type'] ) &&
5569
			'user' === $verified['type'] &&
5570
			! empty( $verified['user_id'] )
5571
		) {
5572
			// Authentication successful.
5573
			$this->rest_authentication_status = true;
5574
			return $verified['user_id'];
5575
		}
5576
5577
		// Something else went wrong.  Probably a signature error.
5578
		$this->rest_authentication_status = new WP_Error(
5579
			'rest_invalid_signature',
5580
			__( 'The request is not signed correctly.', 'jetpack' ),
5581
			array( 'status' => 400 )
5582
		);
5583
		return null;
5584
	}
5585
5586
	/**
5587
	 * Report authentication status to the WP REST API.
5588
	 *
5589
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5590
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5591
	 */
5592
	public function wp_rest_authentication_errors( $value ) {
5593
		if ( $value !== null ) {
5594
			return $value;
5595
		}
5596
		return $this->rest_authentication_status;
5597
	}
5598
5599
	function add_nonce( $timestamp, $nonce ) {
5600
		global $wpdb;
5601
		static $nonces_used_this_request = array();
5602
5603
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5604
			return $nonces_used_this_request["$timestamp:$nonce"];
5605
		}
5606
5607
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5608
		$timestamp = (int) $timestamp;
5609
		$nonce     = esc_sql( $nonce );
5610
5611
		// Raw query so we can avoid races: add_option will also update
5612
		$show_errors = $wpdb->show_errors( false );
5613
5614
		$old_nonce = $wpdb->get_row(
5615
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5616
		);
5617
5618
		if ( is_null( $old_nonce ) ) {
5619
			$return = $wpdb->query(
5620
				$wpdb->prepare(
5621
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5622
					"jetpack_nonce_{$timestamp}_{$nonce}",
5623
					time(),
5624
					'no'
5625
				)
5626
			);
5627
		} else {
5628
			$return = false;
5629
		}
5630
5631
		$wpdb->show_errors( $show_errors );
5632
5633
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5634
5635
		return $return;
5636
	}
5637
5638
	/**
5639
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5640
	 * Capture it here so we can verify the signature later.
5641
	 */
5642
	function xmlrpc_methods( $methods ) {
5643
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5644
		return $methods;
5645
	}
5646
5647
	function public_xmlrpc_methods( $methods ) {
5648
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5649
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5650
		}
5651
		return $methods;
5652
	}
5653
5654
	function jetpack_getOptions( $args ) {
5655
		global $wp_xmlrpc_server;
5656
5657
		$wp_xmlrpc_server->escape( $args );
5658
5659
		$username	= $args[1];
5660
		$password	= $args[2];
5661
5662
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5663
			return $wp_xmlrpc_server->error;
5664
		}
5665
5666
		$options = array();
5667
		$user_data = $this->get_connected_user_data();
5668
		if ( is_array( $user_data ) ) {
5669
			$options['jetpack_user_id'] = array(
5670
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5671
				'readonly'      => true,
5672
				'value'         => $user_data['ID'],
5673
			);
5674
			$options['jetpack_user_login'] = array(
5675
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5676
				'readonly'      => true,
5677
				'value'         => $user_data['login'],
5678
			);
5679
			$options['jetpack_user_email'] = array(
5680
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5681
				'readonly'      => true,
5682
				'value'         => $user_data['email'],
5683
			);
5684
			$options['jetpack_user_site_count'] = array(
5685
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5686
				'readonly'      => true,
5687
				'value'         => $user_data['site_count'],
5688
			);
5689
		}
5690
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5691
		$args = stripslashes_deep( $args );
5692
		return $wp_xmlrpc_server->wp_getOptions( $args );
5693
	}
5694
5695
	function xmlrpc_options( $options ) {
5696
		$jetpack_client_id = false;
5697
		if ( self::is_active() ) {
5698
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5699
		}
5700
		$options['jetpack_version'] = array(
5701
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5702
				'readonly'      => true,
5703
				'value'         => JETPACK__VERSION,
5704
		);
5705
5706
		$options['jetpack_client_id'] = array(
5707
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5708
				'readonly'      => true,
5709
				'value'         => $jetpack_client_id,
5710
		);
5711
		return $options;
5712
	}
5713
5714
	public static function clean_nonces( $all = false ) {
5715
		global $wpdb;
5716
5717
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5718
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5719
5720
		if ( true !== $all ) {
5721
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5722
			$sql_args[] = time() - 3600;
5723
		}
5724
5725
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5726
5727
		$sql = $wpdb->prepare( $sql, $sql_args );
5728
5729
		for ( $i = 0; $i < 1000; $i++ ) {
5730
			if ( ! $wpdb->query( $sql ) ) {
5731
				break;
5732
			}
5733
		}
5734
	}
5735
5736
	/**
5737
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5738
	 * SET: state( $key, $value );
5739
	 * GET: $value = state( $key );
5740
	 *
5741
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5742
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5743
	 * @param bool $restate private
5744
	 */
5745
	public static function state( $key = null, $value = null, $restate = false ) {
5746
		static $state = array();
5747
		static $path, $domain;
5748
		if ( ! isset( $path ) ) {
5749
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5750
			$admin_url = Jetpack::admin_url();
5751
			$bits      = parse_url( $admin_url );
5752
5753
			if ( is_array( $bits ) ) {
5754
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5755
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5756
			} else {
5757
				$path = $domain = null;
5758
			}
5759
		}
5760
5761
		// Extract state from cookies and delete cookies
5762
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5763
			$yum = $_COOKIE[ 'jetpackState' ];
5764
			unset( $_COOKIE[ 'jetpackState' ] );
5765
			foreach ( $yum as $k => $v ) {
5766
				if ( strlen( $v ) )
5767
					$state[ $k ] = $v;
5768
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5769
			}
5770
		}
5771
5772
		if ( $restate ) {
5773
			foreach ( $state as $k => $v ) {
5774
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5775
			}
5776
			return;
5777
		}
5778
5779
		// Get a state variable
5780
		if ( isset( $key ) && ! isset( $value ) ) {
5781
			if ( array_key_exists( $key, $state ) )
5782
				return $state[ $key ];
5783
			return null;
5784
		}
5785
5786
		// Set a state variable
5787
		if ( isset ( $key ) && isset( $value ) ) {
5788
			if( is_array( $value ) && isset( $value[0] ) ) {
5789
				$value = $value[0];
5790
			}
5791
			$state[ $key ] = $value;
5792
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5793
		}
5794
	}
5795
5796
	public static function restate() {
5797
		Jetpack::state( null, null, true );
5798
	}
5799
5800
	public static function check_privacy( $file ) {
5801
		static $is_site_publicly_accessible = null;
5802
5803
		if ( is_null( $is_site_publicly_accessible ) ) {
5804
			$is_site_publicly_accessible = false;
5805
5806
			Jetpack::load_xml_rpc_client();
5807
			$rpc = new Jetpack_IXR_Client();
5808
5809
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5810
			if ( $success ) {
5811
				$response = $rpc->getResponse();
5812
				if ( $response ) {
5813
					$is_site_publicly_accessible = true;
5814
				}
5815
			}
5816
5817
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5818
		}
5819
5820
		if ( $is_site_publicly_accessible ) {
5821
			return;
5822
		}
5823
5824
		$module_slug = self::get_module_slug( $file );
5825
5826
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5827
		if ( ! $privacy_checks ) {
5828
			$privacy_checks = $module_slug;
5829
		} else {
5830
			$privacy_checks .= ",$module_slug";
5831
		}
5832
5833
		Jetpack::state( 'privacy_checks', $privacy_checks );
5834
	}
5835
5836
	/**
5837
	 * Helper method for multicall XMLRPC.
5838
	 */
5839
	public static function xmlrpc_async_call() {
5840
		global $blog_id;
5841
		static $clients = array();
5842
5843
		$client_blog_id = is_multisite() ? $blog_id : 0;
5844
5845
		if ( ! isset( $clients[$client_blog_id] ) ) {
5846
			Jetpack::load_xml_rpc_client();
5847
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5848
			if ( function_exists( 'ignore_user_abort' ) ) {
5849
				ignore_user_abort( true );
5850
			}
5851
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5852
		}
5853
5854
		$args = func_get_args();
5855
5856
		if ( ! empty( $args[0] ) ) {
5857
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5858
		} elseif ( is_multisite() ) {
5859
			foreach ( $clients as $client_blog_id => $client ) {
5860
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5861
					continue;
5862
				}
5863
5864
				$switch_success = switch_to_blog( $client_blog_id, true );
5865
				if ( ! $switch_success ) {
5866
					continue;
5867
				}
5868
5869
				flush();
5870
				$client->query();
5871
5872
				restore_current_blog();
5873
			}
5874
		} else {
5875
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5876
				flush();
5877
				$clients[0]->query();
5878
			}
5879
		}
5880
	}
5881
5882
	public static function staticize_subdomain( $url ) {
5883
5884
		// Extract hostname from URL
5885
		$host = parse_url( $url, PHP_URL_HOST );
5886
5887
		// Explode hostname on '.'
5888
		$exploded_host = explode( '.', $host );
5889
5890
		// Retrieve the name and TLD
5891
		if ( count( $exploded_host ) > 1 ) {
5892
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5893
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5894
			// Rebuild domain excluding subdomains
5895
			$domain = $name . '.' . $tld;
5896
		} else {
5897
			$domain = $host;
5898
		}
5899
		// Array of Automattic domains
5900
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5901
5902
		// Return $url if not an Automattic domain
5903
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5904
			return $url;
5905
		}
5906
5907
		if ( is_ssl() ) {
5908
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5909
		}
5910
5911
		srand( crc32( basename( $url ) ) );
5912
		$static_counter = rand( 0, 2 );
5913
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5914
5915
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5916
	}
5917
5918
/* JSON API Authorization */
5919
5920
	/**
5921
	 * Handles the login action for Authorizing the JSON API
5922
	 */
5923
	function login_form_json_api_authorization() {
5924
		$this->verify_json_api_authorization_request();
5925
5926
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5927
5928
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5929
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5930
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5931
	}
5932
5933
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5934
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5935
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5936
			return $url;
5937
		}
5938
5939
		$parsed_url = parse_url( $url );
5940
		$url = strtok( $url, '?' );
5941
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5942
		if ( ! empty( $parsed_url['query'] ) )
5943
			$url .= "&{$parsed_url['query']}";
5944
5945
		return $url;
5946
	}
5947
5948
	// Make sure the POSTed request is handled by the same action
5949
	function preserve_action_in_login_form_for_json_api_authorization() {
5950
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5951
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5952
	}
5953
5954
	// If someone logs in to approve API access, store the Access Code in usermeta
5955
	function store_json_api_authorization_token( $user_login, $user ) {
5956
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5957
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5958
		$token = wp_generate_password( 32, false );
5959
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5960
	}
5961
5962
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5963
	function allow_wpcom_public_api_domain( $domains ) {
5964
		$domains[] = 'public-api.wordpress.com';
5965
		return $domains;
5966
	}
5967
5968
	// Add all wordpress.com environments to the safe redirect whitelist
5969
	function allow_wpcom_environments( $domains ) {
5970
		$domains[] = 'wordpress.com';
5971
		$domains[] = 'wpcalypso.wordpress.com';
5972
		$domains[] = 'horizon.wordpress.com';
5973
		$domains[] = 'calypso.localhost';
5974
		return $domains;
5975
	}
5976
5977
	// Add the Access Code details to the public-api.wordpress.com redirect
5978
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5979
		return add_query_arg(
5980
			urlencode_deep(
5981
				array(
5982
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5983
					'jetpack-user-id' => (int) $user->ID,
5984
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5985
				)
5986
			),
5987
			$redirect_to
5988
		);
5989
	}
5990
5991
5992
	/**
5993
	 * Verifies the request by checking the signature
5994
	 *
5995
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5996
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5997
	 *
5998
	 * @param null|array $environment
5999
	 */
6000
	function verify_json_api_authorization_request( $environment = null ) {
6001
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6002
6003
		$environment = is_null( $environment )
6004
			? $_REQUEST
6005
			: $environment;
6006
6007
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
6008
		$token = Jetpack_Data::get_access_token( $envUserId );
6009
		if ( ! $token || empty( $token->secret ) ) {
6010
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6011
		}
6012
6013
		$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' );
6014
6015
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6016
6017
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6018
			$signature = $jetpack_signature->sign_request(
6019
				$environment['token'],
6020
				$environment['timestamp'],
6021
				$environment['nonce'],
6022
				'',
6023
				'GET',
6024
				$environment['jetpack_json_api_original_query'],
6025
				null,
6026
				true
6027
			);
6028
		} else {
6029
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6030
		}
6031
6032
		if ( ! $signature ) {
6033
			wp_die( $die_error );
6034
		} else if ( is_wp_error( $signature ) ) {
6035
			wp_die( $die_error );
6036
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
6037
			if ( is_ssl() ) {
6038
				// 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
6039
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6040
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6041
					wp_die( $die_error );
6042
				}
6043
			} else {
6044
				wp_die( $die_error );
6045
			}
6046
		}
6047
6048
		$timestamp = (int) $environment['timestamp'];
6049
		$nonce     = stripslashes( (string) $environment['nonce'] );
6050
6051
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6052
			// De-nonce the nonce, at least for 5 minutes.
6053
			// 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)
6054
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6055
			if ( $old_nonce_time < time() - 300 ) {
6056
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6057
			}
6058
		}
6059
6060
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6061
		$data_filters = array(
6062
			'state'        => 'opaque',
6063
			'client_id'    => 'int',
6064
			'client_title' => 'string',
6065
			'client_image' => 'url',
6066
		);
6067
6068
		foreach ( $data_filters as $key => $sanitation ) {
6069
			if ( ! isset( $data->$key ) ) {
6070
				wp_die( $die_error );
6071
			}
6072
6073
			switch ( $sanitation ) {
6074
			case 'int' :
6075
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6076
				break;
6077
			case 'opaque' :
6078
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6079
				break;
6080
			case 'string' :
6081
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6082
				break;
6083
			case 'url' :
6084
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6085
				break;
6086
			}
6087
		}
6088
6089
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6090
			wp_die( $die_error );
6091
		}
6092
	}
6093
6094
	function login_message_json_api_authorization( $message ) {
6095
		return '<p class="message">' . sprintf(
6096
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6097
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6098
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6099
	}
6100
6101
	/**
6102
	 * Get $content_width, but with a <s>twist</s> filter.
6103
	 */
6104
	public static function get_content_width() {
6105
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6106
		/**
6107
		 * Filter the Content Width value.
6108
		 *
6109
		 * @since 2.2.3
6110
		 *
6111
		 * @param string $content_width Content Width value.
6112
		 */
6113
		return apply_filters( 'jetpack_content_width', $content_width );
6114
	}
6115
6116
	/**
6117
	 * Pings the WordPress.com Mirror Site for the specified options.
6118
	 *
6119
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6120
	 *
6121
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6122
	 */
6123
	public function get_cloud_site_options( $option_names ) {
6124
		$option_names = array_filter( (array) $option_names, 'is_string' );
6125
6126
		Jetpack::load_xml_rpc_client();
6127
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6128
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6129
		if ( $xml->isError() ) {
6130
			return array(
6131
				'error_code' => $xml->getErrorCode(),
6132
				'error_msg'  => $xml->getErrorMessage(),
6133
			);
6134
		}
6135
		$cloud_site_options = $xml->getResponse();
6136
6137
		return $cloud_site_options;
6138
	}
6139
6140
	/**
6141
	 * Checks if the site is currently in an identity crisis.
6142
	 *
6143
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6144
	 */
6145
	public static function check_identity_crisis() {
6146
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6147
			return false;
6148
		}
6149
6150
		return Jetpack_Options::get_option( 'sync_error_idc' );
6151
	}
6152
6153
	/**
6154
	 * Checks whether the home and siteurl specifically are whitelisted
6155
	 * Written so that we don't have re-check $key and $value params every time
6156
	 * we want to check if this site is whitelisted, for example in footer.php
6157
	 *
6158
	 * @since  3.8.0
6159
	 * @return bool True = already whitelisted False = not whitelisted
6160
	 */
6161
	public static function is_staging_site() {
6162
		$is_staging = false;
6163
6164
		$known_staging = array(
6165
			'urls' => array(
6166
				'#\.staging\.wpengine\.com$#i', // WP Engine
6167
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6168
				),
6169
			'constants' => array(
6170
				'IS_WPE_SNAPSHOT',      // WP Engine
6171
				'KINSTA_DEV_ENV',       // Kinsta.com
6172
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6173
				'JETPACK_STAGING_MODE', // Generic
6174
				)
6175
			);
6176
		/**
6177
		 * Filters the flags of known staging sites.
6178
		 *
6179
		 * @since 3.9.0
6180
		 *
6181
		 * @param array $known_staging {
6182
		 *     An array of arrays that each are used to check if the current site is staging.
6183
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6184
		 *     @type array $constants PHP constants of known staging/developement environments.
6185
		 *  }
6186
		 */
6187
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6188
6189
		if ( isset( $known_staging['urls'] ) ) {
6190
			foreach ( $known_staging['urls'] as $url ){
6191
				if ( preg_match( $url, site_url() ) ) {
6192
					$is_staging = true;
6193
					break;
6194
				}
6195
			}
6196
		}
6197
6198
		if ( isset( $known_staging['constants'] ) ) {
6199
			foreach ( $known_staging['constants'] as $constant ) {
6200
				if ( defined( $constant ) && constant( $constant ) ) {
6201
					$is_staging = true;
6202
				}
6203
			}
6204
		}
6205
6206
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6207
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6208
			$is_staging = true;
6209
		}
6210
6211
		/**
6212
		 * Filters is_staging_site check.
6213
		 *
6214
		 * @since 3.9.0
6215
		 *
6216
		 * @param bool $is_staging If the current site is a staging site.
6217
		 */
6218
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6219
	}
6220
6221
	/**
6222
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6223
	 *
6224
	 * @since 4.4.0
6225
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6226
	 *
6227
	 * @return bool
6228
	 */
6229
	public static function validate_sync_error_idc_option() {
6230
		$is_valid = false;
6231
6232
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6233
		if ( false === $idc_allowed ) {
6234
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6235
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6236
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6237
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6238
				$transient_duration = HOUR_IN_SECONDS;
6239
			} else {
6240
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6241
				$idc_allowed = '1';
6242
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6243
			}
6244
6245
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6246
		}
6247
6248
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6249
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6250
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6251
			$local_options = self::get_sync_error_idc_option();
6252
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6253
				$is_valid = true;
6254
			}
6255
		}
6256
6257
		/**
6258
		 * Filters whether the sync_error_idc option is valid.
6259
		 *
6260
		 * @since 4.4.0
6261
		 *
6262
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6263
		 */
6264
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6265
6266
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6267
			// Since the option exists, and did not validate, delete it
6268
			Jetpack_Options::delete_option( 'sync_error_idc' );
6269
		}
6270
6271
		return $is_valid;
6272
	}
6273
6274
	/**
6275
	 * Normalizes a url by doing three things:
6276
	 *  - Strips protocol
6277
	 *  - Strips www
6278
	 *  - Adds a trailing slash
6279
	 *
6280
	 * @since 4.4.0
6281
	 * @param string $url
6282
	 * @return WP_Error|string
6283
	 */
6284
	public static function normalize_url_protocol_agnostic( $url ) {
6285
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6286
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6287
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6288
		}
6289
6290
		// Strip www and protocols
6291
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6292
		return $url;
6293
	}
6294
6295
	/**
6296
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6297
	 *
6298
	 * @since 4.4.0
6299
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6300
	 *
6301
	 * @param array $response
6302
	 * @return array Array of the local urls, wpcom urls, and error code
6303
	 */
6304
	public static function get_sync_error_idc_option( $response = array() ) {
6305
		// Since the local options will hit the database directly, store the values
6306
		// in a transient to allow for autoloading and caching on subsequent views.
6307
		$local_options = get_transient( 'jetpack_idc_local' );
6308
		if ( false === $local_options ) {
6309
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6310
			$local_options = array(
6311
				'home'    => Jetpack_Sync_Functions::home_url(),
6312
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6313
			);
6314
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6315
		}
6316
6317
		$options = array_merge( $local_options, $response );
6318
6319
		$returned_values = array();
6320
		foreach( $options as $key => $option ) {
6321
			if ( 'error_code' === $key ) {
6322
				$returned_values[ $key ] = $option;
6323
				continue;
6324
			}
6325
6326
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6327
				continue;
6328
			}
6329
6330
			$returned_values[ $key ] = $normalized_url;
6331
		}
6332
6333
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6334
6335
		return $returned_values;
6336
	}
6337
6338
	/**
6339
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6340
	 * If set to true, the site will be put into staging mode.
6341
	 *
6342
	 * @since 4.3.2
6343
	 * @return bool
6344
	 */
6345
	public static function sync_idc_optin() {
6346
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6347
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6348
		} else {
6349
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6350
		}
6351
6352
		/**
6353
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6354
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6355
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6356
		 *
6357
		 * @since 4.3.2
6358
		 *
6359
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6360
		 */
6361
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6362
	}
6363
6364
	/**
6365
	 * Maybe Use a .min.css stylesheet, maybe not.
6366
	 *
6367
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6368
	 */
6369
	public static function maybe_min_asset( $url, $path, $plugin ) {
6370
		// Short out on things trying to find actual paths.
6371
		if ( ! $path || empty( $plugin ) ) {
6372
			return $url;
6373
		}
6374
6375
		$path = ltrim( $path, '/' );
6376
6377
		// Strip out the abspath.
6378
		$base = dirname( plugin_basename( $plugin ) );
6379
6380
		// Short out on non-Jetpack assets.
6381
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6382
			return $url;
6383
		}
6384
6385
		// File name parsing.
6386
		$file              = "{$base}/{$path}";
6387
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6388
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6389
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6390
		$extension         = array_shift( $file_name_parts_r );
6391
6392
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6393
			// Already pointing at the minified version.
6394
			if ( 'min' === $file_name_parts_r[0] ) {
6395
				return $url;
6396
			}
6397
6398
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6399
			if ( file_exists( $min_full_path ) ) {
6400
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6401
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6402
				if ( 'css' === $extension ) {
6403
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6404
					self::$min_assets[ $key ] = $path;
6405
				}
6406
			}
6407
		}
6408
6409
		return $url;
6410
	}
6411
6412
	/**
6413
	 * If the asset is minified, let's flag .min as the suffix.
6414
	 *
6415
	 * Attached to `style_loader_src` filter.
6416
	 *
6417
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6418
	 * @param string $handle The registered handle of the script in question.
6419
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6420
	 */
6421
	public static function set_suffix_on_min( $src, $handle ) {
6422
		if ( false === strpos( $src, '.min.css' ) ) {
6423
			return $src;
6424
		}
6425
6426
		if ( ! empty( self::$min_assets ) ) {
6427
			foreach ( self::$min_assets as $file => $path ) {
6428
				if ( false !== strpos( $src, $file ) ) {
6429
					wp_style_add_data( $handle, 'suffix', '.min' );
6430
					return $src;
6431
				}
6432
			}
6433
		}
6434
6435
		return $src;
6436
	}
6437
6438
	/**
6439
	 * Maybe inlines a stylesheet.
6440
	 *
6441
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6442
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6443
	 *
6444
	 * Attached to `style_loader_tag` filter.
6445
	 *
6446
	 * @param string $tag The tag that would link to the external asset.
6447
	 * @param string $handle The registered handle of the script in question.
6448
	 *
6449
	 * @return string
6450
	 */
6451
	public static function maybe_inline_style( $tag, $handle ) {
6452
		global $wp_styles;
6453
		$item = $wp_styles->registered[ $handle ];
6454
6455
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6456
			return $tag;
6457
		}
6458
6459
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6460
			$href = $matches[1];
6461
			// Strip off query string
6462
			if ( $pos = strpos( $href, '?' ) ) {
6463
				$href = substr( $href, 0, $pos );
6464
			}
6465
			// Strip off fragment
6466
			if ( $pos = strpos( $href, '#' ) ) {
6467
				$href = substr( $href, 0, $pos );
6468
			}
6469
		} else {
6470
			return $tag;
6471
		}
6472
6473
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6474
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6475
			return $tag;
6476
		}
6477
6478
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6479
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6480
			// And this isn't the pass that actually deals with the RTL version...
6481
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6482
				// Short out, as the RTL version will deal with it in a moment.
6483
				return $tag;
6484
			}
6485
		}
6486
6487
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6488
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6489
		if ( $css ) {
6490
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6491
			if ( empty( $item->extra['after'] ) ) {
6492
				wp_add_inline_style( $handle, $css );
6493
			} else {
6494
				array_unshift( $item->extra['after'], $css );
6495
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6496
			}
6497
		}
6498
6499
		return $tag;
6500
	}
6501
6502
	/**
6503
	 * Loads a view file from the views
6504
	 *
6505
	 * Data passed in with the $data parameter will be available in the
6506
	 * template file as $data['value']
6507
	 *
6508
	 * @param string $template - Template file to load
6509
	 * @param array $data - Any data to pass along to the template
6510
	 * @return boolean - If template file was found
6511
	 **/
6512
	public function load_view( $template, $data = array() ) {
6513
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6514
6515
		if( file_exists( $views_dir . $template ) ) {
6516
			require_once( $views_dir . $template );
6517
			return true;
6518
		}
6519
6520
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6521
		return false;
6522
	}
6523
6524
	/**
6525
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6526
	 */
6527
	public function deprecated_hooks() {
6528
		global $wp_filter;
6529
6530
		/*
6531
		 * Format:
6532
		 * deprecated_filter_name => replacement_name
6533
		 *
6534
		 * If there is no replacement, use null for replacement_name
6535
		 */
6536
		$deprecated_list = array(
6537
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6538
			'wpl_sharing_2014_1'                                     => null,
6539
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6540
			'jetpack_identity_crisis_options_to_check'               => null,
6541
			'update_option_jetpack_single_user_site'                 => null,
6542
			'audio_player_default_colors'                            => null,
6543
			'add_option_jetpack_featured_images_enabled'             => null,
6544
			'add_option_jetpack_update_details'                      => null,
6545
			'add_option_jetpack_updates'                             => null,
6546
			'add_option_jetpack_network_name'                        => null,
6547
			'add_option_jetpack_network_allow_new_registrations'     => null,
6548
			'add_option_jetpack_network_add_new_users'               => null,
6549
			'add_option_jetpack_network_site_upload_space'           => null,
6550
			'add_option_jetpack_network_upload_file_types'           => null,
6551
			'add_option_jetpack_network_enable_administration_menus' => null,
6552
			'add_option_jetpack_is_multi_site'                       => null,
6553
			'add_option_jetpack_is_main_network'                     => null,
6554
			'add_option_jetpack_main_network_site'                   => null,
6555
			'jetpack_sync_all_registered_options'                    => null,
6556
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6557
			'jetpack_is_post_mailable'                               => null,
6558
			'jetpack_seo_site_host'                                  => null,
6559
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6560
			'jetpack_holiday_snow_option_name'                       => null,
6561
			'jetpack_holiday_chance_of_snow'                         => null,
6562
			'jetpack_holiday_snow_js_url'                            => null,
6563
			'jetpack_is_holiday_snow_season'                         => null,
6564
			'jetpack_holiday_snow_option_updated'                    => null,
6565
			'jetpack_holiday_snowing'                                => null,
6566
		);
6567
6568
		// This is a silly loop depth. Better way?
6569
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6570
			if ( has_action( $hook ) ) {
6571
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6572
					foreach( $values AS $hooked ) {
6573
						if ( is_callable( $hooked['function'] ) ) {
6574
							$function_name = 'an anonymous function';
6575
						} else {
6576
							$function_name = $hooked['function'];
6577
						}
6578
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6579
					}
6580
				}
6581
			}
6582
		}
6583
	}
6584
6585
	/**
6586
	 * Converts any url in a stylesheet, to the correct absolute url.
6587
	 *
6588
	 * Considerations:
6589
	 *  - Normal, relative URLs     `feh.png`
6590
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6591
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6592
	 *  - Absolute URLs             `http://domain.com/feh.png`
6593
	 *  - Domain root relative URLs `/feh.png`
6594
	 *
6595
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6596
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6597
	 *
6598
	 * @return mixed|string
6599
	 */
6600
	public static function absolutize_css_urls( $css, $css_file_url ) {
6601
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6602
		$css_dir = dirname( $css_file_url );
6603
		$p       = parse_url( $css_dir );
6604
		$domain  = sprintf(
6605
					'%1$s//%2$s%3$s%4$s',
6606
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6607
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6608
					$p['host'],
6609
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6610
				);
6611
6612
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6613
			$find = $replace = array();
6614
			foreach ( $matches as $match ) {
6615
				$url = trim( $match['path'], "'\" \t" );
6616
6617
				// If this is a data url, we don't want to mess with it.
6618
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6619
					continue;
6620
				}
6621
6622
				// If this is an absolute or protocol-agnostic url,
6623
				// we don't want to mess with it.
6624
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6625
					continue;
6626
				}
6627
6628
				switch ( substr( $url, 0, 1 ) ) {
6629
					case '/':
6630
						$absolute = $domain . $url;
6631
						break;
6632
					default:
6633
						$absolute = $css_dir . '/' . $url;
6634
				}
6635
6636
				$find[]    = $match[0];
6637
				$replace[] = sprintf( 'url("%s")', $absolute );
6638
			}
6639
			$css = str_replace( $find, $replace, $css );
6640
		}
6641
6642
		return $css;
6643
	}
6644
6645
	/**
6646
	 * This methods removes all of the registered css files on the front end
6647
	 * from Jetpack in favor of using a single file. In effect "imploding"
6648
	 * all the files into one file.
6649
	 *
6650
	 * Pros:
6651
	 * - Uses only ONE css asset connection instead of 15
6652
	 * - Saves a minimum of 56k
6653
	 * - Reduces server load
6654
	 * - Reduces time to first painted byte
6655
	 *
6656
	 * Cons:
6657
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6658
	 *		should not cause any issues with themes.
6659
	 * - Plugins/themes dequeuing styles no longer do anything. See
6660
	 *		jetpack_implode_frontend_css filter for a workaround
6661
	 *
6662
	 * For some situations developers may wish to disable css imploding and
6663
	 * instead operate in legacy mode where each file loads seperately and
6664
	 * can be edited individually or dequeued. This can be accomplished with
6665
	 * the following line:
6666
	 *
6667
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6668
	 *
6669
	 * @since 3.2
6670
	 **/
6671
	public function implode_frontend_css( $travis_test = false ) {
6672
		$do_implode = true;
6673
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6674
			$do_implode = false;
6675
		}
6676
6677
		/**
6678
		 * Allow CSS to be concatenated into a single jetpack.css file.
6679
		 *
6680
		 * @since 3.2.0
6681
		 *
6682
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6683
		 */
6684
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6685
6686
		// Do not use the imploded file when default behaviour was altered through the filter
6687
		if ( ! $do_implode ) {
6688
			return;
6689
		}
6690
6691
		// We do not want to use the imploded file in dev mode, or if not connected
6692
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6693
			if ( ! $travis_test ) {
6694
				return;
6695
			}
6696
		}
6697
6698
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6699
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6700
			return;
6701
		}
6702
6703
		/*
6704
		 * Now we assume Jetpack is connected and able to serve the single
6705
		 * file.
6706
		 *
6707
		 * In the future there will be a check here to serve the file locally
6708
		 * or potentially from the Jetpack CDN
6709
		 *
6710
		 * For now:
6711
		 * - Enqueue a single imploded css file
6712
		 * - Zero out the style_loader_tag for the bundled ones
6713
		 * - Be happy, drink scotch
6714
		 */
6715
6716
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6717
6718
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6719
6720
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6721
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6722
	}
6723
6724
	function concat_remove_style_loader_tag( $tag, $handle ) {
6725
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6726
			$tag = '';
6727
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6728
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6729
			}
6730
		}
6731
6732
		return $tag;
6733
	}
6734
6735
	/*
6736
	 * Check the heartbeat data
6737
	 *
6738
	 * Organizes the heartbeat data by severity.  For example, if the site
6739
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6740
	 *
6741
	 * Data will be added to "caution" array, if it either:
6742
	 *  - Out of date Jetpack version
6743
	 *  - Out of date WP version
6744
	 *  - Out of date PHP version
6745
	 *
6746
	 * $return array $filtered_data
6747
	 */
6748
	public static function jetpack_check_heartbeat_data() {
6749
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6750
6751
		$good    = array();
6752
		$caution = array();
6753
		$bad     = array();
6754
6755
		foreach ( $raw_data as $stat => $value ) {
6756
6757
			// Check jetpack version
6758
			if ( 'version' == $stat ) {
6759
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6760
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6761
					continue;
6762
				}
6763
			}
6764
6765
			// Check WP version
6766
			if ( 'wp-version' == $stat ) {
6767
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6768
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6769
					continue;
6770
				}
6771
			}
6772
6773
			// Check PHP version
6774
			if ( 'php-version' == $stat ) {
6775
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6776
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6777
					continue;
6778
				}
6779
			}
6780
6781
			// Check ID crisis
6782
			if ( 'identitycrisis' == $stat ) {
6783
				if ( 'yes' == $value ) {
6784
					$bad[ $stat ] = $value;
6785
					continue;
6786
				}
6787
			}
6788
6789
			// The rest are good :)
6790
			$good[ $stat ] = $value;
6791
		}
6792
6793
		$filtered_data = array(
6794
			'good'    => $good,
6795
			'caution' => $caution,
6796
			'bad'     => $bad
6797
		);
6798
6799
		return $filtered_data;
6800
	}
6801
6802
6803
	/*
6804
	 * This method is used to organize all options that can be reset
6805
	 * without disconnecting Jetpack.
6806
	 *
6807
	 * It is used in class.jetpack-cli.php to reset options
6808
	 *
6809
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6810
	 *
6811
	 * @return array of options to delete.
6812
	 */
6813
	public static function get_jetpack_options_for_reset() {
6814
		return Jetpack_Options::get_options_for_reset();
6815
	}
6816
6817
	/**
6818
	 * Check if an option of a Jetpack module has been updated.
6819
	 *
6820
	 * If any module option has been updated before Jump Start has been dismissed,
6821
	 * update the 'jumpstart' option so we can hide Jump Start.
6822
	 *
6823
	 * @param string $option_name
6824
	 *
6825
	 * @return bool
6826
	 */
6827
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6828
		// Bail if Jump Start has already been dismissed
6829
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6830
			return false;
6831
		}
6832
6833
		$jetpack = Jetpack::init();
6834
6835
		// Manual build of module options
6836
		$option_names = self::get_jetpack_options_for_reset();
6837
6838
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6839
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6840
6841
			//Jump start is being dismissed send data to MC Stats
6842
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6843
6844
			$jetpack->do_stats( 'server_side' );
6845
		}
6846
6847
	}
6848
6849
	/*
6850
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6851
	 * so we can bring them directly to their site in calypso.
6852
	 *
6853
	 * @param string | url
6854
	 * @return string | url without the guff
6855
	 */
6856
	public static function build_raw_urls( $url ) {
6857
		$strip_http = '/.*?:\/\//i';
6858
		$url = preg_replace( $strip_http, '', $url  );
6859
		$url = str_replace( '/', '::', $url );
6860
		return $url;
6861
	}
6862
6863
	/**
6864
	 * Stores and prints out domains to prefetch for page speed optimization.
6865
	 *
6866
	 * @param mixed $new_urls
6867
	 */
6868
	public static function dns_prefetch( $new_urls = null ) {
6869
		static $prefetch_urls = array();
6870
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6871
			echo "\r\n";
6872
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6873
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6874
			}
6875
		} elseif ( ! empty( $new_urls ) ) {
6876
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6877
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6878
			}
6879
			foreach ( (array) $new_urls as $this_new_url ) {
6880
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6881
			}
6882
			$prefetch_urls = array_unique( $prefetch_urls );
6883
		}
6884
	}
6885
6886
	public function wp_dashboard_setup() {
6887
		if ( self::is_active() ) {
6888
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6889
		}
6890
6891
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6892
			wp_add_dashboard_widget(
6893
				'jetpack_summary_widget',
6894
				esc_html__( 'Site Stats', 'jetpack' ),
6895
				array( __CLASS__, 'dashboard_widget' )
6896
			);
6897
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6898
6899
			// If we're inactive and not in development mode, sort our box to the top.
6900
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6901
				global $wp_meta_boxes;
6902
6903
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6904
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6905
6906
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6907
			}
6908
		}
6909
	}
6910
6911
	/**
6912
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6913
	 * @return mixed
6914
	 */
6915
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6916
		if ( ! is_array( $sorted ) ) {
6917
			return $sorted;
6918
		}
6919
6920
		foreach ( $sorted as $box_context => $ids ) {
6921
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6922
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6923
				continue;
6924
			}
6925
6926
			$ids_array = explode( ',', $ids );
6927
			$key = array_search( 'dashboard_stats', $ids_array );
6928
6929
			if ( false !== $key ) {
6930
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6931
				$ids_array[ $key ] = 'jetpack_summary_widget';
6932
				$sorted[ $box_context ] = implode( ',', $ids_array );
6933
				// We've found it, stop searching, and just return.
6934
				break;
6935
			}
6936
		}
6937
6938
		return $sorted;
6939
	}
6940
6941
	public static function dashboard_widget() {
6942
		/**
6943
		 * Fires when the dashboard is loaded.
6944
		 *
6945
		 * @since 3.4.0
6946
		 */
6947
		do_action( 'jetpack_dashboard_widget' );
6948
	}
6949
6950
	public static function dashboard_widget_footer() {
6951
		?>
6952
		<footer>
6953
6954
		<div class="protect">
6955
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6956
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6957
				<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>
6958
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6959
				<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' ); ?>">
6960
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6961
				</a>
6962
			<?php else : ?>
6963
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6964
			<?php endif; ?>
6965
		</div>
6966
6967
		<div class="akismet">
6968
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6969
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6970
				<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>
6971
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6972
				<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">
6973
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6974
				</a>
6975
			<?php else : ?>
6976
				<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>
6977
			<?php endif; ?>
6978
		</div>
6979
6980
		</footer>
6981
		<?php
6982
	}
6983
6984
	/**
6985
	 * Return string containing the Jetpack logo.
6986
	 *
6987
	 * @since 3.9.0
6988
	 *
6989
	 * @return string
6990
	 */
6991
	public static function get_jp_emblem() {
6992
		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>';
6993
	}
6994
6995
	/*
6996
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6997
	 */
6998
	function jetpack_icon_user_connected( $columns ) {
6999
		$columns['user_jetpack'] = '';
7000
		return $columns;
7001
	}
7002
7003
	/*
7004
	 * Show Jetpack icon if the user is linked.
7005
	 */
7006
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7007
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7008
			$emblem_html = sprintf(
7009
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7010
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7011
				Jetpack::get_jp_emblem()
7012
			);
7013
			return $emblem_html;
7014
		}
7015
7016
		return $val;
7017
	}
7018
7019
	/*
7020
	 * Style the Jetpack user column
7021
	 */
7022
	function jetpack_user_col_style() {
7023
		global $current_screen;
7024
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7025
			<style>
7026
				.fixed .column-user_jetpack {
7027
					width: 21px;
7028
				}
7029
				.jp-emblem-user-admin svg {
7030
					width: 20px;
7031
					height: 20px;
7032
				}
7033
				.jp-emblem-user-admin path {
7034
					fill: #00BE28;
7035
				}
7036
			</style>
7037
		<?php }
7038
	}
7039
7040
	/**
7041
	 * Checks if Akismet is active and working.
7042
	 *
7043
	 * @since  5.1.0
7044
	 * @return bool True = Akismet available. False = Aksimet not available.
7045
	 */
7046
	public static function is_akismet_active() {
7047
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
7048
			return true;
7049
		}
7050
		return false;
7051
	}
7052
7053
	/**
7054
	 * Checks if one or more function names is in debug_backtrace
7055
	 *
7056
	 * @param $names Mixed string name of function or array of string names of functions
7057
	 *
7058
	 * @return bool
7059
	 */
7060
	public static function is_function_in_backtrace( $names ) {
7061
		$backtrace = debug_backtrace( false );
7062
		if ( ! is_array( $names ) ) {
7063
			$names = array( $names );
7064
		}
7065
		$names_as_keys = array_flip( $names );
7066
7067
		//Do check in constant O(1) time for PHP5.5+
7068
		if ( function_exists( 'array_column' ) ) {
7069
			$backtrace_functions = array_column( $backtrace, 'function' );
7070
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7071
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7072
			return ! empty ( $intersection );
7073
		}
7074
7075
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7076
		foreach ( $backtrace as $call ) {
7077
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7078
				return true;
7079
			}
7080
		}
7081
		return false;
7082
	}
7083
7084
	/**
7085
	 * Given a minified path, and a non-minified path, will return
7086
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7087
	 *
7088
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7089
	 * root Jetpack directory.
7090
	 *
7091
	 * @since 5.6.0
7092
	 *
7093
	 * @param string $min_path
7094
	 * @param string $non_min_path
7095
	 * @return string The URL to the file
7096
	 */
7097
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7098
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7099
			? $non_min_path
7100
			: $min_path;
7101
7102
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7103
	}
7104
7105
	/**
7106
	 * Checks for whether Jetpack Rewind is enabled.
7107
	 * Will return true if the state of Rewind is anything except "unavailable".
7108
	 * @return bool|int|mixed
7109
	 */
7110
	public static function is_rewind_enabled() {
7111
		if ( ! Jetpack::is_active() ) {
7112
			return false;
7113
		}
7114
7115
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7116
		if ( false === $rewind_enabled ) {
7117
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7118
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7119
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7120
				&& ! empty( $rewind_data['state'] )
7121
				&& 'active' === $rewind_data['state'] )
7122
				? 1
7123
				: 0;
7124
7125
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7126
		}
7127
		return $rewind_enabled;
7128
	}
7129
7130
	/**
7131
	 * Checks whether or not TOS has been agreed upon.
7132
	 * Will return true if a user has clicked to register, or is already connected.
7133
	 */
7134
	public static function jetpack_tos_agreed() {
7135
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7136
	}
7137
}
7138