Completed
Push — master-stable ( 502f21...5dbebd )
by
unknown
34:46 queued 26:29
created

Jetpack::upgrade_on_module_load()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 5
nc 2
nop 0
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css
37
	 */
38
	public $concatenated_style_handles = array(
39
		'jetpack-carousel',
40
		'grunion.css',
41
		'the-neverending-homepage',
42
		'jetpack_likes',
43
		'jetpack_related-posts',
44
		'sharedaddy',
45
		'jetpack-slideshow',
46
		'presentations',
47
		'jetpack-subscriptions',
48
		'jetpack-responsive-videos-style',
49
		'jetpack-social-menu',
50
		'tiled-gallery',
51
		'jetpack_display_posts_widget',
52
		'gravatar-profile-widget',
53
		'goodreads-widget',
54
		'jetpack_social_media_icons_widget',
55
		'jetpack-top-posts-widget',
56
		'jetpack_image_widget',
57
		'jetpack-my-community-widget',
58
		'wordads',
59
	);
60
61
	public $plugins_to_deactivate = array(
62
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
63
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
64
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
65
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
66
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
67
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
68
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
69
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
70
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
71
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
72
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
73
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
74
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
75
		'omnisearch'          => array( 'jetpack-omnisearch/omnisearch.php', 'Jetpack Omnisearch' ),
76
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
77
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
78
	);
79
80
	static $capability_translations = array(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
81
		'administrator' => 'manage_options',
82
		'editor'        => 'edit_others_posts',
83
		'author'        => 'publish_posts',
84
		'contributor'   => 'edit_posts',
85
		'subscriber'    => 'read',
86
	);
87
88
	/**
89
	 * Map of modules that have conflicts with plugins and should not be auto-activated
90
	 * if the plugins are active.  Used by filter_default_modules
91
	 *
92
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
93
	 * change `module-slug` and add this to your plugin:
94
	 *
95
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
96
	 * function my_jetpack_get_default_modules( $modules ) {
97
	 *     return array_diff( $modules, array( 'module-slug' ) );
98
	 * }
99
	 *
100
	 * @var array
101
	 */
102
	private $conflicting_plugins = array(
103
		'comments'          => array(
104
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
105
			'Disqus'                               => 'disqus-comment-system/disqus.php',
106
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
107
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
108
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
109
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
110
		),
111
		'contact-form'      => array(
112
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
113
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
114
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
115
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
116
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
117
		),
118
		'minileven'         => array(
119
			'WPtouch'                              => 'wptouch/wptouch.php',
120
		),
121
		'latex'             => array(
122
			'LaTeX for WordPress'                  => 'latex/latex.php',
123
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
124
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
125
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
126
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
127
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
128
		),
129
		'protect'           => array(
130
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
131
			'Captcha'                              => 'captcha/captcha.php',
132
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
133
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
134
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
135
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
136
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
137
			'Security-protection'                  => 'security-protection/security-protection.php',
138
			'Login Security'                       => 'login-security/login-security.php',
139
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
140
			'Wordfence Security'                   => 'wordfence/wordfence.php',
141
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
142
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
143
		),
144
		'random-redirect'   => array(
145
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
146
		),
147
		'related-posts'     => array(
148
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
149
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
150
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
151
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
152
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
153
			'outbrain'                             => 'outbrain/outbrain.php',
154
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
155
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
156
		),
157
		'sharedaddy'        => array(
158
			'AddThis'                              => 'addthis/addthis_social_widget.php',
159
			'Add To Any'                           => 'add-to-any/add-to-any.php',
160
			'ShareThis'                            => 'share-this/sharethis.php',
161
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
162
		),
163
		'seo-tools' => array(
164
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
165
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
166
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
167
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
168
		),
169
		'verification-tools' => array(
170
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
171
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
172
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
173
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
174
		),
175
		'widget-visibility' => array(
176
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
177
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
178
		),
179
		'sitemaps' => array(
180
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
181
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
182
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
183
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
184
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
185
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
186
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
187
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
188
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
189
			'Sitemap'                              => 'sitemap/sitemap.php',
190
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
191
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
192
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
193
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
194
		),
195
	);
196
197
	/**
198
	 * Plugins for which we turn off our Facebook OG Tags implementation.
199
	 *
200
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
201
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
202
	 *
203
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
204
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
205
	 */
206
	private $open_graph_conflicting_plugins = array(
207
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
208
		                                                         // 2 Click Social Media Buttons
209
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
210
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
211
		'autodescription/autodescription.php',                   // The SEO Framework
212
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
213
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
214
		                                                         // Open Graph Meta Tags by Heateor
215
		'facebook/facebook.php',                                 // Facebook (official plugin)
216
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
217
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
218
		                                                         // Facebook Featured Image & OG Meta Tags
219
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
220
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
221
		                                                         // Facebook Open Graph Meta Tags for WordPress
222
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
223
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
224
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
225
		                                                         // Fedmich's Facebook Open Graph Meta
226
		'header-footer/plugin.php',                              // Header and Footer
227
		'network-publisher/networkpub.php',                      // Network Publisher
228
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
229
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
230
		                                                         // NextScripts SNAP
231
		'og-tags/og-tags.php',                                   // OG Tags
232
		'opengraph/opengraph.php',                               // Open Graph
233
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
234
		                                                         // Open Graph Protocol Framework
235
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
236
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
237
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
238
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
239
		'sharepress/sharepress.php',                             // SharePress
240
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
241
		'social-discussions/social-discussions.php',             // Social Discussions
242
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
243
		'socialize/socialize.php',                               // Socialize
244
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
245
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
246
		                                                         // Tweet, Like, Google +1 and Share
247
		'wordbooker/wordbooker.php',                             // Wordbooker
248
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
249
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
250
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
251
		                                                         // WP Facebook Like Send & Open Graph Meta
252
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
253
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
254
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
255
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
256
	);
257
258
	/**
259
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
260
	 */
261
	private $twitter_cards_conflicting_plugins = array(
262
	//	'twitter/twitter.php',                       // The official one handles this on its own.
263
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
264
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
265
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
266
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
267
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
268
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
269
		'twitter-cards/twitter-cards.php',           // Twitter Cards
270
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
271
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
272
	);
273
274
	/**
275
	 * Message to display in admin_notice
276
	 * @var string
277
	 */
278
	public $message = '';
279
280
	/**
281
	 * Error to display in admin_notice
282
	 * @var string
283
	 */
284
	public $error = '';
285
286
	/**
287
	 * Modules that need more privacy description.
288
	 * @var string
289
	 */
290
	public $privacy_checks = '';
291
292
	/**
293
	 * Stats to record once the page loads
294
	 *
295
	 * @var array
296
	 */
297
	public $stats = array();
298
299
	/**
300
	 * Jetpack_Sync object
301
	 */
302
	public $sync;
303
304
	/**
305
	 * Verified data for JSON authorization request
306
	 */
307
	public $json_api_authorization_request = array();
308
309
	/**
310
	 * Holds the singleton instance of this class
311
	 * @since 2.3.3
312
	 * @var Jetpack
313
	 */
314
	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...
315
316
	/**
317
	 * Singleton
318
	 * @static
319
	 */
320
	public static function init() {
321
		if ( ! self::$instance ) {
322
			self::$instance = new Jetpack;
323
324
			self::$instance->plugin_upgrade();
325
		}
326
327
		return self::$instance;
328
	}
329
330
	/**
331
	 * Must never be called statically
332
	 */
333
	function plugin_upgrade() {
334
		if ( Jetpack::is_active() ) {
335
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
336
			if ( JETPACK__VERSION != $version ) {
337
338
				// check which active modules actually exist and remove others from active_modules list
339
				$unfiltered_modules = Jetpack::get_active_modules();
340
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
341
				if ( array_diff( $unfiltered_modules, $modules ) ) {
342
					Jetpack::update_active_modules( $modules );
343
				}
344
345
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
346
347
				// Upgrade to 4.3.0
348
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
349
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
350
				}
351
352
				// Make sure Markdown for posts gets turned back on
353
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
354
					update_option( 'wpcom_publish_posts_with_markdown', true );
355
				}
356
357
				Jetpack::maybe_set_version_option();
358
359
				add_action(
360
					'jetpack_modules_loaded',
361
					array( __CLASS__, 'upgrade_on_module_load' )
362
				);
363
			}
364
		}
365
	}
366
367
	/**
368
	 * Runs upgrade routines that need to have modules loaded.
369
	 */
370
	static function upgrade_on_module_load() {
371
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
372
			add_action(
373
				'wp_loaded',
374
				array( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' )
375
			);
376
		}
377
	}
378
379
	static function activate_manage( ) {
380
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
381
			self::activate_module( 'manage', false, false );
382
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
383
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
384
		}
385
	}
386
387
	static function update_active_modules( $modules ) {
388
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
389
390
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
391
392
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
393
			$new_active_modules = array_diff( $modules, $current_modules );
394
			foreach( $new_active_modules as $module ) {
395
				/**
396
				 * Fires when a specific module is activated.
397
				 *
398
				 * @since 1.9.0
399
				 *
400
				 * @param string $module Module slug.
401
				 * @param boolean $success whether the module was activated. @since 4.2
402
				 */
403
				do_action( 'jetpack_activate_module', $module, $success );
404
405
				/**
406
				 * Fires when a module is activated.
407
				 * The dynamic part of the filter, $module, is the module slug.
408
				 *
409
				 * @since 1.9.0
410
				 *
411
				 * @param string $module Module slug.
412
				 */
413
				do_action( "jetpack_activate_module_$module", $module );
414
			}
415
416
			$new_deactive_modules = array_diff( $current_modules, $modules );
417
			foreach( $new_deactive_modules as $module ) {
418
				/**
419
				 * Fired after a module has been deactivated.
420
				 *
421
				 * @since 4.2.0
422
				 *
423
				 * @param string $module Module slug.
424
				 * @param boolean $success whether the module was deactivated.
425
				 */
426
				do_action( 'jetpack_deactivate_module', $module, $success );
427
				/**
428
				 * Fires when a module is deactivated.
429
				 * The dynamic part of the filter, $module, is the module slug.
430
				 *
431
				 * @since 1.9.0
432
				 *
433
				 * @param string $module Module slug.
434
				 */
435
				do_action( "jetpack_deactivate_module_$module", $module );
436
			}
437
		}
438
439
		return $success;
440
	}
441
442
	static function delete_active_modules() {
443
		self::update_active_modules( array() );
444
	}
445
446
	/**
447
	 * Constructor.  Initializes WordPress hooks
448
	 */
449
	private function __construct() {
450
		/*
451
		 * Check for and alert any deprecated hooks
452
		 */
453
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
454
455
		/*
456
		 * Load things that should only be in Network Admin.
457
		 *
458
		 * For now blow away everything else until a more full
459
		 * understanding of what is needed at the network level is
460
		 * available
461
		 */
462
		if( is_multisite() ) {
463
			Jetpack_Network::init();
464
		}
465
466
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
467
468
		// Unlink user before deleting the user from .com
469
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
470
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
471
472
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
473
			@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...
474
475
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
476
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
477
478
			$this->require_jetpack_authentication();
479
480
			if ( Jetpack::is_active() ) {
481
				// Hack to preserve $HTTP_RAW_POST_DATA
482
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
483
484
				$signed = $this->verify_xml_rpc_signature();
485
				if ( $signed && ! is_wp_error( $signed ) ) {
486
					// The actual API methods.
487
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
488
				} else {
489
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
490
					// active Jetpack connection, so that additional users can link their account.
491
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
492
				}
493
			} else {
494
				// The bootstrap API methods.
495
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
496
			}
497
498
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
499
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
500
		} elseif (
501
			is_admin() &&
502
			isset( $_POST['action'] ) && (
503
				'jetpack_upload_file' == $_POST['action'] ||
504
				'jetpack_update_file' == $_POST['action']
505
			)
506
		) {
507
			$this->require_jetpack_authentication();
508
			$this->add_remote_request_handlers();
509
		} else {
510
			if ( Jetpack::is_active() ) {
511
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
512
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
513
			}
514
		}
515
516
		if ( Jetpack::is_active() ) {
517
			Jetpack_Heartbeat::init();
518
		}
519
520
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
521
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
522
523
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
524
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
525
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
526
		}
527
528
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
529
530
		add_action( 'admin_init', array( $this, 'admin_init' ) );
531
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
532
533
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
534
535
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
536
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
537
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
538
539
		// returns HTTPS support status
540
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
541
542
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
543
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
544
545
		// JITM AJAX callback function
546
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
547
548
		// Universal ajax callback for all tracking events triggered via js
549
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
550
551
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
552
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
553
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
554
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
555
556
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
557
558
		/**
559
		 * These actions run checks to load additional files.
560
		 * They check for external files or plugins, so they need to run as late as possible.
561
		 */
562
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
563
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
564
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
565
566
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
567
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
568
569
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
570
571
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
572
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
573
574
		// A filter to control all just in time messages
575
		add_filter( 'jetpack_just_in_time_msgs', '__return_true' );
576
577
		// Update the Jetpack plan from API on heartbeats
578
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
579
580
		/**
581
		 * This is the hack to concatinate all css files into one.
582
		 * For description and reasoning see the implode_frontend_css method
583
		 *
584
		 * Super late priority so we catch all the registered styles
585
		 */
586
		if( !is_admin() ) {
587
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
588
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
589
		}
590
	}
591
592
	function jetpack_admin_ajax_tracks_callback() {
593
		// Check for nonce
594
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
595
			wp_die( 'Permissions check failed.' );
596
		}
597
598
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
599
			wp_die( 'No valid event name or type.' );
600
		}
601
602
		$tracks_data = array();
603
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
604
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
605
		}
606
607
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
608
		wp_send_json_success();
609
		wp_die();
610
	}
611
612
	/**
613
	 * The callback for the JITM ajax requests.
614
	 */
615
	function jetpack_jitm_ajax_callback() {
616
		// Check for nonce
617
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
618
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
619
		}
620
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
621
			$module_slug = $_REQUEST['jitmModule'];
622
			Jetpack::log( 'activate', $module_slug );
623
			Jetpack::activate_module( $module_slug, false, false );
624
			Jetpack::state( 'message', 'no_message' );
625
626
			//A Jetpack module is being activated through a JITM, track it
627
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
628
			$this->do_stats( 'server_side' );
629
630
			wp_send_json_success();
631
		}
632
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
633
			// get the hide_jitm options array
634
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
635
			$module_slug = $_REQUEST['jitmModule'];
636
637
			if( ! $jetpack_hide_jitm ) {
638
				$jetpack_hide_jitm = array(
639
					$module_slug => 'hide'
640
				);
641
			} else {
642
				$jetpack_hide_jitm[$module_slug] = 'hide';
643
			}
644
645
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
646
647
			//jitm is being dismissed forever, track it
648
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
649
			$this->do_stats( 'server_side' );
650
651
			wp_send_json_success();
652
		}
653 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
654
			$module_slug = $_REQUEST['jitmModule'];
655
656
			// User went to WordPress.com, track this
657
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
658
			$this->do_stats( 'server_side' );
659
660
			wp_send_json_success();
661
		}
662 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
663
			$track = $_REQUEST['jitmModule'];
664
665
			// User is viewing JITM, track it.
666
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
667
			$this->do_stats( 'server_side' );
668
669
			wp_send_json_success();
670
		}
671
	}
672
673
	/**
674
	 * If there are any stats that need to be pushed, but haven't been, push them now.
675
	 */
676
	function __destruct() {
677
		if ( ! empty( $this->stats ) ) {
678
			$this->do_stats( 'server_side' );
679
		}
680
	}
681
682
	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...
683
		switch( $cap ) {
684
			case 'jetpack_connect' :
685
			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...
686
				if ( Jetpack::is_development_mode() ) {
687
					$caps = array( 'do_not_allow' );
688
					break;
689
				}
690
				/**
691
				 * Pass through. If it's not development mode, these should match disconnect.
692
				 * Let users disconnect if it's development mode, just in case things glitch.
693
				 */
694
			case 'jetpack_disconnect' :
695
				/**
696
				 * In multisite, can individual site admins manage their own connection?
697
				 *
698
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
699
				 */
700
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
701
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
702
						/**
703
						 * We need to update the option name -- it's terribly unclear which
704
						 * direction the override goes.
705
						 *
706
						 * @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...
707
						 */
708
						$caps = array( 'do_not_allow' );
709
						break;
710
					}
711
				}
712
713
				$caps = array( 'manage_options' );
714
				break;
715
			case 'jetpack_manage_modules' :
716
			case 'jetpack_activate_modules' :
717
			case 'jetpack_deactivate_modules' :
718
				$caps = array( 'manage_options' );
719
				break;
720
			case 'jetpack_configure_modules' :
721
				$caps = array( 'manage_options' );
722
				break;
723
			case 'jetpack_network_admin_page':
724
			case 'jetpack_network_settings_page':
725
				$caps = array( 'manage_network_plugins' );
726
				break;
727
			case 'jetpack_network_sites_page':
728
				$caps = array( 'manage_sites' );
729
				break;
730
			case 'jetpack_admin_page' :
731
				if ( Jetpack::is_development_mode() ) {
732
					$caps = array( 'manage_options' );
733
					break;
734
				} else {
735
					$caps = array( 'read' );
736
				}
737
				break;
738
			case 'jetpack_connect_user' :
739
				if ( Jetpack::is_development_mode() ) {
740
					$caps = array( 'do_not_allow' );
741
					break;
742
				}
743
				$caps = array( 'read' );
744
				break;
745
		}
746
		return $caps;
747
	}
748
749
	function require_jetpack_authentication() {
750
		// Don't let anyone authenticate
751
		$_COOKIE = array();
752
		remove_all_filters( 'authenticate' );
753
		remove_all_actions( 'wp_login_failed' );
754
755
		if ( Jetpack::is_active() ) {
756
			// Allow Jetpack authentication
757
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
758
		}
759
	}
