Changeset 47627

Timestamp:

04/27/2020 02:27:02 AM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support the (min|max)Length JSON Schema keywords.

Props sorenbronsted.
Fixes #48820.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)

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

@@ -1338 +1338 @@
     }
 
-    if ( 'string' === $args['type'] && ! is_string( $value ) ) {
-        /* translators: 1: Parameter, 2: Type name. */
-        return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'string' ) );
+    if ( 'string' === $args['type'] ) {
+        if ( ! is_string( $value ) ) {
+            /* translators: 1: Parameter, 2: Type name. */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'string' ) );
+        }
+
+        if ( isset( $args['minLength'] ) && mb_strlen( $value ) < $args['minLength'] ) {
+            return new WP_Error(
+                'rest_invalid_param',
+                sprintf(
+                    /* translators: 1: Parameter, 2: Number of characters. */
+                    _n( '%1$s must be at least %2$s character long.', '%1$s must be at least %2$s characters long.', $args['minLength'] ),
+                    $param,
+                    number_format_i18n( $args['minLength'] )
+                )
+            );
+        }
+
+        if ( isset( $args['maxLength'] ) && mb_strlen( $value ) > $args['maxLength'] ) {
+            return new WP_Error(
+                'rest_invalid_param',
+                sprintf(
+                    /* translators: 1: Parameter, 2: Number of characters. */
+                    _n( '%1$s must be at most %2$s character long.', '%1$s must be at most %2$s characters long.', $args['maxLength'] ),
+                    $param,
+                    number_format_i18n( $args['maxLength'] )
+                )
+            );
+        }
     }
 

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -349 +349 @@
         $this->assertWPError( rest_validate_value_from_schema( array( 'raw' => array( 'a list' ) ), $schema ) );
     }
+
+    /**
+     * @ticket 48820
+     */
+    public function test_string_min_length() {
+        $schema = array(
+            'type'      => 'string',
+            'minLength' => 2,
+        );
+
+        // longer
+        $this->assertTrue( rest_validate_value_from_schema( 'foo', $schema ) );
+        // exact
+        $this->assertTrue( rest_validate_value_from_schema( 'fo', $schema ) );
+        // non-strings does not validate
+        $this->assertWPError( rest_validate_value_from_schema( 1, $schema ) );
+        // to short
+        $this->assertWPError( rest_validate_value_from_schema( 'f', $schema ) );
+        // one supplementary Unicode code point is not long enough
+        $mb_char = mb_convert_encoding( 'က', 'UTF-8', 'HTML-ENTITIES' );
+        $this->assertWPError( rest_validate_value_from_schema( $mb_char, $schema ) );
+        // two supplementary Unicode code point is long enough
+        $this->assertTrue( rest_validate_value_from_schema( $mb_char . $mb_char, $schema ) );
+    }
+
+    /**
+     * @ticket 48820
+     */
+    public function test_string_max_length() {
+        $schema = array(
+            'type'      => 'string',
+            'maxLength' => 2,
+        );
+
+        // shorter
+        $this->assertTrue( rest_validate_value_from_schema( 'f', $schema ) );
+        // exact
+        $this->assertTrue( rest_validate_value_from_schema( 'fo', $schema ) );
+        // to long
+        $this->assertWPError( rest_validate_value_from_schema( 'foo', $schema ) );
+        // non string
+        $this->assertWPError( rest_validate_value_from_schema( 100, $schema ) );
+        // two supplementary Unicode code point is long enough
+        $mb_char = mb_convert_encoding( 'က', 'UTF-8', 'HTML-ENTITIES' );
+        $this->assertTrue( rest_validate_value_from_schema( $mb_char, $schema ) );
+        // three supplementary Unicode code point is to long
+        $this->assertWPError( rest_validate_value_from_schema( $mb_char . $mb_char . $mb_char, $schema ) );
+    }
 }