Completed
Push — kraftbj-patch-2 ( 82c983...ae9d16 )
by
unknown
513:58 queued 503:20
created

Jetpack::get_file_data()   D

Complexity

Conditions 9
Paths 9

Size

Total Lines 37
Code Lines 18

Duplication

Lines 0
Ratio 0 %

Importance

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

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $args is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
692
		switch( $cap ) {
693
			case 'jetpack_connect' :
694
			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...
695
				if ( Jetpack::is_development_mode() ) {
696
					$caps = array( 'do_not_allow' );
697
					break;
698
				}
699
				/**
700
				 * Pass through. If it's not development mode, these should match disconnect.
701
				 * Let users disconnect if it's development mode, just in case things glitch.
702
				 */
703
			case 'jetpack_disconnect' :
704
				/**
705
				 * In multisite, can individual site admins manage their own connection?
706
				 *
707
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
708
				 */
709
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
710
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
711
						/**
712
						 * We need to update the option name -- it's terribly unclear which
713
						 * direction the override goes.
714
						 *
715
						 * @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...
716
						 */
717
						$caps = array( 'do_not_allow' );
718
						break;
719
					}
720
				}
721
722
				$caps = array( 'manage_options' );
723
				break;
724
			case 'jetpack_manage_modules' :
725
			case 'jetpack_activate_modules' :
726
			case 'jetpack_deactivate_modules' :
727
				$caps = array( 'manage_options' );
728
				break;
729
			case 'jetpack_configure_modules' :
730
				$caps = array( 'manage_options' );
731
				break;
732
			case 'jetpack_network_admin_page':
733
			case 'jetpack_network_settings_page':
734
				$caps = array( 'manage_network_plugins' );
735
				break;
736
			case 'jetpack_network_sites_page':
737
				$caps = array( 'manage_sites' );
738
				break;
739
			case 'jetpack_admin_page' :
740
				if ( Jetpack::is_development_mode() ) {
741
					$caps = array( 'manage_options' );
742
					break;
743
				} else {
744
					$caps = array( 'read' );
745
				}
746
				break;
747
			case 'jetpack_connect_user' :
748
				if ( Jetpack::is_development_mode() ) {
749
					$caps = array( 'do_not_allow' );
750
					break;
751
				}
752
				$caps = array( 'read' );
753
				break;
754
		}
755
		return $caps;
756
	}
757
758
	function require_jetpack_authentication() {
759
		// Don't let anyone authenticate
760
		$_COOKIE = array();
761
		remove_all_filters( 'authenticate' );
762
		remove_all_actions( 'wp_login_failed' );
763
764
		if ( Jetpack::is_active() ) {
765
			// Allow Jetpack authentication
766
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
767
		}
768
	}
769
770
	/**
771
	 * Load language files
772
	 * @action plugins_loaded
773
	 */
774
	public static function plugin_textdomain() {
775
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
776
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
777
	}
778
779
	/**
780
	 * Register assets for use in various modules and the Jetpack admin page.
781
	 *
782
	 * @uses wp_script_is, wp_register_script, plugins_url
783
	 * @action wp_loaded
784
	 * @return null
785
	 */
786
	public function register_assets() {
787
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
788
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
789
		}
790
791 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
792
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
793
		}
794
795 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
796
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
797
		}
798
799 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
800
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
801
		}
802
803
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
804
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
805
806
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
807
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
808
			if ( ! is_numeric( $fb_app_id ) ) {
809
				$fb_app_id = '';
810
			}
811
			wp_localize_script(
812
				'jetpack-facebook-embed',
813
				'jpfbembed',
814
				array(
815
					'appid' => $fb_app_id,
816
					'locale' => $this->get_locale(),
817
				)
818
			);
819
		}
820
821
		/**
822
		 * As jetpack_register_genericons is by default fired off a hook,
823
		 * the hook may have already fired by this point.
824
		 * So, let's just trigger it manually.
825
		 */
826
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
827
		jetpack_register_genericons();
828
829
		/**
830
		 * Register the social logos
831
		 */
832
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
833
		jetpack_register_social_logos();
834
835 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
836
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
837
	}
838
839
	/**
840
	 * Guess locale from language code.
841
	 *
842
	 * @param string $lang Language code.
843
	 * @return string|bool
844
	 */
845 View Code Duplication
	function guess_locale_from_lang( $lang ) {
846
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
847
			return 'en_US';
848
		}
849
850
		if ( ! class_exists( 'GP_Locales' ) ) {
851
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
852
				return false;
853
			}
854
855
			require JETPACK__GLOTPRESS_LOCALES_PATH;
856
		}
857
858
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
859
			// WP.com: get_locale() returns 'it'
860
			$locale = GP_Locales::by_slug( $lang );
861
		} else {
862
			// Jetpack: get_locale() returns 'it_IT';
863
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
864
		}
865
866
		if ( ! $locale ) {
867
			return false;
868
		}
869
870
		if ( empty( $locale->facebook_locale ) ) {
871
			if ( empty( $locale->wp_locale ) ) {
872
				return false;
873
			} else {
874
				// Facebook SDK is smart enough to fall back to en_US if a
875
				// locale isn't supported. Since supported Facebook locales
876
				// can fall out of sync, we'll attempt to use the known
877
				// wp_locale value and rely on said fallback.
878
				return $locale->wp_locale;
879
			}
880
		}
881
882
		return $locale->facebook_locale;
883
	}
884
885
	/**
886
	 * Get the locale.
887
	 *
888
	 * @return string|bool
889
	 */
890
	function get_locale() {
891
		$locale = $this->guess_locale_from_lang( get_locale() );
892
893
		if ( ! $locale ) {
894
			$locale = 'en_US';
895
		}
896
897
		return $locale;
898
	}
899
900
	/**
901
	 * Device Pixels support
902
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
903
	 */
904
	function devicepx() {
905
		if ( Jetpack::is_active() ) {
906
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
907
		}
908
	}
909
910
	/**
911
	 * Return the network_site_url so that .com knows what network this site is a part of.
912
	 * @param  bool $option
913
	 * @return string
914
	 */
915
	public function jetpack_main_network_site_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
916
		return network_site_url();
917
	}
918
	/**
919
	 * Network Name.
920
	 */
921
	static function network_name( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
922
		global $current_site;
923
		return $current_site->site_name;
924
	}
925
	/**
926
	 * Does the network allow new user and site registrations.
927
	 * @return string
928
	 */
929
	static function network_allow_new_registrations( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
930
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
931
	}
932
	/**
933
	 * Does the network allow admins to add new users.
934
	 * @return boolian
935
	 */
936
	static function network_add_new_users( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
937
		return (bool) get_site_option( 'add_new_users' );
938
	}
939
	/**
940
	 * File upload psace left per site in MB.
941
	 *  -1 means NO LIMIT.
942
	 * @return number
943
	 */
944
	static function network_site_upload_space( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
945
		// value in MB
946
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
947
	}
948
949
	/**
950
	 * Network allowed file types.
951
	 * @return string
952
	 */
953
	static function network_upload_file_types( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
954
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
955
	}
956
957
	/**
958
	 * Maximum file upload size set by the network.
959
	 * @return number
960
	 */
961
	static function network_max_upload_file_size( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
962
		// value in KB
963
		return get_site_option( 'fileupload_maxk', 300 );
964
	}
965
966
	/**
967
	 * Lets us know if a site allows admins to manage the network.
968
	 * @return array
969
	 */
970
	static function network_enable_administration_menus( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
971
		return get_site_option( 'menu_items' );
972
	}
973
974
	/**
975
	 * If a user has been promoted to or demoted from admin, we need to clear the
976
	 * jetpack_other_linked_admins transient.
977
	 *
978
	 * @since 4.3.2
979
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
980
	 *
981
	 * @param int    $user_id   The user ID whose role changed.
982
	 * @param string $role      The new role.
983
	 * @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...
984
	 */
985
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
986
		if ( 'administrator' == $role
987
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
988
			|| is_null( $old_roles )
989
		) {
990
			delete_transient( 'jetpack_other_linked_admins' );
991
		}
992
	}
993
994
	/**
995
	 * Checks to see if there are any other users available to become primary
996
	 * Users must both:
997
	 * - Be linked to wpcom
998
	 * - Be an admin
999
	 *
1000
	 * @return mixed False if no other users are linked, Int if there are.
1001
	 */
1002
	static function get_other_linked_admins() {
1003
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1004
1005
		if ( false === $other_linked_users ) {
1006
			$admins = get_users( array( 'role' => 'administrator' ) );
1007
			if ( count( $admins ) > 1 ) {
1008
				$available = array();
1009
				foreach ( $admins as $admin ) {
1010
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1011
						$available[] = $admin->ID;
1012
					}
1013
				}
1014
1015
				$count_connected_admins = count( $available );
1016
				if ( count( $available ) > 1 ) {
1017
					$other_linked_users = $count_connected_admins;
1018
				} else {
1019
					$other_linked_users = 0;
1020
				}
1021
			} else {
1022
				$other_linked_users = 0;
1023
			}
1024
1025
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1026
		}
1027
1028
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1029
	}
1030
1031
	/**
1032
	 * Return whether we are dealing with a multi network setup or not.
1033
	 * The reason we are type casting this is because we want to avoid the situation where
1034
	 * the result is false since when is_main_network_option return false it cases
1035
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1036
	 * database which could be set to anything as opposed to what this function returns.
1037
	 * @param  bool  $option
1038
	 *
1039
	 * @return boolean
1040
	 */
1041
	public function is_main_network_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1042
		// return '1' or ''
1043
		return (string) (bool) Jetpack::is_multi_network();
1044
	}
1045
1046
	/**
1047
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1048
	 *
1049
	 * @param  string  $option
1050
	 * @return boolean
1051
	 */
1052
	public function is_multisite( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

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

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $plugin_file is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $args is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1826
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1827
	}
1828
1829
/* Jetpack Options API */
1830
1831
	public static function get_option_names( $type = 'compact' ) {
1832
		return Jetpack_Options::get_option_names( $type );
1833
	}
1834
1835
	/**
1836
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1837
 	 *
1838
	 * @param string $name    Option name
1839
	 * @param mixed  $default (optional)
1840
	 */
1841
	public static function get_option( $name, $default = false ) {
1842
		return Jetpack_Options::get_option( $name, $default );
1843
	}
1844
1845
	/**
1846
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1847
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1848
	* $name must be a registered option name.
1849
	*/
1850
	public static function create_nonce( $name ) {
1851
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1852
1853
		Jetpack_Options::update_option( $name, $secret );
1854
		@list( $secret_1, $secret_2, $eol ) = explode( ':', Jetpack_Options::get_option( $name ) );
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...
1855
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1856
			return new Jetpack_Error( 'missing_secrets' );
1857
1858
		return array(
1859
			'secret_1' => $secret_1,
1860
			'secret_2' => $secret_2,
1861
			'eol'      => $eol,
1862
		);
1863
	}
1864
1865
	/**
1866
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1867
 	 *
1868
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1869
	 * @param string $name  Option name
1870
	 * @param mixed  $value Option value
1871
	 */
1872
	public static function update_option( $name, $value ) {
1873
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1874
		return Jetpack_Options::update_option( $name, $value );
1875
	}
1876
1877
	/**
1878
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1879
 	 *
1880
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1881
	 * @param array $array array( option name => option value, ... )
1882
	 */
1883
	public static function update_options( $array ) {
1884
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1885
		return Jetpack_Options::update_options( $array );
1886
	}
1887
1888
	/**
1889
	 * Deletes the given option.  May be passed multiple option names as an array.
1890
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1891
	 *
1892
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1893
	 * @param string|array $names
1894
	 */
1895
	public static function delete_option( $names ) {
1896
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1897
		return Jetpack_Options::delete_option( $names );
1898
	}
1899
1900
	/**
1901
	 * Enters a user token into the user_tokens option
1902
	 *
1903
	 * @param int $user_id
1904
	 * @param string $token
1905
	 * return bool
1906
	 */
1907
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1908
		// not designed for concurrent updates
1909
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1910
		if ( ! is_array( $user_tokens ) )
1911
			$user_tokens = array();
1912
		$user_tokens[$user_id] = $token;
1913
		if ( $is_master_user ) {
1914
			$master_user = $user_id;
1915
			$options     = compact( 'user_tokens', 'master_user' );
1916
		} else {
1917
			$options = compact( 'user_tokens' );
1918
		}
1919
		return Jetpack_Options::update_options( $options );
1920
	}
1921
1922
	/**
1923
	 * Returns an array of all PHP files in the specified absolute path.
1924
	 * Equivalent to glob( "$absolute_path/*.php" ).
1925
	 *
1926
	 * @param string $absolute_path The absolute path of the directory to search.
1927
	 * @return array Array of absolute paths to the PHP files.
1928
	 */
1929
	public static function glob_php( $absolute_path ) {
1930
		if ( function_exists( 'glob' ) ) {
1931
			return glob( "$absolute_path/*.php" );
1932
		}
1933
1934
		$absolute_path = untrailingslashit( $absolute_path );
1935
		$files = array();
1936
		if ( ! $dir = @opendir( $absolute_path ) ) {
1937
			return $files;
1938
		}
1939
1940
		while ( false !== $file = readdir( $dir ) ) {
1941
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1942
				continue;
1943
			}
1944
1945
			$file = "$absolute_path/$file";
1946
1947
			if ( ! is_file( $file ) ) {
1948
				continue;
1949
			}
1950
1951
			$files[] = $file;
1952
		}
1953
1954
		closedir( $dir );
1955
1956
		return $files;
1957
	}
1958
1959
	public static function activate_new_modules( $redirect = false ) {
1960
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1961
			return;
1962
		}
1963
1964
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1965 View Code Duplication
		if ( ! $jetpack_old_version ) {
1966
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1967
			/** This action is documented in class.jetpack.php */
1968
			do_action( 'updating_jetpack_version', $version, false );
1969
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1970
		}
1971
1972
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1973
1974
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1975
			return;
1976
		}
1977
1978
		$active_modules     = Jetpack::get_active_modules();
1979
		$reactivate_modules = array();
1980
		foreach ( $active_modules as $active_module ) {
1981
			$module = Jetpack::get_module( $active_module );
1982
			if ( ! isset( $module['changed'] ) ) {
1983
				continue;
1984
			}
1985
1986
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1987
				continue;
1988
			}
1989
1990
			$reactivate_modules[] = $active_module;
1991
			Jetpack::deactivate_module( $active_module );
1992
		}
1993
1994
		$new_version = JETPACK__VERSION . ':' . time();
1995
		/** This action is documented in class.jetpack.php */
1996
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1997
		Jetpack_Options::update_options(
1998
			array(
1999
				'version'     => $new_version,
2000
				'old_version' => $jetpack_old_version,
2001
			)
2002
		);
2003
2004
		Jetpack::state( 'message', 'modules_activated' );
2005
		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...
2006
2007
		if ( $redirect ) {
2008
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2009
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2010
				$page = $_GET['page'];
2011
			}
2012
2013
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2014
			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...
2015
		}
2016
	}
2017
2018
	/**
2019
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2020
	 * Make sure to tuck away module "library" files in a sub-directory.
2021
	 */
2022
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2023
		static $modules = null;
2024
2025
		if ( ! isset( $modules ) ) {
2026
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2027
			// Use the cache if we're on the front-end and it's available...
2028
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2029
				$modules = $available_modules_option[ JETPACK__VERSION ];
2030
			} else {
2031
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2032
2033
				$modules = array();
2034
2035
				foreach ( $files as $file ) {
2036
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2037
						continue;
2038
					}
2039
2040
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2041
				}
2042
2043
				Jetpack_Options::update_option( 'available_modules', array(
2044
					JETPACK__VERSION => $modules,
2045
				) );
2046
			}
2047
		}
2048
2049
		/**
2050
		 * Filters the array of modules available to be activated.
2051
		 *
2052
		 * @since 2.4.0
2053
		 *
2054
		 * @param array $modules Array of available modules.
2055
		 * @param string $min_version Minimum version number required to use modules.
2056
		 * @param string $max_version Maximum version number required to use modules.
2057
		 */
2058
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2059
2060
		if ( ! $min_version && ! $max_version ) {
2061
			return array_keys( $mods );
2062
		}
2063
2064
		$r = array();
2065
		foreach ( $mods as $slug => $introduced ) {
2066
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2067
				continue;
2068
			}
2069
2070
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2071
				continue;
2072
			}
2073
2074
			$r[] = $slug;
2075
		}
2076
2077
		return $r;
2078
	}
2079
2080
	/**
2081
	 * Default modules loaded on activation.
2082
	 */
2083
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2084
		$return = array();
2085
2086
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2087
			$module_data = Jetpack::get_module( $module );
2088
2089
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2090
				case 'yes' :
2091
					$return[] = $module;
2092
					break;
2093
				case 'public' :
2094
					if ( Jetpack_Options::get_option( 'public' ) ) {
2095
						$return[] = $module;
2096
					}
2097
					break;
2098
				case 'no' :
