Completed
Push — master-stable ( b0661e...7c8a41 )
by
unknown
134:26 queued 126:49
created

_inc/lib/class.core-rest-api-endpoints.php (6 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
/**
3
 * Register WP REST API endpoints for Jetpack.
4
 *
5
 * @author Automattic
6
 */
7
8
/**
9
 * Disable direct access.
10
 */
11
if ( ! defined( 'ABSPATH' ) ) {
12
	exit;
13
}
14
15
// Load WP_Error for error messages.
16
require_once ABSPATH . '/wp-includes/class-wp-error.php';
17
18
// Register endpoints when WP REST API is initialized.
19
add_action( 'rest_api_init', array( 'Jetpack_Core_Json_Api_Endpoints', 'register_endpoints' ) );
20
21
/**
22
 * Class Jetpack_Core_Json_Api_Endpoints
23
 *
24
 * @since 4.3.0
25
 */
26
class Jetpack_Core_Json_Api_Endpoints {
27
28
	/**
29
	 * @var string Generic error message when user is not allowed to perform an action.
30
	 */
31
	public static $user_permissions_error_msg;
32
33
	/**
34
	 * @var array Roles that can access Stats once they're granted access.
35
	 */
36
	public static $stats_roles;
37
38
	/**
39
	 * Declare the Jetpack REST API endpoints.
40
	 *
41
	 * @since 4.3.0
42
	 */
43
	public static function register_endpoints() {
44
45
		// Load API endpoint base classes
46
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
47
48
		// Load API endpoints
49
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
50
51
		self::$user_permissions_error_msg = esc_html__(
52
			'You do not have the correct user permissions to perform this action.
53
			Please contact your site admin if you think this is a mistake.',
54
			'jetpack'
55
		);
56
57
		self::$stats_roles = array( 'administrator', 'editor', 'author', 'contributor', 'subscriber' );
58
59
		// Get current connection status of Jetpack
60
		register_rest_route( 'jetpack/v4', '/connection', array(
61
			'methods' => WP_REST_Server::READABLE,
62
			'callback' => __CLASS__ . '::jetpack_connection_status',
63
		) );
64
65
		// Fetches a fresh connect URL
66
		register_rest_route( 'jetpack/v4', '/connection/url', array(
67
			'methods' => WP_REST_Server::READABLE,
68
			'callback' => __CLASS__ . '::build_connect_url',
69
			'permission_callback' => __CLASS__ . '::connect_url_permission_callback',
70
		) );
71
72
		// Get current user connection data
73
		register_rest_route( 'jetpack/v4', '/connection/data', array(
74
			'methods' => WP_REST_Server::READABLE,
75
			'callback' => __CLASS__ . '::get_user_connection_data',
76
			'permission_callback' => __CLASS__ . '::get_user_connection_data_permission_callback',
77
		) );
78
79
		// Disconnect site from WordPress.com servers
80
		register_rest_route( 'jetpack/v4', '/connection', array(
81
			'methods' => WP_REST_Server::EDITABLE,
82
			'callback' => __CLASS__ . '::disconnect_site',
83
			'permission_callback' => __CLASS__ . '::disconnect_site_permission_callback',
84
		) );
85
86
		// Disconnect/unlink user from WordPress.com servers
87
		register_rest_route( 'jetpack/v4', '/connection/user', array(
88
			'methods' => WP_REST_Server::EDITABLE,
89
			'callback' => __CLASS__ . '::unlink_user',
90
			'permission_callback' => __CLASS__ . '::unlink_user_permission_callback',
91
		) );
92
93
		// Get current site data
94
		register_rest_route( 'jetpack/v4', '/site', array(
95
			'methods' => WP_REST_Server::READABLE,
96
			'callback' => __CLASS__ . '::get_site_data',
97
			'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
98
		) );
99
100
		// Confirm that a site in identity crisis should be in staging mode
101
		register_rest_route( 'jetpack/v4', '/identity-crisis/confirm-safe-mode', array(
102
			'methods' => WP_REST_Server::EDITABLE,
103
			'callback' => __CLASS__ . '::confirm_safe_mode',
104
			'permission_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
105
		) );
106
107
		// IDC resolve: create an entirely new shadow site for this URL.
108
		register_rest_route( 'jetpack/v4', '/identity-crisis/start-fresh', array(
109
			'methods' => WP_REST_Server::EDITABLE,
110
			'callback' => __CLASS__ . '::start_fresh_connection',
111
			'permission_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
112
		) );
113
114
		// Handles the request to migrate stats and subscribers during an identity crisis.
115
		register_rest_route( 'jetpack/v4', 'identity-crisis/migrate', array(
116
			'methods' => WP_REST_Server::EDITABLE,
117
			'callback' => __CLASS__ . '::migrate_stats_and_subscribers',
118
			'permissison_callback' => __CLASS__ . '::identity_crisis_mitigation_permission_check',
119
		) );
120
121
		// Return all modules
122
		self::route(
123
			'module/all',
124
			'Jetpack_Core_API_Module_List_Endpoint',
125
			WP_REST_Server::READABLE
126
		);
127
128
		// Activate many modules
129
		self::route(
130
			'/module/all/active',
131
			'Jetpack_Core_API_Module_List_Endpoint',
132
			WP_REST_Server::EDITABLE,
133
			NULL,
134
			array(
135
				'modules' => array(
136
					'default'           => '',
137
					'type'              => 'array',
138
					'required'          => true,
139
					'validate_callback' => __CLASS__ . '::validate_module_list',
140
				),
141
				'active' => array(
142
					'default'           => true,
143
					'type'              => 'boolean',
144
					'required'          => false,
145
					'validate_callback' => __CLASS__ . '::validate_boolean',
146
				),
147
			)
148
		);
149
150
		Jetpack::load_xml_rpc_client();
151
152
		// Return a single module and update it when needed
153
		self::route(
154
			'/module/(?P<slug>[a-z\-]+)',
155
			'Jetpack_Core_API_Data',
156
			WP_REST_Server::READABLE,
157
			new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) )
158
		);
159
160
		// Activate and deactivate a module
161
		self::route(
162
			'/module/(?P<slug>[a-z\-]+)/active',
163
			'Jetpack_Core_API_Module_Toggle_Endpoint',
164
			WP_REST_Server::EDITABLE,
165
			new Jetpack_IXR_Client(),
166
			array(
167
				'active' => array(
168
					'default'           => true,
169
					'type'              => 'boolean',
170
					'required'          => true,
171
					'validate_callback' => __CLASS__ . '::validate_boolean',
172
				),
173
			)
174
		);
175
176
		// Update a module
177
		self::route(
178
			'/module/(?P<slug>[a-z\-]+)',
179
			'Jetpack_Core_API_Data',
180
			WP_REST_Server::EDITABLE,
181
			new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) ),
182
			self::get_updateable_parameters()
183
		);
184
185
		// Get data for a specific module, i.e. Protect block count, WPCOM stats,
186
		// Akismet spam count, etc.
187
		self::route(
188
			'/module/(?P<slug>[a-z\-]+)/data',
189
			'Jetpack_Core_API_Module_Data_Endpoint',
190
			WP_REST_Server::READABLE,
191
			NULL,
192
			array(
193
				'range' => array(
194
					'default'           => 'day',
195
					'type'              => 'string',
196
					'required'          => false,
197
					'validate_callback' => __CLASS__ . '::validate_string',
198
				),
199
			)
200
		);
201
202
		// Update any Jetpack module option or setting
203
		self::route(
204
			'/settings',
205
			'Jetpack_Core_API_Data',
206
			WP_REST_Server::EDITABLE,
207
			new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) ),
208
			self::get_updateable_parameters( 'any' )
209
		);
210
211
		// Update a module
212
		self::route(
213
			'/settings/(?P<slug>[a-z\-]+)',
214
			'Jetpack_Core_API_Data',
215
			WP_REST_Server::EDITABLE,
216
			new Jetpack_IXR_Client( array( 'user_id' => get_current_user_id() ) ),
217
			self::get_updateable_parameters()
218
		);
219
220
		// Return miscellaneous settings
221
		register_rest_route( 'jetpack/v4', '/settings', array(
222
			'methods' => WP_REST_Server::READABLE,
223
			'callback' => __CLASS__ . '::get_settings',
224
			'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
225
		) );
226
227
		// Reset all Jetpack options
228
		register_rest_route( 'jetpack/v4', '/options/(?P<options>[a-z\-]+)', array(
229
			'methods' => WP_REST_Server::EDITABLE,
230
			'callback' => __CLASS__ . '::reset_jetpack_options',
231
			'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
232
		) );
233
234
		// Jumpstart
235
		register_rest_route( 'jetpack/v4', '/jumpstart', array(
236
			'methods' => WP_REST_Server::EDITABLE,
237
			'callback' => __CLASS__ . '::jumpstart_toggle',
238
			'permission_callback' => __CLASS__ . '::manage_modules_permission_check',
239
			'args' => array(
240
				'active' => array(
241
					'required' => true,
242
					'validate_callback' => __CLASS__  . '::validate_boolean',
243
				),
244
			),
245
		) );
246
247
		// Updates: get number of plugin updates available
248
		register_rest_route( 'jetpack/v4', '/updates/plugins', array(
249
			'methods' => WP_REST_Server::READABLE,
250
			'callback' => __CLASS__ . '::get_plugin_update_count',
251
			'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
252
		) );
253
254
		// Dismiss Jetpack Notices
255
		register_rest_route( 'jetpack/v4', '/notice/(?P<notice>[a-z\-_]+)', array(
256
			'methods' => WP_REST_Server::EDITABLE,
257
			'callback' => __CLASS__ . '::dismiss_notice',
258
			'permission_callback' => __CLASS__ . '::view_admin_page_permission_check',
259
		) );
260
261
		// Plugins: get list of all plugins.
262
		register_rest_route( 'jetpack/v4', '/plugins', array(
263
			'methods' => WP_REST_Server::READABLE,
264
			'callback' => __CLASS__ . '::get_plugins',
265
			'permission_callback' => __CLASS__ . '::activate_plugins_permission_check',
266
		) );
267
268
		// Plugins: check if the plugin is active.
269
		register_rest_route( 'jetpack/v4', '/plugin/(?P<plugin>[a-z\/\.\-_]+)', array(
270
			'methods' => WP_REST_Server::READABLE,
271
			'callback' => __CLASS__ . '::get_plugin',
272
			'permission_callback' => __CLASS__ . '::activate_plugins_permission_check',
273
		) );
274
	}
275
276
	public static function route( $path, $classname, $method,
277
		$constructor_arguments = NULL,
278
		$endpoint_arguments = NULL
279
	) {
280
		if ( ! empty( $constructor_arguments ) ) {
281
			$endpoint = new $classname( $constructor_arguments );
282
		} else {
283
			$endpoint = new $classname();
284
		}
285
286
		$parameters = array(
287
			'methods' => $method,
288
			'callback' => array( $endpoint, 'process' ),
289
			'permission_callback' => array( $endpoint, 'can_request' )
290
		);
291
292
		if ( ! empty( $endpoint_arguments ) ) {
293
			$parameters['args'] = $endpoint_arguments;
294
		}
295
296
		register_rest_route( 'jetpack/v4', $path, $parameters );
297
	}
298
299
	/**
300
	 * Handles dismissing of Jetpack Notices
301
	 *
302
	 * @since 4.3.0
303
	 *
304
	 * @return array|wp-error
305
	 */
