Completed
Push — update/react-create-class ( 7f3c72...120f37 )
by
unknown
257:16 queued 246:39
created

Jetpack::plugin_upgrade()   C

Complexity

Conditions 8
Paths 19

Size

Total Lines 43
Code Lines 22

Duplication

Lines 0
Ratio 0 %

Importance

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
704
705
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
706
	}
707
708
	function point_edit_comment_links_to_calypso( $url ) {
709
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
710
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
711
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
712
			Jetpack::build_raw_urls( get_home_url() ),
713
			$query_args['amp;c']
714
		) );
715
	}
716
717
	function jetpack_track_last_sync_callback( $params ) {
718
		/**
719
		 * Filter to turn off jitm caching
720
		 *
721
		 * @since 5.4.0
722
		 *
723
		 * @param bool false Whether to cache just in time messages
724
		 */
725
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
726
			return $params;
727
		}
728
729
		if ( is_array( $params ) && isset( $params[0] ) ) {
730
			$option = $params[0];
731
			if ( 'active_plugins' === $option ) {
732
				// use the cache if we can, but not terribly important if it gets evicted
733
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
734
			}
735
		}
736
737
		return $params;
738
	}
739
740
	function jetpack_connection_banner_callback() {
741
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
742
743
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
744
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
745
			wp_send_json_success();
746
		}
747
748
		wp_die();
749
	}
750
751
	function jetpack_admin_ajax_tracks_callback() {
752
		// Check for nonce
753
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
754
			wp_die( 'Permissions check failed.' );
755
		}
756
757
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
758
			wp_die( 'No valid event name or type.' );
759
		}
760
761
		$tracks_data = array();
762
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
763
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
764
				$tracks_data = $_REQUEST['tracksEventProp'];
765
			} else {
766
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
767
			}
768
		}
769
770
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
771
		wp_send_json_success();
772
		wp_die();
773
	}
774
775
	/**
776
	 * The callback for the JITM ajax requests.
777
	 */
778
	function jetpack_jitm_ajax_callback() {
779
		// Check for nonce
780
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
781
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
782
		}
783
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
784
			$module_slug = $_REQUEST['jitmModule'];
785
			Jetpack::log( 'activate', $module_slug );
786
			Jetpack::activate_module( $module_slug, false, false );
787
			Jetpack::state( 'message', 'no_message' );
788
789
			//A Jetpack module is being activated through a JITM, track it
790
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
791
			$this->do_stats( 'server_side' );
792
793
			wp_send_json_success();
794
		}
795
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
796
			// get the hide_jitm options array
797
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
798
			$module_slug = $_REQUEST['jitmModule'];
799
800
			if( ! $jetpack_hide_jitm ) {
801
				$jetpack_hide_jitm = array(
802
					$module_slug => 'hide'
803
				);
804
			} else {
805
				$jetpack_hide_jitm[$module_slug] = 'hide';
806
			}
807
808
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
809
810
			//jitm is being dismissed forever, track it
811
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
812
			$this->do_stats( 'server_side' );
813
814
			wp_send_json_success();
815
		}
816 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
817
			$module_slug = $_REQUEST['jitmModule'];
818
819
			// User went to WordPress.com, track this
820
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
821
			$this->do_stats( 'server_side' );
822
823
			wp_send_json_success();
824
		}
825 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
826
			$track = $_REQUEST['jitmModule'];
827
828
			// User is viewing JITM, track it.
829
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
830
			$this->do_stats( 'server_side' );
831
832
			wp_send_json_success();
833
		}
834
	}
835
836
	/**
837
	 * If there are any stats that need to be pushed, but haven't been, push them now.
838
	 */
839
	function push_stats() {
840
		if ( ! empty( $this->stats ) ) {
841
			$this->do_stats( 'server_side' );
842
		}
843
	}
844
845
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
846
		switch( $cap ) {
847
			case 'jetpack_connect' :
848
			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...
849
				if ( Jetpack::is_development_mode() ) {
850
					$caps = array( 'do_not_allow' );
851
					break;
852
				}
853
				/**
854
				 * Pass through. If it's not development mode, these should match disconnect.
855
				 * Let users disconnect if it's development mode, just in case things glitch.
856
				 */
857
			case 'jetpack_disconnect' :
858
				/**
859
				 * In multisite, can individual site admins manage their own connection?
860
				 *
861
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
862
				 */
863
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
864
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
865
						/**
866
						 * We need to update the option name -- it's terribly unclear which
867
						 * direction the override goes.
868
						 *
869
						 * @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...
870
						 */
871
						$caps = array( 'do_not_allow' );
872
						break;
873
					}
874
				}
875
876
				$caps = array( 'manage_options' );
877
				break;
878
			case 'jetpack_manage_modules' :
879
			case 'jetpack_activate_modules' :
880
			case 'jetpack_deactivate_modules' :
881
				$caps = array( 'manage_options' );
882
				break;
883
			case 'jetpack_configure_modules' :
884
				$caps = array( 'manage_options' );
885
				break;
886
			case 'jetpack_network_admin_page':
887
			case 'jetpack_network_settings_page':
888
				$caps = array( 'manage_network_plugins' );
889
				break;
890
			case 'jetpack_network_sites_page':
891
				$caps = array( 'manage_sites' );
892
				break;
893
			case 'jetpack_admin_page' :
894
				if ( Jetpack::is_development_mode() ) {
895
					$caps = array( 'manage_options' );
896
					break;
897
				} else {
898
					$caps = array( 'read' );
899
				}
900
				break;
901
			case 'jetpack_connect_user' :
902
				if ( Jetpack::is_development_mode() ) {
903
					$caps = array( 'do_not_allow' );
904
					break;
905
				}
906
				$caps = array( 'read' );
907
				break;
908
		}
909
		return $caps;
910
	}
911
912
	function require_jetpack_authentication() {
913
		// Don't let anyone authenticate
914
		$_COOKIE = array();
915
		remove_all_filters( 'authenticate' );
916
		remove_all_actions( 'wp_login_failed' );
917
918
		if ( Jetpack::is_active() ) {
919
			// Allow Jetpack authentication
920
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
921
		}
922
	}
923
924
	/**
925
	 * Load language files
926
	 * @action plugins_loaded
927
	 */
928
	public static function plugin_textdomain() {
929
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
930
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
931
	}
932
933
	/**
934
	 * Register assets for use in various modules and the Jetpack admin page.
935
	 *
936
	 * @uses wp_script_is, wp_register_script, plugins_url
937
	 * @action wp_loaded
938
	 * @return null
939
	 */
940
	public function register_assets() {
941
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
942
			wp_register_script(
943
				'spin',
944
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
945
				false,
946
				'1.3'
947
			);
948
		}
949
950
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
951
			wp_register_script(
952
				'jquery.spin',
953
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
954
				array( 'jquery', 'spin' ),
955
				'1.3'
956
			);
957
		}
958
959 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
960
			wp_register_script(
961
				'jetpack-gallery-settings',
962
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
963
				array( 'media-views' ),
964
				'20121225'
965
			);
966
		}
967
968
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
969
			wp_register_script(
970
				'jetpack-twitter-timeline',
971
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
972
				array( 'jquery' ),
973
				'4.0.0',
974
				true
975
			);
976
		}
977
978
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
979
			wp_register_script(
980
				'jetpack-facebook-embed',
981
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
982
				array( 'jquery' ),
983
				null,
984
				true
985
			);
986
987
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
988
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
989
			if ( ! is_numeric( $fb_app_id ) ) {
990
				$fb_app_id = '';
991
			}
992
			wp_localize_script(
993
				'jetpack-facebook-embed',
994
				'jpfbembed',
995
				array(
996
					'appid' => $fb_app_id,
997
					'locale' => $this->get_locale(),
998
				)
999
			);
1000
		}
1001
1002
		/**
1003
		 * As jetpack_register_genericons is by default fired off a hook,
1004
		 * the hook may have already fired by this point.
1005
		 * So, let's just trigger it manually.
1006
		 */
1007
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1008
		jetpack_register_genericons();
1009
1010
		/**
1011
		 * Register the social logos
1012
		 */
1013
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1014
		jetpack_register_social_logos();
1015
1016 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1017
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1018
	}
1019
1020
	/**
1021
	 * Guess locale from language code.
1022
	 *
1023
	 * @param string $lang Language code.
1024
	 * @return string|bool
1025
	 */
1026
	function guess_locale_from_lang( $lang ) {
1027
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1028
			return 'en_US';
1029
		}
1030
1031 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1032
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1033
				return false;
1034
			}
1035
1036
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1037
		}
1038
1039
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1040
			// WP.com: get_locale() returns 'it'
1041
			$locale = GP_Locales::by_slug( $lang );
1042
		} else {
1043
			// Jetpack: get_locale() returns 'it_IT';
1044
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1045
		}
1046
1047
		if ( ! $locale ) {
1048
			return false;
1049
		}
1050
1051
		if ( empty( $locale->facebook_locale ) ) {
1052
			if ( empty( $locale->wp_locale ) ) {
1053
				return false;
1054
			} else {
1055
				// Facebook SDK is smart enough to fall back to en_US if a
1056
				// locale isn't supported. Since supported Facebook locales
1057
				// can fall out of sync, we'll attempt to use the known
1058
				// wp_locale value and rely on said fallback.
1059
				return $locale->wp_locale;
1060
			}
1061
		}
1062
1063
		return $locale->facebook_locale;
1064
	}
1065
1066
	/**
1067
	 * Get the locale.
1068
	 *
1069
	 * @return string|bool
1070
	 */
1071
	function get_locale() {
1072
		$locale = $this->guess_locale_from_lang( get_locale() );
1073
1074
		if ( ! $locale ) {
1075
			$locale = 'en_US';
1076
		}
1077
1078
		return $locale;
1079
	}
1080
1081
	/**
1082
	 * Device Pixels support
1083
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1084
	 */
1085
	function devicepx() {
1086
		if ( Jetpack::is_active() ) {
1087
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1088
		}
1089
	}
1090
1091
	/**
1092
	 * Return the network_site_url so that .com knows what network this site is a part of.
1093
	 * @param  bool $option
1094
	 * @return string
1095
	 */
1096
	public function jetpack_main_network_site_option( $option ) {
1097
		return network_site_url();
1098
	}
1099
	/**
1100
	 * Network Name.
1101
	 */
1102
	static function network_name( $option = null ) {
1103
		global $current_site;
1104
		return $current_site->site_name;
1105
	}
1106
	/**
1107
	 * Does the network allow new user and site registrations.
1108
	 * @return string
1109
	 */
1110
	static function network_allow_new_registrations( $option = null ) {
1111
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1112
	}
1113
	/**
1114
	 * Does the network allow admins to add new users.
1115
	 * @return boolian
1116
	 */
1117
	static function network_add_new_users( $option = null ) {
1118
		return (bool) get_site_option( 'add_new_users' );
1119
	}
1120
	/**
1121
	 * File upload psace left per site in MB.
1122
	 *  -1 means NO LIMIT.
1123
	 * @return number
1124
	 */
1125
	static function network_site_upload_space( $option = null ) {
1126
		// value in MB
1127
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1128
	}
1129
1130
	/**
1131
	 * Network allowed file types.
1132
	 * @return string
1133
	 */
1134
	static function network_upload_file_types( $option = null ) {
1135
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1136
	}
1137
1138
	/**
1139
	 * Maximum file upload size set by the network.
1140
	 * @return number
1141
	 */
1142
	static function network_max_upload_file_size( $option = null ) {
1143
		// value in KB
1144
		return get_site_option( 'fileupload_maxk', 300 );
1145
	}
1146
1147
	/**
1148
	 * Lets us know if a site allows admins to manage the network.
1149
	 * @return array
1150
	 */
1151
	static function network_enable_administration_menus( $option = null ) {
1152
		return get_site_option( 'menu_items' );
1153
	}
1154
1155
	/**
1156
	 * If a user has been promoted to or demoted from admin, we need to clear the
1157
	 * jetpack_other_linked_admins transient.
1158
	 *
1159
	 * @since 4.3.2
1160
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1161
	 *
1162
	 * @param int    $user_id   The user ID whose role changed.
1163
	 * @param string $role      The new role.
1164
	 * @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...
1165
	 */
1166
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1167
		if ( 'administrator' == $role
1168
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1169
			|| is_null( $old_roles )
1170
		) {
1171
			delete_transient( 'jetpack_other_linked_admins' );
1172
		}
1173
	}
1174
1175
	/**
1176
	 * Checks to see if there are any other users available to become primary
1177
	 * Users must both:
1178
	 * - Be linked to wpcom
1179
	 * - Be an admin
1180
	 *
1181
	 * @return mixed False if no other users are linked, Int if there are.
1182
	 */
1183
	static function get_other_linked_admins() {
1184
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1185
1186
		if ( false === $other_linked_users ) {
1187
			$admins = get_users( array( 'role' => 'administrator' ) );
1188
			if ( count( $admins ) > 1 ) {
1189
				$available = array();
1190
				foreach ( $admins as $admin ) {
1191
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1192
						$available[] = $admin->ID;
1193
					}
1194
				}
1195
1196
				$count_connected_admins = count( $available );
1197
				if ( count( $available ) > 1 ) {
1198
					$other_linked_users = $count_connected_admins;
1199
				} else {
1200
					$other_linked_users = 0;
1201
				}
1202
			} else {
1203
				$other_linked_users = 0;
1204
			}
1205
1206
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1207
		}
1208
1209
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1210
	}
1211
1212
	/**
1213
	 * Return whether we are dealing with a multi network setup or not.
1214
	 * The reason we are type casting this is because we want to avoid the situation where
1215
	 * the result is false since when is_main_network_option return false it cases
1216
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1217
	 * database which could be set to anything as opposed to what this function returns.
1218
	 * @param  bool  $option
1219
	 *
1220
	 * @return boolean
1221
	 */
1222
	public function is_main_network_option( $option ) {
1223
		// return '1' or ''
1224
		return (string) (bool) Jetpack::is_multi_network();
1225
	}
1226
1227
	/**
1228
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1229
	 *
1230
	 * @param  string  $option
1231
	 * @return boolean
1232
	 */
1233
	public function is_multisite( $option ) {
1234
		return (string) (bool) is_multisite();
1235
	}
1236
1237
	/**
1238
	 * Implemented since there is no core is multi network function
1239
	 * Right now there is no way to tell if we which network is the dominant network on the system
1240
	 *
1241
	 * @since  3.3
1242
	 * @return boolean
1243
	 */
1244
	public static function is_multi_network() {
1245
		global  $wpdb;
1246
1247
		// if we don't have a multi site setup no need to do any more
1248
		if ( ! is_multisite() ) {
1249
			return false;
1250
		}
1251
1252
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1253
		if ( $num_sites > 1 ) {
1254
			return true;
1255
		} else {
1256
			return false;
1257
		}
1258
	}
1259
1260
	/**
1261
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1262
	 * @return null
1263
	 */
1264
	function update_jetpack_main_network_site_option() {
1265
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1266
	}
1267
	/**
1268
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1269
	 *
1270
	 */
1271
	function update_jetpack_network_settings() {
1272
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1273
		// Only sync this info for the main network site.
1274
	}
1275
1276
	/**
1277
	 * Get back if the current site is single user site.
1278
	 *
1279
	 * @return bool
1280
	 */
1281
	public static function is_single_user_site() {
1282
		global $wpdb;
1283
1284 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1285
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1286
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1287
		}
1288
		return 1 === (int) $some_users;
1289
	}
1290
1291
	/**
1292
	 * Returns true if the site has file write access false otherwise.
1293
	 * @return string ( '1' | '0' )
1294
	 **/
1295
	public static function file_system_write_access() {
1296
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1297
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1298
		}
1299
1300
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1301
1302
		$filesystem_method = get_filesystem_method();
1303
		if ( $filesystem_method === 'direct' ) {
1304
			return 1;
1305
		}
1306
1307
		ob_start();
1308
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1309
		ob_end_clean();
1310
		if ( $filesystem_credentials_are_stored ) {
1311
			return 1;
1312
		}
1313
		return 0;
1314
	}
1315
1316
	/**
1317
	 * Finds out if a site is using a version control system.
1318
	 * @return string ( '1' | '0' )
1319
	 **/
1320
	public static function is_version_controlled() {
1321
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1322
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1323
	}
1324
1325
	/**
1326
	 * Determines whether the current theme supports featured images or not.
1327
	 * @return string ( '1' | '0' )
1328
	 */
1329
	public static function featured_images_enabled() {
1330
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1331
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1332
	}
1333
1334
	/**
1335
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1336
	 *
1337
	 * @deprecated 4.7 use get_avatar_url instead.
1338
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1339
	 * @param int $size Size of the avatar image
1340
	 * @param string $default URL to a default image to use if no avatar is available
1341
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1342
	 *
1343
	 * @return array
1344
	 */
1345
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1346
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1347
		return get_avatar_url( $id_or_email, array(
1348
			'size' => $size,
1349
			'default' => $default,
1350
			'force_default' => $force_display,
1351
		) );
1352
	}
1353
1354
	/**
1355
	 * jetpack_updates is saved in the following schema:
1356
	 *
1357
	 * array (
1358
	 *      'plugins'                       => (int) Number of plugin updates available.
1359
	 *      'themes'                        => (int) Number of theme updates available.
1360
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1361
	 *      'translations'                  => (int) Number of translation updates available.
1362
	 *      'total'                         => (int) Total of all available updates.
1363
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1364
	 * )
1365
	 * @return array
1366
	 */
1367
	public static function get_updates() {
1368
		$update_data = wp_get_update_data();
1369
1370
		// Stores the individual update counts as well as the total count.
1371
		if ( isset( $update_data['counts'] ) ) {
1372
			$updates = $update_data['counts'];
1373
		}
1374
1375
		// If we need to update WordPress core, let's find the latest version number.
1376 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1377
			$cur = get_preferred_from_update_core();
1378
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1379
				$updates['wp_update_version'] = $cur->current;
1380
			}
1381
		}
1382
		return isset( $updates ) ? $updates : array();
1383
	}
1384
1385
	public static function get_update_details() {
1386
		$update_details = array(
1387
			'update_core' => get_site_transient( 'update_core' ),
1388
			'update_plugins' => get_site_transient( 'update_plugins' ),
1389
			'update_themes' => get_site_transient( 'update_themes' ),
1390
		);
1391
		return $update_details;
1392
	}
1393
1394
	public static function refresh_update_data() {
1395
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1396
1397
	}
1398
1399
	public static function refresh_theme_data() {
1400
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1401
	}
1402
1403
	/**
1404
	 * Is Jetpack active?
1405
	 */
1406
	public static function is_active() {
1407
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1408
	}
1409
1410
	/**
1411
	 * Make an API call to WordPress.com for plan status
1412
	 *
1413
	 * @uses Jetpack_Options::get_option()
1414
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1415
	 * @uses update_option()
1416
	 *
1417
	 * @access public
1418
	 * @static
1419
	 *
1420
	 * @return bool True if plan is updated, false if no update
1421
	 */
1422
	public static function refresh_active_plan_from_wpcom() {
1423
		// Make the API request
1424
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1425
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1426
1427
		// Bail if there was an error or malformed response
1428
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1429
			return false;
1430
		}
1431
1432
		// Decode the results
1433
		$results = json_decode( $response['body'], true );
1434
1435
		// Bail if there were no results or plan details returned
1436
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1437
			return false;
1438
		}
1439
1440
		// Store the option and return true if updated
1441
		return update_option( 'jetpack_active_plan', $results['plan'] );
1442
	}
1443
1444
	/**
1445
	 * Get the plan that this Jetpack site is currently using
1446
	 *
1447
	 * @uses get_option()
1448
	 *
1449
	 * @access public
1450
	 * @static
1451
	 *
1452
	 * @return array Active Jetpack plan details
1453
	 */
1454
	public static function get_active_plan() {
1455
		$plan = get_option( 'jetpack_active_plan', array() );
1456
1457
		// Set the default options
1458
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1459
			$plan = wp_parse_args( $plan, array(
1460
				'product_slug' => 'jetpack_free',
1461
				'supports'     => array(),
1462
				'class'        => 'free',
1463
			) );
1464
		}
1465
1466
		// Define what paid modules are supported by personal plans
1467
		$personal_plans = array(
1468
			'jetpack_personal',
1469
			'jetpack_personal_monthly',
1470
			'personal-bundle',
1471
		);
1472
1473
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1474
			$plan['supports'] = array(
1475
				'akismet',
1476
			);
1477
			$plan['class'] = 'personal';
1478
		}
1479
1480
		// Define what paid modules are supported by premium plans
1481
		$premium_plans = array(
1482
			'jetpack_premium',
1483
			'jetpack_premium_monthly',
1484
			'value_bundle',
1485
		);
1486
1487
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1488
			$plan['supports'] = array(
1489
				'videopress',
1490
				'akismet',
1491
				'vaultpress',
1492
				'wordads',
1493
			);
1494
			$plan['class'] = 'premium';
1495
		}
1496
1497
		// Define what paid modules are supported by professional plans
1498
		$business_plans = array(
1499
			'jetpack_business',
1500
			'jetpack_business_monthly',
1501
			'business-bundle',
1502
			'vip',
1503
		);
