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@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.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_HASH = 4;
83 * Size of the decoded data array
85 const DECODED_DATA_ARRAY_SIZE = 5;
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';
94 const PACKAGE_CONTENT_SENDER = 'sender';
95 const PACKAGE_CONTENT_HASH = 'hash';
98 * Named array elements for package data
100 const PACKAGE_DATA_SENDER = 'sender';
101 const PACKAGE_DATA_RECIPIENT = 'recipient';
102 const PACKAGE_DATA_CONTENT = 'content';
103 const PACKAGE_DATA_STATUS = 'status';
104 const PACKAGE_DATA_HASH = 'hash';
109 const PACKAGE_STATUS_NEW = 'new';
110 const PACKAGE_STATUS_FAILED = 'failed';
111 const PACKAGE_STATUS_DECODED = 'decoded';
112 const PACKAGE_STATUS_FAKED = 'faked';
115 * Constants for message data array
117 const MESSAGE_ARRAY_DATA = 'message_data';
118 const MESSAGE_ARRAY_TYPE = 'message_type';
121 * Generic answer status field
127 const PACKAGE_TAGS_SEPARATOR = ';';
130 * Raw package data separator
132 const PACKAGE_DATA_SEPARATOR = '#';
135 * Separator for more than one recipient
137 const PACKAGE_RECIPIENT_SEPARATOR = ':';
140 * Network target (alias): 'upper nodes'
142 const NETWORK_TARGET_UPPER = 'upper';
145 * Network target (alias): 'self'
147 const NETWORK_TARGET_SELF = 'self';
150 * Network target (alias): 'dht'
152 const NETWORK_TARGET_DHT = 'dht';
155 * TCP package size in bytes
157 const TCP_PACKAGE_SIZE = 512;
159 /**************************************************************************
160 * Stacker for out-going packages *
161 **************************************************************************/
164 * Stacker name for "undeclared" packages
166 const STACKER_NAME_UNDECLARED = 'package_undeclared';
169 * Stacker name for "declared" packages (which are ready to send out)
171 const STACKER_NAME_DECLARED = 'package_declared';
174 * Stacker name for "out-going" packages
176 const STACKER_NAME_OUTGOING = 'package_outgoing';
178 /**************************************************************************
179 * Stacker for incoming packages *
180 **************************************************************************/
183 * Stacker name for "incoming" decoded raw data
185 const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
188 * Stacker name for handled decoded raw data
190 const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
193 * Stacker name for "chunked" decoded raw data
195 const STACKER_NAME_DECODED_CHUNKED = 'package_chunked_decoded';
197 /**************************************************************************
198 * Stacker for incoming messages *
199 **************************************************************************/
202 * Stacker name for new messages
204 const STACKER_NAME_NEW_MESSAGE = 'package_new_message';
207 * Stacker name for processed messages
209 const STACKER_NAME_PROCESSED_MESSAGE = 'package_processed_message';
211 /**************************************************************************
212 * Stacker for raw data handling *
213 **************************************************************************/
216 * Stacker for outgoing data stream
218 const STACKER_NAME_OUTGOING_STREAM = 'outgoing_stream';
221 * Array index for final hash
223 const RAW_FINAL_HASH_INDEX = 'hash';
226 * Array index for encoded data
228 const RAW_ENCODED_DATA_INDEX = 'data';
231 * Array index for sent bytes
233 const RAW_SENT_BYTES_INDEX = 'sent';
236 * Array index for socket resource
238 const RAW_SOCKET_INDEX = 'socket';
241 * Array index for buffer size
243 const RAW_BUFFER_SIZE_INDEX = 'buffer';
246 * Array index for diff between buffer and sent bytes
248 const RAW_DIFF_INDEX = 'diff';
250 /**************************************************************************
252 **************************************************************************/
253 const PROTOCOL_TCP = 'TCP';
254 const PROTOCOL_UDP = 'UDP';
257 * Protected constructor
261 protected function __construct () {
262 // Call parent constructor
263 parent::__construct(__CLASS__);
267 * Creates an instance of this class
269 * @param $compressorInstance A Compressor instance for compressing the content
270 * @return $packageInstance An instance of a Deliverable class
272 public static final function createNetworkPackage (Compressor $compressorInstance) {
274 $packageInstance = new NetworkPackage();
276 // Now set the compressor instance
277 $packageInstance->setCompressorInstance($compressorInstance);
280 * We need to initialize a stack here for our packages even for those
281 * which have no recipient address and stamp... ;-) This stacker will
282 * also be used for incoming raw data to handle it.
284 $stackInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
286 // At last, set it in this class
287 $packageInstance->setStackInstance($stackInstance);
290 $packageInstance->initStacks();
292 // Get a visitor instance for speeding up things and set it
293 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class');
294 $packageInstance->setVisitorInstance($visitorInstance);
296 // Get crypto instance and set it, too
297 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
298 $packageInstance->setCryptoInstance($cryptoInstance);
300 // Get a singleton package assembler instance from factory and set it here, too
301 $assemblerInstance = PackageAssemblerFactory::createAssemblerInstance($packageInstance);
302 $packageInstance->setAssemblerInstance($assemblerInstance);
305 $nodeInstance = NodeObjectFactory::createNodeInstance();
307 // Get pool instance from node
308 $poolInstance = $nodeInstance->getListenerPoolInstance();
311 $packageInstance->setListenerPoolInstance($poolInstance);
313 // Return the prepared instance
314 return $packageInstance;
318 * Initialize all stackers
320 * @param $forceReInit Whether to force reinitialization of all stacks
323 protected function initStacks ($forceReInit = FALSE) {
325 $this->getStackInstance()->initStacks(array(
326 self::STACKER_NAME_UNDECLARED,
327 self::STACKER_NAME_DECLARED,
328 self::STACKER_NAME_OUTGOING,
329 self::STACKER_NAME_DECODED_INCOMING,
330 self::STACKER_NAME_DECODED_HANDLED,
331 self::STACKER_NAME_DECODED_CHUNKED,
332 self::STACKER_NAME_NEW_MESSAGE,
333 self::STACKER_NAME_PROCESSED_MESSAGE,
334 self::STACKER_NAME_OUTGOING_STREAM
339 * Determines private key hash from given session id
341 * @param $sessionId Session id
342 * @return $hash Private key's hash
344 private function determineSenderPrivateKeyHash ($sessionId) {
346 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
348 // Ask DHT for session id
349 $senderData = $dhtInstance->findNodeLocalBySessionId($sessionId);
351 // Make sure the element 'private_key_hash' is there
352 assert(isset($senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH]));
355 //* DEBUG-DIE */ die('senderData=' . print_r($senderData, TRUE));
356 return $senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH];
360 * "Getter" for hash from given content
362 * @param $content Raw package content
363 * @return $hash Hash for given package content
365 private function getHashFromContent ($content) {
367 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
370 // @TODO md5() is very weak, but it needs to be fast
373 self::PACKAGE_CHECKSUM_SEPARATOR .
374 $this->getSessionId() .
375 self::PACKAGE_CHECKSUM_SEPARATOR .
376 $this->getCompressorInstance()->getCompressorExtension()
380 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',hash=' . $hash . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
387 * Checks whether the checksum (sometimes called "hash") is the same
389 * @param $decodedContent Package raw content
390 * @param $decodedData Whole raw package data array
391 * @return $isChecksumValid Whether the checksum is the same
393 private function isChecksumValid (array $decodedContent, array $decodedData) {
395 $checksum = $this->getHashFromContentSessionId($decodedContent, $decodedData[self::PACKAGE_DATA_SENDER]);
398 $isChecksumValid = ($checksum == $decodedContent[self::PACKAGE_CONTENT_CHECKSUM]);
401 return $isChecksumValid;
405 * Change the package with given status in given stack
407 * @param $packageData Raw package data in an array
408 * @param $stackerName Name of the stacker
409 * @param $newStatus New status to set
412 private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
413 // Skip this for empty stacks
414 if ($this->getStackInstance()->isStackEmpty($stackerName)) {
415 // This avoids an exception after all packages has failed
419 // Pop the entry (it should be it)
420 $nextData = $this->getStackInstance()->popNamed($stackerName);
422 // Compare both hashes
423 assert($nextData[self::PACKAGE_DATA_HASH] == $packageData[self::PACKAGE_DATA_HASH]);
425 // Temporary set the new status
426 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
429 $this->getStackInstance()->pushNamed($stackerName, $packageData);
433 * "Getter" for hash from given content and sender's session id
435 * @param $decodedContent Raw package content
436 * @param $sessionId Session id of the sender
437 * @return $hash Hash for given package content
439 public function getHashFromContentSessionId (array $decodedContent, $sessionId) {
441 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($decodedContent[self::PACKAGE_CONTENT_MESSAGE]) . ',sender=' . $sessionId . ',compressor=' . $decodedContent[self::PACKAGE_CONTENT_EXTENSION]);
444 // @TODO md5() is very weak, but it needs to be fast
446 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] .
447 self::PACKAGE_CHECKSUM_SEPARATOR .
449 self::PACKAGE_CHECKSUM_SEPARATOR .
450 $decodedContent[self::PACKAGE_CONTENT_EXTENSION]
457 ///////////////////////////////////////////////////////////////////////////
458 // Delivering packages / raw data
459 ///////////////////////////////////////////////////////////////////////////
462 * Declares the given raw package data by discovering recipients
464 * @param $packageData Raw package data in an array
467 private function declareRawPackageData (array $packageData) {
468 // Make sure the required field is there
469 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
472 * We need to disover every recipient, just in case we have a
473 * multi-recipient entry like 'upper' is. 'all' may be a not so good
474 * target because it causes an overload on the network and may be
475 * abused for attacking the network with large packages.
477 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
479 // Discover all recipients, this may throw an exception
480 $discoveryInstance->discoverRecipients($packageData);
482 // Now get an iterator
483 $iteratorInstance = $discoveryInstance->getIterator();
485 // Make sure the iterator instance is valid
486 assert($iteratorInstance instanceof Iterator);
488 // Rewind back to the beginning
489 $iteratorInstance->rewind();
491 // ... and begin iteration
492 while ($iteratorInstance->valid()) {
494 $currentRecipient = $iteratorInstance->current();
497 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Setting recipient to ' . $currentRecipient . ',previous=' . $packageData[self::PACKAGE_DATA_RECIPIENT]);
500 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
502 // Push the declared package to the next stack.
503 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
506 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package declared for recipient ' . $currentRecipient);
508 // Skip to next entry
509 $iteratorInstance->next();
513 * The recipient list can be cleaned up here because the package which
514 * shall be delivered has already been added for all entries from the
517 $discoveryInstance->clearRecipients();
521 * Delivers raw package data. In short, this will discover the raw socket
522 * resource through a discovery class (which will analyse the receipient of
523 * the package), register the socket with the connection (handler/helper?)
524 * instance and finally push the raw data on our outgoing queue.
526 * @param $packageData Raw package data in an array
529 private function deliverRawPackageData (array $packageData) {
531 * This package may become big, depending on the shared object size or
532 * delivered message size which shouldn't be so long (to save
533 * bandwidth). Because of the nature of the used protocol (TCP) we need
534 * to split it up into smaller pieces to fit it into a TCP frame.
536 * So first we need (again) a discovery class but now a protocol
537 * discovery to choose the right socket resource. The discovery class
538 * should take a look at the raw package data itself and then decide
539 * which (configurable!) protocol should be used for that type of
542 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
544 // Now discover the right protocol
545 $socketResource = $discoveryInstance->discoverSocket($packageData, BaseConnectionHelper::CONNECTION_TYPE_OUTGOING);
548 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
551 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: stateInstance=' . $helperInstance->getStateInstance());
552 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
554 // The socket needs to be put in a special registry that can handle such data
555 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
557 // Get the connection helper from registry
558 $helperInstance = Registry::getRegistry()->getInstance('connection');
560 // And make sure it is valid
561 assert($helperInstance instanceof ConnectionHelper);
563 // Get connection info class
564 $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($helperInstance->getProtocolName(), 'helper');
566 // Will the info instance with connection helper data
567 $infoInstance->fillWithConnectionHelperInformation($helperInstance);
570 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($infoInstance, $socketResource))) {
572 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Registering socket ' . $socketResource . ' ...');
575 $registryInstance->registerSocket($infoInstance, $socketResource, $packageData);
576 } elseif (!$helperInstance->getStateInstance()->isPeerStateConnected()) {
577 // Is not connected, then we cannot send
578 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Unexpected peer state ' . $helperInstance->getStateInstance()->__toString() . ' detected.');
580 // Shutdown the socket
581 $this->shutdownSocket($socketResource);
585 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
587 // Make sure the connection is up
588 $helperInstance->getStateInstance()->validatePeerStateConnected();
591 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
593 // Enqueue it again on the out-going queue, the connection is up and working at this point
594 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
597 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
601 * Sends waiting packages
603 * @param $packageData Raw package data
606 private function sendOutgoingRawPackageData (array $packageData) {
610 // Get the right connection instance
611 $infoInstance = SocketRegistryFactory::createSocketRegistryInstance()->getInfoInstanceFromPackageData($packageData);
613 // Test helper instance
614 assert($infoInstance instanceof ShareableInfo);
616 // Get helper instance
617 $helperInstance = $infoInstance->getHelperInstance();
619 // Some sanity-checks on the object
620 //* DEBUG-DIE: */ die('[' . __METHOD__ . ':' . __LINE__ . ']: p1=' . $infoInstance->getProtocolName() . ',p2=' . $helperInstance->getProtocolName() . ',infoInstance=' . print_r($infoInstance, TRUE));
621 assert($helperInstance instanceof ConnectionHelper);
622 assert($infoInstance->getProtocolName() == $helperInstance->getProtocolName());
624 // Is this connection still alive?
625 if ($helperInstance->isShuttedDown()) {
626 // This connection is shutting down
627 // @TODO We may want to do somthing more here?
631 // Sent out package data
632 $helperInstance->sendRawPackageData($packageData);
636 * Generates a secure hash for given raw package content and sender id
638 * @param $content Raw package data
639 * @param $senderId Sender id to generate a hash for
640 * @return $hash Hash as hex-encoded string
642 private function generatePackageHash ($content, $senderId) {
643 // Hash content and sender id together, use scrypt
644 $hash = Scrypt::hashScrypt($senderId . ':' . $content . ':' . $this->determineSenderPrivateKeyHash($senderId));
651 * Checks whether the hash of given package data is 'valid', here that
652 * means it is the same or not.
654 * @param $decodedArray An array with 'decoded' (explode() was mostly called) data
655 * @return $isHashValid Whether the hash is valid
656 * @todo Unfinished area, hashes are currently NOT fully supported
658 private function isPackageHashValid (array $decodedArray) {
660 $isHashValid = Scrypt::checkScrypt($decodedArray[self::INDEX_PACKAGE_SENDER] . ':' . $decodedArray[self::INDEX_PACKAGE_CONTENT] . ':' . $this->determineSenderPrivateKeyHash($decodedArray[self::INDEX_PACKAGE_SENDER]), $decodedArray[self::INDEX_PACKAGE_HASH]);
663 //* DEBUG-DIE: */ die(__METHOD__ . ': isHashValid=' . intval($isHashValid) . chr(10) . ',decodedArray=' . print_r($decodedArray, TRUE));
668 * "Enqueues" raw content into this delivery class by reading the raw content
669 * from given helper's template instance and pushing it on the 'undeclared'
672 * @param $helperInstance An instance of a HubHelper class
675 public function enqueueRawDataFromTemplate (HubHelper $helperInstance) {
677 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
679 // Get the raw content ...
680 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
681 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('content(' . strlen($content) . ')=' . $content);
683 // ... and compress it
684 $content = $this->getCompressorInstance()->compressStream($content);
686 // Add magic in front of it and hash behind it, including BASE64 encoding
687 $packageContent = sprintf(self::PACKAGE_MASK,
688 // 1.) Compressor's extension
689 $this->getCompressorInstance()->getCompressorExtension(),
691 self::PACKAGE_MASK_SEPARATOR,
692 // 2.) Raw package content, encoded with BASE64
693 base64_encode($content),
695 self::PACKAGE_MASK_SEPARATOR,
697 implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
699 self::PACKAGE_MASK_SEPARATOR,
701 $this->getHashFromContent($content)
705 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': Enqueueing package for recipientType=' . $helperInstance->getRecipientType() . ' ...');
707 // Now prepare the temporary array and push it on the 'undeclared' stack
708 $this->getStackInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
709 self::PACKAGE_DATA_SENDER => $this->getSessionId(),
710 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
711 self::PACKAGE_DATA_CONTENT => $packageContent,
712 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_NEW,
713 self::PACKAGE_DATA_HASH => $this->generatePackageHash($packageContent, $this->getSessionId())
717 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
721 * Checks whether a package has been enqueued for delivery.
723 * @return $isEnqueued Whether a package is enqueued
725 public function isPackageEnqueued () {
726 // Check whether the stacker is not empty
727 $isEnqueued = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
734 * Checks whether a package has been declared
736 * @return $isDeclared Whether a package is declared
738 public function isPackageDeclared () {
739 // Check whether the stacker is not empty
740 $isDeclared = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
747 * Checks whether a package should be sent out
749 * @return $isWaitingDelivery Whether a package is waiting for delivery
751 public function isPackageWaitingForDelivery () {
752 // Check whether the stacker is not empty
753 $isWaitingDelivery = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
756 return $isWaitingDelivery;
760 * Checks whether encoded (raw) data is pending
762 * @return $isPending Whether encoded data is pending
764 public function isEncodedDataPending () {
765 // Check whether the stacker is not empty
766 $isPending = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
773 * Delivers an enqueued package to the stated destination. If a non-session
774 * id is provided, recipient resolver is being asked (and instanced once).
775 * This allows that a single package is being delivered to multiple targets
776 * without enqueueing it for every target. If no target is provided or it
777 * can't be determined a NoTargetException is being thrown.
780 * @throws NoTargetException If no target can't be determined
782 public function declareEnqueuedPackage () {
784 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
786 // Make sure this method isn't working if there is no package enqueued
787 if (!$this->isPackageEnqueued()) {
788 // This is not fatal but should be avoided
789 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw package data waiting declaration, but ' . __METHOD__ . ' has been called!');
794 * Now there are for sure packages to deliver, so start with the first
797 $packageData = $this->getStackInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
799 // Declare the raw package data for delivery
800 $this->declareRawPackageData($packageData);
803 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
807 * Delivers the next declared package. Only one package per time will be sent
808 * because this may take time and slows down the whole delivery
813 public function processDeclaredPackage () {
815 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
817 // Sanity check if we have packages declared
818 if (!$this->isPackageDeclared()) {
819 // This is not fatal but should be avoided
820 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package has been declared, but ' . __METHOD__ . ' has been called!');
825 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
828 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
830 // Try to deliver the package
832 // And try to send it
833 $this->deliverRawPackageData($packageData);
835 // And remove it finally
836 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
837 } catch (InvalidStateException $e) {
838 // The state is not excepected (shall be 'connected')
839 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
841 // Mark the package with status failed
842 $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
846 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
850 * Sends waiting packages out for delivery
854 public function sendWaitingPackage () {
856 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
858 // Sanity check if we have packages waiting for delivery
859 if (!$this->isPackageWaitingForDelivery()) {
860 // This is not fatal but should be avoided
861 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
866 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_OUTGOING);
869 // Now try to send it
870 $this->sendOutgoingRawPackageData($packageData);
872 // And remove it finally
873 $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING);
874 } catch (InvalidSocketException $e) {
875 // Output exception message
876 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package was not delivered: ' . $e->getMessage());
878 // Mark package as failed
879 $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
883 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
887 * Sends out encoded data to a socket
891 public function sendEncodedData () {
893 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
895 // Make sure there is pending encoded data
896 assert($this->isEncodedDataPending());
898 // Pop current data from stack
899 $encodedDataArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
901 // Init in this round sent bytes
905 assert(is_resource($encodedDataArray[self::RAW_SOCKET_INDEX]));
908 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sending out ' . strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) . ' bytes,rawBufferSize=' . $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] . ',diff=' . $encodedDataArray[self::RAW_DIFF_INDEX]);
909 if ($encodedDataArray[self::RAW_DIFF_INDEX] >= 0) {
910 // Send all out (encodedData is smaller than or equal buffer size)
911 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: MD5=' . md5(substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], 0, ($encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - $encodedDataArray[self::RAW_DIFF_INDEX]))));
912 $sentBytes = @socket_write($encodedDataArray[self::RAW_SOCKET_INDEX], $encodedDataArray[self::RAW_ENCODED_DATA_INDEX], ($encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - $encodedDataArray[self::RAW_DIFF_INDEX]));
914 // Send buffer size out
915 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: MD5=' . md5(substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], 0, $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX])));
916 $sentBytes = @socket_write($encodedDataArray[self::RAW_SOCKET_INDEX], $encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX]);
919 // If there was an error, we don't continue here
920 if ($sentBytes === FALSE) {
921 // Handle the error with a faked recipientData array
922 $this->handleSocketError(__METHOD__, __LINE__, $encodedDataArray[self::RAW_SOCKET_INDEX], array('0.0.0.0', '0'));
925 throw new InvalidSocketException(array($this, $encodedDataArray[self::RAW_SOCKET_INDEX], $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
926 } elseif (($sentBytes === 0) && (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) > 0)) {
927 // Nothing sent means we are done
928 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
931 // The difference between sent bytes and length of raw data should not go below zero
932 assert((strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) - $sentBytes) >= 0);
934 // Add total sent bytes
935 $encodedDataArray[self::RAW_SENT_BYTES_INDEX] += $sentBytes;
937 // Cut out the last unsent bytes
938 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) . ' bytes ...');
939 $encodedDataArray[self::RAW_ENCODED_DATA_INDEX] = substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $sentBytes);
941 // Calculate difference again
942 $encodedDataArray[self::RAW_DIFF_INDEX] = $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]);
945 if (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) <= 0) {
946 // Abort here, all sent!
947 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
952 // Push array back in stack
953 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
956 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
959 ///////////////////////////////////////////////////////////////////////////
960 // Receiving packages / raw data
961 ///////////////////////////////////////////////////////////////////////////
964 * Checks whether decoded raw data is pending
966 * @return $isPending Whether decoded raw data is pending
968 private function isRawDataPending () {
969 // Just return whether the stack is not empty
970 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
977 * Checks whether new raw package data has arrived at a socket
979 * @return $hasArrived Whether new raw package data has arrived for processing
981 public function isNewRawDataPending () {
982 // Visit the pool. This monitors the pool for incoming raw data.
983 $this->getListenerPoolInstance()->accept($this->getVisitorInstance());
985 // Check for new data arrival
986 $hasArrived = $this->isRawDataPending();
993 * Handles the incoming decoded raw data. This method does not "convert" the
994 * decoded data back into a package array, it just "handles" it and pushs it
999 public function handleIncomingDecodedData () {
1001 * This method should only be called if decoded raw data is pending,
1002 * so check it again.
1004 if (!$this->isRawDataPending()) {
1005 // This is not fatal but should be avoided
1006 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw (decoded?) data is pending, but ' . __METHOD__ . ' has been called!');
1010 // Very noisy debug message:
1011 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
1013 // "Pop" the next entry (the same array again) from the stack
1014 $decodedData = $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
1016 // Make sure both array elements are there
1018 (is_array($decodedData)) &&
1019 (isset($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1020 (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1024 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
1025 * only want to handle unhandled packages here.
1027 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
1028 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
1030 // Remove the last chunk SEPARATOR (because there is no need for it)
1031 if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
1032 // It is there and should be removed
1033 $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
1036 // This package is "handled" and can be pushed on the next stack
1037 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Pushing ' . strlen($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA]) . ' bytes to stack ' . self::STACKER_NAME_DECODED_HANDLED . ' ...');
1038 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
1042 * Adds raw decoded data from the given handler instance to this receiver
1044 * @param $handlerInstance An instance of a Networkable class
1047 public function addRawDataToIncomingStack (Networkable $handlerInstance) {
1049 * Get the decoded data from the handler, this is an array with
1050 * 'raw_data' and 'error_code' as elements.
1052 $decodedData = $handlerInstance->getNextRawData();
1054 // Very noisy debug message:
1055 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, TRUE));
1057 // And push it on our stack
1058 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
1062 * Checks whether incoming decoded data is handled.
1064 * @return $isHandled Whether incoming decoded data is handled
1066 public function isIncomingRawDataHandled () {
1067 // Determine if the stack is not empty
1068 $isHandled = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
1075 * Checks whether the assembler has pending data left
1077 * @return $isHandled Whether the assembler has pending data left
1079 public function ifAssemblerHasPendingDataLeft () {
1080 // Determine if the stack is not empty
1081 $isHandled = (!$this->getAssemblerInstance()->isPendingDataEmpty());
1088 * Checks whether the assembler has multiple packages pending
1090 * @return $isPending Whether the assembler has multiple packages pending
1092 public function ifMultipleMessagesPending () {
1093 // Determine if the stack is not empty
1094 $isPending = ($this->getAssemblerInstance()->ifMultipleMessagesPending());
1101 * Handles the attached assemler's pending data queue to be finally
1102 * assembled to the raw package data back.
1106 public function handleAssemblerPendingData () {
1108 $this->getAssemblerInstance()->handlePendingData();
1112 * Handles multiple messages.
1116 public function handleMultipleMessages () {
1118 $this->getAssemblerInstance()->handleMultipleMessages();
1122 * Assembles incoming decoded data so it will become an abstract network
1123 * package again. The assembler does later do it's job by an other task,
1124 * not this one to keep best speed possible.
1128 public function assembleDecodedDataToPackage () {
1129 // Make sure the raw decoded package data is handled
1130 assert($this->isIncomingRawDataHandled());
1132 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
1133 $packageContent = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
1135 // Assert on some elements
1137 (is_array($packageContent)) &&
1138 (isset($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1139 (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1142 // Start assembling the raw package data array by chunking it
1143 $this->getAssemblerInstance()->chunkPackageContent($packageContent);
1145 // Remove the package from 'handled_decoded' stack ...
1146 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
1148 // ... and push it on the 'chunked' stacker
1149 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Pushing ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]) . ' bytes on stack ' . self::STACKER_NAME_DECODED_CHUNKED . ',packageContent=' . print_r($packageContent, TRUE));
1150 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
1154 * Accepts the visitor to process the visit "request"
1156 * @param $visitorInstance An instance of a Visitor class
1159 public function accept (Visitor $visitorInstance) {
1161 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - CALLED!');
1163 // Visit the package
1164 $visitorInstance->visitNetworkPackage($this);
1166 // Then visit the assembler to handle multiple packages
1167 $this->getAssemblerInstance()->accept($visitorInstance);
1170 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - EXIT!');
1178 public function clearAllStacks () {
1179 // Call the init method to force re-initialization
1180 $this->initStacks(TRUE);
1183 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: All stacker have been re-initialized.');
1187 * Removes the first failed outoging package from the stack to continue
1188 * with next one (it will never work until the issue is fixed by you).
1191 * @throws UnexpectedPackageStatusException If the package status is not 'failed'
1192 * @todo This may be enchanced for outgoing packages?
1194 public function removeFirstFailedPackage () {
1195 // Get the package again
1196 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
1198 // Is the package status 'failed'?
1199 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
1201 throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
1204 // Remove this entry
1205 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
1209 * "Decode" the package content into the same array when it was sent.
1211 * @param $rawPackageContent The raw package content to be "decoded"
1212 * @return $decodedData An array with 'sender', 'recipient', 'content' and 'status' elements
1214 public function decodeRawContent ($rawPackageContent) {
1215 // Use the separator '#' to "decode" it
1216 $decodedArray = explode(self::PACKAGE_DATA_SEPARATOR, $rawPackageContent);
1218 // Assert on count (should be always 3)
1219 assert(count($decodedArray) == self::DECODED_DATA_ARRAY_SIZE);
1221 // Generate the hash of comparing it
1222 if (!$this->isPackageHashValid($decodedArray)) {
1223 // Is not valid, so throw an exception here
1224 exit(__METHOD__ . ':INVALID HASH! UNDER CONSTRUCTION!' . chr(10));
1228 * Create 'decodedData' array with all assoziative array elements.
1230 $decodedData = array(
1231 self::PACKAGE_DATA_SENDER => $decodedArray[self::INDEX_PACKAGE_SENDER],
1232 self::PACKAGE_DATA_RECIPIENT => $decodedArray[self::INDEX_PACKAGE_RECIPIENT],
1233 self::PACKAGE_DATA_CONTENT => $decodedArray[self::INDEX_PACKAGE_CONTENT],
1234 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_DECODED,
1235 self::PACKAGE_DATA_HASH => $decodedArray[self::INDEX_PACKAGE_HASH]
1239 return $decodedData;
1243 * Handles decoded data for this node by "decoding" the 'content' part of
1244 * it. Again this method uses explode() for the "decoding" process.
1246 * @param $decodedData An array with decoded raw package data
1248 * @throws InvalidDataChecksumException If the checksum doesn't match
1250 public function handleRawData (array $decodedData) {
1252 * "Decode" the package's content by a simple explode() call, for
1253 * details of the array elements, see comments for constant
1256 $decodedContent = explode(self::PACKAGE_MASK_SEPARATOR, $decodedData[self::PACKAGE_DATA_CONTENT]);
1258 // Assert on array count for a very basic validation
1259 assert(count($decodedContent) == self::PACKAGE_CONTENT_ARRAY_SIZE);
1262 * Convert the indexed array into an associative array. This is much
1263 * better to remember than plain numbers, isn't it?
1265 $decodedContent = array(
1266 // Compressor's extension used to compress the data
1267 self::PACKAGE_CONTENT_EXTENSION => $decodedContent[self::INDEX_COMPRESSOR_EXTENSION],
1268 // Package data (aka "message") in BASE64-decoded form but still compressed
1269 self::PACKAGE_CONTENT_MESSAGE => base64_decode($decodedContent[self::INDEX_PACKAGE_DATA]),
1270 // Tags as an indexed array for "tagging" the message
1271 self::PACKAGE_CONTENT_TAGS => explode(self::PACKAGE_TAGS_SEPARATOR, $decodedContent[self::INDEX_TAGS]),
1272 // Checksum of the _decoded_ data
1273 self::PACKAGE_CONTENT_CHECKSUM => $decodedContent[self::INDEX_CHECKSUM],
1275 self::PACKAGE_CONTENT_SENDER => $decodedData[self::PACKAGE_DATA_SENDER],
1276 // Hash from decoded raw data
1277 self::PACKAGE_CONTENT_HASH => $decodedData[self::PACKAGE_DATA_HASH]
1280 // Is the checksum valid?
1281 if (!$this->isChecksumValid($decodedContent, $decodedData)) {
1282 // Is not the same, so throw an exception here
1283 throw new InvalidDataChecksumException(array($this, $decodedContent, $decodedData), BaseListener::EXCEPTION_INVALID_DATA_CHECKSUM);
1287 * The checksum is the same, then it can be decompressed safely. The
1288 * original message is at this point fully decoded.
1290 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
1292 // And push it on the next stack
1293 $this->getStackInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
1297 * Checks whether a new message has arrived
1299 * @return $hasArrived Whether a new message has arrived for processing
1301 public function isNewMessageArrived () {
1302 // Determine if the stack is not empty
1303 $hasArrived = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
1310 * Handles newly arrived messages
1313 * @todo Implement verification of all sent tags here?
1315 public function handleNewlyArrivedMessage () {
1316 // Get it from the stacker, it is the full array with the decoded message
1317 $decodedContent = $this->getStackInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
1319 // Now get a filter chain back from factory with given tags array
1320 $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
1323 * Process the message through all filters, note that all other
1324 * elements from $decodedContent are no longer needed.
1326 $chainInstance->processMessage($decodedContent, $this);
1330 * Checks whether a processed message is pending for "interpretation"
1332 * @return $isPending Whether a processed message is pending
1334 public function isProcessedMessagePending () {
1336 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
1343 * Handle processed messages by "interpreting" the 'message_type' element
1347 public function handleProcessedMessage () {
1348 // Get it from the stacker, it is the full array with the processed message
1349 $messageArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
1351 // Add type for later easier handling
1352 $messageArray[self::MESSAGE_ARRAY_DATA][self::MESSAGE_ARRAY_TYPE] = $messageArray[self::MESSAGE_ARRAY_TYPE];
1355 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: messageArray=' . print_r($messageArray, TRUE));
1357 // Create a handler instance from given message type
1358 $handlerInstance = MessageTypeHandlerFactory::createMessageTypeHandlerInstance($messageArray[self::MESSAGE_ARRAY_TYPE]);
1360 // Handle message data
1361 $handlerInstance->handleMessageData($messageArray[self::MESSAGE_ARRAY_DATA], $this);
1365 * Feeds the hash and sender (as recipient for the 'sender' reward) to the
1366 * miner's queue, unless the message is not a "reward claim" message as this
1367 * leads to an endless loop. You may wish to run the miner to get some
1368 * reward ("HubCoins") for "mining" this hash.
1370 * @param $decodedDataArray Array with decoded message
1374 public function feedHashToMiner (array $decodedDataArray) {
1375 // Make sure the required elements are there
1376 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_SENDER]));
1377 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_HASH]));
1378 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_TAGS]));
1380 // Resolve session id ('sender' is a session id) into node id
1381 $nodeId = HubTools::resolveNodeIdBySessionId($decodedDataArray[self::PACKAGE_CONTENT_SENDER]);
1383 // Is 'claim_reward' the message type?
1384 if (in_array('claim_reward', $decodedDataArray[self::PACKAGE_CONTENT_TAGS])) {
1386 * Then don't feed this message to the miner as this causes and
1387 * endless loop of mining.
1392 $this->partialStub('@TODO nodeId=' . $nodeId . ',decodedDataArray=' . print_r($decodedDataArray, TRUE));