760
761
	/**
762
	 * Load language files
763
	 * @action plugins_loaded
764
	 */
765
	public static function plugin_textdomain() {
766
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
767
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
768
	}
769
770
	/**
771
	 * Register assets for use in various modules and the Jetpack admin page.
772
	 *
773
	 * @uses wp_script_is, wp_register_script, plugins_url
774
	 * @action wp_loaded
775
	 * @return null
776
	 */
777
	public function register_assets() {
778 View Code Duplication
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
779
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
780
		}
781
782 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
783
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
784
		}
785
786 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
787
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
788
		}
789
790 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
791
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
792
		}
793
794
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
795
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
796
797
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
798
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
799
			if ( ! is_numeric( $fb_app_id ) ) {
800
				$fb_app_id = '';
801
			}
802
			wp_localize_script(
803
				'jetpack-facebook-embed',
804
				'jpfbembed',
805
				array(
806
					'appid' => $fb_app_id,
807
					'locale' => $this->get_locale(),
808
				)
809
			);
810
		}
811
812
		/**
813
		 * As jetpack_register_genericons is by default fired off a hook,
814
		 * the hook may have already fired by this point.
815
		 * So, let's just trigger it manually.
816
		 */
817
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
818
		jetpack_register_genericons();
819
820
		/**
821
		 * Register the social logos
822
		 */
823
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
824
		jetpack_register_social_logos();
825
826 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
827
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
828
	}
829
830
	/**
831
	 * Guess locale from language code.
832
	 *
833
	 * @param string $lang Language code.
834
	 * @return string|bool
835
	 */
836
	function guess_locale_from_lang( $lang ) {
837
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
838
			return 'en_US';
839
		}
840
841
		if ( ! class_exists( 'GP_Locales' ) ) {
842
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
843
				return false;
844
			}
845
846
			require JETPACK__GLOTPRESS_LOCALES_PATH;
847
		}
848
849
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
850
			// WP.com: get_locale() returns 'it'
851
			$locale = GP_Locales::by_slug( $lang );
852
		} else {
853
			// Jetpack: get_locale() returns 'it_IT';
854
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
855
		}
856
857
		if ( ! $locale ) {
858
			return false;
859
		}
860
861
		if ( empty( $locale->facebook_locale ) ) {
862
			if ( empty( $locale->wp_locale ) ) {
863
				return false;
864
			} else {
865
				// Facebook SDK is smart enough to fall back to en_US if a
866
				// locale isn't supported. Since supported Facebook locales
867
				// can fall out of sync, we'll attempt to use the known
868
				// wp_locale value and rely on said fallback.
869
				return $locale->wp_locale;
870
			}
871
		}
872
873
		return $locale->facebook_locale;
874
	}
875
876
	/**
877
	 * Get the locale.
878
	 *
879
	 * @return string|bool
880
	 */
881
	function get_locale() {
882
		$locale = $this->guess_locale_from_lang( get_locale() );
883
884
		if ( ! $locale ) {
885
			$locale = 'en_US';
886
		}
887
888
		return $locale;
889
	}
890
891
	/**
892
	 * Device Pixels support
893
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
894
	 */
895
	function devicepx() {
896
		if ( Jetpack::is_active() ) {
897
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
898
		}
899
	}
900
901
	/**
902
	 * Return the network_site_url so that .com knows what network this site is a part of.
903
	 * @param  bool $option
904
	 * @return string
905
	 */
906
	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...
907
		return network_site_url();
908
	}
909
	/**
910
	 * Network Name.
911
	 */
912
	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...
913
		global $current_site;
914
		return $current_site->site_name;
915
	}
916
	/**
917
	 * Does the network allow new user and site registrations.
918
	 * @return string
919
	 */
920
	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...
921
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
922
	}
923
	/**
924
	 * Does the network allow admins to add new users.
925
	 * @return boolian
926
	 */
927
	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...
928
		return (bool) get_site_option( 'add_new_users' );
929
	}
930
	/**
931
	 * File upload psace left per site in MB.
932
	 *  -1 means NO LIMIT.
933
	 * @return number
934
	 */
935
	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...
936
		// value in MB
937
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
938
	}
939
940
	/**
941
	 * Network allowed file types.
942
	 * @return string
943
	 */
944
	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...
945
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
946
	}
947
948
	/**
949
	 * Maximum file upload size set by the network.
950
	 * @return number
951
	 */
952
	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...
953
		// value in KB
954
		return get_site_option( 'fileupload_maxk', 300 );
955
	}
956
957
	/**
958
	 * Lets us know if a site allows admins to manage the network.
959
	 * @return array
960
	 */
961
	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...
962
		return get_site_option( 'menu_items' );
963
	}
964
965
	/**
966
	 * If a user has been promoted to or demoted from admin, we need to clear the
967
	 * jetpack_other_linked_admins transient.
968
	 *
969
	 * @since 4.3.2
970
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
971
	 *
972
	 * @param int    $user_id   The user ID whose role changed.
973
	 * @param string $role      The new role.
974
	 * @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...
975
	 */
976
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
977
		if ( 'administrator' == $role
978
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
979
			|| is_null( $old_roles )
980
		) {
981
			delete_transient( 'jetpack_other_linked_admins' );
982
		}
983
	}
984
985
	/**
986
	 * Checks to see if there are any other users available to become primary
987
	 * Users must both:
988
	 * - Be linked to wpcom
989
	 * - Be an admin
990
	 *
991
	 * @return mixed False if no other users are linked, Int if there are.
992
	 */
993
	static function get_other_linked_admins() {
994
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
995
996
		if ( false === $other_linked_users ) {
997
			$admins = get_users( array( 'role' => 'administrator' ) );
998
			if ( count( $admins ) > 1 ) {
999
				$available = array();
1000
				foreach ( $admins as $admin ) {
1001
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1002
						$available[] = $admin->ID;
1003
					}
1004
				}
1005
1006
				$count_connected_admins = count( $available );
1007
				if ( count( $available ) > 1 ) {
1008
					$other_linked_users = $count_connected_admins;
1009
				} else {
1010
					$other_linked_users = 0;
1011
				}
1012
			} else {
1013
				$other_linked_users = 0;
1014
			}
1015
1016
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1017
		}
1018
1019
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1020
	}
1021
1022
	/**
1023
	 * Return whether we are dealing with a multi network setup or not.
1024
	 * The reason we are type casting this is because we want to avoid the situation where
1025
	 * the result is false since when is_main_network_option return false it cases
1026
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1027
	 * database which could be set to anything as opposed to what this function returns.
1028
	 * @param  bool  $option
1029
	 *
1030
	 * @return boolean
1031
	 */
1032
	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...
1033
		// return '1' or ''
1034
		return (string) (bool) Jetpack::is_multi_network();
1035
	}
1036
1037
	/**
1038
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1039
	 *
1040
	 * @param  string  $option
1041
	 * @return boolean
1042
	 */
1043
	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...
1044
		return (string) (bool) is_multisite();
1045
	}
1046
1047
	/**
1048
	 * Implemented since there is no core is multi network function
1049
	 * Right now there is no way to tell if we which network is the dominant network on the system
1050
	 *
1051
	 * @since  3.3
1052
	 * @return boolean
1053
	 */
1054
	public static function is_multi_network() {
1055
		global  $wpdb;
1056
1057
		// if we don't have a multi site setup no need to do any more
1058
		if ( ! is_multisite() ) {
1059
			return false;
1060
		}
1061
1062
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1063
		if ( $num_sites > 1 ) {
1064
			return true;
1065
		} else {
1066
			return false;
1067
		}
1068
	}
1069
1070
	/**
1071
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1072
	 * @return null
1073
	 */
1074
	function update_jetpack_main_network_site_option() {
1075
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1076
	}
1077
	/**
1078
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1079
	 *
1080
	 */
1081
	function update_jetpack_network_settings() {
1082
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1083
		// Only sync this info for the main network site.
1084
	}
1085
1086
	/**
1087
	 * Get back if the current site is single user site.
1088
	 *
1089
	 * @return bool
1090
	 */
1091
	public static function is_single_user_site() {
1092
		global $wpdb;
1093
1094 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1095
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1096
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1097
		}
1098
		return 1 === (int) $some_users;
1099
	}
1100
1101
	/**
1102
	 * Returns true if the site has file write access false otherwise.
1103
	 * @return string ( '1' | '0' )
1104
	 **/
1105
	public static function file_system_write_access() {
1106
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1107
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1108
		}
1109
1110
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1111
1112
		$filesystem_method = get_filesystem_method();
1113
		if ( $filesystem_method === 'direct' ) {
1114
			return 1;
1115
		}
1116
1117
		ob_start();
1118
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1119
		ob_end_clean();
1120
		if ( $filesystem_credentials_are_stored ) {
1121
			return 1;
1122
		}
1123
		return 0;
1124
	}
1125
1126
	/**
1127
	 * Finds out if a site is using a version control system.
1128
	 * @return string ( '1' | '0' )
1129
	 **/
1130
	public static function is_version_controlled() {
1131
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1132
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1133
	}
1134
1135
	/**
1136
	 * Determines whether the current theme supports featured images or not.
1137
	 * @return string ( '1' | '0' )
1138
	 */
1139
	public static function featured_images_enabled() {
1140
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1141
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1142
	}
1143
1144
	/**
1145
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1146
	 *
1147
	 * @deprecated 4.7 use get_avatar_url instead.
1148
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1149
	 * @param int $size Size of the avatar image
1150
	 * @param string $default URL to a default image to use if no avatar is available
1151
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1152
	 *
1153
	 * @return array
1154
	 */
1155
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1156
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1157
		return get_avatar_url( $id_or_email, array(
1158
			'size' => $size,
1159
			'default' => $default,
1160
			'force_default' => $force_display,
1161
		) );
1162
	}
1163
1164
	/**
1165
	 * jetpack_updates is saved in the following schema:
1166
	 *
1167
	 * array (
1168
	 *      'plugins'                       => (int) Number of plugin updates available.
1169
	 *      'themes'                        => (int) Number of theme updates available.
1170
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1171
	 *      'translations'                  => (int) Number of translation updates available.
1172
	 *      'total'                         => (int) Total of all available updates.
1173
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1174
	 * )
1175
	 * @return array
1176
	 */
1177
	public static function get_updates() {
1178
		$update_data = wp_get_update_data();
1179
1180
		// Stores the individual update counts as well as the total count.
1181
		if ( isset( $update_data['counts'] ) ) {
1182
			$updates = $update_data['counts'];
1183
		}
1184
1185
		// If we need to update WordPress core, let's find the latest version number.
1186 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1187
			$cur = get_preferred_from_update_core();
1188
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1189
				$updates['wp_update_version'] = $cur->current;
1190
			}
1191
		}
1192
		return isset( $updates ) ? $updates : array();
1193
	}
1194
1195
	public static function get_update_details() {
1196
		$update_details = array(
1197
			'update_core' => get_site_transient( 'update_core' ),
1198
			'update_plugins' => get_site_transient( 'update_plugins' ),
1199
			'update_themes' => get_site_transient( 'update_themes' ),
1200
		);
1201
		return $update_details;
1202
	}
1203
1204
	public static function refresh_update_data() {
1205
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1206
1207
	}
1208
1209
	public static function refresh_theme_data() {
1210
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1211
	}
1212
1213
	/**
1214
	 * Is Jetpack active?
1215
	 */
1216
	public static function is_active() {
1217
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1218
	}
1219
1220
	/**
1221
	 * Make an API call to WordPress.com for plan status
1222
	 *
1223
	 * @uses Jetpack_Options::get_option()
1224
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1225
	 * @uses update_option()
1226
	 *
1227
	 * @access public
1228
	 * @static
1229
	 *
1230
	 * @return bool True if plan is updated, false if no update
1231
	 */
1232
	public static function refresh_active_plan_from_wpcom() {
1233
		// Make the API request
1234
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1235
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1236
1237
		// Bail if there was an error or malformed response
1238
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1239
			return false;
1240
		}
1241
1242
		// Decode the results
1243
		$results = json_decode( $response['body'], true );
1244
1245
		// Bail if there were no results or plan details returned
1246
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1247
			return false;
1248
		}
1249
1250
		// Store the option and return true if updated
1251
		return update_option( 'jetpack_active_plan', $results['plan'] );
1252
	}
1253
1254
	/**
1255
	 * Get the plan that this Jetpack site is currently using
1256
	 *
1257
	 * @uses get_option()
1258
	 *
1259
	 * @access public
1260
	 * @static
1261
	 *
1262
	 * @return array Active Jetpack plan details
1263
	 */
1264
	public static function get_active_plan() {
1265
		$plan = get_option( 'jetpack_active_plan' );
1266
1267
		// Set the default options
1268
		if ( ! $plan ) {
1269
			$plan = array(
1270
				'product_slug' => 'jetpack_free',
1271
				'supports'     => array(),
1272
				'class'        => 'free',
1273
			);
1274
		}
1275
1276
		// Define what paid modules are supported by personal plans
1277
		$personal_plans = array(
1278
			'jetpack_personal',
1279
			'jetpack_personal_monthly',
1280
		);
1281
1282
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1283
			$plan['supports'] = array(
1284
				'akismet',
1285
			);
1286
			$plan['class'] = 'personal';
1287
		}
1288
1289
		// Define what paid modules are supported by premium plans
1290
		$premium_plans = array(
1291
			'jetpack_premium',
1292
			'jetpack_premium_monthly',
1293
		);
1294
1295 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1296
			$plan['supports'] = array(
1297
				'videopress',
1298
				'akismet',
1299
				'vaultpress',
1300
				'wordads',
1301
			);
1302
			$plan['class'] = 'premium';
1303
		}
1304
1305
		// Define what paid modules are supported by professional plans
1306
		$business_plans = array(
1307
			'jetpack_business',
1308
			'jetpack_business_monthly',
1309
		);
1310
1311 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1312
			$plan['supports'] = array(
1313
				'videopress',
1314
				'akismet',
1315
				'vaultpress',
1316
				'seo-tools',
1317
				'google-analytics',
1318
				'wordads',
1319
			);
1320
			$plan['class'] = 'business';
1321
		}
1322
1323
		// Make sure we have an array here in the event database data is stale
1324
		if ( ! isset( $plan['supports'] ) ) {
1325
			$plan['supports'] = array();
1326
		}
1327
1328
		return $plan;
1329
	}
1330
1331
	/**
1332
	 * Determine whether the active plan supports a particular feature
1333
	 *
1334
	 * @uses Jetpack::get_active_plan()
1335
	 *
1336
	 * @access public
1337
	 * @static
1338
	 *
1339
	 * @return bool True if plan supports feature, false if not
1340
	 */
1341
	public static function active_plan_supports( $feature ) {
1342
		$plan = Jetpack::get_active_plan();
1343
1344
		if ( in_array( $feature, $plan['supports'] ) ) {
1345
			return true;
1346
		}
1347
1348
		return false;
1349
	}
1350
1351
	/**
1352
	 * Is Jetpack in development (offline) mode?
1353
	 */
1354
	public static function is_development_mode() {
1355
		$development_mode = false;
1356
1357
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1358
			$development_mode = JETPACK_DEV_DEBUG;
1359
		} elseif ( $site_url = site_url() ) {
1360
			$development_mode = false === strpos( $site_url, '.' );
1361
		}
1362
1363
		/**
1364
		 * Filters Jetpack's development mode.
1365
		 *
1366
		 * @see https://jetpack.com/support/development-mode/
1367
		 *
1368
		 * @since 2.2.1
1369
		 *
1370
		 * @param bool $development_mode Is Jetpack's development mode active.
1371
		 */
1372
		return apply_filters( 'jetpack_development_mode', $development_mode );
1373
	}
1374
1375
	/**
1376
	* Get Jetpack development mode notice text and notice class.
1377
	*
1378
	* Mirrors the checks made in Jetpack::is_development_mode
1379
	*
1380
	*/
1381
	public static function show_development_mode_notice() {
1382
		if ( Jetpack::is_development_mode() ) {
1383
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1384
				$notice = sprintf(
1385
					/* translators: %s is a URL */
1386
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1387
					'https://jetpack.com/support/development-mode/'
1388
				);
1389
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1390
				$notice = sprintf(
1391
					/* translators: %s is a URL */
1392
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1393
					'https://jetpack.com/support/development-mode/'
1394
				);
1395
			} else {
1396
				$notice = sprintf(
1397
					/* translators: %s is a URL */
1398
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1399
					'https://jetpack.com/support/development-mode/'
1400
				);
1401
			}
1402
1403
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1404
		}
1405
1406
		// Throw up a notice if using a development version and as for feedback.
1407
		if ( Jetpack::is_development_version() ) {
1408
			/* translators: %s is a URL */
1409
			$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/' );
1410
1411
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1412
		}
1413
		// Throw up a notice if using staging mode
1414
		if ( Jetpack::is_staging_site() ) {
1415
			/* translators: %s is a URL */
1416
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1417
1418
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1419
		}
1420
	}
1421
1422
	/**
1423
	 * Whether Jetpack's version maps to a public release, or a development version.
1424
	 */
1425
	public static function is_development_version() {
1426
		/**
1427
		 * Allows filtering whether this is a development version of Jetpack.
1428
		 *
1429
		 * This filter is especially useful for tests.
1430
		 *
1431
		 * @since 4.3.0
1432
		 *
1433
		 * @param bool $development_version Is this a develoment version of Jetpack?
1434
		 */
1435
		return (bool) apply_filters(
1436
			'jetpack_development_version',
1437
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1438
		);
1439
	}
1440
1441
	/**
1442
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1443
	 */