1504
1505
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1506
			$plan['supports'] = array(
1507
				'videopress',
1508
				'akismet',
1509
				'vaultpress',
1510
				'seo-tools',
1511
				'google-analytics',
1512
				'wordads',
1513
				'search',
1514
			);
1515
			$plan['class'] = 'business';
1516
		}
1517
1518
		// Make sure we have an array here in the event database data is stale
1519
		if ( ! isset( $plan['supports'] ) ) {
1520
			$plan['supports'] = array();
1521
		}
1522
1523
		return $plan;
1524
	}
1525
1526
	/**
1527
	 * Determine whether the active plan supports a particular feature
1528
	 *
1529
	 * @uses Jetpack::get_active_plan()
1530
	 *
1531
	 * @access public
1532
	 * @static
1533
	 *
1534
	 * @return bool True if plan supports feature, false if not
1535
	 */
1536
	public static function active_plan_supports( $feature ) {
1537
		$plan = Jetpack::get_active_plan();
1538
1539
		if ( in_array( $feature, $plan['supports'] ) ) {
1540
			return true;
1541
		}
1542
1543
		return false;
1544
	}
1545
1546
	/**
1547
	 * Is Jetpack in development (offline) mode?
1548
	 */
1549
	public static function is_development_mode() {
1550
		$development_mode = false;
1551
1552
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1553
			$development_mode = JETPACK_DEV_DEBUG;
1554
		} elseif ( $site_url = site_url() ) {
1555
			$development_mode = false === strpos( $site_url, '.' );
1556
		}
1557
1558
		/**
1559
		 * Filters Jetpack's development mode.
1560
		 *
1561
		 * @see https://jetpack.com/support/development-mode/
1562
		 *
1563
		 * @since 2.2.1
1564
		 *
1565
		 * @param bool $development_mode Is Jetpack's development mode active.
1566
		 */
1567
		return apply_filters( 'jetpack_development_mode', $development_mode );
1568
	}
1569
1570
	/**
1571
	 * Whether the site is currently onboarding or not.
1572
	 * A site is considered as being onboarded if it currently has an onboarding token.
1573
	 *
1574
	 * @since 5.8
1575
	 *
1576
	 * @access public
1577
	 * @static
1578
	 *
1579
	 * @return bool True if the site is currently onboarding, false otherwise
1580
	 */
1581
	public static function is_onboarding() {
1582
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1583
	}
1584
1585
	/**
1586
	* Get Jetpack development mode notice text and notice class.
1587
	*
1588
	* Mirrors the checks made in Jetpack::is_development_mode
1589
	*
1590
	*/
1591
	public static function show_development_mode_notice() {
1592
		if ( Jetpack::is_development_mode() ) {
1593
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1594
				$notice = sprintf(
1595
					/* translators: %s is a URL */
1596
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1597
					'https://jetpack.com/support/development-mode/'
1598
				);
1599
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1600
				$notice = sprintf(
1601
					/* translators: %s is a URL */
1602
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1603
					'https://jetpack.com/support/development-mode/'
1604
				);
1605
			} else {
1606
				$notice = sprintf(
1607
					/* translators: %s is a URL */
1608
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1609
					'https://jetpack.com/support/development-mode/'
1610
				);
1611
			}
1612
1613
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1614
		}
1615
1616
		// Throw up a notice if using a development version and as for feedback.
1617
		if ( Jetpack::is_development_version() ) {
1618
			/* translators: %s is a URL */
1619
			$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/' );
1620
1621
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1622
		}
1623
		// Throw up a notice if using staging mode
1624
		if ( Jetpack::is_staging_site() ) {
1625
			/* translators: %s is a URL */
1626
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1627
1628
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1629
		}
1630
	}
1631
1632
	/**
1633
	 * Whether Jetpack's version maps to a public release, or a development version.
1634
	 */
1635
	public static function is_development_version() {
1636
		/**
1637
		 * Allows filtering whether this is a development version of Jetpack.
1638
		 *
1639
		 * This filter is especially useful for tests.
1640
		 *
1641
		 * @since 4.3.0
1642
		 *
1643
		 * @param bool $development_version Is this a develoment version of Jetpack?
1644
		 */
1645
		return (bool) apply_filters(
1646
			'jetpack_development_version',
1647
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1648
		);
1649
	}
1650
1651
	/**
1652
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1653
	 */
1654
	public static function is_user_connected( $user_id = false ) {
1655
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1656
		if ( ! $user_id ) {
1657
			return false;
1658
		}
1659
1660
		return (bool) Jetpack_Data::get_access_token( $user_id );
1661
	}
1662
1663
	/**
1664
	 * Get the wpcom user data of the current|specified connected user.
1665
	 */
1666
	public static function get_connected_user_data( $user_id = null ) {
1667
		if ( ! $user_id ) {
1668
			$user_id = get_current_user_id();
1669
		}
1670
1671
		$transient_key = "jetpack_connected_user_data_$user_id";
1672
1673
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1674
			return $cached_user_data;
1675
		}
1676
1677
		Jetpack::load_xml_rpc_client();
1678
		$xml = new Jetpack_IXR_Client( array(
1679
			'user_id' => $user_id,
1680
		) );
1681
		$xml->query( 'wpcom.getUser' );
1682
		if ( ! $xml->isError() ) {
1683
			$user_data = $xml->getResponse();
1684
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1685
			return $user_data;
1686
		}
1687
1688
		return false;
1689
	}
1690
1691
	/**
1692
	 * Get the wpcom email of the current|specified connected user.
1693
	 */
1694 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1695
		if ( ! $user_id ) {
1696
			$user_id = get_current_user_id();
1697
		}
1698
		Jetpack::load_xml_rpc_client();
1699
		$xml = new Jetpack_IXR_Client( array(
1700
			'user_id' => $user_id,
1701
		) );
1702
		$xml->query( 'wpcom.getUserEmail' );
1703
		if ( ! $xml->isError() ) {
1704
			return $xml->getResponse();
1705
		}
1706
		return false;
1707
	}
1708
1709
	/**
1710
	 * Get the wpcom email of the master user.
1711
	 */
1712
	public static function get_master_user_email() {
1713
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1714
		if ( $master_user_id ) {
1715
			return self::get_connected_user_email( $master_user_id );
1716
		}
1717
		return '';
1718
	}
1719
1720
	function current_user_is_connection_owner() {
1721
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1722
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1723
	}
1724
1725
	/**
1726
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1727
	 */
1728
	function extra_oembed_providers() {
1729
		// Cloudup: https://dev.cloudup.com/#oembed
1730
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1731
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1732
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1733
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1734
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1735
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1736
	}
1737
1738
	/**
1739
	 * Synchronize connected user role changes
1740
	 */
1741
	function user_role_change( $user_id ) {
1742
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1743
		Jetpack_Sync_Users::user_role_change( $user_id );
1744
	}
1745
1746
	/**
1747
	 * Loads the currently active modules.
1748
	 */
1749
	public static function load_modules() {
1750
		if (
1751
			! self::is_active()
1752
			&& ! self::is_development_mode()
1753
			&& ! self::is_onboarding()
1754
			&& (
1755
				! is_multisite()
1756
				|| ! get_site_option( 'jetpack_protect_active' )
1757
			)
1758
		) {
1759
			return;
1760
		}
1761
1762
		$version = Jetpack_Options::get_option( 'version' );
1763 View Code Duplication
		if ( ! $version ) {
1764
			$version = $old_version = JETPACK__VERSION . ':' . time();
1765
			/** This action is documented in class.jetpack.php */
1766
			do_action( 'updating_jetpack_version', $version, false );
1767
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1768
		}
1769
		list( $version ) = explode( ':', $version );
1770
1771
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1772
1773
		$modules_data = array();
1774
1775
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1776
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1777
			$updated_modules = array();
1778
			foreach ( $modules as $module ) {
1779
				$modules_data[ $module ] = Jetpack::get_module( $module );
1780
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1781
					continue;
1782
				}
1783
1784
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1785
					continue;
1786
				}
1787
1788
				$updated_modules[] = $module;
1789
			}
1790
1791
			$modules = array_diff( $modules, $updated_modules );
1792
		}
1793
1794
		$is_development_mode = Jetpack::is_development_mode();
1795
1796
		foreach ( $modules as $index => $module ) {
1797
			// If we're in dev mode, disable modules requiring a connection
1798
			if ( $is_development_mode ) {
1799
				// Prime the pump if we need to
1800
				if ( empty( $modules_data[ $module ] ) ) {
1801
					$modules_data[ $module ] = Jetpack::get_module( $module );
1802
				}
1803
				// If the module requires a connection, but we're in local mode, don't include it.
1804
				if ( $modules_data[ $module ]['requires_connection'] ) {
1805
					continue;
1806
				}
1807
			}
1808
1809
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1810
				continue;
1811
			}
1812
1813
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1814
				unset( $modules[ $index ] );
1815
				self::update_active_modules( array_values( $modules ) );
1816
				continue;
1817
			}
1818
1819
			/**
1820
			 * Fires when a specific module is loaded.
1821
			 * The dynamic part of the hook, $module, is the module slug.
1822
			 *
1823
			 * @since 1.1.0
1824
			 */
1825
			do_action( 'jetpack_module_loaded_' . $module );
1826
		}
1827
1828
		/**
1829
		 * Fires when all the modules are loaded.
1830
		 *
1831
		 * @since 1.1.0
1832
		 */
1833
		do_action( 'jetpack_modules_loaded' );
1834
1835
		// 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.
1836
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1837
	}
1838
1839
	/**
1840
	 * Check if Jetpack's REST API compat file should be included
1841
	 * @action plugins_loaded
1842
	 * @return null
1843
	 */
1844
	public function check_rest_api_compat() {
1845
		/**
1846
		 * Filters the list of REST API compat files to be included.
1847
		 *
1848
		 * @since 2.2.5
1849
		 *
1850
		 * @param array $args Array of REST API compat files to include.
1851
		 */
1852
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1853
1854
		if ( function_exists( 'bbpress' ) )
1855
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1856
1857
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1858
			require_once $_jetpack_rest_api_compat_include;
1859
	}
1860
1861
	/**
1862
	 * Gets all plugins currently active in values, regardless of whether they're
1863
	 * traditionally activated or network activated.
1864
	 *
1865
	 * @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...
1866
	 */
1867
	public static function get_active_plugins() {
1868
		$active_plugins = (array) get_option( 'active_plugins', array() );
1869
1870
		if ( is_multisite() ) {
1871
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1872
			// whereas active_plugins stores them in the values.
1873
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1874
			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...
1875
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1876
			}
1877
		}
1878
1879
		sort( $active_plugins );
1880
1881
		return array_unique( $active_plugins );
1882
	}
1883
1884
	/**
1885
	 * Gets and parses additional plugin data to send with the heartbeat data
1886
	 *
1887
	 * @since 3.8.1
1888
	 *
1889
	 * @return array Array of plugin data
1890
	 */
1891
	public static function get_parsed_plugin_data() {
1892
		if ( ! function_exists( 'get_plugins' ) ) {
1893
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1894
		}
1895
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1896
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1897
		$active_plugins = Jetpack::get_active_plugins();
1898
1899
		$plugins = array();
1900
		foreach ( $all_plugins as $path => $plugin_data ) {
1901
			$plugins[ $path ] = array(
1902
					'is_active' => in_array( $path, $active_plugins ),
1903
					'file'      => $path,
1904
					'name'      => $plugin_data['Name'],
1905
					'version'   => $plugin_data['Version'],
1906
					'author'    => $plugin_data['Author'],
1907
			);
1908
		}
1909
1910
		return $plugins;
1911
	}
1912
1913
	/**
1914
	 * Gets and parses theme data to send with the heartbeat data
1915
	 *
1916
	 * @since 3.8.1
1917
	 *
1918
	 * @return array Array of theme data
1919
	 */
1920
	public static function get_parsed_theme_data() {
1921
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1922
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1923
1924
		$themes = array();
1925
		foreach ( $all_themes as $slug => $theme_data ) {
1926
			$theme_headers = array();
1927
			foreach ( $header_keys as $header_key ) {
1928
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1929
			}
1930
1931
			$themes[ $slug ] = array(
1932
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1933
					'slug' => $slug,
1934
					'theme_root' => $theme_data->get_theme_root_uri(),
1935
					'parent' => $theme_data->parent(),
1936
					'headers' => $theme_headers
1937
			);
1938
		}
1939
1940
		return $themes;
1941
	}
1942
1943
	/**
1944
	 * Checks whether a specific plugin is active.
1945
	 *
1946
	 * We don't want to store these in a static variable, in case
1947
	 * there are switch_to_blog() calls involved.
1948
	 */
1949
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1950
		return in_array( $plugin, self::get_active_plugins() );
1951
	}
1952
1953
	/**
1954
	 * Check if Jetpack's Open Graph tags should be used.
1955
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1956
	 *
1957
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1958
	 * @action plugins_loaded
1959
	 * @return null
1960
	 */
1961
	public function check_open_graph() {
1962
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1963
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1964
		}
1965
1966
		$active_plugins = self::get_active_plugins();
1967
1968
		if ( ! empty( $active_plugins ) ) {
1969
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1970
				if ( in_array( $plugin, $active_plugins ) ) {
1971
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1972
					break;
1973
				}
1974
			}
1975
		}
1976
1977
		/**
1978
		 * Allow the addition of Open Graph Meta Tags to all pages.
1979
		 *
1980
		 * @since 2.0.3
1981
		 *
1982
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1983
		 */
1984
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1985
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1986
		}
1987
	}
1988
1989
	/**
1990
	 * Check if Jetpack's Twitter tags should be used.
1991
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1992
	 *
1993
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1994
	 * @action plugins_loaded
1995
	 * @return null
1996
	 */
1997
	public function check_twitter_tags() {
1998
1999
		$active_plugins = self::get_active_plugins();
2000
2001
		if ( ! empty( $active_plugins ) ) {
2002
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2003
				if ( in_array( $plugin, $active_plugins ) ) {
2004
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2005
					break;
2006
				}
2007
			}
2008
		}
2009
2010
		/**
2011
		 * Allow Twitter Card Meta tags to be disabled.
2012
		 *
2013
		 * @since 2.6.0
2014
		 *
2015
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2016
		 */
2017
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2018
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2019
		}
2020
	}
2021
2022
	/**
2023
	 * Allows plugins to submit security reports.
2024
 	 *
2025
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2026
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2027
	 * @param array   $args         See definitions above
2028
	 */
2029
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2030
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2031
	}
2032
2033
/* Jetpack Options API */
2034
2035
	public static function get_option_names( $type = 'compact' ) {
2036
		return Jetpack_Options::get_option_names( $type );
2037
	}
2038
2039
	/**
2040
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2041
 	 *
2042
	 * @param string $name    Option name
2043
	 * @param mixed  $default (optional)
2044
	 */
2045
	public static function get_option( $name, $default = false ) {
2046
		return Jetpack_Options::get_option( $name, $default );
2047
	}
2048
2049
	/**
2050
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2051
 	 *
2052
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2053
	 * @param string $name  Option name
2054
	 * @param mixed  $value Option value
2055
	 */
2056
	public static function update_option( $name, $value ) {
2057
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2058
		return Jetpack_Options::update_option( $name, $value );
2059
	}
2060
2061
	/**
2062
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2063
 	 *
2064
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2065
	 * @param array $array array( option name => option value, ... )
2066
	 */
2067
	public static function update_options( $array ) {
2068
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2069
		return Jetpack_Options::update_options( $array );
2070
	}
2071
2072
	/**
2073
	 * Deletes the given option.  May be passed multiple option names as an array.
2074
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2075
	 *
2076
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2077
	 * @param string|array $names
2078
	 */
2079
	public static function delete_option( $names ) {
2080
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2081
		return Jetpack_Options::delete_option( $names );
2082
	}
2083
2084
	/**
2085
	 * Enters a user token into the user_tokens option
2086
	 *
2087
	 * @param int $user_id
2088
	 * @param string $token
2089
	 * return bool
2090
	 */
2091
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2092
		// not designed for concurrent updates
2093
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2094
		if ( ! is_array( $user_tokens ) )
2095
			$user_tokens = array();
2096
		$user_tokens[$user_id] = $token;
2097
		if ( $is_master_user ) {
2098
			$master_user = $user_id;
2099
			$options     = compact( 'user_tokens', 'master_user' );
2100
		} else {
2101
			$options = compact( 'user_tokens' );
2102
		}
2103
		return Jetpack_Options::update_options( $options );
2104
	}
2105
2106
	/**
2107
	 * Returns an array of all PHP files in the specified absolute path.
2108
	 * Equivalent to glob( "$absolute_path/*.php" ).
2109
	 *
2110
	 * @param string $absolute_path The absolute path of the directory to search.
2111
	 * @return array Array of absolute paths to the PHP files.
2112
	 */
2113
	public static function glob_php( $absolute_path ) {
2114
		if ( function_exists( 'glob' ) ) {
2115
			return glob( "$absolute_path/*.php" );
2116
		}
2117
2118
		$absolute_path = untrailingslashit( $absolute_path );
2119
		$files = array();
2120
		if ( ! $dir = @opendir( $absolute_path ) ) {
2121
			return $files;
2122
		}
2123
2124
		while ( false !== $file = readdir( $dir ) ) {
2125
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2126
				continue;
2127
			}
2128
2129
			$file = "$absolute_path/$file";
2130
2131
			if ( ! is_file( $file ) ) {
2132
				continue;
2133
			}
2134
2135
			$files[] = $file;
2136
		}
2137
2138
		closedir( $dir );
2139
2140
		return $files;
2141
	}
2142
2143
	public static function activate_new_modules( $redirect = false ) {
2144
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2145
			return;
2146
		}
2147
2148
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2149 View Code Duplication
		if ( ! $jetpack_old_version ) {
2150
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2151
			/** This action is documented in class.jetpack.php */
2152
			do_action( 'updating_jetpack_version', $version, false );
2153
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2154
		}
2155
2156
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2157
2158
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2159
			return;
2160
		}
2161
2162
		$active_modules     = Jetpack::get_active_modules();
2163
		$reactivate_modules = array();
2164
		foreach ( $active_modules as $active_module ) {
2165
			$module = Jetpack::get_module( $active_module );
2166
			if ( ! isset( $module['changed'] ) ) {
2167
				continue;
2168
			}
2169
2170
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2171
				continue;
2172
			}
2173
2174
			$reactivate_modules[] = $active_module;
2175
			Jetpack::deactivate_module( $active_module );
2176
		}
2177
2178
		$new_version = JETPACK__VERSION . ':' . time();
2179
		/** This action is documented in class.jetpack.php */
2180
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2181
		Jetpack_Options::update_options(
2182
			array(
2183
				'version'     => $new_version,
2184
				'old_version' => $jetpack_old_version,
2185
			)
2186
		);
2187
2188
		Jetpack::state( 'message', 'modules_activated' );
2189
		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...
2190
2191
		if ( $redirect ) {
2192
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2193
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2194
				$page = $_GET['page'];
2195
			}
2196
2197
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2198
			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...
2199
		}
2200
	}
2201
2202
	/**
2203
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2204
	 * Make sure to tuck away module "library" files in a sub-directory.
2205
	 */
2206
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2207
		static $modules = null;
2208
2209
		if ( ! isset( $modules ) ) {
2210
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2211
			// Use the cache if we're on the front-end and it's available...
2212
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2213
				$modules = $available_modules_option[ JETPACK__VERSION ];
2214
			} else {
2215
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2216
2217
				$modules = array();
2218
2219
				foreach ( $files as $file ) {
2220
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2221
						continue;
2222
					}
2223
2224
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2225
				}
2226
2227
				Jetpack_Options::update_option( 'available_modules', array(
2228
					JETPACK__VERSION => $modules,
2229
				) );
2230
			}
2231
		}
2232
2233
		/**
2234
		 * Filters the array of modules available to be activated.
2235
		 *
2236
		 * @since 2.4.0
2237
		 *
2238
		 * @param array $modules Array of available modules.
2239
		 * @param string $min_version Minimum version number required to use modules.
2240
		 * @param string $max_version Maximum version number required to use modules.
2241
		 */
2242
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2243
2244
		if ( ! $min_version && ! $max_version ) {
2245
			return array_keys( $mods );
2246
		}
2247
2248
		$r = array();
2249
		foreach ( $mods as $slug => $introduced ) {
2250
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2251
				continue;
2252
			}
2253
2254
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2255
				continue;
2256
			}
2257
2258
			$r[] = $slug;
2259
		}
2260
2261
		return $r;
2262
	}
2263
2264
	/**
2265
	 * Default modules loaded on activation.
2266
	 */
2267
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2268
		$return = array();
2269
2270
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2271
			$module_data = Jetpack::get_module( $module );
2272
2273
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2274
				case 'yes' :
2275
					$return[] = $module;
2276
					break;
2277
				case 'public' :
2278
					if ( Jetpack_Options::get_option( 'public' ) ) {
2279
						$return[] = $module;
2280
					}
2281
					break;
2282
				case 'no' :
2283
				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...
2284
					break;
2285
			}
2286
		}
2287
		/**
2288
		 * Filters the array of default modules.
2289
		 *
2290
		 * @since 2.5.0
2291
		 *
2292
		 * @param array $return Array of default modules.
2293
		 * @param string $min_version Minimum version number required to use modules.
2294
		 * @param string $max_version Maximum version number required to use modules.
2295
		 */
