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

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

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

publicize-connections.php

224 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	* { # Connnection 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	* Constructor.
34	*/
35	public function __construct() {
36	$this->namespace = 'wpcom/v2';
37	$this->rest_base = 'publicize/connections';
38
39	add_action( 'rest_api_init', array( $this, 'register_routes' ) );
40	}
41
42	/**
43	* Called automatically on `rest_api_init()`.
44	*/
45	public function register_routes() {
46	register_rest_route(
47	$this->namespace,
48	'/' . $this->rest_base,
49	array(
50	array(
51	'methods' => WP_REST_Server::READABLE,
52	'callback' => array( $this, 'get_items' ),
53	'permission_callback' => array( $this, 'get_items_permission_check' ),
54	),
55	'schema' => array( $this, 'get_public_item_schema' ),
56	)
57	);
58	}
59
60	/**
61	* Helper for generating schema. Used by this endpoint and by the
62	* Connection Test Result endpoint.
63	*
64	* @internal
65	* @return array
66	*/
67	protected function get_connection_schema_properties() {
68	return array(
69	'id' => array(
70	'description' => __( 'Unique identifier for the Jetpack Social connection', 'jetpack' ),
71	'type' => 'string',
72	),
73	'service_name' => array(
74	'description' => __( 'Alphanumeric identifier for the Jetpack Social service', 'jetpack' ),
75	'type' => 'string',
76	),
77	'display_name' => array(
78	'description' => __( 'Display name of the connected account', 'jetpack' ),
79	'type' => 'string',
80	),
81	'username' => array(
82	'description' => __( 'Username of the connected account', 'jetpack' ),
83	'type' => 'string',
84	),
85	'profile_display_name' => array(
86	'description' => __( 'The name to display in the profile of the connected account', 'jetpack' ),
87	'type' => 'string',
88	),
89	'profile_picture' => array(
90	'description' => __( 'Profile picture of the connected account', 'jetpack' ),
91	'type' => 'string',
92	),
93	'global' => array(
94	'description' => __( 'Is this connection available to all users?', 'jetpack' ),
95	'type' => 'boolean',
96	),
97	);
98	}
99
100	/**
101	* Schema for the endpoint.
102	*
103	* @return array
104	*/
105	public function get_item_schema() {
106	$schema = array(
107	'$schema' => 'http://json-schema.org/draft-04/schema#',
108	'title' => 'jetpack-publicize-connection',
109	'type' => 'object',
110	'properties' => $this->get_connection_schema_properties(),
111	);
112
113	return $this->add_additional_fields_schema( $schema );
114	}
115
116	/**
117	* Helper for retrieving Connections. Used by this endpoint and by
118	* the Connection Test Result endpoint.
119	*
120	* @internal
121	* @return array
122	*/
123	protected function get_connections() {
124	global $publicize;
125
126	$items = array();
127
128	foreach ( (array) $publicize->get_services( 'connected' ) as $service_name => $connections ) {
129	foreach ( $connections as $connection ) {
130	$connection_meta = $publicize->get_connection_meta( $connection );
131	$connection_data = $connection_meta['connection_data'];
132
133	$items[] = array(
134	'id' => (string) $publicize->get_connection_unique_id( $connection ),
135	'connection_id' => (string) $publicize->get_connection_id( $connection ),
136	'service_name' => $service_name,
137	'display_name' => $publicize->get_display_name( $service_name, $connection ),
138	'username' => $publicize->get_username( $service_name, $connection ),
139	'profile_display_name' => ! empty( $connection_meta['profile_display_name'] ) ? $connection_meta['profile_display_name'] : '',
140	'profile_picture' => ! empty( $connection_meta['profile_picture'] ) ? $connection_meta['profile_picture'] : '',
141	// phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual -- We expect an integer, but do loose comparison below in case some other type is stored.
142	'global' => 0 == $connection_data['user_id'],
143	);
144	}
145	}
146
147	return $items;
148	}
149
150	/**
151	* Get list of connected Publicize connections.
152	*
153	* @param WP_REST_Request $request Full details about the request.
154	*
155	* @return WP_REST_Response suitable for 1-page collection
156	*/
157	public function get_items( $request ) {
158	$items = array();
159
160	foreach ( $this->get_connections() as $item ) {
161	$items[] = $this->prepare_item_for_response( $item, $request );
162	}
163
164	$response = rest_ensure_response( $items );
165	$response->header( 'X-WP-Total', count( $items ) );
166	$response->header( 'X-WP-TotalPages', 1 );
167
168	return $response;
169	}
170
171	/**
172	* Filters out data based on ?_fields= request parameter
173	*
174	* @param array $connection Array of info about a specific Publicize connection.
175	* @param WP_REST_Request $request Full details about the request.
176	*
177	* @return array filtered $connection
178	*/
179	public function prepare_item_for_response( $connection, $request ) {
180	if ( ! is_callable( array( $this, 'get_fields_for_response' ) ) ) {
181	return $connection;
182	}
183
184	$fields = $this->get_fields_for_response( $request );
185
186	$response_data = array();
187	foreach ( $connection as $field => $value ) {
188	if ( in_array( $field, $fields, true ) ) {
189	$response_data[ $field ] = $value;
190	}
191	}
192
193	return $response_data;
194	}
195
196	/**
197	* Verify that user can access Publicize data
198	*
199	* @return true\|WP_Error
200	*/
201	public function get_items_permission_check() {
202	global $publicize;
203
204	if ( ! $publicize ) {
205	return new WP_Error(
206	'publicize_not_available',
207	__( 'Sorry, Jetpack Social is not available on your site right now.', 'jetpack' ),
208	array( 'status' => rest_authorization_required_code() )
209	);
210	}
211
212	if ( $publicize->current_user_can_access_publicize_data() ) {
213	return true;
214	}
215
216	return new WP_Error(
217	'invalid_user_permission_publicize',
218	__( 'Sorry, you are not allowed to access Jetpack Social data on this site.', 'jetpack' ),
219	array( 'status' => rest_authorization_required_code() )
220	);
221	}
222	}
223	wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_List_Publicize_Connections' );
224