2099
				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...
2100
					break;
2101
			}
2102
		}
2103
		/**
2104
		 * Filters the array of default modules.
2105
		 *
2106
		 * @since 2.5.0
2107
		 *
2108
		 * @param array $return Array of default modules.
2109
		 * @param string $min_version Minimum version number required to use modules.
2110
		 * @param string $max_version Maximum version number required to use modules.
2111
		 */
2112
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2113
	}
2114
2115
	/**
2116
	 * Checks activated modules during auto-activation to determine
2117
	 * if any of those modules are being deprecated.  If so, close
2118
	 * them out, and add any replacement modules.
2119
	 *
2120
	 * Runs at priority 99 by default.
2121
	 *
2122
	 * This is run late, so that it can still activate a module if
2123
	 * the new module is a replacement for another that the user
2124
	 * currently has active, even if something at the normal priority
2125
	 * would kibosh everything.
2126
	 *
2127
	 * @since 2.6
2128
	 * @uses jetpack_get_default_modules filter
2129
	 * @param array $modules
2130
	 * @return array
2131
	 */
2132
	function handle_deprecated_modules( $modules ) {
2133
		$deprecated_modules = array(
2134
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2135
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2136
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2137
		);
2138
2139
		// Don't activate SSO if they never completed activating WPCC.
2140
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2141
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2142
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2143
				$deprecated_modules['wpcc'] = null;
2144
			}
2145
		}
2146
2147
		foreach ( $deprecated_modules as $module => $replacement ) {
2148
			if ( Jetpack::is_module_active( $module ) ) {
2149
				self::deactivate_module( $module );
2150
				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...
2151
					$modules[] = $replacement;
2152
				}
2153
			}
2154
		}
2155
2156
		return array_unique( $modules );
2157
	}
2158
2159
	/**
2160
	 * Checks activated plugins during auto-activation to determine
2161
	 * if any of those plugins are in the list with a corresponding module
2162
	 * that is not compatible with the plugin. The module will not be allowed
2163
	 * to auto-activate.
2164
	 *
2165
	 * @since 2.6
2166
	 * @uses jetpack_get_default_modules filter
2167
	 * @param array $modules
2168
	 * @return array
2169
	 */
2170
	function filter_default_modules( $modules ) {
2171
2172
		$active_plugins = self::get_active_plugins();
2173
2174
		if ( ! empty( $active_plugins ) ) {
2175
2176
			// For each module we'd like to auto-activate...
2177
			foreach ( $modules as $key => $module ) {
2178
				// If there are potential conflicts for it...
2179
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2180
					// For each potential conflict...
2181
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2182
						// If that conflicting plugin is active...
2183
						if ( in_array( $plugin, $active_plugins ) ) {
2184
							// Remove that item from being auto-activated.
2185
							unset( $modules[ $key ] );
2186
						}
2187
					}
2188
				}
2189
			}
2190
		}
2191
2192
		return $modules;
2193
	}
2194
2195
	/**
2196
	 * Extract a module's slug from its full path.
2197
	 */
2198
	public static function get_module_slug( $file ) {
2199
		return str_replace( '.php', '', basename( $file ) );
2200
	}
2201
2202
	/**
2203
	 * Generate a module's path from its slug.
2204
	 */
2205
	public static function get_module_path( $slug ) {
2206
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2207
	}
2208
2209
	/**
2210
	 * Load module data from module file. Headers differ from WordPress
2211
	 * plugin headers to avoid them being identified as standalone
2212
	 * plugins on the WordPress plugins page.
2213
	 */
2214
	public static function get_module( $module ) {
2215
		$headers = array(
2216
			'name'                      => 'Module Name',
2217
			'description'               => 'Module Description',
2218
			'jumpstart_desc'            => 'Jumpstart Description',
2219
			'sort'                      => 'Sort Order',
2220
			'recommendation_order'      => 'Recommendation Order',
2221
			'introduced'                => 'First Introduced',
2222
			'changed'                   => 'Major Changes In',
2223
			'deactivate'                => 'Deactivate',
2224
			'free'                      => 'Free',
2225
			'requires_connection'       => 'Requires Connection',
2226
			'auto_activate'             => 'Auto Activate',
2227
			'module_tags'               => 'Module Tags',
2228
			'feature'                   => 'Feature',
2229
			'additional_search_queries' => 'Additional Search Queries',
2230
		);
2231
2232
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2233
2234
		$mod = Jetpack::get_file_data( $file, $headers );
2235
		if ( empty( $mod['name'] ) ) {
2236
			return false;
2237
		}
2238
2239
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2240
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2241
		$mod['deactivate']              = empty( $mod['deactivate'] );
2242
		$mod['free']                    = empty( $mod['free'] );
2243
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2244
2245
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2246
			$mod['auto_activate'] = 'No';
2247
		} else {
2248
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2249
		}
2250
2251
		if ( $mod['module_tags'] ) {
2252
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2253
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2254
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2255
		} else {
2256
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2257
		}
2258
2259
		if ( $mod['feature'] ) {
2260
			$mod['feature'] = explode( ',', $mod['feature'] );
2261
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2262
		} else {
2263
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2264
		}
2265
2266
		/**
2267
		 * Filters the feature array on a module.
2268
		 *
2269
		 * This filter allows you to control where each module is filtered: Recommended,
2270
		 * Jumpstart, and the default "Other" listing.
2271
		 *
2272
		 * @since 3.5.0
2273
		 *
2274
		 * @param array   $mod['feature'] The areas to feature this module:
2275
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2276
		 *     'Recommended' shows on the main Jetpack admin screen.
2277
		 *     'Other' should be the default if no other value is in the array.
2278
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2279
		 * @param array   $mod All the currently assembled module data.
2280
		 */
2281
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2282
2283
		/**
2284
		 * Filter the returned data about a module.
2285
		 *
2286
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2287
		 * so please be careful.
2288
		 *
2289
		 * @since 3.6.0
2290
		 *
2291
		 * @param array   $mod    The details of the requested module.
2292
		 * @param string  $module The slug of the module, e.g. sharedaddy
2293
		 * @param string  $file   The path to the module source file.
2294
		 */
2295
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2296
	}
2297
2298
	/**
2299
	 * Like core's get_file_data implementation, but caches the result.
2300
	 */
2301
	public static function get_file_data( $file, $headers ) {
2302
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2303
		$file_name = basename( $file );
2304
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2305
		$key              = md5( $file_name . serialize( $headers ) );
2306
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2307
2308
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2309
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2310
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2311
		}
2312
2313
		$data = get_file_data( $file, $headers );
2314
2315
		// Strip out any old Jetpack versions that are cluttering the option.
2316
		//
2317
		// We maintain the data for the current version of Jetpack plus the previous version
2318
		// to prevent repeated DB hits on large sites hosted with multiple web servers
2319
		// on a single database (since all web servers might not be updated simultaneously)
2320
		
2321
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2322
		
2323
		if ( count( $file_data_option ) > 2 ) {
2324
			$count = 0;
2325
			krsort( $file_data_option );
2326
			foreach ( $file_data_option as $version => $values ) {
2327
				$count++;
2328
				if ( $count > 2 && JETPACK__VERSION != $version ) {
2329
					unset( $file_data_option[ $version ] );
2330
				}
2331
			}
2332
		}
2333
		
2334
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2335
2336
		return $data;
2337
	}
2338
	
2339
2340
	/**
2341
	 * Return translated module tag.
2342
	 *
2343
	 * @param string $tag Tag as it appears in each module heading.
2344
	 *
2345
	 * @return mixed
2346
	 */
2347
	public static function translate_module_tag( $tag ) {
2348
		return jetpack_get_module_i18n_tag( $tag );
2349
	}
2350
2351
	/**
2352
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2353
	 *
2354
	 * @since 3.9.2
2355
	 *
2356
	 * @param array $modules
2357
	 *
2358
	 * @return string|void
2359
	 */
2360
	public static function get_translated_modules( $modules ) {
2361
		foreach ( $modules as $index => $module ) {
2362
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2363
			if ( isset( $module['name'] ) ) {
2364
				$modules[ $index ]['name'] = $i18n_module['name'];
2365
			}
2366
			if ( isset( $module['description'] ) ) {
2367
				$modules[ $index ]['description'] = $i18n_module['description'];
2368
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2369
			}
2370
		}
2371
		return $modules;
2372
	}
2373
2374
	/**
2375
	 * Get a list of activated modules as an array of module slugs.
2376
	 */
2377
	public static function get_active_modules() {
2378
		$active = Jetpack_Options::get_option( 'active_modules' );
2379
2380
		if ( ! is_array( $active ) ) {
2381
			$active = array();
2382
		}
2383
2384
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2385
			$active[] = 'vaultpress';
2386
		} else {
2387
			$active = array_diff( $active, array( 'vaultpress' ) );
2388
		}
2389
2390
		//If protect is active on the main site of a multisite, it should be active on all sites.
2391
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2392
			$active[] = 'protect';
2393
		}
2394
2395
		return array_unique( $active );
2396
	}
2397
2398
	/**
2399
	 * Check whether or not a Jetpack module is active.
2400
	 *
2401
	 * @param string $module The slug of a Jetpack module.
2402
	 * @return bool
2403
	 *
2404
	 * @static
2405
	 */
2406
	public static function is_module_active( $module ) {
2407
		return in_array( $module, self::get_active_modules() );
2408
	}
2409
2410
	public static function is_module( $module ) {
2411
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2412
	}
2413
2414
	/**
2415
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2416
	 *
2417
	 * @param bool $catch True to start catching, False to stop.
2418
	 *
2419
	 * @static
2420
	 */
2421
	public static function catch_errors( $catch ) {
2422
		static $display_errors, $error_reporting;
2423
2424
		if ( $catch ) {
2425
			$display_errors  = @ini_set( 'display_errors', 1 );
2426
			$error_reporting = @error_reporting( E_ALL );
2427
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2428
		} else {
2429
			@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...
2430
			@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...
2431
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2432
		}
2433
	}
2434
2435
	/**
2436
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2437
	 */
2438
	public static function catch_errors_on_shutdown() {
2439
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2440
	}
2441
2442
	/**
2443
	 * Rewrite any string to make paths easier to read.
2444
	 *
2445
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2446
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2447
	 *
2448
	 * @param $string
2449
	 * @return mixed
2450
	 */
2451
	public static function alias_directories( $string ) {
2452
		// ABSPATH has a trailing slash.
2453
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2454
		// WP_CONTENT_DIR does not have a trailing slash.
2455
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2456
2457
		return $string;
2458
	}
2459
2460
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2461
		$jetpack = Jetpack::init();
2462
2463
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2464
		$modules = array_merge( $other_modules, $modules );
2465
2466
		// Look for standalone plugins and disable if active.
2467
2468
		$to_deactivate = array();
2469
		foreach ( $modules as $module ) {
2470
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2471
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2472
			}
2473
		}
2474
2475
		$deactivated = array();
2476
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2477
			list( $probable_file, $probable_title ) = $deactivate_me;
2478
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2479
				$deactivated[] = $module;
2480
			}
2481
		}
2482
2483
		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...
2484
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2485
2486
			$url = add_query_arg(
2487
				array(
2488
					'action'   => 'activate_default_modules',
2489
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2490
				),
2491
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2492
			);
2493
			wp_safe_redirect( $url );
2494
			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...
2495
		}
2496
2497
		/**
2498
		 * Fires before default modules are activated.
2499
		 *
2500
		 * @since 1.9.0
2501
		 *
2502
		 * @param string $min_version Minimum version number required to use modules.
2503
		 * @param string $max_version Maximum version number required to use modules.
2504
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2505
		 */
2506
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2507
2508
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2509
		Jetpack::restate();
2510
		Jetpack::catch_errors( true );
2511
2512
		$active = Jetpack::get_active_modules();
2513
2514
		foreach ( $modules as $module ) {
2515
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2516
				$active[] = $module;
2517
				self::update_active_modules( $active );
2518
				continue;
2519
			}
2520
2521
			if ( in_array( $module, $active ) ) {
2522
				$module_info = Jetpack::get_module( $module );
2523
				if ( ! $module_info['deactivate'] ) {
2524
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2525 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2526
						$active_state = explode( ',', $active_state );
2527
					} else {
2528
						$active_state = array();
2529
					}
2530
					$active_state[] = $module;
2531
					Jetpack::state( $state, implode( ',', $active_state ) );
2532
				}
2533
				continue;
2534
			}
2535
2536
			$file = Jetpack::get_module_path( $module );
2537
			if ( ! file_exists( $file ) ) {
2538
				continue;
2539
			}
2540
2541
			// we'll override this later if the plugin can be included without fatal error
2542
			if ( $redirect ) {
2543
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2544
			}
2545
			Jetpack::state( 'error', 'module_activation_failed' );
2546
			Jetpack::state( 'module', $module );
2547
			ob_start();
2548
			require $file;
2549
2550
			$active[] = $module;
2551
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2552 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2553
				$active_state = explode( ',', $active_state );
2554
			} else {
2555
				$active_state = array();
2556
			}
2557
			$active_state[] = $module;
2558
			Jetpack::state( $state, implode( ',', $active_state ) );
2559
			Jetpack::update_active_modules( $active );
2560
2561
			ob_end_clean();
2562
		}
2563
		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...
2564
		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...
2565
		Jetpack::catch_errors( false );
2566
		/**
2567
		 * Fires when default modules are activated.
2568
		 *
2569
		 * @since 1.9.0
2570
		 *
2571
		 * @param string $min_version Minimum version number required to use modules.
2572
		 * @param string $max_version Maximum version number required to use modules.
2573
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2574
		 */
2575
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2576
	}
2577
2578
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2579
		/**
2580
		 * Fires before a module is activated.
2581
		 *
2582
		 * @since 2.6.0
2583
		 *
2584
		 * @param string $module Module slug.
2585
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2586
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2587
		 */
2588
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2589
2590
		$jetpack = Jetpack::init();
2591
2592
		if ( ! strlen( $module ) )
2593
			return false;
2594
2595
		if ( ! Jetpack::is_module( $module ) )
2596
			return false;
2597
2598
		// If it's already active, then don't do it again
2599
		$active = Jetpack::get_active_modules();
2600
		foreach ( $active as $act ) {
2601
			if ( $act == $module )
2602
				return true;
2603
		}
2604
2605
		$module_data = Jetpack::get_module( $module );
2606
2607
		if ( ! Jetpack::is_active() ) {
2608
			if ( !Jetpack::is_development_mode() )
2609
				return false;
2610
2611
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2612
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2613
				return false;
2614
		}
2615
2616
		// Check and see if the old plugin is active
2617
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2618
			// Deactivate the old plugin
2619
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2620
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2621
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2622
				Jetpack::state( 'deactivated_plugins', $module );
2623
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2624
				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...
2625
			}
2626
		}
2627
2628
		// Protect won't work with mis-configured IPs
2629
		if ( 'protect' === $module ) {
2630
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2631
			if ( ! jetpack_protect_get_ip() ) {
2632
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2633
				return false;
2634
			}
2635
		}
2636
2637
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2638
		Jetpack::state( 'module', $module );
2639
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2640
2641
		Jetpack::catch_errors( true );
2642
		ob_start();
2643
		require Jetpack::get_module_path( $module );
2644
		/** This action is documented in class.jetpack.php */
2645
		do_action( 'jetpack_activate_module', $module );
2646
		$active[] = $module;
2647
		Jetpack::update_active_modules( $active );
2648
2649
		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...
2650
		ob_end_clean();
2651
		Jetpack::catch_errors( false );
2652
2653
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2654 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2655
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2656
2657
			//Jump start is being dismissed send data to MC Stats
2658
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2659
2660
			$jetpack->do_stats( 'server_side' );
2661
		}
2662
2663
		if ( $redirect ) {
2664
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2665
		}
2666
		if ( $exit ) {
2667
			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...
2668
		}
2669
		return true;
2670
	}
2671
2672
	function activate_module_actions( $module ) {
0 ignored issues
show
Unused Code introduced by
The parameter $module is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2673
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2674
	}
2675
2676
	public static function deactivate_module( $module ) {
2677
		/**
2678
		 * Fires when a module is deactivated.
2679
		 *
2680
		 * @since 1.9.0
2681
		 *
2682
		 * @param string $module Module slug.
2683
		 */
2684
		do_action( 'jetpack_pre_deactivate_module', $module );
2685
2686
		$jetpack = Jetpack::init();
2687
2688
		$active = Jetpack::get_active_modules();
2689
		$new    = array_filter( array_diff( $active, (array) $module ) );
2690
2691
		// A flag for Jump Start so it's not shown again.
2692 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2693
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2694
2695
			//Jump start is being dismissed send data to MC Stats
2696
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2697
2698
			$jetpack->do_stats( 'server_side' );
2699
		}
2700
2701
		return self::update_active_modules( $new );
2702
	}
2703
2704
	public static function enable_module_configurable( $module ) {
2705
		$module = Jetpack::get_module_slug( $module );
2706
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2707
	}
