Completed
Push — fix/jetpack-client-authorized-... ( 61ec70 )
by
unknown
76:33 queued 67:54
created

Jetpack::__construct()   F

Complexity

Conditions 20
Paths 384

Size

Total Lines 164
Code Lines 76

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 20
eloc 76
nc 384
nop 0
dl 0
loc 164
rs 3.6338
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

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

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

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
667
668
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
669
	}
670
671
	function jetpack_track_last_sync_callback( $params ) {
672
		if ( is_array( $params ) && isset( $params[0] ) ) {
673
			$option = $params[0];
674
			if ( 'active_plugins' === $option ) {
675
				// use the cache if we can, but not terribly important if it gets evicted
676
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
677
			}
678
		}
679
680
		return $params;
681
	}
682
683
	function jetpack_connection_banner_callback() {
684
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
685
686
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
687
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
688
			wp_send_json_success();
689
		}
690
		
691
		wp_die();
692
	}
693
	
694
	function jetpack_admin_ajax_tracks_callback() {
695
		// Check for nonce
696
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
697
			wp_die( 'Permissions check failed.' );
698
		}
699
700
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
701
			wp_die( 'No valid event name or type.' );
702
		}
703
704
		$tracks_data = array();
705
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
706
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
707
		}
708
709
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
710
		wp_send_json_success();
711
		wp_die();
712
	}
713
714
	/**
715
	 * The callback for the JITM ajax requests.
716
	 */
717
	function jetpack_jitm_ajax_callback() {
718
		// Check for nonce
719
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
720
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
721
		}
722
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
723
			$module_slug = $_REQUEST['jitmModule'];
724
			Jetpack::log( 'activate', $module_slug );
725
			Jetpack::activate_module( $module_slug, false, false );
726
			Jetpack::state( 'message', 'no_message' );
727
728
			//A Jetpack module is being activated through a JITM, track it
729
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
730
			$this->do_stats( 'server_side' );
731
732
			wp_send_json_success();
733
		}
734
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
735
			// get the hide_jitm options array
736
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
737
			$module_slug = $_REQUEST['jitmModule'];
738
739
			if( ! $jetpack_hide_jitm ) {
740
				$jetpack_hide_jitm = array(
741
					$module_slug => 'hide'
742
				);
743
			} else {
744
				$jetpack_hide_jitm[$module_slug] = 'hide';
745
			}
746
747
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
748
749
			//jitm is being dismissed forever, track it
750
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
751
			$this->do_stats( 'server_side' );
752
753
			wp_send_json_success();
754
		}
755 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
756
			$module_slug = $_REQUEST['jitmModule'];
757
758
			// User went to WordPress.com, track this
759
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
760
			$this->do_stats( 'server_side' );
761
762
			wp_send_json_success();
763
		}
764 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
765
			$track = $_REQUEST['jitmModule'];
766
767
			// User is viewing JITM, track it.
768
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
769
			$this->do_stats( 'server_side' );
770
771
			wp_send_json_success();
772
		}
773
	}
774
775
	/**
776
	 * If there are any stats that need to be pushed, but haven't been, push them now.
777
	 */
778
	function __destruct() {
779
		if ( ! empty( $this->stats ) ) {
780
			$this->do_stats( 'server_side' );
781
		}
782
	}
783
784
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
785
		switch( $cap ) {
786
			case 'jetpack_connect' :
787
			case 'jetpack_reconnect' :
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
788
				if ( Jetpack::is_development_mode() ) {
789
					$caps = array( 'do_not_allow' );
790
					break;
791
				}
792
				/**
793
				 * Pass through. If it's not development mode, these should match disconnect.
794
				 * Let users disconnect if it's development mode, just in case things glitch.
795
				 */
796
			case 'jetpack_disconnect' :
797
				/**
798
				 * In multisite, can individual site admins manage their own connection?
799
				 *
800
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
801
				 */
802
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
803
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
804
						/**
805
						 * We need to update the option name -- it's terribly unclear which
806
						 * direction the override goes.
807
						 *
808
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

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

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

Loading history...
809
						 */
810
						$caps = array( 'do_not_allow' );
811
						break;
812
					}
813
				}
814
815
				$caps = array( 'manage_options' );
816
				break;
817
			case 'jetpack_manage_modules' :
818
			case 'jetpack_activate_modules' :
819
			case 'jetpack_deactivate_modules' :
820
				$caps = array( 'manage_options' );
821
				break;
822
			case 'jetpack_configure_modules' :
823
				$caps = array( 'manage_options' );
824
				break;
825
			case 'jetpack_network_admin_page':
826
			case 'jetpack_network_settings_page':
827
				$caps = array( 'manage_network_plugins' );
828
				break;
829
			case 'jetpack_network_sites_page':
830
				$caps = array( 'manage_sites' );
831
				break;
832
			case 'jetpack_admin_page' :
833
				if ( Jetpack::is_development_mode() ) {
834
					$caps = array( 'manage_options' );
835
					break;
836
				} else {
837
					$caps = array( 'read' );
838
				}
839
				break;
840
			case 'jetpack_connect_user' :
841
				if ( Jetpack::is_development_mode() ) {
842
					$caps = array( 'do_not_allow' );
843
					break;
844
				}
845
				$caps = array( 'read' );
846
				break;
847
		}
848
		return $caps;
849
	}
850
851
	function require_jetpack_authentication() {
852
		// Don't let anyone authenticate
853
		$_COOKIE = array();
854
		remove_all_filters( 'authenticate' );
855
		remove_all_actions( 'wp_login_failed' );
856
857
		if ( Jetpack::is_active() ) {
858
			// Allow Jetpack authentication
859
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
860
		}
861
	}
862
863
	/**
864
	 * Load language files
865
	 * @action plugins_loaded
866
	 */
867
	public static function plugin_textdomain() {
868
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
869
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
870
	}
871
872
	/**
873
	 * Register assets for use in various modules and the Jetpack admin page.
874
	 *
875
	 * @uses wp_script_is, wp_register_script, plugins_url
876
	 * @action wp_loaded
877
	 * @return null
878
	 */
879
	public function register_assets() {
880 View Code Duplication
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
881
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
882
		}
883
884 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
885
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
886
		}
887
888 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
889
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
890
		}
891
892 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
893
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
894
		}
895
896
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
897
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
898
899
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
900
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
901
			if ( ! is_numeric( $fb_app_id ) ) {
902
				$fb_app_id = '';
903
			}
904
			wp_localize_script(
905
				'jetpack-facebook-embed',
906
				'jpfbembed',
907
				array(
908
					'appid' => $fb_app_id,
909
					'locale' => $this->get_locale(),
910
				)
911
			);
912
		}
913
914
		/**
915
		 * As jetpack_register_genericons is by default fired off a hook,
916
		 * the hook may have already fired by this point.
917
		 * So, let's just trigger it manually.
918
		 */
919
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
920
		jetpack_register_genericons();
921
922
		/**
923
		 * Register the social logos
924
		 */
925
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
926
		jetpack_register_social_logos();
927
928 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
929
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
930
	}
931
932
	/**
933
	 * Guess locale from language code.
934
	 *
935
	 * @param string $lang Language code.
936
	 * @return string|bool
937
	 */
938
	function guess_locale_from_lang( $lang ) {
939
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
940
			return 'en_US';
941
		}
942
943 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
944
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
945
				return false;
946
			}
947
948
			require JETPACK__GLOTPRESS_LOCALES_PATH;
949
		}
950
951
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
952
			// WP.com: get_locale() returns 'it'
953
			$locale = GP_Locales::by_slug( $lang );
954
		} else {
955
			// Jetpack: get_locale() returns 'it_IT';
956
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
957
		}
958
959
		if ( ! $locale ) {
960
			return false;
961
		}
962
963
		if ( empty( $locale->facebook_locale ) ) {
964
			if ( empty( $locale->wp_locale ) ) {
965
				return false;
966
			} else {
967
				// Facebook SDK is smart enough to fall back to en_US if a
968
				// locale isn't supported. Since supported Facebook locales
969
				// can fall out of sync, we'll attempt to use the known
970
				// wp_locale value and rely on said fallback.
971
				return $locale->wp_locale;
972
			}
973
		}
974
975
		return $locale->facebook_locale;
976
	}
977
978
	/**
979
	 * Get the locale.
980
	 *
981
	 * @return string|bool
982
	 */
983
	function get_locale() {
984
		$locale = $this->guess_locale_from_lang( get_locale() );
985
986
		if ( ! $locale ) {
987
			$locale = 'en_US';
988
		}
989
990
		return $locale;
991
	}
992
993
	/**
994
	 * Device Pixels support
995
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
996
	 */
997
	function devicepx() {
998
		if ( Jetpack::is_active() ) {
999
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1000
		}
1001
	}
1002
1003
	/**
1004
	 * Return the network_site_url so that .com knows what network this site is a part of.
1005
	 * @param  bool $option
1006
	 * @return string
1007
	 */
1008
	public function jetpack_main_network_site_option( $option ) {
1009
		return network_site_url();
1010
	}
1011
	/**
1012
	 * Network Name.
1013
	 */
1014
	static function network_name( $option = null ) {
1015
		global $current_site;
1016
		return $current_site->site_name;
1017
	}
