Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
41.84%
569 / 1360
22.92%
11 / 48
 CRAP
0.00%
0 / 1
WPCOM_JSON_API_Endpoint
41.99%
569 / 1355
22.92%
11 / 48
 46017.86
0.00%
0 / 1
 __construct
97.67%
84 / 86
0.00%
0 / 1
 12
 query_args
75.00%
3 / 4
0.00%
0 / 1
 2.06
 input
71.43%
25 / 35
0.00%
0 / 1
 23.74
 get_secure_body
0.00%
0 / 9
0.00%
0 / 1
 6
 cast_and_filter
87.88%
29 / 33
0.00%
0 / 1
 16.46
 cast_and_filter_item
12.77%
41 / 321
0.00%
0 / 1
 4544.59
 parse_types
94.74%
18 / 19
0.00%
0 / 1
 5.00
 is_publicly_documentable
0.00%
0 / 1
0.00%
0 / 1
 6
 document
0.00%
0 / 55
0.00%
0 / 1
 110
 add_http_build_query_to_php_content_example
0.00%
0 / 5
0.00%
0 / 1
 2
 generate_doc_description
0.00%
0 / 5
0.00%
0 / 1
 12
 generate_documentation
0.00%
0 / 57
0.00%
0 / 1
 210
 user_can_view_post
35.56%
16 / 45
0.00%
0 / 1
 94.35
 get_author
71.56%
78 / 109
0.00%
0 / 1
 68.49
 check_media_item_read_permission
100.00%
6 / 6
100.00%
1 / 1
 4
 get_media_item
88.00%
22 / 25
0.00%
0 / 1
 7.08
 get_media_item_v1_1
51.22%
63 / 123
0.00%
0 / 1
 638.77
 get_taxonomy
75.00%
3 / 4
0.00%
0 / 1
 3.14
 format_taxonomy
77.78%
21 / 27
0.00%
0 / 1
 8.70
 format_date
100.00%
1 / 1
100.00%
1 / 1
 1
 parse_date
52.63%
10 / 19
0.00%
0 / 1
 5.70
 load_theme_functions
0.00%
0 / 28
0.00%
0 / 1
 272
 copy_hooks
0.00%
0 / 19
0.00%
0 / 1
 90
 get_reflection
0.00%
0 / 11
0.00%
0 / 1
 72
 current_user_can_access_post_type
75.00%
6 / 8
0.00%
0 / 1
 6.56
 is_post_type_allowed
53.85%
7 / 13
0.00%
0 / 1
 11.82
 _get_whitelisted_post_types
100.00%
3 / 3
100.00%
1 / 1
 1
 media_item_is_free_video_mobile_upload_and_too_long
0.00%
0 / 31
0.00%
0 / 1
 90
 handle_media_creation_v1_1
46.43%
39 / 84
0.00%
0 / 1
 200.43
 handle_media_sideload
65.22%
15 / 23
0.00%
0 / 1
 18.06
 is_file_supported_for_sideloading
100.00%
1 / 1
100.00%
1 / 1
 1
 allow_video_uploads
9.52%
2 / 21
0.00%
0 / 1
 138.17
 is_current_site_multi_user
0.00%
0 / 11
0.00%
0 / 1
 6
 allows_cross_origin_requests
0.00%
0 / 1
0.00%
0 / 1
 6
 allows_unauthorized_requests
0.00%
0 / 1
0.00%
0 / 1
 12
 accepts_site_based_authentication
100.00%
2 / 2
100.00%
1 / 1
 2
 get_platform
100.00%
1 / 1
100.00%
1 / 1
 1
 force_wpcom_request
0.00%
0 / 1
0.00%
0 / 1
 2
 get_amp_cache_origins
0.00%
0 / 15
0.00%
0 / 1
 12
 create_rest_route_for_endpoint
100.00%
9 / 9
100.00%
1 / 1
 1
 rest_callback
95.74%
45 / 47
0.00%
0 / 1
 17
 rest_permission_callback
0.00%
0 / 15
0.00%
0 / 1
 90
 rest_permission_callback_custom
0.00%
0 / 1
0.00%
0 / 1
 2
 build_rest_route
100.00%
2 / 2
100.00%
1 / 1
 2
 rest_route_has_tokens
100.00%
1 / 1
100.00%
1 / 1
 1
 build_rest_route_regex
100.00%
11 / 11
100.00%
1 / 1
 3
 build_concrete_rest_route
100.00%
5 / 5
100.00%
1 / 1
 2
 get_rest_min_jp_version
0.00%
0 / 1
0.00%
0 / 1
 2
 callback
n/a
0 / 0
n/a
0 / 0
 0
