Completed
Push — fix/load-issues-on-server-clus... ( f29d65 )
by
unknown
12:13
created

Jetpack::get_file_data()   C

Complexity

Conditions 8
Paths 9

Size

Total Lines 37
Code Lines 18

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 8
eloc 18
nc 9
nop 2
dl 0
loc 37
rs 5.3846
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
				Jetpack::maybe_set_version_option();
357
358
				add_action(
359
					'jetpack_modules_loaded',
360
					array( __CLASS__, 'upgrade_on_module_load' )
361
				);
362
			}
363
		}
364
	}
365
366
	/**
367
	 * Runs upgrade routines that need to have modules loaded.
368
	 */
369
	static function upgrade_on_module_load() {
370
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
371
			add_action(
372
				'wp_loaded',
373
				array( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' )
374
			);
375
		}
376
	}
377
378
	static function activate_manage( ) {
379
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
380
			self::activate_module( 'manage', false, false );
381
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
382
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
383
		}
384
	}
385
386
	static function update_active_modules( $modules ) {
387
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
388
389
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
390
391
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
392
			$new_active_modules = array_diff( $modules, $current_modules );
393
			foreach( $new_active_modules as $module ) {
394
				/**
395
				 * Fires when a specific module is activated.
396
				 *
397
				 * @since 1.9.0
398
				 *
399
				 * @param string $module Module slug.
400
				 * @param boolean $success whether the module was activated. @since 4.2
401
				 */
402
				do_action( 'jetpack_activate_module', $module, $success );
403
404
				/**
405
				 * Fires when a module is activated.
406
				 * The dynamic part of the filter, $module, is the module slug.
407
				 *
408
				 * @since 1.9.0
409
				 *
410
				 * @param string $module Module slug.
411
				 */
412
				do_action( "jetpack_activate_module_$module", $module );
413
			}
414
415
			$new_deactive_modules = array_diff( $current_modules, $modules );
416
			foreach( $new_deactive_modules as $module ) {
417
				/**
418
				 * Fired after a module has been deactivated.
419
				 *
420
				 * @since 4.2.0
421
				 *
422
				 * @param string $module Module slug.
423
				 * @param boolean $success whether the module was deactivated.
424
				 */
425
				do_action( 'jetpack_deactivate_module', $module, $success );
426
				/**
427
				 * Fires when a module is deactivated.
428
				 * The dynamic part of the filter, $module, is the module slug.
429
				 *
430
				 * @since 1.9.0
431
				 *
432
				 * @param string $module Module slug.
433
				 */
434
				do_action( "jetpack_deactivate_module_$module", $module );
435
			}
436
		}
437
438
		return $success;
439
	}
440
441
	static function delete_active_modules() {
442
		self::update_active_modules( array() );
443
	}
444
445
	/**
446
	 * Constructor.  Initializes WordPress hooks
447
	 */
448
	private function __construct() {
449
		/*
450
		 * Check for and alert any deprecated hooks
451
		 */
452
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
453
454
		/*
455
		 * Load things that should only be in Network Admin.
456
		 *
457
		 * For now blow away everything else until a more full
458
		 * understanding of what is needed at the network level is
459
		 * available
460
		 */
461
		if( is_multisite() ) {
462
			Jetpack_Network::init();
463
		}
464
465
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
466
467
		// Unlink user before deleting the user from .com
468
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
469
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
470
471
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
472
			@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...
473
474
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
475
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
476
477
			$this->require_jetpack_authentication();
478
479
			if ( Jetpack::is_active() ) {
480
				// Hack to preserve $HTTP_RAW_POST_DATA
481
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
482
483
				$signed = $this->verify_xml_rpc_signature();
484
				if ( $signed && ! is_wp_error( $signed ) ) {
485
					// The actual API methods.
486
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
487
				} else {
488
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
489
					// active Jetpack connection, so that additional users can link their account.
490
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
491
				}
492
			} else {
493
				// The bootstrap API methods.
494
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
495
			}
496
497
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
498
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
499
		} elseif (
500
			is_admin() &&
501
			isset( $_POST['action'] ) && (
502
				'jetpack_upload_file' == $_POST['action'] ||
503
				'jetpack_update_file' == $_POST['action']
504
			)
505
		) {
506
			$this->require_jetpack_authentication();
507
			$this->add_remote_request_handlers();
508
		} else {
509
			if ( Jetpack::is_active() ) {
510
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
511
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
512
			}
513
		}
514
515
		if ( Jetpack::is_active() ) {
516
			Jetpack_Heartbeat::init();
517
		}
518
519
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
520
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
521
522
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
523
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
524
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
525
		}
526
527
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
528
529
		add_action( 'admin_init', array( $this, 'admin_init' ) );
530
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
531
532
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
533
534
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
535
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
536
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
537
538
		// returns HTTPS support status
539
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
540
541
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
542
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
543
544
		// JITM AJAX callback function
545
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
546
547
		// Universal ajax callback for all tracking events triggered via js
548
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
549
550
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
551
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
552
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
553
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
554
555
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
556
557
		/**
558
		 * These actions run checks to load additional files.
559
		 * They check for external files or plugins, so they need to run as late as possible.
560
		 */
561
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
562
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
563
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
564
565
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
566
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
567
568
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
569
570
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
571
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
572
573
		// A filter to control all just in time messages
574
		add_filter( 'jetpack_just_in_time_msgs', '__return_true' );
575
576
		// Update the Jetpack plan from API on heartbeats
577
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
578
579
		/**
580
		 * This is the hack to concatinate all css files into one.
581
		 * For description and reasoning see the implode_frontend_css method
582
		 *
583
		 * Super late priority so we catch all the registered styles
584
		 */
585
		if( !is_admin() ) {
586
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
587
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
588
		}
589
	}
590
591
	function jetpack_admin_ajax_tracks_callback() {
592
		// Check for nonce
593
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
594
			wp_die( 'Permissions check failed.' );
595
		}
596
597
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
598
			wp_die( 'No valid event name or type.' );
599
		}
600
601
		$tracks_data = array();
602
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
603
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
604
		}
605
606
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
607
		wp_send_json_success();
608
		wp_die();
609
	}
610
611
	/**
612
	 * The callback for the JITM ajax requests.
613
	 */
614
	function jetpack_jitm_ajax_callback() {
615
		// Check for nonce
616
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
617
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
618
		}
619
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
620
			$module_slug = $_REQUEST['jitmModule'];
621
			Jetpack::log( 'activate', $module_slug );
622
			Jetpack::activate_module( $module_slug, false, false );
623
			Jetpack::state( 'message', 'no_message' );
624
625
			//A Jetpack module is being activated through a JITM, track it
626
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
627
			$this->do_stats( 'server_side' );
628
629
			wp_send_json_success();
630
		}
631
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
632
			// get the hide_jitm options array
633
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
634
			$module_slug = $_REQUEST['jitmModule'];
635
636
			if( ! $jetpack_hide_jitm ) {
637
				$jetpack_hide_jitm = array(
638
					$module_slug => 'hide'
639
				);
640
			} else {
641
				$jetpack_hide_jitm[$module_slug] = 'hide';
642
			}
643
644
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
645
646
			//jitm is being dismissed forever, track it
647
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
648
			$this->do_stats( 'server_side' );
649
650
			wp_send_json_success();
651
		}
652 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
653
			$module_slug = $_REQUEST['jitmModule'];
654
655
			// User went to WordPress.com, track this
656
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
657
			$this->do_stats( 'server_side' );
658
659
			wp_send_json_success();
660
		}
661 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
662
			$track = $_REQUEST['jitmModule'];
663
664
			// User is viewing JITM, track it.
665
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
666
			$this->do_stats( 'server_side' );
667
668
			wp_send_json_success();
669
		}
670
	}
671
672
	/**
673
	 * If there are any stats that need to be pushed, but haven't been, push them now.
674
	 */
675
	function __destruct() {
676
		if ( ! empty( $this->stats ) ) {
677
			$this->do_stats( 'server_side' );
678
		}
679
	}
680
681
	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...
682
		switch( $cap ) {
683
			case 'jetpack_connect' :
684
			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...
685
				if ( Jetpack::is_development_mode() ) {
686
					$caps = array( 'do_not_allow' );
687
					break;
688
				}
689
				/**
690
				 * Pass through. If it's not development mode, these should match disconnect.
691
				 * Let users disconnect if it's development mode, just in case things glitch.
692
				 */
693
			case 'jetpack_disconnect' :
694
				/**
695
				 * In multisite, can individual site admins manage their own connection?
696
				 *
697
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
698
				 */
699
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
700
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
701
						/**
702
						 * We need to update the option name -- it's terribly unclear which
703
						 * direction the override goes.
704
						 *
705
						 * @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...
706
						 */
707
						$caps = array( 'do_not_allow' );
708
						break;
709
					}
710
				}
711
712
				$caps = array( 'manage_options' );
713
				break;
714
			case 'jetpack_manage_modules' :
715
			case 'jetpack_activate_modules' :
716
			case 'jetpack_deactivate_modules' :
717
				$caps = array( 'manage_options' );
718
				break;
719
			case 'jetpack_configure_modules' :
720
				$caps = array( 'manage_options' );
721
				break;
722
			case 'jetpack_network_admin_page':
723
			case 'jetpack_network_settings_page':
724
				$caps = array( 'manage_network_plugins' );
725
				break;
726
			case 'jetpack_network_sites_page':
727
				$caps = array( 'manage_sites' );
728
				break;
729
			case 'jetpack_admin_page' :
730
				if ( Jetpack::is_development_mode() ) {
731
					$caps = array( 'manage_options' );
732
					break;
733
				} else {
734
					$caps = array( 'read' );
735
				}
736
				break;
737
			case 'jetpack_connect_user' :
738
				if ( Jetpack::is_development_mode() ) {
739
					$caps = array( 'do_not_allow' );
740
					break;
741
				}
742
				$caps = array( 'read' );
743
				break;
744
		}
745
		return $caps;
746
	}
747
748
	function require_jetpack_authentication() {
749
		// Don't let anyone authenticate
750
		$_COOKIE = array();
751
		remove_all_filters( 'authenticate' );
752
		remove_all_actions( 'wp_login_failed' );
753
754
		if ( Jetpack::is_active() ) {
755
			// Allow Jetpack authentication
756
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
757
		}
758
	}
759
760
	/**
761
	 * Load language files
762
	 * @action plugins_loaded
763
	 */
764
	public static function plugin_textdomain() {
765
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
766
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
767
	}
768
769
	/**
770
	 * Register assets for use in various modules and the Jetpack admin page.
771
	 *
772
	 * @uses wp_script_is, wp_register_script, plugins_url
773
	 * @action wp_loaded
774
	 * @return null
775
	 */
776
	public function register_assets() {
777
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
778
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
779
		}
780
781 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
782
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
783
		}
784
785 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
786
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
787
		}
788
789 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
790
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
791
		}
792
793
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
794
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
795
796
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
797
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
798
			if ( ! is_numeric( $fb_app_id ) ) {
799
				$fb_app_id = '';
800
			}
801
			wp_localize_script(
802
				'jetpack-facebook-embed',
803
				'jpfbembed',
804
				array(
805
					'appid' => $fb_app_id,
806
					'locale' => $this->get_locale(),
807
				)
808
			);
809
		}
810
811
		/**
812
		 * As jetpack_register_genericons is by default fired off a hook,
813
		 * the hook may have already fired by this point.
814
		 * So, let's just trigger it manually.
815
		 */
816
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
817
		jetpack_register_genericons();
818
819
		/**
820
		 * Register the social logos
821
		 */
822
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
823
		jetpack_register_social_logos();
824
825 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
826
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
827
	}
828
829
	/**
830
	 * Guess locale from language code.
831
	 *
832
	 * @param string $lang Language code.
833
	 * @return string|bool
834
	 */
835 View Code Duplication
	function guess_locale_from_lang( $lang ) {
836
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
837
			return 'en_US';
838
		}
839
840
		if ( ! class_exists( 'GP_Locales' ) ) {
841
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
842
				return false;
843
			}
844
845
			require JETPACK__GLOTPRESS_LOCALES_PATH;
846
		}
847
848
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
849
			// WP.com: get_locale() returns 'it'
850
			$locale = GP_Locales::by_slug( $lang );
851
		} else {
852
			// Jetpack: get_locale() returns 'it_IT';
853
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
854
		}
855
856
		if ( ! $locale ) {
857
			return false;
858
		}
859
860
		if ( empty( $locale->facebook_locale ) ) {
861
			if ( empty( $locale->wp_locale ) ) {
862
				return false;
863
			} else {
864
				// Facebook SDK is smart enough to fall back to en_US if a
865
				// locale isn't supported. Since supported Facebook locales
866
				// can fall out of sync, we'll attempt to use the known
867
				// wp_locale value and rely on said fallback.
868
				return $locale->wp_locale;
869
			}
870
		}
871
872
		return $locale->facebook_locale;
873
	}
874
875
	/**
876
	 * Get the locale.
877
	 *
878
	 * @return string|bool
879
	 */
880
	function get_locale() {
881
		$locale = $this->guess_locale_from_lang( get_locale() );
882
883
		if ( ! $locale ) {
884
			$locale = 'en_US';
885
		}
886
887
		return $locale;
888
	}
889
890
	/**
891
	 * Device Pixels support
892
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
893
	 */
894
	function devicepx() {
895
		if ( Jetpack::is_active() ) {
896
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
897
		}
898
	}
899
900
	/**
901
	 * Return the network_site_url so that .com knows what network this site is a part of.
902
	 * @param  bool $option
903
	 * @return string
904
	 */
905
	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...
906
		return network_site_url();
907
	}
908
	/**
909
	 * Network Name.
910
	 */
911
	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...
912
		global $current_site;
913
		return $current_site->site_name;
914
	}
915
	/**
916
	 * Does the network allow new user and site registrations.
917
	 * @return string
918
	 */
919
	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...
920
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
921
	}
922
	/**
923
	 * Does the network allow admins to add new users.
924
	 * @return boolian
925
	 */
926
	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...
927
		return (bool) get_site_option( 'add_new_users' );
928
	}
929
	/**
930
	 * File upload psace left per site in MB.
931
	 *  -1 means NO LIMIT.
932
	 * @return number
933
	 */
934
	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...
935
		// value in MB
936
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
937
	}
938
939
	/**
940
	 * Network allowed file types.
941
	 * @return string
942
	 */
943
	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...
944
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
945
	}
946
947
	/**
948
	 * Maximum file upload size set by the network.
949
	 * @return number
950
	 */
951
	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...
952
		// value in KB
953
		return get_site_option( 'fileupload_maxk', 300 );
954
	}
955
956
	/**
957
	 * Lets us know if a site allows admins to manage the network.
958
	 * @return array
959
	 */
960
	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...
961
		return get_site_option( 'menu_items' );
962
	}
963
964
	/**
965
	 * If a user has been promoted to or demoted from admin, we need to clear the
966
	 * jetpack_other_linked_admins transient.
967
	 *
968
	 * @since 4.3.2
969
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
970
	 *
971
	 * @param int    $user_id   The user ID whose role changed.
972
	 * @param string $role      The new role.
973
	 * @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...
974
	 */
975
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
976
		if ( 'administrator' == $role
977
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
978
			|| is_null( $old_roles )
979
		) {
980
			delete_transient( 'jetpack_other_linked_admins' );
981
		}
982
	}
983
984
	/**
985
	 * Checks to see if there are any other users available to become primary
986
	 * Users must both:
987
	 * - Be linked to wpcom
988
	 * - Be an admin
989
	 *
990
	 * @return mixed False if no other users are linked, Int if there are.
991
	 */
992
	static function get_other_linked_admins() {
993
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
994
995
		if ( false === $other_linked_users ) {
996
			$admins = get_users( array( 'role' => 'administrator' ) );
997
			if ( count( $admins ) > 1 ) {
998
				$available = array();
999
				foreach ( $admins as $admin ) {
1000
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1001
						$available[] = $admin->ID;
1002
					}
1003
				}
1004
1005
				$count_connected_admins = count( $available );
1006
				if ( count( $available ) > 1 ) {
1007
					$other_linked_users = $count_connected_admins;
1008
				} else {
1009
					$other_linked_users = 0;
1010
				}
1011
			} else {
1012
				$other_linked_users = 0;
1013
			}
1014
1015
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1016
		}
1017
1018
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1019
	}
1020
1021
	/**
1022
	 * Return whether we are dealing with a multi network setup or not.
1023
	 * The reason we are type casting this is because we want to avoid the situation where
1024
	 * the result is false since when is_main_network_option return false it cases
1025
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1026
	 * database which could be set to anything as opposed to what this function returns.
1027
	 * @param  bool  $option
1028
	 *
1029
	 * @return boolean
1030
	 */
1031
	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...
1032
		// return '1' or ''
1033
		return (string) (bool) Jetpack::is_multi_network();
1034
	}
1035
1036
	/**
1037
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1038
	 *
1039
	 * @param  string  $option
1040
	 * @return boolean
1041
	 */
1042
	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...
1043
		return (string) (bool) is_multisite();
1044
	}
1045
1046
	/**
1047
	 * Implemented since there is no core is multi network function
1048
	 * Right now there is no way to tell if we which network is the dominant network on the system
1049
	 *
1050
	 * @since  3.3
1051
	 * @return boolean
1052
	 */
1053
	public static function is_multi_network() {
1054
		global  $wpdb;
1055
1056
		// if we don't have a multi site setup no need to do any more
1057
		if ( ! is_multisite() ) {
1058
			return false;
1059
		}
1060
1061
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1062
		if ( $num_sites > 1 ) {
1063
			return true;
1064
		} else {
1065
			return false;
1066
		}
1067
	}
1068
1069
	/**
1070
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1071
	 * @return null
1072
	 */
1073
	function update_jetpack_main_network_site_option() {
1074
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1075
	}
1076
	/**
1077
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1078
	 *
1079
	 */
1080
	function update_jetpack_network_settings() {
1081
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1082
		// Only sync this info for the main network site.
1083
	}
1084
1085
	/**
1086
	 * Get back if the current site is single user site.
1087
	 *
1088
	 * @return bool
1089
	 */
1090
	public static function is_single_user_site() {
1091
		global $wpdb;
1092
1093 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1094
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1095
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1096
		}
1097
		return 1 === (int) $some_users;
1098
	}
1099
1100
	/**
1101
	 * Returns true if the site has file write access false otherwise.
1102
	 * @return string ( '1' | '0' )
1103
	 **/
1104
	public static function file_system_write_access() {
1105
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1106
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1107
		}
1108
1109
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1110
1111
		$filesystem_method = get_filesystem_method();
1112
		if ( $filesystem_method === 'direct' ) {
1113
			return 1;
1114
		}
1115
1116
		ob_start();
1117
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1118
		ob_end_clean();
1119
		if ( $filesystem_credentials_are_stored ) {
1120
			return 1;
1121
		}
1122
		return 0;
1123
	}
1124
1125
	/**
1126
	 * Finds out if a site is using a version control system.
1127
	 * @return string ( '1' | '0' )
1128
	 **/
1129
	public static function is_version_controlled() {
1130
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1131
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1132
	}
1133
1134
	/**
1135
	 * Determines whether the current theme supports featured images or not.
1136
	 * @return string ( '1' | '0' )
1137
	 */
1138
	public static function featured_images_enabled() {
1139
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1140
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1141
	}
1142
1143
	/**
1144
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1145
	 *
1146
	 * @deprecated 4.7 use get_avatar_url instead.
1147
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1148
	 * @param int $size Size of the avatar image
1149
	 * @param string $default URL to a default image to use if no avatar is available
1150
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1151
	 *
1152
	 * @return array
1153
	 */
1154
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1155
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1156
		return get_avatar_url( $id_or_email, array(
1157
			'size' => $size,
1158
			'default' => $default,
1159
			'force_default' => $force_display,
1160
		) );
1161
	}
1162
1163
	/**
1164
	 * jetpack_updates is saved in the following schema:
1165
	 *
1166
	 * array (
1167
	 *      'plugins'                       => (int) Number of plugin updates available.
1168
	 *      'themes'                        => (int) Number of theme updates available.
1169
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1170
	 *      'translations'                  => (int) Number of translation updates available.
1171
	 *      'total'                         => (int) Total of all available updates.
1172
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1173
	 * )
1174
	 * @return array
1175
	 */