2708
2709
	public static function module_configuration_url( $module ) {
2710
		$module = Jetpack::get_module_slug( $module );
2711
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2712
	}
2713
2714
	public static function module_configuration_load( $module, $method ) {
2715
		$module = Jetpack::get_module_slug( $module );
2716
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2717
	}
2718
2719
	public static function module_configuration_head( $module, $method ) {
2720
		$module = Jetpack::get_module_slug( $module );
2721
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2722
	}
2723
2724
	public static function module_configuration_screen( $module, $method ) {
2725
		$module = Jetpack::get_module_slug( $module );
2726
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2727
	}
2728
2729
	public static function module_configuration_activation_screen( $module, $method ) {
2730
		$module = Jetpack::get_module_slug( $module );
2731
		add_action( 'display_activate_module_setting_' . $module, $method );
2732
	}
2733
2734
/* Installation */
2735
2736
	public static function bail_on_activation( $message, $deactivate = true ) {
2737
?>
2738
<!doctype html>
2739
<html>
2740
<head>
2741
<meta charset="<?php bloginfo( 'charset' ); ?>">
2742
<style>
2743
* {
2744
	text-align: center;
2745
	margin: 0;
2746
	padding: 0;
2747
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2748
}
2749
p {
2750
	margin-top: 1em;
2751
	font-size: 18px;
2752
}
2753
</style>
2754
<body>
2755
<p><?php echo esc_html( $message ); ?></p>
2756
</body>
2757
</html>
2758
<?php
2759
		if ( $deactivate ) {
2760
			$plugins = get_option( 'active_plugins' );
2761
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2762
			$update  = false;
2763
			foreach ( $plugins as $i => $plugin ) {
2764
				if ( $plugin === $jetpack ) {
2765
					$plugins[$i] = false;
2766
					$update = true;
2767
				}
2768
			}
2769
2770
			if ( $update ) {
2771
				update_option( 'active_plugins', array_filter( $plugins ) );
2772
			}
2773
		}
2774
		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...
2775
	}
2776
2777
	/**
2778
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2779
	 * @static
2780
	 */
2781
	public static function plugin_activation( $network_wide ) {
2782
		Jetpack_Options::update_option( 'activated', 1 );
2783
2784
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2785
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2786
		}
2787
2788
		if ( $network_wide )
2789
			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...
2790
2791
		// For firing one-off events (notices) immediately after activation
2792
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2793
2794
		Jetpack::plugin_initialize();
2795
	}
2796
	/**
2797
	 * Runs before bumping version numbers up to a new version
2798
	 * @param  (string) $version    Version:timestamp
2799
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2800
	 * @return null              [description]
2801
	 */
2802
	public static function do_version_bump( $version, $old_version ) {
2803
2804
		if ( ! $old_version ) { // For new sites
2805
			// Setting up jetpack manage
2806
			Jetpack::activate_manage();
2807
		}
2808
	}
2809
2810
	/**
2811
	 * Sets the internal version number and activation state.
2812
	 * @static
2813
	 */
2814
	public static function plugin_initialize() {
2815
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2816
			Jetpack_Options::update_option( 'activated', 2 );
2817
		}
2818
2819 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2820
			$version = $old_version = JETPACK__VERSION . ':' . time();
2821
			/** This action is documented in class.jetpack.php */
2822
			do_action( 'updating_jetpack_version', $version, false );
2823
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2824
		}
2825
2826
		Jetpack::load_modules();
2827
2828
		Jetpack_Options::delete_option( 'do_activate' );
2829
	}
2830
2831
	/**
2832
	 * Removes all connection options
2833
	 * @static
2834
	 */
2835
	public static function plugin_deactivation( ) {
2836
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2837
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2838
			Jetpack_Network::init()->deactivate();
2839
		} else {
2840
			Jetpack::disconnect( false );
2841
			//Jetpack_Heartbeat::init()->deactivate();
2842
		}
2843
	}
2844
2845
	/**
2846
	 * Disconnects from the Jetpack servers.
2847
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2848
	 * @static
2849
	 */
2850
	public static function disconnect( $update_activated_state = true ) {
2851
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2852
		Jetpack::clean_nonces( true );
2853
2854
		// If the site is in an IDC because sync is not allowed,
2855
		// let's make sure to not disconnect the production site.
2856
		if ( ! self::validate_sync_error_idc_option() ) {
2857
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2858
			Jetpack::load_xml_rpc_client();
2859
			$xml = new Jetpack_IXR_Client();
2860
			$xml->query( 'jetpack.deregister' );
2861
		}
2862
2863
		Jetpack_Options::delete_option(
2864
			array(
2865
				'register',
2866
				'blog_token',
2867
				'user_token',
2868
				'user_tokens',
2869
				'master_user',
2870
				'time_diff',
2871
				'fallback_no_verify_ssl_certs',
2872
			)
2873
		);
2874
2875
		Jetpack_IDC::clear_all_idc_options();
2876
2877
		if ( $update_activated_state ) {
2878
			Jetpack_Options::update_option( 'activated', 4 );
2879
		}
2880
2881
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2882
			// Check then record unique disconnection if site has never been disconnected previously
2883
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2884
				$jetpack_unique_connection['disconnected'] = 1;
2885
			} else {
2886
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2887
					//track unique disconnect
2888
					$jetpack = Jetpack::init();
2889
2890
					$jetpack->stat( 'connections', 'unique-disconnect' );
2891
					$jetpack->do_stats( 'server_side' );
2892
				}
2893
				// increment number of times disconnected
2894
				$jetpack_unique_connection['disconnected'] += 1;
2895
			}
2896
2897
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2898
		}
2899
2900
		// Delete cached connected user data
2901
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2902
		delete_transient( $transient_key );
2903
2904
		// Delete all the sync related data. Since it could be taking up space.
2905
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2906
		Jetpack_Sync_Sender::get_instance()->uninstall();
2907
2908
		// Disable the Heartbeat cron
2909
		Jetpack_Heartbeat::init()->deactivate();
2910
	}
2911
2912
	/**
2913
	 * Unlinks the current user from the linked WordPress.com user
2914
	 */
2915
	public static function unlink_user( $user_id = null ) {
2916
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2917
			return false;
2918
2919
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2920
2921
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2922
			return false;
2923
2924
		if ( ! isset( $tokens[ $user_id ] ) )
2925
			return false;
2926
2927
		Jetpack::load_xml_rpc_client();
2928
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2929
		$xml->query( 'jetpack.unlink_user', $user_id );
2930
2931
		unset( $tokens[ $user_id ] );
2932
2933
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2934
2935
		/**
2936
		 * Fires after the current user has been unlinked from WordPress.com.
2937
		 *
2938
		 * @since 4.1.0
2939
		 *
2940
		 * @param int $user_id The current user's ID.
2941
		 */
2942
		do_action( 'jetpack_unlinked_user', $user_id );
2943
2944
		return true;
2945
	}
2946
2947
	/**
2948
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2949
	 */
2950
	public static function try_registration() {
2951
		// Let's get some testing in beta versions and such.
2952
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2953
			// Before attempting to connect, let's make sure that the domains are viable.
2954
			$domains_to_check = array_unique( array(
2955
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2956
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2957
			) );
2958
			foreach ( $domains_to_check as $domain ) {
2959
				$result = Jetpack_Data::is_usable_domain( $domain );
2960
				if ( is_wp_error( $result ) ) {
2961
					return $result;
2962
				}
2963
			}
2964
		}
2965
2966
		$result = Jetpack::register();
2967
2968
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2969
		if ( ! $result || is_wp_error( $result ) ) {
2970
			return $result;
2971
		} else {
2972
			return true;
2973
		}
2974
	}
2975
2976
	/**
2977
	 * Tracking an internal event log. Try not to put too much chaff in here.
2978
	 *
2979
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2980
	 */
2981
	public static function log( $code, $data = null ) {
2982
		// only grab the latest 200 entries
2983
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2984
2985
		// Append our event to the log
2986
		$log_entry = array(
2987
			'time'    => time(),
2988
			'user_id' => get_current_user_id(),
2989
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2990
			'code'    => $code,
2991
		);
2992
		// Don't bother storing it unless we've got some.
2993
		if ( ! is_null( $data ) ) {
2994
			$log_entry['data'] = $data;
2995
		}
2996
		$log[] = $log_entry;
2997
2998
		// Try add_option first, to make sure it's not autoloaded.
2999
		// @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...
3000
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3001
			Jetpack_Options::update_option( 'log', $log );
3002
		}
3003
3004
		/**
3005
		 * Fires when Jetpack logs an internal event.
3006
		 *
3007
		 * @since 3.0.0
3008
		 *
3009
		 * @param array $log_entry {
3010
		 *	Array of details about the log entry.
3011
		 *
3012
		 *	@param string time Time of the event.
3013
		 *	@param int user_id ID of the user who trigerred the event.
3014
		 *	@param int blog_id Jetpack Blog ID.
3015
		 *	@param string code Unique name for the event.
3016
		 *	@param string data Data about the event.
3017
		 * }
3018
		 */
3019
		do_action( 'jetpack_log_entry', $log_entry );
3020
	}
3021
3022
	/**
3023
	 * Get the internal event log.
3024
	 *
3025
	 * @param $event (string) - only return the specific log events
3026
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3027
	 *
3028
	 * @return array of log events || WP_Error for invalid params
3029
	 */
3030
	public static function get_log( $event = false, $num = false ) {
3031
		if ( $event && ! is_string( $event ) ) {
3032
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3033
		}
3034
3035
		if ( $num && ! is_numeric( $num ) ) {
3036
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3037
		}
3038
3039
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3040
3041
		// If nothing set - act as it did before, otherwise let's start customizing the output
3042
		if ( ! $num && ! $event ) {
3043
			return $entire_log;
3044
		} else {
3045
			$entire_log = array_reverse( $entire_log );
3046
		}
3047
3048
		$custom_log_output = array();
3049
3050
		if ( $event ) {
3051
			foreach ( $entire_log as $log_event ) {
3052
				if ( $event == $log_event[ 'code' ] ) {
3053
					$custom_log_output[] = $log_event;
3054
				}
3055
			}
3056
		} else {
3057
			$custom_log_output = $entire_log;
3058
		}
3059
3060
		if ( $num ) {
3061
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3062
		}
3063
3064
		return $custom_log_output;
3065
	}
3066
3067
	/**
3068
	 * Log modification of important settings.
3069
	 */
3070
	public static function log_settings_change( $option, $old_value, $value ) {
0 ignored issues
show
Unused Code introduced by
The parameter $old_value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3071
		switch( $option ) {
3072
			case 'jetpack_sync_non_public_post_stati':
3073
				self::log( $option, $value );
3074
				break;
3075
		}
3076
	}
3077
3078
	/**
3079
	 * Return stat data for WPCOM sync
3080
	 */
3081
	public static function get_stat_data( $encode = true, $extended = true ) {
3082
		$data = Jetpack_Heartbeat::generate_stats_array();
3083
3084
		if ( $extended ) {
3085
			$additional_data = self::get_additional_stat_data();
3086
			$data = array_merge( $data, $additional_data );
3087
		}
3088
3089
		if ( $encode ) {
3090
			return json_encode( $data );
3091
		}
3092
3093
		return $data;
3094
	}
3095
3096
	/**
3097
	 * Get additional stat data to sync to WPCOM
3098
	 */
3099
	public static function get_additional_stat_data( $prefix = '' ) {
3100
		$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...
3101
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3102
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3103
		$return["{$prefix}site-count"]     = 0;
3104
3105
		if ( function_exists( 'get_blog_count' ) ) {
3106
			$return["{$prefix}site-count"] = get_blog_count();
3107
		}
3108
		return $return;
3109
	}
3110
3111
	private static function get_site_user_count() {
3112
		global $wpdb;
3113
3114
		if ( function_exists( 'wp_is_large_network' ) ) {
3115
			if ( wp_is_large_network( 'users' ) ) {
3116
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3117
			}
3118
		}
3119 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3120
			// It wasn't there, so regenerate the data and save the transient
3121
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3122
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3123
		}
3124
		return $user_count;
3125
	}
3126
3127
	/* Admin Pages */
3128
3129
	function admin_init() {
3130
		// If the plugin is not connected, display a connect message.
3131
		if (
3132
			// the plugin was auto-activated and needs its candy
3133
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3134
		||
3135
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3136
			! Jetpack_Options::get_option( 'activated' )
3137
		) {
3138
			Jetpack::plugin_initialize();
3139
		}
3140
3141
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3142
			Jetpack_Connection_Banner::init();
3143
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3144
			// Upgrade: 1.1 -> 1.1.1
3145
			// Check and see if host can verify the Jetpack servers' SSL certificate
3146
			$args = array();
3147
			Jetpack_Client::_wp_remote_request(
3148
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3149
				$args,
3150
				true
3151
			);
3152
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3153
			// Show the notice on the Dashboard only for now
3154
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3155
		}
3156
3157
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3158
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3159
		}
3160
3161
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3162
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3163
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3164
3165
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3166
			// Artificially throw errors in certain whitelisted cases during plugin activation
3167
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3168
		}
3169
3170
		// Jetpack Manage Activation Screen from .com
3171
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3172
3173
		// Add custom column in wp-admin/users.php to show whether user is linked.
3174
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3175
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3176
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3177
	}
3178
3179
	function admin_body_class( $admin_body_class = '' ) {
3180
		$classes = explode( ' ', trim( $admin_body_class ) );
3181
3182
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3183
3184
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3185
		return " $admin_body_class ";
3186
	}
3187
3188
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3189
		return $admin_body_class . ' jetpack-pagestyles ';
3190
	}
3191
3192
	/**
3193
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3194
	 *
3195
	 * @return null
3196
	 */
3197
	function prepare_manage_jetpack_notice() {
3198
3199
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3200
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3201
	}
3202
3203
	function manage_activate_screen() {
3204
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3205
	}
3206
	/**
3207
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3208
	 * This function artificially throws errors for such cases (whitelisted).
3209
	 *
3210
	 * @param string $plugin The activated plugin.
3211
	 */
3212
	function throw_error_on_activate_plugin( $plugin ) {
3213
		$active_modules = Jetpack::get_active_modules();
3214
3215
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3216
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3217
			$throw = false;
3218
3219
			// Try and make sure it really was the stats plugin
3220
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3221
				if ( 'stats.php' == basename( $plugin ) ) {
3222
					$throw = true;
3223
				}
3224
			} else {
3225
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3226
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3227
					$throw = true;
3228
				}
3229
			}
3230
3231
			if ( $throw ) {
3232
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3233
			}
3234
		}
3235
	}
3236
3237
	function intercept_plugin_error_scrape_init() {
3238
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3239
	}
3240
3241
	function intercept_plugin_error_scrape( $action, $result ) {
3242
		if ( ! $result ) {
3243
			return;
3244
		}
3245
3246
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3247
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3248
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3249
			}
3250
		}
3251
	}
3252
3253
	function add_remote_request_handlers() {
3254
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3255
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3256
	}
3257
3258
	function remote_request_handlers() {
3259
		$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...
3260
3261
		switch ( current_filter() ) {
3262
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3263
			$response = $this->upload_handler();
3264
			break;
3265
3266
		case 'wp_ajax_nopriv_jetpack_update_file' :
3267
			$response = $this->upload_handler( true );
3268
			break;
3269
		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...
3270
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3271
			break;
3272
		}
3273
3274
		if ( ! $response ) {
3275
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3276
		}
3277
3278
		if ( is_wp_error( $response ) ) {
3279
			$status_code       = $response->get_error_data();
3280
			$error             = $response->get_error_code();
3281
			$error_description = $response->get_error_message();
3282
3283
			if ( ! is_int( $status_code ) ) {
3284
				$status_code = 400;
3285
			}
3286
3287
			status_header( $status_code );
3288
			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...
3289
		}
3290
3291
		status_header( 200 );
3292
		if ( true === $response ) {
3293
			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...
3294
		}
3295
3296
		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...
3297
	}
3298
3299
	/**
3300
	 * Uploads a file gotten from the global $_FILES.
3301
	 * If `$update_media_item` is true and `post_id` is defined
3302
	 * the attachment file of the media item (gotten through of the post_id)
3303
	 * will be updated instead of add a new one.
3304
	 * 
3305
	 * @param  boolean $update_media_item - update media attachment
3306
	 * @return array - An array describing the uploadind files process
3307
	 */
3308
	function upload_handler( $update_media_item = false ) {
3309
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3310
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3311
		}
3312
3313
		$user = wp_authenticate( '', '' );
3314
		if ( ! $user || is_wp_error( $user ) ) {
3315
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3316
		}
3317
3318
		wp_set_current_user( $user->ID );
3319
3320
		if ( ! current_user_can( 'upload_files' ) ) {
3321
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3322
		}
3323
3324
		if ( empty( $_FILES ) ) {
3325
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3326
		}
3327
3328
		foreach ( array_keys( $_FILES ) as $files_key ) {
3329
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3330
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3331
			}
3332
		}