2296
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2297
	}
2298
2299
	/**
2300
	 * Checks activated modules during auto-activation to determine
2301
	 * if any of those modules are being deprecated.  If so, close
2302
	 * them out, and add any replacement modules.
2303
	 *
2304
	 * Runs at priority 99 by default.
2305
	 *
2306
	 * This is run late, so that it can still activate a module if
2307
	 * the new module is a replacement for another that the user
2308
	 * currently has active, even if something at the normal priority
2309
	 * would kibosh everything.
2310
	 *
2311
	 * @since 2.6
2312
	 * @uses jetpack_get_default_modules filter
2313
	 * @param array $modules
2314
	 * @return array
2315
	 */
2316
	function handle_deprecated_modules( $modules ) {
2317
		$deprecated_modules = array(
2318
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2319
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2320
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2321
		);
2322
2323
		// Don't activate SSO if they never completed activating WPCC.
2324
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2325
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2326
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2327
				$deprecated_modules['wpcc'] = null;
2328
			}
2329
		}
2330
2331
		foreach ( $deprecated_modules as $module => $replacement ) {
2332
			if ( Jetpack::is_module_active( $module ) ) {
2333
				self::deactivate_module( $module );
2334
				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...
2335
					$modules[] = $replacement;
2336
				}
2337
			}
2338
		}
2339
2340
		return array_unique( $modules );
2341
	}
2342
2343
	/**
2344
	 * Checks activated plugins during auto-activation to determine
2345
	 * if any of those plugins are in the list with a corresponding module
2346
	 * that is not compatible with the plugin. The module will not be allowed
2347
	 * to auto-activate.
2348
	 *
2349
	 * @since 2.6
2350
	 * @uses jetpack_get_default_modules filter
2351
	 * @param array $modules
2352
	 * @return array
2353
	 */
2354
	function filter_default_modules( $modules ) {
2355
2356
		$active_plugins = self::get_active_plugins();
2357
2358
		if ( ! empty( $active_plugins ) ) {
2359
2360
			// For each module we'd like to auto-activate...
2361
			foreach ( $modules as $key => $module ) {
2362
				// If there are potential conflicts for it...
2363
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2364
					// For each potential conflict...
2365
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2366
						// If that conflicting plugin is active...
2367
						if ( in_array( $plugin, $active_plugins ) ) {
2368
							// Remove that item from being auto-activated.
2369
							unset( $modules[ $key ] );
2370
						}
2371
					}
2372
				}
2373
			}
2374
		}
2375
2376
		return $modules;
2377
	}
2378
2379
	/**
2380
	 * Extract a module's slug from its full path.
2381
	 */
2382
	public static function get_module_slug( $file ) {
2383
		return str_replace( '.php', '', basename( $file ) );
2384
	}
2385
2386
	/**
2387
	 * Generate a module's path from its slug.
2388
	 */
2389
	public static function get_module_path( $slug ) {
2390
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2391
	}
2392
2393
	/**
2394
	 * Load module data from module file. Headers differ from WordPress
2395
	 * plugin headers to avoid them being identified as standalone
2396
	 * plugins on the WordPress plugins page.
2397
	 */
2398
	public static function get_module( $module ) {
2399
		$headers = array(
2400
			'name'                      => 'Module Name',
2401
			'description'               => 'Module Description',
2402
			'jumpstart_desc'            => 'Jumpstart Description',
2403
			'sort'                      => 'Sort Order',
2404
			'recommendation_order'      => 'Recommendation Order',
2405
			'introduced'                => 'First Introduced',
2406
			'changed'                   => 'Major Changes In',
2407
			'deactivate'                => 'Deactivate',
2408
			'free'                      => 'Free',
2409
			'requires_connection'       => 'Requires Connection',
2410
			'auto_activate'             => 'Auto Activate',
2411
			'module_tags'               => 'Module Tags',
2412
			'feature'                   => 'Feature',
2413
			'additional_search_queries' => 'Additional Search Queries',
2414
		);
2415
2416
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2417
2418
		$mod = Jetpack::get_file_data( $file, $headers );
2419
		if ( empty( $mod['name'] ) ) {
2420
			return false;
2421
		}
2422
2423
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2424
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2425
		$mod['deactivate']              = empty( $mod['deactivate'] );
2426
		$mod['free']                    = empty( $mod['free'] );
2427
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2428
2429
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2430
			$mod['auto_activate'] = 'No';
2431
		} else {
2432
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2433
		}
2434
2435
		if ( $mod['module_tags'] ) {
2436
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2437
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2438
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2439
		} else {
2440
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2441
		}
2442
2443
		if ( $mod['feature'] ) {
2444
			$mod['feature'] = explode( ',', $mod['feature'] );
2445
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2446
		} else {
2447
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2448
		}
2449
2450
		/**
2451
		 * Filters the feature array on a module.
2452
		 *
2453
		 * This filter allows you to control where each module is filtered: Recommended,
2454
		 * Jumpstart, and the default "Other" listing.
2455
		 *
2456
		 * @since 3.5.0
2457
		 *
2458
		 * @param array   $mod['feature'] The areas to feature this module:
2459
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2460
		 *     'Recommended' shows on the main Jetpack admin screen.
2461
		 *     'Other' should be the default if no other value is in the array.
2462
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2463
		 * @param array   $mod All the currently assembled module data.
2464
		 */
2465
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2466
2467
		/**
2468
		 * Filter the returned data about a module.
2469
		 *
2470
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2471
		 * so please be careful.
2472
		 *
2473
		 * @since 3.6.0
2474
		 *
2475
		 * @param array   $mod    The details of the requested module.
2476
		 * @param string  $module The slug of the module, e.g. sharedaddy
2477
		 * @param string  $file   The path to the module source file.
2478
		 */
2479
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2480
	}
2481
2482
	/**
2483
	 * Like core's get_file_data implementation, but caches the result.
2484
	 */
2485
	public static function get_file_data( $file, $headers ) {
2486
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2487
		$file_name = basename( $file );
2488
2489
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2490
2491
		$file_data_option = get_transient( $cache_key );
2492
2493
		if ( false === $file_data_option ) {
2494
			$file_data_option = array();
2495
		}
2496
2497
		$key           = md5( $file_name . serialize( $headers ) );
2498
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2499
2500
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2501
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2502
			return $file_data_option[ $key ];
2503
		}
2504
2505
		$data = get_file_data( $file, $headers );
2506
2507
		$file_data_option[ $key ] = $data;
2508
2509
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2510
2511
		return $data;
2512
	}
2513
2514
2515
	/**
2516
	 * Return translated module tag.
2517
	 *
2518
	 * @param string $tag Tag as it appears in each module heading.
2519
	 *
2520
	 * @return mixed
2521
	 */
2522
	public static function translate_module_tag( $tag ) {
2523
		return jetpack_get_module_i18n_tag( $tag );
2524
	}
2525
2526
	/**
2527
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2528
	 *
2529
	 * @since 3.9.2
2530
	 *
2531
	 * @param array $modules
2532
	 *
2533
	 * @return string|void
2534
	 */
2535
	public static function get_translated_modules( $modules ) {
2536
		foreach ( $modules as $index => $module ) {
2537
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2538
			if ( isset( $module['name'] ) ) {
2539
				$modules[ $index ]['name'] = $i18n_module['name'];
2540
			}
2541
			if ( isset( $module['description'] ) ) {
2542
				$modules[ $index ]['description'] = $i18n_module['description'];
2543
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2544
			}
2545
		}
2546
		return $modules;
2547
	}
2548
2549
	/**
2550
	 * Get a list of activated modules as an array of module slugs.
2551
	 */
2552
	public static function get_active_modules() {
2553
		$active = Jetpack_Options::get_option( 'active_modules' );
2554
2555
		if ( ! is_array( $active ) ) {
2556
			$active = array();
2557
		}
2558
2559
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2560
			$active[] = 'vaultpress';
2561
		} else {
2562
			$active = array_diff( $active, array( 'vaultpress' ) );
2563
		}
2564
2565
		//If protect is active on the main site of a multisite, it should be active on all sites.
2566
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2567
			$active[] = 'protect';
2568
		}
2569
2570
		/**
2571
		 * Allow filtering of the active modules.
2572
		 *
2573
		 * Gives theme and plugin developers the power to alter the modules that
2574
		 * are activated on the fly.
2575
		 *
2576
		 * @since 5.8.0
2577
		 *
2578
		 * @param array $active Array of active module slugs.
2579
		 */
2580
		$active = apply_filters( 'jetpack_active_modules', $active );
2581
2582
		return array_unique( $active );
2583
	}
2584
2585
	/**
2586
	 * Check whether or not a Jetpack module is active.
2587
	 *
2588
	 * @param string $module The slug of a Jetpack module.
2589
	 * @return bool
2590
	 *
2591
	 * @static
2592
	 */
2593
	public static function is_module_active( $module ) {
2594
		return in_array( $module, self::get_active_modules() );
2595
	}
2596
2597
	public static function is_module( $module ) {
2598
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2599
	}
2600
2601
	/**
2602
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2603
	 *
2604
	 * @param bool $catch True to start catching, False to stop.
2605
	 *
2606
	 * @static
2607
	 */
2608
	public static function catch_errors( $catch ) {
2609
		static $display_errors, $error_reporting;
2610
2611
		if ( $catch ) {
2612
			$display_errors  = @ini_set( 'display_errors', 1 );
2613
			$error_reporting = @error_reporting( E_ALL );
2614
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2615
		} else {
2616
			@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...
2617
			@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...
2618
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2619
		}
2620
	}
2621
2622
	/**
2623
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2624
	 */
2625
	public static function catch_errors_on_shutdown() {
2626
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2627
	}
2628
2629
	/**
2630
	 * Rewrite any string to make paths easier to read.
2631
	 *
2632
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2633
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2634
	 *
2635
	 * @param $string
2636
	 * @return mixed
2637
	 */
2638
	public static function alias_directories( $string ) {
2639
		// ABSPATH has a trailing slash.
2640
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2641
		// WP_CONTENT_DIR does not have a trailing slash.
2642
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2643
2644
		return $string;
2645
	}
2646
2647
	public static function activate_default_modules(
2648
		$min_version = false,
2649
		$max_version = false,
2650
		$other_modules = array(),
2651
		$redirect = true,
2652
		$send_state_messages = true
2653
	) {
2654
		$jetpack = Jetpack::init();
2655
2656
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2657
		$modules = array_merge( $other_modules, $modules );
2658
2659
		// Look for standalone plugins and disable if active.
2660
2661
		$to_deactivate = array();
2662
		foreach ( $modules as $module ) {
2663
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2664
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2665
			}
2666
		}
2667
2668
		$deactivated = array();
2669
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2670
			list( $probable_file, $probable_title ) = $deactivate_me;
2671
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2672
				$deactivated[] = $module;
2673
			}
2674
		}
2675
2676
		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...
2677
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2678
2679
			$url = add_query_arg(
2680
				array(
2681
					'action'   => 'activate_default_modules',
2682
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2683
				),
2684
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2685
			);
2686
			wp_safe_redirect( $url );
2687
			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...
2688
		}
2689
2690
		/**
2691
		 * Fires before default modules are activated.
2692
		 *
2693
		 * @since 1.9.0
2694
		 *
2695
		 * @param string $min_version Minimum version number required to use modules.
2696
		 * @param string $max_version Maximum version number required to use modules.
2697
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2698
		 */
2699
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2700
2701
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2702
		Jetpack::restate();
2703
		Jetpack::catch_errors( true );
2704
2705
		$active = Jetpack::get_active_modules();
2706
2707
		foreach ( $modules as $module ) {
2708
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2709
				$active[] = $module;
2710
				self::update_active_modules( $active );
2711
				continue;
2712
			}
2713
2714
			if ( $send_state_messages && in_array( $module, $active ) ) {
2715
				$module_info = Jetpack::get_module( $module );
2716 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2717
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2718
					if ( $active_state = Jetpack::state( $state ) ) {
2719
						$active_state = explode( ',', $active_state );
2720
					} else {
2721
						$active_state = array();
2722
					}
2723
					$active_state[] = $module;
2724
					Jetpack::state( $state, implode( ',', $active_state ) );
2725
				}
2726
				continue;
2727
			}
2728
2729
			$file = Jetpack::get_module_path( $module );
2730
			if ( ! file_exists( $file ) ) {
2731
				continue;
2732
			}
2733
2734
			// we'll override this later if the plugin can be included without fatal error
2735
			if ( $redirect ) {
2736
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2737
			}
2738
2739
			if ( $send_state_messages ) {
2740
				Jetpack::state( 'error', 'module_activation_failed' );
2741
				Jetpack::state( 'module', $module );
2742
			}
2743
2744
			ob_start();
2745
			require $file;
2746
2747
			$active[] = $module;
2748
2749 View Code Duplication
			if ( $send_state_messages ) {
2750
2751
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
2752
				if ( $active_state = Jetpack::state( $state ) ) {
2753
					$active_state = explode( ',', $active_state );
2754
				} else {
2755
					$active_state = array();
2756
				}
2757
				$active_state[] = $module;
2758
				Jetpack::state( $state, implode( ',', $active_state ) );
2759
			}
2760
2761
			Jetpack::update_active_modules( $active );
2762
2763
			ob_end_clean();
2764
		}
2765
2766
		if ( $send_state_messages ) {
2767
			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...
2768
			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...
2769
		}
2770
2771
		Jetpack::catch_errors( false );
2772
		/**
2773
		 * Fires when default modules are activated.
2774
		 *
2775
		 * @since 1.9.0
2776
		 *
2777
		 * @param string $min_version Minimum version number required to use modules.
2778
		 * @param string $max_version Maximum version number required to use modules.
2779
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2780
		 */
2781
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2782
	}
2783
2784
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2785
		/**
2786
		 * Fires before a module is activated.
2787
		 *
2788
		 * @since 2.6.0
2789
		 *
2790
		 * @param string $module Module slug.
2791
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2792
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2793
		 */
2794
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2795
2796
		$jetpack = Jetpack::init();
2797
2798
		if ( ! strlen( $module ) )
2799
			return false;
2800
2801
		if ( ! Jetpack::is_module( $module ) )
2802
			return false;
2803
2804
		// If it's already active, then don't do it again
2805
		$active = Jetpack::get_active_modules();
2806
		foreach ( $active as $act ) {
2807
			if ( $act == $module )
2808
				return true;
2809
		}
2810
2811
		$module_data = Jetpack::get_module( $module );
2812
2813
		if ( ! Jetpack::is_active() ) {
2814
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2815
				return false;
2816
2817
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2818
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2819
				return false;
2820
		}
2821
2822
		// Check and see if the old plugin is active
2823
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2824
			// Deactivate the old plugin
2825
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2826
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2827
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2828
				Jetpack::state( 'deactivated_plugins', $module );
2829
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2830
				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...
2831
			}
2832
		}
2833
2834
		// Protect won't work with mis-configured IPs
2835
		if ( 'protect' === $module ) {
2836
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2837
			if ( ! jetpack_protect_get_ip() ) {
2838
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2839
				return false;
2840
			}
2841
		}
2842
2843
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2844
		Jetpack::state( 'module', $module );
2845
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2846
2847
		Jetpack::catch_errors( true );
2848
		ob_start();
2849
		require Jetpack::get_module_path( $module );
2850
		/** This action is documented in class.jetpack.php */
2851
		do_action( 'jetpack_activate_module', $module );
2852
		$active[] = $module;
2853
		Jetpack::update_active_modules( $active );
2854
2855
		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...
2856
		ob_end_clean();
2857
		Jetpack::catch_errors( false );
2858
2859
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2860 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2861
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2862
2863
			//Jump start is being dismissed send data to MC Stats
2864
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2865
2866
			$jetpack->do_stats( 'server_side' );
2867
		}
2868
2869
		if ( $redirect ) {
2870
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2871
		}
2872
		if ( $exit ) {
2873
			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...
2874
		}
2875
		return true;
2876
	}
2877
2878
	function activate_module_actions( $module ) {
2879
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2880
	}
2881
2882
	public static function deactivate_module( $module ) {
2883
		/**
2884
		 * Fires when a module is deactivated.
2885
		 *
2886
		 * @since 1.9.0
2887
		 *
2888
		 * @param string $module Module slug.
2889
		 */
2890
		do_action( 'jetpack_pre_deactivate_module', $module );
2891
2892
		$jetpack = Jetpack::init();
2893
2894
		$active = Jetpack::get_active_modules();
2895
		$new    = array_filter( array_diff( $active, (array) $module ) );
2896
2897
		// A flag for Jump Start so it's not shown again.
2898 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2899
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2900
2901
			//Jump start is being dismissed send data to MC Stats
2902
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2903
2904
			$jetpack->do_stats( 'server_side' );
2905
		}
2906
2907
		return self::update_active_modules( $new );
2908
	}
2909
2910
	public static function enable_module_configurable( $module ) {
2911
		$module = Jetpack::get_module_slug( $module );
2912
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2913
	}
2914
2915
	public static function module_configuration_url( $module ) {
2916
		$module = Jetpack::get_module_slug( $module );
2917
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2918
	}
2919
2920
	public static function module_configuration_load( $module, $method ) {
2921
		$module = Jetpack::get_module_slug( $module );
2922
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2923
	}
2924
2925
	public static function module_configuration_head( $module, $method ) {
2926
		$module = Jetpack::get_module_slug( $module );
2927
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2928
	}
2929
2930
	public static function module_configuration_screen( $module, $method ) {
2931
		$module = Jetpack::get_module_slug( $module );
2932
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2933
	}
2934
2935
	public static function module_configuration_activation_screen( $module, $method ) {
2936
		$module = Jetpack::get_module_slug( $module );
2937
		add_action( 'display_activate_module_setting_' . $module, $method );
2938
	}
2939
2940
/* Installation */
2941
2942
	public static function bail_on_activation( $message, $deactivate = true ) {
2943
?>
2944
<!doctype html>
2945
<html>
2946
<head>
2947
<meta charset="<?php bloginfo( 'charset' ); ?>">
2948
<style>
2949
* {
2950
	text-align: center;
2951
	margin: 0;
2952
	padding: 0;
2953
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2954
}
2955
p {
2956
	margin-top: 1em;
2957
	font-size: 18px;
2958
}
2959
</style>
2960
<body>
2961
<p><?php echo esc_html( $message ); ?></p>
2962
</body>
2963
</html>
2964
<?php
2965
		if ( $deactivate ) {
2966
			$plugins = get_option( 'active_plugins' );
2967
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2968
			$update  = false;
2969
			foreach ( $plugins as $i => $plugin ) {
2970
				if ( $plugin === $jetpack ) {
2971
					$plugins[$i] = false;
2972
					$update = true;
2973
				}
2974
			}
2975
2976
			if ( $update ) {
2977
				update_option( 'active_plugins', array_filter( $plugins ) );
2978
			}
2979
		}
2980
		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...
2981
	}
2982
2983
	/**
2984
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2985
	 * @static
2986
	 */
2987
	public static function plugin_activation( $network_wide ) {
2988
		Jetpack_Options::update_option( 'activated', 1 );
2989
2990
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2991
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2992
		}
2993
2994
		if ( $network_wide )
2995
			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...
2996
2997
		// For firing one-off events (notices) immediately after activation
2998
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2999
3000
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3001
3002
		Jetpack::plugin_initialize();
3003
	}
3004
3005
	public static function get_activation_source( $referer_url ) {
3006
3007
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3008
			return array( 'wp-cli', null );
3009
		}
3010
3011
		$referer = parse_url( $referer_url );
3012
3013
		$source_type = 'unknown';
3014
		$source_query = null;
3015
3016
		if ( ! is_array( $referer ) ) {
3017
			return array( $source_type, $source_query );
3018
		}
3019
3020
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3021
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3022
3023
		if ( isset( $referer['query'] ) ) {
3024
			parse_str( $referer['query'], $query_parts );
3025
		} else {
3026
			$query_parts = array();
3027
		}
3028
3029
		if ( $plugins_path === $referer['path'] ) {
3030
			$source_type = 'list';
3031
		} elseif ( $plugins_install_path === $referer['path'] ) {
3032
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3033
			switch( $tab ) {
3034
				case 'popular':
3035
					$source_type = 'popular';
3036
					break;
3037
				case 'recommended':
3038
					$source_type = 'recommended';
3039
					break;
3040
				case 'favorites':
3041
					$source_type = 'favorites';
3042
					break;
3043
				case 'search':
3044
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3045
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3046
					break;
3047
				default:
3048
					$source_type = 'featured';
3049
			}
3050
		}
3051
3052
		return array( $source_type, $source_query );
3053
	}
3054
3055
	/**
3056
	 * Runs before bumping version numbers up to a new version
3057
	 * @param  string $version    Version:timestamp
3058
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3059
	 * @return null              [description]
3060
	 */
3061
	public static function do_version_bump( $version, $old_version ) {
3062
3063
		if ( ! $old_version ) { // For new sites
3064
			// Setting up jetpack manage
3065
			Jetpack::activate_manage();
3066
		}
3067
	}
3068
3069
	/**
3070
	 * Sets the internal version number and activation state.
3071
	 * @static
3072
	 */