1176
	public static function get_updates() {
1177
		$update_data = wp_get_update_data();
1178
1179
		// Stores the individual update counts as well as the total count.
1180
		if ( isset( $update_data['counts'] ) ) {
1181
			$updates = $update_data['counts'];
1182
		}
1183
1184
		// If we need to update WordPress core, let's find the latest version number.
1185 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1186
			$cur = get_preferred_from_update_core();
1187
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1188
				$updates['wp_update_version'] = $cur->current;
1189
			}
1190
		}
1191
		return isset( $updates ) ? $updates : array();
1192
	}
1193
1194
	public static function get_update_details() {
1195
		$update_details = array(
1196
			'update_core' => get_site_transient( 'update_core' ),
1197
			'update_plugins' => get_site_transient( 'update_plugins' ),
1198
			'update_themes' => get_site_transient( 'update_themes' ),
1199
		);
1200
		return $update_details;
1201
	}
1202
1203
	public static function refresh_update_data() {
1204
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1205
1206
	}
1207
1208
	public static function refresh_theme_data() {
1209
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1210
	}
1211
1212
	/**
1213
	 * Is Jetpack active?
1214
	 */
1215
	public static function is_active() {
1216
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1217
	}
1218
1219
	/**
1220
	 * Make an API call to WordPress.com for plan status
1221
	 *
1222
	 * @uses Jetpack_Options::get_option()
1223
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1224
	 * @uses update_option()
1225
	 *
1226
	 * @access public
1227
	 * @static
1228
	 *
1229
	 * @return bool True if plan is updated, false if no update
1230
	 */
1231
	public static function refresh_active_plan_from_wpcom() {
1232
		// Make the API request
1233
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1234
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1235
1236
		// Bail if there was an error or malformed response
1237
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1238
			return false;
1239
		}
1240
1241
		// Decode the results
1242
		$results = json_decode( $response['body'], true );
1243
1244
		// Bail if there were no results or plan details returned
1245
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1246
			return false;
1247
		}
1248
1249
		// Store the option and return true if updated
1250
		return update_option( 'jetpack_active_plan', $results['plan'] );
1251
	}
1252
1253
	/**
1254
	 * Get the plan that this Jetpack site is currently using
1255
	 *
1256
	 * @uses get_option()
1257
	 *
1258
	 * @access public
1259
	 * @static
1260
	 *
1261
	 * @return array Active Jetpack plan details
1262
	 */
1263
	public static function get_active_plan() {
1264
		$plan = get_option( 'jetpack_active_plan' );
1265
1266
		// Set the default options
1267
		if ( ! $plan ) {
1268
			$plan = array(
1269
				'product_slug' => 'jetpack_free',
1270
				'supports'     => array(),
1271
				'class'        => 'free',
1272
			);
1273
		}
1274
1275
		// Define what paid modules are supported by personal plans
1276
		$personal_plans = array(
1277
			'jetpack_personal',
1278
			'jetpack_personal_monthly',
1279
		);
1280
1281
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1282
			$plan['supports'] = array(
1283
				'akismet',
1284
			);
1285
			$plan['class'] = 'personal';
1286
		}
1287
1288
		// Define what paid modules are supported by premium plans
1289
		$premium_plans = array(
1290
			'jetpack_premium',
1291
			'jetpack_premium_monthly',
1292
		);
1293
1294 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1295
			$plan['supports'] = array(
1296
				'videopress',
1297
				'akismet',
1298
				'vaultpress',
1299
				'wordads',
1300
			);
1301
			$plan['class'] = 'premium';
1302
		}
1303
1304
		// Define what paid modules are supported by professional plans
1305
		$business_plans = array(
1306
			'jetpack_business',
1307
			'jetpack_business_monthly',
1308
		);
1309
1310 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1311
			$plan['supports'] = array(
1312
				'videopress',
1313
				'akismet',
1314
				'vaultpress',
1315
				'seo-tools',
1316
				'google-analytics',
1317
				'wordads',
1318
			);
1319
			$plan['class'] = 'business';
1320
		}
1321
1322
		// Make sure we have an array here in the event database data is stale
1323
		if ( ! isset( $plan['supports'] ) ) {
1324
			$plan['supports'] = array();
1325
		}
1326
1327
		return $plan;
1328
	}
1329
1330
	/**
1331
	 * Determine whether the active plan supports a particular feature
1332
	 *
1333
	 * @uses Jetpack::get_active_plan()
1334
	 *
1335
	 * @access public
1336
	 * @static
1337
	 *
1338
	 * @return bool True if plan supports feature, false if not
1339
	 */
1340
	public static function active_plan_supports( $feature ) {
1341
		$plan = Jetpack::get_active_plan();
1342
1343
		if ( in_array( $feature, $plan['supports'] ) ) {
1344
			return true;
1345
		}
1346
1347
		return false;
1348
	}
1349
1350
	/**
1351
	 * Is Jetpack in development (offline) mode?
1352
	 */
1353
	public static function is_development_mode() {
1354
		$development_mode = false;
1355
1356
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1357
			$development_mode = JETPACK_DEV_DEBUG;
1358
		} elseif ( $site_url = site_url() ) {
1359
			$development_mode = false === strpos( $site_url, '.' );
1360
		}
1361
1362
		/**
1363
		 * Filters Jetpack's development mode.
1364
		 *
1365
		 * @see https://jetpack.com/support/development-mode/
1366
		 *
1367
		 * @since 2.2.1
1368
		 *
1369
		 * @param bool $development_mode Is Jetpack's development mode active.
1370
		 */
1371
		return apply_filters( 'jetpack_development_mode', $development_mode );
1372
	}
1373
1374
	/**
1375
	* Get Jetpack development mode notice text and notice class.
1376
	*
1377
	* Mirrors the checks made in Jetpack::is_development_mode
1378
	*
1379
	*/
1380
	public static function show_development_mode_notice() {
1381
		if ( Jetpack::is_development_mode() ) {
1382
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1383
				$notice = sprintf(
1384
					/* translators: %s is a URL */
1385
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1386
					'https://jetpack.com/support/development-mode/'
1387
				);
1388
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1389
				$notice = sprintf(
1390
					/* translators: %s is a URL */
1391
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1392
					'https://jetpack.com/support/development-mode/'
1393
				);
1394
			} else {
1395
				$notice = sprintf(
1396
					/* translators: %s is a URL */
1397
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1398
					'https://jetpack.com/support/development-mode/'
1399
				);
1400
			}
1401
1402
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1403
		}
1404
1405
		// Throw up a notice if using a development version and as for feedback.
1406
		if ( Jetpack::is_development_version() ) {
1407
			/* translators: %s is a URL */
1408
			$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/' );
1409
1410
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1411
		}
1412
		// Throw up a notice if using staging mode
1413
		if ( Jetpack::is_staging_site() ) {
1414
			/* translators: %s is a URL */
1415
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1416
1417
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1418
		}
1419
	}
1420
1421
	/**
1422
	 * Whether Jetpack's version maps to a public release, or a development version.
1423
	 */
1424
	public static function is_development_version() {
1425
		/**
1426
		 * Allows filtering whether this is a development version of Jetpack.
1427
		 *
1428
		 * This filter is especially useful for tests.
1429
		 *
1430
		 * @since 4.3.0
1431
		 *
1432
		 * @param bool $development_version Is this a develoment version of Jetpack?
1433
		 */
1434
		return (bool) apply_filters(
1435
			'jetpack_development_version',
1436
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1437
		);
1438
	}
1439
1440
	/**
1441
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1442
	 */
1443
	public static function is_user_connected( $user_id = false ) {
1444
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1445
		if ( ! $user_id ) {
1446
			return false;
1447
		}
1448
1449
		return (bool) Jetpack_Data::get_access_token( $user_id );
1450
	}
1451
1452
	/**
1453
	 * Get the wpcom user data of the current|specified connected user.
1454
	 */
1455
	public static function get_connected_user_data( $user_id = null ) {
1456
		if ( ! $user_id ) {
1457
			$user_id = get_current_user_id();
1458
		}
1459
1460
		$transient_key = "jetpack_connected_user_data_$user_id";
1461
1462
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1463
			return $cached_user_data;
1464
		}
1465
1466
		Jetpack::load_xml_rpc_client();
1467
		$xml = new Jetpack_IXR_Client( array(
1468
			'user_id' => $user_id,
1469
		) );
1470
		$xml->query( 'wpcom.getUser' );
1471
		if ( ! $xml->isError() ) {
1472
			$user_data = $xml->getResponse();
1473
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1474
			return $user_data;
1475
		}
1476
1477
		return false;
1478
	}
1479
1480
	/**
1481
	 * Get the wpcom email of the current|specified connected user.
1482
	 */
1483 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1484
		if ( ! $user_id ) {
1485
			$user_id = get_current_user_id();
1486
		}
1487
		Jetpack::load_xml_rpc_client();
1488
		$xml = new Jetpack_IXR_Client( array(
1489
			'user_id' => $user_id,
1490
		) );
1491
		$xml->query( 'wpcom.getUserEmail' );
1492
		if ( ! $xml->isError() ) {
1493
			return $xml->getResponse();
1494
		}
1495
		return false;
1496
	}
1497
1498
	/**
1499
	 * Get the wpcom email of the master user.
1500
	 */
1501
	public static function get_master_user_email() {
1502
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1503
		if ( $master_user_id ) {
1504
			return self::get_connected_user_email( $master_user_id );
1505
		}
1506
		return '';
1507
	}
1508
1509
	function current_user_is_connection_owner() {
1510
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1511
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1512
	}
1513
1514
	/**
1515
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1516
	 */
1517
	function extra_oembed_providers() {
1518
		// Cloudup: https://dev.cloudup.com/#oembed
1519
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1520
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1521
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1522
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1523
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1524
	}
1525
1526
	/**
1527
	 * Synchronize connected user role changes
1528
	 */
1529
	function user_role_change( $user_id ) {
1530
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1531
		Jetpack_Sync_Users::user_role_change( $user_id );
1532
	}
1533
1534
	/**
1535
	 * Loads the currently active modules.
1536
	 */
1537
	public static function load_modules() {
1538
		if ( ! self::is_active() && !self::is_development_mode() ) {
1539
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1540
				return;
1541
			}
1542
		}
1543
1544
		$version = Jetpack_Options::get_option( 'version' );
1545 View Code Duplication
		if ( ! $version ) {
1546
			$version = $old_version = JETPACK__VERSION . ':' . time();
1547
			/** This action is documented in class.jetpack.php */
1548
			do_action( 'updating_jetpack_version', $version, false );
1549
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1550
		}
1551
		list( $version ) = explode( ':', $version );
1552
1553
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1554
1555
		$modules_data = array();
1556
1557
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1558
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1559
			$updated_modules = array();
1560
			foreach ( $modules as $module ) {
1561
				$modules_data[ $module ] = Jetpack::get_module( $module );
1562
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1563
					continue;
1564
				}
1565
1566
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1567
					continue;
1568
				}
1569
1570
				$updated_modules[] = $module;
1571
			}
1572
1573
			$modules = array_diff( $modules, $updated_modules );
1574
		}
1575
1576
		$is_development_mode = Jetpack::is_development_mode();
1577
1578
		foreach ( $modules as $index => $module ) {
1579
			// If we're in dev mode, disable modules requiring a connection
1580
			if ( $is_development_mode ) {
1581
				// Prime the pump if we need to
1582
				if ( empty( $modules_data[ $module ] ) ) {
1583
					$modules_data[ $module ] = Jetpack::get_module( $module );
1584
				}
1585
				// If the module requires a connection, but we're in local mode, don't include it.
1586
				if ( $modules_data[ $module ]['requires_connection'] ) {
1587
					continue;
1588
				}
1589
			}
1590
1591
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1592
				continue;
1593
			}
1594
1595
			if ( ! @include( Jetpack::get_module_path( $module ) ) ) {
1596
				unset( $modules[ $index ] );
1597
				self::update_active_modules( array_values( $modules ) );
1598
				continue;
1599
			}
1600
1601
			/**
1602
			 * Fires when a specific module is loaded.
1603
			 * The dynamic part of the hook, $module, is the module slug.
1604
			 *
1605
			 * @since 1.1.0
1606
			 */
1607
			do_action( 'jetpack_module_loaded_' . $module );
1608
		}
1609
1610
		/**
1611
		 * Fires when all the modules are loaded.
1612
		 *
1613
		 * @since 1.1.0
1614
		 */
1615
		do_action( 'jetpack_modules_loaded' );
1616
1617
		// 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.
1618
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1619
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1620
	}
1621
1622
	/**
1623
	 * Check if Jetpack's REST API compat file should be included
1624
	 * @action plugins_loaded
1625
	 * @return null
1626
	 */
1627
	public function check_rest_api_compat() {
1628
		/**
1629
		 * Filters the list of REST API compat files to be included.
1630
		 *
1631
		 * @since 2.2.5
1632
		 *
1633
		 * @param array $args Array of REST API compat files to include.
1634
		 */
1635
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1636
1637
		if ( function_exists( 'bbpress' ) )
1638
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1639
1640
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1641
			require_once $_jetpack_rest_api_compat_include;
1642
	}
1643
1644
	/**
1645
	 * Gets all plugins currently active in values, regardless of whether they're
1646
	 * traditionally activated or network activated.
1647
	 *
1648
	 * @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...
1649
	 */
1650
	public static function get_active_plugins() {
1651
		$active_plugins = (array) get_option( 'active_plugins', array() );
1652
1653
		if ( is_multisite() ) {
1654
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1655
			// whereas active_plugins stores them in the values.
1656
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1657
			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...
1658
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1659
			}
1660
		}
1661
1662
		sort( $active_plugins );
1663
1664
		return array_unique( $active_plugins );
1665
	}
1666
1667
	/**
1668
	 * Gets and parses additional plugin data to send with the heartbeat data
1669
	 *
1670
	 * @since 3.8.1
1671
	 *
1672
	 * @return array Array of plugin data
1673
	 */
1674
	public static function get_parsed_plugin_data() {
1675
		if ( ! function_exists( 'get_plugins' ) ) {
1676
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1677
		}
1678
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1679
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1680
		$active_plugins = Jetpack::get_active_plugins();
1681
1682
		$plugins = array();
1683
		foreach ( $all_plugins as $path => $plugin_data ) {
1684
			$plugins[ $path ] = array(
1685
					'is_active' => in_array( $path, $active_plugins ),
1686
					'file'      => $path,
1687
					'name'      => $plugin_data['Name'],
1688
					'version'   => $plugin_data['Version'],
1689
					'author'    => $plugin_data['Author'],
1690
			);
1691
		}
1692
1693
		return $plugins;
1694
	}
1695
1696
	/**
1697
	 * Gets and parses theme data to send with the heartbeat data
1698
	 *
1699
	 * @since 3.8.1
1700
	 *
1701
	 * @return array Array of theme data
1702
	 */
1703
	public static function get_parsed_theme_data() {
1704
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1705
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1706
1707
		$themes = array();
1708
		foreach ( $all_themes as $slug => $theme_data ) {
1709
			$theme_headers = array();
1710
			foreach ( $header_keys as $header_key ) {
1711
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1712
			}
1713
1714
			$themes[ $slug ] = array(
1715
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1716
					'slug' => $slug,
1717
					'theme_root' => $theme_data->get_theme_root_uri(),
1718
					'parent' => $theme_data->parent(),
1719
					'headers' => $theme_headers
1720
			);
1721
		}
1722
1723
		return $themes;
1724
	}
1725
1726
	/**
1727
	 * Checks whether a specific plugin is active.
1728
	 *
1729
	 * We don't want to store these in a static variable, in case
1730
	 * there are switch_to_blog() calls involved.
1731
	 */
1732
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1733
		return in_array( $plugin, self::get_active_plugins() );
1734
	}
1735
1736
	/**
1737
	 * Check if Jetpack's Open Graph tags should be used.
1738
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1739
	 *
1740
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1741
	 * @action plugins_loaded
1742
	 * @return null
1743
	 */
1744
	public function check_open_graph() {
1745
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1746
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1747
		}
1748
1749
		$active_plugins = self::get_active_plugins();
1750
1751
		if ( ! empty( $active_plugins ) ) {
1752
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1753
				if ( in_array( $plugin, $active_plugins ) ) {
1754
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1755
					break;
1756
				}
1757
			}
1758
		}
1759
1760
		/**
1761
		 * Allow the addition of Open Graph Meta Tags to all pages.
1762
		 *
1763
		 * @since 2.0.3
1764
		 *
1765
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1766
		 */
1767
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1768
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1769
		}
1770
	}
1771
1772
	/**
1773
	 * Check if Jetpack's Twitter tags should be used.
1774
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1775
	 *
1776
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1777
	 * @action plugins_loaded
1778
	 * @return null
1779
	 */
1780
	public function check_twitter_tags() {
1781
1782
		$active_plugins = self::get_active_plugins();
1783
1784
		if ( ! empty( $active_plugins ) ) {
1785
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1786
				if ( in_array( $plugin, $active_plugins ) ) {
1787
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1788
					break;
1789
				}
1790
			}
1791
		}
1792
1793
		/**
1794
		 * Allow Twitter Card Meta tags to be disabled.
1795
		 *
1796
		 * @since 2.6.0
1797
		 *
1798
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1799
		 */
1800
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1801
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1802
		}
1803
	}
1804
1805
	/**
1806
	 * Allows plugins to submit security reports.
1807
 	 *
1808
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1809
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1810
	 * @param array   $args         See definitions above
1811
	 */
1812
	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...
1813
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1814
	}
1815
1816
/* Jetpack Options API */
1817
1818
	public static function get_option_names( $type = 'compact' ) {
1819
		return Jetpack_Options::get_option_names( $type );
1820
	}
1821
1822
	/**
1823
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1824
 	 *
1825
	 * @param string $name    Option name
1826
	 * @param mixed  $default (optional)
1827
	 */
1828
	public static function get_option( $name, $default = false ) {
1829
		return Jetpack_Options::get_option( $name, $default );
1830
	}
1831
1832
	/**
1833
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1834
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1835
	* $name must be a registered option name.
1836
	*/
1837
	public static function create_nonce( $name ) {
1838
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1839
1840
		Jetpack_Options::update_option( $name, $secret );
1841
		@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...
1842
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1843
			return new Jetpack_Error( 'missing_secrets' );
1844
1845
		return array(
1846
			'secret_1' => $secret_1,
1847
			'secret_2' => $secret_2,
1848
			'eol'      => $eol,
1849
		);
1850
	}
1851
1852
	/**
1853
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1854
 	 *
1855
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1856
	 * @param string $name  Option name
1857
	 * @param mixed  $value Option value
1858
	 */
1859
	public static function update_option( $name, $value ) {
1860
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1861
		return Jetpack_Options::update_option( $name, $value );
1862
	}
1863
1864
	/**
1865
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1866
 	 *
1867
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1868
	 * @param array $array array( option name => option value, ... )
1869
	 */
1870
	public static function update_options( $array ) {
1871
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1872
		return Jetpack_Options::update_options( $array );
1873
	}
1874
1875
	/**
1876
	 * Deletes the given option.  May be passed multiple option names as an array.
1877
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1878
	 *
1879
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1880
	 * @param string|array $names
1881
	 */
1882
	public static function delete_option( $names ) {
1883
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1884
		return Jetpack_Options::delete_option( $names );
1885
	}
1886
1887
	/**
1888
	 * Enters a user token into the user_tokens option
1889
	 *
1890
	 * @param int $user_id
1891
	 * @param string $token
1892
	 * return bool
1893
	 */
1894
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1895
		// not designed for concurrent updates
1896
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1897
		if ( ! is_array( $user_tokens ) )
1898
			$user_tokens = array();
1899
		$user_tokens[$user_id] = $token;
1900
		if ( $is_master_user ) {
1901
			$master_user = $user_id;
1902
			$options     = compact( 'user_tokens', 'master_user' );
1903
		} else {
1904
			$options = compact( 'user_tokens' );
1905
		}
1906
		return Jetpack_Options::update_options( $options );
1907
	}
1908
1909
	/**
1910
	 * Returns an array of all PHP files in the specified absolute path.
1911
	 * Equivalent to glob( "$absolute_path/*.php" ).
1912
	 *
1913
	 * @param string $absolute_path The absolute path of the directory to search.
1914
	 * @return array Array of absolute paths to the PHP files.
1915
	 */
