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