<!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>[36533] trunk: REST API: Add support for CURIEs.</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 { 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/36533">36533</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/36533","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rmccue</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-02-16 02:18:34 +0000 (Tue, 16 Feb 2016)</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: Add support for CURIEs.
CURIEs are Compact URIs, which provide a more usable way to use
custom relations in the API. The `wp` CURIE is registered by default
for `https://api.w.org/` URI relations.
Fixes <a href="https://core.trac.wordpress.org/ticket/34729">#34729</a>.
Props joehoyle.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiclasswprestresponsephp">trunk/src/wp-includes/rest-api/class-wp-rest-response.php</a></li>
<li><a href="#trunksrcwpincludesrestapiclasswprestserverphp">trunk/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestserverphp">trunk/tests/phpunit/tests/rest-api/rest-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiclasswprestresponsephp"></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/class-wp-rest-response.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-response.php 2016-02-16 01:56:13 UTC (rev 36532)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-response.php 2016-02-16 02:18:34 UTC (rev 36533)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -256,4 +256,45 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $error;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get the CURIEs (compact URIs) used for relations.
+ *
+ * @return array
+ */
+ public function get_curies() {
+ $curies = array(
+ array(
+ 'name' => 'wp',
+ 'href' => 'https://api.w.org/{rel}',
+ 'templated' => true,
+ ),
+ );
+
+ /**
+ * Filter extra CURIEs available on API responses.
+ *
+ * CURIEs allow a shortened version of URI relations. This allows a more
+ * usable form for custom relations than using the full URI. These work
+ * similarly to how XML namespaces work.
+ *
+ * Registered CURIES need to specify a name and URI template. This will
+ * automatically transform URI relations into their shortened version.
+ * The shortened relation follows the format `{name}:{rel}`. `{rel}` in
+ * the URI template will be replaced with the `{rel}` part of the
+ * shortened relation.
+ *
+ * For example, a CURIE with name `example` and URI template
+ * `http://w.org/{rel}` would transform a `http://w.org/term` relation
+ * into `example:term`.
+ *
+ * Well-behaved clients should expand and normalise these back to their
+ * full URI relation, however some naive clients may not resolve these
+ * correctly, so adding new CURIEs may break backwards compatibility.
+ *
+ * @param array $additional Additional CURIEs to register with the API.
+ */
+ $additional = apply_filters( 'rest_response_link_curies', array() );
+ return array_merge( $curies, $additional );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiclasswprestserverphp"></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/class-wp-rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2016-02-16 01:56:13 UTC (rev 36532)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2016-02-16 02:18:34 UTC (rev 36533)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -460,7 +460,28 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Convert links to part of the data.
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $curies = $response->get_curies();
+ $used_curies = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $links as $rel => $items ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Convert $rel URIs to their compact versions if they exist.
+ foreach ( $curies as $curie ) {
+ $href_prefix = substr( $curie['href'], 0, strpos( $curie['href'], '{rel}' ) );
+ if ( strpos( $rel, $href_prefix ) !== 0 ) {
+ continue;
+ }
+ $used_curies[ $curie['name'] ] = $curie;
+
+ // Relation now changes from '$uri' to '$curie:$relation'
+ $rel_regex = str_replace( '\{rel\}', '([\w]+)', preg_quote( $curie['href'], '!' ) );
+ preg_match( '!' . $rel_regex . '!', $rel, $matches );
+ if ( $matches ) {
+ $rel = $curie['name'] . ':' . $matches[1];
+ }
+ break;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data[ $rel ] = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $items as $item ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -470,6 +491,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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">+ // Push the curies onto the start of the links array.
+ if ( $used_curies ) {
+ $data = array_merge( array( 'curies' => array_values( $used_curies ) ), $data );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestserverphp"></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-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-server.php 2016-02-16 01:56:13 UTC (rev 36532)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2016-02-16 02:18:34 UTC (rev 36533)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -400,7 +400,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'embed', $alternate[1]['parameters']['context'] );
</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">+ public function test_link_curies() {
+ $response = new WP_REST_Response();
+ $response->add_link( 'https://api.w.org/term', 'http://example.com/' );
+
+ $data = $this->server->response_to_data( $response, false );
+ $links = $data['_links'];
+
+ $this->assertArrayHasKey( 'wp:term', $links );
+ $this->assertArrayHasKey( 'curies', $links );
+ }
+
+ public function test_custom_curie_link() {
+ $response = new WP_REST_Response();
+ $response->add_link( 'http://mysite.com/contact.html', 'http://example.com/' );
+
+ add_filter( 'rest_response_link_curies', array( $this, 'add_custom_curie' ) );
+
+ $data = $this->server->response_to_data( $response, false );
+ $links = $data['_links'];
+
+ $this->assertArrayHasKey( 'my_site:contact', $links );
+ $this->assertArrayHasKey( 'curies', $links );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Helper callback to add a new custom curie via a filter.
+ *
+ * @param array $curies
+ * @return array
+ */
+ public function add_custom_curie( $curies ) {
+ $curies[] = array(
+ 'name' => 'my_site',
+ 'href' => 'http://mysite.com/{rel}.html',
+ 'templated' => true,
+ );
+ return $curies;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @depends test_link_embedding
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_link_embedding_self() {
</span></span></pre>
</div>
</div>
</body>
</html>