Completed
Push — add/changelog-68 ( 5f52c4...18603f )
by Jeremy
09:10
created

Jetpack::build_raw_urls()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 1
dl 0
loc 6
rs 10
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
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
39
	 */
40
	public $concatenated_style_handles = array(
41
		'jetpack-carousel',
42
		'grunion.css',
43
		'the-neverending-homepage',
44
		'jetpack_likes',
45
		'jetpack_related-posts',
46
		'sharedaddy',
47
		'jetpack-slideshow',
48
		'presentations',
49
		'quiz',
50
		'jetpack-subscriptions',
51
		'jetpack-responsive-videos-style',
52
		'jetpack-social-menu',
53
		'tiled-gallery',
54
		'jetpack_display_posts_widget',
55
		'gravatar-profile-widget',
56
		'goodreads-widget',
57
		'jetpack_social_media_icons_widget',
58
		'jetpack-top-posts-widget',
59
		'jetpack_image_widget',
60
		'jetpack-my-community-widget',
61
		'jetpack-authors-widget',
62
		'wordads',
63
		'eu-cookie-law-style',
64
		'flickr-widget-style',
65
		'jetpack-search-widget',
66
		'jetpack-simple-payments-widget-style',
67
		'jetpack-widget-social-icons-styles',
68
	);
69
70
	/**
71
	 * Contains all assets that have had their URL rewritten to minified versions.
72
	 *
73
	 * @var array
74
	 */
75
	static $min_assets = array();
76
77
	public $plugins_to_deactivate = array(
78
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
79
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
80
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
81
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
82
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
83
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
84
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
85
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
86
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
87
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
88
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
89
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
90
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
91
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
92
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
93
	);
94
95
	static $capability_translations = array(
96
		'administrator' => 'manage_options',
97
		'editor'        => 'edit_others_posts',
98
		'author'        => 'publish_posts',
99
		'contributor'   => 'edit_posts',
100
		'subscriber'    => 'read',
101
	);
102
103
	/**
104
	 * Map of modules that have conflicts with plugins and should not be auto-activated
105
	 * if the plugins are active.  Used by filter_default_modules
106
	 *
107
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
108
	 * change `module-slug` and add this to your plugin:
109
	 *
110
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
111
	 * function my_jetpack_get_default_modules( $modules ) {
112
	 *     return array_diff( $modules, array( 'module-slug' ) );
113
	 * }
114
	 *
115
	 * @var array
116
	 */
117
	private $conflicting_plugins = array(
118
		'comments'          => array(
119
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
120
			'Disqus'                               => 'disqus-comment-system/disqus.php',
121
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
122
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
123
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
124
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
125
		),
126
		'comment-likes' => array(
127
			'Epoch'                                => 'epoch/plugincore.php',
128
		),
129
		'contact-form'      => array(
130
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
131
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
132
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
133
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
134
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
135
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
136
		),
137
		'minileven'         => array(
138
			'WPtouch'                              => 'wptouch/wptouch.php',
139
		),
140
		'latex'             => array(
141
			'LaTeX for WordPress'                  => 'latex/latex.php',
142
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
143
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
144
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
145
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
146
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
147
		),
148
		'protect'           => array(
149
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
150
			'Captcha'                              => 'captcha/captcha.php',
151
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
152
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
153
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
154
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
155
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
156
			'Security-protection'                  => 'security-protection/security-protection.php',
157
			'Login Security'                       => 'login-security/login-security.php',
158
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
159
			'Wordfence Security'                   => 'wordfence/wordfence.php',
160
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
161
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
162
		),
163
		'random-redirect'   => array(
164
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
165
		),
166
		'related-posts'     => array(
167
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
168
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
169
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
170
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
171
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
172
			'outbrain'                             => 'outbrain/outbrain.php',
173
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
174
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
175
		),
176
		'sharedaddy'        => array(
177
			'AddThis'                              => 'addthis/addthis_social_widget.php',
178
			'Add To Any'                           => 'add-to-any/add-to-any.php',
179
			'ShareThis'                            => 'share-this/sharethis.php',
180
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
181
		),
182
		'seo-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
			'The SEO Framework'                    => 'autodescription/autodescription.php',
188
		),
189
		'verification-tools' => array(
190
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
191
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
192
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
193
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
194
			'The SEO Framework'                    => 'autodescription/autodescription.php',
195
		),
196
		'widget-visibility' => array(
197
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
198
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
199
		),
200
		'sitemaps' => array(
201
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
202
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
203
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
204
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
205
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
206
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
207
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
208
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
209
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
210
			'The SEO Framework'                    => 'autodescription/autodescription.php',
211
			'Sitemap'                              => 'sitemap/sitemap.php',
212
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
213
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
214
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
215
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
216
		),
217
		'lazy-images' => array(
218
			'Lazy Load'              => 'lazy-load/lazy-load.php',
219
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
220
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
221
		),
222
	);
223
224
	/**
225
	 * Plugins for which we turn off our Facebook OG Tags implementation.
226
	 *
227
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
228
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
229
	 *
230
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
231
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
232
	 */
233
	private $open_graph_conflicting_plugins = array(
234
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
235
		                                                         // 2 Click Social Media Buttons
236
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
237
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
238
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
239
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
240
		                                                         // Open Graph Meta Tags by Heateor
241
		'facebook/facebook.php',                                 // Facebook (official plugin)
242
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
243
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
244
		                                                         // Facebook Featured Image & OG Meta Tags
245
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
246
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
247
		                                                         // Facebook Open Graph Meta Tags for WordPress
248
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
249
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
250
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
251
		                                                         // Fedmich's Facebook Open Graph Meta
252
		'network-publisher/networkpub.php',                      // Network Publisher
253
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
254
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
255
		                                                         // NextScripts SNAP
256
		'og-tags/og-tags.php',                                   // OG Tags
257
		'opengraph/opengraph.php',                               // Open Graph
258
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
259
		                                                         // Open Graph Protocol Framework
260
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
261
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
262
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
263
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
264
		'sharepress/sharepress.php',                             // SharePress
265
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
266
		'social-discussions/social-discussions.php',             // Social Discussions
267
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
268
		'socialize/socialize.php',                               // Socialize
269
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
270
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
271
		                                                         // Tweet, Like, Google +1 and Share
272
		'wordbooker/wordbooker.php',                             // Wordbooker
273
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
274
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
275
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
276
		                                                         // WP Facebook Like Send & Open Graph Meta
277
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
278
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
279
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
280
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
281
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
282
	);
283
284
	/**
285
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
286
	 */
287
	private $twitter_cards_conflicting_plugins = array(
288
	//	'twitter/twitter.php',                       // The official one handles this on its own.
289
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
290
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
291
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
292
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
293
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
294
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
295
		'twitter-cards/twitter-cards.php',           // Twitter Cards
296
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
297
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
298
	);
299
300
	/**
301
	 * Message to display in admin_notice
302
	 * @var string
303
	 */
304
	public $message = '';
305
306
	/**
307
	 * Error to display in admin_notice
308
	 * @var string
309
	 */
310
	public $error = '';
311
312
	/**
313
	 * Modules that need more privacy description.
314
	 * @var string
315
	 */
316
	public $privacy_checks = '';
317
318
	/**
319
	 * Stats to record once the page loads
320
	 *
321
	 * @var array
322
	 */
323
	public $stats = array();
324
325
	/**
326
	 * Jetpack_Sync object
327
	 */
328
	public $sync;
329
330
	/**
331
	 * Verified data for JSON authorization request
332
	 */
333
	public $json_api_authorization_request = array();
334
335
	/**
336
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
337
	 */
338
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
339
340
	/**
341
	 * Holds the singleton instance of this class
342
	 * @since 2.3.3
343
	 * @var Jetpack
344
	 */
345
	static $instance = false;
346
347
	/**
348
	 * Singleton
349
	 * @static
350
	 */
351
	public static function init() {
352
		if ( ! self::$instance ) {
353
			self::$instance = new Jetpack;
354
355
			self::$instance->plugin_upgrade();
356
		}
357
358
		return self::$instance;
359
	}
360
361
	/**
362
	 * Must never be called statically
363
	 */
364
	function plugin_upgrade() {
365
		if ( Jetpack::is_active() ) {
366
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
367
			if ( JETPACK__VERSION != $version ) {
368
				// Prevent multiple upgrades at once - only a single process should trigger
369
				// an upgrade to avoid stampedes
370
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
371
					return;
372
				}
373
374
				// Set a short lock to prevent multiple instances of the upgrade
375
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
376
377
				// check which active modules actually exist and remove others from active_modules list
378
				$unfiltered_modules = Jetpack::get_active_modules();
379
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
380
				if ( array_diff( $unfiltered_modules, $modules ) ) {
381
					Jetpack::update_active_modules( $modules );
382
				}
383
384
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
385
386
				// Upgrade to 4.3.0
387
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
388
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
389
				}
390
391
				// Make sure Markdown for posts gets turned back on
392
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
393
					update_option( 'wpcom_publish_posts_with_markdown', true );
394
				}
395
396
				if ( did_action( 'wp_loaded' ) ) {
397
					self::upgrade_on_load();
398
				} else {
399
					add_action(
400
						'wp_loaded',
401
						array( __CLASS__, 'upgrade_on_load' )
402
					);
403
				}
404
			}
405
		}
406
	}
407
408
	/**
409
	 * Runs upgrade routines that need to have modules loaded.
410
	 */
411
	static function upgrade_on_load() {
412
413
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
414
		// This can happen in case Jetpack has been just upgraded and is
415
		// being initialized late during the page load. In this case we wait
416
		// until the next proper admin page load with Jetpack active.
417
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
418
			delete_transient( self::$plugin_upgrade_lock_key );
419
420
			return;
421
		}
422
423
		Jetpack::maybe_set_version_option();
424
425
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
426
			Jetpack_Widget_Conditions::migrate_post_type_rules();
427
		}
428
429
		if (
430
			class_exists( 'Jetpack_Sitemap_Manager' )
431
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
432
		) {
433
			do_action( 'jetpack_sitemaps_purge_data' );
434
		}
435
436
		delete_transient( self::$plugin_upgrade_lock_key );
437
	}
438
439
	static function activate_manage( ) {
440
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
441
			self::activate_module( 'manage', false, false );
442
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
443
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
444
		}
445
	}
446
447
	static function update_active_modules( $modules ) {
448
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
449
450
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
451
452
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
453
			$new_active_modules = array_diff( $modules, $current_modules );
454
			foreach( $new_active_modules as $module ) {
455
				/**
456
				 * Fires when a specific module is activated.
457
				 *
458
				 * @since 1.9.0
459
				 *
460
				 * @param string $module Module slug.
461
				 * @param boolean $success whether the module was activated. @since 4.2
462
				 */
463
				do_action( 'jetpack_activate_module', $module, $success );
464
465
				/**
466
				 * Fires when a module is activated.
467
				 * The dynamic part of the filter, $module, is the module slug.
468
				 *
469
				 * @since 1.9.0
470
				 *
471
				 * @param string $module Module slug.
472
				 */
473
				do_action( "jetpack_activate_module_$module", $module );
474
			}
475
476
			$new_deactive_modules = array_diff( $current_modules, $modules );
477
			foreach( $new_deactive_modules as $module ) {
478
				/**
479
				 * Fired after a module has been deactivated.
480
				 *
481
				 * @since 4.2.0
482
				 *
483
				 * @param string $module Module slug.
484
				 * @param boolean $success whether the module was deactivated.
485
				 */
486
				do_action( 'jetpack_deactivate_module', $module, $success );
487
				/**
488
				 * Fires when a module is deactivated.
489
				 * The dynamic part of the filter, $module, is the module slug.
490
				 *
491
				 * @since 1.9.0
492
				 *
493
				 * @param string $module Module slug.
494
				 */
495
				do_action( "jetpack_deactivate_module_$module", $module );
496
			}
497
		}
498
499
		return $success;
500
	}
501
502
	static function delete_active_modules() {
503
		self::update_active_modules( array() );
504
	}
505
506
	/**
507
	 * Constructor.  Initializes WordPress hooks
508
	 */
509
	private function __construct() {
510
		/*
511
		 * Check for and alert any deprecated hooks
512
		 */
513
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
514
515
		/*
516
		 * Enable enhanced handling of previewing sites in Calypso
517
		 */
518
		if ( Jetpack::is_active() ) {
519
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
520
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
521
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
522
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
523
		}
524
525
		/*
526
		 * Load things that should only be in Network Admin.
527
		 *
528
		 * For now blow away everything else until a more full
529
		 * understanding of what is needed at the network level is
530
		 * available
531
		 */
532
		if( is_multisite() ) {
533
			Jetpack_Network::init();
534
		}
535
536
		/**
537
		 * Prepare Gutenberg Editor functionality
538
		 */
539
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
540
		add_action( 'init', array( 'Jetpack_Gutenberg', 'load_blocks' ) ); // Registers all the Jetpack blocks .
541
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
542
		add_filter( 'jetpack_set_available_blocks', array( 'Jetpack_Gutenberg', 'jetpack_set_available_blocks' ) );
543
544
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
545
546
		// Unlink user before deleting the user from .com
547
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
548
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
549
550
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
551
			@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...
552
553
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
554
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
555
556
			$this->require_jetpack_authentication();
557
558
			if ( Jetpack::is_active() ) {
559
				// Hack to preserve $HTTP_RAW_POST_DATA
560
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
561
562
				$signed = $this->verify_xml_rpc_signature();
563 View Code Duplication
				if ( $signed && ! is_wp_error( $signed ) ) {
564
					// The actual API methods.
565
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
566
				} else {
567
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
568
					// active Jetpack connection, so that additional users can link their account.
569
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
570
				}
571 View Code Duplication
			} else {
572
				// The bootstrap API methods.
573
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
574
				$signed = $this->verify_xml_rpc_signature();
575
				if ( $signed && ! is_wp_error( $signed ) ) {
576
					// the jetpack Provision method is available for blog-token-signed requests
577
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
578
				}
579
			}
580
581
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
582
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
583
		} elseif (
584
			is_admin() &&
585
			isset( $_POST['action'] ) && (
586
				'jetpack_upload_file' == $_POST['action'] ||
587
				'jetpack_update_file' == $_POST['action']
588
			)
589
		) {
590
			$this->require_jetpack_authentication();
591
			$this->add_remote_request_handlers();
592
		} else {
593
			if ( Jetpack::is_active() ) {
594
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
595
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
596
			}
597
		}
598
599
		if ( Jetpack::is_active() ) {
600
			Jetpack_Heartbeat::init();
601
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
602
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
603
				Jetpack_Search_Performance_Logger::init();
604
			}
605
		}
606
607
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
608
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
609
610
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
611
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
612
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
613
		}
614
615
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
616
617
		add_action( 'admin_init', array( $this, 'admin_init' ) );
618
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
619
620
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
621
622
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
623
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
624
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
625
626
		// returns HTTPS support status
627
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
628
629
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
630
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
631
632
		// JITM AJAX callback function
633
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
634
635
		// Universal ajax callback for all tracking events triggered via js
636
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
637
638
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
639
640
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
641
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
642
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
643
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
644
645
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
646
647
		/**
648
		 * These actions run checks to load additional files.
649
		 * They check for external files or plugins, so they need to run as late as possible.
650
		 */
651
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
652
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
653
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
654
655
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
656
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
657
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
658
659
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
660
661
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
662
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
663
664
		// A filter to control all just in time messages
665
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
666
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
667
668
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
669
		// We should make sure to only do this for front end links.
670
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
671
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
672
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
673
674
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
675
			//so they point moderation links on emails to Calypso
676
			jetpack_require_lib( 'functions.wp-notify' );
677
		}
678
679
		// Update the Jetpack plan from API on heartbeats
680
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
681
682
		/**
683
		 * This is the hack to concatenate all css files into one.
684
		 * For description and reasoning see the implode_frontend_css method
685
		 *
686
		 * Super late priority so we catch all the registered styles
687
		 */
688
		if( !is_admin() ) {
689
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
690
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
691
		}
692
693
		/**
694
		 * These are sync actions that we need to keep track of for jitms
695
		 */
696
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
697
698
		// Actually push the stats on shutdown.
699
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
700
			add_action( 'shutdown', array( $this, 'push_stats' ) );
701
		}
702
	}
703
704
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
705
		$post = get_post( $post_id );
706
707
		if ( empty( $post ) ) {
708
			return $default_url;
709
		}
710
711
		$post_type = $post->post_type;
712
713
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
714
		// https://en.support.wordpress.com/custom-post-types/
715
		$allowed_post_types = array(
716
			'post' => 'post',
717
			'page' => 'page',
718
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
719
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
720
		);
721
722
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
723
			return $default_url;
724
		}
725
726
		$path_prefix = $allowed_post_types[ $post_type ];
727
728
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
729
730
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
731
	}
732
733
	function point_edit_comment_links_to_calypso( $url ) {
734
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
735
		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...
736
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
737
			Jetpack::build_raw_urls( get_home_url() ),
738
			$query_args['amp;c']
739
		) );
740
	}
741
742
	function jetpack_track_last_sync_callback( $params ) {
743
		/**
744
		 * Filter to turn off jitm caching
745
		 *
746
		 * @since 5.4.0
747
		 *
748
		 * @param bool false Whether to cache just in time messages
749
		 */
750
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
751
			return $params;
752
		}
753
754
		if ( is_array( $params ) && isset( $params[0] ) ) {
755
			$option = $params[0];
756
			if ( 'active_plugins' === $option ) {
757
				// use the cache if we can, but not terribly important if it gets evicted
758
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
759
			}
760
		}
761
762
		return $params;
763
	}
764
765
	function jetpack_connection_banner_callback() {
766
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
767
768
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
769
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
770
			wp_send_json_success();
771
		}
772
773
		wp_die();
774
	}
775
776
	function jetpack_admin_ajax_tracks_callback() {
777
		// Check for nonce
778
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
779
			wp_die( 'Permissions check failed.' );
780
		}
781
782
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
783
			wp_die( 'No valid event name or type.' );
784
		}
785
786
		$tracks_data = array();
787
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
788
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
789
				$tracks_data = $_REQUEST['tracksEventProp'];
790
			} else {
791
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
792
			}
793
		}
794
795
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
796
		wp_send_json_success();
797
		wp_die();
798
	}
799
800
	/**
801
	 * The callback for the JITM ajax requests.
802
	 */
803
	function jetpack_jitm_ajax_callback() {
804
		// Check for nonce
805
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
806
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
807
		}
808
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
809
			$module_slug = $_REQUEST['jitmModule'];
810
			Jetpack::log( 'activate', $module_slug );
811
			Jetpack::activate_module( $module_slug, false, false );
812
			Jetpack::state( 'message', 'no_message' );
813
814
			//A Jetpack module is being activated through a JITM, track it
815
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
816
			$this->do_stats( 'server_side' );
817
818
			wp_send_json_success();
819
		}
820
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
821
			// get the hide_jitm options array
822
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
823
			$module_slug = $_REQUEST['jitmModule'];
824
825
			if( ! $jetpack_hide_jitm ) {
826
				$jetpack_hide_jitm = array(
827
					$module_slug => 'hide'
828
				);
829
			} else {
830
				$jetpack_hide_jitm[$module_slug] = 'hide';
831
			}
832
833
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
834
835
			//jitm is being dismissed forever, track it
836
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
837
			$this->do_stats( 'server_side' );
838
839
			wp_send_json_success();
840
		}
841 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
842
			$module_slug = $_REQUEST['jitmModule'];
843
844
			// User went to WordPress.com, track this
845
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
846
			$this->do_stats( 'server_side' );
847
848
			wp_send_json_success();
849
		}
850 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
851
			$track = $_REQUEST['jitmModule'];
852
853
			// User is viewing JITM, track it.
854
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
855
			$this->do_stats( 'server_side' );
856
857
			wp_send_json_success();
858
		}
859
	}
860
861
	/**
862
	 * If there are any stats that need to be pushed, but haven't been, push them now.
863
	 */
864
	function push_stats() {
865
		if ( ! empty( $this->stats ) ) {
866
			$this->do_stats( 'server_side' );
867
		}
868
	}
869
870
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
871
		switch( $cap ) {
872
			case 'jetpack_connect' :
873
			case 'jetpack_reconnect' :
874
				if ( Jetpack::is_development_mode() ) {
875
					$caps = array( 'do_not_allow' );
876
					break;
877
				}
878
				/**
879
				 * Pass through. If it's not development mode, these should match disconnect.
880
				 * Let users disconnect if it's development mode, just in case things glitch.
881
				 */
882
			case 'jetpack_disconnect' :
883
				/**
884
				 * In multisite, can individual site admins manage their own connection?
885
				 *
886
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
887
				 */
888
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
889
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
890
						/**
891
						 * We need to update the option name -- it's terribly unclear which
892
						 * direction the override goes.
893
						 *
894
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
895
						 */
896
						$caps = array( 'do_not_allow' );
897
						break;
898
					}
899
				}
900
901
				$caps = array( 'manage_options' );
902
				break;
903
			case 'jetpack_manage_modules' :
904
			case 'jetpack_activate_modules' :
905
			case 'jetpack_deactivate_modules' :
906
				$caps = array( 'manage_options' );
907
				break;
908
			case 'jetpack_configure_modules' :
909
				$caps = array( 'manage_options' );
910
				break;
911
			case 'jetpack_manage_autoupdates' :
912
				$caps = array(
913
					'manage_options',
914
					'update_plugins',
915
				);
916
				break;
917
			case 'jetpack_network_admin_page':
918
			case 'jetpack_network_settings_page':
919
				$caps = array( 'manage_network_plugins' );
920
				break;
921
			case 'jetpack_network_sites_page':
922
				$caps = array( 'manage_sites' );
923
				break;
924
			case 'jetpack_admin_page' :
925
				if ( Jetpack::is_development_mode() ) {
926
					$caps = array( 'manage_options' );
927
					break;
928
				} else {
929
					$caps = array( 'read' );
930
				}
931
				break;
932
			case 'jetpack_connect_user' :
933
				if ( Jetpack::is_development_mode() ) {
934
					$caps = array( 'do_not_allow' );
935
					break;
936
				}
937
				$caps = array( 'read' );
938
				break;
939
		}
940
		return $caps;
941
	}
942
943
	function require_jetpack_authentication() {
944
		// Don't let anyone authenticate
945
		$_COOKIE = array();
946
		remove_all_filters( 'authenticate' );
947
		remove_all_actions( 'wp_login_failed' );
948
949
		if ( Jetpack::is_active() ) {
950
			// Allow Jetpack authentication
951
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
952
		}
953
	}
954
955
	/**
956
	 * Load language files
957
	 * @action plugins_loaded
958
	 */
959
	public static function plugin_textdomain() {
960
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
961
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
962
	}
963
964
	/**
965
	 * Register assets for use in various modules and the Jetpack admin page.
966
	 *
967
	 * @uses wp_script_is, wp_register_script, plugins_url
968
	 * @action wp_loaded
969
	 * @return null
970
	 */
971
	public function register_assets() {
972
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
973
			wp_register_script(
974
				'spin',
975
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
976
				false,
977
				'1.3'
978
			);
979
		}
980
981
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
982
			wp_register_script(
983
				'jquery.spin',
984
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
985
				array( 'jquery', 'spin' ),
986
				'1.3'
987
			);
988
		}
989
990 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
991
			wp_register_script(
992
				'jetpack-gallery-settings',
993
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
994
				array( 'media-views' ),
995
				'20121225'
996
			);
997
		}
998
999
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1000
			wp_register_script(
1001
				'jetpack-twitter-timeline',
1002
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1003
				array( 'jquery' ),
1004
				'4.0.0',
1005
				true
1006
			);
1007
		}
1008
1009
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1010
			wp_register_script(
1011
				'jetpack-facebook-embed',
1012
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1013
				array( 'jquery' ),
1014
				null,
1015
				true
1016
			);
1017
1018
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1019
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1020
			if ( ! is_numeric( $fb_app_id ) ) {
1021
				$fb_app_id = '';
1022
			}
1023
			wp_localize_script(
1024
				'jetpack-facebook-embed',
1025
				'jpfbembed',
1026
				array(
1027
					'appid' => $fb_app_id,
1028
					'locale' => $this->get_locale(),
1029
				)
1030
			);
1031
		}
