Changeset 44933

Timestamp:

03/19/2019 03:21:28 AM (7 years ago)

Author:

kadamwhite

Message:

REST API: Ensure "Allow" header is returned for OPTIONS requests.

This changeset ensures $request->set_url_params() is called while fulfilling OPTIONS requests, where previously it was skipped because OPTIONS requests short-circuit the logic in dispatch which handles this setup for other request methods. Omitting the URL parameters prevented the Allow header from being set.

Props killua99, noisysocks.
Fixes #45753.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

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

@@ -616 +616 @@
 
         foreach ( $handler->get_routes() as $route => $endpoints ) {
-                $match = preg_match( '@^' . $route . '$@i', $request->get_route() );
+                $match = preg_match( '@^' . $route . '$@i', $request->get_route(), $matches );
 
                 if ( ! $match ) {
                         continue;
+                }
+
+                $args = array();
+                foreach ( $matches as $param => $value ) {
+                        if ( ! is_int( $param ) ) {
+                                $args[ $param ] = $value;
+                        }
+                }
+
+                foreach ( $endpoints as $endpoint ) {
+                        // Remove the redundant preg_match argument.
+                        unset( $args[0] );
+
+                        $request->set_url_params( $args );
+                        $request->set_attributes( $endpoint );
                 }
 

trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -207 +207 @@
                 sort( $keys );
                 $this->assertEquals( array( 'context', 'id' ), $keys );
+        }
+
+        /**
+         * @ticket 43701
+         */
+        public function test_allow_header_sent_on_options_request() {
+                $id1      = $this->factory->attachment->create_object(
+                        $this->test_file,
+                        0,
+                        array(
+                                'post_mime_type' => 'image/jpeg',
+                                'post_excerpt'   => 'A sample caption',
+                        )
+                );
+                $request  = new WP_REST_Request( 'OPTIONS', sprintf( '/wp/v2/media/%d', $id1 ) );
+                $response = rest_get_server()->dispatch( $request );
+                $response = apply_filters( 'rest_post_dispatch', $response, rest_get_server(), $request );
+                $headers  = $response->get_headers();
+
+                $this->assertNotEmpty( $headers['Allow'] );
+                $this->assertEquals( $headers['Allow'], 'GET' );
+
+                wp_set_current_user( self::$editor_id );
+                $request  = new WP_REST_Request( 'OPTIONS', sprintf( '/wp/v2/media/%d', $id1 ) );
+                $response = rest_get_server()->dispatch( $request );
+                $response = apply_filters( 'rest_post_dispatch', $response, rest_get_server(), $request );
+                $headers  = $response->get_headers();
+
+                $this->assertNotEmpty( $headers['Allow'] );
+                $this->assertEquals( $headers['Allow'], 'GET, POST, PUT, PATCH, DELETE' );
         }
 

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -188 +188 @@
                 sort( $keys );
                 $this->assertEquals( array( 'context', 'id', 'password' ), $keys );
+        }
+
+        /**
+         * @ticket 43701
+         */
+        public function test_allow_header_sent_on_options_request() {
+                $request  = new WP_REST_Request( 'OPTIONS', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+                $response = rest_get_server()->dispatch( $request );
+                $response = apply_filters( 'rest_post_dispatch', $response, rest_get_server(), $request );
+                $headers  = $response->get_headers();
+
+                $this->assertNotEmpty( $headers['Allow'] );
+                $this->assertEquals( $headers['Allow'], 'GET' );
+
+                wp_set_current_user( self::$editor_id );
+                $request  = new WP_REST_Request( 'OPTIONS', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+                $response = rest_get_server()->dispatch( $request );
+                $response = apply_filters( 'rest_post_dispatch', $response, rest_get_server(), $request );
+                $headers  = $response->get_headers();
+
+                $this->assertNotEmpty( $headers['Allow'] );
+                $this->assertEquals( $headers['Allow'], 'GET, POST, PUT, PATCH, DELETE' );
         }