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 BaseFrameworkSystem 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 wether the given package data is already processed by this fragmenter
 169          *
 170          * @param       $packageData    Raw package data array
 171          * @return      $isProcessed    Wether 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          * "Getter" for the next hexadecimal-encoded serial number
 289          *
 290          * @return      $encodedSerialNumber    The next hexadecimal-encoded serial number
 291          */
 292         private function getNextHexSerialNumber () {
 293                 // Assert on maximum serial number length
 294                 assert($this->serialNumber <= $this->maxSerialNumber);
 295
 296                 // Encode the current serial number
 297                 $encodedSerialNumber = $this->dec2Hex($this->serialNumber, self::MAX_SERIAL_LENGTH);
 298
 299                 // Count one up
 300                 $this->serialNumber++;
 301
 302                 // Return the encoded serial number
 303                 return $encodedSerialNumber;
 304         }
 305
 306         /**
 307          * Appends an end-of-package chunk to the chunk list for given chunk and
 308          * final hash. As of 23-March-2012 the format of this chunk will be as any
 309          * regular one to keep things easy (KISS) in ChunkHandler class.
 310          *
 311          * @param       $chunkHash      Last chunk's hash
 312          * @param       $finalHash      Final hash for raw (unencoded) data
 313          * @return      void
 314          */
 315         private function appendEndOfPackageChunk ($chunkHash, $finalHash) {
 316                 // Generate end-of-package marker
 317                 $chunkData =
 318                         self::END_OF_PACKAGE_IDENTIFIER .
 319                         $finalHash . self::CHUNK_HASH_SEPARATOR .
 320                         $chunkHash . self::CHUNK_SEPARATOR;
 321
 322                 // Add it as regular chunk
 323                 $this->addChunkData($chunkData);
 324         }
 325
 326         /**
 327          * Splits the given encoded data into smaller chunks, the size of the final
 328          * and the SEPARATOR is being subtracted from chunk size to fit it into a
 329          * TCP package (512 bytes).
 330          *
 331          * @param       $rawData        Raw data string
 332          * @param       $finalHash      Final hash from the raw data
 333          * @return      void
 334          */
 335         private function splitEncodedDataIntoChunks ($rawData, $finalHash) {
 336                 // Make sure final hashes with at least 32 bytes can pass
 337                 assert(strlen($finalHash) >= 32);
 338
 339                 // Calculate real (data) chunk size
 340                 $dataChunkSize = $this->getDataChunkSizeFromHash($finalHash);
 341                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: dataChunkSize=' . $dataChunkSize);
 342
 343                 // Init variables
 344                 $chunkHash = '';
 345
 346                 // Now split it up
 347                 for ($idx = 0; $idx < strlen($rawData); $idx += $dataChunkSize) {
 348                         // Get the next chunk
 349                         $chunkData = substr($rawData, $idx, $dataChunkSize);
 350
 351                         // Add the chunk to the propper array and do all the stuff there
 352                         $this->addChunkData($chunkData);
 353                 } // END - for
 354
 355                 // Debug output
 356                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: Raw data of ' . strlen($rawData) . ' bytes has been fragmented into ' . count($this->chunks[$finalHash]) . ' chunk(s).');
 357
 358                 // Add end-of-package chunk
 359                 $this->appendEndOfPackageChunk($chunkHash, $finalHash);
 360         }
 361
 362         /**
 363          * Adds the given chunk (raw data) to the proper array and hashes it for
 364          * later verfication.
 365          *
 366          * @param       $chunkData      Raw chunk data
 367          * @return      void
 368          */
 369         private function addChunkData ($chunkData) {
 370                 // Hash it
 371                 $rawDataHash = $this->getCryptoInstance()->hashString($chunkData, '', false);
 372
 373                 // Prepend the hash to the chunk
 374                 $rawData = (
 375                         $rawDataHash . self::CHUNK_DATA_HASH_SEPARATOR .
 376                         $this->getNextHexSerialNumber() . self::CHUNK_DATA_HASH_SEPARATOR .
 377                         $rawData . self::CHUNK_SEPARATOR
 378                 );
 379
 380                 // Make sure the chunk is not larger than a TCP package can hold
 381                 assert(strlen($rawData) <= NetworkPackage::TCP_PACKAGE_SIZE);
 382
 383                 // Add it to the array
 384                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: Adding ' . strlen($rawData) . ' bytes of a chunk.');
 385                 $this->chunks[$finalHash][]      = $rawData;
 386                 $this->chunkHashes[$finalHash][] = $rawDataHash;
 387         }
 388
 389         /**
 390          * Prepends a chunk (or more) with all hashes from all chunks + final chunk.
 391          *
 392          * @param       $rawData        Raw data string
 393          * @param       $finalHash      Final hash from the raw data
 394          * @return      void
 395          */
 396         private function prependHashChunk ($rawData, $finalHash) {
 397                 // "Implode" the whole array of hashes into one string
 398                 $rawData = self::HASH_CHUNK_IDENTIFIER . implode(self::CHUNK_HASH_SEPARATOR, $this->chunkHashes[$finalHash]);
 399
 400                 // Also get a hash from it
 401                 $chunkHash = $this->generateHashFromRawData($rawData);
 402
 403                 // Calulcate chunk size
 404                 $dataChunkSize = $this->getDataChunkSizeFromHash($chunkHash);
 405
 406                 // Now array_unshift() it to the two chunk arrays
 407                 for ($idx = 0; $idx < strlen($rawData); $idx += $dataChunkSize) {
 408                         // Get the next chunk
 409                         $chunk = substr($rawData, $idx, $dataChunkSize);
 410
 411                         // Hash it and remember it in seperate array
 412                         $chunkHash = $this->getCryptoInstance()->hashString($chunk, '', false);
 413                         array_unshift($this->chunkHashes[$finalHash], $chunkHash);
 414
 415                         // Prepend the hash to the chunk
 416                         $chunk =
 417                                 $chunkHash . self::CHUNK_DATA_HASH_SEPARATOR .
 418                                 $this->getNextHexSerialNumber() . self::CHUNK_DATA_HASH_SEPARATOR .
 419                                 $chunk . self::CHUNK_SEPARATOR
 420                         ;
 421
 422                         // Make sure the chunk is not larger than a TCP package can hold
 423                         assert(strlen($chunk) <= NetworkPackage::TCP_PACKAGE_SIZE);
 424
 425                         // Add it to the array
 426                         //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: Adding ' . strlen($chunk) . ' bytes of a chunk.');
 427                         array_unshift($this->chunks[$finalHash], $chunk);
 428                 } // END - for
 429         }
 430
 431         /**
 432          * This method does "implode" the given package data array into one long
 433          * string, splits it into small chunks, adds a serial number and checksum
 434          * to all chunks and prepends a chunk with all hashes only in it. It will
 435          * return the final hash for faster processing of packages.
 436          *
 437          * @param       $packageData            Raw package data array
 438          * @param       $helperInstance         An instance of a ConnectionHelper class
 439          * @return      $finalHash                      Final hash for faster processing
 440          * @todo        $helperInstance is unused
 441          */
 442         public function fragmentPackageArray (array $packageData, ConnectionHelper $helperInstance) {
 443                 // Is this package already fragmented?
 444                 if (!$this->isPackageProcessed($packageData)) {
 445                         // Remove package status, the recipient doesn't need this
 446                         unset($packageData[NetworkPackage::PACKAGE_DATA_STATUS]);
 447
 448                         // First we need to "implode" the array
 449                         $rawData = implode(NetworkPackage::PACKAGE_DATA_SEPARATOR, $packageData);
 450
 451                         // Generate the final hash from the raw data (not encoded!)
 452                         $finalHash = $this->generateHashFromRawData($rawData);
 453
 454                         // Remember it
 455                         $this->processedPackages[$this->getProcessedPackagesIndex($packageData)] = $finalHash;
 456
 457                         // Init pointer
 458                         $this->initPointer($finalHash);
 459
 460                         // Split the encoded data into smaller chunks
 461                         $this->splitEncodedDataIntoChunks($rawData, $finalHash);
 462
 463                         // Prepend a chunk with all hashes together
 464                         $this->prependHashChunk($rawData, $finalHash);
 465
 466                         // Mark the package as fragmented
 467                         $this->markPackageDataProcessed($packageData);
 468                 } else {
 469                         // Get the final hash from the package data
 470                         $finalHash = $this->getFinalHashFromPackageData($packageData);
 471                 }
 472
 473                 // Return final hash
 474                 //* NOISY-DEBUG: */ $this->debugOutput('FRAGMENTER: finalHash[' . gettype($finalHash) . ']=' . $finalHash);
 475                 return $finalHash;
 476         }
 477
 478         /**
 479          * This method gets the next chunk from the internal FIFO which should be
 480          * sent to the given recipient. It will return an associative array where
 481          * the key is the chunk hash and value the raw chunk data.
 482          *
 483          * @param       $finalHash              Final hash for faster lookup
 484          * @return      $rawDataChunk   Raw package data chunk
 485          * @throws      AssertionException      If $finalHash was not 'true'
 486          */
 487         public function getNextRawDataChunk ($finalHash) {
 488                 try {
 489                         // Get current chunk index
 490                         $current = $this->getCurrentChunkPointer($finalHash);
 491                 } catch (AssertionException $e) {
 492                         // This may happen when the final hash is true
 493                         if ($finalHash === true) {
 494                                 // Set current to null
 495                                 $current = NULL;
 496                         } else {
 497                                 // Throw the exception
 498                                 throw $e;
 499                         }
 500                 }
 501
 502                 // If there is no entry left, return an empty array
 503                 if ((!isset($this->chunkHashes[$finalHash][$current])) || (!isset($this->chunks[$finalHash][$current]))) {
 504                         // No more entries found
 505                         return array();
 506                 } // END - if
 507
 508                 // Generate the array
 509                 $rawDataChunk = array(
 510                         $this->chunkHashes[$finalHash][$current] => $this->chunks[$finalHash][$current]
 511                 );
 512
 513                 // Count one index up
 514                 $this->nextChunkPointer($finalHash);
 515
 516                 // Return the chunk array
 517                 return $rawDataChunk;
 518         }
 519 }
 520
 521 // [EOF]
 522 ?>