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 $decodedData Array with decoded data
342 * @return $hash Private key's hash
344 private function determineSenderPrivateKeyHash (array $decodedData) {
346 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
348 // Ask DHT for session id
349 $senderData = $dhtInstance->findNodeLocalBySessionId($decodedData[self::INDEX_PACKAGE_SENDER]);
351 // Is an entry found?
352 if (count($senderData) > 0) {
353 // Make sure the element 'private_key_hash' is there
354 /* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: senderData=' . print_r($senderData, TRUE));
355 assert(isset($senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH]));
358 return $senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH];
361 // Make sure the requested element is there
362 // @TODO Wrong hash!!!!
363 /* DEBUG-DIE */ die('decodedData=' . print_r($decodedData, TRUE));
364 assert(isset($decodedData[self::INDEX_PACKAGE_HASH]));
366 // There is no DHT entry so, accept the hash from decoded data
367 return $decodedData[self::INDEX_PACKAGE_HASH];
371 * "Getter" for hash from given content
373 * @param $content Raw package content
374 * @return $hash Hash for given package content
376 private function getHashFromContent ($content) {
378 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
381 // @TODO md5() is very weak, but it needs to be fast
384 self::PACKAGE_CHECKSUM_SEPARATOR .
385 $this->getSessionId() .
386 self::PACKAGE_CHECKSUM_SEPARATOR .
387 $this->getCompressorInstance()->getCompressorExtension()
391 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',hash=' . $hash . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
398 * Checks whether the checksum (sometimes called "hash") is the same
400 * @param $decodedContent Package raw content
401 * @param $decodedData Whole raw package data array
402 * @return $isChecksumValid Whether the checksum is the same
404 private function isChecksumValid (array $decodedContent, array $decodedData) {
406 $checksum = $this->getHashFromContentSessionId($decodedContent, $decodedData[self::PACKAGE_DATA_SENDER]);
409 $isChecksumValid = ($checksum == $decodedContent[self::PACKAGE_CONTENT_CHECKSUM]);
412 return $isChecksumValid;
416 * Change the package with given status in given stack
418 * @param $packageData Raw package data in an array
419 * @param $stackerName Name of the stacker
420 * @param $newStatus New status to set
423 private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
424 // Skip this for empty stacks
425 if ($this->getStackInstance()->isStackEmpty($stackerName)) {
426 // This avoids an exception after all packages has failed
430 // Pop the entry (it should be it)
431 $nextData = $this->getStackInstance()->popNamed($stackerName);
433 // Compare both hashes
434 assert($nextData[self::PACKAGE_DATA_HASH] == $packageData[self::PACKAGE_DATA_HASH]);
436 // Temporary set the new status
437 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
440 $this->getStackInstance()->pushNamed($stackerName, $packageData);
444 * "Getter" for hash from given content and sender's session id
446 * @param $decodedContent Raw package content
447 * @param $sessionId Session id of the sender
448 * @return $hash Hash for given package content
450 public function getHashFromContentSessionId (array $decodedContent, $sessionId) {
452 //* 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]);
455 // @TODO md5() is very weak, but it needs to be fast
457 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] .
458 self::PACKAGE_CHECKSUM_SEPARATOR .
460 self::PACKAGE_CHECKSUM_SEPARATOR .
461 $decodedContent[self::PACKAGE_CONTENT_EXTENSION]
468 ///////////////////////////////////////////////////////////////////////////
469 // Delivering packages / raw data
470 ///////////////////////////////////////////////////////////////////////////
473 * Declares the given raw package data by discovering recipients
475 * @param $packageData Raw package data in an array
478 private function declareRawPackageData (array $packageData) {
479 // Make sure the required field is there
480 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
483 * We need to disover every recipient, just in case we have a
484 * multi-recipient entry like 'upper' is. 'all' may be a not so good
485 * target because it causes an overload on the network and may be
486 * abused for attacking the network with large packages.
488 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
490 // Discover all recipients, this may throw an exception
491 $discoveryInstance->discoverRecipients($packageData);
493 // Now get an iterator
494 $iteratorInstance = $discoveryInstance->getIterator();
496 // Make sure the iterator instance is valid
497 assert($iteratorInstance instanceof Iterator);
499 // Rewind back to the beginning
500 $iteratorInstance->rewind();
502 // ... and begin iteration
503 while ($iteratorInstance->valid()) {
505 $currentRecipient = $iteratorInstance->current();
508 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Setting recipient to ' . $currentRecipient . ',previous=' . $packageData[self::PACKAGE_DATA_RECIPIENT]);
511 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
513 // Push the declared package to the next stack.
514 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
517 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package declared for recipient ' . $currentRecipient);
519 // Skip to next entry
520 $iteratorInstance->next();
524 * The recipient list can be cleaned up here because the package which
525 * shall be delivered has already been added for all entries from the
528 $discoveryInstance->clearRecipients();
532 * Delivers raw package data. In short, this will discover the raw socket
533 * resource through a discovery class (which will analyse the receipient of
534 * the package), register the socket with the connection (handler/helper?)
535 * instance and finally push the raw data on our outgoing queue.
537 * @param $packageData Raw package data in an array
540 private function deliverRawPackageData (array $packageData) {
542 * This package may become big, depending on the shared object size or
543 * delivered message size which shouldn't be so long (to save
544 * bandwidth). Because of the nature of the used protocol (TCP) we need
545 * to split it up into smaller pieces to fit it into a TCP frame.
547 * So first we need (again) a discovery class but now a protocol
548 * discovery to choose the right socket resource. The discovery class
549 * should take a look at the raw package data itself and then decide
550 * which (configurable!) protocol should be used for that type of
553 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
555 // Now discover the right protocol
556 $socketResource = $discoveryInstance->discoverSocket($packageData, BaseConnectionHelper::CONNECTION_TYPE_OUTGOING);
559 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
562 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: stateInstance=' . $helperInstance->getStateInstance());
563 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
565 // The socket needs to be put in a special registry that can handle such data
566 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
568 // Get the connection helper from registry
569 $helperInstance = Registry::getRegistry()->getInstance('connection');
571 // And make sure it is valid
572 assert($helperInstance instanceof ConnectionHelper);
574 // Get connection info class
575 $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($helperInstance->getProtocolName(), 'helper');
577 // Will the info instance with connection helper data
578 $infoInstance->fillWithConnectionHelperInformation($helperInstance);
581 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($infoInstance, $socketResource))) {
583 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Registering socket ' . $socketResource . ' ...');
586 $registryInstance->registerSocket($infoInstance, $socketResource, $packageData);
587 } elseif (!$helperInstance->getStateInstance()->isPeerStateConnected()) {
588 // Is not connected, then we cannot send
589 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Unexpected peer state ' . $helperInstance->getStateInstance()->__toString() . ' detected.');
591 // Shutdown the socket
592 $this->shutdownSocket($socketResource);
596 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
598 // Make sure the connection is up
599 $helperInstance->getStateInstance()->validatePeerStateConnected();
602 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
604 // Enqueue it again on the out-going queue, the connection is up and working at this point
605 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
608 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
612 * Sends waiting packages
614 * @param $packageData Raw package data
617 private function sendOutgoingRawPackageData (array $packageData) {
621 // Get the right connection instance
622 $infoInstance = SocketRegistryFactory::createSocketRegistryInstance()->getInfoInstanceFromPackageData($packageData);
624 // Test helper instance
625 assert($infoInstance instanceof ShareableInfo);
627 // Get helper instance
628 $helperInstance = $infoInstance->getHelperInstance();
630 // Some sanity-checks on the object
631 //* DEBUG-DIE: */ die('[' . __METHOD__ . ':' . __LINE__ . ']: p1=' . $infoInstance->getProtocolName() . ',p2=' . $helperInstance->getProtocolName() . ',infoInstance=' . print_r($infoInstance, TRUE));
632 assert($helperInstance instanceof ConnectionHelper);
633 assert($infoInstance->getProtocolName() == $helperInstance->getProtocolName());
635 // Is this connection still alive?
636 if ($helperInstance->isShuttedDown()) {
637 // This connection is shutting down
638 // @TODO We may want to do somthing more here?
642 // Sent out package data
643 $helperInstance->sendRawPackageData($packageData);
647 * Generates a secure hash for given raw package content and sender id
649 * @param $content Raw package data
650 * @param $senderId Sender id to generate a hash for
651 * @return $hash Hash as hex-encoded string
653 private function generatePackageHash ($content, $senderId) {
656 self::INDEX_PACKAGE_SENDER => $senderId,
657 self::INDEX_PACKAGE_CONTENT => $content,
658 self::INDEX_PACKAGE_HASH => ''
661 // Hash content and sender id together, use scrypt
662 $hash = Scrypt::hashScrypt($senderId . ':' . $content . ':' . $this->determineSenderPrivateKeyHash($data));
669 * Checks whether the hash of given package data is 'valid', here that
670 * means it is the same or not.
672 * @param $decodedArray An array with 'decoded' (explode() was mostly called) data
673 * @return $isHashValid Whether the hash is valid
674 * @todo Unfinished area, hashes are currently NOT fully supported
676 private function isPackageHashValid (array $decodedArray) {
678 //* DEBUG-DIE: */ die(__METHOD__ . ': decodedArray=' . print_r($decodedArray, TRUE));
679 $isHashValid = Scrypt::checkScrypt($decodedArray[self::INDEX_PACKAGE_SENDER] . ':' . $decodedArray[self::INDEX_PACKAGE_CONTENT] . ':' . $this->determineSenderPrivateKeyHash($decodedArray), $decodedArray[self::INDEX_PACKAGE_HASH]);
682 //* DEBUG-DIE: */ die(__METHOD__ . ': isHashValid=' . intval($isHashValid) . ',decodedArray=' . print_r($decodedArray, TRUE));
687 * "Enqueues" raw content into this delivery class by reading the raw content
688 * from given helper's template instance and pushing it on the 'undeclared'
691 * @param $helperInstance An instance of a HubHelper class
694 public function enqueueRawDataFromTemplate (HubHelper $helperInstance) {
696 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
698 // Get the raw content ...
699 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
700 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('content(' . strlen($content) . ')=' . $content);
702 // ... and compress it
703 $content = $this->getCompressorInstance()->compressStream($content);
705 // Add magic in front of it and hash behind it, including BASE64 encoding
706 $packageContent = sprintf(self::PACKAGE_MASK,
707 // 1.) Compressor's extension
708 $this->getCompressorInstance()->getCompressorExtension(),
710 self::PACKAGE_MASK_SEPARATOR,
711 // 2.) Raw package content, encoded with BASE64
712 base64_encode($content),
714 self::PACKAGE_MASK_SEPARATOR,
716 implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
718 self::PACKAGE_MASK_SEPARATOR,
720 $this->getHashFromContent($content)
724 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': Enqueueing package for recipientType=' . $helperInstance->getRecipientType() . ' ...');
726 // Now prepare the temporary array and push it on the 'undeclared' stack
727 $this->getStackInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
728 self::PACKAGE_DATA_SENDER => $this->getSessionId(),
729 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
730 self::PACKAGE_DATA_CONTENT => $packageContent,
731 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_NEW,
732 self::PACKAGE_DATA_HASH => $this->generatePackageHash($packageContent, $this->getSessionId())
736 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
740 * Checks whether a package has been enqueued for delivery.
742 * @return $isEnqueued Whether a package is enqueued
744 public function isPackageEnqueued () {
745 // Check whether the stacker is not empty
746 $isEnqueued = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
753 * Checks whether a package has been declared
755 * @return $isDeclared Whether a package is declared
757 public function isPackageDeclared () {
758 // Check whether the stacker is not empty
759 $isDeclared = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
766 * Checks whether a package should be sent out
768 * @return $isWaitingDelivery Whether a package is waiting for delivery
770 public function isPackageWaitingForDelivery () {
771 // Check whether the stacker is not empty
772 $isWaitingDelivery = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
775 return $isWaitingDelivery;
779 * Checks whether encoded (raw) data is pending
781 * @return $isPending Whether encoded data is pending
783 public function isEncodedDataPending () {
784 // Check whether the stacker is not empty
785 $isPending = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
792 * Delivers an enqueued package to the stated destination. If a non-session
793 * id is provided, recipient resolver is being asked (and instanced once).
794 * This allows that a single package is being delivered to multiple targets
795 * without enqueueing it for every target. If no target is provided or it
796 * can't be determined a NoTargetException is being thrown.
799 * @throws NoTargetException If no target can't be determined
801 public function declareEnqueuedPackage () {
803 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
805 // Make sure this method isn't working if there is no package enqueued
806 if (!$this->isPackageEnqueued()) {
807 // This is not fatal but should be avoided
808 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw package data waiting declaration, but ' . __METHOD__ . ' has been called!');
813 * Now there are for sure packages to deliver, so start with the first
816 $packageData = $this->getStackInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
818 // Declare the raw package data for delivery
819 $this->declareRawPackageData($packageData);
822 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
826 * Delivers the next declared package. Only one package per time will be sent
827 * because this may take time and slows down the whole delivery
832 public function processDeclaredPackage () {
834 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
836 // Sanity check if we have packages declared
837 if (!$this->isPackageDeclared()) {
838 // This is not fatal but should be avoided
839 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package has been declared, but ' . __METHOD__ . ' has been called!');
844 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
847 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
849 // Try to deliver the package
851 // And try to send it
852 $this->deliverRawPackageData($packageData);
854 // And remove it finally
855 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
856 } catch (InvalidStateException $e) {
857 // The state is not excepected (shall be 'connected')
858 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
860 // Mark the package with status failed
861 $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
865 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
869 * Sends waiting packages out for delivery
873 public function sendWaitingPackage () {
875 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
877 // Sanity check if we have packages waiting for delivery
878 if (!$this->isPackageWaitingForDelivery()) {
879 // This is not fatal but should be avoided
880 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
885 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_OUTGOING);
888 // Now try to send it
889 $this->sendOutgoingRawPackageData($packageData);
891 // And remove it finally
892 $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING);
893 } catch (InvalidSocketException $e) {
894 // Output exception message
895 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package was not delivered: ' . $e->getMessage());
897 // Mark package as failed
898 $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
902 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
906 * Sends out encoded data to a socket
910 public function sendEncodedData () {
912 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
914 // Make sure there is pending encoded data
915 assert($this->isEncodedDataPending());
917 // Pop current data from stack
918 $encodedDataArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
920 // Init in this round sent bytes
924 assert(is_resource($encodedDataArray[self::RAW_SOCKET_INDEX]));
927 //* 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]);
928 if ($encodedDataArray[self::RAW_DIFF_INDEX] >= 0) {
929 // Send all out (encodedData is smaller than or equal buffer size)
930 //* 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]))));
931 $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]));
933 // Send buffer size out
934 //* 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])));
935 $sentBytes = @socket_write($encodedDataArray[self::RAW_SOCKET_INDEX], $encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX]);
938 // If there was an error, we don't continue here
939 if ($sentBytes === FALSE) {
940 // Handle the error with a faked recipientData array
941 $this->handleSocketError(__METHOD__, __LINE__, $encodedDataArray[self::RAW_SOCKET_INDEX], array('0.0.0.0', '0'));
944 throw new InvalidSocketException(array($this, $encodedDataArray[self::RAW_SOCKET_INDEX], $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
945 } elseif (($sentBytes === 0) && (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) > 0)) {
946 // Nothing sent means we are done
947 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
950 // The difference between sent bytes and length of raw data should not go below zero
951 assert((strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) - $sentBytes) >= 0);
953 // Add total sent bytes
954 $encodedDataArray[self::RAW_SENT_BYTES_INDEX] += $sentBytes;
956 // Cut out the last unsent bytes
957 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) . ' bytes ...');
958 $encodedDataArray[self::RAW_ENCODED_DATA_INDEX] = substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $sentBytes);
960 // Calculate difference again
961 $encodedDataArray[self::RAW_DIFF_INDEX] = $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]);
964 if (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) <= 0) {
965 // Abort here, all sent!
966 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
971 // Push array back in stack
972 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
975 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
978 ///////////////////////////////////////////////////////////////////////////
979 // Receiving packages / raw data
980 ///////////////////////////////////////////////////////////////////////////
983 * Checks whether decoded raw data is pending
985 * @return $isPending Whether decoded raw data is pending
987 private function isRawDataPending () {
988 // Just return whether the stack is not empty
989 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
996 * Checks whether new raw package data has arrived at a socket
998 * @return $hasArrived Whether new raw package data has arrived for processing
1000 public function isNewRawDataPending () {
1001 // Visit the pool. This monitors the pool for incoming raw data.
1002 $this->getListenerPoolInstance()->accept($this->getVisitorInstance());
1004 // Check for new data arrival
1005 $hasArrived = $this->isRawDataPending();
1007 // Return the status
1012 * Handles the incoming decoded raw data. This method does not "convert" the
1013 * decoded data back into a package array, it just "handles" it and pushs it
1014 * on the next stack.
1018 public function handleIncomingDecodedData () {
1020 * This method should only be called if decoded raw data is pending,
1021 * so check it again.
1023 if (!$this->isRawDataPending()) {
1024 // This is not fatal but should be avoided
1025 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw (decoded?) data is pending, but ' . __METHOD__ . ' has been called!');
1029 // Very noisy debug message:
1030 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
1032 // "Pop" the next entry (the same array again) from the stack
1033 $decodedData = $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
1035 // Make sure both array elements are there
1037 (is_array($decodedData)) &&
1038 (isset($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1039 (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1043 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
1044 * only want to handle unhandled packages here.
1046 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
1047 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
1049 // Remove the last chunk SEPARATOR (because there is no need for it)
1050 if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
1051 // It is there and should be removed
1052 $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
1055 // This package is "handled" and can be pushed on the next stack
1056 //* 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 . ' ...');
1057 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
1061 * Adds raw decoded data from the given handler instance to this receiver
1063 * @param $handlerInstance An instance of a Networkable class
1066 public function addRawDataToIncomingStack (Networkable $handlerInstance) {
1068 * Get the decoded data from the handler, this is an array with
1069 * 'raw_data' and 'error_code' as elements.
1071 $decodedData = $handlerInstance->getNextRawData();
1073 // Very noisy debug message:
1074 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, TRUE));
1076 // And push it on our stack
1077 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
1081 * Checks whether incoming decoded data is handled.
1083 * @return $isHandled Whether incoming decoded data is handled
1085 public function isIncomingRawDataHandled () {
1086 // Determine if the stack is not empty
1087 $isHandled = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
1094 * Checks whether the assembler has pending data left
1096 * @return $isHandled Whether the assembler has pending data left
1098 public function ifAssemblerHasPendingDataLeft () {
1099 // Determine if the stack is not empty
1100 $isHandled = (!$this->getAssemblerInstance()->isPendingDataEmpty());
1107 * Checks whether the assembler has multiple packages pending
1109 * @return $isPending Whether the assembler has multiple packages pending
1111 public function ifMultipleMessagesPending () {
1112 // Determine if the stack is not empty
1113 $isPending = ($this->getAssemblerInstance()->ifMultipleMessagesPending());
1120 * Handles the attached assemler's pending data queue to be finally
1121 * assembled to the raw package data back.
1125 public function handleAssemblerPendingData () {
1127 $this->getAssemblerInstance()->handlePendingData();
1131 * Handles multiple messages.
1135 public function handleMultipleMessages () {
1137 $this->getAssemblerInstance()->handleMultipleMessages();
1141 * Assembles incoming decoded data so it will become an abstract network
1142 * package again. The assembler does later do it's job by an other task,
1143 * not this one to keep best speed possible.
1147 public function assembleDecodedDataToPackage () {
1148 // Make sure the raw decoded package data is handled
1149 assert($this->isIncomingRawDataHandled());
1151 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
1152 $packageContent = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
1154 // Assert on some elements
1156 (is_array($packageContent)) &&
1157 (isset($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1158 (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1161 // Start assembling the raw package data array by chunking it
1162 $this->getAssemblerInstance()->chunkPackageContent($packageContent);
1164 // Remove the package from 'handled_decoded' stack ...
1165 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
1167 // ... and push it on the 'chunked' stacker
1168 //* 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));
1169 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
1173 * Accepts the visitor to process the visit "request"
1175 * @param $visitorInstance An instance of a Visitor class
1178 public function accept (Visitor $visitorInstance) {
1180 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - CALLED!');
1182 // Visit the package
1183 $visitorInstance->visitNetworkPackage($this);
1185 // Then visit the assembler to handle multiple packages
1186 $this->getAssemblerInstance()->accept($visitorInstance);
1189 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - EXIT!');
1197 public function clearAllStacks () {
1198 // Call the init method to force re-initialization
1199 $this->initStacks(TRUE);
1202 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: All stacker have been re-initialized.');
1206 * Removes the first failed outoging package from the stack to continue
1207 * with next one (it will never work until the issue is fixed by you).
1210 * @throws UnexpectedPackageStatusException If the package status is not 'failed'
1211 * @todo This may be enchanced for outgoing packages?
1213 public function removeFirstFailedPackage () {
1214 // Get the package again
1215 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
1217 // Is the package status 'failed'?
1218 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
1220 throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
1223 // Remove this entry
1224 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
1228 * "Decode" the package content into the same array when it was sent.
1230 * @param $rawPackageContent The raw package content to be "decoded"
1231 * @return $decodedData An array with 'sender', 'recipient', 'content' and 'status' elements
1233 public function decodeRawContent ($rawPackageContent) {
1234 // Use the separator '#' to "decode" it
1235 $decodedArray = explode(self::PACKAGE_DATA_SEPARATOR, $rawPackageContent);
1237 // Assert on count (should be always 3)
1238 assert(count($decodedArray) == self::DECODED_DATA_ARRAY_SIZE);
1240 // Generate the hash of comparing it
1241 if (!$this->isPackageHashValid($decodedArray)) {
1242 // Is not valid, so throw an exception here
1243 exit(__METHOD__ . ':INVALID HASH! UNDER CONSTRUCTION!' . chr(10));
1247 * Create 'decodedData' array with all assoziative array elements.
1249 $decodedData = array(
1250 self::PACKAGE_DATA_SENDER => $decodedArray[self::INDEX_PACKAGE_SENDER],
1251 self::PACKAGE_DATA_RECIPIENT => $decodedArray[self::INDEX_PACKAGE_RECIPIENT],
1252 self::PACKAGE_DATA_CONTENT => $decodedArray[self::INDEX_PACKAGE_CONTENT],
1253 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_DECODED,
1254 self::PACKAGE_DATA_HASH => $decodedArray[self::INDEX_PACKAGE_HASH]
1258 return $decodedData;
1262 * Handles decoded data for this node by "decoding" the 'content' part of
1263 * it. Again this method uses explode() for the "decoding" process.
1265 * @param $decodedData An array with decoded raw package data
1267 * @throws InvalidDataChecksumException If the checksum doesn't match
1269 public function handleRawData (array $decodedData) {
1271 * "Decode" the package's content by a simple explode() call, for
1272 * details of the array elements, see comments for constant
1275 $decodedContent = explode(self::PACKAGE_MASK_SEPARATOR, $decodedData[self::PACKAGE_DATA_CONTENT]);
1277 // Assert on array count for a very basic validation
1278 assert(count($decodedContent) == self::PACKAGE_CONTENT_ARRAY_SIZE);
1281 * Convert the indexed array into an associative array. This is much
1282 * better to remember than plain numbers, isn't it?
1284 $decodedContent = array(
1285 // Compressor's extension used to compress the data
1286 self::PACKAGE_CONTENT_EXTENSION => $decodedContent[self::INDEX_COMPRESSOR_EXTENSION],
1287 // Package data (aka "message") in BASE64-decoded form but still compressed
1288 self::PACKAGE_CONTENT_MESSAGE => base64_decode($decodedContent[self::INDEX_PACKAGE_DATA]),
1289 // Tags as an indexed array for "tagging" the message
1290 self::PACKAGE_CONTENT_TAGS => explode(self::PACKAGE_TAGS_SEPARATOR, $decodedContent[self::INDEX_TAGS]),
1291 // Checksum of the _decoded_ data
1292 self::PACKAGE_CONTENT_CHECKSUM => $decodedContent[self::INDEX_CHECKSUM],
1294 self::PACKAGE_CONTENT_SENDER => $decodedData[self::PACKAGE_DATA_SENDER],
1295 // Hash from decoded raw data
1296 self::PACKAGE_CONTENT_HASH => $decodedData[self::PACKAGE_DATA_HASH]
1299 // Is the checksum valid?
1300 if (!$this->isChecksumValid($decodedContent, $decodedData)) {
1301 // Is not the same, so throw an exception here
1302 throw new InvalidDataChecksumException(array($this, $decodedContent, $decodedData), BaseListener::EXCEPTION_INVALID_DATA_CHECKSUM);
1306 * The checksum is the same, then it can be decompressed safely. The
1307 * original message is at this point fully decoded.
1309 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
1311 // And push it on the next stack
1312 $this->getStackInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
1316 * Checks whether a new message has arrived
1318 * @return $hasArrived Whether a new message has arrived for processing
1320 public function isNewMessageArrived () {
1321 // Determine if the stack is not empty
1322 $hasArrived = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
1329 * Handles newly arrived messages
1332 * @todo Implement verification of all sent tags here?
1334 public function handleNewlyArrivedMessage () {
1335 // Get it from the stacker, it is the full array with the decoded message
1336 $decodedContent = $this->getStackInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
1338 // Now get a filter chain back from factory with given tags array
1339 $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
1342 * Process the message through all filters, note that all other
1343 * elements from $decodedContent are no longer needed.
1345 $chainInstance->processMessage($decodedContent, $this);
1349 * Checks whether a processed message is pending for "interpretation"
1351 * @return $isPending Whether a processed message is pending
1353 public function isProcessedMessagePending () {
1355 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
1362 * Handle processed messages by "interpreting" the 'message_type' element
1366 public function handleProcessedMessage () {
1367 // Get it from the stacker, it is the full array with the processed message
1368 $messageArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
1370 // Add type for later easier handling
1371 $messageArray[self::MESSAGE_ARRAY_DATA][self::MESSAGE_ARRAY_TYPE] = $messageArray[self::MESSAGE_ARRAY_TYPE];
1374 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: messageArray=' . print_r($messageArray, TRUE));
1376 // Create a handler instance from given message type
1377 $handlerInstance = MessageTypeHandlerFactory::createMessageTypeHandlerInstance($messageArray[self::MESSAGE_ARRAY_TYPE]);
1379 // Handle message data
1380 $handlerInstance->handleMessageData($messageArray[self::MESSAGE_ARRAY_DATA], $this);
1384 * Feeds the hash and sender (as recipient for the 'sender' reward) to the
1385 * miner's queue, unless the message is not a "reward claim" message as this
1386 * leads to an endless loop. You may wish to run the miner to get some
1387 * reward ("HubCoins") for "mining" this hash.
1389 * @param $decodedDataArray Array with decoded message
1393 public function feedHashToMiner (array $decodedDataArray) {
1394 // Make sure the required elements are there
1395 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_SENDER]));
1396 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_HASH]));
1397 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_TAGS]));
1399 // Resolve session id ('sender' is a session id) into node id
1400 $nodeId = HubTools::resolveNodeIdBySessionId($decodedDataArray[self::PACKAGE_CONTENT_SENDER]);
1402 // Is 'claim_reward' the message type?
1403 if (in_array('claim_reward', $decodedDataArray[self::PACKAGE_CONTENT_TAGS])) {
1405 * Then don't feed this message to the miner as this causes and
1406 * endless loop of mining.
1411 $this->partialStub('@TODO nodeId=' . $nodeId . ',decodedDataArray=' . print_r($decodedDataArray, TRUE));