3073
	public static function plugin_initialize() {
3074
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3075
			Jetpack_Options::update_option( 'activated', 2 );
3076
		}
3077
3078 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3079
			$version = $old_version = JETPACK__VERSION . ':' . time();
3080
			/** This action is documented in class.jetpack.php */
3081
			do_action( 'updating_jetpack_version', $version, false );
3082
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3083
		}
3084
3085
		Jetpack::load_modules();
3086
3087
		Jetpack_Options::delete_option( 'do_activate' );
3088
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3089
	}
3090
3091
	/**
3092
	 * Removes all connection options
3093
	 * @static
3094
	 */
3095
	public static function plugin_deactivation( ) {
3096
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3097
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3098
			Jetpack_Network::init()->deactivate();
3099
		} else {
3100
			Jetpack::disconnect( false );
3101
			//Jetpack_Heartbeat::init()->deactivate();
3102
		}
3103
	}
3104
3105
	/**
3106
	 * Disconnects from the Jetpack servers.
3107
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3108
	 * @static
3109
	 */
3110
	public static function disconnect( $update_activated_state = true ) {
3111
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3112
		Jetpack::clean_nonces( true );
3113
3114
		// If the site is in an IDC because sync is not allowed,
3115
		// let's make sure to not disconnect the production site.
3116
		if ( ! self::validate_sync_error_idc_option() ) {
3117
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3118
			Jetpack::load_xml_rpc_client();
3119
			$xml = new Jetpack_IXR_Client();
3120
			$xml->query( 'jetpack.deregister' );
3121
		}
3122
3123
		Jetpack_Options::delete_option(
3124
			array(
3125
				'blog_token',
3126
				'user_token',
3127
				'user_tokens',
3128
				'master_user',
3129
				'time_diff',
3130
				'fallback_no_verify_ssl_certs',
3131
			)
3132
		);
3133
3134
		Jetpack_IDC::clear_all_idc_options();
3135
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3136
3137
		if ( $update_activated_state ) {
3138
			Jetpack_Options::update_option( 'activated', 4 );
3139
		}
3140
3141
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3142
			// Check then record unique disconnection if site has never been disconnected previously
3143
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3144
				$jetpack_unique_connection['disconnected'] = 1;
3145
			} else {
3146
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3147
					//track unique disconnect
3148
					$jetpack = Jetpack::init();
3149
3150
					$jetpack->stat( 'connections', 'unique-disconnect' );
3151
					$jetpack->do_stats( 'server_side' );
3152
				}
3153
				// increment number of times disconnected
3154
				$jetpack_unique_connection['disconnected'] += 1;
3155
			}
3156
3157
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3158
		}
3159
3160
		// Delete cached connected user data
3161
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3162
		delete_transient( $transient_key );
3163
3164
		// Delete all the sync related data. Since it could be taking up space.
3165
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3166
		Jetpack_Sync_Sender::get_instance()->uninstall();
3167
3168
		// Disable the Heartbeat cron
3169
		Jetpack_Heartbeat::init()->deactivate();
3170
	}
3171
3172
	/**
3173
	 * Unlinks the current user from the linked WordPress.com user
3174
	 */
3175
	public static function unlink_user( $user_id = null ) {
3176
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3177
			return false;
3178
3179
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3180
3181
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3182
			return false;
3183
3184
		if ( ! isset( $tokens[ $user_id ] ) )
3185
			return false;
3186
3187
		Jetpack::load_xml_rpc_client();
3188
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3189
		$xml->query( 'jetpack.unlink_user', $user_id );
3190
3191
		unset( $tokens[ $user_id ] );
3192
3193
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3194
3195
		/**
3196
		 * Fires after the current user has been unlinked from WordPress.com.
3197
		 *
3198
		 * @since 4.1.0
3199
		 *
3200
		 * @param int $user_id The current user's ID.
3201
		 */
3202
		do_action( 'jetpack_unlinked_user', $user_id );
3203
3204
		return true;
3205
	}
3206
3207
	/**
3208
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3209
	 */
3210
	public static function try_registration() {
3211
		// Let's get some testing in beta versions and such.
3212
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3213
			// Before attempting to connect, let's make sure that the domains are viable.
3214
			$domains_to_check = array_unique( array(
3215
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3216
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3217
			) );
3218
			foreach ( $domains_to_check as $domain ) {
3219
				$result = Jetpack_Data::is_usable_domain( $domain );
3220
				if ( is_wp_error( $result ) ) {
3221
					return $result;
3222
				}
3223
			}
3224
		}
3225
3226
		$result = Jetpack::register();
3227
3228
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3229
		if ( ! $result || is_wp_error( $result ) ) {
3230
			return $result;
3231
		} else {
3232
			return true;
3233
		}
3234
	}
3235
3236
	/**
3237
	 * Tracking an internal event log. Try not to put too much chaff in here.
3238
	 *
3239
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3240
	 */
3241
	public static function log( $code, $data = null ) {
3242
		// only grab the latest 200 entries
3243
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3244
3245
		// Append our event to the log
3246
		$log_entry = array(
3247
			'time'    => time(),
3248
			'user_id' => get_current_user_id(),
3249
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3250
			'code'    => $code,
3251
		);
3252
		// Don't bother storing it unless we've got some.
3253
		if ( ! is_null( $data ) ) {
3254
			$log_entry['data'] = $data;
3255
		}
3256
		$log[] = $log_entry;
3257
3258
		// Try add_option first, to make sure it's not autoloaded.
3259
		// @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...
3260
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3261
			Jetpack_Options::update_option( 'log', $log );
3262
		}
3263
3264
		/**
3265
		 * Fires when Jetpack logs an internal event.
3266
		 *
3267
		 * @since 3.0.0
3268
		 *
3269
		 * @param array $log_entry {
3270
		 *	Array of details about the log entry.
3271
		 *
3272
		 *	@param string time Time of the event.
3273
		 *	@param int user_id ID of the user who trigerred the event.
3274
		 *	@param int blog_id Jetpack Blog ID.
3275
		 *	@param string code Unique name for the event.
3276
		 *	@param string data Data about the event.
3277
		 * }
3278
		 */
3279
		do_action( 'jetpack_log_entry', $log_entry );
3280
	}
3281
3282
	/**
3283
	 * Get the internal event log.
3284
	 *
3285
	 * @param $event (string) - only return the specific log events
3286
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3287
	 *
3288
	 * @return array of log events || WP_Error for invalid params
3289
	 */
3290
	public static function get_log( $event = false, $num = false ) {
3291
		if ( $event && ! is_string( $event ) ) {
3292
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3293
		}
3294
3295
		if ( $num && ! is_numeric( $num ) ) {
3296
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3297
		}
3298
3299
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3300
3301
		// If nothing set - act as it did before, otherwise let's start customizing the output
3302
		if ( ! $num && ! $event ) {
3303
			return $entire_log;
3304
		} else {
3305
			$entire_log = array_reverse( $entire_log );
3306
		}
3307
3308
		$custom_log_output = array();
3309
3310
		if ( $event ) {
3311
			foreach ( $entire_log as $log_event ) {
3312
				if ( $event == $log_event[ 'code' ] ) {
3313
					$custom_log_output[] = $log_event;
3314
				}
3315
			}
3316
		} else {
3317
			$custom_log_output = $entire_log;
3318
		}
3319
3320
		if ( $num ) {
3321
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3322
		}
3323
3324
		return $custom_log_output;
3325
	}
3326
3327
	/**
3328
	 * Log modification of important settings.
3329
	 */
3330
	public static function log_settings_change( $option, $old_value, $value ) {
3331
		switch( $option ) {
3332
			case 'jetpack_sync_non_public_post_stati':
3333
				self::log( $option, $value );
3334
				break;
3335
		}
3336
	}
3337
3338
	/**
3339
	 * Return stat data for WPCOM sync
3340
	 */
3341
	public static function get_stat_data( $encode = true, $extended = true ) {
3342
		$data = Jetpack_Heartbeat::generate_stats_array();
3343
3344
		if ( $extended ) {
3345
			$additional_data = self::get_additional_stat_data();
3346
			$data = array_merge( $data, $additional_data );
3347
		}
3348
3349
		if ( $encode ) {
3350
			return json_encode( $data );
3351
		}
3352
3353
		return $data;
3354
	}
3355
3356
	/**
3357
	 * Get additional stat data to sync to WPCOM
3358
	 */
3359
	public static function get_additional_stat_data( $prefix = '' ) {
3360
		$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...
3361
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3362
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3363
		$return["{$prefix}site-count"]     = 0;
3364
3365
		if ( function_exists( 'get_blog_count' ) ) {
3366
			$return["{$prefix}site-count"] = get_blog_count();
3367
		}
3368
		return $return;
3369
	}
3370
3371
	private static function get_site_user_count() {
3372
		global $wpdb;
3373
3374
		if ( function_exists( 'wp_is_large_network' ) ) {
3375
			if ( wp_is_large_network( 'users' ) ) {
3376
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3377
			}
3378
		}
3379 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3380
			// It wasn't there, so regenerate the data and save the transient
3381
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3382
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3383
		}
3384
		return $user_count;
3385
	}
3386
3387
	/* Admin Pages */
3388
3389
	function admin_init() {
3390
		// If the plugin is not connected, display a connect message.
3391
		if (
3392
			// the plugin was auto-activated and needs its candy
3393
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3394
		||
3395
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3396
			! Jetpack_Options::get_option( 'activated' )
3397
		) {
3398
			Jetpack::plugin_initialize();
3399
		}
3400
3401
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3402
			Jetpack_Connection_Banner::init();
3403
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3404
			// Upgrade: 1.1 -> 1.1.1
3405
			// Check and see if host can verify the Jetpack servers' SSL certificate
3406
			$args = array();
3407
			Jetpack_Client::_wp_remote_request(
3408
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3409
				$args,
3410
				true
3411
			);
3412
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3413
			// Show the notice on the Dashboard only for now
3414
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3415
		}
3416
3417
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3418
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3419
		}
3420
3421
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3422
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3423
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3424
3425
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3426
			// Artificially throw errors in certain whitelisted cases during plugin activation
3427
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3428
		}
3429
3430
		// Jetpack Manage Activation Screen from .com
3431
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3432
3433
		// Add custom column in wp-admin/users.php to show whether user is linked.
3434
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3435
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3436
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3437
	}
3438
3439
	function admin_body_class( $admin_body_class = '' ) {
3440
		$classes = explode( ' ', trim( $admin_body_class ) );
3441
3442
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3443
3444
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3445
		return " $admin_body_class ";
3446
	}
3447
3448
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3449
		return $admin_body_class . ' jetpack-pagestyles ';
3450
	}
3451
3452
	/**
3453
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3454
	 *
3455
	 * @return null
3456
	 */
3457
	function prepare_manage_jetpack_notice() {
3458
3459
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3460
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3461
	}
3462
3463
	function manage_activate_screen() {
3464
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3465
	}
3466
	/**
3467
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3468
	 * This function artificially throws errors for such cases (whitelisted).
3469
	 *
3470
	 * @param string $plugin The activated plugin.
3471
	 */
3472
	function throw_error_on_activate_plugin( $plugin ) {
3473
		$active_modules = Jetpack::get_active_modules();
3474
3475
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3476
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3477
			$throw = false;
3478
3479
			// Try and make sure it really was the stats plugin
3480
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3481
				if ( 'stats.php' == basename( $plugin ) ) {
3482
					$throw = true;
3483
				}
3484
			} else {
3485
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3486
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3487
					$throw = true;
3488
				}
3489
			}
3490
3491
			if ( $throw ) {
3492
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3493
			}
3494
		}
3495
	}
3496
3497
	function intercept_plugin_error_scrape_init() {
3498
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3499
	}
3500
3501
	function intercept_plugin_error_scrape( $action, $result ) {
3502
		if ( ! $result ) {
3503
			return;
3504
		}
3505
3506
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3507
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3508
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3509
			}
3510
		}
3511
	}
3512
3513
	function add_remote_request_handlers() {
3514
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3515
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3516
	}
3517
3518
	function remote_request_handlers() {
3519
		$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...
3520
3521
		switch ( current_filter() ) {
3522
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3523
			$response = $this->upload_handler();
3524
			break;
3525
3526
		case 'wp_ajax_nopriv_jetpack_update_file' :
3527
			$response = $this->upload_handler( true );
3528
			break;
3529
		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...
3530
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3531
			break;
3532
		}
3533
3534
		if ( ! $response ) {
3535
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3536
		}
3537
3538
		if ( is_wp_error( $response ) ) {
3539
			$status_code       = $response->get_error_data();
3540
			$error             = $response->get_error_code();
3541
			$error_description = $response->get_error_message();
3542
3543
			if ( ! is_int( $status_code ) ) {
3544
				$status_code = 400;
3545
			}
3546
3547
			status_header( $status_code );
3548
			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...
3549
		}
3550
3551
		status_header( 200 );
3552
		if ( true === $response ) {
3553
			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...
3554
		}
3555
3556
		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...
3557
	}
3558
3559
	/**
3560
	 * Uploads a file gotten from the global $_FILES.
3561
	 * If `$update_media_item` is true and `post_id` is defined
3562
	 * the attachment file of the media item (gotten through of the post_id)
3563
	 * will be updated instead of add a new one.
3564
	 *
3565
	 * @param  boolean $update_media_item - update media attachment
3566
	 * @return array - An array describing the uploadind files process
3567
	 */
3568
	function upload_handler( $update_media_item = false ) {
3569
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3570
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3571
		}
3572
3573
		$user = wp_authenticate( '', '' );
3574
		if ( ! $user || is_wp_error( $user ) ) {
3575
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3576
		}
3577
3578
		wp_set_current_user( $user->ID );
3579
3580
		if ( ! current_user_can( 'upload_files' ) ) {
3581
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3582
		}
3583
3584
		if ( empty( $_FILES ) ) {
3585
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3586
		}
3587
3588
		foreach ( array_keys( $_FILES ) as $files_key ) {
3589
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3590
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3591
			}
3592
		}
3593
3594
		$media_keys = array_keys( $_FILES['media'] );
3595
3596
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3597
		if ( ! $token || is_wp_error( $token ) ) {
3598
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3599
		}
3600
3601
		$uploaded_files = array();
3602
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3603
		unset( $GLOBALS['post'] );
3604
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3605
			$file = array();
3606
			foreach ( $media_keys as $media_key ) {
3607
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3608
			}
3609
3610
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3611
3612
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3613
			if ( $hmac_provided !== $hmac_file ) {
3614
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3615
				continue;
3616
			}
3617
3618
			$_FILES['.jetpack.upload.'] = $file;
3619
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3620
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3621
				$post_id = 0;
3622
			}
3623
3624
			if ( $update_media_item ) {
3625
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3626
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3627
				}
3628
3629
				$media_array = $_FILES['media'];
3630
3631
				$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...
3632
				$file_array['type'] = $media_array['type'][0];
3633
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3634
				$file_array['error'] = $media_array['error'][0];
3635
				$file_array['size'] = $media_array['size'][0];
3636
3637
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3638
3639
				if ( is_wp_error( $edited_media_item ) ) {
3640
					return $edited_media_item;
3641
				}
3642
3643
				$response = (object) array(
3644
					'id'   => (string) $post_id,
3645
					'file' => (string) $edited_media_item->post_title,
3646
					'url'  => (string) wp_get_attachment_url( $post_id ),
3647
					'type' => (string) $edited_media_item->post_mime_type,
3648
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3649
				);
3650
3651
				return (array) array( $response );
3652
			}
3653
3654
			$attachment_id = media_handle_upload(
3655
				'.jetpack.upload.',
3656
				$post_id,
3657
				array(),
3658
				array(
3659
					'action' => 'jetpack_upload_file',
3660
				)
3661
			);
3662
3663
			if ( ! $attachment_id ) {
3664
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3665
			} elseif ( is_wp_error( $attachment_id ) ) {
3666
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3667
			} else {
3668
				$attachment = get_post( $attachment_id );
3669
				$uploaded_files[$index] = (object) array(
3670
					'id'   => (string) $attachment_id,
3671
					'file' => $attachment->post_title,
3672
					'url'  => wp_get_attachment_url( $attachment_id ),
3673
					'type' => $attachment->post_mime_type,
3674
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3675
				);
3676
				// Zip files uploads are not supported unless they are done for installation purposed
3677
				// lets delete them in case something goes wrong in this whole process
3678
				if ( 'application/zip' === $attachment->post_mime_type ) {
3679
					// Schedule a cleanup for 2 hours from now in case of failed install.
3680
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3681
				}
3682
			}
3683
		}
3684
		if ( ! is_null( $global_post ) ) {
3685
			$GLOBALS['post'] = $global_post;
3686
		}
3687
3688
		return $uploaded_files;
3689
	}
3690
3691
	/**
3692
	 * Add help to the Jetpack page
3693
	 *
3694
	 * @since Jetpack (1.2.3)
3695
	 * @return false if not the Jetpack page
3696
	 */
3697
	function admin_help() {
3698
		$current_screen = get_current_screen();
3699
3700
		// Overview
3701
		$current_screen->add_help_tab(
3702
			array(
3703
				'id'		=> 'home',
3704
				'title'		=> __( 'Home', 'jetpack' ),
3705
				'content'	=>
3706
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3707
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3708
					'<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>',
3709
			)
3710
		);
3711
3712
		// Screen Content
3713
		if ( current_user_can( 'manage_options' ) ) {
3714
			$current_screen->add_help_tab(
3715
				array(
3716
					'id'		=> 'settings',
3717
					'title'		=> __( 'Settings', 'jetpack' ),
3718
					'content'	=>
3719
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3720
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3721
						'<ol>' .
3722
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3723
							'<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>' .
3724
						'</ol>' .
3725
						'<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>'
3726
				)
3727
			);
3728
		}
3729
3730
		// Help Sidebar
3731
		$current_screen->set_help_sidebar(
3732
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3733
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3734
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3735
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3736
		);
3737
	}
3738
3739
	function admin_menu_css() {
3740
		wp_enqueue_style( 'jetpack-icons' );
3741
	}
3742
3743
	function admin_menu_order() {
3744
		return true;
3745
	}
3746
3747 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3748
		$jp_menu_order = array();
3749
3750
		foreach ( $menu_order as $index => $item ) {
3751
			if ( $item != 'jetpack' ) {
3752
				$jp_menu_order[] = $item;
3753
			}
3754
3755
			if ( $index == 0 ) {
3756
				$jp_menu_order[] = 'jetpack';
3757
			}
3758
		}
3759
3760
		return $jp_menu_order;
3761
	}
3762
3763
	function admin_head() {
3764 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3765
			/** This action is documented in class.jetpack-admin-page.php */
3766
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3767
	}
3768
3769
	function admin_banner_styles() {
3770
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3771
3772 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3773
			wp_register_style(
3774
				'jetpack-dops-style',
3775
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3776
				array(),
3777
				JETPACK__VERSION
3778
			);
3779
		}
3780
3781
		wp_enqueue_style(
3782
			'jetpack',
3783
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3784
			array( 'jetpack-dops-style' ),
3785
			 JETPACK__VERSION . '-20121016'
3786
		);
3787
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3788
		wp_style_add_data( 'jetpack', 'suffix', $min );
3789
	}
3790
3791
	function plugin_action_links( $actions ) {
3792
3793
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3794
3795
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3796
			return array_merge(
3797
				$jetpack_home,
3798
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3799
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3800
				$actions
3801
				);
3802
			}
3803
3804
		return array_merge( $jetpack_home, $actions );
3805
	}
3806
3807
	/**
3808
	 * This is the first banner
3809
	 * It should be visible only to user that can update the option
3810
	 * Are not connected
3811
	 *
3812
	 * @return null
3813
	 */
3814
	function admin_jetpack_manage_notice() {
3815
		$screen = get_current_screen();
3816
3817
		// Don't show the connect notice on the jetpack settings page.
3818
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3819
			return;
3820
		}
3821
3822
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3823
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3824
		/**
3825
		 * I think it would be great to have different wordsing depending on where you are
3826
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3827
		 * etc..
3828
		 */
3829
3830
		?>
3831
		<div id="message" class="updated jp-banner">
3832
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3833
				<div class="jp-banner__description-container">
3834
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3835
					<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>
3836
					<p class="jp-banner__button-container">
3837
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3838
						<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>
3839
					</p>
3840
				</div>
3841
		</div>
3842
		<?php
3843
	}
3844
3845
	/**
3846
	 * Returns the url that the user clicks to remove the notice for the big banner
3847
	 * @return string
3848
	 */
3849
	function opt_out_jetpack_manage_url() {
3850
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3851
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3852
	}
3853
	/**
3854
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3855
	 * @return string
3856
	 */
3857
	function opt_in_jetpack_manage_url() {
3858
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3859
	}
3860
3861
	function opt_in_jetpack_manage_notice() {
3862
		?>
3863
		<div class="wrap">
3864
			<div id="message" class="jetpack-message is-opt-in">
3865
				<?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' ); ?>
3866
			</div>
3867
		</div>
3868
		<?php
3869
3870
	}
3871
	/**
3872
	 * Determines whether to show the notice of not true = display notice
3873
	 * @return bool
3874
	 */
