application/hub/main/package/class_NetworkPackage.php

   1 <?php
   2 /**
   3  * A NetworkPackage class. This class implements the Deliverable class because
   4  * all network packages should be deliverable to other nodes. It further
   5  * provides methods for reading raw content from template engines and feeding it
   6  * to the stacker for undeclared packages.
   7  *
   8  * The factory method requires you to provide a compressor class (which must
   9  * implement the Compressor interface). If you don't want any compression (not
  10  * adviceable due to increased network load), please use the NullCompressor
  11  * class and encode it with BASE64 for a more error-free transfer over the
  12  * Internet.
  13  *
  14  * For performance reasons, this class should only be instantiated once and then
  15  * used as a "pipe-through" class.
  16  *
  17  * @author              Roland Haeder <webmaster@ship-simu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.ship-simu.org
  22  * @todo                Needs to add functionality for handling the object's type
  23  *
  24  * This program is free software: you can redistribute it and/or modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation, either version 3 of the License, or
  27  * (at your option) any later version.
  28  *
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License
  35  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  36  */
  37 class NetworkPackage extends BaseFrameworkSystem implements Deliverable, Registerable {
  38         /**
  39          * Package mask for compressing package data:
  40          * 1.) Compressor extension
  41          * 2.) Raw package data
  42          * 3.) Tags, seperated by semicolons, no semicolon is required if only one tag is needed
  43          * 4.) Checksum
  44          */
  45         const PACKAGE_MASK = '%s:%s:%s:%s';
  46
  47         /**
  48          * Seperator for the above mask
  49          */
  50         const PACKAGE_MASK_SEPERATOR = ':';
  51
  52         /**
  53          * Array indexes for above mask, start with zero
  54          */
  55         const INDEX_COMPRESSOR_EXTENSION = 0;
  56         const INDEX_PACKAGE_DATA         = 1;
  57         const INDEX_TAGS                 = 2;
  58         const INDEX_CHECKSUM             = 3;
  59
  60         /**
  61          * Array indexes for raw package array
  62          */
  63         const INDEX_PACKAGE_SENDER    = 0;
  64         const INDEX_PACKAGE_RECIPIENT = 1;
  65         const INDEX_PACKAGE_CONTENT   = 2;
  66
  67         /**
  68          * Tags seperator
  69          */
  70         const PACKAGE_TAGS_SEPERATOR = ';';
  71
  72         /**
  73          * Raw package data seperator
  74          */
  75         const PACKAGE_DATA_SEPERATOR = '|';
  76
  77         /**
  78          * Stacker name for "undeclared" packages
  79          */
  80         const STACKER_NAME_UNDECLARED = 'undeclared';
  81
  82         /**
  83          * Stacker name for "declared" packages (which are ready to send out)
  84          */
  85         const STACKER_NAME_DECLARED = 'declared';
  86
  87         /**
  88          * Stacker name for "out-going" packages
  89          */
  90         const STACKER_NAME_OUTGOING = 'outgoing';
  91
  92         /**
  93          * Network target (alias): 'upper hubs'
  94          */
  95         const NETWORK_TARGET_UPPER_HUBS = 'upper';
  96
  97         /**
  98          * Protected constructor
  99          *
 100          * @return      void
 101          */
 102         protected function __construct () {
 103                 // Call parent constructor
 104                 parent::__construct(__CLASS__);
 105
 106                 // We need to initialize a stack here for our packages even those
 107                 // which have no recipient address and stamp... ;-)
 108                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('package_stacker_class');
 109
 110                 // At last, set it in this class
 111                 $this->setStackerInstance($stackerInstance);
 112         }
 113
 114         /**
 115          * Creates an instance of this class
 116          *
 117          * @param       $compressorInstance             A Compressor instance for compressing the content
 118          * @return      $packageInstance                An instance of a Deliverable class
 119          */
 120         public final static function createNetworkPackage (Compressor $compressorInstance) {
 121                 // Get new instance
 122                 $packageInstance = new NetworkPackage();
 123
 124                 // Now set the compressor instance
 125                 $packageInstance->setCompressorInstance($compressorInstance);
 126
 127                 // Return the prepared instance
 128                 return $packageInstance;
 129         }
 130
 131         /**
 132          * "Getter" for hash from given content and helper instance
 133          *
 134          * @param       $content        Raw package content
 135          * @param       $helperInstance         A BaseHubHelper instance
 136          * @return      $hash   Hash for given package content
 137          */
 138         private function getHashFromContent ($content, BaseHubHelper $helperInstance) {
 139                 // Create the hash
 140                 // @TODO crc32 is not good, but it needs to be fast
 141                 $hash = crc32(
 142                         $content .
 143                         ':' .
 144                         $helperInstance->getNodeInstance()->getSessionId() .
 145                         ':' .
 146                         $this->getCompressorInstance()->getCompressorExtension()
 147                 );
 148
 149                 // And return it
 150                 return $hash;
 151         }
 152
 153         /**
 154          * Delivers the given raw package data.
 155          *
 156          * @param       $packageData    Raw package data in an array
 157          * @return      void
 158          */
 159         private function deliverPackage (array $packageData) {
 160                 /*
 161                  * We need to disover every recipient, just in case we have a
 162                  * multi-recipient entry like 'upper' is. 'all' may be a not so good
 163                  * target because it causes an overload on the network and may be
 164                  * abused for attacking the network with large packages.
 165                  */
 166                 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
 167
 168                 // Discover all recipients, this may throw an exception
 169                 $discoveryInstance->discoverRecipients($packageData);
 170
 171                 // Now get an iterator
 172                 $iteratorInstance = $discoveryInstance->getIterator();
 173
 174                 // ... and begin iteration
 175                 while ($iteratorInstance->valid()) {
 176                         // Get current entry
 177                         $currentRecipient = $iteratorInstance->current();
 178
 179                         // Debug message
 180                         $this->debugOutput('PACKAGE: Package declared for recipient ' . $currentRecipient);
 181
 182                         // Set the recipient
 183                         $packageData['recipient'] = $currentRecipient;
 184
 185                         // And enqueue it to the writer class
 186                         $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
 187
 188                         // Skip to next entry
 189                         $iteratorInstance->next();
 190                 } // END - while
 191
 192                 // Clean-up the list
 193                 $discoveryInstance->clearRecipients();
 194         }
 195
 196         /**
 197          * Sends a raw package out
 198          *
 199          * @param       $packageData    Raw package data in an array
 200          * @return      void
 201          */
 202         private function sendRawPackage (array $packageData) {
 203                 /*
 204                  * This package may become big, depending on the shared object size or
 205                  * delivered message size which shouldn't be so long (to save
 206                  * bandwidth). Because of the nature of the used protocol (TCP) we need
 207                  * to split it up into smaller pieces to fit it into a TCP frame.
 208                  *
 209                  * So first we need (again) a discovery class but now a protocol
 210                  * discovery to choose the right socket resource. The discovery class
 211                  * should take a look at the raw package data itself and then decide
 212                  * which (configurable!) protocol should be used for that type of
 213                  * package.
 214                  */
 215                 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
 216
 217                 // Now discover the right protocol
 218                 $socketResource = $discoveryInstance->discoverSocket($packageData);
 219
 220                 // We have to put this socket in our registry, so get an instance
 221                 $registryInstance = SocketRegistry::createSocketRegistry();
 222
 223                 // Get the listener from registry
 224                 $connectionInstance = Registry::getRegistry()->getInstance('connection');
 225
 226                 // Is it not there?
 227                 if (!$registryInstance->isSocketRegistered($connectionInstance, $socketResource)) {
 228                         // Then register it
 229                         $registryInstance->registerSocket($connectionInstance, $socketResource, $packageData);
 230                 } // END - if
 231
 232                 // We enqueue it again, but now in the out-going queue
 233                 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
 234         }
 235
 236         /**
 237          * Sends waiting packages
 238          *
 239          * @param       $packageData    Raw package data
 240          * @return      void
 241          */
 242         private function sendOutgoingPackage (array $packageData) {
 243                 // Get the right connection instance
 244                 $connectionInstance = SocketRegistry::createSocketRegistry()->getHandlerInstanceFromPackageData($packageData);
 245
 246                 // Sent it away (we catch exceptions one method above
 247                 $connectionInstance->sendRawPackageData($packageData);
 248         }
 249
 250         /**
 251          * "Enqueues" raw content into this delivery class by reading the raw content
 252          * from given template instance and pushing it on the 'undeclared' stack.
 253          *
 254          * @param       $helperInstance         A BaseHubHelper instance
 255          * @return      void
 256          */
 257         public function enqueueRawDataFromTemplate (BaseHubHelper $helperInstance) {
 258                 // Get the raw content ...
 259                 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
 260
 261                 // ... and compress it
 262                 $content = $this->getCompressorInstance()->compressStream($content);
 263
 264                 // Add magic in front of it and hash behind it, including BASE64 encoding
 265                 $content = sprintf(self::PACKAGE_MASK,
 266                         // 1.) Compressor's extension
 267                         $this->getCompressorInstance()->getCompressorExtension(),
 268                         // 2.) Raw package content, encoded with BASE64
 269                         base64_encode($content),
 270                         // 3.) Tags
 271                         implode(self::PACKAGE_TAGS_SEPERATOR, $helperInstance->getPackageTags()),
 272                         // 4.) Checksum
 273                         $this->getHashFromContent($content, $helperInstance)
 274                 );
 275
 276                 // Now prepare the temporary array and push it on the 'undeclared' stack
 277                 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
 278                         'sender'    => $helperInstance->getNodeInstance()->getSessionId(),
 279                         'recipient' => self::NETWORK_TARGET_UPPER_HUBS,
 280                         'content'   => $content,
 281                 ));
 282         }
 283
 284         /**
 285          * Checks wether a package has been enqueued for delivery.
 286          *
 287          * @return      $isEnqueued             Wether a package is enqueued
 288          */
 289         public function isPackageEnqueued () {
 290                 // Check wether the stacker is not empty
 291                 $isEnqueued = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
 292
 293                 // Return the result
 294                 return $isEnqueued;
 295         }
 296
 297         /**
 298          * Checks wether a package has been declared
 299          *
 300          * @return      $isDeclared             Wether a package is declared
 301          */
 302         public function isPackageDeclared () {
 303                 // Check wether the stacker is not empty
 304                 $isDeclared = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
 305
 306                 // Return the result
 307                 return $isDeclared;
 308         }
 309
 310         /**
 311          * Checks wether a package should be sent out
 312          *
 313          * @return      $isWaitingDelivery      Wether a package is waiting for delivery
 314          */
 315         public function isPackageWaitingDelivery () {
 316                 // Check wether the stacker is not empty
 317                 $isWaitingDelivery = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
 318
 319                 // Return the result
 320                 return $isWaitingDelivery;
 321         }
 322
 323         /**
 324          * Delivers an enqueued package to the stated destination. If a non-session
 325          * id is provided, recipient resolver is being asked (and instanced once).
 326          * This allows that a single package is being delivered to multiple targets
 327          * without enqueueing it for every target. If no target is provided or it
 328          * can't be determined a NoTargetException is being thrown.
 329          *
 330          * @return      void
 331          * @throws      NoTargetException       If no target can't be determined
 332          */
 333         public function declareEnqueuedPackage () {
 334                 // Make sure this method isn't working if there is no package enqueued
 335                 if (!$this->isPackageEnqueued()) {
 336                         // This is not fatal but should be avoided
 337                         // @TODO Add some logging here
 338                         return;
 339                 } // END - if
 340
 341                 // Now we know for sure there are packages to deliver, we can start
 342                 // with the first one.
 343                 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_UNDECLARED);
 344
 345                 // Finally, deliver the package
 346                 $this->deliverPackage($packageData);
 347
 348                 // And remove it finally
 349                 $this->getStackerInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
 350         }
 351
 352         /**
 353          * Delivers the next declared package. Only one package per time will be sent
 354          * because this may take time and slows down the whole delivery
 355          * infrastructure.
 356          *
 357          * @return      void
 358          */
 359         public function deliverDeclaredPackage () {
 360                 // Sanity check if we have packages declared
 361                 if (!$this->isPackageDeclared()) {
 362                         // This is not fatal but should be avoided
 363                         // @TODO Add some logging here
 364                         return;
 365                 } // END - if
 366
 367                 // Get the package again
 368                 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
 369
 370                 // And send it
 371                 $this->sendRawPackage($packageData);
 372
 373                 // And remove it finally
 374                 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
 375         }
 376
 377         /**
 378          * Sends waiting packages out for delivery
 379          *
 380          * @return      void
 381          */
 382         public function sentWaitingPackage () {
 383                 // Sanity check if we have packages waiting for delivery
 384                 if (!$this->isPackageWaitingDelivery()) {
 385                         // This is not fatal but should be avoided
 386                         // @TODO Add some logging here
 387                         return;
 388                 } // END - if
 389
 390                 // Get the package again
 391                 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_OUTGOING);
 392
 393                 // Now try to send it
 394                 try {
 395                         $this->sendOutgoingPackage($packageData);
 396
 397                         // And remove it finally when it has been fully delivered
 398                         $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING);
 399                 } catch (InvalidSocketException $e) {
 400                         // Output exception message
 401                         $this->debugOutput('PACKAGE: Package was not delivered: ' . $e->getMessage());
 402                 }
 403         }
 404 }
 405
 406 // [EOF]
 407 ?>