Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
22.48%
29 / 129
33.33%
1 / 3
 CRAP
0.00%
0 / 1
WPCOM_JSON_API_Update_Media_v1_1_Endpoint
45.31%
29 / 64
33.33%
1 / 3
 93.13
0.00%
0 / 1
 current_user_can_edit_media_item
100.00%
5 / 5
100.00%
1 / 1
 3
 callback
50.00%
22 / 44
0.00%
0 / 1
 43.12
 handle_video_meta
13.33%
2 / 15
0.00%
0 / 1
 8.86
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
8if ( ! defined( 'ABSPATH' ) ) {
9    exit( 0 );
10}
11
12new 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 */
85class 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     * Do not move this into a trait: this file instantiates the endpoint above the
96     * class declaration, and `use Trait;` disables PHP early binding, which makes the
97     * file fatal with "Class not found".
98     *
99     * @param int $media_id Media post ID.
100     * @return bool
101     */
102    protected function current_user_can_edit_media_item( $media_id ) {
103        if ( ! current_user_can( 'upload_files' ) ) {
104            return false;
105        }
106
107        if ( ! get_post( $media_id ) ) {
108            return true;
109        }
110
111        return current_user_can( 'edit_post', $media_id );
112    }
113
114    /**
115     * Update media item info API v1.1 callback.
116     *
117     * @param string $path API path.
118     * @param int    $blog_id Blog ID.
119     * @param int    $media_id Media ID.
120     *
121     * @return object|WP_Error
122     */
123    public function callback( $path = '', $blog_id = 0, $media_id = 0 ) {
124        $blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
125        if ( is_wp_error( $blog_id ) ) {
126            return $blog_id;
127        }
128
129        if ( ! $this->current_user_can_edit_media_item( $media_id ) ) {
130            return new WP_Error( 'unauthorized', 'User cannot edit media', 403 );
131        }
132
133        $item = $this->get_media_item_v1_1( $media_id );
134
135        if ( is_wp_error( $item ) ) {
136            return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
137        }
138
139        $input  = $this->input( true );
140        $insert = array();
141
142        if ( isset( $input['title'] ) ) {
143            $insert['post_title'] = $input['title'];
144        }
145
146        if ( isset( $input['caption'] ) ) {
147            $insert['post_excerpt'] = $input['caption'];
148        }
149
150        if ( isset( $input['description'] ) ) {
151            $insert['post_content'] = $input['description'];
152        }
153
154        if ( isset( $input['parent_id'] ) ) {
155            $insert['post_parent'] = $input['parent_id'];
156        }
157
158        if ( isset( $input['alt'] ) ) {
159            $alt = wp_strip_all_tags( $input['alt'], true );
160            update_post_meta( $media_id, '_wp_attachment_image_alt', $alt );
161        }
162
163        // audio only artist/album info.
164        if ( str_starts_with( $item->mime_type, 'audio/' ) ) {
165            $changed = false;
166            $id3data = wp_get_attachment_metadata( $media_id );
167
168            if ( ! is_array( $id3data ) ) {
169                $changed = true;
170                $id3data = array();
171            }
172
173            $id3_keys = array(
174                'artist' => __( 'Artist', 'jetpack' ),
175                'album'  => __( 'Album', 'jetpack' ),
176            );
177
178            foreach ( $id3_keys as $key => $label ) {
179                if ( isset( $input[ $key ] ) ) {
180                    $changed         = true;
181                    $id3data[ $key ] = wp_strip_all_tags( $input[ $key ], true );
182                }
183            }
184
185            if ( $changed ) {
186                wp_update_attachment_metadata( $media_id, $id3data );
187            }
188        }
189
190        // Pass the item to the handle_video_meta() that checks if it's a VideoPress item and saves it.
191        $result = $this->handle_video_meta( $media_id, $input, $item );
192
193        if ( is_wp_error( $result ) ) {
194            return $result;
195        }
196
197        $insert['ID'] = $media_id;
198        wp_update_post( (object) $insert );
199
200        $item = $this->get_media_item_v1_1( $media_id );
201        return $item;
202    }
203
204    /**
205     * Persist the VideoPress metadata if the given item argument is a VideoPress item.
206     *
207     * @param string   $media_id The ID of the video.
208     * @param array    $input    The request input.
209     * @param stdClass $item     The response item.
210     *
211     * @return bool|WP_Error
212     */
213    public function handle_video_meta( $media_id, $input, $item ) {
214        if ( ! class_exists( \Videopress_Attachment_Metadata::class ) ) {
215            return false;
216        }
217
218        if ( ! \Videopress_Attachment_Metadata::is_videopress_media( $item ) ) {
219            return false;
220        }
221
222        return \Videopress_Attachment_Metadata::persist_metadata(
223            $media_id,
224            $item->videopress_guid,
225            $input['title'] ?? null,
226            $input['caption'] ?? null,
227            $input['description'] ?? null,
228            $input['rating'] ?? null,
229            $input['display_embed'] ?? null,
230            $input['allow_download'] ?? null,
231            $input['privacy_setting'] ?? null
232        );
233    }
234}