3875
	function can_display_jetpack_manage_notice() {
3876
		// never display the notice to users that can't do anything about it anyways
3877
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3878
			return false;
3879
3880
		// don't display if we are in development more
3881
		if( Jetpack::is_development_mode() ) {
3882
			return false;
3883
		}
3884
		// don't display if the site is private
3885
		if(  ! Jetpack_Options::get_option( 'public' ) )
3886
			return false;
3887
3888
		/**
3889
		 * Should the Jetpack Remote Site Management notice be displayed.
3890
		 *
3891
		 * @since 3.3.0
3892
		 *
3893
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3894
		 */
3895
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3896
	}
3897
3898
	/*
3899
	 * Registration flow:
3900
	 * 1 - ::admin_page_load() action=register
3901
	 * 2 - ::try_registration()
3902
	 * 3 - ::register()
3903
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3904
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3905
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3906
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3907
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3908
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3909
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3910
	 *       jetpack_id, jetpack_secret, jetpack_public
3911
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3912
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3913
	 * 5 - user logs in with WP.com account
3914
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3915
	 *		- Jetpack_Client_Server::authorize()
3916
	 *		- Jetpack_Client_Server::get_token()
3917
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3918
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3919
	 *			- which responds with access_token, token_type, scope
3920
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3921
	 *		- Jetpack::activate_default_modules()
3922
	 *     		- Deactivates deprecated plugins
3923
	 *     		- Activates all default modules
3924
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3925
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3926
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3927
	 *     Done!
3928
	 */
3929
3930
	/**
3931
	 * Handles the page load events for the Jetpack admin page
3932
	 */
3933
	function admin_page_load() {
3934
		$error = false;
3935
3936
		// Make sure we have the right body class to hook stylings for subpages off of.
3937
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3938
3939
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3940
			// Should only be used in intermediate redirects to preserve state across redirects
3941
			Jetpack::restate();
3942
		}
3943
3944
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3945
			// User clicked in the iframe to link their accounts
3946
			if ( ! Jetpack::is_user_connected() ) {
3947
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3948
				if ( isset( $_GET['notes_iframe'] ) )
3949
					$connect_url .= '&notes_iframe';
3950
				wp_redirect( $connect_url );
3951
				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...
3952
			} else {
3953
				if ( ! isset( $_GET['calypso_env'] ) ) {
3954
					Jetpack::state( 'message', 'already_authorized' );
3955
					wp_safe_redirect( Jetpack::admin_url() );
3956
					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...
3957
				} else {
3958
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3959
					$connect_url .= '&already_authorized=true';
3960
					wp_redirect( $connect_url );
3961
					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...
3962
				}
3963
			}
3964
		}
3965
3966
3967
		if ( isset( $_GET['action'] ) ) {
3968
			switch ( $_GET['action'] ) {
3969
			case 'authorize':
3970
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3971
					Jetpack::state( 'message', 'already_authorized' );
3972
					wp_safe_redirect( Jetpack::admin_url() );
3973
					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...
3974
				}
3975
				Jetpack::log( 'authorize' );
3976
				$client_server = new Jetpack_Client_Server;
3977
				$client_server->client_authorize();
3978
				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...
3979
			case 'register' :
3980
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3981
					$error = 'cheatin';
3982
					break;
3983
				}
3984
				check_admin_referer( 'jetpack-register' );
3985
				Jetpack::log( 'register' );
3986
				Jetpack::maybe_set_version_option();
3987
				$registered = Jetpack::try_registration();
3988
				if ( is_wp_error( $registered ) ) {
3989
					$error = $registered->get_error_code();
3990
					Jetpack::state( 'error', $error );
3991
					Jetpack::state( 'error', $registered->get_error_message() );
3992
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3993
						'error_code' => $error,
3994
						'error_message' => $registered->get_error_message()
3995
					) );
3996
					break;
3997
				}
3998
3999
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4000
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4001
4002
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4003
					'from' => $from
4004
				) );
4005
4006
				$url = $this->build_connect_url( true, $redirect, $from );
4007
4008
				if ( ! empty( $_GET['onboarding'] ) ) {
4009
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4010
				}
4011
4012
				wp_redirect( $url );
4013
				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...
4014
			case 'activate' :
4015
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4016
					$error = 'cheatin';
4017
					break;
4018
				}
4019
4020
				$module = stripslashes( $_GET['module'] );
4021
				check_admin_referer( "jetpack_activate-$module" );
4022
				Jetpack::log( 'activate', $module );
4023
				Jetpack::activate_module( $module );
4024
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4025
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4026
				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...
4027
			case 'activate_default_modules' :
4028
				check_admin_referer( 'activate_default_modules' );
4029
				Jetpack::log( 'activate_default_modules' );
4030
				Jetpack::restate();
4031
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4032
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4033
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4034
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4035
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4036
				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...
4037
			case 'disconnect' :
4038
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4039
					$error = 'cheatin';
4040
					break;
4041
				}
4042
4043
				check_admin_referer( 'jetpack-disconnect' );
4044
				Jetpack::log( 'disconnect' );
4045
				Jetpack::disconnect();
4046
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4047
				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...
4048
			case 'reconnect' :
4049
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4050
					$error = 'cheatin';
4051
					break;
4052
				}
4053
4054
				check_admin_referer( 'jetpack-reconnect' );
4055
				Jetpack::log( 'reconnect' );
4056
				$this->disconnect();
4057
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4058
				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...
4059 View Code Duplication
			case 'deactivate' :
4060
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4061
					$error = 'cheatin';
4062
					break;
4063
				}
4064
4065
				$modules = stripslashes( $_GET['module'] );
4066
				check_admin_referer( "jetpack_deactivate-$modules" );
4067
				foreach ( explode( ',', $modules ) as $module ) {
4068
					Jetpack::log( 'deactivate', $module );
4069
					Jetpack::deactivate_module( $module );
4070
					Jetpack::state( 'message', 'module_deactivated' );
4071
				}
4072
				Jetpack::state( 'module', $modules );
4073
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4074
				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...
4075
			case 'unlink' :
4076
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4077
				check_admin_referer( 'jetpack-unlink' );
4078
				Jetpack::log( 'unlink' );
4079
				$this->unlink_user();
4080
				Jetpack::state( 'message', 'unlinked' );
4081
				if ( 'sub-unlink' == $redirect ) {
4082
					wp_safe_redirect( admin_url() );
4083
				} else {
4084
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4085
				}
4086
				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...
4087
			case 'onboard' :
4088
				if ( ! current_user_can( 'manage_options' ) ) {
4089
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4090
				} else {
4091
					Jetpack::create_onboarding_token();
4092
					$url = $this->build_connect_url( true );
4093
4094
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4095
						$url = add_query_arg( 'onboarding', $token, $url );
4096
					}
4097
4098
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4099
					if ( $calypso_env ) {
4100
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4101
					}
4102
4103
					wp_redirect( $url );
4104
					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...
4105
				}
4106
				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...
4107
			default:
4108
				/**
4109
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4110
				 *
4111
				 * @since 2.6.0
4112
				 *
4113
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4114
				 */
4115
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4116
			}
4117
		}
4118
4119
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4120
			self::activate_new_modules( true );
4121
		}
4122
4123
		$message_code = Jetpack::state( 'message' );
4124
		if ( Jetpack::state( 'optin-manage' ) ) {
4125
			$activated_manage = $message_code;
4126
			$message_code = 'jetpack-manage';
4127
		}
4128
4129
		switch ( $message_code ) {
4130
		case 'jetpack-manage':
4131
			$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>';
4132
			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...
4133
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4134
			}
4135
			break;
4136
4137
		}
4138
4139
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4140
4141
		if ( ! empty( $deactivated_plugins ) ) {
4142
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4143
			$deactivated_titles  = array();
4144
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4145
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4146
					continue;
4147
				}
4148
4149
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4150
			}
4151
4152
			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...
4153
				if ( $this->message ) {
4154
					$this->message .= "<br /><br />\n";
4155
				}
4156
4157
				$this->message .= wp_sprintf(
4158
					_n(
4159
						'Jetpack contains the most recent version of the old %l plugin.',
4160
						'Jetpack contains the most recent versions of the old %l plugins.',
4161
						count( $deactivated_titles ),
4162
						'jetpack'
4163
					),
4164
					$deactivated_titles
4165
				);
4166
4167
				$this->message .= "<br />\n";
4168
4169
				$this->message .= _n(
4170
					'The old version has been deactivated and can be removed from your site.',
4171
					'The old versions have been deactivated and can be removed from your site.',
4172
					count( $deactivated_titles ),
4173
					'jetpack'
4174
				);
4175
			}
4176
		}
4177
4178
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4179
4180
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4181
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4182
		}
4183
4184 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4185
			/**
4186
			 * Fires when a module configuration page is loaded.
4187
			 * The dynamic part of the hook is the configure parameter from the URL.
4188
			 *
4189
			 * @since 1.1.0
4190
			 */
4191
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4192
		}
4193
4194
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4195
	}
4196
4197
	function admin_notices() {
4198
4199
		if ( $this->error ) {
4200
?>
4201
<div id="message" class="jetpack-message jetpack-err">
4202
	<div class="squeezer">
4203
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4204
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4205
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4206
<?php	endif; ?>
4207
	</div>
4208
</div>
4209
<?php
4210
		}
4211
4212
		if ( $this->message ) {
4213
?>
4214
<div id="message" class="jetpack-message">
4215
	<div class="squeezer">
4216
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4217
	</div>
4218
</div>
4219
<?php
4220
		}
4221
4222
		if ( $this->privacy_checks ) :
4223
			$module_names = $module_slugs = array();
4224
4225
			$privacy_checks = explode( ',', $this->privacy_checks );
4226
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4227
			foreach ( $privacy_checks as $module_slug ) {
4228
				$module = Jetpack::get_module( $module_slug );
4229
				if ( ! $module ) {
4230
					continue;
4231
				}
4232
4233
				$module_slugs[] = $module_slug;
4234
				$module_names[] = "<strong>{$module['name']}</strong>";
4235
			}
4236
4237
			$module_slugs = join( ',', $module_slugs );
4238
?>
4239
<div id="message" class="jetpack-message jetpack-err">
4240
	<div class="squeezer">
4241
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4242
		<p><?php
4243
			echo wp_kses(
4244
				wptexturize(
4245
					wp_sprintf(
4246
						_nx(
4247
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4248
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4249
							count( $privacy_checks ),
4250
							'%l = list of Jetpack module/feature names',
4251
							'jetpack'
4252
						),
4253
						$module_names
4254
					)
4255
				),
4256
				array( 'strong' => true )
4257
			);
4258
4259
			echo "\n<br />\n";
4260
4261
			echo wp_kses(
4262
				sprintf(
4263
					_nx(
4264
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4265
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4266
						count( $privacy_checks ),
4267
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4268
						'jetpack'
4269
					),
4270
					wp_nonce_url(
4271
						Jetpack::admin_url(
4272
							array(
4273
								'page'   => 'jetpack',
4274
								'action' => 'deactivate',
4275
								'module' => urlencode( $module_slugs ),
4276
							)
4277
						),
4278
						"jetpack_deactivate-$module_slugs"
4279
					),
4280
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4281
				),
4282
				array( 'a' => array( 'href' => true, 'title' => true ) )
4283
			);
4284
		?></p>
4285
	</div>
4286
</div>
4287
<?php endif;
4288
	// only display the notice if the other stuff is not there
4289
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4290
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4291
			$this->opt_in_jetpack_manage_notice();
4292
		}
4293
	}
4294
4295
	/**
4296
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4297
	 */
4298
	function stat( $group, $detail ) {
4299
		if ( ! isset( $this->stats[ $group ] ) )
4300
			$this->stats[ $group ] = array();
4301
		$this->stats[ $group ][] = $detail;
4302
	}
4303
4304
	/**
4305
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4306
	 */
4307
	function do_stats( $method = '' ) {
4308
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4309
			foreach ( $this->stats as $group => $stats ) {
4310
				if ( is_array( $stats ) && count( $stats ) ) {
4311
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4312
					if ( 'server_side' === $method ) {
4313
						self::do_server_side_stat( $args );
4314
					} else {
4315
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4316
					}
4317
				}
4318
				unset( $this->stats[ $group ] );
4319
			}
4320
		}
4321
	}
4322
4323
	/**
4324
	 * Runs stats code for a one-off, server-side.
4325
	 *
4326
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4327
	 *
4328
	 * @return bool If it worked.
4329
	 */
4330
	static function do_server_side_stat( $args ) {
4331
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4332
		if ( is_wp_error( $response ) )
4333
			return false;
4334
4335
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4336
			return false;
4337
4338
		return true;
4339
	}
4340
4341
	/**
4342
	 * Builds the stats url.
4343
	 *
4344
	 * @param $args array|string The arguments to append to the URL.
4345
	 *
4346
	 * @return string The URL to be pinged.
4347
	 */
4348
	static function build_stats_url( $args ) {
4349
		$defaults = array(
4350
			'v'    => 'wpcom2',
4351
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4352
		);
4353
		$args     = wp_parse_args( $args, $defaults );
4354
		/**
4355
		 * Filter the URL used as the Stats tracking pixel.
4356
		 *
4357
		 * @since 2.3.2
4358
		 *
4359
		 * @param string $url Base URL used as the Stats tracking pixel.
4360
		 */
4361
		$base_url = apply_filters(
4362
			'jetpack_stats_base_url',
4363
			'https://pixel.wp.com/g.gif'
4364
		);
4365
		$url      = add_query_arg( $args, $base_url );
4366
		return $url;
4367
	}
4368
4369
	static function translate_current_user_to_role() {
4370
		foreach ( self::$capability_translations as $role => $cap ) {
4371
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4372
				return $role;
4373
			}
4374
		}
4375
4376
		return false;
4377
	}
4378
4379
	static function translate_user_to_role( $user ) {
4380
		foreach ( self::$capability_translations as $role => $cap ) {
4381
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4382
				return $role;
4383
			}
4384
		}
4385
4386
		return false;
4387
    }
4388
4389
	static function translate_role_to_cap( $role ) {
4390
		if ( ! isset( self::$capability_translations[$role] ) ) {
4391
			return false;
4392
		}
4393
4394
		return self::$capability_translations[$role];
4395
	}
4396
4397
	static function sign_role( $role, $user_id = null ) {
4398
		if ( empty( $user_id ) ) {
4399
			$user_id = (int) get_current_user_id();
4400
		}
4401
4402
		if ( ! $user_id  ) {
4403
			return false;
4404
		}
4405
4406
		$token = Jetpack_Data::get_access_token();
4407
		if ( ! $token || is_wp_error( $token ) ) {
4408
			return false;
4409
		}
4410
4411
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4412
	}
4413
4414
4415
	/**
4416
	 * Builds a URL to the Jetpack connection auth page
4417
	 *
4418
	 * @since 3.9.5
4419
	 *
4420
	 * @param bool $raw If true, URL will not be escaped.
4421
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4422
	 *                              If string, will be a custom redirect.
4423
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4424
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4425
	 *
4426
	 * @return string Connect URL
4427
	 */
4428
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4429
		$site_id = Jetpack_Options::get_option( 'id' );
4430
		$token = Jetpack_Options::get_option( 'blog_token' );
4431
4432
		if ( $register || ! $token || ! $site_id ) {
4433
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4434
4435
			if ( ! empty( $redirect ) ) {
4436
				$url = add_query_arg(
4437
					'redirect',
4438
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4439
					$url
4440
				);
4441
			}
4442
4443
			if( is_network_admin() ) {
4444
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4445
			}
4446
		} else {
4447
4448
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4449
			// because otherwise this logic can get us in to a loop.
4450
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4451
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4452
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4453
4454
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4455
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4456
					'1.1'
4457
				);
4458
4459
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4460
					// Generating a register URL instead to refresh the existing token
4461
					return $this->build_connect_url( $raw, $redirect, $from, true );
4462
				}
4463
			}
4464
4465
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4466
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4467
			}
4468
4469
			$role = self::translate_current_user_to_role();
4470
			$signed_role = self::sign_role( $role );
4471
4472
			$user = wp_get_current_user();
4473
4474
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4475
			$redirect = $redirect
4476
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4477
				: $jetpack_admin_page;
4478
4479
			if( isset( $_REQUEST['is_multisite'] ) ) {
4480
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4481
			}
4482
4483
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4484
4485
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4486
				? get_site_icon_url()
4487
				: false;
4488
4489
			/**
4490
			 * Filter the type of authorization.
4491
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4492
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4493
			 *
4494
			 * @since 4.3.3
4495
			 *
4496
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4497
			 */
4498
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4499
4500
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4501
4502
			$args = urlencode_deep(
4503
				array(
4504
					'response_type' => 'code',
4505
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4506
					'redirect_uri'  => add_query_arg(
4507
						array(
4508
							'action'   => 'authorize',
4509
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4510
							'redirect' => urlencode( $redirect ),
4511
						),
4512
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4513
					),
4514
					'state'         => $user->ID,
4515
					'scope'         => $signed_role,
4516
					'user_email'    => $user->user_email,
4517
					'user_login'    => $user->user_login,
4518
					'is_active'     => Jetpack::is_active(),
4519
					'jp_version'    => JETPACK__VERSION,
4520
					'auth_type'     => $auth_type,
4521
					'secret'        => $secrets['secret_1'],
4522
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4523
					'blogname'      => get_option( 'blogname' ),
4524
					'site_url'      => site_url(),
4525
					'home_url'      => home_url(),
4526
					'site_icon'     => $site_icon,
4527
					'site_lang'     => get_locale(),
4528
					'_ui'           => $tracks_identity['_ui'],
4529
					'_ut'           => $tracks_identity['_ut']
4530
				)
4531
			);
4532
4533
			self::apply_activation_source_to_args( $args );
4534
4535
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4536
		}
4537
4538
		if ( $from ) {
4539
			$url = add_query_arg( 'from', $from, $url );
4540
		}
4541
4542
4543
		if ( isset( $_GET['calypso_env'] ) ) {
4544
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4545
		}
4546
4547
		return $raw ? $url : esc_url( $url );
4548
	}
4549
4550
	public static function apply_activation_source_to_args( &$args ) {
4551
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4552
4553
		if ( $activation_source_name ) {
4554
			$args['_as'] = urlencode( $activation_source_name );
4555
		}
4556
4557
		if ( $activation_source_keyword ) {
4558
			$args['_ak'] = urlencode( $activation_source_keyword );
4559
		}
4560
	}
4561
4562
	function build_reconnect_url( $raw = false ) {
4563
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4564
		return $raw ? $url : esc_url( $url );
4565
	}
4566
4567
	public static function admin_url( $args = null ) {
4568
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4569
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4570
		return $url;
4571
	}
4572
4573
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4574
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4575
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4576
	}
4577
4578
	function dismiss_jetpack_notice() {
4579
4580
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4581
			return;
4582
		}
4583
4584
		switch( $_GET['jetpack-notice'] ) {
4585
			case 'dismiss':
4586
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4587
4588
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4589
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4590
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4591
				}
4592
				break;
4593 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...
4594
4595
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4596
					// Don't show the banner again
4597
4598
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4599
					// redirect back to the page that had the notice
4600
					if ( wp_get_referer() ) {
4601
						wp_safe_redirect( wp_get_referer() );
4602
					} else {
4603
						// Take me to Jetpack
4604
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4605
					}
4606
				}
4607
				break;
4608 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...
4609
4610
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4611
					// Don't show the banner again
4612
4613
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4614
					// redirect back to the page that had the notice
4615
					if ( wp_get_referer() ) {
4616
						wp_safe_redirect( wp_get_referer() );
4617
					} else {
4618
						// Take me to Jetpack
4619
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4620
					}
4621
				}
4622
				break;
4623
			case 'jetpack-manage-opt-in':
4624
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4625
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4626
4627
					$redirection_url = Jetpack::admin_url();
4628
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4629
4630
					// Don't redirect form the Jetpack Setting Page
4631
					$referer_parsed = parse_url ( wp_get_referer() );
4632
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4633
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4634
						// Take the user to Jetpack home except when on the setting page
4635
						$redirection_url = wp_get_referer();
4636
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4637
					}
4638
					// Also update the JSON API FULL MANAGEMENT Option
4639
					Jetpack::activate_module( 'manage', false, false );
4640
4641
					// Special Message when option in.
4642
					Jetpack::state( 'optin-manage', 'true' );
4643
					// Activate the Module if not activated already
4644
4645
					// Redirect properly
4646
					wp_safe_redirect( $redirection_url );
4647
4648
				}
4649
				break;
4650
		}
4651
	}
4652
4653
	public static function admin_screen_configure_module( $module_id ) {
4654
4655
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4656
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4657
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4658
				/**
4659
				 * Fires to diplay a custom module activation screen.
4660
				 *
4661
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4662
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4663
				 *
4664
				 * @module manage
4665
				 *
4666
				 * @since 3.8.0
4667
				 *
4668
				 * @param int $module_id Module ID.
4669
				 */
4670
				do_action( 'display_activate_module_setting_' . $module_id );
4671
			} else {
4672
				self::display_activate_module_link( $module_id );
4673
			}
4674
4675
			return false;
4676
		} ?>
4677
4678
		<div id="jp-settings-screen" style="position: relative">
4679
			<h3>
4680
			<?php
4681
				$module = Jetpack::get_module( $module_id );
4682
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4683
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4684
			?>
4685
			</h3>
4686
			<?php