306
	public static function dismiss_notice( $data ) {
307
		$notice = $data['notice'];
308
		$param = $data->get_json_params();
309
310
		if ( ! isset( $param['dismissed'] ) || $param['dismissed'] !== true ) {
311
			return new WP_Error( 'invalid_param', esc_html__( 'Invalid parameter "dismissed".', 'jetpack' ), array( 'status' => 404 ) );
312
		}
313
314
		if ( isset( $notice ) && ! empty( $notice ) ) {
315
			switch( $notice ) {
316
				case 'feedback_dash_request':
317
				case 'welcome':
318
					$notices = get_option( 'jetpack_dismissed_notices', array() );
319
					$notices[ $notice ] = true;
320
					update_option( 'jetpack_dismissed_notices', $notices );
321
					return rest_ensure_response( get_option( 'jetpack_dismissed_notices', array() ) );
322
323
				default:
324
					return new WP_Error( 'invalid_param', esc_html__( 'Invalid parameter "notice".', 'jetpack' ), array( 'status' => 404 ) );
325
			}
326
		}
327
328
		return new WP_Error( 'required_param', esc_html__( 'Missing parameter "notice".', 'jetpack' ), array( 'status' => 404 ) );
329
	}
330
331
	/**
332
	 * Verify that the user can disconnect the site.
333
	 *
334
	 * @since 4.3.0
335
	 *
336
	 * @return bool|WP_Error True if user is able to disconnect the site.
337
	 */