1018
	/**
1019
	 * Does the network allow new user and site registrations.
1020
	 * @return string
1021
	 */
1022
	static function network_allow_new_registrations( $option = null ) {
1023
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1024
	}
1025
	/**
1026
	 * Does the network allow admins to add new users.
1027
	 * @return boolian
1028
	 */
1029
	static function network_add_new_users( $option = null ) {
1030
		return (bool) get_site_option( 'add_new_users' );
1031
	}
1032
	/**
1033
	 * File upload psace left per site in MB.
1034
	 *  -1 means NO LIMIT.
1035
	 * @return number
1036
	 */
1037
	static function network_site_upload_space( $option = null ) {
1038
		// value in MB
1039
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1040
	}
1041
1042
	/**
1043
	 * Network allowed file types.
1044
	 * @return string
1045
	 */
1046
	static function network_upload_file_types( $option = null ) {
1047
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1048
	}
1049
1050
	/**
1051
	 * Maximum file upload size set by the network.
1052
	 * @return number
1053
	 */
1054
	static function network_max_upload_file_size( $option = null ) {
1055
		// value in KB
1056
		return get_site_option( 'fileupload_maxk', 300 );
1057
	}
1058
1059
	/**
1060
	 * Lets us know if a site allows admins to manage the network.
1061
	 * @return array
1062
	 */
1063
	static function network_enable_administration_menus( $option = null ) {
1064
		return get_site_option( 'menu_items' );
1065
	}
1066
1067
	/**
1068
	 * If a user has been promoted to or demoted from admin, we need to clear the
1069
	 * jetpack_other_linked_admins transient.
1070
	 *
1071
	 * @since 4.3.2
1072
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1073
	 *
1074
	 * @param int    $user_id   The user ID whose role changed.
1075
	 * @param string $role      The new role.
1076
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

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

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

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

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

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

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

Loading history...
1756
	 */
1757
	public static function get_active_plugins() {
1758
		$active_plugins = (array) get_option( 'active_plugins', array() );
1759
1760
		if ( is_multisite() ) {
1761
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1762
			// whereas active_plugins stores them in the values.
1763
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1764
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1765
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1766
			}
1767
		}
1768
1769
		sort( $active_plugins );
1770
1771
		return array_unique( $active_plugins );
1772
	}
1773
1774
	/**
1775
	 * Gets and parses additional plugin data to send with the heartbeat data
1776
	 *
1777
	 * @since 3.8.1
1778
	 *
1779
	 * @return array Array of plugin data
1780
	 */
1781
	public static function get_parsed_plugin_data() {
1782
		if ( ! function_exists( 'get_plugins' ) ) {
1783
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1784
		}
1785
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1786
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1787
		$active_plugins = Jetpack::get_active_plugins();
1788
1789
		$plugins = array();
1790
		foreach ( $all_plugins as $path => $plugin_data ) {
1791
			$plugins[ $path ] = array(
1792
					'is_active' => in_array( $path, $active_plugins ),
1793
					'file'      => $path,
1794
					'name'      => $plugin_data['Name'],
1795
					'version'   => $plugin_data['Version'],
1796
					'author'    => $plugin_data['Author'],
1797
			);
1798
		}
1799
1800
		return $plugins;
1801
	}
1802
1803
	/**
1804
	 * Gets and parses theme data to send with the heartbeat data
1805
	 *
1806
	 * @since 3.8.1
1807
	 *
1808
	 * @return array Array of theme data
1809
	 */
1810
	public static function get_parsed_theme_data() {
1811
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1812
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1813
1814
		$themes = array();
1815
		foreach ( $all_themes as $slug => $theme_data ) {
1816
			$theme_headers = array();
1817
			foreach ( $header_keys as $header_key ) {
1818
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1819
			}
1820
1821
			$themes[ $slug ] = array(
1822
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1823
					'slug' => $slug,
1824
					'theme_root' => $theme_data->get_theme_root_uri(),
1825
					'parent' => $theme_data->parent(),
1826
					'headers' => $theme_headers
1827
			);
1828
		}
1829
1830
		return $themes;
1831
	}
1832
1833
	/**
1834
	 * Checks whether a specific plugin is active.
1835
	 *
1836
	 * We don't want to store these in a static variable, in case
1837
	 * there are switch_to_blog() calls involved.
1838
	 */
1839
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1840
		return in_array( $plugin, self::get_active_plugins() );
1841
	}
1842
1843
	/**
1844
	 * Check if Jetpack's Open Graph tags should be used.
1845
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1846
	 *
1847
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1848
	 * @action plugins_loaded
1849
	 * @return null
1850
	 */
1851
	public function check_open_graph() {
1852
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1853
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1854
		}
1855
1856
		$active_plugins = self::get_active_plugins();
1857
1858
		if ( ! empty( $active_plugins ) ) {
1859
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1860
				if ( in_array( $plugin, $active_plugins ) ) {
1861
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1862
					break;
1863
				}
1864
			}
1865
		}
1866
1867
		/**
1868
		 * Allow the addition of Open Graph Meta Tags to all pages.
1869
		 *
1870
		 * @since 2.0.3
1871
		 *
1872
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1873
		 */
1874
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1875
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1876
		}
1877
	}
1878
1879
	/**
1880
	 * Check if Jetpack's Twitter tags should be used.
1881
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1882
	 *
1883
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1884
	 * @action plugins_loaded
1885
	 * @return null
1886
	 */
1887
	public function check_twitter_tags() {
1888
1889
		$active_plugins = self::get_active_plugins();
1890
1891
		if ( ! empty( $active_plugins ) ) {
1892
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1893
				if ( in_array( $plugin, $active_plugins ) ) {
1894
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1895
					break;
1896
				}
1897
			}
1898
		}
1899
1900
		/**
1901
		 * Allow Twitter Card Meta tags to be disabled.
1902
		 *
1903
		 * @since 2.6.0
1904
		 *
1905
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1906
		 */
1907
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1908
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1909
		}
1910
	}
1911
1912
	/**
1913
	 * Allows plugins to submit security reports.
1914
 	 *
1915
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1916
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1917
	 * @param array   $args         See definitions above
1918
	 */
1919
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1920
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1921
	}
1922
1923
/* Jetpack Options API */
1924
1925
	public static function get_option_names( $type = 'compact' ) {
1926
		return Jetpack_Options::get_option_names( $type );
1927
	}
1928
1929
	/**
1930
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1931
 	 *
1932
	 * @param string $name    Option name
1933
	 * @param mixed  $default (optional)
1934
	 */
1935
	public static function get_option( $name, $default = false ) {
1936
		return Jetpack_Options::get_option( $name, $default );
1937
	}
1938
1939
	/**
1940
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1941
 	 *
1942
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1943
	 * @param string $name  Option name
1944
	 * @param mixed  $value Option value
1945
	 */
1946
	public static function update_option( $name, $value ) {
1947
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1948
		return Jetpack_Options::update_option( $name, $value );
1949
	}
1950
1951
	/**
1952
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1953
 	 *
1954
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1955
	 * @param array $array array( option name => option value, ... )
1956
	 */
1957
	public static function update_options( $array ) {
1958
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1959
		return Jetpack_Options::update_options( $array );
1960
	}
1961
1962
	/**
1963
	 * Deletes the given option.  May be passed multiple option names as an array.
1964
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1965
	 *
1966
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1967
	 * @param string|array $names
1968
	 */
1969
	public static function delete_option( $names ) {
1970
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1971
		return Jetpack_Options::delete_option( $names );
1972
	}
1973
1974
	/**
1975
	 * Enters a user token into the user_tokens option
1976
	 *
1977
	 * @param int $user_id
1978
	 * @param string $token
1979
	 * return bool
1980
	 */
1981
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1982
		// not designed for concurrent updates
1983
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1984
		if ( ! is_array( $user_tokens ) )
1985
			$user_tokens = array();
1986
		$user_tokens[$user_id] = $token;
1987
		if ( $is_master_user ) {
1988
			$master_user = $user_id;
1989
			$options     = compact( 'user_tokens', 'master_user' );
1990
		} else {
1991
			$options = compact( 'user_tokens' );
1992
		}
1993
		return Jetpack_Options::update_options( $options );
1994
	}
1995
1996
	/**
1997
	 * Returns an array of all PHP files in the specified absolute path.
1998
	 * Equivalent to glob( "$absolute_path/*.php" ).
1999
	 *
2000
	 * @param string $absolute_path The absolute path of the directory to search.
2001
	 * @return array Array of absolute paths to the PHP files.
2002
	 */
2003
	public static function glob_php( $absolute_path ) {
2004
		if ( function_exists( 'glob' ) ) {
2005
			return glob( "$absolute_path/*.php" );
2006
		}
2007
2008
		$absolute_path = untrailingslashit( $absolute_path );
2009
		$files = array();
2010
		if ( ! $dir = @opendir( $absolute_path ) ) {
2011
			return $files;
2012
		}
2013
2014
		while ( false !== $file = readdir( $dir ) ) {
2015
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2016
				continue;
2017
			}
2018
2019
			$file = "$absolute_path/$file";
2020
2021
			if ( ! is_file( $file ) ) {
2022
				continue;
2023
			}
2024
2025
			$files[] = $file;
2026
		}
