]> git.mxchange.org Git - hub.git/blobdiff - application/hub/main/handler/chunks/class_ChunkHandler.php
Renamed 'stacker' -> 'stack'
[hub.git] / application / hub / main / handler / chunks / class_ChunkHandler.php
index 991a95aa3c09106a3faaefbf87f384dba27d6efc..d0a7feafb6d12de0d417a5a0f5b7746ee0416b46 100644 (file)
@@ -91,9 +91,11 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                $stackerInstance = ObjectFactory::createObjectByConfiguredName('chunk_handler_stacker_class');
 
                // Init all stacker
-               $stackerInstance->initStacker(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP);
-               $stackerInstance->initStacker(self::STACKER_NAME_CHUNKS_WITHOUT_FINAL);
-               $stackerInstance->initStacker(self::STACKER_NAME_ASSEMBLED_RAW_DATA);
+               $stackerInstance->initStacks(array(
+                       self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP,
+                       self::STACKER_NAME_CHUNKS_WITHOUT_FINAL,
+                       self::STACKER_NAME_ASSEMBLED_RAW_DATA
+               ));
 
                // Set the stacker in this handler
                $handlerInstance->setStackerInstance($stackerInstance);
@@ -127,7 +129,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                        // ... and for the hashes
                        'hashes'         => array(),
                        // ... marker for that the final array is complete for assembling all chunks
-                       'is_complete'    => false,
+                       'is_complete'    => FALSE,
                        // ... steps done to assemble all chunks
                        'assemble_steps' => 0,
                );
@@ -150,10 +152,10 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         */
        private function isChunkHashValid (array $chunkSplits) {
                // Now hash the raw data again
-               $chunkHash = $this->getCryptoInstance()->hashString($chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA], $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH], false);
+               $chunkHash = $this->getCryptoInstance()->hashString($chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA], $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH], FALSE);
 
                // Debug output
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: chunkHash=' . $chunkHash . ',chunkSplits[chunk_hash]=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] . ',chunkSplits[serial]=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ',chunkSplits[raw_data]=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA]);
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: chunkHash=' . $chunkHash . ',chunkSplits[chunk_hash]=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] . ',chunkSplits[serial]=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ',chunkSplits[raw_data]=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA]);
 
                // Check it
                $isValid = ($chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] === $chunkHash);
@@ -170,7 +172,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         */
        private function isSerialNumberValid ($serialNumber) {
                // Check it
-               $isValid = ((strlen($serialNumber) == PackageFragmenter::MAX_SERIAL_LENGTH) && ($this->hexval($serialNumber, false) === $serialNumber));
+               $isValid = ((strlen($serialNumber) == PackageFragmenter::MAX_SERIAL_LENGTH) && ($this->hexval($serialNumber, FALSE) === $serialNumber));
 
                // Return result
                return $isValid;
@@ -195,7 +197,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                } // END - if
 
                // Debug message
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: serialNumber=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ',hash=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH]);
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: serialNumber=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ',hash=' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH]);
 
                // Add the chunk data (index 2) to the final array and use the serial number as index
                $this->finalPackageChunks['content'][$chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL]] = $chunkSplits[self::CHUNK_SPLITS_INDEX_RAW_DATA];
@@ -215,7 +217,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                 * As for now, just set the array element. If any further steps are
                 * being added, this should always be the last step.
                 */