1444
	public static function is_user_connected( $user_id = false ) {
1445
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1446
		if ( ! $user_id ) {
1447
			return false;
1448
		}
1449
1450
		return (bool) Jetpack_Data::get_access_token( $user_id );
1451
	}
1452
1453
	/**
1454
	 * Get the wpcom user data of the current|specified connected user.
1455
	 */
1456
	public static function get_connected_user_data( $user_id = null ) {
1457
		if ( ! $user_id ) {
1458
			$user_id = get_current_user_id();
1459
		}
1460
1461
		$transient_key = "jetpack_connected_user_data_$user_id";
1462
1463
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1464
			return $cached_user_data;
1465
		}
1466
1467
		Jetpack::load_xml_rpc_client();
1468
		$xml = new Jetpack_IXR_Client( array(
1469
			'user_id' => $user_id,
1470
		) );
1471
		$xml->query( 'wpcom.getUser' );
1472
		if ( ! $xml->isError() ) {
1473
			$user_data = $xml->getResponse();
1474
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1475
			return $user_data;
1476
		}
1477
1478
		return false;
1479
	}
1480
1481
	/**
1482
	 * Get the wpcom email of the current|specified connected user.
1483
	 */
1484 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1485
		if ( ! $user_id ) {
1486
			$user_id = get_current_user_id();
1487
		}
1488
		Jetpack::load_xml_rpc_client();
1489
		$xml = new Jetpack_IXR_Client( array(
1490
			'user_id' => $user_id,
1491
		) );
1492
		$xml->query( 'wpcom.getUserEmail' );
1493
		if ( ! $xml->isError() ) {
1494
			return $xml->getResponse();
1495
		}
1496
		return false;
1497
	}
1498
1499
	/**
1500
	 * Get the wpcom email of the master user.
1501
	 */
1502
	public static function get_master_user_email() {
1503
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1504
		if ( $master_user_id ) {
1505
			return self::get_connected_user_email( $master_user_id );
1506
		}
1507
		return '';
1508
	}
1509
1510
	function current_user_is_connection_owner() {
1511
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1512
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1513
	}
1514
1515
	/**
1516
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1517
	 */
1518
	function extra_oembed_providers() {
1519
		// Cloudup: https://dev.cloudup.com/#oembed
1520
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1521
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1522
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1523
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1524
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1525
	}
1526
1527
	/**
1528
	 * Synchronize connected user role changes
1529
	 */
1530
	function user_role_change( $user_id ) {
1531
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1532
		Jetpack_Sync_Users::user_role_change( $user_id );
1533
	}
1534
1535
	/**
1536
	 * Loads the currently active modules.
1537
	 */
1538
	public static function load_modules() {
1539
		if ( ! self::is_active() && !self::is_development_mode() ) {
1540
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1541
				return;
1542
			}
1543
		}
1544
1545
		$version = Jetpack_Options::get_option( 'version' );
1546 View Code Duplication
		if ( ! $version ) {
1547
			$version = $old_version = JETPACK__VERSION . ':' . time();
1548
			/** This action is documented in class.jetpack.php */
1549
			do_action( 'updating_jetpack_version', $version, false );
1550
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1551
		}
1552
		list( $version ) = explode( ':', $version );
1553
1554
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1555
1556
		$modules_data = array();
1557
1558
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1559
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1560
			$updated_modules = array();
1561
			foreach ( $modules as $module ) {
1562
				$modules_data[ $module ] = Jetpack::get_module( $module );
1563
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1564
					continue;
1565
				}
1566
1567
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1568
					continue;
1569
				}
1570
1571
				$updated_modules[] = $module;
1572
			}
1573
1574
			$modules = array_diff( $modules, $updated_modules );
1575
		}
1576
1577
		$is_development_mode = Jetpack::is_development_mode();
1578
1579
		foreach ( $modules as $index => $module ) {
1580
			// If we're in dev mode, disable modules requiring a connection
1581
			if ( $is_development_mode ) {
1582
				// Prime the pump if we need to
1583
				if ( empty( $modules_data[ $module ] ) ) {
1584
					$modules_data[ $module ] = Jetpack::get_module( $module );
1585
				}
1586
				// If the module requires a connection, but we're in local mode, don't include it.
1587
				if ( $modules_data[ $module ]['requires_connection'] ) {
1588
					continue;
1589
				}
1590
			}
1591
1592
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1593
				continue;
1594
			}
1595
1596
			if ( ! @include( Jetpack::get_module_path( $module ) ) ) {
1597
				unset( $modules[ $index ] );
1598
				self::update_active_modules( array_values( $modules ) );
1599
				continue;
1600
			}
1601
1602
			/**
1603
			 * Fires when a specific module is loaded.
1604
			 * The dynamic part of the hook, $module, is the module slug.
1605
			 *
1606
			 * @since 1.1.0
1607
			 */
1608
			do_action( 'jetpack_module_loaded_' . $module );
1609
		}
1610
1611
		/**
1612
		 * Fires when all the modules are loaded.
1613
		 *
1614
		 * @since 1.1.0
1615
		 */
1616
		do_action( 'jetpack_modules_loaded' );
1617
1618
		// 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.
1619
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1620
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1621
	}
1622
1623
	/**
1624
	 * Check if Jetpack's REST API compat file should be included
1625
	 * @action plugins_loaded
1626
	 * @return null
1627
	 */
1628
	public function check_rest_api_compat() {
1629
		/**
1630
		 * Filters the list of REST API compat files to be included.
1631
		 *
1632
		 * @since 2.2.5
1633
		 *
1634
		 * @param array $args Array of REST API compat files to include.
1635
		 */
1636
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1637
1638
		if ( function_exists( 'bbpress' ) )
1639
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1640
1641
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1642
			require_once $_jetpack_rest_api_compat_include;
1643
	}
1644
1645
	/**
1646
	 * Gets all plugins currently active in values, regardless of whether they're
1647
	 * traditionally activated or network activated.
1648
	 *
1649
	 * @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...
1650
	 */
1651
	public static function get_active_plugins() {
1652
		$active_plugins = (array) get_option( 'active_plugins', array() );
1653
1654
		if ( is_multisite() ) {
1655
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1656
			// whereas active_plugins stores them in the values.
1657
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1658
			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...
1659
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1660
			}
1661
		}
1662
1663
		sort( $active_plugins );
1664
1665
		return array_unique( $active_plugins );
1666
	}
1667
1668
	/**
1669
	 * Gets and parses additional plugin data to send with the heartbeat data
1670
	 *
1671
	 * @since 3.8.1
1672
	 *
1673
	 * @return array Array of plugin data
1674
	 */
1675
	public static function get_parsed_plugin_data() {
1676
		if ( ! function_exists( 'get_plugins' ) ) {
1677
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1678
		}
1679
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1680
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1681
		$active_plugins = Jetpack::get_active_plugins();
1682
1683
		$plugins = array();
1684
		foreach ( $all_plugins as $path => $plugin_data ) {
1685
			$plugins[ $path ] = array(
1686
					'is_active' => in_array( $path, $active_plugins ),
1687
					'file'      => $path,
1688
					'name'      => $plugin_data['Name'],
1689
					'version'   => $plugin_data['Version'],
1690
					'author'    => $plugin_data['Author'],
1691
			);
1692
		}
1693
1694
		return $plugins;
1695
	}
1696
1697
	/**
1698
	 * Gets and parses theme data to send with the heartbeat data
1699
	 *
1700
	 * @since 3.8.1
1701
	 *
1702
	 * @return array Array of theme data
1703
	 */
1704
	public static function get_parsed_theme_data() {
1705
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1706
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1707
1708
		$themes = array();
1709
		foreach ( $all_themes as $slug => $theme_data ) {
1710
			$theme_headers = array();
1711
			foreach ( $header_keys as $header_key ) {
1712
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1713
			}
1714
1715
			$themes[ $slug ] = array(
1716
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1717
					'slug' => $slug,
1718
					'theme_root' => $theme_data->get_theme_root_uri(),
1719
					'parent' => $theme_data->parent(),
1720
					'headers' => $theme_headers
1721
			);
1722
		}
1723
1724
		return $themes;
1725
	}
1726
1727
	/**
1728
	 * Checks whether a specific plugin is active.
1729
	 *
1730
	 * We don't want to store these in a static variable, in case
1731
	 * there are switch_to_blog() calls involved.
1732
	 */
1733
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1734
		return in_array( $plugin, self::get_active_plugins() );
1735
	}
1736
1737
	/**
1738
	 * Check if Jetpack's Open Graph tags should be used.
1739
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1740
	 *
1741
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1742
	 * @action plugins_loaded
1743
	 * @return null
1744
	 */
1745
	public function check_open_graph() {
1746
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1747
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1748
		}
1749
1750
		$active_plugins = self::get_active_plugins();
1751
1752
		if ( ! empty( $active_plugins ) ) {
1753
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1754
				if ( in_array( $plugin, $active_plugins ) ) {
1755
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1756
					break;
1757
				}
1758
			}
1759
		}
1760
1761
		/**
1762
		 * Allow the addition of Open Graph Meta Tags to all pages.
1763
		 *
1764
		 * @since 2.0.3
1765
		 *
1766
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1767
		 */
1768
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1769
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1770
		}
1771
	}
1772
1773
	/**
1774
	 * Check if Jetpack's Twitter tags should be used.
1775
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1776
	 *
1777
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1778
	 * @action plugins_loaded
1779
	 * @return null
1780
	 */
1781
	public function check_twitter_tags() {
1782
1783
		$active_plugins = self::get_active_plugins();
1784
1785
		if ( ! empty( $active_plugins ) ) {
1786
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1787
				if ( in_array( $plugin, $active_plugins ) ) {
1788
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1789
					break;
1790
				}
1791
			}
1792
		}
1793
1794
		/**
1795
		 * Allow Twitter Card Meta tags to be disabled.
1796
		 *
1797
		 * @since 2.6.0
1798
		 *
1799
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1800
		 */
1801
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1802
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1803
		}
1804
	}
1805
1806
	/**
1807
	 * Allows plugins to submit security reports.
1808
 	 *
1809
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1810
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1811
	 * @param array   $args         See definitions above
1812
	 */
1813
	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...
1814
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1815
	}
1816
1817
/* Jetpack Options API */
1818
1819
	public static function get_option_names( $type = 'compact' ) {
1820
		return Jetpack_Options::get_option_names( $type );
1821
	}
1822
1823
	/**
1824
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1825
 	 *
1826
	 * @param string $name    Option name
1827
	 * @param mixed  $default (optional)
1828
	 */
1829
	public static function get_option( $name, $default = false ) {
1830
		return Jetpack_Options::get_option( $name, $default );
1831
	}
1832
1833
	/**
1834
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1835
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1836
	* $name must be a registered option name.
1837
	*/
1838
	public static function create_nonce( $name ) {
1839
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1840
1841
		Jetpack_Options::update_option( $name, $secret );
1842
		@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...
1843
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1844
			return new Jetpack_Error( 'missing_secrets' );
1845
1846
		return array(
1847
			'secret_1' => $secret_1,
1848
			'secret_2' => $secret_2,
1849
			'eol'      => $eol,
1850
		);
1851
	}
1852
1853
	/**
1854
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1855
 	 *
1856
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1857
	 * @param string $name  Option name
1858
	 * @param mixed  $value Option value
1859
	 */
1860
	public static function update_option( $name, $value ) {
1861
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1862
		return Jetpack_Options::update_option( $name, $value );
1863
	}
1864
1865
	/**
1866
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1867
 	 *
1868
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1869
	 * @param array $array array( option name => option value, ... )
1870
	 */
1871
	public static function update_options( $array ) {
1872
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1873
		return Jetpack_Options::update_options( $array );
1874
	}
1875
1876
	/**
1877
	 * Deletes the given option.  May be passed multiple option names as an array.
1878
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1879
	 *
1880
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1881
	 * @param string|array $names
1882
	 */
1883
	public static function delete_option( $names ) {
1884
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1885
		return Jetpack_Options::delete_option( $names );
1886
	}
1887
1888
	/**
1889
	 * Enters a user token into the user_tokens option
1890
	 *
1891
	 * @param int $user_id
1892
	 * @param string $token
1893
	 * return bool
1894
	 */
1895
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1896
		// not designed for concurrent updates
1897
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1898
		if ( ! is_array( $user_tokens ) )
1899
			$user_tokens = array();
1900
		$user_tokens[$user_id] = $token;
1901
		if ( $is_master_user ) {
1902
			$master_user = $user_id;
1903
			$options     = compact( 'user_tokens', 'master_user' );
1904
		} else {
1905
			$options = compact( 'user_tokens' );
1906
		}
1907
		return Jetpack_Options::update_options( $options );
1908
	}
1909
1910
	/**
1911
	 * Returns an array of all PHP files in the specified absolute path.
1912
	 * Equivalent to glob( "$absolute_path/*.php" ).
1913
	 *
1914
	 * @param string $absolute_path The absolute path of the directory to search.
1915
	 * @return array Array of absolute paths to the PHP files.
1916
	 */
1917
	public static function glob_php( $absolute_path ) {
1918
		if ( function_exists( 'glob' ) ) {
1919
			return glob( "$absolute_path/*.php" );
1920
		}
1921
1922
		$absolute_path = untrailingslashit( $absolute_path );
1923
		$files = array();
1924
		if ( ! $dir = @opendir( $absolute_path ) ) {
1925
			return $files;
1926
		}
1927
1928
		while ( false !== $file = readdir( $dir ) ) {
1929
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1930
				continue;
1931
			}
1932
1933
			$file = "$absolute_path/$file";
1934
1935
			if ( ! is_file( $file ) ) {
1936
				continue;
1937
			}
1938
1939
			$files[] = $file;
1940
		}
1941
1942
		closedir( $dir );
1943
1944
		return $files;
1945
	}
1946
1947
	public static function activate_new_modules( $redirect = false ) {
1948
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1949
			return;
1950
		}
1951
1952
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1953 View Code Duplication
		if ( ! $jetpack_old_version ) {
1954
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1955
			/** This action is documented in class.jetpack.php */
1956
			do_action( 'updating_jetpack_version', $version, false );
1957
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1958
		}
1959
1960
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1961
1962
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1963
			return;
1964
		}
1965
1966
		$active_modules     = Jetpack::get_active_modules();
1967
		$reactivate_modules = array();
1968
		foreach ( $active_modules as $active_module ) {
1969
			$module = Jetpack::get_module( $active_module );
1970
			if ( ! isset( $module['changed'] ) ) {
1971
				continue;
1972
			}
1973
1974
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1975
				continue;
1976
			}
1977
1978
			$reactivate_modules[] = $active_module;
1979
			Jetpack::deactivate_module( $active_module );
1980
		}
1981
1982
		$new_version = JETPACK__VERSION . ':' . time();
1983
		/** This action is documented in class.jetpack.php */
1984
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1985
		Jetpack_Options::update_options(
1986
			array(
1987
				'version'     => $new_version,
1988
				'old_version' => $jetpack_old_version,
1989
			)
1990
		);
1991
1992
		Jetpack::state( 'message', 'modules_activated' );
1993
		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...
1994
1995
		if ( $redirect ) {
1996
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
1997
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
1998
				$page = $_GET['page'];
1999
			}
2000
2001
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2002
			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...
2003
		}
2004
	}
2005
2006
	/**
2007
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2008
	 * Make sure to tuck away module "library" files in a sub-directory.
2009
	 */
2010
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2011
		static $modules = null;
2012
2013
		if ( ! isset( $modules ) ) {
2014
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2015
			// Use the cache if we're on the front-end and it's available...
2016
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2017
				$modules = $available_modules_option[ JETPACK__VERSION ];
2018
			} else {
2019
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2020
2021
				$modules = array();
2022
2023
				foreach ( $files as $file ) {
2024
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2025
						continue;
2026
					}
2027
2028
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2029
				}
2030
2031
				Jetpack_Options::update_option( 'available_modules', array(
2032
					JETPACK__VERSION => $modules,
2033
				) );
2034
			}
2035
		}
2036
2037
		/**
2038
		 * Filters the array of modules available to be activated.
2039
		 *
2040
		 * @since 2.4.0
2041
		 *
2042
		 * @param array $modules Array of available modules.
2043
		 * @param string $min_version Minimum version number required to use modules.
2044
		 * @param string $max_version Maximum version number required to use modules.
2045
		 */
2046
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2047
2048
		if ( ! $min_version && ! $max_version ) {
2049
			return array_keys( $mods );
2050
		}
2051
2052
		$r = array();
2053
		foreach ( $mods as $slug => $introduced ) {
2054
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2055
				continue;
2056
			}
2057
2058
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2059
				continue;
2060
			}
2061
2062
			$r[] = $slug;
2063
		}
2064
2065
		return $r;
2066
	}
2067
2068
	/**
2069
	 * Default modules loaded on activation.
2070
	 */
2071
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2072
		$return = array();
2073
2074
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2075
			$module_data = Jetpack::get_module( $module );
2076
2077
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2078
				case 'yes' :
2079
					$return[] = $module;
2080
					break;
2081
				case 'public' :
2082
					if ( Jetpack_Options::get_option( 'public' ) ) {
2083
						$return[] = $module;
2084
					}
2085
					break;
2086
				case 'no' :
2087
				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...
2088
					break;
2089
			}
2090
		}
2091
		/**
2092
		 * Filters the array of default modules.
2093
		 *
2094
		 * @since 2.5.0
2095
		 *
2096
		 * @param array $return Array of default modules.
2097
		 * @param string $min_version Minimum version number required to use modules.
2098
		 * @param string $max_version Maximum version number required to use modules.
2099
		 */
2100
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2101
	}