2027
2028
		closedir( $dir );
2029
2030
		return $files;
2031
	}
2032
2033
	public static function activate_new_modules( $redirect = false ) {
2034
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2035
			return;
2036
		}
2037
2038
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2039 View Code Duplication
		if ( ! $jetpack_old_version ) {
2040
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2041
			/** This action is documented in class.jetpack.php */
2042
			do_action( 'updating_jetpack_version', $version, false );
2043
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2044
		}
2045
2046
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2047
2048
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2049
			return;
2050
		}
2051
2052
		$active_modules     = Jetpack::get_active_modules();
2053
		$reactivate_modules = array();
2054
		foreach ( $active_modules as $active_module ) {
2055
			$module = Jetpack::get_module( $active_module );
2056
			if ( ! isset( $module['changed'] ) ) {
2057
				continue;
2058
			}
2059
2060
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2061
				continue;
2062
			}
2063
2064
			$reactivate_modules[] = $active_module;
2065
			Jetpack::deactivate_module( $active_module );
2066
		}
2067
2068
		$new_version = JETPACK__VERSION . ':' . time();
2069
		/** This action is documented in class.jetpack.php */
2070
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2071
		Jetpack_Options::update_options(
2072
			array(
2073
				'version'     => $new_version,
2074
				'old_version' => $jetpack_old_version,
2075
			)
2076
		);
2077
2078
		Jetpack::state( 'message', 'modules_activated' );
2079
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2080
2081
		if ( $redirect ) {
2082
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2083
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2084
				$page = $_GET['page'];
2085
			}
2086
2087
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2088
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_new_modules() contains an exit expression.

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

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

Loading history...
2089
		}
2090
	}
2091
2092
	/**
2093
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2094
	 * Make sure to tuck away module "library" files in a sub-directory.
2095
	 */
2096
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2097
		static $modules = null;
2098
2099
		if ( ! isset( $modules ) ) {
2100
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2101
			// Use the cache if we're on the front-end and it's available...
2102
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2103
				$modules = $available_modules_option[ JETPACK__VERSION ];
2104
			} else {
2105
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2106
2107
				$modules = array();
2108
2109
				foreach ( $files as $file ) {
2110
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2111
						continue;
2112
					}
2113
2114
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2115
				}
2116
2117
				Jetpack_Options::update_option( 'available_modules', array(
2118
					JETPACK__VERSION => $modules,
2119
				) );
2120
			}
2121
		}
2122
2123
		/**
2124
		 * Filters the array of modules available to be activated.
2125
		 *
2126
		 * @since 2.4.0
2127
		 *
2128
		 * @param array $modules Array of available modules.
2129
		 * @param string $min_version Minimum version number required to use modules.
2130
		 * @param string $max_version Maximum version number required to use modules.
2131
		 */
2132
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2133
2134
		if ( ! $min_version && ! $max_version ) {
2135
			return array_keys( $mods );
2136
		}
2137
2138
		$r = array();
2139
		foreach ( $mods as $slug => $introduced ) {
2140
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2141
				continue;
2142
			}
2143
2144
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2145
				continue;
2146
			}
2147
2148
			$r[] = $slug;
2149
		}
2150
2151
		return $r;
2152
	}
2153
2154
	/**
2155
	 * Default modules loaded on activation.
2156
	 */
2157
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2158
		$return = array();
2159
2160
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2161
			$module_data = Jetpack::get_module( $module );
2162
2163
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2164
				case 'yes' :
2165
					$return[] = $module;
2166
					break;
2167
				case 'public' :
2168
					if ( Jetpack_Options::get_option( 'public' ) ) {
2169
						$return[] = $module;
2170
					}
2171
					break;
2172
				case 'no' :
2173
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

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

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

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

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

Loading history...
2174
					break;
2175
			}
2176
		}
2177
		/**
2178
		 * Filters the array of default modules.
2179
		 *
2180
		 * @since 2.5.0
2181
		 *
2182
		 * @param array $return Array of default modules.
2183
		 * @param string $min_version Minimum version number required to use modules.
2184
		 * @param string $max_version Maximum version number required to use modules.
2185
		 */
2186
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2187
	}
2188
2189
	/**
2190
	 * Checks activated modules during auto-activation to determine
2191
	 * if any of those modules are being deprecated.  If so, close
2192
	 * them out, and add any replacement modules.
2193
	 *
2194
	 * Runs at priority 99 by default.
2195
	 *
2196
	 * This is run late, so that it can still activate a module if
2197
	 * the new module is a replacement for another that the user
2198
	 * currently has active, even if something at the normal priority
2199
	 * would kibosh everything.
2200
	 *
2201
	 * @since 2.6
2202
	 * @uses jetpack_get_default_modules filter
2203
	 * @param array $modules
2204
	 * @return array
2205
	 */
2206
	function handle_deprecated_modules( $modules ) {
2207
		$deprecated_modules = array(
2208
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2209
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2210
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2211
		);
2212
2213
		// Don't activate SSO if they never completed activating WPCC.
2214
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2215
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2216
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2217
				$deprecated_modules['wpcc'] = null;
2218
			}
2219
		}
2220
2221
		foreach ( $deprecated_modules as $module => $replacement ) {
2222
			if ( Jetpack::is_module_active( $module ) ) {
2223
				self::deactivate_module( $module );
2224
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2225
					$modules[] = $replacement;
2226
				}
2227
			}
2228
		}
2229
2230
		return array_unique( $modules );
2231
	}
2232
2233
	/**
2234
	 * Checks activated plugins during auto-activation to determine
2235
	 * if any of those plugins are in the list with a corresponding module
2236
	 * that is not compatible with the plugin. The module will not be allowed
2237
	 * to auto-activate.
2238
	 *
2239
	 * @since 2.6
2240
	 * @uses jetpack_get_default_modules filter
2241
	 * @param array $modules
2242
	 * @return array
2243
	 */
2244
	function filter_default_modules( $modules ) {
2245
2246
		$active_plugins = self::get_active_plugins();
2247
2248
		if ( ! empty( $active_plugins ) ) {
2249
2250
			// For each module we'd like to auto-activate...
2251
			foreach ( $modules as $key => $module ) {
2252
				// If there are potential conflicts for it...
2253
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2254
					// For each potential conflict...
2255
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2256
						// If that conflicting plugin is active...
2257
						if ( in_array( $plugin, $active_plugins ) ) {
2258
							// Remove that item from being auto-activated.
2259
							unset( $modules[ $key ] );
2260
						}
2261
					}
2262
				}
2263
			}
2264
		}
2265
2266
		return $modules;
2267
	}
2268
2269
	/**
2270
	 * Extract a module's slug from its full path.
2271
	 */
2272
	public static function get_module_slug( $file ) {
2273
		return str_replace( '.php', '', basename( $file ) );
2274
	}
2275
2276
	/**
2277
	 * Generate a module's path from its slug.
2278
	 */
2279
	public static function get_module_path( $slug ) {
2280
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2281
	}
2282
2283
	/**
2284
	 * Load module data from module file. Headers differ from WordPress
2285
	 * plugin headers to avoid them being identified as standalone
2286
	 * plugins on the WordPress plugins page.
2287
	 */
2288
	public static function get_module( $module ) {
2289
		$headers = array(
2290
			'name'                      => 'Module Name',
2291
			'description'               => 'Module Description',
2292
			'jumpstart_desc'            => 'Jumpstart Description',
2293
			'sort'                      => 'Sort Order',
2294
			'recommendation_order'      => 'Recommendation Order',
2295
			'introduced'                => 'First Introduced',
2296
			'changed'                   => 'Major Changes In',
2297
			'deactivate'                => 'Deactivate',
2298
			'free'                      => 'Free',
2299
			'requires_connection'       => 'Requires Connection',
2300
			'auto_activate'             => 'Auto Activate',
2301
			'module_tags'               => 'Module Tags',
2302
			'feature'                   => 'Feature',
2303
			'additional_search_queries' => 'Additional Search Queries',
2304
		);
2305
2306
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2307
2308
		$mod = Jetpack::get_file_data( $file, $headers );
2309
		if ( empty( $mod['name'] ) ) {
2310
			return false;
2311
		}
2312
2313
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2314
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2315
		$mod['deactivate']              = empty( $mod['deactivate'] );
2316
		$mod['free']                    = empty( $mod['free'] );
2317
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2318
2319
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2320
			$mod['auto_activate'] = 'No';
2321
		} else {
2322
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2323
		}
2324
2325
		if ( $mod['module_tags'] ) {
2326
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2327
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2328
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2329
		} else {
2330
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2331
		}
2332
2333
		if ( $mod['feature'] ) {
2334
			$mod['feature'] = explode( ',', $mod['feature'] );
2335
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2336
		} else {
2337
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2338
		}
2339
2340
		/**
2341
		 * Filters the feature array on a module.
2342
		 *
2343
		 * This filter allows you to control where each module is filtered: Recommended,
2344
		 * Jumpstart, and the default "Other" listing.
2345
		 *
2346
		 * @since 3.5.0
2347
		 *
2348
		 * @param array   $mod['feature'] The areas to feature this module:
2349
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2350
		 *     'Recommended' shows on the main Jetpack admin screen.
2351
		 *     'Other' should be the default if no other value is in the array.
2352
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2353
		 * @param array   $mod All the currently assembled module data.
2354
		 */