-               $this->finalPackageChunks['is_complete'] = true;
+               $this->finalPackageChunks['is_complete'] = TRUE;
        }
 
        /**
@@ -244,9 +246,9 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         * @return      void
         */
        private function preparePackageAssmble () {
-               // Make sure both arrays have same count (this however should always be true)
+               // Make sure both arrays have same count (this however should always be TRUE)
                assert(count($this->finalPackageChunks['hashes']) == count($this->finalPackageChunks['content']));
-               //* DIE: */ die(__METHOD__ . ':finalPackageChunks='.print_r($this->finalPackageChunks['content'],true));
+               //* DIE: */ exit(__METHOD__ . ':finalPackageChunks='.print_r($this->finalPackageChunks['content'], TRUE));
 
                /*
                 * Remove last element (hash chunk) from 'hashes'. This hash will never
@@ -282,7 +284,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                        $nextSerial = $this->getFragmenterInstance()->getNextHexSerialNumber();
 
                        // Debug output
-                       //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: serialNumber=' . $serialNumber . ',nextSerial=' . $nextSerial);
+                       //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: serialNumber=' . $serialNumber . ',nextSerial=' . $nextSerial);
 
                        // Is it not the same? Then re-request it
                        if ($serialNumber != $nextSerial) {
@@ -313,8 +315,8 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                // That went well, so start assembling all chunks
                foreach ($this->finalPackageChunks['content'] as $serialNumber => $content) {
                        // Debug message
-                       //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: serialNumber=' . $serialNumber . ' - validating ...');
-                       //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('finalPackageChunks=' . print_r($this->finalPackageChunks,true) . 'chunkHashes=' . print_r($this->chunkHashes,true));
+                       //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: serialNumber=' . $serialNumber . ' - validating ...');
+                       //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('finalPackageChunks=' . print_r($this->finalPackageChunks, TRUE) . 'chunkHashes=' . print_r($this->chunkHashes, TRUE));
 
                        // Is this chunk valid? This should be the case
                        assert($this->isChunkHashValid(array(
@@ -330,7 +332,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                } // END - foreach
 
                // Debug output
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: eopChunk[1]=' . $this->eopChunk[1] . ',' . chr(10) . 'index=' . (count($this->chunkHashes) - 2) . ',' . chr(10) . 'chunkHashes='.print_r($this->chunkHashes,true));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: eopChunk[1]=' . $this->eopChunk[1] . ',' . chr(10) . 'index=' . (count($this->chunkHashes) - 2) . ',' . chr(10) . 'chunkHashes='.print_r($this->chunkHashes, TRUE));
 
                // The last chunk hash must match with the one from eopChunk[1]
                assert($this->eopChunk[1] == $this->chunkHashes[count($this->chunkHashes) - 2]);
@@ -344,7 +346,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         */
        private function verifyRawPackageData () {
                // Hash the raw package data for final verification
-               $finalHash = $this->getCryptoInstance()->hashString($this->rawPackageData, $this->eopChunk[0], false);
+               $finalHash = $this->getCryptoInstance()->hashString($this->rawPackageData, $this->eopChunk[0], FALSE);
 
                // Is it the same?
                assert($finalHash == $this->eopChunk[0]);
@@ -358,11 +360,14 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
         */
        public function addAllChunksWithFinal (array $chunks) {
-               // Validate final chunk
-               if (!$this->isValidFinalChunk($chunks)) {
+               // Try to validate the final chunk
+               try {
+                       // Validate final chunk
+                       $this->isValidFinalChunk($chunks);
+               } catch (AssertionException $e) {
                        // Last chunk is not valid
-                       throw new FinalChunkVerificationException(array($this, $chunks), BaseListener::EXCEPTION_FINAL_CHUNK_VERIFICATION);
-               } // END - if
+                       throw new FinalChunkVerificationException(array($this, $chunks, $e), BaseListener::EXCEPTION_FINAL_CHUNK_VERIFICATION);
+               }
 
                // Do we have some pending chunks (no final)?
                while (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITHOUT_FINAL)) {
@@ -398,7 +403,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         */
        public function ifUnhandledChunksWithFinalAvailable () {
                // Simply check if the stacker is not empty
-               $unhandledChunks = $this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP) === false;
+               $unhandledChunks = $this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_CHUNKS_WITH_FINAL_EOP) === FALSE;
 
                // Return result
                return $unhandledChunks;
@@ -432,7 +437,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                // Is the generated hash from data same ("valid") as given hash?
                if (!$this->isChunkHashValid($chunkSplits)) {
                        // Do some logging
-                       self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: Chunk content is not validating against given hash.');
+                       self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: Chunk content is not validating against given hash.');
 
                        // Re-request this chunk (trust the hash in index # 0)
                        $this->rerequestChunkBySplitsArray($chunkSplits);
@@ -444,7 +449,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                // Is the serial number valid (chars 0-9, length equals PackageFragmenter::MAX_SERIAL_LENGTH)?
                if (!$this->isSerialNumberValid($chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL])) {
                        // Do some logging
-                       self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: Chunk serial number ' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ' for hash ' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] . ' is invalid.');
+                       self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: Chunk serial number ' . $chunkSplits[self::CHUNK_SPLITS_INDEX_SERIAL] . ' for hash ' . $chunkSplits[self::CHUNK_SPLITS_INDEX_HASH] . ' is invalid.');
 
                        // Re-request this chunk
                        $this->rerequestChunkBySplitsArray($chunkSplits);
@@ -477,7 +482,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
         */
        public function ifUnassembledChunksAvailable () {
                // For now do only check the array element 'is_complete'
-               $unassembledChunksAvailable = ($this->finalPackageChunks['is_complete'] === true);
+               $unassembledChunksAvailable = ($this->finalPackageChunks['is_complete'] === TRUE);
 
                // Return status
                return $unassembledChunksAvailable;
@@ -528,7 +533,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
                                break;
 
                        default: // Invalid step found
-                               self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER: Invalid step ' . $this->finalPackageChunks['assemble_steps'] . ' detected.');
+                               self::createDebugInstance(__CLASS__)->debugOutput('CHUNK-HANDLER[' . __LINE__ . ']: Invalid step ' . $this->finalPackageChunks['assemble_steps'] . ' detected.');
                                break;
                } // END - switch
        }
@@ -536,7 +541,7 @@ class ChunkHandler extends BaseHandler implements HandleableChunks, Registerable
        /**
         * Checks whether the raw package data has been assembled back together.
         * This can be safely assumed when rawPackageData is not empty and the
-        * collection of all chunks is false (because initHandler() will reset it).
+        * collection of all chunks is FALSE (because initHandler() will reset it).
         *
         * @return      $isRawPackageDataAvailable      Whether raw package data is available
         */