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, 2008 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                 // Set part description
  61                 $this->setObjectDescription("Standard random number generator");
  62
  63                 // Create unique ID number
  64                 $this->generateUniqueId();
  65
  66                 // Clean up a little
  67                 $this->removeNumberFormaters();
  68                 $this->removeSystemArray();
  69         }
  70
  71         /**
  72          * Creates an instance of this class
  73          *
  74          * @return      $rngInstance    An instance of this random number generator
  75          */
  76         public final static function createRandomNumberGenerator () {
  77                 // Get a new instance
  78                 $rngInstance = new RandomNumberGenerator();
  79
  80                 // Initialize the RNG now
  81                 $rngInstance->initRng();
  82
  83                 // Return the instance
  84                 return $rngInstance;
  85         }
  86
  87         /**
  88          * Initializes the random number generator
  89          *
  90          * @return      void
  91          */
  92         protected function initRng () {
  93                 // Seed mt_rand()
  94                 mt_srand((double) microtime() * 1000000);
  95
  96                 // Get the prime number from config
  97                 $this->prime = $this->getConfigInstance()->readConfig('math_prime');
  98
  99                 // Calculate the extra number which is always the same unless you give
 100                 // a better prime number
 101                 $this->extraNumber = ($this->prime * $this->prime / (pi() ^ 2));
 102
 103                 // Set the server IP to cluster
 104                 $serverIp = "cluster";
 105
 106                 // Do we have a single server?
 107                 if ($this->getConfigInstance()->readConfig('is_single_server') == "Y") {
 108                         // Then use that IP for extra security
 109                         $serverIp = getenv('SERVER_ADDR');
 110                 } // END - if
 111
 112                 // Yet-another fixed salt. This is not dependend on server software or date
 113                 $this->fixedSalt = sha1($serverIp . ":" . serialize($this->getDatabaseInstance()->getConnectionData()));
 114
 115                 // One-way data we need for "extra-salting" the random number
 116                 /* @TODO Add site key for stronger salt! */
 117                 $this->extraSalt = sha1($this->fixedSalt . ":" . getenv('SERVER_SOFTWARE') . ":" . $this->getConfigInstance()->readConfig('date_key'));
 118
 119                 // Get config entry for max salt length
 120                 $this->rndStrLen = $this->getConfigInstance()->readConfig('rnd_str_length');
 121         }
 122
 123         /**
 124          * Makes a pseudo-random string useable for salts
 125          *
 126          * @param       $length                 Length of the string, default: 128
 127          * @return      $randomString   The pseudo-random string
 128          */
 129         public function makeRandomString ($length = -1) {
 130                 // Is the number <1, then fix it to default length
 131                 if ($length < 1) $length = $this->rndStrLen;
 132
 133                 // Initialize the string
 134                 $randomString = "";
 135
 136                 // And generate it
 137                 for ($idx = 0; $idx < $length; $idx++) {
 138                         // Add a random character and add it to our string
 139                         $randomString .= chr($this->randomNumnber(0, 255));
 140                 }
 141
 142                 // Return the random string a little mixed up
 143                 return str_shuffle($randomString);
 144         }
 145
 146         /**
 147          * Generate a pseudo-random integer number in a given range
 148          *
 149          * @param       $min    Min value to generate
 150          * @param       $max    Max value to generate
 151          * @return      $num    Pseudo-random number
 152          */
 153         public function randomNumnber ($min, $max) {
 154                 /* @TODO I had a better random number generator here but now it is somewhere lost :( */
 155                 return mt_rand($min, $max);
 156         }
 157
 158         /**
 159          * Getter for extra salt
 160          *
 161          * @return      $extraSalt
 162          */
 163         public final function getExtraSalt () {
 164                 return $this->extraSalt;
 165         }
 166
 167         /**
 168          * Getter for fixed salt
 169          *
 170          * @return      $fixedSalt
 171          */
 172         public final function getFixedSalt () {
 173                 return $this->fixedSalt;
 174         }
 175 }
 176
 177 // [EOF]
 178 ?>