2355
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2356
2357
		/**
2358
		 * Filter the returned data about a module.
2359
		 *
2360
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2361
		 * so please be careful.
2362
		 *
2363
		 * @since 3.6.0
2364
		 *
2365
		 * @param array   $mod    The details of the requested module.
2366
		 * @param string  $module The slug of the module, e.g. sharedaddy
2367
		 * @param string  $file   The path to the module source file.
2368
		 */
2369
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2370
	}
2371
2372
	/**
2373
	 * Like core's get_file_data implementation, but caches the result.
2374
	 */
2375
	public static function get_file_data( $file, $headers ) {
2376
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2377
		$file_name = basename( $file );
2378
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2379
		$key              = md5( $file_name . serialize( $headers ) );
2380
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2381
2382
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2383
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2384
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2385
		}
2386
2387
		$data = get_file_data( $file, $headers );
2388
2389
		// Strip out any old Jetpack versions that are cluttering the option.
2390
		//
2391
		// We maintain the data for the current version of Jetpack plus the previous version
2392
		// to prevent repeated DB hits on large sites hosted with multiple web servers
2393
		// on a single database (since all web servers might not be updated simultaneously)
2394
2395
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2396
2397
		if ( count( $file_data_option ) > 2 ) {
2398
			$count = 0;
2399
			krsort( $file_data_option );
2400
			foreach ( $file_data_option as $version => $values ) {
2401
				$count++;
2402
				if ( $count > 2 && JETPACK__VERSION != $version ) {
2403
					unset( $file_data_option[ $version ] );
2404
				}
2405
			}
2406
		}
2407
2408
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2409
2410
		return $data;
2411
	}
2412
2413
2414
	/**
2415
	 * Return translated module tag.
2416
	 *
2417
	 * @param string $tag Tag as it appears in each module heading.
2418
	 *
2419
	 * @return mixed
2420
	 */
2421
	public static function translate_module_tag( $tag ) {
2422
		return jetpack_get_module_i18n_tag( $tag );
2423
	}
2424
2425
	/**
2426
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2427
	 *
2428
	 * @since 3.9.2
2429
	 *
2430
	 * @param array $modules
2431
	 *
2432
	 * @return string|void
2433
	 */
2434
	public static function get_translated_modules( $modules ) {
2435
		foreach ( $modules as $index => $module ) {
2436
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2437
			if ( isset( $module['name'] ) ) {
2438
				$modules[ $index ]['name'] = $i18n_module['name'];
2439
			}
2440
			if ( isset( $module['description'] ) ) {
2441
				$modules[ $index ]['description'] = $i18n_module['description'];
2442
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2443
			}
2444
		}
2445
		return $modules;
2446
	}
2447
2448
	/**
2449
	 * Get a list of activated modules as an array of module slugs.
2450
	 */
2451
	public static function get_active_modules() {
2452
		$active = Jetpack_Options::get_option( 'active_modules' );
2453
2454
		if ( ! is_array( $active ) ) {
2455
			$active = array();
2456
		}
2457
2458
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2459
			$active[] = 'vaultpress';
2460
		} else {
2461
			$active = array_diff( $active, array( 'vaultpress' ) );
2462
		}
2463
2464
		//If protect is active on the main site of a multisite, it should be active on all sites.
2465
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2466
			$active[] = 'protect';
2467
		}
2468
2469
		return array_unique( $active );
2470
	}
2471
2472
	/**
2473
	 * Check whether or not a Jetpack module is active.
2474
	 *
2475
	 * @param string $module The slug of a Jetpack module.
2476
	 * @return bool
2477
	 *
2478
	 * @static
2479
	 */
2480
	public static function is_module_active( $module ) {
2481
		return in_array( $module, self::get_active_modules() );
2482
	}
2483
2484
	public static function is_module( $module ) {
2485
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2486
	}
2487
2488
	/**
2489
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2490
	 *
2491
	 * @param bool $catch True to start catching, False to stop.
2492
	 *
2493
	 * @static
2494
	 */
2495
	public static function catch_errors( $catch ) {
2496
		static $display_errors, $error_reporting;
2497
2498
		if ( $catch ) {
2499
			$display_errors  = @ini_set( 'display_errors', 1 );
2500
			$error_reporting = @error_reporting( E_ALL );
2501
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2502
		} else {
2503
			@ini_set( 'display_errors', $display_errors );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

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

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2504
			@error_reporting( $error_reporting );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

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

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2505
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2506
		}
2507
	}
2508
2509
	/**
2510
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2511
	 */
2512
	public static function catch_errors_on_shutdown() {
2513
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2514
	}
2515
2516
	/**
2517
	 * Rewrite any string to make paths easier to read.
2518
	 *
2519
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2520
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2521
	 *
2522
	 * @param $string
2523
	 * @return mixed
2524
	 */
2525
	public static function alias_directories( $string ) {
2526
		// ABSPATH has a trailing slash.
2527
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2528
		// WP_CONTENT_DIR does not have a trailing slash.
2529
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2530
2531
		return $string;
2532
	}
2533
2534
	public static function activate_default_modules(
2535
		$min_version = false,
2536
		$max_version = false,
2537
		$other_modules = array(),
2538
		$redirect = true,
2539
		$send_state_messages = true
2540
	) {
2541
		$jetpack = Jetpack::init();
2542
2543
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2544
		$modules = array_merge( $other_modules, $modules );
2545
2546
		// Look for standalone plugins and disable if active.
2547
2548
		$to_deactivate = array();
2549
		foreach ( $modules as $module ) {
2550
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2551
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2552
			}
2553
		}
2554
2555
		$deactivated = array();
2556
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2557
			list( $probable_file, $probable_title ) = $deactivate_me;
2558
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2559
				$deactivated[] = $module;
2560
			}
2561
		}
2562
2563
		if ( $deactivated && $redirect ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2564
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2565
2566
			$url = add_query_arg(
2567
				array(
2568
					'action'   => 'activate_default_modules',
2569
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2570
				),
2571
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2572
			);
2573
			wp_safe_redirect( $url );
2574
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_default_modules() contains an exit expression.

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

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

Loading history...
2575
		}
2576
2577
		/**
2578
		 * Fires before default modules are activated.
2579
		 *
2580
		 * @since 1.9.0
2581
		 *
2582
		 * @param string $min_version Minimum version number required to use modules.
2583
		 * @param string $max_version Maximum version number required to use modules.
2584
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2585
		 */
2586
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2587
2588
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2589
		Jetpack::restate();
2590
		Jetpack::catch_errors( true );
2591
2592
		$active = Jetpack::get_active_modules();
2593
2594
		foreach ( $modules as $module ) {
2595
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2596
				$active[] = $module;
2597
				self::update_active_modules( $active );
2598
				continue;
2599
			}
2600
2601
			if ( $send_state_messages && in_array( $module, $active ) ) {
2602
				$module_info = Jetpack::get_module( $module );
2603 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2604
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2605
					if ( $active_state = Jetpack::state( $state ) ) {
2606
						$active_state = explode( ',', $active_state );
2607
					} else {
2608
						$active_state = array();
2609
					}
2610
					$active_state[] = $module;
2611
					Jetpack::state( $state, implode( ',', $active_state ) );
2612
				}
2613
				continue;
2614
			}
2615
2616
			$file = Jetpack::get_module_path( $module );
2617
			if ( ! file_exists( $file ) ) {
2618
				continue;
2619
			}
2620
2621
			// we'll override this later if the plugin can be included without fatal error
2622
			if ( $redirect ) {
2623
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2624
			}
2625
2626
			if ( $send_state_messages ) {
2627
				Jetpack::state( 'error', 'module_activation_failed' );
2628
				Jetpack::state( 'module', $module );
2629
			}
2630
2631
			ob_start();
2632
			require $file;
2633
2634
			$active[] = $module;
2635
2636 View Code Duplication
			if ( $send_state_messages ) {
2637
2638
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
2639
				if ( $active_state = Jetpack::state( $state ) ) {
2640
					$active_state = explode( ',', $active_state );
2641
				} else {
2642
					$active_state = array();
2643
				}
2644
				$active_state[] = $module;
2645
				Jetpack::state( $state, implode( ',', $active_state ) );
2646
			}
2647
2648
			Jetpack::update_active_modules( $active );
2649
2650
			ob_end_clean();
2651
		}
2652
2653
		if ( $send_state_messages ) {
2654
			Jetpack::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2656
		}
2657
2658
		Jetpack::catch_errors( false );
2659
		/**
2660
		 * Fires when default modules are activated.
2661
		 *
2662
		 * @since 1.9.0
2663
		 *
2664
		 * @param string $min_version Minimum version number required to use modules.
2665
		 * @param string $max_version Maximum version number required to use modules.
2666
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2667
		 */
2668
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2669
	}
2670
2671
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2672
		/**
2673
		 * Fires before a module is activated.
2674
		 *
2675
		 * @since 2.6.0
2676
		 *
2677
		 * @param string $module Module slug.
2678
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2679
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2680
		 */
2681
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2682
2683
		$jetpack = Jetpack::init();
