Changeset 49329

Timestamp:

10/27/2020 04:42:38 PM (3 months ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support a broader range of JSON media types.

Previously, we only supported application/json which prevented using subtypes like application/activity+json. This allows for the REST API to json_decode the body of requests using a JSON subtype Content-Type. Additionally, wp_die() now properly sends the error as JSON when a JSON subtype is specified in the Accept header.

Props pfefferle.
Fixes #49404.

Location:

trunk

Files:

• src/wp-includes/load.php (modified) (2 diffs)
• src/wp-includes/rest-api/class-wp-rest-request.php (modified) (3 diffs)
• tests/phpunit/tests/functions.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-request.php (modified) (1 diff)

trunk/src/wp-includes/load.php

@@ -1596 +1596 @@
 function wp_is_json_request() {
 
-    if ( isset( $_SERVER['HTTP_ACCEPT'] ) && false !== strpos( $_SERVER['HTTP_ACCEPT'], 'application/json' ) ) {
+    if ( isset( $_SERVER['HTTP_ACCEPT'] ) && wp_is_json_media_type( $_SERVER['HTTP_ACCEPT'] ) ) {
         return true;
     }
 
-    if ( isset( $_SERVER['CONTENT_TYPE'] ) && 'application/json' === $_SERVER['CONTENT_TYPE'] ) {
+    if ( isset( $_SERVER['CONTENT_TYPE'] ) && wp_is_json_media_type( $_SERVER['CONTENT_TYPE'] ) ) {
         return true;
     }
@@ -1634 +1634 @@
     return $jsonp_enabled;
 
+}
+
+/**
+ * Checks whether a string is a valid JSON Media Type.
+ *
+ * @since 5.6.0
+ *
+ * @param string $media_type A Media Type string to check.
+ * @return bool True if string is a valid JSON Media Type.
+ */
+function wp_is_json_media_type( $media_type ) {
+    static $cache = array();
+
+    if ( ! isset( $cache[ $media_type ] ) ) {
+        $cache[ $media_type ] = (bool) preg_match( '/(^|\s|,)application\/([\w!#\$&-\^\.\+]+\+)?json(\+oembed)?($|\s|;|,)/i', $media_type );
+    }
+
+    return $cache[ $media_type ];
 }
 

trunk/src/wp-includes/rest-api/class-wp-rest-request.php

@@ -325 +325 @@
 
     /**
+     * Checks if the request has specified a JSON content-type.
+     *
+     * @since 5.6.0
+     *
+     * @return bool True if the content-type header is JSON.
+     */
+    public function is_json_content_type() {
+        $content_type = $this->get_content_type();
+
+        return isset( $content_type['value'] ) && wp_is_json_media_type( $content_type['value'] );
+    }
+
+    /**
      * Retrieves the parameter priority order.
      *
@@ -336 +349 @@
         $order = array();
 
-        $content_type = $this->get_content_type();
-        if ( isset( $content_type['value'] ) && 'application/json' === $content_type['value'] ) {
+        if ( $this->is_json_content_type() ) {
             $order[] = 'JSON';
         }
@@ -659 +671 @@
 
         // Check that we actually got JSON.
-        $content_type = $this->get_content_type();
-
-        if ( empty( $content_type ) || 'application/json' !== $content_type['value'] ) {
+        if ( ! $this->is_json_content_type() ) {
             return true;
         }

trunk/tests/phpunit/tests/functions.php

@@ -1729 +1729 @@
         );
     }
+
+    /**
+     * @ticket 49404
+     * @dataProvider data_test_wp_is_json_media_type
+     */
+    public function test_wp_is_json_media_type( $input, $expected ) {
+        $this->assertEquals( $expected, wp_is_json_media_type( $input ) );
+    }
+
+
+    public function data_test_wp_is_json_media_type() {
+        return array(
+            array( 'application/ld+json', true ),
+            array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', true ),
+            array( 'application/activity+json', true ),
+            array( 'application/json+oembed', true ),
+            array( 'application/json', true ),
+            array( 'application/nojson', false ),
+            array( 'application/no.json', false ),
+            array( 'text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8', false ),
+            array( 'application/activity+json, application/nojson', true ),
+        );
+    }
 }

trunk/tests/phpunit/tests/rest-api/rest-request.php

@@ -177 +177 @@
         // JSON shouldn't be parsed.
         $this->assertEmpty( $this->request->get_param( 'has_json_params' ) );
+    }
+
+    public static function alternate_json_content_type_provider() {
+        return array(
+            array( 'application/ld+json', 'json', true ),
+            array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', 'json', true ),
+            array( 'application/activity+json', 'json', true ),
+            array( 'application/json+oembed', 'json', true ),
+            array( 'application/nojson', 'body', false ),
+            array( 'application/no.json', 'body', false ),
+        );
+    }
+
+    /**
+     * @ticket 49404
+     * @dataProvider alternate_json_content_type_provider
+     *
+     * @param string  $content_type The content-type
+     * @param string  $source The source value.
+     * @param boolean $accept_json The accept_json value.
+     */
+    public function test_alternate_json_content_type( $content_type, $source, $accept_json ) {
+        $this->request_with_parameters();
+
+        $this->request->set_method( 'POST' );
+        $this->request->set_header( 'Content-Type', $content_type );
+        $this->request->set_attributes( array( 'accept_json' => true ) );
+
+        // Check that JSON takes precedence.
+        $this->assertEquals( $source, $this->request->get_param( 'source' ) );
+        $this->assertEquals( $accept_json, $this->request->get_param( 'has_json_params' ) );
+    }
+
+    public static function is_json_content_type_provider() {
+        return array(
+            array( 'application/ld+json', true ),
+            array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', true ),
+            array( 'application/activity+json', true ),
+            array( 'application/json+oembed', true ),
+            array( 'application/nojson', false ),
+            array( 'application/no.json', false ),
+        );
+    }
+
+    /**
+     * @ticket 49404
+     * @dataProvider is_json_content_type_provider
+     *
+     * @param string  $content_type The content-type
+     * @param boolean $is_json The is_json value.
+     */
+    public function test_is_json_content_type( $content_type, $is_json ) {
+        $this->request_with_parameters();
+
+        $this->request->set_header( 'Content-Type', $content_type );
+
+        // Check for JSON content-type.
+        $this->assertEquals( $is_json, $this->request->is_json_content_type() );
+    }
+
+    /**
+     * @ticket 49404
+     */
+    public function test_content_type_cache() {
+        $this->request_with_parameters();
+        $this->assertFalse( $this->request->is_json_content_type() );
+
+        $this->request->set_header( 'Content-Type', 'application/json' );
+        $this->assertTrue( $this->request->is_json_content_type() );
+
+        $this->request->set_header( 'Content-Type', 'application/activity+json' );
+        $this->assertTrue( $this->request->is_json_content_type() );
+
+        $this->request->set_header( 'Content-Type', 'application/nojson' );
+        $this->assertFalse( $this->request->is_json_content_type() );
+
+        $this->request->set_header( 'Content-Type', 'application/json' );
+        $this->assertTrue( $this->request->is_json_content_type() );
+
+        $this->request->remove_header( 'Content-Type' );
+        $this->assertFalse( $this->request->is_json_content_type() );
     }