1916
	public static function glob_php( $absolute_path ) {
1917
		if ( function_exists( 'glob' ) ) {
1918
			return glob( "$absolute_path/*.php" );
1919
		}
1920
1921
		$absolute_path = untrailingslashit( $absolute_path );
1922
		$files = array();
1923
		if ( ! $dir = @opendir( $absolute_path ) ) {
1924
			return $files;
1925
		}
1926
1927
		while ( false !== $file = readdir( $dir ) ) {
1928
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1929
				continue;
1930
			}
1931
1932
			$file = "$absolute_path/$file";
1933
1934
			if ( ! is_file( $file ) ) {
1935
				continue;
1936
			}
1937
1938
			$files[] = $file;
1939
		}
1940
1941
		closedir( $dir );
1942
1943
		return $files;
1944
	}
1945
1946
	public static function activate_new_modules( $redirect = false ) {
1947
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1948
			return;
1949
		}
1950
1951
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1952 View Code Duplication
		if ( ! $jetpack_old_version ) {
1953
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1954
			/** This action is documented in class.jetpack.php */
1955
			do_action( 'updating_jetpack_version', $version, false );
1956
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1957
		}
1958
1959
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1960
1961
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1962
			return;
1963
		}
1964
1965
		$active_modules     = Jetpack::get_active_modules();
1966
		$reactivate_modules = array();
1967
		foreach ( $active_modules as $active_module ) {
1968
			$module = Jetpack::get_module( $active_module );
1969
			if ( ! isset( $module['changed'] ) ) {
1970
				continue;
1971
			}
1972
1973
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1974
				continue;
1975
			}
1976
1977
			$reactivate_modules[] = $active_module;
1978
			Jetpack::deactivate_module( $active_module );
1979
		}
1980
1981
		$new_version = JETPACK__VERSION . ':' . time();
1982
		/** This action is documented in class.jetpack.php */
1983
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1984
		Jetpack_Options::update_options(
1985
			array(
1986
				'version'     => $new_version,
1987
				'old_version' => $jetpack_old_version,
1988
			)
1989
		);
1990
1991
		Jetpack::state( 'message', 'modules_activated' );
1992
		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...
1993
1994
		if ( $redirect ) {
1995
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
1996
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
1997
				$page = $_GET['page'];
1998
			}
1999
2000
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2001
			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...
2002
		}
2003
	}
2004
2005
	/**
2006
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2007
	 * Make sure to tuck away module "library" files in a sub-directory.
2008
	 */
2009
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2010
		static $modules = null;
2011
2012
		if ( ! isset( $modules ) ) {
2013
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2014
			// Use the cache if we're on the front-end and it's available...
2015
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2016
				$modules = $available_modules_option[ JETPACK__VERSION ];
2017
			} else {
2018
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2019
2020
				$modules = array();
2021
2022
				foreach ( $files as $file ) {
2023
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2024
						continue;
2025
					}
2026
2027
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2028
				}
2029
2030
				Jetpack_Options::update_option( 'available_modules', array(
2031
					JETPACK__VERSION => $modules,
2032
				) );
2033
			}
2034
		}
2035
2036
		/**
2037
		 * Filters the array of modules available to be activated.
2038
		 *
2039
		 * @since 2.4.0
2040
		 *
2041
		 * @param array $modules Array of available modules.
2042
		 * @param string $min_version Minimum version number required to use modules.
2043
		 * @param string $max_version Maximum version number required to use modules.
2044
		 */
2045
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2046
2047
		if ( ! $min_version && ! $max_version ) {
2048
			return array_keys( $mods );
2049
		}
2050
2051
		$r = array();
2052
		foreach ( $mods as $slug => $introduced ) {
2053
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2054
				continue;
2055
			}
2056
2057
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2058
				continue;
2059
			}
2060
2061
			$r[] = $slug;
2062
		}
2063
2064
		return $r;
2065
	}
2066
2067
	/**
2068
	 * Default modules loaded on activation.
2069
	 */
2070
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2071
		$return = array();
2072
2073
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2074
			$module_data = Jetpack::get_module( $module );
2075
2076
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2077
				case 'yes' :
2078
					$return[] = $module;
2079
					break;
2080
				case 'public' :
2081
					if ( Jetpack_Options::get_option( 'public' ) ) {
2082
						$return[] = $module;
2083
					}
2084
					break;
2085
				case 'no' :
2086
				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...
2087
					break;
2088
			}
2089
		}
2090
		/**
2091
		 * Filters the array of default modules.
2092
		 *
2093
		 * @since 2.5.0
2094
		 *
2095
		 * @param array $return Array of default modules.
2096
		 * @param string $min_version Minimum version number required to use modules.
2097
		 * @param string $max_version Maximum version number required to use modules.
2098
		 */
2099
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2100
	}
2101
2102
	/**
2103
	 * Checks activated modules during auto-activation to determine
2104
	 * if any of those modules are being deprecated.  If so, close
2105
	 * them out, and add any replacement modules.
2106
	 *
2107
	 * Runs at priority 99 by default.
2108
	 *
2109
	 * This is run late, so that it can still activate a module if
2110
	 * the new module is a replacement for another that the user
2111
	 * currently has active, even if something at the normal priority
2112
	 * would kibosh everything.
2113
	 *
2114
	 * @since 2.6
2115
	 * @uses jetpack_get_default_modules filter
2116
	 * @param array $modules
2117
	 * @return array
2118
	 */
2119
	function handle_deprecated_modules( $modules ) {
2120
		$deprecated_modules = array(
2121
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2122
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2123
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2124
		);
2125
2126
		// Don't activate SSO if they never completed activating WPCC.
2127
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2128
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2129
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2130
				$deprecated_modules['wpcc'] = null;
2131
			}
2132
		}
2133
2134
		foreach ( $deprecated_modules as $module => $replacement ) {
2135
			if ( Jetpack::is_module_active( $module ) ) {
2136
				self::deactivate_module( $module );
2137
				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...
2138
					$modules[] = $replacement;
2139
				}
2140
			}
2141
		}
2142
2143
		return array_unique( $modules );
2144
	}
2145
2146
	/**
2147
	 * Checks activated plugins during auto-activation to determine
2148
	 * if any of those plugins are in the list with a corresponding module
2149
	 * that is not compatible with the plugin. The module will not be allowed
2150
	 * to auto-activate.
2151
	 *
2152
	 * @since 2.6
2153
	 * @uses jetpack_get_default_modules filter
2154
	 * @param array $modules
2155
	 * @return array
2156
	 */
2157
	function filter_default_modules( $modules ) {
2158
2159
		$active_plugins = self::get_active_plugins();
2160
2161
		if ( ! empty( $active_plugins ) ) {
2162
2163
			// For each module we'd like to auto-activate...
2164
			foreach ( $modules as $key => $module ) {
2165
				// If there are potential conflicts for it...
2166
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2167
					// For each potential conflict...
2168
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2169
						// If that conflicting plugin is active...
2170
						if ( in_array( $plugin, $active_plugins ) ) {
2171
							// Remove that item from being auto-activated.
2172
							unset( $modules[ $key ] );
2173
						}
2174
					}
2175
				}
2176
			}
2177
		}
2178
2179
		return $modules;
2180
	}
2181
2182
	/**
2183
	 * Extract a module's slug from its full path.
2184
	 */
2185
	public static function get_module_slug( $file ) {
2186
		return str_replace( '.php', '', basename( $file ) );
2187
	}
2188
2189
	/**
2190
	 * Generate a module's path from its slug.
2191
	 */
2192
	public static function get_module_path( $slug ) {
2193
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2194
	}
2195
2196
	/**
2197
	 * Load module data from module file. Headers differ from WordPress
2198
	 * plugin headers to avoid them being identified as standalone
2199
	 * plugins on the WordPress plugins page.
2200
	 */
2201
	public static function get_module( $module ) {
2202
		$headers = array(
2203
			'name'                      => 'Module Name',
2204
			'description'               => 'Module Description',
2205
			'jumpstart_desc'            => 'Jumpstart Description',
2206
			'sort'                      => 'Sort Order',
2207
			'recommendation_order'      => 'Recommendation Order',
2208
			'introduced'                => 'First Introduced',
2209
			'changed'                   => 'Major Changes In',
2210
			'deactivate'                => 'Deactivate',
2211
			'free'                      => 'Free',
2212
			'requires_connection'       => 'Requires Connection',
2213
			'auto_activate'             => 'Auto Activate',
2214
			'module_tags'               => 'Module Tags',
2215
			'feature'                   => 'Feature',
2216
			'additional_search_queries' => 'Additional Search Queries',
2217
		);
2218
2219
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2220
2221
		$mod = Jetpack::get_file_data( $file, $headers );
2222
		if ( empty( $mod['name'] ) ) {
2223
			return false;
2224
		}
2225
2226
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2227
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2228
		$mod['deactivate']              = empty( $mod['deactivate'] );
2229
		$mod['free']                    = empty( $mod['free'] );
2230
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2231
2232
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2233
			$mod['auto_activate'] = 'No';
2234
		} else {
2235
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2236
		}
2237
2238
		if ( $mod['module_tags'] ) {
2239
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2240
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2241
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2242
		} else {
2243
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2244
		}
2245
2246
		if ( $mod['feature'] ) {
2247
			$mod['feature'] = explode( ',', $mod['feature'] );
2248
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2249
		} else {
2250
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2251
		}
2252
2253
		/**
2254
		 * Filters the feature array on a module.
2255
		 *
2256
		 * This filter allows you to control where each module is filtered: Recommended,
2257
		 * Jumpstart, and the default "Other" listing.
2258
		 *
2259
		 * @since 3.5.0
2260
		 *
2261
		 * @param array   $mod['feature'] The areas to feature this module:
2262
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2263
		 *     'Recommended' shows on the main Jetpack admin screen.
2264
		 *     'Other' should be the default if no other value is in the array.
2265
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2266
		 * @param array   $mod All the currently assembled module data.
2267
		 */
2268
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2269
2270
		/**
2271
		 * Filter the returned data about a module.
2272
		 *
2273
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2274
		 * so please be careful.
2275
		 *
2276
		 * @since 3.6.0
2277
		 *
2278
		 * @param array   $mod    The details of the requested module.
2279
		 * @param string  $module The slug of the module, e.g. sharedaddy
2280
		 * @param string  $file   The path to the module source file.
2281
		 */
2282
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2283
	}
2284
2285
	/**
2286
	 * Like core's get_file_data implementation, but caches the result.
2287
	 */
2288
	public static function get_file_data( $file, $headers ) {
2289
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2290
		$file_name = basename( $file );
2291
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2292
		$key              = md5( $file_name . serialize( $headers ) );
2293
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2294
2295
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2296
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2297
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2298
		}
2299
2300
		$data = get_file_data( $file, $headers );
2301
2302
		// Strip out any old Jetpack versions that are cluttering the option.
2303
		//
2304
		// We maintain the data for the current version of Jetpack plus the previous version
2305
		// to prevent repeated DB hits on large sites hosted with multiple web servers
2306
		// on a single database (since all web servers might not be updated simultaneously)
2307
		
2308
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2309
		
2310
		if( count( $file_data_option ) > 2 ) {
2311
			$count = 0;
2312
			krsort( $file_data_option );
2313
			foreach ( $file_data_option as $version => $values ) {
2314
				$count++;
2315
				if( $count > 2 ) {
2316
					unset( $file_data_option[ $version ] );
2317
				}
2318
			}
2319
		}
2320
		
2321
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2322
2323
		return $data;
2324
	}
2325
	
2326
2327
	/**
2328
	 * Return translated module tag.
2329
	 *
2330
	 * @param string $tag Tag as it appears in each module heading.
2331
	 *
2332
	 * @return mixed
2333
	 */
2334
	public static function translate_module_tag( $tag ) {
2335
		return jetpack_get_module_i18n_tag( $tag );
2336
	}
2337
2338
	/**
2339
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2340
	 *
2341
	 * @since 3.9.2
2342
	 *
2343
	 * @param array $modules
2344
	 *
2345
	 * @return string|void
2346
	 */
2347
	public static function get_translated_modules( $modules ) {
2348
		foreach ( $modules as $index => $module ) {
2349
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2350
			if ( isset( $module['name'] ) ) {
2351
				$modules[ $index ]['name'] = $i18n_module['name'];
2352
			}
2353
			if ( isset( $module['description'] ) ) {
2354
				$modules[ $index ]['description'] = $i18n_module['description'];
2355
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2356
			}
2357
		}
2358
		return $modules;
2359
	}
2360
2361
	/**
2362
	 * Get a list of activated modules as an array of module slugs.
2363
	 */
2364
	public static function get_active_modules() {
2365
		$active = Jetpack_Options::get_option( 'active_modules' );
2366
2367
		if ( ! is_array( $active ) ) {
2368
			$active = array();
2369
		}
2370
2371
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2372
			$active[] = 'vaultpress';
2373
		} else {
2374
			$active = array_diff( $active, array( 'vaultpress' ) );
2375
		}
2376
2377
		//If protect is active on the main site of a multisite, it should be active on all sites.
2378
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2379
			$active[] = 'protect';
2380
		}
2381
2382
		return array_unique( $active );
2383
	}
2384
2385
	/**
2386
	 * Check whether or not a Jetpack module is active.
2387
	 *
2388
	 * @param string $module The slug of a Jetpack module.
2389
	 * @return bool
2390
	 *
2391
	 * @static
2392
	 */
2393
	public static function is_module_active( $module ) {
2394
		return in_array( $module, self::get_active_modules() );
2395
	}
2396
2397
	public static function is_module( $module ) {
2398
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2399
	}
2400
2401
	/**
2402
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2403
	 *
2404
	 * @param bool $catch True to start catching, False to stop.
2405
	 *
2406
	 * @static
2407
	 */
2408
	public static function catch_errors( $catch ) {
2409
		static $display_errors, $error_reporting;
2410
2411
		if ( $catch ) {
2412
			$display_errors  = @ini_set( 'display_errors', 1 );
2413
			$error_reporting = @error_reporting( E_ALL );
2414
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2415
		} else {
2416
			@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...
2417
			@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...
2418
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2419
		}
2420
	}
2421
2422
	/**
2423
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2424
	 */
2425
	public static function catch_errors_on_shutdown() {
2426
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2427
	}
2428
2429
	/**
2430
	 * Rewrite any string to make paths easier to read.
2431
	 *
2432
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2433
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2434
	 *
2435
	 * @param $string
2436
	 * @return mixed
2437
	 */
2438
	public static function alias_directories( $string ) {
2439
		// ABSPATH has a trailing slash.
2440
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2441
		// WP_CONTENT_DIR does not have a trailing slash.
2442
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2443
2444
		return $string;
2445
	}
2446
2447
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2448
		$jetpack = Jetpack::init();
2449
2450
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2451
		$modules = array_merge( $other_modules, $modules );
2452
2453
		// Look for standalone plugins and disable if active.
2454
2455
		$to_deactivate = array();
2456
		foreach ( $modules as $module ) {
2457
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2458
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2459
			}
2460
		}
2461
2462
		$deactivated = array();
2463
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2464
			list( $probable_file, $probable_title ) = $deactivate_me;
2465
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2466
				$deactivated[] = $module;
2467
			}
2468
		}
2469
2470
		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...
2471
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2472
2473
			$url = add_query_arg(
2474
				array(
2475
					'action'   => 'activate_default_modules',
2476
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2477
				),
2478
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2479
			);
2480
			wp_safe_redirect( $url );
2481
			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...
2482
		}
2483
2484
		/**
2485
		 * Fires before default modules are activated.
2486
		 *
2487
		 * @since 1.9.0
2488
		 *
2489
		 * @param string $min_version Minimum version number required to use modules.
2490
		 * @param string $max_version Maximum version number required to use modules.
2491
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2492
		 */
2493
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2494
2495
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2496
		Jetpack::restate();
2497
		Jetpack::catch_errors( true );
2498
2499
		$active = Jetpack::get_active_modules();
2500
2501
		foreach ( $modules as $module ) {
2502
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2503
				$active[] = $module;
2504
				self::update_active_modules( $active );
2505
				continue;
2506
			}
2507
2508
			if ( in_array( $module, $active ) ) {
2509
				$module_info = Jetpack::get_module( $module );
2510
				if ( ! $module_info['deactivate'] ) {
2511
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2512 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2513
						$active_state = explode( ',', $active_state );
2514
					} else {
2515
						$active_state = array();
2516
					}
2517
					$active_state[] = $module;
2518
					Jetpack::state( $state, implode( ',', $active_state ) );
2519
				}
2520
				continue;
2521
			}
2522
2523
			$file = Jetpack::get_module_path( $module );
2524
			if ( ! file_exists( $file ) ) {
2525
				continue;
2526
			}
2527
2528
			// we'll override this later if the plugin can be included without fatal error
2529
			if ( $redirect ) {
2530
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2531
			}
2532
			Jetpack::state( 'error', 'module_activation_failed' );
2533
			Jetpack::state( 'module', $module );
2534
			ob_start();
2535
			require $file;
2536
2537
			$active[] = $module;
2538
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2539 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2540
				$active_state = explode( ',', $active_state );
2541
			} else {
2542
				$active_state = array();
2543
			}
2544
			$active_state[] = $module;
2545
			Jetpack::state( $state, implode( ',', $active_state ) );
2546
			Jetpack::update_active_modules( $active );
2547
2548
			ob_end_clean();
2549
		}
2550
		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...
2551
		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...
2552
		Jetpack::catch_errors( false );
2553
		/**
2554
		 * Fires when default modules are activated.
2555
		 *
2556
		 * @since 1.9.0
2557
		 *
2558
		 * @param string $min_version Minimum version number required to use modules.
2559
		 * @param string $max_version Maximum version number required to use modules.
2560
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2561
		 */
2562
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2563
	}
2564
2565
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2566
		/**
2567
		 * Fires before a module is activated.
2568
		 *
2569
		 * @since 2.6.0
2570
		 *
2571
		 * @param string $module Module slug.
2572
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2573
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2574
		 */
2575
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2576
2577
		$jetpack = Jetpack::init();
2578
2579
		if ( ! strlen( $module ) )
2580
			return false;
2581
2582
		if ( ! Jetpack::is_module( $module ) )
2583
			return false;
2584
2585
		// If it's already active, then don't do it again
2586
		$active = Jetpack::get_active_modules();
2587
		foreach ( $active as $act ) {
2588
			if ( $act == $module )
2589
				return true;
2590
		}
2591
2592
		$module_data = Jetpack::get_module( $module );
2593
2594
		if ( ! Jetpack::is_active() ) {
2595
			if ( !Jetpack::is_development_mode() )
2596
				return false;
2597
2598
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2599
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2600
				return false;
2601
		}
2602
2603
		// Check and see if the old plugin is active
2604
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2605
			// Deactivate the old plugin
2606
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2607
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2608
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2609
				Jetpack::state( 'deactivated_plugins', $module );
2610
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2611
				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...
2612
			}
2613
		}
2614
2615
		// Protect won't work with mis-configured IPs
2616
		if ( 'protect' === $module ) {
2617
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2618
			if ( ! jetpack_protect_get_ip() ) {
2619
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2620
				return false;
2621
			}
2622
		}
2623
2624
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2625
		Jetpack::state( 'module', $module );
2626
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2627
2628
		Jetpack::catch_errors( true );
2629
		ob_start();
2630
		require Jetpack::get_module_path( $module );
2631
		/** This action is documented in class.jetpack.php */
2632
		do_action( 'jetpack_activate_module', $module );
2633
		$active[] = $module;
2634
		Jetpack::update_active_modules( $active );
2635
2636
		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...
2637
		ob_end_clean();
2638
		Jetpack::catch_errors( false );
2639
2640
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2641 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2642
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2643
2644
			//Jump start is being dismissed send data to MC Stats
2645
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2646
2647
			$jetpack->do_stats( 'server_side' );
2648
		}
2649
2650
		if ( $redirect ) {
2651
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2652
		}
2653
		if ( $exit ) {
2654
			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...
2655
		}
2656
		return true;
2657
	}
2658
2659
	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...
2660
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2661
	}