2684
2685
		if ( ! strlen( $module ) )
2686
			return false;
2687
2688
		if ( ! Jetpack::is_module( $module ) )
2689
			return false;
2690
2691
		// If it's already active, then don't do it again
2692
		$active = Jetpack::get_active_modules();
2693
		foreach ( $active as $act ) {
2694
			if ( $act == $module )
2695
				return true;
2696
		}
2697
2698
		$module_data = Jetpack::get_module( $module );
2699
2700
		if ( ! Jetpack::is_active() ) {
2701
			if ( !Jetpack::is_development_mode() )
2702
				return false;
2703
2704
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2705
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2706
				return false;
2707
		}
2708
2709
		// Check and see if the old plugin is active
2710
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2711
			// Deactivate the old plugin
2712
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2713
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2714
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2715
				Jetpack::state( 'deactivated_plugins', $module );
2716
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2717
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

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

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

Loading history...
2718
			}
2719
		}
2720
2721
		// Protect won't work with mis-configured IPs
2722
		if ( 'protect' === $module ) {
2723
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2724
			if ( ! jetpack_protect_get_ip() ) {
2725
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2726
				return false;
2727
			}
2728
		}
2729
2730
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2731
		Jetpack::state( 'module', $module );
2732
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2733
2734
		Jetpack::catch_errors( true );
2735
		ob_start();
2736
		require Jetpack::get_module_path( $module );
2737
		/** This action is documented in class.jetpack.php */
2738
		do_action( 'jetpack_activate_module', $module );
2739
		$active[] = $module;
2740
		Jetpack::update_active_modules( $active );
2741
2742
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2743
		ob_end_clean();
2744
		Jetpack::catch_errors( false );
2745
2746
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2747 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2748
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2749
2750
			//Jump start is being dismissed send data to MC Stats
2751
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2752
2753
			$jetpack->do_stats( 'server_side' );
2754
		}
2755
2756
		if ( $redirect ) {
2757
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2758
		}
2759
		if ( $exit ) {
2760
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

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

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

Loading history...
2761
		}
2762
		return true;
2763
	}
2764
2765
	function activate_module_actions( $module ) {
2766
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2767
	}
2768
2769
	public static function deactivate_module( $module ) {
2770
		/**
2771
		 * Fires when a module is deactivated.
2772
		 *
2773
		 * @since 1.9.0
2774
		 *
2775
		 * @param string $module Module slug.
2776
		 */
2777
		do_action( 'jetpack_pre_deactivate_module', $module );
2778
2779
		$jetpack = Jetpack::init();
2780
2781
		$active = Jetpack::get_active_modules();
2782
		$new    = array_filter( array_diff( $active, (array) $module ) );
2783
2784
		// A flag for Jump Start so it's not shown again.
2785 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2786
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2787
2788
			//Jump start is being dismissed send data to MC Stats
2789
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2790
2791
			$jetpack->do_stats( 'server_side' );
2792
		}
2793
2794
		return self::update_active_modules( $new );
2795
	}
2796
2797
	public static function enable_module_configurable( $module ) {
2798
		$module = Jetpack::get_module_slug( $module );
2799
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2800
	}
2801
2802
	public static function module_configuration_url( $module ) {
2803
		$module = Jetpack::get_module_slug( $module );
2804
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2805
	}
2806
2807
	public static function module_configuration_load( $module, $method ) {
2808
		$module = Jetpack::get_module_slug( $module );
2809
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2810
	}
2811
2812
	public static function module_configuration_head( $module, $method ) {
2813
		$module = Jetpack::get_module_slug( $module );
2814
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2815
	}
2816
2817
	public static function module_configuration_screen( $module, $method ) {
2818
		$module = Jetpack::get_module_slug( $module );
2819
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2820
	}
2821
2822
	public static function module_configuration_activation_screen( $module, $method ) {
2823
		$module = Jetpack::get_module_slug( $module );
2824
		add_action( 'display_activate_module_setting_' . $module, $method );
2825
	}
2826
2827
/* Installation */
2828
2829
	public static function bail_on_activation( $message, $deactivate = true ) {
2830
?>
2831
<!doctype html>
2832
<html>
2833
<head>
2834
<meta charset="<?php bloginfo( 'charset' ); ?>">
2835
<style>
2836
* {
2837
	text-align: center;
2838
	margin: 0;
2839
	padding: 0;
2840
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2841
}
2842
p {
2843
	margin-top: 1em;
2844
	font-size: 18px;
2845
}
2846
</style>
2847
<body>
2848
<p><?php echo esc_html( $message ); ?></p>
2849
</body>
2850
</html>
2851
<?php
2852
		if ( $deactivate ) {
2853
			$plugins = get_option( 'active_plugins' );
2854
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2855
			$update  = false;
2856
			foreach ( $plugins as $i => $plugin ) {
2857
				if ( $plugin === $jetpack ) {
2858
					$plugins[$i] = false;
2859
					$update = true;
2860
				}
2861
			}
2862
2863
			if ( $update ) {
2864
				update_option( 'active_plugins', array_filter( $plugins ) );
2865
			}
2866
		}
2867
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method bail_on_activation() contains an exit expression.

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

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

Loading history...
2868
	}
2869
2870
	/**
2871
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2872
	 * @static
2873
	 */
2874
	public static function plugin_activation( $network_wide ) {
2875
		Jetpack_Options::update_option( 'activated', 1 );
2876
2877
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2878
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2879
		}
2880
2881
		if ( $network_wide )
2882
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2883
2884
		// For firing one-off events (notices) immediately after activation
2885
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2886
2887
		Jetpack::plugin_initialize();
2888
	}
2889
	/**
2890
	 * Runs before bumping version numbers up to a new version
2891
	 * @param  string $version    Version:timestamp
2892
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
2893
	 * @return null              [description]
2894
	 */
2895
	public static function do_version_bump( $version, $old_version ) {
2896
2897
		if ( ! $old_version ) { // For new sites
2898
			// Setting up jetpack manage
2899
			Jetpack::activate_manage();
2900
		}
2901
	}
2902
2903
	/**
2904
	 * Sets the internal version number and activation state.
2905
	 * @static
2906
	 */
2907
	public static function plugin_initialize() {
2908
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2909
			Jetpack_Options::update_option( 'activated', 2 );
2910
		}
2911
2912 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2913
			$version = $old_version = JETPACK__VERSION . ':' . time();
2914
			/** This action is documented in class.jetpack.php */
2915
			do_action( 'updating_jetpack_version', $version, false );
2916
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2917
		}
2918
2919
		Jetpack::load_modules();
2920
2921
		Jetpack_Options::delete_option( 'do_activate' );
2922
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
2923
	}
2924
2925
	/**
2926
	 * Removes all connection options
2927
	 * @static
2928
	 */
2929
	public static function plugin_deactivation( ) {
2930
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2931
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2932
			Jetpack_Network::init()->deactivate();
2933
		} else {
2934
			Jetpack::disconnect( false );
2935
			//Jetpack_Heartbeat::init()->deactivate();
2936
		}
2937
	}
2938
2939
	/**
2940
	 * Disconnects from the Jetpack servers.
2941
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2942
	 * @static
2943
	 */
2944
	public static function disconnect( $update_activated_state = true ) {
2945
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2946
		Jetpack::clean_nonces( true );
2947
2948
		// If the site is in an IDC because sync is not allowed,
2949
		// let's make sure to not disconnect the production site.
2950
		if ( ! self::validate_sync_error_idc_option() ) {
2951
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2952
			Jetpack::load_xml_rpc_client();
2953
			$xml = new Jetpack_IXR_Client();
2954
			$xml->query( 'jetpack.deregister' );
2955
		}
2956
2957
		Jetpack_Options::delete_option(
2958
			array(
2959
				'blog_token',
2960
				'user_token',
2961
				'user_tokens',
2962
				'master_user',
2963
				'time_diff',
2964
				'fallback_no_verify_ssl_certs',
2965
			)
2966
		);
2967
2968
		Jetpack_IDC::clear_all_idc_options();
2969
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
2970
2971
		if ( $update_activated_state ) {
2972
			Jetpack_Options::update_option( 'activated', 4 );
2973
		}
2974
2975
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2976
			// Check then record unique disconnection if site has never been disconnected previously
2977
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2978
				$jetpack_unique_connection['disconnected'] = 1;
2979
			} else {
2980
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2981
					//track unique disconnect
2982
					$jetpack = Jetpack::init();
2983
2984
					$jetpack->stat( 'connections', 'unique-disconnect' );
2985
					$jetpack->do_stats( 'server_side' );
2986
				}
2987
				// increment number of times disconnected
2988
				$jetpack_unique_connection['disconnected'] += 1;
2989
			}
2990
2991
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2992
		}
2993
2994
		// Delete cached connected user data
2995
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2996
		delete_transient( $transient_key );
2997
2998
		// Delete all the sync related data. Since it could be taking up space.
2999
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3000
		Jetpack_Sync_Sender::get_instance()->uninstall();
3001
3002
		// Disable the Heartbeat cron
3003
		Jetpack_Heartbeat::init()->deactivate();
3004
	}
3005
3006
	/**
3007
	 * Unlinks the current user from the linked WordPress.com user
3008
	 */