1032
1033
		/**
1034
		 * As jetpack_register_genericons is by default fired off a hook,
1035
		 * the hook may have already fired by this point.
1036
		 * So, let's just trigger it manually.
1037
		 */
1038
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1039
		jetpack_register_genericons();
1040
1041
		/**
1042
		 * Register the social logos
1043
		 */
1044
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1045
		jetpack_register_social_logos();
1046
1047 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1048
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1049
	}
1050
1051
	/**
1052
	 * Guess locale from language code.
1053
	 *
1054
	 * @param string $lang Language code.
1055
	 * @return string|bool
1056
	 */
1057 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1058
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1059
			return 'en_US';
1060
		}
1061
1062
		if ( ! class_exists( 'GP_Locales' ) ) {
1063
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1064
				return false;
1065
			}
1066
1067
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1068
		}
1069
1070
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1071
			// WP.com: get_locale() returns 'it'
1072
			$locale = GP_Locales::by_slug( $lang );
1073
		} else {
1074
			// Jetpack: get_locale() returns 'it_IT';
1075
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1076
		}
1077
1078
		if ( ! $locale ) {
1079
			return false;
1080
		}
1081
1082
		if ( empty( $locale->facebook_locale ) ) {
1083
			if ( empty( $locale->wp_locale ) ) {
1084
				return false;
1085
			} else {
1086
				// Facebook SDK is smart enough to fall back to en_US if a
1087
				// locale isn't supported. Since supported Facebook locales
1088
				// can fall out of sync, we'll attempt to use the known
1089
				// wp_locale value and rely on said fallback.
1090
				return $locale->wp_locale;
1091
			}
1092
		}
1093
1094
		return $locale->facebook_locale;
1095
	}
1096
1097
	/**
1098
	 * Get the locale.
1099
	 *
1100
	 * @return string|bool
1101
	 */
1102
	function get_locale() {
1103
		$locale = $this->guess_locale_from_lang( get_locale() );
1104
1105
		if ( ! $locale ) {
1106
			$locale = 'en_US';
1107
		}
1108
1109
		return $locale;
1110
	}
1111
1112
	/**
1113
	 * Device Pixels support
1114
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1115
	 */
1116
	function devicepx() {
1117
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1118
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1119
		}
1120
	}
1121
1122
	/**
1123
	 * Return the network_site_url so that .com knows what network this site is a part of.
1124
	 * @param  bool $option
1125
	 * @return string
1126
	 */
1127
	public function jetpack_main_network_site_option( $option ) {
1128
		return network_site_url();
1129
	}
1130
	/**
1131
	 * Network Name.
1132
	 */
1133
	static function network_name( $option = null ) {
1134
		global $current_site;
1135
		return $current_site->site_name;
1136
	}
1137
	/**
1138
	 * Does the network allow new user and site registrations.
1139
	 * @return string
1140
	 */
1141
	static function network_allow_new_registrations( $option = null ) {
1142
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1143
	}
1144
	/**
1145
	 * Does the network allow admins to add new users.
1146
	 * @return boolian
1147
	 */
1148
	static function network_add_new_users( $option = null ) {
1149
		return (bool) get_site_option( 'add_new_users' );
1150
	}
1151
	/**
1152
	 * File upload psace left per site in MB.
1153
	 *  -1 means NO LIMIT.
1154
	 * @return number
1155
	 */
1156
	static function network_site_upload_space( $option = null ) {
1157
		// value in MB
1158
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1159
	}
1160
1161
	/**
1162
	 * Network allowed file types.
1163
	 * @return string
1164
	 */
1165
	static function network_upload_file_types( $option = null ) {
1166
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1167
	}
1168
1169
	/**
1170
	 * Maximum file upload size set by the network.
1171
	 * @return number
1172
	 */
1173
	static function network_max_upload_file_size( $option = null ) {
1174
		// value in KB
1175
		return get_site_option( 'fileupload_maxk', 300 );
1176
	}
1177
1178
	/**
1179
	 * Lets us know if a site allows admins to manage the network.
1180
	 * @return array
1181
	 */
1182
	static function network_enable_administration_menus( $option = null ) {
1183
		return get_site_option( 'menu_items' );
1184
	}
1185
1186
	/**
1187
	 * If a user has been promoted to or demoted from admin, we need to clear the
1188
	 * jetpack_other_linked_admins transient.
1189
	 *
1190
	 * @since 4.3.2
1191
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1192
	 *
1193
	 * @param int    $user_id   The user ID whose role changed.
1194
	 * @param string $role      The new role.
1195
	 * @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...
1196
	 */
1197
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1198
		if ( 'administrator' == $role
1199
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1200
			|| is_null( $old_roles )
1201
		) {
1202
			delete_transient( 'jetpack_other_linked_admins' );
1203
		}
1204
	}
1205
1206
	/**
1207
	 * Checks to see if there are any other users available to become primary
1208
	 * Users must both:
1209
	 * - Be linked to wpcom
1210
	 * - Be an admin
1211
	 *
1212
	 * @return mixed False if no other users are linked, Int if there are.
1213
	 */
1214
	static function get_other_linked_admins() {
1215
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1216
1217
		if ( false === $other_linked_users ) {
1218
			$admins = get_users( array( 'role' => 'administrator' ) );
1219
			if ( count( $admins ) > 1 ) {
1220
				$available = array();
1221
				foreach ( $admins as $admin ) {
1222
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1223
						$available[] = $admin->ID;
1224
					}
1225
				}
1226
1227
				$count_connected_admins = count( $available );
1228
				if ( count( $available ) > 1 ) {
1229
					$other_linked_users = $count_connected_admins;
1230
				} else {
1231
					$other_linked_users = 0;
1232
				}
1233
			} else {
1234
				$other_linked_users = 0;
1235
			}
1236
1237
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1238
		}
1239
1240
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1241
	}
1242
1243
	/**
1244
	 * Return whether we are dealing with a multi network setup or not.
1245
	 * The reason we are type casting this is because we want to avoid the situation where
1246
	 * the result is false since when is_main_network_option return false it cases
1247
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1248
	 * database which could be set to anything as opposed to what this function returns.
1249
	 * @param  bool  $option
1250
	 *
1251
	 * @return boolean
1252
	 */
1253
	public function is_main_network_option( $option ) {
1254
		// return '1' or ''
1255
		return (string) (bool) Jetpack::is_multi_network();
1256
	}
1257
1258
	/**
1259
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1260
	 *
1261
	 * @param  string  $option
1262
	 * @return boolean
1263
	 */
1264
	public function is_multisite( $option ) {
1265
		return (string) (bool) is_multisite();
1266
	}
1267
1268
	/**
1269
	 * Implemented since there is no core is multi network function
1270
	 * Right now there is no way to tell if we which network is the dominant network on the system
1271
	 *
1272
	 * @since  3.3
1273
	 * @return boolean
1274
	 */
1275
	public static function is_multi_network() {
1276
		global  $wpdb;
1277
1278
		// if we don't have a multi site setup no need to do any more
1279
		if ( ! is_multisite() ) {
1280
			return false;
1281
		}
1282
1283
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1284
		if ( $num_sites > 1 ) {
1285
			return true;
1286
		} else {
1287
			return false;
1288
		}
1289
	}
1290
1291
	/**
1292
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1293
	 * @return null
1294
	 */
1295
	function update_jetpack_main_network_site_option() {
1296
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1297
	}
1298
	/**
1299
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1300
	 *
1301
	 */
1302
	function update_jetpack_network_settings() {
1303
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1304
		// Only sync this info for the main network site.
1305
	}
1306
1307
	/**
1308
	 * Get back if the current site is single user site.
1309
	 *
1310
	 * @return bool
1311
	 */
1312
	public static function is_single_user_site() {
1313
		global $wpdb;
1314
1315 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1316
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1317
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1318
		}
1319
		return 1 === (int) $some_users;
1320
	}
1321
1322
	/**
1323
	 * Returns true if the site has file write access false otherwise.
1324
	 * @return string ( '1' | '0' )
1325
	 **/
1326
	public static function file_system_write_access() {
1327
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1328
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1329
		}
1330
1331
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1332
1333
		$filesystem_method = get_filesystem_method();
1334
		if ( $filesystem_method === 'direct' ) {
1335
			return 1;
1336
		}
1337
1338
		ob_start();
1339
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1340
		ob_end_clean();
1341
		if ( $filesystem_credentials_are_stored ) {
1342
			return 1;
1343
		}
1344
		return 0;
1345
	}
1346
1347
	/**
1348
	 * Finds out if a site is using a version control system.
1349
	 * @return string ( '1' | '0' )
1350
	 **/
1351
	public static function is_version_controlled() {
1352
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1353
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1354
	}
1355
1356
	/**
1357
	 * Determines whether the current theme supports featured images or not.
1358
	 * @return string ( '1' | '0' )
1359
	 */
1360
	public static function featured_images_enabled() {
1361
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1362
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1363
	}
1364
1365
	/**
1366
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1367
	 *
1368
	 * @deprecated 4.7 use get_avatar_url instead.
1369
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1370
	 * @param int $size Size of the avatar image
1371
	 * @param string $default URL to a default image to use if no avatar is available
1372
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1373
	 *
1374
	 * @return array
1375
	 */
1376
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1377
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1378
		return get_avatar_url( $id_or_email, array(
1379
			'size' => $size,
1380
			'default' => $default,
1381
			'force_default' => $force_display,
1382
		) );
1383
	}
1384
1385
	/**
1386
	 * jetpack_updates is saved in the following schema:
1387
	 *
1388
	 * array (
1389
	 *      'plugins'                       => (int) Number of plugin updates available.
1390
	 *      'themes'                        => (int) Number of theme updates available.
1391
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1392
	 *      'translations'                  => (int) Number of translation updates available.
1393
	 *      'total'                         => (int) Total of all available updates.
1394
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1395
	 * )
1396
	 * @return array
1397
	 */
1398
	public static function get_updates() {
1399
		$update_data = wp_get_update_data();
1400
1401
		// Stores the individual update counts as well as the total count.
1402
		if ( isset( $update_data['counts'] ) ) {
1403
			$updates = $update_data['counts'];
1404
		}
1405
1406
		// If we need to update WordPress core, let's find the latest version number.
1407 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1408
			$cur = get_preferred_from_update_core();
1409
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1410
				$updates['wp_update_version'] = $cur->current;
1411
			}
1412
		}
1413
		return isset( $updates ) ? $updates : array();
1414
	}
1415
1416
	public static function get_update_details() {
1417
		$update_details = array(
1418
			'update_core' => get_site_transient( 'update_core' ),
1419
			'update_plugins' => get_site_transient( 'update_plugins' ),
1420
			'update_themes' => get_site_transient( 'update_themes' ),
1421
		);
1422
		return $update_details;
1423
	}
1424
1425
	public static function refresh_update_data() {
1426
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1427
1428
	}
1429
1430
	public static function refresh_theme_data() {
1431
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1432
	}
1433
1434
	/**
1435
	 * Is Jetpack active?
1436
	 */
1437
	public static function is_active() {
1438
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1439
	}
1440
1441
	/**
1442
	 * Make an API call to WordPress.com for plan status
1443
	 *
1444
	 * @uses Jetpack_Options::get_option()
1445
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1446
	 * @uses update_option()
1447
	 *
1448
	 * @access public
1449
	 * @static
1450
	 *
1451
	 * @return bool True if plan is updated, false if no update
1452
	 */
1453
	public static function refresh_active_plan_from_wpcom() {
1454
		// Make the API request
1455
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1456
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1457
1458
		// Bail if there was an error or malformed response
1459
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1460
			return false;
1461
		}
1462
1463
		// Decode the results
1464
		$results = json_decode( $response['body'], true );
1465
1466
		// Bail if there were no results or plan details returned
1467
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1468
			return false;
1469
		}
1470
1471
		// Store the option and return true if updated
1472
		return update_option( 'jetpack_active_plan', $results['plan'] );
1473
	}
1474
1475
	/**
1476
	 * Get the plan that this Jetpack site is currently using
1477
	 *
1478
	 * @uses get_option()
1479
	 *
1480
	 * @access public
1481
	 * @static
1482
	 *
1483
	 * @return array Active Jetpack plan details
1484
	 */
1485
	public static function get_active_plan() {
1486
		global $active_plan_cache;
1487
1488
		// this can be expensive to compute so we cache for the duration of a request
1489
		if ( is_array( $active_plan_cache ) && ! empty( $active_plan_cache ) ) {
1490
			return $active_plan_cache;
1491
		}
1492
1493
		$plan = get_option( 'jetpack_active_plan', array() );
1494
1495
		// Set the default options
1496
		$plan = wp_parse_args( $plan, array(
1497
			'product_slug' => 'jetpack_free',
1498
			'class'        => 'free',
1499
			'features'     => array(
1500
				'active' => array()
1501
			),
1502
		) );
1503
1504
		$supports = array();
1505
1506
		// Define what paid modules are supported by personal plans
1507
		$personal_plans = array(
1508
			'jetpack_personal',
1509
			'jetpack_personal_monthly',
1510
			'personal-bundle',
1511
			'personal-bundle-2y',
1512
		);
1513
1514
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1515
			// special support value, not a module but a separate plugin
1516
			$supports[] = 'akismet';
1517
			$plan['class'] = 'personal';
1518
		}
1519
1520
		// Define what paid modules are supported by premium plans
1521
		$premium_plans = array(
1522
			'jetpack_premium',
1523
			'jetpack_premium_monthly',
1524
			'value_bundle',
1525
			'value_bundle-2y',
1526
		);
1527
1528 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1529
			$supports[] = 'akismet';
1530
			$supports[] = 'simple-payments';
1531
			$supports[] = 'vaultpress';
1532
			$supports[] = 'videopress';
1533
			$plan['class'] = 'premium';
1534
		}
1535
1536
		// Define what paid modules are supported by professional plans
1537
		$business_plans = array(
1538
			'jetpack_business',
1539
			'jetpack_business_monthly',
1540
			'business-bundle',
1541
			'business-bundle-2y',
1542
			'vip',
1543
		);
1544
1545 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1546
			$supports[] = 'akismet';
1547
			$supports[] = 'simple-payments';
1548
			$supports[] = 'vaultpress';
1549
			$supports[] = 'videopress';
1550
			$plan['class'] = 'business';
1551
		}
1552
1553
		// get available features
1554
		foreach ( self::get_available_modules() as $module_slug ) {
1555
			$module = self::get_module( $module_slug );
1556
			if ( ! isset( $module ) || ! is_array( $module ) ) {
1557
				continue;
1558
			}
1559
			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
1560
				$supports[] = $module_slug;
1561
			}
1562
		}
1563
1564
		$plan['supports'] = $supports;
1565
1566
		$active_plan_cache = $plan;
1567
1568
		return $plan;
1569
	}
1570
1571
	/**
1572
	 * Determine whether the active plan supports a particular feature
1573
	 *
1574
	 * @uses Jetpack::get_active_plan()
1575
	 *
1576
	 * @access public
1577
	 * @static
1578
	 *
1579
	 * @return bool True if plan supports feature, false if not
1580
	 */
1581
	public static function active_plan_supports( $feature ) {
1582
		$plan = Jetpack::get_active_plan();
1583
1584
		// Manually mapping WordPress.com features to Jetpack module slugs
1585
		foreach ( $plan['features']['active'] as $wpcom_feature ) {
1586
			switch ( $wpcom_feature ) {
1587
				case 'wordads-jetpack';
1588
1589
				// WordAds are supported for this site
1590
				if ( 'wordads' === $feature ) {
1591
					return true;
1592
				}
1593
				break;
1594
			}
1595
		}
1596
1597
		if (
1598
			in_array( $feature, $plan['supports'] )
1599
			|| in_array( $feature, $plan['features']['active'] )
1600
		) {
1601
			return true;
1602
		}
1603
1604
		return false;
1605
	}
1606
1607
	/**
1608
	 * Is Jetpack in development (offline) mode?
1609
	 */
1610
	public static function is_development_mode() {
1611
		$development_mode = false;
1612
1613
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1614
			$development_mode = JETPACK_DEV_DEBUG;
1615
		} elseif ( $site_url = site_url() ) {
1616
			$development_mode = false === strpos( $site_url, '.' );
1617
		}
1618
1619
		/**
1620
		 * Filters Jetpack's development mode.
1621
		 *
1622
		 * @see https://jetpack.com/support/development-mode/
1623
		 *
1624
		 * @since 2.2.1
1625
		 *
1626
		 * @param bool $development_mode Is Jetpack's development mode active.
1627
		 */
1628
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1629
		return $development_mode;
1630
	}
1631
1632
	/**
1633
	 * Whether the site is currently onboarding or not.
1634
	 * A site is considered as being onboarded if it currently has an onboarding token.
1635
	 *
1636
	 * @since 5.8
1637
	 *
1638
	 * @access public
1639
	 * @static
1640
	 *
1641
	 * @return bool True if the site is currently onboarding, false otherwise
1642
	 */
1643
	public static function is_onboarding() {
1644
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1645
	}
1646
1647
	/**
1648
	* Get Jetpack development mode notice text and notice class.
1649
	*
1650
	* Mirrors the checks made in Jetpack::is_development_mode
1651
	*
1652
	*/
1653
	public static function show_development_mode_notice() {
1654
		if ( Jetpack::is_development_mode() ) {
1655
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1656
				$notice = sprintf(
1657
					/* translators: %s is a URL */
1658
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1659
					'https://jetpack.com/support/development-mode/'
1660
				);
1661
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1662
				$notice = sprintf(
1663
					/* translators: %s is a URL */
1664
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1665
					'https://jetpack.com/support/development-mode/'
1666
				);
1667
			} else {
1668
				$notice = sprintf(
1669
					/* translators: %s is a URL */
1670
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1671
					'https://jetpack.com/support/development-mode/'
1672
				);
1673
			}
1674
1675
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1676
		}
1677
1678
		// Throw up a notice if using a development version and as for feedback.
1679
		if ( Jetpack::is_development_version() ) {
1680
			/* translators: %s is a URL */
1681
			$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/' );
1682
1683
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1684
		}
1685
		// Throw up a notice if using staging mode
1686
		if ( Jetpack::is_staging_site() ) {
1687
			/* translators: %s is a URL */
1688
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1689
1690
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1691
		}
1692
	}
1693
1694
	/**
1695
	 * Whether Jetpack's version maps to a public release, or a development version.
1696
	 */
1697
	public static function is_development_version() {
1698
		/**
1699
		 * Allows filtering whether this is a development version of Jetpack.
1700
		 *
1701
		 * This filter is especially useful for tests.
1702
		 *
1703
		 * @since 4.3.0
1704
		 *
1705
		 * @param bool $development_version Is this a develoment version of Jetpack?
1706
		 */
1707
		return (bool) apply_filters(
1708
			'jetpack_development_version',
1709
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1710
		);
1711
	}
1712
1713
	/**
1714
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1715
	 */
1716
	public static function is_user_connected( $user_id = false ) {
1717
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1718
		if ( ! $user_id ) {
1719
			return false;
1720
		}
1721
1722
		return (bool) Jetpack_Data::get_access_token( $user_id );
1723
	}
1724
1725
	/**
1726
	 * Get the wpcom user data of the current|specified connected user.
1727
	 */
1728
	public static function get_connected_user_data( $user_id = null ) {
1729
		if ( ! $user_id ) {
1730
			$user_id = get_current_user_id();
1731
		}
1732
1733
		$transient_key = "jetpack_connected_user_data_$user_id";
1734
1735
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1736
			return $cached_user_data;
1737
		}
1738
1739
		Jetpack::load_xml_rpc_client();
1740
		$xml = new Jetpack_IXR_Client( array(
1741
			'user_id' => $user_id,
1742
		) );
1743
		$xml->query( 'wpcom.getUser' );
1744
		if ( ! $xml->isError() ) {
1745
			$user_data = $xml->getResponse();
1746
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1747
			return $user_data;
1748
		}
1749
1750
		return false;
1751
	}
1752
1753
	/**
1754
	 * Get the wpcom email of the current|specified connected user.
1755
	 */
1756 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1757
		if ( ! $user_id ) {
1758
			$user_id = get_current_user_id();
1759
		}
1760
		Jetpack::load_xml_rpc_client();
1761
		$xml = new Jetpack_IXR_Client( array(
1762
			'user_id' => $user_id,
1763
		) );
1764
		$xml->query( 'wpcom.getUserEmail' );
1765
		if ( ! $xml->isError() ) {
1766
			return $xml->getResponse();
1767
		}
1768
		return false;
1769
	}
1770
1771
	/**
1772
	 * Get the wpcom email of the master user.
1773
	 */
1774
	public static function get_master_user_email() {
1775
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1776
		if ( $master_user_id ) {
1777
			return self::get_connected_user_email( $master_user_id );
1778
		}
1779
		return '';
1780
	}
1781
1782
	function current_user_is_connection_owner() {
1783
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1784
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1785
	}
1786
1787
	/**
1788
	 * Gets current user IP address.
1789
	 *
1790
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1791
	 *
1792
	 * @return string                  Current user IP address.
1793
	 */
1794
	public static function current_user_ip( $check_all_headers = false ) {
1795
		if ( $check_all_headers ) {
1796
			foreach ( array(
1797
				'HTTP_CF_CONNECTING_IP',
1798
				'HTTP_CLIENT_IP',
1799
				'HTTP_X_FORWARDED_FOR',
1800
				'HTTP_X_FORWARDED',
1801
				'HTTP_X_CLUSTER_CLIENT_IP',
1802
				'HTTP_FORWARDED_FOR',
1803
				'HTTP_FORWARDED',
1804
				'HTTP_VIA',
1805
			) as $key ) {
1806
				if ( ! empty( $_SERVER[ $key ] ) ) {
1807
					return $_SERVER[ $key ];
1808
				}
1809
			}
1810
		}
1811
1812
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1813
	}
1814
1815
	/**
1816
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1817
	 */
1818
	function extra_oembed_providers() {
1819
		// Cloudup: https://dev.cloudup.com/#oembed
1820
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1821
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1822
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1823
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1824
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1825
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1826
	}
1827
1828
	/**
1829
	 * Synchronize connected user role changes
1830
	 */
1831
	function user_role_change( $user_id ) {
1832
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1833
		Jetpack_Sync_Users::user_role_change( $user_id );
1834
	}
1835
1836
	/**
1837
	 * Loads the currently active modules.
1838
	 */
1839
	public static function load_modules() {
1840
		if (
1841
			! self::is_active()
1842
			&& ! self::is_development_mode()
1843
			&& ! self::is_onboarding()
1844
			&& (
1845
				! is_multisite()
1846
				|| ! get_site_option( 'jetpack_protect_active' )
1847
			)
1848
		) {
1849
			return;
1850
		}
1851
1852
		$version = Jetpack_Options::get_option( 'version' );
1853 View Code Duplication
		if ( ! $version ) {
1854
			$version = $old_version = JETPACK__VERSION . ':' . time();
1855
			/** This action is documented in class.jetpack.php */
1856
			do_action( 'updating_jetpack_version', $version, false );
1857
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1858
		}
1859
		list( $version ) = explode( ':', $version );
1860
1861
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1862
1863
		$modules_data = array();
1864
1865
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1866
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1867
			$updated_modules = array();
1868
			foreach ( $modules as $module ) {
1869
				$modules_data[ $module ] = Jetpack::get_module( $module );
1870
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1871
					continue;
1872
				}
1873
1874
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1875
					continue;
1876
				}
1877
1878
				$updated_modules[] = $module;
1879
			}
1880
1881
			$modules = array_diff( $modules, $updated_modules );
1882
		}
1883
1884
		$is_development_mode = Jetpack::is_development_mode();
1885
1886
		foreach ( $modules as $index => $module ) {
1887
			// If we're in dev mode, disable modules requiring a connection
1888
			if ( $is_development_mode ) {
1889
				// Prime the pump if we need to
1890
				if ( empty( $modules_data[ $module ] ) ) {
1891
					$modules_data[ $module ] = Jetpack::get_module( $module );
1892
				}
1893
				// If the module requires a connection, but we're in local mode, don't include it.
1894
				if ( $modules_data[ $module ]['requires_connection'] ) {
1895
					continue;
1896
				}
1897
			}
1898
1899
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1900
				continue;
1901
			}
1902
1903
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1904
				unset( $modules[ $index ] );
