Completed
Push — update/remove-site-icon-code ( 7017f6...f4e6c1 )
by
unknown
420:56 queued 412:29
created

Jetpack::build_connect_url()   F

Complexity

Conditions 15
Paths 272

Size

Total Lines 84
Code Lines 52

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 15
eloc 52
nc 272
nop 3
dl 0
loc 84
rs 3.7313
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

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