Changeset 53473

Timestamp:

06/06/2022 10:48:21 PM (2 years ago)

Author:

audrasjb

Message:

General: Ensure wp_rand() returns 0 when $min and $max values are equal to 0.

This changeset ensures wp_rand() returns zero instead of a random number when both $min and $max values are equal to zero.

Fixes #55194.

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (4 diffs)
• tests/phpunit/tests/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2597 +2597 @@
      * @since 2.6.2
      * @since 4.4.0 Uses PHP7 random_int() or the random_compat library if available.
+     * @since 6.1.0 Returns zero instead of a random number if both `$min` and `$max` are zero.
      *
      * @global string $rnd_value
      *
-     * @param int $min Lower limit for the generated number.
-     * @param int $max Upper limit for the generated number.
+     * @param int $min Optional. Lower limit for the generated number.
+     *                 Accepts positive integers or zero. Defaults to 0.
+     * @param int $max Optional. Upper limit for the generated number.
+     *                 Accepts positive integers. Defaults to 4294967295.
      * @return int A random number between min and max.
      */
-    function wp_rand( $min = 0, $max = 0 ) {
+    function wp_rand( $min = null, $max = null ) {
         global $rnd_value;
 
@@ -2610 +2613 @@
         // truncate integers larger than PHP_INT_MAX to PHP_INT_MAX rather than overflowing them to floats.
         $max_random_number = 3000000000 === 2147483647 ? (float) '4294967295' : 4294967295; // 4294967295 = 0xffffffff
+
+        if ( null === $min ) {
+            $min = 0;
+        }
+
+        if ( null === $max ) {
+            $max = $max_random_number;
+        }
 
         // We only handle ints, floats are truncated to their integer value.
@@ -2619 +2630 @@
         if ( $use_random_int_functionality ) {
             try {
-                $_max = ( 0 != $max ) ? $max : $max_random_number;
                 // wp_rand() can accept arguments in either order, PHP cannot.
-                $_max = max( $min, $_max );
-                $_min = min( $min, $_max );
+                $_max = max( $min, $max );
+                $_min = min( $min, $max );
                 $val  = random_int( $_min, $_max );
                 if ( false !== $val ) {
@@ -2662 +2672 @@
 
         // Reduce the value to be within the min - max range.
-        if ( 0 != $max ) {
-            $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
-        }
+        $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
 
         return abs( (int) $value );

trunk/tests/phpunit/tests/pluggable.php

@@ -225 +225 @@
             ),
             'wp_rand'                         => array(
-                'min' => 0,
-                'max' => 0,
+                'min' => null,
+                'max' => null,
             ),
             'wp_set_password'                 => array( 'password', 'user_id' ),
@@ -355 +355 @@
         $this->assertSame( $current_user, $from_get_user_by );
     }
+
+    /**
+     * Tests that wp_rand() returns zero.
+     *
+     * @ticket 55194
+     * @dataProvider data_wp_rand_should_return_zero
+     * @covers ::wp_rand
+     *
+     * @param mixed $min Lower limit for the generated number.
+     * @param mixed $max Upper limit for the generated number.
+     */
+    public function test_wp_rand_should_return_zero( $min, $max ) {
+        $this->assertSame( 0, wp_rand( $min, $max ) );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_wp_rand_should_return_zero() {
+        return array(
+            'min and max as 0'      => array(
+                'min' => 0,
+                'max' => 0,
+            ),
+            'min and max as 0.0'    => array(
+                'min' => 0.0,
+                'max' => 0.0,
+            ),
+            'min as null, max as 0' => array(
+                'min' => null,
+                'max' => 0,
+            ),
+        );
+    }
+
+    /**
+     * Tests that wp_rand() returns a value between 1 and 99.
+     *
+     * @ticket 55194
+     * @dataProvider data_wp_rand_should_return_between_1_and_99
+     * @covers ::wp_rand
+     *
+     * @param int $min Lower limit for the generated number.
+     * @param int $max Upper limit for the generated number.
+     */
+    public function test_wp_rand_should_return_between_1_and_99( $min, $max ) {
+        $this->assertGreaterThan(
+            0,
+            wp_rand( $min, $max ),
+            'The value was not greater than 0'
+        );
+
+        $this->assertLessThan(
+            100,
+            wp_rand( $min, $max ),
+            'The value was not less than 100'
+        );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_wp_rand_should_return_between_1_and_99() {
+        return array(
+            '1 and 99'       => array(
+                'min' => 1,
+                'max' => 99,
+            ),
+            '-1 and 99'      => array(
+                'min' => -1,
+                'max' => 99,
+            ),
+            '1 and -99'      => array(
+                'min' => 1,
+                'max' => -99,
+            ),
+            '-1 and -99'     => array(
+                'min' => -1,
+                'max' => -99,
+            ),
+            '1.0 and 99.0'   => array(
+                'min' => 1.0,
+                'max' => 99.0,
+            ),
+            '-1.0 and -99.0' => array(
+                'min' => -1.0,
+                'max' => -99.0,
+            ),
+        );
+    }
 }