1905
				self::update_active_modules( array_values( $modules ) );
1906
				continue;
1907
			}
1908
1909
			/**
1910
			 * Fires when a specific module is loaded.
1911
			 * The dynamic part of the hook, $module, is the module slug.
1912
			 *
1913
			 * @since 1.1.0
1914
			 */
1915
			do_action( 'jetpack_module_loaded_' . $module );
1916
		}
1917
1918
		/**
1919
		 * Fires when all the modules are loaded.
1920
		 *
1921
		 * @since 1.1.0
1922
		 */
1923
		do_action( 'jetpack_modules_loaded' );
1924
1925
		// 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.
1926
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1927
	}
1928
1929
	/**
1930
	 * Check if Jetpack's REST API compat file should be included
1931
	 * @action plugins_loaded
1932
	 * @return null
1933
	 */
1934
	public function check_rest_api_compat() {
1935
		/**
1936
		 * Filters the list of REST API compat files to be included.
1937
		 *
1938
		 * @since 2.2.5
1939
		 *
1940
		 * @param array $args Array of REST API compat files to include.
1941
		 */
1942
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1943
1944
		if ( function_exists( 'bbpress' ) )
1945
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1946
1947
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1948
			require_once $_jetpack_rest_api_compat_include;
1949
	}
1950
1951
	/**
1952
	 * Gets all plugins currently active in values, regardless of whether they're
1953
	 * traditionally activated or network activated.
1954
	 *
1955
	 * @todo Store the result in core's object cache maybe?
1956
	 */
1957
	public static function get_active_plugins() {
1958
		$active_plugins = (array) get_option( 'active_plugins', array() );
1959
1960
		if ( is_multisite() ) {
1961
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1962
			// whereas active_plugins stores them in the values.
1963
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1964
			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...
1965
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1966
			}
1967
		}
1968
1969
		sort( $active_plugins );
1970
1971
		return array_unique( $active_plugins );
1972
	}
1973
1974
	/**
1975
	 * Gets and parses additional plugin data to send with the heartbeat data
1976
	 *
1977
	 * @since 3.8.1
1978
	 *
1979
	 * @return array Array of plugin data
1980
	 */
1981
	public static function get_parsed_plugin_data() {
1982
		if ( ! function_exists( 'get_plugins' ) ) {
1983
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1984
		}
1985
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1986
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1987
		$active_plugins = Jetpack::get_active_plugins();
1988
1989
		$plugins = array();
1990
		foreach ( $all_plugins as $path => $plugin_data ) {
1991
			$plugins[ $path ] = array(
1992
					'is_active' => in_array( $path, $active_plugins ),
1993
					'file'      => $path,
1994
					'name'      => $plugin_data['Name'],
1995
					'version'   => $plugin_data['Version'],
1996
					'author'    => $plugin_data['Author'],
1997
			);
1998
		}
1999
2000
		return $plugins;
2001
	}
2002
2003
	/**
2004
	 * Gets and parses theme data to send with the heartbeat data
2005
	 *
2006
	 * @since 3.8.1
2007
	 *
2008
	 * @return array Array of theme data
2009
	 */
2010
	public static function get_parsed_theme_data() {
2011
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
2012
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2013
2014
		$themes = array();
2015
		foreach ( $all_themes as $slug => $theme_data ) {
2016
			$theme_headers = array();
2017
			foreach ( $header_keys as $header_key ) {
2018
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2019
			}
2020
2021
			$themes[ $slug ] = array(
2022
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
2023
					'slug' => $slug,
2024
					'theme_root' => $theme_data->get_theme_root_uri(),
2025
					'parent' => $theme_data->parent(),
2026
					'headers' => $theme_headers
2027
			);
2028
		}
2029
2030
		return $themes;
2031
	}
2032
2033
	/**
2034
	 * Checks whether a specific plugin is active.
2035
	 *
2036
	 * We don't want to store these in a static variable, in case
2037
	 * there are switch_to_blog() calls involved.
2038
	 */
2039
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2040
		return in_array( $plugin, self::get_active_plugins() );
2041
	}
2042
2043
	/**
2044
	 * Check if Jetpack's Open Graph tags should be used.
2045
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2046
	 *
2047
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2048
	 * @action plugins_loaded
2049
	 * @return null
2050
	 */
2051
	public function check_open_graph() {
2052
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2053
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2054
		}
2055
2056
		$active_plugins = self::get_active_plugins();
2057
2058
		if ( ! empty( $active_plugins ) ) {
2059
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2060
				if ( in_array( $plugin, $active_plugins ) ) {
2061
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2062
					break;
2063
				}
2064
			}
2065
		}
2066
2067
		/**
2068
		 * Allow the addition of Open Graph Meta Tags to all pages.
2069
		 *
2070
		 * @since 2.0.3
2071
		 *
2072
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2073
		 */
2074
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2075
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2076
		}
2077
	}
2078
2079
	/**
2080
	 * Check if Jetpack's Twitter tags should be used.
2081
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2082
	 *
2083
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2084
	 * @action plugins_loaded
2085
	 * @return null
2086
	 */
2087
	public function check_twitter_tags() {
2088
2089
		$active_plugins = self::get_active_plugins();
2090
2091
		if ( ! empty( $active_plugins ) ) {
2092
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2093
				if ( in_array( $plugin, $active_plugins ) ) {
2094
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2095
					break;
2096
				}
2097
			}
2098
		}
2099
2100
		/**
2101
		 * Allow Twitter Card Meta tags to be disabled.
2102
		 *
2103
		 * @since 2.6.0
2104
		 *
2105
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2106
		 */
2107
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2108
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2109
		}
2110
	}
2111
2112
	/**
2113
	 * Allows plugins to submit security reports.
2114
 	 *
2115
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2116
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2117
	 * @param array   $args         See definitions above
2118
	 */
2119
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2120
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2121
	}
2122
2123
/* Jetpack Options API */
2124
2125
	public static function get_option_names( $type = 'compact' ) {
2126
		return Jetpack_Options::get_option_names( $type );
2127
	}
2128
2129
	/**
2130
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2131
 	 *
2132
	 * @param string $name    Option name
2133
	 * @param mixed  $default (optional)
2134
	 */
2135
	public static function get_option( $name, $default = false ) {
2136
		return Jetpack_Options::get_option( $name, $default );
2137
	}
2138
2139
	/**
2140
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2141
 	 *
2142
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2143
	 * @param string $name  Option name
2144
	 * @param mixed  $value Option value
2145
	 */
2146
	public static function update_option( $name, $value ) {
2147
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2148
		return Jetpack_Options::update_option( $name, $value );
2149
	}
2150
2151
	/**
2152
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2153
 	 *
2154
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2155
	 * @param array $array array( option name => option value, ... )
2156
	 */
2157
	public static function update_options( $array ) {
2158
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2159
		return Jetpack_Options::update_options( $array );
2160
	}
2161
2162
	/**
2163
	 * Deletes the given option.  May be passed multiple option names as an array.
2164
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2165
	 *
2166
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2167
	 * @param string|array $names
2168
	 */
2169
	public static function delete_option( $names ) {
2170
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2171
		return Jetpack_Options::delete_option( $names );
2172
	}
2173
2174
	/**
2175
	 * Enters a user token into the user_tokens option
2176
	 *
2177
	 * @param int $user_id
2178
	 * @param string $token
2179
	 * return bool
2180
	 */
2181
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2182
		// not designed for concurrent updates
2183
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2184
		if ( ! is_array( $user_tokens ) )
2185
			$user_tokens = array();
2186
		$user_tokens[$user_id] = $token;
2187
		if ( $is_master_user ) {
2188
			$master_user = $user_id;
2189
			$options     = compact( 'user_tokens', 'master_user' );
2190
		} else {
2191
			$options = compact( 'user_tokens' );
2192
		}
2193
		return Jetpack_Options::update_options( $options );
2194
	}
2195
2196
	/**
2197
	 * Returns an array of all PHP files in the specified absolute path.
2198
	 * Equivalent to glob( "$absolute_path/*.php" ).
2199
	 *
2200
	 * @param string $absolute_path The absolute path of the directory to search.
2201
	 * @return array Array of absolute paths to the PHP files.
2202
	 */
2203
	public static function glob_php( $absolute_path ) {
2204
		if ( function_exists( 'glob' ) ) {
2205
			return glob( "$absolute_path/*.php" );
2206
		}
2207
2208
		$absolute_path = untrailingslashit( $absolute_path );
2209
		$files = array();
2210
		if ( ! $dir = @opendir( $absolute_path ) ) {
2211
			return $files;
2212
		}
2213
2214
		while ( false !== $file = readdir( $dir ) ) {
2215
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2216
				continue;
2217
			}
2218
2219
			$file = "$absolute_path/$file";
2220
2221
			if ( ! is_file( $file ) ) {
2222
				continue;
2223
			}
2224
2225
			$files[] = $file;
2226
		}
2227
2228
		closedir( $dir );
2229
2230
		return $files;
2231
	}
2232
2233
	public static function activate_new_modules( $redirect = false ) {
2234
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2235
			return;
2236
		}
2237
2238
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2239 View Code Duplication
		if ( ! $jetpack_old_version ) {
2240
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2241
			/** This action is documented in class.jetpack.php */
2242
			do_action( 'updating_jetpack_version', $version, false );
2243
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2244
		}
2245
2246
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2247
2248
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2249
			return;
2250
		}
2251
2252
		$active_modules     = Jetpack::get_active_modules();
2253
		$reactivate_modules = array();
2254
		foreach ( $active_modules as $active_module ) {
2255
			$module = Jetpack::get_module( $active_module );
2256
			if ( ! isset( $module['changed'] ) ) {
2257
				continue;
2258
			}
2259
2260
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2261
				continue;
2262
			}
2263
2264
			$reactivate_modules[] = $active_module;
2265
			Jetpack::deactivate_module( $active_module );
2266
		}
2267
2268
		$new_version = JETPACK__VERSION . ':' . time();
2269
		/** This action is documented in class.jetpack.php */
2270
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2271
		Jetpack_Options::update_options(
2272
			array(
2273
				'version'     => $new_version,
2274
				'old_version' => $jetpack_old_version,
2275
			)
2276
		);
2277
2278
		Jetpack::state( 'message', 'modules_activated' );
2279
		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...
2280
2281
		if ( $redirect ) {
2282
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2283
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2284
				$page = $_GET['page'];
2285
			}
2286
2287
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2288
			exit;
2289
		}
2290
	}
2291
2292
	/**
2293
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2294
	 * Make sure to tuck away module "library" files in a sub-directory.
2295
	 */
2296
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2297
		static $modules = null;
2298
2299
		if ( ! isset( $modules ) ) {
2300
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2301
			// Use the cache if we're on the front-end and it's available...
2302
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2303
				$modules = $available_modules_option[ JETPACK__VERSION ];
2304
			} else {
2305
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2306
2307
				$modules = array();
2308
2309
				foreach ( $files as $file ) {
2310
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2311
						continue;
2312
					}
2313
2314
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2315
				}
2316
2317
				Jetpack_Options::update_option( 'available_modules', array(
2318
					JETPACK__VERSION => $modules,
2319
				) );
2320
			}
2321
		}
2322
2323
		/**
2324
		 * Filters the array of modules available to be activated.
2325
		 *
2326
		 * @since 2.4.0
2327
		 *
2328
		 * @param array $modules Array of available modules.
2329
		 * @param string $min_version Minimum version number required to use modules.
2330
		 * @param string $max_version Maximum version number required to use modules.
2331
		 */
2332
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2333
2334
		if ( ! $min_version && ! $max_version ) {
2335
			return array_keys( $mods );
2336
		}
2337
2338
		$r = array();
2339
		foreach ( $mods as $slug => $introduced ) {
2340
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2341
				continue;
2342
			}
2343
2344
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2345
				continue;
2346
			}
2347
2348
			$r[] = $slug;
2349
		}
2350
2351
		return $r;
2352
	}
2353
2354
	/**
2355
	 * Default modules loaded on activation.
2356
	 */
2357
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2358
		$return = array();
2359
2360
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2361
			$module_data = Jetpack::get_module( $module );
2362
2363
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2364
				case 'yes' :
2365
					$return[] = $module;
2366
					break;
2367
				case 'public' :
2368
					if ( Jetpack_Options::get_option( 'public' ) ) {
2369
						$return[] = $module;
2370
					}
2371
					break;
2372
				case 'no' :
2373
				default :
2374
					break;
2375
			}
2376
		}
2377
		/**
2378
		 * Filters the array of default modules.
2379
		 *
2380
		 * @since 2.5.0
2381
		 *
2382
		 * @param array $return Array of default modules.
2383
		 * @param string $min_version Minimum version number required to use modules.
2384
		 * @param string $max_version Maximum version number required to use modules.
2385
		 */
2386
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2387
	}
2388
2389
	/**
2390
	 * Checks activated modules during auto-activation to determine
2391
	 * if any of those modules are being deprecated.  If so, close
2392
	 * them out, and add any replacement modules.
2393
	 *
2394
	 * Runs at priority 99 by default.
2395
	 *
2396
	 * This is run late, so that it can still activate a module if
2397
	 * the new module is a replacement for another that the user
2398
	 * currently has active, even if something at the normal priority
2399
	 * would kibosh everything.
2400
	 *
2401
	 * @since 2.6
2402
	 * @uses jetpack_get_default_modules filter
2403
	 * @param array $modules
2404
	 * @return array
2405
	 */
2406
	function handle_deprecated_modules( $modules ) {
2407
		$deprecated_modules = array(
2408
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2409
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2410
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2411
		);
2412
2413
		// Don't activate SSO if they never completed activating WPCC.
2414
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2415
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2416
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2417
				$deprecated_modules['wpcc'] = null;
2418
			}
2419
		}
2420
2421
		foreach ( $deprecated_modules as $module => $replacement ) {
2422
			if ( Jetpack::is_module_active( $module ) ) {
2423
				self::deactivate_module( $module );
2424
				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...
2425
					$modules[] = $replacement;
2426
				}
2427
			}
2428
		}
2429
2430
		return array_unique( $modules );
2431
	}
2432
2433
	/**
2434
	 * Checks activated plugins during auto-activation to determine
2435
	 * if any of those plugins are in the list with a corresponding module
2436
	 * that is not compatible with the plugin. The module will not be allowed
2437
	 * to auto-activate.
2438
	 *
2439
	 * @since 2.6
2440
	 * @uses jetpack_get_default_modules filter
2441
	 * @param array $modules
2442
	 * @return array
2443
	 */
2444
	function filter_default_modules( $modules ) {
2445
2446
		$active_plugins = self::get_active_plugins();
2447
2448
		if ( ! empty( $active_plugins ) ) {
2449
2450
			// For each module we'd like to auto-activate...
2451
			foreach ( $modules as $key => $module ) {
2452
				// If there are potential conflicts for it...
2453
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2454
					// For each potential conflict...
2455
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2456
						// If that conflicting plugin is active...
2457
						if ( in_array( $plugin, $active_plugins ) ) {
2458
							// Remove that item from being auto-activated.
2459
							unset( $modules[ $key ] );
2460
						}
2461
					}
2462
				}
2463
			}
2464
		}
2465
2466
		return $modules;
2467
	}
2468
2469
	/**
2470
	 * Extract a module's slug from its full path.
2471
	 */
2472
	public static function get_module_slug( $file ) {
2473
		return str_replace( '.php', '', basename( $file ) );
2474
	}
2475
2476
	/**
2477
	 * Generate a module's path from its slug.
2478
	 */
2479
	public static function get_module_path( $slug ) {
2480
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2481
	}
2482
2483
	/**
2484
	 * Load module data from module file. Headers differ from WordPress
2485
	 * plugin headers to avoid them being identified as standalone
2486
	 * plugins on the WordPress plugins page.
2487
	 */
2488
	public static function get_module( $module ) {
2489
		$headers = array(
2490
			'name'                      => 'Module Name',
2491
			'description'               => 'Module Description',
2492
			'jumpstart_desc'            => 'Jumpstart Description',
2493
			'sort'                      => 'Sort Order',
2494
			'recommendation_order'      => 'Recommendation Order',
2495
			'introduced'                => 'First Introduced',
2496
			'changed'                   => 'Major Changes In',
2497
			'deactivate'                => 'Deactivate',
2498
			'free'                      => 'Free',
2499
			'requires_connection'       => 'Requires Connection',
2500
			'auto_activate'             => 'Auto Activate',
2501
			'module_tags'               => 'Module Tags',
2502
			'feature'                   => 'Feature',
2503
			'additional_search_queries' => 'Additional Search Queries',
2504
			'plan_classes'              => 'Plans',
2505
		);
2506
2507
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2508
2509
		$mod = Jetpack::get_file_data( $file, $headers );
2510
		if ( empty( $mod['name'] ) ) {
2511
			return false;
2512
		}
2513
2514
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2515
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2516
		$mod['deactivate']              = empty( $mod['deactivate'] );
2517
		$mod['free']                    = empty( $mod['free'] );
2518
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2519
2520
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2521
			$mod['auto_activate'] = 'No';
2522
		} else {
2523
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2524
		}
2525
2526
		if ( $mod['module_tags'] ) {
2527
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2528
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2529
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2530
		} else {
2531
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2532
		}
2533
2534 View Code Duplication
		if ( $mod['plan_classes'] ) {
2535
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2536
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2537
		} else {
2538
			$mod['plan_classes'] = array( 'free' );
2539
		}
2540
2541 View Code Duplication
		if ( $mod['feature'] ) {
2542
			$mod['feature'] = explode( ',', $mod['feature'] );
2543
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2544
		} else {
2545
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2546
		}
2547
2548
		/**
2549
		 * Filters the feature array on a module.
2550
		 *
2551
		 * This filter allows you to control where each module is filtered: Recommended,
2552
		 * Jumpstart, and the default "Other" listing.
2553
		 *
2554
		 * @since 3.5.0
2555
		 *
2556
		 * @param array   $mod['feature'] The areas to feature this module:
2557
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2558
		 *     'Recommended' shows on the main Jetpack admin screen.
2559
		 *     'Other' should be the default if no other value is in the array.
2560
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2561
		 * @param array   $mod All the currently assembled module data.
2562
		 */
2563
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2564
2565
		/**
2566
		 * Filter the returned data about a module.
2567
		 *
2568
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2569
		 * so please be careful.
2570
		 *
2571
		 * @since 3.6.0
2572
		 *
2573
		 * @param array   $mod    The details of the requested module.
2574
		 * @param string  $module The slug of the module, e.g. sharedaddy
2575
		 * @param string  $file   The path to the module source file.
2576
		 */
2577
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2578
	}
2579
2580
	/**
2581
	 * Like core's get_file_data implementation, but caches the result.
2582
	 */
2583
	public static function get_file_data( $file, $headers ) {
2584
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2585
		$file_name = basename( $file );
2586
2587
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2588
2589
		$file_data_option = get_transient( $cache_key );
2590
2591
		if ( false === $file_data_option ) {
2592
			$file_data_option = array();
2593
		}
2594
2595
		$key           = md5( $file_name . serialize( $headers ) );
2596
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2597
2598
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2599
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2600
			return $file_data_option[ $key ];
2601
		}
2602
2603
		$data = get_file_data( $file, $headers );
2604
2605
		$file_data_option[ $key ] = $data;
2606
2607
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2608
2609
		return $data;
2610
	}
2611
2612
2613
	/**
2614
	 * Return translated module tag.
2615
	 *
2616
	 * @param string $tag Tag as it appears in each module heading.
2617
	 *
2618
	 * @return mixed
2619
	 */
2620
	public static function translate_module_tag( $tag ) {
2621
		return jetpack_get_module_i18n_tag( $tag );
2622
	}
2623
2624
	/**
2625
	 * Get i18n strings as a JSON-encoded string
2626
	 *
2627
	 * @return string The locale as JSON
2628
	 */
2629
	public static function get_i18n_data_json() {
2630
		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . get_user_locale() . '.json';
2631
2632
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2633
			$locale_data = @file_get_contents( $i18n_json );
2634
			if ( $locale_data ) {
2635
				return $locale_data;
2636
			}
2637
		}
2638
2639
		// Return valid empty Jed locale
2640
		return json_encode( array(
2641
			'' => array(
2642
				'domain' => 'jetpack',
2643
				'lang'   => is_admin() ? get_user_locale() : get_locale(),
2644
			),
2645
		) );
2646
	}
2647
2648
	/**
2649
	 * Add locale data setup to wp-i18n
2650
	 *
2651
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2652
	 *
2653
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2654
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2655
	 *
2656
	 * This method provides a safe way to request the setup multiple times but add the script at
2657
	 * most once.
2658
	 *
2659
	 * @since 6.7.0
2660
	 *
2661
	 * @return void
2662
	 */
2663
	public static function setup_wp_i18n_locale_data() {
2664
		static $script_added = false;
2665
		if ( ! $script_added ) {
2666
			$script_added = true;
2667
			wp_add_inline_script(
2668
				'wp-i18n',
2669
				'wp.i18n.setLocaleData( ' . Jetpack::get_i18n_data_json() . ', \'jetpack\' );'
2670
			);
2671
		}
2672
	}
2673
2674
	/**
2675
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2676
	 *
2677
	 * @since 3.9.2
2678
	 *
2679
	 * @param array $modules
2680
	 *
2681
	 * @return string|void
2682
	 */
2683
	public static function get_translated_modules( $modules ) {
2684
		foreach ( $modules as $index => $module ) {
2685
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2686
			if ( isset( $module['name'] ) ) {
2687
				$modules[ $index ]['name'] = $i18n_module['name'];
2688
			}
2689
			if ( isset( $module['description'] ) ) {
2690
				$modules[ $index ]['description'] = $i18n_module['description'];
2691
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2692
			}
2693
		}
2694
		return $modules;
2695
	}
2696
2697
	/**
2698
	 * Get a list of activated modules as an array of module slugs.
2699
	 */
2700
	public static function get_active_modules() {
2701
		$active = Jetpack_Options::get_option( 'active_modules' );
2702
2703
		if ( ! is_array( $active ) ) {
2704
			$active = array();
2705
		}
2706
2707
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2708
			$active[] = 'vaultpress';
2709
		} else {
2710
			$active = array_diff( $active, array( 'vaultpress' ) );
2711
		}
2712
2713
		//If protect is active on the main site of a multisite, it should be active on all sites.
2714
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2715
			$active[] = 'protect';
2716
		}
2717
2718
		/**
2719
		 * Allow filtering of the active modules.
2720
		 *
2721
		 * Gives theme and plugin developers the power to alter the modules that
2722
		 * are activated on the fly.
2723
		 *
2724
		 * @since 5.8.0
2725
		 *
2726
		 * @param array $active Array of active module slugs.
2727
		 */
2728
		$active = apply_filters( 'jetpack_active_modules', $active );
2729
2730
		return array_unique( $active );
2731
	}
2732
2733
	/**
2734
	 * Check whether or not a Jetpack module is active.
2735
	 *
2736
	 * @param string $module The slug of a Jetpack module.
2737
	 * @return bool
2738
	 *
2739
	 * @static
2740
	 */
2741
	public static function is_module_active( $module ) {
2742
		return in_array( $module, self::get_active_modules() );
2743
	}
2744
2745
	public static function is_module( $module ) {
2746
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2747
	}
2748
2749
	/**
2750
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2751
	 *
2752
	 * @param bool $catch True to start catching, False to stop.
2753
	 *
2754
	 * @static
2755
	 */
2756
	public static function catch_errors( $catch ) {
2757
		static $display_errors, $error_reporting;
2758
2759
		if ( $catch ) {
2760
			$display_errors  = @ini_set( 'display_errors', 1 );
2761
			$error_reporting = @error_reporting( E_ALL );
2762
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2763
		} else {
2764
			@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...
2765
			@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...
2766
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2767
		}
2768
	}
2769
2770
	/**
2771
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2772
	 */
2773
	public static function catch_errors_on_shutdown() {
2774
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2775
	}
2776
2777
	/**
2778
	 * Rewrite any string to make paths easier to read.
2779
	 *
2780
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2781
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2782
	 *
2783
	 * @param $string
2784
	 * @return mixed
2785
	 */
