application/hub/main/package/assembler/class_PackageAssembler.php

   1 <?php
   2 /**
   3  * A PackageAssembler class to assemble a package content stream fragemented
   4  * by PackageFragmenter back to a raw package data array.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class PackageAssembler extends BaseHubSystem implements Assembler, Registerable {
  26         /**
  27          * Pending data
  28          */
  29         private $pendingData = '';
  30
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Creates an instance of this class
  43          *
  44          * @param       $packageInstance        An instance of a Receivable class
  45          * @return      $assemblerInstance      An instance of an Assembler class
  46          */
  47         public static final function createPackageAssembler (Receivable $packageInstance) {
  48                 // Get new instance
  49                 $assemblerInstance = new PackageAssembler();
  50
  51                 // Set package instance here
  52                 $assemblerInstance->setPackageInstance($packageInstance);
  53
  54                 // Return the prepared instance
  55                 return $assemblerInstance;
  56         }
  57
  58         /**
  59          * Checks whether the input buffer (stacker to be more preceise) is empty.
  60          *
  61          * @return      $isInputBufferEmpty             Whether the input buffer is empty
  62          */
  63         private function ifInputBufferIsEmpty () {
  64                 // Check it
  65                 $isInputBufferEmpty = $this->getPackageInstance()->getStackerInstance()->isStackEmpty(NetworkPackage::STACKER_NAME_DECODED_HANDLED);
  66
  67                 // Debug message
  68                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: isInputBufferEmpty=' . intval($isInputBufferEmpty));
  69
  70                 // Return it
  71                 return $isInputBufferEmpty;
  72         }
  73
  74         /**
  75          * Checks whether given package content is completed (start/end markers are found)
  76          *
  77          * @param       $packageContent         An array with two elements: 'decoded_data' and 'error_code'
  78          * @return      $isCompleted            Whether the given package content is completed
  79          */
  80         private function isPackageContentCompleted (array $packageContent) {
  81                 // Check both
  82                 $isCompleted = ((substr($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA], 0, 5) == '[[S]]') && (substr($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA], -5, 5) == '[[E]]'));
  83
  84                 // Return status
  85                 return $isCompleted;
  86         }
  87
  88         /**
  89          * Assembles the content from $packageContent. This method does only
  90          * initialize the whole process by creating a call-back which will then
  91          * itself (99.9% of all cases) "explode" the decoded data stream and add
  92          * it to a chunk assembler queue.
  93          *
  94          * If the call-back method or this would attempt to assemble the package
  95          * chunks and (maybe) re-request some chunks from the sender, this would
  96          * take to much time and therefore slow down this node again.
  97          *
  98          * @param       $packageContent         An array with two elements: 'decoded_data' and 'error_code'
  99          * @return      void
 100          * @throws      UnsupportedPackageCodeHandlerException  If the package code handler is not implemented
 101          */
 102         public function chunkPackageContent (array $packageContent) {
 103                 // Validate the package content array again
 104                 assert(
 105                         (isset($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA])) &&
 106                         (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
 107                 );
 108
 109                 // Construct call-back name from package error code
 110                 $methodName = 'handlePackageBy' . $this->convertToClassName($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]);
 111
 112                 // Abort if the call-back method is not there
 113                 if (!method_exists($this, $methodName)) {
 114                         // Throw an exception
 115                         throw new UnsupportedPackageCodeHandlerException(array($this, $methodName, $packageContent), BaseListener::EXCEPTION_UNSUPPORTED_PACKAGE_CODE_HANDLER);
 116                 } // END - if
 117
 118                 // Call it back
 119                 call_user_func(array($this, $methodName), $packageContent);
 120         }
 121
 122         /**************************************************************************
 123          *                 Call-back methods for above method                     *
 124          **************************************************************************/
 125
 126         /**
 127          * Call-back handler to handle unhandled packages. This method "explodes"
 128          * the string with the chunk separator from PackageFragmenter class, does
 129          * some low checks on it and feeds it into another queue for verification
 130          * and re-request for bad chunks.
 131          *
 132          * @param       $packageContent         An array with two elements: 'decoded_data' and 'error_code'
 133          * @return      void
 134          * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
 135          */
 136         private function handlePackageByUnhandledPackage (array $packageContent) {
 137                 // Debug message
 138                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: packageData[' . BaseRawDataHandler::PACKAGE_DECODED_DATA . ']=' . $packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]);
 139
 140                 // Check for some conditions
 141                 if ((!$this->ifInputBufferIsEmpty()) || (!$this->isPackageContentCompleted($packageContent))) {
 142                         // Last chunk is not valid, so wait for more
 143                         $this->pendingData .= $packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA];
 144
 145                         // Debug message
 146                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: Partial data received. Waiting for more ... ( ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]) . ' bytes)');
 147                 } else {
 148                         // Debug message
 149                         //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('packageContent=' . print_r($packageContent,true) . ',chunks='.print_r($chunks,true));
 150
 151                         /*
 152                          * "explode" the string from 'decoded_data' with chunk separator to
 153                          * get an array of chunks. These chunks must then be verified by
 154                          * their checksums. Also the final chunk must be handled.
 155                          */
 156                         $chunks = explode(PackageFragmenter::CHUNK_SEPARATOR, $packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]);
 157
 158                         // Now get a chunk handler instance
 159                         $handlerInstance = ChunkHandlerFactory::createChunkHandlerInstance();
 160
 161                         // Add all chunks because the last final chunk is found
 162                         $handlerInstance->addAllChunksWithFinal($chunks);
 163                 }
 164         }
 165
 166         /**
 167          * Checks whether the assembler's pending data is empty which means it has
 168          * no pending data left for handling ... ;-)
 169          *
 170          * @return      $ifPendingDataIsEmpty   Whether pending data is empty
 171          */
 172         public function isPendingDataEmpty () {
 173                 // A simbple check
 174                 $ifPendingDataIsEmpty = empty($this->pendingData);
 175
 176                 // Return it
 177                 return $ifPendingDataIsEmpty;
 178         }
 179
 180         /**
 181          * Handles the assembler's pending data
 182          *
 183          * @return      void
 184          */
 185         public function handlePendingData () {
 186                 // Assert on condition
 187                 assert(!$this->isPendingDataEmpty());
 188
 189                 // Init fake array
 190                 $packageContent = array(
 191                         BaseRawDataHandler::PACKAGE_DECODED_DATA => $this->pendingData,
 192                         BaseRawDataHandler::PACKAGE_ERROR_CODE   => BaseRawDataHandler::SOCKET_ERROR_UNHANDLED
 193                 );
 194
 195                 // Clear pending data
 196                 $this->pendingData = '';
 197
 198                 // Debug message
 199                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: Last block of partial data received. A total of ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]) . ' bytes has been received.');
 200
 201                 // Call the real handler method
 202                 $this->handlePackageByUnhandledPackage($packageContent);
 203         }
 204 }
 205
 206 // [EOF]
 207 ?>