2102
2103
	/**
2104
	 * Checks activated modules during auto-activation to determine
2105
	 * if any of those modules are being deprecated.  If so, close
2106
	 * them out, and add any replacement modules.
2107
	 *
2108
	 * Runs at priority 99 by default.
2109
	 *
2110
	 * This is run late, so that it can still activate a module if
2111
	 * the new module is a replacement for another that the user
2112
	 * currently has active, even if something at the normal priority
2113
	 * would kibosh everything.
2114
	 *
2115
	 * @since 2.6
2116
	 * @uses jetpack_get_default_modules filter
2117
	 * @param array $modules
2118
	 * @return array
2119
	 */
2120
	function handle_deprecated_modules( $modules ) {
2121
		$deprecated_modules = array(
2122
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2123
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2124
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2125
		);
2126
2127
		// Don't activate SSO if they never completed activating WPCC.
2128
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2129
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2130
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2131
				$deprecated_modules['wpcc'] = null;
2132
			}
2133
		}
2134
2135
		foreach ( $deprecated_modules as $module => $replacement ) {
2136
			if ( Jetpack::is_module_active( $module ) ) {
2137
				self::deactivate_module( $module );
2138
				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...
2139
					$modules[] = $replacement;
2140
				}
2141
			}
2142
		}
2143
2144
		return array_unique( $modules );
2145
	}
2146
2147
	/**
2148
	 * Checks activated plugins during auto-activation to determine
2149
	 * if any of those plugins are in the list with a corresponding module
2150
	 * that is not compatible with the plugin. The module will not be allowed
2151
	 * to auto-activate.
2152
	 *
2153
	 * @since 2.6
2154
	 * @uses jetpack_get_default_modules filter
2155
	 * @param array $modules
2156
	 * @return array
2157
	 */
2158
	function filter_default_modules( $modules ) {
2159
2160
		$active_plugins = self::get_active_plugins();
2161
2162
		if ( ! empty( $active_plugins ) ) {
2163
2164
			// For each module we'd like to auto-activate...
2165
			foreach ( $modules as $key => $module ) {
2166
				// If there are potential conflicts for it...
2167
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2168
					// For each potential conflict...
2169
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2170
						// If that conflicting plugin is active...
2171
						if ( in_array( $plugin, $active_plugins ) ) {
2172
							// Remove that item from being auto-activated.
2173
							unset( $modules[ $key ] );
2174
						}
2175
					}
2176
				}
2177
			}
2178
		}
2179
2180
		return $modules;
2181
	}
2182
2183
	/**
2184
	 * Extract a module's slug from its full path.
2185
	 */
2186
	public static function get_module_slug( $file ) {
2187
		return str_replace( '.php', '', basename( $file ) );
2188
	}
2189
2190
	/**
2191
	 * Generate a module's path from its slug.
2192
	 */
2193
	public static function get_module_path( $slug ) {
2194
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2195
	}
2196
2197
	/**
2198
	 * Load module data from module file. Headers differ from WordPress
2199
	 * plugin headers to avoid them being identified as standalone
2200
	 * plugins on the WordPress plugins page.
2201
	 */
2202
	public static function get_module( $module ) {
2203
		$headers = array(
2204
			'name'                      => 'Module Name',
2205
			'description'               => 'Module Description',
2206
			'jumpstart_desc'            => 'Jumpstart Description',
2207
			'sort'                      => 'Sort Order',
2208
			'recommendation_order'      => 'Recommendation Order',
2209
			'introduced'                => 'First Introduced',
2210
			'changed'                   => 'Major Changes In',
2211
			'deactivate'                => 'Deactivate',
2212
			'free'                      => 'Free',
2213
			'requires_connection'       => 'Requires Connection',
2214
			'auto_activate'             => 'Auto Activate',
2215
			'module_tags'               => 'Module Tags',
2216
			'feature'                   => 'Feature',
2217
			'additional_search_queries' => 'Additional Search Queries',
2218
		);
2219
2220
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2221
2222
		$mod = Jetpack::get_file_data( $file, $headers );
2223
		if ( empty( $mod['name'] ) ) {
2224
			return false;
2225
		}
2226
2227
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2228
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2229
		$mod['deactivate']              = empty( $mod['deactivate'] );
2230
		$mod['free']                    = empty( $mod['free'] );
2231
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2232
2233
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2234
			$mod['auto_activate'] = 'No';
2235
		} else {
2236
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2237
		}
2238
2239
		if ( $mod['module_tags'] ) {
2240
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2241
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2242
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2243
		} else {
2244
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2245
		}
2246
2247
		if ( $mod['feature'] ) {
2248
			$mod['feature'] = explode( ',', $mod['feature'] );
2249
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2250
		} else {
2251
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2252
		}
2253
2254
		/**
2255
		 * Filters the feature array on a module.
2256
		 *
2257
		 * This filter allows you to control where each module is filtered: Recommended,
2258
		 * Jumpstart, and the default "Other" listing.
2259
		 *
2260
		 * @since 3.5.0
2261
		 *
2262
		 * @param array   $mod['feature'] The areas to feature this module:
2263
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2264
		 *     'Recommended' shows on the main Jetpack admin screen.
2265
		 *     'Other' should be the default if no other value is in the array.
2266
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2267
		 * @param array   $mod All the currently assembled module data.
2268
		 */
2269
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2270
2271
		/**
2272
		 * Filter the returned data about a module.
2273
		 *
2274
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2275
		 * so please be careful.
2276
		 *
2277
		 * @since 3.6.0
2278
		 *
2279
		 * @param array   $mod    The details of the requested module.
2280
		 * @param string  $module The slug of the module, e.g. sharedaddy
2281
		 * @param string  $file   The path to the module source file.
2282
		 */
2283
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2284
	}
2285
2286
	/**
2287
	 * Like core's get_file_data implementation, but caches the result.
2288
	 */
2289
	public static function get_file_data( $file, $headers ) {
2290
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2291
		$file_name = basename( $file );
2292
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2293
		$key              = md5( $file_name . serialize( $headers ) );
2294
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2295
2296
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2297
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2298
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2299
		}
2300
2301
		$data = get_file_data( $file, $headers );
2302
2303
		// Strip out any old Jetpack versions that are cluttering the option.
2304
		$file_data_option = array_intersect_key( (array) $file_data_option, array( JETPACK__VERSION => null ) );
2305
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2306
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2307
2308
		return $data;
2309
	}
2310
2311
	/**
2312
	 * Return translated module tag.
2313
	 *
2314
	 * @param string $tag Tag as it appears in each module heading.
2315
	 *
2316
	 * @return mixed
2317
	 */
2318
	public static function translate_module_tag( $tag ) {
2319
		return jetpack_get_module_i18n_tag( $tag );
2320
	}
2321
2322
	/**
2323
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2324
	 *
2325
	 * @since 3.9.2
2326
	 *
2327
	 * @param array $modules
2328
	 *
2329
	 * @return string|void
2330
	 */
2331
	public static function get_translated_modules( $modules ) {
2332
		foreach ( $modules as $index => $module ) {
2333
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2334
			if ( isset( $module['name'] ) ) {
2335
				$modules[ $index ]['name'] = $i18n_module['name'];
2336
			}
2337
			if ( isset( $module['description'] ) ) {
2338
				$modules[ $index ]['description'] = $i18n_module['description'];
2339
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2340
			}
2341
		}
2342
		return $modules;
2343
	}
2344
2345
	/**
2346
	 * Get a list of activated modules as an array of module slugs.
2347
	 */
2348
	public static function get_active_modules() {
2349
		$active = Jetpack_Options::get_option( 'active_modules' );
2350
2351
		if ( ! is_array( $active ) ) {
2352
			$active = array();
2353
		}
2354
2355
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2356
			$active[] = 'vaultpress';
2357
		} else {
2358
			$active = array_diff( $active, array( 'vaultpress' ) );
2359
		}
2360
2361
		//If protect is active on the main site of a multisite, it should be active on all sites.
2362
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2363
			$active[] = 'protect';
2364
		}
2365
2366
		return array_unique( $active );
2367
	}
2368
2369
	/**
2370
	 * Check whether or not a Jetpack module is active.
2371
	 *
2372
	 * @param string $module The slug of a Jetpack module.
2373
	 * @return bool
2374
	 *
2375
	 * @static
2376
	 */
2377
	public static function is_module_active( $module ) {
2378
		return in_array( $module, self::get_active_modules() );
2379
	}
2380
2381
	public static function is_module( $module ) {
2382
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2383
	}
2384
2385
	/**
2386
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2387
	 *
2388
	 * @param bool $catch True to start catching, False to stop.
2389
	 *
2390
	 * @static
2391
	 */
2392
	public static function catch_errors( $catch ) {
2393
		static $display_errors, $error_reporting;
2394
2395
		if ( $catch ) {
2396
			$display_errors  = @ini_set( 'display_errors', 1 );
2397
			$error_reporting = @error_reporting( E_ALL );
2398
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2399
		} else {
2400
			@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...
2401
			@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...
2402
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2403
		}
2404
	}
2405
2406
	/**
2407
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2408
	 */
2409
	public static function catch_errors_on_shutdown() {
2410
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2411
	}
2412
2413
	/**
2414
	 * Rewrite any string to make paths easier to read.
2415
	 *
2416
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2417
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2418
	 *
2419
	 * @param $string
2420
	 * @return mixed
2421
	 */
2422
	public static function alias_directories( $string ) {
2423
		// ABSPATH has a trailing slash.
2424
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2425
		// WP_CONTENT_DIR does not have a trailing slash.
2426
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2427
2428
		return $string;
2429
	}
2430
2431
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2432
		$jetpack = Jetpack::init();
2433
2434
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2435
		$modules = array_merge( $other_modules, $modules );
2436
2437
		// Look for standalone plugins and disable if active.
2438
2439
		$to_deactivate = array();
2440
		foreach ( $modules as $module ) {
2441
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2442
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2443
			}
2444
		}
2445
2446
		$deactivated = array();
2447
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2448
			list( $probable_file, $probable_title ) = $deactivate_me;
2449
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2450
				$deactivated[] = $module;
2451
			}
2452
		}
2453
2454
		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...
2455
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2456
2457
			$url = add_query_arg(
2458
				array(
2459
					'action'   => 'activate_default_modules',
2460
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2461
				),
2462
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2463
			);
2464
			wp_safe_redirect( $url );
2465
			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...
2466
		}
2467
2468
		/**
2469
		 * Fires before default modules are activated.
2470
		 *
2471
		 * @since 1.9.0
2472
		 *
2473
		 * @param string $min_version Minimum version number required to use modules.
2474
		 * @param string $max_version Maximum version number required to use modules.
2475
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2476
		 */
2477
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2478
2479
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2480
		Jetpack::restate();
2481
		Jetpack::catch_errors( true );
2482
2483
		$active = Jetpack::get_active_modules();
2484
2485
		foreach ( $modules as $module ) {
2486
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2487
				$active[] = $module;
2488
				self::update_active_modules( $active );
2489
				continue;
2490
			}
2491
2492
			if ( in_array( $module, $active ) ) {
2493
				$module_info = Jetpack::get_module( $module );
2494
				if ( ! $module_info['deactivate'] ) {
2495
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2496 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2497
						$active_state = explode( ',', $active_state );
2498
					} else {
2499
						$active_state = array();
2500
					}
2501
					$active_state[] = $module;
2502
					Jetpack::state( $state, implode( ',', $active_state ) );
2503
				}
2504
				continue;
2505
			}
2506
2507
			$file = Jetpack::get_module_path( $module );
2508
			if ( ! file_exists( $file ) ) {
2509
				continue;
2510
			}
2511
2512
			// we'll override this later if the plugin can be included without fatal error
2513
			if ( $redirect ) {
2514
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2515
			}
2516
			Jetpack::state( 'error', 'module_activation_failed' );
2517
			Jetpack::state( 'module', $module );
2518
			ob_start();
2519
			require $file;
2520
2521
			$active[] = $module;
2522
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2523 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2524
				$active_state = explode( ',', $active_state );
2525
			} else {
2526
				$active_state = array();
2527
			}
2528
			$active_state[] = $module;
2529
			Jetpack::state( $state, implode( ',', $active_state ) );
2530
			Jetpack::update_active_modules( $active );
2531
2532
			ob_end_clean();
2533
		}
2534
		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...
2535
		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...
2536
		Jetpack::catch_errors( false );
2537
		/**
2538
		 * Fires when default modules are activated.
2539
		 *
2540
		 * @since 1.9.0
2541
		 *
2542
		 * @param string $min_version Minimum version number required to use modules.
2543
		 * @param string $max_version Maximum version number required to use modules.
2544
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2545
		 */
2546
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2547
	}
2548
2549
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2550
		/**
2551
		 * Fires before a module is activated.
2552
		 *
2553
		 * @since 2.6.0
2554
		 *
2555
		 * @param string $module Module slug.
2556
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2557
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2558
		 */
2559
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2560
2561
		$jetpack = Jetpack::init();
2562
2563
		if ( ! strlen( $module ) )
2564
			return false;
2565
2566
		if ( ! Jetpack::is_module( $module ) )
2567
			return false;
2568
2569
		// If it's already active, then don't do it again
2570
		$active = Jetpack::get_active_modules();
2571
		foreach ( $active as $act ) {
2572
			if ( $act == $module )
2573
				return true;
2574
		}
2575
2576
		$module_data = Jetpack::get_module( $module );
2577
2578
		if ( ! Jetpack::is_active() ) {
2579
			if ( !Jetpack::is_development_mode() )
2580
				return false;
2581
2582
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2583
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2584
				return false;
2585
		}
2586
2587
		// Check and see if the old plugin is active
2588
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2589
			// Deactivate the old plugin
2590
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2591
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2592
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2593
				Jetpack::state( 'deactivated_plugins', $module );
2594
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2595
				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...
2596
			}
2597
		}
2598
2599
		// Protect won't work with mis-configured IPs
2600
		if ( 'protect' === $module ) {
2601
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2602
			if ( ! jetpack_protect_get_ip() ) {
2603
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2604
				return false;
2605
			}
2606
		}
2607
2608
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2609
		Jetpack::state( 'module', $module );
2610
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2611
2612
		Jetpack::catch_errors( true );
2613
		ob_start();
2614
		require Jetpack::get_module_path( $module );
2615
		/** This action is documented in class.jetpack.php */
2616
		do_action( 'jetpack_activate_module', $module );
2617
		$active[] = $module;
2618
		Jetpack::update_active_modules( $active );
2619
2620
		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...
2621
		ob_end_clean();
2622
		Jetpack::catch_errors( false );
2623
2624
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2625 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2626
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2627
2628
			//Jump start is being dismissed send data to MC Stats
2629
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2630
2631
			$jetpack->do_stats( 'server_side' );
2632
		}
2633
2634
		if ( $redirect ) {
2635
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2636
		}
2637
		if ( $exit ) {
2638
			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...
2639
		}
2640
		return true;
2641
	}
2642
2643
	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...
2644
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2645
	}
2646
2647
	public static function deactivate_module( $module ) {
2648
		/**
2649
		 * Fires when a module is deactivated.
2650
		 *
2651
		 * @since 1.9.0
2652
		 *
2653
		 * @param string $module Module slug.
2654
		 */
2655
		do_action( 'jetpack_pre_deactivate_module', $module );
2656
2657
		$jetpack = Jetpack::init();
2658
2659
		$active = Jetpack::get_active_modules();
2660
		$new    = array_filter( array_diff( $active, (array) $module ) );
2661
2662
		// A flag for Jump Start so it's not shown again.
2663 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2664
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2665
2666
			//Jump start is being dismissed send data to MC Stats
2667
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2668
2669
			$jetpack->do_stats( 'server_side' );
2670
		}
2671
2672
		return self::update_active_modules( $new );
2673
	}
2674
2675
	public static function enable_module_configurable( $module ) {
2676
		$module = Jetpack::get_module_slug( $module );
2677
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2678
	}
2679
2680
	public static function module_configuration_url( $module ) {
2681
		$module = Jetpack::get_module_slug( $module );
2682
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2683
	}
2684
2685
	public static function module_configuration_load( $module, $method ) {
2686
		$module = Jetpack::get_module_slug( $module );
2687
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2688
	}
2689
2690
	public static function module_configuration_head( $module, $method ) {
2691
		$module = Jetpack::get_module_slug( $module );
2692
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2693
	}
2694
2695
	public static function module_configuration_screen( $module, $method ) {
2696
		$module = Jetpack::get_module_slug( $module );
2697
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2698
	}
2699
2700
	public static function module_configuration_activation_screen( $module, $method ) {
2701
		$module = Jetpack::get_module_slug( $module );
2702
		add_action( 'display_activate_module_setting_' . $module, $method );
2703
	}
2704
2705
/* Installation */
2706
2707
	public static function bail_on_activation( $message, $deactivate = true ) {
2708
?>
2709
<!doctype html>
2710
<html>
2711
<head>
2712
<meta charset="<?php bloginfo( 'charset' ); ?>">
2713
<style>
2714
* {
2715
	text-align: center;
2716
	margin: 0;
2717
	padding: 0;
2718
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2719
}
2720
p {
2721
	margin-top: 1em;
2722
	font-size: 18px;
2723
}
2724
</style>
2725
<body>
2726
<p><?php echo esc_html( $message ); ?></p>
2727
</body>
2728
</html>
2729
<?php
2730
		if ( $deactivate ) {
2731
			$plugins = get_option( 'active_plugins' );
2732
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2733
			$update  = false;
2734
			foreach ( $plugins as $i => $plugin ) {
2735
				if ( $plugin === $jetpack ) {
2736
					$plugins[$i] = false;
2737
					$update = true;
2738
				}
2739
			}
2740
2741
			if ( $update ) {
2742
				update_option( 'active_plugins', array_filter( $plugins ) );
2743
			}
2744
		}
2745
		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...
2746
	}
2747
2748
	/**
2749
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2750
	 * @static
2751
	 */