2786
	public static function alias_directories( $string ) {
2787
		// ABSPATH has a trailing slash.
2788
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2789
		// WP_CONTENT_DIR does not have a trailing slash.
2790
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2791
2792
		return $string;
2793
	}
2794
2795
	public static function activate_default_modules(
2796
		$min_version = false,
2797
		$max_version = false,
2798
		$other_modules = array(),
2799
		$redirect = true,
2800
		$send_state_messages = true
2801
	) {
2802
		$jetpack = Jetpack::init();
2803
2804
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2805
		$modules = array_merge( $other_modules, $modules );
2806
2807
		// Look for standalone plugins and disable if active.
2808
2809
		$to_deactivate = array();
2810
		foreach ( $modules as $module ) {
2811
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2812
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2813
			}
2814
		}
2815
2816
		$deactivated = array();
2817
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2818
			list( $probable_file, $probable_title ) = $deactivate_me;
2819
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2820
				$deactivated[] = $module;
2821
			}
2822
		}
2823
2824
		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...
2825
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2826
2827
			$url = add_query_arg(
2828
				array(
2829
					'action'   => 'activate_default_modules',
2830
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2831
				),
2832
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2833
			);
2834
			wp_safe_redirect( $url );
2835
			exit;
2836
		}
2837
2838
		/**
2839
		 * Fires before default modules are activated.
2840
		 *
2841
		 * @since 1.9.0
2842
		 *
2843
		 * @param string $min_version Minimum version number required to use modules.
2844
		 * @param string $max_version Maximum version number required to use modules.
2845
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2846
		 */
2847
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2848
2849
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2850
		if ( $send_state_messages ) {
2851
			Jetpack::restate();
2852
			Jetpack::catch_errors( true );
2853
		}
2854
2855
		$active = Jetpack::get_active_modules();
2856
2857
		foreach ( $modules as $module ) {
2858
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2859
				$active[] = $module;
2860
				self::update_active_modules( $active );
2861
				continue;
2862
			}
2863
2864
			if ( $send_state_messages && in_array( $module, $active ) ) {
2865
				$module_info = Jetpack::get_module( $module );
2866 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2867
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2868
					if ( $active_state = Jetpack::state( $state ) ) {
2869
						$active_state = explode( ',', $active_state );
2870
					} else {
2871
						$active_state = array();
2872
					}
2873
					$active_state[] = $module;
2874
					Jetpack::state( $state, implode( ',', $active_state ) );
2875
				}
2876
				continue;
2877
			}
2878
2879
			$file = Jetpack::get_module_path( $module );
2880
			if ( ! file_exists( $file ) ) {
2881
				continue;
2882
			}
2883
2884
			// we'll override this later if the plugin can be included without fatal error
2885
			if ( $redirect ) {
2886
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2887
			}
2888
2889
			if ( $send_state_messages ) {
2890
				Jetpack::state( 'error', 'module_activation_failed' );
2891
				Jetpack::state( 'module', $module );
2892
			}
2893
2894
			ob_start();
2895
			require_once $file;
2896
2897
			$active[] = $module;
2898
2899 View Code Duplication
			if ( $send_state_messages ) {
2900
2901
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2902
				if ( $active_state = Jetpack::state( $state ) ) {
2903
					$active_state = explode( ',', $active_state );
2904
				} else {
2905
					$active_state = array();
2906
				}
2907
				$active_state[] = $module;
2908
				Jetpack::state( $state, implode( ',', $active_state ) );
2909
			}
2910
2911
			Jetpack::update_active_modules( $active );
2912
2913
			ob_end_clean();
2914
		}
2915
2916
		if ( $send_state_messages ) {
2917
			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...
2918
			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...
2919
		}
2920
2921
		Jetpack::catch_errors( false );
2922
		/**
2923
		 * Fires when default modules are activated.
2924
		 *
2925
		 * @since 1.9.0
2926
		 *
2927
		 * @param string $min_version Minimum version number required to use modules.
2928
		 * @param string $max_version Maximum version number required to use modules.
2929
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2930
		 */
2931
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2932
	}
2933
2934
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2935
		/**
2936
		 * Fires before a module is activated.
2937
		 *
2938
		 * @since 2.6.0
2939
		 *
2940
		 * @param string $module Module slug.
2941
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2942
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2943
		 */
2944
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2945
2946
		$jetpack = Jetpack::init();
2947
2948
		if ( ! strlen( $module ) )
2949
			return false;
2950
2951
		if ( ! Jetpack::is_module( $module ) )
2952
			return false;
2953
2954
		// If it's already active, then don't do it again
2955
		$active = Jetpack::get_active_modules();
2956
		foreach ( $active as $act ) {
2957
			if ( $act == $module )
2958
				return true;
2959
		}
2960
2961
		$module_data = Jetpack::get_module( $module );
2962
2963
		if ( ! Jetpack::is_active() ) {
2964
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2965
				return false;
2966
2967
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2968
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2969
				return false;
2970
		}
2971
2972
		// Check and see if the old plugin is active
2973
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2974
			// Deactivate the old plugin
2975
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2976
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2977
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2978
				Jetpack::state( 'deactivated_plugins', $module );
2979
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2980
				exit;
2981
			}
2982
		}
2983
2984
		// Protect won't work with mis-configured IPs
2985
		if ( 'protect' === $module ) {
2986
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2987
			if ( ! jetpack_protect_get_ip() ) {
2988
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2989
				return false;
2990
			}
2991
		}
2992
2993
		if ( ! Jetpack::active_plan_supports( $module ) ) {
2994
			return false;
2995
		}
2996
2997
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2998
		Jetpack::state( 'module', $module );
2999
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3000
3001
		Jetpack::catch_errors( true );
3002
		ob_start();
3003
		require Jetpack::get_module_path( $module );
3004
		/** This action is documented in class.jetpack.php */
3005
		do_action( 'jetpack_activate_module', $module );
3006
		$active[] = $module;
3007
		Jetpack::update_active_modules( $active );
3008
3009
		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...
3010
		ob_end_clean();
3011
		Jetpack::catch_errors( false );
3012
3013
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
3014 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
3015
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3016
3017
			//Jump start is being dismissed send data to MC Stats
3018
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
3019
3020
			$jetpack->do_stats( 'server_side' );
3021
		}
3022
3023
		if ( $redirect ) {
3024
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3025
		}
3026
		if ( $exit ) {
3027
			exit;
3028
		}
3029
		return true;
3030
	}
3031
3032
	function activate_module_actions( $module ) {
3033
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3034
	}
3035
3036
	public static function deactivate_module( $module ) {
3037
		/**
3038
		 * Fires when a module is deactivated.
3039
		 *
3040
		 * @since 1.9.0
3041
		 *
3042
		 * @param string $module Module slug.
3043
		 */
3044
		do_action( 'jetpack_pre_deactivate_module', $module );
3045
3046
		$jetpack = Jetpack::init();
3047
3048
		$active = Jetpack::get_active_modules();
3049
		$new    = array_filter( array_diff( $active, (array) $module ) );
3050
3051
		// A flag for Jump Start so it's not shown again.
3052 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
3053
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3054
3055
			//Jump start is being dismissed send data to MC Stats
3056
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
3057
3058
			$jetpack->do_stats( 'server_side' );
3059
		}
3060
3061
		return self::update_active_modules( $new );
3062
	}
3063
3064
	public static function enable_module_configurable( $module ) {
3065
		$module = Jetpack::get_module_slug( $module );
3066
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3067
	}
3068
3069
	public static function module_configuration_url( $module ) {
3070
		$module = Jetpack::get_module_slug( $module );
3071
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
3072
	}
3073
3074
	public static function module_configuration_load( $module, $method ) {
3075
		$module = Jetpack::get_module_slug( $module );
3076
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
3077
	}
3078
3079
	public static function module_configuration_head( $module, $method ) {
3080
		$module = Jetpack::get_module_slug( $module );
3081
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
3082
	}
3083
3084
	public static function module_configuration_screen( $module, $method ) {
3085
		$module = Jetpack::get_module_slug( $module );
3086
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
3087
	}
3088
3089
	public static function module_configuration_activation_screen( $module, $method ) {
3090
		$module = Jetpack::get_module_slug( $module );
3091
		add_action( 'display_activate_module_setting_' . $module, $method );
3092
	}
3093
3094
/* Installation */
3095
3096
	public static function bail_on_activation( $message, $deactivate = true ) {
3097
?>
3098
<!doctype html>
3099
<html>
3100
<head>
3101
<meta charset="<?php bloginfo( 'charset' ); ?>">
3102
<style>
3103
* {
3104
	text-align: center;
3105
	margin: 0;
3106
	padding: 0;
3107
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3108
}
3109
p {
3110
	margin-top: 1em;
3111
	font-size: 18px;
3112
}
3113
</style>
3114
<body>
3115
<p><?php echo esc_html( $message ); ?></p>
3116
</body>
3117
</html>
3118
<?php
3119
		if ( $deactivate ) {
3120
			$plugins = get_option( 'active_plugins' );
3121
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3122
			$update  = false;
3123
			foreach ( $plugins as $i => $plugin ) {
3124
				if ( $plugin === $jetpack ) {
3125
					$plugins[$i] = false;
3126
					$update = true;
3127
				}
3128
			}
3129
3130
			if ( $update ) {
3131
				update_option( 'active_plugins', array_filter( $plugins ) );
3132
			}
3133
		}
3134
		exit;
3135
	}
3136
3137
	/**
3138
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3139
	 * @static
3140
	 */
3141
	public static function plugin_activation( $network_wide ) {
3142
		Jetpack_Options::update_option( 'activated', 1 );
3143
3144
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3145
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3146
		}
3147
3148
		if ( $network_wide )
3149
			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...
3150
3151
		// For firing one-off events (notices) immediately after activation
3152
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3153
3154
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3155
3156
		Jetpack::plugin_initialize();
3157
	}
3158
3159
	public static function get_activation_source( $referer_url ) {
3160
3161
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3162
			return array( 'wp-cli', null );
3163
		}
3164
3165
		$referer = parse_url( $referer_url );
3166
3167
		$source_type = 'unknown';
3168
		$source_query = null;
3169
3170
		if ( ! is_array( $referer ) ) {
3171
			return array( $source_type, $source_query );
3172
		}
3173
3174
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3175
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3176
3177
		if ( isset( $referer['query'] ) ) {
3178
			parse_str( $referer['query'], $query_parts );
3179
		} else {
3180
			$query_parts = array();
3181
		}
3182
3183
		if ( $plugins_path === $referer['path'] ) {
3184
			$source_type = 'list';
3185
		} elseif ( $plugins_install_path === $referer['path'] ) {
3186
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3187
			switch( $tab ) {
3188
				case 'popular':
3189
					$source_type = 'popular';
3190
					break;
3191
				case 'recommended':
3192
					$source_type = 'recommended';
3193
					break;
3194
				case 'favorites':
3195
					$source_type = 'favorites';
3196
					break;
3197
				case 'search':
3198
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3199
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3200
					break;
3201
				default:
3202
					$source_type = 'featured';
3203
			}
3204
		}
3205
3206
		return array( $source_type, $source_query );
3207
	}
3208
3209
	/**
3210
	 * Runs before bumping version numbers up to a new version
3211
	 * @param  string $version    Version:timestamp
3212
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3213
	 * @return null              [description]
3214
	 */
3215
	public static function do_version_bump( $version, $old_version ) {
3216
3217
		if ( ! $old_version ) { // For new sites
3218
			// Setting up jetpack manage
3219
			Jetpack::activate_manage();
3220
		}
3221
	}
3222
3223
	/**
3224
	 * Sets the internal version number and activation state.
3225
	 * @static
3226
	 */
3227
	public static function plugin_initialize() {
3228
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3229
			Jetpack_Options::update_option( 'activated', 2 );
3230
		}
3231
3232 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3233
			$version = $old_version = JETPACK__VERSION . ':' . time();
3234
			/** This action is documented in class.jetpack.php */
3235
			do_action( 'updating_jetpack_version', $version, false );
3236
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3237
		}
3238
3239
		Jetpack::load_modules();
3240
3241
		Jetpack_Options::delete_option( 'do_activate' );
3242
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3243
	}
3244
3245
	/**
3246
	 * Removes all connection options
3247
	 * @static
3248
	 */
3249
	public static function plugin_deactivation( ) {
3250
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3251
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3252
			Jetpack_Network::init()->deactivate();
3253
		} else {
3254
			Jetpack::disconnect( false );
3255
			//Jetpack_Heartbeat::init()->deactivate();
3256
		}
3257
	}
3258
3259
	/**
3260
	 * Disconnects from the Jetpack servers.
3261
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3262
	 * @static
3263
	 */
3264
	public static function disconnect( $update_activated_state = true ) {
3265
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3266
		Jetpack::clean_nonces( true );
3267
3268
		// If the site is in an IDC because sync is not allowed,
3269
		// let's make sure to not disconnect the production site.
3270
		if ( ! self::validate_sync_error_idc_option() ) {
3271
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3272
			Jetpack::load_xml_rpc_client();
3273
			$xml = new Jetpack_IXR_Client();
3274
			$xml->query( 'jetpack.deregister' );
3275
		}
3276
3277
		Jetpack_Options::delete_option(
3278
			array(
3279
				'blog_token',
3280
				'user_token',
3281
				'user_tokens',
3282
				'master_user',
3283
				'time_diff',
3284
				'fallback_no_verify_ssl_certs',
3285
			)
3286
		);
3287
3288
		Jetpack_IDC::clear_all_idc_options();
3289
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3290
3291
		if ( $update_activated_state ) {
3292
			Jetpack_Options::update_option( 'activated', 4 );
3293
		}
3294
3295
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3296
			// Check then record unique disconnection if site has never been disconnected previously
3297
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3298
				$jetpack_unique_connection['disconnected'] = 1;
3299
			} else {
3300
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3301
					//track unique disconnect
3302
					$jetpack = Jetpack::init();
3303
3304
					$jetpack->stat( 'connections', 'unique-disconnect' );
3305
					$jetpack->do_stats( 'server_side' );
3306
				}
3307
				// increment number of times disconnected
3308
				$jetpack_unique_connection['disconnected'] += 1;
3309
			}
3310
3311
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3312
		}
3313
3314
		// Delete cached connected user data
3315
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3316
		delete_transient( $transient_key );
3317
3318
		// Delete all the sync related data. Since it could be taking up space.
3319
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3320
		Jetpack_Sync_Sender::get_instance()->uninstall();
3321
3322
		// Disable the Heartbeat cron
3323
		Jetpack_Heartbeat::init()->deactivate();
3324
	}
3325
3326
	/**
3327
	 * Unlinks the current user from the linked WordPress.com user
3328
	 */
3329
	public static function unlink_user( $user_id = null ) {
3330
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3331
			return false;
3332
3333
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3334
3335
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3336
			return false;
3337
3338
		if ( ! isset( $tokens[ $user_id ] ) )
3339
			return false;
3340
3341
		Jetpack::load_xml_rpc_client();
3342
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3343
		$xml->query( 'jetpack.unlink_user', $user_id );
3344
3345
		unset( $tokens[ $user_id ] );
3346
3347
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3348
3349
		/**
3350
		 * Fires after the current user has been unlinked from WordPress.com.
3351
		 *
3352
		 * @since 4.1.0
3353
		 *
3354
		 * @param int $user_id The current user's ID.
3355
		 */
3356
		do_action( 'jetpack_unlinked_user', $user_id );
3357
3358
		return true;
3359
	}
3360
3361
	/**
3362
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3363
	 */
3364
	public static function try_registration() {
3365
		// The user has agreed to the TOS at some point by now.
3366
		Jetpack_Options::update_option( 'tos_agreed', true );
3367
3368
		// Let's get some testing in beta versions and such.
3369
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3370
			// Before attempting to connect, let's make sure that the domains are viable.
3371
			$domains_to_check = array_unique( array(
3372
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3373
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3374
			) );
3375
			foreach ( $domains_to_check as $domain ) {
3376
				$result = Jetpack_Data::is_usable_domain( $domain );
3377
				if ( is_wp_error( $result ) ) {
3378
					return $result;
3379
				}
3380
			}
3381
		}
3382
3383
		$result = Jetpack::register();
3384
3385
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3386
		if ( ! $result || is_wp_error( $result ) ) {
3387
			return $result;
3388
		} else {
3389
			return true;
3390
		}
3391
	}
3392
3393
	/**
3394
	 * Tracking an internal event log. Try not to put too much chaff in here.
3395
	 *
3396
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3397
	 */
3398
	public static function log( $code, $data = null ) {
3399
		// only grab the latest 200 entries
3400
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3401
3402
		// Append our event to the log
3403
		$log_entry = array(
3404
			'time'    => time(),
3405
			'user_id' => get_current_user_id(),
3406
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3407
			'code'    => $code,
3408
		);
3409
		// Don't bother storing it unless we've got some.
3410
		if ( ! is_null( $data ) ) {
3411
			$log_entry['data'] = $data;
3412
		}
3413
		$log[] = $log_entry;
3414
3415
		// Try add_option first, to make sure it's not autoloaded.
3416
		// @todo: Add an add_option method to Jetpack_Options
3417
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3418
			Jetpack_Options::update_option( 'log', $log );
3419
		}
3420
3421
		/**
3422
		 * Fires when Jetpack logs an internal event.
3423
		 *
3424
		 * @since 3.0.0
3425
		 *
3426
		 * @param array $log_entry {
3427
		 *	Array of details about the log entry.
3428
		 *
3429
		 *	@param string time Time of the event.
3430
		 *	@param int user_id ID of the user who trigerred the event.
3431
		 *	@param int blog_id Jetpack Blog ID.
3432
		 *	@param string code Unique name for the event.
3433
		 *	@param string data Data about the event.
3434
		 * }
3435
		 */
3436
		do_action( 'jetpack_log_entry', $log_entry );
3437
	}
3438
3439
	/**
3440
	 * Get the internal event log.
3441
	 *
3442
	 * @param $event (string) - only return the specific log events
3443
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3444
	 *
3445
	 * @return array of log events || WP_Error for invalid params
3446
	 */
3447
	public static function get_log( $event = false, $num = false ) {
3448
		if ( $event && ! is_string( $event ) ) {
3449
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3450
		}
3451
3452
		if ( $num && ! is_numeric( $num ) ) {
3453
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3454
		}
3455
3456
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3457
3458
		// If nothing set - act as it did before, otherwise let's start customizing the output
3459
		if ( ! $num && ! $event ) {
3460
			return $entire_log;
3461
		} else {
3462
			$entire_log = array_reverse( $entire_log );
3463
		}
3464
3465
		$custom_log_output = array();
3466
3467
		if ( $event ) {
3468
			foreach ( $entire_log as $log_event ) {
3469
				if ( $event == $log_event[ 'code' ] ) {
3470
					$custom_log_output[] = $log_event;
3471
				}
3472
			}
3473
		} else {
3474
			$custom_log_output = $entire_log;
3475
		}
3476
3477
		if ( $num ) {
3478
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3479
		}
3480
3481
		return $custom_log_output;
3482
	}
3483
3484
	/**
3485
	 * Log modification of important settings.
3486
	 */
3487
	public static function log_settings_change( $option, $old_value, $value ) {
3488
		switch( $option ) {
3489
			case 'jetpack_sync_non_public_post_stati':
3490
				self::log( $option, $value );
3491
				break;
3492
		}
3493
	}
3494
3495
	/**
3496
	 * Return stat data for WPCOM sync
3497
	 */
3498
	public static function get_stat_data( $encode = true, $extended = true ) {
3499
		$data = Jetpack_Heartbeat::generate_stats_array();
3500
3501
		if ( $extended ) {
3502
			$additional_data = self::get_additional_stat_data();
3503
			$data = array_merge( $data, $additional_data );
3504
		}
3505
3506
		if ( $encode ) {
3507
			return json_encode( $data );
3508
		}
3509
3510
		return $data;
3511
	}
3512
3513
	/**
3514
	 * Get additional stat data to sync to WPCOM
3515
	 */
3516
	public static function get_additional_stat_data( $prefix = '' ) {
3517
		$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...
3518
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3519
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3520
		$return["{$prefix}site-count"]     = 0;
3521
3522
		if ( function_exists( 'get_blog_count' ) ) {
3523
			$return["{$prefix}site-count"] = get_blog_count();
3524
		}
3525
		return $return;
3526
	}
3527
3528
	private static function get_site_user_count() {
3529
		global $wpdb;
3530
3531
		if ( function_exists( 'wp_is_large_network' ) ) {
3532
			if ( wp_is_large_network( 'users' ) ) {
3533
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3534
			}
3535
		}
3536 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3537
			// It wasn't there, so regenerate the data and save the transient
3538
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3539
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3540
		}
3541
		return $user_count;
3542
	}
3543
3544
	/* Admin Pages */
3545
3546
	function admin_init() {
3547
		// If the plugin is not connected, display a connect message.
3548
		if (
3549
			// the plugin was auto-activated and needs its candy
3550
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3551
		||
3552
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3553
			! Jetpack_Options::get_option( 'activated' )
3554
		) {
3555
			Jetpack::plugin_initialize();
3556
		}
3557
3558
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3559
			Jetpack_Connection_Banner::init();
3560
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3561
			// Upgrade: 1.1 -> 1.1.1
3562
			// Check and see if host can verify the Jetpack servers' SSL certificate
3563
			$args = array();
3564
			Jetpack_Client::_wp_remote_request(
3565
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3566
				$args,
3567
				true
3568
			);
3569
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3570
			// Show the notice on the Dashboard only for now
3571
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3572
		}
3573
3574
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3575
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3576
		}
3577
3578
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3579
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3580
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3581
3582
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3583
			// Artificially throw errors in certain whitelisted cases during plugin activation
3584
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3585
		}
3586
3587
		// Jetpack Manage Activation Screen from .com
3588
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3589
3590
		// Add custom column in wp-admin/users.php to show whether user is linked.
3591
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3592
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3593
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3594
	}
3595
3596
	function admin_body_class( $admin_body_class = '' ) {
3597
		$classes = explode( ' ', trim( $admin_body_class ) );
3598
3599
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3600
3601
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3602
		return " $admin_body_class ";
3603
	}
3604
3605
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3606
		return $admin_body_class . ' jetpack-pagestyles ';
3607
	}
3608
3609
	/**
3610
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3611
	 *
3612
	 * @return null
3613
	 */
3614
	function prepare_manage_jetpack_notice() {
3615
3616
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3617
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3618
	}
3619
3620
	function manage_activate_screen() {
3621
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3622
	}
3623
	/**
3624
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3625
	 * This function artificially throws errors for such cases (whitelisted).
3626
	 *
3627
	 * @param string $plugin The activated plugin.
3628
	 */
3629
	function throw_error_on_activate_plugin( $plugin ) {
3630
		$active_modules = Jetpack::get_active_modules();
3631
3632
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3633
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3634
			$throw = false;
3635
3636
			// Try and make sure it really was the stats plugin
3637
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3638
				if ( 'stats.php' == basename( $plugin ) ) {
3639
					$throw = true;
3640
				}
3641
			} else {
3642
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3643
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3644
					$throw = true;
3645
				}
3646
			}
3647
3648
			if ( $throw ) {
3649
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3650
			}
3651
		}
3652
	}
3653
3654
	function intercept_plugin_error_scrape_init() {
3655
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3656
	}
3657
3658
	function intercept_plugin_error_scrape( $action, $result ) {
3659
		if ( ! $result ) {
3660
			return;
3661
		}
3662
3663
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3664
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3665
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3666
			}
3667
		}
3668
	}
3669
3670
	function add_remote_request_handlers() {
3671
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3672
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3673
	}
3674
3675
	function remote_request_handlers() {
3676
		$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...
3677
3678
		switch ( current_filter() ) {
3679
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3680
			$response = $this->upload_handler();
3681
			break;
3682
3683
		case 'wp_ajax_nopriv_jetpack_update_file' :
3684
			$response = $this->upload_handler( true );
3685
			break;
3686
		default :
3687
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3688
			break;
3689
		}
3690
3691
		if ( ! $response ) {
3692
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3693
		}
3694
3695
		if ( is_wp_error( $response ) ) {
3696
			$status_code       = $response->get_error_data();
3697
			$error             = $response->get_error_code();
3698
			$error_description = $response->get_error_message();
3699
3700
			if ( ! is_int( $status_code ) ) {
3701
				$status_code = 400;
3702
			}
3703
3704
			status_header( $status_code );
3705
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3706
		}
3707
3708
		status_header( 200 );
3709
		if ( true === $response ) {
3710
			exit;
3711
		}
3712
3713
		die( json_encode( (object) $response ) );
3714
	}
