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 {
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';
50 * Seperator for the above mask
52 const PACKAGE_MASK_SEPERATOR = ':';
55 * Seperator for checksum
57 const PACKAGE_CHECKSUM_SEPERATOR = ':';
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;
75 * Named array elements for package data
77 const PACKAGE_DATA_SENDER = 'sender';
78 const PACKAGE_DATA_RECIPIENT = 'recipient';
79 const PACKAGE_DATA_CONTENT = 'content';
84 const PACKAGE_TAGS_SEPERATOR = ';';
87 * Raw package data seperator
89 const PACKAGE_DATA_SEPERATOR = '#';
92 * Stacker name for "undeclared" packages
94 const STACKER_NAME_UNDECLARED = 'package_undeclared';
97 * Stacker name for "declared" packages (which are ready to send out)
99 const STACKER_NAME_DECLARED = 'package_declared';
102 * Stacker name for "out-going" packages
104 const STACKER_NAME_OUTGOING = 'package_outgoing';
107 * Stacker name for "incoming" decoded raw data
109 const STACKER_NAME_DECODED_INCOMING = 'package_decoded_data';
112 * Stacker name for handled decoded raw data
114 const STACKER_NAME_DECODED_HANDLED = 'package_handled_decoded';
117 * Stacker name for "back-buffered" packages
119 const STACKER_NAME_BACK_BUFFER = 'package_backbuffer';
122 * Network target (alias): 'upper hubs'
124 const NETWORK_TARGET_UPPER_HUBS = 'upper';
127 * Network target (alias): 'self'
129 const NETWORK_TARGET_SELF = 'self';
132 * TCP package size in bytes
134 const TCP_PACKAGE_SIZE = 512;
137 * Protected constructor
141 protected function __construct () {
142 // Call parent constructor
143 parent::__construct(__CLASS__);
147 * Creates an instance of this class
149 * @param $compressorInstance A Compressor instance for compressing the content
150 * @return $packageInstance An instance of a Deliverable class
152 public static final function createNetworkPackage (Compressor $compressorInstance) {
154 $packageInstance = new NetworkPackage();
156 // Now set the compressor instance
157 $packageInstance->setCompressorInstance($compressorInstance);
160 * We need to initialize a stack here for our packages even for those
161 * which have no recipient address and stamp... ;-) This stacker will
162 * also be used for incoming raw data to handle it.
164 $stackerInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
166 // At last, set it in this class
167 $packageInstance->setStackerInstance($stackerInstance);
170 $packageInstance->initStackers();
172 // Get a visitor instance for speeding up things
173 $visitorInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_monitor_visitor_class', array($packageInstance));
175 // Set it in this package
176 $packageInstance->setVisitorInstance($visitorInstance);
178 // Return the prepared instance
179 return $packageInstance;
183 * Initialize all stackers
187 protected function initStackers () {
191 self::STACKER_NAME_UNDECLARED,
192 self::STACKER_NAME_DECLARED,
193 self::STACKER_NAME_OUTGOING,
194 self::STACKER_NAME_DECODED_INCOMING,
195 self::STACKER_NAME_DECODED_HANDLED,
196 self::STACKER_NAME_BACK_BUFFER
199 $this->getStackerInstance()->initStacker($stackerName);
204 * "Getter" for hash from given content and helper instance
206 * @param $content Raw package content
207 * @param $helperInstance An instance of a HelpableHub class
208 * @param $nodeInstance An instance of a NodeHelper class
209 * @return $hash Hash for given package content
210 * @todo $helperInstance is unused
212 private function getHashFromContent ($content, HelpableHub $helperInstance, NodeHelper $nodeInstance) {
214 // @TODO crc32() is not very strong, but it needs to be fast
217 self::PACKAGE_CHECKSUM_SEPERATOR .
218 $nodeInstance->getSessionId() .
219 self::PACKAGE_CHECKSUM_SEPERATOR .
220 $this->getCompressorInstance()->getCompressorExtension()
227 ///////////////////////////////////////////////////////////////////////////
228 // Delivering packages / raw data
229 ///////////////////////////////////////////////////////////////////////////
232 * Delivers the given raw package data.
234 * @param $packageData Raw package data in an array
237 private function declareRawPackageData (array $packageData) {
239 * We need to disover every recipient, just in case we have a
240 * multi-recipient entry like 'upper' is. 'all' may be a not so good
241 * target because it causes an overload on the network and may be
242 * abused for attacking the network with large packages.
244 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
246 // Discover all recipients, this may throw an exception
247 $discoveryInstance->discoverRecipients($packageData);
249 // Now get an iterator
250 $iteratorInstance = $discoveryInstance->getIterator();
252 // ... and begin iteration
253 while ($iteratorInstance->valid()) {
255 $currentRecipient = $iteratorInstance->current();
258 $this->debugOutput('PACKAGE: Package declared for recipient ' . $currentRecipient);
261 $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
263 // And enqueue it to the writer class
264 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
266 // Skip to next entry
267 $iteratorInstance->next();
271 $discoveryInstance->clearRecipients();
275 * Delivers raw package data. In short, this will discover the raw socket
276 * resource through a discovery class (which will analyse the receipient of
277 * the package), register the socket with the connection (handler/helper?)
278 * instance and finally push the raw data on our outgoing queue.
280 * @param $packageData Raw package data in an array
283 private function deliverRawPackageData (array $packageData) {
285 * This package may become big, depending on the shared object size or
286 * delivered message size which shouldn't be so long (to save
287 * bandwidth). Because of the nature of the used protocol (TCP) we need
288 * to split it up into smaller pieces to fit it into a TCP frame.
290 * So first we need (again) a discovery class but now a protocol
291 * discovery to choose the right socket resource. The discovery class
292 * should take a look at the raw package data itself and then decide
293 * which (configurable!) protocol should be used for that type of
296 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
298 // Now discover the right protocol
299 $socketResource = $discoveryInstance->discoverSocket($packageData);
302 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after discoverSocket() has been called.');
304 // We have to put this socket in our registry, so get an instance
305 $registryInstance = SocketRegistry::createSocketRegistry();
307 // Get the listener from registry
308 $helperInstance = Registry::getRegistry()->getInstance('connection');
311 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' before isSocketRegistered() has been called.');
314 if ((is_resource($socketResource)) && (!$registryInstance->isSocketRegistered($helperInstance, $socketResource))) {
316 $registryInstance->registerSocket($helperInstance, $socketResource, $packageData);
320 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after isSocketRegistered() has been called.');
322 // Make sure the connection is up
323 $helperInstance->getStateInstance()->validatePeerStateConnected();
326 //* NOISY-DEBUG: */ $this->debugOutput('NETWORK-PACKAGE: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
328 // We enqueue it again, but now in the out-going queue
329 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
333 * Sends waiting packages
335 * @param $packageData Raw package data
338 private function sendOutgoingRawPackageData (array $packageData) {
342 // Get the right connection instance
343 $helperInstance = SocketRegistry::createSocketRegistry()->getHandlerInstanceFromPackageData($packageData);
345 // Is this connection still alive?
346 if ($helperInstance->isShuttedDown()) {
347 // This connection is shutting down
348 // @TODO We may want to do somthing more here?
352 // Sent out package data
353 $sentBytes = $helperInstance->sendRawPackageData($packageData);
355 // Remember unsent raw bytes in back-buffer, if any
356 $this->storeUnsentBytesInBackBuffer($packageData, $sentBytes);
360 * "Enqueues" raw content into this delivery class by reading the raw content
361 * from given template instance and pushing it on the 'undeclared' stack.
363 * @param $helperInstance An instance of a HelpableHub class
364 * @param $nodeInstance An instance of a NodeHelper class
367 public function enqueueRawDataFromTemplate (HelpableHub $helperInstance, NodeHelper $nodeInstance) {
368 // Get the raw content ...
369 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
371 // ... and compress it
372 $content = $this->getCompressorInstance()->compressStream($content);
374 // Add magic in front of it and hash behind it, including BASE64 encoding
375 $content = sprintf(self::PACKAGE_MASK,
376 // 1.) Compressor's extension
377 $this->getCompressorInstance()->getCompressorExtension(),
378 // 2.) Raw package content, encoded with BASE64
379 base64_encode($content),
381 implode(self::PACKAGE_TAGS_SEPERATOR, $helperInstance->getPackageTags()),
383 $this->getHashFromContent($content, $helperInstance, $nodeInstance)
386 // Now prepare the temporary array and push it on the 'undeclared' stack
387 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
388 self::PACKAGE_DATA_SENDER => $nodeInstance->getSessionId(),
389 self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
390 self::PACKAGE_DATA_CONTENT => $content,
395 * Checks wether a package has been enqueued for delivery.
397 * @return $isEnqueued Wether a package is enqueued
399 public function isPackageEnqueued () {
400 // Check wether the stacker is not empty
401 $isEnqueued = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
408 * Checks wether a package has been declared
410 * @return $isDeclared Wether a package is declared
412 public function isPackageDeclared () {
413 // Check wether the stacker is not empty
414 $isDeclared = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
421 * Checks wether a package should be sent out
423 * @return $isWaitingDelivery Wether a package is waiting for delivery
425 public function isPackageWaitingForDelivery () {
426 // Check wether the stacker is not empty
427 $isWaitingDelivery = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
430 return $isWaitingDelivery;
434 * Delivers an enqueued package to the stated destination. If a non-session
435 * id is provided, recipient resolver is being asked (and instanced once).
436 * This allows that a single package is being delivered to multiple targets
437 * without enqueueing it for every target. If no target is provided or it
438 * can't be determined a NoTargetException is being thrown.
441 * @throws NoTargetException If no target can't be determined
443 public function declareEnqueuedPackage () {
444 // Make sure this method isn't working if there is no package enqueued
445 if (!$this->isPackageEnqueued()) {
446 // This is not fatal but should be avoided
447 // @TODO Add some logging here
451 // Now we know for sure there are packages to deliver, we can start
452 // with the first one.
453 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_UNDECLARED);
455 // Declare the raw package data for delivery
456 $this->declareRawPackageData($packageData);
458 // And remove it finally
459 $this->getStackerInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
463 * Delivers the next declared package. Only one package per time will be sent
464 * because this may take time and slows down the whole delivery
469 public function deliverDeclaredPackage () {
470 // Sanity check if we have packages declared
471 if (!$this->isPackageDeclared()) {
472 // This is not fatal but should be avoided
473 // @TODO Add some logging here
477 // Get the package again
478 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
481 // And try to send it
482 $this->deliverRawPackageData($packageData);
484 // And remove it finally
485 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
486 } catch (InvalidStateException $e) {
487 // The state is not excepected (shall be 'connected')
488 $this->debugOutput('PACKAGE: Unexpected state detected. message=' . $e->getMessage());
493 * Sends waiting packages out for delivery
497 public function sendWaitingPackage () {
498 // Send any waiting bytes in the back-buffer before sending a new package
499 $this->sendBackBufferBytes();
501 // Sanity check if we have packages waiting for delivery
502 if (!$this->isPackageWaitingForDelivery()) {
503 // This is not fatal but should be avoided
504 $this->debugOutput('PACKAGE: No package is waiting for delivery, but ' . __METHOD__ . ' was called.');
508 // Get the package again
509 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_OUTGOING);
512 // Now try to send it
513 $this->sendOutgoingRawPackageData($packageData);
515 // And remove it finally
516 $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING);
517 } catch (InvalidSocketException $e) {
518 // Output exception message
519 $this->debugOutput('PACKAGE: Package was not delivered: ' . $e->getMessage());
523 ///////////////////////////////////////////////////////////////////////////
524 // Receiving packages / raw data
525 ///////////////////////////////////////////////////////////////////////////
528 * Checks wether decoded raw data is pending
530 * @return $isPending Wether decoded raw data is pending
532 private function isDecodedDataPending () {
533 // Just return wether the stack is not empty
534 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
541 * Checks wether new raw package data has arrived at a socket
543 * @param $poolInstance An instance of a PoolableListener class
544 * @return $hasArrived Wether new raw package data has arrived for processing
546 public function isNewRawDataPending (PoolableListener $poolInstance) {
547 // Visit the pool. This monitors the pool for incoming raw data.
548 $poolInstance->accept($this->getVisitorInstance());
550 // Check for new data arrival
551 $hasArrived = $this->isDecodedDataPending();
558 * Handles the incoming decoded raw data. This method does not "convert" the
559 * decoded data back into a package array, it just "handles" it and pushs it
564 public function handleIncomingDecodedData () {
566 * This method should only be called if decoded raw data is pending,
569 if (!$this->isDecodedDataPending()) {
570 // This is not fatal but should be avoided
571 // @TODO Add some logging here
575 // Very noisy debug message:
576 /* NOISY-DEBUG: */ $this->debugOutput('PACKAGE: Stacker size is ' . $this->getStackerInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
578 // "Pop" the next entry (the same array again) from the stack
579 $decodedData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
581 // Make sure both array elements are there
582 assert((is_array($decodedData)) && (isset($decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA])) && (isset($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE])));
585 * Also make sure the error code is SOCKET_ERROR_UNHANDLED because we
586 * only want to handle unhandled packages here.
588 assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
590 // Remove the last chunk seperator (because it is being added and we don't need it)
591 if (substr($decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPERATOR) {
592 // It is there and should be removed
593 $decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_DECODED_DATA], 0, -1);
596 // This package is "handled" and can be pushed on the next stack
597 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
601 * Adds raw decoded data from the given handler instance to this receiver
603 * @param $handlerInstance An instance of a Networkable class
606 public function addDecodedDataToIncomingStack (Networkable $handlerInstance) {
608 * Get the decoded data from the handler, this is an array with
609 * 'decoded_data' and 'error_code' as elements.
611 $decodedData = $handlerInstance->getNextDecodedData();
613 // Very noisy debug message:
614 //* NOISY-DEBUG: */ $this->debugOutput('PACKAGE: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, true));
616 // And push it on our stack
617 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
621 * Checks wether incoming decoded data is handled.
623 * @return $isHandled Wether incoming decoded data is handled
625 public function isIncomingDecodedDataHandled () {
626 // Determine if the stack is not empty
627 $isHandled = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
634 * Assembles incoming decoded data so it will become an abstract network
639 public function assembleDecodedDataToPackage () {
640 $this->partialStub('Please implement this method.');
644 * Checks wether a new package has arrived
646 * @return $hasArrived Wether a new package has arrived for processing
648 public function isNewPackageArrived () {
649 // @TODO Add some content here