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;
81 const INDEX_PACKAGE_PRIVATE_KEY_HASH = 5;
84 * Size of the decoded data array
86 const DECODED_DATA_ARRAY_SIZE = 6;
89 * Named array elements for decoded package content
91 const PACKAGE_CONTENT_EXTENSION = 'compressor';
92 const PACKAGE_CONTENT_MESSAGE = 'message';
93 const PACKAGE_CONTENT_TAGS = 'tags';
94 const PACKAGE_CONTENT_CHECKSUM = 'checksum';
95 const PACKAGE_CONTENT_SENDER = 'sender';
96 const PACKAGE_CONTENT_HASH = 'hash';
97 const PACKAGE_CONTENT_PRIVATE_KEY_HASH = 'pkhash';
100 * Named array elements for package data
102 const PACKAGE_DATA_SENDER = 'sender';
103 const PACKAGE_DATA_RECIPIENT = 'recipient';
104 const PACKAGE_DATA_CONTENT = 'content';
105 const PACKAGE_DATA_STATUS = 'status';
106 const PACKAGE_DATA_HASH = 'hash';
107 const PACKAGE_DATA_PRIVATE_KEY_HASH = 'pkhash';
112 const PACKAGE_STATUS_NEW = 'new';
113 const PACKAGE_STATUS_FAILED = 'failed';
114 const PACKAGE_STATUS_DECODED = 'decoded';
115 const PACKAGE_STATUS_FAKED = 'faked';
118 * Constants for message data array
120 const MESSAGE_ARRAY_DATA = 'message_data';
121 const MESSAGE_ARRAY_TYPE = 'message_type';
122 const MESSAGE_ARRAY_SENDER = 'message_sender';
123 const MESSAGE_ARRAY_HASH = 'message_hash';
124 const MESSAGE_ARRAY_TAGS = 'message_tags';
127 * Generic answer status field
133 const PACKAGE_TAGS_SEPARATOR = ';';
136 * Raw package data separator
138 const PACKAGE_DATA_SEPARATOR = '#';
141 * Separator for more than one recipient
143 const PACKAGE_RECIPIENT_SEPARATOR = ':';
146 * Network target (alias): 'upper nodes'
148 const NETWORK_TARGET_UPPER = 'upper';
151 * Network target (alias): 'self'
153 const NETWORK_TARGET_SELF = 'self';
156 * Network target (alias): 'dht'
158 const NETWORK_TARGET_DHT = 'dht';
161 * TCP package size in bytes
163 const TCP_PACKAGE_SIZE = 512;
165 /**************************************************************************
166 * Stacker for out-going packages *
167 **************************************************************************/
170 * Stacker name for "undeclared" packages
172 const STACKER_NAME_UNDECLARED = 'package_undeclared';
175 * Stacker name for "declared" packages (which are ready to send out)
177 const STACKER_NAME_DECLARED = 'package_declared';
180 * Stacker name for "out-going" packages
182 const STACKER_NAME_OUTGOING = 'package_outgoing';
184 /**************************************************************************
185 * Stacker for incoming packages *
186 **************************************************************************/
189 * Stacker name for "incoming" decoded raw data
191 const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
194 * Stacker name for handled decoded raw data
196 const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
199 * Stacker name for "chunked" decoded raw data
201 const STACKER_NAME_DECODED_CHUNKED = 'package_chunked_decoded';
203 /**************************************************************************
204 * Stacker for incoming messages *
205 **************************************************************************/
208 * Stacker name for new messages
210 const STACKER_NAME_NEW_MESSAGE = 'package_new_message';
213 * Stacker name for processed messages
215 const STACKER_NAME_PROCESSED_MESSAGE = 'package_processed_message';
217 /**************************************************************************
218 * Stacker for raw data handling *
219 **************************************************************************/
222 * Stacker for outgoing data stream
224 const STACKER_NAME_OUTGOING_STREAM = 'outgoing_stream';
227 * Array index for final hash
229 const RAW_FINAL_HASH_INDEX = 'hash';
232 * Array index for encoded data
234 const RAW_ENCODED_DATA_INDEX = 'data';
237 * Array index for sent bytes
239 const RAW_SENT_BYTES_INDEX = 'sent';
242 * Array index for socket resource
244 const RAW_SOCKET_INDEX = 'socket';
247 * Array index for buffer size
249 const RAW_BUFFER_SIZE_INDEX = 'buffer';
252 * Array index for diff between buffer and sent bytes
254 const RAW_DIFF_INDEX = 'diff';
256 /**************************************************************************
258 **************************************************************************/
259 const PROTOCOL_TCP = 'TCP';
260 const PROTOCOL_UDP = 'UDP';
263 * Protected constructor
267 protected function __construct () {
268 // Call parent constructor
269 parent::__construct(__CLASS__);
273 * Creates an instance of this class
275 * @param $compressorInstance A Compressor instance for compressing the content
276 * @return $packageInstance An instance of a Deliverable class
278 public static final function createNetworkPackage (Compressor $compressorInstance) {
280 $packageInstance = new NetworkPackage();
282 // Now set the compressor instance
283 $packageInstance->setCompressorInstance($compressorInstance);
286 * We need to initialize a stack here for our packages even for those
287 * which have no recipient address and stamp... ;-) This stacker will
288 * also be used for incoming raw data to handle it.
290 $stackInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
292 // At last, set it in this class
293 $packageInstance->setStackInstance($stackInstance);
296 $packageInstance->initStacks();
298 // Get a visitor instance for speeding up things and set it
299 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class');
300 $packageInstance->setVisitorInstance($visitorInstance);
302 // Get crypto instance and set it, too
303 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
304 $packageInstance->setCryptoInstance($cryptoInstance);
306 // Get a singleton package assembler instance from factory and set it here, too
307 $assemblerInstance = PackageAssemblerFactory::createAssemblerInstance($packageInstance);
308 $packageInstance->setAssemblerInstance($assemblerInstance);
311 $nodeInstance = NodeObjectFactory::createNodeInstance();
313 // Get pool instance from node
314 $poolInstance = $nodeInstance->getListenerPoolInstance();
317 $packageInstance->setListenerPoolInstance($poolInstance);
319 // Return the prepared instance
320 return $packageInstance;
324 * Initialize all stackers
326 * @param $forceReInit Whether to force reinitialization of all stacks
329 protected function initStacks ($forceReInit = FALSE) {
331 $this->getStackInstance()->initStacks(array(
332 self::STACKER_NAME_UNDECLARED,
333 self::STACKER_NAME_DECLARED,
334 self::STACKER_NAME_OUTGOING,
335 self::STACKER_NAME_DECODED_INCOMING,
336 self::STACKER_NAME_DECODED_HANDLED,
337 self::STACKER_NAME_DECODED_CHUNKED,
338 self::STACKER_NAME_NEW_MESSAGE,
339 self::STACKER_NAME_PROCESSED_MESSAGE,
340 self::STACKER_NAME_OUTGOING_STREAM
345 * Determines private key hash from given session id
347 * @param $decodedData Array with decoded data
348 * @return $hash Private key's hash
349 * @throws InvalidPrivateKeyHashException If the private key's hash is not valid
351 private function determineSenderPrivateKeyHash (array $decodedData) {
353 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
355 // Ask DHT for session id
356 $senderData = $dhtInstance->findNodeLocalBySessionId($decodedData[self::PACKAGE_CONTENT_SENDER]);
358 // Is an entry found?
359 if (count($senderData) > 0) {
360 // Make sure the element 'private_key_hash' is there
361 //* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: senderData=' . print_r($senderData, TRUE));
362 assert(isset($senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH]));
364 // Don't accept empty hashes
365 if (empty($senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH])) {
367 throw new InvalidPrivateKeyHashException(array($this, $senderData, 'empty hash in senderData'));
371 return $senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH];
374 // Make sure the requested element is there
375 //* DEBUG-DIE */ die('decodedData=' . print_r($decodedData, TRUE));
376 assert(isset($decodedData[self::PACKAGE_CONTENT_PRIVATE_KEY_HASH]));
378 // Don't accept empty keys
379 if (empty($decodedData[self::PACKAGE_CONTENT_PRIVATE_KEY_HASH])) {
381 throw new InvalidPrivateKeyHashException(array($this, $senderData, 'empty hash in decodedData'));
384 // There is no DHT entry so, accept the hash from decoded data
385 return $decodedData[self::PACKAGE_CONTENT_PRIVATE_KEY_HASH];
389 * "Getter" for hash from given content
391 * @param $content Raw package content
392 * @return $hash Hash for given package content
394 private function getHashFromContent ($content) {
396 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
399 // @TODO md5() is very weak, but it needs to be fast
402 self::PACKAGE_CHECKSUM_SEPARATOR .
403 $this->getSessionId() .
404 self::PACKAGE_CHECKSUM_SEPARATOR .
405 $this->getCompressorInstance()->getCompressorExtension()
409 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',hash=' . $hash . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
416 * Checks whether the checksum (sometimes called "hash") is the same
418 * @param $decodedContent Package raw content
419 * @param $decodedData Whole raw package data array
420 * @return $isChecksumValid Whether the checksum is the same
422 private function isChecksumValid (array $decodedContent, array $decodedData) {
424 $checksum = $this->getHashFromContentSessionId($decodedContent, $decodedData[self::PACKAGE_DATA_SENDER]);
427 $isChecksumValid = ($checksum == $decodedContent[self::PACKAGE_CONTENT_CHECKSUM]);
430 return $isChecksumValid;
434 * Change the package with given status in given stack
436 * @param $packageData Raw package data in an array
437 * @param $stackerName Name of the stacker
438 * @param $newStatus New status to set
441 private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
442 // Skip this for empty stacks
443 if ($this->getStackInstance()->isStackEmpty($stackerName)) {
444 // This avoids an exception after all packages has failed
448 // Pop the entry (it should be it)
449 $nextData = $this->getStackInstance()->popNamed($stackerName);
451 // Compare both hashes
452 assert($nextData[self::PACKAGE_DATA_HASH] == $packageData[self::PACKAGE_DATA_HASH]);
454 // Temporary set the new status
455 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
458 $this->getStackInstance()->pushNamed($stackerName, $packageData);
462 * "Getter" for hash from given content and sender's session id
464 * @param $decodedContent Raw package content
465 * @param $sessionId Session id of the sender
466 * @return $hash Hash for given package content
468 public function getHashFromContentSessionId (array $decodedContent, $sessionId) {
470 //* 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]);
473 // @TODO md5() is very weak, but it needs to be fast
475 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] .
476 self::PACKAGE_CHECKSUM_SEPARATOR .
478 self::PACKAGE_CHECKSUM_SEPARATOR .
479 $decodedContent[self::PACKAGE_CONTENT_EXTENSION]
486 ///////////////////////////////////////////////////////////////////////////
487 // Delivering packages / raw data
488 ///////////////////////////////////////////////////////////////////////////
491 * Declares the given raw package data by discovering recipients
493 * @param $packageData Raw package data in an array
496 private function declareRawPackageData (array $packageData) {
497 // Make sure the required field is there
498 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
501 * We need to disover every recipient, just in case we have a
502 * multi-recipient entry like 'upper' is. 'all' may be a not so good
503 * target because it causes an overload on the network and may be
504 * abused for attacking the network with large packages.
506 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
508 // Discover all recipients, this may throw an exception
509 $discoveryInstance->discoverRecipients($packageData);
511 // Now get an iterator
512 $iteratorInstance = $discoveryInstance->getIterator();
514 // Make sure the iterator instance is valid
515 assert($iteratorInstance instanceof Iterator);
517 // Rewind back to the beginning
518 $iteratorInstance->rewind();
520 // ... and begin iteration
521 while ($iteratorInstance->valid()) {
523 $currentRecipient = $iteratorInstance->current();
526 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Setting recipient to ' . $currentRecipient . ',previous=' . $packageData[self::PACKAGE_DATA_RECIPIENT]);
529 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
531 // Push the declared package to the next stack.
532 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
535 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package declared for recipient ' . $currentRecipient);
537 // Skip to next entry
538 $iteratorInstance->next();
542 * The recipient list can be cleaned up here because the package which
543 * shall be delivered has already been added for all entries from the
546 $discoveryInstance->clearRecipients();
550 * Delivers raw package data. In short, this will discover the raw socket
551 * resource through a discovery class (which will analyse the receipient of
552 * the package), register the socket with the connection (handler/helper?)
553 * instance and finally push the raw data on our outgoing queue.
555 * @param $packageData Raw package data in an array
558 private function deliverRawPackageData (array $packageData) {
560 * This package may become big, depending on the shared object size or
561 * delivered message size which shouldn't be so long (to save
562 * bandwidth). Because of the nature of the used protocol (TCP) we need
563 * to split it up into smaller pieces to fit it into a TCP frame.
565 * So first we need (again) a discovery class but now a protocol
566 * discovery to choose the right socket resource. The discovery class
567 * should take a look at the raw package data itself and then decide
568 * which (configurable!) protocol should be used for that type of
571 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
573 // Now discover the right protocol
574 $socketResource = $discoveryInstance->discoverSocket($packageData, BaseConnectionHelper::CONNECTION_TYPE_OUTGOING);
577 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
580 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: stateInstance=' . $helperInstance->getStateInstance());
581 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
583 // The socket needs to be put in a special registry that can handle such data
584 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
586 // Get the connection helper from registry
587 $helperInstance = Registry::getRegistry()->getInstance('connection');
589 // And make sure it is valid
590 assert($helperInstance instanceof ConnectionHelper);
592 // Get connection info class
593 $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($helperInstance->getProtocolName(), 'helper');
595 // Will the info instance with connection helper data
596 $infoInstance->fillWithConnectionHelperInformation($helperInstance);
599 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($infoInstance, $socketResource))) {
601 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Registering socket ' . $socketResource . ' ...');
604 $registryInstance->registerSocket($infoInstance, $socketResource, $packageData);
605 } elseif (!$helperInstance->getStateInstance()->isPeerStateConnected()) {
606 // Is not connected, then we cannot send
607 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Unexpected peer state ' . $helperInstance->getStateInstance()->__toString() . ' detected.');
609 // Shutdown the socket
610 $this->shutdownSocket($socketResource);
614 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
616 // Make sure the connection is up
617 $helperInstance->getStateInstance()->validatePeerStateConnected();
620 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
622 // Enqueue it again on the out-going queue, the connection is up and working at this point
623 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
626 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
630 * Sends waiting packages
632 * @param $packageData Raw package data
635 private function sendOutgoingRawPackageData (array $packageData) {
639 // Get the right connection instance
640 $infoInstance = SocketRegistryFactory::createSocketRegistryInstance()->getInfoInstanceFromPackageData($packageData);
642 // Test helper instance
643 assert($infoInstance instanceof ShareableInfo);
645 // Get helper instance
646 $helperInstance = $infoInstance->getHelperInstance();
648 // Some sanity-checks on the object
649 //* DEBUG-DIE: */ die('[' . __METHOD__ . ':' . __LINE__ . ']: p1=' . $infoInstance->getProtocolName() . ',p2=' . $helperInstance->getProtocolName() . ',infoInstance=' . print_r($infoInstance, TRUE));
650 assert($helperInstance instanceof ConnectionHelper);
651 assert($infoInstance->getProtocolName() == $helperInstance->getProtocolName());
653 // Is this connection still alive?
654 if ($helperInstance->isShuttedDown()) {
655 // This connection is shutting down
656 // @TODO We may want to do somthing more here?
660 // Sent out package data
661 $helperInstance->sendRawPackageData($packageData);
665 * Generates a secure hash for given raw package content and sender id
667 * @param $content Raw package data
668 * @param $senderId Sender id to generate a hash for
669 * @return $hash Hash as hex-encoded string
671 private function generatePackageHash ($content, $senderId) {
673 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content()=' . strlen($content) . ',senderId=' . $senderId . ' - CALLED!');
675 // Is the feature enabled?
676 if (!FrameworkFeature::isFeatureAvailable('hubcoin_reward')) {
677 // Feature is not enabled
678 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Feature "hubcoin_reward" not available, not generating package hash. Returning NULL ...');
684 self::PACKAGE_CONTENT_SENDER => $senderId,
685 self::PACKAGE_CONTENT_MESSAGE => $content,
686 self::PACKAGE_CONTENT_PRIVATE_KEY_HASH => ''
689 // Hash content and sender id together, use scrypt
690 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: senderId=' . $senderId . ',content()=' . strlen($content));
691 $hash = FrameworkFeature::callFeature('hubcoin_reward', 'generateHash', array($senderId . ':' . $content . ':' . $this->determineSenderPrivateKeyHash($data)));
694 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: hash=' . $hash . ' - EXIT!');
701 * Checks whether the hash of given package data is 'valid', here that
702 * means it is the same or not.
704 * @param $decodedArray An array with 'decoded' (explode() was mostly called) data
705 * @return $isHashValid Whether the hash is valid
706 * @todo Unfinished area, hashes are currently NOT fully supported
708 private function isPackageHashValid (array $decodedArray) {
710 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedArray=' . print_r($decodedArray, TRUE) . ' - CALLED!');
712 // Make sure the required array elements are there
713 assert(isset($decodedArray[self::PACKAGE_CONTENT_SENDER]));
714 assert(isset($decodedArray[self::PACKAGE_CONTENT_MESSAGE]));
715 assert(isset($decodedArray[self::PACKAGE_CONTENT_HASH]));
716 assert(isset($decodedArray[self::PACKAGE_CONTENT_PRIVATE_KEY_HASH]));
718 // Is the feature enabled?
719 if (!FrameworkFeature::isFeatureAvailable('hubcoin_reward')) {
720 // Feature is not enabled, so hashes are always valid
721 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Feature "hubcoin_reward" not available, not checking hash. Returning TRUE ...');
726 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: senderId=' . $decodedArray[self::PACKAGE_CONTENT_SENDER] . ',message()=' . strlen($decodedArray[self::PACKAGE_CONTENT_MESSAGE]) . ',hash=' . $decodedArray[self::PACKAGE_CONTENT_HASH]);
727 //* DEBUG-DIE: */ die(__METHOD__ . ': decodedArray=' . print_r($decodedArray, TRUE));
728 $isHashValid = FrameworkFeature::callFeature('hubcoin_reward', 'checkHash', array($decodedArray[self::PACKAGE_CONTENT_SENDER] . ':' . $decodedArray[self::PACKAGE_CONTENT_MESSAGE] . ':' . $this->determineSenderPrivateKeyHash($decodedArray), $decodedArray[self::PACKAGE_CONTENT_HASH]));
731 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: isHashValid=' . intval($isHashValid) . ' - EXIT!');
736 * "Enqueues" raw content into this delivery class by reading the raw content
737 * from given helper's template instance and pushing it on the 'undeclared'
740 * @param $helperInstance An instance of a HubHelper class
743 public function enqueueRawDataFromTemplate (HubHelper $helperInstance) {
745 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
747 // Get the raw content ...
748 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
749 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('content(' . strlen($content) . ')=' . $content);
751 // ... and compress it
752 $compressed = $this->getCompressorInstance()->compressStream($content);
754 // Add magic in front of it and hash behind it, including BASE64 encoding
755 $packageContent = sprintf(self::PACKAGE_MASK,
756 // 1.) Compressor's extension
757 $this->getCompressorInstance()->getCompressorExtension(),
759 self::PACKAGE_MASK_SEPARATOR,
760 // 2.) Compressed raw package content, encoded with BASE64
761 base64_encode($compressed),
763 self::PACKAGE_MASK_SEPARATOR,
765 implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
767 self::PACKAGE_MASK_SEPARATOR,
769 $this->getHashFromContent($compressed)
773 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': Enqueueing package for recipientType=' . $helperInstance->getRecipientType() . ' ...');
775 // Now prepare the temporary array and push it on the 'undeclared' stack
776 $this->getStackInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
777 self::PACKAGE_DATA_SENDER => $this->getSessionId(),
778 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
779 self::PACKAGE_DATA_CONTENT => $packageContent,
780 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_NEW,
781 self::PACKAGE_DATA_HASH => $this->generatePackageHash($content, $this->getSessionId()),
782 self::PACKAGE_DATA_PRIVATE_KEY_HASH => $this->getPrivateKeyHash(),
786 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
790 * Checks whether a package has been enqueued for delivery.
792 * @return $isEnqueued Whether a package is enqueued
794 public function isPackageEnqueued () {
795 // Check whether the stacker is not empty
796 $isEnqueued = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
803 * Checks whether a package has been declared
805 * @return $isDeclared Whether a package is declared
807 public function isPackageDeclared () {
808 // Check whether the stacker is not empty
809 $isDeclared = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
816 * Checks whether a package should be sent out
818 * @return $isWaitingDelivery Whether a package is waiting for delivery
820 public function isPackageWaitingForDelivery () {
821 // Check whether the stacker is not empty
822 $isWaitingDelivery = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
825 return $isWaitingDelivery;
829 * Checks whether encoded (raw) data is pending
831 * @return $isPending Whether encoded data is pending
833 public function isEncodedDataPending () {
834 // Check whether the stacker is not empty
835 $isPending = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
842 * Delivers an enqueued package to the stated destination. If a non-session
843 * id is provided, recipient resolver is being asked (and instanced once).
844 * This allows that a single package is being delivered to multiple targets
845 * without enqueueing it for every target. If no target is provided or it
846 * can't be determined a NoTargetException is being thrown.
849 * @throws NoTargetException If no target can't be determined
851 public function declareEnqueuedPackage () {
853 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
855 // Make sure this method isn't working if there is no package enqueued
856 if (!$this->isPackageEnqueued()) {
857 // This is not fatal but should be avoided
858 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw package data waiting declaration, but ' . __METHOD__ . ' has been called!');
863 * Now there are for sure packages to deliver, so start with the first
866 $packageData = $this->getStackInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
868 // Declare the raw package data for delivery
869 $this->declareRawPackageData($packageData);
872 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
876 * Delivers the next declared package. Only one package per time will be sent
877 * because this may take time and slows down the whole delivery
882 public function processDeclaredPackage () {
884 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
886 // Sanity check if we have packages declared
887 if (!$this->isPackageDeclared()) {
888 // This is not fatal but should be avoided
889 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package has been declared, but ' . __METHOD__ . ' has been called!');
894 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
897 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
899 // Try to deliver the package
901 // And try to send it
902 $this->deliverRawPackageData($packageData);
904 // And remove it finally
905 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
906 } catch (UnexpectedStateException $e) {
907 // The state is not excepected (shall be 'connected')
908 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
910 // Mark the package with status failed
911 $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
915 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
919 * Sends waiting packages out for delivery
923 public function sendWaitingPackage () {
925 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
927 // Sanity check if we have packages waiting for delivery
928 if (!$this->isPackageWaitingForDelivery()) {
929 // This is not fatal but should be avoided
930 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
935 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_OUTGOING);
938 // Now try to send it
939 $this->sendOutgoingRawPackageData($packageData);
941 // And remove it finally
942 $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING);
943 } catch (InvalidSocketException $e) {
944 // Output exception message
945 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package was not delivered: ' . $e->getMessage());
947 // Mark package as failed
948 $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
952 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
956 * Sends out encoded data to a socket
960 public function sendEncodedData () {
962 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
964 // Make sure there is pending encoded data
965 assert($this->isEncodedDataPending());
967 // Pop current data from stack
968 $encodedDataArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
970 // Init in this round sent bytes
974 assert(is_resource($encodedDataArray[self::RAW_SOCKET_INDEX]));
977 //* 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]);
978 if ($encodedDataArray[self::RAW_DIFF_INDEX] >= 0) {
979 // Send all out (encodedData is smaller than or equal buffer size)
980 //* 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]))));
981 $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]));
983 // Send buffer size out
984 //* 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])));
985 $sentBytes = @socket_write($encodedDataArray[self::RAW_SOCKET_INDEX], $encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX]);
988 // If there was an error, we don't continue here
989 if ($sentBytes === FALSE) {
990 // Handle the error with a faked recipientData array
991 $this->handleSocketError(__METHOD__, __LINE__, $encodedDataArray[self::RAW_SOCKET_INDEX], array('0.0.0.0', '0'));
994 throw new InvalidSocketException(array($this, $encodedDataArray[self::RAW_SOCKET_INDEX], $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
995 } elseif (($sentBytes === 0) && (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) > 0)) {
996 // Nothing sent means we are done
997 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
1000 // The difference between sent bytes and length of raw data should not go below zero
1001 assert((strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) - $sentBytes) >= 0);
1003 // Add total sent bytes
1004 $encodedDataArray[self::RAW_SENT_BYTES_INDEX] += $sentBytes;
1006 // Cut out the last unsent bytes
1007 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) . ' bytes ...');
1008 $encodedDataArray[self::RAW_ENCODED_DATA_INDEX] = substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $sentBytes);
1010 // Calculate difference again
1011 $encodedDataArray[self::RAW_DIFF_INDEX] = $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]);
1014 if (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) <= 0) {
1015 // Abort here, all sent!
1016 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
1021 // Push array back in stack
1022 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
1025 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
1028 ///////////////////////////////////////////////////////////////////////////
1029 // Receiving packages / raw data
1030 ///////////////////////////////////////////////////////////////////////////
1033 * Checks whether decoded raw data is pending
1035 * @return $isPending Whether decoded raw data is pending
1037 private function isRawDataPending () {
1038 // Just return whether the stack is not empty
1039 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
1041 // Return the status
1046 * Checks whether new raw package data has arrived at a socket
1048 * @return $hasArrived Whether new raw package data has arrived for processing
1050 public function isNewRawDataPending () {
1051 // Visit the pool. This monitors the pool for incoming raw data.
1052 $this->getListenerPoolInstance()->accept($this->getVisitorInstance());
1054 // Check for new data arrival
1055 $hasArrived = $this->isRawDataPending();
1057 // Return the status
1062 * Handles the incoming decoded raw data. This method does not "convert" the
1063 * decoded data back into a package array, it just "handles" it and pushs it
1064 * on the next stack.
1068 public function handleIncomingDecodedData () {
1070 * This method should only be called if decoded raw data is pending,
1071 * so check it again.
1073 if (!$this->isRawDataPending()) {
1074 // This is not fatal but should be avoided
1075 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw (decoded?) data is pending, but ' . __METHOD__ . ' has been called!');
1079 // Very noisy debug message:
1080 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
1082 // "Pop" the next entry (the same array again) from the stack
1083 $decodedData = $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
1085 // Make sure both array elements are there
1087 (is_array($decodedData)) &&
1088 (isset($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1089 (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1093 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
1094 * only want to handle unhandled packages here.
1096 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
1097 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
1099 // Remove the last chunk SEPARATOR (because there is no need for it)
1100 if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
1101 // It is there and should be removed
1102 $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
1105 // This package is "handled" and can be pushed on the next stack
1106 //* 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 . ' ...');
1107 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
1111 * Adds raw decoded data from the given handler instance to this receiver
1113 * @param $handlerInstance An instance of a Networkable class
1116 public function addRawDataToIncomingStack (Networkable $handlerInstance) {
1118 * Get the decoded data from the handler, this is an array with
1119 * 'raw_data' and 'error_code' as elements.
1121 $decodedData = $handlerInstance->getNextRawData();
1123 // Very noisy debug message:
1124 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, TRUE));
1126 // And push it on our stack
1127 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
1131 * Checks whether incoming decoded data is handled.
1133 * @return $isHandled Whether incoming decoded data is handled
1135 public function isIncomingRawDataHandled () {
1136 // Determine if the stack is not empty
1137 $isHandled = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
1144 * Checks whether the assembler has pending data left
1146 * @return $isHandled Whether the assembler has pending data left
1148 public function ifAssemblerHasPendingDataLeft () {
1149 // Determine if the stack is not empty
1150 $isHandled = (!$this->getAssemblerInstance()->isPendingDataEmpty());
1157 * Checks whether the assembler has multiple packages pending
1159 * @return $isPending Whether the assembler has multiple packages pending
1161 public function ifMultipleMessagesPending () {
1162 // Determine if the stack is not empty
1163 $isPending = ($this->getAssemblerInstance()->ifMultipleMessagesPending());
1170 * Handles the attached assemler's pending data queue to be finally
1171 * assembled to the raw package data back.
1175 public function handleAssemblerPendingData () {
1177 $this->getAssemblerInstance()->handlePendingData();
1181 * Handles multiple messages.
1185 public function handleMultipleMessages () {
1187 $this->getAssemblerInstance()->handleMultipleMessages();
1191 * Assembles incoming decoded data so it will become an abstract network
1192 * package again. The assembler does later do it's job by an other task,
1193 * not this one to keep best speed possible.
1197 public function assembleDecodedDataToPackage () {
1198 // Make sure the raw decoded package data is handled
1199 assert($this->isIncomingRawDataHandled());
1201 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
1202 $packageContent = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
1204 // Assert on some elements
1206 (is_array($packageContent)) &&
1207 (isset($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1208 (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1211 // Start assembling the raw package data array by chunking it
1212 $this->getAssemblerInstance()->chunkPackageContent($packageContent);
1214 // Remove the package from 'handled_decoded' stack ...
1215 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
1217 // ... and push it on the 'chunked' stacker
1218 //* 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));
1219 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
1223 * Accepts the visitor to process the visit "request"
1225 * @param $visitorInstance An instance of a Visitor class
1228 public function accept (Visitor $visitorInstance) {
1230 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - CALLED!');
1232 // Visit the package
1233 $visitorInstance->visitNetworkPackage($this);
1235 // Then visit the assembler to handle multiple packages
1236 $this->getAssemblerInstance()->accept($visitorInstance);
1239 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - EXIT!');
1247 public function clearAllStacks () {
1248 // Call the init method to force re-initialization
1249 $this->initStacks(TRUE);
1252 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: All stacker have been re-initialized.');
1256 * Removes the first failed outoging package from the stack to continue
1257 * with next one (it will never work until the issue is fixed by you).
1260 * @throws UnexpectedPackageStatusException If the package status is not 'failed'
1261 * @todo This may be enchanced for outgoing packages?
1263 public function removeFirstFailedPackage () {
1264 // Get the package again
1265 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
1267 // Is the package status 'failed'?
1268 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
1270 throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
1273 // Remove this entry
1274 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
1278 * "Decode" the package content into the same array when it was sent.
1280 * @param $rawPackageContent The raw package content to be "decoded"
1281 * @return $decodedData An array with 'sender', 'recipient', 'content' and 'status' elements
1283 public function decodeRawContent ($rawPackageContent) {
1284 // Use the separator '#' to "decode" it
1285 $decodedArray = explode(self::PACKAGE_DATA_SEPARATOR, $rawPackageContent);
1287 // Assert on count (should be always 3)
1288 assert(count($decodedArray) == self::DECODED_DATA_ARRAY_SIZE);
1291 * Create 'decodedData' array with all assoziative array elements.
1293 $decodedData = array(
1294 self::PACKAGE_DATA_SENDER => $decodedArray[self::INDEX_PACKAGE_SENDER],
1295 self::PACKAGE_DATA_RECIPIENT => $decodedArray[self::INDEX_PACKAGE_RECIPIENT],
1296 self::PACKAGE_DATA_CONTENT => $decodedArray[self::INDEX_PACKAGE_CONTENT],
1297 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_DECODED,
1298 self::PACKAGE_DATA_HASH => $decodedArray[self::INDEX_PACKAGE_HASH],
1299 self::PACKAGE_DATA_PRIVATE_KEY_HASH => $decodedArray[self::INDEX_PACKAGE_PRIVATE_KEY_HASH]
1303 return $decodedData;
1307 * Handles decoded data for this node by "decoding" the 'content' part of
1308 * it. Again this method uses explode() for the "decoding" process.
1310 * @param $decodedData An array with decoded raw package data
1312 * @throws InvalidDataChecksumException If the checksum doesn't match
1314 public function handleRawData (array $decodedData) {
1316 * "Decode" the package's content by a simple explode() call, for
1317 * details of the array elements, see comments for constant
1320 $decodedContent = explode(self::PACKAGE_MASK_SEPARATOR, $decodedData[self::PACKAGE_DATA_CONTENT]);
1322 // Assert on array count for a very basic validation
1323 assert(count($decodedContent) == self::PACKAGE_CONTENT_ARRAY_SIZE);
1326 * Convert the indexed array into an associative array. This is much
1327 * better to remember than plain numbers, isn't it?
1329 $decodedContent = array(
1330 // Compressor's extension used to compress the data
1331 self::PACKAGE_CONTENT_EXTENSION => $decodedContent[self::INDEX_COMPRESSOR_EXTENSION],
1332 // Package data (aka "message") in BASE64-decoded form but still compressed
1333 self::PACKAGE_CONTENT_MESSAGE => base64_decode($decodedContent[self::INDEX_PACKAGE_DATA]),
1334 // Tags as an indexed array for "tagging" the message
1335 self::PACKAGE_CONTENT_TAGS => explode(self::PACKAGE_TAGS_SEPARATOR, $decodedContent[self::INDEX_TAGS]),
1336 // Checksum of the _decoded_ data
1337 self::PACKAGE_CONTENT_CHECKSUM => $decodedContent[self::INDEX_CHECKSUM],
1339 self::PACKAGE_CONTENT_SENDER => $decodedData[self::PACKAGE_DATA_SENDER],
1340 // Hash from decoded raw data
1341 self::PACKAGE_CONTENT_HASH => $decodedData[self::PACKAGE_DATA_HASH],
1342 // Hash of private key
1343 self::PACKAGE_CONTENT_PRIVATE_KEY_HASH => $decodedData[self::PACKAGE_DATA_PRIVATE_KEY_HASH]
1346 // Is the checksum valid?
1347 if (!$this->isChecksumValid($decodedContent, $decodedData)) {
1348 // Is not the same, so throw an exception here
1349 throw new InvalidDataChecksumException(array($this, $decodedContent, $decodedData), BaseListener::EXCEPTION_INVALID_DATA_CHECKSUM);
1353 * The checksum is the same, then it can be decompressed safely. The
1354 * original message is at this point fully decoded.
1356 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
1358 // And push it on the next stack
1359 $this->getStackInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
1363 * Checks whether a new message has arrived
1365 * @return $hasArrived Whether a new message has arrived for processing
1367 public function isNewMessageArrived () {
1368 // Determine if the stack is not empty
1369 $hasArrived = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
1376 * Handles newly arrived messages
1379 * @todo Implement verification of all sent tags here?
1381 public function handleNewlyArrivedMessage () {
1382 // Make sure there is at least one message
1383 assert($this->isNewMessageArrived());
1385 // Get it from the stacker, it is the full array with the decoded message
1386 $decodedContent = $this->getStackInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
1388 // Generate the hash of comparing it
1389 if (!$this->isPackageHashValid($decodedContent)) {
1390 // Is not valid, so throw an exception here
1391 exit(__METHOD__ . ':INVALID HASH! UNDER CONSTRUCTION!' . chr(10));
1394 // Now get a filter chain back from factory with given tags array
1395 $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
1398 * Process the message through all filters, note that all other
1399 * elements from $decodedContent are no longer needed.
1401 $chainInstance->processMessage($decodedContent, $this);
1404 * Post-processing of message data (this won't remove the message from
1407 $chainInstance->postProcessMessage($this);
1411 * Checks whether a processed message is pending for "interpretation"
1413 * @return $isPending Whether a processed message is pending
1415 public function isProcessedMessagePending () {
1417 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
1424 * Handle processed messages by "interpreting" the 'message_type' element
1428 public function handleProcessedMessage () {
1429 // Get it from the stacker, it is the full array with the processed message
1430 $messageArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
1432 // Add type for later easier handling
1433 $messageArray[self::MESSAGE_ARRAY_DATA][self::MESSAGE_ARRAY_TYPE] = $messageArray[self::MESSAGE_ARRAY_TYPE];
1436 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: messageArray=' . print_r($messageArray, TRUE));
1438 // Create a handler instance from given message type
1439 $handlerInstance = MessageTypeHandlerFactory::createMessageTypeHandlerInstance($messageArray[self::MESSAGE_ARRAY_TYPE]);
1441 // Handle message data
1442 $handlerInstance->handleMessageData($messageArray[self::MESSAGE_ARRAY_DATA], $this);
1444 // Post-handling of message data
1445 $handlerInstance->postHandleMessageData($messageArray, $this);
1449 * Feeds the hash and sender (as recipient for the 'sender' reward) to the
1450 * miner's queue, unless the message is not a "reward claim" message as this
1451 * leads to an endless loop. You may wish to run the miner to get some
1452 * reward ("Hubcoins") for "mining" this hash.
1454 * @param $messageData Array with message data
1458 public function feedHashToMiner (array $messageData) {
1459 // Is the feature enabled?
1460 if (!FrameworkFeature::isFeatureAvailable('hubcoin_reward')) {
1462 * Feature is not enabled, don't feed the hash to the miner as it
1468 // Make sure the required elements are there
1469 assert(isset($messageData[self::MESSAGE_ARRAY_SENDER]));
1470 assert(isset($messageData[self::MESSAGE_ARRAY_HASH]));
1471 assert(isset($messageData[self::MESSAGE_ARRAY_TAGS]));
1474 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
1476 // Resolve session id ('sender' is a session id) into node id
1477 $nodeId = HubTools::resolveNodeIdBySessionId($messageData[self::MESSAGE_ARRAY_SENDER]);
1479 // Is 'claim_reward' the message type?
1480 if (in_array('claim_reward', $messageData[self::MESSAGE_ARRAY_TAGS])) {
1482 * Then don't feed this message to the miner as this causes an
1483 * endless loop of mining.
1488 $this->partialStub('@TODO nodeId=' . $nodeId . ',messageData=' . print_r($messageData, TRUE));