3333
3334
		$media_keys = array_keys( $_FILES['media'] );
3335
3336
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3337
		if ( ! $token || is_wp_error( $token ) ) {
3338
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3339
		}
3340
3341
		$uploaded_files = array();
3342
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3343
		unset( $GLOBALS['post'] );
3344
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3345
			$file = array();
3346
			foreach ( $media_keys as $media_key ) {
3347
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3348
			}
3349
3350
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3351
3352
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3353
			if ( $hmac_provided !== $hmac_file ) {
3354
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3355
				continue;
3356
			}
3357
3358
			$_FILES['.jetpack.upload.'] = $file;
3359
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3360
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3361
				$post_id = 0;
3362
			}
3363
3364
			if ( $update_media_item ) {
3365
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3366
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3367
				}
3368
3369
				$media_array = $_FILES['media'];
3370
3371
				$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...
3372
				$file_array['type'] = $media_array['type'][0]; 
3373
				$file_array['tmp_name'] = $media_array['tmp_name'][0]; 
3374
				$file_array['error'] = $media_array['error'][0]; 
3375
				$file_array['size'] = $media_array['size'][0];
3376
3377
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3378
3379
				if ( is_wp_error( $edited_media_item ) ) {
3380
					return $edited_media_item;
3381
				}
3382
3383
				$response = (object) array(
3384
					'id'   => (string) $post_id,
3385
					'file' => (string) $edited_media_item->post_title,
3386
					'url'  => (string) wp_get_attachment_url( $post_id ),
3387
					'type' => (string) $edited_media_item->post_mime_type,
3388
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3389
				);
3390
3391
				return (array) array( $response );
3392
			}
3393
3394
			$attachment_id = media_handle_upload(
3395
				'.jetpack.upload.',
3396
				$post_id,
3397
				array(),
3398
				array(
3399
					'action' => 'jetpack_upload_file',
3400
				)
3401
			);
3402
3403
			if ( ! $attachment_id ) {
3404
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3405
			} elseif ( is_wp_error( $attachment_id ) ) {
3406
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3407
			} else {
3408
				$attachment = get_post( $attachment_id );
3409
				$uploaded_files[$index] = (object) array(
3410
					'id'   => (string) $attachment_id,
3411
					'file' => $attachment->post_title,
3412
					'url'  => wp_get_attachment_url( $attachment_id ),
3413
					'type' => $attachment->post_mime_type,
3414
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3415
				);
3416
				// Zip files uploads are not supported unless they are done for installation purposed
3417
				// lets delete them in case something goes wrong in this whole process
3418
				if ( 'application/zip' === $attachment->post_mime_type ) {
3419
					// Schedule a cleanup for 2 hours from now in case of failed install.
3420
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3421
				}
3422
			}
3423
		}
3424
		if ( ! is_null( $global_post ) ) {
3425
			$GLOBALS['post'] = $global_post;
3426
		}
3427
3428
		return $uploaded_files;
3429
	}
3430
3431
	/**
3432
	 * Add help to the Jetpack page
3433
	 *
3434
	 * @since Jetpack (1.2.3)
3435
	 * @return false if not the Jetpack page
3436
	 */
3437
	function admin_help() {
3438
		$current_screen = get_current_screen();
3439
3440
		// Overview
3441
		$current_screen->add_help_tab(
3442
			array(
3443
				'id'		=> 'home',
3444
				'title'		=> __( 'Home', 'jetpack' ),
3445
				'content'	=>
3446
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3447
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3448
					'<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>',
3449
			)
3450
		);
3451
3452
		// Screen Content
3453
		if ( current_user_can( 'manage_options' ) ) {
3454
			$current_screen->add_help_tab(
3455
				array(
3456
					'id'		=> 'settings',
3457
					'title'		=> __( 'Settings', 'jetpack' ),
3458
					'content'	=>
3459
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3460
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3461
						'<ol>' .
3462
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3463
							'<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>' .
3464
						'</ol>' .
3465
						'<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>'
3466
				)
3467
			);
3468
		}
3469
3470
		// Help Sidebar
3471
		$current_screen->set_help_sidebar(
3472
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3473
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3474
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3475
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3476
		);
3477
	}
3478
3479
	function admin_menu_css() {
3480
		wp_enqueue_style( 'jetpack-icons' );
3481
	}
3482
3483
	function admin_menu_order() {
3484
		return true;
3485
	}
3486
3487 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3488
		$jp_menu_order = array();
3489
3490
		foreach ( $menu_order as $index => $item ) {
3491
			if ( $item != 'jetpack' ) {
3492
				$jp_menu_order[] = $item;
3493
			}
3494
3495
			if ( $index == 0 ) {
3496
				$jp_menu_order[] = 'jetpack';
3497
			}
3498
		}
3499
3500
		return $jp_menu_order;
3501
	}
3502
3503
	function admin_head() {
3504 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3505
			/** This action is documented in class.jetpack-admin-page.php */
3506
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3507
	}
3508
3509
	function admin_banner_styles() {
3510
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3511
3512 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3513
			wp_register_style(
3514
				'jetpack-dops-style',
3515
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3516
				array(),
3517
				JETPACK__VERSION
3518
			);
3519
		}
3520
3521
		wp_enqueue_style(
3522
			'jetpack',
3523
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3524
			array( 'jetpack-dops-style' ),
3525
			 JETPACK__VERSION . '-20121016'
3526
		);
3527
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3528
		wp_style_add_data( 'jetpack', 'suffix', $min );
3529
	}
3530
3531
	function plugin_action_links( $actions ) {
3532
3533
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3534
3535
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3536
			return array_merge(
3537
				$jetpack_home,
3538
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3539
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3540
				$actions
3541
				);
3542
			}
3543
3544
		return array_merge( $jetpack_home, $actions );
3545
	}
3546
3547
	/**
3548
	 * This is the first banner
3549
	 * It should be visible only to user that can update the option
3550
	 * Are not connected
3551
	 *
3552
	 * @return null
3553
	 */
3554
	function admin_jetpack_manage_notice() {
3555
		$screen = get_current_screen();
3556
3557
		// Don't show the connect notice on the jetpack settings page.
3558
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3559
			return;
3560
		}
3561
3562
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3563
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3564
		/**
3565
		 * I think it would be great to have different wordsing depending on where you are
3566
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3567
		 * etc..
3568
		 */
3569
3570
		?>
3571
		<div id="message" class="updated jp-banner">
3572
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3573
				<div class="jp-banner__description-container">
3574
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3575
					<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>
3576
					<p class="jp-banner__button-container">
3577
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3578
						<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>
3579
					</p>
3580
				</div>
3581
		</div>
3582
		<?php
3583
	}
3584
3585
	/**
3586
	 * Returns the url that the user clicks to remove the notice for the big banner
3587
	 * @return (string)
3588
	 */
3589
	function opt_out_jetpack_manage_url() {
3590
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3591
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3592
	}
3593
	/**
3594
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3595
	 * @return (string)
3596
	 */
3597
	function opt_in_jetpack_manage_url() {
3598
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3599
	}
3600
3601
	function opt_in_jetpack_manage_notice() {
3602
		?>
3603
		<div class="wrap">
3604
			<div id="message" class="jetpack-message is-opt-in">
3605
				<?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' ); ?>
3606
			</div>
3607
		</div>
3608
		<?php
3609
3610
	}
3611
	/**
3612
	 * Determines whether to show the notice of not true = display notice
3613
	 * @return (bool)
3614
	 */
3615
	function can_display_jetpack_manage_notice() {
3616
		// never display the notice to users that can't do anything about it anyways
3617
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3618
			return false;
3619
3620
		// don't display if we are in development more
3621
		if( Jetpack::is_development_mode() ) {
3622
			return false;
3623
		}
3624
		// don't display if the site is private
3625
		if(  ! Jetpack_Options::get_option( 'public' ) )
3626
			return false;
3627
3628
		/**
3629
		 * Should the Jetpack Remote Site Management notice be displayed.
3630
		 *
3631
		 * @since 3.3.0
3632
		 *
3633
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3634
		 */
3635
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3636
	}
3637
3638
	/*
3639
	 * Registration flow:
3640
	 * 1 - ::admin_page_load() action=register
3641
	 * 2 - ::try_registration()
3642
	 * 3 - ::register()
3643
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3644
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3645
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3646
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3647
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3648
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3649
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3650
	 *       jetpack_id, jetpack_secret, jetpack_public
3651
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3652
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3653
	 * 5 - user logs in with WP.com account
3654
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3655
	 *		- Jetpack_Client_Server::authorize()
3656
	 *		- Jetpack_Client_Server::get_token()
3657
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3658
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3659
	 *			- which responds with access_token, token_type, scope
3660
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3661
	 *		- Jetpack::activate_default_modules()
3662
	 *     		- Deactivates deprecated plugins
3663
	 *     		- Activates all default modules
3664
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3665
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3666
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3667
	 *     Done!
3668
	 */
3669
3670
	/**
3671
	 * Handles the page load events for the Jetpack admin page
3672
	 */
3673
	function admin_page_load() {
3674
		$error = false;
3675
3676
		// Make sure we have the right body class to hook stylings for subpages off of.
3677
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3678
3679
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3680
			// Should only be used in intermediate redirects to preserve state across redirects
3681
			Jetpack::restate();
3682
		}
3683
3684
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3685
			// User clicked in the iframe to link their accounts
3686
			if ( ! Jetpack::is_user_connected() ) {
3687
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3688
				if ( isset( $_GET['notes_iframe'] ) )
3689
					$connect_url .= '&notes_iframe';
3690
				wp_redirect( $connect_url );
3691
				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...
3692
			} else {
3693
				if ( ! isset( $_GET['calypso_env'] ) ) {
3694
					Jetpack::state( 'message', 'already_authorized' );
3695
					wp_safe_redirect( Jetpack::admin_url() );
3696
				} else {
3697
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3698
					$connect_url .= '&already_authorized=true';
3699
					wp_redirect( $connect_url );
3700
				}
3701
			}
3702
		}
3703
3704
3705
		if ( isset( $_GET['action'] ) ) {
3706
			switch ( $_GET['action'] ) {
3707
			case 'authorize':
3708
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3709
					Jetpack::state( 'message', 'already_authorized' );
3710
					wp_safe_redirect( Jetpack::admin_url() );
3711
					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...
3712
				}
3713
				Jetpack::log( 'authorize' );
3714
				$client_server = new Jetpack_Client_Server;
3715
				$client_server->client_authorize();
3716
				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...
3717
			case 'register' :
3718
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3719
					$error = 'cheatin';
3720
					break;
3721
				}
3722
				check_admin_referer( 'jetpack-register' );
3723
				Jetpack::log( 'register' );
3724
				Jetpack::maybe_set_version_option();
3725
				$registered = Jetpack::try_registration();
3726
				if ( is_wp_error( $registered ) ) {
3727
					$error = $registered->get_error_code();
3728
					Jetpack::state( 'error', $error );
3729
					Jetpack::state( 'error', $registered->get_error_message() );
3730
					break;
3731
				}
3732
3733
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3734
3735
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3736
				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...
3737
			case 'activate' :
3738
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3739
					$error = 'cheatin';
3740
					break;
3741
				}
3742
3743
				$module = stripslashes( $_GET['module'] );
3744
				check_admin_referer( "jetpack_activate-$module" );
3745
				Jetpack::log( 'activate', $module );
3746
				Jetpack::activate_module( $module );
3747
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3748
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3749
				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...
3750
			case 'activate_default_modules' :
3751
				check_admin_referer( 'activate_default_modules' );
3752
				Jetpack::log( 'activate_default_modules' );
3753
				Jetpack::restate();
3754
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3755
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3756
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3757
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3758
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3759
				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...
3760
			case 'disconnect' :
3761
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3762
					$error = 'cheatin';
3763
					break;
3764
				}
3765
3766
				check_admin_referer( 'jetpack-disconnect' );
3767
				Jetpack::log( 'disconnect' );
3768
				Jetpack::disconnect();
3769
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3770
				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...
3771
			case 'reconnect' :
3772
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3773
					$error = 'cheatin';
3774
					break;
3775
				}
3776
3777
				check_admin_referer( 'jetpack-reconnect' );
3778
				Jetpack::log( 'reconnect' );
3779
				$this->disconnect();
3780
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3781
				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...
3782 View Code Duplication
			case 'deactivate' :
3783
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3784
					$error = 'cheatin';
3785
					break;
3786
				}
3787
3788
				$modules = stripslashes( $_GET['module'] );
3789
				check_admin_referer( "jetpack_deactivate-$modules" );
3790
				foreach ( explode( ',', $modules ) as $module ) {
3791
					Jetpack::log( 'deactivate', $module );
3792
					Jetpack::deactivate_module( $module );
3793
					Jetpack::state( 'message', 'module_deactivated' );
3794
				}
3795
				Jetpack::state( 'module', $modules );
3796
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3797
				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...
3798
			case 'unlink' :
3799
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3800
				check_admin_referer( 'jetpack-unlink' );
3801
				Jetpack::log( 'unlink' );
3802
				$this->unlink_user();
3803
				Jetpack::state( 'message', 'unlinked' );
3804
				if ( 'sub-unlink' == $redirect ) {
3805
					wp_safe_redirect( admin_url() );
3806
				} else {
3807
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3808
				}
3809
				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...
3810
			default:
3811
				/**
3812
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3813
				 *
3814
				 * @since 2.6.0
3815
				 *
3816
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3817
				 */
3818
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3819
			}
3820
		}
3821
3822
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3823
			self::activate_new_modules( true );
3824
		}
3825
3826
		$message_code = Jetpack::state( 'message' );
3827
		if ( Jetpack::state( 'optin-manage' ) ) {
3828
			$activated_manage = $message_code;
3829
			$message_code = 'jetpack-manage';
3830
		}
3831
3832
		switch ( $message_code ) {
3833
		case 'jetpack-manage':
3834
			$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>';
3835
			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...
3836
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3837
			}
3838
			break;
3839
3840
		}
3841
3842
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3843
3844
		if ( ! empty( $deactivated_plugins ) ) {
3845
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3846
			$deactivated_titles  = array();
3847
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3848
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3849
					continue;
3850
				}
3851
3852
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3853
			}
3854
3855
			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...
3856
				if ( $this->message ) {
3857
					$this->message .= "<br /><br />\n";
3858
				}
3859
3860
				$this->message .= wp_sprintf(
3861
					_n(
3862
						'Jetpack contains the most recent version of the old %l plugin.',
3863
						'Jetpack contains the most recent versions of the old %l plugins.',
3864
						count( $deactivated_titles ),
3865
						'jetpack'
3866
					),
3867
					$deactivated_titles
3868
				);
3869
3870
				$this->message .= "<br />\n";
3871
3872
				$this->message .= _n(
3873
					'The old version has been deactivated and can be removed from your site.',
3874
					'The old versions have been deactivated and can be removed from your site.',
3875
					count( $deactivated_titles ),
3876
					'jetpack'
3877
				);
3878
			}
3879
		}
3880
3881
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3882
3883
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3884
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3885
		}
3886
3887 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3888
			/**
3889
			 * Fires when a module configuration page is loaded.
3890
			 * The dynamic part of the hook is the configure parameter from the URL.
3891
			 *
3892
			 * @since 1.1.0
3893
			 */
3894
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3895
		}
3896
3897
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3898
	}
3899
3900
	function admin_notices() {
3901
3902
		if ( $this->error ) {
3903
?>
3904
<div id="message" class="jetpack-message jetpack-err">
3905
	<div class="squeezer">
3906
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3907
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3908
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3909
<?php	endif; ?>
3910
	</div>
3911
</div>
3912
<?php
3913
		}
3914
3915
		if ( $this->message ) {
3916
?>
3917
<div id="message" class="jetpack-message">
3918
	<div class="squeezer">
3919
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3920
	</div>
3921
</div>
3922
<?php
3923
		}
3924
3925
		if ( $this->privacy_checks ) :
3926
			$module_names = $module_slugs = array();
3927
3928
			$privacy_checks = explode( ',', $this->privacy_checks );
3929
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3930
			foreach ( $privacy_checks as $module_slug ) {
3931
				$module = Jetpack::get_module( $module_slug );
3932
				if ( ! $module ) {
3933
					continue;
3934
				}
3935
3936
				$module_slugs[] = $module_slug;
3937
				$module_names[] = "<strong>{$module['name']}</strong>";
3938
			}
3939
3940
			$module_slugs = join( ',', $module_slugs );
3941
?>
3942
<div id="message" class="jetpack-message jetpack-err">
3943
	<div class="squeezer">
3944
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3945
		<p><?php
3946
			echo wp_kses(
3947
				wptexturize(
3948
					wp_sprintf(
3949
						_nx(
3950
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3951
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3952
							count( $privacy_checks ),
3953
							'%l = list of Jetpack module/feature names',
3954
							'jetpack'
3955
						),
3956
						$module_names
3957
					)
3958
				),
3959
				array( 'strong' => true )
3960
			);
3961
3962
			echo "\n<br />\n";
3963
3964
			echo wp_kses(
3965
				sprintf(
3966
					_nx(
3967
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3968
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3969
						count( $privacy_checks ),
3970
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3971
						'jetpack'
3972
					),
3973
					wp_nonce_url(
3974
						Jetpack::admin_url(
3975
							array(
3976
								'page'   => 'jetpack',
3977
								'action' => 'deactivate',
3978
								'module' => urlencode( $module_slugs ),
3979
							)
3980
						),
3981
						"jetpack_deactivate-$module_slugs"
3982
					),
3983
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3984
				),
3985
				array( 'a' => array( 'href' => true, 'title' => true ) )
3986
			);
3987
		?></p>
3988
	</div>
3989
</div>
3990
<?php endif;
3991
	// only display the notice if the other stuff is not there
3992
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3993
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3994
			$this->opt_in_jetpack_manage_notice();
3995
		}