4687
				/**
4688
				 * Fires within the displayed message when a feature configuation is updated.
4689
				 *
4690
				 * @since 3.4.0
4691
				 *
4692
				 * @param int $module_id Module ID.
4693
				 */
4694
				do_action( 'jetpack_notices_update_settings', $module_id );
4695
				/**
4696
				 * Fires when a feature configuation screen is loaded.
4697
				 * The dynamic part of the hook, $module_id, is the module ID.
4698
				 *
4699
				 * @since 1.1.0
4700
				 */
4701
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4702
			?>
4703
		</div><?php
4704
	}
4705
4706
	/**
4707
	 * Display link to activate the module to see the settings screen.
4708
	 * @param  string $module_id
4709
	 * @return null
4710
	 */
4711
	public static function display_activate_module_link( $module_id ) {
4712
4713
		$info =  Jetpack::get_module( $module_id );
4714
		$extra = '';
4715
		$activate_url = wp_nonce_url(
4716
				Jetpack::admin_url(
4717
					array(
4718
						'page'   => 'jetpack',
4719
						'action' => 'activate',
4720
						'module' => $module_id,
4721
					)
4722
				),
4723
				"jetpack_activate-$module_id"
4724
			);
4725
4726
		?>
4727
4728
		<div class="wrap configure-module">
4729
			<div id="jp-settings-screen">
4730
				<?php
4731
				if ( $module_id == 'json-api' ) {
4732
4733
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4734
4735
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4736
4737
					$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' );
4738
4739
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4740
				} ?>
4741
4742
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4743
				<div class="narrow">
4744
					<p><?php echo  $info['description']; ?></p>
4745
					<?php if( $extra ) { ?>
4746
					<p><?php echo esc_html( $extra ); ?></p>
4747
					<?php } ?>
4748
					<p>
4749
						<?php
4750
						if( wp_get_referer() ) {
4751
							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() );
4752
						} else {
4753
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4754
						} ?>
4755
					</p>
4756
				</div>
4757
4758
			</div>
4759
		</div>
4760
4761
		<?php
4762
	}
4763
4764
	public static function sort_modules( $a, $b ) {
4765
		if ( $a['sort'] == $b['sort'] )
4766
			return 0;
4767
4768
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4769
	}
4770
4771
	function ajax_recheck_ssl() {
4772
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4773
		$result = Jetpack::permit_ssl( true );
4774
		wp_send_json( array(
4775
			'enabled' => $result,
4776
			'message' => get_transient( 'jetpack_https_test_message' )
4777
		) );
4778
	}
4779
4780
/* Client API */
4781
4782
	/**
4783
	 * Returns the requested Jetpack API URL
4784
	 *
4785
	 * @return string
4786
	 */
4787
	public static function api_url( $relative_url ) {
4788
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4789
	}
4790
4791
	/**
4792
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4793
	 */
4794
	public static function fix_url_for_bad_hosts( $url ) {
4795
		if ( 0 !== strpos( $url, 'https://' ) ) {
4796
			return $url;
4797
		}
4798
4799
		switch ( JETPACK_CLIENT__HTTPS ) {
4800
			case 'ALWAYS' :
4801
				return $url;
4802
			case 'NEVER' :
4803
				return set_url_scheme( $url, 'http' );
4804
			// default : case 'AUTO' :
4805
		}
4806
4807
		// we now return the unmodified SSL URL by default, as a security precaution
4808
		return $url;
4809
	}
4810
4811
	/**
4812
	 * Create a random secret for validating onboarding payload
4813
	 *
4814
	 * @return string Secret token
4815
	 */
4816
	public static function create_onboarding_token() {
4817
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4818
			$token = wp_generate_password( 32, false );
4819
			Jetpack_Options::update_option( 'onboarding', $token );
4820
		}
4821
4822
		return $token;
4823
	}
4824
4825
	/**
4826
	 * Remove the onboarding token
4827
	 *
4828
	 * @return bool True on success, false on failure
4829
	 */
4830
	public static function invalidate_onboarding_token() {
4831
		return Jetpack_Options::delete_option( 'onboarding' );
4832
	}
4833
4834
	/**
4835
	 * Validate an onboarding token for a specific action
4836
	 *
4837
	 * @return boolean True if token/action pair is accepted, false if not
4838
	 */
4839
	public static function validate_onboarding_token_action( $token, $action ) {
4840
		// Compare tokens, bail if tokens do not match
4841
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4842
			return false;
4843
		}
4844
4845
		// List of valid actions we can take
4846
		$valid_actions = array(
4847
			'/jetpack/v4/settings',
4848
		);
4849
4850
		// Whitelist the action
4851
		if ( ! in_array( $action, $valid_actions ) ) {
4852
			return false;
4853
		}
4854
4855
		return true;
4856
	}
4857
4858
	/**
4859
	 * Checks to see if the URL is using SSL to connect with Jetpack
4860
	 *
4861
	 * @since 2.3.3
4862
	 * @return boolean
4863
	 */
4864
	public static function permit_ssl( $force_recheck = false ) {
4865
		// Do some fancy tests to see if ssl is being supported
4866
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4867
			$message = '';
4868
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4869
				$ssl = 0;
4870
			} else {
4871
				switch ( JETPACK_CLIENT__HTTPS ) {
4872
					case 'NEVER':
4873
						$ssl = 0;
4874
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4875
						break;
4876
					case 'ALWAYS':
4877
					case 'AUTO':
4878
					default:
4879
						$ssl = 1;
4880
						break;
4881
				}
4882
4883
				// If it's not 'NEVER', test to see
4884
				if ( $ssl ) {
4885
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4886
						$ssl = 0;
4887
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4888
					} else {
4889
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4890
						if ( is_wp_error( $response ) ) {
4891
							$ssl = 0;
4892
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4893
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4894
							$ssl = 0;
4895
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4896
						}
4897
					}
4898
				}
4899
			}
4900
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4901
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4902
		}
4903
4904
		return (bool) $ssl;
4905
	}
4906
4907
	/*
4908
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4909
	 */
4910
	public function alert_auto_ssl_fail() {
4911
		if ( ! current_user_can( 'manage_options' ) )
4912
			return;
4913
4914
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4915
		?>
4916
4917
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4918
			<div class="jp-banner__content">
4919
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4920
				<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>
4921
				<p>
4922
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4923
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4924
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4925
				</p>
4926
				<p>
4927
					<?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' ),
4928
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4929
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4930
				</p>
4931
			</div>
4932
		</div>
4933
		<style>
4934
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4935
		</style>
4936
		<script type="text/javascript">
4937
			jQuery( document ).ready( function( $ ) {
4938
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4939
					var $this = $( this );
4940
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4941
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4942
					e.preventDefault();
4943
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4944
					$.post( ajaxurl, data )
4945
					  .done( function( response ) {
4946
					  	if ( response.enabled ) {
4947
					  		$( '#jetpack-ssl-warning' ).hide();
4948
					  	} else {
4949
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4950
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4951
					  	}
4952
					  }.bind( $this ) );
4953
				} );
4954
			} );
4955
		</script>
4956
4957
		<?php
4958
	}
4959
4960
	/**
4961
	 * Returns the Jetpack XML-RPC API
4962
	 *
4963
	 * @return string
4964
	 */
4965
	public static function xmlrpc_api_url() {
4966
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4967
		return untrailingslashit( $base ) . '/xmlrpc.php';
4968
	}
4969
4970
	/**
4971
	 * Creates two secret tokens and the end of life timestamp for them.
4972
	 *
4973
	 * Note these tokens are unique per call, NOT static per site for connecting.
4974
	 *
4975
	 * @since 2.6
4976
	 * @return array
4977
	 */
4978
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4979
		if ( ! $user_id ) {
4980
			$user_id = get_current_user_id();
4981
		}
4982
4983
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4984
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4985
4986
		if (
4987
			isset( $secrets[ $secret_name ] ) &&
4988
			$secrets[ $secret_name ]['exp'] > time()
4989
		) {
4990
			return $secrets[ $secret_name ];
4991
		}
4992
4993
		$secret_value = array(
4994
			'secret_1'  => wp_generate_password( 32, false ),
4995
			'secret_2'  => wp_generate_password( 32, false ),
4996
			'exp'       => time() + $exp,
4997
		);
4998
4999
		$secrets[ $secret_name ] = $secret_value;
5000
5001
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5002
		return $secrets[ $secret_name ];
5003
	}
5004
5005
	public static function get_secrets( $action, $user_id ) {
5006
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5007
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5008
5009
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5010
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5011
		}
5012
5013
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5014
			self::delete_secrets( $action, $user_id );
5015
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5016
		}
5017
5018
		return $secrets[ $secret_name ];
5019
	}
5020
5021
	public static function delete_secrets( $action, $user_id ) {
5022
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5023
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5024
		if ( isset( $secrets[ $secret_name ] ) ) {
5025
			unset( $secrets[ $secret_name ] );
5026
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5027
		}
5028
	}
5029
5030
	/**
5031
	 * Builds the timeout limit for queries talking with the wpcom servers.
5032
	 *
5033
	 * Based on local php max_execution_time in php.ini
5034
	 *
5035
	 * @since 2.6
5036
	 * @return int
5037
	 * @deprecated
5038
	 **/
5039
	public function get_remote_query_timeout_limit() {
5040
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5041
		return Jetpack::get_max_execution_time();
5042
	}
5043
5044
	/**
5045
	 * Builds the timeout limit for queries talking with the wpcom servers.
5046
	 *
5047
	 * Based on local php max_execution_time in php.ini
5048
	 *
5049
	 * @since 5.4
5050
	 * @return int
5051
	 **/
5052
	public static function get_max_execution_time() {
5053
		$timeout = (int) ini_get( 'max_execution_time' );
5054
5055
		// Ensure exec time set in php.ini
5056
		if ( ! $timeout ) {
5057
			$timeout = 30;
5058
		}
5059
		return $timeout;
5060
	}
5061
5062
	/**
5063
	 * Sets a minimum request timeout, and returns the current timeout
5064
	 *
5065
	 * @since 5.4
5066
	 **/
5067
	public static function set_min_time_limit( $min_timeout ) {
5068
		$timeout = self::get_max_execution_time();
5069
		if ( $timeout < $min_timeout ) {
5070
			$timeout = $min_timeout;
5071
			set_time_limit( $timeout );
5072
		}
5073
		return $timeout;
5074
	}
5075
5076
5077
	/**
5078
	 * Takes the response from the Jetpack register new site endpoint and
5079
	 * verifies it worked properly.
5080
	 *
5081
	 * @since 2.6
5082
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5083
	 **/
5084
	public function validate_remote_register_response( $response ) {
5085
	  if ( is_wp_error( $response ) ) {
5086
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5087
		}
5088
5089
		$code   = wp_remote_retrieve_response_code( $response );
5090
		$entity = wp_remote_retrieve_body( $response );
5091
		if ( $entity )
5092
			$registration_response = json_decode( $entity );
5093
		else
5094
			$registration_response = false;
5095
5096
		$code_type = intval( $code / 100 );
5097
		if ( 5 == $code_type ) {
5098
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5099
		} elseif ( 408 == $code ) {
5100
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5101
		} elseif ( ! empty( $registration_response->error ) ) {
5102
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5103
				$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' );
5104
			} else {
5105
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5106
			}
5107
5108
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5109
		} elseif ( 200 != $code ) {
5110
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5111
		}
5112
5113
		// Jetpack ID error block
5114
		if ( empty( $registration_response->jetpack_id ) ) {
5115
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5116
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5117
			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 );
5118
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5119
			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 );
5120
		}
5121
5122
	    return $registration_response;
5123
	}
5124
	/**
5125
	 * @return bool|WP_Error
5126
	 */
5127
	public static function register() {
5128
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5129
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5130
		$secrets = Jetpack::generate_secrets( 'register' );
5131
5132 View Code Duplication
		if (
5133
			empty( $secrets['secret_1'] ) ||
5134
			empty( $secrets['secret_2'] ) ||
5135
			empty( $secrets['exp'] )
5136
		) {
5137
			return new Jetpack_Error( 'missing_secrets' );
5138
		}
5139
5140
		// better to try (and fail) to set a higher timeout than this system
5141
		// supports than to have register fail for more users than it should
5142
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5143
5144
		$gmt_offset = get_option( 'gmt_offset' );
5145
		if ( ! $gmt_offset ) {
5146
			$gmt_offset = 0;
5147
		}
5148
5149
		$stats_options = get_option( 'stats_options' );
5150
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5151
5152
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5153
5154
		$args = array(
5155
			'method'  => 'POST',
5156
			'body'    => array(
5157
				'siteurl'         => site_url(),
5158
				'home'            => home_url(),
5159
				'gmt_offset'      => $gmt_offset,
5160
				'timezone_string' => (string) get_option( 'timezone_string' ),
5161
				'site_name'       => (string) get_option( 'blogname' ),
5162
				'secret_1'        => $secrets['secret_1'],
5163
				'secret_2'        => $secrets['secret_2'],
5164
				'site_lang'       => get_locale(),
5165
				'timeout'         => $timeout,
5166
				'stats_id'        => $stats_id,
5167
				'state'           => get_current_user_id(),
5168
				'_ui'             => $tracks_identity['_ui'],
5169
				'_ut'             => $tracks_identity['_ut'],
5170
				'jetpack_version' => JETPACK__VERSION
5171
			),
5172
			'headers' => array(
5173
				'Accept' => 'application/json',
5174
			),
5175
			'timeout' => $timeout,
5176
		);
5177
5178
		self::apply_activation_source_to_args( $args['body'] );
5179
5180
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5181
5182
		// Make sure the response is valid and does not contain any Jetpack errors
5183
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5184
		if ( is_wp_error( $registration_details ) ) {
5185
			return $registration_details;
5186
		} elseif ( ! $registration_details ) {
5187
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5188
		}
5189
5190 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5191
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5192
		}
5193
5194
		if ( isset( $registration_details->jetpack_public ) ) {
5195
			$jetpack_public = (int) $registration_details->jetpack_public;
5196
		} else {
5197
			$jetpack_public = false;
5198
		}
5199
5200
		Jetpack_Options::update_options(
5201
			array(
5202
				'id'         => (int)    $registration_details->jetpack_id,
5203
				'blog_token' => (string) $registration_details->jetpack_secret,
5204
				'public'     => $jetpack_public,
5205
			)
5206
		);
5207
5208
		/**
5209
		 * Fires when a site is registered on WordPress.com.
5210
		 *
5211
		 * @since 3.7.0
5212
		 *
5213
		 * @param int $json->jetpack_id Jetpack Blog ID.
5214
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5215
		 * @param int|bool $jetpack_public Is the site public.
5216
		 */
5217
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5218
5219
		// Initialize Jump Start for the first and only time.
5220
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5221
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5222
5223
			$jetpack = Jetpack::init();
5224
5225
			$jetpack->stat( 'jumpstart', 'unique-views' );
5226
			$jetpack->do_stats( 'server_side' );
5227
		};
5228
5229
		return true;
5230
	}
5231
5232
	/**
5233
	 * If the db version is showing something other that what we've got now, bump it to current.
5234
	 *
5235
	 * @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...
5236
	 */
5237
	public static function maybe_set_version_option() {
5238
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5239
		if ( JETPACK__VERSION != $version ) {
5240
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5241
5242
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5243
				/** This action is documented in class.jetpack.php */
5244
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5245
			}
5246
5247
			return true;
5248
		}
5249
		return false;
5250
	}
5251
5252
/* Client Server API */
5253
5254
	/**
5255
	 * Loads the Jetpack XML-RPC client
5256
	 */
5257
	public static function load_xml_rpc_client() {
5258
		require_once ABSPATH . WPINC . '/class-IXR.php';
5259
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5260
	}
5261
5262
	/**
5263
	 * Resets the saved authentication state in between testing requests.
5264
	 */
5265
	public function reset_saved_auth_state() {
5266
		$this->xmlrpc_verification = null;
5267
		$this->rest_authentication_status = null;
5268
	}
5269
5270
	function verify_xml_rpc_signature() {
5271
		if ( $this->xmlrpc_verification ) {
5272
			return $this->xmlrpc_verification;
5273
		}
5274
5275
		// It's not for us
5276
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5277
			return false;
5278
		}
5279
5280
		@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...
5281
		if (
5282
			empty( $token_key )
5283
		||
5284
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5285
		) {
5286
			return false;
5287
		}
5288
5289
		if ( '0' === $user_id ) {
5290
			$token_type = 'blog';
5291
			$user_id = 0;
5292
		} else {
5293
			$token_type = 'user';
5294
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5295
				return false;
5296
			}
5297
			$user_id = (int) $user_id;
5298
5299
			$user = new WP_User( $user_id );
5300
			if ( ! $user || ! $user->exists() ) {
5301
				return false;
5302
			}
5303
		}
5304
5305
		$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...
5306
		if ( ! $token ) {
5307
			return false;
5308
		}
5309
5310
		$token_check = "$token_key.";
5311
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5312
			return false;
5313
		}
5314
5315
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5316
5317
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5318
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5319
			$post_data   = $_POST;
5320
			$file_hashes = array();
5321
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5322
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5323
					continue;
5324
				}
5325
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5326
				$file_hashes[$post_data_key] = $post_data_value;
5327
			}
5328
5329
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5330
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5331
				$post_data[$post_data_key] = $post_data_value;
5332
			}
5333
5334
			ksort( $post_data );
5335
5336
			$body = http_build_query( stripslashes_deep( $post_data ) );
5337
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5338
			$body = file_get_contents( 'php://input' );
5339
		} else {
5340
			$body = null;
5341
		}
5342
5343
		$signature = $jetpack_signature->sign_current_request(
5344
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5345
		);
5346
5347
		if ( ! $signature ) {
5348
			return false;
5349
		} else if ( is_wp_error( $signature ) ) {
5350
			return $signature;
5351
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5352
			return false;
5353
		}
5354
5355
		$timestamp = (int) $_GET['timestamp'];
5356
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5357
5358
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5359
			return false;
5360
		}
5361
5362
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5363
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5364
			if ( ! empty( $_GET['onboarding'] ) ) {
5365
				$jpo = $_GET;
5366
			} else {
5367
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5368
			}
5369
5370
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5371
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5372
5373
			if (
5374
				isset( $jpo_user ) && isset( $jpo_token ) &&
5375
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5376
				isset( $_GET['rest_route'] ) &&
5377
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5378
			) {
5379
				$jpUser = get_user_by( 'email', $jpo_user );
5380
				if ( is_a( $jpUser, 'WP_User' ) ) {
5381
					wp_set_current_user( $jpUser->ID );
5382
					$user_can = is_multisite()
5383
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5384
						: current_user_can( 'manage_options' );
5385
					if ( $user_can ) {
5386
						$token_type = 'user';
5387
						$token->external_user_id = $jpUser->ID;
5388
					}
5389
				}
5390
			}
5391
		}
5392
5393
		$this->xmlrpc_verification = array(
5394
			'type'    => $token_type,
5395
			'user_id' => $token->external_user_id,
5396
		);
5397
5398
		return $this->xmlrpc_verification;
5399
	}
5400
5401
	/**
5402
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5403
	 */
5404
	function authenticate_jetpack( $user, $username, $password ) {
5405
		if ( is_a( $user, 'WP_User' ) ) {
5406
			return $user;
5407
		}
5408
5409
		$token_details = $this->verify_xml_rpc_signature();
5410
5411
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5412
			return $user;
5413
		}
5414
5415
		if ( 'user' !== $token_details['type'] ) {
5416
			return $user;
5417
		}
5418
5419
		if ( ! $token_details['user_id'] ) {
5420
			return $user;
5421
		}
5422
5423
		nocache_headers();
5424
5425
		return new WP_User( $token_details['user_id'] );
5426
	}
5427
5428
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5429
	// Uses the existing XMLRPC request signing implementation.
5430
	function wp_rest_authenticate( $user ) {
5431
		if ( ! empty( $user ) ) {
5432
			// Another authentication method is in effect.
5433
			return $user;
5434
		}
5435
5436
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5437
			// Nothing to do for this authentication method.
5438
			return null;
5439
		}
5440
5441
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5442
			// Nothing to do for this authentication method.
5443
			return null;
5444
		}
5445
5446
		// Ensure that we always have the request body available.  At this
5447
		// point, the WP REST API code to determine the request body has not
5448
		// run yet.  That code may try to read from 'php://input' later, but
5449
		// this can only be done once per request in PHP versions prior to 5.6.
5450
		// So we will go ahead and perform this read now if needed, and save
5451
		// the request body where both the Jetpack signature verification code
5452
		// and the WP REST API code can see it.
5453
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5454
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5455
		}
5456
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5457
5458
		// Only support specific request parameters that have been tested and
5459
		// are known to work with signature verification.  A different method
5460
		// can be passed to the WP REST API via the '?_method=' parameter if
5461
		// needed.
5462
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5463
			$this->rest_authentication_status = new WP_Error(
5464
				'rest_invalid_request',
5465
				__( 'This request method is not supported.', 'jetpack' ),
5466
				array( 'status' => 400 )
5467
			);
5468
			return null;
5469
		}
5470
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5471
			$this->rest_authentication_status = new WP_Error(
5472
				'rest_invalid_request',
5473
				__( 'This request method does not support body parameters.', 'jetpack' ),
5474
				array( 'status' => 400 )
5475
			);
