publicize-services.php — Jetpack – WP Security, Backup, Speed, & Growth 13.5.2

jetpack / _inc / lib / core-api / wpcom-endpoints / publicize-services.php

jetpack / _inc / lib / core-api / wpcom-endpoints Last commit date

publicize-services.php

177 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Endpoint used to fetch information to connect to a Publicize service.
4	*
5	* @package automattic/jetpack
6	*/
7
8	/**
9	* Publicize: List Publicize Services
10	*
11	* [
12	* { # Service Object. See schema for more detail.
13	* name: (string) Service slug
14	* label: (string) Human readable label for the Service
15	* url: (string) Connect URL
16	* },
17	* ...
18	* ]
19	*
20	* @since 6.8
21	*/
22	class WPCOM_REST_API_V2_Endpoint_List_Publicize_Services extends WP_REST_Controller {
23	/**
24	* Flag to help WordPress.com decide where it should look for
25	* Publicize data. Ignored for direct requests to Jetpack sites.
26	*
27	* @var bool $wpcom_is_wpcom_only_endpoint
28	*/
29	public $wpcom_is_wpcom_only_endpoint = true;
30
31	/**
32	* Constructor.
33	*/
34	public function __construct() {
35	$this->namespace = 'wpcom/v2';
36	$this->rest_base = 'publicize/services';
37
38	add_action( 'rest_api_init', array( $this, 'register_routes' ) );
39	}
40
41	/**
42	* Called automatically on `rest_api_init()`.
43	*/
44	public function register_routes() {
45	register_rest_route(
46	$this->namespace,
47	'/' . $this->rest_base,
48	array(
49	array(
50	'methods' => WP_REST_Server::READABLE,
51	'callback' => array( $this, 'get_items' ),
52	'permission_callback' => array( $this, 'get_items_permission_check' ),
53	),
54	'schema' => array( $this, 'get_public_item_schema' ),
55	)
56	);
57	}
58
59	/**
60	* Schema for the publicize services endpoint.
61	*
62	* @return array
63	*/
64	public function get_item_schema() {
65	$schema = array(
66	'$schema' => 'http://json-schema.org/draft-04/schema#',
67	'title' => 'jetpack-publicize-service',
68	'type' => 'object',
69	'properties' => array(
70	'name' => array(
71	'description' => __( 'Alphanumeric identifier for the Jetpack Social service', 'jetpack' ),
72	'type' => 'string',
73	),
74	'label' => array(
75	'description' => __( 'Human readable label for the Jetpack Social service', 'jetpack' ),
76	'type' => 'string',
77	),
78	'url' => array(
79	'description' => __( 'The URL used to connect to the Jetpack Social service', 'jetpack' ),
80	'type' => 'string',
81	'format' => 'uri',
82	),
83	),
84	);
85
86	return $this->add_additional_fields_schema( $schema );
87	}
88
89	/**
90	* Retrieves available Publicize Services.
91	*
92	* @see Publicize::get_available_service_data()
93	*
94	* @param WP_REST_Request $request Full details about the request.
95	*
96	* @return WP_REST_Response suitable for 1-page collection
97	*/
98	public function get_items( $request ) {
99	global $publicize;
100
101	if ( ! defined( 'IS_WPCOM' ) \|\| ! IS_WPCOM ) {
102	/**
103	* We need this because Publicize::get_available_service_data() uses `Jetpack_Keyring_Service_Helper`
104	* and `Jetpack_Keyring_Service_Helper` needs a `sharing` page to be registered.
105	*/
106	require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
107	Jetpack_Keyring_Service_Helper::register_sharing_page();
108	}
109
110	$services_data = $publicize->get_available_service_data();
111
112	$services = array();
113	foreach ( $services_data as $service_data ) {
114	$services[] = $this->prepare_item_for_response( $service_data, $request );
115	}
116
117	$response = rest_ensure_response( $services );
118	$response->header( 'X-WP-Total', count( $services ) );
119	$response->header( 'X-WP-TotalPages', 1 );
120
121	return $response;
122	}
123
124	/**
125	* Filters out data based on ?_fields= request parameter
126	*
127	* @param array $service UI service connection data for a specific Publicize service.
128	* @param WP_REST_Request $request Full details about the request.
129	*
130	* @return array filtered $service
131	*/
132	public function prepare_item_for_response( $service, $request ) {
133	if ( ! is_callable( array( $this, 'get_fields_for_response' ) ) ) {
134	return $service;
135	}
136
137	$fields = $this->get_fields_for_response( $request );
138
139	$response_data = array();
140	foreach ( $service as $field => $value ) {
141	if ( in_array( $field, $fields, true ) ) {
142	$response_data[ $field ] = $value;
143	}
144	}
145
146	return $response_data;
147	}
148
149	/**
150	* Verify that user can access Publicize data
151	*
152	* @return true\|WP_Error
153	*/
154	public function get_items_permission_check() {
155	global $publicize;
156
157	if ( ! $publicize ) {
158	return new WP_Error(
159	'publicize_not_available',
160	__( 'Sorry, Jetpack Social is not available on your site right now.', 'jetpack' ),
161	array( 'status' => rest_authorization_required_code() )
162	);
163	}
164
165	if ( $publicize->current_user_can_access_publicize_data() ) {
166	return true;
167	}
168
169	return new WP_Error(
170	'invalid_user_permission_publicize',
171	__( 'Sorry, you are not allowed to access Jetpack Social data on this site.', 'jetpack' ),
172	array( 'status' => rest_authorization_required_code() )
173	);
174	}
175	}
176	wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_List_Publicize_Services' );
177