3715
3716
	/**
3717
	 * Uploads a file gotten from the global $_FILES.
3718
	 * If `$update_media_item` is true and `post_id` is defined
3719
	 * the attachment file of the media item (gotten through of the post_id)
3720
	 * will be updated instead of add a new one.
3721
	 *
3722
	 * @param  boolean $update_media_item - update media attachment
3723
	 * @return array - An array describing the uploadind files process
3724
	 */
3725
	function upload_handler( $update_media_item = false ) {
3726
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3727
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3728
		}
3729
3730
		$user = wp_authenticate( '', '' );
3731
		if ( ! $user || is_wp_error( $user ) ) {
3732
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3733
		}
3734
3735
		wp_set_current_user( $user->ID );
3736
3737
		if ( ! current_user_can( 'upload_files' ) ) {
3738
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3739
		}
3740
3741
		if ( empty( $_FILES ) ) {
3742
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3743
		}
3744
3745
		foreach ( array_keys( $_FILES ) as $files_key ) {
3746
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3747
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3748
			}
3749
		}
3750
3751
		$media_keys = array_keys( $_FILES['media'] );
3752
3753
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3754
		if ( ! $token || is_wp_error( $token ) ) {
3755
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3756
		}
3757
3758
		$uploaded_files = array();
3759
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3760
		unset( $GLOBALS['post'] );
3761
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3762
			$file = array();
3763
			foreach ( $media_keys as $media_key ) {
3764
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3765
			}
3766
3767
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3768
3769
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3770
			if ( $hmac_provided !== $hmac_file ) {
3771
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3772
				continue;
3773
			}
3774
3775
			$_FILES['.jetpack.upload.'] = $file;
3776
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3777
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3778
				$post_id = 0;
3779
			}
3780
3781
			if ( $update_media_item ) {
3782
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3783
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3784
				}
3785
3786
				$media_array = $_FILES['media'];
3787
3788
				$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...
3789
				$file_array['type'] = $media_array['type'][0];
3790
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3791
				$file_array['error'] = $media_array['error'][0];
3792
				$file_array['size'] = $media_array['size'][0];
3793
3794
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3795
3796
				if ( is_wp_error( $edited_media_item ) ) {
3797
					return $edited_media_item;
3798
				}
3799
3800
				$response = (object) array(
3801
					'id'   => (string) $post_id,
3802
					'file' => (string) $edited_media_item->post_title,
3803
					'url'  => (string) wp_get_attachment_url( $post_id ),
3804
					'type' => (string) $edited_media_item->post_mime_type,
3805
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3806
				);
3807
3808
				return (array) array( $response );
3809
			}
3810
3811
			$attachment_id = media_handle_upload(
3812
				'.jetpack.upload.',
3813
				$post_id,
3814
				array(),
3815
				array(
3816
					'action' => 'jetpack_upload_file',
3817
				)
3818
			);
3819
3820
			if ( ! $attachment_id ) {
3821
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3822
			} elseif ( is_wp_error( $attachment_id ) ) {
3823
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3824
			} else {
3825
				$attachment = get_post( $attachment_id );
3826
				$uploaded_files[$index] = (object) array(
3827
					'id'   => (string) $attachment_id,
3828
					'file' => $attachment->post_title,
3829
					'url'  => wp_get_attachment_url( $attachment_id ),
3830
					'type' => $attachment->post_mime_type,
3831
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3832
				);
3833
				// Zip files uploads are not supported unless they are done for installation purposed
3834
				// lets delete them in case something goes wrong in this whole process
3835
				if ( 'application/zip' === $attachment->post_mime_type ) {
3836
					// Schedule a cleanup for 2 hours from now in case of failed install.
3837
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3838
				}
3839
			}
3840
		}
3841
		if ( ! is_null( $global_post ) ) {
3842
			$GLOBALS['post'] = $global_post;
3843
		}
3844
3845
		return $uploaded_files;
3846
	}
3847
3848
	/**
3849
	 * Add help to the Jetpack page
3850
	 *
3851
	 * @since Jetpack (1.2.3)
3852
	 * @return false if not the Jetpack page
3853
	 */
3854
	function admin_help() {
3855
		$current_screen = get_current_screen();
3856
3857
		// Overview
3858
		$current_screen->add_help_tab(
3859
			array(
3860
				'id'		=> 'home',
3861
				'title'		=> __( 'Home', 'jetpack' ),
3862
				'content'	=>
3863
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3864
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3865
					'<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>',
3866
			)
3867
		);
3868
3869
		// Screen Content
3870
		if ( current_user_can( 'manage_options' ) ) {
3871
			$current_screen->add_help_tab(
3872
				array(
3873
					'id'		=> 'settings',
3874
					'title'		=> __( 'Settings', 'jetpack' ),
3875
					'content'	=>
3876
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3877
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3878
						'<ol>' .
3879
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3880
							'<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>' .
3881
						'</ol>' .
3882
						'<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>'
3883
				)
3884
			);
3885
		}
3886
3887
		// Help Sidebar
3888
		$current_screen->set_help_sidebar(
3889
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3890
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3891
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3892
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3893
		);
3894
	}
3895
3896
	function admin_menu_css() {
3897
		wp_enqueue_style( 'jetpack-icons' );
3898
	}
3899
3900
	function admin_menu_order() {
3901
		return true;
3902
	}
3903
3904 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3905
		$jp_menu_order = array();
3906
3907
		foreach ( $menu_order as $index => $item ) {
3908
			if ( $item != 'jetpack' ) {
3909
				$jp_menu_order[] = $item;
3910
			}
3911
3912
			if ( $index == 0 ) {
3913
				$jp_menu_order[] = 'jetpack';
3914
			}
3915
		}
3916
3917
		return $jp_menu_order;
3918
	}
3919
3920
	function admin_head() {
3921 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3922
			/** This action is documented in class.jetpack-admin-page.php */
3923
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3924
	}
3925
3926
	function admin_banner_styles() {
3927
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3928
3929
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3930
			wp_register_style(
3931
				'jetpack-dops-style',
3932
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3933
				array(),
3934
				JETPACK__VERSION
3935
			);
3936
		}
3937
3938
		wp_enqueue_style(
3939
			'jetpack',
3940
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3941
			array( 'jetpack-dops-style' ),
3942
			 JETPACK__VERSION . '-20121016'
3943
		);
3944
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3945
		wp_style_add_data( 'jetpack', 'suffix', $min );
3946
	}
3947
3948
	function plugin_action_links( $actions ) {
3949
3950
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3951
3952
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3953
			return array_merge(
3954
				$jetpack_home,
3955
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3956
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3957
				$actions
3958
				);
3959
			}
3960
3961
		return array_merge( $jetpack_home, $actions );
3962
	}
3963
3964
	/**
3965
	 * This is the first banner
3966
	 * It should be visible only to user that can update the option
3967
	 * Are not connected
3968
	 *
3969
	 * @return null
3970
	 */
3971
	function admin_jetpack_manage_notice() {
3972
		$screen = get_current_screen();
3973
3974
		// Don't show the connect notice on the jetpack settings page.
3975
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3976
			return;
3977
		}
3978
3979
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3980
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3981
		/**
3982
		 * I think it would be great to have different wordsing depending on where you are
3983
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3984
		 * etc..
3985
		 */
3986
3987
		?>
3988
		<div id="message" class="updated jp-banner">
3989
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3990
				<div class="jp-banner__description-container">
3991
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3992
					<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>
3993
					<p class="jp-banner__button-container">
3994
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3995
						<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>
3996
					</p>
3997
				</div>
3998
		</div>
3999
		<?php
4000
	}
4001
4002
	/**
4003
	 * Returns the url that the user clicks to remove the notice for the big banner
4004
	 * @return string
4005
	 */
4006
	function opt_out_jetpack_manage_url() {
4007
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
4008
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
4009
	}
4010
	/**
4011
	 * Returns the url that the user clicks to opt in to Jetpack Manage
4012
	 * @return string
4013
	 */
4014
	function opt_in_jetpack_manage_url() {
4015
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
4016
	}
4017
4018
	function opt_in_jetpack_manage_notice() {
4019
		?>
4020
		<div class="wrap">
4021
			<div id="message" class="jetpack-message is-opt-in">
4022
				<?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' ); ?>
4023
			</div>
4024
		</div>
4025
		<?php
4026
4027
	}
4028
	/**
4029
	 * Determines whether to show the notice of not true = display notice
4030
	 * @return bool
4031
	 */
4032
	function can_display_jetpack_manage_notice() {
4033
		// never display the notice to users that can't do anything about it anyways
4034
		if( ! current_user_can( 'jetpack_manage_modules' ) )
4035
			return false;
4036
4037
		// don't display if we are in development more
4038
		if( Jetpack::is_development_mode() ) {
4039
			return false;
4040
		}
4041
		// don't display if the site is private
4042
		if(  ! Jetpack_Options::get_option( 'public' ) )
4043
			return false;
4044
4045
		/**
4046
		 * Should the Jetpack Remote Site Management notice be displayed.
4047
		 *
4048
		 * @since 3.3.0
4049
		 *
4050
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
4051
		 */
4052
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
4053
	}
4054
4055
	/*
4056
	 * Registration flow:
4057
	 * 1 - ::admin_page_load() action=register
4058
	 * 2 - ::try_registration()
4059
	 * 3 - ::register()
4060
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4061
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4062
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4063
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4064
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4065
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4066
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4067
	 *       jetpack_id, jetpack_secret, jetpack_public
4068
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4069
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4070
	 * 5 - user logs in with WP.com account
4071
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4072
	 *		- Jetpack_Client_Server::authorize()
4073
	 *		- Jetpack_Client_Server::get_token()
4074
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4075
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4076
	 *			- which responds with access_token, token_type, scope
4077
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
4078
	 *		- Jetpack::activate_default_modules()
4079
	 *     		- Deactivates deprecated plugins
4080
	 *     		- Activates all default modules
4081
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4082
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4083
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4084
	 *     Done!
4085
	 */
4086
4087
	/**
4088
	 * Handles the page load events for the Jetpack admin page
4089
	 */
4090
	function admin_page_load() {
4091
		$error = false;
4092
4093
		// Make sure we have the right body class to hook stylings for subpages off of.
4094
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
4095
4096
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4097
			// Should only be used in intermediate redirects to preserve state across redirects
4098
			Jetpack::restate();
4099
		}
4100
4101
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4102
			// User clicked in the iframe to link their accounts
4103
			if ( ! Jetpack::is_user_connected() ) {
4104
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4105
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4106
4107
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4108
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4109
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4110
4111
				if ( isset( $_GET['notes_iframe'] ) )
4112
					$connect_url .= '&notes_iframe';
4113
				wp_redirect( $connect_url );
4114
				exit;
4115
			} else {
4116
				if ( ! isset( $_GET['calypso_env'] ) ) {
4117
					Jetpack::state( 'message', 'already_authorized' );
4118
					wp_safe_redirect( Jetpack::admin_url() );
4119
					exit;
4120
				} else {
4121
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4122
					$connect_url .= '&already_authorized=true';
4123
					wp_redirect( $connect_url );
4124
					exit;
4125
				}
4126
			}
4127
		}
4128
4129
4130
		if ( isset( $_GET['action'] ) ) {
4131
			switch ( $_GET['action'] ) {
4132
			case 'authorize':
4133
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4134
					Jetpack::state( 'message', 'already_authorized' );
4135
					wp_safe_redirect( Jetpack::admin_url() );
4136
					exit;
4137
				}
4138
				Jetpack::log( 'authorize' );
4139
				$client_server = new Jetpack_Client_Server;
4140
				$client_server->client_authorize();
4141
				exit;
4142
			case 'register' :
4143
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4144
					$error = 'cheatin';
4145
					break;
4146
				}
4147
				check_admin_referer( 'jetpack-register' );
4148
				Jetpack::log( 'register' );
4149
				Jetpack::maybe_set_version_option();
4150
				$registered = Jetpack::try_registration();
4151
				if ( is_wp_error( $registered ) ) {
4152
					$error = $registered->get_error_code();
4153
					Jetpack::state( 'error', $error );
4154
					Jetpack::state( 'error', $registered->get_error_message() );
4155
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4156
						'error_code' => $error,
4157
						'error_message' => $registered->get_error_message()
4158
					) );
4159
					break;
4160
				}
4161
4162
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4163
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4164
4165
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4166
					'from' => $from
4167
				) );
4168
4169
				$url = $this->build_connect_url( true, $redirect, $from );
4170
4171
				if ( ! empty( $_GET['onboarding'] ) ) {
4172
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4173
				}
4174
4175
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4176
					$url = add_query_arg( 'auth_approved', 'true', $url );
4177
				}
4178
4179
				wp_redirect( $url );
4180
				exit;
4181
			case 'activate' :
4182
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4183
					$error = 'cheatin';
4184
					break;
4185
				}
4186
4187
				$module = stripslashes( $_GET['module'] );
4188
				check_admin_referer( "jetpack_activate-$module" );
4189
				Jetpack::log( 'activate', $module );
4190
				if ( ! Jetpack::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Jetpack::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4191
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4192
				}
4193
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4194
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4195
				exit;
4196
			case 'activate_default_modules' :
4197
				check_admin_referer( 'activate_default_modules' );
4198
				Jetpack::log( 'activate_default_modules' );
4199
				Jetpack::restate();
4200
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4201
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4202
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4203
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4204
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4205
				exit;
4206
			case 'disconnect' :
4207
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4208
					$error = 'cheatin';
4209
					break;
4210
				}
4211
4212
				check_admin_referer( 'jetpack-disconnect' );
4213
				Jetpack::log( 'disconnect' );
4214
				Jetpack::disconnect();
4215
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4216
				exit;
4217
			case 'reconnect' :
4218
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4219
					$error = 'cheatin';
4220
					break;
4221
				}
4222
4223
				check_admin_referer( 'jetpack-reconnect' );
4224
				Jetpack::log( 'reconnect' );
4225
				$this->disconnect();
4226
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4227
				exit;
4228 View Code Duplication
			case 'deactivate' :
4229
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4230
					$error = 'cheatin';
4231
					break;
4232
				}
4233
4234
				$modules = stripslashes( $_GET['module'] );
4235
				check_admin_referer( "jetpack_deactivate-$modules" );
4236
				foreach ( explode( ',', $modules ) as $module ) {
4237
					Jetpack::log( 'deactivate', $module );
4238
					Jetpack::deactivate_module( $module );
4239
					Jetpack::state( 'message', 'module_deactivated' );
4240
				}
4241
				Jetpack::state( 'module', $modules );
4242
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4243
				exit;
4244
			case 'unlink' :
4245
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4246
				check_admin_referer( 'jetpack-unlink' );
4247
				Jetpack::log( 'unlink' );
4248
				$this->unlink_user();
4249
				Jetpack::state( 'message', 'unlinked' );
4250
				if ( 'sub-unlink' == $redirect ) {
4251
					wp_safe_redirect( admin_url() );
4252
				} else {
4253
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4254
				}
4255
				exit;
4256
			case 'onboard' :
4257
				if ( ! current_user_can( 'manage_options' ) ) {
4258
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4259
				} else {
4260
					Jetpack::create_onboarding_token();
4261
					$url = $this->build_connect_url( true );
4262
4263
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4264
						$url = add_query_arg( 'onboarding', $token, $url );
4265
					}
4266
4267
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4268
					if ( $calypso_env ) {
4269
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4270
					}
4271
4272
					wp_redirect( $url );
4273
					exit;
4274
				}
4275
				exit;
4276
			default:
4277
				/**
4278
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4279
				 *
4280
				 * @since 2.6.0
4281
				 *
4282
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4283
				 */
4284
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4285
			}
4286
		}
4287
4288
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4289
			self::activate_new_modules( true );
4290
		}
4291
4292
		$message_code = Jetpack::state( 'message' );
4293
		if ( Jetpack::state( 'optin-manage' ) ) {
4294
			$activated_manage = $message_code;
4295
			$message_code = 'jetpack-manage';
4296
		}
4297
4298
		switch ( $message_code ) {
4299
		case 'jetpack-manage':
4300
			$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>';
4301
			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...
4302
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4303
			}
4304
			break;
4305
4306
		}
4307
4308
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4309
4310
		if ( ! empty( $deactivated_plugins ) ) {
4311
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4312
			$deactivated_titles  = array();
4313
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4314
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4315
					continue;
4316
				}
4317
4318
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4319
			}
4320
4321
			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...
4322
				if ( $this->message ) {
4323
					$this->message .= "<br /><br />\n";
4324
				}
4325
4326
				$this->message .= wp_sprintf(
4327
					_n(
4328
						'Jetpack contains the most recent version of the old %l plugin.',
4329
						'Jetpack contains the most recent versions of the old %l plugins.',
4330
						count( $deactivated_titles ),
4331
						'jetpack'
4332
					),
4333
					$deactivated_titles
4334
				);
4335
4336
				$this->message .= "<br />\n";
4337
4338
				$this->message .= _n(
4339
					'The old version has been deactivated and can be removed from your site.',
4340
					'The old versions have been deactivated and can be removed from your site.',
4341
					count( $deactivated_titles ),
4342
					'jetpack'
4343
				);
4344
			}
4345
		}
4346
4347
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4348
4349
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4350
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4351
		}
4352
4353 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4354
			/**
4355
			 * Fires when a module configuration page is loaded.
4356
			 * The dynamic part of the hook is the configure parameter from the URL.
4357
			 *
4358
			 * @since 1.1.0
4359
			 */
4360
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4361
		}
4362
4363
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4364
	}
4365
4366
	function admin_notices() {
4367
4368
		if ( $this->error ) {
4369
?>
4370
<div id="message" class="jetpack-message jetpack-err">
4371
	<div class="squeezer">
4372
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4373
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4374
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4375
<?php	endif; ?>
4376
	</div>
4377
</div>
4378
<?php
4379
		}
4380
4381
		if ( $this->message ) {
4382
?>
4383
<div id="message" class="jetpack-message">
4384
	<div class="squeezer">
4385
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4386
	</div>
4387
</div>
4388
<?php
4389
		}
4390
4391
		if ( $this->privacy_checks ) :
4392
			$module_names = $module_slugs = array();
4393
4394
			$privacy_checks = explode( ',', $this->privacy_checks );
4395
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4396
			foreach ( $privacy_checks as $module_slug ) {
4397
				$module = Jetpack::get_module( $module_slug );
4398
				if ( ! $module ) {
4399
					continue;
4400
				}
4401
4402
				$module_slugs[] = $module_slug;
4403
				$module_names[] = "<strong>{$module['name']}</strong>";
4404
			}
4405
4406
			$module_slugs = join( ',', $module_slugs );
4407
?>
4408
<div id="message" class="jetpack-message jetpack-err">
4409
	<div class="squeezer">
4410
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4411
		<p><?php
4412
			echo wp_kses(
4413
				wptexturize(
4414
					wp_sprintf(
4415
						_nx(
4416
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4417
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4418
							count( $privacy_checks ),
4419
							'%l = list of Jetpack module/feature names',
4420
							'jetpack'
4421
						),
4422
						$module_names
4423
					)
4424
				),
4425
				array( 'strong' => true )
4426
			);
4427
4428
			echo "\n<br />\n";
4429
4430
			echo wp_kses(
4431
				sprintf(
4432
					_nx(
4433
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4434
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4435
						count( $privacy_checks ),
4436
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4437
						'jetpack'
4438
					),
4439
					wp_nonce_url(
4440
						Jetpack::admin_url(
4441
							array(
4442
								'page'   => 'jetpack',
4443
								'action' => 'deactivate',
4444
								'module' => urlencode( $module_slugs ),
4445
							)
4446
						),
4447
						"jetpack_deactivate-$module_slugs"
4448
					),
4449
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4450
				),
4451
				array( 'a' => array( 'href' => true, 'title' => true ) )
4452
			);
4453
		?></p>
4454
	</div>
4455
</div>
4456
<?php endif;
4457
	// only display the notice if the other stuff is not there
4458
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4459
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4460
			$this->opt_in_jetpack_manage_notice();
4461
		}
4462
	}
4463
4464
	/**
4465
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4466
	 */
4467
	function stat( $group, $detail ) {
4468
		if ( ! isset( $this->stats[ $group ] ) )
4469
			$this->stats[ $group ] = array();
4470
		$this->stats[ $group ][] = $detail;
4471
	}
4472
4473
	/**
4474
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4475
	 */
4476
	function do_stats( $method = '' ) {
4477
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4478
			foreach ( $this->stats as $group => $stats ) {
4479
				if ( is_array( $stats ) && count( $stats ) ) {
4480
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4481
					if ( 'server_side' === $method ) {
4482
						self::do_server_side_stat( $args );
4483
					} else {
4484
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4485
					}
4486
				}
4487
				unset( $this->stats[ $group ] );
4488
			}
4489
		}
4490
	}
4491
4492
	/**
4493
	 * Runs stats code for a one-off, server-side.
4494
	 *
4495
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4496
	 *
4497
	 * @return bool If it worked.
4498
	 */
4499
	static function do_server_side_stat( $args ) {
4500
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4501
		if ( is_wp_error( $response ) )
4502
			return false;
4503
4504
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4505
			return false;
4506
4507
		return true;
4508
	}
4509
4510
	/**
4511
	 * Builds the stats url.
4512
	 *
4513
	 * @param $args array|string The arguments to append to the URL.
4514
	 *
4515
	 * @return string The URL to be pinged.
4516
	 */
4517
	static function build_stats_url( $args ) {
4518
		$defaults = array(
4519
			'v'    => 'wpcom2',
4520
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4521
		);
4522
		$args     = wp_parse_args( $args, $defaults );
4523
		/**
4524
		 * Filter the URL used as the Stats tracking pixel.
4525
		 *
4526
		 * @since 2.3.2
4527
		 *
4528
		 * @param string $url Base URL used as the Stats tracking pixel.
4529
		 */
4530
		$base_url = apply_filters(
4531
			'jetpack_stats_base_url',
4532
			'https://pixel.wp.com/g.gif'
4533
		);
4534
		$url      = add_query_arg( $args, $base_url );
4535
		return $url;
4536
	}
4537
4538
	static function translate_current_user_to_role() {
4539
		foreach ( self::$capability_translations as $role => $cap ) {
4540
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4541
				return $role;
4542
			}
4543
		}
4544
4545
		return false;
4546
	}
4547
4548
	static function translate_user_to_role( $user ) {
4549
		foreach ( self::$capability_translations as $role => $cap ) {
4550
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4551
				return $role;
4552
			}
4553
		}
4554
4555
		return false;
4556
    }
4557
4558
	static function translate_role_to_cap( $role ) {
4559
		if ( ! isset( self::$capability_translations[$role] ) ) {
4560
			return false;
4561
		}
4562
4563
		return self::$capability_translations[$role];
4564
	}
4565
4566
	static function sign_role( $role, $user_id = null ) {
4567
		if ( empty( $user_id ) ) {
4568
			$user_id = (int) get_current_user_id();
4569
		}
4570
4571
		if ( ! $user_id  ) {
4572
			return false;
4573
		}
4574
4575
		$token = Jetpack_Data::get_access_token();
4576
		if ( ! $token || is_wp_error( $token ) ) {
4577
			return false;
4578
		}
4579
4580
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4581
	}
4582
4583
4584
	/**
4585
	 * Builds a URL to the Jetpack connection auth page
4586
	 *
4587
	 * @since 3.9.5
4588
	 *
4589
	 * @param bool $raw If true, URL will not be escaped.
4590
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4591
	 *                              If string, will be a custom redirect.
4592
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4593
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4594
	 *
4595
	 * @return string Connect URL
4596
	 */
4597
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4598
		$site_id = Jetpack_Options::get_option( 'id' );
4599
		$token = Jetpack_Options::get_option( 'blog_token' );