2662
2663
	public static function deactivate_module( $module ) {
2664
		/**
2665
		 * Fires when a module is deactivated.
2666
		 *
2667
		 * @since 1.9.0
2668
		 *
2669
		 * @param string $module Module slug.
2670
		 */
2671
		do_action( 'jetpack_pre_deactivate_module', $module );
2672
2673
		$jetpack = Jetpack::init();
2674
2675
		$active = Jetpack::get_active_modules();
2676
		$new    = array_filter( array_diff( $active, (array) $module ) );
2677
2678
		// A flag for Jump Start so it's not shown again.
2679 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2680
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2681
2682
			//Jump start is being dismissed send data to MC Stats
2683
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2684
2685
			$jetpack->do_stats( 'server_side' );
2686
		}
2687
2688
		return self::update_active_modules( $new );
2689
	}
2690
2691
	public static function enable_module_configurable( $module ) {
2692
		$module = Jetpack::get_module_slug( $module );
2693
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2694
	}
2695
2696
	public static function module_configuration_url( $module ) {
2697
		$module = Jetpack::get_module_slug( $module );
2698
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2699
	}
2700
2701
	public static function module_configuration_load( $module, $method ) {
2702
		$module = Jetpack::get_module_slug( $module );
2703
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2704
	}
2705
2706
	public static function module_configuration_head( $module, $method ) {
2707
		$module = Jetpack::get_module_slug( $module );
2708
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2709
	}
2710
2711
	public static function module_configuration_screen( $module, $method ) {
2712
		$module = Jetpack::get_module_slug( $module );
2713
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2714
	}
2715
2716
	public static function module_configuration_activation_screen( $module, $method ) {
2717
		$module = Jetpack::get_module_slug( $module );
2718
		add_action( 'display_activate_module_setting_' . $module, $method );
2719
	}
2720
2721
/* Installation */
2722
2723
	public static function bail_on_activation( $message, $deactivate = true ) {
2724
?>
2725
<!doctype html>
2726
<html>
2727
<head>
2728
<meta charset="<?php bloginfo( 'charset' ); ?>">
2729
<style>
2730
* {
2731
	text-align: center;
2732
	margin: 0;
2733
	padding: 0;
2734
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2735
}
2736
p {
2737
	margin-top: 1em;
2738
	font-size: 18px;
2739
}
2740
</style>
2741
<body>
2742
<p><?php echo esc_html( $message ); ?></p>
2743
</body>
2744
</html>
2745
<?php
2746
		if ( $deactivate ) {
2747
			$plugins = get_option( 'active_plugins' );
2748
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2749
			$update  = false;
2750
			foreach ( $plugins as $i => $plugin ) {
2751
				if ( $plugin === $jetpack ) {
2752
					$plugins[$i] = false;
2753
					$update = true;
2754
				}
2755
			}
2756
2757
			if ( $update ) {
2758
				update_option( 'active_plugins', array_filter( $plugins ) );
2759
			}
2760
		}
2761
		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...
2762
	}
2763
2764
	/**
2765
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2766
	 * @static
2767
	 */
2768
	public static function plugin_activation( $network_wide ) {
2769
		Jetpack_Options::update_option( 'activated', 1 );
2770
2771
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2772
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2773
		}
2774
2775
		if ( $network_wide )
2776
			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...
2777
2778
		Jetpack::plugin_initialize();
2779
	}
2780
	/**
2781
	 * Runs before bumping version numbers up to a new version
2782
	 * @param  (string) $version    Version:timestamp
2783
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2784
	 * @return null              [description]
2785
	 */
2786
	public static function do_version_bump( $version, $old_version ) {
2787
2788
		if ( ! $old_version ) { // For new sites
2789
			// Setting up jetpack manage
2790
			Jetpack::activate_manage();
2791
		}
2792
	}
2793
2794
	/**
2795
	 * Sets the internal version number and activation state.
2796
	 * @static
2797
	 */
2798
	public static function plugin_initialize() {
2799
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2800
			Jetpack_Options::update_option( 'activated', 2 );
2801
		}
2802
2803 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2804
			$version = $old_version = JETPACK__VERSION . ':' . time();
2805
			/** This action is documented in class.jetpack.php */
2806
			do_action( 'updating_jetpack_version', $version, false );
2807
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2808
		}
2809
2810
		Jetpack::load_modules();
2811
2812
		Jetpack_Options::delete_option( 'do_activate' );
2813
	}
2814
2815
	/**
2816
	 * Removes all connection options
2817
	 * @static
2818
	 */
2819
	public static function plugin_deactivation( ) {
2820
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2821
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2822
			Jetpack_Network::init()->deactivate();
2823
		} else {
2824
			Jetpack::disconnect( false );
2825
			//Jetpack_Heartbeat::init()->deactivate();
2826
		}
2827
	}
2828
2829
	/**
2830
	 * Disconnects from the Jetpack servers.
2831
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2832
	 * @static
2833
	 */
2834
	public static function disconnect( $update_activated_state = true ) {
2835
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2836
		Jetpack::clean_nonces( true );
2837
2838
		// If the site is in an IDC because sync is not allowed,
2839
		// let's make sure to not disconnect the production site.
2840
		if ( ! self::validate_sync_error_idc_option() ) {
2841
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2842
			Jetpack::load_xml_rpc_client();
2843
			$xml = new Jetpack_IXR_Client();
2844
			$xml->query( 'jetpack.deregister' );
2845
		}
2846
2847
		Jetpack_Options::delete_option(
2848
			array(
2849
				'register',
2850
				'blog_token',
2851
				'user_token',
2852
				'user_tokens',
2853
				'master_user',
2854
				'time_diff',
2855
				'fallback_no_verify_ssl_certs',
2856
			)
2857
		);
2858
2859
		Jetpack_IDC::clear_all_idc_options();
2860
2861
		if ( $update_activated_state ) {
2862
			Jetpack_Options::update_option( 'activated', 4 );
2863
		}
2864
2865
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2866
			// Check then record unique disconnection if site has never been disconnected previously
2867
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2868
				$jetpack_unique_connection['disconnected'] = 1;
2869
			} else {
2870
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2871
					//track unique disconnect
2872
					$jetpack = Jetpack::init();
2873
2874
					$jetpack->stat( 'connections', 'unique-disconnect' );
2875
					$jetpack->do_stats( 'server_side' );
2876
				}
2877
				// increment number of times disconnected
2878
				$jetpack_unique_connection['disconnected'] += 1;
2879
			}
2880
2881
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2882
		}
2883
2884
		// Delete cached connected user data
2885
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2886
		delete_transient( $transient_key );
2887
2888
		// Delete all the sync related data. Since it could be taking up space.
2889
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2890
		Jetpack_Sync_Sender::get_instance()->uninstall();
2891
2892
		// Disable the Heartbeat cron
2893
		Jetpack_Heartbeat::init()->deactivate();
2894
	}
2895
2896
	/**
2897
	 * Unlinks the current user from the linked WordPress.com user
2898
	 */
2899
	public static function unlink_user( $user_id = null ) {
2900
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2901
			return false;
2902
2903
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2904
2905
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2906
			return false;
2907
2908
		if ( ! isset( $tokens[ $user_id ] ) )
2909
			return false;
2910
2911
		Jetpack::load_xml_rpc_client();
2912
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2913
		$xml->query( 'jetpack.unlink_user', $user_id );
2914
2915
		unset( $tokens[ $user_id ] );
2916
2917
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2918
2919
		/**
2920
		 * Fires after the current user has been unlinked from WordPress.com.
2921
		 *
2922
		 * @since 4.1.0
2923
		 *
2924
		 * @param int $user_id The current user's ID.
2925
		 */
2926
		do_action( 'jetpack_unlinked_user', $user_id );
2927
2928
		return true;
2929
	}
2930
2931
	/**
2932
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2933
	 */
2934
	public static function try_registration() {
2935
		// Let's get some testing in beta versions and such.
2936
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2937
			// Before attempting to connect, let's make sure that the domains are viable.
2938
			$domains_to_check = array_unique( array(
2939
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2940
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2941
			) );
2942
			foreach ( $domains_to_check as $domain ) {
2943
				$result = Jetpack_Data::is_usable_domain( $domain );
2944
				if ( is_wp_error( $result ) ) {
2945
					return $result;
2946
				}
2947
			}
2948
		}
2949
2950
		$result = Jetpack::register();
2951
2952
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2953
		if ( ! $result || is_wp_error( $result ) ) {
2954
			return $result;
2955
		} else {
2956
			return true;
2957
		}
2958
	}
2959
2960
	/**
2961
	 * Tracking an internal event log. Try not to put too much chaff in here.
2962
	 *
2963
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2964
	 */
2965
	public static function log( $code, $data = null ) {
2966
		// only grab the latest 200 entries
2967
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2968
2969
		// Append our event to the log
2970
		$log_entry = array(
2971
			'time'    => time(),
2972
			'user_id' => get_current_user_id(),
2973
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2974
			'code'    => $code,
2975
		);
2976
		// Don't bother storing it unless we've got some.
2977
		if ( ! is_null( $data ) ) {
2978
			$log_entry['data'] = $data;
2979
		}
2980
		$log[] = $log_entry;
2981
2982
		// Try add_option first, to make sure it's not autoloaded.
2983
		// @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...
2984
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
2985
			Jetpack_Options::update_option( 'log', $log );
2986
		}
2987
2988
		/**
2989
		 * Fires when Jetpack logs an internal event.
2990
		 *
2991
		 * @since 3.0.0
2992
		 *
2993
		 * @param array $log_entry {
2994
		 *	Array of details about the log entry.
2995
		 *
2996
		 *	@param string time Time of the event.
2997
		 *	@param int user_id ID of the user who trigerred the event.
2998
		 *	@param int blog_id Jetpack Blog ID.
2999
		 *	@param string code Unique name for the event.
3000
		 *	@param string data Data about the event.
3001
		 * }
3002
		 */
3003
		do_action( 'jetpack_log_entry', $log_entry );
3004
	}
3005
3006
	/**
3007
	 * Get the internal event log.
3008
	 *
3009
	 * @param $event (string) - only return the specific log events
3010
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3011
	 *
3012
	 * @return array of log events || WP_Error for invalid params
3013
	 */
3014
	public static function get_log( $event = false, $num = false ) {
3015
		if ( $event && ! is_string( $event ) ) {
3016
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3017
		}
3018
3019
		if ( $num && ! is_numeric( $num ) ) {
3020
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3021
		}
3022
3023
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3024
3025
		// If nothing set - act as it did before, otherwise let's start customizing the output
3026
		if ( ! $num && ! $event ) {
3027
			return $entire_log;
3028
		} else {
3029
			$entire_log = array_reverse( $entire_log );
3030
		}
3031
3032
		$custom_log_output = array();
3033
3034
		if ( $event ) {
3035
			foreach ( $entire_log as $log_event ) {
3036
				if ( $event == $log_event[ 'code' ] ) {
3037
					$custom_log_output[] = $log_event;
3038
				}
3039
			}
3040
		} else {
3041
			$custom_log_output = $entire_log;
3042
		}
3043
3044
		if ( $num ) {
3045
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3046
		}
3047
3048
		return $custom_log_output;
3049
	}
3050
3051
	/**
3052
	 * Log modification of important settings.
3053
	 */
3054
	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...
3055
		switch( $option ) {
3056
			case 'jetpack_sync_non_public_post_stati':
3057
				self::log( $option, $value );
3058
				break;
3059
		}
3060
	}
3061
3062
	/**
3063
	 * Return stat data for WPCOM sync
3064
	 */
3065
	public static function get_stat_data( $encode = true, $extended = true ) {
3066
		$data = Jetpack_Heartbeat::generate_stats_array();
3067
3068
		if ( $extended ) {
3069
			$additional_data = self::get_additional_stat_data();
3070
			$data = array_merge( $data, $additional_data );
3071
		}
3072
3073
		if ( $encode ) {
3074
			return json_encode( $data );
3075
		}
3076
3077
		return $data;
3078
	}
3079
3080
	/**
3081
	 * Get additional stat data to sync to WPCOM
3082
	 */
3083
	public static function get_additional_stat_data( $prefix = '' ) {
3084
		$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...
3085
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3086
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3087
		$return["{$prefix}site-count"]     = 0;
3088
3089
		if ( function_exists( 'get_blog_count' ) ) {
3090
			$return["{$prefix}site-count"] = get_blog_count();
3091
		}
3092
		return $return;
3093
	}
3094
3095
	private static function get_site_user_count() {
3096
		global $wpdb;
3097
3098
		if ( function_exists( 'wp_is_large_network' ) ) {
3099
			if ( wp_is_large_network( 'users' ) ) {
3100
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3101
			}
3102
		}
3103 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3104
			// It wasn't there, so regenerate the data and save the transient
3105
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3106
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3107
		}
3108
		return $user_count;
3109
	}
3110
3111
	/* Admin Pages */
3112
3113
	function admin_init() {
3114
		// If the plugin is not connected, display a connect message.
3115
		if (
3116
			// the plugin was auto-activated and needs its candy
3117
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3118
		||
3119
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3120
			! Jetpack_Options::get_option( 'activated' )
3121
		) {
3122
			Jetpack::plugin_initialize();
3123
		}
3124
3125
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3126
			Jetpack_Connection_Banner::init();
3127
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3128
			// Upgrade: 1.1 -> 1.1.1
3129
			// Check and see if host can verify the Jetpack servers' SSL certificate
3130
			$args = array();
3131
			Jetpack_Client::_wp_remote_request(
3132
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3133
				$args,
3134
				true
3135
			);
3136
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3137
			// Show the notice on the Dashboard only for now
3138
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3139
		}
3140
3141
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3142
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3143
		}
3144
3145
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3146
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3147
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3148
3149
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3150
			// Artificially throw errors in certain whitelisted cases during plugin activation
3151
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3152
		}
3153
3154
		// Jetpack Manage Activation Screen from .com
3155
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3156
3157
		// Add custom column in wp-admin/users.php to show whether user is linked.
3158
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3159
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3160
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3161
	}
3162
3163
	function admin_body_class( $admin_body_class = '' ) {
3164
		$classes = explode( ' ', trim( $admin_body_class ) );
3165
3166
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3167
3168
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3169
		return " $admin_body_class ";
3170
	}
3171
3172
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3173
		return $admin_body_class . ' jetpack-pagestyles ';
3174
	}
3175
3176
	/**
3177
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3178
	 *
3179
	 * @return null
3180
	 */
3181
	function prepare_manage_jetpack_notice() {
3182
3183
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3184
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3185
	}
3186
3187
	function manage_activate_screen() {
3188
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3189
	}
3190
	/**
3191
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3192
	 * This function artificially throws errors for such cases (whitelisted).
3193
	 *
3194
	 * @param string $plugin The activated plugin.
3195
	 */
3196
	function throw_error_on_activate_plugin( $plugin ) {
3197
		$active_modules = Jetpack::get_active_modules();
3198
3199
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3200
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3201
			$throw = false;
3202
3203
			// Try and make sure it really was the stats plugin
3204
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3205
				if ( 'stats.php' == basename( $plugin ) ) {
3206
					$throw = true;
3207
				}
3208
			} else {
3209
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3210
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3211
					$throw = true;
3212
				}
3213
			}
3214
3215
			if ( $throw ) {
3216
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3217
			}
3218
		}
3219
	}
3220
3221
	function intercept_plugin_error_scrape_init() {
3222
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3223
	}
3224
3225
	function intercept_plugin_error_scrape( $action, $result ) {
3226
		if ( ! $result ) {
3227
			return;
3228
		}
3229
3230
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3231
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3232
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3233
			}
3234
		}
3235
	}
3236
3237
	function add_remote_request_handlers() {
3238
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3239
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3240
	}
3241
3242
	function remote_request_handlers() {
3243
		$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...
3244
3245
		switch ( current_filter() ) {
3246
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3247
			$response = $this->upload_handler();
3248
			break;
3249
3250
		case 'wp_ajax_nopriv_jetpack_update_file' :
3251
			$response = $this->upload_handler( true );
3252
			break;
3253
		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...
3254
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3255
			break;
3256
		}
3257
3258
		if ( ! $response ) {
3259
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3260
		}
3261
3262
		if ( is_wp_error( $response ) ) {
3263
			$status_code       = $response->get_error_data();
3264
			$error             = $response->get_error_code();
3265
			$error_description = $response->get_error_message();
3266
3267
			if ( ! is_int( $status_code ) ) {
3268
				$status_code = 400;
3269
			}
3270
3271
			status_header( $status_code );
3272
			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...
3273
		}
3274
3275
		status_header( 200 );
3276
		if ( true === $response ) {
3277
			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...
3278
		}
3279
3280
		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...
3281
	}
3282
3283
	/**
3284
	 * Uploads a file gotten from the global $_FILES.
3285
	 * If `$update_media_item` is true and `post_id` is defined
3286
	 * the attachment file of the media item (gotten through of the post_id)
3287
	 * will be updated instead of add a new one.
3288
	 * 
3289
	 * @param  boolean $update_media_item - update media attachment
3290
	 * @return array - An array describing the uploadind files process
3291
	 */
3292
	function upload_handler( $update_media_item = false ) {
3293
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3294
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3295
		}
3296
3297
		$user = wp_authenticate( '', '' );
3298
		if ( ! $user || is_wp_error( $user ) ) {
3299
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3300
		}
3301
3302
		wp_set_current_user( $user->ID );
3303
3304
		if ( ! current_user_can( 'upload_files' ) ) {
3305
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3306
		}
3307
3308
		if ( empty( $_FILES ) ) {
3309
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3310
		}
3311
3312
		foreach ( array_keys( $_FILES ) as $files_key ) {
3313
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3314
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3315
			}
3316
		}
3317
3318
		$media_keys = array_keys( $_FILES['media'] );
3319
3320
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3321
		if ( ! $token || is_wp_error( $token ) ) {
3322
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3323
		}
3324
3325
		$uploaded_files = array();
3326
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3327
		unset( $GLOBALS['post'] );
3328
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3329
			$file = array();
3330
			foreach ( $media_keys as $media_key ) {
3331
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3332
			}
3333
3334
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3335
3336
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3337
			if ( $hmac_provided !== $hmac_file ) {
3338
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3339
				continue;
3340
			}
3341
3342
			$_FILES['.jetpack.upload.'] = $file;
3343
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3344
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3345
				$post_id = 0;
3346
			}
3347
3348
			if ( $update_media_item ) {
3349
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3350
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3351
				}
3352
3353
				$media_array = $_FILES['media'];
3354
3355
				$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...
3356
				$file_array['type'] = $media_array['type'][0]; 
3357
				$file_array['tmp_name'] = $media_array['tmp_name'][0]; 
3358
				$file_array['error'] = $media_array['error'][0]; 
3359
				$file_array['size'] = $media_array['size'][0];
3360
3361
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3362
3363
				if ( is_wp_error( $edited_media_item ) ) {
3364
					return $edited_media_item;
3365
				}
3366
3367
				$response = (object) array(
3368
					'id'   => (string) $post_id,
3369
					'file' => (string) $edited_media_item->post_title,
3370
					'url'  => (string) wp_get_attachment_url( $post_id ),
3371
					'type' => (string) $edited_media_item->post_mime_type,
3372
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3373
				);
3374
3375
				return (array) array( $response );
3376
			}
3377
3378
			$attachment_id = media_handle_upload(
3379
				'.jetpack.upload.',
3380
				$post_id,
3381
				array(),
3382
				array(
3383
					'action' => 'jetpack_upload_file',
3384
				)
3385
			);
3386
3387
			if ( ! $attachment_id ) {
3388
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3389
			} elseif ( is_wp_error( $attachment_id ) ) {
3390
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3391
			} else {
3392
				$attachment = get_post( $attachment_id );
3393
				$uploaded_files[$index] = (object) array(
3394
					'id'   => (string) $attachment_id,
3395
					'file' => $attachment->post_title,
3396
					'url'  => wp_get_attachment_url( $attachment_id ),
3397
					'type' => $attachment->post_mime_type,
3398
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3399
				);
3400
				// Zip files uploads are not supported unless they are done for installation purposed
3401
				// lets delete them in case something goes wrong in this whole process
3402
				if ( 'application/zip' === $attachment->post_mime_type ) {
3403
					// Schedule a cleanup for 2 hours from now in case of failed install.
3404
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3405
				}
3406
			}
3407
		}
3408
		if ( ! is_null( $global_post ) ) {
3409
			$GLOBALS['post'] = $global_post;
3410
		}
3411
3412
		return $uploaded_files;
3413
	}
3414
3415
	/**
3416
	 * Add help to the Jetpack page
3417
	 *
3418
	 * @since Jetpack (1.2.3)
3419
	 * @return false if not the Jetpack page
3420
	 */