5476
			return null;
5477
		}
5478
5479
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5480
			$content_type = $_SERVER['CONTENT_TYPE'];
5481
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5482
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5483
		}
5484
5485
		if (
5486
			isset( $content_type ) &&
5487
			$content_type !== 'application/x-www-form-urlencoded' &&
5488
			$content_type !== 'application/json'
5489
		) {
5490
			$this->rest_authentication_status = new WP_Error(
5491
				'rest_invalid_request',
5492
				__( 'This Content-Type is not supported.', 'jetpack' ),
5493
				array( 'status' => 400 )
5494
			);
5495
			return null;
5496
		}
5497
5498
		$verified = $this->verify_xml_rpc_signature();
5499
5500
		if ( is_wp_error( $verified ) ) {
5501
			$this->rest_authentication_status = $verified;
5502
			return null;
5503
		}
5504
5505
		if (
5506
			$verified &&
5507
			isset( $verified['type'] ) &&
5508
			'user' === $verified['type'] &&
5509
			! empty( $verified['user_id'] )
5510
		) {
5511
			// Authentication successful.
5512
			$this->rest_authentication_status = true;
5513
			return $verified['user_id'];
5514
		}
5515
5516
		// Something else went wrong.  Probably a signature error.
5517
		$this->rest_authentication_status = new WP_Error(
5518
			'rest_invalid_signature',
5519
			__( 'The request is not signed correctly.', 'jetpack' ),
5520
			array( 'status' => 400 )
5521
		);
5522
		return null;
5523
	}
5524
5525
	/**
5526
	 * Report authentication status to the WP REST API.
5527
	 *
5528
	 * @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...
5529
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5530
	 */
5531
	public function wp_rest_authentication_errors( $value ) {
5532
		if ( $value !== null ) {
5533
			return $value;
5534
		}
5535
		return $this->rest_authentication_status;
5536
	}
5537
5538
	function add_nonce( $timestamp, $nonce ) {
5539
		global $wpdb;
5540
		static $nonces_used_this_request = array();
5541
5542
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5543
			return $nonces_used_this_request["$timestamp:$nonce"];
5544
		}
5545
5546
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5547
		$timestamp = (int) $timestamp;
5548
		$nonce     = esc_sql( $nonce );
5549
5550
		// Raw query so we can avoid races: add_option will also update
5551
		$show_errors = $wpdb->show_errors( false );
5552
5553
		$old_nonce = $wpdb->get_row(
5554
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5555
		);
5556
5557
		if ( is_null( $old_nonce ) ) {
5558
			$return = $wpdb->query(
5559
				$wpdb->prepare(
5560
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5561
					"jetpack_nonce_{$timestamp}_{$nonce}",
5562
					time(),
5563
					'no'
5564
				)
5565
			);
5566
		} else {
5567
			$return = false;
5568
		}
5569
5570
		$wpdb->show_errors( $show_errors );
5571
5572
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5573
5574
		return $return;
5575
	}
5576
5577
	/**
5578
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5579
	 * Capture it here so we can verify the signature later.
5580
	 */
5581
	function xmlrpc_methods( $methods ) {
5582
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5583
		return $methods;
5584
	}
5585
5586
	function public_xmlrpc_methods( $methods ) {
5587
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5588
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5589
		}
5590
		return $methods;
5591
	}
5592
5593
	function jetpack_getOptions( $args ) {
5594
		global $wp_xmlrpc_server;
5595
5596
		$wp_xmlrpc_server->escape( $args );
5597
5598
		$username	= $args[1];
5599
		$password	= $args[2];
5600
5601
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5602
			return $wp_xmlrpc_server->error;
5603
		}
5604
5605
		$options = array();
5606
		$user_data = $this->get_connected_user_data();
5607
		if ( is_array( $user_data ) ) {
5608
			$options['jetpack_user_id'] = array(
5609
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5610
				'readonly'      => true,
5611
				'value'         => $user_data['ID'],
5612
			);
5613
			$options['jetpack_user_login'] = array(
5614
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5615
				'readonly'      => true,
5616
				'value'         => $user_data['login'],
5617
			);
5618
			$options['jetpack_user_email'] = array(
5619
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5620
				'readonly'      => true,
5621
				'value'         => $user_data['email'],
5622
			);
5623
			$options['jetpack_user_site_count'] = array(
5624
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5625
				'readonly'      => true,
5626
				'value'         => $user_data['site_count'],
5627
			);
5628
		}
5629
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5630
		$args = stripslashes_deep( $args );
5631
		return $wp_xmlrpc_server->wp_getOptions( $args );
5632
	}
5633
5634
	function xmlrpc_options( $options ) {
5635
		$jetpack_client_id = false;
5636
		if ( self::is_active() ) {
5637
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5638
		}
5639
		$options['jetpack_version'] = array(
5640
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5641
				'readonly'      => true,
5642
				'value'         => JETPACK__VERSION,
5643
		);
5644
5645
		$options['jetpack_client_id'] = array(
5646
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5647
				'readonly'      => true,
5648
				'value'         => $jetpack_client_id,
5649
		);
5650
		return $options;
5651
	}
5652
5653
	public static function clean_nonces( $all = false ) {
5654
		global $wpdb;
5655
5656
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5657
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5658
5659
		if ( true !== $all ) {
5660
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5661
			$sql_args[] = time() - 3600;
5662
		}
5663
5664
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5665
5666
		$sql = $wpdb->prepare( $sql, $sql_args );
5667
5668
		for ( $i = 0; $i < 1000; $i++ ) {
5669
			if ( ! $wpdb->query( $sql ) ) {
5670
				break;
5671
			}
5672
		}
5673
	}
5674
5675
	/**
5676
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5677
	 * SET: state( $key, $value );
5678
	 * GET: $value = state( $key );
5679
	 *
5680
	 * @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...
5681
	 * @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...
5682
	 * @param bool $restate private
5683
	 */
5684
	public static function state( $key = null, $value = null, $restate = false ) {
5685
		static $state = array();
5686
		static $path, $domain;
5687
		if ( ! isset( $path ) ) {
5688
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5689
			$admin_url = Jetpack::admin_url();
5690
			$bits      = parse_url( $admin_url );
5691
5692
			if ( is_array( $bits ) ) {
5693
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5694
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5695
			} else {
5696
				$path = $domain = null;
5697
			}
5698
		}
5699
5700
		// Extract state from cookies and delete cookies
5701
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5702
			$yum = $_COOKIE[ 'jetpackState' ];
5703
			unset( $_COOKIE[ 'jetpackState' ] );
5704
			foreach ( $yum as $k => $v ) {
5705
				if ( strlen( $v ) )
5706
					$state[ $k ] = $v;
5707
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5708
			}
5709
		}
5710
5711
		if ( $restate ) {
5712
			foreach ( $state as $k => $v ) {
5713
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5714
			}
5715
			return;
5716
		}
5717
5718
		// Get a state variable
5719
		if ( isset( $key ) && ! isset( $value ) ) {
5720
			if ( array_key_exists( $key, $state ) )
5721
				return $state[ $key ];
5722
			return null;
5723
		}
5724
5725
		// Set a state variable
5726
		if ( isset ( $key ) && isset( $value ) ) {
5727
			if( is_array( $value ) && isset( $value[0] ) ) {
5728
				$value = $value[0];
5729
			}
5730
			$state[ $key ] = $value;
5731
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5732
		}
5733
	}
5734
5735
	public static function restate() {
5736
		Jetpack::state( null, null, true );
5737
	}
5738
5739
	public static function check_privacy( $file ) {
5740
		static $is_site_publicly_accessible = null;
5741
5742
		if ( is_null( $is_site_publicly_accessible ) ) {
5743
			$is_site_publicly_accessible = false;
5744
5745
			Jetpack::load_xml_rpc_client();
5746
			$rpc = new Jetpack_IXR_Client();
5747
5748
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5749
			if ( $success ) {
5750
				$response = $rpc->getResponse();
5751
				if ( $response ) {
5752
					$is_site_publicly_accessible = true;
5753
				}
5754
			}
5755
5756
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5757
		}
5758
5759
		if ( $is_site_publicly_accessible ) {
5760
			return;
5761
		}
5762
5763
		$module_slug = self::get_module_slug( $file );
5764
5765
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5766
		if ( ! $privacy_checks ) {
5767
			$privacy_checks = $module_slug;
5768
		} else {
5769
			$privacy_checks .= ",$module_slug";
5770
		}
5771
5772
		Jetpack::state( 'privacy_checks', $privacy_checks );
5773
	}
5774
5775
	/**
5776
	 * Helper method for multicall XMLRPC.
5777
	 */
5778
	public static function xmlrpc_async_call() {
5779
		global $blog_id;
5780
		static $clients = array();
5781
5782
		$client_blog_id = is_multisite() ? $blog_id : 0;
5783
5784
		if ( ! isset( $clients[$client_blog_id] ) ) {
5785
			Jetpack::load_xml_rpc_client();
5786
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5787
			if ( function_exists( 'ignore_user_abort' ) ) {
5788
				ignore_user_abort( true );
5789
			}
5790
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5791
		}
5792
5793
		$args = func_get_args();
5794
5795
		if ( ! empty( $args[0] ) ) {
5796
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5797
		} elseif ( is_multisite() ) {
5798
			foreach ( $clients as $client_blog_id => $client ) {
5799
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5800
					continue;
5801
				}
5802
5803
				$switch_success = switch_to_blog( $client_blog_id, true );
5804
				if ( ! $switch_success ) {
5805
					continue;
5806
				}
5807
5808
				flush();
5809
				$client->query();
5810
5811
				restore_current_blog();
5812
			}
5813
		} else {
5814
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5815
				flush();
5816
				$clients[0]->query();
5817
			}
5818
		}
5819
	}
5820
5821
	public static function staticize_subdomain( $url ) {
5822
5823
		// Extract hostname from URL
5824
		$host = parse_url( $url, PHP_URL_HOST );
5825
5826
		// Explode hostname on '.'
5827
		$exploded_host = explode( '.', $host );
5828
5829
		// Retrieve the name and TLD
5830
		if ( count( $exploded_host ) > 1 ) {
5831
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5832
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5833
			// Rebuild domain excluding subdomains
5834
			$domain = $name . '.' . $tld;
5835
		} else {
5836
			$domain = $host;
5837
		}
5838
		// Array of Automattic domains
5839
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5840
5841
		// Return $url if not an Automattic domain
5842
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5843
			return $url;
5844
		}
5845
5846
		if ( is_ssl() ) {
5847
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5848
		}
5849
5850
		srand( crc32( basename( $url ) ) );
5851
		$static_counter = rand( 0, 2 );
5852
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5853
5854
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5855
	}
5856
5857
/* JSON API Authorization */
5858
5859
	/**
5860
	 * Handles the login action for Authorizing the JSON API
5861
	 */
5862
	function login_form_json_api_authorization() {
5863
		$this->verify_json_api_authorization_request();
5864
5865
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5866
5867
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5868
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5869
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5870
	}
5871
5872
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5873
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5874
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5875
			return $url;
5876
		}
5877
5878
		$parsed_url = parse_url( $url );
5879
		$url = strtok( $url, '?' );
5880
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5881
		if ( ! empty( $parsed_url['query'] ) )
5882
			$url .= "&{$parsed_url['query']}";
5883
5884
		return $url;
5885
	}
5886
5887
	// Make sure the POSTed request is handled by the same action
5888
	function preserve_action_in_login_form_for_json_api_authorization() {
5889
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5890
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5891
	}
5892
5893
	// If someone logs in to approve API access, store the Access Code in usermeta
5894
	function store_json_api_authorization_token( $user_login, $user ) {
5895
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5896
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5897
		$token = wp_generate_password( 32, false );
5898
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5899
	}
5900
5901
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5902
	function allow_wpcom_public_api_domain( $domains ) {
5903
		$domains[] = 'public-api.wordpress.com';
5904
		return $domains;
5905
	}
5906
5907
	// Add the Access Code details to the public-api.wordpress.com redirect
5908
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5909
		return add_query_arg(
5910
			urlencode_deep(
5911
				array(
5912
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5913
					'jetpack-user-id' => (int) $user->ID,
5914
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5915
				)
5916
			),
5917
			$redirect_to
5918
		);
5919
	}
5920
5921
5922
	/**
5923
	 * Verifies the request by checking the signature
5924
	 *
5925
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5926
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5927
	 *
5928
	 * @param null|array $environment
5929
	 */
5930
	function verify_json_api_authorization_request( $environment = null ) {
5931
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5932
5933
		$environment = is_null( $environment )
5934
			? $_REQUEST
5935
			: $environment;
5936
5937
		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...
5938
		$token = Jetpack_Data::get_access_token( $envUserId );
5939
		if ( ! $token || empty( $token->secret ) ) {
5940
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5941
		}
5942
5943
		$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' );
5944
5945
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5946
5947
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5948
			$signature = $jetpack_signature->sign_request(
5949
				$environment['token'],
5950
				$environment['timestamp'],
5951
				$environment['nonce'],
5952
				'',
5953
				'GET',
5954
				$environment['jetpack_json_api_original_query'],
5955
				null,
5956
				true
5957
			);
5958
		} else {
5959
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5960
		}
5961
5962
		if ( ! $signature ) {
5963
			wp_die( $die_error );
5964
		} else if ( is_wp_error( $signature ) ) {
5965
			wp_die( $die_error );
5966
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5967
			if ( is_ssl() ) {
5968
				// 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
5969
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5970
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5971
					wp_die( $die_error );
5972
				}
5973
			} else {
5974
				wp_die( $die_error );
5975
			}
5976
		}
5977
5978
		$timestamp = (int) $environment['timestamp'];
5979
		$nonce     = stripslashes( (string) $environment['nonce'] );
5980
5981
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5982
			// De-nonce the nonce, at least for 5 minutes.
5983
			// 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)
5984
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5985
			if ( $old_nonce_time < time() - 300 ) {
5986
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5987
			}
5988
		}
5989
5990
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5991
		$data_filters = array(
5992
			'state'        => 'opaque',
5993
			'client_id'    => 'int',
5994
			'client_title' => 'string',
5995
			'client_image' => 'url',
5996
		);
5997
5998
		foreach ( $data_filters as $key => $sanitation ) {
5999
			if ( ! isset( $data->$key ) ) {
6000
				wp_die( $die_error );
6001
			}
6002
6003
			switch ( $sanitation ) {
6004
			case 'int' :
6005
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6006
				break;
6007
			case 'opaque' :
6008
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6009
				break;
6010
			case 'string' :
6011
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6012
				break;
6013
			case 'url' :
6014
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6015
				break;
6016
			}
6017
		}
6018
6019
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6020
			wp_die( $die_error );
6021
		}
6022
	}
6023
6024
	function login_message_json_api_authorization( $message ) {
6025
		return '<p class="message">' . sprintf(
6026
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6027
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6028
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6029
	}
6030
6031
	/**
6032
	 * Get $content_width, but with a <s>twist</s> filter.
6033
	 */
6034
	public static function get_content_width() {
6035
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6036
		/**
6037
		 * Filter the Content Width value.
6038
		 *
6039
		 * @since 2.2.3
6040
		 *
6041
		 * @param string $content_width Content Width value.
6042
		 */
6043
		return apply_filters( 'jetpack_content_width', $content_width );
6044
	}
6045
6046
	/**
6047
	 * Pings the WordPress.com Mirror Site for the specified options.
6048
	 *
6049
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6050
	 *
6051
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6052
	 */
6053
	public function get_cloud_site_options( $option_names ) {
6054
		$option_names = array_filter( (array) $option_names, 'is_string' );
6055
6056
		Jetpack::load_xml_rpc_client();
6057
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6058
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6059
		if ( $xml->isError() ) {
6060
			return array(
6061
				'error_code' => $xml->getErrorCode(),
6062
				'error_msg'  => $xml->getErrorMessage(),
6063
			);
6064
		}
6065
		$cloud_site_options = $xml->getResponse();
6066
6067
		return $cloud_site_options;
6068
	}
6069
6070
	/**
6071
	 * Checks if the site is currently in an identity crisis.
6072
	 *
6073
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6074
	 */
6075
	public static function check_identity_crisis() {
6076
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6077
			return false;
6078
		}
6079
6080
		return Jetpack_Options::get_option( 'sync_error_idc' );
6081
	}
6082
6083
	/**
6084
	 * Checks whether the home and siteurl specifically are whitelisted
6085
	 * Written so that we don't have re-check $key and $value params every time
6086
	 * we want to check if this site is whitelisted, for example in footer.php
6087
	 *
6088
	 * @since  3.8.0
6089
	 * @return bool True = already whitelisted False = not whitelisted
6090
	 */
6091
	public static function is_staging_site() {
6092
		$is_staging = false;
6093
6094
		$known_staging = array(
6095
			'urls' => array(
6096
				'#\.staging\.wpengine\.com$#i', // WP Engine
6097
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6098
				),
6099
			'constants' => array(
6100
				'IS_WPE_SNAPSHOT',      // WP Engine
6101
				'KINSTA_DEV_ENV',       // Kinsta.com
6102
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6103
				'JETPACK_STAGING_MODE', // Generic
6104
				)
6105
			);
6106
		/**
6107
		 * Filters the flags of known staging sites.
6108
		 *
6109
		 * @since 3.9.0
6110
		 *
6111
		 * @param array $known_staging {
6112
		 *     An array of arrays that each are used to check if the current site is staging.
6113
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6114
		 *     @type array $constants PHP constants of known staging/developement environments.
6115
		 *  }
6116
		 */
6117
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6118
6119
		if ( isset( $known_staging['urls'] ) ) {
6120
			foreach ( $known_staging['urls'] as $url ){
6121
				if ( preg_match( $url, site_url() ) ) {
6122
					$is_staging = true;
6123
					break;
6124
				}
6125
			}
6126
		}
6127
6128
		if ( isset( $known_staging['constants'] ) ) {
6129
			foreach ( $known_staging['constants'] as $constant ) {
6130
				if ( defined( $constant ) && constant( $constant ) ) {
6131
					$is_staging = true;
6132
				}
6133
			}
6134
		}
6135
6136
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6137
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6138
			$is_staging = true;
6139
		}
6140
6141
		/**
6142
		 * Filters is_staging_site check.
6143
		 *
6144
		 * @since 3.9.0
6145
		 *
6146
		 * @param bool $is_staging If the current site is a staging site.
6147
		 */
6148
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6149
	}
6150
6151
	/**
6152
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6153
	 *
6154
	 * @since 4.4.0
6155
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6156
	 *
6157
	 * @return bool
6158
	 */
6159
	public static function validate_sync_error_idc_option() {
6160
		$is_valid = false;
6161
6162
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6163
		if ( false === $idc_allowed ) {
6164
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6165
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6166
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6167
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6168
				$transient_duration = HOUR_IN_SECONDS;
6169
			} else {
6170
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6171
				$idc_allowed = '1';
6172
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6173
			}
6174
6175
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6176
		}
6177
6178
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6179
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6180
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6181
			$local_options = self::get_sync_error_idc_option();
6182
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6183
				$is_valid = true;
6184
			}
6185
		}
6186
6187
		/**
6188
		 * Filters whether the sync_error_idc option is valid.
6189
		 *
6190
		 * @since 4.4.0
6191
		 *
6192
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6193
		 */
6194
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6195
6196
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6197
			// Since the option exists, and did not validate, delete it
6198
			Jetpack_Options::delete_option( 'sync_error_idc' );
6199
		}
6200
6201
		return $is_valid;
6202
	}
6203
6204
	/**
6205
	 * Normalizes a url by doing three things:
6206
	 *  - Strips protocol
6207
	 *  - Strips www
6208
	 *  - Adds a trailing slash
6209
	 *
6210
	 * @since 4.4.0
6211
	 * @param string $url
6212
	 * @return WP_Error|string
6213
	 */
6214
	public static function normalize_url_protocol_agnostic( $url ) {
6215
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6216
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6217
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6218
		}
6219
6220
		// Strip www and protocols
6221
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6222
		return $url;
6223
	}
6224
6225
	/**
6226
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6227
	 *
6228
	 * @since 4.4.0
6229
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6230
	 *
6231
	 * @param array $response
6232
	 * @return array Array of the local urls, wpcom urls, and error code
6233
	 */
6234
	public static function get_sync_error_idc_option( $response = array() ) {
6235
		// Since the local options will hit the database directly, store the values
6236
		// in a transient to allow for autoloading and caching on subsequent views.
6237
		$local_options = get_transient( 'jetpack_idc_local' );
6238
		if ( false === $local_options ) {
6239
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6240
			$local_options = array(
6241
				'home'    => Jetpack_Sync_Functions::home_url(),
6242
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6243
			);
6244
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6245
		}
6246
6247
		$options = array_merge( $local_options, $response );
6248
6249
		$returned_values = array();
6250
		foreach( $options as $key => $option ) {
6251
			if ( 'error_code' === $key ) {
6252
				$returned_values[ $key ] = $option;
6253
				continue;
6254
			}
6255
6256
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6257
				continue;
6258
			}
6259
6260
			$returned_values[ $key ] = $normalized_url;
6261
		}
6262
6263
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6264
6265
		return $returned_values;
6266
	}
