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
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
15 * For performance reasons, this class should only be instanciated once and then
16 * used as a "pipe-through" class.
18 * @author Roland Haeder <webmaster@ship-simu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.ship-simu.org
23 * @todo Needs to add functionality for handling the object's type
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.
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.
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/>.
38 class NetworkPackage extends BaseFrameworkSystem implements Deliverable, Receivable, Registerable, Visitable {
40 * Package mask for compressing package data:
41 * 0: Compressor extension
43 * 2: Tags, seperated by semicolons, no semicolon is required if only one tag is needed
47 const PACKAGE_MASK = '%s%s%s%s%s%s%s';
50 * Separator for the above mask
52 const PACKAGE_MASK_SEPARATOR = '^';
55 * SEPARATOR for checksum
57 const PACKAGE_CHECKSUM_SEPARATOR = '_';
60 * Array indexes for above mask, start with zero
62 const INDEX_COMPRESSOR_EXTENSION = 0;
63 const INDEX_PACKAGE_DATA = 1;
65 const INDEX_CHECKSUM = 3;
68 * Array indexes for raw package array
70 const INDEX_PACKAGE_SENDER = 0;
71 const INDEX_PACKAGE_RECIPIENT = 1;
72 const INDEX_PACKAGE_CONTENT = 2;
73 const INDEX_PACKAGE_STATUS = 3;
76 * Named array elements for package data
78 const PACKAGE_DATA_SENDER = 'sender';
79 const PACKAGE_DATA_RECIPIENT = 'recipient';
80 const PACKAGE_DATA_CONTENT = 'content';
81 const PACKAGE_DATA_STATUS = 'status';
86 const PACKAGE_STATUS_NEW = 'new';
87 const PACKAGE_STATUS_FAILED = 'failed';
92 const PACKAGE_TAGS_SEPARATOR = ';';
95 * Raw package data SEPARATOR
97 const PACKAGE_DATA_SEPARATOR = '#';
100 * Network target (alias): 'upper hubs'
102 const NETWORK_TARGET_UPPER_HUBS = 'upper';
105 * Network target (alias): 'self'
107 const NETWORK_TARGET_SELF = 'self';
110 * TCP package size in bytes
112 const TCP_PACKAGE_SIZE = 512;
114 /**************************************************************************
115 * Stacker for out-going packages *
116 **************************************************************************/
119 * Stacker name for "undeclared" packages
121 const STACKER_NAME_UNDECLARED = 'package_undeclared';
124 * Stacker name for "declared" packages (which are ready to send out)
126 const STACKER_NAME_DECLARED = 'package_declared';
129 * Stacker name for "out-going" packages
131 const STACKER_NAME_OUTGOING = 'package_outgoing';
133 /**************************************************************************
134 * Stacker for incoming packages *
135 **************************************************************************/
138 * Stacker name for "incoming" decoded raw data
140 const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
143 * Stacker name for handled decoded raw data
145 const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
148 * Stacker name for "chunked" decoded raw data
150 const STACKER_NAME_DECODED_CHUNKED = 'package_chunked_decoded';
152 /**************************************************************************
153 * Stacker for other/internal purposes *
154 **************************************************************************/
157 * Stacker name for "back-buffered" packages
159 const STACKER_NAME_BACK_BUFFER = 'package_backbuffer';
162 * Protected constructor
166 protected function __construct () {
167 // Call parent constructor
168 parent::__construct(__CLASS__);
172 * Creates an instance of this class
174 * @param $compressorInstance A Compressor instance for compressing the content
175 * @return $packageInstance An instance of a Deliverable class
177 public static final function createNetworkPackage (Compressor $compressorInstance) {
179 $packageInstance = new NetworkPackage();
181 // Now set the compressor instance
182 $packageInstance->setCompressorInstance($compressorInstance);
185 * We need to initialize a stack here for our packages even for those
186 * which have no recipient address and stamp... ;-) This stacker will
187 * also be used for incoming raw data to handle it.
189 $stackerInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
191 // At last, set it in this class
192 $packageInstance->setStackerInstance($stackerInstance);
195 $packageInstance->initStackers();
197 // Get a visitor instance for speeding up things
198 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class', array($packageInstance));
200 // Set it in this package
201 $packageInstance->setVisitorInstance($visitorInstance);
203 // Return the prepared instance
204 return $packageInstance;
208 * Initialize all stackers
210 * @param $forceReInit Whether to force reinitialization of all stacks
213 protected function initStackers ($forceReInit = false) {
217 self::STACKER_NAME_UNDECLARED,
218 self::STACKER_NAME_DECLARED,
219 self::STACKER_NAME_OUTGOING,
220 self::STACKER_NAME_DECODED_INCOMING,
221 self::STACKER_NAME_DECODED_HANDLED,
222 self::STACKER_NAME_DECODED_CHUNKED,
223 self::STACKER_NAME_BACK_BUFFER
226 $this->getStackerInstance()->initStacker($stackerName, $forceReInit);
231 * "Getter" for hash from given content and helper instance
233 * @param $content Raw package content
234 * @param $helperInstance An instance of a HelpableHub class
235 * @param $nodeInstance An instance of a NodeHelper class
236 * @return $hash Hash for given package content
237 * @todo $helperInstance is unused
239 private function getHashFromContent ($content, HelpableHub $helperInstance, NodeHelper $nodeInstance) {
241 // @TODO crc32() is very weak, but it needs to be fast
244 self::PACKAGE_CHECKSUM_SEPARATOR .
245 $nodeInstance->getSessionId() .
246 self::PACKAGE_CHECKSUM_SEPARATOR .
247 $this->getCompressorInstance()->getCompressorExtension()
255 * Change the package with given status in given stack
257 * @param $packageData Raw package data in an array
258 * @param $stackerName Name of the stacker
259 * @param $newStatus New status to set
262 private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
263 // Skip this for empty stacks
264 if ($this->getStackerInstance()->isStackEmpty($stackerName)) {
265 // This avoids an exception after all packages has failed
269 // Pop the entry (it should be it)
270 $this->getStackerInstance()->popNamed($stackerName);
272 // Temporary set the new status
273 $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
276 $this->getStackerInstance()->pushNamed($stackerName, $packageData);
279 ///////////////////////////////////////////////////////////////////////////
280 // Delivering packages / raw data
281 ///////////////////////////////////////////////////////////////////////////
284 * Delivers the given raw package data.
286 * @param $packageData Raw package data in an array
289 private function declareRawPackageData (array $packageData) {
291 * We need to disover every recipient, just in case we have a
292 * multi-recipient entry like 'upper' is. 'all' may be a not so good
293 * target because it causes an overload on the network and may be
294 * abused for attacking the network with large packages.
296 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
298 // Discover all recipients, this may throw an exception
299 $discoveryInstance->discoverRecipients($packageData);
301 // Now get an iterator
302 $iteratorInstance = $discoveryInstance->getIterator();
304 // ... and begin iteration
305 while ($iteratorInstance->valid()) {
307 $currentRecipient = $iteratorInstance->current();
310 $this->debugOutput('PACKAGE: Package declared for recipient ' . $currentRecipient);
313 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
315 // And enqueue it to the writer class
316 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
318 // Skip to next entry
319 $iteratorInstance->next();
323 * The recipient list can be cleaned up here because the package which
324 * shall be delivered has already been added for all entries from the
327 $discoveryInstance->clearRecipients();
331 * Delivers raw package data. In short, this will discover the raw socket
332 * resource through a discovery class (which will analyse the receipient of
333 * the package), register the socket with the connection (handler/helper?)
334 * instance and finally push the raw data on our outgoing queue.
336 * @param $packageData Raw package data in an array
339 private function deliverRawPackageData (array $packageData) {
341 * This package may become big, depending on the shared object size or
342 * delivered message size which shouldn't be so long (to save
343 * bandwidth). Because of the nature of the used protocol (TCP) we need
344 * to split it up into smaller pieces to fit it into a TCP frame.
346 * So first we need (again) a discovery class but now a protocol
347 * discovery to choose the right socket resource. The discovery class
348 * should take a look at the raw package data itself and then decide
349 * which (configurable!) protocol should be used for that type of
352 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
354 // Now discover the right protocol
355 $socketResource = $discoveryInstance->discoverSocket($packageData);
358 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
360 // We have to put this socket in our registry, so get an instance
361 $registryInstance = SocketRegistry::createSocketRegistry();
363 // Get the listener from registry
364 $helperInstance = Registry::getRegistry()->getInstance('connection');
367 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
370 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($helperInstance, $socketResource))) {
372 $registryInstance->registerSocket($helperInstance, $socketResource, $packageData);
376 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
378 // Make sure the connection is up
379 $helperInstance->getStateInstance()->validatePeerStateConnected();
382 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
384 // Enqueue it again on the out-going queue, the connection is up and working at this point
385 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
389 * Sends waiting packages
391 * @param $packageData Raw package data
394 private function sendOutgoingRawPackageData (array $packageData) {
398 // Get the right connection instance
399 $helperInstance = SocketRegistry::createSocketRegistry()->getHandlerInstanceFromPackageData($packageData);
401 // Is this connection still alive?
402 if ($helperInstance->isShuttedDown()) {
403 // This connection is shutting down
404 // @TODO We may want to do somthing more here?
408 // Sent out package data
409 $sentBytes = $helperInstance->sendRawPackageData($packageData);
411 // Remember unsent raw bytes in back-buffer, if any
412 $this->storeUnsentBytesInBackBuffer($packageData, $sentBytes);
416 * "Enqueues" raw content into this delivery class by reading the raw content
417 * from given template instance and pushing it on the 'undeclared' stack.
419 * @param $helperInstance An instance of a HelpableHub class
420 * @param $nodeInstance An instance of a NodeHelper class
423 public function enqueueRawDataFromTemplate (HelpableHub $helperInstance, NodeHelper $nodeInstance) {
424 // Get the raw content ...
425 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
427 // ... and compress it
428 $content = $this->getCompressorInstance()->compressStream($content);
430 // Add magic in front of it and hash behind it, including BASE64 encoding
431 $content = sprintf(self::PACKAGE_MASK,
432 // 1.) Compressor's extension
433 $this->getCompressorInstance()->getCompressorExtension(),
435 self::PACKAGE_MASK_SEPARATOR,
436 // 2.) Raw package content, encoded with BASE64
437 base64_encode($content),
439 self::PACKAGE_MASK_SEPARATOR,
441 implode(self::PACKAGE_TAGS_SEPARATOR, $helperInstance->getPackageTags()),
443 self::PACKAGE_MASK_SEPARATOR,
445 $this->getHashFromContent($content, $helperInstance, $nodeInstance)
448 // Now prepare the temporary array and push it on the 'undeclared' stack
449 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
450 self::PACKAGE_DATA_SENDER => $nodeInstance->getSessionId(),
451 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
452 self::PACKAGE_DATA_CONTENT => $content,
453 self::PACKAGE_DATA_STATUS => self::PACKAGE_STATUS_NEW
458 * Checks wether a package has been enqueued for delivery.
460 * @return $isEnqueued Wether a package is enqueued
462 public function isPackageEnqueued () {
463 // Check wether the stacker is not empty
464 $isEnqueued = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
471 * Checks wether a package has been declared
473 * @return $isDeclared Wether a package is declared
475 public function isPackageDeclared () {
476 // Check wether the stacker is not empty
477 $isDeclared = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
484 * Checks wether a package should be sent out
486 * @return $isWaitingDelivery Wether a package is waiting for delivery
488 public function isPackageWaitingForDelivery () {
489 // Check wether the stacker is not empty
490 $isWaitingDelivery = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
493 return $isWaitingDelivery;
497 * Delivers an enqueued package to the stated destination. If a non-session
498 * id is provided, recipient resolver is being asked (and instanced once).
499 * This allows that a single package is being delivered to multiple targets
500 * without enqueueing it for every target. If no target is provided or it
501 * can't be determined a NoTargetException is being thrown.
504 * @throws NoTargetException If no target can't be determined
506 public function declareEnqueuedPackage () {
507 // Make sure this method isn't working if there is no package enqueued
508 if (!$this->isPackageEnqueued()) {
509 // This is not fatal but should be avoided
510 // @TODO Add some logging here
514 // Now we know for sure there are packages to deliver, we can start
515 // with the first one.
516 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_UNDECLARED);
518 // Declare the raw package data for delivery
519 $this->declareRawPackageData($packageData);
521 // And remove it finally
522 $this->getStackerInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
526 * Delivers the next declared package. Only one package per time will be sent
527 * because this may take time and slows down the whole delivery
532 public function deliverDeclaredPackage () {
533 // Sanity check if we have packages declared
534 if (!$this->isPackageDeclared()) {
535 // This is not fatal but should be avoided
536 // @TODO Add some logging here
541 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
544 // And try to send it
545 $this->deliverRawPackageData($packageData);
547 // And remove it finally
548 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
549 } catch (InvalidStateException $e) {
550 // The state is not excepected (shall be 'connected')
551 $this->debugOutput('PACKAGE: Caught exception ' . $e->__toString() . ' with message=' . $e->getMessage());
553 // Mark the package with status failed
554 $this->changePackageStatus($packageData, self::STACKER_NAME_DECLARED, self::PACKAGE_STATUS_FAILED);
559 * Sends waiting packages out for delivery
563 public function sendWaitingPackage () {
564 // Send any waiting bytes in the back-buffer before sending a new package
565 $this->sendBackBufferBytes();
567 // Sanity check if we have packages waiting for delivery
568 if (!$this->isPackageWaitingForDelivery()) {
569 // This is not fatal but should be avoided
570 $this->debugOutput('PACKAGE: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
575 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_OUTGOING);
578 // Now try to send it
579 $this->sendOutgoingRawPackageData($packageData);
581 // And remove it finally
582 $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING);
583 } catch (InvalidSocketException $e) {
584 // Output exception message
585 $this->debugOutput('PACKAGE: Package was not delivered: ' . $e->getMessage());
587 // Mark package as failed
588 $this->changePackageStatus($packageData, self::STACKER_NAME_OUTGOING, self::PACKAGE_STATUS_FAILED);
592 ///////////////////////////////////////////////////////////////////////////
593 // Receiving packages / raw data
594 ///////////////////////////////////////////////////////////////////////////
597 * Checks wether decoded raw data is pending
599 * @return $isPending Wether decoded raw data is pending
601 private function isDecodedDataPending () {
602 // Just return wether the stack is not empty
603 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
610 * Checks wether new raw package data has arrived at a socket
612 * @param $poolInstance An instance of a PoolableListener class
613 * @return $hasArrived Wether new raw package data has arrived for processing
615 public function isNewRawDataPending (PoolableListener $poolInstance) {
616 // Visit the pool. This monitors the pool for incoming raw data.
617 $poolInstance->accept($this->getVisitorInstance());
619 // Check for new data arrival
620 $hasArrived = $this->isDecodedDataPending();
627 * Handles the incoming decoded raw data. This method does not "convert" the
628 * decoded data back into a package array, it just "handles" it and pushs it
633 public function handleIncomingDecodedData () {
635 * This method should only be called if decoded raw data is pending,
638 if (!$this->isDecodedDataPending()) {
639 // This is not fatal but should be avoided
640 // @TODO Add some logging here
644 // Very noisy debug message:
645 /* NOISY-DEBUG: */ $this->debugOutput('PACKAGE: Stacker size is ' . $this->getStackerInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
647 // "Pop" the next entry (the same array again) from the stack
648 $decodedData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
650 // Make sure both array elements are there
652 (is_array($decodedData)) &&
653 (isset($decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA])) &&
654 (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE]))
658 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
659 * only want to handle unhandled packages here.
661 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
663 // Remove the last chunk SEPARATOR (because it is being added and we don't need it)
664 if (substr($decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
665 // It is there and should be removed
666 $decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA], 0, -1);
669 // This package is "handled" and can be pushed on the next stack
670 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
674 * Adds raw decoded data from the given handler instance to this receiver
676 * @param $handlerInstance An instance of a Networkable class
679 public function addDecodedDataToIncomingStack (Networkable $handlerInstance) {
681 * Get the decoded data from the handler, this is an array with
682 * 'decoded_data' and 'error_code' as elements.
684 $decodedData = $handlerInstance->getNextDecodedData();
686 // Very noisy debug message:
687 //* NOISY-DEBUG: */ $this->debugOutput('PACKAGE: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, true));
689 // And push it on our stack
690 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
694 * Checks wether incoming decoded data is handled.
696 * @return $isHandled Wether incoming decoded data is handled
698 public function isIncomingDecodedDataHandled () {
699 // Determine if the stack is not empty
700 $isHandled = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
707 * Assembles incoming decoded data so it will become an abstract network
708 * package again. The assembler does later do it's job by an other task,
709 * not this one to keep best speed possible.
713 public function assembleDecodedDataToPackage () {
714 // Make sure the raw decoded package data is handled
715 assert($this->isIncomingDecodedDataHandled());
717 // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
718 $packageContent = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
720 // Get a singleton package assembler instance from factory
721 $assemblerInstance = PackageAssemblerFactory::createAssemblerInstance();
723 // Start assembling the raw package data array by chunking it
724 $assemblerInstance->chunkPackageContent($packageContent);
726 // Remove the package from 'handled_decoded' stack ...
727 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
729 // ... and push it on the 'chunked' stacker
730 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
734 * Checks wether a new package has arrived
736 * @return $hasArrived Wether a new package has arrived for processing
738 public function isNewPackageArrived () {
739 // @TODO Add some content here
743 * Accepts the visitor to process the visit "request"
745 * @param $visitorInstance An instance of a Visitor class
748 public function accept (Visitor $visitorInstance) {
750 //* NOISY-DEBUG: */ $this->debugOutput('PACKAGE: ' . $visitorInstance->__toString() . ' has visited - START');
753 $visitorInstance->visitNetworkPackage($this);
756 //* NOISY-DEBUG: */ $this->debugOutput('PACKAGE: ' . $visitorInstance->__toString() . ' has visited - FINISHED');
764 public function clearAllStacker () {
765 // Call the init method to force re-initialization
766 $this->initStackers(true);
769 /* DEBUG: */ $this->debugOutput('PACKAGE: All stacker have been re-initialized.');
773 * Removes the first failed outoging package from the stack to continue
774 * with next one (it will never work until the issue is fixed by you).
777 * @throws UnexpectedPackageStatusException If the package status is not 'failed'
778 * @todo This may be enchanced for outgoing packages?
780 public function removeFirstFailedPackage () {
781 // Get the package again
782 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
784 // Is the package status 'failed'?
785 if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
787 throw new UnexpectedPackageStatusException(array($this, $packageData, self::PACKAGE_STATUS_FAILED), BaseListener::EXCEPTION_UNEXPECTED_PACKAGE_STATUS);
791 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);