Changeset 47260

Timestamp:

02/11/2020 03:20:05 AM (5 years ago)

Author:

kadamwhite

Message:

REST API: Match REST API routes on namespace before performing regex checks.

Rule out groups of API endpoints by simple namespace string comparison to reduce the number of regex checks necessary when matching a route.

Props TimothyBlynJacobs.
Fixes #48530.

Location:

trunk

Files:

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

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

@@ -745 +745 @@
      *
      * @since 4.4.0
-     *
+     * @since 5.4.0 Add $namespace parameter.
+     *
+     * @param string $namespace Optionally, only return routes in the given namespace.
      * @return array `'/path/regex' => array( $callback, $bitmask )` or
      *               `'/path/regex' => array( array( $callback, $bitmask ), ...)`.
      */
-    public function get_routes() {
+    public function get_routes( $namespace = '' ) {
+        $endpoints = $this->endpoints;
+
+        if ( $namespace ) {
+            $endpoints = wp_list_filter( $endpoints, array( 'namespace' => $namespace ) );
+        }
 
         /**
@@ -761 +768 @@
          *                         `'/path/regex' => array( array( $callback, $bitmask ).
          */
-        $endpoints = apply_filters( 'rest_endpoints', $this->endpoints );
+        $endpoints = apply_filters( 'rest_endpoints', $endpoints );
 
         // Normalise the endpoints.
@@ -873 +880 @@
         $path   = $request->get_route();
 
-        foreach ( $this->get_routes() as $route => $handlers ) {
+        $routes = array();
+
+        foreach ( $this->get_namespaces() as $namespace ) {
+            if ( 0 === strpos( ltrim( $path, '/' ), $namespace ) ) {
+                $routes = $this->get_routes( $namespace );
+                break;
+            }
+        }
+
+        if ( ! $routes ) {
+            $routes = $this->get_routes();
+        }
+
+        foreach ( $routes as $route => $handlers ) {
             $match = preg_match( '@^' . $route . '$@i', $path, $matches );
 

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

@@ -1432 +1432 @@
     }
 
+    /**
+     * @ticket 48530
+     */
+    public function test_get_routes_respects_namespace_parameter() {
+        $routes = rest_get_server()->get_routes( 'oembed/1.0' );
+
+        foreach ( $routes as $route => $handlers ) {
+            $this->assertStringStartsWith( '/oembed/1.0', $route );
+        }
+    }
+
     public function _validate_as_integer_123( $value, $request, $key ) {
         if ( ! is_int( $value ) ) {