WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / random_compat / random_int.php
1 <?php
2 /**
3  * Random_* Compatibility Library 
4  * for using the new PHP 7 random_* API in PHP 5 projects
5  * 
6  * The MIT License (MIT)
7  * 
8  * Copyright (c) 2015 Paragon Initiative Enterprises
9  * 
10  * Permission is hereby granted, free of charge, to any person obtaining a copy
11  * of this software and associated documentation files (the "Software"), to deal
12  * in the Software without restriction, including without limitation the rights
13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14  * copies of the Software, and to permit persons to whom the Software is
15  * furnished to do so, subject to the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be included in
18  * all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26  * SOFTWARE.
27  */
28
29 /**
30  * Fetch a random integer between $min and $max inclusive
31  * 
32  * @param int $min
33  * @param int $max
34  * 
35  * @throws Exception
36  * 
37  * @return int
38  */
39 function random_int($min, $max)
40 {
41     /**
42      * Type and input logic checks
43      * 
44      * If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX)
45      * (non-inclusive), it will sanely cast it to an int. If you it's equal to
46      * ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats 
47      * lose precision, so the <= and => operators might accidentally let a float
48      * through.
49      */
50     
51     try {
52         $min = RandomCompat_intval($min);
53     } catch (TypeError $ex) {
54         throw new TypeError(
55             'random_int(): $min must be an integer'
56         );
57     }
58     try {
59         $max = RandomCompat_intval($max);
60     } catch (TypeError $ex) {
61         throw new TypeError(
62             'random_int(): $max must be an integer'
63         );
64     }
65     
66     /**
67      * Now that we've verified our weak typing system has given us an integer,
68      * let's validate the logic then we can move forward with generating random
69      * integers along a given range.
70      */
71     if ($min > $max) {
72         throw new Error(
73             'Minimum value must be less than or equal to the maximum value'
74         );
75     }
76     if ($max === $min) {
77         return $min;
78     }
79
80     /**
81      * Initialize variables to 0
82      * 
83      * We want to store:
84      * $bytes => the number of random bytes we need
85      * $mask => an integer bitmask (for use with the &) operator
86      *          so we can minimize the number of discards
87      */
88     $attempts = $bits = $bytes = $mask = $valueShift = 0;
89
90     /**
91      * At this point, $range is a positive number greater than 0. It might
92      * overflow, however, if $max - $min > PHP_INT_MAX. PHP will cast it to
93      * a float and we will lose some precision.
94      */
95     $range = $max - $min;
96
97     /**
98      * Test for integer overflow:
99      */
100     if (!is_int($range)) {
101         /**
102          * Still safely calculate wider ranges.
103          * Provided by @CodesInChaos, @oittaa
104          * 
105          * @ref https://gist.github.com/CodesInChaos/03f9ea0b58e8b2b8d435
106          * 
107          * We use ~0 as a mask in this case because it generates all 1s
108          * 
109          * @ref https://eval.in/400356 (32-bit)
110          * @ref http://3v4l.org/XX9r5  (64-bit)
111          */
112         $bytes = PHP_INT_SIZE;
113         $mask = ~0;
114     } else {
115         /**
116          * $bits is effectively ceil(log($range, 2)) without dealing with 
117          * type juggling
118          */
119         while ($range > 0) {
120             if ($bits % 8 === 0) {
121                ++$bytes;
122             }
123             ++$bits;
124             $range >>= 1;
125             $mask = $mask << 1 | 1;
126         }
127         $valueShift = $min;
128     }
129
130     /**
131      * Now that we have our parameters set up, let's begin generating
132      * random integers until one falls between $min and $max
133      */
134     do {
135         /**
136          * The rejection probability is at most 0.5, so this corresponds
137          * to a failure probability of 2^-128 for a working RNG
138          */
139         if ($attempts > 128) {
140             throw new Exception(
141                 'random_int: RNG is broken - too many rejections'
142             );
143         }
144
145         /**
146          * Let's grab the necessary number of random bytes
147          */
148         $randomByteString = random_bytes($bytes);
149         if ($randomByteString === false) {
150             throw new Exception(
151                 'Random number generator failure'
152             );
153         }
154
155         /**
156          * Let's turn $randomByteString into an integer
157          * 
158          * This uses bitwise operators (<< and |) to build an integer
159          * out of the values extracted from ord()
160          * 
161          * Example: [9F] | [6D] | [32] | [0C] =>
162          *   159 + 27904 + 3276800 + 201326592 =>
163          *   204631455
164          */
165         $val = 0;
166         for ($i = 0; $i < $bytes; ++$i) {
167             $val |= ord($randomByteString[$i]) << ($i * 8);
168         }
169
170         /**
171          * Apply mask
172          */
173         $val &= $mask;
174         $val += $valueShift;
175
176         ++$attempts;
177         /**
178          * If $val overflows to a floating point number,
179          * ... or is larger than $max,
180          * ... or smaller than $min,
181          * then try again.
182          */
183     } while (!is_int($val) || $val > $max || $val < $min);
184     return (int) $val;
185 }