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