<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[44933] trunk: REST API: Ensure "Allow" header is returned for OPTIONS requests.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/44933">44933</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/44933","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-03-19 03:21:28 +0000 (Tue, 19 Mar 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/45753">#45753</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2019-03-19 02:47:41 UTC (rev 44932)
+++ trunk/src/wp-includes/rest-api.php 2019-03-19 03:21:28 UTC (rev 44933)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -615,12 +615,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $handler->get_routes() as $route => $endpoints ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $match = preg_match( '@^' . $route . '$@i', $request->get_route() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $match = preg_match( '@^' . $route . '$@i', $request->get_route(), $matches );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $match ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data = $handler->get_data_for_route( $route, $endpoints, 'help' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response->set_matched_route( $route );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2019-03-19 02:47:41 UTC (rev 44932)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2019-03-19 03:21:28 UTC (rev 44933)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,6 +208,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( 'context', 'id' ), $keys );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> $id1 = $this->factory->attachment->create_object(
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2019-03-19 02:47:41 UTC (rev 44932)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2019-03-19 03:21:28 UTC (rev 44933)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,6 +189,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( 'context', 'id', 'password' ), $keys );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items() {
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span></span></pre>
</div>
</div>
</body>
</html>