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