<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53473] trunk: General: Ensure `wp_rand()` returns `0` when `$min` and `$max` values are equal to `0`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53473">53473</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53473","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-06-06 22:48:21 +0000 (Mon, 06 Jun 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/55194">#55194</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>
<li><a href="#trunktestsphpunittestspluggablephp">trunk/tests/phpunit/tests/pluggable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespluggablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/pluggable.php 2022-06-06 22:33:15 UTC (rev 53472)
+++ trunk/src/wp-includes/pluggable.php 2022-06-06 22:48:21 UTC (rev 53473)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2596,14 +2596,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.2
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 Uses PHP7 random_int() or the random_compat library if available.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.1.0 Returns zero instead of a random number if both `$min` and `$max` are zero.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $rnd_value
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $min Lower limit for the generated number.
- * @param int $max Upper limit for the generated number.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int A random number between min and max.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function wp_rand( $min = 0, $max = 0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function wp_rand( $min = null, $max = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $rnd_value;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Some misconfigured 32-bit environments (Entropy PHP, for example)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2610,6 +2613,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // truncate integers larger than PHP_INT_MAX to PHP_INT_MAX rather than overflowing them to floats.
</span><span class="cx" style="display: block; padding: 0 10px"> $max_random_number = 3000000000 === 2147483647 ? (float) '4294967295' : 4294967295; // 4294967295 = 0xffffffff
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( null === $min ) {
+ $min = 0;
+ }
+
+ if ( null === $max ) {
+ $max = $max_random_number;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // We only handle ints, floats are truncated to their integer value.
</span><span class="cx" style="display: block; padding: 0 10px"> $min = (int) $min;
</span><span class="cx" style="display: block; padding: 0 10px"> $max = (int) $max;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2618,10 +2629,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> static $use_random_int_functionality = true;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $use_random_int_functionality ) {
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $_max = ( 0 != $max ) ? $max : $max_random_number;
</del><span class="cx" style="display: block; padding: 0 10px"> // wp_rand() can accept arguments in either order, PHP cannot.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $_max = max( $min, $_max );
- $_min = min( $min, $_max );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $_max = max( $min, $max );
+ $_min = min( $min, $max );
</ins><span class="cx" style="display: block; padding: 0 10px"> $val = random_int( $_min, $_max );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $val ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return absint( $val );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2661,9 +2671,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = abs( hexdec( $value ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Reduce the value to be within the min - max range.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 0 != $max ) {
- $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return abs( (int) $value );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestspluggablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/pluggable.php 2022-06-06 22:33:15 UTC (rev 53472)
+++ trunk/tests/phpunit/tests/pluggable.php 2022-06-06 22:48:21 UTC (rev 53473)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,8 +224,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'extra_special_chars' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_rand' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'min' => 0,
- 'max' => 0,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'min' => null,
+ 'max' => null,
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp_set_password' => array( 'password', 'user_id' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'get_avatar' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,4 +354,98 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $current_user, $from_get_user_by );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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,
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>