application/hub/main/package/class_NetworkPackage.php

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