| author | ymh <ymh.work@gmail.com> |
| Fri, 05 Sep 2025 18:40:08 +0200 | |
| changeset 21 | 48c4eec2b7e6 |
| parent 19 | 3d72ae0968f4 |
| permissions | -rw-r--r-- |
| 18 | 1 |
<?php |
2 |
/** |
|
3 |
* REST API: WP_REST_Application_Passwords_Controller class |
|
4 |
* |
|
5 |
* @package WordPress |
|
6 |
* @subpackage REST_API |
|
7 |
* @since 5.6.0 |
|
8 |
*/ |
|
9 |
||
10 |
/** |
|
11 |
* Core class to access a user's application passwords via the REST API. |
|
12 |
* |
|
13 |
* @since 5.6.0 |
|
14 |
* |
|
15 |
* @see WP_REST_Controller |
|
16 |
*/ |
|
17 |
class WP_REST_Application_Passwords_Controller extends WP_REST_Controller { |
|
18 |
||
19 |
/** |
|
20 |
* Application Passwords controller constructor. |
|
21 |
* |
|
22 |
* @since 5.6.0 |
|
23 |
*/ |
|
24 |
public function __construct() { |
|
25 |
$this->namespace = 'wp/v2'; |
|
26 |
$this->rest_base = 'users/(?P<user_id>(?:[\d]+|me))/application-passwords'; |
|
27 |
} |
|
28 |
||
29 |
/** |
|
30 |
* Registers the REST API routes for the application passwords controller. |
|
31 |
* |
|
32 |
* @since 5.6.0 |
|
33 |
*/ |
|
34 |
public function register_routes() { |
|
35 |
register_rest_route( |
|
36 |
$this->namespace, |
|
37 |
'/' . $this->rest_base, |
|
38 |
array( |
|
39 |
array( |
|
40 |
'methods' => WP_REST_Server::READABLE, |
|
41 |
'callback' => array( $this, 'get_items' ), |
|
42 |
'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
43 |
'args' => $this->get_collection_params(), |
|
44 |
), |
|
45 |
array( |
|
46 |
'methods' => WP_REST_Server::CREATABLE, |
|
47 |
'callback' => array( $this, 'create_item' ), |
|
48 |
'permission_callback' => array( $this, 'create_item_permissions_check' ), |
|
49 |
'args' => $this->get_endpoint_args_for_item_schema(), |
|
50 |
), |
|
51 |
array( |
|
52 |
'methods' => WP_REST_Server::DELETABLE, |
|
53 |
'callback' => array( $this, 'delete_items' ), |
|
54 |
'permission_callback' => array( $this, 'delete_items_permissions_check' ), |
|
55 |
), |
|
56 |
'schema' => array( $this, 'get_public_item_schema' ), |
|
57 |
) |
|
58 |
); |
|
59 |
||
60 |
register_rest_route( |
|
61 |
$this->namespace, |
|
62 |
'/' . $this->rest_base . '/introspect', |
|
63 |
array( |
|
64 |
array( |
|
65 |
'methods' => WP_REST_Server::READABLE, |
|
66 |
'callback' => array( $this, 'get_current_item' ), |
|
67 |
'permission_callback' => array( $this, 'get_current_item_permissions_check' ), |
|
68 |
'args' => array( |
|
69 |
'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
70 |
), |
|
71 |
), |
|
72 |
'schema' => array( $this, 'get_public_item_schema' ), |
|
73 |
) |
|
74 |
); |
|
75 |
||
76 |
register_rest_route( |
|
77 |
$this->namespace, |
|
78 |
'/' . $this->rest_base . '/(?P<uuid>[\w\-]+)', |
|
79 |
array( |
|
80 |
array( |
|
81 |
'methods' => WP_REST_Server::READABLE, |
|
82 |
'callback' => array( $this, 'get_item' ), |
|
83 |
'permission_callback' => array( $this, 'get_item_permissions_check' ), |
|
84 |
'args' => array( |
|
85 |
'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
86 |
), |
|
87 |
), |
|
88 |
array( |
|
89 |
'methods' => WP_REST_Server::EDITABLE, |
|
90 |
'callback' => array( $this, 'update_item' ), |
|
91 |
'permission_callback' => array( $this, 'update_item_permissions_check' ), |
|
92 |
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
93 |
), |
|
94 |
array( |
|
95 |
'methods' => WP_REST_Server::DELETABLE, |
|
96 |
'callback' => array( $this, 'delete_item' ), |
|
97 |
'permission_callback' => array( $this, 'delete_item_permissions_check' ), |
|
98 |
), |
|
99 |
'schema' => array( $this, 'get_public_item_schema' ), |
|
100 |
) |
|
101 |
); |
|
102 |
} |
|
103 |
||
104 |
/** |
|
105 |
* Checks if a given request has access to get application passwords. |
|
106 |
* |
|
107 |
* @since 5.6.0 |
|
108 |
* |
|
109 |
* @param WP_REST_Request $request Full details about the request. |
|
110 |
* @return true|WP_Error True if the request has read access, WP_Error object otherwise. |
|
111 |
*/ |
|
112 |
public function get_items_permissions_check( $request ) { |
|
113 |
$user = $this->get_user( $request ); |
|
114 |
||
115 |
if ( is_wp_error( $user ) ) { |
|
116 |
return $user; |
|
117 |
} |
|
118 |
||
119 |
if ( ! current_user_can( 'list_app_passwords', $user->ID ) ) { |
|
120 |
return new WP_Error( |
|
121 |
'rest_cannot_list_application_passwords', |
|
122 |
__( 'Sorry, you are not allowed to list application passwords for this user.' ), |
|
123 |
array( 'status' => rest_authorization_required_code() ) |
|
124 |
); |
|
125 |
} |
|
126 |
||
127 |
return true; |
|
128 |
} |
|
129 |
||
130 |
/** |
|
131 |
* Retrieves a collection of application passwords. |
|
132 |
* |
|
133 |
* @since 5.6.0 |
|
134 |
* |
|
135 |
* @param WP_REST_Request $request Full details about the request. |
|
136 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
137 |
*/ |
|
138 |
public function get_items( $request ) { |
|
139 |
$user = $this->get_user( $request ); |
|
140 |
||
141 |
if ( is_wp_error( $user ) ) { |
|
142 |
return $user; |
|
143 |
} |
|
144 |
||
145 |
$passwords = WP_Application_Passwords::get_user_application_passwords( $user->ID ); |
|
146 |
$response = array(); |
|
147 |
||
148 |
foreach ( $passwords as $password ) { |
|
149 |
$response[] = $this->prepare_response_for_collection( |
|
150 |
$this->prepare_item_for_response( $password, $request ) |
|
151 |
); |
|
152 |
} |
|
153 |
||
154 |
return new WP_REST_Response( $response ); |
|
155 |
} |
|
156 |
||
157 |
/** |
|
158 |
* Checks if a given request has access to get a specific application password. |
|
159 |
* |
|
160 |
* @since 5.6.0 |
|
161 |
* |
|
162 |
* @param WP_REST_Request $request Full details about the request. |
|
163 |
* @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise. |
|
164 |
*/ |
|
165 |
public function get_item_permissions_check( $request ) { |
|
166 |
$user = $this->get_user( $request ); |
|
167 |
||
168 |
if ( is_wp_error( $user ) ) { |
|
169 |
return $user; |
|
170 |
} |
|
171 |
||
172 |
if ( ! current_user_can( 'read_app_password', $user->ID, $request['uuid'] ) ) { |
|
173 |
return new WP_Error( |
|
174 |
'rest_cannot_read_application_password', |
|
175 |
__( 'Sorry, you are not allowed to read this application password.' ), |
|
176 |
array( 'status' => rest_authorization_required_code() ) |
|
177 |
); |
|
178 |
} |
|
179 |
||
180 |
return true; |
|
181 |
} |
|
182 |
||
183 |
/** |
|
184 |
* Retrieves one application password from the collection. |
|
185 |
* |
|
186 |
* @since 5.6.0 |
|
187 |
* |
|
188 |
* @param WP_REST_Request $request Full details about the request. |
|
189 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
190 |
*/ |
|
191 |
public function get_item( $request ) { |
|
192 |
$password = $this->get_application_password( $request ); |
|
193 |
||
194 |
if ( is_wp_error( $password ) ) { |
|
195 |
return $password; |
|
196 |
} |
|
197 |
||
198 |
return $this->prepare_item_for_response( $password, $request ); |
|
199 |
} |
|
200 |
||
201 |
/** |
|
202 |
* Checks if a given request has access to create application passwords. |
|
203 |
* |
|
204 |
* @since 5.6.0 |
|
205 |
* |
|
206 |
* @param WP_REST_Request $request Full details about the request. |
|
207 |
* @return true|WP_Error True if the request has access to create items, WP_Error object otherwise. |
|
208 |
*/ |
|
209 |
public function create_item_permissions_check( $request ) { |
|
210 |
$user = $this->get_user( $request ); |
|
211 |
||
212 |
if ( is_wp_error( $user ) ) { |
|
213 |
return $user; |
|
214 |
} |
|
215 |
||
216 |
if ( ! current_user_can( 'create_app_password', $user->ID ) ) { |
|
217 |
return new WP_Error( |
|
218 |
'rest_cannot_create_application_passwords', |
|
219 |
__( 'Sorry, you are not allowed to create application passwords for this user.' ), |
|
220 |
array( 'status' => rest_authorization_required_code() ) |
|
221 |
); |
|
222 |
} |
|
223 |
||
224 |
return true; |
|
225 |
} |
|
226 |
||
227 |
/** |
|
228 |
* Creates an application password. |
|
229 |
* |
|
230 |
* @since 5.6.0 |
|
231 |
* |
|
232 |
* @param WP_REST_Request $request Full details about the request. |
|
233 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
234 |
*/ |
|
235 |
public function create_item( $request ) { |
|
236 |
$user = $this->get_user( $request ); |
|
237 |
||
238 |
if ( is_wp_error( $user ) ) { |
|
239 |
return $user; |
|
240 |
} |
|
241 |
||
242 |
$prepared = $this->prepare_item_for_database( $request ); |
|
243 |
||
244 |
if ( is_wp_error( $prepared ) ) { |
|
245 |
return $prepared; |
|
246 |
} |
|
247 |
||
248 |
$created = WP_Application_Passwords::create_new_application_password( $user->ID, wp_slash( (array) $prepared ) ); |
|
249 |
||
250 |
if ( is_wp_error( $created ) ) { |
|
251 |
return $created; |
|
252 |
} |
|
253 |
||
254 |
$password = $created[0]; |
|
255 |
$item = WP_Application_Passwords::get_user_application_password( $user->ID, $created[1]['uuid'] ); |
|
256 |
||
257 |
$item['new_password'] = WP_Application_Passwords::chunk_password( $password ); |
|
258 |
$fields_update = $this->update_additional_fields_for_object( $item, $request ); |
|
259 |
||
260 |
if ( is_wp_error( $fields_update ) ) { |
|
261 |
return $fields_update; |
|
262 |
} |
|
263 |
||
264 |
/** |
|
265 |
* Fires after a single application password is completely created or updated via the REST API. |
|
266 |
* |
|
267 |
* @since 5.6.0 |
|
268 |
* |
|
269 |
* @param array $item Inserted or updated password item. |
|
270 |
* @param WP_REST_Request $request Request object. |
|
271 |
* @param bool $creating True when creating an application password, false when updating. |
|
272 |
*/ |
|
273 |
do_action( 'rest_after_insert_application_password', $item, $request, true ); |
|
274 |
||
275 |
$request->set_param( 'context', 'edit' ); |
|
276 |
$response = $this->prepare_item_for_response( $item, $request ); |
|
277 |
||
278 |
$response->set_status( 201 ); |
|
279 |
$response->header( 'Location', $response->get_links()['self'][0]['href'] ); |
|
280 |
||
281 |
return $response; |
|
282 |
} |
|
283 |
||
284 |
/** |
|
285 |
* Checks if a given request has access to update application passwords. |
|
286 |
* |
|
287 |
* @since 5.6.0 |
|
288 |
* |
|
289 |
* @param WP_REST_Request $request Full details about the request. |
|
290 |
* @return true|WP_Error True if the request has access to create items, WP_Error object otherwise. |
|
291 |
*/ |
|
292 |
public function update_item_permissions_check( $request ) { |
|
293 |
$user = $this->get_user( $request ); |
|
294 |
||
295 |
if ( is_wp_error( $user ) ) { |
|
296 |
return $user; |
|
297 |
} |
|
298 |
||
299 |
if ( ! current_user_can( 'edit_app_password', $user->ID, $request['uuid'] ) ) { |
|
300 |
return new WP_Error( |
|
301 |
'rest_cannot_edit_application_password', |
|
302 |
__( 'Sorry, you are not allowed to edit this application password.' ), |
|
303 |
array( 'status' => rest_authorization_required_code() ) |
|
304 |
); |
|
305 |
} |
|
306 |
||
307 |
return true; |
|
308 |
} |
|
309 |
||
310 |
/** |
|
311 |
* Updates an application password. |
|
312 |
* |
|
313 |
* @since 5.6.0 |
|
314 |
* |
|
315 |
* @param WP_REST_Request $request Full details about the request. |
|
316 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
317 |
*/ |
|
318 |
public function update_item( $request ) { |
|
319 |
$user = $this->get_user( $request ); |
|
320 |
||
321 |
if ( is_wp_error( $user ) ) { |
|
322 |
return $user; |
|
323 |
} |
|
324 |
||
325 |
$item = $this->get_application_password( $request ); |
|
326 |
||
327 |
if ( is_wp_error( $item ) ) { |
|
328 |
return $item; |
|
329 |
} |
|
330 |
||
331 |
$prepared = $this->prepare_item_for_database( $request ); |
|
332 |
||
333 |
if ( is_wp_error( $prepared ) ) { |
|
334 |
return $prepared; |
|
335 |
} |
|
336 |
||
337 |
$saved = WP_Application_Passwords::update_application_password( $user->ID, $item['uuid'], wp_slash( (array) $prepared ) ); |
|
338 |
||
339 |
if ( is_wp_error( $saved ) ) { |
|
340 |
return $saved; |
|
341 |
} |
|
342 |
||
343 |
$fields_update = $this->update_additional_fields_for_object( $item, $request ); |
|
344 |
||
345 |
if ( is_wp_error( $fields_update ) ) { |
|
346 |
return $fields_update; |
|
347 |
} |
|
348 |
||
349 |
$item = WP_Application_Passwords::get_user_application_password( $user->ID, $item['uuid'] ); |
|
350 |
||
351 |
/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.php */ |
|
352 |
do_action( 'rest_after_insert_application_password', $item, $request, false ); |
|
353 |
||
354 |
$request->set_param( 'context', 'edit' ); |
|
355 |
return $this->prepare_item_for_response( $item, $request ); |
|
356 |
} |
|
357 |
||
358 |
/** |
|
| 19 | 359 |
* Checks if a given request has access to delete all application passwords for a user. |
| 18 | 360 |
* |
361 |
* @since 5.6.0 |
|
362 |
* |
|
363 |
* @param WP_REST_Request $request Full details about the request. |
|
364 |
* @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise. |
|
365 |
*/ |
|
366 |
public function delete_items_permissions_check( $request ) { |
|
367 |
$user = $this->get_user( $request ); |
|
368 |
||
369 |
if ( is_wp_error( $user ) ) { |
|
370 |
return $user; |
|
371 |
} |
|
372 |
||
373 |
if ( ! current_user_can( 'delete_app_passwords', $user->ID ) ) { |
|
374 |
return new WP_Error( |
|
375 |
'rest_cannot_delete_application_passwords', |
|
376 |
__( 'Sorry, you are not allowed to delete application passwords for this user.' ), |
|
377 |
array( 'status' => rest_authorization_required_code() ) |
|
378 |
); |
|
379 |
} |
|
380 |
||
381 |
return true; |
|
382 |
} |
|
383 |
||
384 |
/** |
|
| 19 | 385 |
* Deletes all application passwords for a user. |
| 18 | 386 |
* |
387 |
* @since 5.6.0 |
|
388 |
* |
|
389 |
* @param WP_REST_Request $request Full details about the request. |
|
390 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
391 |
*/ |
|
392 |
public function delete_items( $request ) { |
|
393 |
$user = $this->get_user( $request ); |
|
394 |
||
395 |
if ( is_wp_error( $user ) ) { |
|
396 |
return $user; |
|
397 |
} |
|
398 |
||
399 |
$deleted = WP_Application_Passwords::delete_all_application_passwords( $user->ID ); |
|
400 |
||
401 |
if ( is_wp_error( $deleted ) ) { |
|
402 |
return $deleted; |
|
403 |
} |
|
404 |
||
405 |
return new WP_REST_Response( |
|
406 |
array( |
|
407 |
'deleted' => true, |
|
408 |
'count' => $deleted, |
|
409 |
) |
|
410 |
); |
|
411 |
} |
|
412 |
||
413 |
/** |
|
| 19 | 414 |
* Checks if a given request has access to delete a specific application password for a user. |
| 18 | 415 |
* |
416 |
* @since 5.6.0 |
|
417 |
* |
|
418 |
* @param WP_REST_Request $request Full details about the request. |
|
419 |
* @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise. |
|
420 |
*/ |
|
421 |
public function delete_item_permissions_check( $request ) { |
|
422 |
$user = $this->get_user( $request ); |
|
423 |
||
424 |
if ( is_wp_error( $user ) ) { |
|
425 |
return $user; |
|
426 |
} |
|
427 |
||
428 |
if ( ! current_user_can( 'delete_app_password', $user->ID, $request['uuid'] ) ) { |
|
429 |
return new WP_Error( |
|
430 |
'rest_cannot_delete_application_password', |
|
431 |
__( 'Sorry, you are not allowed to delete this application password.' ), |
|
432 |
array( 'status' => rest_authorization_required_code() ) |
|
433 |
); |
|
434 |
} |
|
435 |
||
436 |
return true; |
|
437 |
} |
|
438 |
||
439 |
/** |
|
| 19 | 440 |
* Deletes an application password for a user. |
| 18 | 441 |
* |
442 |
* @since 5.6.0 |
|
443 |
* |
|
444 |
* @param WP_REST_Request $request Full details about the request. |
|
445 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
446 |
*/ |
|
447 |
public function delete_item( $request ) { |
|
448 |
$user = $this->get_user( $request ); |
|
449 |
||
450 |
if ( is_wp_error( $user ) ) { |
|
451 |
return $user; |
|
452 |
} |
|
453 |
||
454 |
$password = $this->get_application_password( $request ); |
|
455 |
||
456 |
if ( is_wp_error( $password ) ) { |
|
457 |
return $password; |
|
458 |
} |
|
459 |
||
460 |
$request->set_param( 'context', 'edit' ); |
|
461 |
$previous = $this->prepare_item_for_response( $password, $request ); |
|
462 |
$deleted = WP_Application_Passwords::delete_application_password( $user->ID, $password['uuid'] ); |
|
463 |
||
464 |
if ( is_wp_error( $deleted ) ) { |
|
465 |
return $deleted; |
|
466 |
} |
|
467 |
||
468 |
return new WP_REST_Response( |
|
469 |
array( |
|
470 |
'deleted' => true, |
|
471 |
'previous' => $previous->get_data(), |
|
472 |
) |
|
473 |
); |
|
474 |
} |
|
475 |
||
476 |
/** |
|
| 19 | 477 |
* Checks if a given request has access to get the currently used application password for a user. |
| 18 | 478 |
* |
479 |
* @since 5.7.0 |
|
480 |
* |
|
481 |
* @param WP_REST_Request $request Full details about the request. |
|
482 |
* @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise. |
|
483 |
*/ |
|
484 |
public function get_current_item_permissions_check( $request ) { |
|
485 |
$user = $this->get_user( $request ); |
|
486 |
||
487 |
if ( is_wp_error( $user ) ) { |
|
488 |
return $user; |
|
489 |
} |
|
490 |
||
491 |
if ( get_current_user_id() !== $user->ID ) { |
|
492 |
return new WP_Error( |
|
493 |
'rest_cannot_introspect_app_password_for_non_authenticated_user', |
|
| 19 | 494 |
__( 'The authenticated application password can only be introspected for the current user.' ), |
| 18 | 495 |
array( 'status' => rest_authorization_required_code() ) |
496 |
); |
|
497 |
} |
|
498 |
||
499 |
return true; |
|
500 |
} |
|
501 |
||
502 |
/** |
|
| 19 | 503 |
* Retrieves the application password being currently used for authentication of a user. |
| 18 | 504 |
* |
505 |
* @since 5.7.0 |
|
506 |
* |
|
507 |
* @param WP_REST_Request $request Full details about the request. |
|
508 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
509 |
*/ |
|
510 |
public function get_current_item( $request ) { |
|
511 |
$user = $this->get_user( $request ); |
|
512 |
||
513 |
if ( is_wp_error( $user ) ) { |
|
514 |
return $user; |
|
515 |
} |
|
516 |
||
517 |
$uuid = rest_get_authenticated_app_password(); |
|
518 |
||
519 |
if ( ! $uuid ) { |
|
520 |
return new WP_Error( |
|
521 |
'rest_no_authenticated_app_password', |
|
| 19 | 522 |
__( 'Cannot introspect application password.' ), |
| 18 | 523 |
array( 'status' => 404 ) |
524 |
); |
|
525 |
} |
|
526 |
||
527 |
$password = WP_Application_Passwords::get_user_application_password( $user->ID, $uuid ); |
|
528 |
||
529 |
if ( ! $password ) { |
|
530 |
return new WP_Error( |
|
531 |
'rest_application_password_not_found', |
|
532 |
__( 'Application password not found.' ), |
|
533 |
array( 'status' => 500 ) |
|
534 |
); |
|
535 |
} |
|
536 |
||
537 |
return $this->prepare_item_for_response( $password, $request ); |
|
538 |
} |
|
539 |
||
540 |
/** |
|
541 |
* Performs a permissions check for the request. |
|
542 |
* |
|
543 |
* @since 5.6.0 |
|
544 |
* @deprecated 5.7.0 Use `edit_user` directly or one of the specific meta capabilities introduced in 5.7.0. |
|
545 |
* |
|
546 |
* @param WP_REST_Request $request |
|
547 |
* @return true|WP_Error |
|
548 |
*/ |
|
549 |
protected function do_permissions_check( $request ) { |
|
550 |
_deprecated_function( __METHOD__, '5.7.0' ); |
|
551 |
||
552 |
$user = $this->get_user( $request ); |
|
553 |
||
554 |
if ( is_wp_error( $user ) ) { |
|
555 |
return $user; |
|
556 |
} |
|
557 |
||
558 |
if ( ! current_user_can( 'edit_user', $user->ID ) ) { |
|
559 |
return new WP_Error( |
|
560 |
'rest_cannot_manage_application_passwords', |
|
561 |
__( 'Sorry, you are not allowed to manage application passwords for this user.' ), |
|
562 |
array( 'status' => rest_authorization_required_code() ) |
|
563 |
); |
|
564 |
} |
|
565 |
||
566 |
return true; |
|
567 |
} |
|
568 |
||
569 |
/** |
|
570 |
* Prepares an application password for a create or update operation. |
|
571 |
* |
|
572 |
* @since 5.6.0 |
|
573 |
* |
|
574 |
* @param WP_REST_Request $request Request object. |
|
575 |
* @return object|WP_Error The prepared item, or WP_Error object on failure. |
|
576 |
*/ |
|
577 |
protected function prepare_item_for_database( $request ) { |
|
578 |
$prepared = (object) array( |
|
579 |
'name' => $request['name'], |
|
580 |
); |
|
581 |
||
582 |
if ( $request['app_id'] && ! $request['uuid'] ) { |
|
583 |
$prepared->app_id = $request['app_id']; |
|
584 |
} |
|
585 |
||
586 |
/** |
|
587 |
* Filters an application password before it is inserted via the REST API. |
|
588 |
* |
|
589 |
* @since 5.6.0 |
|
590 |
* |
|
591 |
* @param stdClass $prepared An object representing a single application password prepared for inserting or updating the database. |
|
592 |
* @param WP_REST_Request $request Request object. |
|
593 |
*/ |
|
594 |
return apply_filters( 'rest_pre_insert_application_password', $prepared, $request ); |
|
595 |
} |
|
596 |
||
597 |
/** |
|
598 |
* Prepares the application password for the REST response. |
|
599 |
* |
|
600 |
* @since 5.6.0 |
|
601 |
* |
|
602 |
* @param array $item WordPress representation of the item. |
|
603 |
* @param WP_REST_Request $request Request object. |
|
604 |
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. |
|
605 |
*/ |
|
606 |
public function prepare_item_for_response( $item, $request ) { |
|
607 |
$user = $this->get_user( $request ); |
|
608 |
||
609 |
if ( is_wp_error( $user ) ) { |
|
610 |
return $user; |
|
611 |
} |
|
612 |
||
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
613 |
$fields = $this->get_fields_for_response( $request ); |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
614 |
|
| 18 | 615 |
$prepared = array( |
616 |
'uuid' => $item['uuid'], |
|
617 |
'app_id' => empty( $item['app_id'] ) ? '' : $item['app_id'], |
|
618 |
'name' => $item['name'], |
|
619 |
'created' => gmdate( 'Y-m-d\TH:i:s', $item['created'] ), |
|
620 |
'last_used' => $item['last_used'] ? gmdate( 'Y-m-d\TH:i:s', $item['last_used'] ) : null, |
|
621 |
'last_ip' => $item['last_ip'] ? $item['last_ip'] : null, |
|
622 |
); |
|
623 |
||
624 |
if ( isset( $item['new_password'] ) ) { |
|
625 |
$prepared['password'] = $item['new_password']; |
|
626 |
} |
|
627 |
||
628 |
$prepared = $this->add_additional_fields_to_object( $prepared, $request ); |
|
629 |
$prepared = $this->filter_response_by_context( $prepared, $request['context'] ); |
|
630 |
||
631 |
$response = new WP_REST_Response( $prepared ); |
|
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
632 |
|
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
633 |
if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) { |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
634 |
$response->add_links( $this->prepare_links( $user, $item ) ); |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
635 |
} |
| 18 | 636 |
|
637 |
/** |
|
638 |
* Filters the REST API response for an application password. |
|
639 |
* |
|
640 |
* @since 5.6.0 |
|
641 |
* |
|
642 |
* @param WP_REST_Response $response The response object. |
|
643 |
* @param array $item The application password array. |
|
644 |
* @param WP_REST_Request $request The request object. |
|
645 |
*/ |
|
646 |
return apply_filters( 'rest_prepare_application_password', $response, $item, $request ); |
|
647 |
} |
|
648 |
||
649 |
/** |
|
650 |
* Prepares links for the request. |
|
651 |
* |
|
652 |
* @since 5.6.0 |
|
653 |
* |
|
654 |
* @param WP_User $user The requested user. |
|
655 |
* @param array $item The application password. |
|
656 |
* @return array The list of links. |
|
657 |
*/ |
|
658 |
protected function prepare_links( WP_User $user, $item ) { |
|
659 |
return array( |
|
660 |
'self' => array( |
|
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
661 |
'href' => rest_url( |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
662 |
sprintf( |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
663 |
'%s/users/%d/application-passwords/%s', |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
664 |
$this->namespace, |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
665 |
$user->ID, |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
666 |
$item['uuid'] |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
667 |
) |
|
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
668 |
), |
| 18 | 669 |
), |
670 |
); |
|
671 |
} |
|
672 |
||
673 |
/** |
|
674 |
* Gets the requested user. |
|
675 |
* |
|
676 |
* @since 5.6.0 |
|
677 |
* |
|
678 |
* @param WP_REST_Request $request The request object. |
|
679 |
* @return WP_User|WP_Error The WordPress user associated with the request, or a WP_Error if none found. |
|
680 |
*/ |
|
681 |
protected function get_user( $request ) { |
|
682 |
if ( ! wp_is_application_passwords_available() ) { |
|
683 |
return new WP_Error( |
|
684 |
'application_passwords_disabled', |
|
685 |
__( 'Application passwords are not available.' ), |
|
686 |
array( 'status' => 501 ) |
|
687 |
); |
|
688 |
} |
|
689 |
||
690 |
$error = new WP_Error( |
|
691 |
'rest_user_invalid_id', |
|
692 |
__( 'Invalid user ID.' ), |
|
693 |
array( 'status' => 404 ) |
|
694 |
); |
|
695 |
||
696 |
$id = $request['user_id']; |
|
697 |
||
698 |
if ( 'me' === $id ) { |
|
699 |
if ( ! is_user_logged_in() ) { |
|
700 |
return new WP_Error( |
|
701 |
'rest_not_logged_in', |
|
702 |
__( 'You are not currently logged in.' ), |
|
703 |
array( 'status' => 401 ) |
|
704 |
); |
|
705 |
} |
|
706 |
||
707 |
$user = wp_get_current_user(); |
|
708 |
} else { |
|
709 |
$id = (int) $id; |
|
710 |
||
711 |
if ( $id <= 0 ) { |
|
712 |
return $error; |
|
713 |
} |
|
714 |
||
715 |
$user = get_userdata( $id ); |
|
716 |
} |
|
717 |
||
718 |
if ( empty( $user ) || ! $user->exists() ) { |
|
719 |
return $error; |
|
720 |
} |
|
721 |
||
|
21
48c4eec2b7e6
Add CLAUDE.md documentation and sync WordPress core files
ymh <ymh.work@gmail.com>
parents:
19
diff
changeset
|
722 |
if ( is_multisite() && ! user_can( $user->ID, 'manage_sites' ) && ! is_user_member_of_blog( $user->ID ) ) { |
| 18 | 723 |
return $error; |
724 |
} |
|
725 |
||
726 |
if ( ! wp_is_application_passwords_available_for_user( $user ) ) { |
|
727 |
return new WP_Error( |
|
728 |
'application_passwords_disabled_for_user', |
|
729 |
__( 'Application passwords are not available for your account. Please contact the site administrator for assistance.' ), |
|
730 |
array( 'status' => 501 ) |
|
731 |
); |
|
732 |
} |
|
733 |
||
734 |
return $user; |
|
735 |
} |
|
736 |
||
737 |
/** |
|
| 19 | 738 |
* Gets the requested application password for a user. |
| 18 | 739 |
* |
740 |
* @since 5.6.0 |
|
741 |
* |
|
742 |
* @param WP_REST_Request $request The request object. |
|
743 |
* @return array|WP_Error The application password details if found, a WP_Error otherwise. |
|
744 |
*/ |
|
745 |
protected function get_application_password( $request ) { |
|
746 |
$user = $this->get_user( $request ); |
|
747 |
||
748 |
if ( is_wp_error( $user ) ) { |
|
749 |
return $user; |
|
750 |
} |
|
751 |
||
752 |
$password = WP_Application_Passwords::get_user_application_password( $user->ID, $request['uuid'] ); |
|
753 |
||
754 |
if ( ! $password ) { |
|
755 |
return new WP_Error( |
|
756 |
'rest_application_password_not_found', |
|
757 |
__( 'Application password not found.' ), |
|
758 |
array( 'status' => 404 ) |
|
759 |
); |
|
760 |
} |
|
761 |
||
762 |
return $password; |
|
763 |
} |
|
764 |
||
765 |
/** |
|
766 |
* Retrieves the query params for the collections. |
|
767 |
* |
|
768 |
* @since 5.6.0 |
|
769 |
* |
|
770 |
* @return array Query parameters for the collection. |
|
771 |
*/ |
|
772 |
public function get_collection_params() { |
|
773 |
return array( |
|
774 |
'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
775 |
); |
|
776 |
} |
|
777 |
||
778 |
/** |
|
779 |
* Retrieves the application password's schema, conforming to JSON Schema. |
|
780 |
* |
|
781 |
* @since 5.6.0 |
|
782 |
* |
|
783 |
* @return array Item schema data. |
|
784 |
*/ |
|
785 |
public function get_item_schema() { |
|
786 |
if ( $this->schema ) { |
|
787 |
return $this->add_additional_fields_schema( $this->schema ); |
|
788 |
} |
|
789 |
||
790 |
$this->schema = array( |
|
791 |
'$schema' => 'http://json-schema.org/draft-04/schema#', |
|
792 |
'title' => 'application-password', |
|
793 |
'type' => 'object', |
|
794 |
'properties' => array( |
|
795 |
'uuid' => array( |
|
796 |
'description' => __( 'The unique identifier for the application password.' ), |
|
797 |
'type' => 'string', |
|
798 |
'format' => 'uuid', |
|
799 |
'context' => array( 'view', 'edit', 'embed' ), |
|
800 |
'readonly' => true, |
|
801 |
), |
|
802 |
'app_id' => array( |
|
| 19 | 803 |
'description' => __( 'A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.' ), |
| 18 | 804 |
'type' => 'string', |
805 |
'format' => 'uuid', |
|
806 |
'context' => array( 'view', 'edit', 'embed' ), |
|
807 |
), |
|
808 |
'name' => array( |
|
809 |
'description' => __( 'The name of the application password.' ), |
|
810 |
'type' => 'string', |
|
811 |
'required' => true, |
|
812 |
'context' => array( 'view', 'edit', 'embed' ), |
|
813 |
'minLength' => 1, |
|
814 |
'pattern' => '.*\S.*', |
|
815 |
), |
|
816 |
'password' => array( |
|
817 |
'description' => __( 'The generated password. Only available after adding an application.' ), |
|
818 |
'type' => 'string', |
|
819 |
'context' => array( 'edit' ), |
|
820 |
'readonly' => true, |
|
821 |
), |
|
822 |
'created' => array( |
|
823 |
'description' => __( 'The GMT date the application password was created.' ), |
|
824 |
'type' => 'string', |
|
825 |
'format' => 'date-time', |
|
826 |
'context' => array( 'view', 'edit' ), |
|
827 |
'readonly' => true, |
|
828 |
), |
|
829 |
'last_used' => array( |
|
830 |
'description' => __( 'The GMT date the application password was last used.' ), |
|
831 |
'type' => array( 'string', 'null' ), |
|
832 |
'format' => 'date-time', |
|
833 |
'context' => array( 'view', 'edit' ), |
|
834 |
'readonly' => true, |
|
835 |
), |
|
836 |
'last_ip' => array( |
|
837 |
'description' => __( 'The IP address the application password was last used by.' ), |
|
838 |
'type' => array( 'string', 'null' ), |
|
839 |
'format' => 'ip', |
|
840 |
'context' => array( 'view', 'edit' ), |
|
841 |
'readonly' => true, |
|
842 |
), |
|
843 |
), |
|
844 |
); |
|
845 |
||
846 |
return $this->add_additional_fields_schema( $this->schema ); |
|
847 |
} |
|
848 |
} |