3009
	public static function unlink_user( $user_id = null ) {
3010
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3011
			return false;
3012
3013
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3014
3015
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3016
			return false;
3017
3018
		if ( ! isset( $tokens[ $user_id ] ) )
3019
			return false;
3020
3021
		Jetpack::load_xml_rpc_client();
3022
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3023
		$xml->query( 'jetpack.unlink_user', $user_id );
3024
3025
		unset( $tokens[ $user_id ] );
3026
3027
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3028
3029
		/**
3030
		 * Fires after the current user has been unlinked from WordPress.com.
3031
		 *
3032
		 * @since 4.1.0
3033
		 *
3034
		 * @param int $user_id The current user's ID.
3035
		 */
3036
		do_action( 'jetpack_unlinked_user', $user_id );
3037
3038
		return true;
3039
	}
3040
3041
	/**
3042
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3043
	 */
3044
	public static function try_registration() {
3045
		// Let's get some testing in beta versions and such.
3046
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3047
			// Before attempting to connect, let's make sure that the domains are viable.
3048
			$domains_to_check = array_unique( array(
3049
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3050
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3051
			) );
3052
			foreach ( $domains_to_check as $domain ) {
3053
				$result = Jetpack_Data::is_usable_domain( $domain );
3054
				if ( is_wp_error( $result ) ) {
3055
					return $result;
3056
				}
3057
			}
3058
		}
3059
3060
		$result = Jetpack::register();
3061
3062
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3063
		if ( ! $result || is_wp_error( $result ) ) {
3064
			return $result;
3065
		} else {
3066
			return true;
3067
		}
3068
	}
3069
3070
	/**
3071
	 * Tracking an internal event log. Try not to put too much chaff in here.
3072
	 *
3073
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3074
	 */
3075
	public static function log( $code, $data = null ) {
3076
		// only grab the latest 200 entries
3077
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3078
3079
		// Append our event to the log
3080
		$log_entry = array(
3081
			'time'    => time(),
3082
			'user_id' => get_current_user_id(),
3083
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3084
			'code'    => $code,
3085
		);
3086
		// Don't bother storing it unless we've got some.
3087
		if ( ! is_null( $data ) ) {
3088
			$log_entry['data'] = $data;
3089
		}
3090
		$log[] = $log_entry;
3091
3092
		// Try add_option first, to make sure it's not autoloaded.
3093
		// @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...
3094
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3095
			Jetpack_Options::update_option( 'log', $log );
3096
		}
3097
3098
		/**
3099
		 * Fires when Jetpack logs an internal event.
3100
		 *
3101
		 * @since 3.0.0
3102
		 *
3103
		 * @param array $log_entry {
3104
		 *	Array of details about the log entry.
3105
		 *
3106
		 *	@param string time Time of the event.
3107
		 *	@param int user_id ID of the user who trigerred the event.
3108
		 *	@param int blog_id Jetpack Blog ID.
3109
		 *	@param string code Unique name for the event.
3110
		 *	@param string data Data about the event.
3111
		 * }
3112
		 */
3113
		do_action( 'jetpack_log_entry', $log_entry );
3114
	}
3115
3116
	/**
3117
	 * Get the internal event log.
3118
	 *
3119
	 * @param $event (string) - only return the specific log events
3120
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3121
	 *
3122
	 * @return array of log events || WP_Error for invalid params
3123
	 */
3124
	public static function get_log( $event = false, $num = false ) {
3125
		if ( $event && ! is_string( $event ) ) {
3126
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3127
		}
3128
3129
		if ( $num && ! is_numeric( $num ) ) {
3130
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3131
		}
3132
3133
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3134
3135
		// If nothing set - act as it did before, otherwise let's start customizing the output
3136
		if ( ! $num && ! $event ) {
3137
			return $entire_log;
3138
		} else {
3139
			$entire_log = array_reverse( $entire_log );
3140
		}
3141
3142
		$custom_log_output = array();
3143
3144
		if ( $event ) {
3145
			foreach ( $entire_log as $log_event ) {
3146
				if ( $event == $log_event[ 'code' ] ) {
3147
					$custom_log_output[] = $log_event;
3148
				}
3149
			}
3150
		} else {
3151
			$custom_log_output = $entire_log;
3152
		}
3153
3154
		if ( $num ) {
3155
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3156
		}
3157
3158
		return $custom_log_output;
3159
	}
3160
3161
	/**
3162
	 * Log modification of important settings.
3163
	 */
3164
	public static function log_settings_change( $option, $old_value, $value ) {
3165
		switch( $option ) {
3166
			case 'jetpack_sync_non_public_post_stati':
3167
				self::log( $option, $value );
3168
				break;
3169
		}
3170
	}
3171
3172
	/**
3173
	 * Return stat data for WPCOM sync
3174
	 */
3175
	public static function get_stat_data( $encode = true, $extended = true ) {
3176
		$data = Jetpack_Heartbeat::generate_stats_array();
3177
3178
		if ( $extended ) {
3179
			$additional_data = self::get_additional_stat_data();
3180
			$data = array_merge( $data, $additional_data );
3181
		}
3182
3183
		if ( $encode ) {
3184
			return json_encode( $data );
3185
		}
3186
3187
		return $data;
3188
	}
3189
3190
	/**
3191
	 * Get additional stat data to sync to WPCOM
3192
	 */
3193
	public static function get_additional_stat_data( $prefix = '' ) {
3194
		$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...
3195
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3196
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3197
		$return["{$prefix}site-count"]     = 0;
3198
3199
		if ( function_exists( 'get_blog_count' ) ) {
3200
			$return["{$prefix}site-count"] = get_blog_count();
3201
		}
3202
		return $return;
3203
	}
3204
3205
	private static function get_site_user_count() {
3206
		global $wpdb;
3207
3208
		if ( function_exists( 'wp_is_large_network' ) ) {
3209
			if ( wp_is_large_network( 'users' ) ) {
3210
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3211
			}
3212
		}
3213 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3214
			// It wasn't there, so regenerate the data and save the transient
3215
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3216
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3217
		}
3218
		return $user_count;
3219
	}
3220
3221
	/* Admin Pages */
3222
3223
	function admin_init() {
3224
		// If the plugin is not connected, display a connect message.
3225
		if (
3226
			// the plugin was auto-activated and needs its candy
3227
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3228
		||
3229
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3230
			! Jetpack_Options::get_option( 'activated' )
3231
		) {
3232
			Jetpack::plugin_initialize();
3233
		}
3234
3235
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3236
			Jetpack_Connection_Banner::init();
3237
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3238
			// Upgrade: 1.1 -> 1.1.1
3239
			// Check and see if host can verify the Jetpack servers' SSL certificate
3240
			$args = array();
3241
			Jetpack_Client::_wp_remote_request(
3242
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3243
				$args,
3244
				true
3245
			);
3246
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3247
			// Show the notice on the Dashboard only for now
3248
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3249
		}
3250
3251
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3252
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3253
		}
3254
3255
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3256
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3257
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3258
3259
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3260
			// Artificially throw errors in certain whitelisted cases during plugin activation
3261
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3262
		}
3263
3264
		// Jetpack Manage Activation Screen from .com
3265
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3266
3267
		// Add custom column in wp-admin/users.php to show whether user is linked.
3268
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3269
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3270
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3271
	}
3272
3273
	function admin_body_class( $admin_body_class = '' ) {
3274
		$classes = explode( ' ', trim( $admin_body_class ) );
3275
3276
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3277
3278
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3279
		return " $admin_body_class ";
3280
	}
3281
3282
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3283
		return $admin_body_class . ' jetpack-pagestyles ';
3284
	}
3285
3286
	/**
3287
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3288
	 *
3289
	 * @return null
3290
	 */
3291
	function prepare_manage_jetpack_notice() {
3292
3293
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3294
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3295
	}
3296
3297
	function manage_activate_screen() {
3298
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3299
	}
3300
	/**
3301
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3302
	 * This function artificially throws errors for such cases (whitelisted).
3303
	 *
3304
	 * @param string $plugin The activated plugin.
3305
	 */
3306
	function throw_error_on_activate_plugin( $plugin ) {
3307
		$active_modules = Jetpack::get_active_modules();
3308
3309
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3310
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3311
			$throw = false;
3312
3313
			// Try and make sure it really was the stats plugin
3314
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3315
				if ( 'stats.php' == basename( $plugin ) ) {
3316
					$throw = true;
3317
				}
3318
			} else {
3319
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3320
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3321
					$throw = true;
3322
				}
3323
			}
3324
3325
			if ( $throw ) {
3326
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3327
			}
3328
		}
3329
	}
3330
3331
	function intercept_plugin_error_scrape_init() {
3332
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3333
	}
3334
3335
	function intercept_plugin_error_scrape( $action, $result ) {
3336
		if ( ! $result ) {
3337
			return;
3338
		}
3339
3340
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3341
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3342
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3343
			}
3344
		}
3345
	}
3346
3347
	function add_remote_request_handlers() {
3348
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3349
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3350
	}