3421
	function admin_help() {
3422
		$current_screen = get_current_screen();
3423
3424
		// Overview
3425
		$current_screen->add_help_tab(
3426
			array(
3427
				'id'		=> 'home',
3428
				'title'		=> __( 'Home', 'jetpack' ),
3429
				'content'	=>
3430
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3431
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3432
					'<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>',
3433
			)
3434
		);
3435
3436
		// Screen Content
3437
		if ( current_user_can( 'manage_options' ) ) {
3438
			$current_screen->add_help_tab(
3439
				array(
3440
					'id'		=> 'settings',
3441
					'title'		=> __( 'Settings', 'jetpack' ),
3442
					'content'	=>
3443
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3444
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3445
						'<ol>' .
3446
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3447
							'<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>' .
3448
						'</ol>' .
3449
						'<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>'
3450
				)
3451
			);
3452
		}
3453
3454
		// Help Sidebar
3455
		$current_screen->set_help_sidebar(
3456
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3457
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3458
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3459
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3460
		);
3461
	}
3462
3463
	function admin_menu_css() {
3464
		wp_enqueue_style( 'jetpack-icons' );
3465
	}
3466
3467
	function admin_menu_order() {
3468
		return true;
3469
	}
3470
3471 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3472
		$jp_menu_order = array();
3473
3474
		foreach ( $menu_order as $index => $item ) {
3475
			if ( $item != 'jetpack' ) {
3476
				$jp_menu_order[] = $item;
3477
			}
3478
3479
			if ( $index == 0 ) {
3480
				$jp_menu_order[] = 'jetpack';
3481
			}
3482
		}
3483
3484
		return $jp_menu_order;
3485
	}
3486
3487
	function admin_head() {
3488 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3489
			/** This action is documented in class.jetpack-admin-page.php */
3490
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3491
	}
3492
3493
	function admin_banner_styles() {
3494
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3495
3496 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3497
			wp_register_style(
3498
				'jetpack-dops-style',
3499
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3500
				array(),
3501
				JETPACK__VERSION
3502
			);
3503
		}
3504
3505
		wp_enqueue_style(
3506
			'jetpack',
3507
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3508
			array( 'jetpack-dops-style' ),
3509
			 JETPACK__VERSION . '-20121016'
3510
		);
3511
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3512
		wp_style_add_data( 'jetpack', 'suffix', $min );
3513
	}
3514
3515
	function plugin_action_links( $actions ) {
3516
3517
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3518
3519
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3520
			return array_merge(
3521
				$jetpack_home,
3522
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3523
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3524
				$actions
3525
				);
3526
			}
3527
3528
		return array_merge( $jetpack_home, $actions );
3529
	}
3530
3531
	/**
3532
	 * This is the first banner
3533
	 * It should be visible only to user that can update the option
3534
	 * Are not connected
3535
	 *
3536
	 * @return null
3537
	 */
3538
	function admin_jetpack_manage_notice() {
3539
		$screen = get_current_screen();
3540
3541
		// Don't show the connect notice on the jetpack settings page.
3542
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3543
			return;
3544
		}
3545
3546
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3547
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3548
		/**
3549
		 * I think it would be great to have different wordsing depending on where you are
3550
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3551
		 * etc..
3552
		 */
3553
3554
		?>
3555
		<div id="message" class="updated jp-banner">
3556
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3557
				<div class="jp-banner__description-container">
3558
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3559
					<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>
3560
					<p class="jp-banner__button-container">
3561
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3562
						<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>
3563
					</p>
3564
				</div>
3565
		</div>
3566
		<?php
3567
	}
3568
3569
	/**
3570
	 * Returns the url that the user clicks to remove the notice for the big banner
3571
	 * @return (string)
3572
	 */
3573
	function opt_out_jetpack_manage_url() {
3574
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3575
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3576
	}
3577
	/**
3578
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3579
	 * @return (string)
3580
	 */
3581
	function opt_in_jetpack_manage_url() {
3582
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3583
	}
3584
3585
	function opt_in_jetpack_manage_notice() {
3586
		?>
3587
		<div class="wrap">
3588
			<div id="message" class="jetpack-message is-opt-in">
3589
				<?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' ); ?>
3590
			</div>
3591
		</div>
3592
		<?php
3593
3594
	}
3595
	/**
3596
	 * Determines whether to show the notice of not true = display notice
3597
	 * @return (bool)
3598
	 */
3599
	function can_display_jetpack_manage_notice() {
3600
		// never display the notice to users that can't do anything about it anyways
3601
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3602
			return false;
3603
3604
		// don't display if we are in development more
3605
		if( Jetpack::is_development_mode() ) {
3606
			return false;
3607
		}
3608
		// don't display if the site is private
3609
		if(  ! Jetpack_Options::get_option( 'public' ) )
3610
			return false;
3611
3612
		/**
3613
		 * Should the Jetpack Remote Site Management notice be displayed.
3614
		 *
3615
		 * @since 3.3.0
3616
		 *
3617
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3618
		 */
3619
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3620
	}
3621
3622
	/*
3623
	 * Registration flow:
3624
	 * 1 - ::admin_page_load() action=register
3625
	 * 2 - ::try_registration()
3626
	 * 3 - ::register()
3627
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3628
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3629
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3630
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3631
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3632
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3633
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3634
	 *       jetpack_id, jetpack_secret, jetpack_public
3635
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3636
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3637
	 * 5 - user logs in with WP.com account
3638
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3639
	 *		- Jetpack_Client_Server::authorize()
3640
	 *		- Jetpack_Client_Server::get_token()
3641
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3642
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3643
	 *			- which responds with access_token, token_type, scope
3644
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3645
	 *		- Jetpack::activate_default_modules()
3646
	 *     		- Deactivates deprecated plugins
3647
	 *     		- Activates all default modules
3648
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3649
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3650
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3651
	 *     Done!
3652
	 */
3653
3654
	/**
3655
	 * Handles the page load events for the Jetpack admin page
3656
	 */
3657
	function admin_page_load() {
3658
		$error = false;
3659
3660
		// Make sure we have the right body class to hook stylings for subpages off of.
3661
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3662
3663
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3664
			// Should only be used in intermediate redirects to preserve state across redirects
3665
			Jetpack::restate();
3666
		}
3667
3668
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3669
			// User clicked in the iframe to link their accounts
3670
			if ( ! Jetpack::is_user_connected() ) {
3671
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3672
				if ( isset( $_GET['notes_iframe'] ) )
3673
					$connect_url .= '&notes_iframe';
3674
				wp_redirect( $connect_url );
3675
				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...
3676
			} else {
3677
				if ( ! isset( $_GET['calypso_env'] ) ) {
3678
					Jetpack::state( 'message', 'already_authorized' );
3679
					wp_safe_redirect( Jetpack::admin_url() );
3680
				} else {
3681
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3682
					$connect_url .= '&already_authorized=true';
3683
					wp_redirect( $connect_url );
3684
				}
3685
			}
3686
		}
3687
3688
3689
		if ( isset( $_GET['action'] ) ) {
3690
			switch ( $_GET['action'] ) {
3691
			case 'authorize':
3692
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3693
					Jetpack::state( 'message', 'already_authorized' );
3694
					wp_safe_redirect( Jetpack::admin_url() );
3695
					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...
3696
				}
3697
				Jetpack::log( 'authorize' );
3698
				$client_server = new Jetpack_Client_Server;
3699
				$client_server->client_authorize();
3700
				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...
3701
			case 'register' :
3702
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3703
					$error = 'cheatin';
3704
					break;
3705
				}
3706
				check_admin_referer( 'jetpack-register' );
3707
				Jetpack::log( 'register' );
3708
				Jetpack::maybe_set_version_option();
3709
				$registered = Jetpack::try_registration();
3710
				if ( is_wp_error( $registered ) ) {
3711
					$error = $registered->get_error_code();
3712
					Jetpack::state( 'error', $error );
3713
					Jetpack::state( 'error', $registered->get_error_message() );
3714
					break;
3715
				}
3716
3717
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3718
3719
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3720
				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...
3721
			case 'activate' :
3722
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3723
					$error = 'cheatin';
3724
					break;
3725
				}
3726
3727
				$module = stripslashes( $_GET['module'] );
3728
				check_admin_referer( "jetpack_activate-$module" );
3729
				Jetpack::log( 'activate', $module );
3730
				Jetpack::activate_module( $module );
3731
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3732
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3733
				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...
3734
			case 'activate_default_modules' :
3735
				check_admin_referer( 'activate_default_modules' );
3736
				Jetpack::log( 'activate_default_modules' );
3737
				Jetpack::restate();
3738
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3739
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3740
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3741
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3742
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3743
				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...
3744
			case 'disconnect' :
3745
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3746
					$error = 'cheatin';
3747
					break;
3748
				}
3749
3750
				check_admin_referer( 'jetpack-disconnect' );
3751
				Jetpack::log( 'disconnect' );
3752
				Jetpack::disconnect();
3753
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3754
				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...
3755
			case 'reconnect' :
3756
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3757
					$error = 'cheatin';
3758
					break;
3759
				}
3760
3761
				check_admin_referer( 'jetpack-reconnect' );
3762
				Jetpack::log( 'reconnect' );
3763
				$this->disconnect();
3764
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3765
				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...
3766 View Code Duplication
			case 'deactivate' :
3767
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3768
					$error = 'cheatin';
3769
					break;
3770
				}
3771
3772
				$modules = stripslashes( $_GET['module'] );
3773
				check_admin_referer( "jetpack_deactivate-$modules" );
3774
				foreach ( explode( ',', $modules ) as $module ) {
3775
					Jetpack::log( 'deactivate', $module );
3776
					Jetpack::deactivate_module( $module );
3777
					Jetpack::state( 'message', 'module_deactivated' );
3778
				}
3779
				Jetpack::state( 'module', $modules );
3780
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
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
			case 'unlink' :
3783
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3784
				check_admin_referer( 'jetpack-unlink' );
3785
				Jetpack::log( 'unlink' );
3786
				$this->unlink_user();
3787
				Jetpack::state( 'message', 'unlinked' );
3788
				if ( 'sub-unlink' == $redirect ) {
3789
					wp_safe_redirect( admin_url() );
3790
				} else {
3791
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3792
				}
3793
				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...
3794
			default:
3795
				/**
3796
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3797
				 *
3798
				 * @since 2.6.0
3799
				 *
3800
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3801
				 */
3802
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3803
			}
3804
		}
3805
3806
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3807
			self::activate_new_modules( true );
3808
		}
3809
3810
		$message_code = Jetpack::state( 'message' );
3811
		if ( Jetpack::state( 'optin-manage' ) ) {
3812
			$activated_manage = $message_code;
3813
			$message_code = 'jetpack-manage';
3814
		}
3815
3816
		switch ( $message_code ) {
3817
		case 'jetpack-manage':
3818
			$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>';
3819
			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...
3820
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3821
			}
3822
			break;
3823
3824
		}
3825
3826
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3827
3828
		if ( ! empty( $deactivated_plugins ) ) {
3829
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3830
			$deactivated_titles  = array();
3831
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3832
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3833
					continue;
3834
				}
3835
3836
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3837
			}
3838
3839
			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...
3840
				if ( $this->message ) {
3841
					$this->message .= "<br /><br />\n";
3842
				}
3843
3844
				$this->message .= wp_sprintf(
3845
					_n(
3846
						'Jetpack contains the most recent version of the old %l plugin.',
3847
						'Jetpack contains the most recent versions of the old %l plugins.',
3848
						count( $deactivated_titles ),
3849
						'jetpack'
3850
					),
3851
					$deactivated_titles
3852
				);
3853
3854
				$this->message .= "<br />\n";
3855
3856
				$this->message .= _n(
3857
					'The old version has been deactivated and can be removed from your site.',
3858
					'The old versions have been deactivated and can be removed from your site.',
3859
					count( $deactivated_titles ),
3860
					'jetpack'
3861
				);
3862
			}
3863
		}
3864
3865
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3866
3867
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3868
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3869
		}
3870
3871 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3872
			/**
3873
			 * Fires when a module configuration page is loaded.
3874
			 * The dynamic part of the hook is the configure parameter from the URL.
3875
			 *
3876
			 * @since 1.1.0
3877
			 */
3878
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3879
		}
3880
3881
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3882
	}
3883
3884
	function admin_notices() {
3885
3886
		if ( $this->error ) {
3887
?>
3888
<div id="message" class="jetpack-message jetpack-err">
3889
	<div class="squeezer">
3890
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3891
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3892
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3893
<?php	endif; ?>
3894
	</div>
3895
</div>
3896
<?php
3897
		}
3898
3899
		if ( $this->message ) {
3900
?>
3901
<div id="message" class="jetpack-message">
3902
	<div class="squeezer">
3903
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3904
	</div>
3905
</div>
3906
<?php
3907
		}
3908
3909
		if ( $this->privacy_checks ) :
3910
			$module_names = $module_slugs = array();
3911
3912
			$privacy_checks = explode( ',', $this->privacy_checks );
3913
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3914
			foreach ( $privacy_checks as $module_slug ) {
3915
				$module = Jetpack::get_module( $module_slug );
3916
				if ( ! $module ) {
3917
					continue;
3918
				}
3919
3920
				$module_slugs[] = $module_slug;
3921
				$module_names[] = "<strong>{$module['name']}</strong>";
3922
			}
3923
3924
			$module_slugs = join( ',', $module_slugs );
3925
?>
3926
<div id="message" class="jetpack-message jetpack-err">
3927
	<div class="squeezer">
3928
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3929
		<p><?php
3930
			echo wp_kses(
3931
				wptexturize(
3932
					wp_sprintf(
3933
						_nx(
3934
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3935
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3936
							count( $privacy_checks ),
3937
							'%l = list of Jetpack module/feature names',
3938
							'jetpack'
3939
						),
3940
						$module_names
3941
					)
3942
				),
3943
				array( 'strong' => true )
3944
			);
3945
3946
			echo "\n<br />\n";
3947
3948
			echo wp_kses(
3949
				sprintf(
3950
					_nx(
3951
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3952
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3953
						count( $privacy_checks ),
3954
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3955
						'jetpack'
3956
					),
3957
					wp_nonce_url(
3958
						Jetpack::admin_url(
3959
							array(
3960
								'page'   => 'jetpack',
3961
								'action' => 'deactivate',
3962
								'module' => urlencode( $module_slugs ),
3963
							)
3964
						),
3965
						"jetpack_deactivate-$module_slugs"
3966
					),
3967
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3968
				),
3969
				array( 'a' => array( 'href' => true, 'title' => true ) )
3970
			);
3971
		?></p>
3972
	</div>
3973
</div>
3974
<?php endif;
3975
	// only display the notice if the other stuff is not there
3976
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3977
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3978
			$this->opt_in_jetpack_manage_notice();
3979
		}
3980
	}
3981
3982
	/**
3983
	 * Record a stat for later output.  This will only currently output in the admin_footer.
3984
	 */
3985
	function stat( $group, $detail ) {
3986
		if ( ! isset( $this->stats[ $group ] ) )
3987
			$this->stats[ $group ] = array();
3988
		$this->stats[ $group ][] = $detail;
3989
	}
3990
3991
	/**
3992
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
3993
	 */
3994
	function do_stats( $method = '' ) {
3995
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
3996
			foreach ( $this->stats as $group => $stats ) {
3997
				if ( is_array( $stats ) && count( $stats ) ) {
3998
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
3999
					if ( 'server_side' === $method ) {
4000
						self::do_server_side_stat( $args );
4001
					} else {
4002
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4003
					}
4004
				}
4005
				unset( $this->stats[ $group ] );
4006
			}
4007
		}
4008
	}
4009
4010
	/**
4011
	 * Runs stats code for a one-off, server-side.
4012
	 *
4013
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4014
	 *
4015
	 * @return bool If it worked.
4016
	 */
4017
	static function do_server_side_stat( $args ) {
4018
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4019
		if ( is_wp_error( $response ) )
4020
			return false;
4021
4022
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4023
			return false;
4024
4025
		return true;
4026
	}
4027
4028
	/**
4029
	 * Builds the stats url.
4030
	 *
4031
	 * @param $args array|string The arguments to append to the URL.
4032
	 *
4033
	 * @return string The URL to be pinged.
4034
	 */
4035
	static function build_stats_url( $args ) {
4036
		$defaults = array(
4037
			'v'    => 'wpcom2',
4038
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4039
		);
4040
		$args     = wp_parse_args( $args, $defaults );
4041
		/**
4042
		 * Filter the URL used as the Stats tracking pixel.
4043
		 *
4044
		 * @since 2.3.2
4045
		 *
4046
		 * @param string $url Base URL used as the Stats tracking pixel.
4047
		 */
4048
		$base_url = apply_filters(
4049
			'jetpack_stats_base_url',
4050
			'https://pixel.wp.com/g.gif'
4051
		);
4052
		$url      = add_query_arg( $args, $base_url );
4053
		return $url;
4054
	}
4055
4056
	static function translate_current_user_to_role() {
4057
		foreach ( self::$capability_translations as $role => $cap ) {
4058
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4059
				return $role;
4060
			}
4061
		}
4062
4063
		return false;
4064
	}
4065
4066
	static function translate_role_to_cap( $role ) {
4067
		if ( ! isset( self::$capability_translations[$role] ) ) {
4068
			return false;
4069
		}
4070
4071
		return self::$capability_translations[$role];
4072
	}
4073
4074
	static function sign_role( $role ) {
4075
		if ( ! $user_id = (int) get_current_user_id() ) {
4076
			return false;
4077
		}
4078
4079
		$token = Jetpack_Data::get_access_token();
4080
		if ( ! $token || is_wp_error( $token ) ) {
4081
			return false;
4082
		}
4083
4084
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4085
	}
4086
4087
4088
	/**
4089
	 * Builds a URL to the Jetpack connection auth page
4090
	 *
4091
	 * @since 3.9.5
4092
	 *
4093
	 * @param bool $raw If true, URL will not be escaped.
4094
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4095
	 *                              If string, will be a custom redirect.
4096
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4097
	 *
4098
	 * @return string Connect URL
4099
	 */
4100
	function build_connect_url( $raw = false, $redirect = false, $from = false ) {
4101
		if ( ! Jetpack_Options::get_option( 'blog_token' ) || ! Jetpack_Options::get_option( 'id' ) ) {
4102
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4103
			if( is_network_admin() ) {
4104
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4105
			}
4106
		} else {
4107
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4108
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4109
			}
4110
4111
			$role = self::translate_current_user_to_role();
4112
			$signed_role = self::sign_role( $role );
4113
4114
			$user = wp_get_current_user();
4115
4116
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4117
			$redirect = $redirect
4118
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4119
				: $jetpack_admin_page;
4120
4121
			if( isset( $_REQUEST['is_multisite'] ) ) {
4122
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4123
			}
4124
4125
			$secrets = Jetpack::init()->generate_secrets( 'authorize' );
4126
			@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...
4127
4128
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4129
				? get_site_icon_url()
4130
				: false;
4131
4132
			/**
4133
			 * Filter the type of authorization.
4134
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4135
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4136
			 *
4137
			 * @since 4.3.3
4138
			 *
4139
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4140
			 */
4141
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4142
4143
			$args = urlencode_deep(
4144
				array(
4145
					'response_type' => 'code',
4146
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4147
					'redirect_uri'  => add_query_arg(
4148
						array(
4149
							'action'   => 'authorize',
4150
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4151
							'redirect' => urlencode( $redirect ),
4152
						),
4153
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4154
					),
4155
					'state'         => $user->ID,
4156
					'scope'         => $signed_role,
4157
					'user_email'    => $user->user_email,
4158
					'user_login'    => $user->user_login,
4159
					'is_active'     => Jetpack::is_active(),
4160
					'jp_version'    => JETPACK__VERSION,
4161
					'auth_type'     => $auth_type,
4162
					'secret'        => $secret,
4163
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4164
					'blogname'      => get_option( 'blogname' ),
4165
					'site_url'      => site_url(),
4166
					'home_url'      => home_url(),
4167
					'site_icon'     => $site_icon,
4168
				)
4169
			);
4170
4171
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4172
		}
4173
4174
		if ( $from ) {
4175
			$url = add_query_arg( 'from', $from, $url );
4176
		}