3996
	}
3997
3998
	/**
3999
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4000
	 */
4001
	function stat( $group, $detail ) {
4002
		if ( ! isset( $this->stats[ $group ] ) )
4003
			$this->stats[ $group ] = array();
4004
		$this->stats[ $group ][] = $detail;
4005
	}
4006
4007
	/**
4008
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4009
	 */
4010
	function do_stats( $method = '' ) {
4011
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4012
			foreach ( $this->stats as $group => $stats ) {
4013
				if ( is_array( $stats ) && count( $stats ) ) {
4014
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4015
					if ( 'server_side' === $method ) {
4016
						self::do_server_side_stat( $args );
4017
					} else {
4018
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4019
					}
4020
				}
4021
				unset( $this->stats[ $group ] );
4022
			}
4023
		}
4024
	}
4025
4026
	/**
4027
	 * Runs stats code for a one-off, server-side.
4028
	 *
4029
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4030
	 *
4031
	 * @return bool If it worked.
4032
	 */
4033
	static function do_server_side_stat( $args ) {
4034
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4035
		if ( is_wp_error( $response ) )
4036
			return false;
4037
4038
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4039
			return false;
4040
4041
		return true;
4042
	}
4043
4044
	/**
4045
	 * Builds the stats url.
4046
	 *
4047
	 * @param $args array|string The arguments to append to the URL.
4048
	 *
4049
	 * @return string The URL to be pinged.
4050
	 */
4051
	static function build_stats_url( $args ) {
4052
		$defaults = array(
4053
			'v'    => 'wpcom2',
4054
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4055
		);
4056
		$args     = wp_parse_args( $args, $defaults );
4057
		/**
4058
		 * Filter the URL used as the Stats tracking pixel.
4059
		 *
4060
		 * @since 2.3.2
4061
		 *
4062
		 * @param string $url Base URL used as the Stats tracking pixel.
4063
		 */
4064
		$base_url = apply_filters(
4065
			'jetpack_stats_base_url',
4066
			'https://pixel.wp.com/g.gif'
4067
		);
4068
		$url      = add_query_arg( $args, $base_url );
4069
		return $url;
4070
	}
4071
4072
	static function translate_current_user_to_role() {
4073
		foreach ( self::$capability_translations as $role => $cap ) {
4074
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4075
				return $role;
4076
			}
4077
		}
4078
4079
		return false;
4080
	}
4081
4082
	static function translate_role_to_cap( $role ) {
4083
		if ( ! isset( self::$capability_translations[$role] ) ) {
4084
			return false;
4085
		}
4086
4087
		return self::$capability_translations[$role];
4088
	}
4089
4090
	static function sign_role( $role ) {
4091
		if ( ! $user_id = (int) get_current_user_id() ) {
4092
			return false;
4093
		}
4094
4095
		$token = Jetpack_Data::get_access_token();
4096
		if ( ! $token || is_wp_error( $token ) ) {
4097
			return false;
4098
		}
4099
4100
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4101
	}
4102
4103
4104
	/**
4105
	 * Builds a URL to the Jetpack connection auth page
4106
	 *
4107
	 * @since 3.9.5
4108
	 *
4109
	 * @param bool $raw If true, URL will not be escaped.
4110
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4111
	 *                              If string, will be a custom redirect.
4112
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4113
	 *
4114
	 * @return string Connect URL
4115
	 */
4116
	function build_connect_url( $raw = false, $redirect = false, $from = false ) {
4117
		if ( ! Jetpack_Options::get_option( 'blog_token' ) || ! Jetpack_Options::get_option( 'id' ) ) {
4118
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4119
			if( is_network_admin() ) {
4120
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4121
			}
4122
		} else {
4123
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4124
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4125
			}
4126
4127
			$role = self::translate_current_user_to_role();
4128
			$signed_role = self::sign_role( $role );
4129
4130
			$user = wp_get_current_user();
4131
4132
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4133
			$redirect = $redirect
4134
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4135
				: $jetpack_admin_page;
4136
4137
			if( isset( $_REQUEST['is_multisite'] ) ) {
4138
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4139
			}
4140
4141
			$secrets = Jetpack::init()->generate_secrets( 'authorize' );
4142
			@list( $secret ) = explode( ':', $secrets );
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...
4143
4144
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4145
				? get_site_icon_url()
4146
				: false;
4147
4148
			/**
4149
			 * Filter the type of authorization.
4150
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4151
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4152
			 *
4153
			 * @since 4.3.3
4154
			 *
4155
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4156
			 */
4157
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4158
4159
			$args = urlencode_deep(
4160
				array(
4161
					'response_type' => 'code',
4162
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4163
					'redirect_uri'  => add_query_arg(
4164
						array(
4165
							'action'   => 'authorize',
4166
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4167
							'redirect' => urlencode( $redirect ),
4168
						),
4169
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4170
					),
4171
					'state'         => $user->ID,
4172
					'scope'         => $signed_role,
4173
					'user_email'    => $user->user_email,
4174
					'user_login'    => $user->user_login,
4175
					'is_active'     => Jetpack::is_active(),
4176
					'jp_version'    => JETPACK__VERSION,
4177
					'auth_type'     => $auth_type,
4178
					'secret'        => $secret,
4179
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4180
					'blogname'      => get_option( 'blogname' ),
4181
					'site_url'      => site_url(),
4182
					'home_url'      => home_url(),
4183
					'site_icon'     => $site_icon,
4184
				)
4185
			);
4186
4187
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4188
		}
4189
4190
		if ( $from ) {
4191
			$url = add_query_arg( 'from', $from, $url );
4192
		}
4193
4194
		if ( isset( $_GET['calypso_env'] ) ) {
4195
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4196
		}
4197
4198
		return $raw ? $url : esc_url( $url );
4199
	}
4200
4201
	function build_reconnect_url( $raw = false ) {
4202
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4203
		return $raw ? $url : esc_url( $url );
4204
	}
4205
4206
	public static function admin_url( $args = null ) {
4207
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4208
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4209
		return $url;
4210
	}
4211
4212
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4213
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4214
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4215
	}
4216
4217
	function dismiss_jetpack_notice() {
4218
4219
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4220
			return;
4221
		}
4222
4223
		switch( $_GET['jetpack-notice'] ) {
4224
			case 'dismiss':
4225
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4226
4227
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4228
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4229
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4230
				}
4231
				break;
4232 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...
4233
4234
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4235
					// Don't show the banner again
4236
4237
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4238
					// redirect back to the page that had the notice
4239
					if ( wp_get_referer() ) {
4240
						wp_safe_redirect( wp_get_referer() );
4241
					} else {
4242
						// Take me to Jetpack
4243
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4244
					}
4245
				}
4246
				break;
4247 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...
4248
4249
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4250
					// Don't show the banner again
4251
4252
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4253
					// redirect back to the page that had the notice
4254
					if ( wp_get_referer() ) {
4255
						wp_safe_redirect( wp_get_referer() );
4256
					} else {
4257
						// Take me to Jetpack
4258
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4259
					}
4260
				}
4261
				break;
4262
			case 'jetpack-manage-opt-in':
4263
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4264
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4265
4266
					$redirection_url = Jetpack::admin_url();
4267
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4268
4269
					// Don't redirect form the Jetpack Setting Page
4270
					$referer_parsed = parse_url ( wp_get_referer() );
4271
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4272
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4273
						// Take the user to Jetpack home except when on the setting page
4274
						$redirection_url = wp_get_referer();
4275
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4276
					}
4277
					// Also update the JSON API FULL MANAGEMENT Option
4278
					Jetpack::activate_module( 'manage', false, false );
4279
4280
					// Special Message when option in.
4281
					Jetpack::state( 'optin-manage', 'true' );
4282
					// Activate the Module if not activated already
4283
4284
					// Redirect properly
4285
					wp_safe_redirect( $redirection_url );
4286
4287
				}
4288
				break;
4289
		}
4290
	}
4291
4292
	public static function admin_screen_configure_module( $module_id ) {
4293
4294
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4295
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4296
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4297
				/**
4298
				 * Fires to diplay a custom module activation screen.
4299
				 *
4300
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4301
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4302
				 *
4303
				 * @module manage
4304
				 *
4305
				 * @since 3.8.0
4306
				 *
4307
				 * @param int $module_id Module ID.
4308
				 */
4309
				do_action( 'display_activate_module_setting_' . $module_id );
4310
			} else {
4311
				self::display_activate_module_link( $module_id );
4312
			}
4313
4314
			return false;
4315
		} ?>
4316
4317
		<div id="jp-settings-screen" style="position: relative">
4318
			<h3>
4319
			<?php
4320
				$module = Jetpack::get_module( $module_id );
4321
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4322
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4323
			?>
4324
			</h3>
4325
			<?php
4326
				/**
4327
				 * Fires within the displayed message when a feature configuation is updated.
4328
				 *
4329
				 * @since 3.4.0
4330
				 *
4331
				 * @param int $module_id Module ID.
4332
				 */
4333
				do_action( 'jetpack_notices_update_settings', $module_id );
4334
				/**
4335
				 * Fires when a feature configuation screen is loaded.
4336
				 * The dynamic part of the hook, $module_id, is the module ID.
4337
				 *
4338
				 * @since 1.1.0
4339
				 */
4340
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4341
			?>
4342
		</div><?php
4343
	}
4344
4345
	/**
4346
	 * Display link to activate the module to see the settings screen.
4347
	 * @param  string $module_id
4348
	 * @return null
4349
	 */
4350
	public static function display_activate_module_link( $module_id ) {
4351
4352
		$info =  Jetpack::get_module( $module_id );
4353
		$extra = '';
4354
		$activate_url = wp_nonce_url(
4355
				Jetpack::admin_url(
4356
					array(
4357
						'page'   => 'jetpack',
4358
						'action' => 'activate',
4359
						'module' => $module_id,
4360
					)
4361
				),
4362
				"jetpack_activate-$module_id"
4363
			);
4364
4365
		?>
4366
4367
		<div class="wrap configure-module">
4368
			<div id="jp-settings-screen">
4369
				<?php
4370
				if ( $module_id == 'json-api' ) {
4371
4372
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4373
4374
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4375
4376
					$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' );
4377
4378
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4379
				} ?>
4380
4381
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4382
				<div class="narrow">
4383
					<p><?php echo  $info['description']; ?></p>
4384
					<?php if( $extra ) { ?>
4385
					<p><?php echo esc_html( $extra ); ?></p>
4386
					<?php } ?>
4387
					<p>
4388
						<?php
4389
						if( wp_get_referer() ) {
4390
							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() );
4391
						} else {
4392
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4393
						} ?>
4394
					</p>
4395
				</div>
4396
4397
			</div>
4398
		</div>
4399
4400
		<?php
4401
	}
4402
4403
	public static function sort_modules( $a, $b ) {
4404
		if ( $a['sort'] == $b['sort'] )
4405
			return 0;
4406
4407
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4408
	}
4409
4410
	function ajax_recheck_ssl() {
4411
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4412
		$result = Jetpack::permit_ssl( true );
4413
		wp_send_json( array(
4414
			'enabled' => $result,
4415
			'message' => get_transient( 'jetpack_https_test_message' )
4416
		) );
4417
	}
4418
4419
/* Client API */
4420
4421
	/**
4422
	 * Returns the requested Jetpack API URL
4423
	 *
4424
	 * @return string
4425
	 */
4426
	public static function api_url( $relative_url ) {
4427
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4428
	}
4429
4430
	/**
4431
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4432
	 */
4433
	public static function fix_url_for_bad_hosts( $url ) {
4434
		if ( 0 !== strpos( $url, 'https://' ) ) {
4435
			return $url;
4436
		}
4437
4438
		switch ( JETPACK_CLIENT__HTTPS ) {
4439
			case 'ALWAYS' :
4440
				return $url;
4441
			case 'NEVER' :
4442
				return set_url_scheme( $url, 'http' );
4443
			// default : case 'AUTO' :
4444
		}
4445
4446
		// we now return the unmodified SSL URL by default, as a security precaution
4447
		return $url;
4448
	}
4449
4450
	/**
4451
	 * Checks to see if the URL is using SSL to connect with Jetpack
4452
	 *
4453
	 * @since 2.3.3
4454
	 * @return boolean
4455
	 */
4456
	public static function permit_ssl( $force_recheck = false ) {
4457
		// Do some fancy tests to see if ssl is being supported
4458
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4459
			$message = '';
4460
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4461
				$ssl = 0;
4462
			} else {
4463
				switch ( JETPACK_CLIENT__HTTPS ) {
4464
					case 'NEVER':
4465
						$ssl = 0;
4466
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4467
						break;
4468
					case 'ALWAYS':
4469
					case 'AUTO':
4470
					default:
4471
						$ssl = 1;
4472
						break;
4473
				}
4474
4475
				// If it's not 'NEVER', test to see
4476
				if ( $ssl ) {
4477
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4478
						$ssl = 0;
4479
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4480
					} else {
4481
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4482
						if ( is_wp_error( $response ) ) {
4483
							$ssl = 0;
4484
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4485
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4486
							$ssl = 0;
4487
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4488
						}
4489
					}
4490
				}
4491
			}
4492
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4493
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4494
		}
4495
4496
		return (bool) $ssl;
4497
	}
4498
4499
	/*
4500
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4501
	 */
4502
	public function alert_auto_ssl_fail() {
4503
		if ( ! current_user_can( 'manage_options' ) )
4504
			return;
4505
4506
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4507
		?>
4508
4509
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4510
			<div class="jp-banner__content">
4511
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4512
				<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>
4513
				<p>
4514
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4515
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4516
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4517
				</p>
4518
				<p>
4519
					<?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' ),
4520
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4521
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4522
				</p>
4523
			</div>
4524
		</div>
4525
		<style>
4526
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4527
		</style>
4528
		<script type="text/javascript">
4529
			jQuery( document ).ready( function( $ ) {
4530
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4531
					var $this = $( this );
4532
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4533
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4534
					e.preventDefault();
4535
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4536
					$.post( ajaxurl, data )
4537
					  .done( function( response ) {
4538
					  	if ( response.enabled ) {
4539
					  		$( '#jetpack-ssl-warning' ).hide();
4540
					  	} else {
4541
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4542
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4543
					  	}
4544
					  }.bind( $this ) );
4545
				} );
4546
			} );
4547
		</script>
4548
4549
		<?php
4550
	}
4551
4552
	/**
4553
	 * Returns the Jetpack XML-RPC API
4554
	 *
4555
	 * @return string
4556
	 */
4557
	public static function xmlrpc_api_url() {
4558
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4559
		return untrailingslashit( $base ) . '/xmlrpc.php';
4560
	}
4561
4562
	/**
4563
	 * Creates two secret tokens and the end of life timestamp for them.
4564
	 *
4565
	 * Note these tokens are unique per call, NOT static per site for connecting.
4566
	 *
4567
	 * @since 2.6
4568
	 * @return array
4569
	 */
4570
	public function generate_secrets( $action, $exp = 600 ) {
4571
	    $secret = wp_generate_password( 32, false ) // secret_1
4572
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4573
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4574
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4575
		Jetpack_Options::update_option( $action, $secret );
4576
	    return Jetpack_Options::get_option( $action );
4577
	}
4578
4579
	/**
4580
	 * Builds the timeout limit for queries talking with the wpcom servers.
4581
	 *
4582
	 * Based on local php max_execution_time in php.ini
4583
	 *
4584
	 * @since 2.6
4585
	 * @return int
4586
	 **/
4587
	public function get_remote_query_timeout_limit() {
4588
	    $timeout = (int) ini_get( 'max_execution_time' );
4589
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4590
				$timeout = 30;
4591
	    return intval( $timeout / 2 );
4592
	}
4593
4594
4595
	/**
4596
	 * Takes the response from the Jetpack register new site endpoint and
4597
	 * verifies it worked properly.
4598
	 *
4599
	 * @since 2.6
4600
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4601
	 **/
