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 - 2012 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_SIGNATURE = 4;
83 * Size of the decoded data array ('status' is not included)
85 const DECODED_DATA_ARRAY_SIZE = 4;
88 * Named array elements for decoded package content
90 const PACKAGE_CONTENT_EXTENSION = 'compressor';
91 const PACKAGE_CONTENT_MESSAGE = 'message';
92 const PACKAGE_CONTENT_TAGS = 'tags';
93 const PACKAGE_CONTENT_CHECKSUM = 'checksum';
96 * Named array elements for package data
98 const PACKAGE_DATA_SENDER = 'sender';
99 const PACKAGE_DATA_RECIPIENT = 'recipient';
100 const PACKAGE_DATA_PROTOCOL = 'protocol';
101 const PACKAGE_DATA_CONTENT = 'content';
102 const PACKAGE_DATA_STATUS = 'status';
103 const PACKAGE_DATA_SIGNATURE = 'signature';
108 const PACKAGE_STATUS_NEW = 'new';
109 const PACKAGE_STATUS_FAILED = 'failed';
110 const PACKAGE_STATUS_DECODED = 'decoded';
111 const PACKAGE_STATUS_FAKED = 'faked';
114 * Constants for message data array
116 const MESSAGE_ARRAY_DATA = 'message_data';
117 const MESSAGE_ARRAY_TYPE = 'message_type';
120 * Generic answer status field
126 const PACKAGE_TAGS_SEPARATOR = ';';
129 * Raw package data separator
131 const PACKAGE_DATA_SEPARATOR = '#';
134 * Separator for more than one recipient
136 const PACKAGE_RECIPIENT_SEPARATOR = ':';
139 * Network target (alias): 'upper nodes'
141 const NETWORK_TARGET_UPPER = 'upper';
144 * Network target (alias): 'self'
146 const NETWORK_TARGET_SELF = 'self';
149 * Network target (alias): 'dht'
151 const NETWORK_TARGET_DHT = 'dht';
154 * TCP package size in bytes
156 const TCP_PACKAGE_SIZE = 512;
158 /**************************************************************************
159 * Stacker for out-going packages *
160 **************************************************************************/
163 * Stacker name for "undeclared" packages
165 const STACKER_NAME_UNDECLARED = 'package_undeclared';
168 * Stacker name for "declared" packages (which are ready to send out)
170 const STACKER_NAME_DECLARED = 'package_declared';
173 * Stacker name for "out-going" packages
175 const STACKER_NAME_OUTGOING = 'package_outgoing';
177 /**************************************************************************
178 * Stacker for incoming packages *
179 **************************************************************************/
182 * Stacker name for "incoming" decoded raw data
184 const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
187 * Stacker name for handled decoded raw data
189 const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
192 * Stacker name for "chunked" decoded raw data
194 const STACKER_NAME_DECODED_CHUNKED = 'package_chunked_decoded';
196 /**************************************************************************
197 * Stacker for incoming messages *
198 **************************************************************************/
201 * Stacker name for new messages
203 const STACKER_NAME_NEW_MESSAGE = 'package_new_message';
206 * Stacker name for processed messages
208 const STACKER_NAME_PROCESSED_MESSAGE = 'package_processed_message';
210 /**************************************************************************
211 * Stacker for raw data handling *
212 **************************************************************************/
215 * Stacker for outgoing data stream
217 const STACKER_NAME_OUTGOING_STREAM = 'outgoing_stream';
220 * Array index for final hash
222 const RAW_FINAL_HASH_INDEX = 'hash';
225 * Array index for encoded data
227 const RAW_ENCODED_DATA_INDEX = 'data';
230 * Array index for sent bytes
232 const RAW_SENT_BYTES_INDEX = 'sent';
235 * Array index for socket resource
237 const RAW_SOCKET_INDEX = 'socket';
240 * Array index for buffer size
242 const RAW_BUFFER_SIZE_INDEX = 'buffer';
245 * Array index for diff between buffer and sent bytes
247 const RAW_DIFF_INDEX = 'diff';
249 /**************************************************************************
251 **************************************************************************/
252 const PROTOCOL_TCP = 'TCP';
253 const PROTOCOL_UDP = 'UDP';
256 * Protected constructor
260 protected function __construct () {
261 // Call parent constructor
262 parent::__construct(__CLASS__);
266 * Creates an instance of this class
268 * @param $compressorInstance A Compressor instance for compressing the content
269 * @return $packageInstance An instance of a Deliverable class
271 public static final function createNetworkPackage (Compressor $compressorInstance) {
273 $packageInstance = new NetworkPackage();
275 // Now set the compressor instance
276 $packageInstance->setCompressorInstance($compressorInstance);
279 * We need to initialize a stack here for our packages even for those
280 * which have no recipient address and stamp... ;-) This stacker will
281 * also be used for incoming raw data to handle it.
283 $stackInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
285 // At last, set it in this class
286 $packageInstance->setStackInstance($stackInstance);
289 $packageInstance->initStacks();
291 // Get a visitor instance for speeding up things and set it
292 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class', array($packageInstance));
293 $packageInstance->setVisitorInstance($visitorInstance);
295 // Get crypto instance and set it, too
296 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
297 $packageInstance->setCryptoInstance($cryptoInstance);
299 // Get a singleton package assembler instance from factory and set it here, too
300 $assemblerInstance = PackageAssemblerFactory::createAssemblerInstance($packageInstance);
301 $packageInstance->setAssemblerInstance($assemblerInstance);
303 // Return the prepared instance
304 return $packageInstance;
308 * Initialize all stackers
310 * @param $forceReInit Whether to force reinitialization of all stacks
313 protected function initStacks ($forceReInit = FALSE) {
315 $this->getStackInstance()->initStacks(array(
316 self::STACKER_NAME_UNDECLARED,
317 self::STACKER_NAME_DECLARED,
318 self::STACKER_NAME_OUTGOING,
319 self::STACKER_NAME_DECODED_INCOMING,
320 self::STACKER_NAME_DECODED_HANDLED,
321 self::STACKER_NAME_DECODED_CHUNKED,
322 self::STACKER_NAME_NEW_MESSAGE,
323 self::STACKER_NAME_PROCESSED_MESSAGE,
324 self::STACKER_NAME_OUTGOING_STREAM
329 * "Getter" for hash from given content
331 * @param $content Raw package content
332 * @return $hash Hash for given package content
334 private function getHashFromContent ($content) {
336 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
339 // @TODO md5() is very weak, but it needs to be fast
342 self::PACKAGE_CHECKSUM_SEPARATOR .
343 $this->getSessionId() .
344 self::PACKAGE_CHECKSUM_SEPARATOR .
345 $this->getCompressorInstance()->getCompressorExtension()
349 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',hash=' . $hash . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
356 * Checks whether the checksum (sometimes called "hash") is the same
358 * @param $decodedContent Package raw content
359 * @param $decodedData Whole raw package data array
360 * @return $isChecksumValid Whether the checksum is the same
362 private function isChecksumValid (array $decodedContent, array $decodedData) {
364 $checksum = $this->getHashFromContentSessionId($decodedContent, $decodedData[self::PACKAGE_DATA_SENDER]);
367 $isChecksumValid = ($checksum == $decodedContent[self::PACKAGE_CONTENT_CHECKSUM]);
370 return $isChecksumValid;
374 * Change the package with given status in given stack
376 * @param $packageData Raw package data in an array
377 * @param $stackerName Name of the stacker
378 * @param $newStatus New status to set
381 private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
382 // Skip this for empty stacks
383 if ($this->getStackInstance()->isStackEmpty($stackerName)) {
384 // This avoids an exception after all packages has failed
388 // Pop the entry (it should be it)
389 $nextData = $this->getStackInstance()->popNamed($stackerName);
391 // Compare both signatures
392 assert($nextData[self::PACKAGE_DATA_SIGNATURE] == $packageData[self::PACKAGE_DATA_SIGNATURE]);
394 // Temporary set the new status
395 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
398 $this->getStackInstance()->pushNamed($stackerName, $packageData);
402 * "Getter" for hash from given content and sender's session id
404 * @param $decodedContent Raw package content
405 * @param $sessionId Session id of the sender
406 * @return $hash Hash for given package content
408 public function getHashFromContentSessionId (array $decodedContent, $sessionId) {
410 //* 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]);
413 // @TODO md5() is very weak, but it needs to be fast
415 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] .
416 self::PACKAGE_CHECKSUM_SEPARATOR .
418 self::PACKAGE_CHECKSUM_SEPARATOR .
419 $decodedContent[self::PACKAGE_CONTENT_EXTENSION]
426 ///////////////////////////////////////////////////////////////////////////
427 // Delivering packages / raw data
428 ///////////////////////////////////////////////////////////////////////////
431 * Declares the given raw package data by discovering recipients
433 * @param $packageData Raw package data in an array
436 private function declareRawPackageData (array $packageData) {
437 // Make sure the required field is there
438 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
441 * We need to disover every recipient, just in case we have a
442 * multi-recipient entry like 'upper' is. 'all' may be a not so good
443 * target because it causes an overload on the network and may be
444 * abused for attacking the network with large packages.
446 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
448 // Discover all recipients, this may throw an exception
449 $discoveryInstance->discoverRecipients($packageData);
451 // Now get an iterator
452 $iteratorInstance = $discoveryInstance->getIterator();
454 // Rewind back to the beginning
455 $iteratorInstance->rewind();
457 // ... and begin iteration
458 while ($iteratorInstance->valid()) {
460 $currentRecipient = $iteratorInstance->current();
463 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Setting recipient to ' . $currentRecipient . ',previous=' . $packageData[self::PACKAGE_DATA_RECIPIENT]);
466 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
468 // Push the declared package to the next stack.
469 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
472 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package declared for recipient ' . $currentRecipient);
474 // Skip to next entry
475 $iteratorInstance->next();
479 * The recipient list can be cleaned up here because the package which
480 * shall be delivered has already been added for all entries from the
483 $discoveryInstance->clearRecipients();
487 * Delivers raw package data. In short, this will discover the raw socket
488 * resource through a discovery class (which will analyse the receipient of
489 * the package), register the socket with the connection (handler/helper?)
490 * instance and finally push the raw data on our outgoing queue.
492 * @param $packageData Raw package data in an array
495 private function deliverRawPackageData (array $packageData) {
497 * This package may become big, depending on the shared object size or
498 * delivered message size which shouldn't be so long (to save
499 * bandwidth). Because of the nature of the used protocol (TCP) we need
500 * to split it up into smaller pieces to fit it into a TCP frame.
502 * So first we need (again) a discovery class but now a protocol
503 * discovery to choose the right socket resource. The discovery class
504 * should take a look at the raw package data itself and then decide
505 * which (configurable!) protocol should be used for that type of
508 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
510 // Now discover the right protocol
511 $socketResource = $discoveryInstance->discoverSocket($packageData, BaseConnectionHelper::CONNECTION_TYPE_OUTGOING);
514 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
517 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: stateInstance=' . $helperInstance->getStateInstance());
518 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
520 // The socket needs to be put in a special registry that can handle such data
521 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
523 // Get the connection helper from registry
524 $helperInstance = Registry::getRegistry()->getInstance('connection');
526 // And make sure it is valid
527 assert($helperInstance instanceof ConnectionHelper);
530 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($helperInstance, $socketResource))) {
532 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Registering socket ' . $socketResource . ' ...');
535 $registryInstance->registerSocket($helperInstance, $socketResource, $packageData);
536 } elseif (!$helperInstance->getStateInstance()->isPeerStateConnected()) {
537 // Is not connected, then we cannot send
538 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Unexpected peer state ' . $helperInstance->getStateInstance()->__toString() . ' detected.');
540 // Shutdown the socket
541 $this->shutdownSocket($socketResource);
545 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
547 // Make sure the connection is up
548 $helperInstance->getStateInstance()->validatePeerStateConnected();
551 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
553 // Enqueue it again on the out-going queue, the connection is up and working at this point
554 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
557 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
561 * Sends waiting packages
563 * @param $packageData Raw package data
566 private function sendOutgoingRawPackageData (array $packageData) {
570 // Get the right connection instance
571 $helperInstance = SocketRegistryFactory::createSocketRegistryInstance()->getHandlerInstanceFromPackageData($packageData);
573 // Is this connection still alive?
574 if ($helperInstance->isShuttedDown()) {
575 // This connection is shutting down
576 // @TODO We may want to do somthing more here?
580 // Sent out package data
581 $helperInstance->sendRawPackageData($packageData);
585 * Generates a signature for given raw package content and sender id
587 * @param $content Raw package data
588 * @param $senderId Sender id to generate a signature for
589 * @return $signature Signature as BASE64-encoded string
591 private function generatePackageSignature ($content, $senderId) {
592 // Hash content and sender id together, use md5() as last algo
593 $hash = md5($this->getCryptoInstance()->hashString($senderId . $content, $this->getPrivateKey(), FALSE));
595 // Encrypt the content again with the hash as a key
596 $encryptedContent = $this->getCryptoInstance()->encryptString($content, $hash);
598 // Encode it with BASE64
599 $signature = base64_encode($encryptedContent);
606 * Checks whether the signature of given package data is 'valid', here that
607 * means it is the same or not.
609 * @param $decodedArray An array with 'decoded' (explode() was mostly called) data
610 * @return $isSignatureValid Whether the signature is valid
611 * @todo Unfinished area, signatures are currently NOT fully supported
613 private function isPackageSignatureValid (array $decodedArray) {
614 // Generate the signature of comparing it
615 $signature = $this->generatePackageSignature($decodedArray[self::INDEX_PACKAGE_CONTENT], $decodedArray[self::INDEX_PACKAGE_SENDER]);
618 //$isSignatureValid =
619 exit(__METHOD__.': signature='.$signature.chr(10).',decodedArray='.print_r($decodedArray, TRUE));
623 * "Enqueues" raw content into this delivery class by reading the raw content
624 * from given helper's template instance and pushing it on the 'undeclared'
627 * @param $helperInstance An instance of a Helper class
628 * @param $protocol Name of used protocol (TCP/UDP)
631 public function enqueueRawDataFromTemplate (Helper $helperInstance, $protocolName) {
632 // Get the raw content ...
633 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
634 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('content(' . strlen($content) . ')=' . $content);
636 // ... and compress it
637 $content = $this->getCompressorInstance()->compressStream($content);
639 // Add magic in front of it and hash behind it, including BASE64 encoding
640 $packageContent = sprintf(self::PACKAGE_MASK,
641 // 1.) Compressor's extension
642 $this->getCompressorInstance()->getCompressorExtension(),
644 self::PACKAGE_MASK_SEPARATOR,
645 // 2.) Raw package content, encoded with BASE64
646 base64_encode($content),
648 self::PACKAGE_MASK_SEPARATOR,
650 implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
652 self::PACKAGE_MASK_SEPARATOR,
654 $this->getHashFromContent($content)
657 // Now prepare the temporary array and push it on the 'undeclared' stack
658 $this->getStackInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
659 self::PACKAGE_DATA_SENDER => $this->getSessionId(),
660 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
661 self::PACKAGE_DATA_PROTOCOL => $protocolName,
662 self::PACKAGE_DATA_CONTENT => $packageContent,
663 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_NEW,
664 self::PACKAGE_DATA_SIGNATURE => $this->generatePackageSignature($packageContent, $this->getSessionId())
669 * Checks whether a package has been enqueued for delivery.
671 * @return $isEnqueued Whether a package is enqueued
673 public function isPackageEnqueued () {
674 // Check whether the stacker is not empty
675 $isEnqueued = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
682 * Checks whether a package has been declared
684 * @return $isDeclared Whether a package is declared
686 public function isPackageDeclared () {
687 // Check whether the stacker is not empty
688 $isDeclared = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
695 * Checks whether a package should be sent out
697 * @return $isWaitingDelivery Whether a package is waiting for delivery
699 public function isPackageWaitingForDelivery () {
700 // Check whether the stacker is not empty
701 $isWaitingDelivery = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
704 return $isWaitingDelivery;
708 * Checks whether encoded (raw) data is pending
710 * @return $isPending Whether encoded data is pending
712 public function isEncodedDataPending () {
713 // Check whether the stacker is not empty
714 $isPending = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
721 * Delivers an enqueued package to the stated destination. If a non-session
722 * id is provided, recipient resolver is being asked (and instanced once).
723 * This allows that a single package is being delivered to multiple targets
724 * without enqueueing it for every target. If no target is provided or it
725 * can't be determined a NoTargetException is being thrown.
728 * @throws NoTargetException If no target can't be determined
730 public function declareEnqueuedPackage () {
731 // Make sure this method isn't working if there is no package enqueued
732 if (!$this->isPackageEnqueued()) {
733 // This is not fatal but should be avoided
734 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw package data waiting declaration, but ' . __METHOD__ . ' has been called!');
739 * Now there are for sure packages to deliver, so start with the first
742 $packageData = $this->getStackInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
744 // Declare the raw package data for delivery
745 $this->declareRawPackageData($packageData);
749 * Delivers the next declared package. Only one package per time will be sent
750 * because this may take time and slows down the whole delivery
755 public function processDeclaredPackage () {
756 // Sanity check if we have packages declared
757 if (!$this->isPackageDeclared()) {
758 // This is not fatal but should be avoided
759 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package has been declared, but ' . __METHOD__ . ' has been called!');
764 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
767 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
769 // Try to deliver the package
771 // And try to send it
772 $this->deliverRawPackageData($packageData);
774 // And remove it finally
775 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
776 } catch (InvalidStateException $e) {
777 // The state is not excepected (shall be 'connected')
778 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
780 // Mark the package with status failed
781 $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
786 * Sends waiting packages out for delivery
790 public function sendWaitingPackage () {
791 // Sanity check if we have packages waiting for delivery
792 if (!$this->isPackageWaitingForDelivery()) {
793 // This is not fatal but should be avoided
794 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
799 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_OUTGOING);
802 // Now try to send it
803 $this->sendOutgoingRawPackageData($packageData);
805 // And remove it finally
806 $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING);
807 } catch (InvalidSocketException $e) {
808 // Output exception message
809 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package was not delivered: ' . $e->getMessage());
811 // Mark package as failed
812 $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
817 * Sends out encoded data to a socket
821 public function sendEncodedData () {
822 // Make sure there is pending encoded data
823 assert($this->isEncodedDataPending());
825 // Pop current data from stack
826 $encodedDataArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
828 // Init in this round sent bytes
832 assert(is_resource($encodedDataArray[self::RAW_SOCKET_INDEX]));
835 //* 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]);
836 if ($encodedDataArray[self::RAW_DIFF_INDEX] >= 0) {
837 // Send all out (encodedData is smaller than or equal buffer size)
838 //* 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]))));
839 $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]));
841 // Send buffer size out
842 //* 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])));
843 $sentBytes = @socket_write($encodedDataArray[self::RAW_SOCKET_INDEX], $encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX]);
846 // If there was an error, we don't continue here
847 if ($sentBytes === FALSE) {
848 // Handle the error with a faked recipientData array
849 $this->handleSocketError(__METHOD__, __LINE__, $encodedDataArray[self::RAW_SOCKET_INDEX], array('0.0.0.0', '0'));
852 throw new InvalidSocketException(array($this, $encodedDataArray[self::RAW_SOCKET_INDEX], $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
853 } elseif (($sentBytes === 0) && (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) > 0)) {
854 // Nothing sent means we are done
855 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
858 // The difference between sent bytes and length of raw data should not go below zero
859 assert((strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) - $sentBytes) >= 0);
861 // Add total sent bytes
862 $encodedDataArray[self::RAW_SENT_BYTES_INDEX] += $sentBytes;
864 // Cut out the last unsent bytes
865 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) . ' bytes ...');
866 $encodedDataArray[self::RAW_ENCODED_DATA_INDEX] = substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $sentBytes);
868 // Calculate difference again
869 $encodedDataArray[self::RAW_DIFF_INDEX] = $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]);
872 if (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) <= 0) {
873 // Abort here, all sent!
874 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
879 // Push array back in stack
880 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
883 ///////////////////////////////////////////////////////////////////////////
884 // Receiving packages / raw data
885 ///////////////////////////////////////////////////////////////////////////
888 * Checks whether decoded raw data is pending
890 * @return $isPending Whether decoded raw data is pending
892 private function isRawDataPending () {
893 // Just return whether the stack is not empty
894 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
901 * Checks whether new raw package data has arrived at a socket
903 * @param $poolInstance An instance of a PoolableListener class
904 * @return $hasArrived Whether new raw package data has arrived for processing
906 public function isNewRawDataPending (PoolableListener $poolInstance) {
907 // Visit the pool. This monitors the pool for incoming raw data.
908 $poolInstance->accept($this->getVisitorInstance());
910 // Check for new data arrival
911 $hasArrived = $this->isRawDataPending();
918 * Handles the incoming decoded raw data. This method does not "convert" the
919 * decoded data back into a package array, it just "handles" it and pushs it
924 public function handleIncomingDecodedData () {
926 * This method should only be called if decoded raw data is pending,
929 if (!$this->isRawDataPending()) {
930 // This is not fatal but should be avoided
931 self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw (decoded?) data is pending, but ' . __METHOD__ . ' has been called!');
935 // Very noisy debug message:
936 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
938 // "Pop" the next entry (the same array again) from the stack
939 $decodedData = $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
941 // Make sure both array elements are there
943 (is_array($decodedData)) &&
944 (isset($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
945 (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
949 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
950 * only want to handle unhandled packages here.
952 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
953 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
955 // Remove the last chunk SEPARATOR (because there is no need for it)
956 if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
957 // It is there and should be removed
958 $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
961 // This package is "handled" and can be pushed on the next stack
962 //* 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 . ' ...');
963 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
967 * Adds raw decoded data from the given handler instance to this receiver
969 * @param $handlerInstance An instance of a Networkable class
972 public function addRawDataToIncomingStack (Networkable $handlerInstance) {
974 * Get the decoded data from the handler, this is an array with
975 * 'raw_data' and 'error_code' as elements.
977 $decodedData = $handlerInstance->getNextRawData();
979 // Very noisy debug message:
980 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, TRUE));
982 // And push it on our stack
983 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
987 * Checks whether incoming decoded data is handled.
989 * @return $isHandled Whether incoming decoded data is handled
991 public function isIncomingRawDataHandled () {
992 // Determine if the stack is not empty
993 $isHandled = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
1000 * Checks whether the assembler has pending data left
1002 * @return $isHandled Whether the assembler has pending data left
1004 public function ifAssemblerHasPendingDataLeft () {
1005 // Determine if the stack is not empty
1006 $isHandled = (!$this->getAssemblerInstance()->isPendingDataEmpty());
1013 * Checks whether the assembler has multiple packages pending
1015 * @return $isPending Whether the assembler has multiple packages pending
1017 public function ifMultipleMessagesPending () {
1018 // Determine if the stack is not empty
1019 $isPending = ($this->getAssemblerInstance()->ifMultipleMessagesPending());
1026 * Handles the attached assemler's pending data queue to be finally
1027 * assembled to the raw package data back.
1031 public function handleAssemblerPendingData () {
1033 $this->getAssemblerInstance()->handlePendingData();
1037 * Handles multiple messages.
1041 public function handleMultipleMessages () {
1043 $this->getAssemblerInstance()->handleMultipleMessages();
1047 * Assembles incoming decoded data so it will become an abstract network
1048 * package again. The assembler does later do it's job by an other task,
1049 * not this one to keep best speed possible.
1053 public function assembleDecodedDataToPackage () {
1054 // Make sure the raw decoded package data is handled
1055 assert($this->isIncomingRawDataHandled());
1057 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
1058 $packageContent = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
1060 // Assert on some elements
1062 (is_array($packageContent)) &&
1063 (isset($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1064 (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1067 // Start assembling the raw package data array by chunking it
1068 $this->getAssemblerInstance()->chunkPackageContent($packageContent);
1070 // Remove the package from 'handled_decoded' stack ...
1071 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
1073 // ... and push it on the 'chunked' stacker
1074 //* 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));
1075 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
1079 * Accepts the visitor to process the visit "request"
1081 * @param $visitorInstance An instance of a Visitor class
1084 public function accept (Visitor $visitorInstance) {
1086 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - START');
1088 // Visit the package
1089 $visitorInstance->visitNetworkPackage($this);
1091 // Then visit the assembler to handle multiple packages
1092 $this->getAssemblerInstance()->accept($visitorInstance);
1095 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - FINISHED');
1103 public function clearAllStacks () {
1104 // Call the init method to force re-initialization
1105 $this->initStacks(TRUE);
1108 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: All stacker have been re-initialized.');
1112 * Removes the first failed outoging package from the stack to continue
1113 * with next one (it will never work until the issue is fixed by you).
1116 * @throws UnexpectedPackageStatusException If the package status is not 'failed'
1117 * @todo This may be enchanced for outgoing packages?
1119 public function removeFirstFailedPackage () {
1120 // Get the package again
1121 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
1123 // Is the package status 'failed'?
1124 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
1126 throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
1129 // Remove this entry
1130 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
1134 * "Decode" the package content into the same array when it was sent.
1136 * @param $rawPackageContent The raw package content to be "decoded"
1137 * @return $decodedData An array with 'sender', 'recipient', 'content' and 'status' elements
1139 public function decodeRawContent ($rawPackageContent) {
1140 // Use the separator '#' to "decode" it
1141 $decodedArray = explode(self::PACKAGE_DATA_SEPARATOR, $rawPackageContent);
1143 // Assert on count (should be always 3)
1144 assert(count($decodedArray) == self::DECODED_DATA_ARRAY_SIZE);
1146 // Generate the signature of comparing it
1148 * @todo Unsupported feature of "signed" messages commented out
1149 if (!$this->isPackageSignatureValid($decodedArray)) {
1150 // Is not valid, so throw an exception here
1151 exit(__METHOD__ . ':INVALID SIG! UNDER CONSTRUCTION!' . chr(10));
1156 * Create 'decodedData' array with all assoziative array elements,
1159 $decodedData = array(
1160 self::PACKAGE_DATA_SENDER => $decodedArray[self::INDEX_PACKAGE_SENDER],
1161 self::PACKAGE_DATA_RECIPIENT => $decodedArray[self::INDEX_PACKAGE_RECIPIENT],
1162 self::PACKAGE_DATA_CONTENT => $decodedArray[self::INDEX_PACKAGE_CONTENT],
1163 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_DECODED
1167 return $decodedData;
1171 * Handles decoded data for this node by "decoding" the 'content' part of
1172 * it. Again this method uses explode() for the "decoding" process.
1174 * @param $decodedData An array with decoded raw package data
1176 * @throws InvalidDataChecksumException If the checksum doesn't match
1178 public function handleRawData (array $decodedData) {
1180 * "Decode" the package's content by a simple explode() call, for
1181 * details of the array elements, see comments for constant
1184 $decodedContent = explode(self::PACKAGE_MASK_SEPARATOR, $decodedData[self::PACKAGE_DATA_CONTENT]);
1186 // Assert on array count for a very basic validation
1187 assert(count($decodedContent) == self::PACKAGE_CONTENT_ARRAY_SIZE);
1190 * Convert the indexed array into an associative array. This is much
1191 * better to remember than plain numbers, isn't it?
1193 $decodedContent = array(
1194 // Compressor's extension used to compress the data
1195 self::PACKAGE_CONTENT_EXTENSION => $decodedContent[self::INDEX_COMPRESSOR_EXTENSION],
1196 // Package data (aka "message") in BASE64-decoded form but still compressed
1197 self::PACKAGE_CONTENT_MESSAGE => base64_decode($decodedContent[self::INDEX_PACKAGE_DATA]),
1198 // Tags as an indexed array for "tagging" the message
1199 self::PACKAGE_CONTENT_TAGS => explode(self::PACKAGE_TAGS_SEPARATOR, $decodedContent[self::INDEX_TAGS]),
1200 // Checksum of the _decoded_ data
1201 self::PACKAGE_CONTENT_CHECKSUM => $decodedContent[self::INDEX_CHECKSUM]
1204 // Is the checksum valid?
1205 if (!$this->isChecksumValid($decodedContent, $decodedData)) {
1206 // Is not the same, so throw an exception here
1207 throw new InvalidDataChecksumException(array($this, $decodedContent, $decodedData), BaseListener::EXCEPTION_INVALID_DATA_CHECKSUM);
1211 * The checksum is the same, then it can be decompressed safely. The
1212 * original message is at this point fully decoded.
1214 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
1216 // And push it on the next stack
1217 $this->getStackInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
1221 * Checks whether a new message has arrived
1223 * @return $hasArrived Whether a new message has arrived for processing
1225 public function isNewMessageArrived () {
1226 // Determine if the stack is not empty
1227 $hasArrived = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
1234 * Handles newly arrived messages
1237 * @todo Implement verification of all sent tags here?
1239 public function handleNewlyArrivedMessage () {
1240 // Get it from the stacker, it is the full array with the decoded message
1241 $decodedContent = $this->getStackInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
1243 // Now get a filter chain back from factory with given tags array
1244 $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
1247 * Process the message through all filters, note that all other
1248 * elements from $decodedContent are no longer needed.
1250 $chainInstance->processMessage($decodedContent[self::PACKAGE_CONTENT_MESSAGE], $this);
1254 * Checks whether a processed message is pending for "interpretation"
1256 * @return $isPending Whether a processed message is pending
1258 public function isProcessedMessagePending () {
1260 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
1267 * Handle processed messages by "interpreting" the 'message_type' element
1271 public function handleProcessedMessage () {
1272 // Get it from the stacker, it is the full array with the processed message
1273 $messageArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
1275 // Add type for later easier handling
1276 $messageArray[self::MESSAGE_ARRAY_DATA][self::MESSAGE_ARRAY_TYPE] = $messageArray[self::MESSAGE_ARRAY_TYPE];
1279 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: messageArray=' . print_r($messageArray, TRUE));
1281 // Create a handler instance from given message type
1282 $handlerInstance = MessageTypeHandlerFactory::createMessageTypeHandlerInstance($messageArray[self::MESSAGE_ARRAY_TYPE]);
1284 // Handle message data
1285 $handlerInstance->handleMessageData($messageArray[self::MESSAGE_ARRAY_DATA], $this);