application/hub/main/package/class_NetworkPackage.php

   1 <?php
   2 /**
   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
   7  * packages.
   8  *
   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
  13  * Internet.
  14  *
  15  * For performance reasons, this class should only be instanciated once and then
  16  * used as a "pipe-through" class.
  17  *
  18  * @author              Roland Haeder <webmaster@shipsimu.org>
  19  * @version             0.0.0
  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
  24  *
  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.
  29  *
  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.
  34  *
  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/>.
  37  */
  38 class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, Registerable, Visitable {
  39         /**
  40          * Package mask for compressing package data:
  41          * 0: Compressor extension
  42          * 1: Raw package data
  43          * 2: Tags, seperated by semicolons, no semicolon is required if only one tag is needed
  44          * 3: Checksum
  45          *                     0  1  2  3
  46          */
  47         const PACKAGE_MASK = '%s%s%s%s%s%s%s';
  48
  49         /**
  50          * Separator for the above mask
  51          */
  52         const PACKAGE_MASK_SEPARATOR = '^';
  53
  54         /**
  55          * Size of an array created by invoking
  56          * explode(NetworkPackage::PACKAGE_MASK_SEPARATOR, $content).
  57          */
  58         const PACKAGE_CONTENT_ARRAY_SIZE = 4;
  59
  60         /**
  61          * Separator for checksum
  62          */
  63         const PACKAGE_CHECKSUM_SEPARATOR = '_';
  64
  65         /**
  66          * Array indexes for above mask, start with zero
  67          */
  68         const INDEX_COMPRESSOR_EXTENSION = 0;
  69         const INDEX_PACKAGE_DATA         = 1;
  70         const INDEX_TAGS                 = 2;
  71         const INDEX_CHECKSUM             = 3;
  72
  73         /**
  74          * Array indexes for raw package array
  75          */
  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
  82         /**
  83          * Size of the decoded data array
  84          */
  85         const DECODED_DATA_ARRAY_SIZE = 5;
  86
  87         /**
  88          * Named array elements for decoded package content
  89          */
  90         const PACKAGE_CONTENT_EXTENSION = 'compressor';
  91         const PACKAGE_CONTENT_MESSAGE   = 'message';
  92         const PACKAGE_CONTENT_TAGS      = 'tags';
  93         const PACKAGE_CONTENT_CHECKSUM  = 'checksum';
  94         const PACKAGE_CONTENT_SENDER    = 'sender';
  95         const PACKAGE_CONTENT_HASH      = 'hash';
  96
  97         /**
  98          * Named array elements for package data
  99          */
 100         const PACKAGE_DATA_SENDER    = 'sender';
 101         const PACKAGE_DATA_RECIPIENT = 'recipient';
 102         const PACKAGE_DATA_CONTENT   = 'content';
 103         const PACKAGE_DATA_STATUS    = 'status';
 104         const PACKAGE_DATA_HASH      = 'hash';
 105
 106         /**
 107          * All package status
 108          */
 109         const PACKAGE_STATUS_NEW     = 'new';
 110         const PACKAGE_STATUS_FAILED  = 'failed';
 111         const PACKAGE_STATUS_DECODED = 'decoded';
 112         const PACKAGE_STATUS_FAKED   = 'faked';
 113
 114         /**
 115          * Constants for message data array
 116          */
 117         const MESSAGE_ARRAY_DATA = 'message_data';
 118         const MESSAGE_ARRAY_TYPE = 'message_type';
 119
 120         /**
 121          * Generic answer status field
 122          */
 123
 124         /**
 125          * Tags separator
 126          */
 127         const PACKAGE_TAGS_SEPARATOR = ';';
 128
 129         /**
 130          * Raw package data separator
 131          */
 132         const PACKAGE_DATA_SEPARATOR = '#';
 133
 134         /**
 135          * Separator for more than one recipient
 136          */
 137         const PACKAGE_RECIPIENT_SEPARATOR = ':';
 138
 139         /**
 140          * Network target (alias): 'upper nodes'
 141          */
 142         const NETWORK_TARGET_UPPER = 'upper';
 143
 144         /**
 145          * Network target (alias): 'self'
 146          */
 147         const NETWORK_TARGET_SELF = 'self';
 148
 149         /**
 150          * Network target (alias): 'dht'
 151          */
 152         const NETWORK_TARGET_DHT = 'dht';
 153
 154         /**
 155          * TCP package size in bytes
 156          */
 157         const TCP_PACKAGE_SIZE = 512;
 158
 159         /**************************************************************************
 160          *                    Stacker for out-going packages                      *
 161          **************************************************************************/
 162
 163         /**
 164          * Stacker name for "undeclared" packages
 165          */
 166         const STACKER_NAME_UNDECLARED = 'package_undeclared';
 167
 168         /**
 169          * Stacker name for "declared" packages (which are ready to send out)
 170          */
 171         const STACKER_NAME_DECLARED = 'package_declared';
 172
 173         /**
 174          * Stacker name for "out-going" packages
 175          */
 176         const STACKER_NAME_OUTGOING = 'package_outgoing';
 177
 178         /**************************************************************************
 179          *                     Stacker for incoming packages                      *
 180          **************************************************************************/
 181
 182         /**
 183          * Stacker name for "incoming" decoded raw data
 184          */
 185         const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
 186
 187         /**
 188          * Stacker name for handled decoded raw data
 189          */
 190         const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
 191
 192         /**
 193          * Stacker name for "chunked" decoded raw data
 194          */
 195         const STACKER_NAME_DECODED_CHUNKED = 'package_chunked_decoded';
 196
 197         /**************************************************************************
 198          *                     Stacker for incoming messages                      *
 199          **************************************************************************/
 200
 201         /**
 202          * Stacker name for new messages
 203          */
 204         const STACKER_NAME_NEW_MESSAGE = 'package_new_message';
 205
 206         /**
 207          * Stacker name for processed messages
 208          */
 209         const STACKER_NAME_PROCESSED_MESSAGE = 'package_processed_message';
 210
 211         /**************************************************************************
 212          *                      Stacker for raw data handling                     *
 213          **************************************************************************/
 214
 215         /**
 216          * Stacker for outgoing data stream
 217          */
 218         const STACKER_NAME_OUTGOING_STREAM = 'outgoing_stream';
 219
 220         /**
 221          * Array index for final hash
 222          */
 223         const RAW_FINAL_HASH_INDEX = 'hash';
 224
 225         /**
 226          * Array index for encoded data
 227          */
 228         const RAW_ENCODED_DATA_INDEX = 'data';
 229
 230         /**
 231          * Array index for sent bytes
 232          */
 233         const RAW_SENT_BYTES_INDEX = 'sent';
 234
 235         /**
 236          * Array index for socket resource
 237          */
 238         const RAW_SOCKET_INDEX = 'socket';
 239
 240         /**
 241          * Array index for buffer size
 242          */
 243         const RAW_BUFFER_SIZE_INDEX = 'buffer';
 244
 245         /**
 246          * Array index for diff between buffer and sent bytes
 247          */
 248         const RAW_DIFF_INDEX = 'diff';
 249
 250         /**************************************************************************
 251          *                            Protocol names                              *
 252          **************************************************************************/
 253         const PROTOCOL_TCP = 'TCP';
 254         const PROTOCOL_UDP = 'UDP';
 255
 256         /**
 257          * Protected constructor
 258          *
 259          * @return      void
 260          */
 261         protected function __construct () {
 262                 // Call parent constructor
 263                 parent::__construct(__CLASS__);
 264         }
 265
 266         /**
 267          * Creates an instance of this class
 268          *
 269          * @param       $compressorInstance             A Compressor instance for compressing the content
 270          * @return      $packageInstance                An instance of a Deliverable class
 271          */
 272         public static final function createNetworkPackage (Compressor $compressorInstance) {
 273                 // Get new instance
 274                 $packageInstance = new NetworkPackage();
 275
 276                 // Now set the compressor instance
 277                 $packageInstance->setCompressorInstance($compressorInstance);
 278
 279                 /*
 280                  * We need to initialize a stack here for our packages even for those
 281                  * which have no recipient address and stamp... ;-) This stacker will
 282                  * also be used for incoming raw data to handle it.
 283                  */
 284                 $stackInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
 285
 286                 // At last, set it in this class
 287                 $packageInstance->setStackInstance($stackInstance);
 288
 289                 // Init all stacker
 290                 $packageInstance->initStacks();
 291
 292                 // Get a visitor instance for speeding up things and set it
 293                 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class');
 294                 $packageInstance->setVisitorInstance($visitorInstance);
 295
 296                 // Get crypto instance and set it, too
 297                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
 298                 $packageInstance->setCryptoInstance($cryptoInstance);
 299
 300                 // Get a singleton package assembler instance from factory and set it here, too
 301                 $assemblerInstance = PackageAssemblerFactory::createAssemblerInstance($packageInstance);
 302                 $packageInstance->setAssemblerInstance($assemblerInstance);
 303
 304                 // Get node instance
 305                 $nodeInstance = NodeObjectFactory::createNodeInstance();
 306
 307                 // Get pool instance from node
 308                 $poolInstance = $nodeInstance->getListenerPoolInstance();
 309
 310                 // And set it here
 311                 $packageInstance->setListenerPoolInstance($poolInstance);
 312
 313                 // Return the prepared instance
 314                 return $packageInstance;
 315         }
 316
 317         /**
 318          * Initialize all stackers
 319          *
 320          * @param       $forceReInit    Whether to force reinitialization of all stacks
 321          * @return      void
 322          */
 323         protected function initStacks ($forceReInit = FALSE) {
 324                 // Initialize all
 325                 $this->getStackInstance()->initStacks(array(
 326                         self::STACKER_NAME_UNDECLARED,
 327                         self::STACKER_NAME_DECLARED,
 328                         self::STACKER_NAME_OUTGOING,
 329                         self::STACKER_NAME_DECODED_INCOMING,
 330                         self::STACKER_NAME_DECODED_HANDLED,
 331                         self::STACKER_NAME_DECODED_CHUNKED,
 332                         self::STACKER_NAME_NEW_MESSAGE,
 333                         self::STACKER_NAME_PROCESSED_MESSAGE,
 334                         self::STACKER_NAME_OUTGOING_STREAM
 335                 ), $forceReInit);
 336         }
 337
 338         /**
 339          * Determines private key hash from given session id
 340          *
 341          * @param       $sessionId      Session id
 342          * @return      $hash           Private key's hash
 343          */
 344         private function determineSenderPrivateKeyHash ($sessionId) {
 345                 // Get DHT instance
 346                 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
 347
 348                 // Ask DHT for session id
 349                 $senderData = $dhtInstance->findNodeLocalBySessionId($sessionId);
 350
 351                 // Is an entry found?
 352                 if (count($senderData) > 0) {
 353                         // Make sure the element 'private_key_hash' is there
 354                         /* NOISY-DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: senderData=' . print_r($senderData, TRUE));
 355                         assert(isset($senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH]));
 356
 357                         // Return it
 358                         return $senderData[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH];
 359                 } // END - if
 360         }
 361
 362         /**
 363          * "Getter" for hash from given content
 364          *
 365          * @param       $content        Raw package content
 366          * @return      $hash           Hash for given package content
 367          */
 368         private function getHashFromContent ($content) {
 369                 // Debug message
 370                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
 371
 372                 // Create the hash
 373                 // @TODO md5() is very weak, but it needs to be fast
 374                 $hash = md5(
 375                         $content .
 376                         self::PACKAGE_CHECKSUM_SEPARATOR .
 377                         $this->getSessionId() .
 378                         self::PACKAGE_CHECKSUM_SEPARATOR .
 379                         $this->getCompressorInstance()->getCompressorExtension()
 380                 );
 381
 382                 // Debug message
 383                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: content[md5]=' . md5($content) . ',sender=' . $this->getSessionId() . ',hash=' . $hash . ',compressor=' . $this->getCompressorInstance()->getCompressorExtension());
 384
 385                 // And return it
 386                 return $hash;
 387         }
 388
 389         /**
 390          * Checks whether the checksum (sometimes called "hash") is the same
 391          *
 392          * @param       $decodedContent         Package raw content
 393          * @param       $decodedData            Whole raw package data array
 394          * @return      $isChecksumValid        Whether the checksum is the same
 395          */
 396         private function isChecksumValid (array $decodedContent, array $decodedData) {
 397                 // Get checksum
 398                 $checksum = $this->getHashFromContentSessionId($decodedContent, $decodedData[self::PACKAGE_DATA_SENDER]);
 399
 400                 // Is it the same?
 401                 $isChecksumValid = ($checksum == $decodedContent[self::PACKAGE_CONTENT_CHECKSUM]);
 402
 403                 // Return it
 404                 return $isChecksumValid;
 405         }
 406
 407         /**
 408          * Change the package with given status in given stack
 409          *
 410          * @param       $packageData    Raw package data in an array
 411          * @param       $stackerName    Name of the stacker
 412          * @param       $newStatus              New status to set
 413          * @return      void
 414          */
 415         private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
 416                 // Skip this for empty stacks
 417                 if ($this->getStackInstance()->isStackEmpty($stackerName)) {
 418                         // This avoids an exception after all packages has failed
 419                         return;
 420                 } // END - if
 421
 422                 // Pop the entry (it should be it)
 423                 $nextData = $this->getStackInstance()->popNamed($stackerName);
 424
 425                 // Compare both hashes
 426                 assert($nextData[self::PACKAGE_DATA_HASH] == $packageData[self::PACKAGE_DATA_HASH]);
 427
 428                 // Temporary set the new status
 429                 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
 430
 431                 // And push it again
 432                 $this->getStackInstance()->pushNamed($stackerName, $packageData);
 433         }
 434
 435         /**
 436          * "Getter" for hash from given content and sender's session id
 437          *
 438          * @param       $decodedContent         Raw package content
 439          * @param       $sessionId                      Session id of the sender
 440          * @return      $hash                           Hash for given package content
 441          */
 442         public function getHashFromContentSessionId (array $decodedContent, $sessionId) {
 443                 // Debug message
 444                 //* 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]);
 445
 446                 // Create the hash
 447                 // @TODO md5() is very weak, but it needs to be fast
 448                 $hash = md5(
 449                         $decodedContent[self::PACKAGE_CONTENT_MESSAGE] .
 450                         self::PACKAGE_CHECKSUM_SEPARATOR .
 451                         $sessionId .
 452                         self::PACKAGE_CHECKSUM_SEPARATOR .
 453                         $decodedContent[self::PACKAGE_CONTENT_EXTENSION]
 454                 );
 455
 456                 // And return it
 457                 return $hash;
 458         }
 459
 460         ///////////////////////////////////////////////////////////////////////////
 461         //                   Delivering packages / raw data
 462         ///////////////////////////////////////////////////////////////////////////
 463
 464         /**
 465          * Declares the given raw package data by discovering recipients
 466          *
 467          * @param       $packageData    Raw package data in an array
 468          * @return      void
 469          */
 470         private function declareRawPackageData (array $packageData) {
 471                 // Make sure the required field is there
 472                 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
 473
 474                 /*
 475                  * We need to disover every recipient, just in case we have a
 476                  * multi-recipient entry like 'upper' is. 'all' may be a not so good
 477                  * target because it causes an overload on the network and may be
 478                  * abused for attacking the network with large packages.
 479                  */
 480                 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
 481
 482                 // Discover all recipients, this may throw an exception
 483                 $discoveryInstance->discoverRecipients($packageData);
 484
 485                 // Now get an iterator
 486                 $iteratorInstance = $discoveryInstance->getIterator();
 487
 488                 // Make sure the iterator instance is valid
 489                 assert($iteratorInstance instanceof Iterator);
 490
 491                 // Rewind back to the beginning
 492                 $iteratorInstance->rewind();
 493
 494                 // ... and begin iteration
 495                 while ($iteratorInstance->valid()) {
 496                         // Get current entry
 497                         $currentRecipient = $iteratorInstance->current();
 498
 499                         // Debug message
 500                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Setting recipient to ' . $currentRecipient . ',previous=' . $packageData[self::PACKAGE_DATA_RECIPIENT]);
 501
 502                         // Set the recipient
 503                         $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
 504
 505                         // Push the declared package to the next stack.
 506                         $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
 507
 508                         // Debug message
 509                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package declared for recipient ' . $currentRecipient);
 510
 511                         // Skip to next entry
 512                         $iteratorInstance->next();
 513                 } // END - while
 514
 515                 /*
 516                  * The recipient list can be cleaned up here because the package which
 517                  * shall be delivered has already been added for all entries from the
 518                  * list.
 519                  */
 520                 $discoveryInstance->clearRecipients();
 521         }
 522
 523         /**
 524          * Delivers raw package data. In short, this will discover the raw socket
 525          * resource through a discovery class (which will analyse the receipient of
 526          * the package), register the socket with the connection (handler/helper?)
 527          * instance and finally push the raw data on our outgoing queue.
 528          *
 529          * @param       $packageData    Raw package data in an array
 530          * @return      void
 531          */
 532         private function deliverRawPackageData (array $packageData) {
 533                 /*
 534                  * This package may become big, depending on the shared object size or
 535                  * delivered message size which shouldn't be so long (to save
 536                  * bandwidth). Because of the nature of the used protocol (TCP) we need
 537                  * to split it up into smaller pieces to fit it into a TCP frame.
 538                  *
 539                  * So first we need (again) a discovery class but now a protocol
 540                  * discovery to choose the right socket resource. The discovery class
 541                  * should take a look at the raw package data itself and then decide
 542                  * which (configurable!) protocol should be used for that type of
 543                  * package.
 544                  */
 545                 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
 546
 547                 // Now discover the right protocol
 548                 $socketResource = $discoveryInstance->discoverSocket($packageData, BaseConnectionHelper::CONNECTION_TYPE_OUTGOING);
 549
 550                 // Debug message
 551                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
 552
 553                 // Debug message
 554                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: stateInstance=' . $helperInstance->getStateInstance());
 555                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
 556
 557                 // The socket needs to be put in a special registry that can handle such data
 558                 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
 559
 560                 // Get the connection helper from registry
 561                 $helperInstance = Registry::getRegistry()->getInstance('connection');
 562
 563                 // And make sure it is valid
 564                 assert($helperInstance instanceof ConnectionHelper);
 565
 566                 // Get connection info class
 567                 $infoInstance = ConnectionInfoFactory::createConnectionInfoInstance($helperInstance->getProtocolName(), 'helper');
 568
 569                 // Will the info instance with connection helper data
 570                 $infoInstance->fillWithConnectionHelperInformation($helperInstance);
 571
 572                 // Is it not there?
 573                 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($infoInstance, $socketResource))) {
 574                         // Debug message
 575                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Registering socket ' . $socketResource . ' ...');
 576
 577                         // Then register it
 578                         $registryInstance->registerSocket($infoInstance, $socketResource, $packageData);
 579                 } elseif (!$helperInstance->getStateInstance()->isPeerStateConnected()) {
 580                         // Is not connected, then we cannot send
 581                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Unexpected peer state ' . $helperInstance->getStateInstance()->__toString() . ' detected.');
 582
 583                         // Shutdown the socket
 584                         $this->shutdownSocket($socketResource);
 585                 }
 586
 587                 // Debug message
 588                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
 589
 590                 // Make sure the connection is up
 591                 $helperInstance->getStateInstance()->validatePeerStateConnected();
 592
 593                 // Debug message
 594                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
 595
 596                 // Enqueue it again on the out-going queue, the connection is up and working at this point
 597                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
 598
 599                 // Debug message
 600                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
 601         }
 602
 603         /**
 604          * Sends waiting packages
 605          *
 606          * @param       $packageData    Raw package data
 607          * @return      void
 608          */
 609         private function sendOutgoingRawPackageData (array $packageData) {
 610                 // Init sent bytes
 611                 $sentBytes = 0;
 612
 613                 // Get the right connection instance
 614                 $infoInstance = SocketRegistryFactory::createSocketRegistryInstance()->getInfoInstanceFromPackageData($packageData);
 615
 616                 // Test helper instance
 617                 assert($infoInstance instanceof ShareableInfo);
 618
 619                 // Get helper instance
 620                 $helperInstance = $infoInstance->getHelperInstance();
 621
 622                 // Some sanity-checks on the object
 623                 //* DEBUG-DIE: */ die('[' . __METHOD__ . ':' . __LINE__ . ']: p1=' . $infoInstance->getProtocolName() . ',p2=' . $helperInstance->getProtocolName() . ',infoInstance=' . print_r($infoInstance, TRUE));
 624                 assert($helperInstance instanceof ConnectionHelper);
 625                 assert($infoInstance->getProtocolName() == $helperInstance->getProtocolName());
 626
 627                 // Is this connection still alive?
 628                 if ($helperInstance->isShuttedDown()) {
 629                         // This connection is shutting down
 630                         // @TODO We may want to do somthing more here?
 631                         return;
 632                 } // END - if
 633
 634                 // Sent out package data
 635                 $helperInstance->sendRawPackageData($packageData);
 636         }
 637
 638         /**
 639          * Generates a secure hash for given raw package content and sender id
 640          *
 641          * @param       $content        Raw package data
 642          * @param       $senderId       Sender id to generate a hash for
 643          * @return      $hash   Hash as hex-encoded string
 644          */
 645         private function generatePackageHash ($content, $senderId) {
 646                 // Hash content and sender id together, use scrypt
 647                 $hash = Scrypt::hashScrypt($senderId . ':' . $content . ':' . $this->determineSenderPrivateKeyHash($senderId));
 648
 649                 // Return it
 650                 return $hash;
 651         }
 652
 653         /**
 654          * Checks whether the hash of given package data is 'valid', here that
 655          * means it is the same or not.
 656          *
 657          * @param       $decodedArray           An array with 'decoded' (explode() was mostly called) data
 658          * @return      $isHashValid    Whether the hash is valid
 659          * @todo        Unfinished area, hashes are currently NOT fully supported
 660          */
 661         private function isPackageHashValid (array $decodedArray) {
 662                 // Check validity
 663                 $isHashValid = Scrypt::checkScrypt($decodedArray[self::INDEX_PACKAGE_SENDER] . ':' . $decodedArray[self::INDEX_PACKAGE_CONTENT] . ':' . $this->determineSenderPrivateKeyHash($decodedArray[self::INDEX_PACKAGE_SENDER]), $decodedArray[self::INDEX_PACKAGE_HASH]);
 664
 665                 // Return it
 666                 //* DEBUG-DIE: */ die(__METHOD__ . ': isHashValid=' . intval($isHashValid) . chr(10) . ',decodedArray=' . print_r($decodedArray, TRUE));
 667                 return $isHashValid;
 668         }
 669
 670         /**
 671          * "Enqueues" raw content into this delivery class by reading the raw content
 672          * from given helper's template instance and pushing it on the 'undeclared'
 673          * stack.
 674          *
 675          * @param       $helperInstance         An instance of a HubHelper class
 676          * @return      void
 677          */
 678         public function enqueueRawDataFromTemplate (HubHelper $helperInstance) {
 679                 // Debug message
 680                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
 681
 682                 // Get the raw content ...
 683                 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
 684                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('content(' . strlen($content) . ')=' . $content);
 685
 686                 // ... and compress it
 687                 $content = $this->getCompressorInstance()->compressStream($content);
 688
 689                 // Add magic in front of it and hash behind it, including BASE64 encoding
 690                 $packageContent = sprintf(self::PACKAGE_MASK,
 691                         // 1.) Compressor's extension
 692                         $this->getCompressorInstance()->getCompressorExtension(),
 693                         // - separator
 694                         self::PACKAGE_MASK_SEPARATOR,
 695                         // 2.) Raw package content, encoded with BASE64
 696                         base64_encode($content),
 697                         // - separator
 698                         self::PACKAGE_MASK_SEPARATOR,
 699                         // 3.) Tags
 700                         implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
 701                         // - separator
 702                         self::PACKAGE_MASK_SEPARATOR,
 703                         // 4.) Checksum
 704                         $this->getHashFromContent($content)
 705                 );
 706
 707                 // Debug message
 708                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': Enqueueing package for recipientType=' . $helperInstance->getRecipientType() . ' ...');
 709
 710                 // Now prepare the temporary array and push it on the 'undeclared' stack
 711                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
 712                         self::PACKAGE_DATA_SENDER    => $this->getSessionId(),
 713                         self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
 714                         self::PACKAGE_DATA_CONTENT   => $packageContent,
 715                         self::PACKAGE_DATA_STATUS    => self::PACKAGE_STATUS_NEW,
 716                         self::PACKAGE_DATA_HASH      => $this->generatePackageHash($packageContent, $this->getSessionId())
 717                 ));
 718
 719                 // Debug message
 720                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
 721         }
 722
 723         /**
 724          * Checks whether a package has been enqueued for delivery.
 725          *
 726          * @return      $isEnqueued             Whether a package is enqueued
 727          */
 728         public function isPackageEnqueued () {
 729                 // Check whether the stacker is not empty
 730                 $isEnqueued = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
 731
 732                 // Return the result
 733                 return $isEnqueued;
 734         }
 735
 736         /**
 737          * Checks whether a package has been declared
 738          *
 739          * @return      $isDeclared             Whether a package is declared
 740          */
 741         public function isPackageDeclared () {
 742                 // Check whether the stacker is not empty
 743                 $isDeclared = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
 744
 745                 // Return the result
 746                 return $isDeclared;
 747         }
 748
 749         /**
 750          * Checks whether a package should be sent out
 751          *
 752          * @return      $isWaitingDelivery      Whether a package is waiting for delivery
 753          */
 754         public function isPackageWaitingForDelivery () {
 755                 // Check whether the stacker is not empty
 756                 $isWaitingDelivery = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
 757
 758                 // Return the result
 759                 return $isWaitingDelivery;
 760         }
 761
 762         /**
 763          * Checks whether encoded (raw) data is pending
 764          *
 765          * @return      $isPending              Whether encoded data is pending
 766          */
 767         public function isEncodedDataPending () {
 768                 // Check whether the stacker is not empty
 769                 $isPending = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
 770
 771                 // Return the result
 772                 return $isPending;
 773         }
 774
 775         /**
 776          * Delivers an enqueued package to the stated destination. If a non-session
 777          * id is provided, recipient resolver is being asked (and instanced once).
 778          * This allows that a single package is being delivered to multiple targets
 779          * without enqueueing it for every target. If no target is provided or it
 780          * can't be determined a NoTargetException is being thrown.
 781          *
 782          * @return      void
 783          * @throws      NoTargetException       If no target can't be determined
 784          */
 785         public function declareEnqueuedPackage () {
 786                 // Debug message
 787                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
 788
 789                 // Make sure this method isn't working if there is no package enqueued
 790                 if (!$this->isPackageEnqueued()) {
 791                         // This is not fatal but should be avoided
 792                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw package data waiting declaration, but ' . __METHOD__ . ' has been called!');
 793                         return;
 794                 } // END - if
 795
 796                 /*
 797                  * Now there are for sure packages to deliver, so start with the first
 798                  * one.
 799                  */
 800                 $packageData = $this->getStackInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
 801
 802                 // Declare the raw package data for delivery
 803                 $this->declareRawPackageData($packageData);
 804
 805                 // Debug message
 806                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
 807         }
 808
 809         /**
 810          * Delivers the next declared package. Only one package per time will be sent
 811          * because this may take time and slows down the whole delivery
 812          * infrastructure.
 813          *
 814          * @return      void
 815          */
 816         public function processDeclaredPackage () {
 817                 // Debug message
 818                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
 819
 820                 // Sanity check if we have packages declared
 821                 if (!$this->isPackageDeclared()) {
 822                         // This is not fatal but should be avoided
 823                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package has been declared, but ' . __METHOD__ . ' has been called!');
 824                         return;
 825                 } // END - if
 826
 827                 // Get the package
 828                 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
 829
 830                 // Assert on it
 831                 assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
 832
 833                 // Try to deliver the package
 834                 try {
 835                         // And try to send it
 836                         $this->deliverRawPackageData($packageData);
 837
 838                         // And remove it finally
 839                         $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
 840                 } catch (InvalidStateException $e) {
 841                         // The state is not excepected (shall be 'connected')
 842                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
 843
 844                         // Mark the package with status failed
 845                         $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
 846                 }
 847
 848                 // Debug message
 849                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
 850         }
 851
 852         /**
 853          * Sends waiting packages out for delivery
 854          *
 855          * @return      void
 856          */
 857         public function sendWaitingPackage () {
 858                 // Debug message
 859                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
 860
 861                 // Sanity check if we have packages waiting for delivery
 862                 if (!$this->isPackageWaitingForDelivery()) {
 863                         // This is not fatal but should be avoided
 864                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
 865                         return;
 866                 } // END - if
 867
 868                 // Get the package
 869                 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_OUTGOING);
 870
 871                 try {
 872                         // Now try to send it
 873                         $this->sendOutgoingRawPackageData($packageData);
 874
 875                         // And remove it finally
 876                         $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING);
 877                 } catch (InvalidSocketException $e) {
 878                         // Output exception message
 879                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package was not delivered: ' . $e->getMessage());
 880
 881                         // Mark package as failed
 882                         $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
 883                 }
 884
 885                 // Debug message
 886                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
 887         }
 888
 889         /**
 890          * Sends out encoded data to a socket
 891          *
 892          * @return      void
 893          */
 894         public function sendEncodedData () {
 895                 // Debug message
 896                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': CALLED!');
 897
 898                 // Make sure there is pending encoded data
 899                 assert($this->isEncodedDataPending());
 900
 901                 // Pop current data from stack
 902                 $encodedDataArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
 903
 904                 // Init in this round sent bytes
 905                 $sentBytes = 0;
 906
 907                 // Assert on socket
 908                 assert(is_resource($encodedDataArray[self::RAW_SOCKET_INDEX]));
 909
 910                 // And deliver it
 911                 //* 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]);
 912                 if ($encodedDataArray[self::RAW_DIFF_INDEX] >= 0) {
 913                         // Send all out (encodedData is smaller than or equal buffer size)
 914                         //* 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]))));
 915                         $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]));
 916                 } else {
 917                         // Send buffer size out
 918                         //* 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])));
 919                         $sentBytes = @socket_write($encodedDataArray[self::RAW_SOCKET_INDEX], $encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX]);
 920                 }
 921
 922                 // If there was an error, we don't continue here
 923                 if ($sentBytes === FALSE) {
 924                         // Handle the error with a faked recipientData array
 925                         $this->handleSocketError(__METHOD__, __LINE__, $encodedDataArray[self::RAW_SOCKET_INDEX], array('0.0.0.0', '0'));
 926
 927                         // And throw it
 928                         throw new InvalidSocketException(array($this, $encodedDataArray[self::RAW_SOCKET_INDEX], $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
 929                 } elseif (($sentBytes === 0) && (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) > 0)) {
 930                         // Nothing sent means we are done
 931                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
 932                         return;
 933                 } else {
 934                         // The difference between sent bytes and length of raw data should not go below zero
 935                         assert((strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) - $sentBytes) >= 0);
 936
 937                         // Add total sent bytes
 938                         $encodedDataArray[self::RAW_SENT_BYTES_INDEX] += $sentBytes;
 939
 940                         // Cut out the last unsent bytes
 941                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Sent out ' . $sentBytes . ' of ' . strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) . ' bytes ...');
 942                         $encodedDataArray[self::RAW_ENCODED_DATA_INDEX] = substr($encodedDataArray[self::RAW_ENCODED_DATA_INDEX], $sentBytes);
 943
 944                         // Calculate difference again
 945                         $encodedDataArray[self::RAW_DIFF_INDEX] = $encodedDataArray[self::RAW_BUFFER_SIZE_INDEX] - strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]);
 946
 947                         // Can we abort?
 948                         if (strlen($encodedDataArray[self::RAW_ENCODED_DATA_INDEX]) <= 0) {
 949                                 // Abort here, all sent!
 950                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONNECTION-HELPER[' . __METHOD__ . ':' . __LINE__ . ']: All sent! (LINE=' . __LINE__ . ')');
 951                                 return;
 952                         } // END - if
 953                 }
 954
 955                 // Push array back in stack
 956                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
 957
 958                 // Debug message
 959                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ': EXIT!');
 960         }
 961
 962         ///////////////////////////////////////////////////////////////////////////
 963         //                   Receiving packages / raw data
 964         ///////////////////////////////////////////////////////////////////////////
 965
 966         /**
 967          * Checks whether decoded raw data is pending
 968          *
 969          * @return      $isPending      Whether decoded raw data is pending
 970          */
 971         private function isRawDataPending () {
 972                 // Just return whether the stack is not empty
 973                 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
 974
 975                 // Return the status
 976                 return $isPending;
 977         }
 978
 979         /**
 980          * Checks whether new raw package data has arrived at a socket
 981          *
 982          * @return      $hasArrived             Whether new raw package data has arrived for processing
 983          */
 984         public function isNewRawDataPending () {
 985                 // Visit the pool. This monitors the pool for incoming raw data.
 986                 $this->getListenerPoolInstance()->accept($this->getVisitorInstance());
 987
 988                 // Check for new data arrival
 989                 $hasArrived = $this->isRawDataPending();
 990
 991                 // Return the status
 992                 return $hasArrived;
 993         }
 994
 995         /**
 996          * Handles the incoming decoded raw data. This method does not "convert" the
 997          * decoded data back into a package array, it just "handles" it and pushs it
 998          * on the next stack.
 999          *
1000          * @return      void
1001          */
1002         public function handleIncomingDecodedData () {
1003                 /*
1004                  * This method should only be called if decoded raw data is pending,
1005                  * so check it again.
1006                  */
1007                 if (!$this->isRawDataPending()) {
1008                         // This is not fatal but should be avoided
1009                         self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: No raw (decoded?) data is pending, but ' . __METHOD__ . ' has been called!');
1010                         return;
1011                 } // END - if
1012
1013                 // Very noisy debug message:
1014                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
1015
1016                 // "Pop" the next entry (the same array again) from the stack
1017                 $decodedData = $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
1018
1019                 // Make sure both array elements are there
1020                 assert(
1021                         (is_array($decodedData)) &&
1022                         (isset($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1023                         (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1024                 );
1025
1026                 /*
1027                  * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
1028                  * only want to handle unhandled packages here.
1029                  */
1030                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
1031                 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
1032
1033                 // Remove the last chunk SEPARATOR (because there is no need for it)
1034                 if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
1035                         // It is there and should be removed
1036                         $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
1037                 } // END - if
1038
1039                 // This package is "handled" and can be pushed on the next stack
1040                 //* 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 . ' ...');
1041                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
1042         }
1043
1044         /**
1045          * Adds raw decoded data from the given handler instance to this receiver
1046          *
1047          * @param       $handlerInstance        An instance of a Networkable class
1048          * @return      void
1049          */
1050         public function addRawDataToIncomingStack (Networkable $handlerInstance) {
1051                 /*
1052                  * Get the decoded data from the handler, this is an array with
1053                  * 'raw_data' and 'error_code' as elements.
1054                  */
1055                 $decodedData = $handlerInstance->getNextRawData();
1056
1057                 // Very noisy debug message:
1058                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, TRUE));
1059
1060                 // And push it on our stack
1061                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
1062         }
1063
1064         /**
1065          * Checks whether incoming decoded data is handled.
1066          *
1067          * @return      $isHandled      Whether incoming decoded data is handled
1068          */
1069         public function isIncomingRawDataHandled () {
1070                 // Determine if the stack is not empty
1071                 $isHandled = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
1072
1073                 // Return it
1074                 return $isHandled;
1075         }
1076
1077         /**
1078          * Checks whether the assembler has pending data left
1079          *
1080          * @return      $isHandled      Whether the assembler has pending data left
1081          */
1082         public function ifAssemblerHasPendingDataLeft () {
1083                 // Determine if the stack is not empty
1084                 $isHandled = (!$this->getAssemblerInstance()->isPendingDataEmpty());
1085
1086                 // Return it
1087                 return $isHandled;
1088         }
1089
1090         /**
1091          * Checks whether the assembler has multiple packages pending
1092          *
1093          * @return      $isPending      Whether the assembler has multiple packages pending
1094          */
1095         public function ifMultipleMessagesPending () {
1096                 // Determine if the stack is not empty
1097                 $isPending = ($this->getAssemblerInstance()->ifMultipleMessagesPending());
1098
1099                 // Return it
1100                 return $isPending;
1101         }
1102
1103         /**
1104          * Handles the attached assemler's pending data queue to be finally
1105          * assembled to the raw package data back.
1106          *
1107          * @return      void
1108          */
1109         public function handleAssemblerPendingData () {
1110                 // Handle it
1111                 $this->getAssemblerInstance()->handlePendingData();
1112         }
1113
1114         /**
1115          * Handles multiple messages.
1116          *
1117          * @return      void
1118          */
1119         public function handleMultipleMessages () {
1120                 // Handle it
1121                 $this->getAssemblerInstance()->handleMultipleMessages();
1122         }
1123
1124         /**
1125          * Assembles incoming decoded data so it will become an abstract network
1126          * package again. The assembler does later do it's job by an other task,
1127          * not this one to keep best speed possible.
1128          *
1129          * @return      void
1130          */
1131         public function assembleDecodedDataToPackage () {
1132                 // Make sure the raw decoded package data is handled
1133                 assert($this->isIncomingRawDataHandled());
1134
1135                 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
1136                 $packageContent = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
1137
1138                 // Assert on some elements
1139                 assert(
1140                         (is_array($packageContent)) &&
1141                         (isset($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA])) &&
1142                         (isset($packageContent[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
1143                 );
1144
1145                 // Start assembling the raw package data array by chunking it
1146                 $this->getAssemblerInstance()->chunkPackageContent($packageContent);
1147
1148                 // Remove the package from 'handled_decoded' stack ...
1149                 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
1150
1151                 // ... and push it on the 'chunked' stacker
1152                 //* 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));
1153                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
1154         }
1155
1156         /**
1157          * Accepts the visitor to process the visit "request"
1158          *
1159          * @param       $visitorInstance        An instance of a Visitor class
1160          * @return      void
1161          */
1162         public function accept (Visitor $visitorInstance) {
1163                 // Debug message
1164                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - CALLED!');
1165
1166                 // Visit the package
1167                 $visitorInstance->visitNetworkPackage($this);
1168
1169                 // Then visit the assembler to handle multiple packages
1170                 $this->getAssemblerInstance()->accept($visitorInstance);
1171
1172                 // Debug message
1173                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: ' . $visitorInstance->__toString() . ' has visited - EXIT!');
1174         }
1175
1176         /**
1177          * Clears all stacks
1178          *
1179          * @return      void
1180          */
1181         public function clearAllStacks () {
1182                 // Call the init method to force re-initialization
1183                 $this->initStacks(TRUE);
1184
1185                 // Debug message
1186                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: All stacker have been re-initialized.');
1187         }
1188
1189         /**
1190          * Removes the first failed outoging package from the stack to continue
1191          * with next one (it will never work until the issue is fixed by you).
1192          *
1193          * @return      void
1194          * @throws      UnexpectedPackageStatusException        If the package status is not 'failed'
1195          * @todo        This may be enchanced for outgoing packages?
1196          */
1197         public function removeFirstFailedPackage () {
1198                 // Get the package again
1199                 $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
1200
1201                 // Is the package status 'failed'?
1202                 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
1203                         // Not failed!
1204                         throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
1205                 } // END - if
1206
1207                 // Remove this entry
1208                 $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
1209         }
1210
1211         /**
1212          * "Decode" the package content into the same array when it was sent.
1213          *
1214          * @param       $rawPackageContent      The raw package content to be "decoded"
1215          * @return      $decodedData            An array with 'sender', 'recipient', 'content' and 'status' elements
1216          */
1217         public function decodeRawContent ($rawPackageContent) {
1218                 // Use the separator '#' to "decode" it
1219                 $decodedArray = explode(self::PACKAGE_DATA_SEPARATOR, $rawPackageContent);
1220
1221                 // Assert on count (should be always 3)
1222                 assert(count($decodedArray) == self::DECODED_DATA_ARRAY_SIZE);
1223
1224                 // Generate the hash of comparing it
1225                 if (!$this->isPackageHashValid($decodedArray)) {
1226                         // Is not valid, so throw an exception here
1227                         exit(__METHOD__ . ':INVALID HASH! UNDER CONSTRUCTION!' . chr(10));
1228                 } // END - if
1229
1230                 /*
1231                  * Create 'decodedData' array with all assoziative array elements.
1232                  */
1233                 $decodedData = array(
1234                         self::PACKAGE_DATA_SENDER    => $decodedArray[self::INDEX_PACKAGE_SENDER],
1235                         self::PACKAGE_DATA_RECIPIENT => $decodedArray[self::INDEX_PACKAGE_RECIPIENT],
1236                         self::PACKAGE_DATA_CONTENT   => $decodedArray[self::INDEX_PACKAGE_CONTENT],
1237                         self::PACKAGE_DATA_STATUS    => self::PACKAGE_STATUS_DECODED,
1238                         self::PACKAGE_DATA_HASH      => $decodedArray[self::INDEX_PACKAGE_HASH]
1239                 );
1240
1241                 // And return it
1242                 return $decodedData;
1243         }
1244
1245         /**
1246          * Handles decoded data for this node by "decoding" the 'content' part of
1247          * it. Again this method uses explode() for the "decoding" process.
1248          *
1249          * @param       $decodedData    An array with decoded raw package data
1250          * @return      void
1251          * @throws      InvalidDataChecksumException    If the checksum doesn't match
1252          */
1253         public function handleRawData (array $decodedData) {
1254                 /*
1255                  * "Decode" the package's content by a simple explode() call, for
1256                  * details of the array elements, see comments for constant
1257                  * PACKAGE_MASK.
1258                  */
1259                 $decodedContent = explode(self::PACKAGE_MASK_SEPARATOR, $decodedData[self::PACKAGE_DATA_CONTENT]);
1260
1261                 // Assert on array count for a very basic validation
1262                 assert(count($decodedContent) == self::PACKAGE_CONTENT_ARRAY_SIZE);
1263
1264                 /*
1265                  * Convert the indexed array into an associative array. This is much
1266                  * better to remember than plain numbers, isn't it?
1267                  */
1268                 $decodedContent = array(
1269                         // Compressor's extension used to compress the data
1270                         self::PACKAGE_CONTENT_EXTENSION => $decodedContent[self::INDEX_COMPRESSOR_EXTENSION],
1271                         // Package data (aka "message") in BASE64-decoded form but still compressed
1272                         self::PACKAGE_CONTENT_MESSAGE   => base64_decode($decodedContent[self::INDEX_PACKAGE_DATA]),
1273                         // Tags as an indexed array for "tagging" the message
1274                         self::PACKAGE_CONTENT_TAGS      => explode(self::PACKAGE_TAGS_SEPARATOR, $decodedContent[self::INDEX_TAGS]),
1275                         // Checksum of the _decoded_ data
1276                         self::PACKAGE_CONTENT_CHECKSUM  => $decodedContent[self::INDEX_CHECKSUM],
1277                         // Sender's id
1278                         self::PACKAGE_CONTENT_SENDER    => $decodedData[self::PACKAGE_DATA_SENDER],
1279                         // Hash from decoded raw data
1280                         self::PACKAGE_CONTENT_HASH      => $decodedData[self::PACKAGE_DATA_HASH]
1281                 );
1282
1283                 // Is the checksum valid?
1284                 if (!$this->isChecksumValid($decodedContent, $decodedData)) {
1285                         // Is not the same, so throw an exception here
1286                         throw new InvalidDataChecksumException(array($this, $decodedContent, $decodedData), BaseListener::EXCEPTION_INVALID_DATA_CHECKSUM);
1287                 } // END - if
1288
1289                 /*
1290                  * The checksum is the same, then it can be decompressed safely. The
1291                  * original message is at this point fully decoded.
1292                  */
1293                 $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
1294
1295                 // And push it on the next stack
1296                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
1297         }
1298
1299         /**
1300          * Checks whether a new message has arrived
1301          *
1302          * @return      $hasArrived             Whether a new message has arrived for processing
1303          */
1304         public function isNewMessageArrived () {
1305                 // Determine if the stack is not empty
1306                 $hasArrived = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
1307
1308                 // Return it
1309                 return $hasArrived;
1310         }
1311
1312         /**
1313          * Handles newly arrived messages
1314          *
1315          * @return      void
1316          * @todo        Implement verification of all sent tags here?
1317          */
1318         public function handleNewlyArrivedMessage () {
1319                 // Get it from the stacker, it is the full array with the decoded message
1320                 $decodedContent = $this->getStackInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
1321
1322                 // Now get a filter chain back from factory with given tags array
1323                 $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
1324
1325                 /*
1326                  * Process the message through all filters, note that all other
1327                  * elements from $decodedContent are no longer needed.
1328                  */
1329                 $chainInstance->processMessage($decodedContent, $this);
1330         }
1331
1332         /**
1333          * Checks whether a processed message is pending for "interpretation"
1334          *
1335          * @return      $isPending      Whether a processed message is pending
1336          */
1337         public function isProcessedMessagePending () {
1338                 // Check it
1339                 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
1340
1341                 // Return it
1342                 return $isPending;
1343         }
1344
1345         /**
1346          * Handle processed messages by "interpreting" the 'message_type' element
1347          *
1348          * @return      void
1349          */
1350         public function handleProcessedMessage () {
1351                 // Get it from the stacker, it is the full array with the processed message
1352                 $messageArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
1353
1354                 // Add type for later easier handling
1355                 $messageArray[self::MESSAGE_ARRAY_DATA][self::MESSAGE_ARRAY_TYPE] = $messageArray[self::MESSAGE_ARRAY_TYPE];
1356
1357                 // Debug message
1358                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: messageArray=' . print_r($messageArray, TRUE));
1359
1360                 // Create a handler instance from given message type
1361                 $handlerInstance = MessageTypeHandlerFactory::createMessageTypeHandlerInstance($messageArray[self::MESSAGE_ARRAY_TYPE]);
1362
1363                 // Handle message data
1364                 $handlerInstance->handleMessageData($messageArray[self::MESSAGE_ARRAY_DATA], $this);
1365         }
1366
1367         /**
1368          * Feeds the hash and sender (as recipient for the 'sender' reward) to the
1369          * miner's queue, unless the message is not a "reward claim" message as this
1370          * leads to an endless loop. You may wish to run the miner to get some
1371          * reward ("HubCoins") for "mining" this hash.
1372          *
1373          * @param       $decodedDataArray       Array with decoded message
1374          * @return      void
1375          * @todo        ~10% done?
1376          */
1377         public function feedHashToMiner (array $decodedDataArray) {
1378                 // Make sure the required elements are there
1379                 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_SENDER]));
1380                 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_HASH]));
1381                 assert(isset($decodedDataArray[self::PACKAGE_CONTENT_TAGS]));
1382
1383                 // Resolve session id ('sender' is a session id) into node id
1384                 $nodeId = HubTools::resolveNodeIdBySessionId($decodedDataArray[self::PACKAGE_CONTENT_SENDER]);
1385
1386                 // Is 'claim_reward' the message type?
1387                 if (in_array('claim_reward', $decodedDataArray[self::PACKAGE_CONTENT_TAGS])) {
1388                         /*
1389                          * Then don't feed this message to the miner as this causes and
1390                          * endless loop of mining.
1391                          */
1392                         return;
1393                 } // END - if
1394
1395                 $this->partialStub('@TODO nodeId=' . $nodeId . ',decodedDataArray=' . print_r($decodedDataArray, TRUE));
1396         }
1397 }
1398
1399 // [EOF]
1400 ?>