4602
	public function validate_remote_register_response( $response ) {
4603
	  if ( is_wp_error( $response ) ) {
4604
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4605
		}
4606
4607
		$code   = wp_remote_retrieve_response_code( $response );
4608
		$entity = wp_remote_retrieve_body( $response );
4609
		if ( $entity )
4610
			$registration_response = json_decode( $entity );
4611
		else
4612
			$registration_response = false;
4613
4614
		$code_type = intval( $code / 100 );
4615
		if ( 5 == $code_type ) {
4616
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4617
		} elseif ( 408 == $code ) {
4618
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4619
		} elseif ( ! empty( $registration_response->error ) ) {
4620
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4621
				$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' );
4622
			} else {
4623
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4624
			}
4625
4626
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4627
		} elseif ( 200 != $code ) {
4628
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4629
		}
4630
4631
		// Jetpack ID error block
4632
		if ( empty( $registration_response->jetpack_id ) ) {
4633
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4634
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4635
			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 );
4636
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4637
			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 );
4638
		}
4639
4640
	    return $registration_response;
4641
	}
4642
	/**
4643
	 * @return bool|WP_Error
4644
	 */
4645
	public static function register() {
4646
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4647
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4648
4649
		@list( $secret_1, $secret_2, $secret_eol ) = explode( ':', $secrets );
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...
4650 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4651
			return new Jetpack_Error( 'missing_secrets' );
4652
		}
4653
4654
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4655
4656
		$gmt_offset = get_option( 'gmt_offset' );
4657
		if ( ! $gmt_offset ) {
4658
			$gmt_offset = 0;
4659
		}
4660
4661
		$stats_options = get_option( 'stats_options' );
4662
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4663
4664
		$args = array(
4665
			'method'  => 'POST',
4666
			'body'    => array(
4667
				'siteurl'         => site_url(),
4668
				'home'            => home_url(),
4669
				'gmt_offset'      => $gmt_offset,
4670
				'timezone_string' => (string) get_option( 'timezone_string' ),
4671
				'site_name'       => (string) get_option( 'blogname' ),
4672
				'secret_1'        => $secret_1,
4673
				'secret_2'        => $secret_2,
4674
				'site_lang'       => get_locale(),
4675
				'timeout'         => $timeout,
4676
				'stats_id'        => $stats_id,
4677
				'state'           => get_current_user_id(),
4678
			),
4679
			'headers' => array(
4680
				'Accept' => 'application/json',
4681
			),
4682
			'timeout' => $timeout,
4683
		);
4684
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4685
4686
		// Make sure the response is valid and does not contain any Jetpack errors
4687
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4688
		if ( is_wp_error( $registration_details ) ) {
4689
		    return $registration_details;
4690
		} elseif ( ! $registration_details ) {
4691
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4692
		}
4693
4694 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4695
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4696
		}
4697
4698
		if ( isset( $registration_details->jetpack_public ) ) {
4699
			$jetpack_public = (int) $registration_details->jetpack_public;
4700
		} else {
4701
			$jetpack_public = false;
4702
		}
4703
4704
		Jetpack_Options::update_options(
4705
			array(
4706
				'id'         => (int)    $registration_details->jetpack_id,
4707
				'blog_token' => (string) $registration_details->jetpack_secret,
4708
				'public'     => $jetpack_public,
4709
			)
4710
		);
4711
4712
		/**
4713
		 * Fires when a site is registered on WordPress.com.
4714
		 *
4715
		 * @since 3.7.0
4716
		 *
4717
		 * @param int $json->jetpack_id Jetpack Blog ID.
4718
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4719
		 * @param int|bool $jetpack_public Is the site public.
4720
		 */
4721
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4722
4723
		// Initialize Jump Start for the first and only time.
4724
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4725
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4726
4727
			$jetpack = Jetpack::init();
4728
4729
			$jetpack->stat( 'jumpstart', 'unique-views' );
4730
			$jetpack->do_stats( 'server_side' );
4731
		};
4732
4733
		return true;
4734
	}
4735
4736
	/**
4737
	 * If the db version is showing something other that what we've got now, bump it to current.
4738
	 *
4739
	 * @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...
4740
	 */
4741
	public static function maybe_set_version_option() {
4742
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4743
		if ( JETPACK__VERSION != $version ) {
4744
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4745
4746
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4747
				/** This action is documented in class.jetpack.php */
4748
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4749
			}
4750
4751
			return true;
4752
		}
4753
		return false;
4754
	}
4755
4756
/* Client Server API */
4757
4758
	/**
4759
	 * Loads the Jetpack XML-RPC client
4760
	 */
4761
	public static function load_xml_rpc_client() {
4762
		require_once ABSPATH . WPINC . '/class-IXR.php';
4763
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4764
	}
4765
4766
	/**
4767
	 * Resets the saved authentication state in between testing requests.
4768
	 */
4769
	public function reset_saved_auth_state() {
4770
		$this->xmlrpc_verification = null;
4771
		$this->rest_authentication_status = null;
4772
	}
4773
4774
	function verify_xml_rpc_signature() {
4775
		if ( $this->xmlrpc_verification ) {
4776
			return $this->xmlrpc_verification;
4777
		}
4778
4779
		// It's not for us
4780
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4781
			return false;
4782
		}
4783
4784
		@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...
4785
		if (
4786
			empty( $token_key )
4787
		||
4788
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4789
		) {
4790
			return false;
4791
		}
4792
4793
		if ( '0' === $user_id ) {
4794
			$token_type = 'blog';
4795
			$user_id = 0;
4796
		} else {
4797
			$token_type = 'user';
4798
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4799
				return false;
4800
			}
4801
			$user_id = (int) $user_id;
4802
4803
			$user = new WP_User( $user_id );
4804
			if ( ! $user || ! $user->exists() ) {
4805
				return false;
4806
			}
4807
		}
4808
4809
		$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...
4810
		if ( ! $token ) {
4811
			return false;
4812
		}
4813
4814
		$token_check = "$token_key.";
4815
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4816
			return false;
4817
		}
4818
4819
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4820
4821
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4822
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4823
			$post_data   = $_POST;
4824
			$file_hashes = array();
4825
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4826
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4827
					continue;
4828
				}
4829
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4830
				$file_hashes[$post_data_key] = $post_data_value;
4831
			}
4832
4833
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4834
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4835
				$post_data[$post_data_key] = $post_data_value;
4836
			}
4837
4838
			ksort( $post_data );
4839
4840
			$body = http_build_query( stripslashes_deep( $post_data ) );
4841
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4842
			$body = file_get_contents( 'php://input' );
4843
		} else {
4844
			$body = null;
4845
		}
4846
4847
		$signature = $jetpack_signature->sign_current_request(
4848
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4849
		);
4850
4851
		if ( ! $signature ) {
4852
			return false;
4853
		} else if ( is_wp_error( $signature ) ) {
4854
			return $signature;
4855
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4856
			return false;
4857
		}
4858
4859
		$timestamp = (int) $_GET['timestamp'];
4860
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4861
4862
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4863
			return false;
4864
		}
4865
4866
		$this->xmlrpc_verification = array(
4867
			'type'    => $token_type,
4868
			'user_id' => $token->external_user_id,
4869
		);
4870
4871
		return $this->xmlrpc_verification;
4872
	}
4873
4874
	/**
4875
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4876
	 */
4877
	function authenticate_jetpack( $user, $username, $password ) {
0 ignored issues
show
Unused Code introduced by
The parameter $username is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $password is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
4878
		if ( is_a( $user, 'WP_User' ) ) {
4879
			return $user;
4880
		}
4881
4882
		$token_details = $this->verify_xml_rpc_signature();
4883
4884
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4885
			return $user;
4886
		}
4887
4888
		if ( 'user' !== $token_details['type'] ) {
4889
			return $user;
4890
		}
4891
4892
		if ( ! $token_details['user_id'] ) {
4893
			return $user;
4894
		}
4895
4896
		nocache_headers();
4897
4898
		return new WP_User( $token_details['user_id'] );
4899
	}
4900
4901
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4902
	// Uses the existing XMLRPC request signing implementation.
4903
	function wp_rest_authenticate( $user ) {
4904
		if ( ! empty( $user ) ) {
4905
			// Another authentication method is in effect.
4906
			return $user;
4907
		}
4908
4909
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4910
			// Nothing to do for this authentication method.
4911
			return null;
4912
		}
4913
4914
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4915
			// Nothing to do for this authentication method.
4916
			return null;
4917
		}
4918
4919
		// Ensure that we always have the request body available.  At this
4920
		// point, the WP REST API code to determine the request body has not
4921
		// run yet.  That code may try to read from 'php://input' later, but
4922
		// this can only be done once per request in PHP versions prior to 5.6.
4923
		// So we will go ahead and perform this read now if needed, and save
4924
		// the request body where both the Jetpack signature verification code
4925
		// and the WP REST API code can see it.
4926
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4927
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4928
		}
4929
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4930
4931
		// Only support specific request parameters that have been tested and
4932
		// are known to work with signature verification.  A different method
4933
		// can be passed to the WP REST API via the '?_method=' parameter if
4934
		// needed.
4935
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4936
			$this->rest_authentication_status = new WP_Error(
4937
				'rest_invalid_request',
4938
				__( 'This request method is not supported.', 'jetpack' ),
4939
				array( 'status' => 400 )
4940
			);
4941
			return null;
4942
		}
4943
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
4944
			$this->rest_authentication_status = new WP_Error(
4945
				'rest_invalid_request',
4946
				__( 'This request method does not support body parameters.', 'jetpack' ),
4947
				array( 'status' => 400 )
4948
			);
4949
			return null;
4950
		}
4951
4952
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
4953
			$content_type = $_SERVER['CONTENT_TYPE'];
4954
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
4955
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
4956
		}
4957
4958
		if (
4959
			isset( $content_type ) &&
4960
			$content_type !== 'application/x-www-form-urlencoded' &&
4961
			$content_type !== 'application/json'
4962
		) {
4963
			$this->rest_authentication_status = new WP_Error(
4964
				'rest_invalid_request',
4965
				__( 'This Content-Type is not supported.', 'jetpack' ),
4966
				array( 'status' => 400 )
4967
			);
4968
			return null;
4969
		}
4970
4971
		$verified = $this->verify_xml_rpc_signature();
4972
4973
		if ( is_wp_error( $verified ) ) {
4974
			$this->rest_authentication_status = $verified;
4975
			return null;
4976
		}
4977
4978
		if (
4979
			$verified &&
4980
			isset( $verified['type'] ) &&
4981
			'user' === $verified['type'] &&
4982
			! empty( $verified['user_id'] )
4983
		) {
4984
			// Authentication successful.
4985
			$this->rest_authentication_status = true;
4986
			return $verified['user_id'];
4987
		}
4988
4989
		// Something else went wrong.  Probably a signature error.
4990
		$this->rest_authentication_status = new WP_Error(
4991
			'rest_invalid_signature',
4992
			__( 'The request is not signed correctly.', 'jetpack' ),
4993
			array( 'status' => 400 )
4994
		);
4995
		return null;
4996
	}
4997
4998
	/**
4999
	 * Report authentication status to the WP REST API.
5000
	 *
5001
	 * @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...
5002
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5003
	 */
5004
	public function wp_rest_authentication_errors( $value ) {
5005
		if ( $value !== null ) {
5006
			return $value;
5007
		}
5008
		return $this->rest_authentication_status;
5009
	}
5010
5011
	function add_nonce( $timestamp, $nonce ) {
5012
		global $wpdb;
5013
		static $nonces_used_this_request = array();
5014
5015
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5016
			return $nonces_used_this_request["$timestamp:$nonce"];
5017
		}
5018
5019
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5020
		$timestamp = (int) $timestamp;
5021
		$nonce     = esc_sql( $nonce );
5022
5023
		// Raw query so we can avoid races: add_option will also update
5024
		$show_errors = $wpdb->show_errors( false );
5025
5026
		$old_nonce = $wpdb->get_row(
5027
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5028
		);
5029
5030
		if ( is_null( $old_nonce ) ) {
5031
			$return = $wpdb->query(
5032
				$wpdb->prepare(
5033
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5034
					"jetpack_nonce_{$timestamp}_{$nonce}",
5035
					time(),
5036
					'no'
5037
				)
5038
			);
5039
		} else {
5040
			$return = false;
5041
		}
5042
5043
		$wpdb->show_errors( $show_errors );
5044
5045
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5046
5047
		return $return;
5048
	}
5049
5050
	/**
5051
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5052
	 * Capture it here so we can verify the signature later.
5053
	 */
5054
	function xmlrpc_methods( $methods ) {
5055
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5056
		return $methods;
5057
	}
5058
5059
	function public_xmlrpc_methods( $methods ) {
5060
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5061
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5062
		}
5063
		return $methods;
5064
	}
5065
5066
	function jetpack_getOptions( $args ) {
5067
		global $wp_xmlrpc_server;
5068
5069
		$wp_xmlrpc_server->escape( $args );
5070
5071
		$username	= $args[1];
5072
		$password	= $args[2];
5073
5074
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5075
			return $wp_xmlrpc_server->error;
5076
		}
5077
5078
		$options = array();
5079
		$user_data = $this->get_connected_user_data();
5080
		if ( is_array( $user_data ) ) {
5081
			$options['jetpack_user_id'] = array(
5082
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5083
				'readonly'      => true,
5084
				'value'         => $user_data['ID'],
5085
			);
5086
			$options['jetpack_user_login'] = array(
5087
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5088
				'readonly'      => true,
5089
				'value'         => $user_data['login'],
5090
			);
5091
			$options['jetpack_user_email'] = array(
5092
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5093
				'readonly'      => true,
5094
				'value'         => $user_data['email'],
5095
			);
5096
			$options['jetpack_user_site_count'] = array(
5097
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5098
				'readonly'      => true,
5099
				'value'         => $user_data['site_count'],
5100
			);
5101
		}
5102
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5103
		$args = stripslashes_deep( $args );
5104
		return $wp_xmlrpc_server->wp_getOptions( $args );
5105
	}
5106
5107
	function xmlrpc_options( $options ) {
5108
		$jetpack_client_id = false;
5109
		if ( self::is_active() ) {
5110
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5111
		}
5112
		$options['jetpack_version'] = array(
5113
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5114
				'readonly'      => true,
5115
				'value'         => JETPACK__VERSION,
5116
		);
5117
5118
		$options['jetpack_client_id'] = array(
5119
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5120
				'readonly'      => true,
5121
				'value'         => $jetpack_client_id,
5122
		);
5123
		return $options;
5124
	}
5125
5126
	public static function clean_nonces( $all = false ) {
5127
		global $wpdb;
5128
5129
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5130
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5131
5132
		if ( true !== $all ) {
5133
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5134
			$sql_args[] = time() - 3600;
5135
		}
5136
5137
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5138
5139
		$sql = $wpdb->prepare( $sql, $sql_args );
5140
5141
		for ( $i = 0; $i < 1000; $i++ ) {
5142
			if ( ! $wpdb->query( $sql ) ) {
5143
				break;
5144
			}
5145
		}
5146
	}
5147
5148
	/**
5149
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5150
	 * SET: state( $key, $value );
5151
	 * GET: $value = state( $key );
5152
	 *
5153
	 * @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...
5154
	 * @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...
5155
	 * @param bool $restate private
5156
	 */
5157
	public static function state( $key = null, $value = null, $restate = false ) {
5158
		static $state = array();
5159
		static $path, $domain;
5160
		if ( ! isset( $path ) ) {
5161
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5162
			$admin_url = Jetpack::admin_url();
5163
			$bits      = parse_url( $admin_url );
5164
5165
			if ( is_array( $bits ) ) {
5166
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5167
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5168
			} else {
5169
				$path = $domain = null;
5170
			}
5171
		}
5172
5173
		// Extract state from cookies and delete cookies
5174
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5175
			$yum = $_COOKIE[ 'jetpackState' ];
5176
			unset( $_COOKIE[ 'jetpackState' ] );
5177
			foreach ( $yum as $k => $v ) {
5178
				if ( strlen( $v ) )
5179
					$state[ $k ] = $v;
5180
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5181
			}
5182
		}
5183
5184
		if ( $restate ) {
5185
			foreach ( $state as $k => $v ) {
5186
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5187
			}
5188
			return;
5189
		}
5190
5191
		// Get a state variable
5192
		if ( isset( $key ) && ! isset( $value ) ) {
5193
			if ( array_key_exists( $key, $state ) )
5194
				return $state[ $key ];
5195
			return null;
5196
		}
5197
5198
		// Set a state variable
5199
		if ( isset ( $key ) && isset( $value ) ) {
5200
			if( is_array( $value ) && isset( $value[0] ) ) {
5201
				$value = $value[0];
5202
			}
5203
			$state[ $key ] = $value;
5204
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5205
		}
5206
	}
5207
5208
	public static function restate() {
5209
		Jetpack::state( null, null, true );
5210
	}