1<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2/**
3 * Jetpack API endpoint base class.
4 *
5 * @package automattic/jetpack
6 */
7
8use Automattic\Jetpack\Connection\Client;
9use Automattic\Jetpack\Connection\Manager;
10use Automattic\Jetpack\Connection\Rest_Authentication;
11use Automattic\Jetpack\Connection\Tokens;
12use Automattic\Jetpack\Status;
13use Automattic\Jetpack\Status\Host;
14
15require_once __DIR__ . '/json-api-config.php';
16require_once __DIR__ . '/sal/class.json-api-links.php';
17require_once __DIR__ . '/sal/class.json-api-metadata.php';
18require_once __DIR__ . '/sal/class.json-api-date.php';
19
20/**
21 * Endpoint.
22 */
23abstract class WPCOM_JSON_API_Endpoint {
24    /**
25     * The API Object
26     *
27     * @var WPCOM_JSON_API
28     */
29    public $api;
30
31    /**
32     * The link-generating utility class
33     *
34     * @var WPCOM_JSON_API_Links
35     */
36    public $links;
37
38    /**
39     * Whether to pass wpcom user details.
40     *
41     * @var bool
42     */
43    public $pass_wpcom_user_details = false;
44
45    /**
46     * One liner.
47     *
48     * @var string
49     */
50    public $description;
51
52    /**
53     * Object Grouping For Documentation (Users, Posts, Comments)
54     *
55     * @var string
56     */
57    public $group;
58
59    /**
60     * Stats extra value to bump
61     *
62     * @var mixed
63     */
64    public $stat;
65
66    /**
67     * HTTP Method
68     *
69     * @var string
70     */
71    public $method = 'GET';
72
73    /**
74     * Minimum version of the api for which to serve this endpoint
75     *
76     * @var string
77     */
78    public $min_version = '0';
79
80    /**
81     * Maximum version of the api for which to serve this endpoint
82     *
83     * @var string
84     */
85    public $max_version = WPCOM_JSON_API__CURRENT_VERSION;
86
87    /**
88     * Forced endpoint environment when running on WPCOM
89     *
90     * @var string '', 'wpcom', 'secure', or 'jetpack'
91     */
92    public $force = '';
93
94    /**
95     * Whether the endpoint is deprecated
96     *
97     * @var bool
98     */
99    public $deprecated = false;
100
101    /**
102     * Version of the endpoint this endpoint is deprecated in favor of.
103     *
104     * @var string
105     */
106    protected $new_version = WPCOM_JSON_API__CURRENT_VERSION;
107
108    /**
109     * Whether the endpoint is only available on WordPress.com hosted blogs
110     *
111     * @var bool
112     */
113    public $jp_disabled = false;
114
115    /**
116     * Path at which to serve this endpoint: sprintf() format.
117     *
118     * @var string
119     */
120    public $path = '';
121
122    /**
123     * Identifiers to fill sprintf() formatted $path
124     *
125     * @var array
126     */
127    public $path_labels = array();
128
129    /**
130     * The REST endpoint if available.
131     *
132     * @var string
133     */
134    public $rest_route;
135
136    /**
137     * Jetpack Version in which REST support was introduced.
138     *
139     * @var string
140     */
141    public $rest_min_jp_version;
142
143    /**
144     * Accepted query parameters
145     *
146     * @var array
147     */
148    public $query = array(
149        // Parameter name.
150        'context'       => array(
151            // Default value => description.
152            'display' => 'Formats the output as HTML for display.  Shortcodes are parsed, paragraph tags are added, etc..',
153            // Other possible values => description.
154            'edit'    => 'Formats the output for editing.  Shortcodes are left unparsed, significant whitespace is kept, etc..',
155        ),
156        'http_envelope' => array(
157            'false' => '',
158            'true'  => 'Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code.  Setting this parameter will force the HTTP status code to always be 200.  The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.',
159        ),
160        'pretty'        => array(
161            'false' => '',
162            'true'  => 'Output pretty JSON',
163        ),
164        'meta'          => "(string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes",
165        'fields'        => '(string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title',
166        // Parameter name => description (default value is empty).
167        'callback'      => '(string) An optional JSONP callback function.',
168    );
169
170    /**
171     * Response format
172     *
173     * @var array
174     */
175    public $response_format = array();
176
177    /**
178     * Request format
179     *
180     * @var array
181     */
182    public $request_format = array();
183
184    /**
185     * Is this endpoint still in testing phase?  If so, not available to the public.
186     *
187     * @var bool
188     */
189    public $in_testing = false;
190
191    /**
192     * Is this endpoint still allowed if the site in question is flagged?
193     *
194     * @var bool
195     */
196    public $allowed_if_flagged = false;
197
198    /**
199     * Is this endpoint allowed if the site is red flagged?
200     *
201     * @var bool
202     */
203    public $allowed_if_red_flagged = false;
204
205    /**
206     * Is this endpoint allowed if the site is deleted?
207     *
208     * @var bool
209     */
210    public $allowed_if_deleted = false;
211
212    /**
213     * Version of the API
214     *
215     * @var string
216     */
217    public $version = '';
218
219    /**
220     * Example request to make
221     *
222     * @var string
223     */
224    public $example_request = '';
225
226    /**
227     * Example request data (for POST methods)
228     *
229     * @var string
230     */
231    public $example_request_data = '';
232
233    /**
234     * Example response from $example_request
235     *
236     * @var string
237     */
238    public $example_response = '';
239
240    /**
241     * OAuth2 scope required when running on WPCOM
242     *
243     * @var string
244     */
245    public $required_scope = '';
246
247    /**
248     * Set to true if the endpoint implements its own filtering instead of the standard `fields` query method
249     *
250     * @var bool
251     */
252    public $custom_fields_filtering = false;
253
254    /**
255     * Set to true if the endpoint accepts all cross origin requests. You probably should not set this flag.
256     *
257     * @var bool
258     */
259    public $allow_cross_origin_request = false;
260
261    /**
262     * Set to true if the endpoint can recieve unauthorized POST requests.
263     *
264     * @var bool
265     */
266    public $allow_unauthorized_request = false;
267
268    /**
269     * Set to true if the endpoint should accept site based (not user based) authentication.
270     *
271     * @var bool
272     */
273    public $allow_jetpack_site_auth = false;
274
275    /**
276     * Set to true if the endpoint should accept user based authentication.
277     *
278     * @var bool
279     */
280    public $allow_jetpack_token_auth = false;
281
282    /**
283     * Set to true if the endpoint should accept auth from an upload token.
284     *
285     * @var bool
286     */
287    public $allow_upload_token_auth = false;
288
289    /**
290     * Set to true if the endpoint should require auth from a Rewind auth token.
291     *
292     * @var bool
293     */
294    public $require_rewind_auth = false;
295
296    /**
297     * Whether this endpoint allows falling back to a blog token for making requests to remote Jetpack sites.
298     *
299     * @var bool
300     */
301    public $allow_fallback_to_jetpack_blog_token = false;
302
303    /**
304     * REST namespace.
305     */
306    const REST_NAMESPACE = 'jetpack/rest';
307
308    /**
309     * Post object format.
310     *
311     * @var array
312     */
313    public $post_object_format;
314
315    /**
316     * Comment object format.
317     *
318     * @var array
319     */
320    public $comment_object_format;
321
322    /**
323     * Dropdown page object format.
324     *
325     * @var array
326     */
327    public $dropdown_page_object_format;
328
329    /**
330     * Constructor.
331     *
332     * @param string|array|object $args Args.
333     */
334    public function __construct( $args ) {
335        $defaults = array(
336            'in_testing'                           => false,
337            'allowed_if_flagged'                   => false,
338            'allowed_if_red_flagged'               => false,
339            'allowed_if_deleted'                   => false,
340            'description'                          => '',
341            'group'                                => '',
342            'stat'                                 => '',
343            'method'                               => 'GET',
344            'path'                                 => '/',
345            'min_version'                          => '0',
346            'max_version'                          => WPCOM_JSON_API__CURRENT_VERSION,
347            'force'                                => '',
348            'deprecated'                           => false,
349            'new_version'                          => WPCOM_JSON_API__CURRENT_VERSION,
350            'jp_disabled'                          => false,
351            'path_labels'                          => array(),
352            'rest_route'                           => null,
353            'rest_min_jp_version'                  => null,
354            'request_format'                       => array(),
355            'response_format'                      => array(),
356            'query_parameters'                     => array(),
357            'version'                              => 'v1',
358            'example_request'                      => '',
359            'example_request_data'                 => '',
360            'example_response'                     => '',
361            'required_scope'                       => '',
362            'pass_wpcom_user_details'              => false,
363            'custom_fields_filtering'              => false,
364            'allow_cross_origin_request'           => false,
365            'allow_unauthorized_request'           => false,
366            'allow_jetpack_site_auth'              => false,
367            'allow_jetpack_token_auth'             => false,
368            'allow_upload_token_auth'              => false,
369            'allow_fallback_to_jetpack_blog_token' => false,
370        );
371
372        $args = wp_parse_args( $args, $defaults );
373
374        $this->in_testing = $args['in_testing'];
375
376        $this->allowed_if_flagged     = $args['allowed_if_flagged'];
377        $this->allowed_if_red_flagged = $args['allowed_if_red_flagged'];
378        $this->allowed_if_deleted     = $args['allowed_if_deleted'];
379
380        $this->description = $args['description'];
381        $this->group       = $args['group'];
382        $this->stat        = $args['stat'];
383        $this->force       = $args['force'];
384        $this->jp_disabled = $args['jp_disabled'];
385
386        $this->method      = $args['method'];
387        $this->path        = $args['path'];
388        $this->path_labels = $args['path_labels'];
389        $this->min_version = $args['min_version'];
390        $this->max_version = $args['max_version'];
391        $this->deprecated  = $args['deprecated'];
392        $this->new_version = $args['new_version'];
393
394        $this->rest_route          = $args['rest_route'];
395        $this->rest_min_jp_version = $args['rest_min_jp_version'];
396
397        // Ensure max version is not less than min version.
398        if ( version_compare( $this->min_version, $this->max_version, '>' ) ) {
399            $this->max_version = $this->min_version;
400        }
401
402        $this->pass_wpcom_user_details = $args['pass_wpcom_user_details'];
403        $this->custom_fields_filtering = (bool) $args['custom_fields_filtering'];
404
405        $this->allow_cross_origin_request           = (bool) $args['allow_cross_origin_request'];
406        $this->allow_unauthorized_request           = (bool) $args['allow_unauthorized_request'];
407        $this->allow_jetpack_site_auth              = (bool) $args['allow_jetpack_site_auth'];
408        $this->allow_jetpack_token_auth             = (bool) $args['allow_jetpack_token_auth'];
409        $this->allow_upload_token_auth              = (bool) $args['allow_upload_token_auth'];
410        $this->allow_fallback_to_jetpack_blog_token = (bool) $args['allow_fallback_to_jetpack_blog_token'];
411        $this->require_rewind_auth                  = isset( $args['require_rewind_auth'] ) ? (bool) $args['require_rewind_auth'] : false;
412
413        $this->version = $args['version'];
414
415        $this->required_scope = $args['required_scope'];
416
417        if ( $this->request_format ) {
418            $this->request_format = array_filter( array_merge( $this->request_format, $args['request_format'] ) );
419        } else {
420            $this->request_format = $args['request_format'];
421        }
422
423        if ( $this->response_format ) {
424            $this->response_format = array_filter( array_merge( $this->response_format, $args['response_format'] ) );
425        } else {
426            $this->response_format = $args['response_format'];
427        }
428
429        if ( false === $args['query_parameters'] ) {
430            $this->query = array();
431        } elseif ( is_array( $args['query_parameters'] ) ) {
432            $this->query = array_filter( array_merge( $this->query, $args['query_parameters'] ) );
433        }
434
435        $this->api   = WPCOM_JSON_API::init(); // Auto-add to WPCOM_JSON_API.
436        $this->links = WPCOM_JSON_API_Links::getInstance();
437
438        /** Example Request/Response */
439
440        // Examples for endpoint documentation request.
441        $this->example_request      = $args['example_request'];
442        $this->example_request_data = $args['example_request_data'];
443        $this->example_response     = $args['example_response'];
444
445        $this->api->add( $this );
446
447        if ( ( ! defined( 'IS_WPCOM' ) || ! IS_WPCOM ) && $this->rest_route && ( ! defined( 'XMLRPC_REQUEST' ) || ! XMLRPC_REQUEST ) ) {
448            $this->create_rest_route_for_endpoint();
449        }
450    }
451
452    /**
453     * Get all query args. Prefill with defaults.
454     *
455     * @param bool $return_default_values Whether to include default values in the response.
456     * @param bool $cast_and_filter Whether to cast and filter input according to the documentation.
457     * @return array
458     */
459    public function query_args( $return_default_values = true, $cast_and_filter = true ) {
460        $args = array_intersect_key( $this->api->query, $this->query );
461
462        if ( ! $cast_and_filter ) {
463            return $args;
464        }
465
466        return $this->cast_and_filter( $args, $this->query, $return_default_values );
467    }
468
469    /**
470     * Get POST body data.
471     *
472     * @param bool $return_default_values Whether to include default values in the response.
473     * @param bool $cast_and_filter Whether to cast and filter input according to the documentation.
474     * @return mixed
475     */
476    public function input( $return_default_values = true, $cast_and_filter = true ) {
477        $return       = null;
478        $input        = trim( (string) $this->api->post_body );
479        $content_type = (string) $this->api->content_type;
480        if ( $content_type ) {
481            list ( $content_type ) = explode( ';', $content_type );
482        }
483        $content_type = trim( $content_type );
484        switch ( $content_type ) {
485            case 'application/json':
486            case 'application/x-javascript':
487            case 'text/javascript':
488            case 'text/x-javascript':
489            case 'text/x-json':
490            case 'text/json':
491                $return = json_decode( $input, true );
492
493                if ( JSON_ERROR_NONE !== json_last_error() ) {
494                    return null;
495                }
496
497                break;
498            case 'multipart/form-data':
499                // phpcs:ignore WordPress.Security.NonceVerification.Missing
500                $return = array_merge( stripslashes_deep( $_POST ), $_FILES );
501                break;
502            case 'application/x-www-form-urlencoded':
503                // attempt JSON first, since probably a curl command.
504                $return = json_decode( $input, true );
505
506                if ( $return === null ) {
507                    wp_parse_str( $input, $return );
508                }
509
510                break;
511            default:
512                wp_parse_str( $input, $return );
513                break;
514        }
515
516        if ( isset( $this->api->query['force'] )
517            && 'secure' === $this->api->query['force']
518            && isset( $return['secure_key'] ) ) {
519            $this->api->post_body      = $this->get_secure_body( $return['secure_key'] );
520            $this->api->query['force'] = false;
521            return $this->input( $return_default_values, $cast_and_filter );
522        }
523
524        if ( $cast_and_filter ) {
525            $return = $this->cast_and_filter( $return, $this->request_format, $return_default_values );
526        }
527        return $return;
528    }
529
530    /**
531     * Fetch a body via secure request.
532     *
533     * @param string $secure_key Key for the request.
534     * @return mixed|null API response, or null if the request failed.
535     */
536    protected function get_secure_body( $secure_key ) {
537        $response = Client::wpcom_json_api_request_as_blog(
538            sprintf( '/sites/%d/secure-request', Jetpack_Options::get_option( 'id' ) ),
539            '1.1',
540            array( 'method' => 'POST' ),
541            array( 'secure_key' => $secure_key )
542        );
543        if ( 200 !== $response['response']['code'] ) {
544            return null;
545        }
546        return json_decode( $response['body'], true );
547    }
548
549    /**
550     * Cast and filter data.
551     *
552     * @param mixed $data Data to cast and filter.
553     * @param array $documentation Documentation for keys in `$data` to keep and cast.
554     * @param bool  $return_default_values Set default values from `$documentation` to process.
555     * @param bool  $for_output See `$this->cast_and_filter_item()`.
556     * @return mixed Filtered data.
557     */
558    public function cast_and_filter( $data, $documentation, $return_default_values = false, $for_output = false ) {
559        $return_as_object = false;
560        if ( is_object( $data ) ) {
561            // @todo this should probably be a deep copy if $data can ever have nested objects
562            $data             = (array) $data;
563            $return_as_object = true;
564        } elseif ( ! is_array( $data ) ) {
565            return $data;
566        }
567
568        $boolean_arg = array( 'false', 'true' );
569        $naeloob_arg = array( 'true', 'false' );
570
571        $return = array();
572
573        foreach ( $documentation as $key => $description ) {
574            if ( is_array( $description ) ) {
575                // String or boolean array keys only.
576                $whitelist = array_keys( $description );
577
578                if ( $whitelist === $boolean_arg || $whitelist === $naeloob_arg ) {
579                    // Truthiness.
580                    if ( isset( $data[ $key ] ) ) {
581                        $return[ $key ] = (bool) WPCOM_JSON_API::is_truthy( $data[ $key ] );
582                    } elseif ( $return_default_values ) {
583                        $return[ $key ] = $whitelist === $naeloob_arg; // Default to true for naeloob_arg and false for boolean_arg.
584                    }
585                } elseif ( isset( $data[ $key ] ) && isset( $description[ $data[ $key ] ] ) ) {
586                    // String Key.
587                    $return[ $key ] = (string) $data[ $key ];
588                } elseif ( $return_default_values ) {
589                    // Default value.
590                    $return[ $key ] = (string) current( $whitelist );
591                }
592
593                continue;
594            }
595
596            $types = $this->parse_types( $description );
597            $type  = array_shift( $types );
598
599            // Explicit default - string and int only for now.  Always set these reguardless of $return_default_values.
600            if ( isset( $type['default'] ) ) {
601                if ( ! isset( $data[ $key ] ) ) {
602                    $data[ $key ] = $type['default'];
603                }
604            }
605
606            if ( ! isset( $data[ $key ] ) ) {
607                continue;
608            }
609
610            $this->cast_and_filter_item( $return, $type, $key, $data[ $key ], $types, $for_output );
611        }
612
613        if ( $return_as_object ) {
614            return (object) $return;
615        }
616
617        return $return;
618    }
619
620    /**
621     * Casts $value according to $type.
622     * Handles fallbacks for certain values of $type when $value is not that $type
623     * Currently, only handles fallback between string <-> array (two way), from string -> false (one way), and from object -> false (one way),
624     * and string -> object (one way)
625     *
626     * Handles "child types" - array:URL, object:category
627     * array:URL means an array of URLs
628     * object:category means a hash of categories
629     *
630     * Handles object typing - object>post means an object of type post
631     *
632     * @param array        $return Array to assign the value into.
633     * @param string|array $type Type to cast.
634     * @param string|int   $key Key in `$return` to assign the value to.
635     * @param mixed        $value Value to cast.
636     * @param array        $types Fallback types.
637     * @param bool         $for_output Appears to affect formatting of 'date' types.
638     */
639    public function cast_and_filter_item( &$return, $type, $key, $value, $types = array(), $for_output = false ) {
640        if ( is_string( $type ) ) {
641            $type = compact( 'type' );
642        }
643
644        switch ( $type['type'] ) {
645            case 'false':
646                $return[ $key ] = false;
647                break;
648            case 'url':
649                if ( is_object( $value ) && isset( $value->url ) && str_contains( $value->url, 'https://videos.files.wordpress.com/' ) ) {
650                    $value = $value->url;
651                }
652                // Check for string since esc_url_raw() expects one.
653                if ( ! is_string( $value ) ) {
654                    break;
655                }
656                $return[ $key ] = (string) esc_url_raw( $value );
657                break;
658            case 'string':
659                // Fallback string -> array, or for string -> object.
660                if ( is_array( $value ) || is_object( $value ) ) {
661                    if ( ! empty( $types[0] ) ) {
662                        $next_type = array_shift( $types );
663                        return $this->cast_and_filter_item( $return, $next_type, $key, $value, $types, $for_output );
664                    }
665                }
666
667                // Fallback string -> false.
668                if ( ! is_string( $value ) ) {
669                    if ( ! empty( $types[0] ) && 'false' === $types[0]['type'] ) {
670                        $next_type = array_shift( $types );
671                        return $this->cast_and_filter_item( $return, $next_type, $key, $value, $types, $for_output );
672                    }
673                    if ( is_array( $value ) ) {
674                        // Give up rather than setting the value to the string 'Array'.
675                        break;
676                    }
677                }
678                $return[ $key ] = (string) $value;
679                break;
680            case 'html':
681                $return[ $key ] = (string) $value;
682                break;
683            case 'safehtml':
684                $return[ $key ] = wp_kses( (string) $value, wp_kses_allowed_html() );
685                break;
686            case 'zip':
687            case 'media':
688                if ( is_array( $value ) ) {
689                    if ( isset( $value['name'] ) && is_array( $value['name'] ) ) {
690                        // It's a $_FILES array
691                        // Reformat into array of $_FILES items.
692                        $files = array();
693
694                        foreach ( $value['name'] as $k => $v ) {
695                            $files[ $k ] = array();
696                            foreach ( array_keys( $value ) as $file_key ) {
697                                $files[ $k ][ $file_key ] = $value[ $file_key ][ $k ];
698                            }
699                        }
700
701                        foreach ( $files as $k => $file ) {
702                            if ( ! isset( $file['tmp_name'] ) || ! is_string( $file['tmp_name'] ) || ! is_uploaded_file( $file['tmp_name'] ) ) {
703                                unset( $files[ $k ] );
704                            }
705                        }
706                        if ( $files ) {
707                            $return[ $key ] = $files;
708                        }
709                    } elseif ( isset( $value['tmp_name'] ) && is_string( $value['tmp_name'] ) && is_uploaded_file( $value['tmp_name'] ) ) {
710                        $return[ $key ] = $value;
711                    }
712                }
713                break;
714            case 'array':
715                // Fallback array -> string.
716                if ( is_string( $value ) ) {
717                    if ( ! empty( $types[0] ) ) {
718                        $next_type = array_shift( $types );
719                        return $this->cast_and_filter_item( $return, $next_type, $key, $value, $types, $for_output );
720                    }
721                }
722
723                if ( isset( $type['children'] ) ) {
724                    $children = array();
725                    foreach ( (array) $value as $k => $child ) {
726                        $this->cast_and_filter_item( $children, $type['children'], $k, $child, array(), $for_output );
727                    }
728                    $return[ $key ] = (array) $children;
729                    break;
730                }
731
732                $return[ $key ] = (array) $value;
733                break;
734            case 'iso 8601 datetime':
735            case 'datetime':
736                // (string)s
737                $dates = $this->parse_date( (string) $value );
738                if ( $for_output ) {
739                    $return[ $key ] = $this->format_date( $dates[1], $dates[0] );
740                } else {
741                    list( $return[ $key ], $return[ "{$key}_gmt" ] ) = $dates;
742                }
743                break;
744            case 'float':
745                $return[ $key ] = (float) $value;
746                break;
747            case 'int':
748            case 'integer':
749                $return[ $key ] = (int) $value;
750                break;
751            case 'bool':
752            case 'boolean':
753                $return[ $key ] = (bool) WPCOM_JSON_API::is_truthy( $value );
754                break;
755            case 'object':
756                // Fallback object -> false.
757                if ( is_scalar( $value ) || $value === null ) {
758                    if ( ! empty( $types[0] ) && 'false' === $types[0]['type'] ) {
759                        return $this->cast_and_filter_item( $return, 'false', $key, $value, $types, $for_output );
760                    }
761                }
762
763                if ( isset( $type['children'] ) ) {
764                    $children = array();
765                    foreach ( (array) $value as $k => $child ) {
766                        $this->cast_and_filter_item( $children, $type['children'], $k, $child, array(), $for_output );
767                    }
768                    $return[ $key ] = (object) $children;
769                    break;
770                }
771
772                if ( isset( $type['subtype'] ) ) {
773                    return $this->cast_and_filter_item( $return, $type['subtype'], $key, $value, $types, $for_output );
774                }
775
776                $return[ $key ] = (object) $value;
777                break;
778            case 'post':
779                $return[ $key ] = (object) $this->cast_and_filter( $value, $this->post_object_format, false, $for_output );
780                break;
781            case 'comment':
782                $return[ $key ] = (object) $this->cast_and_filter( $value, $this->comment_object_format, false, $for_output );
783                break;
784            case 'tag':
785            case 'category':
786                $docs = array(
787                    'ID'          => '(int)',
788                    'name'        => '(string)',
789                    'slug'        => '(string)',
790                    'description' => '(HTML)',
791                    'post_count'  => '(int)',
792                    'feed_url'    => '(string)',
793                    'meta'        => '(object)',
794                );
795                if ( 'category' === $type['type'] ) {
796                    $docs['parent'] = '(int)';
797                }
798                $return[ $key ] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
799                break;
800            case 'post_reference':
801            case 'comment_reference':
802                $docs           = array(
803                    'ID'    => '(int)',
804                    'type'  => '(string)',
805                    'title' => '(string)',
806                    'link'  => '(URL)',
807                );
808                $return[ $key ] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
809                break;
810            case 'geo':
811                $docs           = array(
812                    'latitude'  => '(float)',
813                    'longitude' => '(float)',
814                    'address'   => '(string)',
815                );
816                $return[ $key ] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
817                break;
818            case 'author':
819                $docs           = array(
820                    'ID'             => '(int)',
821                    'user_login'     => '(string)',
822                    'login'          => '(string)',
823                    'email'          => '(string|false)',
824                    'name'           => '(string)',
825                    'first_name'     => '(string)',
826                    'last_name'      => '(string)',
827                    'nice_name'      => '(string)',
828                    'URL'            => '(URL)',
829                    'avatar_URL'     => '(URL)',
830                    'profile_URL'    => '(URL)',
831                    'is_super_admin' => '(bool)',
832                    'roles'          => '(array:string)',
833                    'ip_address'     => '(string|false)',
834                    'wpcom_id'       => '(int|null)',
835                    'wpcom_login'    => '(string|null)',
836                );
837                $return[ $key ] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
838                break;
839            case 'role':
840                $docs           = array(
841                    'name'         => '(string)',
842                    'display_name' => '(string)',
843                    'capabilities' => '(object:boolean)',
844                );
845                $return[ $key ] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
846                break;
847            case 'attachment':
848                $docs           = array(
849                    'ID'        => '(int)',
850                    'URL'       => '(URL)',
851                    'guid'      => '(string)',
852                    'mime_type' => '(string)',
853                    'width'     => '(int)',
854                    'height'    => '(int)',
855                    'duration'  => '(int)',
856                );
857                $return[ $key ] = (object) $this->cast_and_filter(
858                    $value,
859                    /**
860                    * Filter the documentation returned for a post attachment.
861                    *
862                    * @module json-api
863                    *
864                    * @since 1.9.0
865                    *
866                    * @param array $docs Array of documentation about a post attachment.
867                    */
868                    apply_filters( 'wpcom_json_api_attachment_cast_and_filter', $docs ),
869                    false,
870                    $for_output
871                );
872                break;
873            case 'metadata':
874                $docs           = array(
875                    'id'             => '(int)',
876                    'key'            => '(string)',
877                    'value'          => '(string|false|float|int|array|object)',
878                    'previous_value' => '(string)',
879                    'operation'      => '(string)',
880                );
881                $return[ $key ] = (object) $this->cast_and_filter(
882                    $value,
883                    /** This filter is documented in class.json-api-endpoints.php */
884                    apply_filters( 'wpcom_json_api_attachment_cast_and_filter', $docs ),
885                    false,
886                    $for_output
887                );
888                break;
889            case 'plugin':
890                $docs           = array(
891                    'id'           => '(safehtml) The plugin\'s ID',
892                    'slug'         => '(safehtml) The plugin\'s Slug',
893                    'active'       => '(boolean)  The plugin status.',
894                    'update'       => '(object)   The plugin update info.',
895                    'name'         => '(safehtml) The name of the plugin.',
896                    'plugin_url'   => '(url)      Link to the plugin\'s web site.',
897                    'version'      => '(safehtml) The plugin version number.',
898                    'description'  => '(safehtml) Description of what the plugin does and/or notes from the author',
899                    'author'       => '(safehtml) The plugin author\'s name',
900                    'author_url'   => '(url)      The plugin author web site address',
901                    'network'      => '(boolean)  Whether the plugin can only be activated network wide.',
902                    'autoupdate'   => '(boolean)  Whether the plugin is auto updated',
903                    'log'          => '(array:safehtml) An array of update log strings.',
904                    'action_links' => '(array) An array of action links that the plugin uses.',
905                );
906                $return[ $key ] = (object) $this->cast_and_filter(
907                    $value,
908                    /**
909                    * Filter the documentation returned for a plugin.
910                    *
911                    * @module json-api
912                    *
913                    * @since 3.1.0
914                    *
915                    * @param array $docs Array of documentation about a plugin.
916                    */
917                    apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
918                    false,
919                    $for_output
920                );
921                break;
922            case 'plugin_v1_2':
923                $docs           = class_exists( 'Jetpack_JSON_API_Get_Plugins_v1_2_Endpoint' )
924                ? Jetpack_JSON_API_Get_Plugins_v1_2_Endpoint::$_response_format
925                : Jetpack_JSON_API_Plugins_Endpoint::$_response_format_v1_2;
926                $return[ $key ] = (object) $this->cast_and_filter(
927                    $value,
928                    /**
929                    * Filter the documentation returned for a plugin.
930                    *
931                    * @module json-api
932                    *
933                    * @since 3.1.0
934                    *
935                    * @param array $docs Array of documentation about a plugin.
936                    */
937                    apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
938                    false,
939                    $for_output
940                );
941                break;
942            case 'file_mod_capabilities':
943                $docs           = array(
944                    'reasons_modify_files_unavailable' => '(array) The reasons why files can\'t be modified',
945                    'reasons_autoupdate_unavailable'   => '(array) The reasons why autoupdates aren\'t allowed',
946                    'modify_files'                     => '(boolean) true if files can be modified',
947                    'autoupdate_files'                 => '(boolean) true if autoupdates are allowed',
948                );
949                $return[ $key ] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
950                break;
951            case 'jetpackmodule':
952                $docs           = array(
953                    'id'          => '(string)   The module\'s ID',
954                    'active'      => '(boolean)  The module\'s status.',
955                    'name'        => '(string)   The module\'s name.',
956                    'description' => '(safehtml) The module\'s description.',
957                    'sort'        => '(int)      The module\'s display order.',
958                    'introduced'  => '(string)   The Jetpack version when the module was introduced.',
959                    'changed'     => '(string)   The Jetpack version when the module was changed.',
960                    'free'        => '(boolean)  The module\'s Free or Paid status.',
961                    'module_tags' => '(array)    The module\'s tags.',
962                    'override'    => '(string)   The module\'s override. Empty if no override, otherwise \'active\' or \'inactive\'',
963                );
964                $return[ $key ] = (object) $this->cast_and_filter(
965                    $value,
966                    /** This filter is documented in class.json-api-endpoints.php */
967                    apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
968                    false,
969                    $for_output
970                );
971                break;
972            case 'sharing_button':
973                $docs           = array(
974                    'ID'         => '(string)',
975                    'name'       => '(string)',
976                    'URL'        => '(string)',
977                    'icon'       => '(string)',
978                    'enabled'    => '(bool)',
979                    'visibility' => '(string)',
980                );
981                $return[ $key ] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
982                break;
983            case 'sharing_button_service':
984                $docs           = array(
985                    'ID'               => '(string) The service identifier',
986                    'name'             => '(string) The service name',
987                    'class_name'       => '(string) Class name for custom style sharing button elements',
988                    'genericon'        => '(string) The Genericon unicode character for the custom style sharing button icon',
989                    'preview_smart'    => '(string) An HTML snippet of a rendered sharing button smart preview',
990                    'preview_smart_js' => '(string) An HTML snippet of the page-wide initialization scripts used for rendering the sharing button smart preview',
991                );
992                $return[ $key ] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
993                break;
994            case 'site_keyring':
995                $docs           = array(
996                    'keyring_id'       => '(int) Keyring ID',
997                    'service'          => '(string) The service name',
998                    'external_user_id' => '(string) External user id for the service',
999                );
1000                $return[ $key ] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
1001                break;
1002            case 'taxonomy':
1003                $docs           = array(
1004                    'name'         => '(string) The taxonomy slug',
1005                    'label'        => '(string) The taxonomy human-readable name',
1006                    'labels'       => '(object) Mapping of labels for the taxonomy',
1007                    'description'  => '(string) The taxonomy description',
1008                    'hierarchical' => '(bool) Whether the taxonomy is hierarchical',
1009                    'public'       => '(bool) Whether the taxonomy is public',
1010                    'capabilities' => '(object) Mapping of current user capabilities for the taxonomy',
1011                );
1012                $return[ $key ] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
1013                break;
1014            case 'visibility':
1015                // This is needed to fix a bug in WPAndroid where `public: "PUBLIC"` is sent in place of `public: 1`.
1016                if ( 'public' === strtolower( $value ) ) {
1017                    $return[ $key ] = 1;
1018                } elseif ( 'private' === strtolower( $value ) ) {
1019                    $return[ $key ] = -1;
1020                } else {
1021                    $return[ $key ] = (int) $value;
1022                }
1023                break;
1024            case 'dropdown_page':
1025                $return[ $key ] = (array) $this->cast_and_filter( $value, $this->dropdown_page_object_format, false, $for_output );
1026                break;
1027            default:
1028                $method_name = $type['type'] . '_docs';
1029                if ( method_exists( 'WPCOM_JSON_API_Jetpack_Overrides', $method_name ) ) {
1030                    $docs = WPCOM_JSON_API_Jetpack_Overrides::$method_name();
1031                }
1032
1033                if ( ! empty( $docs ) ) {
1034                    $return[ $key ] = (object) $this->cast_and_filter(
1035                        $value,
1036                        /** This filter is documented in class.json-api-endpoints.php */
1037                        apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
1038                        false,
1039                        $for_output
1040                    );
1041                } else {
1042                    // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error, WordPress.Security.EscapeOutput.OutputNotEscaped
1043                    trigger_error( "Unknown API casting type {$type['type']}", E_USER_WARNING );
1044                }
1045        }
1046    }
1047
1048    /**
1049     * Parse types from text.
1050     *
1051     * @param string $text Text.
1052     * @return array Types.
1053     */
1054    public function parse_types( $text ) {
1055        if ( ! preg_match( '#^\(([^)]+)\)#', ltrim( $text ), $matches ) ) {
1056            return array( array( 'type' => 'none' ) );
1057        }
1058
1059        $types  = explode( '|', strtolower( $matches[1] ) );
1060        $return = array();
1061        foreach ( $types as $type ) {
1062            foreach ( array(
1063                ':' => 'children',
1064                '>' => 'subtype',
1065                '=' => 'default',
1066            ) as $operator => $meaning ) {
1067                if ( str_contains( $type, $operator ) ) {
1068                    $item     = explode( $operator, $type, 2 );
1069                    $return[] = array(
1070                        'type'   => $item[0],
1071                        $meaning => $item[1],
1072                    );
1073                    continue 2;
1074                }
1075            }
1076            $return[] = compact( 'type' );
1077        }
1078
1079        return $return;
1080    }
1081
1082    /**
1083     * Checks if the endpoint is publicly displayable
1084     *
1085     * @return bool
1086     */
1087    public function is_publicly_documentable() {
1088        return '__do_not_document' !== $this->group && true !== $this->in_testing;
1089    }
1090
1091    /**
1092     * Auto generates documentation based on description, method, path, path_labels, and query parameters.
1093     * Echoes HTML.
1094     *
1095     * @param bool $show_description Whether to show the description.
1096     */
1097    public function document( $show_description = true ) {
1098        global $wpdb;
1099        $original_post = $GLOBALS['post'] ?? 'unset';
1100        unset( $GLOBALS['post'] );
1101
1102        $doc = $this->generate_documentation();
1103
1104        if ( $show_description ) :
1105            ?>
1106<caption>
1107    <h1><?php echo wp_kses_post( $doc['method'] ); ?> <?php echo wp_kses_post( $doc['path_labeled'] ); ?></h1>
1108    <p><?php echo wp_kses_post( $doc['description'] ); ?></p>
1109</caption>
1110
1111<?php endif; ?>
1112
1113        <?php if ( true === $this->deprecated ) { ?>
1114<p><strong>This endpoint is deprecated in favor of version <?php echo (float) $this->new_version; ?></strong></p>
1115<?php } ?>
1116
1117<section class="resource-info">
1118    <h2 id="apidoc-resource-info">Resource Information</h2>
1119
1120    <table class="api-doc api-doc-resource-parameters api-doc-resource">
1121
1122    <thead>
1123        <tr>
1124            <th class="api-index-title" scope="column">&nbsp;</th>
1125            <th class="api-index-title" scope="column">&nbsp;</th>
1126        </tr>
1127    </thead>
1128    <tbody>
1129
1130        <tr class="api-index-item">
1131            <th scope="row" class="parameter api-index-item-title">Method</th>
1132            <td class="type api-index-item-title"><?php echo wp_kses_post( $doc['method'] ); ?></td>
1133        </tr>
1134
1135        <tr class="api-index-item">
1136            <th scope="row" class="parameter api-index-item-title">URL</th>
1137            <?php
1138            $version = WPCOM_JSON_API__CURRENT_VERSION;
1139            if ( ! empty( $this->max_version ) ) {
1140                $version = $this->max_version;
1141            }
1142            ?>
1143            <td class="type api-index-item-title">https://public-api.wordpress.com/rest/v<?php echo (float) $version; ?><?php echo wp_kses_post( $doc['path_labeled'] ); ?></td>
1144        </tr>
1145
1146        <tr class="api-index-item">
1147            <th scope="row" class="parameter api-index-item-title">Requires authentication?</th>
1148            <?php
1149            $requires_auth = $wpdb->get_row( $wpdb->prepare( 'SELECT requires_authentication FROM rest_api_documentation WHERE `version` = %s AND `path` = %s AND `method` = %s LIMIT 1', $version, untrailingslashit( $doc['path_labeled'] ), $doc['method'] ) );
1150            ?>
1151            <td class="type api-index-item-title"><?php echo ( ! empty( $requires_auth->requires_authentication ) ? 'Yes' : 'No' ); ?></td>
1152        </tr>
1153
1154    </tbody>
1155    </table>
1156
1157</section>
1158
1159        <?php
1160
1161        foreach ( array(
1162            'path'     => 'Method Parameters',
1163            'query'    => 'Query Parameters',
1164            'body'     => 'Request Parameters',
1165            'response' => 'Response Parameters',
1166        ) as $doc_section_key => $label ) :
1167            $doc_section = 'response' === $doc_section_key ? $doc['response']['body'] : $doc['request'][ $doc_section_key ];
1168            if ( ! $doc_section ) {
1169                continue;
1170            }
1171
1172            $param_label = strtolower( str_replace( ' ', '-', $label ) );
1173            ?>
1174
1175<section class="<?php echo esc_attr( $param_label ); ?>">
1176
1177<h2 id="apidoc-<?php echo esc_attr( $doc_section_key ); ?>"><?php echo wp_kses_post( $label ); ?></h2>
1178
1179<table class="api-doc api-doc-<?php echo esc_attr( $param_label ); ?>-parameters api-doc-<?php echo esc_attr( strtolower( str_replace( ' ', '-', $doc['group'] ) ) ); ?>">
1180
1181<thead>
1182    <tr>
1183        <th class="api-index-title" scope="column">Parameter</th>
1184        <th class="api-index-title" scope="column">Type</th>
1185        <th class="api-index-title" scope="column">Description</th>
1186    </tr>
1187</thead>
1188<tbody>
1189
1190            <?php foreach ( $doc_section as $key => $item ) : ?>
1191
1192    <tr class="api-index-item">
1193        <th scope="row" class="parameter api-index-item-title"><?php echo wp_kses_post( $key ); ?></th>
1194        <td class="type api-index-item-title"><?php echo wp_kses_post( $item['type'] ); // @todo auto-link? ?></td>
1195        <td class="description api-index-item-body">
1196                <?php
1197
1198                $this->generate_doc_description( $item['description'] );
1199
1200                ?>
1201        </td>
1202    </tr>
1203
1204<?php endforeach; ?>
1205</tbody>
1206</table>
1207</section>
1208<?php endforeach; ?>
1209
1210        <?php
1211        if ( 'unset' !== $original_post ) {
1212            $GLOBALS['post'] = $original_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
1213        }
1214    }
1215
1216    /**
1217     * `preg_replace_callback` callback to add http_build_query to php content example.
1218     *
1219     * @todo Is this used anywhere?
1220     *
1221     * @param array $matches Matches.
1222     * @return string
1223     */
1224    public function add_http_build_query_to_php_content_example( $matches ) {
1225        $trimmed_match = ltrim( $matches[0] );
1226        $pad           = substr( $matches[0], 0, -1 * strlen( $trimmed_match ) );
1227        $pad           = ltrim( $pad, ' ' );
1228        $return        = '  ' . str_replace( "\n", "\n  ", $matches[0] );
1229        return " http_build_query({$return}{$pad})";
1230    }
1231
1232    /**
1233     * Recursively generates the <dl>'s to document item descriptions.
1234     * Echoes HTML.
1235     *
1236     * @param string|array $item Post data to output, or an array of key => data mappings.
1237     */
1238    public function generate_doc_description( $item ) {
1239        if ( is_array( $item ) ) :
1240            ?>
1241
1242        <dl>
1243            <?php    foreach ( $item as $description_key => $description_value ) : ?>
1244
1245            <dt><?php echo wp_kses_post( $description_key . ':' ); ?></dt>
1246            <dd><?php $this->generate_doc_description( $description_value ); ?></dd>
1247
1248            <?php    endforeach; ?>
1249
1250        </dl>
1251
1252            <?php
1253        else :
1254            echo wp_kses_post( $item );
1255        endif;
1256    }
1257
1258    /**
1259     * Auto generates documentation based on description, method, path, path_labels, and query parameters.
1260     * Echoes HTML.
1261     */
1262    public function generate_documentation() {
1263        $format       = str_replace( '%d', '%s', $this->path );
1264        $path_labeled = $format;
1265        if ( ! empty( $this->path_labels ) ) {
1266            $path_labeled = vsprintf( $format, array_keys( $this->path_labels ) );
1267        }
1268        $boolean_arg = array( 'false', 'true' );
1269        $naeloob_arg = array( 'true', 'false' );
1270
1271        $doc = array(
1272            'description'  => $this->description,
1273            'method'       => $this->method,
1274            'path_format'  => $this->path,
1275            'path_labeled' => $path_labeled,
1276            'group'        => $this->group,
1277            'request'      => array(
1278                'path'  => array(),
1279                'query' => array(),
1280                'body'  => array(),
1281            ),
1282            'response'     => array(
1283                'body' => array(),
1284            ),
1285        );
1286
1287        foreach ( array(
1288            'path_labels'     => 'path',
1289            'query'           => 'query',
1290            'request_format'  => 'body',
1291            'response_format' => 'body',
1292        ) as $_property => $doc_item ) {
1293            foreach ( (array) $this->$_property as $key => $description ) {
1294                if ( is_array( $description ) ) {
1295                    $description_keys = array_keys( $description );
1296                    if ( $boolean_arg === $description_keys || $naeloob_arg === $description_keys ) {
1297                        $type = '(bool)';
1298                    } else {
1299                        $type = '(string)';
1300                    }
1301
1302                    if ( 'response_format' !== $_property ) {
1303                        // hack - don't show "(default)" in response format.
1304                        reset( $description );
1305                        $description_key                 = key( $description );
1306                        $description[ $description_key ] = "(default) {$description[$description_key]}";
1307                    }
1308                } else {
1309                    $types   = $this->parse_types( $description );
1310                    $type    = array();
1311                    $default = '';
1312
1313                    foreach ( $types as $type_array ) {
1314                        $type[] = $type_array['type'];
1315                        if ( isset( $type_array['default'] ) ) {
1316                            $default = $type_array['default'];
1317                            if ( 'string' === $type_array['type'] ) {
1318                                $default = "'$default'";
1319                            }
1320                        }
1321                    }
1322                    $type = '(' . implode( '|', $type ) . ')';
1323                    if ( str_contains( $description, ')' ) ) {
1324                        list( , $description ) = explode( ')', $description, 2 );
1325                    }
1326                    $description = trim( $description );
1327                    if ( $default ) {
1328                        $description .= " Default: $default.";
1329                    }
1330                }
1331
1332                $item = compact( 'type', 'description' );
1333
1334                if ( 'response_format' === $_property ) {
1335                    $doc['response'][ $doc_item ][ $key ] = $item;
1336                } else {
1337                    $doc['request'][ $doc_item ][ $key ] = $item;
1338                }
1339            }
1340        }
1341
1342        return $doc;
1343    }
1344
1345    /**
1346     * Can the user view the post?
1347     *
1348     * @param int $post_id Post ID.
1349     * @return bool|WP_Error
1350     */
1351    public function user_can_view_post( $post_id ) {
1352        $post = get_post( $post_id );
1353        if ( ! $post || is_wp_error( $post ) ) {
1354            return false;
1355        }
1356
1357        if ( 'inherit' === $post->post_status ) {
1358            $parent_post     = get_post( $post->post_parent );
1359            $post_status_obj = get_post_status_object( $parent_post->post_status ?? $post->post_status );
1360        } else {
1361            $post_status_obj = get_post_status_object( $post->post_status );
1362        }
1363
1364        if ( empty( $post_status_obj->public ) ) {
1365            if ( is_user_logged_in() ) {
1366                if ( ! empty( $post_status_obj->protected ) ) {
1367                    if ( ! current_user_can( 'edit_post', $post->ID ) ) {
1368                        return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1369                    }
1370                } elseif ( ! empty( $post_status_obj->private ) ) {
1371                    if ( ! current_user_can( 'read_post', $post->ID ) ) {
1372                        return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1373                    }
1374                } elseif ( in_array( $post->post_status, array( 'inherit', 'trash' ), true ) ) {
1375                    if ( ! current_user_can( 'edit_post', $post->ID ) ) {
1376                        return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1377                    }
1378                } elseif ( 'auto-draft' === $post->post_status ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedElseif
1379                    // allow auto-drafts.
1380                } else {
1381                    return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1382                }
1383            } else {
1384                return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1385            }
1386        }
1387
1388        if (
1389            ( new Status() )->is_private_site() &&
1390            /**
1391             * Filter access to a specific post.
1392             *
1393             * @module json-api
1394             *
1395             * @since 3.4.0
1396             *
1397             * @param bool current_user_can( 'read_post', $post->ID ) Can the current user access the post.
1398             * @param WP_Post $post Post data.
1399             */
1400            ! apply_filters(
1401                'wpcom_json_api_user_can_view_post',
1402                current_user_can( 'read_post', $post->ID ),
1403                $post
1404            )
1405        ) {
1406            return new WP_Error(
1407                'unauthorized',
1408                'User cannot view post',
1409                array(
1410                    'status_code' => 403,
1411                    'error'       => 'private_blog',
1412                )
1413            );
1414        }
1415
1416        if ( strlen( $post->post_password ) && ! current_user_can( 'edit_post', $post->ID ) ) {
1417            return new WP_Error(
1418                'unauthorized',
1419                'User cannot view password protected post',
1420                array(
1421                    'status_code' => 403,
1422                    'error'       => 'password_protected',
1423                )
1424            );
1425        }
1426
1427        return true;
1428    }
1429
1430    /**
1431     * Returns author object.
1432     *
1433     * @param object $author user ID, user row, WP_User object, comment row, post row.
1434     * @param bool   $show_email_and_ip output the author's email address and IP address?.
1435     *
1436     * @return object
1437     */
1438    public function get_author( $author, $show_email_and_ip = false ) {
1439        $is_jetpack = null;
1440        $login      = null;
1441        $email      = null;
1442        $name       = null;
1443        $first_name = null;
1444        $last_name  = null;
1445        $nice       = null;
1446        $url        = null;
1447        $ip_address = $author->comment_author_IP ?? '';
1448        $site_id    = -1;
1449
1450        if ( isset( $author->comment_author_email ) ) {
1451            $id         = empty( $author->user_id ) ? 0 : (int) $author->user_id;
1452            $login      = '';
1453            $email      = $author->comment_author_email;
1454            $name       = $author->comment_author;
1455            $first_name = '';
1456            $last_name  = '';
1457            $avatar_url = $this->api->get_avatar_url( $author );
1458            $nice       = '';
1459            $url        = $author->comment_author_url;
1460            // Convert Gravatar URLs containing an email address to the hashed version.
1461            if ( preg_match( '#^https?://(?:www\.)?gravatar\.com/([^/?]+)#i', $url, $matches ) && is_email( $matches[1] ) ) {
1462                $url = 'https://gravatar.com/' . md5( strtolower( trim( $matches[1] ) ) );
1463            }
1464
1465            // Add additional user data to the response if a valid user ID is available.
1466            if ( 0 < $id ) {
1467                $user = get_user_by( 'id', $id );
1468                if ( $user instanceof WP_User ) {
1469                    $login      = $user->user_login ?? '';
1470                    $first_name = $user->first_name ?? '';
1471                    $last_name  = $user->last_name ?? '';
1472                    $nice       = $user->user_nicename ?? '';
1473                }
1474            }
1475
1476            // Comment author URLs and Emails are sent through wp_kses() on save, which replaces "&" with "&amp;"
1477            // "&" is the only email/URL character altered by wp_kses().
1478            foreach ( array( 'email', 'url' ) as $field ) {
1479                $$field = str_replace( '&amp;', '&', $$field );
1480            }
1481        } elseif ( $author instanceof WP_User || isset( $author->user_email ) ) {
1482            $author = $author->ID;
1483        } elseif ( isset( $author->user_id ) && $author->user_id ) {
1484            $author = $author->user_id;
1485        } elseif ( isset( $author->post_author ) ) {
1486            // then $author is a Post Object.
1487            if ( ! $author->post_author ) {
1488                return null;
1489            }
1490            /**
1491             * Filter whether the current site is a Jetpack site.
1492             *
1493             * @module json-api
1494             *
1495             * @since 3.3.0
1496             *
1497             * @param bool false Is the current site a Jetpack site. Default to false.
1498             * @param int get_current_blog_id() Blog ID.
1499             */
1500            $is_jetpack = true === apply_filters( 'is_jetpack_site', false, get_current_blog_id() );
1501            $post_id    = $author->ID;
1502            if ( $is_jetpack && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
1503                $id         = get_post_meta( $post_id, '_jetpack_post_author_external_id', true );
1504                $email      = get_post_meta( $post_id, '_jetpack_author_email', true );
1505                $login      = '';
1506                $name       = get_post_meta( $post_id, '_jetpack_author', true );
1507                $first_name = '';
1508                $last_name  = '';
1509                $url        = '';
1510                $nice       = '';
1511            } else {
1512                $author = $author->post_author;
1513            }
1514        }
1515
1516        if ( ! isset( $id ) ) {
1517            $user = get_user_by( 'id', $author );
1518            if ( ! $user || is_wp_error( $user ) ) {
1519                return null;
1520            }
1521            $id         = $user->ID;
1522            $email      = $user->user_email;
1523            $login      = $user->user_login;
1524            $name       = $user->display_name;
1525            $first_name = $user->first_name;
1526            $last_name  = $user->last_name;
1527            $url        = $user->user_url;
1528            $nice       = $user->user_nicename;
1529        }
1530        if ( defined( 'IS_WPCOM' ) && IS_WPCOM && ! $is_jetpack && $id > 0 ) {
1531            /**
1532             * Allow customizing the blog ID returned with the author in WordPress.com REST API queries.
1533             *
1534             * @since 12.9
1535             *
1536             * @module json-api
1537             *
1538             * @param bool|int $active_blog  Blog ID, or false by default.
1539             * @param int      $id           User ID.
1540             */
1541            $active_blog = apply_filters( 'wpcom_api_pre_get_active_blog_author', false, $id );
1542            if ( false === $active_blog ) {
1543                $active_blog = get_active_blog_for_user( $id );
1544            }
1545            if ( ! empty( $active_blog ) ) {
1546                $site_id = $active_blog->blog_id;
1547            }
1548            if ( $site_id > - 1 ) {
1549                $site_visible = (
1550                    - 1 !== (int) $active_blog->public ||
1551                    is_private_blog_user( $site_id, get_current_user_id() )
1552                );
1553            }
1554            $profile_url = "https://gravatar.com/{$login}";
1555        } else {
1556            $profile_url = 'https://gravatar.com/' . md5( strtolower( trim( $email ) ) );
1557        }
1558
1559        if ( ! isset( $avatar_url ) ) {
1560            $avatar_url = $this->api->get_avatar_url( $email );
1561        }
1562
1563        if ( $show_email_and_ip ) {
1564            $email      = (string) $email;
1565            $ip_address = (string) $ip_address;
1566        } else {
1567            $email      = false;
1568            $ip_address = false;
1569        }
1570
1571        $author = array(
1572            'ID'          => (int) $id,
1573            'login'       => (string) $login,
1574            'email'       => $email, // string|bool.
1575            'name'        => (string) $name,
1576            'first_name'  => (string) $first_name,
1577            'last_name'   => (string) $last_name,
1578            'nice_name'   => (string) $nice,
1579            'URL'         => (string) esc_url_raw( $url ),
1580            'avatar_URL'  => (string) esc_url_raw( $avatar_url ),
1581            'profile_URL' => (string) esc_url_raw( $profile_url ),
1582            'ip_address'  => $ip_address, // string|bool.
1583        );
1584
1585        if ( $site_id > -1 ) {
1586            $author['site_ID']      = (int) $site_id;
1587            $author['site_visible'] = $site_visible ?? null;
1588        }
1589
1590        // Only include WordPress.com user data when author_wpcom_data is enabled.
1591        $args = $this->query_args();
1592
1593        if ( ! empty( $id ) && ! empty( $args['author_wpcom_data'] ) ) {
1594            if ( ( new Host() )->is_wpcom_simple() ) {
1595                $user                  = get_user_by( 'id', $id );
1596                $author['wpcom_id']    = isset( $user->ID ) ? (int) $user->ID : null;
1597                $author['wpcom_login'] = $user->user_login ?? '';
1598            } else {
1599                // If this is a Jetpack site, use the connection manager to get the user data.
1600                $wpcom_user_data = ( new Manager() )->get_connected_user_data( $id );
1601                if ( $wpcom_user_data && isset( $wpcom_user_data['ID'] ) ) {
1602                    $author['wpcom_id']    = (int) $wpcom_user_data['ID'];
1603                    $author['wpcom_login'] = $wpcom_user_data['login'] ?? '';
1604                }
1605            }
1606        }
1607
1608        return (object) $author;
1609    }
1610
1611    /**
1612     * Whether the current user may read the given media item through a media GET endpoint.
1613     *
1614     * Requires `edit_posts`, which Contributors hold, and returns only attachments. Any
1615     * other post type is reported as unknown media.
1616     *
1617     * @param int $media_id Media post ID.
1618     * @return true|WP_Error True if the item may be returned, WP_Error otherwise.
1619     */
1620    public function check_media_item_read_permission( $media_id ) {
1621        // upload_files can probably be used for other endpoints but we want contributors to be able to use media too.
1622        if ( ! current_user_can( 'edit_posts' ) ) {
1623            return new WP_Error( 'unauthorized', 'User cannot view media', 403 );
1624        }
1625
1626        $media_item = get_post( $media_id );
1627
1628        if ( $media_item && 'attachment' !== $media_item->post_type ) {
1629            return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
1630        }
1631
1632        return true;
1633    }
1634
1635    /**
1636     * Get a media item.
1637     *
1638     * @param int $media_id Media post ID.
1639     * @return object|WP_Error Media item data, or WP_Error.
1640     */
1641    public function get_media_item( $media_id ) {
1642        $media_item = get_post( $media_id );
1643
1644        if ( ! $media_item || is_wp_error( $media_item ) ) {
1645            return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
1646        }
1647
1648        $response = array(
1649            'id'          => (string) $media_item->ID,
1650            'date'        => (string) $this->format_date( $media_item->post_date_gmt, $media_item->post_date ),
1651            'parent'      => $media_item->post_parent,
1652            'link'        => wp_get_attachment_url( $media_item->ID ),
1653            'title'       => $media_item->post_title,
1654            'caption'     => $media_item->post_excerpt,
1655            'description' => $media_item->post_content,
1656            'metadata'    => wp_get_attachment_metadata( $media_item->ID ),
1657        );
1658
1659        if ( defined( 'IS_WPCOM' ) && IS_WPCOM && is_array( $response['metadata'] ) && ! empty( $response['metadata']['file'] ) ) {
1660            remove_filter( '_wp_relative_upload_path', 'wpcom_wp_relative_upload_path', 10 );
1661            $response['metadata']['file'] = _wp_relative_upload_path( $response['metadata']['file'] );
1662            add_filter( '_wp_relative_upload_path', 'wpcom_wp_relative_upload_path', 10, 2 );
1663        }
1664
1665        $response['meta'] = (object) array(
1666            'links' => (object) array(
1667                'self' => (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_id ),
1668                'help' => (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_id, 'help' ),
1669                'site' => (string) $this->links->get_site_link( $this->api->get_blog_id_for_output() ),
1670            ),
1671        );
1672
1673        return (object) $response;
1674    }
1675
1676    /**
1677     * Get a v1.1 media item.
1678     *
1679     * @param int          $media_id Media post ID.
1680     * @param WP_Post|null $media_item Media item.
1681     * @param string|null  $file File path.
1682     * @return object|WP_Error Media item data, or WP_Error.
1683     */
1684    public function get_media_item_v1_1( $media_id, $media_item = null, $file = null ) {
1685        if ( ! $media_item ) {
1686            $media_item = get_post( $media_id );
1687        }
1688
1689        if ( ! $media_item || is_wp_error( $media_item ) ) {
1690            return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
1691        }
1692
1693        $attachment_file = isset( $media_item->ID ) ? get_attached_file( $media_item->ID ) : null;
1694
1695        $file      = basename( $attachment_file ? $attachment_file : $file );
1696        $file_info = pathinfo( $file );
1697        $ext       = $file_info['extension'] ?? null;
1698
1699        // File operations are handled differently on WordPress.com.
1700        if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1701            $attachment_metadata = isset( $media_item->ID ) ? wp_get_attachment_metadata( $media_item->ID ) : array();
1702            $filesize            = ! empty( $attachment_metadata['filesize'] ) ? $attachment_metadata['filesize'] : 0;
1703        } else {
1704            // For VideoPress videos, $attachment_file is the video URL.
1705            $filesize = ( $attachment_file && file_exists( $attachment_file ) )
1706            ? filesize( $attachment_file )
1707            : 0;
1708        }
1709
1710        $response = array(
1711            'ID'          => $media_item->ID ?? null,
1712            'URL'         => isset( $media_item->ID ) ? wp_get_attachment_url( $media_item->ID ) : null,
1713            'guid'        => $media_item->guid ?? null,
1714            'date'        => ( isset( $media_item->post_date_gmt ) && isset( $media_item->post_date ) ) ?
1715            (string) $this->format_date( $media_item->post_date_gmt, $media_item->post_date ) : null,
1716            'post_ID'     => $media_item->post_parent ?? null,
1717            'author_ID'   => isset( $media_item->post_author ) ? (int) $media_item->post_author : null,
1718            'file'        => $file,
1719            'mime_type'   => $media_item->post_mime_type ?? null,
1720            'extension'   => $ext,
1721            'title'       => $media_item->post_title ?? '',
1722            'caption'     => $media_item->post_excerpt ?? '',
1723            'description' => $media_item->post_content ?? '',
1724            'alt'         => isset( $media_item->ID ) ? get_post_meta( $media_item->ID, '_wp_attachment_image_alt', true ) : '',
1725            'icon'        => isset( $media_item->ID ) ? wp_mime_type_icon( $media_item->ID ) : null,
1726            'size'        => size_format( (int) $filesize, 2 ),
1727            'thumbnails'  => array(),
1728        );
1729
1730        if ( in_array( $ext, array( 'jpg', 'jpeg', 'png', 'gif', 'webp' ), true ) && isset( $media_item->ID ) ) {
1731            $metadata = wp_get_attachment_metadata( $media_item->ID );
1732            if ( isset( $metadata['height'] ) ) {
1733                $response['height'] = $metadata['height'];
1734            }
1735            if ( isset( $metadata['width'] ) ) {
1736                $response['width'] = $metadata['width'];
1737            }
1738
1739            if ( isset( $metadata['sizes'] ) ) {
1740                /**
1741                 * Filter the thumbnail sizes available for each attachment ID.
1742                 *
1743                 * @module json-api
1744                 *
1745                 * @since 3.9.0
1746                 *
1747                 * @param array $metadata['sizes'] Array of thumbnail sizes available for a given attachment ID.
1748                 * @param string $media_id Attachment ID.
1749                 */
1750                $sizes = apply_filters( 'rest_api_thumbnail_sizes', $metadata['sizes'], $media_item->ID );
1751                if ( is_array( $sizes ) ) {
1752                    foreach ( $sizes as $size => $size_details ) {
1753                        if ( isset( $size_details['file'] ) ) {
1754                            $response['thumbnails'][ $size ] = dirname( $response['URL'] ) . '/' . $size_details['file'];
1755                        }
1756                    }
1757                    /**
1758                     * Filter the thumbnail URLs for attachment files.
1759                     *
1760                     * @module json-api
1761                     *
1762                     * @since 7.1.0
1763                     *
1764                     * @param array $metadata['sizes'] Array with thumbnail sizes as keys and URLs as values.
1765                     */
1766                    $response['thumbnails'] = apply_filters( 'rest_api_thumbnail_size_urls', $response['thumbnails'] );
1767                }
1768            }
1769
1770            if ( isset( $metadata['image_meta'] ) ) {
1771                $response['exif'] = $metadata['image_meta'];
1772            }
1773        }
1774
1775        if ( in_array( $ext, array( 'mp3', 'm4a', 'wav', 'ogg' ), true ) && isset( $media_item->ID ) ) {
1776            $metadata = wp_get_attachment_metadata( $media_item->ID );
1777
1778            if ( isset( $metadata['length'] ) ) {
1779                $response['length'] = $metadata['length'];
1780            }
1781            $response['exif'] = is_array( $metadata ) ? $metadata : false;
1782        }
1783
1784        $is_video = false;
1785
1786        if (
1787            in_array( $ext, array( 'ogv', 'mp4', 'mov', 'wmv', 'avi', 'mpg', '3gp', '3g2', 'm4v' ), true )
1788            || 'video/videopress' === $response['mime_type']
1789        ) {
1790            $is_video = true;
1791        }
1792
1793        if ( $is_video && isset( $media_item->ID ) ) {
1794            $metadata = wp_get_attachment_metadata( $media_item->ID );
1795
1796            if ( isset( $metadata['height'] ) ) {
1797                $response['height'] = $metadata['height'];
1798            }
1799            if ( isset( $metadata['width'] ) ) {
1800                $response['width'] = $metadata['width'];
1801            }
1802
1803            if ( isset( $metadata['length'] ) ) {
1804                $response['length'] = $metadata['length'];
1805            }
1806
1807            if ( empty( $response['length'] ) && isset( $metadata['duration'] ) ) {
1808                $response['length'] = (int) $metadata['duration'];
1809            }
1810
1811            if ( empty( $response['length'] ) && isset( $metadata['videopress']['duration'] ) ) {
1812                $response['length'] = ceil( $metadata['videopress']['duration'] / 1000 );
1813            }
1814
1815            // add VideoPress info.
1816            if ( function_exists( 'video_get_info_by_blogpostid' ) ) {
1817                $info = video_get_info_by_blogpostid( $this->api->get_blog_id_for_output(), $media_item->ID );
1818
1819                // If we failed to get VideoPress info, but it exists in the meta data (for some reason)
1820                // then let's use that.
1821                if ( false === $info && isset( $metadata['videopress'] ) ) {
1822                    $info = (object) $metadata['videopress'];
1823                }
1824
1825                if ( isset( $info->rating ) ) {
1826                    $response['rating'] = $info->rating;
1827                }
1828
1829                if ( isset( $info->display_embed ) ) {
1830                    $response['display_embed'] = (string) (int) $info->display_embed;
1831                    // If not, default to metadata (for WPCOM).
1832                } elseif ( isset( $metadata['videopress']['display_embed'] ) ) {
1833                    // We convert it to int then to string so that (bool) false to become "0".
1834                    $response['display_embed'] = (string) (int) $metadata['videopress']['display_embed'];
1835                }
1836
1837                if ( isset( $info->allow_download ) ) {
1838                    $response['allow_download'] = (string) (int) $info->allow_download;
1839                } elseif ( isset( $metadata['videopress']['allow_download'] ) ) {
1840                    // We convert it to int then to string so that (bool) false to become "0".
1841                    $response['allow_download'] = (string) (int) $metadata['videopress']['allow_download'];
1842                }
1843
1844                if ( isset( $info->thumbnail_generating ) ) {
1845                    $response['thumbnail_generating'] = (bool) intval( $info->thumbnail_generating );
1846                } elseif ( isset( $metadata['videopress']['thumbnail_generating'] ) ) {
1847                    $response['thumbnail_generating'] = (bool) intval( $metadata['videopress']['thumbnail_generating'] );
1848                }
1849
1850                if ( isset( $info->privacy_setting ) ) {
1851                    $response['privacy_setting'] = (int) $info->privacy_setting;
1852                } elseif ( isset( $metadata['videopress']['privacy_setting'] ) ) {
1853                    $response['privacy_setting'] = (int) $metadata['videopress']['privacy_setting'];
1854                }
1855
1856                $thumbnail_query_data = array();
1857                if ( ! empty( $info ) && function_exists( 'video_is_private' ) && video_is_private( $info ) ) {
1858                    $thumbnail_query_data['metadata_token'] = video_generate_auth_token( $info );
1859                }
1860
1861                // Thumbnails.
1862                if ( function_exists( 'video_format_done' ) && function_exists( 'video_image_url_by_guid' ) ) {
1863                    $response['thumbnails'] = array(
1864                        'fmt_hd'  => '',
1865                        'fmt_dvd' => '',
1866                        'fmt_std' => '',
1867                    );
1868                    foreach ( $response['thumbnails'] as $size => $thumbnail_url ) {
1869                        if ( video_format_done( $info, $size ) ) {
1870                            $response['thumbnails'][ $size ] = \add_query_arg( $thumbnail_query_data, \video_image_url_by_guid( $info->guid, $size ) );
1871                        } else {
1872                            unset( $response['thumbnails'][ $size ] );
1873                        }
1874                    }
1875                }
1876
1877                if ( isset( $info->title ) ) {
1878                    $response['title'] = $info->title;
1879                }
1880
1881                // If we didn't get VideoPress information (for some reason) then let's
1882                // not try and include it in the response.
1883                if ( isset( $info->guid ) ) {
1884                    $response['videopress_guid']            = $info->guid;
1885                    $response['videopress_processing_done'] = isset( $info->finish_date_gmt ) && '0000-00-00 00:00:00' !== $info->finish_date_gmt;
1886                }
1887            }
1888        }
1889
1890        $response['thumbnails'] = (object) $response['thumbnails'];
1891
1892        $response['meta'] = (object) array(
1893            'links' => (object) array(
1894                'self' => isset( $media_item->ID ) ? (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_item->ID ) : null,
1895                'help' => isset( $media_item->ID ) ? (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_item->ID, 'help' ) : null,
1896                'site' => (string) $this->links->get_site_link( $this->api->get_blog_id_for_output() ),
1897            ),
1898        );
1899
1900        // add VideoPress link to the meta.
1901        if ( isset( $response['videopress_guid'] ) ) {
1902            if ( function_exists( 'video_get_info_by_blogpostid' ) ) {
1903                $response['meta']->links->videopress = (string) $this->links->get_link( '/videos/%s', $response['videopress_guid'], '' );
1904            }
1905        }
1906
1907        if ( isset( $media_item->post_parent ) && $media_item->post_parent > 0 ) {
1908            $response['meta']->links->parent = (string) $this->links->get_post_link( $this->api->get_blog_id_for_output(), $media_item->post_parent );
1909        }
1910
1911        return (object) $response;
1912    }
1913
1914    /**
1915     * Get a formatted taxonomy.
1916     *
1917     * @param int    $taxonomy_id Taxonomy ID.
1918     * @param string $taxonomy_type Name of taxonomy.
1919     * @param string $context Context, 'edit' or 'display'.
1920     * @return object|WP_Error
1921     */
1922    public function get_taxonomy( $taxonomy_id, $taxonomy_type, $context ) {
1923
1924        $taxonomy = get_term_by( 'slug', $taxonomy_id, $taxonomy_type );
1925        // keep updating this function.
1926        if ( ! $taxonomy || is_wp_error( $taxonomy ) ) {
1927            return new WP_Error( 'unknown_taxonomy', 'Unknown taxonomy', 404 );
1928        }
1929
1930        return $this->format_taxonomy( $taxonomy, $taxonomy_type, $context );
1931    }
1932
1933    /**
1934     * Format a taxonomy.
1935     *
1936     * @param WP_Term $taxonomy Taxonomy.
1937     * @param string  $taxonomy_type Name of taxonomy.
1938     * @param string  $context Context, 'edit' or 'display'.
1939     * @return object|WP_Error
1940     */
1941    public function format_taxonomy( $taxonomy, $taxonomy_type, $context ) {
1942        // Permissions.
1943        switch ( $context ) {
1944            case 'edit':
1945                $tax = get_taxonomy( $taxonomy_type );
1946                if ( ! current_user_can( $tax->cap->edit_terms ) ) {
1947                    return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
1948                }
1949                break;
1950            case 'display':
1951                if ( ( new Status() )->is_private_site() && ! current_user_can( 'read' ) ) {
1952                    return new WP_Error( 'unauthorized', 'User cannot view taxonomy', 403 );
1953                }
1954                break;
1955            default:
1956                return new WP_Error( 'invalid_context', 'Invalid API CONTEXT', 400 );
1957        }
1958
1959        $response                = array();
1960        $response['ID']          = (int) $taxonomy->term_id;
1961        $response['name']        = (string) $taxonomy->name;
1962        $response['slug']        = (string) $taxonomy->slug;
1963        $response['description'] = (string) $taxonomy->description;
1964        $response['post_count']  = (int) $taxonomy->count;
1965        $response['feed_url']    = get_term_feed_link( $taxonomy->term_id, $taxonomy_type );
1966
1967        if ( is_taxonomy_hierarchical( $taxonomy_type ) ) {
1968            $response['parent'] = (int) $taxonomy->parent;
1969        }
1970
1971        $response['meta'] = (object) array(
1972            'links' => (object) array(
1973                'self' => (string) $this->links->get_taxonomy_link( $this->api->get_blog_id_for_output(), $taxonomy->slug, $taxonomy_type ),
1974                'help' => (string) $this->links->get_taxonomy_link( $this->api->get_blog_id_for_output(), $taxonomy->slug, $taxonomy_type, 'help' ),
1975                'site' => (string) $this->links->get_site_link( $this->api->get_blog_id_for_output() ),
1976            ),
1977        );
1978
1979        return (object) $response;
1980    }
1981
1982    /**
1983     * Returns ISO 8601 formatted datetime: 2011-12-08T01:15:36-08:00
1984     *
1985     * @param string $date_gmt GMT datetime string.
1986     * @param string $date Optional. Used to calculate the offset from GMT.
1987     * @return string
1988     */
1989    public function format_date( $date_gmt, $date = null ) {
1990        return WPCOM_JSON_API_Date::format_date( $date_gmt, $date );
1991    }
1992
1993    /**
1994     * Parses a date string and returns the local and GMT representations
1995     * of that date & time in 'YYYY-MM-DD HH:MM:SS' format without
1996     * timezones or offsets. If the parsed datetime was not localized to a
1997     * particular timezone or offset we will assume it was given in GMT
1998     * relative to now and will convert it to local time using either the
1999     * timezone set in the options table for the blog or the GMT offset.
2000     *
2001     * @param string $date_string Date to parse.
2002     *
2003     * @return array{string,string} ( $local_time_string, $gmt_time_string )
2004     */
2005    public function parse_date( $date_string ) {
2006        $date_string_info = date_parse( $date_string );
2007        if ( 0 === $date_string_info['error_count'] ) {
2008            // Check if it's already localized. Can't just check is_localtime because date_parse('oppossum') returns true; WTF, PHP.
2009            if ( isset( $date_string_info['zone'] ) && true === $date_string_info['is_localtime'] ) {
2010                $dt_utc   = new DateTime( $date_string );
2011                $dt_local = clone $dt_utc;
2012                $dt_utc->setTimezone( new DateTimeZone( 'UTC' ) );
2013                return array(
2014                    $dt_local->format( 'Y-m-d H:i:s' ),
2015                    $dt_utc->format( 'Y-m-d H:i:s' ),
2016                );
2017            }
2018
2019            // It's parseable but no TZ info so assume UTC.
2020            $dt_utc   = new DateTime( $date_string, new DateTimeZone( 'UTC' ) );
2021            $dt_local = clone $dt_utc;
2022        } else {
2023            // Could not parse time, use now in UTC.
2024            $dt_utc   = new DateTime( 'now', new DateTimeZone( 'UTC' ) );
2025            $dt_local = clone $dt_utc;
2026        }
2027
2028        $dt_local->setTimezone( wp_timezone() );
2029
2030        return array(
2031            $dt_local->format( 'Y-m-d H:i:s' ),
2032            $dt_utc->format( 'Y-m-d H:i:s' ),
2033        );
2034    }
2035
2036    /**
2037     * Load the functions.php file for the current theme to get its post formats, CPTs, etc.
2038     */
2039    public function load_theme_functions() {
2040        if ( ! defined( 'STYLESHEETPATH' ) ) {
2041            wp_templating_constants();
2042        }
2043
2044        // bail if we've done this already (can happen when calling /batch endpoint).
2045        if ( defined( 'REST_API_THEME_FUNCTIONS_LOADED' ) ) {
2046            return;
2047        }
2048
2049        // VIP context loading is handled elsewhere, so bail to prevent
2050        // duplicate loading. See `switch_to_blog_and_validate_user()`.
2051        if ( defined( 'WPCOM_IS_VIP_ENV' ) && WPCOM_IS_VIP_ENV ) {
2052            return;
2053        }
2054
2055        $do_check_theme =
2056            defined( 'REST_API_TEST_REQUEST' ) && REST_API_TEST_REQUEST ||
2057            defined( 'IS_WPCOM' ) && IS_WPCOM;
2058
2059        if ( $do_check_theme && ! wpcom_should_load_theme_files_on_rest_api() ) {
2060            return;
2061        }
2062
2063        define( 'REST_API_THEME_FUNCTIONS_LOADED', true );
2064
2065        // the theme info we care about is found either within functions.php or one of the jetpack files.
2066        $function_files = array( '/functions.php', '/inc/jetpack.compat.php', '/inc/jetpack.php', '/includes/jetpack.compat.php' );
2067
2068        $copy_dirs = array( get_template_directory() );
2069
2070        // Is this a child theme? Load the child theme's functions file.
2071        if ( get_stylesheet_directory() !== get_template_directory() && wpcom_is_child_theme() ) {
2072            foreach ( $function_files as $function_file ) {
2073                if ( file_exists( get_stylesheet_directory() . $function_file ) ) {
2074                    require_once get_stylesheet_directory() . $function_file;
2075                }
2076            }
2077            $copy_dirs[] = get_stylesheet_directory();
2078        }
2079
2080        foreach ( $function_files as $function_file ) {
2081            if ( file_exists( get_template_directory() . $function_file ) ) {
2082                require_once get_template_directory() . $function_file;
2083            }
2084        }
2085
2086        // add inc/wpcom.php and/or includes/wpcom.php.
2087        wpcom_load_theme_compat_file();
2088
2089        // Enable including additional directories or files in actions to be copied.
2090        $copy_dirs = apply_filters( 'restapi_theme_action_copy_dirs', $copy_dirs );
2091
2092        // since the stuff we care about (CPTS, post formats, are usually on setup or init hooks, we want to load those).
2093        $this->copy_hooks( 'after_setup_theme', 'restapi_theme_after_setup_theme', $copy_dirs );
2094
2095        /**
2096         * Fires functions hooked onto `after_setup_theme` by the theme for the purpose of the REST API.
2097         *
2098         * The REST API does not load the theme when processing requests.
2099         * To enable theme-based functionality, the API will load the '/functions.php',
2100         * '/inc/jetpack.compat.php', '/inc/jetpack.php', '/includes/jetpack.compat.php files
2101         * of the theme (parent and child) and copy functions hooked onto 'after_setup_theme' within those files.
2102         *
2103         * @module json-api
2104         *
2105         * @since 3.2.0
2106         */
2107        do_action( 'restapi_theme_after_setup_theme' );
2108        $this->copy_hooks( 'init', 'restapi_theme_init', $copy_dirs );
2109
2110        /**
2111         * Fires functions hooked onto `init` by the theme for the purpose of the REST API.
2112         *
2113         * The REST API does not load the theme when processing requests.
2114         * To enable theme-based functionality, the API will load the '/functions.php',
2115         * '/inc/jetpack.compat.php', '/inc/jetpack.php', '/includes/jetpack.compat.php files
2116         * of the theme (parent and child) and copy functions hooked onto 'init' within those files.
2117         *
2118         * @module json-api
2119         *
2120         * @since 3.2.0
2121         */
2122        do_action( 'restapi_theme_init' );
2123    }
2124
2125    /**
2126     * Copy hook functions.
2127     *
2128     * @param string $from_hook Hook to copy from.
2129     * @param string $to_hook Hook to copy to.
2130     * @param array  $base_paths Only copy hooks defined in the specified paths.
2131     */
2132    public function copy_hooks( $from_hook, $to_hook, $base_paths ) {
2133        global $wp_filter;
2134        foreach ( $wp_filter as $hook => $actions ) {
2135
2136            if ( $from_hook !== $hook ) {
2137                continue;
2138            }
2139            if ( ! has_action( $hook ) ) {
2140                continue;
2141            }
2142
2143            foreach ( $actions as $priority => $callbacks ) {
2144                foreach ( $callbacks as $callback_data ) {
2145                    $callback = $callback_data['function'];
2146
2147                    // use reflection api to determine filename where function is defined.
2148                    $reflection = $this->get_reflection( $callback );
2149
2150                    if ( false !== $reflection ) {
2151                        $file_name = $reflection->getFileName();
2152                        foreach ( $base_paths as $base_path ) {
2153
2154                            // only copy hooks with functions which are part of the specified files.
2155                            if ( str_starts_with( $file_name, $base_path ) ) {
2156                                add_action(
2157                                    $to_hook,
2158                                    $callback_data['function'],
2159                                    $priority,
2160                                    $callback_data['accepted_args']
2161                                );
2162                            }
2163                        }
2164                    }
2165                }
2166            }
2167        }
2168    }
2169
2170    /**
2171     * Get a ReflectionMethod or ReflectionFunction for the callback.
2172     *
2173     * @param callable $callback Callback.
2174     * @return ReflectionMethod|ReflectionFunction|false
2175     */
2176    public function get_reflection( $callback ) {
2177        if ( is_array( $callback ) ) {
2178            list( $class, $method ) = $callback;
2179            return new ReflectionMethod( $class, $method );
2180        }
2181
2182        if ( is_string( $callback ) && strpos( $callback, '::' ) !== false ) {
2183            list( $class, $method ) = explode( '::', $callback );
2184            return new ReflectionMethod( $class, $method );
2185        }
2186
2187        if ( method_exists( $callback, '__invoke' ) ) {
2188            return new ReflectionMethod( $callback, '__invoke' );
2189        }
2190
2191        if ( is_string( $callback ) && strpos( $callback, '::' ) === false && function_exists( $callback ) ) {
2192            return new ReflectionFunction( $callback );
2193        }
2194
2195        return false;
2196    }
2197
2198    /**
2199     * Check whether a user can view or edit a post type.
2200     *
2201     * @param string $post_type post type to check.
2202     * @param string $context   'display' or 'edit'.
2203     * @return bool
2204     */
2205    public function current_user_can_access_post_type( $post_type, $context = 'display' ) {
2206        $post_type_object = get_post_type_object( $post_type );
2207        if ( ! $post_type_object ) {
2208            return false;
2209        }
2210
2211        switch ( $context ) {
2212            case 'edit':
2213                return current_user_can( $post_type_object->cap->edit_posts );
2214            case 'display':
2215                return $post_type_object->public || current_user_can( $post_type_object->cap->read_private_posts );
2216            default:
2217                return false;
2218        }
2219    }
2220
2221    /**
2222     * Is the post type allowed?
2223     *
2224     * @param string $post_type Post type.
2225     * @return bool
2226     */
2227    public function is_post_type_allowed( $post_type ) {
2228        // if the post type is empty, that's fine, WordPress will default to post.
2229        if ( empty( $post_type ) ) {
2230            return true;
2231        }
2232
2233        // allow special 'any' type.
2234        if ( 'any' === $post_type ) {
2235            return true;
2236        }
2237
2238        // check for allowed types.
2239        if ( in_array( $post_type, $this->_get_whitelisted_post_types(), true ) ) {
2240            return true;
2241        }
2242
2243        $post_type_object = get_post_type_object( $post_type );
2244        if ( $post_type_object ) {
2245            if ( ! empty( $post_type_object->show_in_rest ) ) {
2246                return $post_type_object->show_in_rest;
2247            }
2248            if ( ! empty( $post_type_object->publicly_queryable ) ) {
2249                return $post_type_object->publicly_queryable;
2250            }
2251        }
2252
2253        return ! empty( $post_type_object->public );
2254    }
2255
2256    /**
2257     * Gets the whitelisted post types that JP should allow access to.
2258     *
2259     * @return array Whitelisted post types.
2260     */
2261    protected function _get_whitelisted_post_types() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- Legacy.
2262        $allowed_types = array( 'post', 'page', 'revision' );
2263
2264        /**
2265         * Filter the post types Jetpack has access to, and can synchronize with WordPress.com.
2266         *
2267         * @module json-api
2268         *
2269         * @since 2.2.3
2270         *
2271         * @param array $allowed_types Array of whitelisted post types. Default to `array( 'post', 'page', 'revision' )`.
2272         */
2273        $allowed_types = apply_filters( 'rest_api_allowed_post_types', $allowed_types );
2274
2275        return array_unique( $allowed_types );
2276    }
2277
2278    /**
2279     * Mobile apps are allowed free video uploads, but limited to 5 minutes in length.
2280     *
2281     * @param array $media_item the media item to evaluate.
2282     *
2283     * @return bool true if the media item is a video that was uploaded via the mobile
2284     * app that is longer than 5 minutes.
2285     */
2286    public function media_item_is_free_video_mobile_upload_and_too_long( $media_item ) {
2287        if ( ! $media_item ) {
2288            return false;
2289        }
2290
2291        // Verify file is a video.
2292        $is_video = preg_match( '@^video/@', $media_item['type'] );
2293        if ( ! $is_video ) {
2294            return false;
2295        }
2296
2297        // Check if the request is from a mobile app, where we allow free video uploads at limited length.
2298        if ( ! in_array( $this->api->token_details['client_id'], VIDEOPRESS_ALLOWED_REST_API_CLIENT_IDS, true ) ) {
2299            return false;
2300        }
2301
2302        // We're only worried about free sites.
2303        require_once WP_CONTENT_DIR . '/admin-plugins/wpcom-billing.php';
2304        $current_plan = WPCOM_Store_API::get_current_plan( get_current_blog_id() );
2305        if ( ! $current_plan['is_free'] ) {
2306            return false;
2307        }
2308
2309        // We don't know if this is an upload or a sideload, but in either case the tmp_name should be a path, not a URL.
2310        if ( wp_parse_url( $media_item['tmp_name'], PHP_URL_SCHEME ) !== null ) {
2311            return false;
2312        }
2313
2314        // Check if video is longer than 5 minutes.
2315        $video_meta = wp_read_video_metadata( $media_item['tmp_name'] );
2316        if (
2317            false !== $video_meta &&
2318            isset( $video_meta['length'] ) &&
2319            5 * MINUTE_IN_SECONDS < $video_meta['length']
2320        ) {
2321            videopress_log(
2322                'videopress_app_upload_length_block',
2323                'Mobile app upload on free site blocked because length was longer than 5 minutes.',
2324                null,
2325                null,
2326                null,
2327                null,
2328                array(
2329                    'blog_id' => get_current_blog_id(),
2330                    'user_id' => get_current_user_id(),
2331                )
2332            );
2333            return true;
2334        }
2335
2336        return false;
2337    }
2338
2339    /**
2340     * Handle a v1.1 media creation.
2341     *
2342     * Only one of $media_files and $media_urls should be non-empty.
2343     *
2344     * @param array     $media_files File upload data.
2345     * @param array     $media_urls URLs to fetch.
2346     * @param array     $media_attrs Attributes corresponding to each entry in `$media_files`/`$media_urls`.
2347     * @param int|false $force_parent_id Force the parent ID, overriding `$media_attrs[]['parent_id']`.
2348     * @return array Two items:
2349     *  - media_ids: IDs created, by index in `$media_files`/`$media_urls`.
2350     *  - errors: Errors encountered, by index in `$media_files`/`$media_urls`.
2351     */
2352    public function handle_media_creation_v1_1( $media_files, $media_urls, $media_attrs = array(), $force_parent_id = false ) {
2353
2354        add_filter( 'upload_mimes', array( $this, 'allow_video_uploads' ) );
2355
2356        $media_ids             = array();
2357        $errors                = array();
2358        $user_can_upload_files = current_user_can( 'upload_files' ) || $this->api->is_authorized_with_upload_token();
2359        $media_attrs           = array_values( $media_attrs ); // reset the keys.
2360        $i                     = 0;
2361
2362        if ( ! empty( $media_files ) ) {
2363            $this->api->trap_wp_die( 'upload_error' );
2364            foreach ( $media_files as $media_item ) {
2365                $_FILES['.api.media.item.'] = $media_item;
2366
2367                if ( ! $user_can_upload_files ) {
2368                    $media_id = new WP_Error( 'unauthorized', 'User cannot upload media.', 403 );
2369                } elseif ( ! is_array( $media_item ) ) {
2370                    $media_id   = new WP_Error( 'invalid_input', 'Unable to process request.', 400 );
2371                    $media_item = array(
2372                        'name' => 'invalid_file',
2373                    );
2374                } elseif ( $this->media_item_is_free_video_mobile_upload_and_too_long( $media_item ) ) {
2375                    $media_id = new WP_Error( 'upload_video_length', 'Video uploads longer than 5 minutes require a paid plan.', 400 );
2376                } else {
2377                    if ( $force_parent_id ) {
2378                        $parent_id = absint( $force_parent_id );
2379                    } elseif ( ! empty( $media_attrs[ $i ] ) && ! empty( $media_attrs[ $i ]['parent_id'] ) ) {
2380                        $parent_id = absint( $media_attrs[ $i ]['parent_id'] );
2381                    } else {
2382                        $parent_id = 0;
2383                    }
2384                    $media_id = media_handle_upload( '.api.media.item.', $parent_id );
2385                }
2386                if ( is_wp_error( $media_id ) ) {
2387                    $errors[ $i ]['file']    = $media_item['name'];
2388                    $errors[ $i ]['error']   = $media_id->get_error_code();
2389                    $errors[ $i ]['message'] = $media_id->get_error_message();
2390                } else {
2391                    $media_ids[ $i ] = $media_id;
2392                }
2393
2394                ++$i;
2395            }
2396            $this->api->trap_wp_die( null );
2397            unset( $_FILES['.api.media.item.'] );
2398        }
2399
2400        if ( ! empty( $media_urls ) ) {
2401            foreach ( $media_urls as $url ) {
2402                if ( ! $user_can_upload_files ) {
2403                    $media_id = new WP_Error( 'unauthorized', 'User cannot upload media.', 403 );
2404                } else {
2405                    if ( $force_parent_id ) {
2406                        $parent_id = absint( $force_parent_id );
2407                    } elseif ( ! empty( $media_attrs[ $i ] ) && ! empty( $media_attrs[ $i ]['parent_id'] ) ) {
2408                        $parent_id = absint( $media_attrs[ $i ]['parent_id'] );
2409                    } else {
2410                        $parent_id = 0;
2411                    }
2412                    $media_id = $this->handle_media_sideload( $url, $parent_id );
2413                }
2414                if ( is_wp_error( $media_id ) ) {
2415                    $errors[ $i ] = array(
2416                        'file'    => $url,
2417                        'error'   => $media_id->get_error_code(),
2418                        'message' => $media_id->get_error_message(),
2419                    );
2420                } elseif ( ! empty( $media_id ) ) {
2421                    $media_ids[ $i ] = $media_id;
2422                }
2423
2424                ++$i;
2425            }
2426        }
2427
2428        if ( ! empty( $media_attrs ) ) {
2429            foreach ( $media_ids as $index => $media_id ) {
2430                if ( empty( $media_attrs[ $index ] ) ) {
2431                    continue;
2432                }
2433
2434                $attrs  = $media_attrs[ $index ];
2435                $insert = array();
2436
2437                // Attributes: Title, Caption, Description.
2438
2439                if ( isset( $attrs['title'] ) ) {
2440                    $insert['post_title'] = $attrs['title'];
2441                }
2442
2443                if ( isset( $attrs['caption'] ) ) {
2444                    $insert['post_excerpt'] = $attrs['caption'];
2445                }
2446
2447                if ( isset( $attrs['description'] ) ) {
2448                    $insert['post_content'] = $attrs['description'];
2449                }
2450
2451                if ( ! empty( $insert ) ) {
2452                    $insert['ID'] = $media_id;
2453                    wp_update_post( (object) $insert );
2454                }
2455
2456                // Attributes: Alt.
2457
2458                if ( isset( $attrs['alt'] ) ) {
2459                    $alt = wp_strip_all_tags( $attrs['alt'], true );
2460                    update_post_meta( $media_id, '_wp_attachment_image_alt', $alt );
2461                }
2462
2463                // Attributes: Artist, Album.
2464
2465                $id3_meta = array();
2466
2467                foreach ( array( 'artist', 'album' ) as $key ) {
2468                    if ( isset( $attrs[ $key ] ) ) {
2469                        $id3_meta[ $key ] = wp_strip_all_tags( $attrs[ $key ], true );
2470                    }
2471                }
2472
2473                if ( ! empty( $id3_meta ) ) {
2474                    // Before updating metadata, ensure that the item is audio.
2475                    $item = $this->get_media_item_v1_1( $media_id );
2476                    if ( str_starts_with( $item->mime_type, 'audio/' ) ) {
2477                        wp_update_attachment_metadata( $media_id, $id3_meta );
2478                    }
2479                }
2480
2481                // Attributes: Meta
2482                if ( isset( $attrs['meta'] ) && isset( $attrs['meta']['vertical_id'] ) ) {
2483                    update_post_meta( $media_id, 'vertical_id', $attrs['meta']['vertical_id'] );
2484                }
2485            }
2486        }
2487
2488        return array(
2489            'media_ids' => $media_ids,
2490            'errors'    => $errors,
2491        );
2492    }
2493
2494    /**
2495     * Handle a media sideload.
2496     *
2497     * @param string $url URL.
2498     * @param int    $parent_post_id Parent post ID.
2499     * @param string $type Type.
2500     * @return int|WP_Error|false Media post ID, or error, or false if nothing was sideloaded.
2501     */
2502    public function handle_media_sideload( $url, $parent_post_id = 0, $type = 'any' ) {
2503        if ( ! function_exists( 'download_url' ) || ! function_exists( 'media_handle_sideload' ) ) {
2504            return false;
2505        }
2506
2507        // if we didn't get a URL, let's bail.
2508        $parsed = wp_parse_url( $url );
2509        if ( empty( $parsed ) ) {
2510            return false;
2511        }
2512
2513        $tmp = download_url( $url );
2514        if ( is_wp_error( $tmp ) ) {
2515            return $tmp;
2516        }
2517
2518        // First check to see if we get a mime-type match by file, otherwise, check to
2519        // see if WordPress supports this file as an image. If neither, then it is not supported.
2520        if ( ! $this->is_file_supported_for_sideloading( $tmp ) || 'image' === $type && ! file_is_displayable_image( $tmp ) ) {
2521            @unlink( $tmp ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
2522            return new WP_Error( 'invalid_input', 'Invalid file type.', 403 );
2523        }
2524
2525        // emulate a $_FILES entry.
2526        $file_array = array(
2527            'name'     => basename( wp_parse_url( $url, PHP_URL_PATH ) ),
2528            'tmp_name' => $tmp,
2529        );
2530
2531        $id = media_handle_sideload( $file_array, $parent_post_id );
2532        if ( file_exists( $tmp ) ) {
2533            @unlink( $tmp ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
2534        }
2535
2536        if ( is_wp_error( $id ) ) {
2537            return $id;
2538        }
2539
2540        if ( ! $id || ! is_int( $id ) ) {
2541            return false;
2542        }
2543
2544        return $id;
2545    }
2546
2547    /**
2548     * Checks that the mime type of the specified file is among those in a filterable list of mime types.
2549     *
2550     * @param string $file Path to file to get its mime type.
2551     *
2552     * @return bool
2553     */
2554    protected function is_file_supported_for_sideloading( $file ) {
2555        return jetpack_is_file_supported_for_sideloading( $file );
2556    }
2557
2558    /**
2559     * Filter for `upload_mimes`.
2560     *
2561     * @param array $mimes Allowed mime types.
2562     * @return array Allowed mime types.
2563     */
2564    public function allow_video_uploads( $mimes ) {
2565        // if we are on Jetpack, bail - Videos are already allowed.
2566        if ( ! defined( 'IS_WPCOM' ) || ! IS_WPCOM ) {
2567            return $mimes;
2568        }
2569
2570        // extra check that this filter is only ever applied during REST API requests.
2571        if ( ! defined( 'REST_API_REQUEST' ) || ! REST_API_REQUEST ) {
2572            return $mimes;
2573        }
2574
2575        // bail early if they already have video upload capability.
2576        if ( wpcom_site_can_upload_videos() ) {
2577            return $mimes;
2578        }
2579
2580        // lets whitelist to only specific clients right now.
2581        $clients_allowed_video_uploads = array();
2582        /**
2583         * Filter the list of whitelisted video clients.
2584         *
2585         * @module json-api
2586         *
2587         * @since 3.2.0
2588         *
2589         * @param array $clients_allowed_video_uploads Array of whitelisted Video clients.
2590         */
2591        $clients_allowed_video_uploads = apply_filters( 'rest_api_clients_allowed_video_uploads', $clients_allowed_video_uploads );
2592        if ( ! isset( $this->api->token_details['client_id'] ) || ! in_array( $this->api->token_details['client_id'], $clients_allowed_video_uploads, true ) ) {
2593            return $mimes;
2594        }
2595
2596        $mime_list = wp_get_mime_types();
2597
2598        $video_exts = explode( ' ', get_site_option( 'video_upload_filetypes', false, false ) );
2599        /**
2600         * Filter the video filetypes allowed on the site.
2601         *
2602         * @module json-api
2603         *
2604         * @since 3.2.0
2605         *
2606         * @param array $video_exts Array of video filetypes allowed on the site.
2607         */
2608        $video_exts  = apply_filters( 'video_upload_filetypes', $video_exts );
2609        $video_mimes = array();
2610
2611        if ( ! empty( $video_exts ) ) {
2612            foreach ( $video_exts as $ext ) {
2613                foreach ( $mime_list as $ext_pattern => $mime ) {
2614                    if ( '' !== $ext && str_contains( $ext_pattern, $ext ) ) {
2615                        $video_mimes[ $ext_pattern ] = $mime;
2616                    }
2617                }
2618            }
2619
2620            $mimes = array_merge( $mimes, $video_mimes );
2621        }
2622
2623        return $mimes;
2624    }
2625
2626    /**
2627     * Is the current site multi-user?
2628     *
2629     * @return bool
2630     */
2631    public function is_current_site_multi_user() {
2632        $users = wp_cache_get( 'site_user_count', 'WPCOM_JSON_API_Endpoint' );
2633        if ( false === $users ) {
2634            $user_query = new WP_User_Query(
2635                array(
2636                    'blog_id' => get_current_blog_id(),
2637                    'fields'  => 'ID',
2638                )
2639            );
2640            $users      = (int) $user_query->get_total();
2641            wp_cache_set( 'site_user_count', $users, 'WPCOM_JSON_API_Endpoint', DAY_IN_SECONDS );
2642        }
2643        return $users > 1;
2644    }
2645
2646    /**
2647     * Whether cross-origin requests are allowed.
2648     *
2649     * @return bool
2650     */
2651    public function allows_cross_origin_requests() {
2652        return 'GET' === $this->method || $this->allow_cross_origin_request;
2653    }
2654
2655    /**
2656     * Whether unauthorized requests are allowed.
2657     *
2658     * @param string   $origin Origin.
2659     * @param string[] $complete_access_origins Access origins.
2660     * @return bool
2661     */
2662    public function allows_unauthorized_requests( $origin, $complete_access_origins ) {
2663        return 'GET' === $this->method || ( $this->allow_unauthorized_request && in_array( $origin, $complete_access_origins, true ) );
2664    }
2665
2666    /**
2667     * Whether this endpoint accepts site based authentication for the current request.
2668     *
2669     * @since 9.1.0
2670     *
2671     * @return bool true, if Jetpack blog token is used and `allow_jetpack_site_auth` is true,
2672     * false otherwise.
2673     */
2674    public function accepts_site_based_authentication() {
2675        return $this->allow_jetpack_site_auth &&
2676            $this->api->is_jetpack_authorized_for_site();
2677    }
2678
2679    /**
2680     * Get platform.
2681     *
2682     * @return WPORG_Platform
2683     */
2684    public function get_platform() {
2685        return wpcom_get_sal_platform( $this->api->token_details );
2686    }
2687
2688    /**
2689     * Allows the endpoint to perform logic to allow it to decide whether-or-not it should force a
2690     * response from the WPCOM API, or potentially go to the Jetpack blog.
2691     *
2692     * Override this method if you want to do something different.
2693     *
2694     * @param int $blog_id Blog ID.
2695     * @return bool
2696     */
2697    public function force_wpcom_request( $blog_id ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
2698        return false;
2699    }
2700
2701    /**
2702     * Get an array of all valid AMP origins for a blog's siteurl.
2703     *
2704     * @param string $siteurl Origin url of the API request.
2705     * @return array
2706     */
2707    public function get_amp_cache_origins( $siteurl ) {
2708        $host = wp_parse_url( $siteurl, PHP_URL_HOST );
2709
2710        /*
2711         * From AMP docs:
2712         * "When possible, the Google AMP Cache will create a subdomain for each AMP document's domain by first converting it
2713         * from IDN (punycode) to UTF-8. The caches replaces every - (dash) with -- (2 dashes) and replace every . (dot) with
2714         * - (dash). For example, pub.com will map to pub-com.cdn.ampproject.org."
2715         */
2716        if ( function_exists( 'idn_to_utf8' ) ) {
2717            // The third parameter is set explicitly to prevent issues with newer PHP versions compiled with an old ICU version.
2718            $variant = defined( 'INTL_IDNA_VARIANT_UTS46' )
2719                ? INTL_IDNA_VARIANT_UTS46
2720                // phpcs:ignore PHPCompatibility.Constants.RemovedConstants.intl_idna_variant_2003Deprecated, PHPCompatibility.Constants.RemovedConstants.intl_idna_variant_2003DeprecatedRemoved
2721                : INTL_IDNA_VARIANT_2003; // @phan-suppress-current-line PhanUndeclaredConstant
2722            $host = idn_to_utf8( $host, IDNA_DEFAULT, $variant );
2723        }
2724        $subdomain = str_replace( array( '-', '.' ), array( '--', '-' ), $host );
2725        return array(
2726            $siteurl,
2727            // Google AMP Cache (legacy).
2728            'https://cdn.ampproject.org',
2729            // Google AMP Cache subdomain.
2730            sprintf( 'https://%s.cdn.ampproject.org', $subdomain ),
2731            // Cloudflare AMP Cache.
2732            sprintf( 'https://%s.amp.cloudflare.com', $subdomain ),
2733            // Bing AMP Cache.
2734            sprintf( 'https://%s.bing-amp.com', $subdomain ),
2735        );
2736    }
2737
2738    /**
2739     * Register a REST route for this jsonAPI endpoint.
2740     *
2741     * @return void
2742     * @throws Exception The exception if something goes wrong.
2743     */
2744    public function create_rest_route_for_endpoint() {
2745        register_rest_route(
2746            static::REST_NAMESPACE,
2747            $this->build_rest_route_regex(),
2748            array(
2749                'methods'             => $this->method,
2750                'callback'            => array( $this, 'rest_callback' ),
2751                'permission_callback' => array( $this, 'rest_permission_callback' ),
2752            )
2753        );
2754    }
2755
2756    /**
2757     * Handle the rest call.
2758     *
2759     * @param WP_REST_Request $request The request object.
2760     *
2761     * @return mixed|WP_Error
2762     */
2763    public function rest_callback( WP_REST_Request $request ) {
2764        // phpcs:ignore WordPress.PHP.IniSet.display_errors_Disallowed -- Making sure random warnings don't break JSON.
2765        ini_set( 'display_errors', false );
2766
2767        $blog_id = Jetpack_Options::get_option( 'id' );
2768
2769        add_filter( 'user_can_richedit', '__return_true' );
2770        add_filter( 'comment_edit_pre', array( $this->api, 'comment_edit_pre' ) );
2771
2772        $this->api->initialize();
2773        $this->api->endpoint = $this;
2774
2775        $this->api->path    = $this->path;
2776        $this->api->version = $this->max_version;
2777
2778        $locale = $request->get_param( 'language' );
2779        if ( $locale ) {
2780            $this->api->init_locale( $locale );
2781        }
2782
2783        if ( $this->in_testing && ! WPCOM_JSON_API__DEBUG ) {
2784            return new WP_Error( 'endpoint_not_available' );
2785        }
2786
2787        $token_data = ( new Manager() )->verify_xml_rpc_signature();
2788        if ( ! $token_data || empty( $token_data['token_key'] ) || ! array_key_exists( 'user_id', $token_data ) ) {
2789            return new WP_Error( 'response_signature_error' );
2790        }
2791
2792        $token = ( new Tokens() )->get_access_token( $token_data['user_id'], $token_data['token_key'] );
2793        if ( is_wp_error( $token ) ) {
2794            return $token;
2795        }
2796        if ( ! $token ) {
2797            return new WP_Error( 'response_signature_error' );
2798        }
2799
2800        /** This action is documented in class.json-api.php */
2801        do_action( 'wpcom_json_api_output', $this->stat );
2802
2803        $response = call_user_func_array(
2804            array( $this, 'callback' ),
2805            array_values( array( $this->path, $blog_id ) + $request->get_url_params() )
2806        );
2807
2808        if ( ! $response && ! is_array( $response ) ) {
2809            // Dealing with empty non-array response.
2810            $response = new WP_Error( 'empty_response', 'Endpoint response is empty', 500 );
2811        }
2812
2813        // Mirror the XML-RPC path, which runs filter_fields() in WPCOM_JSON_API::output() before
2814        // returning, so a `fields` request yields the same keys on both transports. Endpoints may
2815        // force-add keys past `fields` for internal processors (e.g. the post type/status/password);
2816        // without this they would leak on the REST transport only.
2817        if ( ! is_wp_error( $response ) ) {
2818            $response = $this->api->filter_fields( $response );
2819        }
2820
2821        $status_code = 200;
2822
2823        if ( is_wp_error( $response ) ) {
2824            $status_code = 500;
2825
2826            if ( $response->get_error_data() && is_scalar( $response->get_error_data() )
2827                && (string) (int) $response->get_error_data() === (string) $response->get_error_data()
2828            ) {
2829                $status_code = (int) $response->get_error_data();
2830            }
2831
2832            $response = WPCOM_JSON_API::serializable_error( $response );
2833        }
2834
2835        if ( $request->get_param( 'http_envelope' ) ) {
2836            $response = WPCOM_JSON_API::wrap_http_envelope( $status_code, $response, 'application/json' );
2837        }
2838
2839        $response = wp_json_encode( $response, JSON_UNESCAPED_SLASHES );
2840
2841        $nonce = wp_generate_password( 10, false );
2842        $hmac  = hash_hmac( 'sha1', $nonce . $response, $token->secret );
2843
2844        return array(
2845            $response,
2846            (string) $nonce,
2847            $hmac,
2848        );
2849    }
2850
2851    /**
2852     * The REST endpoint should only be available for requests signed with a valid blog or user token.
2853     * Declaring it "final" so individual endpoints couldn't remove this requirement.
2854     *
2855     * If you need to add custom permissions to individual endpoints, you can override method `rest_permission_callback_custom()`.
2856     *
2857     * @see self::rest_permission_callback_custom()
2858     *
2859     * @return true|WP_Error
2860     */
2861    final public function rest_permission_callback() {
2862        $manager = new Manager( 'jetpack' );
2863        if ( ! $manager->is_connected() ) {
2864            return new WP_Error( 'site_not_connected' );
2865        }
2866
2867        if ( ( ( $this->allow_jetpack_site_auth || $this->allow_fallback_to_jetpack_blog_token ) && Rest_Authentication::is_signed_with_blog_token() )
2868            || ( get_current_user_id() && Rest_Authentication::is_signed_with_user_token() )
2869        ) {
2870            $custom_permission_result = $this->rest_permission_callback_custom();
2871
2872            // Successful custom permission check.
2873            if ( $custom_permission_result === true ) {
2874                return true;
2875            }
2876
2877            // Custom permission check errored, returning the error.
2878            if ( is_wp_error( $custom_permission_result ) ) {
2879                return $custom_permission_result;
2880            }
2881
2882            // Custom permission check failed, but didn't return a specific error. Proceed to returning the generic error.
2883        }
2884
2885        $message = esc_html__(
2886            'You do not have the correct user permissions to perform this action. Please contact your site admin if you think this is a mistake.',
2887            'jetpack'
2888        );
2889        return new WP_Error( 'rest_api_invalid_permission', $message, array( 'status' => rest_authorization_required_code() ) );
2890    }
2891
2892    /**
2893     * You can override this method in individual endpoints to add custom permission checks.
2894     * This will run on top of `rest_permission_callback()`.
2895     *
2896     * @see self::rest_permission_callback()
2897     *
2898     * @return true|WP_Error
2899     */
2900    public function rest_permission_callback_custom() {
2901        return true;
2902    }
2903
2904    /**
2905     * Build the REST endpoint URL.
2906     *
2907     * @return string
2908     */
2909    public function build_rest_route() {
2910        $version_prefix = $this->max_version ? 'v' . $this->max_version : '';
2911        return $version_prefix . $this->rest_route;
2912    }
2913
2914    /**
2915     * Whether the endpoint's rest_route carries %d/%s path-parameter tokens.
2916     *
2917     * @return bool
2918     */
2919    private function rest_route_has_tokens() {
2920        return str_contains( (string) $this->rest_route, '%' );
2921    }
2922
2923    /**
2924     * REST route with %d/%s path tokens converted to named captures, for register_rest_route().
2925     * Static (token-less) routes are returned unchanged.
2926     *
2927     * @return string
2928     */
2929    public function build_rest_route_regex() {
2930        if ( ! $this->rest_route_has_tokens() ) {
2931            return $this->build_rest_route();
2932        }
2933
2934        $index = 0;
2935        return preg_replace_callback(
2936            '/%[sd]/',
2937            function ( $matches ) use ( &$index ) {
2938                $name = 'p' . ( ++$index );
2939                return '%d' === $matches[0] ? "(?P<$name>\\d+)" : "(?P<$name>[^/]+)";
2940            },
2941            $this->build_rest_route()
2942        );
2943    }
2944
2945    /**
2946     * Concrete REST route for a single request: the real path-parameter values (from the request URL,
2947     * minus the leading site segment) substituted into the tokenized rest_route. Static routes are
2948     * returned unchanged. Used by the proxy transport.
2949     *
2950     * @param string $url Full request URL.
2951     * @return string
2952     */
2953    public function build_concrete_rest_route( $url ) {
2954        if ( ! $this->rest_route_has_tokens() ) {
2955            return $this->build_rest_route();
2956        }
2957
2958        // The request path minus its "/rest/vX.Y/sites/<site>" prefix already IS the concrete route
2959        // tail. The proxy matched this request to the endpoint's path template first, so the tail is
2960        // guaranteed to fit the pattern build_rest_route_regex() registered on the remote.
2961        $path = (string) wp_parse_url( $url, PHP_URL_PATH );
2962        $path = preg_replace( '#^/rest/v[\d.]+/sites/[^/]+#', '', $path );
2963
2964        return 'v' . $this->max_version . $path;
2965    }
2966
2967    /**
2968     * Get Jetpack Version where support for the endpoint was introduced.
2969     *
2970     * @return string
2971     */
2972    public function get_rest_min_jp_version() {
2973        return $this->rest_min_jp_version;
2974    }
2975
2976    /**
2977     * Return endpoint response
2978     *
2979     * @param string $path ... determined by ->$path.
2980     *
2981     * @return array|WP_Error
2982     *  falsy: HTTP 500, no response body
2983     *  WP_Error( $error_code, $error_message, $http_status_code ): HTTP $status_code, json_encode( array( 'error' => $error_code, 'message' => $error_message ) ) response body
2984     *  $data: HTTP 200, json_encode( $data ) response body
2985     */
2986    abstract public function callback( $path = '' );
2987}
2988
2989require_once __DIR__ . '/json-endpoints.php';