4600
4601
		if ( $register || ! $token || ! $site_id ) {
4602
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4603
4604
			if ( ! empty( $redirect ) ) {
4605
				$url = add_query_arg(
4606
					'redirect',
4607
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4608
					$url
4609
				);
4610
			}
4611
4612
			if( is_network_admin() ) {
4613
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4614
			}
4615
		} else {
4616
4617
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4618
			// because otherwise this logic can get us in to a loop.
4619
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4620
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4621
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4622
4623
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4624
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4625
					'1.1'
4626
				);
4627
4628
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4629
					// Generating a register URL instead to refresh the existing token
4630
					return $this->build_connect_url( $raw, $redirect, $from, true );
4631
				}
4632
			}
4633
4634
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4635
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4636
			}
4637
4638
			$role = self::translate_current_user_to_role();
4639
			$signed_role = self::sign_role( $role );
4640
4641
			$user = wp_get_current_user();
4642
4643
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4644
			$redirect = $redirect
4645
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4646
				: $jetpack_admin_page;
4647
4648
			if( isset( $_REQUEST['is_multisite'] ) ) {
4649
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4650
			}
4651
4652
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4653
4654
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4655
				? get_site_icon_url()
4656
				: false;
4657
4658
			/**
4659
			 * Filter the type of authorization.
4660
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4661
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4662
			 *
4663
			 * @since 4.3.3
4664
			 *
4665
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4666
			 */
4667
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4668
4669
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4670
4671
			$args = urlencode_deep(
4672
				array(
4673
					'response_type' => 'code',
4674
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4675
					'redirect_uri'  => add_query_arg(
4676
						array(
4677
							'action'   => 'authorize',
4678
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4679
							'redirect' => urlencode( $redirect ),
4680
						),
4681
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4682
					),
4683
					'state'         => $user->ID,
4684
					'scope'         => $signed_role,
4685
					'user_email'    => $user->user_email,
4686
					'user_login'    => $user->user_login,
4687
					'is_active'     => Jetpack::is_active(),
4688
					'jp_version'    => JETPACK__VERSION,
4689
					'auth_type'     => $auth_type,
4690
					'secret'        => $secrets['secret_1'],
4691
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4692
					'blogname'      => get_option( 'blogname' ),
4693
					'site_url'      => site_url(),
4694
					'home_url'      => home_url(),
4695
					'site_icon'     => $site_icon,
4696
					'site_lang'     => get_locale(),
4697
					'_ui'           => $tracks_identity['_ui'],
4698
					'_ut'           => $tracks_identity['_ut']
4699
				)
4700
			);
4701
4702
			self::apply_activation_source_to_args( $args );
4703
4704
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4705
		}
4706
4707
		if ( $from ) {
4708
			$url = add_query_arg( 'from', $from, $url );
4709
		}
4710
4711
4712
		if ( isset( $_GET['calypso_env'] ) ) {
4713
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4714
		}
4715
4716
		return $raw ? $url : esc_url( $url );
4717
	}
4718
4719
	public static function apply_activation_source_to_args( &$args ) {
4720
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4721
4722
		if ( $activation_source_name ) {
4723
			$args['_as'] = urlencode( $activation_source_name );
4724
		}
4725
4726
		if ( $activation_source_keyword ) {
4727
			$args['_ak'] = urlencode( $activation_source_keyword );
4728
		}
4729
	}
4730
4731
	function build_reconnect_url( $raw = false ) {
4732
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4733
		return $raw ? $url : esc_url( $url );
4734
	}
4735
4736
	public static function admin_url( $args = null ) {
4737
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4738
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4739
		return $url;
4740
	}
4741
4742
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4743
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4744
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4745
	}
4746
4747
	function dismiss_jetpack_notice() {
4748
4749
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4750
			return;
4751
		}
4752
4753
		switch( $_GET['jetpack-notice'] ) {
4754
			case 'dismiss':
4755
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4756
4757
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4758
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4759
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4760
				}
4761
				break;
4762 View Code Duplication
			case 'jetpack-manage-opt-out':
4763
4764
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4765
					// Don't show the banner again
4766
4767
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4768
					// redirect back to the page that had the notice
4769
					if ( wp_get_referer() ) {
4770
						wp_safe_redirect( wp_get_referer() );
4771
					} else {
4772
						// Take me to Jetpack
4773
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4774
					}
4775
				}
4776
				break;
4777 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
4778
4779
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4780
					// Don't show the banner again
4781
4782
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4783
					// redirect back to the page that had the notice
4784
					if ( wp_get_referer() ) {
4785
						wp_safe_redirect( wp_get_referer() );
4786
					} else {
4787
						// Take me to Jetpack
4788
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4789
					}
4790
				}
4791
				break;
4792
			case 'jetpack-manage-opt-in':
4793
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4794
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4795
4796
					$redirection_url = Jetpack::admin_url();
4797
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4798
4799
					// Don't redirect form the Jetpack Setting Page
4800
					$referer_parsed = parse_url ( wp_get_referer() );
4801
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4802
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4803
						// Take the user to Jetpack home except when on the setting page
4804
						$redirection_url = wp_get_referer();
4805
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4806
					}
4807
					// Also update the JSON API FULL MANAGEMENT Option
4808
					Jetpack::activate_module( 'manage', false, false );
4809
4810
					// Special Message when option in.
4811
					Jetpack::state( 'optin-manage', 'true' );
4812
					// Activate the Module if not activated already
4813
4814
					// Redirect properly
4815
					wp_safe_redirect( $redirection_url );
4816
4817
				}
4818
				break;
4819
		}
4820
	}
4821
4822
	public static function admin_screen_configure_module( $module_id ) {
4823
4824
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4825
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4826
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4827
				/**
4828
				 * Fires to diplay a custom module activation screen.
4829
				 *
4830
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4831
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4832
				 *
4833
				 * @module manage
4834
				 *
4835
				 * @since 3.8.0
4836
				 *
4837
				 * @param int $module_id Module ID.
4838
				 */
4839
				do_action( 'display_activate_module_setting_' . $module_id );
4840
			} else {
4841
				self::display_activate_module_link( $module_id );
4842
			}
4843
4844
			return false;
4845
		} ?>
4846
4847
		<div id="jp-settings-screen" style="position: relative">
4848
			<h3>
4849
			<?php
4850
				$module = Jetpack::get_module( $module_id );
4851
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4852
			?>
4853
			</h3>
4854
			<?php
4855
				/**
4856
				 * Fires within the displayed message when a feature configuation is updated.
4857
				 *
4858
				 * @since 3.4.0
4859
				 *
4860
				 * @param int $module_id Module ID.
4861
				 */
4862
				do_action( 'jetpack_notices_update_settings', $module_id );
4863
				/**
4864
				 * Fires when a feature configuation screen is loaded.
4865
				 * The dynamic part of the hook, $module_id, is the module ID.
4866
				 *
4867
				 * @since 1.1.0
4868
				 */
4869
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4870
			?>
4871
		</div><?php
4872
	}
4873
4874
	/**
4875
	 * Display link to activate the module to see the settings screen.
4876
	 * @param  string $module_id
4877
	 * @return null
4878
	 */
4879
	public static function display_activate_module_link( $module_id ) {
4880
4881
		$info =  Jetpack::get_module( $module_id );
4882
		$extra = '';
4883
		$activate_url = wp_nonce_url(
4884
				Jetpack::admin_url(
4885
					array(
4886
						'page'   => 'jetpack',
4887
						'action' => 'activate',
4888
						'module' => $module_id,
4889
					)
4890
				),
4891
				"jetpack_activate-$module_id"
4892
			);
4893
4894
		?>
4895
4896
		<div class="wrap configure-module">
4897
			<div id="jp-settings-screen">
4898
				<?php
4899
				if ( $module_id == 'json-api' ) {
4900
4901
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4902
4903
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4904
4905
					$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' );
4906
4907
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4908
				} ?>
4909
4910
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4911
				<div class="narrow">
4912
					<p><?php echo  $info['description']; ?></p>
4913
					<?php if( $extra ) { ?>
4914
					<p><?php echo esc_html( $extra ); ?></p>
4915
					<?php } ?>
4916
					<p>
4917
						<?php
4918
						if( wp_get_referer() ) {
4919
							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() );
4920
						} else {
4921
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4922
						} ?>
4923
					</p>
4924
				</div>
4925
4926
			</div>
4927
		</div>
4928
4929
		<?php
4930
	}
4931
4932
	public static function sort_modules( $a, $b ) {
4933
		if ( $a['sort'] == $b['sort'] )
4934
			return 0;
4935
4936
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4937
	}
4938
4939
	function ajax_recheck_ssl() {
4940
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4941
		$result = Jetpack::permit_ssl( true );
4942
		wp_send_json( array(
4943
			'enabled' => $result,
4944
			'message' => get_transient( 'jetpack_https_test_message' )
4945
		) );
4946
	}
4947
4948
/* Client API */
4949
4950
	/**
4951
	 * Returns the requested Jetpack API URL
4952
	 *
4953
	 * @return string
4954
	 */
4955
	public static function api_url( $relative_url ) {
4956
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4957
	}
4958
4959
	/**
4960
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4961
	 */
4962
	public static function fix_url_for_bad_hosts( $url ) {
4963
		if ( 0 !== strpos( $url, 'https://' ) ) {
4964
			return $url;
4965
		}
4966
4967
		switch ( JETPACK_CLIENT__HTTPS ) {
4968
			case 'ALWAYS' :
4969
				return $url;
4970
			case 'NEVER' :
4971
				return set_url_scheme( $url, 'http' );
4972
			// default : case 'AUTO' :
4973
		}
4974
4975
		// we now return the unmodified SSL URL by default, as a security precaution
4976
		return $url;
4977
	}
4978
4979
	/**
4980
	 * Create a random secret for validating onboarding payload
4981
	 *
4982
	 * @return string Secret token
4983
	 */
4984
	public static function create_onboarding_token() {
4985
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4986
			$token = wp_generate_password( 32, false );
4987
			Jetpack_Options::update_option( 'onboarding', $token );
4988
		}
4989
4990
		return $token;
4991
	}
4992
4993
	/**
4994
	 * Remove the onboarding token
4995
	 *
4996
	 * @return bool True on success, false on failure
4997
	 */
4998
	public static function invalidate_onboarding_token() {
4999
		return Jetpack_Options::delete_option( 'onboarding' );
5000
	}
5001
5002
	/**
5003
	 * Validate an onboarding token for a specific action
5004
	 *
5005
	 * @return boolean True if token/action pair is accepted, false if not
5006
	 */
5007
	public static function validate_onboarding_token_action( $token, $action ) {
5008
		// Compare tokens, bail if tokens do not match
5009
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5010
			return false;
5011
		}
5012
5013
		// List of valid actions we can take
5014
		$valid_actions = array(
5015
			'/jetpack/v4/settings',
5016
		);
5017
5018
		// Whitelist the action
5019
		if ( ! in_array( $action, $valid_actions ) ) {
5020
			return false;
5021
		}
5022
5023
		return true;
5024
	}
5025
5026
	/**
5027
	 * Checks to see if the URL is using SSL to connect with Jetpack
5028
	 *
5029
	 * @since 2.3.3
5030
	 * @return boolean
5031
	 */
5032
	public static function permit_ssl( $force_recheck = false ) {
5033
		// Do some fancy tests to see if ssl is being supported
5034
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5035
			$message = '';
5036
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5037
				$ssl = 0;
5038
			} else {
5039
				switch ( JETPACK_CLIENT__HTTPS ) {
5040
					case 'NEVER':
5041
						$ssl = 0;
5042
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5043
						break;
5044
					case 'ALWAYS':
5045
					case 'AUTO':
5046
					default:
5047
						$ssl = 1;
5048
						break;
5049
				}
5050
5051
				// If it's not 'NEVER', test to see
5052
				if ( $ssl ) {
5053
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5054
						$ssl = 0;
5055
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5056
					} else {
5057
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5058
						if ( is_wp_error( $response ) ) {
5059
							$ssl = 0;
5060
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5061
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5062
							$ssl = 0;
5063
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5064
						}
5065
					}
5066
				}
5067
			}
5068
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5069
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5070
		}
5071
5072
		return (bool) $ssl;
5073
	}
5074
5075
	/*
5076
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5077
	 */
5078
	public function alert_auto_ssl_fail() {
5079
		if ( ! current_user_can( 'manage_options' ) )
5080
			return;
5081
5082
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5083
		?>
5084
5085
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5086
			<div class="jp-banner__content">
5087
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5088
				<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>
5089
				<p>
5090
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5091
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5092
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5093
				</p>
5094
				<p>
5095
					<?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' ),
5096
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
5097
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
5098
				</p>
5099
			</div>
5100
		</div>
5101
		<style>
5102
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5103
		</style>
5104
		<script type="text/javascript">
5105
			jQuery( document ).ready( function( $ ) {
5106
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5107
					var $this = $( this );
5108
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5109
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5110
					e.preventDefault();
5111
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5112
					$.post( ajaxurl, data )
5113
					  .done( function( response ) {
5114
					  	if ( response.enabled ) {
5115
					  		$( '#jetpack-ssl-warning' ).hide();
5116
					  	} else {
5117
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5118
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5119
					  	}
5120
					  }.bind( $this ) );
5121
				} );
5122
			} );
5123
		</script>
5124
5125
		<?php
5126
	}
5127
5128
	/**
5129
	 * Returns the Jetpack XML-RPC API
5130
	 *
5131
	 * @return string
5132
	 */
5133
	public static function xmlrpc_api_url() {
5134
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5135
		return untrailingslashit( $base ) . '/xmlrpc.php';
5136
	}
5137
5138
	/**
5139
	 * Creates two secret tokens and the end of life timestamp for them.
5140
	 *
5141
	 * Note these tokens are unique per call, NOT static per site for connecting.
5142
	 *
5143
	 * @since 2.6
5144
	 * @return array
5145
	 */
5146
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5147
		if ( ! $user_id ) {
5148
			$user_id = get_current_user_id();
5149
		}
5150
5151
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5152
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5153
5154
		if (
5155
			isset( $secrets[ $secret_name ] ) &&
5156
			$secrets[ $secret_name ]['exp'] > time()
5157
		) {
5158
			return $secrets[ $secret_name ];
5159
		}
5160
5161
		$secret_value = array(
5162
			'secret_1'  => wp_generate_password( 32, false ),
5163
			'secret_2'  => wp_generate_password( 32, false ),
5164
			'exp'       => time() + $exp,
5165
		);
5166
5167
		$secrets[ $secret_name ] = $secret_value;
5168
5169
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5170
		return $secrets[ $secret_name ];
5171
	}
5172
5173
	public static function get_secrets( $action, $user_id ) {
5174
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5175
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5176
5177
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5178
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5179
		}
5180
5181
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5182
			self::delete_secrets( $action, $user_id );
5183
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5184
		}
5185
5186
		return $secrets[ $secret_name ];
5187
	}
5188
5189
	public static function delete_secrets( $action, $user_id ) {
5190
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5191
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5192
		if ( isset( $secrets[ $secret_name ] ) ) {
5193
			unset( $secrets[ $secret_name ] );
5194
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5195
		}
5196
	}
5197
5198
	/**
5199
	 * Builds the timeout limit for queries talking with the wpcom servers.
5200
	 *
5201
	 * Based on local php max_execution_time in php.ini
5202
	 *
5203
	 * @since 2.6
5204
	 * @return int
5205
	 * @deprecated
5206
	 **/
5207
	public function get_remote_query_timeout_limit() {
5208
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5209
		return Jetpack::get_max_execution_time();
5210
	}
5211
5212
	/**
5213
	 * Builds the timeout limit for queries talking with the wpcom servers.
5214
	 *
5215
	 * Based on local php max_execution_time in php.ini
5216
	 *
5217
	 * @since 5.4
5218
	 * @return int
5219
	 **/
5220
	public static function get_max_execution_time() {
5221
		$timeout = (int) ini_get( 'max_execution_time' );
5222
5223
		// Ensure exec time set in php.ini
5224
		if ( ! $timeout ) {
5225
			$timeout = 30;
5226
		}
5227
		return $timeout;
5228
	}
5229
5230
	/**
5231
	 * Sets a minimum request timeout, and returns the current timeout
5232
	 *
5233
	 * @since 5.4
5234
	 **/
5235
	public static function set_min_time_limit( $min_timeout ) {
5236
		$timeout = self::get_max_execution_time();
5237
		if ( $timeout < $min_timeout ) {
5238
			$timeout = $min_timeout;
5239
			set_time_limit( $timeout );
5240
		}
5241
		return $timeout;
5242
	}
5243
5244
5245
	/**
5246
	 * Takes the response from the Jetpack register new site endpoint and
5247
	 * verifies it worked properly.
5248
	 *
5249
	 * @since 2.6
5250
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5251
	 **/
5252
	public function validate_remote_register_response( $response ) {
5253
	  if ( is_wp_error( $response ) ) {
5254
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5255
		}
5256
5257
		$code   = wp_remote_retrieve_response_code( $response );
5258
		$entity = wp_remote_retrieve_body( $response );
5259
		if ( $entity )
5260
			$registration_response = json_decode( $entity );
5261
		else
5262
			$registration_response = false;
5263
5264
		$code_type = intval( $code / 100 );
5265
		if ( 5 == $code_type ) {
5266
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5267
		} elseif ( 408 == $code ) {
5268
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5269
		} elseif ( ! empty( $registration_response->error ) ) {
5270
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5271
				$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' );
5272
			} else {
5273
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5274
			}
5275
5276
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5277
		} elseif ( 200 != $code ) {
5278
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5279
		}
5280
5281
		// Jetpack ID error block
5282
		if ( empty( $registration_response->jetpack_id ) ) {
5283
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5284
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5285
			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 );
5286
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5287
			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 );
5288
		}
5289
5290
	    return $registration_response;
5291
	}
5292
	/**
5293
	 * @return bool|WP_Error
5294
	 */
5295
	public static function register() {
5296
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5297
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5298
		$secrets = Jetpack::generate_secrets( 'register' );
5299
5300 View Code Duplication
		if (
5301
			empty( $secrets['secret_1'] ) ||
5302
			empty( $secrets['secret_2'] ) ||
5303
			empty( $secrets['exp'] )
5304
		) {
5305
			return new Jetpack_Error( 'missing_secrets' );
5306
		}
5307
5308
		// better to try (and fail) to set a higher timeout than this system
5309
		// supports than to have register fail for more users than it should
5310
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5311
5312
		$gmt_offset = get_option( 'gmt_offset' );
5313
		if ( ! $gmt_offset ) {
5314
			$gmt_offset = 0;
5315
		}
5316
5317
		$stats_options = get_option( 'stats_options' );
5318
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5319
5320
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5321
5322
		$args = array(
5323
			'method'  => 'POST',
5324
			'body'    => array(
5325
				'siteurl'         => site_url(),
5326
				'home'            => home_url(),
5327
				'gmt_offset'      => $gmt_offset,
5328
				'timezone_string' => (string) get_option( 'timezone_string' ),
5329
				'site_name'       => (string) get_option( 'blogname' ),
5330
				'secret_1'        => $secrets['secret_1'],
5331
				'secret_2'        => $secrets['secret_2'],
5332
				'site_lang'       => get_locale(),
5333
				'timeout'         => $timeout,
5334
				'stats_id'        => $stats_id,
5335
				'state'           => get_current_user_id(),
5336
				'_ui'             => $tracks_identity['_ui'],
5337
				'_ut'             => $tracks_identity['_ut'],
5338
				'jetpack_version' => JETPACK__VERSION
5339
			),
5340
			'headers' => array(
5341
				'Accept' => 'application/json',
5342
			),
5343
			'timeout' => $timeout,
5344
		);
5345
5346
		self::apply_activation_source_to_args( $args['body'] );
5347
5348
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5349
5350
		// Make sure the response is valid and does not contain any Jetpack errors
5351
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5352
		if ( is_wp_error( $registration_details ) ) {
5353
			return $registration_details;
5354
		} elseif ( ! $registration_details ) {
5355
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5356
		}
5357
5358 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5359
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5360
		}
5361
5362
		if ( isset( $registration_details->jetpack_public ) ) {
5363
			$jetpack_public = (int) $registration_details->jetpack_public;
5364
		} else {
5365
			$jetpack_public = false;
5366
		}
5367
5368
		Jetpack_Options::update_options(
5369
			array(
5370
				'id'         => (int)    $registration_details->jetpack_id,
5371
				'blog_token' => (string) $registration_details->jetpack_secret,
5372
				'public'     => $jetpack_public,
5373
			)
5374
		);
5375
5376
		/**
5377
		 * Fires when a site is registered on WordPress.com.
5378
		 *
5379
		 * @since 3.7.0
5380
		 *
5381
		 * @param int $json->jetpack_id Jetpack Blog ID.
5382
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5383
		 * @param int|bool $jetpack_public Is the site public.
5384
		 */
5385
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5386
5387
		// Initialize Jump Start for the first and only time.
5388
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5389
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5390
5391
			$jetpack = Jetpack::init();
5392
5393
			$jetpack->stat( 'jumpstart', 'unique-views' );
5394
			$jetpack->do_stats( 'server_side' );
5395
		};
5396
5397
		return true;
5398
	}
5399
5400
	/**
5401
	 * If the db version is showing something other that what we've got now, bump it to current.
5402
	 *
5403
	 * @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...
5404
	 */
5405
	public static function maybe_set_version_option() {
5406
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5407
		if ( JETPACK__VERSION != $version ) {
5408
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5409
5410
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5411
				/** This action is documented in class.jetpack.php */
5412
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5413
			}
5414
5415
			return true;
5416
		}
5417
		return false;
5418
	}
5419
5420
/* Client Server API */
5421
5422
	/**
5423
	 * Loads the Jetpack XML-RPC client
5424
	 */
5425
	public static function load_xml_rpc_client() {
5426
		require_once ABSPATH . WPINC . '/class-IXR.php';
5427
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5428
	}
5429
5430
	/**
5431
	 * Resets the saved authentication state in between testing requests.
5432
	 */
5433
	public function reset_saved_auth_state() {
5434
		$this->xmlrpc_verification = null;
5435
		$this->rest_authentication_status = null;
5436
	}
5437
5438
	function verify_xml_rpc_signature() {
5439
		if ( $this->xmlrpc_verification ) {
5440
			return $this->xmlrpc_verification;
5441
		}
5442
5443
		// It's not for us
5444
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5445
			return false;
5446
		}
5447
5448
		@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...
5449
		if (
5450
			empty( $token_key )
5451
		||
5452
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5453
		) {
5454
			return false;
5455
		}
5456
5457
		if ( '0' === $user_id ) {
5458
			$token_type = 'blog';
5459
			$user_id = 0;
5460
		} else {
5461
			$token_type = 'user';
5462
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5463
				return false;
5464
			}
5465
			$user_id = (int) $user_id;
5466
5467
			$user = new WP_User( $user_id );
5468
			if ( ! $user || ! $user->exists() ) {
5469
				return false;
5470
			}
5471
		}
5472
5473
		$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...
5474
		if ( ! $token ) {
5475
			return false;
5476
		}
5477
5478
		$token_check = "$token_key.";
5479
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5480
			return false;
5481
		}
5482
5483
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5484
5485
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5486
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5487
			$post_data   = $_POST;
5488
			$file_hashes = array();
5489
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5490
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5491
					continue;
5492
				}
5493
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5494
				$file_hashes[$post_data_key] = $post_data_value;
5495
			}
5496
5497
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5498
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5499
				$post_data[$post_data_key] = $post_data_value;
5500
			}
5501
5502
			ksort( $post_data );
5503
5504
			$body = http_build_query( stripslashes_deep( $post_data ) );
5505
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5506
			$body = file_get_contents( 'php://input' );
5507
		} else {
5508
			$body = null;
5509
		}
5510
5511
		$signature = $jetpack_signature->sign_current_request(
5512
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5513
		);
5514
5515
		if ( ! $signature ) {
5516
			return false;
5517
		} else if ( is_wp_error( $signature ) ) {
5518
			return $signature;
5519
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5520
			return false;
5521
		}
5522
5523
		$timestamp = (int) $_GET['timestamp'];
5524
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5525
5526
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5527
			return false;
5528
		}
5529
5530
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5531
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5532
			if ( ! empty( $_GET['onboarding'] ) ) {
5533
				$jpo = $_GET;
5534
			} else {
5535
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5536
			}
