51a0846ecd72a66b84839a02fbc0d9e2e1f35a10
[core.git] / inc / classes / main / rng / class_RandomNumberGenerator.php
1 <?php
2 /**
3  * A standard random number generator
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007 - 2009 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class RandomNumberGenerator extends BaseFrameworkSystem {
25         /**
26          * Prime number for better pseudo random numbers
27          */
28         private $prime = 0;
29
30         /**
31          * Add this calculated number to the rng
32          */
33         private $extraNumber = 0;
34
35         /**
36          * Extra salt for secured hashing
37          */
38         private $extraSalt = "";
39
40         /**
41          * Fixed salt for secured hashing
42          */
43         private $fixedSalt = "";
44
45         /**
46          * Maximum length for random string
47          */
48         private $rndStrLen = 0;
49
50         /**
51          * Protected constructor
52          *
53          * @param       $className      Name of this class
54          * @return      void
55          */
56         protected function __construct ($className = __CLASS__) {
57                 // Call parent constructor
58                 parent::__construct($className);
59
60                 // Clean up a little
61                 $this->removeNumberFormaters();
62                 $this->removeSystemArray();
63         }
64
65         /**
66          * Creates an instance of this class
67          *
68          * @param       $extraInstance  An extra instance for more salt (default: null)
69          * @return      $rngInstance    An instance of this random number generator
70          */
71         public final static function createRandomNumberGenerator (FrameworkInterface $extraInstance = null) {
72                 // Get a new instance
73                 $rngInstance = new RandomNumberGenerator();
74
75                 // Initialize the RNG now
76                 $rngInstance->initRng($extraInstance);
77
78                 // Return the instance
79                 return $rngInstance;
80         }
81
82         /**
83          * Initializes the random number generator
84          *
85          * @param       $extraInstance  An extra instance for more salt (default: null)
86          * @return      void
87          * @todo        Add site key for stronger salt!
88          */
89         protected function initRng ($extraInstance) {
90                 // Get the prime number from config
91                 $this->prime = $this->getConfigInstance()->readConfig('math_prime');
92
93                 // Calculate the extra number which is always the same unless you give
94                 // a better prime number
95                 $this->extraNumber = ($this->prime * $this->prime / (pi() ^ 2));
96
97                 // Seed mt_rand()
98                 mt_srand((double) sqrt(microtime() * 100000000 * $this->extraNumber));
99
100                 // Set the server IP to cluster
101                 $serverIp = "cluster";
102
103                 // Do we have a single server?
104                 if ($this->getConfigInstance()->readConfig('is_single_server') === "Y") {
105                         // Then use that IP for extra security
106                         $serverIp = getenv('SERVER_ADDR');
107                 } // END - if
108
109                 // Yet-another fixed salt. This is not dependend on server software or date
110                 if ($extraInstance instanceof FrameworkInterface) {
111                         // With extra instance information
112                         $this->fixedSalt = sha1($serverIp . ":" . $extraInstance->__toString() . ":" . serialize($this->getDatabaseInstance()->getConnectionData()));
113                 } else {
114                         // Without extra information
115                         $this->fixedSalt = sha1($serverIp . ":" . serialize($this->getDatabaseInstance()->getConnectionData()));
116                 }
117
118                 // One-way data we need for "extra-salting" the random number
119                 $this->extraSalt = sha1($this->fixedSalt . ":" . getenv('SERVER_SOFTWARE') . ":" . $this->getConfigInstance()->readConfig('date_key') . $this->getConfigInstance()->readConfig('base_url'));
120
121                 // Get config entry for max salt length
122                 $this->rndStrLen = $this->getConfigInstance()->readConfig('rnd_str_length');
123         }
124
125         /**
126          * Makes a pseudo-random string useable for salts
127          *
128          * @param       $length                 Length of the string, default: 128
129          * @return      $randomString   The pseudo-random string
130          */
131         public function randomString ($length = -1) {
132                 // Is the number <1, then fix it to default length
133                 if ($length < 1) $length = $this->rndStrLen;
134
135                 // Initialize the string
136                 $randomString = "";
137
138                 // And generate it
139                 for ($idx = 0; $idx < $length; $idx++) {
140                         // Add a random character and add it to our string
141                         $randomString .= chr($this->randomNumber(0, 255));
142                 }
143
144                 // Return the random string a little mixed up
145                 return str_shuffle($randomString);
146         }
147
148         /**
149          * Generate a pseudo-random integer number in a given range
150          *
151          * @param       $min    Min value to generate
152          * @param       $max    Max value to generate
153          * @return      $num    Pseudo-random number
154          * @todo        I had a better random number generator here but now it is somewhere lost :(
155          */
156         public function randomNumber ($min, $max) {
157                 return mt_rand($min, $max);
158         }
159
160         /**
161          * Getter for extra salt
162          *
163          * @return      $extraSalt
164          */
165         public final function getExtraSalt () {
166                 return $this->extraSalt;
167         }
168
169         /**
170          * Getter for fixed salt
171          *
172          * @return      $fixedSalt
173          */
174         public final function getFixedSalt () {
175                 return $this->fixedSalt;
176         }
177 }
178
179 // [EOF]
180 ?>