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