]> git.mxchange.org Git - hub.git/blobdiff - application/hub/main/package/assembler/class_PackageAssembler.php
Again contunued on 'hub' project:
[hub.git] / application / hub / main / package / assembler / class_PackageAssembler.php
index 2255fe1f1cd8f348bb2b45634d874508003a79df..b53cc50ff07f16cc48b4c127b4aadc19af1b19ab 100644 (file)
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class PackageAssembler extends BaseFrameworkSystem implements Assembler, Registerable {
+class PackageAssembler extends BaseHubSystem implements Assembler, Registerable {
+       /**
+        * Pending data
+        */
+       private $pendingData = '';
+
        /**
         * Protected constructor
         *
@@ -36,16 +41,36 @@ class PackageAssembler extends BaseFrameworkSystem implements Assembler, Registe
        /**
         * Creates an instance of this class
         *
-        * @return      $assemblerInstance              An instance of a Fragmentable class
+        * @param       $packageInstance        An instance of a Receivable class
+        * @return      $assemblerInstance      An instance of an Assembler class
         */
-       public static final function createPackageAssembler () {
+       public static final function createPackageAssembler (Receivable $packageInstance) {
                // Get new instance
                $assemblerInstance = new PackageAssembler();
 
+               // Set package instance here
+               $assemblerInstance->setPackageInstance($packageInstance);
+
                // Return the prepared instance
                return $assemblerInstance;
        }
 
+       /**
+        * Checks whether the input buffer (stacker to be more preceise) is empty.
+        *
+        * @return      $isInputBufferEmpty             Whether the input buffer is empty
+        */
+       private function ifInputBufferIsEmpty () {
+               // Check it
+               $isInputBufferEmpty = $this->getPackageInstance()->getStackerInstance()->isStackEmpty(NetworkPackage::STACKER_NAME_DECODED_HANDLED);
+
+               // Debug message
+               //* NOISY-DEBUG: */ $this->debugOutput('PACKAGE-ASSEMBLER: isInputBufferEmpty=' . intval($isInputBufferEmpty));
+
+               // Return it
+               return $isInputBufferEmpty;
+       }
+
        /**
         * Assembles the content from $packageContent. This method does only
         * initialize the whole process by creating a call-back which will then
@@ -60,7 +85,7 @@ class PackageAssembler extends BaseFrameworkSystem implements Assembler, Registe
         * @return      void
         * @throws      UnsupportedPackageCodeHandlerException  If the package code handler is not implemented
         */
-       public function assemblePackageDataArrayFromContent (array $packageContent) {
+       public function chunkPackageContent (array $packageContent) {
                // Validate the package content array again
                assert(
                        (isset($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA])) &&
@@ -73,35 +98,91 @@ class PackageAssembler extends BaseFrameworkSystem implements Assembler, Registe
                // Abort if the call-back method is not there
                if (!method_exists($this, $methodName)) {
                        // Throw an exception
-                       throw new UnsupportedPackageCodeHandlerException(array($this, $packageContent, $methodName), BaseListener::EXCEPTION_UNSUPPORTED_PACKAGE_CODE_HANDLER);
+                       throw new UnsupportedPackageCodeHandlerException(array($this, $methodName, $packageContent), BaseListener::EXCEPTION_UNSUPPORTED_PACKAGE_CODE_HANDLER);
                } // END - if
 
                // Call it back
                call_user_func(array($this, $methodName), $packageContent);
        }
 
+       /**************************************************************************
+        *                 Call-back methods for above method                     *
+        **************************************************************************/
+
        /**
-        * Call-back handler to handle unhandled packages
+        * Call-back handler to handle unhandled packages. This method "explodes"
+        * the string with the chunk separator from PackageFragmenter class, does
+        * some low checks on it and feeds it into another queue for verification
+        * and re-request for bad chunks.
         *
         * @param       $packageContent         An array with two elements: 'decoded_data' and 'error_code'
         * @return      void
         * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
         */
        private function handlePackageByUnhandledPackage (array $packageContent) {
-               /*
-                * "explode" the string from 'decoded_data' with chunk separator to
-                * get an array of chunks. These chunks must then be verified by
-                * their checksums. Also the final chunk must be handled.
-                */
-               $chunks = explode(PackageFragmenter::CHUNK_SEPARATOR, $packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]);
-
-               // Validate final chunk
-               if (substr($chunks[count($chunks) - 1], 0, strlen(PackageFragmenter::END_OF_PACKAGE_IDENTIFIER)) != PackageFragmenter::END_OF_PACKAGE_IDENTIFIER) {
-                       // Last chunk is not valid
-                       throw new FinalChunkVerificationException(array($this, $packageContent, $chunks), BaseListener::EXCEPTION_FINAL_CHUNK_VERIFICATION);
-               } // END - if
+               // Check for some conditions
+               if (!$this->ifInputBufferIsEmpty()) {
+                       // Last chunk is not valid, so wait for more
+                       $this->pendingData .= $packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA];
+
+                       // Debug message
+                       /* NOISY-DEBUG: */ $this->debugOutput('PACKAGE-ASSEMBLER: Partial data received. Waiting for more ... ( ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]) . ' bytes)');
+               } else {
+                       // Debug message
+                       //* NOISY-DEBUG */ $this->debugOutput('packageContent=' . print_r($packageContent,true) . ',chunks='.print_r($chunks,true));
+
+                       /*
+                        * "explode" the string from 'decoded_data' with chunk separator to
+                        * get an array of chunks. These chunks must then be verified by
+                        * their checksums. Also the final chunk must be handled.
+                        */
+                       $chunks = explode(PackageFragmenter::CHUNK_SEPARATOR, $packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]);
+
+                       // Now get a chunk handler instance
+                       $handlerInstance = ChunkHandlerFactory::createChunkHandlerInstance();
+
+                       // Add all chunks because the last final chunk is found
+                       $handlerInstance->addAllChunksWithFinal($chunks);
+               }
+       }
+
+       /**
+        * Checks whether the assembler's pending data is empty which means it has
+        * no pending data left for handling ... ;-)
+        *
+        * @return      $ifPendingDataIsEmpty   Whether pending data is empty
+        */
+       public function isPendingDataEmpty () {
+               // A simbple check
+               $ifPendingDataIsEmpty = empty($this->pendingData);
+
+               // Return it
+               return $ifPendingDataIsEmpty;
+       }
+
+       /**
+        * Handles the assembler's pending data
+        *
+        * @return      void
+        */
+       public function handlePendingData () {
+               // Assert on condition
+               assert(!$this->isPendingDataEmpty());
+
+               // Init fake array
+               $packageContent = array(
+                       BaseRawDataHandler::PACKAGE_DECODED_DATA => $this->pendingData,
+                       BaseRawDataHandler::PACKAGE_ERROR_CODE   => BaseRawDataHandler::SOCKET_ERROR_UNHANDLED
+               );
+
+               // Clear pending data
+               $this->pendingData = '';
+
+               // Debug message
+               /* NOISY-DEBUG: */ $this->debugOutput('PACKAGE-ASSEMBLER: Last block of partial data received. A total of ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_DECODED_DATA]) . ' bytes has been received.');
 
-               die('chunks='.print_r($chunks,true));
+               // Call the real handler method
+               $this->handlePackageByUnhandledPackage($packageContent);
        }
 }