class.wpcom-json-api-update-media-v1-1-endpoint.php — Jetpack – WP Security, Backup, Speed, & Growth 16.2-a.1

jetpack / json-endpoints / class.wpcom-json-api-update-media-v1-1-endpoint.php

jetpack / json-endpoints Last commit date

class.wpcom-json-api-update-media-v1-1-endpoint.php

250 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Update media item info v1.1 endpoint.
4	*
5	* Endpoint: v1.1/sites/%s/media/%d
6	*/
7
8	if ( ! defined( 'ABSPATH' ) ) {
9	exit( 0 );
10	}
11
12	new WPCOM_JSON_API_Update_Media_v1_1_Endpoint(
13	array(
14	'description' => 'Edit basic information about a media item.',
15	'group' => 'media',
16	'stat' => 'media:1:POST',
17	'min_version' => '1.1',
18	'max_version' => '1.1',
19	'method' => 'POST',
20	'path' => '/sites/%s/media/%d',
21	'path_labels' => array(
22	'$site' => '(int\|string) Site ID or domain',
23	'$media_ID' => '(int) The ID of the media item',
24	),
25
26	'request_format' => array(
27	'parent_id' => '(int) ID of the post this media is attached to',
28	'title' => '(string) The file name.',
29	'caption' => '(string) File caption.',
30	'description' => '(HTML) Description of the file.',
31	'alt' => '(string) Alternative text for image files.',
32	'rating' => '(string) Video only. Video rating.',
33	'display_embed' => '(string) Video only. Whether to share or not the video.',
34	'allow_download' => '(string) Video only. Whether the video can be downloaded or not.',
35	'privacy_setting' => '(int) Video only. The privacy level for the video.',
36	'artist' => '(string) Audio Only. Artist metadata for the audio track.',
37	'album' => '(string) Audio Only. Album metadata for the audio track.',
38	),
39
40	'response_format' => array(
41	'ID' => '(int) The ID of the media item',
42	'date' => '(ISO 8601 datetime) The date the media was uploaded',
43	'post_ID' => '(int) ID of the post this media is attached to',
44	'author_ID' => '(int) ID of the user who uploaded the media',
45	'URL' => '(string) URL to the file',
46	'guid' => '(string) Unique identifier',
47	'file' => '(string) File name',
48	'extension' => '(string) File extension',
49	'mime_type' => '(string) File mime type',
50	'title' => '(string) File name',
51	'caption' => '(string) User provided caption of the file',
52	'description' => '(string) Description of the file',
53	'alt' => '(string) Alternative text for image files.',
54	'thumbnails' => '(object) Media item thumbnail URL options',
55	'height' => '(int) (Image & video only) Height of the media item',
56	'width' => '(int) (Image & video only) Width of the media item',
57	'length' => '(int) (Video & audio only) Duration of the media item, in seconds',
58	'exif' => '(array) (Image & audio only) Exif (meta) information about the media item',
59	'rating' => '(string) (Video only) VideoPress rating of the video',
60	'display_embed' => '(string) Video only. Whether to share or not the video.',
61	'allow_download' => '(string) Video only. Whether the video can be downloaded or not.',
62	'privacy_setting' => '(int) Video only. The privacy level for the video.',
63	'videopress_guid' => '(string) (Video only) VideoPress GUID of the video when uploaded on a blog with VideoPress',
64	'videopress_processing_done' => '(bool) (Video only) If the video is uploaded on a blog with VideoPress, this will return the status of processing on the video.',
65	),
66
67	'example_request' => 'https://public-api.wordpress.com/rest/v1.1/sites/82974409/media/446',
68	'example_request_data' => array(
69	'headers' => array(
70	'authorization' => 'Bearer YOUR_API_TOKEN',
71	),
72	'body' => array(
73	'title' => 'Updated Title',
74	),
75	),
76	)
77	);
78
79	// phpcs:disable PEAR.NamingConventions.ValidClassName.Invalid
80	/**
81	* Update media item info v1.1 class.
82	*
83	* @phan-constructor-used-for-side-effects
84	*/
85	class WPCOM_JSON_API_Update_Media_v1_1_Endpoint extends WPCOM_JSON_API_Endpoint {
86	/**
87	* Whether the current user may edit the given media item.
88	*
89	* `upload_files` is a primitive capability and ignores any object passed to it,
90	* so it only tells us the caller may upload something, never that they may edit
91	* this particular item. A missing item is passed through so the caller receives
92	* the endpoint's own 404 rather than a 403. A userless request gets no exemption:
93	* `edit_post` fails closed for user 0 like any other caller.
94	*
95	* Non-attachments are refused outright. `get_post()` resolves any post type, so
96	* without this test a media endpoint edits ordinary posts, pages and revisions.
97	* The post-type test must stay below the missing-post passthrough: that branch
98	* returns true, so testing there would skip `edit_post` for ordinary posts.
99	*
100	* A non-attachment yields 403, not the 404 a missing item gets. This is a boolean
101	* gate, and `get_media_item*()` resolves any post type, so a passthrough would
102	* return 200 rather than 404. Revisit if clients conflate it with an auth failure.
103	*
104	* Do not move this into a trait: this file instantiates the endpoint above the
105	* class declaration, and `use Trait;` disables PHP early binding, which makes the
106	* file fatal with "Class not found".
107	*
108	* @param int $media_id Media post ID.
109	* @return bool
110	*/
111	protected function current_user_can_edit_media_item( $media_id ) {
112	if ( ! current_user_can( 'upload_files' ) ) {
113	return false;
114	}
115
116	$post = get_post( $media_id );
117
118	if ( ! $post ) {
119	return true;
120	}
121
122	if ( 'attachment' !== $post->post_type ) {
123	return false;
124	}
125
126	return current_user_can( 'edit_post', $media_id );
127	}
128
129	/**
130	* Update media item info API v1.1 callback.
131	*
132	* @param string $path API path.
133	* @param int $blog_id Blog ID.
134	* @param int $media_id Media ID.
135	*
136	* @return object\|WP_Error
137	*/
138	public function callback( $path = '', $blog_id = 0, $media_id = 0 ) {
139	$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
140	if ( is_wp_error( $blog_id ) ) {
141	return $blog_id;
142	}
143
144	if ( ! $this->current_user_can_edit_media_item( $media_id ) ) {
145	return new WP_Error( 'unauthorized', 'User cannot edit media', 403 );
146	}
147
148	$item = $this->get_media_item_v1_1( $media_id );
149
150	if ( is_wp_error( $item ) ) {
151	return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
152	}
153
154	$input = $this->input( true );
155	$insert = array();
156
157	if ( isset( $input['title'] ) ) {
158	$insert['post_title'] = $input['title'];
159	}
160
161	if ( isset( $input['caption'] ) ) {
162	$insert['post_excerpt'] = $input['caption'];
163	}
164
165	if ( isset( $input['description'] ) ) {
166	$insert['post_content'] = $input['description'];
167	}
168
169	if ( isset( $input['parent_id'] ) ) {
170	$insert['post_parent'] = $input['parent_id'];
171	}
172
173	if ( isset( $input['alt'] ) ) {
174	$alt = wp_strip_all_tags( $input['alt'], true );
175	update_post_meta( $media_id, '_wp_attachment_image_alt', $alt );
176	}
177
178	// audio only artist/album info.
179	if ( str_starts_with( $item->mime_type, 'audio/' ) ) {
180	$changed = false;
181	$id3data = wp_get_attachment_metadata( $media_id );
182
183	if ( ! is_array( $id3data ) ) {
184	$changed = true;
185	$id3data = array();
186	}
187
188	$id3_keys = array(
189	'artist' => __( 'Artist', 'jetpack' ),
190	'album' => __( 'Album', 'jetpack' ),
191	);
192
193	foreach ( $id3_keys as $key => $label ) {
194	if ( isset( $input[ $key ] ) ) {
195	$changed = true;
196	$id3data[ $key ] = wp_strip_all_tags( $input[ $key ], true );
197	}
198	}
199
200	if ( $changed ) {
201	wp_update_attachment_metadata( $media_id, $id3data );
202	}
203	}
204
205	// Pass the item to the handle_video_meta() that checks if it's a VideoPress item and saves it.
206	$result = $this->handle_video_meta( $media_id, $input, $item );
207
208	if ( is_wp_error( $result ) ) {
209	return $result;
210	}
211
212	$insert['ID'] = $media_id;
213	wp_update_post( (object) $insert );
214
215	$item = $this->get_media_item_v1_1( $media_id );
216	return $item;
217	}
218
219	/**
220	* Persist the VideoPress metadata if the given item argument is a VideoPress item.
221	*
222	* @param string $media_id The ID of the video.
223	* @param array $input The request input.
224	* @param stdClass $item The response item.
225	*
226	* @return bool\|WP_Error
227	*/
228	public function handle_video_meta( $media_id, $input, $item ) {
229	if ( ! class_exists( \Videopress_Attachment_Metadata::class ) ) {
230	return false;
231	}
232
233	if ( ! \Videopress_Attachment_Metadata::is_videopress_media( $item ) ) {
234	return false;
235	}
236
237	return \Videopress_Attachment_Metadata::persist_metadata(
238	$media_id,
239	$item->videopress_guid,
240	$input['title'] ?? null,
241	$input['caption'] ?? null,
242	$input['description'] ?? null,
243	$input['rating'] ?? null,
244	$input['display_embed'] ?? null,
245	$input['allow_download'] ?? null,
246	$input['privacy_setting'] ?? null
247	);
248	}
249	}
250