3351
3352
	function remote_request_handlers() {
3353
		$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...
3354
3355
		switch ( current_filter() ) {
3356
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3357
			$response = $this->upload_handler();
3358
			break;
3359
3360
		case 'wp_ajax_nopriv_jetpack_update_file' :
3361
			$response = $this->upload_handler( true );
3362
			break;
3363
		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...
3364
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3365
			break;
3366
		}
3367
3368
		if ( ! $response ) {
3369
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3370
		}
3371
3372
		if ( is_wp_error( $response ) ) {
3373
			$status_code       = $response->get_error_data();
3374
			$error             = $response->get_error_code();
3375
			$error_description = $response->get_error_message();
3376
3377
			if ( ! is_int( $status_code ) ) {
3378
				$status_code = 400;
3379
			}
3380
3381
			status_header( $status_code );
3382
			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...
3383
		}
3384
3385
		status_header( 200 );
3386
		if ( true === $response ) {
3387
			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...
3388
		}
3389
3390
		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...
3391
	}
3392
3393
	/**
3394
	 * Uploads a file gotten from the global $_FILES.
3395
	 * If `$update_media_item` is true and `post_id` is defined
3396
	 * the attachment file of the media item (gotten through of the post_id)
3397
	 * will be updated instead of add a new one.
3398
	 *
3399
	 * @param  boolean $update_media_item - update media attachment
3400
	 * @return array - An array describing the uploadind files process
3401
	 */
3402
	function upload_handler( $update_media_item = false ) {
3403
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3404
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3405
		}
3406
3407
		$user = wp_authenticate( '', '' );
3408
		if ( ! $user || is_wp_error( $user ) ) {
3409
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3410
		}
3411
3412
		wp_set_current_user( $user->ID );
3413
3414
		if ( ! current_user_can( 'upload_files' ) ) {
3415
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3416
		}
3417
3418
		if ( empty( $_FILES ) ) {
3419
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3420
		}
3421
3422
		foreach ( array_keys( $_FILES ) as $files_key ) {
3423
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3424
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3425
			}
3426
		}
3427
3428
		$media_keys = array_keys( $_FILES['media'] );
3429
3430
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3431
		if ( ! $token || is_wp_error( $token ) ) {
3432
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3433
		}
3434
3435
		$uploaded_files = array();
3436
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3437
		unset( $GLOBALS['post'] );
3438
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3439
			$file = array();
3440
			foreach ( $media_keys as $media_key ) {
3441
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3442
			}
3443
3444
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3445
3446
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3447
			if ( $hmac_provided !== $hmac_file ) {
3448
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3449
				continue;
3450
			}
3451
3452
			$_FILES['.jetpack.upload.'] = $file;
3453
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3454
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3455
				$post_id = 0;
3456
			}
3457
3458
			if ( $update_media_item ) {
3459
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3460
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3461
				}
3462
3463
				$media_array = $_FILES['media'];
3464
3465
				$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...
3466
				$file_array['type'] = $media_array['type'][0];
3467
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3468
				$file_array['error'] = $media_array['error'][0];
3469
				$file_array['size'] = $media_array['size'][0];
3470
3471
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3472
3473
				if ( is_wp_error( $edited_media_item ) ) {
3474
					return $edited_media_item;
3475
				}
3476
3477
				$response = (object) array(
3478
					'id'   => (string) $post_id,
3479
					'file' => (string) $edited_media_item->post_title,
3480
					'url'  => (string) wp_get_attachment_url( $post_id ),
3481
					'type' => (string) $edited_media_item->post_mime_type,
3482
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3483
				);
3484
3485
				return (array) array( $response );
3486
			}
3487
3488
			$attachment_id = media_handle_upload(
3489
				'.jetpack.upload.',
3490
				$post_id,
3491
				array(),
3492
				array(
3493
					'action' => 'jetpack_upload_file',
3494
				)
3495
			);
3496
3497
			if ( ! $attachment_id ) {
3498
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3499
			} elseif ( is_wp_error( $attachment_id ) ) {
3500
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3501
			} else {
3502
				$attachment = get_post( $attachment_id );
3503
				$uploaded_files[$index] = (object) array(
3504
					'id'   => (string) $attachment_id,
3505
					'file' => $attachment->post_title,
3506
					'url'  => wp_get_attachment_url( $attachment_id ),
3507
					'type' => $attachment->post_mime_type,
3508
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3509
				);
3510
				// Zip files uploads are not supported unless they are done for installation purposed
3511
				// lets delete them in case something goes wrong in this whole process
3512
				if ( 'application/zip' === $attachment->post_mime_type ) {
3513
					// Schedule a cleanup for 2 hours from now in case of failed install.
3514
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3515
				}
3516
			}
3517
		}
3518
		if ( ! is_null( $global_post ) ) {
3519
			$GLOBALS['post'] = $global_post;
3520
		}
3521
3522
		return $uploaded_files;
3523
	}
3524
3525
	/**
3526
	 * Add help to the Jetpack page
3527
	 *
3528
	 * @since Jetpack (1.2.3)
3529
	 * @return false if not the Jetpack page
3530
	 */
3531
	function admin_help() {
3532
		$current_screen = get_current_screen();
3533
3534
		// Overview
3535
		$current_screen->add_help_tab(
3536
			array(
3537
				'id'		=> 'home',
3538
				'title'		=> __( 'Home', 'jetpack' ),
3539
				'content'	=>
3540
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3541
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3542
					'<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>',
3543
			)
3544
		);
3545
3546
		// Screen Content
3547
		if ( current_user_can( 'manage_options' ) ) {
3548
			$current_screen->add_help_tab(
3549
				array(
3550
					'id'		=> 'settings',
3551
					'title'		=> __( 'Settings', 'jetpack' ),
3552
					'content'	=>
3553
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3554
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3555
						'<ol>' .
3556
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3557
							'<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>' .
3558
						'</ol>' .
3559
						'<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>'
3560
				)
3561
			);
3562
		}
3563
3564
		// Help Sidebar
3565
		$current_screen->set_help_sidebar(
3566
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3567
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3568
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3569
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3570
		);
3571
	}
3572
3573
	function admin_menu_css() {
3574
		wp_enqueue_style( 'jetpack-icons' );
3575
	}
3576
3577
	function admin_menu_order() {
3578
		return true;
3579
	}
3580
3581 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3582
		$jp_menu_order = array();
3583
3584
		foreach ( $menu_order as $index => $item ) {
3585
			if ( $item != 'jetpack' ) {
3586
				$jp_menu_order[] = $item;
3587
			}
3588
3589
			if ( $index == 0 ) {
3590
				$jp_menu_order[] = 'jetpack';
3591
			}
3592
		}
3593
3594
		return $jp_menu_order;
3595
	}
3596
3597
	function admin_head() {
3598 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3599
			/** This action is documented in class.jetpack-admin-page.php */
3600
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3601
	}
3602
3603
	function admin_banner_styles() {
3604
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3605
3606 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3607
			wp_register_style(
3608
				'jetpack-dops-style',
3609
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3610
				array(),
3611
				JETPACK__VERSION
3612
			);
3613
		}
3614
3615
		wp_enqueue_style(
3616
			'jetpack',
3617
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3618
			array( 'jetpack-dops-style' ),
3619
			 JETPACK__VERSION . '-20121016'
3620
		);
3621
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3622
		wp_style_add_data( 'jetpack', 'suffix', $min );
3623
	}
3624
3625
	function plugin_action_links( $actions ) {
3626
3627
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3628
3629
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3630
			return array_merge(
3631
				$jetpack_home,
3632
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3633
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3634
				$actions
3635
				);
3636
			}
3637
3638
		return array_merge( $jetpack_home, $actions );
3639
	}
3640
3641
	/**
3642
	 * This is the first banner
3643
	 * It should be visible only to user that can update the option
3644
	 * Are not connected
3645
	 *
3646
	 * @return null
3647
	 */
3648
	function admin_jetpack_manage_notice() {
3649
		$screen = get_current_screen();
3650
3651
		// Don't show the connect notice on the jetpack settings page.
3652
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3653
			return;
3654
		}
3655
3656
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3657
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3658
		/**
3659
		 * I think it would be great to have different wordsing depending on where you are
3660
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3661
		 * etc..
3662
		 */
3663
3664
		?>
3665
		<div id="message" class="updated jp-banner">
3666
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3667
				<div class="jp-banner__description-container">
3668
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3669
					<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>
3670
					<p class="jp-banner__button-container">
3671
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3672
						<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>
3673
					</p>
3674
				</div>
3675
		</div>
3676
		<?php
3677
	}
3678
3679
	/**
3680
	 * Returns the url that the user clicks to remove the notice for the big banner
3681
	 * @return string
3682
	 */
3683
	function opt_out_jetpack_manage_url() {
3684
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3685
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3686
	}
3687
	/**
3688
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3689
	 * @return string
3690
	 */
3691
	function opt_in_jetpack_manage_url() {
3692
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3693
	}
3694
3695
	function opt_in_jetpack_manage_notice() {
3696
		?>
3697
		<div class="wrap">
3698
			<div id="message" class="jetpack-message is-opt-in">
3699
				<?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' ); ?>
3700
			</div>
3701
		</div>
3702
		<?php
3703
3704
	}
3705
	/**
3706
	 * Determines whether to show the notice of not true = display notice
3707
	 * @return bool
3708
	 */
