3 * A NetworkPackage class. This class implements Deliverable and Receivable
4 * because all network packages should be deliverable to other nodes and
5 * receivable from other nodes. It further provides methods for reading raw
6 * content from template engines and feeding it to the stacker for undeclared
9 * The factory method requires you to provide a compressor class (which must
10 * implement the Compressor interface). If you don't want any compression (not
11 * adviceable due to increased network load), please use the NullCompressor
12 * class and encode it with BASE64 for a more error-free transfer over the
15 * For performance reasons, this class should only be instanciated once and then
16 * used as a "pipe-through" class.
18 * @author Roland Haeder <webmaster@ship-simu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.ship-simu.org
23 * @todo Needs to add functionality for handling the object's type
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, Registerable, Visitable {
40 * Package mask for compressing package data:
41 * 0: Compressor extension
43 * 2: Tags, seperated by semicolons, no semicolon is required if only one tag is needed
47 const PACKAGE_MASK = '%s%s%s%s%s%s%s';
50 * Separator for the above mask
52 const PACKAGE_MASK_SEPARATOR = '^';
55 * Size of an array created by invoking
56 * explode(NetworkPackage::PACKAGE_MASK_SEPARATOR, $content).
58 const PACKAGE_CONTENT_ARRAY_SIZE = 4;
61 * Separator for checksum
63 const PACKAGE_CHECKSUM_SEPARATOR = '_';
66 * Array indexes for above mask, start with zero
68 const INDEX_COMPRESSOR_EXTENSION = 0;
69 const INDEX_PACKAGE_DATA = 1;
71 const INDEX_CHECKSUM = 3;
74 * Array indexes for raw package array
76 const INDEX_PACKAGE_SENDER = 0;
77 const INDEX_PACKAGE_RECIPIENT = 1;
78 const INDEX_PACKAGE_CONTENT = 2;
79 const INDEX_PACKAGE_STATUS = 3;
80 const INDEX_PACKAGE_SIGNATURE = 4;
83 * Size of the decoded data array ('status' is not included)
85 const DECODED_DATA_ARRAY_SIZE = 4;
88 * Named array elements for decoded package content
90 const PACKAGE_CONTENT_EXTENSION = 'compressor';
91 const PACKAGE_CONTENT_MESSAGE = 'message';
92 const PACKAGE_CONTENT_TAGS = 'tags';
93 const PACKAGE_CONTENT_CHECKSUM = 'checksum';
96 * Named array elements for package data
98 const PACKAGE_DATA_SENDER = 'sender';
99 const PACKAGE_DATA_RECIPIENT = 'recipient';
100 const PACKAGE_DATA_PROTOCOL = 'protocol';
101 const PACKAGE_DATA_CONTENT = 'content';
102 const PACKAGE_DATA_STATUS = 'status';
103 const PACKAGE_DATA_SIGNATURE = 'signature';
108 const PACKAGE_STATUS_NEW = 'new';
109 const PACKAGE_STATUS_FAILED = 'failed';
110 const PACKAGE_STATUS_DECODED = 'decoded';
111 const PACKAGE_STATUS_FAKED = 'faked';
114 * Constants for message data array
116 const MESSAGE_ARRAY_DATA = 'message_data';
117 const MESSAGE_ARRAY_TYPE = 'message_type';
122 const PACKAGE_TAGS_SEPARATOR = ';';
125 * Raw package data separator
127 const PACKAGE_DATA_SEPARATOR = '#';
130 * Separator for more than one recipient
132 const PACKAGE_RECIPIENT_SEPARATOR = ':';
135 * Network target (alias): 'upper hubs'
137 const NETWORK_TARGET_UPPER_HUBS = 'upper';
140 * Network target (alias): 'self'
142 const NETWORK_TARGET_SELF = 'self';
145 * TCP package size in bytes
147 const TCP_PACKAGE_SIZE = 512;
149 /**************************************************************************
150 * Stacker for out-going packages *
151 **************************************************************************/
154 * Stacker name for "undeclared" packages
156 const STACKER_NAME_UNDECLARED = 'package_undeclared';
159 * Stacker name for "declared" packages (which are ready to send out)
161 const STACKER_NAME_DECLARED = 'package_declared';
164 * Stacker name for "out-going" packages
166 const STACKER_NAME_OUTGOING = 'package_outgoing';
168 /**************************************************************************
169 * Stacker for incoming packages *
170 **************************************************************************/
173 * Stacker name for "incoming" decoded raw data
175 const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
178 * Stacker name for handled decoded raw data
180 const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
183 * Stacker name for "chunked" decoded raw data
185 const STACKER_NAME_DECODED_CHUNKED = 'package_chunked_decoded';
187 /**************************************************************************
188 * Stacker for incoming messages *
189 **************************************************************************/
192 * Stacker name for new messages
194 const STACKER_NAME_NEW_MESSAGE = 'package_new_message';
197 * Stacker name for processed messages
199 const STACKER_NAME_PROCESSED_MESSAGE = 'package_processed_message';
201 /**************************************************************************
202 * Stacker for other/internal purposes *
203 **************************************************************************/
206 * Stacker name for "back-buffered" packages
208 const STACKER_NAME_BACK_BUFFER = 'package_backbuffer';
210 /**************************************************************************
212 **************************************************************************/
213 const PROTOCOL_TCP = 'TCP';
214 const PROTOCOL_UDP = 'UDP';
217 * Protected constructor
221 protected function __construct () {
222 // Call parent constructor
223 parent::__construct(__CLASS__);
227 * Creates an instance of this class
229 * @param $compressorInstance A Compressor instance for compressing the content
230 * @return $packageInstance An instance of a Deliverable class
232 public static final function createNetworkPackage (Compressor $compressorInstance) {
234 $packageInstance = new NetworkPackage();
236 // Now set the compressor instance
237 $packageInstance->setCompressorInstance($compressorInstance);
240 * We need to initialize a stack here for our packages even for those
241 * which have no recipient address and stamp... ;-) This stacker will
242 * also be used for incoming raw data to handle it.
244 $stackerInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
246 // At last, set it in this class
247 $packageInstance->setStackerInstance($stackerInstance);
250 $packageInstance->initStackers();
252 // Get a visitor instance for speeding up things and set it
253 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class', array($packageInstance));
254 $packageInstance->setVisitorInstance($visitorInstance);
256 // Get crypto instance and set it, too
257 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
258 $packageInstance->setCryptoInstance($cryptoInstance);
260 // Get a singleton package assembler instance from factory and set it here, too
261 $assemblerInstance = PackageAssemblerFactory::createAssemblerInstance($packageInstance);
262 $packageInstance->setAssemblerInstance($assemblerInstance);
264 // Return the prepared instance
265 return $packageInstance;
269 * Initialize all stackers
271 * @param $forceReInit Whether to force reinitialization of all stacks
274 protected function initStackers ($forceReInit = false) {
278 self::STACKER_NAME_UNDECLARED,
279 self::STACKER_NAME_DECLARED,
280 self::STACKER_NAME_OUTGOING,
281 self::STACKER_NAME_DECODED_INCOMING,
282 self::STACKER_NAME_DECODED_HANDLED,
283 self::STACKER_NAME_DECODED_CHUNKED,
284 self::STACKER_NAME_NEW_MESSAGE,
285 self::STACKER_NAME_PROCESSED_MESSAGE,
286 self::STACKER_NAME_BACK_BUFFER
289 $this->getStackerInstance()->initStacker($stackerName, $forceReInit);
294 * "Getter" for hash from given content
296 * @param $content Raw package content
297 * @return $hash Hash for given package content
299 private function getHashFromContent ($content) {
301 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
304 // @TODO crc32() is very weak, but it needs to be fast
307 self::PACKAGE_CHECKSUM_SEPARATOR .
308 $this->getSessionId() .
309 self::PACKAGE_CHECKSUM_SEPARATOR .
310 $this->getCompressorInstance()->getCompressorExtension()
318 * Checks whether the checksum (sometimes called "hash") is the same
320 * @param $decodedContent Package raw content
321 * @param $decodedData Whole raw package data array
322 * @return $isChecksumValid Whether the checksum is the same
324 private function isChecksumValid (array $decodedContent, array $decodedData) {
326 $checksum = $this->getHashFromContentSessionId($decodedContent, $decodedData[self::PACKAGE_DATA_SENDER]);
329 $isChecksumValid = ($checksum == $decodedContent[self::PACKAGE_CONTENT_CHECKSUM]);
332 return $isChecksumValid;
336 * Change the package with given status in given stack
338 * @param $packageData Raw package data in an array
339 * @param $stackerName Name of the stacker
340 * @param $newStatus New status to set
343 private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
344 // Skip this for empty stacks
345 if ($this->getStackerInstance()->isStackEmpty($stackerName)) {
346 // This avoids an exception after all packages has failed
350 // Pop the entry (it should be it)
351 $nextData = $this->getStackerInstance()->popNamed($stackerName);
353 // Compare both signatures
354 assert($nextData[self::PACKAGE_DATA_SIGNATURE] == $packageData[self::PACKAGE_DATA_SIGNATURE]);
356 // Temporary set the new status
357 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
360 $this->getStackerInstance()->pushNamed($stackerName, $packageData);
364 * "Getter" for hash from given content and sender's session id
366 * @param $decodedContent Raw package content
367 * @param $sessionId Session id of the sender
368 * @return $hash Hash for given package content
370 public function getHashFromContentSessionId (array $decodedContent, $sessionId) {
372 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: content[md5]=' . md5($decodedContent[self::PACKAGE_CONTENT_MESSAGE]) . ',sender=' . $sessionId . ',compressor=' . $decodedContent[self::PACKAGE_CONTENT_EXTENSION]);
375 // @TODO crc32() is very weak, but it needs to be fast
377 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] .
378 self::PACKAGE_CHECKSUM_SEPARATOR .
380 self::PACKAGE_CHECKSUM_SEPARATOR .
381 $decodedContent[self::PACKAGE_CONTENT_EXTENSION]
388 ///////////////////////////////////////////////////////////////////////////
389 // Delivering packages / raw data
390 ///////////////////////////////////////////////////////////////////////////
393 * Delivers the given raw package data.
395 * @param $packageData Raw package data in an array
398 private function declareRawPackageData (array $packageData) {
400 * We need to disover every recipient, just in case we have a
401 * multi-recipient entry like 'upper' is. 'all' may be a not so good
402 * target because it causes an overload on the network and may be
403 * abused for attacking the network with large packages.
405 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
407 // Discover all recipients, this may throw an exception
408 $discoveryInstance->discoverRecipients($packageData);
410 // Now get an iterator
411 $iteratorInstance = $discoveryInstance->getIterator();
413 // Rewind back to the beginning
414 $iteratorInstance->rewind();
416 // ... and begin iteration
417 while ($iteratorInstance->valid()) {
419 $currentRecipient = $iteratorInstance->current();
422 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Setting recipient to ' . $currentRecipient . ',previous=' . $packageData[self::PACKAGE_DATA_RECIPIENT]);
425 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
427 // And enqueue it to the writer class
428 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
431 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Package declared for recipient ' . $currentRecipient);
433 // Skip to next entry
434 $iteratorInstance->next();
438 * The recipient list can be cleaned up here because the package which
439 * shall be delivered has already been added for all entries from the
442 $discoveryInstance->clearRecipients();
446 * Delivers raw package data. In short, this will discover the raw socket
447 * resource through a discovery class (which will analyse the receipient of
448 * the package), register the socket with the connection (handler/helper?)
449 * instance and finally push the raw data on our outgoing queue.
451 * @param $packageData Raw package data in an array
454 private function deliverRawPackageData (array $packageData) {
456 * This package may become big, depending on the shared object size or
457 * delivered message size which shouldn't be so long (to save
458 * bandwidth). Because of the nature of the used protocol (TCP) we need
459 * to split it up into smaller pieces to fit it into a TCP frame.
461 * So first we need (again) a discovery class but now a protocol
462 * discovery to choose the right socket resource. The discovery class
463 * should take a look at the raw package data itself and then decide
464 * which (configurable!) protocol should be used for that type of
467 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
469 // Now discover the right protocol
470 $socketResource = $discoveryInstance->discoverSocket($packageData, BaseConnectionHelper::CONNECTION_TYPE_OUTGOING);
473 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
475 // We have to put this socket in our registry, so get an instance
476 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
478 // Get the listener from registry
479 $helperInstance = Registry::getRegistry()->getInstance('connection');
482 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: stateInstance=' . $helperInstance->getStateInstance());
483 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
486 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($helperInstance, $socketResource))) {
488 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Registering socket ' . $socketResource . ' ...');
491 $registryInstance->registerSocket($helperInstance, $socketResource, $packageData);
492 } elseif (!$helperInstance->getStateInstance()->isPeerStateConnected()) {
493 // Is not connected, then we cannot send
494 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Unexpected peer state ' . $helperInstance->getStateInstance()->__toString() . ' detected.');
496 // Shutdown the socket
497 $this->shutdownSocket($socketResource);
501 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
503 // Make sure the connection is up
504 $helperInstance->getStateInstance()->validatePeerStateConnected();
507 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
509 // Enqueue it again on the out-going queue, the connection is up and working at this point
510 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
513 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
517 * Sends waiting packages
519 * @param $packageData Raw package data
522 private function sendOutgoingRawPackageData (array $packageData) {
526 // Get the right connection instance
527 $helperInstance = SocketRegistryFactory::createSocketRegistryInstance()->getHandlerInstanceFromPackageData($packageData);
529 // Is this connection still alive?
530 if ($helperInstance->isShuttedDown()) {
531 // This connection is shutting down
532 // @TODO We may want to do somthing more here?
536 // Sent out package data
537 $sentBytes = $helperInstance->sendRawPackageData($packageData);
539 // Remember unsent raw bytes in back-buffer, if any
540 $this->storeUnsentBytesInBackBuffer($packageData, $sentBytes);
544 * Generates a signature for given raw package content and sender id
546 * @param $content Raw package data
547 * @param $senderId Sender id to generate a signature for
548 * @return $signature Signature as BASE64-encoded string
550 private function generatePackageSignature ($content, $senderId) {
551 // Hash content and sender id together, use md5() as last algo
552 $hash = md5($this->getCryptoInstance()->hashString($senderId . $content, $this->getPrivateKey(), false));
554 // Encrypt the content again with the hash as a key
555 $encryptedContent = $this->getCryptoInstance()->encryptString($content, $hash);
557 // Encode it with BASE64
558 $signature = base64_encode($encryptedContent);
565 * Checks whether the signature of given package data is 'valid', here that
566 * means it is the same or not.
568 * @param $decodedArray An array with 'decoded' (explode() was mostly called) data
569 * @return $isSignatureValid Whether the signature is valid
570 * @todo Unfinished area, signatures are currently NOT fully supported
572 private function isPackageSignatureValid (array $decodedArray) {
573 // Generate the signature of comparing it
574 $signature = $this->generatePackageSignature($decodedArray[self::INDEX_PACKAGE_CONTENT], $decodedArray[self::INDEX_PACKAGE_SENDER]);
577 //$isSignatureValid =
578 exit(__METHOD__.': signature='.$signature.chr(10).',decodedArray='.print_r($decodedArray,true));
582 * "Enqueues" raw content into this delivery class by reading the raw content
583 * from given helper's template instance and pushing it on the 'undeclared'
586 * @param $helperInstance An instance of a HelpableHub class
587 * @param $protocol Name of used protocol (TCP/UDP)
590 public function enqueueRawDataFromTemplate (HelpableHub $helperInstance, $protocolName) {
591 // Get the raw content ...
592 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
593 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('content(' . strlen($content) . ')=' . $content);
595 // ... and compress it
596 $content = $this->getCompressorInstance()->compressStream($content);
598 // Add magic in front of it and hash behind it, including BASE64 encoding
599 $content = sprintf(self::PACKAGE_MASK,
600 // 1.) Compressor's extension
601 $this->getCompressorInstance()->getCompressorExtension(),
603 self::PACKAGE_MASK_SEPARATOR,
604 // 2.) Raw package content, encoded with BASE64
605 base64_encode($content),
607 self::PACKAGE_MASK_SEPARATOR,
609 implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
611 self::PACKAGE_MASK_SEPARATOR,
613 $this->getHashFromContent($content)
616 // Now prepare the temporary array and push it on the 'undeclared' stack
617 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
618 self::PACKAGE_DATA_SENDER => $this->getSessionId(),
619 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
620 self::PACKAGE_DATA_PROTOCOL => $protocolName,
621 self::PACKAGE_DATA_CONTENT => $content,
622 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_NEW,
623 self::PACKAGE_DATA_SIGNATURE => $this->generatePackageSignature($content, $this->getSessionId())
628 * Checks whether a package has been enqueued for delivery.
630 * @return $isEnqueued Whether a package is enqueued
632 public function isPackageEnqueued () {
633 // Check whether the stacker is not empty
634 $isEnqueued = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
641 * Checks whether a package has been declared
643 * @return $isDeclared Whether a package is declared
645 public function isPackageDeclared () {
646 // Check whether the stacker is not empty
647 $isDeclared = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
654 * Checks whether a package should be sent out
656 * @return $isWaitingDelivery Whether a package is waiting for delivery
658 public function isPackageWaitingForDelivery () {
659 // Check whether the stacker is not empty
660 $isWaitingDelivery = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
663 return $isWaitingDelivery;
667 * Delivers an enqueued package to the stated destination. If a non-session
668 * id is provided, recipient resolver is being asked (and instanced once).
669 * This allows that a single package is being delivered to multiple targets
670 * without enqueueing it for every target. If no target is provided or it
671 * can't be determined a NoTargetException is being thrown.
674 * @throws NoTargetException If no target can't be determined
676 public function declareEnqueuedPackage () {
677 // Make sure this method isn't working if there is no package enqueued
678 if (!$this->isPackageEnqueued()) {
679 // This is not fatal but should be avoided
680 // @TODO Add some logging here
685 * Now there are for sure packages to deliver, so start with the first
688 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_UNDECLARED);
690 // Declare the raw package data for delivery
691 $this->declareRawPackageData($packageData);
693 // And remove it finally
694 $this->getStackerInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
698 * Delivers the next declared package. Only one package per time will be sent
699 * because this may take time and slows down the whole delivery
704 public function deliverDeclaredPackage () {
705 // Sanity check if we have packages declared
706 if (!$this->isPackageDeclared()) {
707 // This is not fatal but should be avoided
708 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: No package has been declared, but ' . __METHOD__ . ' has been called!');
713 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
716 // And try to send it
717 $this->deliverRawPackageData($packageData);
719 // And remove it finally
720 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
721 } catch (InvalidStateException $e) {
722 // The state is not excepected (shall be 'connected')
723 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
725 // Mark the package with status failed
726 $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
731 * Sends waiting packages out for delivery
735 public function sendWaitingPackage () {
736 // Send any waiting bytes in the back-buffer before sending a new package
737 $this->sendBackBufferBytes();
739 // Sanity check if we have packages waiting for delivery
740 if (!$this->isPackageWaitingForDelivery()) {
741 // This is not fatal but should be avoided
742 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
747 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_OUTGOING);
750 // Now try to send it
751 $this->sendOutgoingRawPackageData($packageData);
753 // And remove it finally
754 $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING);
755 } catch (InvalidSocketException $e) {
756 // Output exception message
757 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Package was not delivered: ' . $e->getMessage());
759 // Mark package as failed
760 $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
764 ///////////////////////////////////////////////////////////////////////////
765 // Receiving packages / raw data
766 ///////////////////////////////////////////////////////////////////////////
769 * Checks whether decoded raw data is pending
771 * @return $isPending Whether decoded raw data is pending
773 private function isRawDataPending () {
774 // Just return whether the stack is not empty
775 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
782 * Checks whether new raw package data has arrived at a socket
784 * @param $poolInstance An instance of a PoolableListener class
785 * @return $hasArrived Whether new raw package data has arrived for processing
787 public function isNewRawDataPending (PoolableListener $poolInstance) {
788 // Visit the pool. This monitors the pool for incoming raw data.
789 $poolInstance->accept($this->getVisitorInstance());
791 // Check for new data arrival
792 $hasArrived = $this->isRawDataPending();
799 * Handles the incoming decoded raw data. This method does not "convert" the
800 * decoded data back into a package array, it just "handles" it and pushs it
805 public function handleIncomingDecodedData () {
807 * This method should only be called if decoded raw data is pending,
810 if (!$this->isRawDataPending()) {
811 // This is not fatal but should be avoided
812 // @TODO Add some logging here
816 // Very noisy debug message:
817 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: Stacker size is ' . $this->getStackerInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
819 // "Pop" the next entry (the same array again) from the stack
820 $decodedData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
822 // Make sure both array elements are there
824 (is_array($decodedData)) &&
825 (isset($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
826 (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
830 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
831 * only want to handle unhandled packages here.
833 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
834 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
836 // Remove the last chunk SEPARATOR (because it is being added and we don't need it)
837 if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
838 // It is there and should be removed
839 $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
842 // This package is "handled" and can be pushed on the next stack
843 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
847 * Adds raw decoded data from the given handler instance to this receiver
849 * @param $handlerInstance An instance of a Networkable class
852 public function addRawDataToIncomingStack (Networkable $handlerInstance) {
854 * Get the decoded data from the handler, this is an array with
855 * 'raw_data' and 'error_code' as elements.
857 $decodedData = $handlerInstance->getNextRawData();
859 // Very noisy debug message:
860 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, true));
862 // And push it on our stack
863 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
867 * Checks whether incoming decoded data is handled.
869 * @return $isHandled Whether incoming decoded data is handled
871 public function isIncomingRawDataHandled () {
872 // Determine if the stack is not empty
873 $isHandled = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
880 * Checks whether the assembler has pending data left
882 * @return $isHandled Whether the assembler has pending data left
884 public function ifAssemblerHasPendingDataLeft () {
885 // Determine if the stack is not empty
886 $isHandled = (!$this->getAssemblerInstance()->isPendingDataEmpty());
893 * Handles the attached assemler's pending data queue to be finally
894 * assembled to the raw package data back.
898 public function handleAssemblerPendingData () {
900 $this->getAssemblerInstance()->handlePendingData();
904 * Assembles incoming decoded data so it will become an abstract network
905 * package again. The assembler does later do it's job by an other task,
906 * not this one to keep best speed possible.
910 public function assembleDecodedDataToPackage () {
911 // Make sure the raw decoded package data is handled
912 assert($this->isIncomingRawDataHandled());
914 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
915 $packageContent = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
917 // Start assembling the raw package data array by chunking it
918 $this->getAssemblerInstance()->chunkPackageContent($packageContent);
920 // Remove the package from 'handled_decoded' stack ...
921 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
923 // ... and push it on the 'chunked' stacker
924 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
928 * Accepts the visitor to process the visit "request"
930 * @param $visitorInstance An instance of a Visitor class
933 public function accept (Visitor $visitorInstance) {
935 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: ' . $visitorInstance->__toString() . ' has visited - START');
938 $visitorInstance->visitNetworkPackage($this);
941 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: ' . $visitorInstance->__toString() . ' has visited - FINISHED');
949 public function clearAllStacker () {
950 // Call the init method to force re-initialization
951 $this->initStackers(true);
954 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE: All stacker have been re-initialized.');
958 * Removes the first failed outoging package from the stack to continue
959 * with next one (it will never work until the issue is fixed by you).
962 * @throws UnexpectedPackageStatusException If the package status is not 'failed'
963 * @todo This may be enchanced for outgoing packages?
965 public function removeFirstFailedPackage () {
966 // Get the package again
967 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
969 // Is the package status 'failed'?
970 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
972 throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
976 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
980 * "Decode" the package content into the same array when it was sent.
982 * @param $rawPackageContent The raw package content to be "decoded"
983 * @return $decodedData An array with 'sender', 'recipient', 'content' and 'status' elements
985 public function decodeRawContent ($rawPackageContent) {
986 // Use the separator '#' to "decode" it
987 $decodedArray = explode(self::PACKAGE_DATA_SEPARATOR, $rawPackageContent);
989 // Assert on count (should be always 3)
990 assert(count($decodedArray) == self::DECODED_DATA_ARRAY_SIZE);
992 // Generate the signature of comparing it
994 * @todo Unsupported feature of "signed" messages commented out
995 if (!$this->isPackageSignatureValid($decodedArray)) {
996 // Is not valid, so throw an exception here
997 exit(__METHOD__ . ':INVALID SIG! UNDER CONSTRUCTION!' . chr(10));
1002 * Create 'decodedData' array with all assoziative array elements,
1005 $decodedData = array(
1006 self::PACKAGE_DATA_SENDER => $decodedArray[self::INDEX_PACKAGE_SENDER],
1007 self::PACKAGE_DATA_RECIPIENT => $decodedArray[self::INDEX_PACKAGE_RECIPIENT],
1008 self::PACKAGE_DATA_CONTENT => $decodedArray[self::INDEX_PACKAGE_CONTENT],
1009 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_DECODED
1013 return $decodedData;
1017 * Handles decoded data for this node by "decoding" the 'content' part of
1018 * it. Again this method uses explode() for the "decoding" process.
1020 * @param $decodedData An array with decoded raw package data
1022 * @throws InvalidDataChecksumException If the checksum doesn't match
1024 public function handleRawData (array $decodedData) {
1026 * "Decode" the package's content by a simple explode() call, for
1027 * details of the array elements, see comments for constant
1030 $decodedContent = explode(self::PACKAGE_MASK_SEPARATOR, $decodedData[self::PACKAGE_DATA_CONTENT]);
1032 // Assert on array count for a very basic validation
1033 assert(count($decodedContent) == self::PACKAGE_CONTENT_ARRAY_SIZE);
1036 * Convert the indexed array into an associative array. This is much
1037 * better to remember than plain numbers, isn't it?
1039 $decodedContent = array(
1040 // Compressor's extension used to compress the data
1041 self::PACKAGE_CONTENT_EXTENSION => $decodedContent[self::INDEX_COMPRESSOR_EXTENSION],
1042 // Package data (aka "message") in BASE64-decoded form but still compressed
1043 self::PACKAGE_CONTENT_MESSAGE => base64_decode($decodedContent[self::INDEX_PACKAGE_DATA]),
1044 // Tags as an indexed array for "tagging" the message
1045 self::PACKAGE_CONTENT_TAGS => explode(self::PACKAGE_TAGS_SEPARATOR, $decodedContent[self::INDEX_TAGS]),
1046 // Checksum of the _decoded_ data
1047 self::PACKAGE_CONTENT_CHECKSUM => $decodedContent[self::INDEX_CHECKSUM]
1050 // Is the checksum valid?
1051 if (!$this->isChecksumValid($decodedContent, $decodedData)) {
1052 // Is not the same, so throw an exception here
1053 throw new InvalidDataChecksumException(array($this, $decodedContent, $decodedData), BaseListener::EXCEPTION_INVALID_DATA_CHECKSUM);
1057 * The checksum is the same, then it can be decompressed safely. The
1058 * original message is at this point fully decoded.
1060 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
1062 // And push it on the next stack
1063 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
1067 * Checks whether a new message has arrived
1069 * @return $hasArrived Whether a new message has arrived for processing
1071 public function isNewMessageArrived () {
1072 // Determine if the stack is not empty
1073 $hasArrived = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
1080 * Handles newly arrived messages
1083 * @todo Implement verification of all sent tags here?
1085 public function handleNewlyArrivedMessage () {
1086 // Get it from the stacker, it is the full array with the decoded message
1087 $decodedContent = $this->getStackerInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
1089 // Now get a filter chain back from factory with given tags array
1090 $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
1093 * Process the message through all filters, note that all other
1094 * elements from $decodedContent are no longer needed.
1096 $chainInstance->processMessage($decodedContent[self::PACKAGE_CONTENT_MESSAGE], $this);
1100 * Checks whether a processed message is pending for "interpretation"
1102 * @return $isPending Whether a processed message is pending
1104 public function isProcessedMessagePending () {
1106 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
1113 * Handle processed messages by "interpreting" the 'message_type' element
1117 public function handleProcessedMessage () {
1118 // Get it from the stacker, it is the full array with the processed message
1119 $messageArray = $this->getStackerInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
1121 // Create a handler instance from given message type
1122 $handlerInstance = MessageTypeHandlerFactory::createMessageTypeHandlerInstance($messageArray[self::MESSAGE_ARRAY_TYPE]);
1124 // Handle message data
1125 $handlerInstance->handleMessageData($messageArray[self::MESSAGE_ARRAY_DATA], $this);