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