3709
	function can_display_jetpack_manage_notice() {
3710
		// never display the notice to users that can't do anything about it anyways
3711
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3712
			return false;
3713
3714
		// don't display if we are in development more
3715
		if( Jetpack::is_development_mode() ) {
3716
			return false;
3717
		}
3718
		// don't display if the site is private
3719
		if(  ! Jetpack_Options::get_option( 'public' ) )
3720
			return false;
3721
3722
		/**
3723
		 * Should the Jetpack Remote Site Management notice be displayed.
3724
		 *
3725
		 * @since 3.3.0
3726
		 *
3727
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3728
		 */
3729
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3730
	}
3731
3732
	/*
3733
	 * Registration flow:
3734
	 * 1 - ::admin_page_load() action=register
3735
	 * 2 - ::try_registration()
3736
	 * 3 - ::register()
3737
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3738
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3739
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3740
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3741
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3742
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3743
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3744
	 *       jetpack_id, jetpack_secret, jetpack_public
3745
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3746
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3747
	 * 5 - user logs in with WP.com account
3748
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3749
	 *		- Jetpack_Client_Server::authorize()
3750
	 *		- Jetpack_Client_Server::get_token()
3751
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3752
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3753
	 *			- which responds with access_token, token_type, scope
3754
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3755
	 *		- Jetpack::activate_default_modules()
3756
	 *     		- Deactivates deprecated plugins
3757
	 *     		- Activates all default modules
3758
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3759
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3760
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3761
	 *     Done!
3762
	 */
3763
3764
	/**
3765
	 * Handles the page load events for the Jetpack admin page
3766
	 */
3767
	function admin_page_load() {
3768
		$error = false;
3769
3770
		// Make sure we have the right body class to hook stylings for subpages off of.
3771
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3772
3773
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3774
			// Should only be used in intermediate redirects to preserve state across redirects
3775
			Jetpack::restate();
3776
		}
3777
3778
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3779
			// User clicked in the iframe to link their accounts
3780
			if ( ! Jetpack::is_user_connected() ) {
3781
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3782
				if ( isset( $_GET['notes_iframe'] ) )
3783
					$connect_url .= '&notes_iframe';
3784
				wp_redirect( $connect_url );
3785
				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...
3786
			} else {
3787
				if ( ! isset( $_GET['calypso_env'] ) ) {
3788
					Jetpack::state( 'message', 'already_authorized' );
3789
					wp_safe_redirect( Jetpack::admin_url() );
3790
				} else {
3791
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3792
					$connect_url .= '&already_authorized=true';
3793
					wp_redirect( $connect_url );
3794
				}
3795
			}
3796
		}
3797
3798
3799
		if ( isset( $_GET['action'] ) ) {
3800
			switch ( $_GET['action'] ) {
3801
			case 'authorize':
3802
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3803
					Jetpack::state( 'message', 'already_authorized' );
3804
					wp_safe_redirect( Jetpack::admin_url() );
3805
					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...
3806
				}
3807
				Jetpack::log( 'authorize' );
3808
				$client_server = new Jetpack_Client_Server;
3809
				$client_server->client_authorize();
3810
				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...
3811
			case 'register' :
3812
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3813
					$error = 'cheatin';
3814
					break;
3815
				}
3816
				check_admin_referer( 'jetpack-register' );
3817
				Jetpack::log( 'register' );
3818
				Jetpack::maybe_set_version_option();
3819
				$registered = Jetpack::try_registration();
3820
				if ( is_wp_error( $registered ) ) {
3821
					$error = $registered->get_error_code();
3822
					Jetpack::state( 'error', $error );
3823
					Jetpack::state( 'error', $registered->get_error_message() );
3824
					break;
3825
				}
3826
3827
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3828
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3829
3830
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3831
				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...
3832
			case 'activate' :
3833
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3834
					$error = 'cheatin';
3835
					break;
3836
				}
3837
3838
				$module = stripslashes( $_GET['module'] );
3839
				check_admin_referer( "jetpack_activate-$module" );
3840
				Jetpack::log( 'activate', $module );
3841
				Jetpack::activate_module( $module );
3842
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3843
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3844
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

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

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
6522
				array( __CLASS__, 'dashboard_widget' )
6523
			);
6524
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6525
6526
			// If we're inactive and not in development mode, sort our box to the top.
6527
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6528
				global $wp_meta_boxes;
6529
6530
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6531
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6532
6533
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6534
			}
6535
		}
6536
	}
6537
6538
	/**
6539
	 * @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...
6540
	 * @return mixed
6541
	 */
6542
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6543
		if ( ! is_array( $sorted ) ) {
6544
			return $sorted;
6545
		}
6546
6547
		foreach ( $sorted as $box_context => $ids ) {
6548
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6549
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6550
				continue;
6551
			}
6552
6553
			$ids_array = explode( ',', $ids );
6554
			$key = array_search( 'dashboard_stats', $ids_array );
6555
6556
			if ( false !== $key ) {
6557
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6558
				$ids_array[ $key ] = 'jetpack_summary_widget';
6559
				$sorted[ $box_context ] = implode( ',', $ids_array );
6560
				// We've found it, stop searching, and just return.
6561
				break;
6562
			}
6563
		}
6564
6565
		return $sorted;
6566
	}
6567
6568
	public static function dashboard_widget() {
6569
		/**
6570
		 * Fires when the dashboard is loaded.
6571
		 *
6572
		 * @since 3.4.0
6573
		 */
6574
		do_action( 'jetpack_dashboard_widget' );
6575
	}
6576
6577
	public static function dashboard_widget_footer() {
6578
		?>
6579
		<footer>
6580
6581
		<div class="protect">
6582
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6583
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6584
				<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>
6585
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6586
				<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' ); ?>">
6587
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6588
				</a>
6589
			<?php else : ?>
6590
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6591
			<?php endif; ?>
6592
		</div>
6593
6594
		<div class="akismet">
6595
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6596
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6597
				<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>
6598
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6599
				<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">
6600
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6601
				</a>
6602
			<?php else : ?>
6603
				<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>
6604
			<?php endif; ?>
6605
		</div>
6606
6607
		</footer>
6608
		<?php
6609
	}
6610
6611
	/**
6612
	 * Return string containing the Jetpack logo.
6613
	 *
6614
	 * @since 3.9.0
6615
	 *
6616
	 * @return string
6617
	 */
6618
	public static function get_jp_emblem() {
6619
		return '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0" y="0" width="20" height="20" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve"><path d="M86.4 0C38.7 0 0 38.7 0 86.4c0 47.7 38.7 86.4 86.4 86.4s86.4-38.7 86.4-86.4C172.9 38.7 134.2 0 86.4 0zM83.1 106.6l-27.1-6.9C49 98 45.7 90.1 49.3 84l33.8-58.5V106.6zM124.9 88.9l-33.8 58.5V66.3l27.1 6.9C125.1 74.9 128.4 82.8 124.9 88.9z" /></svg>';
6620
	}
6621
6622
	/*
6623
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6624
	 */
6625
	function jetpack_icon_user_connected( $columns ) {
6626
		$columns['user_jetpack'] = '';
6627
		return $columns;
6628
	}
6629
6630
	/*
6631
	 * Show Jetpack icon if the user is linked.
6632
	 */
6633
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6634
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6635
			$emblem_html = sprintf(
6636
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6637
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6638
				Jetpack::get_jp_emblem()
6639
			);
6640
			return $emblem_html;
6641
		}
6642
6643
		return $val;
6644
	}
6645
6646
	/*
6647
	 * Style the Jetpack user column
6648
	 */
6649
	function jetpack_user_col_style() {
6650
		global $current_screen;
6651
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6652
			<style>
6653
				.fixed .column-user_jetpack {
6654
					width: 21px;
6655
				}
6656
				.jp-emblem-user-admin svg {
6657
					width: 20px;
6658
					height: 20px;
6659
				}
6660
				.jp-emblem-user-admin path {
6661
					fill: #8cc258;
6662
				}
6663
			</style>
6664
		<?php }
6665
	}
6666
6667
	/**
6668
	 * Checks if Akismet is active and working.
6669
	 *
6670
	 * @since  5.1.0
6671
	 * @return bool True = Akismet available. False = Aksimet not available.
6672
	 */
6673
	public static function is_akismet_active() {
6674
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6675
			return true;
6676
		}
6677
		return false;
6678
	}
6679
6680
	/**
6681
	 * Checks if one or more function names is in debug_backtrace
6682
	 *
6683
	 * @param $names Mixed string name of function or array of string names of functions
6684
	 *
6685
	 * @return bool
6686
	 */
6687
	public static function is_function_in_backtrace( $names ) {
6688
		$backtrace = debug_backtrace( false );
6689
		if ( ! is_array( $names ) ) {
6690
			$names = array( $names );
6691
		}
6692
		$names_as_keys = array_flip( $names );
6693
6694
		//Do check in constant O(1) time for PHP5.5+
6695
		if ( function_exists( 'array_column' ) ) {
6696
			$backtrace_functions = array_column( $backtrace, 'function' );
6697
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6698
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6699
			return ! empty ( $intersection );
6700
		}
6701
6702
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6703
		foreach ( $backtrace as $call ) {
6704
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6705
				return true;
6706
			}
6707
		}
6708
		return false;
6709
	}
6710
}
6711