4177
4178
		if ( isset( $_GET['calypso_env'] ) ) {
4179
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4180
		}
4181
4182
		return $raw ? $url : esc_url( $url );
4183
	}
4184
4185
	function build_reconnect_url( $raw = false ) {
4186
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4187
		return $raw ? $url : esc_url( $url );
4188
	}
4189
4190
	public static function admin_url( $args = null ) {
4191
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4192
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4193
		return $url;
4194
	}
4195
4196
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4197
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4198
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4199
	}
4200
4201
	function dismiss_jetpack_notice() {
4202
4203
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4204
			return;
4205
		}
4206
4207
		switch( $_GET['jetpack-notice'] ) {
4208
			case 'dismiss':
4209
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4210
4211
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4212
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4213
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4214
				}
4215
				break;
4216 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...
4217
4218
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4219
					// Don't show the banner again
4220
4221
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4222
					// redirect back to the page that had the notice
4223
					if ( wp_get_referer() ) {
4224
						wp_safe_redirect( wp_get_referer() );
4225
					} else {
4226
						// Take me to Jetpack
4227
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4228
					}
4229
				}
4230
				break;
4231 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...
4232
4233
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4234
					// Don't show the banner again
4235
4236
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4237
					// redirect back to the page that had the notice
4238
					if ( wp_get_referer() ) {
4239
						wp_safe_redirect( wp_get_referer() );
4240
					} else {
4241
						// Take me to Jetpack
4242
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4243
					}
4244
				}
4245
				break;
4246
			case 'jetpack-manage-opt-in':
4247
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4248
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4249
4250
					$redirection_url = Jetpack::admin_url();
4251
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4252
4253
					// Don't redirect form the Jetpack Setting Page
4254
					$referer_parsed = parse_url ( wp_get_referer() );
4255
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4256
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4257
						// Take the user to Jetpack home except when on the setting page
4258
						$redirection_url = wp_get_referer();
4259
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4260
					}
4261
					// Also update the JSON API FULL MANAGEMENT Option
4262
					Jetpack::activate_module( 'manage', false, false );
4263
4264
					// Special Message when option in.
4265
					Jetpack::state( 'optin-manage', 'true' );
4266
					// Activate the Module if not activated already
4267
4268
					// Redirect properly
4269
					wp_safe_redirect( $redirection_url );
4270
4271
				}
4272
				break;
4273
		}
4274
	}
4275
4276
	function debugger_page() {
4277
		nocache_headers();
4278
		if ( ! current_user_can( 'manage_options' ) ) {
4279
			die( '-1' );
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() 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...
4280
		}
4281
		Jetpack_Debugger::jetpack_debug_display_handler();
4282
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() 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...
4283
	}
4284
4285
	public static function admin_screen_configure_module( $module_id ) {
4286
4287
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4288
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4289
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4290
				/**
4291
				 * Fires to diplay a custom module activation screen.
4292
				 *
4293
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4294
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4295
				 *
4296
				 * @module manage
4297
				 *
4298
				 * @since 3.8.0
4299
				 *
4300
				 * @param int $module_id Module ID.
4301
				 */
4302
				do_action( 'display_activate_module_setting_' . $module_id );
4303
			} else {
4304
				self::display_activate_module_link( $module_id );
4305
			}
4306
4307
			return false;
4308
		} ?>
4309
4310
		<div id="jp-settings-screen" style="position: relative">
4311
			<h3>
4312
			<?php
4313
				$module = Jetpack::get_module( $module_id );
4314
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4315
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4316
			?>
4317
			</h3>
4318
			<?php
4319
				/**
4320
				 * Fires within the displayed message when a feature configuation is updated.
4321
				 *
4322
				 * @since 3.4.0
4323
				 *
4324
				 * @param int $module_id Module ID.
4325
				 */
4326
				do_action( 'jetpack_notices_update_settings', $module_id );
4327
				/**
4328
				 * Fires when a feature configuation screen is loaded.
4329
				 * The dynamic part of the hook, $module_id, is the module ID.
4330
				 *
4331
				 * @since 1.1.0
4332
				 */
4333
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4334
			?>
4335
		</div><?php
4336
	}
4337
4338
	/**
4339
	 * Display link to activate the module to see the settings screen.
4340
	 * @param  string $module_id
4341
	 * @return null
4342
	 */
4343
	public static function display_activate_module_link( $module_id ) {
4344
4345
		$info =  Jetpack::get_module( $module_id );
4346
		$extra = '';
4347
		$activate_url = wp_nonce_url(
4348
				Jetpack::admin_url(
4349
					array(
4350
						'page'   => 'jetpack',
4351
						'action' => 'activate',
4352
						'module' => $module_id,
4353
					)
4354
				),
4355
				"jetpack_activate-$module_id"
4356
			);
4357
4358
		?>
4359
4360
		<div class="wrap configure-module">
4361
			<div id="jp-settings-screen">
4362
				<?php
4363
				if ( $module_id == 'json-api' ) {
4364
4365
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4366
4367
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4368
4369
					$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' );
4370
4371
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4372
				} ?>
4373
4374
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4375
				<div class="narrow">
4376
					<p><?php echo  $info['description']; ?></p>
4377
					<?php if( $extra ) { ?>
4378
					<p><?php echo esc_html( $extra ); ?></p>
4379
					<?php } ?>
4380
					<p>
4381
						<?php
4382
						if( wp_get_referer() ) {
4383
							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() );
4384
						} else {
4385
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4386
						} ?>
4387
					</p>
4388
				</div>
4389
4390
			</div>
4391
		</div>
4392
4393
		<?php
4394
	}
4395
4396
	public static function sort_modules( $a, $b ) {
4397
		if ( $a['sort'] == $b['sort'] )
4398
			return 0;
4399
4400
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4401
	}
4402
4403
	function ajax_recheck_ssl() {
4404
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4405
		$result = Jetpack::permit_ssl( true );
4406
		wp_send_json( array(
4407
			'enabled' => $result,
4408
			'message' => get_transient( 'jetpack_https_test_message' )
4409
		) );
4410
	}
4411
4412
/* Client API */
4413
4414
	/**
4415
	 * Returns the requested Jetpack API URL
4416
	 *
4417
	 * @return string
4418
	 */
4419
	public static function api_url( $relative_url ) {
4420
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4421
	}
4422
4423
	/**
4424
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4425
	 */
4426
	public static function fix_url_for_bad_hosts( $url ) {
4427
		if ( 0 !== strpos( $url, 'https://' ) ) {
4428
			return $url;
4429
		}
4430
4431
		switch ( JETPACK_CLIENT__HTTPS ) {
4432
			case 'ALWAYS' :
4433
				return $url;
4434
			case 'NEVER' :
4435
				return set_url_scheme( $url, 'http' );
4436
			// default : case 'AUTO' :
4437
		}
4438
4439
		// we now return the unmodified SSL URL by default, as a security precaution
4440
		return $url;
4441
	}
4442
4443
	/**
4444
	 * Checks to see if the URL is using SSL to connect with Jetpack
4445
	 *
4446
	 * @since 2.3.3
4447
	 * @return boolean
4448
	 */
4449
	public static function permit_ssl( $force_recheck = false ) {
4450
		// Do some fancy tests to see if ssl is being supported
4451
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4452
			$message = '';
4453
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4454
				$ssl = 0;
4455
			} else {
4456
				switch ( JETPACK_CLIENT__HTTPS ) {
4457
					case 'NEVER':
4458
						$ssl = 0;
4459
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4460
						break;
4461
					case 'ALWAYS':
4462
					case 'AUTO':
4463
					default:
4464
						$ssl = 1;
4465
						break;
4466
				}
4467
4468
				// If it's not 'NEVER', test to see
4469
				if ( $ssl ) {
4470
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4471
						$ssl = 0;
4472
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4473
					} else {
4474
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4475
						if ( is_wp_error( $response ) ) {
4476
							$ssl = 0;
4477
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4478
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4479
							$ssl = 0;
4480
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4481
						}
4482
					}
4483
				}
4484
			}
4485
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4486
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4487
		}
4488
4489
		return (bool) $ssl;
4490
	}
4491
4492
	/*
4493
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4494
	 */
4495
	public function alert_auto_ssl_fail() {
4496
		if ( ! current_user_can( 'manage_options' ) )
4497
			return;
4498
4499
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4500
		?>
4501
4502
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4503
			<div class="jp-banner__content">
4504
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4505
				<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>
4506
				<p>
4507
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4508
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4509
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4510
				</p>
4511
				<p>
4512
					<?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' ),
4513
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4514
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4515
				</p>
4516
			</div>
4517
		</div>
4518
		<style>
4519
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4520
		</style>
4521
		<script type="text/javascript">
4522
			jQuery( document ).ready( function( $ ) {
4523
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4524
					var $this = $( this );
4525
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4526
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4527
					e.preventDefault();
4528
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4529
					$.post( ajaxurl, data )
4530
					  .done( function( response ) {
4531
					  	if ( response.enabled ) {
4532
					  		$( '#jetpack-ssl-warning' ).hide();
4533
					  	} else {
4534
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4535
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4536
					  	}
4537
					  }.bind( $this ) );
4538
				} );
4539
			} );
4540
		</script>
4541
4542
		<?php
4543
	}
4544
4545
	/**
4546
	 * Returns the Jetpack XML-RPC API
4547
	 *
4548
	 * @return string
4549
	 */
4550
	public static function xmlrpc_api_url() {
4551
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4552
		return untrailingslashit( $base ) . '/xmlrpc.php';
4553
	}
4554
4555
	/**
4556
	 * Creates two secret tokens and the end of life timestamp for them.
4557
	 *
4558
	 * Note these tokens are unique per call, NOT static per site for connecting.
4559
	 *
4560
	 * @since 2.6
4561
	 * @return array
4562
	 */
4563
	public function generate_secrets( $action, $exp = 600 ) {
4564
	    $secret = wp_generate_password( 32, false ) // secret_1
4565
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4566
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4567
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4568
		Jetpack_Options::update_option( $action, $secret );
4569
	    return Jetpack_Options::get_option( $action );
4570
	}
4571
4572
	/**
4573
	 * Builds the timeout limit for queries talking with the wpcom servers.
4574
	 *
4575
	 * Based on local php max_execution_time in php.ini
4576
	 *
4577
	 * @since 2.6
4578
	 * @return int
4579
	 **/
4580
	public function get_remote_query_timeout_limit() {
4581
	    $timeout = (int) ini_get( 'max_execution_time' );
4582
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4583
				$timeout = 30;
4584
	    return intval( $timeout / 2 );
4585
	}
4586
4587
4588
	/**
4589
	 * Takes the response from the Jetpack register new site endpoint and
4590
	 * verifies it worked properly.
4591
	 *
4592
	 * @since 2.6
4593
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4594
	 **/
4595
	public function validate_remote_register_response( $response ) {
4596
	  if ( is_wp_error( $response ) ) {
4597
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4598
		}
4599
4600
		$code   = wp_remote_retrieve_response_code( $response );
4601
		$entity = wp_remote_retrieve_body( $response );
4602
		if ( $entity )
4603
			$registration_response = json_decode( $entity );
4604
		else
4605
			$registration_response = false;
4606
4607
		$code_type = intval( $code / 100 );
4608
		if ( 5 == $code_type ) {
4609
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4610
		} elseif ( 408 == $code ) {
4611
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4612
		} elseif ( ! empty( $registration_response->error ) ) {
4613
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4614
				$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' );
4615
			} else {
4616
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4617
			}
4618
4619
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4620
		} elseif ( 200 != $code ) {
4621
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4622
		}
4623
4624
		// Jetpack ID error block
4625
		if ( empty( $registration_response->jetpack_id ) ) {
4626
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4627
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4628
			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 );
4629
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4630
			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 );
4631
		}
4632
4633
	    return $registration_response;
4634
	}
4635
	/**
4636
	 * @return bool|WP_Error
4637
	 */
4638
	public static function register() {
4639
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4640
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4641
4642
		@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...
4643 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4644
			return new Jetpack_Error( 'missing_secrets' );
4645
		}
4646
4647
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4648
4649
		$gmt_offset = get_option( 'gmt_offset' );
4650
		if ( ! $gmt_offset ) {
4651
			$gmt_offset = 0;
4652
		}
4653
4654
		$stats_options = get_option( 'stats_options' );
4655
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4656
4657
		$args = array(
4658
			'method'  => 'POST',
4659
			'body'    => array(
4660
				'siteurl'         => site_url(),
4661
				'home'            => home_url(),
4662
				'gmt_offset'      => $gmt_offset,
4663
				'timezone_string' => (string) get_option( 'timezone_string' ),
4664
				'site_name'       => (string) get_option( 'blogname' ),
4665
				'secret_1'        => $secret_1,
4666
				'secret_2'        => $secret_2,
4667
				'site_lang'       => get_locale(),
4668
				'timeout'         => $timeout,
4669
				'stats_id'        => $stats_id,
4670
				'state'           => get_current_user_id(),
4671
			),
4672
			'headers' => array(
4673
				'Accept' => 'application/json',
4674
			),
4675
			'timeout' => $timeout,
4676
		);
4677
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4678
4679
		// Make sure the response is valid and does not contain any Jetpack errors
4680
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4681
		if ( is_wp_error( $registration_details ) ) {
4682
		    return $registration_details;
4683
		} elseif ( ! $registration_details ) {
4684
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4685
		}
4686
4687 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4688
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4689
		}
4690
4691
		if ( isset( $registration_details->jetpack_public ) ) {
4692
			$jetpack_public = (int) $registration_details->jetpack_public;
4693
		} else {
4694
			$jetpack_public = false;
4695
		}
4696
4697
		Jetpack_Options::update_options(
4698
			array(
4699
				'id'         => (int)    $registration_details->jetpack_id,
4700
				'blog_token' => (string) $registration_details->jetpack_secret,
4701
				'public'     => $jetpack_public,
4702
			)
4703
		);
4704
4705
		/**
4706
		 * Fires when a site is registered on WordPress.com.
4707
		 *
4708
		 * @since 3.7.0
4709
		 *
4710
		 * @param int $json->jetpack_id Jetpack Blog ID.
4711
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4712
		 * @param int|bool $jetpack_public Is the site public.
4713
		 */
4714
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4715
4716
		// Initialize Jump Start for the first and only time.
4717
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4718
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4719
4720
			$jetpack = Jetpack::init();
4721
4722
			$jetpack->stat( 'jumpstart', 'unique-views' );
4723
			$jetpack->do_stats( 'server_side' );
4724
		};
4725
4726
		return true;
4727
	}
4728
4729
	/**
4730
	 * If the db version is showing something other that what we've got now, bump it to current.
4731
	 *
4732
	 * @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...
4733
	 */
4734
	public static function maybe_set_version_option() {
4735
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4736
		if ( JETPACK__VERSION != $version ) {
4737
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4738
4739
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4740
				/** This action is documented in class.jetpack.php */
4741
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4742
			}
4743
4744
			return true;
4745
		}
4746
		return false;
4747
	}
4748
4749
/* Client Server API */
4750
4751
	/**
4752
	 * Loads the Jetpack XML-RPC client
4753
	 */
4754
	public static function load_xml_rpc_client() {
4755
		require_once ABSPATH . WPINC . '/class-IXR.php';
4756
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4757
	}
4758
4759
	/**
4760
	 * Resets the saved authentication state in between testing requests.
4761
	 */
4762
	public function reset_saved_auth_state() {
4763
		$this->xmlrpc_verification = null;
4764
		$this->rest_authentication_status = null;
4765
	}
4766
4767
	function verify_xml_rpc_signature() {
4768
		if ( $this->xmlrpc_verification ) {
4769
			return $this->xmlrpc_verification;
4770
		}
4771
4772
		// It's not for us
4773
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4774
			return false;
4775
		}
4776
4777
		@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...
4778
		if (
4779
			empty( $token_key )
4780
		||
4781
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4782
		) {
4783
			return false;
4784
		}
4785
4786
		if ( '0' === $user_id ) {
4787
			$token_type = 'blog';
4788
			$user_id = 0;
4789
		} else {
4790
			$token_type = 'user';
4791
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4792
				return false;
4793
			}
4794
			$user_id = (int) $user_id;
4795
4796
			$user = new WP_User( $user_id );
4797
			if ( ! $user || ! $user->exists() ) {
4798
				return false;
4799
			}
4800
		}
4801
4802
		$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...
4803
		if ( ! $token ) {
4804
			return false;
4805
		}
4806
4807
		$token_check = "$token_key.";
4808
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4809
			return false;
4810
		}
4811
4812
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4813
4814
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4815
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4816
			$post_data   = $_POST;
4817
			$file_hashes = array();
4818
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4819
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4820
					continue;
4821
				}
4822
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4823
				$file_hashes[$post_data_key] = $post_data_value;
4824
			}
4825
4826
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4827
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4828
				$post_data[$post_data_key] = $post_data_value;
4829
			}
4830
4831
			ksort( $post_data );
4832
4833
			$body = http_build_query( stripslashes_deep( $post_data ) );
4834
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4835
			$body = file_get_contents( 'php://input' );
4836
		} else {
4837
			$body = null;
4838
		}
4839
4840
		$signature = $jetpack_signature->sign_current_request(
4841
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4842
		);
4843
4844
		if ( ! $signature ) {
4845
			return false;
4846
		} else if ( is_wp_error( $signature ) ) {
4847
			return $signature;
4848
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4849
			return false;
4850
		}
4851
4852
		$timestamp = (int) $_GET['timestamp'];
4853
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4854
4855
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4856
			return false;
4857
		}
4858
4859
		$this->xmlrpc_verification = array(
4860
			'type'    => $token_type,
4861
			'user_id' => $token->external_user_id,
4862
		);
4863
4864
		return $this->xmlrpc_verification;
4865
	}
4866
4867
	/**
4868
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4869
	 */
4870
	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...
4871
		if ( is_a( $user, 'WP_User' ) ) {
4872
			return $user;
4873
		}
4874
4875
		$token_details = $this->verify_xml_rpc_signature();
4876
4877
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4878
			return $user;
4879
		}
4880
4881
		if ( 'user' !== $token_details['type'] ) {
4882
			return $user;
4883
		}
4884
4885
		if ( ! $token_details['user_id'] ) {
4886
			return $user;
4887
		}
4888
4889
		nocache_headers();
4890
4891
		return new WP_User( $token_details['user_id'] );
4892
	}
4893
4894
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4895
	// Uses the existing XMLRPC request signing implementation.
4896
	function wp_rest_authenticate( $user ) {
4897
		if ( ! empty( $user ) ) {
4898
			// Another authentication method is in effect.
4899
			return $user;
4900
		}
4901
4902
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4903
			// Nothing to do for this authentication method.
4904
			return null;
4905
		}
4906
4907
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4908
			// Nothing to do for this authentication method.
4909
			return null;
4910
		}
4911
4912
		// Ensure that we always have the request body available.  At this
4913
		// point, the WP REST API code to determine the request body has not
4914
		// run yet.  That code may try to read from 'php://input' later, but
4915
		// this can only be done once per request in PHP versions prior to 5.6.
4916
		// So we will go ahead and perform this read now if needed, and save
4917
		// the request body where both the Jetpack signature verification code
4918
		// and the WP REST API code can see it.
4919
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4920
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4921
		}
4922
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4923
4924
		// Only support specific request parameters that have been tested and
4925
		// are known to work with signature verification.  A different method
4926
		// can be passed to the WP REST API via the '?_method=' parameter if
4927
		// needed.
4928
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4929
			$this->rest_authentication_status = new WP_Error(
4930
				'rest_invalid_request',
4931
				__( 'This request method is not supported.', 'jetpack' ),
4932
				array( 'status' => 400 )
4933
			);
4934
			return null;
4935
		}
4936
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
4937
			$this->rest_authentication_status = new WP_Error(
4938
				'rest_invalid_request',
4939
				__( 'This request method does not support body parameters.', 'jetpack' ),
4940
				array( 'status' => 400 )
4941
			);
4942
			return null;
4943
		}
4944
4945
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
4946
			$content_type = $_SERVER['CONTENT_TYPE'];
4947
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
4948
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
4949
		}
4950
4951
		if (
4952
			isset( $content_type ) &&
4953
			$content_type !== 'application/x-www-form-urlencoded' &&
4954
			$content_type !== 'application/json'
4955
		) {
4956
			$this->rest_authentication_status = new WP_Error(
4957
				'rest_invalid_request',
4958
				__( 'This Content-Type is not supported.', 'jetpack' ),
4959
				array( 'status' => 400 )
4960
			);
4961
			return null;
4962
		}