2752
	public static function plugin_activation( $network_wide ) {
2753
		Jetpack_Options::update_option( 'activated', 1 );
2754
2755
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2756
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2757
		}
2758
2759
		if ( $network_wide )
2760
			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...
2761
2762
		Jetpack::plugin_initialize();
2763
	}
2764
	/**
2765
	 * Runs before bumping version numbers up to a new version
2766
	 * @param  (string) $version    Version:timestamp
2767
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2768
	 * @return null              [description]
2769
	 */
2770
	public static function do_version_bump( $version, $old_version ) {
2771
2772
		if ( ! $old_version ) { // For new sites
2773
			// Setting up jetpack manage
2774
			Jetpack::activate_manage();
2775
		}
2776
	}
2777
2778
	/**
2779
	 * Sets the internal version number and activation state.
2780
	 * @static
2781
	 */
2782
	public static function plugin_initialize() {
2783
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2784
			Jetpack_Options::update_option( 'activated', 2 );
2785
		}
2786
2787 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2788
			$version = $old_version = JETPACK__VERSION . ':' . time();
2789
			/** This action is documented in class.jetpack.php */
2790
			do_action( 'updating_jetpack_version', $version, false );
2791
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2792
		}
2793
2794
		Jetpack::load_modules();
2795
2796
		Jetpack_Options::delete_option( 'do_activate' );
2797
	}
2798
2799
	/**
2800
	 * Removes all connection options
2801
	 * @static
2802
	 */
2803
	public static function plugin_deactivation( ) {
2804
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2805
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2806
			Jetpack_Network::init()->deactivate();
2807
		} else {
2808
			Jetpack::disconnect( false );
2809
			//Jetpack_Heartbeat::init()->deactivate();
2810
		}
2811
	}
2812
2813
	/**
2814
	 * Disconnects from the Jetpack servers.
2815
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2816
	 * @static
2817
	 */
2818
	public static function disconnect( $update_activated_state = true ) {
2819
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2820
		Jetpack::clean_nonces( true );
2821
2822
		// If the site is in an IDC because sync is not allowed,
2823
		// let's make sure to not disconnect the production site.
2824
		if ( ! self::validate_sync_error_idc_option() ) {
2825
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2826
			Jetpack::load_xml_rpc_client();
2827
			$xml = new Jetpack_IXR_Client();
2828
			$xml->query( 'jetpack.deregister' );
2829
		}
2830
2831
		Jetpack_Options::delete_option(
2832
			array(
2833
				'register',
2834
				'blog_token',
2835
				'user_token',
2836
				'user_tokens',
2837
				'master_user',
2838
				'time_diff',
2839
				'fallback_no_verify_ssl_certs',
2840
			)
2841
		);
2842
2843
		Jetpack_IDC::clear_all_idc_options();
2844
2845
		if ( $update_activated_state ) {
2846
			Jetpack_Options::update_option( 'activated', 4 );
2847
		}
2848
2849
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2850
			// Check then record unique disconnection if site has never been disconnected previously
2851
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2852
				$jetpack_unique_connection['disconnected'] = 1;
2853
			} else {
2854
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2855
					//track unique disconnect
2856
					$jetpack = Jetpack::init();
2857
2858
					$jetpack->stat( 'connections', 'unique-disconnect' );
2859
					$jetpack->do_stats( 'server_side' );
2860
				}
2861
				// increment number of times disconnected
2862
				$jetpack_unique_connection['disconnected'] += 1;
2863
			}
2864
2865
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2866
		}
2867
2868
		// Delete cached connected user data
2869
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2870
		delete_transient( $transient_key );
2871
2872
		// Delete all the sync related data. Since it could be taking up space.
2873
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2874
		Jetpack_Sync_Sender::get_instance()->uninstall();
2875
2876
		// Disable the Heartbeat cron
2877
		Jetpack_Heartbeat::init()->deactivate();
2878
	}
2879
2880
	/**
2881
	 * Unlinks the current user from the linked WordPress.com user
2882
	 */
2883
	public static function unlink_user( $user_id = null ) {
2884
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2885
			return false;
2886
2887
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2888
2889
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2890
			return false;
2891
2892
		if ( ! isset( $tokens[ $user_id ] ) )
2893
			return false;
2894
2895
		Jetpack::load_xml_rpc_client();
2896
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2897
		$xml->query( 'jetpack.unlink_user', $user_id );
2898
2899
		unset( $tokens[ $user_id ] );
2900
2901
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2902
2903
		/**
2904
		 * Fires after the current user has been unlinked from WordPress.com.
2905
		 *
2906
		 * @since 4.1.0
2907
		 *
2908
		 * @param int $user_id The current user's ID.
2909
		 */
2910
		do_action( 'jetpack_unlinked_user', $user_id );
2911
2912
		return true;
2913
	}
2914
2915
	/**
2916
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2917
	 */
2918
	public static function try_registration() {
2919
		// Let's get some testing in beta versions and such.
2920
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2921
			// Before attempting to connect, let's make sure that the domains are viable.
2922
			$domains_to_check = array_unique( array(
2923
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2924
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2925
			) );
2926
			foreach ( $domains_to_check as $domain ) {
2927
				$result = Jetpack_Data::is_usable_domain( $domain );
2928
				if ( is_wp_error( $result ) ) {
2929
					return $result;
2930
				}
2931
			}
2932
		}
2933
2934
		$result = Jetpack::register();
2935
2936
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2937
		if ( ! $result || is_wp_error( $result ) ) {
2938
			return $result;
2939
		} else {
2940
			return true;
2941
		}
2942
	}
2943
2944
	/**
2945
	 * Tracking an internal event log. Try not to put too much chaff in here.
2946
	 *
2947
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2948
	 */
2949
	public static function log( $code, $data = null ) {
2950
		// only grab the latest 200 entries
2951
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2952
2953
		// Append our event to the log
2954
		$log_entry = array(
2955
			'time'    => time(),
2956
			'user_id' => get_current_user_id(),
2957
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2958
			'code'    => $code,
2959
		);
2960
		// Don't bother storing it unless we've got some.
2961
		if ( ! is_null( $data ) ) {
2962
			$log_entry['data'] = $data;
2963
		}
2964
		$log[] = $log_entry;
2965
2966
		// Try add_option first, to make sure it's not autoloaded.
2967
		// @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...
2968
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
2969
			Jetpack_Options::update_option( 'log', $log );
2970
		}
2971
2972
		/**
2973
		 * Fires when Jetpack logs an internal event.
2974
		 *
2975
		 * @since 3.0.0
2976
		 *
2977
		 * @param array $log_entry {
2978
		 *	Array of details about the log entry.
2979
		 *
2980
		 *	@param string time Time of the event.
2981
		 *	@param int user_id ID of the user who trigerred the event.
2982
		 *	@param int blog_id Jetpack Blog ID.
2983
		 *	@param string code Unique name for the event.
2984
		 *	@param string data Data about the event.
2985
		 * }
2986
		 */
2987
		do_action( 'jetpack_log_entry', $log_entry );
2988
	}
2989
2990
	/**
2991
	 * Get the internal event log.
2992
	 *
2993
	 * @param $event (string) - only return the specific log events
2994
	 * @param $num   (int)    - get specific number of latest results, limited to 200
2995
	 *
2996
	 * @return array of log events || WP_Error for invalid params
2997
	 */
2998
	public static function get_log( $event = false, $num = false ) {
2999
		if ( $event && ! is_string( $event ) ) {
3000
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3001
		}
3002
3003
		if ( $num && ! is_numeric( $num ) ) {
3004
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3005
		}
3006
3007
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3008
3009
		// If nothing set - act as it did before, otherwise let's start customizing the output
3010
		if ( ! $num && ! $event ) {
3011
			return $entire_log;
3012
		} else {
3013
			$entire_log = array_reverse( $entire_log );
3014
		}
3015
3016
		$custom_log_output = array();
3017
3018
		if ( $event ) {
3019
			foreach ( $entire_log as $log_event ) {
3020
				if ( $event == $log_event[ 'code' ] ) {
3021
					$custom_log_output[] = $log_event;
3022
				}
3023
			}
3024
		} else {
3025
			$custom_log_output = $entire_log;
3026
		}
3027
3028
		if ( $num ) {
3029
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3030
		}
3031
3032
		return $custom_log_output;
3033
	}
3034
3035
	/**
3036
	 * Log modification of important settings.
3037
	 */
3038
	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...
3039
		switch( $option ) {
3040
			case 'jetpack_sync_non_public_post_stati':
3041
				self::log( $option, $value );
3042
				break;
3043
		}
3044
	}
3045
3046
	/**
3047
	 * Return stat data for WPCOM sync
3048
	 */
3049
	public static function get_stat_data( $encode = true, $extended = true ) {
3050
		$data = Jetpack_Heartbeat::generate_stats_array();
3051
3052
		if ( $extended ) {
3053
			$additional_data = self::get_additional_stat_data();
3054
			$data = array_merge( $data, $additional_data );
3055
		}
3056
3057
		if ( $encode ) {
3058
			return json_encode( $data );
3059
		}
3060
3061
		return $data;
3062
	}
3063
3064
	/**
3065
	 * Get additional stat data to sync to WPCOM
3066
	 */
3067
	public static function get_additional_stat_data( $prefix = '' ) {
3068
		$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...
3069
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3070
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3071
		$return["{$prefix}site-count"]     = 0;
3072
3073
		if ( function_exists( 'get_blog_count' ) ) {
3074
			$return["{$prefix}site-count"] = get_blog_count();
3075
		}
3076
		return $return;
3077
	}
3078
3079
	private static function get_site_user_count() {
3080
		global $wpdb;
3081
3082
		if ( function_exists( 'wp_is_large_network' ) ) {
3083
			if ( wp_is_large_network( 'users' ) ) {
3084
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3085
			}
3086
		}
3087 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3088
			// It wasn't there, so regenerate the data and save the transient
3089
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3090
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3091
		}
3092
		return $user_count;
3093
	}
3094
3095
	/* Admin Pages */
3096
3097
	function admin_init() {
3098
		// If the plugin is not connected, display a connect message.
3099
		if (
3100
			// the plugin was auto-activated and needs its candy
3101
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3102
		||
3103
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3104
			! Jetpack_Options::get_option( 'activated' )
3105
		) {
3106
			Jetpack::plugin_initialize();
3107
		}
3108
3109
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3110
			Jetpack_Connection_Banner::init();
3111
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3112
			// Upgrade: 1.1 -> 1.1.1
3113
			// Check and see if host can verify the Jetpack servers' SSL certificate
3114
			$args = array();
3115
			Jetpack_Client::_wp_remote_request(
3116
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3117
				$args,
3118
				true
3119
			);
3120
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3121
			// Show the notice on the Dashboard only for now
3122
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3123
		}
3124
3125
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3126
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3127
		}
3128
3129
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3130
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3131
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3132
3133
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3134
			// Artificially throw errors in certain whitelisted cases during plugin activation
3135
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3136
		}
3137
3138
		// Jetpack Manage Activation Screen from .com
3139
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3140
3141
		// Add custom column in wp-admin/users.php to show whether user is linked.
3142
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3143
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3144
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3145
	}
3146
3147
	function admin_body_class( $admin_body_class = '' ) {
3148
		$classes = explode( ' ', trim( $admin_body_class ) );
3149
3150
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3151
3152
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3153
		return " $admin_body_class ";
3154
	}
3155
3156
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3157
		return $admin_body_class . ' jetpack-pagestyles ';
3158
	}
3159
3160
	/**
3161
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3162
	 *
3163
	 * @return null
3164
	 */
3165
	function prepare_manage_jetpack_notice() {
3166
3167
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3168
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3169
	}
3170
3171
	function manage_activate_screen() {
3172
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3173
	}
3174
	/**
3175
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3176
	 * This function artificially throws errors for such cases (whitelisted).
3177
	 *
3178
	 * @param string $plugin The activated plugin.
3179
	 */
3180
	function throw_error_on_activate_plugin( $plugin ) {
3181
		$active_modules = Jetpack::get_active_modules();
3182
3183
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3184
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3185
			$throw = false;
3186
3187
			// Try and make sure it really was the stats plugin
3188
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3189
				if ( 'stats.php' == basename( $plugin ) ) {
3190
					$throw = true;
3191
				}
3192
			} else {
3193
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3194
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3195
					$throw = true;
3196
				}
3197
			}
3198
3199
			if ( $throw ) {
3200
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3201
			}
3202
		}
3203
	}
3204
3205
	function intercept_plugin_error_scrape_init() {
3206
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3207
	}
3208
3209
	function intercept_plugin_error_scrape( $action, $result ) {
3210
		if ( ! $result ) {
3211
			return;
3212
		}
3213
3214
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3215
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3216
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3217
			}
3218
		}
3219
	}
3220
3221
	function add_remote_request_handlers() {
3222
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3223
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3224
	}
3225
3226
	function remote_request_handlers() {
3227
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3228
3229
		switch ( current_filter() ) {
3230
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3231
			$response = $this->upload_handler();
3232
			break;
3233
3234
		case 'wp_ajax_nopriv_jetpack_update_file' :
3235
			$response = $this->upload_handler( true );
3236
			break;
3237
		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...
3238
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3239
			break;
3240
		}
3241
3242
		if ( ! $response ) {
3243
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3244
		}
3245
3246
		if ( is_wp_error( $response ) ) {
3247
			$status_code       = $response->get_error_data();
3248
			$error             = $response->get_error_code();
3249
			$error_description = $response->get_error_message();
3250
3251
			if ( ! is_int( $status_code ) ) {
3252
				$status_code = 400;
3253
			}
3254
3255
			status_header( $status_code );
3256
			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...
3257
		}
3258
3259
		status_header( 200 );
3260
		if ( true === $response ) {
3261
			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...
3262
		}
3263
3264
		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...
3265
	}
3266
3267
	/**
3268
	 * Uploads a file gotten from the global $_FILES.
3269
	 * If `$update_media_item` is true and `post_id` is defined
3270
	 * the attachment file of the media item (gotten through of the post_id)
3271
	 * will be updated instead of add a new one.
3272
	 * 
3273
	 * @param  boolean $update_media_item - update media attachment
3274
	 * @return array - An array describing the uploadind files process
3275
	 */
3276
	function upload_handler( $update_media_item = false ) {
3277
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3278
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3279
		}
3280
3281
		$user = wp_authenticate( '', '' );
3282
		if ( ! $user || is_wp_error( $user ) ) {
3283
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3284
		}
3285
3286
		wp_set_current_user( $user->ID );
3287
3288
		if ( ! current_user_can( 'upload_files' ) ) {
3289
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3290
		}
3291
3292
		if ( empty( $_FILES ) ) {
3293
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3294
		}
3295
3296
		foreach ( array_keys( $_FILES ) as $files_key ) {
3297
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3298
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3299
			}
3300
		}
3301
3302
		$media_keys = array_keys( $_FILES['media'] );
3303
3304
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3305
		if ( ! $token || is_wp_error( $token ) ) {
3306
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3307
		}
3308
3309
		$uploaded_files = array();
3310
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3311
		unset( $GLOBALS['post'] );
3312
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3313
			$file = array();
3314
			foreach ( $media_keys as $media_key ) {
3315
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3316
			}
3317
3318
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3319
3320
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3321
			if ( $hmac_provided !== $hmac_file ) {
3322
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3323
				continue;
3324
			}
3325
3326
			$_FILES['.jetpack.upload.'] = $file;
3327
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3328
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3329
				$post_id = 0;
3330
			}
3331
3332
			if ( $update_media_item ) {
3333
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3334
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3335
				}
3336
3337
				$media_array = $_FILES['media'];
3338
3339
				$file_array['name'] = $media_array['name'][0]; 
0 ignored issues
show
Coding Style Comprehensibility introduced by
$file_array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $file_array = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3340
				$file_array['type'] = $media_array['type'][0]; 
3341
				$file_array['tmp_name'] = $media_array['tmp_name'][0]; 
3342
				$file_array['error'] = $media_array['error'][0]; 
3343
				$file_array['size'] = $media_array['size'][0];
3344
3345
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3346
3347
				if ( is_wp_error( $edited_media_item ) ) {
3348
					return $edited_media_item;
3349
				}
3350
3351
				$response = (object) array(
3352
					'id'   => (string) $post_id,
3353
					'file' => (string) $edited_media_item->post_title,
3354
					'url'  => (string) wp_get_attachment_url( $post_id ),
3355
					'type' => (string) $edited_media_item->post_mime_type,
3356
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3357
				);
3358
3359
				return (array) array( $response );
3360
			}
3361
3362
			$attachment_id = media_handle_upload(
3363
				'.jetpack.upload.',
3364
				$post_id,
3365
				array(),
3366
				array(
3367
					'action' => 'jetpack_upload_file',
3368
				)
3369
			);
3370
3371
			if ( ! $attachment_id ) {
3372
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3373
			} elseif ( is_wp_error( $attachment_id ) ) {
3374
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3375
			} else {
3376
				$attachment = get_post( $attachment_id );
3377
				$uploaded_files[$index] = (object) array(
3378
					'id'   => (string) $attachment_id,
3379
					'file' => $attachment->post_title,
3380
					'url'  => wp_get_attachment_url( $attachment_id ),
3381
					'type' => $attachment->post_mime_type,
3382
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3383
				);
3384
				// Zip files uploads are not supported unless they are done for installation purposed
3385
				// lets delete them in case something goes wrong in this whole process
3386
				if ( 'application/zip' === $attachment->post_mime_type ) {
3387
					// Schedule a cleanup for 2 hours from now in case of failed install.
3388
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3389
				}
3390
			}
3391
		}
3392
		if ( ! is_null( $global_post ) ) {
3393
			$GLOBALS['post'] = $global_post;
3394
		}
3395
3396
		return $uploaded_files;