338 View Code Duplication
	public static function disconnect_site_permission_callback() {
339
		if ( current_user_can( 'jetpack_disconnect' ) ) {
340
			return true;
341
		}
342
343
		return new WP_Error( 'invalid_user_permission_jetpack_disconnect', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
344
345
	}
346
347
	/**
348
	 * Verify that the user can get a connect/link URL
349
	 *
350
	 * @since 4.3.0
351
	 *
352
	 * @return bool|WP_Error True if user is able to disconnect the site.
353
	 */
354 View Code Duplication
	public static function connect_url_permission_callback() {
355
		if ( current_user_can( 'jetpack_connect_user' ) ) {
356
			return true;
357
		}
358
359
		return new WP_Error( 'invalid_user_permission_jetpack_disconnect', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
360
361
	}
362
363
	/**
364
	 * Verify that a user can get the data about the current user.
365
	 * Only those who can connect.
366
	 *
367
	 * @since 4.3.0
368
	 *
369
	 * @uses Jetpack::is_user_connected();
370
	 *
371
	 * @return bool|WP_Error True if user is able to unlink.
372
	 */
373 View Code Duplication
	public static function get_user_connection_data_permission_callback() {
374
		if ( current_user_can( 'jetpack_connect_user' ) ) {
375
			return true;
376
		}
377
378
		return new WP_Error( 'invalid_user_permission_user_connection_data', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
379
	}
380
381
	/**
382
	 * Verify that a user can use the /connection/user endpoint. Has to be a registered user and be currently linked.
383
	 *
384
	 * @since 4.3.0
385
	 *
386
	 * @uses Jetpack::is_user_connected();
387
	 *
388
	 * @return bool|WP_Error True if user is able to unlink.
389
	 */
390
	public static function unlink_user_permission_callback() {
391
		if ( current_user_can( 'jetpack_connect_user' ) && Jetpack::is_user_connected( get_current_user_id() ) ) {
392
			return true;
393
		}
394
395
		return new WP_Error( 'invalid_user_permission_unlink_user', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
396
	}
397
398
	/**
399
	 * Verify that user can manage Jetpack modules.
400
	 *
401
	 * @since 4.3.0
402
	 *
403
	 * @return bool Whether user has the capability 'jetpack_manage_modules'.
404
	 */
405
	public static function manage_modules_permission_check() {
406
		if ( current_user_can( 'jetpack_manage_modules' ) ) {
407
			return true;
408
		}
409
410
		return new WP_Error( 'invalid_user_permission_manage_modules', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
411
	}
412
413
	/**
414
	 * Verify that user can update Jetpack modules.
415
	 *
416
	 * @since 4.3.0
417
	 *
418
	 * @return bool Whether user has the capability 'jetpack_configure_modules'.
419
	 */
420 View Code Duplication
	public static function configure_modules_permission_check() {
421
		if ( current_user_can( 'jetpack_configure_modules' ) ) {
422
			return true;
423
		}
424
425
		return new WP_Error( 'invalid_user_permission_configure_modules', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
426
	}
427
428
	/**
429
	 * Verify that user can view Jetpack admin page.
430
	 *
431
	 * @since 4.3.0
432
	 *
433
	 * @return bool Whether user has the capability 'jetpack_admin_page'.
434
	 */
435 View Code Duplication
	public static function view_admin_page_permission_check() {
436
		if ( current_user_can( 'jetpack_admin_page' ) ) {
437
			return true;
438
		}
439
440
		return new WP_Error( 'invalid_user_permission_view_admin', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
441
	}
442
443
	/**
444
	 * Verify that user can mitigate an identity crisis.
445
	 *
446
	 * @since 4.4.0
447
	 *
448
	 * @return bool Whether user has capability 'jetpack_disconnect'.
449
	 */
450 View Code Duplication
	public static function identity_crisis_mitigation_permission_check() {
451
		if ( current_user_can( 'jetpack_disconnect' ) ) {
452
			return true;
453
		}
454
455
		return new WP_Error( 'invalid_user_permission_identity_crisis', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
456
	}
457
458
	/**
459
	 * Verify that user can update Jetpack general settings.
460
	 *
461
	 * @since 4.3.0
462
	 *
463
	 * @return bool Whether user has the capability 'update_settings_permission_check'.
464
	 */
465 View Code Duplication
	public static function update_settings_permission_check() {
466
		if ( current_user_can( 'jetpack_configure_modules' ) ) {
467
			return true;
468
		}
469
470
		return new WP_Error( 'invalid_user_permission_manage_settings', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
471
	}
472
473
	/**
474
	 * Verify that user can view Jetpack admin page and can activate plugins.
475
	 *
476
	 * @since 4.3.0
477
	 *
478
	 * @return bool Whether user has the capability 'jetpack_admin_page' and 'activate_plugins'.
479
	 */
480 View Code Duplication
	public static function activate_plugins_permission_check() {
481
		if ( current_user_can( 'jetpack_admin_page' ) && current_user_can( 'activate_plugins' ) ) {
482
			return true;
483
		}
484
485
		return new WP_Error( 'invalid_user_permission_activate_plugins', self::$user_permissions_error_msg, array( 'status' => self::rest_authorization_required_code() ) );
486
	}
487
488
	/**
489
	 * Contextual HTTP error code for authorization failure.
490
	 *
491
	 * Taken from rest_authorization_required_code() in WP-API plugin until is added to core.
492
	 * @see https://github.com/WP-API/WP-API/commit/7ba0ae6fe4f605d5ffe4ee85b1cd5f9fb46900a6
493
	 *
494
	 * @since 4.3.0
495
	 *
496
	 * @return int
497
	 */
498
	public static function rest_authorization_required_code() {
499
		return is_user_logged_in() ? 403 : 401;
500
	}
501
502
	/**
503
	 * Get connection status for this Jetpack site.
504
	 *
505
	 * @since 4.3.0
506
	 *
507
	 * @return bool True if site is connected
508
	 */
509
	public static function jetpack_connection_status() {
510
		return rest_ensure_response( array(
511
				'isActive'  => Jetpack::is_active(),
512
				'isStaging' => Jetpack::is_staging_site(),
513
				'devMode'   => array(
514
					'isActive' => Jetpack::is_development_mode(),
515
					'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
516
					'url'      => site_url() && false === strpos( site_url(), '.' ),
517
					'filter'   => apply_filters( 'jetpack_development_mode', false ),
518
				),
519
			)
520
		);
521
	}
522
523
	/**
524
	 * Disconnects Jetpack from the WordPress.com Servers
525
	 *
526
	 * @uses Jetpack::disconnect();
527
	 * @since 4.3.0
528
	 * @return bool|WP_Error True if Jetpack successfully disconnected.
529
	 */
530 View Code Duplication
	public static function disconnect_site( $data ) {
531
		$param = $data->get_json_params();
532
533
		if ( ! isset( $param['isActive'] ) || $param['isActive'] !== false ) {
534
			return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
535
		}
536
537
		if ( Jetpack::is_active() ) {
538
			Jetpack::disconnect();
539
			return rest_ensure_response( array( 'code' => 'success' ) );
540
		}
541
542
		return new WP_Error( 'disconnect_failed', esc_html__( 'Was not able to disconnect the site.  Please try again.', 'jetpack' ), array( 'status' => 400 ) );
543
	}
544
545
	/**
546
	 * Gets a new connect raw URL with fresh nonce.
547
	 *
548
	 * @uses Jetpack::disconnect();
549
	 * @since 4.3.0
550
	 * @return string|WP_Error A raw URL if the connection URL could be built; error message otherwise.
551
	 */
552
	public static function build_connect_url() {
553
		$url = Jetpack::init()->build_connect_url( true, false, false );
554
		if ( $url ) {
555
			return rest_ensure_response( $url );
556
		}
557
558
		return new WP_Error( 'build_connect_url_failed', esc_html__( 'Unable to build the connect URL.  Please reload the page and try again.', 'jetpack' ), array( 'status' => 400 ) );
559
	}
560
561
	/**
562
	 * Get miscellaneous settings for this Jetpack installation, like Holiday Snow.
563
	 *
564
	 * @since 4.3.0
565
	 *
566
	 * @return object $response {
567
	 *     Array of miscellaneous settings.
568
	 *
569
	 *     @type bool $holiday-snow Did Jack steal Christmas?
570
	 * }
571
	 */
572
	public static function get_settings() {
573
		$response = array(
574
			self::holiday_snow_option_name() => get_option( self::holiday_snow_option_name() ) == 'letitsnow',
575
		);
576
		return rest_ensure_response( $response );
577
	}
578
579
	/**
580
	 * Get miscellaneous user data related to the connection. Similar data available in old "My Jetpack".
581
	 * Information about the master/primary user.
582
	 * Information about the current user.
583
	 *
584
	 * @since 4.3.0
585
	 *
586
	 * @return object
587
	 */
588
	public static function get_user_connection_data() {
589
		require_once( JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class.jetpack-react-page.php' );
590
591
		$response = array(
592
//			'othersLinked' => Jetpack::get_other_linked_admins(),
593
			'currentUser'  => jetpack_current_user_data(),
594
		);
595
		return rest_ensure_response( $response );
596
	}
597
598
	/**
599
	 * Returns the proper name for Jetpack Holiday Snow setting.
600
	 * When the REST route starts, the holiday-snow.php file where jetpack_holiday_snow_option_name() function is defined is not loaded,
601
	 * so where using this to replicate it and have the same functionality.
602
	 *
603
	 * @since 4.4.0
604
	 *
605
	 * @return string
606
	 */
607
	public static function holiday_snow_option_name() {
608
		/** This filter is documented in modules/holiday-snow.php */
609
		return apply_filters( 'jetpack_holiday_snow_option_name', 'jetpack_holiday_snow_enabled' );
610
	}
611
612
	/**
613
	 * Update a single miscellaneous setting for this Jetpack installation, like Holiday Snow.
614
	 *
615
	 * @since 4.3.0
616
	 *
617
	 * @param WP_REST_Request $data
618
	 *
619
	 * @return object Jetpack miscellaneous settings.
620
	 */
621
	public static function update_setting( $data ) {
622
		// Get parameters to update the module.
623
		$param = $data->get_json_params();
624
625
		// Exit if no parameters were passed.
626 View Code Duplication
		if ( ! is_array( $param ) ) {
627
			return new WP_Error( 'missing_setting', esc_html__( 'Missing setting.', 'jetpack' ), array( 'status' => 404 ) );
628
		}
629
630
		// Get option name and value.
631
		$option = key( $param );
632
		$value  = current( $param );
633
634
		// Log success or not
635
		$updated = false;
636
637
		switch ( $option ) {
638
			case self::holiday_snow_option_name():
639
				$updated = update_option( $option, ( true == (bool) $value ) ? 'letitsnow' : '' );
640
				break;
641
		}
642
643
		if ( $updated ) {
644
			return rest_ensure_response( array(
645
				'code' 	  => 'success',
646
				'message' => esc_html__( 'Setting updated.', 'jetpack' ),
647
				'value'   => $value,
648
			) );
649
		}
650
651
		return new WP_Error( 'setting_not_updated', esc_html__( 'The setting was not updated.', 'jetpack' ), array( 'status' => 400 ) );
652
	}
653
654
	/**
655
	 * Unlinks current user from the WordPress.com Servers.
656
	 *
657
	 * @since 4.3.0
658
	 * @uses  Jetpack::unlink_user
659
	 *
660
	 * @return bool|WP_Error True if user successfully unlinked.
661
	 */
662 View Code Duplication
	public static function unlink_user( $data ) {
663
		$param = $data->get_json_params();
664
665
		if ( ! isset( $param['linked'] ) || $param['linked'] !== false ) {
666
			return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
667
		}
668
669
		if ( Jetpack::unlink_user() ) {
670
			return rest_ensure_response(
671
				array(
672
					'code' => 'success'
673
				)
674
			);
675
		}
676
677
		return new WP_Error( 'unlink_user_failed', esc_html__( 'Was not able to unlink the user.  Please try again.', 'jetpack' ), array( 'status' => 400 ) );
678
	}
679
680
	/**
681
	 * Get site data, including for example, the site's current plan.
682
	 *
683
	 * @since 4.3.0
684
	 *
685
	 * @return array Array of Jetpack modules.
686
	 */
687
	public static function get_site_data() {
688
689
		if ( $site_id = Jetpack_Options::get_option( 'id' ) ) {
690
			$response = Jetpack_Client::wpcom_json_api_request_as_blog( sprintf( '/sites/%d', $site_id ), '1.1' );
691
692
			if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
693
				return new WP_Error( 'site_data_fetch_failed', esc_html__( 'Failed fetching site data. Try again later.', 'jetpack' ), array( 'status' => 400 ) );
694
			}
695
696
			return rest_ensure_response( array(
697
					'code' => 'success',
698
					'message' => esc_html__( 'Site data correctly received.', 'jetpack' ),
699
					'data' => wp_remote_retrieve_body( $response ),
700
				)
701
			);
702
		}
703
704
		return new WP_Error( 'site_id_missing', esc_html__( 'The ID of this site does not exist.', 'jetpack' ), array( 'status' => 404 ) );
705
	}
706
707
	/**
708
	 * Handles identity crisis mitigation, confirming safe mode for this site.
709
	 *
710
	 * @since 4.4.0
711
	 *
712
	 * @return bool | WP_Error True if option is properly set.
713
	 */
714
	public static function confirm_safe_mode() {
715
		$updated = Jetpack_Options::update_option( 'safe_mode_confirmed', true );
716
		if ( $updated ) {
717
			return rest_ensure_response(
718
				array(
719
					'code' => 'success'
720
				)
721
			);
722
		}
723
		return new WP_Error(
724
			'error_setting_jetpack_safe_mode',
725
			esc_html__( 'Could not confirm safe mode.', 'jetpack' ),
726
			array( 'status' => 500 )
727
		);
728
	}
729
730
	/**
731
	 * Handles identity crisis mitigation, migrating stats and subscribers from old url to this, new url.
732
	 *
733
	 * @since 4.4.0
734
	 *
735
	 * @return bool | WP_Error True if option is properly set.
736
	 */
737
	public static function migrate_stats_and_subscribers() {
738
		if ( Jetpack_Options::get_option( 'sync_error_idc' ) && ! Jetpack_Options::delete_option( 'sync_error_idc' ) ) {
739
			return new WP_Error(
740
				'error_deleting_sync_error_idc',
741
				esc_html__( 'Could not delete sync error option.', 'jetpack' ),
742
				array( 'status' => 500 )
743
			);
744
		}
745
746
		if ( Jetpack_Options::get_option( 'migrate_for_idc' ) || Jetpack_Options::update_option( 'migrate_for_idc', true ) ) {
747
			return rest_ensure_response(
748
				array(
749
					'code' => 'success'
750
				)
751
			);
752
		}
753
		return new WP_Error(
754
			'error_setting_jetpack_migrate',
755
			esc_html__( 'Could not confirm migration.', 'jetpack' ),
756
			array( 'status' => 500 )
757
		);
758
	}
759
760
	/**
761
	 * This IDC resolution will disconnect the site and re-connect to a completely new
762
	 * and separate shadow site than the original.
763
	 *
764
	 * It will first will disconnect the site without phoning home as to not disturb the production site.
765
	 * It then builds a fresh connection URL and sends it back along with the response.
766
	 *
767
	 * @since 4.4.0
768
	 * @return bool|WP_Error
769
	 */
770
	public static function start_fresh_connection() {
771
		// First clear the options / disconnect.
772
		Jetpack::disconnect();
773
		return self::build_connect_url();
774
	}
775
776
	/**
777
	 * Reset Jetpack options
778
	 *
779
	 * @since 4.3.0
780
	 *
781
	 * @param WP_REST_Request $data {
782
	 *     Array of parameters received by request.
783
	 *
784
	 *     @type string $options Available options to reset are options|modules
785
	 * }
786
	 *
787
	 * @return bool|WP_Error True if options were reset. Otherwise, a WP_Error instance with the corresponding error.
788
	 */
789
	public static function reset_jetpack_options( $data ) {
790
		$param = $data->get_json_params();
791
792
		if ( ! isset( $param['reset'] ) || $param['reset'] !== true ) {
793
			return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
794
		}
795
796
		if ( isset( $data['options'] ) ) {
797
			$data = $data['options'];
798
799
			switch( $data ) {
800
				case ( 'options' ) :
801
					$options_to_reset = Jetpack::get_jetpack_options_for_reset();
802
803
					// Reset the Jetpack options
804
					foreach ( $options_to_reset['jp_options'] as $option_to_reset ) {
805
						Jetpack_Options::delete_option( $option_to_reset );
806
					}
807
808
					foreach ( $options_to_reset['wp_options'] as $option_to_reset ) {
809
						delete_option( $option_to_reset );
810
					}
811
812
					// Reset to default modules
813
					$default_modules = Jetpack::get_default_modules();
814
					Jetpack::update_active_modules( $default_modules );
815
816
					// Jumpstart option is special
817
					Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
818
					return rest_ensure_response( array(
819
						'code' 	  => 'success',
820
						'message' => esc_html__( 'Jetpack options reset.', 'jetpack' ),
821
					) );
822
					break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
823
824
				case 'modules':
825
					$default_modules = Jetpack::get_default_modules();
826
					Jetpack::update_active_modules( $default_modules );
827
					return rest_ensure_response( array(
828
						'code' 	  => 'success',
829
						'message' => esc_html__( 'Modules reset to default.', 'jetpack' ),
830
					) );
831
					break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
832
833
				default:
834
					return new WP_Error( 'invalid_param', esc_html__( 'Invalid Parameter', 'jetpack' ), array( 'status' => 404 ) );
835
			}
836
		}
837
838
		return new WP_Error( 'required_param', esc_html__( 'Missing parameter "type".', 'jetpack' ), array( 'status' => 404 ) );
839
	}
840
841
	/**
842
	 * Toggles activation or deactivation of the JumpStart
843
	 *
844
	 * @since 4.3.0
845
	 *
846
	 * @param WP_REST_Request $data {
847
	 *     Array of parameters received by request.
848
	 * }
849
	 *
850
	 * @return bool|WP_Error True if toggling Jumpstart succeeded. Otherwise, a WP_Error instance with the corresponding error.
851
	 */
852
	public static function jumpstart_toggle( $data ) {
853
		$param = $data->get_json_params();
854
855
		if ( $param[ 'active' ] ) {
856
			return self::jumpstart_activate( $data );
857
		} else {
858
			return self::jumpstart_deactivate( $data );
859
		}
860
	}
861
862
	/**
863
	 * Activates a series of valid Jetpack modules and initializes some options.
864
	 *
865
	 * @since 4.3.0
866
	 *
867
	 * @param WP_REST_Request $data {
868
	 *     Array of parameters received by request.
869
	 * }
870
	 *
871
	 * @return bool|WP_Error True if Jumpstart succeeded. Otherwise, a WP_Error instance with the corresponding error.
872
	 */
873
	public static function jumpstart_activate( $data ) {
874
		$modules = Jetpack::get_available_modules();
875
		$activate_modules = array();
876
		foreach ( $modules as $module ) {
877
			$module_info = Jetpack::get_module( $module );
878
			if ( isset( $module_info['feature'] ) && is_array( $module_info['feature'] ) && in_array( 'Jumpstart', $module_info['feature'] ) ) {
879
				$activate_modules[] = $module;
880
			}
881
		}
882
883
		// Collect success/error messages like modules that are properly activated.
884
		$result = array(
885
			'activated_modules' => array(),
886
			'failed_modules'    => array(),
887
		);
888
889
		// Update the jumpstart option
890
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
891
			$result['jumpstart_activated'] = Jetpack_Options::update_option( 'jumpstart', 'jumpstart_activated' );
892
		}
893
894
		// Check for possible conflicting plugins
895
		$module_slugs_filtered = Jetpack::init()->filter_default_modules( $activate_modules );
896
897
		foreach ( $module_slugs_filtered as $module_slug ) {
898
			Jetpack::log( 'activate', $module_slug );
899
			if ( Jetpack::activate_module( $module_slug, false, false ) ) {
900
				$result['activated_modules'][] = $module_slug;
901
			} else {
902
				$result['failed_modules'][] = $module_slug;
903
			}
904
		}
905
906
		// Set the default sharing buttons and set to display on posts if none have been set.
907
		$sharing_services = get_option( 'sharing-services' );
908
		$sharing_options  = get_option( 'sharing-options' );
909
		if ( empty( $sharing_services['visible'] ) ) {
910
			// Default buttons to set
911
			$visible = array(
912
				'twitter',
913
				'facebook',
914
				'google-plus-1',
915
			);
916
			$hidden = array();
917
918
			// Set some sharing settings
919
			$sharing = new Sharing_Service();
920
			$sharing_options['global'] = array(
921
				'button_style'  => 'icon',
922
				'sharing_label' => $sharing->default_sharing_label,
923
				'open_links'    => 'same',
924
				'show'          => array( 'post' ),
925
				'custom'        => isset( $sharing_options['global']['custom'] ) ? $sharing_options['global']['custom'] : array()
926
			);
927
928
			$result['sharing_options']  = update_option( 'sharing-options', $sharing_options );
929
			$result['sharing_services'] = update_option( 'sharing-services', array( 'visible' => $visible, 'hidden' => $hidden ) );
930
		}
931
932
		// If all Jumpstart modules were activated
933
		if ( empty( $result['failed_modules'] ) ) {
934
			return rest_ensure_response( array(
935
				'code' 	  => 'success',
936
				'message' => esc_html__( 'Jumpstart done.', 'jetpack' ),
937
				'data'    => $result,
938
			) );
939
		}
940
941
		return new WP_Error( 'jumpstart_failed', esc_html( sprintf( _n( 'Jumpstart failed activating this module: %s.', 'Jumpstart failed activating these modules: %s.', count( $result['failed_modules'] ), 'jetpack' ), join( ', ', $result['failed_modules'] ) ) ), array( 'status' => 400 ) );
942
	}
943
944
	/**
945
	 * Dismisses Jumpstart so user is not prompted to go through it again.
946
	 *
947
	 * @since 4.3.0
948
	 *
949
	 * @param WP_REST_Request $data {
950
	 *     Array of parameters received by request.
951
	 * }
952
	 *
953
	 * @return bool|WP_Error True if Jumpstart was disabled or was nothing to dismiss. Otherwise, a WP_Error instance with a message.
954
	 */
955
	public static function jumpstart_deactivate( $data ) {
956
957
		// If dismissed, flag the jumpstart option as such.
958
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
959
			if ( Jetpack_Options::update_option( 'jumpstart', 'jumpstart_dismissed' ) ) {
960
				return rest_ensure_response( array(
961
					'code' 	  => 'success',
962
					'message' => esc_html__( 'Jumpstart dismissed.', 'jetpack' ),
963
				) );
964
			} else {
965
				return new WP_Error( 'jumpstart_failed_dismiss', esc_html__( 'Jumpstart could not be dismissed.', 'jetpack' ), array( 'status' => 400 ) );
966
			}
967
		}
968
969
		// If this was not a new connection and there was nothing to dismiss, don't fail.
970
		return rest_ensure_response( array(
971
			'code' 	  => 'success',
972
			'message' => esc_html__( 'Nothing to dismiss. This was not a new connection.', 'jetpack' ),
973
		) );
974
	}
975
976
	/**
977
	 * Get the query parameters to update module options or general settings.
978
	 *
979
	 * @since 4.3.0
980
	 * @since 4.4.0 Accepts a $selector parameter.
981
	 *
982
	 * @param string $selector Selects a set of options to update, Can be empty, a module slug or 'any'.
983
	 *
984
	 * @return array
985
	 */
986
	public static function get_updateable_parameters( $selector = '' ) {
987
		$parameters = array(
988
			'context'     => array(
989
				'default' => 'edit',
990
			),
991
		);
992
993
		return array_merge( $parameters, self::get_updateable_data_list( $selector ) );
994
	}
995
996
	/**
997
	 * Returns a list of module options or general settings that can be updated.
998
	 *
999
	 * @since 4.3.0
1000
	 * @since 4.4.0 Accepts 'any' as a parameter which will make it return the entire list.
1001
	 *
1002
	 * @param string|array $selector Module slug, 'any', or an array of parameters.
1003
	 *                               If empty, it's assumed we're updating a module and we'll try to get its slug.
1004
	 *                               If 'any' the full list is returned.
1005
	 *                               If it's an array of parameters, includes the elements by matching keys.
1006
	 *
1007
	 * @return array
1008
	 */
1009
	public static function get_updateable_data_list( $selector = '' ) {
1010
1011
		$options = array(
1012
1013
			// Carousel
1014
			'carousel_background_color' => array(
1015
				'description'       => esc_html__( 'Background color.', 'jetpack' ),
1016
				'type'              => 'string',
1017
				'default'           => 'black',
1018
				'enum'              => array(
1019
					'black' => esc_html__( 'Black', 'jetpack' ),
1020
					'white' => esc_html__( 'White', 'jetpack' ),
1021
				),
1022
				'validate_callback' => __CLASS__ . '::validate_list_item',
1023
				'jp_group'          => 'carousel',
1024
			),
1025
			'carousel_display_exif' => array(
1026
				'description'       => wp_kses( sprintf( __( 'Show photo metadata (<a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) ), array( 'a' => array( 'href' => true, 'target' => true ) ) ),
1027
				'type'              => 'boolean',
1028
				'default'           => 0,
1029
				'validate_callback' => __CLASS__ . '::validate_boolean',
1030
				'jp_group'          => 'carousel',
1031
			),
1032
1033
			// Comments
1034
			'highlander_comment_form_prompt' => array(
1035
				'description'       => esc_html__( 'Greeting Text', 'jetpack' ),
1036
				'type'              => 'string',
1037
				'default'           => esc_html__( 'Leave a Reply', 'jetpack' ),
1038
				'sanitize_callback' => 'sanitize_text_field',
1039
				'jp_group'          => 'comments',
1040
			),
1041
			'jetpack_comment_form_color_scheme' => array(
1042
				'description'       => esc_html__( "Color Scheme", 'jetpack' ),
1043
				'type'              => 'string',
1044
				'default'           => 'light',
1045
				'enum'              => array(
1046
					'light'       => esc_html__( 'Light', 'jetpack' ),
1047
					'dark'        => esc_html__( 'Dark', 'jetpack' ),
1048
					'transparent' => esc_html__( 'Transparent', 'jetpack' ),
1049
				),
1050
				'validate_callback' => __CLASS__ . '::validate_list_item',
1051
				'jp_group'          => 'comments',
1052
			),
1053
1054
			// Custom Content Types
1055
			'jetpack_portfolio' => array(
1056
				'description'       => esc_html__( 'Enable or disable Jetpack portfolio post type.', 'jetpack' ),
1057
				'type'              => 'boolean',
1058
				'default'           => 0,
1059
				'validate_callback' => __CLASS__ . '::validate_boolean',
1060
				'jp_group'          => 'custom-content-types',
1061
			),
1062
			'jetpack_portfolio_posts_per_page' => array(
1063
				'description'       => esc_html__( 'Number of entries to show at most in Portfolio pages.', 'jetpack' ),
1064
				'type'              => 'integer',
1065
				'default'           => 10,
1066
				'validate_callback' => __CLASS__ . '::validate_posint',
1067
				'jp_group'          => 'custom-content-types',
1068
			),
1069
			'jetpack_testimonial' => array(
1070
				'description'       => esc_html__( 'Enable or disable Jetpack testimonial post type.', 'jetpack' ),
1071
				'type'              => 'boolean',
1072
				'default'           => 0,
1073
				'validate_callback' => __CLASS__ . '::validate_boolean',
1074
				'jp_group'          => 'custom-content-types',
1075
			),
1076
			'jetpack_testimonial_posts_per_page' => array(
1077
				'description'       => esc_html__( 'Number of entries to show at most in Testimonial pages.', 'jetpack' ),
1078
				'type'              => 'integer',
1079
				'default'           => 10,
1080
				'validate_callback' => __CLASS__ . '::validate_posint',
1081
				'jp_group'          => 'custom-content-types',
1082
			),
1083
1084
			// Galleries
1085
			'tiled_galleries' => array(
1086
				'description'       => esc_html__( 'Display all your gallery pictures in a cool mosaic.', 'jetpack' ),
1087
				'type'              => 'boolean',
1088
				'default'           => 0,
1089
				'validate_callback' => __CLASS__ . '::validate_boolean',
1090
				'jp_group'          => 'tiled-gallery',
1091
			),
1092
1093
			'gravatar_disable_hovercards' => array(
1094
				'description'       => esc_html__( "View people's profiles when you mouse over their Gravatars", 'jetpack' ),
1095
				'type'              => 'string',
1096
				'default'           => 'enabled',
1097
				// Not visible. This is used as the checkbox value.
1098
				'enum'              => array(
1099
					'enabled'  => esc_html__( 'Enabled', 'jetpack' ),
1100
					'disabled' => esc_html__( 'Disabled', 'jetpack' ),
1101
				),
1102
				'validate_callback' => __CLASS__ . '::validate_list_item',
1103
				'jp_group'          => 'gravatar-hovercards',
1104
			),
1105
1106
			// Infinite Scroll
1107
			'infinite_scroll' => array(
1108
				'description'       => esc_html__( 'To infinity and beyond', 'jetpack' ),
1109
				'type'              => 'boolean',
1110
				'default'           => 1,
1111
				'validate_callback' => __CLASS__ . '::validate_boolean',
1112
				'jp_group'          => 'infinite-scroll',
1113
			),
1114
			'infinite_scroll_google_analytics' => array(
1115
				'description'       => esc_html__( 'Use Google Analytics with Infinite Scroll', 'jetpack' ),
1116
				'type'              => 'boolean',
1117
				'default'           => 0,
1118
				'validate_callback' => __CLASS__ . '::validate_boolean',
1119
				'jp_group'          => 'infinite-scroll',
1120
			),
1121
1122
			// Likes
1123
			'wpl_default' => array(
1124
				'description'       => esc_html__( 'WordPress.com Likes are', 'jetpack' ),
1125
				'type'              => 'string',
1126
				'default'           => 'on',
1127
				'enum'              => array(
1128
					'on'  => esc_html__( 'On for all posts', 'jetpack' ),
1129
					'off' => esc_html__( 'Turned on per post', 'jetpack' ),
1130
				),
1131
				'validate_callback' => __CLASS__ . '::validate_list_item',
1132
				'jp_group'          => 'likes',
1133
			),
1134
			'social_notifications_like' => array(
1135
				'description'       => esc_html__( 'Send email notification when someone likes a post', 'jetpack' ),
1136
				'type'              => 'boolean',
1137
				'default'           => 1,
1138
				'validate_callback' => __CLASS__ . '::validate_boolean',
1139
				'jp_group'          => 'likes',
1140
			),
1141
1142
			// Markdown
1143
			'wpcom_publish_comments_with_markdown' => array(
1144
				'description'       => esc_html__( 'Use Markdown for comments.', 'jetpack' ),
1145
				'type'              => 'boolean',
1146
				'default'           => 0,
1147
				'validate_callback' => __CLASS__ . '::validate_boolean',
1148
				'jp_group'          => 'markdown',
1149
			),
1150
1151
			// Mobile Theme
1152
			'wp_mobile_excerpt' => array(
1153
				'description'       => esc_html__( 'Excerpts', 'jetpack' ),
1154
				'type'              => 'string',
1155
				'default'           => 'disabled',
1156
				'enum'              => array(
1157
					'enabled'  => esc_html__( 'Enable excerpts on front page and on archive pages', 'jetpack' ),
1158
					'disabled' => esc_html__( 'Show full posts on front page and on archive pages', 'jetpack' ),
1159
				),
1160
				'validate_callback' => __CLASS__ . '::validate_list_item',
1161
				'jp_group'          => 'minileven',
1162
			),
1163
			'wp_mobile_featured_images' => array(
1164
				'description'       => esc_html__( 'Featured Images', 'jetpack' ),
1165
				'type'              => 'string',
1166
				'default'           => 'disabled',
1167
				'enum'              => array(
1168
					'enabled'  => esc_html__( 'Display featured images', 'jetpack' ),
1169
					'disabled' => esc_html__( 'Hide all featured images', 'jetpack' ),
1170
				),
1171
				'validate_callback' => __CLASS__ . '::validate_list_item',
1172
				'jp_group'          => 'minileven',
1173
			),
1174
			'wp_mobile_app_promos' => array(
1175
				'description'       => esc_html__( 'Show a promo for the WordPress mobile apps in the footer of the mobile theme.', 'jetpack' ),
1176
				'type'              => 'boolean',
1177
				'default'           => 0,
1178
				'validate_callback' => __CLASS__ . '::validate_boolean',
1179
				'jp_group'          => 'minileven',
1180
			),
1181
1182
			// Monitor
1183
			'monitor_receive_notifications' => array(
1184
				'description'       => esc_html__( 'Receive Monitor Email Notifications.', 'jetpack' ),
1185
				'type'              => 'boolean',
1186
				'default'           => 0,
1187
				'validate_callback' => __CLASS__ . '::validate_boolean',
1188
				'jp_group'          => 'monitor',
1189
			),
1190
1191
			// Post by Email
1192
			'post_by_email_address' => array(
1193
				'description'       => esc_html__( 'Email Address', 'jetpack' ),
1194
				'type'              => 'string',
1195
				'default'           => 'noop',
1196
				'enum'              => array(
1197
					'noop'       => '',
1198
					'create'     => esc_html__( 'Create Post by Email address', 'jetpack' ),
1199
					'regenerate' => esc_html__( 'Regenerate Post by Email address', 'jetpack' ),
1200
					'delete'     => esc_html__( 'Delete Post by Email address', 'jetpack' ),
1201
				),
1202
				'validate_callback' => __CLASS__ . '::validate_list_item',
1203
				'jp_group'          => 'post-by-email',
1204
			),
1205
1206
			// Protect
1207
			'jetpack_protect_key' => array(
1208
				'description'       => esc_html__( 'Protect API key', 'jetpack' ),
1209
				'type'              => 'string',
1210
				'default'           => '',
1211
				'validate_callback' => __CLASS__ . '::validate_alphanum',
1212
				'jp_group'          => 'protect',
1213
			),
1214
			'jetpack_protect_global_whitelist' => array(
1215
				'description'       => esc_html__( 'Protect global whitelist', 'jetpack' ),
1216
				'type'              => 'string',
1217
				'default'           => '',
1218
				'validate_callback' => __CLASS__ . '::validate_string',
1219
				'sanitize_callback' => 'esc_textarea',
1220
				'jp_group'          => 'protect',
1221
			),
1222
1223
			// Sharing
1224
			'sharing_services' => array(
1225
				'description'       => esc_html__( 'Enabled Services and those hidden behind a button', 'jetpack' ),
1226
				'type'              => 'array',
1227
				'default'           => array(
1228
					'visible' => array( 'twitter', 'facebook', 'google-plus-1' ),
1229
					'hidden'  => array(),
1230
				),
1231
				'validate_callback' => __CLASS__ . '::validate_services',
1232
				'jp_group'          => 'sharedaddy',
1233
			),
1234
			'button_style' => array(
1235
				'description'       => esc_html__( 'Button Style', 'jetpack' ),
1236
				'type'              => 'string',
1237
				'default'           => 'icon',
1238
				'enum'              => array(
1239
					'icon-text' => esc_html__( 'Icon + text', 'jetpack' ),
1240
					'icon'      => esc_html__( 'Icon only', 'jetpack' ),
1241
					'text'      => esc_html__( 'Text only', 'jetpack' ),
1242
					'official'  => esc_html__( 'Official buttons', 'jetpack' ),
1243
				),
1244
				'validate_callback' => __CLASS__ . '::validate_list_item',
1245
				'jp_group'          => 'sharedaddy',
1246
			),
1247
			'sharing_label' => array(
1248
				'description'       => esc_html__( 'Sharing Label', 'jetpack' ),
1249
				'type'              => 'string',
1250
				'default'           => '',
1251
				'validate_callback' => __CLASS__ . '::validate_string',
1252
				'sanitize_callback' => 'esc_html',
1253
				'jp_group'          => 'sharedaddy',
1254
			),
1255
			'show' => array(
1256
				'description'       => esc_html__( 'Views where buttons are shown', 'jetpack' ),
1257
				'type'              => 'array',
1258
				'default'           => array( 'post' ),
1259
				'validate_callback' => __CLASS__ . '::validate_sharing_show',
1260
				'jp_group'          => 'sharedaddy',
1261
			),
1262
			'jetpack-twitter-cards-site-tag' => array(
1263
				'description'       => esc_html__( "The Twitter username of the owner of this site's domain.", 'jetpack' ),
1264
				'type'              => 'string',
1265
				'default'           => '',
1266
				'validate_callback' => __CLASS__ . '::validate_twitter_username',
1267
				'sanitize_callback' => 'esc_html',
1268
				'jp_group'          => 'sharedaddy',
1269
			),
1270
			'sharedaddy_disable_resources' => array(
1271
				'description'       => esc_html__( 'Disable CSS and JS', 'jetpack' ),
1272
				'type'              => 'boolean',
1273
				'default'           => 0,
1274
				'validate_callback' => __CLASS__ . '::validate_boolean',
1275
				'jp_group'          => 'sharedaddy',
1276
			),
1277
			'custom' => array(
1278
				'description'       => esc_html__( 'Custom sharing services added by user.', 'jetpack' ),
1279
				'type'              => 'array',
1280
				'default'           => array(
1281
					'sharing_name' => '',
1282
					'sharing_url'  => '',
1283
					'sharing_icon' => '',
1284
				),
1285
				'validate_callback' => __CLASS__ . '::validate_custom_service',
1286
				'jp_group'          => 'sharedaddy',
1287
			),
1288
			// Not an option, but an action that can be perfomed on the list of custom services passing the service ID.
1289
			'sharing_delete_service' => array(
1290
				'description'       => esc_html__( 'Delete custom sharing service.', 'jetpack' ),
1291
				'type'              => 'string',
1292
				'default'           => '',
1293
				'validate_callback' => __CLASS__ . '::validate_custom_service_id',
1294
				'jp_group'          => 'sharedaddy',
1295
			),
1296
1297
			// SSO
1298
			'jetpack_sso_require_two_step' => array(
1299
				'description'       => esc_html__( 'Require Two-Step Authentication', 'jetpack' ),
1300
				'type'              => 'boolean',
1301
				'default'           => 0,
1302
				'validate_callback' => __CLASS__ . '::validate_boolean',
1303
				'jp_group'          => 'sso',
1304
			),
1305
			'jetpack_sso_match_by_email' => array(
1306
				'description'       => esc_html__( 'Match by Email', 'jetpack' ),
1307
				'type'              => 'boolean',
1308
				'default'           => 0,
1309
				'validate_callback' => __CLASS__ . '::validate_boolean',
1310
				'jp_group'          => 'sso',
1311
			),
1312
1313
			// Subscriptions
1314
			'stb_enabled' => array(
1315
				'description'       => esc_html__( "Show a <em>'follow blog'</em> option in the comment form", 'jetpack' ),
1316
				'type'              => 'boolean',
1317
				'default'           => 1,
1318
				'validate_callback' => __CLASS__ . '::validate_boolean',
1319
				'jp_group'          => 'subscriptions',
1320
			),
1321
			'stc_enabled' => array(
1322
				'description'       => esc_html__( "Show a <em>'follow comments'</em> option in the comment form", 'jetpack' ),
1323
				'type'              => 'boolean',
1324
				'default'           => 1,
1325
				'validate_callback' => __CLASS__ . '::validate_boolean',
1326
				'jp_group'          => 'subscriptions',
1327
			),
1328
1329
			// Related Posts
1330
			'show_headline' => array(
1331
				'description'       => esc_html__( 'Show a "Related" header to more clearly separate the related section from posts', 'jetpack' ),
1332
				'type'              => 'boolean',
1333
				'default'           => 1,
1334
				'validate_callback' => __CLASS__ . '::validate_boolean',
1335
				'jp_group'          => 'related-posts',
1336
			),
1337
			'show_thumbnails' => array(
1338
				'description'       => esc_html__( 'Use a large and visually striking layout', 'jetpack' ),
1339
				'type'              => 'boolean',
1340
				'default'           => 0,
1341
				'validate_callback' => __CLASS__ . '::validate_boolean',
1342
				'jp_group'          => 'related-posts',
1343
			),
1344
1345
			// Spelling and Grammar - After the Deadline
1346
			'onpublish' => array(
1347
				'description'       => esc_html__( 'Proofread when a post or page is first published.', 'jetpack' ),
1348
				'type'              => 'boolean',
1349
				'default'           => 0,
1350
				'validate_callback' => __CLASS__ . '::validate_boolean',
1351
				'jp_group'          => 'after-the-deadline',
1352
			),
1353
			'onupdate' => array(
1354
				'description'       => esc_html__( 'Proofread when a post or page is updated.', 'jetpack' ),
1355
				'type'              => 'boolean',
1356
				'default'           => 0,
1357
				'validate_callback' => __CLASS__ . '::validate_boolean',
1358
				'jp_group'          => 'after-the-deadline',
1359
			),
1360
			'Bias Language' => array(
1361
				'description'       => esc_html__( 'Bias Language', 'jetpack' ),
1362
				'type'              => 'boolean',
1363
				'default'           => 0,
1364
				'validate_callback' => __CLASS__ . '::validate_boolean',
1365
				'jp_group'          => 'after-the-deadline',
1366
			),
1367
			'Cliches' => array(
1368
				'description'       => esc_html__( 'Clichés', 'jetpack' ),
1369
				'type'              => 'boolean',
1370
				'default'           => 0,
1371
				'validate_callback' => __CLASS__ . '::validate_boolean',
1372
				'jp_group'          => 'after-the-deadline',
1373
			),
1374
			'Complex Expression' => array(
1375
				'description'       => esc_html__( 'Complex Phrases', 'jetpack' ),
1376
				'type'              => 'boolean',
1377
				'default'           => 0,
1378
				'validate_callback' => __CLASS__ . '::validate_boolean',
1379
				'jp_group'          => 'after-the-deadline',
1380
			),
1381
			'Diacritical Marks' => array(
1382
				'description'       => esc_html__( 'Diacritical Marks', 'jetpack' ),
1383
				'type'              => 'boolean',
1384
				'default'           => 0,
1385
				'validate_callback' => __CLASS__ . '::validate_boolean',
1386
				'jp_group'          => 'after-the-deadline',
1387
			),
1388
			'Double Negative' => array(
1389
				'description'       => esc_html__( 'Double Negatives', 'jetpack' ),
1390
				'type'              => 'boolean',
1391
				'default'           => 0,
1392
				'validate_callback' => __CLASS__ . '::validate_boolean',
1393
				'jp_group'          => 'after-the-deadline',
1394
			),
1395
			'Hidden Verbs' => array(
1396
				'description'       => esc_html__( 'Hidden Verbs', 'jetpack' ),
1397
				'type'              => 'boolean',
1398
				'default'           => 0,
1399
				'validate_callback' => __CLASS__ . '::validate_boolean',
1400
				'jp_group'          => 'after-the-deadline',
1401
			),
1402
			'Jargon Language' => array(
1403
				'description'       => esc_html__( 'Jargon', 'jetpack' ),
1404
				'type'              => 'boolean',
1405
				'default'           => 0,
1406
				'validate_callback' => __CLASS__ . '::validate_boolean',
1407
				'jp_group'          => 'after-the-deadline',
1408
			),
1409
			'Passive voice' => array(
1410
				'description'       => esc_html__( 'Passive Voice', 'jetpack' ),
1411
				'type'              => 'boolean',
1412
				'default'           => 0,
1413
				'validate_callback' => __CLASS__ . '::validate_boolean',
1414
				'jp_group'          => 'after-the-deadline',
1415
			),
1416
			'Phrases to Avoid' => array(
1417
				'description'       => esc_html__( 'Phrases to Avoid', 'jetpack' ),
1418
				'type'              => 'boolean',
1419
				'default'           => 0,
1420
				'validate_callback' => __CLASS__ . '::validate_boolean',
1421
				'jp_group'          => 'after-the-deadline',
1422
			),
1423
			'Redundant Expression' => array(
1424
				'description'       => esc_html__( 'Redundant Phrases', 'jetpack' ),
1425
				'type'              => 'boolean',
1426
				'default'           => 0,
1427
				'validate_callback' => __CLASS__ . '::validate_boolean',
1428
				'jp_group'          => 'after-the-deadline',
1429
			),
1430
			'guess_lang' => array(
1431
				'description'       => esc_html__( 'Use automatically detected language to proofread posts and pages', 'jetpack' ),
1432
				'type'              => 'boolean',
1433
				'default'           => 0,
1434
				'validate_callback' => __CLASS__ . '::validate_boolean',
1435
				'jp_group'          => 'after-the-deadline',
1436
			),
1437
			'ignored_phrases' => array(
1438
				'description'       => esc_html__( 'Add Phrase to be ignored', 'jetpack' ),
1439
				'type'              => 'string',
1440
				'default'           => '',
1441
				'sanitize_callback' => 'esc_html',
1442
				'jp_group'          => 'after-the-deadline',
1443
			),
1444
			'unignore_phrase' => array(
1445
				'description'       => esc_html__( 'Remove Phrase from being ignored', 'jetpack' ),
1446
				'type'              => 'string',
1447
				'default'           => '',
1448
				'sanitize_callback' => 'esc_html',
1449
				'jp_group'          => 'after-the-deadline',
1450
			),
1451
1452
			// Verification Tools
1453
			'google' => array(
1454
				'description'       => esc_html__( 'Google Search Console', 'jetpack' ),
1455
				'type'              => 'string',
1456
				'default'           => '',
1457
				'validate_callback' => __CLASS__ . '::validate_alphanum',
1458
				'jp_group'          => 'verification-tools',
1459
			),
1460
			'bing' => array(
1461
				'description'       => esc_html__( 'Bing Webmaster Center', 'jetpack' ),
1462
				'type'              => 'string',
1463
				'default'           => '',
1464
				'validate_callback' => __CLASS__ . '::validate_alphanum',
1465
				'jp_group'          => 'verification-tools',
1466
			),
1467
			'pinterest' => array(
1468
				'description'       => esc_html__( 'Pinterest Site Verification', 'jetpack' ),
1469
				'type'              => 'string',
1470
				'default'           => '',
1471
				'validate_callback' => __CLASS__ . '::validate_alphanum',
1472
				'jp_group'          => 'verification-tools',
1473
			),
1474
			'yandex' => array(
1475
				'description'        => esc_html__( 'Yandex Site Verification', 'jetpack' ),
1476
				'type'               => 'string',
1477
				'default'            => '',
1478
				'validate_callback'  => __CLASS__ . '::validate_alphanum',
1479
				'jp_group'          => 'verification-tools',
1480
			),
1481
1482
			// Stats
1483
			'admin_bar' => array(
1484
				'description'       => esc_html__( 'Put a chart showing 48 hours of views in the admin bar.', 'jetpack' ),
1485
				'type'              => 'boolean',
1486
				'default'           => 1,
1487
				'validate_callback' => __CLASS__ . '::validate_boolean',
1488
				'jp_group'          => 'stats',
1489
			),
1490
			'roles' => array(
1491
				'description'       => esc_html__( 'Select the roles that will be able to view stats reports.', 'jetpack' ),
1492
				'type'              => 'array',
1493
				'default'           => array( 'administrator' ),
1494
				'validate_callback' => __CLASS__ . '::validate_stats_roles',
1495
				'sanitize_callback' => __CLASS__ . '::sanitize_stats_allowed_roles',
1496
				'jp_group'          => 'stats',
1497
			),
1498
			'count_roles' => array(
1499
				'description'       => esc_html__( 'Count the page views of registered users who are logged in.', 'jetpack' ),
1500
				'type'              => 'array',
1501
				'default'           => array( 'administrator' ),
1502
				'validate_callback' => __CLASS__ . '::validate_stats_roles',
1503
				'jp_group'          => 'stats',
1504
			),
1505
			'blog_id' => array(
1506
				'description'       => esc_html__( 'Blog ID.', 'jetpack' ),
1507
				'type'              => 'boolean',
1508
				'default'           => 0,
1509
				'validate_callback' => __CLASS__ . '::validate_boolean',
1510
				'jp_group'          => 'stats',
1511
			),
1512
			'do_not_track' => array(
1513
				'description'       => esc_html__( 'Do not track.', 'jetpack' ),
1514
				'type'              => 'boolean',
1515
				'default'           => 1,
1516
				'validate_callback' => __CLASS__ . '::validate_boolean',
1517
				'jp_group'          => 'stats',
1518
			),
1519
			'hide_smile' => array(
1520
				'description'       => esc_html__( 'Hide the stats smiley face image.', 'jetpack' ),
1521
				'type'              => 'boolean',
1522
				'default'           => 1,
1523
				'validate_callback' => __CLASS__ . '::validate_boolean',
1524
				'jp_group'          => 'stats',
1525
			),
1526
			'version' => array(
1527
				'description'       => esc_html__( 'Version.', 'jetpack' ),
1528
				'type'              => 'integer',
1529
				'default'           => 9,
1530
				'validate_callback' => __CLASS__ . '::validate_posint',
1531
				'jp_group'          => 'stats',
1532
			),
1533
1534
			// Settings - Not a module
1535
			self::holiday_snow_option_name() => array(
1536
				'description'       => '',
1537
				'type'              => 'boolean',
1538
				'default'           => 0,
1539
				'validate_callback' => __CLASS__ . '::validate_boolean',
1540
				'jp_group'          => 'settings',
1541
			),
1542
1543
		);
1544
1545
		// Add modules to list so they can be toggled
1546
		$modules = Jetpack::get_available_modules();
1547
		if ( is_array( $modules ) && ! empty( $modules ) ) {
1548
			$module_args = array(
1549
				'description'       => '',
1550
				'type'              => 'boolean',
1551
				'default'           => 0,
1552
				'validate_callback' => __CLASS__ . '::validate_boolean',
1553
				'jp_group'          => 'modules',
1554
			);
1555
			foreach( $modules as $module ) {
1556
				$options[ $module ] = $module_args;
1557
			}
1558
		}
1559
1560
		if ( is_array( $selector ) ) {
1561
1562
			// Return only those options whose keys match $selector keys
1563
			return array_intersect_key( $options, $selector );
1564
		}
1565
1566
		if ( 'any' === $selector ) {
1567
1568
			// Toggle module or update any module option or any general setting
1569
			return $options;
1570
		}
1571
1572
		// We're updating the options for a single module.
1573
		if ( empty( $selector ) ) {
1574
			$selector = self::get_module_requested();
1575
		}
1576
		$selected = array();
1577
		foreach ( $options as $option => $attributes ) {
1578
1579
			// Not adding an isset( $attributes['jp_group'] ) because if it's not set, it must be fixed, otherwise options will fail.
1580
			if ( $selector === $attributes['jp_group'] ) {
1581
				$selected[ $option ] = $attributes;
1582
			}
1583
		}
1584
		return $selected;
1585
	}
1586
1587
	/**
1588
	 * Validates that the parameter is either a pure boolean or a numeric string that can be mapped to a boolean.
1589
	 *
1590
	 * @since 4.3.0
1591
	 *
1592
	 * @param string|bool $value Value to check.
1593
	 * @param WP_REST_Request $request
1594
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1595
	 *
1596
	 * @return bool
1597
	 */
1598
	public static function validate_boolean( $value, $request, $param ) {
1599
		if ( ! is_bool( $value ) && ! ( ( ctype_digit( $value ) || is_numeric( $value ) ) && in_array( $value, array( 0, 1 ) ) ) ) {
1600
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be true, false, 0 or 1.', 'jetpack' ), $param ) );
1601
		}
1602
		return true;
1603
	}
1604
1605
	/**
1606
	 * Validates that the parameter is a positive integer.
1607
	 *
1608
	 * @since 4.3.0
1609
	 *
1610
	 * @param int $value Value to check.
1611
	 * @param WP_REST_Request $request
1612
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1613
	 *
1614
	 * @return bool
1615
	 */
1616
	public static function validate_posint( $value = 0, $request, $param ) {
1617 View Code Duplication
		if ( ! is_numeric( $value ) || $value <= 0 ) {
1618
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a positive integer.', 'jetpack' ), $param ) );
1619
		}
1620
		return true;
1621
	}
1622
1623
	/**
1624
	 * Validates that the parameter belongs to a list of admitted values.
1625
	 *
1626
	 * @since 4.3.0
1627
	 *
1628
	 * @param string $value Value to check.
1629
	 * @param WP_REST_Request $request
1630
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1631
	 *
1632
	 * @return bool
1633
	 */
1634
	public static function validate_list_item( $value = '', $request, $param ) {
1635
		$attributes = $request->get_attributes();
1636
		if ( ! isset( $attributes['args'][ $param ] ) || ! is_array( $attributes['args'][ $param ] ) ) {
1637
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s not recognized', 'jetpack' ), $param ) );
1638
		}
1639
		$args = $attributes['args'][ $param ];
1640
		if ( ! empty( $args['enum'] ) ) {
1641
1642
			// If it's an associative array, use the keys to check that the value is among those admitted.
1643
			$enum = ( count( array_filter( array_keys( $args['enum'] ), 'is_string' ) ) > 0 ) ? array_keys( $args['enum'] ) : $args['enum'];
1644 View Code Duplication
			if ( ! in_array( $value, $enum ) ) {
1645
				return new WP_Error( 'invalid_param_value', sprintf(
1646
					/* Translators: first variable is the parameter passed to endpoint that holds the list item, the second is a list of admitted values. */
1647
					esc_html__( '%1$s must be one of %2$s', 'jetpack' ), $param, implode( ', ', $enum )
1648
				) );
1649
			}
1650
		}
1651
		return true;
1652
	}
1653
1654
	/**
1655
	 * Validates that the parameter belongs to a list of admitted values.
1656
	 *
1657
	 * @since 4.3.0
1658
	 *
1659
	 * @param string $value Value to check.
1660
	 * @param WP_REST_Request $request
1661
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1662
	 *
1663
	 * @return bool
1664
	 */
1665
	public static function validate_module_list( $value = '', $request, $param ) {
1666
		if ( ! is_array( $value ) ) {
1667
			return new WP_Error( 'invalid_param_value', sprintf( esc_html__( '%s must be an array', 'jetpack' ), $param ) );
1668
		}
1669
1670
		$modules = Jetpack::get_available_modules();
1671
1672 View Code Duplication
		if ( count( array_intersect( $value, $modules ) ) != count( $value ) ) {
1673
			return new WP_Error( 'invalid_param_value', sprintf( esc_html__( '%s must be a list of valid modules', 'jetpack' ), $param ) );
1674
		}
1675
1676
		return true;
1677
	}
1678
1679
	/**
1680
	 * Validates that the parameter is an alphanumeric or empty string (to be able to clear the field).
1681
	 *
1682
	 * @since 4.3.0
1683
	 *
1684
	 * @param string $value Value to check.
1685
	 * @param WP_REST_Request $request
1686
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1687
	 *
1688
	 * @return bool
1689
	 */
1690
	public static function validate_alphanum( $value = '', $request, $param ) {
1691 View Code Duplication
		if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/[a-z0-9]+/i', $value ) ) ) {
1692
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
1693
		}
1694
		return true;
1695
	}
1696
1697
	/**
1698
	 * Validates that the parameter is among the roles allowed for Stats.
1699
	 *
1700
	 * @since 4.3.0
1701
	 *
1702
	 * @param string|bool $value Value to check.
1703
	 * @param WP_REST_Request $request
1704
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1705
	 *
1706
	 * @return bool
1707
	 */
1708
	public static function validate_stats_roles( $value, $request, $param ) {
1709
		if ( ! empty( $value ) && ! array_intersect( self::$stats_roles, $value ) ) {
1710
			return new WP_Error( 'invalid_param', sprintf(
1711
				/* Translators: first variable is the name of a parameter passed to endpoint holding the role that will be checked, the second is a list of roles allowed to see stats. The parameter is checked against this list. */
1712
				esc_html__( '%1$s must be %2$s.', 'jetpack' ), $param, join( ', ', self::$stats_roles )
1713
			) );
1714
		}
1715
		return true;
1716
	}
1717
1718
	/**
1719
	 * Validates that the parameter is among the views where the Sharing can be displayed.
1720
	 *
1721
	 * @since 4.3.0
1722
	 *
1723
	 * @param string|bool $value Value to check.
1724
	 * @param WP_REST_Request $request
1725
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1726
	 *
1727
	 * @return bool
1728
	 */
1729
	public static function validate_sharing_show( $value, $request, $param ) {
1730
		$views = array( 'index', 'post', 'page', 'attachment', 'jetpack-portfolio' );
1731 View Code Duplication
		if ( ! array_intersect( $views, $value ) ) {
1732
			return new WP_Error( 'invalid_param', sprintf(
1733
				/* Translators: first variable is the name of a parameter passed to endpoint holding the post type where Sharing will be displayed, the second is a list of post types where Sharing can be displayed */
1734
				esc_html__( '%1$s must be %2$s.', 'jetpack' ), $param, join( ', ', $views )
1735
			) );
1736
		}
1737
		return true;
1738
	}
1739
1740
	/**
1741
	 * Validates that the parameter is among the views where the Sharing can be displayed.
1742
	 *
1743
	 * @since 4.3.0
1744
	 *
1745
	 * @param string|bool $value {
1746
	 *     Value to check received by request.
1747
	 *
1748
	 *     @type array $visible List of slug of services to share to that are displayed directly in the page.
1749
	 *     @type array $hidden  List of slug of services to share to that are concealed in a folding menu.
1750
	 * }
1751
	 * @param WP_REST_Request $request
1752
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1753
	 *
1754
	 * @return bool
1755
	 */
1756
	public static function validate_services( $value, $request, $param ) {
1757 View Code Duplication
		if ( ! is_array( $value ) || ! isset( $value['visible'] ) || ! isset( $value['hidden'] ) ) {
1758
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array with visible and hidden items.', 'jetpack' ), $param ) );
1759
		}
1760
1761
		// Allow to clear everything.
1762
		if ( empty( $value['visible'] ) && empty( $value['hidden'] ) ) {
1763
			return true;
1764
		}
1765
1766 View Code Duplication
		if ( ! class_exists( 'Sharing_Service' ) && ! @include( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
1767
			return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
1768
		}
1769
		$sharer = new Sharing_Service();
1770
		$services = array_keys( $sharer->get_all_services() );
1771
1772
		if (
1773
			( ! empty( $value['visible'] ) && ! array_intersect( $value['visible'], $services ) )
1774
			||
1775
			( ! empty( $value['hidden'] ) && ! array_intersect( $value['hidden'], $services ) ) )
1776
		{
1777
			return new WP_Error( 'invalid_param', sprintf(
1778
				/* Translators: placeholder 1 is a parameter holding the services passed to endpoint, placeholder 2 is a list of all Jetpack Sharing services */
1779
				esc_html__( '%1$s visible and hidden items must be a list of %2$s.', 'jetpack' ), $param, join( ', ', $services )
1780
			) );
1781
		}
1782
		return true;
1783
	}
1784
1785
	/**
1786
	 * Validates that the parameter has enough information to build a custom sharing button.
1787
	 *
1788
	 * @since 4.3.0
1789
	 *
1790
	 * @param string|bool $value Value to check.
1791
	 * @param WP_REST_Request $request
1792
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1793
	 *
1794
	 * @return bool
1795
	 */
1796
	public static function validate_custom_service( $value, $request, $param ) {
1797 View Code Duplication
		if ( ! is_array( $value ) || ! isset( $value['sharing_name'] ) || ! isset( $value['sharing_url'] ) || ! isset( $value['sharing_icon'] ) ) {
1798
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an array with sharing name, url and icon.', 'jetpack' ), $param ) );
1799
		}
1800
1801
		// Allow to clear everything.
1802
		if ( empty( $value['sharing_name'] ) && empty( $value['sharing_url'] ) && empty( $value['sharing_icon'] ) ) {
1803
			return true;
1804
		}
1805
1806 View Code Duplication
		if ( ! class_exists( 'Sharing_Service' ) && ! @include( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
1807
			return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
1808
		}
1809
1810
		if ( ( ! empty( $value['sharing_name'] ) && ! is_string( $value['sharing_name'] ) )
1811
		|| ( ! empty( $value['sharing_url'] ) && ! is_string( $value['sharing_url'] ) )
1812
		|| ( ! empty( $value['sharing_icon'] ) && ! is_string( $value['sharing_icon'] ) ) ) {
1813
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s needs sharing name, url and icon.', 'jetpack' ), $param ) );
1814
		}
1815
		return true;
1816
	}
1817
1818
	/**
1819
	 * Validates that the parameter is a custom sharing service ID like 'custom-1461976264'.
1820
	 *
1821
	 * @since 4.3.0
1822
	 *
1823
	 * @param string $value Value to check.
1824
	 * @param WP_REST_Request $request
1825
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1826
	 *
1827
	 * @return bool
1828
	 */
1829
	public static function validate_custom_service_id( $value = '', $request, $param ) {
1830 View Code Duplication
		if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/custom\-[0-1]+/i', $value ) ) ) {
1831
			return new WP_Error( 'invalid_param', sprintf( esc_html__( "%s must be a string prefixed with 'custom-' and followed by a numeric ID.", 'jetpack' ), $param ) );
1832
		}
1833
1834 View Code Duplication
		if ( ! class_exists( 'Sharing_Service' ) && ! @include( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
1835
			return new WP_Error( 'invalid_param', esc_html__( 'Failed loading required dependency Sharing_Service.', 'jetpack' ) );
1836
		}
1837
		$sharer = new Sharing_Service();
1838
		$services = array_keys( $sharer->get_all_services() );
1839
1840 View Code Duplication
		if ( ! empty( $value ) && ! in_array( $value, $services ) ) {
1841
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s is not a registered custom sharing service.', 'jetpack' ), $param ) );
1842
		}
1843
1844
		return true;
1845
	}
1846
1847
	/**
1848
	 * Validates that the parameter is a Twitter username or empty string (to be able to clear the field).
1849
	 *
1850
	 * @since 4.3.0
1851
	 *
1852
	 * @param string $value Value to check.
1853
	 * @param WP_REST_Request $request
1854
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1855
	 *
1856
	 * @return bool
1857
	 */
1858
	public static function validate_twitter_username( $value = '', $request, $param ) {
1859 View Code Duplication
		if ( ! empty( $value ) && ( ! is_string( $value ) || ! preg_match( '/^@?\w{1,15}$/i', $value ) ) ) {
1860
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a Twitter username.', 'jetpack' ), $param ) );
1861
		}
1862
		return true;
1863
	}
1864
1865
	/**
1866
	 * Validates that the parameter is a string.
1867
	 *
1868
	 * @since 4.3.0
1869
	 *
1870
	 * @param string $value Value to check.
1871
	 * @param WP_REST_Request $request
1872
	 * @param string $param Name of the parameter passed to endpoint holding $value.
1873
	 *
1874
	 * @return bool
1875
	 */
1876
	public static function validate_string( $value = '', $request, $param ) {
1877 View Code Duplication
		if ( ! is_string( $value ) ) {
1878
			return new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be a string.', 'jetpack' ), $param ) );
1879
		}
1880
		return true;
1881
	}
1882
1883
	/**
1884
	 * If for some reason the roles allowed to see Stats are empty (for example, user tampering with checkboxes),
1885
	 * return an array with only 'administrator' as the allowed role and save it for 'roles' option.
1886
	 *
1887
	 * @since 4.3.0
1888
	 *
1889
	 * @param string|bool $value Value to check.
1890
	 *
1891
	 * @return bool
1892
	 */
1893
	public static function sanitize_stats_allowed_roles( $value ) {
1894
		if ( empty( $value ) ) {
1895
			return array( 'administrator' );
1896
		}
1897
		return $value;
1898
	}
1899
1900
	/**
1901
	 * Get the currently accessed route and return the module slug in it.
1902
	 *
1903
	 * @since 4.3.0
1904
	 *
1905
	 * @param string $route Regular expression for the endpoint with the module slug to return.
1906
	 *
1907
	 * @return array
1908
	 */
1909
	public static function get_module_requested( $route = '/module/(?P<slug>[a-z\-]+)' ) {
1910
1911
		if ( empty( $GLOBALS['wp']->query_vars['rest_route'] ) ) {
1912
			return '';
1913
		}
1914
1915
		preg_match( "#$route#", $GLOBALS['wp']->query_vars['rest_route'], $module );
1916
1917
		if ( empty( $module['slug'] ) ) {
1918
			return '';
1919
		}
1920
1921
		return $module['slug'];
1922
	}
1923
1924
	/**
1925
	 * Adds extra information for modules.
1926
	 *
1927
	 * @since 4.3.0
1928
	 *
1929
	 * @param string      $modules Can be a single module or a list of modules.
1930
	 * @param null|string $slug    Slug of the module in the first parameter.
1931
	 *
1932
	 * @return array
1933
	 */
1934
	public static function prepare_modules_for_response( $modules = '', $slug = null ) {
1935
		if ( get_option( 'permalink_structure' ) ) {
1936
			$sitemap_url = home_url( '/sitemap.xml' );
1937
			$news_sitemap_url = home_url( '/news-sitemap.xml' );
1938
		} else {
1939
			$sitemap_url = home_url( '/?jetpack-sitemap=true' );
1940
			$news_sitemap_url = home_url( '/?jetpack-news-sitemap=true' );
1941
		}
1942
		/** This filter is documented in modules/sitemaps/sitemaps.php */
1943
		$sitemap_url = apply_filters( 'jetpack_sitemap_location', $sitemap_url );
1944
		/** This filter is documented in modules/sitemaps/sitemaps.php */
1945
		$news_sitemap_url = apply_filters( 'jetpack_news_sitemap_location', $news_sitemap_url );
1946
1947
		if ( is_null( $slug ) && isset( $modules['sitemaps'] ) ) {
1948
			// Is a list of modules
1949
			$modules['sitemaps']['extra']['sitemap_url'] = $sitemap_url;
1950
			$modules['sitemaps']['extra']['news_sitemap_url'] = $news_sitemap_url;
1951
		} elseif ( 'sitemaps' == $slug ) {
1952
			// It's a single module
1953
			$modules['extra']['sitemap_url'] = $sitemap_url;
1954
			$modules['extra']['news_sitemap_url'] = $news_sitemap_url;
1955
		}
1956
		return $modules;
1957
	}
1958
1959
	/**
1960
	 * Remove 'validate_callback' item from options available for module.
1961
	 * Fetch current option value and add to array of module options.
1962
	 * Prepare values of module options that need special handling, like those saved in wpcom.
1963
	 *
1964
	 * @since 4.3.0
1965
	 *
1966
	 * @param string $module Module slug.
1967
	 * @return array
1968
	 */
1969
	public static function prepare_options_for_response( $module = '' ) {
1970
		$options = self::get_updateable_data_list( $module );
1971
1972
		if ( ! is_array( $options ) || empty( $options ) ) {
1973
			return $options;
1974
		}
1975
1976
		foreach ( $options as $key => $value ) {
1977
1978
			if ( isset( $options[ $key ]['validate_callback'] ) ) {
1979
				unset( $options[ $key ]['validate_callback'] );
1980
			}
1981
1982
			$default_value = isset( $options[ $key ]['default'] ) ? $options[ $key ]['default'] : '';
1983
1984
			$current_value = get_option( $key, $default_value );
1985
1986
			$options[ $key ]['current_value'] = self::cast_value( $current_value, $options[ $key ] );
1987
		}
1988
1989
		// Some modules need special treatment.
1990
		switch ( $module ) {
1991
1992
			case 'monitor':
1993
				// Status of user notifications
1994
				$options['monitor_receive_notifications']['current_value'] = self::cast_value( self::get_remote_value( 'monitor', 'monitor_receive_notifications' ), $options['monitor_receive_notifications'] );
1995
				break;
1996
1997
			case 'post-by-email':
1998
				// Email address
1999
				$options['post_by_email_address']['current_value'] = self::cast_value( self::get_remote_value( 'post-by-email', 'post_by_email_address' ), $options['post_by_email_address'] );
2000
				break;
2001
2002
			case 'protect':
2003
				// Protect
2004
				$options['jetpack_protect_key']['current_value'] = get_site_option( 'jetpack_protect_key', false );
2005
				if ( ! function_exists( 'jetpack_protect_format_whitelist' ) ) {
2006
					@include( JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php' );
2007
				}
2008
				$options['jetpack_protect_global_whitelist']['current_value'] = jetpack_protect_format_whitelist();
2009
				break;
2010
2011
			case 'related-posts':
2012
				// It's local, but it must be broken apart since it's saved as an array.
2013
				$options = self::split_options( $options, Jetpack_Options::get_option( 'relatedposts' ) );
2014
				break;
2015
2016
			case 'verification-tools':
2017
				// It's local, but it must be broken apart since it's saved as an array.
2018
				$options = self::split_options( $options, get_option( 'verification_services_codes' ) );
2019
				break;
2020
2021
			case 'sharedaddy':
2022
				// It's local, but it must be broken apart since it's saved as an array.
2023
				if ( ! class_exists( 'Sharing_Service' ) && ! @include( JETPACK__PLUGIN_DIR . 'modules/sharedaddy/sharing-service.php' ) ) {
2024
					break;
2025
				}
2026
				$sharer = new Sharing_Service();
2027
				$options = self::split_options( $options, $sharer->get_global_options() );
2028
				$options['sharing_services']['current_value'] = $sharer->get_blog_services();
2029
				break;
2030
2031
			case 'after-the-deadline':
2032
				if ( ! function_exists( 'AtD_get_options' ) ) {
2033
					@include( JETPACK__PLUGIN_DIR . 'modules/after-the-deadline.php' );
2034
				}
2035
				$atd_options = array_merge( AtD_get_options( get_current_user_id(), 'AtD_options' ), AtD_get_options( get_current_user_id(), 'AtD_check_when' ) );
2036
				unset( $atd_options['name'] );
2037
				foreach ( $atd_options as $key => $value ) {
2038
					$options[ $key ]['current_value'] = self::cast_value( $value, $options[ $key ] );
2039
				}
2040
				$atd_options = AtD_get_options( get_current_user_id(), 'AtD_guess_lang' );
2041
				$options['guess_lang']['current_value'] = self::cast_value( isset( $atd_options['true'] ), $options[ 'guess_lang' ] );
2042
				$options['ignored_phrases']['current_value'] = AtD_get_setting( get_current_user_id(), 'AtD_ignored_phrases' );
2043
				unset( $options['unignore_phrase'] );
2044
				break;
2045
2046
			case 'minileven':
2047
				$options['wp_mobile_excerpt']['current_value'] =
2048
					1 === intval( $options['wp_mobile_excerpt']['current_value'] ) ?
2049
					'enabled' : 'disabled';
2050
2051
				$options['wp_mobile_featured_images']['current_value'] =
2052
					1 === intval( $options['wp_mobile_featured_images']['current_value'] ) ?
2053
					'enabled' : 'disabled';
2054
				break;
2055
2056
			case 'stats':
2057
				// It's local, but it must be broken apart since it's saved as an array.
2058
				if ( ! function_exists( 'stats_get_options' ) ) {
2059
					@include( JETPACK__PLUGIN_DIR . 'modules/stats.php' );
2060
				}
2061
				$options = self::split_options( $options, stats_get_options() );
2062
				break;
2063
		}
2064
2065
		return $options;
2066
	}
2067
2068
	/**
2069
	 * Splits module options saved as arrays like relatedposts or verification_services_codes into separate options to be returned in the response.
2070
	 *
2071
	 * @since 4.3.0
2072
	 *
2073
	 * @param array  $separate_options Array of options admitted by the module.
2074
	 * @param array  $grouped_options Option saved as array to be splitted.
2075
	 * @param string $prefix Optional prefix for the separate option keys.
2076
	 *
2077
	 * @return array
2078
	 */
2079
	public static function split_options( $separate_options, $grouped_options, $prefix = '' ) {
2080
		if ( is_array( $grouped_options ) ) {
2081
			foreach ( $grouped_options as $key => $value ) {
2082
				$option_key = $prefix . $key;
2083
				if ( isset( $separate_options[ $option_key ] ) ) {
2084
					$separate_options[ $option_key ]['current_value'] = self::cast_value( $grouped_options[ $key ], $separate_options[ $option_key ] );
2085
				}
2086
			}
2087
		}
2088
		return $separate_options;
2089
	}
2090
2091
	/**
2092
	 * Perform a casting to the value specified in the option definition.
2093
	 *
2094
	 * @since 4.3.0
2095
	 *
2096
	 * @param mixed $value Value to cast to the proper type.
2097
	 * @param array $definition Type to cast the value to.
2098
	 *
2099
	 * @return bool|float|int|string
2100
	 */
2101
	public static function cast_value( $value, $definition ) {
2102
		if ( $value === 'NULL' ) {
2103
			return null;
2104
		}
2105
2106
		if ( isset( $definition['type'] ) ) {
2107
			switch ( $definition['type'] ) {
2108
				case 'boolean':
2109
					if ( 'true' === $value ) {
2110
						return true;
2111
					} elseif ( 'false' === $value ) {
2112
						return false;
2113
					}
2114
					return (bool) $value;
2115
					break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
2116
2117
				case 'integer':
2118
					return (int) $value;
2119
					break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
2120
2121
				case 'float':
2122
					return (float) $value;
2123
					break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
2124
2125
				case 'string':
2126
					return (string) $value;
2127
					break;
0 ignored issues
show
break is not strictly necessary here and could be removed.

The break statement is not necessary if it is preceded for example by a return statement:

switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

If you would like to keep this construct to be consistent with other case statements, you can safely mark this issue as a false-positive.

Loading history...
2128
			}
2129
		}
2130
		return $value;
2131
	}
2132
2133
	/**
2134
	 * Get a value not saved locally.
2135
	 *
2136
	 * @since 4.3.0
2137
	 *
2138
	 * @param string $module Module slug.
2139
	 * @param string $option Option name.
2140
	 *
2141
	 * @return bool Whether user is receiving notifications or not.
2142
	 */
2143
	public static function get_remote_value( $module, $option ) {
2144
2145
		if ( in_array( $module, array( 'post-by-email' ), true ) ) {
2146
			$option .= get_current_user_id();
2147
		}
2148
2149
		// If option doesn't exist, 'does_not_exist' will be returned.
2150
		$value = get_option( $option, 'does_not_exist' );
2151
2152
		// If option exists, just return it.
2153
		if ( 'does_not_exist' !== $value ) {
2154
			return $value;
2155
		}
2156
2157
		// Only check a remote option if Jetpack is connected.
2158
		if ( ! Jetpack::is_active() ) {
2159
			return false;
2160
		}
2161
2162
		// If the module is inactive, load the class to use the method.
2163
		if ( ! did_action( 'jetpack_module_loaded_' . $module ) ) {
2164
			// Class can't be found so do nothing.
2165
			if ( ! @include( Jetpack::get_module_path( $module ) ) ) {
2166
				return false;
2167
			}
2168
		}
2169
2170
		// Do what is necessary for each module.
2171
		switch ( $module ) {
2172
			case 'monitor':
2173
				$monitor = new Jetpack_Monitor();
2174
				$value = $monitor->user_receives_notifications( false );
2175
				break;
2176
2177
			case 'post-by-email':
2178
				$post_by_email = new Jetpack_Post_By_Email();
2179
				$value = $post_by_email->get_post_by_email_address();
2180
				if ( $value === null ) {
2181
					$value = 'NULL'; // sentinel value so it actually gets set
2182
				}
2183
				break;
2184
		}
2185
2186
		// Normalize value to boolean.
2187
		if ( is_wp_error( $value ) || is_null( $value ) ) {
2188
			$value = false;
2189
		}
2190
2191
		// Save option to use it next time.
2192
		update_option( $option, $value );
2193
2194
		return $value;
2195
	}
2196
2197
	/**
2198
	 * Get number of plugin updates available.
2199
	 *
2200
	 * @since 4.3.0
2201
	 *
2202
	 * @return mixed|WP_Error Number of plugin updates available. Otherwise, a WP_Error instance with the corresponding error.
2203
	 */
2204
	public static function get_plugin_update_count() {
2205
		$updates = wp_get_update_data();
2206
		if ( isset( $updates['counts'] ) && isset( $updates['counts']['plugins'] ) ) {
2207
			$count = $updates['counts']['plugins'];
2208
			if ( 0 == $count ) {
2209
				$response = array(
2210
					'code'    => 'success',
2211
					'message' => esc_html__( 'All plugins are up-to-date. Keep up the good work!', 'jetpack' ),
2212
					'count'   => 0,
2213
				);
2214
			} else {
2215
				$response = array(
2216
					'code'    => 'updates-available',
2217
					'message' => esc_html( sprintf( _n( '%s plugin need updating.', '%s plugins need updating.', $count, 'jetpack' ), $count ) ),
2218
					'count'   => $count,
2219
				);
2220
			}
2221
			return rest_ensure_response( $response );
2222
		}
2223
2224
		return new WP_Error( 'not_found', esc_html__( 'Could not check updates for plugins on this site.', 'jetpack' ), array( 'status' => 404 ) );
2225
	}
2226
2227
2228
	/**
2229
	 * Returns a list of all plugins in the site.
2230
	 *
2231
	 * @since 4.2.0
2232
	 * @uses get_plugins()
2233
	 *
2234
	 * @return array
2235
	 */
2236
	private static function core_get_plugins() {
2237
		if ( ! function_exists( 'get_plugins' ) ) {
2238
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2239
		}
2240
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2241
		$plugins = apply_filters( 'all_plugins', get_plugins() );
2242
2243
		if ( is_array( $plugins ) && ! empty( $plugins ) ) {
2244
			foreach ( $plugins as $plugin_slug => $plugin_data ) {
2245
				$plugins[ $plugin_slug ]['active'] = self::core_is_plugin_active( $plugin_slug );
2246
			}
2247
			return $plugins;
2248
		}
2249
2250
		return array();
2251
	}
2252
2253
	/**
2254
	 * Checks if the queried plugin is active.
2255
	 *
2256
	 * @since 4.2.0
2257
	 * @uses is_plugin_active()
2258
	 *
2259
	 * @return bool
2260
	 */
2261
	private static function core_is_plugin_active( $plugin ) {
2262
		if ( ! function_exists( 'get_plugins' ) ) {
2263
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2264
		}
2265
2266
		return is_plugin_active( $plugin );
2267
	}
2268
2269
	/**
2270
	 * Get plugins data in site.
2271
	 *
2272
	 * @since 4.2.0
2273
	 *
2274
	 * @return WP_REST_Response|WP_Error List of plugins in the site. Otherwise, a WP_Error instance with the corresponding error.
2275
	 */
2276
	public static function get_plugins() {
2277
		$plugins = self::core_get_plugins();
2278
2279
		if ( ! empty( $plugins ) ) {
2280
			return rest_ensure_response( $plugins );
2281
		}
2282
2283
		return new WP_Error( 'not_found', esc_html__( 'Unable to list plugins.', 'jetpack' ), array( 'status' => 404 ) );
2284
	}
2285
2286
	/**
2287
	 * Get data about the queried plugin. Currently it only returns whether the plugin is active or not.
2288
	 *
2289
	 * @since 4.2.0
2290
	 *
2291
	 * @param WP_REST_Request $data {
2292
	 *     Array of parameters received by request.
2293
	 *
2294
	 *     @type string $slug Plugin slug with the syntax 'plugin-directory/plugin-main-file.php'.
2295
	 * }
2296
	 *
2297
	 * @return bool|WP_Error True if module was activated. Otherwise, a WP_Error instance with the corresponding error.
2298
	 */
2299
	public static function get_plugin( $data ) {
2300
2301
		$plugins = self::core_get_plugins();
2302
2303
		if ( empty( $plugins ) ) {
2304
			return new WP_Error( 'no_plugins_found', esc_html__( 'This site has no plugins.', 'jetpack' ), array( 'status' => 404 ) );
2305
		}
2306
2307
		$plugin = stripslashes( $data['plugin'] );
2308
2309
		if ( ! in_array( $plugin, array_keys( $plugins ) ) ) {
2310
			return new WP_Error( 'plugin_not_found', esc_html( sprintf( __( 'Plugin %s is not installed.', 'jetpack' ), $plugin ) ), array( 'status' => 404 ) );
2311
		}
2312
2313
		$plugin_data = $plugins[ $plugin ];
2314
2315
		$plugin_data['active'] = self::core_is_plugin_active( $plugin );
2316
2317
		return rest_ensure_response( array(
2318
			'code'    => 'success',
2319
			'message' => esc_html__( 'Plugin found.', 'jetpack' ),
2320
			'data'    => $plugin_data
2321
		) );
2322
	}
2323
2324
} // class end
2325