Changeset 48357 for trunk/src/wp-includes/rest-api.php

Timestamp:

07/07/2020 03:20:34 AM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Add support for the uniqueItems keyword.

Props sorenbronsted.
Fixes #48821.

File:

• trunk/src/wp-includes/rest-api.php (modified) (6 diffs)

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

@@ -1440 +1440 @@
 
 /**
+ * Checks if an array is made up of unique items.
+ *
+ * @since 5.5.0
+ *
+ * @param array $array The array to check.
+ * @return bool True if the array contains unique items, false otherwise.
+ */
+function rest_validate_array_contains_unique_items( $array ) {
+    $seen = array();
+
+    foreach ( $array as $item ) {
+        $stabilized = rest_stabilize_value( $item );
+        $key        = serialize( $stabilized );
+
+        if ( ! isset( $seen[ $key ] ) ) {
+            $seen[ $key ] = true;
+
+            continue;
+        }
+
+        return false;
+    }
+
+    return true;
+}
+
+/**
+ * Stabilizes a value following JSON Schema semantics.
+ *
+ * For lists, order is preserved. For objects, properties are reordered alphabetically.
+ *
+ * @since 5.5.0
+ *
+ * @param mixed $value The value to stabilize. Must already be sanitized. Objects should have been converted to arrays.
+ * @return mixed The stabilized value.
+ */
+function rest_stabilize_value( $value ) {
+    if ( is_scalar( $value ) || is_null( $value ) ) {
+        return $value;
+    }
+
+    if ( is_object( $value ) ) {
+        _doing_it_wrong( __FUNCTION__, __( 'Cannot stabilize objects. Convert the object to an array first.' ), '5.5.0' );
+
+        return $value;
+    }
+
+    ksort( $value );
+
+    foreach ( $value as $k => $v ) {
+        $value[ $k ] = rest_stabilize_value( $v );
+    }
+
+    return $value;
+}
+
+/**
  * Validate a value based on a schema.
  *
@@ -1449 +1506 @@
  * @since 5.5.0 Add the "uuid" and "hex-color" formats.
  *              Support the "minLength", "maxLength" and "pattern" keywords for strings.
+ *              Support the "minItems", "maxItems" and "uniqueItems" keywords for arrays.
  *              Validate required properties.
- *              Support the "minItems" and "maxItems" keywords for arrays.
  *
  * @param mixed  $value The value to validate.
@@ -1493 +1550 @@
         $value = rest_sanitize_array( $value );
 
-        foreach ( $value as $index => $v ) {
-            $is_valid = rest_validate_value_from_schema( $v, $args['items'], $param . '[' . $index . ']' );
-            if ( is_wp_error( $is_valid ) ) {
-                return $is_valid;
+        if ( isset( $args['items'] ) ) {
+            foreach ( $value as $index => $v ) {
+                $is_valid = rest_validate_value_from_schema( $v, $args['items'], $param . '[' . $index . ']' );
+                if ( is_wp_error( $is_valid ) ) {
+                    return $is_valid;
+                }
             }
         }
@@ -1508 +1567 @@
             /* translators: 1: Parameter, 2: Number. */
             return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at most %2$s items.' ), $param, number_format_i18n( $args['maxItems'] ) ) );
+        }
+
+        if ( ! empty( $args['uniqueItems'] ) && ! rest_validate_array_contains_unique_items( $value ) ) {
+            /* translators: 1: Parameter */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s has duplicate items.' ), $param ) );
         }
     }
@@ -1719 +1783 @@
  * @param array  $args  Schema array to use for sanitization.
  * @param string $param The parameter name, used in error messages.
- * @return mixed The sanitized value.
+ * @return mixed|WP_Error The sanitized value or a WP_Error instance if the value cannot be safely sanitized.
  */
 function rest_sanitize_value_from_schema( $value, $args, $param = '' ) {
@@ -1751 +1815 @@
         $value = rest_sanitize_array( $value );
 
-        if ( empty( $args['items'] ) ) {
-            return $value;
-        }
-
-        foreach ( $value as $index => $v ) {
-            $value[ $index ] = rest_sanitize_value_from_schema( $v, $args['items'], $param . '[' . $index . ']' );
+        if ( ! empty( $args['items'] ) ) {
+            foreach ( $value as $index => $v ) {
+                $value[ $index ] = rest_sanitize_value_from_schema( $v, $args['items'], $param . '[' . $index . ']' );
+            }
+        }
+
+        if ( ! empty( $args['uniqueItems'] ) && ! rest_validate_array_contains_unique_items( $value ) ) {
+            /* translators: 1: Parameter */
+            return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s has duplicate items.' ), $param ) );
         }