3397
	}
3398
3399
	/**
3400
	 * Add help to the Jetpack page
3401
	 *
3402
	 * @since Jetpack (1.2.3)
3403
	 * @return false if not the Jetpack page
3404
	 */
3405
	function admin_help() {
3406
		$current_screen = get_current_screen();
3407
3408
		// Overview
3409
		$current_screen->add_help_tab(
3410
			array(
3411
				'id'		=> 'home',
3412
				'title'		=> __( 'Home', 'jetpack' ),
3413
				'content'	=>
3414
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3415
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3416
					'<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>',
3417
			)
3418
		);
3419
3420
		// Screen Content
3421
		if ( current_user_can( 'manage_options' ) ) {
3422
			$current_screen->add_help_tab(
3423
				array(
3424
					'id'		=> 'settings',
3425
					'title'		=> __( 'Settings', 'jetpack' ),
3426
					'content'	=>
3427
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3428
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3429
						'<ol>' .
3430
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3431
							'<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>' .
3432
						'</ol>' .
3433
						'<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>'
3434
				)
3435
			);
3436
		}
3437
3438
		// Help Sidebar
3439
		$current_screen->set_help_sidebar(
3440
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3441
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3442
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3443
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3444
		);
3445
	}
3446
3447
	function admin_menu_css() {
3448
		wp_enqueue_style( 'jetpack-icons' );
3449
	}
3450
3451
	function admin_menu_order() {
3452
		return true;
3453
	}
3454
3455 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3456
		$jp_menu_order = array();
3457
3458
		foreach ( $menu_order as $index => $item ) {
3459
			if ( $item != 'jetpack' ) {
3460
				$jp_menu_order[] = $item;
3461
			}
3462
3463
			if ( $index == 0 ) {
3464
				$jp_menu_order[] = 'jetpack';
3465
			}
3466
		}
3467
3468
		return $jp_menu_order;
3469
	}
3470
3471
	function admin_head() {
3472 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3473
			/** This action is documented in class.jetpack-admin-page.php */
3474
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3475
	}
3476
3477
	function admin_banner_styles() {
3478
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3479
3480 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3481
			wp_register_style(
3482
				'jetpack-dops-style',
3483
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3484
				array(),
3485
				JETPACK__VERSION
3486
			);
3487
		}
3488
3489
		wp_enqueue_style(
3490
			'jetpack',
3491
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3492
			array( 'jetpack-dops-style' ),
3493
			 JETPACK__VERSION . '-20121016'
3494
		);
3495
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3496
		wp_style_add_data( 'jetpack', 'suffix', $min );
3497
	}
3498
3499
	function plugin_action_links( $actions ) {
3500
3501
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3502
3503
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3504
			return array_merge(
3505
				$jetpack_home,
3506
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3507
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3508
				$actions
3509
				);
3510
			}
3511
3512
		return array_merge( $jetpack_home, $actions );
3513
	}
3514
3515
	/**
3516
	 * This is the first banner
3517
	 * It should be visible only to user that can update the option
3518
	 * Are not connected
3519
	 *
3520
	 * @return null
3521
	 */
3522
	function admin_jetpack_manage_notice() {
3523
		$screen = get_current_screen();
3524
3525
		// Don't show the connect notice on the jetpack settings page.
3526
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3527
			return;
3528
		}
3529
3530
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3531
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3532
		/**
3533
		 * I think it would be great to have different wordsing depending on where you are
3534
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3535
		 * etc..
3536
		 */
3537
3538
		?>
3539
		<div id="message" class="updated jp-banner">
3540
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3541
				<div class="jp-banner__description-container">
3542
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3543
					<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>
3544
					<p class="jp-banner__button-container">
3545
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3546
						<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>
3547
					</p>
3548
				</div>
3549
		</div>
3550
		<?php
3551
	}
3552
3553
	/**
3554
	 * Returns the url that the user clicks to remove the notice for the big banner
3555
	 * @return (string)
3556
	 */
3557
	function opt_out_jetpack_manage_url() {
3558
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3559
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3560
	}
3561
	/**
3562
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3563
	 * @return (string)
3564
	 */
3565
	function opt_in_jetpack_manage_url() {
3566
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3567
	}
3568
3569
	function opt_in_jetpack_manage_notice() {
3570
		?>
3571
		<div class="wrap">
3572
			<div id="message" class="jetpack-message is-opt-in">
3573
				<?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' ); ?>
3574
			</div>
3575
		</div>
3576
		<?php
3577
3578
	}
3579
	/**
3580
	 * Determines whether to show the notice of not true = display notice
3581
	 * @return (bool)
3582
	 */
3583
	function can_display_jetpack_manage_notice() {
3584
		// never display the notice to users that can't do anything about it anyways
3585
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3586
			return false;
3587
3588
		// don't display if we are in development more
3589
		if( Jetpack::is_development_mode() ) {
3590
			return false;
3591
		}
3592
		// don't display if the site is private
3593
		if(  ! Jetpack_Options::get_option( 'public' ) )
3594
			return false;
3595
3596
		/**
3597
		 * Should the Jetpack Remote Site Management notice be displayed.
3598
		 *
3599
		 * @since 3.3.0
3600
		 *
3601
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3602
		 */
3603
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3604
	}
3605
3606
	/*
3607
	 * Registration flow:
3608
	 * 1 - ::admin_page_load() action=register
3609
	 * 2 - ::try_registration()
3610
	 * 3 - ::register()
3611
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3612
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3613
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3614
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3615
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3616
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3617
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3618
	 *       jetpack_id, jetpack_secret, jetpack_public
3619
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3620
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3621
	 * 5 - user logs in with WP.com account
3622
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3623
	 *		- Jetpack_Client_Server::authorize()
3624
	 *		- Jetpack_Client_Server::get_token()
3625
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3626
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3627
	 *			- which responds with access_token, token_type, scope
3628
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3629
	 *		- Jetpack::activate_default_modules()
3630
	 *     		- Deactivates deprecated plugins
3631
	 *     		- Activates all default modules
3632
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3633
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3634
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3635
	 *     Done!
3636
	 */
3637
3638
	/**
3639
	 * Handles the page load events for the Jetpack admin page
3640
	 */
3641
	function admin_page_load() {
3642
		$error = false;
3643
3644
		// Make sure we have the right body class to hook stylings for subpages off of.
3645
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3646
3647
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3648
			// Should only be used in intermediate redirects to preserve state across redirects
3649
			Jetpack::restate();
3650
		}
3651
3652
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3653
			// User clicked in the iframe to link their accounts
3654
			if ( ! Jetpack::is_user_connected() ) {
3655
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3656
				if ( isset( $_GET['notes_iframe'] ) )
3657
					$connect_url .= '&notes_iframe';
3658
				wp_redirect( $connect_url );
3659
				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...
3660
			} else {
3661
				if ( ! isset( $_GET['calypso_env'] ) ) {
3662
					Jetpack::state( 'message', 'already_authorized' );
3663
					wp_safe_redirect( Jetpack::admin_url() );
3664
				} else {
3665
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3666
					$connect_url .= '&already_authorized=true';
3667
					wp_redirect( $connect_url );
3668
				}
3669
			}
3670
		}
3671
3672
3673
		if ( isset( $_GET['action'] ) ) {
3674
			switch ( $_GET['action'] ) {
3675
			case 'authorize':
3676
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3677
					Jetpack::state( 'message', 'already_authorized' );
3678
					wp_safe_redirect( Jetpack::admin_url() );
3679
					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...
3680
				}
3681
				Jetpack::log( 'authorize' );
3682
				$client_server = new Jetpack_Client_Server;
3683
				$client_server->client_authorize();
3684
				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...
3685
			case 'register' :
3686
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3687
					$error = 'cheatin';
3688
					break;
3689
				}
3690
				check_admin_referer( 'jetpack-register' );
3691
				Jetpack::log( 'register' );
3692
				Jetpack::maybe_set_version_option();
3693
				$registered = Jetpack::try_registration();
3694
				if ( is_wp_error( $registered ) ) {
3695
					$error = $registered->get_error_code();
3696
					Jetpack::state( 'error', $error );
3697
					Jetpack::state( 'error', $registered->get_error_message() );
3698
					break;
3699
				}
3700
3701
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3702
3703
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3704
				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...
3705
			case 'activate' :
3706
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3707
					$error = 'cheatin';
3708
					break;
3709
				}
3710
3711
				$module = stripslashes( $_GET['module'] );
3712
				check_admin_referer( "jetpack_activate-$module" );
3713
				Jetpack::log( 'activate', $module );
3714
				Jetpack::activate_module( $module );
3715
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3716
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3717
				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...
3718
			case 'activate_default_modules' :
3719
				check_admin_referer( 'activate_default_modules' );
3720
				Jetpack::log( 'activate_default_modules' );
3721
				Jetpack::restate();
3722
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3723
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3724
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3725
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3726
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3727
				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...
3728
			case 'disconnect' :
3729
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3730
					$error = 'cheatin';
3731
					break;
3732
				}
3733
3734
				check_admin_referer( 'jetpack-disconnect' );
3735
				Jetpack::log( 'disconnect' );
3736
				Jetpack::disconnect();
3737
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3738
				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...
3739
			case 'reconnect' :
3740
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3741
					$error = 'cheatin';
3742
					break;
3743
				}
3744
3745
				check_admin_referer( 'jetpack-reconnect' );
3746
				Jetpack::log( 'reconnect' );
3747
				$this->disconnect();
3748
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3749
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3750 View Code Duplication
			case 'deactivate' :
3751
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3752
					$error = 'cheatin';
3753
					break;
3754
				}
3755
3756
				$modules = stripslashes( $_GET['module'] );
3757
				check_admin_referer( "jetpack_deactivate-$modules" );
3758
				foreach ( explode( ',', $modules ) as $module ) {
3759
					Jetpack::log( 'deactivate', $module );
3760
					Jetpack::deactivate_module( $module );
3761
					Jetpack::state( 'message', 'module_deactivated' );
3762
				}
3763
				Jetpack::state( 'module', $modules );
3764
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3765
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3766
			case 'unlink' :
3767
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3768
				check_admin_referer( 'jetpack-unlink' );
3769
				Jetpack::log( 'unlink' );
3770
				$this->unlink_user();
3771
				Jetpack::state( 'message', 'unlinked' );
3772
				if ( 'sub-unlink' == $redirect ) {
3773
					wp_safe_redirect( admin_url() );
3774
				} else {
3775
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3776
				}
3777
				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...
3778
			default:
3779
				/**
3780
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3781
				 *
3782
				 * @since 2.6.0
3783
				 *
3784
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3785
				 */
3786
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3787
			}
3788
		}
3789
3790
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3791
			self::activate_new_modules( true );
3792
		}
3793
3794
		$message_code = Jetpack::state( 'message' );
3795
		if ( Jetpack::state( 'optin-manage' ) ) {
3796
			$activated_manage = $message_code;
3797
			$message_code = 'jetpack-manage';
3798
		}
3799
3800
		switch ( $message_code ) {
3801
		case 'jetpack-manage':
3802
			$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>';
3803
			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...
3804
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3805
			}
3806
			break;
3807
3808
		}
3809
3810
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3811
3812
		if ( ! empty( $deactivated_plugins ) ) {
3813
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3814
			$deactivated_titles  = array();
3815
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3816
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3817
					continue;
3818
				}
3819
3820
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3821
			}
3822
3823
			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...
3824
				if ( $this->message ) {
3825
					$this->message .= "<br /><br />\n";
3826
				}
3827
3828
				$this->message .= wp_sprintf(
3829
					_n(
3830
						'Jetpack contains the most recent version of the old %l plugin.',
3831
						'Jetpack contains the most recent versions of the old %l plugins.',
3832
						count( $deactivated_titles ),
3833
						'jetpack'
3834
					),
3835
					$deactivated_titles
3836
				);
3837
3838
				$this->message .= "<br />\n";
3839
3840
				$this->message .= _n(
3841
					'The old version has been deactivated and can be removed from your site.',
3842
					'The old versions have been deactivated and can be removed from your site.',
3843
					count( $deactivated_titles ),
3844
					'jetpack'
3845
				);
3846
			}
3847
		}
3848
3849
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3850
3851
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3852
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3853
		}
3854
3855 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3856
			/**
3857
			 * Fires when a module configuration page is loaded.
3858
			 * The dynamic part of the hook is the configure parameter from the URL.
3859
			 *
3860
			 * @since 1.1.0
3861
			 */
3862
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3863
		}
3864
3865
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3866
	}
3867
3868
	function admin_notices() {
3869
3870
		if ( $this->error ) {
3871
?>
3872
<div id="message" class="jetpack-message jetpack-err">
3873
	<div class="squeezer">
3874
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3875
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3876
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3877
<?php	endif; ?>
3878
	</div>
3879
</div>
3880
<?php
3881
		}
3882
3883
		if ( $this->message ) {
3884
?>
3885
<div id="message" class="jetpack-message">
3886
	<div class="squeezer">
3887
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3888
	</div>
3889
</div>
3890
<?php
3891
		}
3892
3893
		if ( $this->privacy_checks ) :
3894
			$module_names = $module_slugs = array();
3895
3896
			$privacy_checks = explode( ',', $this->privacy_checks );
3897
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3898
			foreach ( $privacy_checks as $module_slug ) {
3899
				$module = Jetpack::get_module( $module_slug );
3900
				if ( ! $module ) {
3901
					continue;
3902
				}
3903
3904
				$module_slugs[] = $module_slug;
3905
				$module_names[] = "<strong>{$module['name']}</strong>";
3906
			}
3907
3908
			$module_slugs = join( ',', $module_slugs );
3909
?>
3910
<div id="message" class="jetpack-message jetpack-err">
3911
	<div class="squeezer">
3912
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3913
		<p><?php
3914
			echo wp_kses(
3915
				wptexturize(
3916
					wp_sprintf(
3917
						_nx(
3918
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3919
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3920
							count( $privacy_checks ),
3921
							'%l = list of Jetpack module/feature names',
3922
							'jetpack'
3923
						),
3924
						$module_names
3925
					)
3926
				),
3927
				array( 'strong' => true )
3928
			);
3929
3930
			echo "\n<br />\n";
3931
3932
			echo wp_kses(
3933
				sprintf(
3934
					_nx(
3935
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3936
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3937
						count( $privacy_checks ),
3938
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3939
						'jetpack'
3940
					),
3941
					wp_nonce_url(
3942
						Jetpack::admin_url(
3943
							array(
3944
								'page'   => 'jetpack',
3945
								'action' => 'deactivate',
3946
								'module' => urlencode( $module_slugs ),
3947
							)
3948
						),
3949
						"jetpack_deactivate-$module_slugs"
3950
					),
3951
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3952
				),
3953
				array( 'a' => array( 'href' => true, 'title' => true ) )
3954
			);
3955
		?></p>
3956
	</div>
3957
</div>
3958
<?php endif;
3959
	// only display the notice if the other stuff is not there
3960
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3961
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3962
			$this->opt_in_jetpack_manage_notice();
3963
		}
3964
	}
3965
3966
	/**
3967
	 * Record a stat for later output.  This will only currently output in the admin_footer.
3968
	 */
3969
	function stat( $group, $detail ) {
3970
		if ( ! isset( $this->stats[ $group ] ) )
3971
			$this->stats[ $group ] = array();
3972
		$this->stats[ $group ][] = $detail;
3973
	}
3974
3975
	/**
3976
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
3977
	 */
3978
	function do_stats( $method = '' ) {
3979
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
3980
			foreach ( $this->stats as $group => $stats ) {
3981
				if ( is_array( $stats ) && count( $stats ) ) {
3982
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
3983
					if ( 'server_side' === $method ) {
3984
						self::do_server_side_stat( $args );
3985
					} else {
3986
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
3987
					}
3988
				}
3989
				unset( $this->stats[ $group ] );
3990
			}
3991
		}
3992
	}
3993
3994
	/**
3995
	 * Runs stats code for a one-off, server-side.
3996
	 *
3997
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
3998
	 *
3999
	 * @return bool If it worked.
4000
	 */
4001
	static function do_server_side_stat( $args ) {
4002
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4003
		if ( is_wp_error( $response ) )
4004
			return false;
4005
4006
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4007
			return false;
4008
4009
		return true;
4010
	}
4011
4012
	/**
4013
	 * Builds the stats url.
4014
	 *
4015
	 * @param $args array|string The arguments to append to the URL.
4016
	 *
4017
	 * @return string The URL to be pinged.
4018
	 */
4019
	static function build_stats_url( $args ) {
4020
		$defaults = array(
4021
			'v'    => 'wpcom2',
4022
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4023
		);
4024
		$args     = wp_parse_args( $args, $defaults );
4025
		/**
4026
		 * Filter the URL used as the Stats tracking pixel.
4027
		 *
4028
		 * @since 2.3.2
4029
		 *
4030
		 * @param string $url Base URL used as the Stats tracking pixel.
4031
		 */
4032
		$base_url = apply_filters(
4033
			'jetpack_stats_base_url',
4034
			'https://pixel.wp.com/g.gif'
4035
		);
4036
		$url      = add_query_arg( $args, $base_url );
4037
		return $url;
4038
	}
4039
4040
	static function translate_current_user_to_role() {
4041
		foreach ( self::$capability_translations as $role => $cap ) {
4042
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4043
				return $role;
4044
			}
4045
		}
4046
4047
		return false;
4048
	}
4049
4050
	static function translate_role_to_cap( $role ) {
4051
		if ( ! isset( self::$capability_translations[$role] ) ) {
4052
			return false;
4053
		}
4054
4055
		return self::$capability_translations[$role];
4056
	}
