publicize-connections.php — Jetpack – WP Security, Backup, Speed, & Growth 14.3.1

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

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

publicize-connections.php

208 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Fetch information about Publicize connections on a site.
4	*
5	* @package automattic/jetpack
6	*/
7
8	/**
9	* Publicize: List Connections
10	*
11	* [
12	* { # Connection Object. See schema for more detail.
13	* id: (string) Connection unique_id
14	* service_name: (string) Service slug
15	* display_name: (string) User name/display name of user/connection on Service
16	* global: (boolean) Is the Connection available to all users of the site?
17	* },
18	* ...
19	* ]
20	*
21	* @since 6.8
22	*/
23	class WPCOM_REST_API_V2_Endpoint_List_Publicize_Connections extends WP_REST_Controller {
24	/**
25	* Flag to help WordPress.com decide where it should look for
26	* Publicize data. Ignored for direct requests to Jetpack sites.
27	*
28	* @var bool $wpcom_is_wpcom_only_endpoint
29	*/
30	public $wpcom_is_wpcom_only_endpoint = true;
31
32	/**
33	* Called automatically on `rest_api_init()`.
34	*/
35	public function register_routes() {
36	// Endpoint moved to publicize package.
37	}
38
39	/**
40	* Helper for generating schema. Used by this endpoint and by the
41	* Connection Test Result endpoint.
42	*
43	* @internal
44	* @return array
45	*/
46	protected function get_connection_schema_properties() {
47	return array(
48	'id' => array(
49	'description' => __( 'Unique identifier for the Jetpack Social connection', 'jetpack' ),
50	'type' => 'string',
51	),
52	'service_name' => array(
53	'description' => __( 'Alphanumeric identifier for the Jetpack Social service', 'jetpack' ),
54	'type' => 'string',
55	),
56	'display_name' => array(
57	'description' => __( 'Display name of the connected account', 'jetpack' ),
58	'type' => 'string',
59	),
60	'username' => array(
61	'description' => __( 'Username of the connected account', 'jetpack' ),
62	'type' => 'string',
63	),
64	'profile_display_name' => array(
65	'description' => __( 'The name to display in the profile of the connected account', 'jetpack' ),
66	'type' => 'string',
67	),
68	'profile_picture' => array(
69	'description' => __( 'Profile picture of the connected account', 'jetpack' ),
70	'type' => 'string',
71	),
72	'global' => array(
73	'description' => __( 'Is this connection available to all users?', 'jetpack' ),
74	'type' => 'boolean',
75	),
76	'external_id' => array(
77	'description' => __( 'The external ID of the connected account', 'jetpack' ),
78	'type' => 'string',
79	),
80	);
81	}
82
83	/**
84	* Schema for the endpoint.
85	*
86	* @return array
87	*/
88	public function get_item_schema() {
89	$schema = array(
90	'$schema' => 'http://json-schema.org/draft-04/schema#',
91	'title' => 'jetpack-publicize-connection',
92	'type' => 'object',
93	'properties' => $this->get_connection_schema_properties(),
94	);
95
96	return $this->add_additional_fields_schema( $schema );
97	}
98
99	/**
100	* Helper for retrieving Connections. Used by this endpoint and by
101	* the Connection Test Result endpoint.
102	*
103	* @internal
104	* @return array
105	*/
106	protected function get_connections() {
107	global $publicize;
108
109	$items = array();
110
111	foreach ( (array) $publicize->get_services( 'connected' ) as $service_name => $connections ) {
112	foreach ( $connections as $connection ) {
113	$connection_meta = $publicize->get_connection_meta( $connection );
114	$connection_data = $connection_meta['connection_data'];
115
116	$items[] = array(
117	'id' => (string) $publicize->get_connection_unique_id( $connection ),
118	'connection_id' => (string) $publicize->get_connection_id( $connection ),
119	'service_name' => $service_name,
120	'display_name' => $publicize->get_display_name( $service_name, $connection ),
121	'username' => $publicize->get_username( $service_name, $connection ),
122	'profile_display_name' => ! empty( $connection_meta['profile_display_name'] ) ? $connection_meta['profile_display_name'] : '',
123	'profile_picture' => ! empty( $connection_meta['profile_picture'] ) ? $connection_meta['profile_picture'] : '',
124	// phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual -- We expect an integer, but do loose comparison below in case some other type is stored.
125	'global' => 0 == $connection_data['user_id'],
126	'external_id' => $connection_meta['external_id'] ?? '',
127	);
128	}
129	}
130
131	return $items;
132	}
133
134	/**
135	* Get list of connected Publicize connections.
136	*
137	* @param WP_REST_Request $request Full details about the request.
138	*
139	* @return WP_REST_Response suitable for 1-page collection
140	*/
141	public function get_items( $request ) {
142	$items = array();
143
144	foreach ( $this->get_connections() as $item ) {
145	$items[] = $this->prepare_item_for_response( $item, $request );
146	}
147
148	$response = rest_ensure_response( $items );
149	$response->header( 'X-WP-Total', count( $items ) );
150	$response->header( 'X-WP-TotalPages', 1 );
151
152	return $response;
153	}
154
155	/**
156	* Filters out data based on ?_fields= request parameter
157	*
158	* @param array $connection Array of info about a specific Publicize connection.
159	* @param WP_REST_Request $request Full details about the request.
160	*
161	* @return array filtered $connection
162	*/
163	public function prepare_item_for_response( $connection, $request ) {
164	if ( ! is_callable( array( $this, 'get_fields_for_response' ) ) ) {
165	return $connection;
166	}
167
168	$fields = $this->get_fields_for_response( $request );
169
170	$response_data = array();
171	foreach ( $connection as $field => $value ) {
172	if ( in_array( $field, $fields, true ) ) {
173	$response_data[ $field ] = $value;
174	}
175	}
176
177	return $response_data;
178	}
179
180	/**
181	* Verify that user can access Publicize data
182	*
183	* @return true\|WP_Error
184	*/
185	public function get_items_permission_check() {
186	global $publicize;
187
188	if ( ! $publicize ) {
189	return new WP_Error(
190	'publicize_not_available',
191	__( 'Sorry, Jetpack Social is not available on your site right now.', 'jetpack' ),
192	array( 'status' => rest_authorization_required_code() )
193	);
194	}
195
196	if ( $publicize->current_user_can_access_publicize_data() ) {
197	return true;
198	}
199
200	return new WP_Error(
201	'invalid_user_permission_publicize',
202	__( 'Sorry, you are not allowed to access Jetpack Social data on this site.', 'jetpack' ),
203	array( 'status' => rest_authorization_required_code() )
204	);
205	}
206	}
207	wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_List_Publicize_Connections' );
208