application/hub/main/package/fragmenter/class_PackageFragmenter.php

   1 <?php
   2 /**
   3  * A PackageFragmenter class to fragment package data into smaller chunks for
   4  * delivery. This class calculates a final hash on the raw input data and
   5  * fragments the data into smaller chunks after it has been encoded by a
   6  * "outgoing encoding stream".
   7  *
   8  * All chunks are extended with a hash and a serial number to make it later
   9  * easier to verify them and put them back in the right order and to, if
  10  * required, request a re-delivery of an invalid chunk (e.g. hash didn't match).
  11  * Also an "end-of-package" marker is being added as the last chunk to mark the
  12  * end of of the whole package submission.
  13  *
  14  * @author              Roland Haeder <webmaster@ship-simu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.ship-simu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class PackageFragmenter extends BaseHubSystem implements Fragmentable, Registerable {
  34         /**
  35          * Cached chunk size in bits
  36          */
  37         private $chunkSize = 0;
  38
  39         /**
  40          * Array for chunks
  41          */
  42         private $chunks = array();
  43
  44         /**
  45          * Array for chunk hashes
  46          */
  47         private $chunkHashes = array();
  48
  49         /**
  50          * Array for chunk pointers
  51          */
  52         private $chunkPointers = array();
  53
  54         /**
  55          * Array for processed packages
  56          */
  57         private $processedPackages = array();
  58
  59         /**
  60          * Serial number
  61          */
  62         private $serialNumber = 0x00000000;
  63
  64         /**
  65          * Maximum possible serial number
  66          */
  67         private $maxSerialNumber  = 0;
  68
  69         /**
  70          * Length of largest possible serial number
  71          */
  72         const MAX_SERIAL_LENGTH = 8;
  73
  74         /**
  75          * Separator between chunk data, serial number and chunk hash
  76          */
  77         const CHUNK_DATA_HASH_SEPARATOR = '@';
  78
  79         /**
  80          * SEPARATOR for all chunk hashes
  81          */
  82         const CHUNK_HASH_SEPARATOR = ';';
  83
  84         /**
  85          * SEPARATOR between two chunks
  86          */
  87         const CHUNK_SEPARATOR = '|';
  88
  89         /**
  90          * Identifier for hash chunk
  91          */
  92         const HASH_CHUNK_IDENTIFIER = 'HASH-CHUNK:';
  93
  94         /**
  95          * Identifier for end-of-package marker
  96          */
  97         const END_OF_PACKAGE_IDENTIFIER = 'EOP:';
  98
  99         /**
 100          * Protected constructor
 101          *
 102          * @return      void
 103          */
 104         protected function __construct () {
 105                 // Call parent constructor
 106                 parent::__construct(__CLASS__);
 107
 108                 // Init this fragmenter
 109                 $this->initFragmenter();
 110         }
 111
 112         /**
 113          * Creates an instance of this class
 114          *
 115          * @return      $fragmenterInstance             An instance of a Fragmentable class
 116          */
 117         public static final function createPackageFragmenter () {
 118                 // Get new instance
 119                 $fragmenterInstance = new PackageFragmenter();
 120
 121                 // And also a crypto instance (for our encrypted messages)
 122                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
 123                 $fragmenterInstance->setCryptoInstance($cryptoInstance);
 124
 125                 // Return the prepared instance
 126                 return $fragmenterInstance;
 127         }
 128
 129         /**
 130          * Initializes this fragmenter
 131          *
 132          * @return      void
 133          */
 134         private function initFragmenter () {
 135                 // Load some configuration entries and "cache" them:
 136                 // - Chunk size in bits
 137                 $this->chunkSize = $this->getConfigInstance()->getConfigEntry('package_chunk_size');
 138
 139                 // - Maximum serial number
 140                 $this->maxSerialNumber = $this->hex2dec(str_repeat('f', self::MAX_SERIAL_LENGTH));
 141         }
 142
 143         /**
 144          * Initializes the pointer for given final hash
 145          *
 146          * @param       $finalHash      Final hash to initialize pointer for
 147          * @return      void
 148          */
 149         private function initPointer ($finalHash) {
 150                 $this->chunkPointers[$finalHash] = 0;
 151         }
 152
 153         /**
 154          * "Getter" for processedPackages array index
 155          *
 156          * @param       $packageData    Raw package data array
 157          * @return      $index                  Array index for processedPackages
 158          */
 159         private function getProcessedPackagesIndex (array $packageData) {
 160                 return (
 161                         $packageData[NetworkPackage::PACKAGE_DATA_SENDER]    . NetworkPackage::PACKAGE_DATA_SEPARATOR .
 162                         $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . NetworkPackage::PACKAGE_DATA_SEPARATOR .
 163                         $packageData[NetworkPackage::PACKAGE_DATA_CONTENT]   . NetworkPackage::PACKAGE_DATA_SEPARATOR
 164                 );
 165         }
 166
 167         /**
 168          * Checks whether the given package data is already processed by this fragmenter
 169          *
 170          * @param       $packageData    Raw package data array
 171          * @return      $isProcessed    Whether the package has been fragmented
 172          */
 173         private function isPackageProcessed (array $packageData) {
 174                 // Get array index
 175                 $index = $this->getProcessedPackagesIndex($packageData);
 176
 177                 // Is the array index there?
 178                 $isProcessed = (
 179                         (isset($this->processedPackages[$index]))
 180                                 &&
 181                         ($this->processedPackages[$index] === true)
 182                 );
 183
 184                 // Return it
 185                 return $isProcessed;
 186         }
 187
 188         /**
 189          * Marks the given package data as processed by this fragmenter
 190          *
 191          * @param       $packageData    Raw package data array
 192          * @return      void
 193          */
 194         private function markPackageDataProcessed (array $packageData) {
 195                 // Remember it (until we may remove it)
 196                 $this->processedPackages[$this->getProcessedPackagesIndex($packageData)] = true;
 197         }
 198
 199         /**
 200          * Getter for final hash from given package data
 201          *
 202          * @param       $packageData    Raw package data array
 203          * @return      $finalHash              Final hash for package data
 204          */
 205         private function getFinalHashFromPackageData (array $packageData) {
 206                 // Make sure it is there
 207                 assert(isset($this->processedPackages[$this->getProcessedPackagesIndex($packageData)]));
 208
 209                 // Return it
 210                 return $this->processedPackages[$this->getProcessedPackagesIndex($packageData)];
 211         }
 212
 213         /**
 214          * Get next chunk pointer for given final hash
 215          *
 216          * @param       $finalHash      Final hash to get current pointer for
 217          */
 218         private function getCurrentChunkPointer ($finalHash) {
 219                 // Is the final hash valid?
 220                 assert(strlen($finalHash) > 0);
 221
 222                 // Is the pointer already initialized?
 223                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: finalHash=' . $finalHash);
 224                 assert(isset($this->chunkPointers[$finalHash]));
 225
 226                 // Return it
 227                 return $this->chunkPointers[$finalHash];
 228         }
 229
 230         /**
 231          * Advance the chunk pointer for given final hash
 232          *
 233          * @param       $finalHash      Final hash to advance the pointer for
 234          */
 235         private function nextChunkPointer ($finalHash) {
 236                 // Is the pointer already initialized?
 237                 assert(isset($this->chunkPointers[$finalHash]));
 238
 239                 // Count one up
 240                 $this->chunkPointers[$finalHash]++;
 241         }
 242
 243         /**
 244          * "Getter" for data chunk size of given hash.
 245          *
 246          * @param       $hash                   Hash to substract it's length
 247          * @return      $dataChunkSize  The chunk size
 248          */
 249         private function getDataChunkSizeFromHash ($hash) {
 250                 // Calculate real (data) chunk size
 251                 $dataChunkSize = (
 252                         // Real chunk size
 253                         ($this->chunkSize / 8) -
 254                         // Hash size
 255                         strlen($hash) -
 256                         // Length of sperators
 257                         (strlen(self::CHUNK_DATA_HASH_SEPARATOR) * 2) -
 258                         // Length of max serial number
 259                         self::MAX_SERIAL_LENGTH
 260                 );
 261
 262                 // This should be larger than zero bytes
 263                 assert($dataChunkSize > 0);
 264
 265                 // Return it
 266                 return $dataChunkSize;
 267         }
 268
 269         /**
 270          * Generates a hash from raw data
 271          *
 272          * @param       $rawData        Raw data bytes to hash
 273          * @return      $hash           Hash from the raw data
 274          * @todo        Implement a way to send non-announcement packages with extra-salt
 275          */
 276         private function generateHashFromRawData ($rawData) {
 277                 /*
 278                  * Get the crypto instance and hash the data with no extra salt because
 279                  * the other peer doesn't have *this* peer's salt.
 280                  */
 281                 $hash = $this->getCryptoInstance()->hashString($rawData, '', false);
 282
 283                 // Return it
 284                 return $hash;
 285         }
 286
 287         /**
 288          * Appends an end-of-package chunk to the chunk list for given chunk and
 289          * final hash. As of 23-March-2012 the format of this chunk will be as any
 290          * regular one to keep things easy (KISS) in ChunkHandler class.
 291          *
 292          * @param       $lastChunk      Last chunk raw data
 293          * @param       $finalHash      Final hash for raw (unencoded) data
 294          * @return      void
 295          */
 296         private function appendEndOfPackageChunk ($lastChunk, $finalHash) {
 297                 // Generate end-of-package marker
 298                 $chunkData =
 299                         self::END_OF_PACKAGE_IDENTIFIER .
 300                         $finalHash . self::CHUNK_HASH_SEPARATOR .
 301                         $this->generateHashFromRawData($lastChunk);
 302
 303                 // Add it as regular chunk
 304                 $this->addChunkData($finalHash, $chunkData);
 305         }
 306
 307         /**
 308          * Splits the given encoded data into smaller chunks, the size of the final
 309          * and the SEPARATOR is being subtracted from chunk size to fit it into a
 310          * TCP package (512 bytes).
 311          *
 312          * @param       $rawData        Raw data string
 313          * @param       $finalHash      Final hash from the raw data
 314          * @return      void
 315          */
 316         private function splitEncodedDataIntoChunks ($rawData, $finalHash) {
 317                 // Make sure final hashes with at least 32 bytes can pass
 318                 assert(strlen($finalHash) >= 32);
 319
 320                 // Calculate real (data) chunk size
 321                 $dataChunkSize = $this->getDataChunkSizeFromHash($finalHash);
 322                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: dataChunkSize=' . $dataChunkSize);
 323
 324                 // Init variables
 325                 $chunkHash = '';
 326                 $chunkData = '';
 327
 328                 // Now split it up
 329                 for ($idx = 0; $idx < strlen($rawData); $idx += $dataChunkSize) {
 330                         // Get the next chunk
 331                         $chunkData = substr($rawData, $idx, $dataChunkSize);
 332
 333                         // Add the chunk to the propper array and do all the stuff there
 334                         $this->addChunkData($finalHash, $chunkData);
 335                 } // END - for
 336
 337                 // Debug output
 338                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: Raw data of ' . strlen($rawData) . ' bytes has been fragmented into ' . count($this->chunks[$finalHash]) . ' chunk(s).');
 339
 340                 // Add end-of-package chunk
 341                 $this->appendEndOfPackageChunk($chunkData, $finalHash);
 342         }
 343
 344         /**
 345          * Adds the given chunk (raw data) to the proper array and hashes it for
 346          * later verfication.
 347          *
 348          * @param       $finalHash      Final hash for faster processing
 349          * @param       $chunkData      Raw chunk data
 350          * @return      void
 351          */
 352         private function addChunkData ($finalHash, $chunkData) {
 353                 // Hash it
 354                 $rawDataHash = $this->getCryptoInstance()->hashString($chunkData, '', false);
 355
 356                 // Prepend the hash to the chunk
 357                 $rawData = (
 358                         $rawDataHash . self::CHUNK_DATA_HASH_SEPARATOR .
 359                         $this->getNextHexSerialNumber() . self::CHUNK_DATA_HASH_SEPARATOR .
 360                         $chunkData . self::CHUNK_SEPARATOR
 361                 );
 362
 363                 // Make sure the chunk is not larger than a TCP package can hold
 364                 assert(strlen($rawData) <= NetworkPackage::TCP_PACKAGE_SIZE);
 365
 366                 // Add it to the array
 367                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: Adding ' . strlen($rawData) . ' bytes of a chunk ...');
 368                 $this->chunks[$finalHash][]      = $rawData;
 369                 $this->chunkHashes[$finalHash][] = $rawDataHash;
 370         }
 371
 372         /**
 373          * Prepends a chunk (or more) with all hashes from all chunks + final chunk.
 374          *
 375          * @param       $rawData        Raw data string
 376          * @param       $finalHash      Final hash from the raw data
 377          * @return      void
 378          */
 379         private function prependHashChunk ($rawData, $finalHash) {
 380                 // "Implode" the whole array of hashes into one string
 381                 $rawData = self::HASH_CHUNK_IDENTIFIER . implode(self::CHUNK_HASH_SEPARATOR, $this->chunkHashes[$finalHash]);
 382
 383                 // Also get a hash from it
 384                 $chunkHash = $this->generateHashFromRawData($rawData);
 385
 386                 // Calulcate chunk size
 387                 $dataChunkSize = $this->getDataChunkSizeFromHash($chunkHash);
 388
 389                 // Now array_unshift() it to the two chunk arrays
 390                 for ($idx = 0; $idx < strlen($rawData); $idx += $dataChunkSize) {
 391                         // Get the next chunk
 392                         $chunk = substr($rawData, $idx, $dataChunkSize);
 393
 394                         // Hash it and remember it in seperate array
 395                         $chunkHash = $this->getCryptoInstance()->hashString($chunk, '', false);
 396                         array_unshift($this->chunkHashes[$finalHash], $chunkHash);
 397
 398                         // Prepend the hash to the chunk
 399                         $chunk =
 400                                 $chunkHash . self::CHUNK_DATA_HASH_SEPARATOR .
 401                                 $this->getNextHexSerialNumber() . self::CHUNK_DATA_HASH_SEPARATOR .
 402                                 $chunk . self::CHUNK_SEPARATOR
 403                         ;
 404
 405                         // Make sure the chunk is not larger than a TCP package can hold
 406                         assert(strlen($chunk) <= NetworkPackage::TCP_PACKAGE_SIZE);
 407
 408                         // Add it to the array
 409                         //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: Adding ' . strlen($chunk) . ' bytes of a chunk.');
 410                         array_unshift($this->chunks[$finalHash], $chunk);
 411                 } // END - for
 412         }
 413
 414         /**
 415          * "Getter" for the next hexadecimal-encoded serial number
 416          *
 417          * @return      $encodedSerialNumber    The next hexadecimal-encoded serial number
 418          */
 419         public function getNextHexSerialNumber () {
 420                 // Assert on maximum serial number length
 421                 assert($this->serialNumber <= $this->maxSerialNumber);
 422
 423                 // Encode the current serial number
 424                 $encodedSerialNumber = $this->dec2Hex($this->serialNumber, self::MAX_SERIAL_LENGTH);
 425
 426                 // Count one up
 427                 $this->serialNumber++;
 428
 429                 // Return the encoded serial number
 430                 return $encodedSerialNumber;
 431         }
 432
 433         /**
 434          * This method does "implode" the given package data array into one long
 435          * string, splits it into small chunks, adds a serial number and checksum
 436          * to all chunks and prepends a chunk with all hashes only in it. It will
 437          * return the final hash for faster processing of packages.
 438          *
 439          * @param       $packageData            Raw package data array
 440          * @param       $helperInstance         An instance of a ConnectionHelper class
 441          * @return      $finalHash                      Final hash for faster processing
 442          * @todo        $helperInstance is unused
 443          */
 444         public function fragmentPackageArray (array $packageData, ConnectionHelper $helperInstance) {
 445                 // Is this package already fragmented?
 446                 if (!$this->isPackageProcessed($packageData)) {
 447                         // Remove package status, the recipient doesn't need this
 448                         unset($packageData[NetworkPackage::PACKAGE_DATA_STATUS]);
 449
 450                         // First we need to "implode" the array
 451                         $rawData = implode(NetworkPackage::PACKAGE_DATA_SEPARATOR, $packageData);
 452
 453                         // Generate the final hash from the raw data (not encoded!)
 454                         $finalHash = $this->generateHashFromRawData($rawData);
 455
 456                         // Remember it
 457                         $this->processedPackages[$this->getProcessedPackagesIndex($packageData)] = $finalHash;
 458
 459                         // Init pointer
 460                         $this->initPointer($finalHash);
 461
 462                         // Split the encoded data into smaller chunks
 463                         $this->splitEncodedDataIntoChunks($rawData, $finalHash);
 464
 465                         // Prepend a chunk with all hashes together
 466                         $this->prependHashChunk($rawData, $finalHash);
 467
 468                         // Mark the package as fragmented
 469                         $this->markPackageDataProcessed($packageData);
 470                 } else {
 471                         // Get the final hash from the package data
 472                         $finalHash = $this->getFinalHashFromPackageData($packageData);
 473                 }
 474
 475                 // Return final hash
 476                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: finalHash[' . gettype($finalHash) . ']=' . $finalHash);
 477                 return $finalHash;
 478         }
 479
 480         /**
 481          * This method gets the next chunk from the internal FIFO which should be
 482          * sent to the given recipient. It will return an associative array where
 483          * the key is the chunk hash and value the raw chunk data.
 484          *
 485          * @param       $finalHash              Final hash for faster lookup
 486          * @return      $rawDataChunk   Raw package data chunk
 487          * @throws      AssertionException      If $finalHash was not 'true'
 488          */
 489         public function getNextRawDataChunk ($finalHash) {
 490                 try {
 491                         // Get current chunk index
 492                         $current = $this->getCurrentChunkPointer($finalHash);
 493                 } catch (AssertionException $e) {
 494                         // This may happen when the final hash is true
 495                         if ($finalHash === true) {
 496                                 // Set current to null
 497                                 $current = NULL;
 498                         } else {
 499                                 // Throw the exception
 500                                 throw $e;
 501                         }
 502                 }
 503
 504                 // If there is no entry left, return an empty array
 505                 if ((!isset($this->chunkHashes[$finalHash][$current])) || (!isset($this->chunks[$finalHash][$current]))) {
 506                         // No more entries found
 507                         return array();
 508                 } // END - if
 509
 510                 // Generate the array
 511                 $rawDataChunk = array(
 512                         $this->chunkHashes[$finalHash][$current] => $this->chunks[$finalHash][$current]
 513                 );
 514
 515                 // Count one index up
 516                 $this->nextChunkPointer($finalHash);
 517
 518                 // Return the chunk array
 519                 return $rawDataChunk;
 520         }
 521
 522         /**
 523          * Resets the serial number to zero
 524          *
 525          * @return      void
 526          */
 527         public function resetSerialNumber () {
 528                 $this->serialNumber = 0;
 529         }
 530 }
 531
 532 // [EOF]
 533 ?>