5537
5538
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5539
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5540
5541
			if (
5542
				isset( $jpo_user ) && isset( $jpo_token ) &&
5543
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5544
				isset( $_GET['rest_route'] ) &&
5545
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5546
			) {
5547
				$jpUser = get_user_by( 'email', $jpo_user );
5548
				if ( is_a( $jpUser, 'WP_User' ) ) {
5549
					wp_set_current_user( $jpUser->ID );
5550
					$user_can = is_multisite()
5551
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5552
						: current_user_can( 'manage_options' );
5553
					if ( $user_can ) {
5554
						$token_type = 'user';
5555
						$token->external_user_id = $jpUser->ID;
5556
					}
5557
				}
5558
			}
5559
		}
5560
5561
		$this->xmlrpc_verification = array(
5562
			'type'    => $token_type,
5563
			'user_id' => $token->external_user_id,
5564
		);
5565
5566
		return $this->xmlrpc_verification;
5567
	}
5568
5569
	/**
5570
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5571
	 */
5572
	function authenticate_jetpack( $user, $username, $password ) {
5573
		if ( is_a( $user, 'WP_User' ) ) {
5574
			return $user;
5575
		}
5576
5577
		$token_details = $this->verify_xml_rpc_signature();
5578
5579
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5580
			return $user;
5581
		}
5582
5583
		if ( 'user' !== $token_details['type'] ) {
5584
			return $user;
5585
		}
5586
5587
		if ( ! $token_details['user_id'] ) {
5588
			return $user;
5589
		}
5590
5591
		nocache_headers();
5592
5593
		return new WP_User( $token_details['user_id'] );
5594
	}
5595
5596
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5597
	// Uses the existing XMLRPC request signing implementation.
5598
	function wp_rest_authenticate( $user ) {
5599
		if ( ! empty( $user ) ) {
5600
			// Another authentication method is in effect.
5601
			return $user;
5602
		}
5603
5604
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5605
			// Nothing to do for this authentication method.
5606
			return null;
5607
		}
5608
5609
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5610
			// Nothing to do for this authentication method.
5611
			return null;
5612
		}
5613
5614
		// Ensure that we always have the request body available.  At this
5615
		// point, the WP REST API code to determine the request body has not
5616
		// run yet.  That code may try to read from 'php://input' later, but
5617
		// this can only be done once per request in PHP versions prior to 5.6.
5618
		// So we will go ahead and perform this read now if needed, and save
5619
		// the request body where both the Jetpack signature verification code
5620
		// and the WP REST API code can see it.
5621
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5622
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5623
		}
5624
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5625
5626
		// Only support specific request parameters that have been tested and
5627
		// are known to work with signature verification.  A different method
5628
		// can be passed to the WP REST API via the '?_method=' parameter if
5629
		// needed.
5630
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5631
			$this->rest_authentication_status = new WP_Error(
5632
				'rest_invalid_request',
5633
				__( 'This request method is not supported.', 'jetpack' ),
5634
				array( 'status' => 400 )
5635
			);
5636
			return null;
5637
		}
5638
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5639
			$this->rest_authentication_status = new WP_Error(
5640
				'rest_invalid_request',
5641
				__( 'This request method does not support body parameters.', 'jetpack' ),
5642
				array( 'status' => 400 )
5643
			);
5644
			return null;
5645
		}
5646
5647
		$verified = $this->verify_xml_rpc_signature();
5648
5649
		if ( is_wp_error( $verified ) ) {
5650
			$this->rest_authentication_status = $verified;
5651
			return null;
5652
		}
5653
5654
		if (
5655
			$verified &&
5656
			isset( $verified['type'] ) &&
5657
			'user' === $verified['type'] &&
5658
			! empty( $verified['user_id'] )
5659
		) {
5660
			// Authentication successful.
5661
			$this->rest_authentication_status = true;
5662
			return $verified['user_id'];
5663
		}
5664
5665
		// Something else went wrong.  Probably a signature error.
5666
		$this->rest_authentication_status = new WP_Error(
5667
			'rest_invalid_signature',
5668
			__( 'The request is not signed correctly.', 'jetpack' ),
5669
			array( 'status' => 400 )
5670
		);
5671
		return null;
5672
	}
5673
5674
	/**
5675
	 * Report authentication status to the WP REST API.
5676
	 *
5677
	 * @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...
5678
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5679
	 */
5680
	public function wp_rest_authentication_errors( $value ) {
5681
		if ( $value !== null ) {
5682
			return $value;
5683
		}
5684
		return $this->rest_authentication_status;
5685
	}
5686
5687
	function add_nonce( $timestamp, $nonce ) {
5688
		global $wpdb;
5689
		static $nonces_used_this_request = array();
5690
5691
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5692
			return $nonces_used_this_request["$timestamp:$nonce"];
5693
		}
5694
5695
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5696
		$timestamp = (int) $timestamp;
5697
		$nonce     = esc_sql( $nonce );
5698
5699
		// Raw query so we can avoid races: add_option will also update
5700
		$show_errors = $wpdb->show_errors( false );
5701
5702
		$old_nonce = $wpdb->get_row(
5703
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5704
		);
5705
5706
		if ( is_null( $old_nonce ) ) {
5707
			$return = $wpdb->query(
5708
				$wpdb->prepare(
5709
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5710
					"jetpack_nonce_{$timestamp}_{$nonce}",
5711
					time(),
5712
					'no'
5713
				)
5714
			);
5715
		} else {
5716
			$return = false;
5717
		}
5718
5719
		$wpdb->show_errors( $show_errors );
5720
5721
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5722
5723
		return $return;
5724
	}
5725
5726
	/**
5727
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5728
	 * Capture it here so we can verify the signature later.
5729
	 */
5730
	function xmlrpc_methods( $methods ) {
5731
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5732
		return $methods;
5733
	}
5734
5735
	function public_xmlrpc_methods( $methods ) {
5736
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5737
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5738
		}
5739
		return $methods;
5740
	}
5741
5742
	function jetpack_getOptions( $args ) {
5743
		global $wp_xmlrpc_server;
5744
5745
		$wp_xmlrpc_server->escape( $args );
5746
5747
		$username	= $args[1];
5748
		$password	= $args[2];
5749
5750
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5751
			return $wp_xmlrpc_server->error;
5752
		}
5753
5754
		$options = array();
5755
		$user_data = $this->get_connected_user_data();
5756
		if ( is_array( $user_data ) ) {
5757
			$options['jetpack_user_id'] = array(
5758
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5759
				'readonly'      => true,
5760
				'value'         => $user_data['ID'],
5761
			);
5762
			$options['jetpack_user_login'] = array(
5763
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5764
				'readonly'      => true,
5765
				'value'         => $user_data['login'],
5766
			);
5767
			$options['jetpack_user_email'] = array(
5768
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5769
				'readonly'      => true,
5770
				'value'         => $user_data['email'],
5771
			);
5772
			$options['jetpack_user_site_count'] = array(
5773
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5774
				'readonly'      => true,
5775
				'value'         => $user_data['site_count'],
5776
			);
5777
		}
5778
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5779
		$args = stripslashes_deep( $args );
5780
		return $wp_xmlrpc_server->wp_getOptions( $args );
5781
	}
5782
5783
	function xmlrpc_options( $options ) {
5784
		$jetpack_client_id = false;
5785
		if ( self::is_active() ) {
5786
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5787
		}
5788
		$options['jetpack_version'] = array(
5789
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5790
				'readonly'      => true,
5791
				'value'         => JETPACK__VERSION,
5792
		);
5793
5794
		$options['jetpack_client_id'] = array(
5795
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5796
				'readonly'      => true,
5797
				'value'         => $jetpack_client_id,
5798
		);
5799
		return $options;
5800
	}
5801
5802
	public static function clean_nonces( $all = false ) {
5803
		global $wpdb;
5804
5805
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5806
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5807
5808
		if ( true !== $all ) {
5809
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5810
			$sql_args[] = time() - 3600;
5811
		}
5812
5813
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5814
5815
		$sql = $wpdb->prepare( $sql, $sql_args );
5816
5817
		for ( $i = 0; $i < 1000; $i++ ) {
5818
			if ( ! $wpdb->query( $sql ) ) {
5819
				break;
5820
			}
5821
		}
5822
	}
5823
5824
	/**
5825
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5826
	 * SET: state( $key, $value );
5827
	 * GET: $value = state( $key );
5828
	 *
5829
	 * @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...
5830
	 * @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...
5831
	 * @param bool $restate private
5832
	 */
5833
	public static function state( $key = null, $value = null, $restate = false ) {
5834
		static $state = array();
5835
		static $path, $domain;
5836
		if ( ! isset( $path ) ) {
5837
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5838
			$admin_url = Jetpack::admin_url();
5839
			$bits      = parse_url( $admin_url );
5840
5841
			if ( is_array( $bits ) ) {
5842
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5843
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5844
			} else {
5845
				$path = $domain = null;
5846
			}
5847
		}
5848
5849
		// Extract state from cookies and delete cookies
5850
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5851
			$yum = $_COOKIE[ 'jetpackState' ];
5852
			unset( $_COOKIE[ 'jetpackState' ] );
5853
			foreach ( $yum as $k => $v ) {
5854
				if ( strlen( $v ) )
5855
					$state[ $k ] = $v;
5856
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5857
			}
5858
		}
5859
5860
		if ( $restate ) {
5861
			foreach ( $state as $k => $v ) {
5862
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5863
			}
5864
			return;
5865
		}
5866
5867
		// Get a state variable
5868
		if ( isset( $key ) && ! isset( $value ) ) {
5869
			if ( array_key_exists( $key, $state ) )
5870
				return $state[ $key ];
5871
			return null;
5872
		}
5873
5874
		// Set a state variable
5875
		if ( isset ( $key ) && isset( $value ) ) {
5876
			if( is_array( $value ) && isset( $value[0] ) ) {
5877
				$value = $value[0];
5878
			}
5879
			$state[ $key ] = $value;
5880
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5881
		}
5882
	}
5883
5884
	public static function restate() {
5885
		Jetpack::state( null, null, true );
5886
	}
5887
5888
	public static function check_privacy( $file ) {
5889
		static $is_site_publicly_accessible = null;
5890
5891
		if ( is_null( $is_site_publicly_accessible ) ) {
5892
			$is_site_publicly_accessible = false;
5893
5894
			Jetpack::load_xml_rpc_client();
5895
			$rpc = new Jetpack_IXR_Client();
5896
5897
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5898
			if ( $success ) {
5899
				$response = $rpc->getResponse();
5900
				if ( $response ) {
5901
					$is_site_publicly_accessible = true;
5902
				}
5903
			}
5904
5905
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5906
		}
5907
5908
		if ( $is_site_publicly_accessible ) {
5909
			return;
5910
		}
5911
5912
		$module_slug = self::get_module_slug( $file );
5913
5914
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5915
		if ( ! $privacy_checks ) {
5916
			$privacy_checks = $module_slug;
5917
		} else {
5918
			$privacy_checks .= ",$module_slug";
5919
		}
5920
5921
		Jetpack::state( 'privacy_checks', $privacy_checks );
5922
	}
5923
5924
	/**
5925
	 * Helper method for multicall XMLRPC.
5926
	 */
5927
	public static function xmlrpc_async_call() {
5928
		global $blog_id;
5929
		static $clients = array();
5930
5931
		$client_blog_id = is_multisite() ? $blog_id : 0;
5932
5933
		if ( ! isset( $clients[$client_blog_id] ) ) {
5934
			Jetpack::load_xml_rpc_client();
5935
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5936
			if ( function_exists( 'ignore_user_abort' ) ) {
5937
				ignore_user_abort( true );
5938
			}
5939
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5940
		}
5941
5942
		$args = func_get_args();
5943
5944
		if ( ! empty( $args[0] ) ) {
5945
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5946
		} elseif ( is_multisite() ) {
5947
			foreach ( $clients as $client_blog_id => $client ) {
5948
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5949
					continue;
5950
				}
5951
5952
				$switch_success = switch_to_blog( $client_blog_id, true );
5953
				if ( ! $switch_success ) {
5954
					continue;
5955
				}
5956
5957
				flush();
5958
				$client->query();
5959
5960
				restore_current_blog();
5961
			}
5962
		} else {
5963
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5964
				flush();
5965
				$clients[0]->query();
5966
			}
5967
		}
5968
	}
5969
5970
	public static function staticize_subdomain( $url ) {
5971
5972
		// Extract hostname from URL
5973
		$host = parse_url( $url, PHP_URL_HOST );
5974
5975
		// Explode hostname on '.'
5976
		$exploded_host = explode( '.', $host );
5977
5978
		// Retrieve the name and TLD
5979
		if ( count( $exploded_host ) > 1 ) {
5980
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5981
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5982
			// Rebuild domain excluding subdomains
5983
			$domain = $name . '.' . $tld;
5984
		} else {
5985
			$domain = $host;
5986
		}
5987
		// Array of Automattic domains
5988
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5989
5990
		// Return $url if not an Automattic domain
5991
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5992
			return $url;
5993
		}
5994
5995
		if ( is_ssl() ) {
5996
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5997
		}
5998
5999
		srand( crc32( basename( $url ) ) );
6000
		$static_counter = rand( 0, 2 );
6001
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
6002
6003
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
6004
	}
6005
6006
/* JSON API Authorization */
6007
6008
	/**
6009
	 * Handles the login action for Authorizing the JSON API
6010
	 */
6011
	function login_form_json_api_authorization() {
6012
		$this->verify_json_api_authorization_request();
6013
6014
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
6015
6016
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6017
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6018
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6019
	}
6020
6021
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6022
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6023
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6024
			return $url;
6025
		}
6026
6027
		$parsed_url = parse_url( $url );
6028
		$url = strtok( $url, '?' );
6029
		$url = "$url?{$_SERVER['QUERY_STRING']}";
6030
		if ( ! empty( $parsed_url['query'] ) )
6031
			$url .= "&{$parsed_url['query']}";
6032
6033
		return $url;
6034
	}
6035
6036
	// Make sure the POSTed request is handled by the same action
6037
	function preserve_action_in_login_form_for_json_api_authorization() {
6038
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6039
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6040
	}
6041
6042
	// If someone logs in to approve API access, store the Access Code in usermeta
6043
	function store_json_api_authorization_token( $user_login, $user ) {
6044
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6045
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6046
		$token = wp_generate_password( 32, false );
6047
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6048
	}
6049
6050
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6051
	function allow_wpcom_public_api_domain( $domains ) {
6052
		$domains[] = 'public-api.wordpress.com';
6053
		return $domains;
6054
	}
6055
6056
	// Add all wordpress.com environments to the safe redirect whitelist
6057
	function allow_wpcom_environments( $domains ) {
6058
		$domains[] = 'wordpress.com';
6059
		$domains[] = 'wpcalypso.wordpress.com';
6060
		$domains[] = 'horizon.wordpress.com';
6061
		$domains[] = 'calypso.localhost';
6062
		return $domains;
6063
	}
6064
6065
	// Add the Access Code details to the public-api.wordpress.com redirect
6066
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6067
		return add_query_arg(
6068
			urlencode_deep(
6069
				array(
6070
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6071
					'jetpack-user-id' => (int) $user->ID,
6072
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6073
				)
6074
			),
6075
			$redirect_to
6076
		);
6077
	}
6078
6079
6080
	/**
6081
	 * Verifies the request by checking the signature
6082
	 *
6083
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6084
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6085
	 *
6086
	 * @param null|array $environment
6087
	 */
6088
	function verify_json_api_authorization_request( $environment = null ) {
6089
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6090
6091
		$environment = is_null( $environment )
6092
			? $_REQUEST
6093
			: $environment;
6094
6095
		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...
6096
		$token = Jetpack_Data::get_access_token( $envUserId );
6097
		if ( ! $token || empty( $token->secret ) ) {
6098
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6099
		}
6100
6101
		$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' );
6102
6103
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6104
6105
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6106
			$signature = $jetpack_signature->sign_request(
6107
				$environment['token'],
6108
				$environment['timestamp'],
6109
				$environment['nonce'],
6110
				'',
6111
				'GET',
6112
				$environment['jetpack_json_api_original_query'],
6113
				null,
6114
				true
6115
			);
6116
		} else {
6117
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6118
		}
6119
6120
		if ( ! $signature ) {
6121
			wp_die( $die_error );
6122
		} else if ( is_wp_error( $signature ) ) {
6123
			wp_die( $die_error );
6124
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
6125
			if ( is_ssl() ) {
6126
				// 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
6127
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6128
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6129
					wp_die( $die_error );
6130
				}
6131
			} else {
6132
				wp_die( $die_error );
6133
			}
6134
		}
6135
6136
		$timestamp = (int) $environment['timestamp'];
6137
		$nonce     = stripslashes( (string) $environment['nonce'] );
6138
6139
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6140
			// De-nonce the nonce, at least for 5 minutes.
6141
			// 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)
6142
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6143
			if ( $old_nonce_time < time() - 300 ) {
6144
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6145
			}
6146
		}
6147
6148
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6149
		$data_filters = array(
6150
			'state'        => 'opaque',
6151
			'client_id'    => 'int',
6152
			'client_title' => 'string',
6153
			'client_image' => 'url',
6154
		);
6155
6156
		foreach ( $data_filters as $key => $sanitation ) {
6157
			if ( ! isset( $data->$key ) ) {
6158
				wp_die( $die_error );
6159
			}
6160
6161
			switch ( $sanitation ) {
6162
			case 'int' :
6163
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6164
				break;
6165
			case 'opaque' :
6166
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6167
				break;
6168
			case 'string' :
6169
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6170
				break;
6171
			case 'url' :
6172
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6173
				break;
6174
			}
6175
		}
6176
6177
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6178
			wp_die( $die_error );
6179
		}
6180
	}
6181
6182
	function login_message_json_api_authorization( $message ) {
6183
		return '<p class="message">' . sprintf(
6184
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6185
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6186
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6187
	}
6188
6189
	/**
6190
	 * Get $content_width, but with a <s>twist</s> filter.
6191
	 */
6192
	public static function get_content_width() {
6193
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6194
		/**
6195
		 * Filter the Content Width value.
6196
		 *
6197
		 * @since 2.2.3
6198
		 *
6199
		 * @param string $content_width Content Width value.
6200
		 */
6201
		return apply_filters( 'jetpack_content_width', $content_width );
6202
	}
6203
6204
	/**
6205
	 * Pings the WordPress.com Mirror Site for the specified options.
6206
	 *
6207
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6208
	 *
6209
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6210
	 */
6211
	public function get_cloud_site_options( $option_names ) {
6212
		$option_names = array_filter( (array) $option_names, 'is_string' );
6213
6214
		Jetpack::load_xml_rpc_client();
6215
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6216
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6217
		if ( $xml->isError() ) {
6218
			return array(
6219
				'error_code' => $xml->getErrorCode(),
6220
				'error_msg'  => $xml->getErrorMessage(),
6221
			);
6222
		}
6223
		$cloud_site_options = $xml->getResponse();
6224
6225
		return $cloud_site_options;
6226
	}
6227
6228
	/**
6229
	 * Checks if the site is currently in an identity crisis.
6230
	 *
6231
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6232
	 */
6233
	public static function check_identity_crisis() {
6234
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6235
			return false;
6236
		}
6237
6238
		return Jetpack_Options::get_option( 'sync_error_idc' );
6239
	}
6240
6241
	/**
6242
	 * Checks whether the home and siteurl specifically are whitelisted
6243
	 * Written so that we don't have re-check $key and $value params every time
6244
	 * we want to check if this site is whitelisted, for example in footer.php
6245
	 *
6246
	 * @since  3.8.0
6247
	 * @return bool True = already whitelisted False = not whitelisted
6248
	 */
6249
	public static function is_staging_site() {
6250
		$is_staging = false;
6251
6252
		$known_staging = array(
6253
			'urls' => array(
6254
				'#\.staging\.wpengine\.com$#i', // WP Engine
6255
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6256
				),
6257
			'constants' => array(
6258
				'IS_WPE_SNAPSHOT',      // WP Engine
6259
				'KINSTA_DEV_ENV',       // Kinsta.com
6260
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6261
				'JETPACK_STAGING_MODE', // Generic
6262
				)
6263
			);
6264
		/**
6265
		 * Filters the flags of known staging sites.
6266
		 *
6267
		 * @since 3.9.0
6268
		 *
6269
		 * @param array $known_staging {
6270
		 *     An array of arrays that each are used to check if the current site is staging.
6271
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6272
		 *     @type array $constants PHP constants of known staging/developement environments.
6273
		 *  }
6274
		 */
6275
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6276
6277
		if ( isset( $known_staging['urls'] ) ) {
6278
			foreach ( $known_staging['urls'] as $url ){
6279
				if ( preg_match( $url, site_url() ) ) {
6280
					$is_staging = true;
6281
					break;
6282
				}
6283
			}
6284
		}
6285
6286
		if ( isset( $known_staging['constants'] ) ) {
6287
			foreach ( $known_staging['constants'] as $constant ) {
6288
				if ( defined( $constant ) && constant( $constant ) ) {
6289
					$is_staging = true;
6290
				}
6291
			}
6292
		}
6293
6294
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6295
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6296
			$is_staging = true;
6297
		}
6298
6299
		/**
6300
		 * Filters is_staging_site check.
6301
		 *
6302
		 * @since 3.9.0
6303
		 *
6304
		 * @param bool $is_staging If the current site is a staging site.
6305
		 */
6306
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6307
	}
6308
6309
	/**
6310
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6311
	 *
6312
	 * @since 4.4.0
6313
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6314
	 *
6315
	 * @return bool
6316
	 */
6317
	public static function validate_sync_error_idc_option() {
6318
		$is_valid = false;
6319
6320
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6321
		if ( false === $idc_allowed ) {
6322
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6323
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6324
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6325
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6326
				$transient_duration = HOUR_IN_SECONDS;
6327
			} else {
6328
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6329
				$idc_allowed = '1';
6330
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6331
			}
6332
6333
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6334
		}
6335
6336
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6337
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6338
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6339
			$local_options = self::get_sync_error_idc_option();
6340
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6341
				$is_valid = true;
6342
			}
6343
		}
6344
6345
		/**
6346
		 * Filters whether the sync_error_idc option is valid.
6347
		 *
6348
		 * @since 4.4.0
6349
		 *
6350
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6351
		 */
6352
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6353
6354
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6355
			// Since the option exists, and did not validate, delete it
6356
			Jetpack_Options::delete_option( 'sync_error_idc' );
6357
		}
6358
6359
		return $is_valid;
6360
	}
6361
6362
	/**
6363
	 * Normalizes a url by doing three things:
6364
	 *  - Strips protocol
6365
	 *  - Strips www
6366
	 *  - Adds a trailing slash
6367
	 *
6368
	 * @since 4.4.0
6369
	 * @param string $url
6370
	 * @return WP_Error|string
6371
	 */
6372
	public static function normalize_url_protocol_agnostic( $url ) {
6373
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6374
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6375
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6376
		}
6377
6378
		// Strip www and protocols
6379
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6380
		return $url;
6381
	}
6382
6383
	/**
6384
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6385
	 *
6386
	 * @since 4.4.0
6387
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6388
	 *
6389
	 * @param array $response
6390
	 * @return array Array of the local urls, wpcom urls, and error code
6391
	 */
6392
	public static function get_sync_error_idc_option( $response = array() ) {
6393
		// Since the local options will hit the database directly, store the values
6394
		// in a transient to allow for autoloading and caching on subsequent views.
6395
		$local_options = get_transient( 'jetpack_idc_local' );
6396
		if ( false === $local_options ) {
6397
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6398
			$local_options = array(
6399
				'home'    => Jetpack_Sync_Functions::home_url(),
6400
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6401
			);
6402
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6403
		}
6404
6405
		$options = array_merge( $local_options, $response );
6406
6407
		$returned_values = array();
6408
		foreach( $options as $key => $option ) {
6409
			if ( 'error_code' === $key ) {
6410
				$returned_values[ $key ] = $option;
6411
				continue;
6412
			}
6413
6414
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6415
				continue;
6416
			}
6417
6418
			$returned_values[ $key ] = $normalized_url;
6419
		}
6420
6421
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6422
6423
		return $returned_values;
6424
	}
6425
6426
	/**
6427
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6428
	 * If set to true, the site will be put into staging mode.
6429
	 *
6430
	 * @since 4.3.2
6431
	 * @return bool
6432
	 */
