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