3 * A PackageAssembler class to assemble a package content stream fragemented
4 * by PackageFragmenter back to a raw package data array.
6 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
25 class PackageAssembler extends BaseHubSystem implements Assembler, Registerable {
29 private $pendingData = '';
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates an instance of this class
44 * @param $packageInstance An instance of a Receivable class
45 * @return $assemblerInstance An instance of an Assembler class
47 public static final function createPackageAssembler (Receivable $packageInstance) {
49 $assemblerInstance = new PackageAssembler();
51 // Set package instance here
52 $assemblerInstance->setPackageInstance($packageInstance);
54 // Create an instance of a raw data input stream
55 $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_input_stream_class');
58 $assemblerInstance->setInputStreamInstance($streamInstance);
60 // Return the prepared instance
61 return $assemblerInstance;
65 * Checks whether the input buffer (stacker to be more preceise) is empty.
67 * @return $isInputBufferEmpty Whether the input buffer is empty
69 private function ifInputBufferIsEmpty () {
71 $isInputBufferEmpty = $this->getPackageInstance()->getStackerInstance()->isStackEmpty(NetworkPackage::STACKER_NAME_DECODED_HANDLED);
74 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: isInputBufferEmpty=' . intval($isInputBufferEmpty));
77 return $isInputBufferEmpty;
81 * Checks whether given package content is completed (start/end markers are found)
83 * @param $packageContent An array with two elements: 'raw_data' and 'error_code'
84 * @return $isCompleted Whether the given package content is completed
86 private function isPackageContentCompleted (array $packageContent) {
88 $isCompleted = $this->ifStartEndMarkersSet($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]);
95 * Assembles the content from $packageContent. This method does only
96 * initialize the whole process by creating a call-back which will then
97 * itself (99.9% of all cases) "explode" the decoded data stream and add
98 * it to a chunk assembler queue.
100 * If the call-back method or this would attempt to assemble the package
101 * chunks and (maybe) re-request some chunks from the sender, this would
102 * take to much time and therefore slow down this node again.
104 * @param $packageContent An array with two elements: 'raw_data' and 'error_code'
106 * @throws UnsupportedPackageCodeHandlerException If the package code handler is not implemented
108 public function chunkPackageContent (array $packageContent) {
109 // Validate the package content array again
111 (isset($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
112 (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
115 // Construct call-back name from package error code
116 $methodName = 'handlePackageBy' . $this->convertToClassName($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]);
118 // Abort if the call-back method is not there
119 if (!method_exists($this, $methodName)) {
120 // Throw an exception
121 throw new UnsupportedPackageCodeHandlerException(array($this, $methodName, $packageContent), BaseListener::EXCEPTION_UNSUPPORTED_PACKAGE_CODE_HANDLER);
125 call_user_func(array($this, $methodName), $packageContent);
128 /**************************************************************************
129 * Call-back methods for above method *
130 **************************************************************************/
133 * Call-back handler to handle unhandled package data. This method
134 * "explodes" the string with the chunk separator from PackageFragmenter
135 * class, does some low checks on it and feeds it into another queue for
136 * verification and re-request for bad chunks.
138 * @param $packageContent An array with two elements: 'raw_data' and 'error_code'
141 private function handlePackageByUnhandledPackage (array $packageContent) {
143 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: packageData[' . BaseRawDataHandler::PACKAGE_RAW_DATA . ']=' . $packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]);
145 // Check for some conditions
146 if ((!$this->ifInputBufferIsEmpty()) || (!$this->isPackageContentCompleted($packageContent))) {
147 // Last chunk is not valid, so wait for more
148 $this->pendingData .= $packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA];
151 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: Partial data received. Waiting for more ... ( ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]) . ' bytes)');
154 /* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('packageContent=' . print_r($packageContent,true) . ',chunks='.print_r($chunks,true));
159 * Checks whether the assembler's pending data is empty which means it has
160 * no pending data left for handling ... ;-)
162 * @return $ifPendingDataIsEmpty Whether pending data is empty
164 public function isPendingDataEmpty () {
166 $ifPendingDataIsEmpty = empty($this->pendingData);
169 return $ifPendingDataIsEmpty;
173 * Handles the assembler's pending data
177 public function handlePendingData () {
179 /* NOISY-DEBUG: */ $this->debugOutput('PACKAGE-ASSEMBLER: Going to decode ' . strlen($this->pendingData) . ' Bytes of pending data. pendingData=' . $this->pendingData);
181 // Assert on condition
182 assert(!$this->isPendingDataEmpty());
185 $packageContent = array(
186 BaseRawDataHandler::PACKAGE_RAW_DATA => $this->getInputStreamInstance()->streamData($this->pendingData),
187 BaseRawDataHandler::PACKAGE_ERROR_CODE => BaseRawDataHandler::SOCKET_ERROR_UNHANDLED
190 // Clear pending data
191 $this->pendingData = '';
194 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('PACKAGE-ASSEMBLER: Last block of partial data received. A total of ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]) . ' bytes has been received.');
197 * "explode" the string from 'raw_data' with chunk separator to
198 * get an array of chunks. These chunks must then be verified by
199 * their checksums. Also the final chunk must be handled.
201 $chunks = explode(PackageFragmenter::CHUNK_SEPARATOR, $packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]);
203 // Now get a chunk handler instance
204 $handlerInstance = ChunkHandlerFactory::createChunkHandlerInstance();
206 // Add all chunks because the last final chunk is found
207 $handlerInstance->addAllChunksWithFinal($chunks);