4963
4964
		$verified = $this->verify_xml_rpc_signature();
4965
4966
		if ( is_wp_error( $verified ) ) {
4967
			$this->rest_authentication_status = $verified;
4968
			return null;
4969
		}
4970
4971
		if (
4972
			$verified &&
4973
			isset( $verified['type'] ) &&
4974
			'user' === $verified['type'] &&
4975
			! empty( $verified['user_id'] )
4976
		) {
4977
			// Authentication successful.
4978
			$this->rest_authentication_status = true;
4979
			return $verified['user_id'];
4980
		}
4981
4982
		// Something else went wrong.  Probably a signature error.
4983
		$this->rest_authentication_status = new WP_Error(
4984
			'rest_invalid_signature',
4985
			__( 'The request is not signed correctly.', 'jetpack' ),
4986
			array( 'status' => 400 )
4987
		);
4988
		return null;
4989
	}
4990
4991
	/**
4992
	 * Report authentication status to the WP REST API.
4993
	 *
4994
	 * @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...
4995
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
4996
	 */
4997
	public function wp_rest_authentication_errors( $value ) {
4998
		if ( $value !== null ) {
4999
			return $value;
5000
		}
5001
		return $this->rest_authentication_status;
5002
	}
5003
5004
	function add_nonce( $timestamp, $nonce ) {
5005
		global $wpdb;
5006
		static $nonces_used_this_request = array();
5007
5008
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5009
			return $nonces_used_this_request["$timestamp:$nonce"];
5010
		}
5011
5012
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5013
		$timestamp = (int) $timestamp;
5014
		$nonce     = esc_sql( $nonce );
5015
5016
		// Raw query so we can avoid races: add_option will also update
5017
		$show_errors = $wpdb->show_errors( false );
5018
5019
		$old_nonce = $wpdb->get_row(
5020
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5021
		);
5022
5023
		if ( is_null( $old_nonce ) ) {
5024
			$return = $wpdb->query(
5025
				$wpdb->prepare(
5026
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5027
					"jetpack_nonce_{$timestamp}_{$nonce}",
5028
					time(),
5029
					'no'
5030
				)
5031
			);
5032
		} else {
5033
			$return = false;
5034
		}
5035
5036
		$wpdb->show_errors( $show_errors );
5037
5038
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5039
5040
		return $return;
5041
	}
5042
5043
	/**
5044
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5045
	 * Capture it here so we can verify the signature later.
5046
	 */
5047
	function xmlrpc_methods( $methods ) {
5048
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5049
		return $methods;
5050
	}
5051
5052
	function public_xmlrpc_methods( $methods ) {
5053
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5054
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5055
		}
5056
		return $methods;
5057
	}
5058
5059
	function jetpack_getOptions( $args ) {
5060
		global $wp_xmlrpc_server;
5061
5062
		$wp_xmlrpc_server->escape( $args );
5063
5064
		$username	= $args[1];
5065
		$password	= $args[2];
5066
5067
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5068
			return $wp_xmlrpc_server->error;
5069
		}
5070
5071
		$options = array();
5072
		$user_data = $this->get_connected_user_data();
5073
		if ( is_array( $user_data ) ) {
5074
			$options['jetpack_user_id'] = array(
5075
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5076
				'readonly'      => true,
5077
				'value'         => $user_data['ID'],
5078
			);
5079
			$options['jetpack_user_login'] = array(
5080
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5081
				'readonly'      => true,
5082
				'value'         => $user_data['login'],
5083
			);
5084
			$options['jetpack_user_email'] = array(
5085
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5086
				'readonly'      => true,
5087
				'value'         => $user_data['email'],
5088
			);
5089
			$options['jetpack_user_site_count'] = array(
5090
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5091
				'readonly'      => true,
5092
				'value'         => $user_data['site_count'],
5093
			);
5094
		}
5095
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5096
		$args = stripslashes_deep( $args );
5097
		return $wp_xmlrpc_server->wp_getOptions( $args );
5098
	}
5099
5100
	function xmlrpc_options( $options ) {
5101
		$jetpack_client_id = false;
5102
		if ( self::is_active() ) {
5103
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5104
		}
5105
		$options['jetpack_version'] = array(
5106
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5107
				'readonly'      => true,
5108
				'value'         => JETPACK__VERSION,
5109
		);
5110
5111
		$options['jetpack_client_id'] = array(
5112
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5113
				'readonly'      => true,
5114
				'value'         => $jetpack_client_id,
5115
		);
5116
		return $options;
5117
	}
5118
5119
	public static function clean_nonces( $all = false ) {
5120
		global $wpdb;
5121
5122
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5123
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5124
5125
		if ( true !== $all ) {
5126
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5127
			$sql_args[] = time() - 3600;
5128
		}
5129
5130
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5131
5132
		$sql = $wpdb->prepare( $sql, $sql_args );
5133
5134
		for ( $i = 0; $i < 1000; $i++ ) {
5135
			if ( ! $wpdb->query( $sql ) ) {
5136
				break;
5137
			}
5138
		}
5139
	}
5140
5141
	/**
5142
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5143
	 * SET: state( $key, $value );
5144
	 * GET: $value = state( $key );
5145
	 *
5146
	 * @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...
5147
	 * @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...
5148
	 * @param bool $restate private
5149
	 */
5150
	public static function state( $key = null, $value = null, $restate = false ) {
5151
		static $state = array();
5152
		static $path, $domain;
5153
		if ( ! isset( $path ) ) {
5154
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5155
			$admin_url = Jetpack::admin_url();
5156
			$bits      = parse_url( $admin_url );
5157
5158
			if ( is_array( $bits ) ) {
5159
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5160
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5161
			} else {
5162
				$path = $domain = null;
5163
			}
5164
		}
5165
5166
		// Extract state from cookies and delete cookies
5167
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5168
			$yum = $_COOKIE[ 'jetpackState' ];
5169
			unset( $_COOKIE[ 'jetpackState' ] );
5170
			foreach ( $yum as $k => $v ) {
5171
				if ( strlen( $v ) )
5172
					$state[ $k ] = $v;
5173
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5174
			}
5175
		}
5176
5177
		if ( $restate ) {
5178
			foreach ( $state as $k => $v ) {
5179
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5180
			}
5181
			return;
5182
		}
5183
5184
		// Get a state variable
5185
		if ( isset( $key ) && ! isset( $value ) ) {
5186
			if ( array_key_exists( $key, $state ) )
5187
				return $state[ $key ];
5188
			return null;
5189
		}
5190
5191
		// Set a state variable
5192
		if ( isset ( $key ) && isset( $value ) ) {
5193
			if( is_array( $value ) && isset( $value[0] ) ) {
5194
				$value = $value[0];
5195
			}
5196
			$state[ $key ] = $value;
5197
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5198
		}
5199
	}
5200
5201
	public static function restate() {
5202
		Jetpack::state( null, null, true );
5203
	}
5204
5205
	public static function check_privacy( $file ) {
5206
		static $is_site_publicly_accessible = null;
5207
5208
		if ( is_null( $is_site_publicly_accessible ) ) {
5209
			$is_site_publicly_accessible = false;
5210
5211
			Jetpack::load_xml_rpc_client();
5212
			$rpc = new Jetpack_IXR_Client();
5213
5214
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5215
			if ( $success ) {
5216
				$response = $rpc->getResponse();
5217
				if ( $response ) {
5218
					$is_site_publicly_accessible = true;
5219
				}
5220
			}
5221
5222
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5223
		}
5224
5225
		if ( $is_site_publicly_accessible ) {
5226
			return;
5227
		}
5228
5229
		$module_slug = self::get_module_slug( $file );
5230
5231
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5232
		if ( ! $privacy_checks ) {
5233
			$privacy_checks = $module_slug;
5234
		} else {
5235
			$privacy_checks .= ",$module_slug";
5236
		}
5237
5238
		Jetpack::state( 'privacy_checks', $privacy_checks );
5239
	}
5240
5241
	/**
5242
	 * Helper method for multicall XMLRPC.
5243
	 */
5244
	public static function xmlrpc_async_call() {
5245
		global $blog_id;
5246
		static $clients = array();
5247
5248
		$client_blog_id = is_multisite() ? $blog_id : 0;
5249
5250
		if ( ! isset( $clients[$client_blog_id] ) ) {
5251
			Jetpack::load_xml_rpc_client();
5252
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5253
			if ( function_exists( 'ignore_user_abort' ) ) {
5254
				ignore_user_abort( true );
5255
			}
5256
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5257
		}
5258
5259
		$args = func_get_args();
5260
5261
		if ( ! empty( $args[0] ) ) {
5262
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5263
		} elseif ( is_multisite() ) {
5264
			foreach ( $clients as $client_blog_id => $client ) {
5265
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5266
					continue;
5267
				}
5268
5269
				$switch_success = switch_to_blog( $client_blog_id, true );
5270
				if ( ! $switch_success ) {
5271
					continue;
5272
				}
5273
5274
				flush();
5275
				$client->query();
5276
5277
				restore_current_blog();
5278
			}
5279
		} else {
5280
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5281
				flush();
5282
				$clients[0]->query();
5283
			}
5284
		}
5285
	}
5286
5287
	public static function staticize_subdomain( $url ) {
5288
5289
		// Extract hostname from URL
5290
		$host = parse_url( $url, PHP_URL_HOST );
5291
5292
		// Explode hostname on '.'
5293
		$exploded_host = explode( '.', $host );
5294
5295
		// Retrieve the name and TLD
5296
		if ( count( $exploded_host ) > 1 ) {
5297
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5298
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5299
			// Rebuild domain excluding subdomains
5300
			$domain = $name . '.' . $tld;
5301
		} else {
5302
			$domain = $host;
5303
		}
5304
		// Array of Automattic domains
5305
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5306
5307
		// Return $url if not an Automattic domain
5308
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5309
			return $url;
5310
		}
5311
5312
		if ( is_ssl() ) {
5313
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5314
		}
5315
5316
		srand( crc32( basename( $url ) ) );
5317
		$static_counter = rand( 0, 2 );
5318
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5319
5320
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5321
	}
5322
5323
/* JSON API Authorization */
5324
5325
	/**
5326
	 * Handles the login action for Authorizing the JSON API
5327
	 */
5328
	function login_form_json_api_authorization() {
5329
		$this->verify_json_api_authorization_request();
5330
5331
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5332
5333
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5334
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5335
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5336
	}
5337
5338
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5339
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5340
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5341
			return $url;
5342
		}
5343
5344
		$parsed_url = parse_url( $url );
5345
		$url = strtok( $url, '?' );
5346
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5347
		if ( ! empty( $parsed_url['query'] ) )
5348
			$url .= "&{$parsed_url['query']}";
5349
5350
		return $url;
5351
	}
5352
5353
	// Make sure the POSTed request is handled by the same action
5354
	function preserve_action_in_login_form_for_json_api_authorization() {
5355
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5356
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5357
	}
5358
5359
	// If someone logs in to approve API access, store the Access Code in usermeta
5360
	function store_json_api_authorization_token( $user_login, $user ) {
5361
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5362
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5363
		$token = wp_generate_password( 32, false );
5364
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5365
	}
5366
5367
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5368
	function allow_wpcom_public_api_domain( $domains ) {
5369
		$domains[] = 'public-api.wordpress.com';
5370
		return $domains;
5371
	}
5372
5373
	// Add the Access Code details to the public-api.wordpress.com redirect
5374
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5375
		return add_query_arg(
5376
			urlencode_deep(
5377
				array(
5378
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5379
					'jetpack-user-id' => (int) $user->ID,
5380
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5381
				)
5382
			),
5383
			$redirect_to
5384
		);
5385
	}
5386
5387
5388
	/**
5389
	 * Verifies the request by checking the signature
5390
	 *
5391
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5392
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5393
	 *
5394
	 * @param null|array $environment
5395
	 */
5396
	function verify_json_api_authorization_request( $environment = null ) {
5397
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5398
5399
		$environment = is_null( $environment )
5400
			? $_REQUEST
5401
			: $environment;
5402
5403
		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...
5404
		$token = Jetpack_Data::get_access_token( $envUserId );
5405
		if ( ! $token || empty( $token->secret ) ) {
5406
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5407
		}
5408
5409
		$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' );
5410
5411
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5412
5413
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5414
			$signature = $jetpack_signature->sign_request(
5415
				$environment['token'],
5416
				$environment['timestamp'],
5417
				$environment['nonce'],
5418
				'',
5419
				'GET',
5420
				$environment['jetpack_json_api_original_query'],
5421
				null,
5422
				true
5423
			);
5424
		} else {
5425
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5426
		}
5427
5428
		if ( ! $signature ) {
5429
			wp_die( $die_error );
5430
		} else if ( is_wp_error( $signature ) ) {
5431
			wp_die( $die_error );
5432
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5433
			if ( is_ssl() ) {
5434
				// 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
5435
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5436
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5437
					wp_die( $die_error );
5438
				}
5439
			} else {
5440
				wp_die( $die_error );
5441
			}
5442
		}
5443
5444
		$timestamp = (int) $environment['timestamp'];
5445
		$nonce     = stripslashes( (string) $environment['nonce'] );
5446
5447
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5448
			// De-nonce the nonce, at least for 5 minutes.
5449
			// 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)
5450
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5451
			if ( $old_nonce_time < time() - 300 ) {
5452
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5453
			}
5454
		}
5455
5456
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5457
		$data_filters = array(
5458
			'state'        => 'opaque',
5459
			'client_id'    => 'int',
5460
			'client_title' => 'string',
5461
			'client_image' => 'url',
5462
		);
5463
5464
		foreach ( $data_filters as $key => $sanitation ) {
5465
			if ( ! isset( $data->$key ) ) {
5466
				wp_die( $die_error );
5467
			}
5468
5469
			switch ( $sanitation ) {
5470
			case 'int' :
5471
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5472
				break;
5473
			case 'opaque' :
5474
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5475
				break;
5476
			case 'string' :
5477
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5478
				break;
5479
			case 'url' :
5480
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5481
				break;
5482
			}
5483
		}
5484
5485
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5486
			wp_die( $die_error );
5487
		}
5488
	}
5489
5490
	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...
5491
		return '<p class="message">' . sprintf(
5492
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5493
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5494
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5495
	}
5496
5497
	/**
5498
	 * Get $content_width, but with a <s>twist</s> filter.
5499
	 */
5500
	public static function get_content_width() {
5501
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5502
		/**
5503
		 * Filter the Content Width value.
5504
		 *
5505
		 * @since 2.2.3
5506
		 *
5507
		 * @param string $content_width Content Width value.
5508
		 */
5509
		return apply_filters( 'jetpack_content_width', $content_width );
5510
	}
5511
5512
	/**
5513
	 * Pings the WordPress.com Mirror Site for the specified options.
5514
	 *
5515
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5516
	 *
5517
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5518
	 */
5519
	public function get_cloud_site_options( $option_names ) {
5520
		$option_names = array_filter( (array) $option_names, 'is_string' );
5521
5522
		Jetpack::load_xml_rpc_client();
5523
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5524
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5525
		if ( $xml->isError() ) {
5526
			return array(
5527
				'error_code' => $xml->getErrorCode(),
5528
				'error_msg'  => $xml->getErrorMessage(),
5529
			);
5530
		}
5531
		$cloud_site_options = $xml->getResponse();
5532
5533
		return $cloud_site_options;
5534
	}
5535
5536
	/**
5537
	 * Checks if the site is currently in an identity crisis.
5538
	 *
5539
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5540
	 */
5541
	public static function check_identity_crisis() {
5542
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5543
			return false;
5544
		}
5545
5546
		return Jetpack_Options::get_option( 'sync_error_idc' );
5547
	}
5548
5549
	/**
5550
	 * Checks whether the home and siteurl specifically are whitelisted
5551
	 * Written so that we don't have re-check $key and $value params every time
5552
	 * we want to check if this site is whitelisted, for example in footer.php
5553
	 *
5554
	 * @since  3.8.0
5555
	 * @return bool True = already whitelisted False = not whitelisted
5556
	 */
5557
	public static function is_staging_site() {
5558
		$is_staging = false;
5559
5560
		$known_staging = array(
5561
			'urls' => array(
5562
				'#\.staging\.wpengine\.com$#i', // WP Engine
5563
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5564
				),
5565
			'constants' => array(
5566
				'IS_WPE_SNAPSHOT',      // WP Engine
5567
				'KINSTA_DEV_ENV',       // Kinsta.com
5568
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5569
				'JETPACK_STAGING_MODE', // Generic
5570
				)
5571
			);
5572
		/**
5573
		 * Filters the flags of known staging sites.
5574
		 *
5575
		 * @since 3.9.0
5576
		 *
5577
		 * @param array $known_staging {
5578
		 *     An array of arrays that each are used to check if the current site is staging.
5579
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5580
		 *     @type array $constants PHP constants of known staging/developement environments.
5581
		 *  }
5582
		 */
5583
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5584
5585
		if ( isset( $known_staging['urls'] ) ) {
5586
			foreach ( $known_staging['urls'] as $url ){
5587
				if ( preg_match( $url, site_url() ) ) {
5588
					$is_staging = true;
5589
					break;
5590
				}
5591
			}
5592
		}
5593
5594
		if ( isset( $known_staging['constants'] ) ) {
5595
			foreach ( $known_staging['constants'] as $constant ) {
5596
				if ( defined( $constant ) && constant( $constant ) ) {
5597
					$is_staging = true;
5598
				}
5599
			}
5600
		}
5601
5602
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5603
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5604
			$is_staging = true;
5605
		}
5606
5607
		/**
5608
		 * Filters is_staging_site check.
5609
		 *
5610
		 * @since 3.9.0
5611
		 *
5612
		 * @param bool $is_staging If the current site is a staging site.
5613
		 */
5614
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5615
	}
5616
5617
	/**
5618
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5619
	 *
5620
	 * @return bool
5621
	 */
5622
	public static function validate_sync_error_idc_option() {
5623
		$is_valid = false;
5624
5625
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5626
		if ( false === $idc_allowed ) {
5627
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5628
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5629
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5630
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5631
				$transient_duration = HOUR_IN_SECONDS;
5632
			} else {
5633
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5634
				$idc_allowed = '1';
5635
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5636
			}
5637
5638
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5639
		}
5640
5641
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5642
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5643
		$local_options = self::get_sync_error_idc_option();
5644
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5645
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5646
				$is_valid = true;
5647
			}
5648
		}
5649
5650
		/**
5651
		 * Filters whether the sync_error_idc option is valid.
5652
		 *
5653
		 * @since 4.4.0
5654
		 *
5655
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5656
		 */
5657
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5658
5659
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5660
			// Since the option exists, and did not validate, delete it
5661
			Jetpack_Options::delete_option( 'sync_error_idc' );
5662
		}
5663
5664
		return $is_valid;
5665
	}
5666
5667
	/**
5668
	 * Normalizes a url by doing three things:
5669
	 *  - Strips protocol
5670
	 *  - Strips www
5671
	 *  - Adds a trailing slash
5672
	 *
5673
	 * @since 4.4.0
5674
	 * @param string $url
5675
	 * @return WP_Error|string
5676
	 */
5677
	public static function normalize_url_protocol_agnostic( $url ) {
5678
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5679
		if ( ! $parsed_url ) {
5680
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5681
		}
5682
5683
		// Strip www and protocols
5684
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5685
		return $url;
5686
	}
5687
5688
	/**
5689
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5690
	 *
5691
	 * @since 4.4.0
5692
	 *
5693
	 * @param array $response
5694
	 * @return array Array of the local urls, wpcom urls, and error code
5695
	 */
5696
	public static function get_sync_error_idc_option( $response = array() ) {
5697
		$local_options = array(
5698
			'home' => get_home_url(),
5699
			'siteurl' => get_site_url(),
5700
		);
5701
5702
		$options = array_merge( $local_options, $response );
5703
5704
		$returned_values = array();
5705
		foreach( $options as $key => $option ) {
5706
			if ( 'error_code' === $key ) {
5707
				$returned_values[ $key ] = $option;
5708
				continue;
5709
			}
5710
5711
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5712
				continue;
5713
			}
5714
5715
			$returned_values[ $key ] = $normalized_url;
5716
		}
