Changeset 37041

Timestamp:

03/22/2016 12:15:49 AM (7 years ago)

Author:

joehoyle

Message:

REST API: Provide better method for generating CURIEs

In [36533] CURIEs were added to the API responses for the link relation URIs, this makes
it a lot easier for clients to look up links by relation. That patch was functional, but
broke on edge cases such as embedded responses and collection items with links in the items.

This patch instead takes a less obtrusive approach by creating a new get_compact_response_links
to compliment get_response_links making both old and new functionality available.

Also the regex for curie relations has been relaxed to .+ as rel names can have any uri-valid charector in it.

Fixes #34729.

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-server.php (modified) (5 diffs)

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

@@ -422 +422 @@
     public function response_to_data( $response, $embed ) {
         $data  = $response->get_data();
-        $links = $this->get_response_links( $response );
+        $links = $this->get_compact_response_links( $response );
 
         if ( ! empty( $links ) ) {
@@ -455 +455 @@
     public static function get_response_links( $response ) {
         $links = $response->get_links();
-
         if ( empty( $links ) ) {
             return array();
@@ -462 +461 @@
         // Convert links to part of the data.
         $data = array();
+        foreach ( $links as $rel => $items ) {
+            $data[ $rel ] = array();
+
+            foreach ( $items as $item ) {
+                $attributes = $item['attributes'];
+                $attributes['href'] = $item['href'];
+                $data[ $rel ][] = $attributes;
+            }
+        }
+
+        return $data;
+    }
+
+    /**
+     * Retrieves the CURIEs (compact URIs) used for relations.
+     *
+     * Extracts the links from a response into a structured hash, suitable for
+     * direct output.
+     *
+     * @since 4.5.0
+     * @access public
+     * @static
+     *
+     * @param WP_REST_Response $response Response to extract links from.
+     * @return array Map of link relation to list of link hashes.
+     */
+    public static function get_compact_response_links( $response ) {
+        $links = self::get_response_links( $response );
+
+        if ( empty( $links ) ) {
+            return array();
+        }
+
         $curies = $response->get_curies();
         $used_curies = array();
@@ -473 +505 @@
                     continue;
                 }
-                $used_curies[ $curie['name'] ] = $curie;
 
                 // Relation now changes from '$uri' to '$curie:$relation'
-                $rel_regex = str_replace( '\{rel\}', '([\w]+)', preg_quote( $curie['href'], '!' ) );
+                $rel_regex = str_replace( '\{rel\}', '(.+)', preg_quote( $curie['href'], '!' ) );
                 preg_match( '!' . $rel_regex . '!', $rel, $matches );
                 if ( $matches ) {
-                    $rel = $curie['name'] . ':' . $matches[1];
-                }
-                break;
-            }
-
-            $data[ $rel ] = array();
-
-            foreach ( $items as $item ) {
-                $attributes = $item['attributes'];
-                $attributes['href'] = $item['href'];
-                $data[ $rel ][] = $attributes;
+                    $new_rel = $curie['name'] . ':' . $matches[1];
+                    $used_curies[ $curie['name'] ] = $curie;
+                    $links[ $new_rel ] = $items;
+                    unset( $links[ $rel ] );
+                    break;
+                }
             }
         }
@@ -495 +521 @@
         // Push the curies onto the start of the links array.
         if ( $used_curies ) {
-            $data = array_merge( array( 'curies' => array_values( $used_curies ) ), $data );
-        }
-
-        return $data;
+            $links['curies'] = array_values( $used_curies );
+        }
+
+        return $links;
     }