6267
6268
	/**
6269
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6270
	 * If set to true, the site will be put into staging mode.
6271
	 *
6272
	 * @since 4.3.2
6273
	 * @return bool
6274
	 */
6275
	public static function sync_idc_optin() {
6276
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6277
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6278
		} else {
6279
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6280
		}
6281
6282
		/**
6283
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6284
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6285
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6286
		 *
6287
		 * @since 4.3.2
6288
		 *
6289
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6290
		 */
6291
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6292
	}
6293
6294
	/**
6295
	 * Maybe Use a .min.css stylesheet, maybe not.
6296
	 *
6297
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6298
	 */
6299
	public static function maybe_min_asset( $url, $path, $plugin ) {
6300
		// Short out on things trying to find actual paths.
6301
		if ( ! $path || empty( $plugin ) ) {
6302
			return $url;
6303
		}
6304
6305
		$path = ltrim( $path, '/' );
6306
6307
		// Strip out the abspath.
6308
		$base = dirname( plugin_basename( $plugin ) );
6309
6310
		// Short out on non-Jetpack assets.
6311
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6312
			return $url;
6313
		}
6314
6315
		// File name parsing.
6316
		$file              = "{$base}/{$path}";
6317
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6318
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6319
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6320
		$extension         = array_shift( $file_name_parts_r );
6321
6322
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6323
			// Already pointing at the minified version.
6324
			if ( 'min' === $file_name_parts_r[0] ) {
6325
				return $url;
6326
			}
6327
6328
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6329
			if ( file_exists( $min_full_path ) ) {
6330
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6331
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6332
				if ( 'css' === $extension ) {
6333
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6334
					self::$min_assets[ $key ] = $path;
6335
				}
6336
			}
6337
		}
6338
6339
		return $url;
6340
	}
6341
6342
	/**
6343
	 * If the asset is minified, let's flag .min as the suffix.
6344
	 *
6345
	 * Attached to `style_loader_src` filter.
6346
	 *
6347
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

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

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

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

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

Loading history...
6348
	 * @param string $handle The registered handle of the script in question.
6349
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

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

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

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

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

Loading history...
6350
	 */
6351
	public static function set_suffix_on_min( $src, $handle ) {
6352
		if ( false === strpos( $src, '.min.css' ) ) {
6353
			return $src;
6354
		}
6355
6356
		if ( ! empty( self::$min_assets ) ) {
6357
			foreach ( self::$min_assets as $file => $path ) {
6358
				if ( false !== strpos( $src, $file ) ) {
6359
					wp_style_add_data( $handle, 'suffix', '.min' );
6360
					return $src;
6361
				}
6362
			}
6363
		}
6364
6365
		return $src;
6366
	}
6367
6368
	/**
6369
	 * Maybe inlines a stylesheet.
6370
	 *
6371
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6372
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6373
	 *
6374
	 * Attached to `style_loader_tag` filter.
6375
	 *
6376
	 * @param string $tag The tag that would link to the external asset.
6377
	 * @param string $handle The registered handle of the script in question.
6378
	 *
6379
	 * @return string
6380
	 */
6381
	public static function maybe_inline_style( $tag, $handle ) {
6382
		global $wp_styles;
6383
		$item = $wp_styles->registered[ $handle ];
6384
6385
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6386
			return $tag;
6387
		}
6388
6389
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6390
			$href = $matches[1];
6391
			// Strip off query string
6392
			if ( $pos = strpos( $href, '?' ) ) {
6393
				$href = substr( $href, 0, $pos );
6394
			}
6395
			// Strip off fragment
6396
			if ( $pos = strpos( $href, '#' ) ) {
6397
				$href = substr( $href, 0, $pos );
6398
			}
6399
		} else {
6400
			return $tag;
6401
		}
6402
6403
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6404
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6405
			return $tag;
6406
		}
6407
6408
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6409
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6410
			// And this isn't the pass that actually deals with the RTL version...
6411
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6412
				// Short out, as the RTL version will deal with it in a moment.
6413
				return $tag;
6414
			}
6415
		}
6416
6417
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6418
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6419
		if ( $css ) {
6420
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6421
			if ( empty( $item->extra['after'] ) ) {
6422
				wp_add_inline_style( $handle, $css );
6423
			} else {
6424
				array_unshift( $item->extra['after'], $css );
6425
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6426
			}
6427
		}
6428
6429
		return $tag;
6430
	}
6431
6432
	/**
6433
	 * Loads a view file from the views
6434
	 *
6435
	 * Data passed in with the $data parameter will be available in the
6436
	 * template file as $data['value']
6437
	 *
6438
	 * @param string $template - Template file to load
6439
	 * @param array $data - Any data to pass along to the template
6440
	 * @return boolean - If template file was found
6441
	 **/
6442
	public function load_view( $template, $data = array() ) {
6443
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6444
6445
		if( file_exists( $views_dir . $template ) ) {
6446
			require_once( $views_dir . $template );
6447
			return true;
6448
		}
6449
6450
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6451
		return false;
6452
	}
6453
6454
	/**
6455
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6456
	 */
6457
	public function deprecated_hooks() {
6458
		global $wp_filter;
6459
6460
		/*
6461
		 * Format:
6462
		 * deprecated_filter_name => replacement_name
6463
		 *
6464
		 * If there is no replacement, use null for replacement_name
6465
		 */
6466
		$deprecated_list = array(
6467
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6468
			'wpl_sharing_2014_1'                                     => null,
6469
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6470
			'jetpack_identity_crisis_options_to_check'               => null,
6471
			'update_option_jetpack_single_user_site'                 => null,
6472
			'audio_player_default_colors'                            => null,
6473
			'add_option_jetpack_featured_images_enabled'             => null,
6474
			'add_option_jetpack_update_details'                      => null,
6475
			'add_option_jetpack_updates'                             => null,
6476
			'add_option_jetpack_network_name'                        => null,
6477
			'add_option_jetpack_network_allow_new_registrations'     => null,
6478
			'add_option_jetpack_network_add_new_users'               => null,
6479
			'add_option_jetpack_network_site_upload_space'           => null,
6480
			'add_option_jetpack_network_upload_file_types'           => null,
6481
			'add_option_jetpack_network_enable_administration_menus' => null,
6482
			'add_option_jetpack_is_multi_site'                       => null,
6483
			'add_option_jetpack_is_main_network'                     => null,
6484
			'add_option_jetpack_main_network_site'                   => null,
6485
			'jetpack_sync_all_registered_options'                    => null,
6486
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6487
			'jetpack_is_post_mailable'                               => null,
6488
			'jetpack_seo_site_host'                                  => null,
6489
		);
6490
6491
		// This is a silly loop depth. Better way?
6492
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6493
			if ( has_action( $hook ) ) {
6494
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6495
					foreach( $values AS $hooked ) {
6496
						if ( is_callable( $hooked['function'] ) ) {
6497
							$function_name = 'an anonymous function';
6498
						} else {
6499
							$function_name = $hooked['function'];
6500
						}
6501
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6502
					}
6503
				}
6504
			}
6505
		}
6506
	}
6507
6508
	/**
6509
	 * Converts any url in a stylesheet, to the correct absolute url.
6510
	 *
6511
	 * Considerations:
6512
	 *  - Normal, relative URLs     `feh.png`
6513
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6514
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6515
	 *  - Absolute URLs             `http://domain.com/feh.png`
6516
	 *  - Domain root relative URLs `/feh.png`
6517
	 *
6518
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6519
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6520
	 *
6521
	 * @return mixed|string
6522
	 */
6523
	public static function absolutize_css_urls( $css, $css_file_url ) {
6524
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6525
		$css_dir = dirname( $css_file_url );
6526
		$p       = parse_url( $css_dir );
6527
		$domain  = sprintf(
6528
					'%1$s//%2$s%3$s%4$s',
6529
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6530
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6531
					$p['host'],
6532
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6533
				);
6534
6535
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6536
			$find = $replace = array();
6537
			foreach ( $matches as $match ) {
6538
				$url = trim( $match['path'], "'\" \t" );
6539
6540
				// If this is a data url, we don't want to mess with it.
6541
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6542
					continue;
6543
				}
6544
6545
				// If this is an absolute or protocol-agnostic url,
6546
				// we don't want to mess with it.
6547
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6548
					continue;
6549
				}
6550
6551
				switch ( substr( $url, 0, 1 ) ) {
6552
					case '/':
6553
						$absolute = $domain . $url;
6554
						break;
6555
					default:
6556
						$absolute = $css_dir . '/' . $url;
6557
				}
6558
6559
				$find[]    = $match[0];
6560
				$replace[] = sprintf( 'url("%s")', $absolute );
6561
			}
6562
			$css = str_replace( $find, $replace, $css );
6563
		}
6564
6565
		return $css;
6566
	}
6567
6568
	/**
6569
	 * This methods removes all of the registered css files on the front end
6570
	 * from Jetpack in favor of using a single file. In effect "imploding"
6571
	 * all the files into one file.
6572
	 *
6573
	 * Pros:
6574
	 * - Uses only ONE css asset connection instead of 15
6575
	 * - Saves a minimum of 56k
6576
	 * - Reduces server load
6577
	 * - Reduces time to first painted byte
6578
	 *
6579
	 * Cons:
6580
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6581
	 *		should not cause any issues with themes.
6582
	 * - Plugins/themes dequeuing styles no longer do anything. See
6583
	 *		jetpack_implode_frontend_css filter for a workaround
6584
	 *
6585
	 * For some situations developers may wish to disable css imploding and
6586
	 * instead operate in legacy mode where each file loads seperately and
6587
	 * can be edited individually or dequeued. This can be accomplished with
6588
	 * the following line:
6589
	 *
6590
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6591
	 *
6592
	 * @since 3.2
6593
	 **/
6594
	public function implode_frontend_css( $travis_test = false ) {
6595
		$do_implode = true;
6596
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6597
			$do_implode = false;
6598
		}
6599
6600
		/**
6601
		 * Allow CSS to be concatenated into a single jetpack.css file.
6602
		 *
6603
		 * @since 3.2.0
6604
		 *
6605
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6606
		 */
6607
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6608
6609
		// Do not use the imploded file when default behaviour was altered through the filter
6610
		if ( ! $do_implode ) {
6611
			return;
6612
		}
6613
6614
		// We do not want to use the imploded file in dev mode, or if not connected
6615
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6616
			if ( ! $travis_test ) {
6617
				return;
6618
			}
6619
		}
6620
6621
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6622
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6623
			return;
6624
		}
6625
6626
		/*
6627
		 * Now we assume Jetpack is connected and able to serve the single
6628
		 * file.
6629
		 *
6630
		 * In the future there will be a check here to serve the file locally
6631
		 * or potentially from the Jetpack CDN
6632
		 *
6633
		 * For now:
6634
		 * - Enqueue a single imploded css file
6635
		 * - Zero out the style_loader_tag for the bundled ones
6636
		 * - Be happy, drink scotch
6637
		 */
6638
6639
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6640
6641
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6642
6643
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6644
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6645
	}
6646
6647
	function concat_remove_style_loader_tag( $tag, $handle ) {
6648
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6649
			$tag = '';
6650
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6651
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6652
			}
6653
		}
6654
6655
		return $tag;
6656
	}
6657
6658
	/*
6659
	 * Check the heartbeat data
6660
	 *
6661
	 * Organizes the heartbeat data by severity.  For example, if the site
6662
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6663
	 *
6664
	 * Data will be added to "caution" array, if it either:
6665
	 *  - Out of date Jetpack version
6666
	 *  - Out of date WP version
6667
	 *  - Out of date PHP version
6668
	 *
6669
	 * $return array $filtered_data
6670
	 */
6671
	public static function jetpack_check_heartbeat_data() {
6672
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6673
6674
		$good    = array();
6675
		$caution = array();
6676
		$bad     = array();
6677
6678
		foreach ( $raw_data as $stat => $value ) {
6679
6680
			// Check jetpack version
6681
			if ( 'version' == $stat ) {
6682
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6683
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6684
					continue;
6685
				}
6686
			}
6687
6688
			// Check WP version
6689
			if ( 'wp-version' == $stat ) {
6690
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6691
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6692
					continue;
6693
				}
6694
			}
6695
6696
			// Check PHP version
6697
			if ( 'php-version' == $stat ) {
6698
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6699
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6700
					continue;
6701
				}
6702
			}
6703
6704
			// Check ID crisis
6705
			if ( 'identitycrisis' == $stat ) {
6706
				if ( 'yes' == $value ) {
6707
					$bad[ $stat ] = $value;
6708
					continue;
6709
				}
6710
			}
6711
6712
			// The rest are good :)
6713
			$good[ $stat ] = $value;
6714
		}
6715
6716
		$filtered_data = array(
6717
			'good'    => $good,
6718
			'caution' => $caution,
6719
			'bad'     => $bad
6720
		);
6721
6722
		return $filtered_data;
6723
	}
6724
6725
6726
	/*
6727
	 * This method is used to organize all options that can be reset
6728
	 * without disconnecting Jetpack.
6729
	 *
6730
	 * It is used in class.jetpack-cli.php to reset options
6731
	 *
6732
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6733
	 *
6734
	 * @return array of options to delete.
6735
	 */
6736
	public static function get_jetpack_options_for_reset() {
6737
		return Jetpack_Options::get_options_for_reset();
6738
	}
6739
6740
	/**
6741
	 * Check if an option of a Jetpack module has been updated.
6742
	 *
6743
	 * If any module option has been updated before Jump Start has been dismissed,
6744
	 * update the 'jumpstart' option so we can hide Jump Start.
6745
	 *
6746
	 * @param string $option_name
6747
	 *
6748
	 * @return bool
6749
	 */
6750
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6751
		// Bail if Jump Start has already been dismissed
6752
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6753
			return false;
6754
		}
6755
6756
		$jetpack = Jetpack::init();
6757
6758
		// Manual build of module options
6759
		$option_names = self::get_jetpack_options_for_reset();
6760
6761
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6762
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6763
6764
			//Jump start is being dismissed send data to MC Stats
6765
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6766
6767
			$jetpack->do_stats( 'server_side' );
6768
		}
6769
6770
	}
6771
6772
	/*
6773
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6774
	 * so we can bring them directly to their site in calypso.
6775
	 *
6776
	 * @param string | url
6777
	 * @return string | url without the guff
6778
	 */
6779
	public static function build_raw_urls( $url ) {
6780
		$strip_http = '/.*?:\/\//i';
6781
		$url = preg_replace( $strip_http, '', $url  );
6782
		$url = str_replace( '/', '::', $url );
6783
		return $url;
6784
	}
6785
6786
	/**
6787
	 * Stores and prints out domains to prefetch for page speed optimization.
6788
	 *
6789
	 * @param mixed $new_urls
6790
	 */
6791
	public static function dns_prefetch( $new_urls = null ) {
6792
		static $prefetch_urls = array();
6793
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6794
			echo "\r\n";
6795
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6796
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6797
			}
6798
		} elseif ( ! empty( $new_urls ) ) {
6799
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6800
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6801
			}
6802
			foreach ( (array) $new_urls as $this_new_url ) {
6803
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6804
			}
6805
			$prefetch_urls = array_unique( $prefetch_urls );
6806
		}
6807
	}
6808
6809
	public function wp_dashboard_setup() {
6810
		if ( self::is_active() ) {
6811
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6812
		}
6813
6814
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6815
			wp_add_dashboard_widget(
6816
				'jetpack_summary_widget',
6817
				esc_html__( 'Site Stats', 'jetpack' ),
6818
				array( __CLASS__, 'dashboard_widget' )
6819
			);
6820
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6821
6822
			// If we're inactive and not in development mode, sort our box to the top.
6823
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6824
				global $wp_meta_boxes;
6825
6826
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6827
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6828
6829
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6830
			}
6831
		}
6832
	}
6833
6834
	/**
6835
	 * @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...
6836
	 * @return mixed
6837
	 */
6838
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6839
		if ( ! is_array( $sorted ) ) {
6840
			return $sorted;
6841
		}
6842
6843
		foreach ( $sorted as $box_context => $ids ) {
6844
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6845
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6846
				continue;
6847
			}
6848
6849
			$ids_array = explode( ',', $ids );
6850
			$key = array_search( 'dashboard_stats', $ids_array );
6851
6852
			if ( false !== $key ) {
6853
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6854
				$ids_array[ $key ] = 'jetpack_summary_widget';
6855
				$sorted[ $box_context ] = implode( ',', $ids_array );
6856
				// We've found it, stop searching, and just return.
6857
				break;
6858
			}
6859
		}
6860
6861
		return $sorted;
6862
	}
6863
6864
	public static function dashboard_widget() {
6865
		/**
6866
		 * Fires when the dashboard is loaded.
6867
		 *
6868
		 * @since 3.4.0
6869
		 */
6870
		do_action( 'jetpack_dashboard_widget' );
6871
	}
6872
6873
	public static function dashboard_widget_footer() {
6874
		?>
6875
		<footer>
6876
6877
		<div class="protect">
6878
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6879
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6880
				<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>
6881
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6882
				<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' ); ?>">
6883
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6884
				</a>
6885
			<?php else : ?>
6886
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6887
			<?php endif; ?>
6888
		</div>
6889
6890
		<div class="akismet">
6891
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6892
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6893
				<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>
6894
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6895
				<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">
6896
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6897
				</a>
6898
			<?php else : ?>
6899
				<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>
6900
			<?php endif; ?>
6901
		</div>
6902
6903
		</footer>
6904
		<?php
6905
	}
6906
6907
	/**
6908
	 * Return string containing the Jetpack logo.
6909
	 *
6910
	 * @since 3.9.0
6911
	 *
6912
	 * @return string
6913
	 */
6914
	public static function get_jp_emblem() {
6915
		return '<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 32 32"><path fill="#00BE28" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/></svg>';
6916
	}
6917
6918
	/*
6919
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6920
	 */
6921
	function jetpack_icon_user_connected( $columns ) {
6922
		$columns['user_jetpack'] = '';
6923
		return $columns;
6924
	}
6925
6926
	/*
6927
	 * Show Jetpack icon if the user is linked.
6928
	 */
6929
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6930
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6931
			$emblem_html = sprintf(
6932
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6933
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6934
				Jetpack::get_jp_emblem()
6935
			);
6936
			return $emblem_html;
6937
		}
6938
6939
		return $val;
6940
	}
6941
6942
	/*
6943
	 * Style the Jetpack user column
6944
	 */
6945
	function jetpack_user_col_style() {
6946
		global $current_screen;
6947
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6948
			<style>
6949
				.fixed .column-user_jetpack {
6950
					width: 21px;
6951
				}
6952
				.jp-emblem-user-admin svg {
6953
					width: 20px;
6954
					height: 20px;
6955
				}
6956
				.jp-emblem-user-admin path {
6957
					fill: #00BE28;
6958
				}
6959
			</style>
6960
		<?php }
6961
	}
6962
6963
	/**
6964
	 * Checks if Akismet is active and working.
6965
	 *
6966
	 * @since  5.1.0
6967
	 * @return bool True = Akismet available. False = Aksimet not available.
6968
	 */
6969
	public static function is_akismet_active() {
6970
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6971
			return true;
6972
		}
6973
		return false;
6974
	}
6975
6976
	/**
6977
	 * Checks if one or more function names is in debug_backtrace
6978
	 *
6979
	 * @param $names Mixed string name of function or array of string names of functions
6980
	 *
6981
	 * @return bool
6982
	 */
6983
	public static function is_function_in_backtrace( $names ) {
6984
		$backtrace = debug_backtrace( false );
6985
		if ( ! is_array( $names ) ) {
6986
			$names = array( $names );
6987
		}
6988
		$names_as_keys = array_flip( $names );
6989
6990
		//Do check in constant O(1) time for PHP5.5+
6991
		if ( function_exists( 'array_column' ) ) {
6992
			$backtrace_functions = array_column( $backtrace, 'function' );
6993
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6994
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6995
			return ! empty ( $intersection );
6996
		}
6997
6998
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6999
		foreach ( $backtrace as $call ) {
7000
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7001
				return true;
7002
			}
7003
		}
7004
		return false;
7005
	}
7006
7007
	/**
7008
	 * Given a minified path, and a non-minified path, will return
7009
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7010
	 *
7011
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7012
	 * root Jetpack directory.
7013
	 *
7014
	 * @since 5.6.0
7015
	 *
7016
	 * @param string $min_path
7017
	 * @param string $non_min_path
7018
	 * @return string The URL to the file
7019
	 */
7020
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7021
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7022
			? $non_min_path
7023
			: $min_path;
7024
7025
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7026
	}
7027
7028
	/**
7029
	 * Checks for whether Jetpack Rewind is enabled.
7030
	 * Will return true if the state of Rewind is anything except "unavailable".
7031
	 * @return bool|int|mixed
7032
	 */
7033
	public static function is_rewind_enabled() {
7034
		if ( ! Jetpack::is_active() ) {
7035
			return false;
7036
		}
7037
7038
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7039
		if ( false === $rewind_enabled ) {
7040
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7041
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7042
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7043
				&& ! empty( $rewind_data['state'] )
7044
				&& 'active' === $rewind_data['state'] )
7045
				? 1
7046
				: 0;
7047
7048
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7049
		}
7050
		return $rewind_enabled;
7051
	}
7052
}
7053