5211
5212
	public static function check_privacy( $file ) {
5213
		static $is_site_publicly_accessible = null;
5214
5215
		if ( is_null( $is_site_publicly_accessible ) ) {
5216
			$is_site_publicly_accessible = false;
5217
5218
			Jetpack::load_xml_rpc_client();
5219
			$rpc = new Jetpack_IXR_Client();
5220
5221
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5222
			if ( $success ) {
5223
				$response = $rpc->getResponse();
5224
				if ( $response ) {
5225
					$is_site_publicly_accessible = true;
5226
				}
5227
			}
5228
5229
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5230
		}
5231
5232
		if ( $is_site_publicly_accessible ) {
5233
			return;
5234
		}
5235
5236
		$module_slug = self::get_module_slug( $file );
5237
5238
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5239
		if ( ! $privacy_checks ) {
5240
			$privacy_checks = $module_slug;
5241
		} else {
5242
			$privacy_checks .= ",$module_slug";
5243
		}
5244
5245
		Jetpack::state( 'privacy_checks', $privacy_checks );
5246
	}
5247
5248
	/**
5249
	 * Helper method for multicall XMLRPC.
5250
	 */
5251
	public static function xmlrpc_async_call() {
5252
		global $blog_id;
5253
		static $clients = array();
5254
5255
		$client_blog_id = is_multisite() ? $blog_id : 0;
5256
5257
		if ( ! isset( $clients[$client_blog_id] ) ) {
5258
			Jetpack::load_xml_rpc_client();
5259
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5260
			if ( function_exists( 'ignore_user_abort' ) ) {
5261
				ignore_user_abort( true );
5262
			}
5263
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5264
		}
5265
5266
		$args = func_get_args();
5267
5268
		if ( ! empty( $args[0] ) ) {
5269
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5270
		} elseif ( is_multisite() ) {
5271
			foreach ( $clients as $client_blog_id => $client ) {
5272
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5273
					continue;
5274
				}
5275
5276
				$switch_success = switch_to_blog( $client_blog_id, true );
5277
				if ( ! $switch_success ) {
5278
					continue;
5279
				}
5280
5281
				flush();
5282
				$client->query();
5283
5284
				restore_current_blog();
5285
			}
5286
		} else {
5287
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5288
				flush();
5289
				$clients[0]->query();
5290
			}
5291
		}
5292
	}
5293
5294
	public static function staticize_subdomain( $url ) {
5295
5296
		// Extract hostname from URL
5297
		$host = parse_url( $url, PHP_URL_HOST );
5298
5299
		// Explode hostname on '.'
5300
		$exploded_host = explode( '.', $host );
5301
5302
		// Retrieve the name and TLD
5303
		if ( count( $exploded_host ) > 1 ) {
5304
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5305
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5306
			// Rebuild domain excluding subdomains
5307
			$domain = $name . '.' . $tld;
5308
		} else {
5309
			$domain = $host;
5310
		}
5311
		// Array of Automattic domains
5312
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5313
5314
		// Return $url if not an Automattic domain
5315
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5316
			return $url;
5317
		}
5318
5319
		if ( is_ssl() ) {
5320
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5321
		}
5322
5323
		srand( crc32( basename( $url ) ) );
5324
		$static_counter = rand( 0, 2 );
5325
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5326
5327
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5328
	}
5329
5330
/* JSON API Authorization */
5331
5332
	/**
5333
	 * Handles the login action for Authorizing the JSON API
5334
	 */
5335
	function login_form_json_api_authorization() {
5336
		$this->verify_json_api_authorization_request();
5337
5338
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5339
5340
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5341
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5342
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5343
	}
5344
5345
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5346
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5347
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5348
			return $url;
5349
		}
5350
5351
		$parsed_url = parse_url( $url );
5352
		$url = strtok( $url, '?' );
5353
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5354
		if ( ! empty( $parsed_url['query'] ) )
5355
			$url .= "&{$parsed_url['query']}";
5356
5357
		return $url;
5358
	}
5359
5360
	// Make sure the POSTed request is handled by the same action
5361
	function preserve_action_in_login_form_for_json_api_authorization() {
5362
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5363
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5364
	}
5365
5366
	// If someone logs in to approve API access, store the Access Code in usermeta
5367
	function store_json_api_authorization_token( $user_login, $user ) {
5368
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5369
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5370
		$token = wp_generate_password( 32, false );
5371
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5372
	}
5373
5374
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5375
	function allow_wpcom_public_api_domain( $domains ) {
5376
		$domains[] = 'public-api.wordpress.com';
5377
		return $domains;
5378
	}
5379
5380
	// Add the Access Code details to the public-api.wordpress.com redirect
5381
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5382
		return add_query_arg(
5383
			urlencode_deep(
5384
				array(
5385
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5386
					'jetpack-user-id' => (int) $user->ID,
5387
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5388
				)
5389
			),
5390
			$redirect_to
5391
		);
5392
	}
5393
5394
5395
	/**
5396
	 * Verifies the request by checking the signature
5397
	 *
5398
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5399
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5400
	 *
5401
	 * @param null|array $environment
5402
	 */
5403
	function verify_json_api_authorization_request( $environment = null ) {
5404
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5405
5406
		$environment = is_null( $environment )
5407
			? $_REQUEST
5408
			: $environment;
5409
5410
		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...
5411
		$token = Jetpack_Data::get_access_token( $envUserId );
5412
		if ( ! $token || empty( $token->secret ) ) {
5413
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5414
		}
5415
5416
		$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' );
5417
5418
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5419
5420
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5421
			$signature = $jetpack_signature->sign_request(
5422
				$environment['token'],
5423
				$environment['timestamp'],
5424
				$environment['nonce'],
5425
				'',
5426
				'GET',
5427
				$environment['jetpack_json_api_original_query'],
5428
				null,
5429
				true
5430
			);
5431
		} else {
5432
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5433
		}
5434
5435
		if ( ! $signature ) {
5436
			wp_die( $die_error );
5437
		} else if ( is_wp_error( $signature ) ) {
5438
			wp_die( $die_error );
5439
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5440
			if ( is_ssl() ) {
5441
				// 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
5442
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5443
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5444
					wp_die( $die_error );
5445
				}
5446
			} else {
5447
				wp_die( $die_error );
5448
			}
5449
		}
5450
5451
		$timestamp = (int) $environment['timestamp'];
5452
		$nonce     = stripslashes( (string) $environment['nonce'] );
5453
5454
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5455
			// De-nonce the nonce, at least for 5 minutes.
5456
			// 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)
5457
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5458
			if ( $old_nonce_time < time() - 300 ) {
5459
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5460
			}
5461
		}
5462
5463
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5464
		$data_filters = array(
5465
			'state'        => 'opaque',
5466
			'client_id'    => 'int',
5467
			'client_title' => 'string',
5468
			'client_image' => 'url',
5469
		);
5470
5471
		foreach ( $data_filters as $key => $sanitation ) {
5472
			if ( ! isset( $data->$key ) ) {
5473
				wp_die( $die_error );
5474
			}
5475
5476
			switch ( $sanitation ) {
5477
			case 'int' :
5478
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5479
				break;
5480
			case 'opaque' :
5481
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5482
				break;
5483
			case 'string' :
5484
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5485
				break;
5486
			case 'url' :
5487
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5488
				break;
5489
			}
5490
		}
5491
5492
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5493
			wp_die( $die_error );
5494
		}
5495
	}
5496
5497
	function login_message_json_api_authorization( $message ) {
0 ignored issues
show
Unused Code introduced by
The parameter $message is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
5498
		return '<p class="message">' . sprintf(
5499
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5500
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5501
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5502
	}
5503
5504
	/**
5505
	 * Get $content_width, but with a <s>twist</s> filter.
5506
	 */
5507
	public static function get_content_width() {
5508
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5509
		/**
5510
		 * Filter the Content Width value.
5511
		 *
5512
		 * @since 2.2.3
5513
		 *
5514
		 * @param string $content_width Content Width value.
5515
		 */
5516
		return apply_filters( 'jetpack_content_width', $content_width );
5517
	}
5518
5519
	/**
5520
	 * Pings the WordPress.com Mirror Site for the specified options.
5521
	 *
5522
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5523
	 *
5524
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5525
	 */
5526
	public function get_cloud_site_options( $option_names ) {
5527
		$option_names = array_filter( (array) $option_names, 'is_string' );
5528
5529
		Jetpack::load_xml_rpc_client();
5530
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5531
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5532
		if ( $xml->isError() ) {
5533
			return array(
5534
				'error_code' => $xml->getErrorCode(),
5535
				'error_msg'  => $xml->getErrorMessage(),
5536
			);
5537
		}
5538
		$cloud_site_options = $xml->getResponse();
5539
5540
		return $cloud_site_options;
5541
	}
5542
5543
	/**
5544
	 * Checks if the site is currently in an identity crisis.
5545
	 *
5546
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5547
	 */
5548
	public static function check_identity_crisis() {
5549
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5550
			return false;
5551
		}
5552
5553
		return Jetpack_Options::get_option( 'sync_error_idc' );
5554
	}
5555
5556
	/**
5557
	 * Checks whether the home and siteurl specifically are whitelisted
5558
	 * Written so that we don't have re-check $key and $value params every time
5559
	 * we want to check if this site is whitelisted, for example in footer.php
5560
	 *
5561
	 * @since  3.8.0
5562
	 * @return bool True = already whitelisted False = not whitelisted
5563
	 */
5564
	public static function is_staging_site() {
5565
		$is_staging = false;
5566
5567
		$known_staging = array(
5568
			'urls' => array(
5569
				'#\.staging\.wpengine\.com$#i', // WP Engine
5570
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5571
				),
5572
			'constants' => array(
5573
				'IS_WPE_SNAPSHOT',      // WP Engine
5574
				'KINSTA_DEV_ENV',       // Kinsta.com
5575
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5576
				'JETPACK_STAGING_MODE', // Generic
5577
				)
5578
			);
5579
		/**
5580
		 * Filters the flags of known staging sites.
5581
		 *
5582
		 * @since 3.9.0
5583
		 *
5584
		 * @param array $known_staging {
5585
		 *     An array of arrays that each are used to check if the current site is staging.
5586
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5587
		 *     @type array $constants PHP constants of known staging/developement environments.
5588
		 *  }
5589
		 */
5590
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5591
5592
		if ( isset( $known_staging['urls'] ) ) {
5593
			foreach ( $known_staging['urls'] as $url ){
5594
				if ( preg_match( $url, site_url() ) ) {
5595
					$is_staging = true;
5596
					break;
5597
				}
5598
			}
5599
		}
5600
5601
		if ( isset( $known_staging['constants'] ) ) {
5602
			foreach ( $known_staging['constants'] as $constant ) {
5603
				if ( defined( $constant ) && constant( $constant ) ) {
5604
					$is_staging = true;
5605
				}
5606
			}
5607
		}
5608
5609
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5610
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5611
			$is_staging = true;
5612
		}
5613
5614
		/**
5615
		 * Filters is_staging_site check.
5616
		 *
5617
		 * @since 3.9.0
5618
		 *
5619
		 * @param bool $is_staging If the current site is a staging site.
5620
		 */
5621
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5622
	}
5623
5624
	/**
5625
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5626
	 *
5627
	 * @return bool
5628
	 */
5629
	public static function validate_sync_error_idc_option() {
5630
		$is_valid = false;
5631
5632
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5633
		if ( false === $idc_allowed ) {
5634
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5635
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5636
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5637
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5638
				$transient_duration = HOUR_IN_SECONDS;
5639
			} else {
5640
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5641
				$idc_allowed = '1';
5642
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5643
			}
5644
5645
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5646
		}
5647
5648
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5649
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5650
		$local_options = self::get_sync_error_idc_option();
5651
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5652
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5653
				$is_valid = true;
5654
			}
5655
		}
5656
5657
		/**
5658
		 * Filters whether the sync_error_idc option is valid.
5659
		 *
5660
		 * @since 4.4.0
5661
		 *
5662
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5663
		 */
5664
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5665
5666
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5667
			// Since the option exists, and did not validate, delete it
5668
			Jetpack_Options::delete_option( 'sync_error_idc' );
5669
		}
5670
5671
		return $is_valid;
5672
	}
5673
5674
	/**
5675
	 * Normalizes a url by doing three things:
5676
	 *  - Strips protocol
5677
	 *  - Strips www
5678
	 *  - Adds a trailing slash
5679
	 *
5680
	 * @since 4.4.0
5681
	 * @param string $url
5682
	 * @return WP_Error|string
5683
	 */
5684
	public static function normalize_url_protocol_agnostic( $url ) {
5685
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5686
		if ( ! $parsed_url ) {
5687
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5688
		}
5689
5690
		// Strip www and protocols
5691
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5692
		return $url;
5693
	}
5694
5695
	/**
5696
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5697
	 *
5698
	 * @since 4.4.0
5699
	 *
5700
	 * @param array $response
5701
	 * @return array Array of the local urls, wpcom urls, and error code
5702
	 */
5703
	public static function get_sync_error_idc_option( $response = array() ) {
5704
		$local_options = array(
5705
			'home' => get_home_url(),
5706
			'siteurl' => get_site_url(),
5707
		);
5708
5709
		$options = array_merge( $local_options, $response );
5710
5711
		$returned_values = array();
5712
		foreach( $options as $key => $option ) {
5713
			if ( 'error_code' === $key ) {
5714
				$returned_values[ $key ] = $option;
5715
				continue;
5716
			}
5717
5718
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5719
				continue;
5720
			}
5721
5722
			$returned_values[ $key ] = $normalized_url;
5723
		}
5724
5725
		return $returned_values;
5726
	}
5727
5728
	/**
5729
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5730
	 * If set to true, the site will be put into staging mode.
5731
	 *
5732
	 * @since 4.3.2
5733
	 * @return bool
5734
	 */
5735
	public static function sync_idc_optin() {
5736
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5737
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5738
		} else {
5739
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5740
		}
5741
5742
		/**
5743
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5744
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5745
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5746
		 *
5747
		 * @since 4.3.2
5748
		 *
5749
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5750
		 */
5751
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5752
	}
5753
5754
	/**
5755
	 * Maybe Use a .min.css stylesheet, maybe not.
5756
	 *
5757
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5758
	 */
5759
	public static function maybe_min_asset( $url, $path, $plugin ) {
5760
		// Short out on things trying to find actual paths.
5761
		if ( ! $path || empty( $plugin ) ) {
5762
			return $url;
5763
		}
5764
5765
		// Strip out the abspath.
5766
		$base = dirname( plugin_basename( $plugin ) );
5767
5768
		// Short out on non-Jetpack assets.
5769
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5770
			return $url;
5771
		}
5772
5773
		// File name parsing.
5774
		$file              = "{$base}/{$path}";
5775
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5776
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5777
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5778
		$extension         = array_shift( $file_name_parts_r );
5779
5780
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5781
			// Already pointing at the minified version.
5782
			if ( 'min' === $file_name_parts_r[0] ) {
5783
				return $url;
5784
			}
5785
5786
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5787
			if ( file_exists( $min_full_path ) ) {
5788
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5789
			}
5790
		}
5791
5792
		return $url;
5793
	}
5794
5795
	/**
5796
	 * Maybe inlines a stylesheet.
5797
	 *
5798
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5799
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5800
	 *
5801
	 * Attached to `style_loader_tag` filter.
5802
	 *
5803
	 * @param string $tag The tag that would link to the external asset.
5804
	 * @param string $handle The registered handle of the script in question.
5805
	 *
5806
	 * @return string
5807
	 */
5808
	public static function maybe_inline_style( $tag, $handle ) {
5809
		global $wp_styles;
5810
		$item = $wp_styles->registered[ $handle ];
5811
5812
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5813
			return $tag;
5814
		}
5815
5816
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5817
			$href = $matches[1];
5818
			// Strip off query string
5819
			if ( $pos = strpos( $href, '?' ) ) {
5820
				$href = substr( $href, 0, $pos );
5821
			}
5822
			// Strip off fragment
5823
			if ( $pos = strpos( $href, '#' ) ) {
5824
				$href = substr( $href, 0, $pos );
5825
			}
5826
		} else {
5827
			return $tag;
5828
		}
5829
5830
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5831
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5832
			return $tag;
5833
		}
5834
5835
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5836
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5837
			// And this isn't the pass that actually deals with the RTL version...
5838
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5839
				// Short out, as the RTL version will deal with it in a moment.
5840
				return $tag;
5841
			}
5842
		}
5843
5844
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5845
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5846
		if ( $css ) {
5847
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5848
			if ( empty( $item->extra['after'] ) ) {
5849
				wp_add_inline_style( $handle, $css );
5850
			} else {
5851
				array_unshift( $item->extra['after'], $css );
5852
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5853
			}
5854
		}
5855
5856
		return $tag;
5857
	}
5858
5859
	/**
5860
	 * Loads a view file from the views
5861
	 *
5862
	 * Data passed in with the $data parameter will be available in the
5863
	 * template file as $data['value']
5864
	 *
5865
	 * @param string $template - Template file to load
5866
	 * @param array $data - Any data to pass along to the template
5867
	 * @return boolean - If template file was found
5868
	 **/
5869
	public function load_view( $template, $data = array() ) {
5870
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5871
5872
		if( file_exists( $views_dir . $template ) ) {
5873
			require_once( $views_dir . $template );
5874
			return true;
5875
		}
5876
5877
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5878
		return false;
5879
	}
