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.
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
14 * For performance reasons, this class should only be instantiated once and then
15 * used as a "pipe-through" class.
17 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
37 class NetworkPackage extends BaseFrameworkSystem implements Deliverable, Registerable {
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
45 const PACKAGE_MASK = '%s:%s:%s:%s';
48 * Seperator for the above mask
50 const PACKAGE_MASK_SEPERATOR = ':';
53 * Array indexes for above mask, start with zero
55 const INDEX_COMPRESSOR_EXTENSION = 0;
56 const INDEX_PACKAGE_DATA = 1;
58 const INDEX_CHECKSUM = 3;
63 const PACKAGE_TAGS_SEPERATOR = ';';
66 * Raw package data seperator
68 const PACKAGE_DATA_SEPERATOR = '|';
71 * Stacker name for "undeclared" packages
73 const STACKER_NAME_UNDECLARED = 'undeclared';
76 * Stacker name for "declared" packages (which are ready to send out)
78 const STACKER_NAME_DECLARED = 'declared';
81 * Stacker name for "out-going" packages
83 const STACKER_NAME_OUTGOING = 'outgoing';
86 * Network target (alias): 'upper hubs'
88 const NETWORK_TARGET_UPPER_HUBS = 'upper';
91 * Protected constructor
95 protected function __construct () {
96 // Call parent constructor
97 parent::__construct(__CLASS__);
99 // We need to initialize a stack here for our packages even those
100 // which have no recipient address and stamp... ;-)
101 $stackerInstance = ObjectFactory::createObjectByConfiguredName('package_stacker_class');
103 // At last, set it in this class
104 $this->setStackerInstance($stackerInstance);
108 * Creates an instance of this class
110 * @param $compressorInstance A Compressor instance for compressing the content
111 * @return $packageInstance An instance of a Deliverable class
113 public final static function createNetworkPackage (Compressor $compressorInstance) {
115 $packageInstance = new NetworkPackage();
117 // Now set the compressor instance
118 $packageInstance->setCompressorInstance($compressorInstance);
120 // Return the prepared instance
121 return $packageInstance;
125 * "Getter" for hash from given content and helper instance
127 * @param $content Raw package content
128 * @param $helperInstance A BaseHubHelper instance
129 * @return $hash Hash for given package content
131 private function getHashFromContent ($content, BaseHubHelper $helperInstance) {
133 // @TODO crc32 is not good, but it needs to be fast
137 $helperInstance->getNodeInstance()->getSessionId() .
139 $this->getCompressorInstance()->getCompressorExtension()
147 * Delivers the given raw package data.
149 * @param $packageData Raw package data in an array
152 private function deliverPackage (array $packageData) {
154 * We need to disover every recipient, just in case we have a
155 * multi-recipient entry like 'upper' is. 'all' may be a not so good
156 * target because it causes an overload on the network and may be
157 * abused for attacking the network with large packages.
159 $discoveryInstance = PackageDiscoveryFactory::createPackageDiscoveryInstance();
161 // Discover all recipients, this may throw an exception
162 $discoveryInstance->discoverRecipients($packageData);
164 // Now get an iterator
165 $iteratorInstance = $discoveryInstance->getIterator();
167 // ... and begin iteration
168 while ($iteratorInstance->valid()) {
170 $currentRecipient = $iteratorInstance->current();
173 $this->debugOutput('PACKAGE: Package declared for recipient ' . $currentRecipient);
176 $packageData['recipient'] = $currentRecipient;
178 // And enqueue it to the writer class
179 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
181 // Skip to next entry
182 $iteratorInstance->next();
186 $discoveryInstance->clearRecipients();
190 * Sends a raw package out
192 * @param $packageData Raw package data in an array
195 private function sendRawPackage (array $packageData) {
197 * This package may become big, depending on the shared object size or
198 * delivered message size which shouldn't be so long (to save
199 * bandwidth). Because of the nature of the used protocol (TCP) we need
200 * to split it up into smaller pieces to fit it into a TCP frame.
202 * So first we need (again) a discovery class but now a protocol
203 * discovery to choose the right socket resource. The discovery class
204 * should take a look at the raw package data itself and then decide
205 * which (configurable!) protocol should be used for that type of
208 $discoveryInstance = SocketDiscoveryFactory::createSocketDiscoveryInstance();
210 // Now discover the right protocol
211 $socketResource = $discoveryInstance->discoverSocket($packageData);
213 // We have to put this socket in our registry, so get an instance
214 $registryInstance = SocketRegistry::createSocketRegistry();
216 // Get the listener from registry
217 $connectionInstance = Registry::getRegistry()->getInstance('connection');
220 if (!$registryInstance->isSocketRegistered($connectionInstance, $socketResource)) {
222 $registryInstance->registerSocket($connectionInstance, $socketResource, $packageData);
225 // We enqueue it again, but now in the out-going queue
226 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
230 * Sends waiting packages
232 * @param $packageData Raw package data
235 private function sendOutgoingPackage (array $packageData) {
236 // Get the right connection instance
237 $connectionInstance = SocketRegistry::createSocketRegistry()->getHandlerInstanceFromPackageData($packageData);
239 // Sent it away (we catch exceptions one method above
240 $connectionInstance->sendRawPackageData($packageData);
244 * "Enqueues" raw content into this delivery class by reading the raw content
245 * from given template instance and pushing it on the 'undeclared' stack.
247 * @param $helperInstance A BaseHubHelper instance
250 public function enqueueRawDataFromTemplate (BaseHubHelper $helperInstance) {
251 // Get the raw content ...
252 $content = $helperInstance->getTemplateInstance()->getRawTemplateData();
254 // ... and compress it
255 $content = $this->getCompressorInstance()->compressStream($content);
257 // Add magic in front of it and hash behind it, including BASE64 encoding
258 $content = sprintf(self::PACKAGE_MASK,
259 // 1.) Compressor's extension
260 $this->getCompressorInstance()->getCompressorExtension(),
261 // 2.) Raw package content, encoded with BASE64
262 base64_encode($content),
264 implode(self::PACKAGE_TAGS_SEPERATOR, $helperInstance->getPackageTags()),
266 $this->getHashFromContent($content, $helperInstance)
269 // Now prepare the temporary array and push it on the 'undeclared' stack
270 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
271 'sender' => $helperInstance->getNodeInstance()->getSessionId(),
272 'recipient' => self::NETWORK_TARGET_UPPER_HUBS,
273 'content' => $content,
278 * Checks wether a package has been enqueued for delivery.
280 * @return $isEnqueued Wether a package is enqueued
282 public function isPackageEnqueued () {
283 // Check wether the stacker is not empty
284 $isEnqueued = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
291 * Checks wether a package has been declared
293 * @return $isDeclared Wether a package is declared
295 public function isPackageDeclared () {
296 // Check wether the stacker is not empty
297 $isDeclared = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
304 * Checks wether a package should be sent out
306 * @return $isWaitingDelivery Wether a package is waiting for delivery
308 public function isPackageWaitingDelivery () {
309 // Check wether the stacker is not empty
310 $isWaitingDelivery = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
313 return $isWaitingDelivery;
317 * Delivers an enqueued package to the stated destination. If a non-session
318 * id is provided, recipient resolver is being asked (and instanced once).
319 * This allows that a single package is being delivered to multiple targets
320 * without enqueueing it for every target. If no target is provided or it
321 * can't be determined a NoTargetException is being thrown.
324 * @throws NoTargetException If no target can't be determined
326 public function declareEnqueuedPackage () {
327 // Make sure this method isn't working if there is no package enqueued
328 if (!$this->isPackageEnqueued()) {
329 // This is not fatal but should be avoided
330 // @TODO Add some logging here
334 // Now we know for sure there are packages to deliver, we can start
335 // with the first one.
336 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_UNDECLARED);
338 // Finally, deliver the package
339 $this->deliverPackage($packageData);
341 // And remove it finally
342 $this->getStackerInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
346 * Delivers the next declared package. Only one package per time will be sent
347 * because this may take time and slows down the whole delivery
352 public function deliverDeclaredPackage () {
353 // Sanity check if we have packages declared
354 if (!$this->isPackageDeclared()) {
355 // This is not fatal but should be avoided
356 // @TODO Add some logging here
360 // Get the package again
361 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
364 $this->sendRawPackage($packageData);
366 // And remove it finally
367 $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
371 * Sends waiting packages out for delivery
375 public function sentWaitingPackage () {
376 // Sanity check if we have packages waiting for delivery
377 if (!$this->isPackageWaitingDelivery()) {
378 // This is not fatal but should be avoided
379 // @TODO Add some logging here
383 // Get the package again
384 $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_OUTGOING);
386 // Now try to send it
388 $this->sendOutgoingPackage($packageData);
390 // And remove it finally when it has been fully delivered
391 $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING);
392 } catch (InvalidSocketException $e) {
393 // Output exception message
394 $this->debugOutput('PACKAGE: Package was not delivered: ' . $e->getMessage());