application/hub/main/handler/chunks/class_ChunkHandler.php

   1 <?php
   2 /**
   3  * A Chunk handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 ChunkHandler extends BaseHandler implements HandleableChunks, Registerable {
  25         /**
  26          * Stacker for chunks with final EOP
  27          */
  28         const STACKER_NAME_CHUNKS_WITH_FINAL_EOP = 'final_chunks';
  29         const STACKER_NAME_CHUNKS_WITHOUT_FINAL  = 'pending_chunks';
  30         const STACKER_NAME_ASSEMBLED_RAW_DATA    = 'chunk_raw_data';
  31
  32         /**
  33          * Chunk splits:
  34          * 0 = Hash
  35          * 1 = Serial number
  36          * 2 = Raw data
  37          */
  38         const CHUNK_SPLITS_INDEX_HASH     = 0;
  39         const CHUNK_SPLITS_INDEX_SERIAL   = 1;
  40         const CHUNK_SPLITS_INDEX_RAW_DATA = 2;
  41
  42         /**
  43          * The final array for assembling the original package back together
  44          */
  45         private $finalPackageChunks = array();
  46
  47         /**
  48          * Array of chunk hashes
  49          */
  50         private $chunkHashes = array();
  51
  52         /**
  53          * Raw EOP chunk data in an array:
  54          *
  55          * 0 = Final hash,
  56          * 1 = Hash of last chunk
  57          */
  58         private $eopChunk = array();
  59
  60         /**
  61          * Raw package data
  62          */
  63         private $rawPackageData = '';
  64
  65         /**
  66          * Protected constructor
  67          *
  68          * @return      void
  69          */
  70         protected function __construct () {
  71                 // Call parent constructor
  72                 parent::__construct(__CLASS__);
  73
  74                 // Set handler name
  75                 $this->setHandlerName('chunk');
  76
  77                 // Initialize handler
  78                 $this->initHandler();
  79         }
  80
  81         /**
  82          * Creates an instance of this class
  83          *
  84          * @return      $handlerInstance        An instance of a chunk Handler class
  85          */
  86         public final static function createChunkHandler () {
  87                 // Get new instance
  88                 $handlerInstance = new ChunkHandler();
  89
  90                 // Get a FIFO stacker
  91                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('chunk_handler_stacker_class');
  92
  93                 // Init all stacker
  94                 $stackerInstance->initStacks(array(
  95                         self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP,
  96                         self::STACKER_NAME_CHUNKS_WITHOUT_FINAL,
  97                         self::STACKER_NAME_ASSEMBLED_RAW_DATA
  98                 ));
  99
 100                 // Set the stacker in this handler
 101                 $handlerInstance->setStackerInstance($stackerInstance);
 102
 103                 // Get a crypto instance ...
 104                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
 105
 106                 // ... and set it in this handler
 107                 $handlerInstance->setCryptoInstance($cryptoInstance);
 108
 109                 // Get a fragmenter instance for later verification of serial numbers (e.g. if all are received)
 110                 $fragmenterInstance = FragmenterFactory::createFragmenterInstance('package');
 111
 112                 // Set it in this handler
 113                 $handlerInstance->setFragmenterInstance($fragmenterInstance);
 114
 115                 // Return the prepared instance
 116                 return $handlerInstance;
 117         }
 118
 119         /**
 120          * Initializes the handler
 121          *
 122          * @return      void
 123          */
 124         private function initHandler () {
 125                 // Init finalPackageChunks
 126                 $this->finalPackageChunks = array(
 127                         // Array for package content
 128                         'content'        => array(),
 129                         // ... and for the hashes
 130                         'hashes'         => array(),
 131                         // ... marker for that the final array is complete for assembling all chunks
 132                         'is_complete'    => FALSE,
 133                         // ... steps done to assemble all chunks
 134                         'assemble_steps' => 0,
 135                 );
 136
 137                 // ... chunkHashes:
 138                 $this->chunkHashes = array();
 139
 140                 // ... eopChunk:
 141                 $this->eopChunk = array(
 142                         0 => 'INVALID',
 143                         1 => 'INVALID',
 144                 );
 145         }
 146
 147         /**
 148          * Checks whether the hash generated from package content is the same ("valid") as given
 149          *
 150          * @param       $chunkSplits    An array from a splitted chunk
 151          * @return      $isValid                Whether the hash is "valid"
 152          */
 153         private function isChunkHashValid (array $chunkSplits) {
 154                 // Noisy debug line:
 155                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: chunkSplits=' . print_r($chunkSplits, TRUE));
 156
 157                 // Assert on some elements
 158                 assert(isset($chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA]));
 159                 assert(isset($chunkSplits[self::CHUNK_SPLITS_INDEX_HASH]));
 160
 161                 // Now hash the raw data again
 162                 $chunkHash = $this->getCryptoInstance()->hashString($chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA], $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH], FALSE);
 163
 164                 // Check it
 165                 $isValid = ($chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] === $chunkHash);
 166
 167                 // Debug output
 168                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: chunkHash=' . $chunkHash . ',isValid=' . intval($isValid));
 169
 170                 // ... and return it
 171                 return $isValid;
 172         }
 173
 174         /**
 175          * Checks whether the given serial number is valid
 176          *
 177          * @param       $serialNumber   A serial number from a chunk
 178          * @return      $isValid                Whether the serial number is valid
 179          */
 180         private function isSerialNumberValid ($serialNumber) {
 181                 // Check it
 182                 $isValid = ((strlen($serialNumber) == PackageFragmenter::MAX_SERIAL_LENGTH) && ($this->hexval($serialNumber, FALSE) === $serialNumber));
 183
 184                 // Return result
 185                 return $isValid;
 186         }
 187
 188         /**
 189          * Adds the chunk to the final array which will be used for the final step
 190          * which will be to assemble all chunks back to the original package content
 191          * and for the final hash check.
 192          *
 193          * This method may throw an exception if a chunk with the same serial number
 194          * has already been added to avoid mixing chunks from different packages.
 195          *
 196          * @param       $chunkSplits    An array from a splitted chunk
 197          * @return      void
 198          */
 199         private function addChunkToFinalArray (array $chunkSplits) {
 200                 // Is the serial number (index 1) already been added?
 201                 if (isset($this->finalPackageChunks[$chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL]])) {
 202                         // Then throw an exception
 203                         throw new ChunkAlreadyAssembledException(array($this, $chunkSplits), self::EXCEPTION_CHUNK_ALREADY_ASSEMBLED);
 204                 } // END - if
 205
 206                 // Debug message
 207                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: serialNumber=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ',hash=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH]);
 208
 209                 // Add the chunk data (index 2) to the final array and use the serial number as index
 210                 $this->finalPackageChunks['content'][$chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL]] = $chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA];
 211
 212                 // ... and the hash as well
 213                 $this->finalPackageChunks['hashes'][$chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL]] = $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH];
 214         }
 215
 216         /**
 217          * Marks the final array as completed, do only this if you really have all
 218          * chunks together including EOP and "hash chunk".
 219          *
 220          * @return      void
 221          */
 222         private function markFinalArrayAsCompleted () {
 223                 /*
 224                  * As for now, just set the array element. If any further steps are
 225                  * being added, this should always be the last step.
 226                  */
 227                 $this->finalPackageChunks['is_complete'] = TRUE;
 228         }
 229
 230         /**
 231          * Sorts the chunks array by using the serial number as a sorting key. In
 232          * most situations a call of ksort() is enough to accomblish this. So this
 233          * method may only call ksort() on the chunks array.
 234          *
 235          * This method sorts 'content' and 'hashes' so both must have used the
 236          * serial numbers as array indexes.
 237          *
 238          * @return      void
 239          */
 240         private function sortChunksArray () {
 241                 // Sort 'content' first
 242                 ksort($this->finalPackageChunks['content']);
 243
 244                 // ... then 'hashes'
 245                 ksort($this->finalPackageChunks['hashes']);
 246         }
 247
 248         /**
 249          * Prepares the package assemble by removing last chunks (last shall be
 250          * hash chunk, pre-last shall be EOP chunk) and verify that all serial
 251          * numbers are valid (same as PackageFragmenter class would generate).
 252          *
 253          * @return      void
 254          */
 255         private function preparePackageAssmble () {
 256                 // Make sure both arrays have same count (this however should always be TRUE)
 257                 assert(count($this->finalPackageChunks['hashes']) == count($this->finalPackageChunks['content']));
 258                 //* DIE: */ exit(__METHOD__ . ':finalPackageChunks='.print_r($this->finalPackageChunks['content'], TRUE));
 259
 260                 /*
 261                  * Remove last element (hash chunk) from 'hashes'. This hash will never
 262                  * be needed, so ignore it.
 263                  */
 264                 array_pop($this->finalPackageChunks['hashes']);
 265
 266                 // ... and from 'content' as well but save it for later use
 267                 $this->chunkHashes = explode(PackageFragmenter::CHUNK_HASH_SEPARATOR, substr(array_pop($this->finalPackageChunks['content']), strlen(PackageFragmenter::HASH_CHUNK_IDENTIFIER)));
 268
 269                 // Remove EOP chunk and keep a copy of it
 270                 array_pop($this->finalPackageChunks['hashes']);
 271                 $this->eopChunk = explode(PackageFragmenter::CHUNK_HASH_SEPARATOR, substr(array_pop($this->finalPackageChunks['content']), strlen(PackageFragmenter::END_OF_PACKAGE_IDENTIFIER)));
 272
 273                 // Verify all serial numbers
 274                 $this->verifyChunkSerialNumbers();
 275         }
 276
 277         /**
 278          * Verifies all chunk serial numbers by using a freshly initialized
 279          * fragmenter instance. Do ALWAYS sort the array and array_pop() the hash
 280          * chunk before calling this method to avoid re-requests of many chunks.
 281          *
 282          * @return      void
 283          */
 284         private function verifyChunkSerialNumbers () {
 285                 // Reset the serial number generator
 286                 $this->getFragmenterInstance()->resetSerialNumber();
 287
 288                 // "Walk" through all (content) chunks
 289                 foreach ($this->finalPackageChunks['content'] as $serialNumber => $content) {
 290                         // Get next serial number
 291                         $nextSerial = $this->getFragmenterInstance()->getNextHexSerialNumber();
 292
 293                         // Debug output
 294                         /* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: serialNumber=' . $serialNumber . ',nextSerial=' . $nextSerial);
 295
 296                         // Is it not the same? Then re-request it
 297                         if ($serialNumber != $nextSerial) {
 298                                 // This is invalid, so remove it
 299                                 unset($this->finalPackageChunks['content'][$serialNumber]);
 300                                 unset($this->finalPackageChunks['hashes'][$serialNumber]);
 301
 302                                 // And re-request it with valid serial number (and hash chunk)
 303                                 $this->rerequestChunkBySerialNumber($nextSerial);
 304                         } // END - if
 305                 } // END - foreach
 306         }
 307
 308         /**
 309          * Assembles and verifies ("final check") chunks back together to the
 310          * original package (raw data for the start). This method should only be
 311          * called AFTER the EOP and final-chunk chunk have been removed.
 312          *
 313          * @return      void
 314          */
 315         private function assembleAllChunksToPackage () {
 316                 // If chunkHashes is not filled, don't continue
 317                 assert(count($this->chunkHashes) > 0);
 318
 319                 // Init raw package data string
 320                 $this->rawPackageData = '';
 321
 322                 // That went well, so start assembling all chunks
 323                 foreach ($this->finalPackageChunks['content'] as $serialNumber => $content) {
 324                         // Debug message
 325                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: serialNumber=' . $serialNumber . ' - validating ...');
 326                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('finalPackageChunks=' . print_r($this->finalPackageChunks, TRUE) . 'chunkHashes=' . print_r($this->chunkHashes, TRUE));
 327
 328                         // Is this chunk valid? This should be the case
 329                         assert($this->isChunkHashValid(array(
 330                                 self::CHUNK_SPLITS_INDEX_HASH     => $this->finalPackageChunks['hashes'][$serialNumber],
 331                                 self::CHUNK_SPLITS_INDEX_RAW_DATA => $content
 332                         )));
 333
 334                         // ... and is also in the hash chunk?
 335                         assert(in_array($this->finalPackageChunks['hashes'][$serialNumber], $this->chunkHashes));
 336
 337                         // Verification okay, add it to the raw data
 338                         $this->rawPackageData .= $content;
 339                 } // END - foreach
 340
 341                 // Debug output
 342                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: eopChunk[1]=' . $this->eopChunk[1] . ',' . chr(10) . 'index=' . (count($this->chunkHashes) - 2) . ',' . chr(10) . 'chunkHashes='.print_r($this->chunkHashes, TRUE));
 343
 344                 // The last chunk hash must match with the one from eopChunk[1]
 345                 assert($this->eopChunk[1] == $this->chunkHashes[count($this->chunkHashes) - 2]);
 346         }
 347
 348         /**
 349          * Verifies the finally assembled raw package data by comparing it against
 350          * the final hash.
 351          *
 352          * @return      void
 353          */
 354         private function verifyRawPackageData () {
 355                 // Hash the raw package data for final verification
 356                 $finalHash = $this->getCryptoInstance()->hashString($this->rawPackageData, $this->eopChunk[0], FALSE);
 357
 358                 // Is it the same?
 359                 assert($finalHash == $this->eopChunk[0]);
 360         }
 361
 362         /**
 363          * Adds all chunks if the last one verifies as a 'final chunk'.
 364          *
 365          * @param       $chunks         An array with chunks, the last one should be a 'final'
 366          * @return      void
 367          * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
 368          */
 369         public function addAllChunksWithFinal (array $chunks) {
 370                 // Try to validate the final chunk
 371                 try {
 372                         // Validate final chunk
 373                         $this->isValidFinalChunk($chunks);
 374                 } catch (AssertionException $e) {
 375                         // Last chunk is not valid
 376                         throw new FinalChunkVerificationException(array($this, $chunks, $e), BaseListener::EXCEPTION_FINAL_CHUNK_VERIFICATION);
 377                 }
 378
 379                 // Do we have some pending chunks (no final)?
 380                 while (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITHOUT_FINAL)) {
 381                         // Then get it first and add it before the EOP chunks
 382                         array_unshift($chunks, $this->getStackerInstance()->popNamed(self::STACKER_NAME_CHUNKS_WITHOUT_FINAL));
 383                 } // END - while
 384
 385                 // Add all chunks to the FIFO stacker
 386                 foreach ($chunks as $chunk) {
 387                         // Add the chunk
 388                         $this->getStackerInstance()->pushNamed(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP, $chunk);
 389                 } // END - foreach
 390         }
 391
 392         /**
 393          * Adds all chunks and wait for more (e.g. incomplete transmission)
 394          *
 395          * @param       $chunks         An array with chunks, the last one should be a 'final'
 396          * @return      void
 397          */
 398         public function addAllChunksWait (array $chunks) {
 399                 // Add all chunks to the FIFO stacker
 400                 foreach ($chunks as $chunk) {
 401                         // Add the chunk
 402                         $this->getStackerInstance()->pushNamed(self::STACKER_NAME_CHUNKS_WITHOUT_FINAL, $chunk);
 403                 } // END - foreach
 404         }
 405
 406         /**
 407          * Checks whether unhandled chunks are available
 408          *
 409          * @return      $unhandledChunks        Whether unhandled chunks are left
 410          */
 411         public function ifUnhandledChunksWithFinalAvailable () {
 412                 // Simply check if the stacker is not empty
 413                 $unhandledChunks = $this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP) === FALSE;
 414
 415                 // Return result
 416                 return $unhandledChunks;
 417         }
 418
 419         /**
 420          * Handles available chunks by processing one-by-one (not all together,
 421          * this would slow-down the whole application) with the help of an
 422          * iterator.
 423          *
 424          * @return      void
 425          */
 426         public function handleAvailableChunksWithFinal () {
 427                 // First check if there are undhandled chunks available
 428                 assert($this->ifUnhandledChunksWithFinalAvailable());
 429
 430                 // Get an entry from the stacker
 431                 $chunk = $this->getStackerInstance()->popNamed(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP);
 432
 433                 // Split the string with proper separator character
 434                 $chunkSplits = explode(PackageFragmenter::CHUNK_DATA_HASH_SEPARATOR, $chunk);
 435
 436                 /*
 437                  * Make sure three elements are always found:
 438                  * 0 = Hash
 439                  * 1 = Serial number
 440                  * 2 = Raw data
 441                  */
 442                 assert(count($chunkSplits) == 3);
 443
 444                 // Is the generated hash from data same ("valid") as given hash?
 445                 if (!$this->isChunkHashValid($chunkSplits)) {
 446                         // Do some logging
 447                         self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Chunk content is not validating against given hash.');
 448
 449                         // Re-request this chunk (trust the hash in index # 0)
 450                         $this->rerequestChunkBySplitsArray($chunkSplits);
 451
 452                         // Don't process this chunk
 453                         return;
 454                 } // END - if
 455
 456                 // Is the serial number valid (chars 0-9, length equals PackageFragmenter::MAX_SERIAL_LENGTH)?
 457                 if (!$this->isSerialNumberValid($chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL])) {
 458                         // Do some logging
 459                         self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Chunk serial number ' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ' for hash ' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] . ' is invalid.');
 460
 461                         // Re-request this chunk
 462                         $this->rerequestChunkBySplitsArray($chunkSplits);
 463
 464                         // Don't process this chunk
 465                         return;
 466                 } // END - if
 467
 468                 /*
 469                  * It is now known that (as long as the hash algorithm has no
 470                  * collisions) the content is the same as the sender sends it to this
 471                  * peer.
 472                  *
 473                  * And also the serial number is valid (basicly) at this point. Now the
 474                  * chunk can be added to the final array.
 475                  */
 476                 $this->addChunkToFinalArray($chunkSplits);
 477
 478                 // Is the stack now empty?
 479                 if ($this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP)) {
 480                         // Then mark the final array as complete
 481                         $this->markFinalArrayAsCompleted();
 482                 } // END - if
 483         }
 484
 485         /**
 486          * Checks whether unassembled chunks are available (ready) in final array
 487          *
 488          * @return      $unassembledChunksAvailable             Whether unassembled chunks are available
 489          */
 490         public function ifUnassembledChunksAvailable () {
 491                 // For now do only check the array element 'is_complete'
 492                 $unassembledChunksAvailable = ($this->finalPackageChunks['is_complete'] === TRUE);
 493
 494                 // Return status
 495                 return $unassembledChunksAvailable;
 496         }
 497
 498         /**
 499          * Assembles all chunks (except EOP and "hash chunk") back together to the original package data.
 500          *
 501          * This is done by the following steps:
 502          *
 503          * 1) Sort the final array with ksort(). This will bring the "hash
 504          *    chunk" up to the last array index and the EOP chunk to the
 505          *    pre-last array index
 506          * 2) Assemble all chunks except two last (see above step)
 507          * 3) While so, do the final check on all hashes
 508          * 4) If the package is assembled back together, hash it again for
 509          *    the very final verification.
 510          *
 511          * @return      void
 512          */
 513         public function assembleChunksFromFinalArray () {
 514                 // Make sure the final array is really completed
 515                 assert($this->ifUnassembledChunksAvailable());
 516
 517                 // Count up stepping
 518                 $this->finalPackageChunks['assemble_steps']++;
 519
 520                 // Do the next step
 521                 switch ($this->finalPackageChunks['assemble_steps']) {
 522                         case 1: // Sort the chunks array (the serial number shall act as a sorting key)
 523                                 $this->sortChunksArray();
 524                                 break;
 525
 526                         case 2: // Prepare the assemble by removing last two indexes
 527                                 $this->preparePackageAssmble();
 528                                 break;
 529
 530                         case 3: // Assemble all chunks back together to the original package
 531                                 $this->assembleAllChunksToPackage();
 532                                 break;
 533
 534                         case 4: // Verify the raw data by hashing it again
 535                                 $this->verifyRawPackageData();
 536                                 break;
 537
 538                         case 5: // Re-initialize handler to reset it to the old state
 539                                 $this->initHandler();
 540                                 break;
 541
 542                         default: // Invalid step found
 543                                 self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Invalid step ' . $this->finalPackageChunks['assemble_steps'] . ' detected.');
 544                                 break;
 545                 } // END - switch
 546         }
 547
 548         /**
 549          * Checks whether the raw package data has been assembled back together.
 550          * This can be safely assumed when rawPackageData is not empty and the
 551          * collection of all chunks is FALSE (because initHandler() will reset it).
 552          *
 553          * @return      $isRawPackageDataAvailable      Whether raw package data is available
 554          */
 555         public function ifRawPackageDataIsAvailable () {
 556                 // Check it
 557                 $isRawPackageDataAvailable = ((!empty($this->rawPackageData)) && (!$this->ifUnassembledChunksAvailable()));
 558
 559                 // Return it
 560                 return $isRawPackageDataAvailable;
 561         }
 562
 563         /**
 564          * Handles the finally assembled raw package data by feeding it into another
 565          * stacker for further decoding/processing.
 566          *
 567          * @return      void
 568          */
 569         public function handledAssembledRawPackageData () {
 570                 // Assert to make sure that there is raw package data available
 571                 assert($this->ifRawPackageDataIsAvailable());
 572
 573                 // Then feed it into the next stacker
 574                 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_ASSEMBLED_RAW_DATA, $this->rawPackageData);
 575
 576                 // ... and reset it
 577                 $this->rawPackageData = '';
 578         }
 579 }
 580
 581 // [EOF]
 582 ?>