6433
	public static function sync_idc_optin() {
6434
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6435
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6436
		} else {
6437
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6438
		}
6439
6440
		/**
6441
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6442
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6443
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6444
		 *
6445
		 * @since 4.3.2
6446
		 *
6447
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6448
		 */
6449
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6450
	}
6451
6452
	/**
6453
	 * Maybe Use a .min.css stylesheet, maybe not.
6454
	 *
6455
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6456
	 */
6457
	public static function maybe_min_asset( $url, $path, $plugin ) {
6458
		// Short out on things trying to find actual paths.
6459
		if ( ! $path || empty( $plugin ) ) {
6460
			return $url;
6461
		}
6462
6463
		$path = ltrim( $path, '/' );
6464
6465
		// Strip out the abspath.
6466
		$base = dirname( plugin_basename( $plugin ) );
6467
6468
		// Short out on non-Jetpack assets.
6469
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6470
			return $url;
6471
		}
6472
6473
		// File name parsing.
6474
		$file              = "{$base}/{$path}";
6475
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6476
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6477
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6478
		$extension         = array_shift( $file_name_parts_r );
6479
6480
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6481
			// Already pointing at the minified version.
6482
			if ( 'min' === $file_name_parts_r[0] ) {
6483
				return $url;
6484
			}
6485
6486
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6487
			if ( file_exists( $min_full_path ) ) {
6488
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6489
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6490
				if ( 'css' === $extension ) {
6491
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6492
					self::$min_assets[ $key ] = $path;
6493
				}
6494
			}
6495
		}
6496
6497
		return $url;
6498
	}
6499
6500
	/**
6501
	 * If the asset is minified, let's flag .min as the suffix.
6502
	 *
6503
	 * Attached to `style_loader_src` filter.
6504
	 *
6505
	 * @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...
6506
	 * @param string $handle The registered handle of the script in question.
6507
	 * @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...
6508
	 */
6509
	public static function set_suffix_on_min( $src, $handle ) {
6510
		if ( false === strpos( $src, '.min.css' ) ) {
6511
			return $src;
6512
		}
6513
6514
		if ( ! empty( self::$min_assets ) ) {
6515
			foreach ( self::$min_assets as $file => $path ) {
6516
				if ( false !== strpos( $src, $file ) ) {
6517
					wp_style_add_data( $handle, 'suffix', '.min' );
6518
					return $src;
6519
				}
6520
			}
6521
		}
6522
6523
		return $src;
6524
	}
6525
6526
	/**
6527
	 * Maybe inlines a stylesheet.
6528
	 *
6529
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6530
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6531
	 *
6532
	 * Attached to `style_loader_tag` filter.
6533
	 *
6534
	 * @param string $tag The tag that would link to the external asset.
6535
	 * @param string $handle The registered handle of the script in question.
6536
	 *
6537
	 * @return string
6538
	 */
6539
	public static function maybe_inline_style( $tag, $handle ) {
6540
		global $wp_styles;
6541
		$item = $wp_styles->registered[ $handle ];
6542
6543
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6544
			return $tag;
6545
		}
6546
6547
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6548
			$href = $matches[1];
6549
			// Strip off query string
6550
			if ( $pos = strpos( $href, '?' ) ) {
6551
				$href = substr( $href, 0, $pos );
6552
			}
6553
			// Strip off fragment
6554
			if ( $pos = strpos( $href, '#' ) ) {
6555
				$href = substr( $href, 0, $pos );
6556
			}
6557
		} else {
6558
			return $tag;
6559
		}
6560
6561
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6562
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6563
			return $tag;
6564
		}
6565
6566
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6567
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6568
			// And this isn't the pass that actually deals with the RTL version...
6569
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6570
				// Short out, as the RTL version will deal with it in a moment.
6571
				return $tag;
6572
			}
6573
		}
6574
6575
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6576
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6577
		if ( $css ) {
6578
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6579
			if ( empty( $item->extra['after'] ) ) {
6580
				wp_add_inline_style( $handle, $css );
6581
			} else {
6582
				array_unshift( $item->extra['after'], $css );
6583
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6584
			}
6585
		}
6586
6587
		return $tag;
6588
	}
6589
6590
	/**
6591
	 * Loads a view file from the views
6592
	 *
6593
	 * Data passed in with the $data parameter will be available in the
6594
	 * template file as $data['value']
6595
	 *
6596
	 * @param string $template - Template file to load
6597
	 * @param array $data - Any data to pass along to the template
6598
	 * @return boolean - If template file was found
6599
	 **/
6600
	public function load_view( $template, $data = array() ) {
6601
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6602
6603
		if( file_exists( $views_dir . $template ) ) {
6604
			require_once( $views_dir . $template );
6605
			return true;
6606
		}
6607
6608
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6609
		return false;
6610
	}
6611
6612
	/**
6613
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6614
	 */
6615
	public function deprecated_hooks() {
6616
		global $wp_filter;
6617
6618
		/*
6619
		 * Format:
6620
		 * deprecated_filter_name => replacement_name
6621
		 *
6622
		 * If there is no replacement, use null for replacement_name
6623
		 */
6624
		$deprecated_list = array(
6625
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6626
			'wpl_sharing_2014_1'                                     => null,
6627
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6628
			'jetpack_identity_crisis_options_to_check'               => null,
6629
			'update_option_jetpack_single_user_site'                 => null,
6630
			'audio_player_default_colors'                            => null,
6631
			'add_option_jetpack_featured_images_enabled'             => null,
6632
			'add_option_jetpack_update_details'                      => null,
6633
			'add_option_jetpack_updates'                             => null,
6634
			'add_option_jetpack_network_name'                        => null,
6635
			'add_option_jetpack_network_allow_new_registrations'     => null,
6636
			'add_option_jetpack_network_add_new_users'               => null,
6637
			'add_option_jetpack_network_site_upload_space'           => null,
6638
			'add_option_jetpack_network_upload_file_types'           => null,
6639
			'add_option_jetpack_network_enable_administration_menus' => null,
6640
			'add_option_jetpack_is_multi_site'                       => null,
6641
			'add_option_jetpack_is_main_network'                     => null,
6642
			'add_option_jetpack_main_network_site'                   => null,
6643
			'jetpack_sync_all_registered_options'                    => null,
6644
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6645
			'jetpack_is_post_mailable'                               => null,
6646
			'jetpack_seo_site_host'                                  => null,
6647
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6648
			'jetpack_holiday_snow_option_name'                       => null,
6649
			'jetpack_holiday_chance_of_snow'                         => null,
6650
			'jetpack_holiday_snow_js_url'                            => null,
6651
			'jetpack_is_holiday_snow_season'                         => null,
6652
			'jetpack_holiday_snow_option_updated'                    => null,
6653
			'jetpack_holiday_snowing'                                => null,
6654
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6655
			'jetpack_cache_plans'                                    => null,
6656
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6657
			'jetpack_lazy_images_skip_image_with_atttributes'        => 'jetpack_lazy_images_skip_image_with_attributes',
6658
			'jetpack_enable_site_verification'                       => null,
6659
		);
6660
6661
		// This is a silly loop depth. Better way?
6662
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6663
			if ( has_action( $hook ) ) {
6664
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6665
					foreach( $values AS $hooked ) {
6666
						if ( is_callable( $hooked['function'] ) ) {
6667
							$function_name = 'an anonymous function';
6668
						} else {
6669
							$function_name = $hooked['function'];
6670
						}
6671
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6672
					}
6673
				}
6674
			}
6675
		}
6676
	}
6677
6678
	/**
6679
	 * Converts any url in a stylesheet, to the correct absolute url.
6680
	 *
6681
	 * Considerations:
6682
	 *  - Normal, relative URLs     `feh.png`
6683
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6684
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6685
	 *  - Absolute URLs             `http://domain.com/feh.png`
6686
	 *  - Domain root relative URLs `/feh.png`
6687
	 *
6688
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6689
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6690
	 *
6691
	 * @return mixed|string
6692
	 */
6693
	public static function absolutize_css_urls( $css, $css_file_url ) {
6694
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6695
		$css_dir = dirname( $css_file_url );
6696
		$p       = parse_url( $css_dir );
6697
		$domain  = sprintf(
6698
					'%1$s//%2$s%3$s%4$s',
6699
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6700
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6701
					$p['host'],
6702
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6703
				);
6704
6705
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6706
			$find = $replace = array();
6707
			foreach ( $matches as $match ) {
6708
				$url = trim( $match['path'], "'\" \t" );
6709
6710
				// If this is a data url, we don't want to mess with it.
6711
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6712
					continue;
6713
				}
6714
6715
				// If this is an absolute or protocol-agnostic url,
6716
				// we don't want to mess with it.
6717
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6718
					continue;
6719
				}
6720
6721
				switch ( substr( $url, 0, 1 ) ) {
6722
					case '/':
6723
						$absolute = $domain . $url;
6724
						break;
6725
					default:
6726
						$absolute = $css_dir . '/' . $url;
6727
				}
6728
6729
				$find[]    = $match[0];
6730
				$replace[] = sprintf( 'url("%s")', $absolute );
6731
			}
6732
			$css = str_replace( $find, $replace, $css );
6733
		}
6734
6735
		return $css;
6736
	}
6737
6738
	/**
6739
	 * This methods removes all of the registered css files on the front end
6740
	 * from Jetpack in favor of using a single file. In effect "imploding"
6741
	 * all the files into one file.
6742
	 *
6743
	 * Pros:
6744
	 * - Uses only ONE css asset connection instead of 15
6745
	 * - Saves a minimum of 56k
6746
	 * - Reduces server load
6747
	 * - Reduces time to first painted byte
6748
	 *
6749
	 * Cons:
6750
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6751
	 *		should not cause any issues with themes.
6752
	 * - Plugins/themes dequeuing styles no longer do anything. See
6753
	 *		jetpack_implode_frontend_css filter for a workaround
6754
	 *
6755
	 * For some situations developers may wish to disable css imploding and
6756
	 * instead operate in legacy mode where each file loads seperately and
6757
	 * can be edited individually or dequeued. This can be accomplished with
6758
	 * the following line:
6759
	 *
6760
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6761
	 *
6762
	 * @since 3.2
6763
	 **/
6764
	public function implode_frontend_css( $travis_test = false ) {
6765
		$do_implode = true;
6766
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6767
			$do_implode = false;
6768
		}
6769
6770
		/**
6771
		 * Allow CSS to be concatenated into a single jetpack.css file.
6772
		 *
6773
		 * @since 3.2.0
6774
		 *
6775
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6776
		 */
6777
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6778
6779
		// Do not use the imploded file when default behaviour was altered through the filter
6780
		if ( ! $do_implode ) {
6781
			return;
6782
		}
6783
6784
		// We do not want to use the imploded file in dev mode, or if not connected
6785
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6786
			if ( ! $travis_test ) {
6787
				return;
6788
			}
6789
		}
6790
6791
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6792
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6793
			return;
6794
		}
6795
6796
		/*
6797
		 * Now we assume Jetpack is connected and able to serve the single
6798
		 * file.
6799
		 *
6800
		 * In the future there will be a check here to serve the file locally
6801
		 * or potentially from the Jetpack CDN
6802
		 *
6803
		 * For now:
6804
		 * - Enqueue a single imploded css file
6805
		 * - Zero out the style_loader_tag for the bundled ones
6806
		 * - Be happy, drink scotch
6807
		 */
6808
6809
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6810
6811
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6812
6813
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6814
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6815
	}
6816
6817
	function concat_remove_style_loader_tag( $tag, $handle ) {
6818
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6819
			$tag = '';
6820
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6821
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6822
			}
6823
		}
6824
6825
		return $tag;
6826
	}
6827
6828
	/*
6829
	 * Check the heartbeat data
6830
	 *
6831
	 * Organizes the heartbeat data by severity.  For example, if the site
6832
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6833
	 *
6834
	 * Data will be added to "caution" array, if it either:
6835
	 *  - Out of date Jetpack version
6836
	 *  - Out of date WP version
6837
	 *  - Out of date PHP version
6838
	 *
6839
	 * $return array $filtered_data
6840
	 */
6841
	public static function jetpack_check_heartbeat_data() {
6842
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6843
6844
		$good    = array();
6845
		$caution = array();
6846
		$bad     = array();
6847
6848
		foreach ( $raw_data as $stat => $value ) {
6849
6850
			// Check jetpack version
6851
			if ( 'version' == $stat ) {
6852
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6853
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6854
					continue;
6855
				}
6856
			}
6857
6858
			// Check WP version
6859
			if ( 'wp-version' == $stat ) {
6860
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6861
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6862
					continue;
6863
				}
6864
			}
6865
6866
			// Check PHP version
6867
			if ( 'php-version' == $stat ) {
6868
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6869
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6870
					continue;
6871
				}
6872
			}
6873
6874
			// Check ID crisis
6875
			if ( 'identitycrisis' == $stat ) {
6876
				if ( 'yes' == $value ) {
6877
					$bad[ $stat ] = $value;
6878
					continue;
6879
				}
6880
			}
6881
6882
			// The rest are good :)
6883
			$good[ $stat ] = $value;
6884
		}
6885
6886
		$filtered_data = array(
6887
			'good'    => $good,
6888
			'caution' => $caution,
6889
			'bad'     => $bad
6890
		);
6891
6892
		return $filtered_data;
6893
	}
6894
6895
6896
	/*
6897
	 * This method is used to organize all options that can be reset
6898
	 * without disconnecting Jetpack.
6899
	 *
6900
	 * It is used in class.jetpack-cli.php to reset options
6901
	 *
6902
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6903
	 *
6904
	 * @return array of options to delete.
6905
	 */
6906
	public static function get_jetpack_options_for_reset() {
6907
		return Jetpack_Options::get_options_for_reset();
6908
	}
6909
6910
	/**
6911
	 * Check if an option of a Jetpack module has been updated.
6912
	 *
6913
	 * If any module option has been updated before Jump Start has been dismissed,
6914
	 * update the 'jumpstart' option so we can hide Jump Start.
6915
	 *
6916
	 * @param string $option_name
6917
	 *
6918
	 * @return bool
6919
	 */
6920
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6921
		// Bail if Jump Start has already been dismissed
6922
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6923
			return false;
6924
		}
6925
6926
		$jetpack = Jetpack::init();
6927
6928
		// Manual build of module options
6929
		$option_names = self::get_jetpack_options_for_reset();
6930
6931
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6932
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6933
6934
			//Jump start is being dismissed send data to MC Stats
6935
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6936
6937
			$jetpack->do_stats( 'server_side' );
6938
		}
6939
6940
	}
6941
6942
	/*
6943
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6944
	 * so we can bring them directly to their site in calypso.
6945
	 *
6946
	 * @param string | url
6947
	 * @return string | url without the guff
6948
	 */
6949
	public static function build_raw_urls( $url ) {
6950
		$strip_http = '/.*?:\/\//i';
6951
		$url = preg_replace( $strip_http, '', $url  );
6952
		$url = str_replace( '/', '::', $url );
6953
		return $url;
6954
	}
6955
6956
	/**
6957
	 * Stores and prints out domains to prefetch for page speed optimization.
6958
	 *
6959
	 * @param mixed $new_urls
6960
	 */
6961
	public static function dns_prefetch( $new_urls = null ) {
6962
		static $prefetch_urls = array();
6963
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6964
			echo "\r\n";
6965
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6966
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6967
			}
6968
		} elseif ( ! empty( $new_urls ) ) {
6969
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6970
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6971
			}
6972
			foreach ( (array) $new_urls as $this_new_url ) {
6973
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6974
			}
6975
			$prefetch_urls = array_unique( $prefetch_urls );
6976
		}
6977
	}
6978
6979
	public function wp_dashboard_setup() {
6980
		if ( self::is_active() ) {
6981
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6982
		}
6983
6984
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6985
			wp_add_dashboard_widget(
6986
				'jetpack_summary_widget',
6987
				esc_html__( 'Site Stats', 'jetpack' ),
6988
				array( __CLASS__, 'dashboard_widget' )
6989
			);
6990
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6991
6992
			// If we're inactive and not in development mode, sort our box to the top.
6993
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6994
				global $wp_meta_boxes;
6995
6996
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6997
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6998
6999
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7000
			}
7001
		}
7002
	}
7003
7004
	/**
7005
	 * @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...
7006
	 * @return mixed
7007
	 */
7008
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7009
		if ( ! is_array( $sorted ) ) {
7010
			return $sorted;
7011
		}
7012
7013
		foreach ( $sorted as $box_context => $ids ) {
7014
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7015
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7016
				continue;
7017
			}
7018
7019
			$ids_array = explode( ',', $ids );
7020
			$key = array_search( 'dashboard_stats', $ids_array );
7021
7022
			if ( false !== $key ) {
7023
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7024
				$ids_array[ $key ] = 'jetpack_summary_widget';
7025
				$sorted[ $box_context ] = implode( ',', $ids_array );
7026
				// We've found it, stop searching, and just return.
7027
				break;
7028
			}
7029
		}
7030
7031
		return $sorted;
7032
	}
7033
7034
	public static function dashboard_widget() {
7035
		/**
7036
		 * Fires when the dashboard is loaded.
7037
		 *
7038
		 * @since 3.4.0
7039
		 */
7040
		do_action( 'jetpack_dashboard_widget' );
7041
	}
7042
7043
	public static function dashboard_widget_footer() {
7044
		?>
7045
		<footer>
7046
7047
		<div class="protect">
7048
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
7049
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
7050
				<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>
7051
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
7052
				<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' ); ?>">
7053
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
7054
				</a>
7055
			<?php else : ?>
7056
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
7057
			<?php endif; ?>
7058
		</div>
7059
7060
		<div class="akismet">
7061
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7062
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
7063
				<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>
7064
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7065
				<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">
7066
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
7067
				</a>
7068
			<?php else : ?>
7069
				<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>
7070
			<?php endif; ?>
7071
		</div>
7072
7073
		</footer>
7074
		<?php
7075
	}
7076
7077
	/**
7078
	 * Return string containing the Jetpack logo.
7079
	 *
7080
	 * @since 3.9.0
7081
	 *
7082
	 * @return string
7083
	 */
7084
	public static function get_jp_emblem() {
7085
		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>';
7086
	}
7087
7088
	/*
7089
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7090
	 */
7091
	function jetpack_icon_user_connected( $columns ) {
7092
		$columns['user_jetpack'] = '';
7093
		return $columns;
7094
	}
7095
7096
	/*
7097
	 * Show Jetpack icon if the user is linked.
7098
	 */
7099
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7100
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7101
			$emblem_html = sprintf(
7102
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7103
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7104
				Jetpack::get_jp_emblem()
7105
			);
7106
			return $emblem_html;
7107
		}
7108
7109
		return $val;
7110
	}
7111
7112
	/*
7113
	 * Style the Jetpack user column
7114
	 */
7115
	function jetpack_user_col_style() {
7116
		global $current_screen;
7117
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7118
			<style>
7119
				.fixed .column-user_jetpack {
7120
					width: 21px;
7121
				}
7122
				.jp-emblem-user-admin svg {
7123
					width: 20px;
7124
					height: 20px;
7125
				}
7126
				.jp-emblem-user-admin path {
7127
					fill: #00BE28;
7128
				}
7129
			</style>
7130
		<?php }
7131
	}
7132
7133
	/**
7134
	 * Checks if Akismet is active and working.
7135
	 *
7136
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7137
	 * that implied usage of methods present since more recent version.
7138
	 * See https://github.com/Automattic/jetpack/pull/9585
7139
	 *
7140
	 * @since  5.1.0
7141
	 *
7142
	 * @return bool True = Akismet available. False = Aksimet not available.
7143
	 */
7144
	public static function is_akismet_active() {
7145
		if ( method_exists( 'Akismet' , 'http_post' ) ) {
7146
			$akismet_key = Akismet::get_api_key();
7147
			if ( ! $akismet_key ) {
7148
				return false;
7149
			}
7150
			$cached_key_verification = get_transient( 'jetpack_akismet_key_is_valid' );
7151
7152
			// We cache the result of the Akismet key verification for ten minutes.
7153
			if ( in_array( $cached_key_verification, array( 'valid', 'invalid' ) ) ) {
7154
				$akismet_key_state = $cached_key_verification;
7155
			} else {
7156
				$akismet_key_state = Akismet::verify_key( $akismet_key );
7157
				if ( 'failed' === $akismet_key_state ) {
7158
					return false;
7159
				}
7160
				set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7161
			}
7162
7163
			return ( 'valid' === $akismet_key_state );
7164
		}
7165
		return false;
7166
	}
7167
7168
	/**
7169
	 * Checks if one or more function names is in debug_backtrace
7170
	 *
7171
	 * @param $names Mixed string name of function or array of string names of functions
7172
	 *
7173
	 * @return bool
7174
	 */
7175
	public static function is_function_in_backtrace( $names ) {
7176
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility.PHP.NewFunctionParameters.debug_backtrace_optionsFound
7177
		if ( ! is_array( $names ) ) {
7178
			$names = array( $names );
7179
		}
7180
		$names_as_keys = array_flip( $names );
7181
7182
		//Do check in constant O(1) time for PHP5.5+
7183
		if ( function_exists( 'array_column' ) ) {
7184
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility.PHP.NewFunctions.array_columnFound
7185
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7186
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7187
			return ! empty ( $intersection );
7188
		}
7189
7190
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7191
		foreach ( $backtrace as $call ) {
7192
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7193
				return true;
7194
			}
7195
		}
7196
		return false;
7197
	}
7198
7199
	/**
7200
	 * Given a minified path, and a non-minified path, will return
7201
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7202
	 *
7203
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7204
	 * root Jetpack directory.
7205
	 *
7206
	 * @since 5.6.0
7207
	 *
7208
	 * @param string $min_path
7209
	 * @param string $non_min_path
7210
	 * @return string The URL to the file
7211
	 */
7212
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7213
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7214
			? $non_min_path
7215
			: $min_path;
7216
7217
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7218
	}
7219
7220
	/**
7221
	 * Checks for whether Jetpack Rewind is enabled.
7222
	 * Will return true if the state of Rewind is anything except "unavailable".
7223
	 * @return bool|int|mixed
7224
	 */
7225
	public static function is_rewind_enabled() {
7226
		if ( ! Jetpack::is_active() ) {
7227
			return false;
7228
		}
7229
7230
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7231
		if ( false === $rewind_enabled ) {
7232
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7233
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7234
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7235
				&& ! empty( $rewind_data['state'] )
7236
				&& 'active' === $rewind_data['state'] )
7237
				? 1
7238
				: 0;
7239
7240
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7241
		}
7242
		return $rewind_enabled;
7243
	}
7244
7245
	/**
7246
	 * Checks whether or not TOS has been agreed upon.
7247
	 * Will return true if a user has clicked to register, or is already connected.
7248
	 */
7249
	public static function jetpack_tos_agreed() {
7250
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7251
	}
7252
7253
	/**
7254
	 * Handles activating default modules as well general cleanup for the new connection.
7255
	 *
7256
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7257
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7258
	 * @param boolean $send_state_messages          Whether to send state messages.
7259
	 * @return void
7260
	 */
7261
	public static function handle_post_authorization_actions(
7262
		$activate_sso = false,
7263
		$redirect_on_activation_error = false,
7264
		$send_state_messages = true
7265
	) {
7266
		$other_modules = $activate_sso
7267
			? array( 'sso' )
7268
			: array();
7269
7270
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7271
			Jetpack::delete_active_modules();
7272
7273
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 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...
7274
		} else {
7275
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7276
		}
7277
7278
		// Since this is a fresh connection, be sure to clear out IDC options
7279
		Jetpack_IDC::clear_all_idc_options();
7280
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7281
7282
		// Start nonce cleaner
7283
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7284
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7285
7286
		if ( $send_state_messages ) {
7287
			Jetpack::state( 'message', 'authorized' );
7288
		}
7289
	}
7290
7291
	/**
7292
	 * Returns a boolean for whether backups UI should be displayed or not.
7293
	 *
7294
	 * @return bool Should backups UI be displayed?
7295
	 */
7296
	public static function show_backups_ui() {
7297
		/**
7298
		 * Whether UI for backups should be displayed.
7299
		 *
7300
		 * @since 6.5.0
7301
		 *
7302
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7303
		 */
7304
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7305
	}
7306
}
7307