5880
5881
	/**
5882
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5883
	 */
5884
	public function deprecated_hooks() {
5885
		global $wp_filter;
5886
5887
		/*
5888
		 * Format:
5889
		 * deprecated_filter_name => replacement_name
5890
		 *
5891
		 * If there is no replacement, use null for replacement_name
5892
		 */
5893
		$deprecated_list = array(
5894
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5895
			'wpl_sharing_2014_1'                                     => null,
5896
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5897
			'jetpack_identity_crisis_options_to_check'               => null,
5898
			'update_option_jetpack_single_user_site'                 => null,
5899
			'audio_player_default_colors'                            => null,
5900
			'add_option_jetpack_featured_images_enabled'             => null,
5901
			'add_option_jetpack_update_details'                      => null,
5902
			'add_option_jetpack_updates'                             => null,
5903
			'add_option_jetpack_network_name'                        => null,
5904
			'add_option_jetpack_network_allow_new_registrations'     => null,
5905
			'add_option_jetpack_network_add_new_users'               => null,
5906
			'add_option_jetpack_network_site_upload_space'           => null,
5907
			'add_option_jetpack_network_upload_file_types'           => null,
5908
			'add_option_jetpack_network_enable_administration_menus' => null,
5909
			'add_option_jetpack_is_multi_site'                       => null,
5910
			'add_option_jetpack_is_main_network'                     => null,
5911
			'add_option_jetpack_main_network_site'                   => null,
5912
			'jetpack_sync_all_registered_options'                    => null,
5913
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5914
			'jetpack_is_post_mailable'                               => null,
5915
		);
5916
5917
		// This is a silly loop depth. Better way?
5918
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5919
			if ( has_action( $hook ) ) {
5920
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5921
					foreach( $values AS $hooked ) {
5922
						if ( is_callable( $hooked['function'] ) ) {
5923
							$function_name = 'an anonymous function';
5924
						} else {
5925
							$function_name = $hooked['function'];
5926
						}
5927
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
5928
					}
5929
				}
5930
			}
5931
		}
5932
	}
5933
5934
	/**
5935
	 * Converts any url in a stylesheet, to the correct absolute url.
5936
	 *
5937
	 * Considerations:
5938
	 *  - Normal, relative URLs     `feh.png`
5939
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
5940
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
5941
	 *  - Absolute URLs             `http://domain.com/feh.png`
5942
	 *  - Domain root relative URLs `/feh.png`
5943
	 *
5944
	 * @param $css string: The raw CSS -- should be read in directly from the file.
5945
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
5946
	 *
5947
	 * @return mixed|string
5948
	 */
5949
	public static function absolutize_css_urls( $css, $css_file_url ) {
5950
		$pattern = '#url\((?P<path>[^)]*)\)#i';
5951
		$css_dir = dirname( $css_file_url );
5952
		$p       = parse_url( $css_dir );
5953
		$domain  = sprintf(
5954
					'%1$s//%2$s%3$s%4$s',
5955
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
5956
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
5957
					$p['host'],
5958
					isset( $p['port'] )             ? ":{$p['port']}" : ''
5959
				);
5960
5961
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
5962
			$find = $replace = array();
5963
			foreach ( $matches as $match ) {
5964
				$url = trim( $match['path'], "'\" \t" );
5965
5966
				// If this is a data url, we don't want to mess with it.
5967
				if ( 'data:' === substr( $url, 0, 5 ) ) {
5968
					continue;
5969
				}
5970
5971
				// If this is an absolute or protocol-agnostic url,
5972
				// we don't want to mess with it.
5973
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
5974
					continue;
5975
				}
5976
5977
				switch ( substr( $url, 0, 1 ) ) {
5978
					case '/':
5979
						$absolute = $domain . $url;
5980
						break;
5981
					default:
5982
						$absolute = $css_dir . '/' . $url;
5983
				}
5984
5985
				$find[]    = $match[0];
5986
				$replace[] = sprintf( 'url("%s")', $absolute );
5987
			}
5988
			$css = str_replace( $find, $replace, $css );
5989
		}
5990
5991
		return $css;
5992
	}
5993
5994
	/**
5995
	 * This methods removes all of the registered css files on the front end
5996
	 * from Jetpack in favor of using a single file. In effect "imploding"
5997
	 * all the files into one file.
5998
	 *
5999
	 * Pros:
6000
	 * - Uses only ONE css asset connection instead of 15
6001
	 * - Saves a minimum of 56k
6002
	 * - Reduces server load
6003
	 * - Reduces time to first painted byte
6004
	 *
6005
	 * Cons:
6006
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6007
	 *		should not cause any issues with themes.
6008
	 * - Plugins/themes dequeuing styles no longer do anything. See
6009
	 *		jetpack_implode_frontend_css filter for a workaround
6010
	 *
6011
	 * For some situations developers may wish to disable css imploding and
6012
	 * instead operate in legacy mode where each file loads seperately and
6013
	 * can be edited individually or dequeued. This can be accomplished with
6014
	 * the following line:
6015
	 *
6016
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6017
	 *
6018
	 * @since 3.2
6019
	 **/
6020
	public function implode_frontend_css( $travis_test = false ) {
6021
		$do_implode = true;
6022
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6023
			$do_implode = false;
6024
		}
6025
6026
		/**
6027
		 * Allow CSS to be concatenated into a single jetpack.css file.
6028
		 *
6029
		 * @since 3.2.0
6030
		 *
6031
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6032
		 */
6033
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6034
6035
		// Do not use the imploded file when default behaviour was altered through the filter
6036
		if ( ! $do_implode ) {
6037
			return;
6038
		}
6039
6040
		// We do not want to use the imploded file in dev mode, or if not connected
6041
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6042
			if ( ! $travis_test ) {
6043
				return;
6044
			}
6045
		}
6046
6047
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6048
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6049
			return;
6050
		}
6051
6052
		/*
6053
		 * Now we assume Jetpack is connected and able to serve the single
6054
		 * file.
6055
		 *
6056
		 * In the future there will be a check here to serve the file locally
6057
		 * or potentially from the Jetpack CDN
6058
		 *
6059
		 * For now:
6060
		 * - Enqueue a single imploded css file
6061
		 * - Zero out the style_loader_tag for the bundled ones
6062
		 * - Be happy, drink scotch
6063
		 */
6064
6065
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6066
6067
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6068
6069
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6070
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6071
	}
6072
6073
	function concat_remove_style_loader_tag( $tag, $handle ) {
6074
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6075
			$tag = '';
6076
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6077
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6078
			}
6079
		}
6080
6081
		return $tag;
6082
	}
6083
6084
	/*
6085
	 * Check the heartbeat data
6086
	 *
6087
	 * Organizes the heartbeat data by severity.  For example, if the site
6088
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6089
	 *
6090
	 * Data will be added to "caution" array, if it either:
6091
	 *  - Out of date Jetpack version
6092
	 *  - Out of date WP version
6093
	 *  - Out of date PHP version
6094
	 *
6095
	 * $return array $filtered_data
6096
	 */
6097
	public static function jetpack_check_heartbeat_data() {
6098
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6099
6100
		$good    = array();
6101
		$caution = array();
6102
		$bad     = array();
6103
6104
		foreach ( $raw_data as $stat => $value ) {
6105
6106
			// Check jetpack version
6107
			if ( 'version' == $stat ) {
6108
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6109
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6110
					continue;
6111
				}
6112
			}
6113
6114
			// Check WP version
6115
			if ( 'wp-version' == $stat ) {
6116
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6117
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6118
					continue;
6119
				}
6120
			}
6121
6122
			// Check PHP version
6123
			if ( 'php-version' == $stat ) {
6124
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6125
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6126
					continue;
6127
				}
6128
			}
6129
6130
			// Check ID crisis
6131
			if ( 'identitycrisis' == $stat ) {
6132
				if ( 'yes' == $value ) {
6133
					$bad[ $stat ] = $value;
6134
					continue;
6135
				}
6136
			}
6137
6138
			// The rest are good :)
6139
			$good[ $stat ] = $value;
6140
		}
6141
6142
		$filtered_data = array(
6143
			'good'    => $good,
6144
			'caution' => $caution,
6145
			'bad'     => $bad
6146
		);
6147
6148
		return $filtered_data;
6149
	}
6150
6151
6152
	/*
6153
	 * This method is used to organize all options that can be reset
6154
	 * without disconnecting Jetpack.
6155
	 *
6156
	 * It is used in class.jetpack-cli.php to reset options
6157
	 *
6158
	 * @return array of options to delete.
6159
	 */
6160
	public static function get_jetpack_options_for_reset() {
6161
		$jetpack_options            = Jetpack_Options::get_option_names();
6162
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6163
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6164
6165
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6166
6167
		// A manual build of the wp options
6168
		$wp_options = array(
6169
			'sharing-options',
6170
			'disabled_likes',
6171
			'disabled_reblogs',
6172
			'jetpack_comments_likes_enabled',
6173
			'wp_mobile_excerpt',
6174
			'wp_mobile_featured_images',
6175
			'wp_mobile_app_promos',
6176
			'stats_options',
6177
			'stats_dashboard_widget',
6178
			'safecss_preview_rev',
6179
			'safecss_rev',
6180
			'safecss_revision_migrated',
6181
			'nova_menu_order',
6182
			'jetpack_portfolio',
6183
			'jetpack_portfolio_posts_per_page',
6184
			'jetpack_testimonial',
6185
			'jetpack_testimonial_posts_per_page',
6186
			'wp_mobile_custom_css',
6187
			'sharedaddy_disable_resources',
6188
			'sharing-options',
6189
			'sharing-services',
6190
			'site_icon_temp_data',
6191
			'featured-content',
6192
			'site_logo',
6193
			'jetpack_dismissed_notices',
6194
		);
6195
6196
		// Flag some Jetpack options as unsafe
6197
		$unsafe_options = array(
6198
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6199
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6200
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6201
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6202
6203
			// non_compact
6204
			'activated',
6205
6206
			// private
6207
			'register',
6208
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6209
			'user_token',                  // (string) The User Token of this site. (deprecated)
6210
			'user_tokens'
6211
		);
6212
6213
		// Remove the unsafe Jetpack options
6214
		foreach ( $unsafe_options as $unsafe_option ) {
6215
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6216
				unset( $all_jp_options[ $key ] );
6217
			}
6218
		}
6219
6220
		$options = array(
6221
			'jp_options' => $all_jp_options,
6222
			'wp_options' => $wp_options
6223
		);
6224
6225
		return $options;
6226
	}
6227
6228
	/**
6229
	 * Check if an option of a Jetpack module has been updated.
6230
	 *
6231
	 * If any module option has been updated before Jump Start has been dismissed,
6232
	 * update the 'jumpstart' option so we can hide Jump Start.
6233
	 *
6234
	 * @param string $option_name
6235
	 *
6236
	 * @return bool
6237
	 */
6238
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6239
		// Bail if Jump Start has already been dismissed
6240
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6241
			return false;
6242
		}
6243
6244
		$jetpack = Jetpack::init();
6245
6246
		// Manual build of module options
6247
		$option_names = self::get_jetpack_options_for_reset();
6248
6249
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6250
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6251
6252
			//Jump start is being dismissed send data to MC Stats
6253
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6254
6255
			$jetpack->do_stats( 'server_side' );
6256
		}
6257
6258
	}
6259
6260
	/*
6261
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6262
	 * so we can bring them directly to their site in calypso.
6263
	 *
6264
	 * @param string | url
6265
	 * @return string | url without the guff
6266
	 */
6267
	public static function build_raw_urls( $url ) {
6268
		$strip_http = '/.*?:\/\//i';
6269
		$url = preg_replace( $strip_http, '', $url  );
6270
		$url = str_replace( '/', '::', $url );
6271
		return $url;
6272
	}
6273
6274
	/**
6275
	 * Stores and prints out domains to prefetch for page speed optimization.
6276
	 *
6277
	 * @param mixed $new_urls
6278
	 */
6279
	public static function dns_prefetch( $new_urls = null ) {
6280
		static $prefetch_urls = array();
6281
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6282
			echo "\r\n";
6283
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6284
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6285
			}
6286
		} elseif ( ! empty( $new_urls ) ) {
6287
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6288
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6289
			}
6290
			foreach ( (array) $new_urls as $this_new_url ) {
6291
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6292
			}
6293
			$prefetch_urls = array_unique( $prefetch_urls );
6294
		}
6295
	}
6296
6297
	public function wp_dashboard_setup() {
6298
		if ( self::is_active() ) {
6299
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6300
			$widget_title = __( 'Site Stats', 'jetpack' );
6301
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6302
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6303
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6304
		}
6305
6306
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6307
			wp_add_dashboard_widget(
6308
				'jetpack_summary_widget',
6309
				$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...
6310
				array( __CLASS__, 'dashboard_widget' )
6311
			);
6312
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6313
6314
			// If we're inactive and not in development mode, sort our box to the top.
6315
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6316
				global $wp_meta_boxes;
6317
6318
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6319
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6320
6321
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6322
			}
6323
		}
6324
	}
6325
6326
	/**
6327
	 * @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...
6328
	 * @return mixed
6329
	 */
6330
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6331
		if ( ! is_array( $sorted ) ) {
6332
			return $sorted;
6333
		}
6334
6335
		foreach ( $sorted as $box_context => $ids ) {
6336
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6337
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6338
				continue;
6339
			}
6340
6341
			$ids_array = explode( ',', $ids );
6342
			$key = array_search( 'dashboard_stats', $ids_array );
6343
6344
			if ( false !== $key ) {
6345
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6346
				$ids_array[ $key ] = 'jetpack_summary_widget';
6347
				$sorted[ $box_context ] = implode( ',', $ids_array );
6348
				// We've found it, stop searching, and just return.
6349
				break;
6350
			}
6351
		}
6352
6353
		return $sorted;
6354
	}
6355
6356
	public static function dashboard_widget() {
6357
		/**
6358
		 * Fires when the dashboard is loaded.
6359
		 *
6360
		 * @since 3.4.0
6361
		 */
6362
		do_action( 'jetpack_dashboard_widget' );
6363
	}
6364
6365
	public static function dashboard_widget_footer() {
6366
		?>
6367
		<footer>
6368
6369
		<div class="protect">
6370
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6371
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6372
				<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>
6373
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6374
				<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' ); ?>">
6375
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6376
				</a>
6377
			<?php else : ?>
6378
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6379
			<?php endif; ?>
6380
		</div>
6381
6382
		<div class="akismet">
6383
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6384
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6385
				<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>
6386
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6387
				<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">
6388
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6389
				</a>
6390
			<?php else : ?>
6391
				<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>
6392
			<?php endif; ?>
6393
		</div>
6394
6395
		</footer>
6396
		<?php
6397
	}
6398
6399
	public function dashboard_widget_connect_to_wpcom() {
6400
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6401
			return;
6402
		}
6403
		?>
6404
		<div class="wpcom-connect">
6405
			<div class="jp-emblem">
6406
			<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" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve">
6407
				<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"/>
6408
			</svg>
6409
			</div>
6410
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6411
			<p><?php echo wp_kses( __( 'Connecting Jetpack will show you <strong>stats</strong> about your traffic, <strong>protect</strong> you from brute force attacks, <strong>speed up</strong> your images and photos, and enable other <strong>traffic and security</strong> features.', 'jetpack' ), 'jetpack' ) ?></p>
6412
6413
			<div class="actions">
6414
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6415
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6416
				</a>
6417
			</div>
6418
		</div>
6419
		<?php
6420
	}
6421
6422
	/**
6423
	 * Return string containing the Jetpack logo.
6424
	 *
6425
	 * @since 3.9.0
6426
	 *
6427
	 * @return string
6428
	 */
6429
	public static function get_jp_emblem() {
6430
		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" 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>';
6431
	}
6432
6433
	/*
6434
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6435
	 */
6436
	function jetpack_icon_user_connected( $columns ) {
6437
		$columns['user_jetpack'] = '';
6438
		return $columns;
6439
	}
6440
6441
	/*
6442
	 * Show Jetpack icon if the user is linked.
6443
	 */
6444
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6445
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6446
			$emblem_html = sprintf(
6447
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6448
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6449
				Jetpack::get_jp_emblem()
6450
			);
6451
			return $emblem_html;
6452
		}
6453
6454
		return $val;
6455
	}
6456
6457
	/*
6458
	 * Style the Jetpack user column
6459
	 */
6460
	function jetpack_user_col_style() {
6461
		global $current_screen;
6462
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6463
			<style>
6464
				.fixed .column-user_jetpack {
6465
					width: 21px;
6466
				}
6467
				.jp-emblem-user-admin svg {
6468
					width: 20px;
6469
					height: 20px;
6470
				}
6471
				.jp-emblem-user-admin path {
6472
					fill: #8cc258;
6473
				}
6474
			</style>
6475
		<?php }
6476
	}
6477
}
6478