5717
5718
		return $returned_values;
5719
	}
5720
5721
	/**
5722
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5723
	 * If set to true, the site will be put into staging mode.
5724
	 *
5725
	 * @since 4.3.2
5726
	 * @return bool
5727
	 */
5728
	public static function sync_idc_optin() {
5729
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5730
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5731
		} else {
5732
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5733
		}
5734
5735
		/**
5736
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5737
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5738
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5739
		 *
5740
		 * @since 4.3.2
5741
		 *
5742
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5743
		 */
5744
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5745
	}
5746
5747
	/**
5748
	 * Maybe Use a .min.css stylesheet, maybe not.
5749
	 *
5750
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5751
	 */
5752
	public static function maybe_min_asset( $url, $path, $plugin ) {
5753
		// Short out on things trying to find actual paths.
5754
		if ( ! $path || empty( $plugin ) ) {
5755
			return $url;
5756
		}
5757
5758
		// Strip out the abspath.
5759
		$base = dirname( plugin_basename( $plugin ) );
5760
5761
		// Short out on non-Jetpack assets.
5762
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5763
			return $url;
5764
		}
5765
5766
		// File name parsing.
5767
		$file              = "{$base}/{$path}";
5768
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5769
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5770
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5771
		$extension         = array_shift( $file_name_parts_r );
5772
5773
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5774
			// Already pointing at the minified version.
5775
			if ( 'min' === $file_name_parts_r[0] ) {
5776
				return $url;
5777
			}
5778
5779
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5780
			if ( file_exists( $min_full_path ) ) {
5781
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5782
			}
5783
		}
5784
5785
		return $url;
5786
	}
5787
5788
	/**
5789
	 * Maybe inlines a stylesheet.
5790
	 *
5791
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5792
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5793
	 *
5794
	 * Attached to `style_loader_tag` filter.
5795
	 *
5796
	 * @param string $tag The tag that would link to the external asset.
5797
	 * @param string $handle The registered handle of the script in question.
5798
	 *
5799
	 * @return string
5800
	 */
5801
	public static function maybe_inline_style( $tag, $handle ) {
5802
		global $wp_styles;
5803
		$item = $wp_styles->registered[ $handle ];
5804
5805
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5806
			return $tag;
5807
		}
5808
5809
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5810
			$href = $matches[1];
5811
			// Strip off query string
5812
			if ( $pos = strpos( $href, '?' ) ) {
5813
				$href = substr( $href, 0, $pos );
5814
			}
5815
			// Strip off fragment
5816
			if ( $pos = strpos( $href, '#' ) ) {
5817
				$href = substr( $href, 0, $pos );
5818
			}
5819
		} else {
5820
			return $tag;
5821
		}
5822
5823
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5824
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5825
			return $tag;
5826
		}
5827
5828
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5829
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5830
			// And this isn't the pass that actually deals with the RTL version...
5831
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5832
				// Short out, as the RTL version will deal with it in a moment.
5833
				return $tag;
5834
			}
5835
		}
5836
5837
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5838
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5839
		if ( $css ) {
5840
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5841
			if ( empty( $item->extra['after'] ) ) {
5842
				wp_add_inline_style( $handle, $css );
5843
			} else {
5844
				array_unshift( $item->extra['after'], $css );
5845
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5846
			}
5847
		}
5848
5849
		return $tag;
5850
	}
5851
5852
	/**
5853
	 * Loads a view file from the views
5854
	 *
5855
	 * Data passed in with the $data parameter will be available in the
5856
	 * template file as $data['value']
5857
	 *
5858
	 * @param string $template - Template file to load
5859
	 * @param array $data - Any data to pass along to the template
5860
	 * @return boolean - If template file was found
5861
	 **/
5862
	public function load_view( $template, $data = array() ) {
5863
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5864
5865
		if( file_exists( $views_dir . $template ) ) {
5866
			require_once( $views_dir . $template );
5867
			return true;
5868
		}
5869
5870
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5871
		return false;
5872
	}
5873
5874
	/**
5875
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5876
	 */
5877
	public function deprecated_hooks() {
5878
		global $wp_filter;
5879
5880
		/*
5881
		 * Format:
5882
		 * deprecated_filter_name => replacement_name
5883
		 *
5884
		 * If there is no replacement, use null for replacement_name
5885
		 */
5886
		$deprecated_list = array(
5887
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5888
			'wpl_sharing_2014_1'                                     => null,
5889
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5890
			'jetpack_identity_crisis_options_to_check'               => null,
5891
			'update_option_jetpack_single_user_site'                 => null,
5892
			'audio_player_default_colors'                            => null,
5893
			'add_option_jetpack_featured_images_enabled'             => null,
5894
			'add_option_jetpack_update_details'                      => null,
5895
			'add_option_jetpack_updates'                             => null,
5896
			'add_option_jetpack_network_name'                        => null,
5897
			'add_option_jetpack_network_allow_new_registrations'     => null,
5898
			'add_option_jetpack_network_add_new_users'               => null,
5899
			'add_option_jetpack_network_site_upload_space'           => null,
5900
			'add_option_jetpack_network_upload_file_types'           => null,
5901
			'add_option_jetpack_network_enable_administration_menus' => null,
5902
			'add_option_jetpack_is_multi_site'                       => null,
5903
			'add_option_jetpack_is_main_network'                     => null,
5904
			'add_option_jetpack_main_network_site'                   => null,
5905
			'jetpack_sync_all_registered_options'                    => null,
5906
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5907
			'jetpack_is_post_mailable'                               => null,
5908
		);
5909
5910
		// This is a silly loop depth. Better way?
5911
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5912
			if ( has_action( $hook ) ) {
5913
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5914
					foreach( $values AS $hooked ) {
5915
						if ( is_callable( $hooked['function'] ) ) {
5916
							$function_name = 'an anonymous function';
5917
						} else {
5918
							$function_name = $hooked['function'];
5919
						}
5920
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
5921
					}
5922
				}
5923
			}
5924
		}
5925
	}
5926
5927
	/**
5928
	 * Converts any url in a stylesheet, to the correct absolute url.
5929
	 *
5930
	 * Considerations:
5931
	 *  - Normal, relative URLs     `feh.png`
5932
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
5933
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
5934
	 *  - Absolute URLs             `http://domain.com/feh.png`
5935
	 *  - Domain root relative URLs `/feh.png`
5936
	 *
5937
	 * @param $css string: The raw CSS -- should be read in directly from the file.
5938
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
5939
	 *
5940
	 * @return mixed|string
5941
	 */
5942
	public static function absolutize_css_urls( $css, $css_file_url ) {
5943
		$pattern = '#url\((?P<path>[^)]*)\)#i';
5944
		$css_dir = dirname( $css_file_url );
5945
		$p       = parse_url( $css_dir );
5946
		$domain  = sprintf(
5947
					'%1$s//%2$s%3$s%4$s',
5948
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
5949
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
5950
					$p['host'],
5951
					isset( $p['port'] )             ? ":{$p['port']}" : ''
5952
				);
5953
5954
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
5955
			$find = $replace = array();
5956
			foreach ( $matches as $match ) {
5957
				$url = trim( $match['path'], "'\" \t" );
5958
5959
				// If this is a data url, we don't want to mess with it.
5960
				if ( 'data:' === substr( $url, 0, 5 ) ) {
5961
					continue;
5962
				}
5963
5964
				// If this is an absolute or protocol-agnostic url,
5965
				// we don't want to mess with it.
5966
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
5967
					continue;
5968
				}
5969
5970
				switch ( substr( $url, 0, 1 ) ) {
5971
					case '/':
5972
						$absolute = $domain . $url;
5973
						break;
5974
					default:
5975
						$absolute = $css_dir . '/' . $url;
5976
				}
5977
5978
				$find[]    = $match[0];
5979
				$replace[] = sprintf( 'url("%s")', $absolute );
5980
			}
5981
			$css = str_replace( $find, $replace, $css );
5982
		}
5983
5984
		return $css;
5985
	}
5986
5987
	/**
5988
	 * This methods removes all of the registered css files on the front end
5989
	 * from Jetpack in favor of using a single file. In effect "imploding"
5990
	 * all the files into one file.
5991
	 *
5992
	 * Pros:
5993
	 * - Uses only ONE css asset connection instead of 15
5994
	 * - Saves a minimum of 56k
5995
	 * - Reduces server load
5996
	 * - Reduces time to first painted byte
5997
	 *
5998
	 * Cons:
5999
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6000
	 *		should not cause any issues with themes.
6001
	 * - Plugins/themes dequeuing styles no longer do anything. See
6002
	 *		jetpack_implode_frontend_css filter for a workaround
6003
	 *
6004
	 * For some situations developers may wish to disable css imploding and
6005
	 * instead operate in legacy mode where each file loads seperately and
6006
	 * can be edited individually or dequeued. This can be accomplished with
6007
	 * the following line:
6008
	 *
6009
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6010
	 *
6011
	 * @since 3.2
6012
	 **/
6013
	public function implode_frontend_css( $travis_test = false ) {
6014
		$do_implode = true;
6015
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6016
			$do_implode = false;
6017
		}
6018
6019
		/**
6020
		 * Allow CSS to be concatenated into a single jetpack.css file.
6021
		 *
6022
		 * @since 3.2.0
6023
		 *
6024
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6025
		 */
6026
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6027
6028
		// Do not use the imploded file when default behaviour was altered through the filter
6029
		if ( ! $do_implode ) {
6030
			return;
6031
		}
6032
6033
		// We do not want to use the imploded file in dev mode, or if not connected
6034
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6035
			if ( ! $travis_test ) {
6036
				return;
6037
			}
6038
		}
6039
6040
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6041
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6042
			return;
6043
		}
6044
6045
		/*
6046
		 * Now we assume Jetpack is connected and able to serve the single
6047
		 * file.
6048
		 *
6049
		 * In the future there will be a check here to serve the file locally
6050
		 * or potentially from the Jetpack CDN
6051
		 *
6052
		 * For now:
6053
		 * - Enqueue a single imploded css file
6054
		 * - Zero out the style_loader_tag for the bundled ones
6055
		 * - Be happy, drink scotch
6056
		 */
6057
6058
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6059
6060
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6061
6062
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6063
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6064
	}
6065
6066
	function concat_remove_style_loader_tag( $tag, $handle ) {
6067
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6068
			$tag = '';
6069
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6070
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6071
			}
6072
		}
6073
6074
		return $tag;
6075
	}
6076
6077
	/*
6078
	 * Check the heartbeat data
6079
	 *
6080
	 * Organizes the heartbeat data by severity.  For example, if the site
6081
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6082
	 *
6083
	 * Data will be added to "caution" array, if it either:
6084
	 *  - Out of date Jetpack version
6085
	 *  - Out of date WP version
6086
	 *  - Out of date PHP version
6087
	 *
6088
	 * $return array $filtered_data
6089
	 */
6090
	public static function jetpack_check_heartbeat_data() {
6091
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6092
6093
		$good    = array();
6094
		$caution = array();
6095
		$bad     = array();
6096
6097
		foreach ( $raw_data as $stat => $value ) {
6098
6099
			// Check jetpack version
6100
			if ( 'version' == $stat ) {
6101
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6102
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6103
					continue;
6104
				}
6105
			}
6106
6107
			// Check WP version
6108
			if ( 'wp-version' == $stat ) {
6109
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6110
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6111
					continue;
6112
				}
6113
			}
6114
6115
			// Check PHP version
6116
			if ( 'php-version' == $stat ) {
6117
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6118
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6119
					continue;
6120
				}
6121
			}
6122
6123
			// Check ID crisis
6124
			if ( 'identitycrisis' == $stat ) {
6125
				if ( 'yes' == $value ) {
6126
					$bad[ $stat ] = $value;
6127
					continue;
6128
				}
6129
			}
6130
6131
			// The rest are good :)
6132
			$good[ $stat ] = $value;
6133
		}
6134
6135
		$filtered_data = array(
6136
			'good'    => $good,
6137
			'caution' => $caution,
6138
			'bad'     => $bad
6139
		);
6140
6141
		return $filtered_data;
6142
	}
6143
6144
6145
	/*
6146
	 * This method is used to organize all options that can be reset
6147
	 * without disconnecting Jetpack.
6148
	 *
6149
	 * It is used in class.jetpack-cli.php to reset options
6150
	 *
6151
	 * @return array of options to delete.
6152
	 */
6153
	public static function get_jetpack_options_for_reset() {
6154
		$jetpack_options            = Jetpack_Options::get_option_names();
6155
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6156
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6157
6158
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6159
6160
		// A manual build of the wp options
6161
		$wp_options = array(
6162
			'sharing-options',
6163
			'disabled_likes',
6164
			'disabled_reblogs',
6165
			'jetpack_comments_likes_enabled',
6166
			'wp_mobile_excerpt',
6167
			'wp_mobile_featured_images',
6168
			'wp_mobile_app_promos',
6169
			'stats_options',
6170
			'stats_dashboard_widget',
6171
			'safecss_preview_rev',
6172
			'safecss_rev',
6173
			'safecss_revision_migrated',
6174
			'nova_menu_order',
6175
			'jetpack_portfolio',
6176
			'jetpack_portfolio_posts_per_page',
6177
			'jetpack_testimonial',
6178
			'jetpack_testimonial_posts_per_page',
6179
			'wp_mobile_custom_css',
6180
			'sharedaddy_disable_resources',
6181
			'sharing-options',
6182
			'sharing-services',
6183
			'site_icon_temp_data',
6184
			'featured-content',
6185
			'site_logo',
6186
			'jetpack_dismissed_notices',
6187
		);
6188
6189
		// Flag some Jetpack options as unsafe
6190
		$unsafe_options = array(
6191
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6192
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6193
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6194
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6195
6196
			// non_compact
6197
			'activated',
6198
6199
			// private
6200
			'register',
6201
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6202
			'user_token',                  // (string) The User Token of this site. (deprecated)
6203
			'user_tokens'
6204
		);
6205
6206
		// Remove the unsafe Jetpack options
6207
		foreach ( $unsafe_options as $unsafe_option ) {
6208
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6209
				unset( $all_jp_options[ $key ] );
6210
			}
6211
		}
6212
6213
		$options = array(
6214
			'jp_options' => $all_jp_options,
6215
			'wp_options' => $wp_options
6216
		);
6217
6218
		return $options;
6219
	}
6220
6221
	/**
6222
	 * Check if an option of a Jetpack module has been updated.
6223
	 *
6224
	 * If any module option has been updated before Jump Start has been dismissed,
6225
	 * update the 'jumpstart' option so we can hide Jump Start.
6226
	 *
6227
	 * @param string $option_name
6228
	 *
6229
	 * @return bool
6230
	 */
6231
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6232
		// Bail if Jump Start has already been dismissed
6233
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6234
			return false;
6235
		}
6236
6237
		$jetpack = Jetpack::init();
6238
6239
		// Manual build of module options
6240
		$option_names = self::get_jetpack_options_for_reset();
6241
6242
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6243
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6244
6245
			//Jump start is being dismissed send data to MC Stats
6246
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6247
6248
			$jetpack->do_stats( 'server_side' );
6249
		}
6250
6251
	}
6252
6253
	/*
6254
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6255
	 * so we can bring them directly to their site in calypso.
6256
	 *
6257
	 * @param string | url
6258
	 * @return string | url without the guff
6259
	 */
6260
	public static function build_raw_urls( $url ) {
6261
		$strip_http = '/.*?:\/\//i';
6262
		$url = preg_replace( $strip_http, '', $url  );
6263
		$url = str_replace( '/', '::', $url );
6264
		return $url;
6265
	}
6266
6267
	/**
6268
	 * Stores and prints out domains to prefetch for page speed optimization.
6269
	 *
6270
	 * @param mixed $new_urls
6271
	 */
6272
	public static function dns_prefetch( $new_urls = null ) {
6273
		static $prefetch_urls = array();
6274
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6275
			echo "\r\n";
6276
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6277
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6278
			}
6279
		} elseif ( ! empty( $new_urls ) ) {
6280
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6281
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6282
			}
6283
			foreach ( (array) $new_urls as $this_new_url ) {
6284
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6285
			}
6286
			$prefetch_urls = array_unique( $prefetch_urls );
6287
		}
6288
	}
6289
6290
	public function wp_dashboard_setup() {
6291
		if ( self::is_active() ) {
6292
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6293
			$widget_title = __( 'Site Stats', 'jetpack' );
6294
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6295
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6296
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6297
		}
6298
6299
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6300
			wp_add_dashboard_widget(
6301
				'jetpack_summary_widget',
6302
				$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...
6303
				array( __CLASS__, 'dashboard_widget' )
6304
			);
6305
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6306
6307
			// If we're inactive and not in development mode, sort our box to the top.
6308
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6309
				global $wp_meta_boxes;
6310
6311
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6312
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6313
6314
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6315
			}
6316
		}
6317
	}
6318
6319
	/**
6320
	 * @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...
6321
	 * @return mixed
6322
	 */
6323
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6324
		if ( ! is_array( $sorted ) ) {
6325
			return $sorted;
6326
		}
6327
6328
		foreach ( $sorted as $box_context => $ids ) {
6329
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6330
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6331
				continue;
6332
			}
6333
6334
			$ids_array = explode( ',', $ids );
6335
			$key = array_search( 'dashboard_stats', $ids_array );
6336
6337
			if ( false !== $key ) {
6338
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6339
				$ids_array[ $key ] = 'jetpack_summary_widget';
6340
				$sorted[ $box_context ] = implode( ',', $ids_array );
6341
				// We've found it, stop searching, and just return.
6342
				break;
6343
			}
6344
		}
6345
6346
		return $sorted;
6347
	}
6348
6349
	public static function dashboard_widget() {
6350
		/**
6351
		 * Fires when the dashboard is loaded.
6352
		 *
6353
		 * @since 3.4.0
6354
		 */
6355
		do_action( 'jetpack_dashboard_widget' );
6356
	}
6357
6358
	public static function dashboard_widget_footer() {
6359
		?>
6360
		<footer>
6361
6362
		<div class="protect">
6363
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6364
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6365
				<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>
6366
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6367
				<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' ); ?>">
6368
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6369
				</a>
6370
			<?php else : ?>
6371
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6372
			<?php endif; ?>
6373
		</div>
6374
6375
		<div class="akismet">
6376
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6377
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6378
				<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>
6379
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6380
				<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">
6381
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6382
				</a>
6383
			<?php else : ?>
6384
				<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>
6385
			<?php endif; ?>
6386
		</div>
6387
6388
		</footer>
6389
		<?php
6390
	}
6391
6392
	public function dashboard_widget_connect_to_wpcom() {
6393
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6394
			return;
6395
		}
6396
		?>
6397
		<div class="wpcom-connect">
6398
			<div class="jp-emblem">
6399
			<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">
6400
				<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"/>
6401
			</svg>
6402
			</div>
6403
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6404
			<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>
6405
6406
			<div class="actions">
6407
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6408
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6409
				</a>
6410
			</div>
6411
		</div>
6412
		<?php
6413
	}
6414
6415
	/**
6416
	 * Return string containing the Jetpack logo.
6417
	 *
6418
	 * @since 3.9.0
6419
	 *
6420
	 * @return string
6421
	 */
6422
	public static function get_jp_emblem() {
6423
		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>';
6424
	}
6425
6426
	/*
6427
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6428
	 */
6429
	function jetpack_icon_user_connected( $columns ) {
6430
		$columns['user_jetpack'] = '';
6431
		return $columns;
6432
	}
6433
6434
	/*
6435
	 * Show Jetpack icon if the user is linked.
6436
	 */
6437
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6438
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6439
			$emblem_html = sprintf(
6440
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6441
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6442
				Jetpack::get_jp_emblem()
6443
			);
6444
			return $emblem_html;
6445
		}
6446
6447
		return $val;
6448
	}
6449
6450
	/*
6451
	 * Style the Jetpack user column
6452
	 */
6453
	function jetpack_user_col_style() {
6454
		global $current_screen;
6455
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6456
			<style>
6457
				.fixed .column-user_jetpack {
6458
					width: 21px;
6459
				}
6460
				.jp-emblem-user-admin svg {
6461
					width: 20px;
6462
					height: 20px;
6463
				}
6464
				.jp-emblem-user-admin path {
6465
					fill: #8cc258;
6466
				}
6467
			</style>
6468
		<?php }
6469
	}
6470
}
6471