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

   1 <?php
   2 /**
   3  * A Chunk handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   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 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
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set handler name
  40                 $this->setHandlerName('chunk');
  41         }
  42
  43         /**
  44          * Creates an instance of this class
  45          *
  46          * @return      $handlerInstance        An instance of a chunk Handler class
  47          */
  48         public final static function createChunkHandler () {
  49                 // Get new instance
  50                 $handlerInstance = new ChunkHandler();
  51
  52                 // Get a FIFO stacker
  53                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('chunk_handler_stacker_class');
  54
  55                 // Init all stacker
  56                 $stackerInstance->initStacker(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP);
  57
  58                 // Set the stacker in this handler
  59                 $handlerInstance->setStackerInstance($stackerInstance);
  60
  61                 // Get a crypto instance ...
  62                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
  63
  64                 // ... and set it in this handler
  65                 $handlerInstance->setCryptoInstance($cryptoInstance);
  66
  67                 // Return the prepared instance
  68                 return $handlerInstance;
  69         }
  70
  71         /**
  72          * Checks whether the hash generated from package content is the same ("valid") as given
  73          *
  74          * @param       $chunkSplits    An array from a splitted chunk
  75          * @return      $isValid                Whether the hash is "valid"
  76          */
  77         private function isChunkHashValid (array $chunkSplits) {
  78                 // Now hash the raw data again
  79                 $chunkHash = $this->getCryptoInstance()->hashString($chunkSplits[2], $chunkSplits[0], false);
  80
  81                 // Debug output
  82                 //* NOISY-DEBUG: */ $this->debugOutput('CHUNK-HANDLER: chunkHash=' . $chunkHash . ',chunkSplits[0]=' . $chunkSplits[0] . ',chunkSplits[1]=' . $chunkSplits[1]);
  83
  84                 // Check it
  85                 $isValid = ($chunkSplits[0] === $chunkHash);
  86
  87                 // ... and return it
  88                 return $isValid;
  89         }
  90
  91         /**
  92          * Checks whether the given serial number is valid
  93          *
  94          * @param       $serialNumber   A serial number from a chunk
  95          * @return      $isValid                Whether the serial number is valid
  96          */
  97         private function isSerialNumberValid ($serialNumber) {
  98                 // Check it
  99                 $isValid = ((strlen($serialNumber) == PackageFragmenter::MAX_SERIAL_LENGTH) && ($this->bigintval($serialNumber, false) === $serialNumber));
 100
 101                 // Return result
 102                 return $isValid;
 103         }
 104
 105         /**
 106          * Adds all chunks if the last one verifies as a 'final chunk'.
 107          *
 108          * @param       $chunks         An array with chunks, the last one should be a 'final'
 109          * @return      void
 110          * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
 111          */
 112         public function addAllChunksWithFinal (array $chunks) {
 113                 // Validate final chunk
 114                 if (!$this->isValidFinalChunk($chunks)) {
 115                         // Last chunk is not valid
 116                         throw new FinalChunkVerificationException(array($this, $chunks), BaseListener::EXCEPTION_FINAL_CHUNK_VERIFICATION);
 117                 } // END - if
 118
 119                 // Add all chunks to the FIFO stacker
 120                 foreach ($chunks as $chunk) {
 121                         // Add the chunk
 122                         $this->getStackerInstance()->pushNamed(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP, $chunk);
 123                 } // END - foreach
 124         }
 125
 126         /**
 127          * Checks whether unhandled chunks are available
 128          *
 129          * @return      $unhandledChunks        Whether unhandled chunks are left
 130          */
 131         public function ifUnhandledChunksWithFinalAvailable () {
 132                 // Simply check if the stacker is not empty
 133                 $unhandledChunks = $this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP) === false;
 134
 135                 // Return result
 136                 return $unhandledChunks;
 137         }
 138
 139         /**
 140          * Handles available chunks by processing one-by-one (not all together,
 141          * this would slow-down the whole application) with the help of an
 142          * iterator.
 143          *
 144          * @return      void
 145          */
 146         public function handleAvailableChunksWithFinal () {
 147                 // First check if there are undhandled chunks available
 148                 assert($this->ifUnhandledChunksWithFinalAvailable());
 149
 150                 // Get an entry from the stacker
 151                 $chunk = $this->getStackerInstance()->popNamed(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP);
 152
 153                 // Split the string with proper separator character
 154                 $chunkSplits = explode(PackageFragmenter::CHUNK_DATA_HASH_SEPARATOR, $chunk);
 155
 156                 /*
 157                  * Make sure three elements are always found:
 158                  * 0 = Hash
 159                  * 1 = Serial number
 160                  * 2 = Raw data
 161                  */
 162                 assert(count($chunkSplits) == 3);
 163
 164                 // Is the generated hash from data same ("valid") as given hash?
 165                 if (!$this->isChunkHashValid($chunkSplits)) {
 166                         // Do some logging
 167                         $this->debugOutput('CHUNK-HANDLER: Chunk content is not validating against given hash.');
 168
 169                         // Re-request this chunk (trust the hash in index # 0)
 170                         $this->rerequestChunkBySplitsArray($chunkSplits);
 171
 172                         // Don't process this chunk
 173                         return;
 174                 } // END - if
 175
 176                 // Is the serial number valid (chars 0-9, length equals PackageFragmenter::MAX_SERIAL_LENGTH)?
 177                 if (!$this->isSerialNumberValid($chunkSplits[1])) {
 178                         // Do some logging
 179                         $this->debugOutput('CHUNK-HANDLER: Chunk serial number is invalid.');
 180
 181                         // Re-request this chunk
 182                         $this->rerequestChunkBySplitsArray($chunkSplits);
 183
 184                         // Don't process this chunk
 185                         return;
 186                 } // END - if
 187
 188                 /*
 189                  * It is now known that (as long as the hash algorithm has no
 190                  * collisions) the content is the same as the sender sends it to this
 191                  * peer.
 192                  *
 193                  * And also the serial number is valid (basicly) at this point.
 194                  */
 195                 die('chunk=' . $chunk . chr(10));
 196         }
 197 }
 198
 199 // [EOF]
 200 ?>