4057
4058
	static function sign_role( $role ) {
4059
		if ( ! $user_id = (int) get_current_user_id() ) {
4060
			return false;
4061
		}
4062
4063
		$token = Jetpack_Data::get_access_token();
4064
		if ( ! $token || is_wp_error( $token ) ) {
4065
			return false;
4066
		}
4067
4068
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4069
	}
4070
4071
4072
	/**
4073
	 * Builds a URL to the Jetpack connection auth page
4074
	 *
4075
	 * @since 3.9.5
4076
	 *
4077
	 * @param bool $raw If true, URL will not be escaped.
4078
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4079
	 *                              If string, will be a custom redirect.
4080
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4081
	 *
4082
	 * @return string Connect URL
4083
	 */
4084
	function build_connect_url( $raw = false, $redirect = false, $from = false ) {
4085
		if ( ! Jetpack_Options::get_option( 'blog_token' ) || ! Jetpack_Options::get_option( 'id' ) ) {
4086
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4087
			if( is_network_admin() ) {
4088
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4089
			}
4090
		} else {
4091
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4092
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4093
			}
4094
4095
			$role = self::translate_current_user_to_role();
4096
			$signed_role = self::sign_role( $role );
4097
4098
			$user = wp_get_current_user();
4099
4100
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4101
			$redirect = $redirect
4102
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4103
				: $jetpack_admin_page;
4104
4105
			if( isset( $_REQUEST['is_multisite'] ) ) {
4106
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4107
			}
4108
4109
			$secrets = Jetpack::init()->generate_secrets( 'authorize' );
4110
			@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...
4111
4112
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4113
				? get_site_icon_url()
4114
				: false;
4115
4116
			/**
4117
			 * Filter the type of authorization.
4118
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4119
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4120
			 *
4121
			 * @since 4.3.3
4122
			 *
4123
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4124
			 */
4125
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4126
4127
			$args = urlencode_deep(
4128
				array(
4129
					'response_type' => 'code',
4130
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4131
					'redirect_uri'  => add_query_arg(
4132
						array(
4133
							'action'   => 'authorize',
4134
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4135
							'redirect' => urlencode( $redirect ),
4136
						),
4137
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4138
					),
4139
					'state'         => $user->ID,
4140
					'scope'         => $signed_role,
4141
					'user_email'    => $user->user_email,
4142
					'user_login'    => $user->user_login,
4143
					'is_active'     => Jetpack::is_active(),
4144
					'jp_version'    => JETPACK__VERSION,
4145
					'auth_type'     => $auth_type,
4146
					'secret'        => $secret,
4147
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4148
					'blogname'      => get_option( 'blogname' ),
4149
					'site_url'      => site_url(),
4150
					'home_url'      => home_url(),
4151
					'site_icon'     => $site_icon,
4152
				)
4153
			);
4154
4155
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4156
		}
4157
4158
		if ( $from ) {
4159
			$url = add_query_arg( 'from', $from, $url );
4160
		}
4161
4162
		if ( isset( $_GET['calypso_env'] ) ) {
4163
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4164
		}
4165
4166
		return $raw ? $url : esc_url( $url );
4167
	}
4168
4169
	function build_reconnect_url( $raw = false ) {
4170
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4171
		return $raw ? $url : esc_url( $url );
4172
	}
4173
4174
	public static function admin_url( $args = null ) {
4175
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4176
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4177
		return $url;
4178
	}
4179
4180
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4181
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4182
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4183
	}
4184
4185
	function dismiss_jetpack_notice() {
4186
4187
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4188
			return;
4189
		}
4190
4191
		switch( $_GET['jetpack-notice'] ) {
4192
			case 'dismiss':
4193
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4194
4195
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4196
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4197
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4198
				}
4199
				break;
4200 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...
4201
4202
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4203
					// Don't show the banner again
4204
4205
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4206
					// redirect back to the page that had the notice
4207
					if ( wp_get_referer() ) {
4208
						wp_safe_redirect( wp_get_referer() );
4209
					} else {
4210
						// Take me to Jetpack
4211
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4212
					}
4213
				}
4214
				break;
4215 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...
4216
4217
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4218
					// Don't show the banner again
4219
4220
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4221
					// redirect back to the page that had the notice
4222
					if ( wp_get_referer() ) {
4223
						wp_safe_redirect( wp_get_referer() );
4224
					} else {
4225
						// Take me to Jetpack
4226
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4227
					}
4228
				}
4229
				break;
4230
			case 'jetpack-manage-opt-in':
4231
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4232
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4233
4234
					$redirection_url = Jetpack::admin_url();
4235
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4236
4237
					// Don't redirect form the Jetpack Setting Page
4238
					$referer_parsed = parse_url ( wp_get_referer() );
4239
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4240
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4241
						// Take the user to Jetpack home except when on the setting page
4242
						$redirection_url = wp_get_referer();
4243
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4244
					}
4245
					// Also update the JSON API FULL MANAGEMENT Option
4246
					Jetpack::activate_module( 'manage', false, false );
4247
4248
					// Special Message when option in.
4249
					Jetpack::state( 'optin-manage', 'true' );
4250
					// Activate the Module if not activated already
4251
4252
					// Redirect properly
4253
					wp_safe_redirect( $redirection_url );
4254
4255
				}
4256
				break;
4257
		}
4258
	}
4259
4260
	function debugger_page() {
4261
		nocache_headers();
4262
		if ( ! current_user_can( 'manage_options' ) ) {
4263
			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...
4264
		}
4265
		Jetpack_Debugger::jetpack_debug_display_handler();
4266
		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...
4267
	}
4268
4269
	public static function admin_screen_configure_module( $module_id ) {
4270
4271
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4272
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4273
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4274
				/**
4275
				 * Fires to diplay a custom module activation screen.
4276
				 *
4277
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4278
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4279
				 *
4280
				 * @module manage
4281
				 *
4282
				 * @since 3.8.0
4283
				 *
4284
				 * @param int $module_id Module ID.
4285
				 */
4286
				do_action( 'display_activate_module_setting_' . $module_id );
4287
			} else {
4288
				self::display_activate_module_link( $module_id );
4289
			}
4290
4291
			return false;
4292
		} ?>
4293
4294
		<div id="jp-settings-screen" style="position: relative">
4295
			<h3>
4296
			<?php
4297
				$module = Jetpack::get_module( $module_id );
4298
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4299
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4300
			?>
4301
			</h3>
4302
			<?php
4303
				/**
4304
				 * Fires within the displayed message when a feature configuation is updated.
4305
				 *
4306
				 * @since 3.4.0
4307
				 *
4308
				 * @param int $module_id Module ID.
4309
				 */
4310
				do_action( 'jetpack_notices_update_settings', $module_id );
4311
				/**
4312
				 * Fires when a feature configuation screen is loaded.
4313
				 * The dynamic part of the hook, $module_id, is the module ID.
4314
				 *
4315
				 * @since 1.1.0
4316
				 */
4317
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4318
			?>
4319
		</div><?php
4320
	}
4321
4322
	/**
4323
	 * Display link to activate the module to see the settings screen.
4324
	 * @param  string $module_id
4325
	 * @return null
4326
	 */
4327
	public static function display_activate_module_link( $module_id ) {
4328
4329
		$info =  Jetpack::get_module( $module_id );
4330
		$extra = '';
4331
		$activate_url = wp_nonce_url(
4332
				Jetpack::admin_url(
4333
					array(
4334
						'page'   => 'jetpack',
4335
						'action' => 'activate',
4336
						'module' => $module_id,
4337
					)
4338
				),
4339
				"jetpack_activate-$module_id"
4340
			);
4341
4342
		?>
4343
4344
		<div class="wrap configure-module">
4345
			<div id="jp-settings-screen">
4346
				<?php
4347
				if ( $module_id == 'json-api' ) {
4348
4349
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4350
4351
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4352
4353
					$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' );
4354
4355
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4356
				} ?>
4357
4358
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4359
				<div class="narrow">
4360
					<p><?php echo  $info['description']; ?></p>
4361
					<?php if( $extra ) { ?>
4362
					<p><?php echo esc_html( $extra ); ?></p>
4363
					<?php } ?>
4364
					<p>
4365
						<?php
4366
						if( wp_get_referer() ) {
4367
							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() );
4368
						} else {
4369
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4370
						} ?>
4371
					</p>
4372
				</div>
4373
4374
			</div>
4375
		</div>
4376
4377
		<?php
4378
	}
4379
4380
	public static function sort_modules( $a, $b ) {
4381
		if ( $a['sort'] == $b['sort'] )
4382
			return 0;
4383
4384
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4385
	}
4386
4387
	function ajax_recheck_ssl() {
4388
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4389
		$result = Jetpack::permit_ssl( true );
4390
		wp_send_json( array(
4391
			'enabled' => $result,
4392
			'message' => get_transient( 'jetpack_https_test_message' )
4393
		) );
4394
	}
4395
4396
/* Client API */
4397
4398
	/**
4399
	 * Returns the requested Jetpack API URL
4400
	 *
4401
	 * @return string
4402
	 */
4403
	public static function api_url( $relative_url ) {
4404
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4405
	}
4406
4407
	/**
4408
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4409
	 */
4410
	public static function fix_url_for_bad_hosts( $url ) {
4411
		if ( 0 !== strpos( $url, 'https://' ) ) {
4412
			return $url;
4413
		}
4414
4415
		switch ( JETPACK_CLIENT__HTTPS ) {
4416
			case 'ALWAYS' :
4417
				return $url;
4418
			case 'NEVER' :
4419
				return set_url_scheme( $url, 'http' );
4420
			// default : case 'AUTO' :
4421
		}
4422
4423
		// we now return the unmodified SSL URL by default, as a security precaution
4424
		return $url;
4425
	}
4426
4427
	/**
4428
	 * Checks to see if the URL is using SSL to connect with Jetpack
4429
	 *
4430
	 * @since 2.3.3
4431
	 * @return boolean
4432
	 */
4433
	public static function permit_ssl( $force_recheck = false ) {
4434
		// Do some fancy tests to see if ssl is being supported
4435
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4436
			$message = '';
4437
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4438
				$ssl = 0;
4439
			} else {
4440
				switch ( JETPACK_CLIENT__HTTPS ) {
4441
					case 'NEVER':
4442
						$ssl = 0;
4443
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4444
						break;
4445
					case 'ALWAYS':
4446
					case 'AUTO':
4447
					default:
4448
						$ssl = 1;
4449
						break;
4450
				}
4451
4452
				// If it's not 'NEVER', test to see
4453
				if ( $ssl ) {
4454
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4455
						$ssl = 0;
4456
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4457
					} else {
4458
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4459
						if ( is_wp_error( $response ) ) {
4460
							$ssl = 0;
4461
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4462
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4463
							$ssl = 0;
4464
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4465
						}
4466
					}
4467
				}
4468
			}
4469
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4470
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4471
		}
4472
4473
		return (bool) $ssl;
4474
	}
4475
4476
	/*
4477
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4478
	 */
4479
	public function alert_auto_ssl_fail() {
4480
		if ( ! current_user_can( 'manage_options' ) )
4481
			return;
4482
4483
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4484
		?>
4485
4486
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4487
			<div class="jp-banner__content">
4488
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4489
				<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>
4490
				<p>
4491
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4492
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4493
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4494
				</p>
4495
				<p>
4496
					<?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' ),
4497
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4498
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4499
				</p>
4500
			</div>
4501
		</div>
4502
		<style>
4503
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4504
		</style>
4505
		<script type="text/javascript">
4506
			jQuery( document ).ready( function( $ ) {
4507
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4508
					var $this = $( this );
4509
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4510
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4511
					e.preventDefault();
4512
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4513
					$.post( ajaxurl, data )
4514
					  .done( function( response ) {
4515
					  	if ( response.enabled ) {
4516
					  		$( '#jetpack-ssl-warning' ).hide();
4517
					  	} else {
4518
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4519
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4520
					  	}
4521
					  }.bind( $this ) );
4522
				} );
4523
			} );
4524
		</script>
4525
4526
		<?php
4527
	}
4528
4529
	/**
4530
	 * Returns the Jetpack XML-RPC API
4531
	 *
4532
	 * @return string
4533
	 */
4534
	public static function xmlrpc_api_url() {
4535
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4536
		return untrailingslashit( $base ) . '/xmlrpc.php';
4537
	}
4538
4539
	/**
4540
	 * Creates two secret tokens and the end of life timestamp for them.
4541
	 *
4542
	 * Note these tokens are unique per call, NOT static per site for connecting.
4543
	 *
4544
	 * @since 2.6
4545
	 * @return array
4546
	 */
4547
	public function generate_secrets( $action, $exp = 600 ) {
4548
	    $secret = wp_generate_password( 32, false ) // secret_1
4549
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4550
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4551
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4552
		Jetpack_Options::update_option( $action, $secret );
4553
	    return Jetpack_Options::get_option( $action );
4554
	}
4555
4556
	/**
4557
	 * Builds the timeout limit for queries talking with the wpcom servers.
4558
	 *
4559
	 * Based on local php max_execution_time in php.ini
4560
	 *
4561
	 * @since 2.6
4562
	 * @return int
4563
	 **/
4564
	public function get_remote_query_timeout_limit() {
4565
	    $timeout = (int) ini_get( 'max_execution_time' );
4566
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4567
				$timeout = 30;
4568
	    return intval( $timeout / 2 );
4569
	}
4570
4571
4572
	/**
4573
	 * Takes the response from the Jetpack register new site endpoint and
4574
	 * verifies it worked properly.
4575
	 *
4576
	 * @since 2.6
4577
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4578
	 **/
4579
	public function validate_remote_register_response( $response ) {
4580
	  if ( is_wp_error( $response ) ) {
4581
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4582
		}
4583
4584
		$code   = wp_remote_retrieve_response_code( $response );
4585
		$entity = wp_remote_retrieve_body( $response );
4586
		if ( $entity )
4587
			$registration_response = json_decode( $entity );
4588
		else
4589
			$registration_response = false;
4590
4591
		$code_type = intval( $code / 100 );
4592
		if ( 5 == $code_type ) {
4593
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4594
		} elseif ( 408 == $code ) {
4595
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4596
		} elseif ( ! empty( $registration_response->error ) ) {
4597
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4598
				$error_description = __( "PHP's XML extension is not available. Jetpack requires the XML extension to communicate with WordPress.com. Please contact your hosting provider to enable PHP's XML extension.", 'jetpack' );
4599
			} else {
4600
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4601
			}
4602
4603
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4604
		} elseif ( 200 != $code ) {
4605
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4606
		}
4607
4608
		// Jetpack ID error block
4609
		if ( empty( $registration_response->jetpack_id ) ) {
4610
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4611
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4612
			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 );
4613
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4614
			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 );
4615
		}
4616
4617
	    return $registration_response;
4618
	}
4619
	/**
4620
	 * @return bool|WP_Error
4621
	 */
4622
	public static function register() {
4623
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4624
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4625
4626
		@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...
4627 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4628
			return new Jetpack_Error( 'missing_secrets' );
4629
		}
4630
4631
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4632
4633
		$gmt_offset = get_option( 'gmt_offset' );
4634
		if ( ! $gmt_offset ) {
4635
			$gmt_offset = 0;
4636
		}
4637
4638
		$stats_options = get_option( 'stats_options' );
4639
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4640
4641
		$args = array(
4642
			'method'  => 'POST',
4643
			'body'    => array(
4644
				'siteurl'         => site_url(),
4645
				'home'            => home_url(),
4646
				'gmt_offset'      => $gmt_offset,
4647
				'timezone_string' => (string) get_option( 'timezone_string' ),
4648
				'site_name'       => (string) get_option( 'blogname' ),
4649
				'secret_1'        => $secret_1,
4650
				'secret_2'        => $secret_2,
4651
				'site_lang'       => get_locale(),
4652
				'timeout'         => $timeout,
4653
				'stats_id'        => $stats_id,
4654
				'state'           => get_current_user_id(),
4655
			),
4656
			'headers' => array(
4657
				'Accept' => 'application/json',
4658
			),
4659
			'timeout' => $timeout,
4660
		);
4661
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4662
4663
		// Make sure the response is valid and does not contain any Jetpack errors
4664
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4665
		if ( is_wp_error( $registration_details ) ) {
4666
		    return $registration_details;
4667
		} elseif ( ! $registration_details ) {
4668
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4669
		}
4670
4671 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4672
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4673
		}
4674
4675
		if ( isset( $registration_details->jetpack_public ) ) {
4676
			$jetpack_public = (int) $registration_details->jetpack_public;
4677
		} else {
4678
			$jetpack_public = false;
4679
		}
4680
4681
		Jetpack_Options::update_options(
4682
			array(
4683
				'id'         => (int)    $registration_details->jetpack_id,
4684
				'blog_token' => (string) $registration_details->jetpack_secret,
4685
				'public'     => $jetpack_public,
4686
			)
4687
		);
4688
4689
		/**
4690
		 * Fires when a site is registered on WordPress.com.
4691
		 *
4692
		 * @since 3.7.0
4693
		 *
4694
		 * @param int $json->jetpack_id Jetpack Blog ID.
4695
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4696
		 * @param int|bool $jetpack_public Is the site public.
4697
		 */
4698
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4699
4700
		// Initialize Jump Start for the first and only time.
4701
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4702
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4703
4704
			$jetpack = Jetpack::init();
4705
4706
			$jetpack->stat( 'jumpstart', 'unique-views' );
4707
			$jetpack->do_stats( 'server_side' );
4708
		};
4709
4710
		return true;
4711
	}
4712
4713
	/**
4714
	 * If the db version is showing something other that what we've got now, bump it to current.
4715
	 *
4716
	 * @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...
4717
	 */
4718
	public static function maybe_set_version_option() {
4719
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4720
		if ( JETPACK__VERSION != $version ) {
4721
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4722
4723
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4724
				/** This action is documented in class.jetpack.php */
4725
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4726
			}
4727
4728
			return true;
4729
		}
4730
		return false;
4731
	}
4732
4733
/* Client Server API */
4734
4735
	/**
4736
	 * Loads the Jetpack XML-RPC client
4737
	 */
4738
	public static function load_xml_rpc_client() {
4739
		require_once ABSPATH . WPINC . '/class-IXR.php';
4740
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4741
	}
4742
4743
	/**
4744
	 * Resets the saved authentication state in between testing requests.
4745
	 */
4746
	public function reset_saved_auth_state() {
4747
		$this->xmlrpc_verification = null;
4748
		$this->rest_authentication_status = null;
4749
	}
4750
4751
	function verify_xml_rpc_signature() {
4752
		if ( $this->xmlrpc_verification ) {
4753
			return $this->xmlrpc_verification;
4754
		}
4755
4756
		// It's not for us
4757
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4758
			return false;
4759
		}
4760
4761
		@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...
4762
		if (
4763
			empty( $token_key )
4764
		||
4765
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4766
		) {
4767
			return false;
4768
		}
4769
4770
		if ( '0' === $user_id ) {
4771
			$token_type = 'blog';
4772
			$user_id = 0;
4773
		} else {
4774
			$token_type = 'user';
4775
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4776
				return false;
4777
			}
4778
			$user_id = (int) $user_id;
4779
4780
			$user = new WP_User( $user_id );
4781
			if ( ! $user || ! $user->exists() ) {
4782
				return false;
4783
			}
4784
		}
4785
4786
		$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...
4787
		if ( ! $token ) {
4788
			return false;
4789
		}
4790
4791
		$token_check = "$token_key.";
4792
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4793
			return false;
4794
		}
4795
4796
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4797
4798
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4799
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4800
			$post_data   = $_POST;
4801
			$file_hashes = array();
4802
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4803
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4804
					continue;
4805
				}
4806
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4807
				$file_hashes[$post_data_key] = $post_data_value;
4808
			}
4809
4810
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4811
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4812
				$post_data[$post_data_key] = $post_data_value;
4813
			}
4814
4815
			ksort( $post_data );
4816
4817
			$body = http_build_query( stripslashes_deep( $post_data ) );
4818
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4819
			$body = file_get_contents( 'php://input' );
4820
		} else {
4821
			$body = null;
4822
		}
4823
4824
		$signature = $jetpack_signature->sign_current_request(
4825
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4826
		);
4827
4828
		if ( ! $signature ) {
4829
			return false;
4830
		} else if ( is_wp_error( $signature ) ) {
4831
			return $signature;
4832
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4833
			return false;
4834
		}
4835
4836
		$timestamp = (int) $_GET['timestamp'];
4837
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4838
4839
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4840
			return false;
4841
		}
4842
4843
		$this->xmlrpc_verification = array(
4844
			'type'    => $token_type,
4845
			'user_id' => $token->external_user_id,
4846
		);
4847
4848
		return $this->xmlrpc_verification;
4849
	}
4850
4851
	/**
4852
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4853
	 */
4854
	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...
4855
		if ( is_a( $user, 'WP_User' ) ) {
4856
			return $user;
4857
		}
4858
4859
		$token_details = $this->verify_xml_rpc_signature();
4860
4861
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4862
			return $user;
4863
		}
4864
4865
		if ( 'user' !== $token_details['type'] ) {
4866
			return $user;
4867
		}
4868
4869
		if ( ! $token_details['user_id'] ) {
4870
			return $user;
4871
		}
4872
4873
		nocache_headers();
4874
4875
		return new WP_User( $token_details['user_id'] );
4876
	}
4877
4878
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4879
	// Uses the existing XMLRPC request signing implementation.
4880
	function wp_rest_authenticate( $user ) {
4881
		if ( ! empty( $user ) ) {
4882
			// Another authentication method is in effect.
4883
			return $user;
4884
		}
4885
4886
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4887
			// Nothing to do for this authentication method.
4888
			return null;
4889
		}
4890
4891
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4892
			// Nothing to do for this authentication method.
4893
			return null;
4894
		}
4895
4896
		// Ensure that we always have the request body available.  At this
4897
		// point, the WP REST API code to determine the request body has not
4898
		// run yet.  That code may try to read from 'php://input' later, but
4899
		// this can only be done once per request in PHP versions prior to 5.6.
4900
		// So we will go ahead and perform this read now if needed, and save
4901
		// the request body where both the Jetpack signature verification code
4902
		// and the WP REST API code can see it.
4903
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4904
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4905
		}
4906
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4907
4908
		// Only support specific request parameters that have been tested and
4909
		// are known to work with signature verification.  A different method
4910
		// can be passed to the WP REST API via the '?_method=' parameter if
4911
		// needed.
4912
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4913
			$this->rest_authentication_status = new WP_Error(
4914
				'rest_invalid_request',
4915
				__( 'This request method is not supported.', 'jetpack' ),
4916
				array( 'status' => 400 )
4917
			);
4918
			return null;
4919
		}
4920
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
4921
			$this->rest_authentication_status = new WP_Error(
4922
				'rest_invalid_request',
4923
				__( 'This request method does not support body parameters.', 'jetpack' ),
4924
				array( 'status' => 400 )
4925
			);
4926
			return null;
4927
		}
4928
4929
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
4930
			$content_type = $_SERVER['CONTENT_TYPE'];
4931
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
4932
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
4933
		}
4934
4935
		if (
4936
			isset( $content_type ) &&
4937
			$content_type !== 'application/x-www-form-urlencoded' &&
4938
			$content_type !== 'application/json'
4939
		) {
4940
			$this->rest_authentication_status = new WP_Error(
4941
				'rest_invalid_request',
4942
				__( 'This Content-Type is not supported.', 'jetpack' ),
4943
				array( 'status' => 400 )
4944
			);
4945
			return null;
4946
		}
4947
4948
		$verified = $this->verify_xml_rpc_signature();
4949
4950
		if ( is_wp_error( $verified ) ) {
4951
			$this->rest_authentication_status = $verified;
4952
			return null;
4953
		}
4954
4955
		if (
4956
			$verified &&
4957
			isset( $verified['type'] ) &&
4958
			'user' === $verified['type'] &&
4959
			! empty( $verified['user_id'] )
4960
		) {
4961
			// Authentication successful.
4962
			$this->rest_authentication_status = true;
4963
			return $verified['user_id'];
4964
		}
4965
4966
		// Something else went wrong.  Probably a signature error.
4967
		$this->rest_authentication_status = new WP_Error(
4968
			'rest_invalid_signature',
4969
			__( 'The request is not signed correctly.', 'jetpack' ),
4970
			array( 'status' => 400 )
4971
		);
4972
		return null;
4973
	}
4974
4975
	/**
4976
	 * Report authentication status to the WP REST API.
4977
	 *
4978
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
4979
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
4980
	 */
4981
	public function wp_rest_authentication_errors( $value ) {
4982
		if ( $value !== null ) {
4983
			return $value;
4984
		}
4985
		return $this->rest_authentication_status;
4986
	}
4987
4988
	function add_nonce( $timestamp, $nonce ) {
4989
		global $wpdb;
4990
		static $nonces_used_this_request = array();
4991
4992
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
4993
			return $nonces_used_this_request["$timestamp:$nonce"];
4994
		}
4995
4996
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
4997
		$timestamp = (int) $timestamp;
4998
		$nonce     = esc_sql( $nonce );
4999
5000
		// Raw query so we can avoid races: add_option will also update
5001
		$show_errors = $wpdb->show_errors( false );
5002
5003
		$old_nonce = $wpdb->get_row(
5004
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5005
		);
5006
5007
		if ( is_null( $old_nonce ) ) {
5008
			$return = $wpdb->query(
5009
				$wpdb->prepare(
5010
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5011
					"jetpack_nonce_{$timestamp}_{$nonce}",
5012
					time(),
5013
					'no'
5014
				)
5015
			);
5016
		} else {
5017
			$return = false;
5018
		}
5019
5020
		$wpdb->show_errors( $show_errors );
5021
5022
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5023
5024
		return $return;
5025
	}
5026
5027
	/**
5028
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5029
	 * Capture it here so we can verify the signature later.
5030
	 */
5031
	function xmlrpc_methods( $methods ) {
5032
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5033
		return $methods;
5034
	}
5035
5036
	function public_xmlrpc_methods( $methods ) {
5037
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5038
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5039
		}
5040
		return $methods;
5041
	}
5042
5043
	function jetpack_getOptions( $args ) {
5044
		global $wp_xmlrpc_server;
5045
5046
		$wp_xmlrpc_server->escape( $args );
5047
5048
		$username	= $args[1];
5049
		$password	= $args[2];
5050
5051
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5052
			return $wp_xmlrpc_server->error;
5053
		}
5054
5055
		$options = array();
5056
		$user_data = $this->get_connected_user_data();
5057
		if ( is_array( $user_data ) ) {
5058
			$options['jetpack_user_id'] = array(
5059
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5060
				'readonly'      => true,
5061
				'value'         => $user_data['ID'],
5062
			);
5063
			$options['jetpack_user_login'] = array(
5064
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5065
				'readonly'      => true,
5066
				'value'         => $user_data['login'],
5067
			);
5068
			$options['jetpack_user_email'] = array(
5069
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5070
				'readonly'      => true,
5071
				'value'         => $user_data['email'],
5072
			);
5073
			$options['jetpack_user_site_count'] = array(
5074
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5075
				'readonly'      => true,
5076
				'value'         => $user_data['site_count'],
5077
			);
5078
		}
5079
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5080
		$args = stripslashes_deep( $args );
5081
		return $wp_xmlrpc_server->wp_getOptions( $args );
5082
	}
5083
5084
	function xmlrpc_options( $options ) {
5085
		$jetpack_client_id = false;
5086
		if ( self::is_active() ) {
5087
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5088
		}
5089
		$options['jetpack_version'] = array(
5090
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5091
				'readonly'      => true,
5092
				'value'         => JETPACK__VERSION,
5093
		);
5094
5095
		$options['jetpack_client_id'] = array(
5096
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5097
				'readonly'      => true,
5098
				'value'         => $jetpack_client_id,
5099
		);
5100
		return $options;
5101
	}
5102
5103
	public static function clean_nonces( $all = false ) {
5104
		global $wpdb;
5105
5106
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5107
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5108
5109
		if ( true !== $all ) {
5110
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5111
			$sql_args[] = time() - 3600;
5112
		}
5113
5114
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5115
5116
		$sql = $wpdb->prepare( $sql, $sql_args );
5117
5118
		for ( $i = 0; $i < 1000; $i++ ) {
5119
			if ( ! $wpdb->query( $sql ) ) {
5120
				break;
5121
			}
5122
		}
5123
	}
5124
5125
	/**
5126
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5127
	 * SET: state( $key, $value );
5128
	 * GET: $value = state( $key );
5129
	 *
5130
	 * @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...
5131
	 * @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...
5132
	 * @param bool $restate private
5133
	 */
5134
	public static function state( $key = null, $value = null, $restate = false ) {
5135
		static $state = array();
5136
		static $path, $domain;
5137
		if ( ! isset( $path ) ) {
5138
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5139
			$admin_url = Jetpack::admin_url();
5140
			$bits      = parse_url( $admin_url );
5141
5142
			if ( is_array( $bits ) ) {
5143
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5144
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5145
			} else {
5146
				$path = $domain = null;
5147
			}
5148
		}
5149
5150
		// Extract state from cookies and delete cookies
5151
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5152
			$yum = $_COOKIE[ 'jetpackState' ];
5153
			unset( $_COOKIE[ 'jetpackState' ] );
5154
			foreach ( $yum as $k => $v ) {
5155
				if ( strlen( $v ) )
5156
					$state[ $k ] = $v;
5157
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5158
			}
5159
		}
5160
5161
		if ( $restate ) {
5162
			foreach ( $state as $k => $v ) {
5163
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5164
			}
5165
			return;
5166
		}
5167
5168
		// Get a state variable
5169
		if ( isset( $key ) && ! isset( $value ) ) {
5170
			if ( array_key_exists( $key, $state ) )
5171
				return $state[ $key ];
5172
			return null;
5173
		}
5174
5175
		// Set a state variable
5176
		if ( isset ( $key ) && isset( $value ) ) {
5177
			if( is_array( $value ) && isset( $value[0] ) ) {
5178
				$value = $value[0];
5179
			}
5180
			$state[ $key ] = $value;
5181
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5182
		}
5183
	}
5184
5185
	public static function restate() {
5186
		Jetpack::state( null, null, true );
5187
	}
5188
5189
	public static function check_privacy( $file ) {
5190
		static $is_site_publicly_accessible = null;
5191
5192
		if ( is_null( $is_site_publicly_accessible ) ) {
5193
			$is_site_publicly_accessible = false;
5194
5195
			Jetpack::load_xml_rpc_client();
5196
			$rpc = new Jetpack_IXR_Client();
5197
5198
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5199
			if ( $success ) {
5200
				$response = $rpc->getResponse();
5201
				if ( $response ) {
5202
					$is_site_publicly_accessible = true;
5203
				}
5204
			}
5205
5206
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5207
		}
5208
5209
		if ( $is_site_publicly_accessible ) {
5210
			return;
5211
		}
5212
5213
		$module_slug = self::get_module_slug( $file );
5214
5215
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5216
		if ( ! $privacy_checks ) {
5217
			$privacy_checks = $module_slug;
5218
		} else {
5219
			$privacy_checks .= ",$module_slug";
5220
		}
5221
5222
		Jetpack::state( 'privacy_checks', $privacy_checks );
5223
	}
5224
5225
	/**
5226
	 * Helper method for multicall XMLRPC.
5227
	 */
5228
	public static function xmlrpc_async_call() {
5229
		global $blog_id;
5230
		static $clients = array();
5231
5232
		$client_blog_id = is_multisite() ? $blog_id : 0;
5233
5234
		if ( ! isset( $clients[$client_blog_id] ) ) {
5235
			Jetpack::load_xml_rpc_client();
5236
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5237
			if ( function_exists( 'ignore_user_abort' ) ) {
5238
				ignore_user_abort( true );
5239
			}
5240
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5241
		}
5242
5243
		$args = func_get_args();
5244
5245
		if ( ! empty( $args[0] ) ) {
5246
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5247
		} elseif ( is_multisite() ) {
5248
			foreach ( $clients as $client_blog_id => $client ) {
5249
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5250
					continue;
5251
				}
5252
5253
				$switch_success = switch_to_blog( $client_blog_id, true );
5254
				if ( ! $switch_success ) {
5255
					continue;
5256
				}
5257
5258
				flush();
5259
				$client->query();
5260
5261
				restore_current_blog();
5262
			}
5263
		} else {
5264
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5265
				flush();
5266
				$clients[0]->query();
5267
			}
5268
		}
5269
	}
5270
5271
	public static function staticize_subdomain( $url ) {
5272
5273
		// Extract hostname from URL
5274
		$host = parse_url( $url, PHP_URL_HOST );
5275
5276
		// Explode hostname on '.'
5277
		$exploded_host = explode( '.', $host );
5278
5279
		// Retrieve the name and TLD
5280
		if ( count( $exploded_host ) > 1 ) {
5281
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5282
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5283
			// Rebuild domain excluding subdomains
5284
			$domain = $name . '.' . $tld;
5285
		} else {
5286
			$domain = $host;
5287
		}
5288
		// Array of Automattic domains
5289
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5290
5291
		// Return $url if not an Automattic domain
5292
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5293
			return $url;
5294
		}
5295
5296
		if ( is_ssl() ) {
5297
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5298
		}
5299
5300
		srand( crc32( basename( $url ) ) );
5301
		$static_counter = rand( 0, 2 );
5302
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5303
5304
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5305
	}
5306
5307
/* JSON API Authorization */
5308
5309
	/**
5310
	 * Handles the login action for Authorizing the JSON API
5311
	 */
5312
	function login_form_json_api_authorization() {
5313
		$this->verify_json_api_authorization_request();
5314
5315
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5316
5317
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5318
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5319
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5320
	}
5321
5322
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5323
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5324
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5325
			return $url;
5326
		}
5327
5328
		$parsed_url = parse_url( $url );
5329
		$url = strtok( $url, '?' );
5330
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5331
		if ( ! empty( $parsed_url['query'] ) )
5332
			$url .= "&{$parsed_url['query']}";
5333
5334
		return $url;
5335
	}
5336
5337
	// Make sure the POSTed request is handled by the same action
5338
	function preserve_action_in_login_form_for_json_api_authorization() {
5339
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5340
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5341
	}
5342
5343
	// If someone logs in to approve API access, store the Access Code in usermeta
5344
	function store_json_api_authorization_token( $user_login, $user ) {
5345
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5346
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5347
		$token = wp_generate_password( 32, false );
5348
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5349
	}
5350
5351
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5352
	function allow_wpcom_public_api_domain( $domains ) {
5353
		$domains[] = 'public-api.wordpress.com';
5354
		return $domains;
5355
	}
5356
5357
	// Add the Access Code details to the public-api.wordpress.com redirect
5358
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5359
		return add_query_arg(
5360
			urlencode_deep(
5361
				array(
5362
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5363
					'jetpack-user-id' => (int) $user->ID,
5364
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5365
				)
5366
			),
5367
			$redirect_to
5368
		);
5369
	}
5370
5371
5372
	/**
5373
	 * Verifies the request by checking the signature
5374
	 *
5375
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5376
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5377
	 *
5378
	 * @param null|array $environment
5379
	 */
5380
	function verify_json_api_authorization_request( $environment = null ) {
5381
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5382
5383
		$environment = is_null( $environment )
5384
			? $_REQUEST
5385
			: $environment;
5386
5387
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken is unused. Consider omitting it like so list($first,,$third).

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

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

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

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