application/hub/main/nodes/class_BaseHubNode.php

   1 <?php
   2 /**
   3  * A general hub node class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
  25         /**
  26          * Node types
  27          */
  28         const NODE_TYPE_BOOT    = 'boot';
  29         const NODE_TYPE_MASTER  = 'master';
  30         const NODE_TYPE_LIST    = 'list';
  31         const NODE_TYPE_REGULAR = 'regular';
  32
  33         // Exception constants
  34         const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00;
  35
  36         // Other constants
  37         const OBJECT_LIST_SEPARATOR = ',';
  38
  39         /**
  40          * IP/port number of bootstrapping node
  41          */
  42         private $bootIpPort = '';
  43
  44         /**
  45          * Query connector instance
  46          */
  47         private $queryConnectorInstance = NULL;
  48
  49         /**
  50          * Queue connector instance
  51          */
  52         private $queueConnectorInstance = NULL;
  53
  54         /**
  55          * Whether this node is anncounced (KEEP ON false!)
  56          * @deprecated
  57          */
  58         private $hubIsAnnounced = false;
  59
  60         /**
  61          * Whether this hub is active (default: false)
  62          */
  63         private $isActive = false;
  64
  65         /**
  66          * Whether this node accepts announcements (default: false)
  67          */
  68         private $acceptAnnouncements = false;
  69
  70         /**
  71          * Protected constructor
  72          *
  73          * @param       $className      Name of the class
  74          * @return      void
  75          */
  76         protected function __construct ($className) {
  77                 // Call parent constructor
  78                 parent::__construct($className);
  79
  80                 // Get a wrapper instance
  81                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_info_db_wrapper_class');
  82
  83                 // Set it here
  84                 $this->setWrapperInstance($wrapperInstance);
  85
  86                 // Get a crypto instance
  87                 $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
  88
  89                 // Set it here
  90                 $this->setCryptoInstance($cryptoInstance);
  91
  92                 // Init state which sets the state to 'init'
  93                 $this->initState();
  94         }
  95
  96         /**
  97          * Initializes the node's state which sets it to 'init'
  98          *
  99          * @return      void
 100          */
 101         private function initState() {
 102                 /*
 103                  * Get the state factory and create the initial state, we don't need
 104                  * the state instance here
 105                  */
 106                 NodeStateFactory::createNodeStateInstanceByName('init', $this);
 107         }
 108
 109         /**
 110          * Generates a random string from various data inluding UUID if PECL
 111          * extension uuid is installed.
 112          *
 113          * @param       $length                 Length of the random part
 114          * @return      $randomString   Random string
 115          * @todo        Make this code more generic and move it to CryptoHelper or
 116          */
 117         protected function generateRamdomString ($length) {
 118                 // Get an RNG instance
 119                 $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
 120
 121                 // Generate a pseudo-random string
 122                 $randomString = $rngInstance->randomString($length) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
 123
 124                 // Add UUID for even more entropy for the hasher
 125                 $randomString .= $this->getCryptoInstance()->createUuid();
 126
 127                 // Return it
 128                 return $randomString;
 129         }
 130
 131         /**
 132          * Generates a private key and hashes it (for speeding up things)
 133          *
 134          * @param       $searchInstance         An instance of a LocalSearchCriteria class
 135          * @return void
 136          */
 137         private function generatePrivateKeyAndHash (LocalSearchCriteria $searchInstance) {
 138                 // Generate a pseudo-random string
 139                 $randomString = $this->getCryptoInstance()->randomString(255);
 140
 141                 // Hash and encrypt the string so we become a node id (also documented as "hub id")
 142                 $this->setPrivateKey($this->getCryptoInstance()->encryptString($randomString));
 143                 $this->setPrivateKeyHash($this->getCryptoInstance()->hashString($this->getPrivateKey()));
 144
 145                 // Register the node id with our wrapper
 146                 $this->getWrapperInstance()->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance);
 147
 148                 // Output message
 149                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . '');
 150         }
 151
 152         /**
 153          * Setter for query instance
 154          *
 155          * @param       $connectorInstance              Our new query instance
 156          * @return      void
 157          */
 158         private final function setQueryConnectorInstance (Connectable $connectorInstance) {
 159                 $this->queryConnectorInstance = $connectorInstance;
 160         }
 161
 162         /**
 163          * Getter for query instance
 164          *
 165          * @return      $connectorInstance              Our new query instance
 166          */
 167         public final function getQueryConnectorInstance () {
 168                 return $this->queryConnectorInstance;
 169         }
 170
 171         /**
 172          * Setter for queue instance
 173          *
 174          * @param       $connectorInstance              Our new queue instance
 175          * @return      void
 176          */
 177         private final function setQueueConnectorInstance (Connectable $connectorInstance) {
 178                 $this->queueConnectorInstance = $connectorInstance;
 179         }
 180
 181         /**
 182          * Getter for queue instance
 183          *
 184          * @return      $connectorInstance              Our new queue instance
 185          */
 186         public final function getQueueConnectorInstance () {
 187                 return $this->queueConnectorInstance;
 188         }
 189
 190         /**
 191          * Getter for boot IP/port combination
 192          *
 193          * @return      $bootIpPort             The IP/port combination of the boot node
 194          */
 195         protected final function getBootIpPort () {
 196                 return $this->bootIpPort;
 197         }
 198
 199         /**
 200          * Checks whether the given IP address matches one of the bootstrapping nodes
 201          *
 202          * @param       $remoteAddr             IP address to checkout against our bootstrapping list
 203          * @return      $isFound                Whether the IP is found
 204          */
 205         protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) {
 206                 // By default nothing is found
 207                 $isFound = false;
 208
 209                 // Run through all configured IPs
 210                 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
 211                         // Split it up in IP/port
 212                         $ipPortArray = explode(':', $ipPort);
 213
 214                         // Does it match?
 215                         if ($ipPortArray[0] == $remoteAddr) {
 216                                 // Found it!
 217                                 $isFound = true;
 218
 219                                 // Remember the port number
 220                                 $this->bootIpPort = $ipPort;
 221
 222                                 // Output message
 223                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
 224
 225                                 // Stop further searching
 226                                 break;
 227                         } elseif ($ipPortArray[0] == $this->getConfigInstance()->getConfigEntry('node_listen_addr')) {
 228                                 /*
 229                                  * IP matches listen address. At this point we really don't care
 230                                  * if we can really listen on that address
 231                                  */
 232                                 $isFound = true;
 233
 234                                 // Remember the port number
 235                                 $this->bootIpPort = $ipPort;
 236
 237                                 // Output message
 238                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
 239
 240                                 // Stop further searching
 241                                 break;
 242                         }
 243                 } // END - foreach
 244
 245                 // Return the result
 246                 return $isFound;
 247         }
 248
 249         /**
 250          * Outputs the console teaser. This should only be executed on startup or
 251          * full restarts. This method generates some space around the teaser.
 252          *
 253          * @return      void
 254          */
 255         public function outputConsoleTeaser () {
 256                 // Get the app instance (for shortening our code)
 257                 $app = $this->getApplicationInstance();
 258
 259                 // Output all lines
 260                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
 261                 self::createDebugInstance(__CLASS__)->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
 262                 self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Hub Developer Team');
 263                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
 264                 self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
 265                 self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
 266                 self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
 267                 self::createDebugInstance(__CLASS__)->debugOutput(' ');
 268         }
 269
 270         /**
 271          * Generic method to acquire a hub-id. On first run this generates a new one
 272          * based on many pseudo-random data. On any later run, unless the id
 273          * got not removed from database, it will be restored from the database.
 274          *
 275          * @param       $requestInstance        A Requestable class
 276          * @param       $responseInstance       A Responseable class
 277          * @return      void
 278          */
 279         public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) {
 280                 // Is there a node id?
 281                 if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) {
 282                         // Get the node id from result and set it
 283                         $this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID));
 284
 285                         // Output message
 286                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . '');
 287                 } else {
 288                         // Generate a pseudo-random string
 289                         $randomString = $this->getCryptoInstance()->randomString(255);
 290
 291                         // Hash and encrypt the string so we become a node id (also documented as "hub id")
 292                         $this->setNodeId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
 293
 294                         // Register the node id with our wrapper
 295                         $this->getWrapperInstance()->registerNodeId($this, $this->getRequestInstance());
 296
 297                         // Output message
 298                         self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . '');
 299                 }
 300         }
 301
 302         /**
 303          * Generates a session id which will be sent to the other hubs and peers
 304          *
 305          * @return      void
 306          */
 307         public function bootstrapGenerateSessionId () {
 308                 // Now get a search criteria instance
 309                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 310
 311                 // Search for the node number one which is hard-coded the default
 312                 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR  , 1);
 313                 $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_MODE, $this->getRequestInstance()->getRequestElement('mode'));
 314                 $searchInstance->setLimit(1);
 315
 316                 // Remember it for later usage
 317                 $this->setSearchInstance($searchInstance);
 318
 319                 // Get a random string
 320                 $randomString = $this->generateRamdomString(255);
 321
 322                 // Hash and encrypt the string so we become a "node id" aka Hub-Id
 323                 $this->setSessionId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
 324
 325                 // Register the node id with our wrapper
 326                 $this->getWrapperInstance()->registerSessionId($this, $this->getRequestInstance(), $searchInstance);
 327
 328                 // Output message
 329                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
 330
 331                 // Change the state because the node has auired a hub id
 332                 $this->getStateInstance()->nodeGeneratedSessionId();
 333         }
 334
 335         /**
 336          * Generate a private key for en-/decryption
 337          *
 338          * @return      void
 339          */
 340         public function bootstrapGeneratePrivateKey () {
 341                 // Is it valid?
 342                 if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) {
 343                         // Is the element set?
 344                         if (is_null($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))) {
 345                                 /*
 346                                  * Auto-generate the private key for e.g. out-dated database
 347                                  * "tables". This allows a smooth update for the underlaying
 348                                  * database table.
 349                                  */
 350                                 $this->generatePrivateKeyAndHash($this->getSearchInstance());
 351                         } else {
 352                                 // Get the node id from result and set it
 353                                 $this->setPrivateKey(base64_decode($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY)));
 354                                 $this->setPrivateKeyHash($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH));
 355
 356                                 // Output message
 357                                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found private key hash: ' . $this->getPrivateKeyHash() . '');
 358                         }
 359                 } else {
 360                         /*
 361                          * Generate it in a private method (no confusion with 'private
 362                          * method access' and 'private key' here! ;-)).
 363                          */
 364                         $this->generatePrivateKeyAndHash($this->getSearchInstance());
 365                 }
 366         }
 367
 368         /**
 369          * Adds hub data elements to a given dataset instance
 370          *
 371          * @param       $criteriaInstance       An instance of a storeable criteria
 372          * @param       $requestInstance        An instance of a Requestable class
 373          * @return      void
 374          */
 375         public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
 376                 // Make sure request instance is set as it is not optional
 377                 assert($requestInstance instanceof Requestable);
 378
 379                 // Add node number and type
 380                 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR  , 1);
 381                 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_MODE, $requestInstance->getRequestElement('mode'));
 382
 383                 // Add the node id
 384                 $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId());
 385
 386                 // Add the session id if acquired
 387                 if ($this->getSessionId() != '') {
 388                         $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId());
 389                 } // END - if
 390
 391                 // Add the private key if acquired
 392                 if ($this->getPrivateKey() != '') {
 393                         $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY, base64_encode($this->getPrivateKey()));
 394                         $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH, $this->getPrivateKeyHash());
 395                 } // END - if
 396         }
 397
 398         /**
 399          * Updates a given field with new value
 400          *
 401          * @param       $fieldName              Field to update
 402          * @param       $fieldValue             New value to store
 403          * @return      void
 404          * @throws      DatabaseUpdateSupportException  If this class does not support database updates
 405          * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
 406          */
 407         public function updateDatabaseField ($fieldName, $fieldValue) {
 408                 // Unfinished
 409                 $this->partialStub('Unfinished!');
 410                 return;
 411
 412                 // Get a critieria instance
 413                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 414
 415                 // Add search criteria
 416                 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
 417                 $searchInstance->setLimit(1);
 418
 419                 // Now get another criteria
 420                 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
 421
 422                 // Add criteria entry which we shall update
 423                 $updateInstance->addCriteria($fieldName, $fieldValue);
 424
 425                 // Add the search criteria for searching for the right entry
 426                 $updateInstance->setSearchInstance($searchInstance);
 427
 428                 // Set wrapper class name
 429                 $updateInstance->setWrapperConfigEntry('user_db_wrapper_class');
 430
 431                 // Remember the update in database result
 432                 $this->getResultInstance()->add2UpdateQueue($updateInstance);
 433         }
 434
 435         /**
 436          * Announces this hub to the upper (bootstrap or list) hubs. After this is
 437          * successfully done the given task is unregistered from the handler. This
 438          * might look a bit overloaded here but the announcement phase isn't a
 439          * simple "Hello there" message, it may later on also contain more
 440          * informations like the object list.
 441          *
 442          * @param       $taskInstance   The task instance running this announcement
 443          * @return      void
 444          * @throws      NodeAlreadyAnnouncedException   If this hub is already announced
 445          * @todo        Change the first if() block to check for a specific state
 446          */
 447         public function announceToUpperNodes (Taskable $taskInstance) {
 448                 // Is this hub node announced?
 449                 if ($this->hubIsAnnounced === true) {
 450                         // Already announced!
 451                         throw new NodeAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED);
 452                 } // END - if
 453
 454                 // Debug output
 455                 self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
 456
 457                 // Get a helper instance
 458                 $helperInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_helper_class');
 459
 460                 // Load the announcement descriptor
 461                 $helperInstance->loadDescriptorXml($this);
 462
 463                 // Compile all variables
 464                 $helperInstance->getTemplateInstance()->compileConfigInVariables();
 465
 466                 // "Publish" the descriptor by sending it to the bootstrap/list nodes
 467                 $helperInstance->sendPackage($this);
 468
 469                 // Change the state, this should be the last line except debug output
 470                 $this->getStateInstance()->nodeAnnouncedToUpperHubs();
 471
 472                 // Debug output
 473                 self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: FINISHED');
 474         }
 475
 476         /**
 477          * Does a self-connect attempt on the public IP address. This should make
 478          * it sure, we are reachable from outside world. For this kind of package we
 479          * don't need that overload we have in the announcement phase.
 480          *
 481          * @param       $taskInstance   The task instance running this announcement
 482          * @return      void
 483          */
 484         public function doSelfConnection (Taskable $taskInstance) {
 485                 // Debug output
 486                 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
 487
 488                 // Get a helper instance
 489                 $helperInstance = ObjectFactory::createObjectByConfiguredName('node_self_connect_helper_class', array($this));
 490
 491                 // Load the descriptor (XML) file
 492                 $helperInstance->loadDescriptorXml($this);
 493
 494                 // Compile all variables
 495                 $helperInstance->getTemplateInstance()->compileConfigInVariables();
 496
 497                 // And send the package away
 498                 $helperInstance->sendPackage($this);
 499
 500                 // Debug output
 501                 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Self Connection: FINISHED');
 502         }
 503
 504         /**
 505          * Activates the hub by doing some final preparation and setting
 506          * $hubIsActive to true
 507          *
 508          * @param       $requestInstance        A Requestable class
 509          * @param       $responseInstance       A Responseable class
 510          * @return      void
 511          */
 512         public function activateNode (Requestable $requestInstance, Responseable $responseInstance) {
 513                 // Checks whether a listener is still active and shuts it down if one
 514                 // is still listening.
 515                 if (($this->determineIfListenerIsActive()) && ($this->isNodeActive())) {
 516                         // Shutdown them down before they can hurt anything
 517                         $this->shutdownListenerPool();
 518                 } // END - if
 519
 520                 // Get the controller here
 521                 $controllerInstance = Registry::getRegistry()->getInstance('controller');
 522
 523                 // Run all filters for the hub activation
 524                 $controllerInstance->executeActivationFilters($requestInstance, $responseInstance);
 525
 526                 // ----------------------- Last step from here ------------------------
 527                 // Activate the hub. This is ALWAYS the last step in this method
 528                 $this->getStateInstance()->nodeIsActivated();
 529                 // ---------------------- Last step until here ------------------------
 530         }
 531
 532         /**
 533          * Initializes the listener pool (class)
 534          *
 535          * @return      void
 536          */
 537         public function initializeListenerPool () {
 538                 // Debug output
 539                 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: START');
 540
 541                 // Get a new pool instance
 542                 $this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)));
 543
 544                 // Get an instance of the low-level listener
 545                 $listenerInstance = ObjectFactory::createObjectByConfiguredName('tcp_listener_class', array($this));
 546
 547                 // Setup address and port
 548                 $listenerInstance->setListenAddressByConfiguration('node_listen_addr');
 549
 550                 /*
 551                  * All nodes can now use the same configuration entry because it can be
 552                  * customized in config-local.php.
 553                  */
 554                 $listenerInstance->setListenPortByConfiguration('node_listen_port');
 555
 556                 // Initialize the listener
 557                 $listenerInstance->initListener();
 558
 559                 // Get a decorator class
 560                 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_tcp_listener_class', array($listenerInstance));
 561
 562                 // Add this listener to the pool
 563                 $this->getListenerPoolInstance()->addListener($decoratorInstance);
 564
 565                 // Get a decorator class
 566                 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance));
 567
 568                 // Add this listener to the pool
 569                 $this->getListenerPoolInstance()->addListener($decoratorInstance);
 570
 571                 // Get an instance of the low-level listener
 572                 $listenerInstance = ObjectFactory::createObjectByConfiguredName('udp_listener_class', array($this));
 573
 574                 // Setup address and port
 575                 $listenerInstance->setListenAddressByConfiguration('node_listen_addr');
 576
 577                 /*
 578                  * All nodes can now use the same configuration entry because it can be
 579                  * customized in config-local.php.
 580                  */
 581                 $listenerInstance->setListenPortByConfiguration('node_listen_port');
 582
 583                 // Initialize the listener
 584                 $listenerInstance->initListener();
 585
 586                 // Get a decorator class
 587                 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_udp_listener_class', array($listenerInstance));
 588
 589                 // Add this listener to the pool
 590                 $this->getListenerPoolInstance()->addListener($decoratorInstance);
 591
 592                 // Get a decorator class
 593                 $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance));
 594
 595                 // Add this listener to the pool
 596                 $this->getListenerPoolInstance()->addListener($decoratorInstance);
 597
 598                 // Debug output
 599                 self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: FINISHED.');
 600         }
 601
 602         /**
 603          * Getter for isActive attribute
 604          *
 605          * @return      $isActive       Whether the hub is active
 606          */
 607         public final function isNodeActive () {
 608                 return $this->isActive;
 609         }
 610
 611         /**
 612          * Enables (default) or disables isActive flag
 613          *
 614          * @param       $isActive       Whether the hub is active
 615          * @return      void
 616          */
 617         public final function enableIsActive ($isActive = true) {
 618                 $this->isActive = (bool) $isActive;
 619         }
 620
 621         /**
 622          * Checks whether this node accepts announcements
 623          *
 624          * @return      $acceptAnnouncements    Whether this node accepts announcements
 625          */
 626         public final function isAcceptingAnnouncements () {
 627                 // Check it (this node must be active and not shutdown!)
 628                 $acceptAnnouncements = (($this->acceptAnnouncements === true) && ($this->isNodeActive()));
 629
 630                 // Return it
 631                 return $acceptAnnouncements;
 632         }
 633
 634         /**
 635          * Checks whether this node has attempted to announce itself
 636          *
 637          * @return      $hasAnnounced   Whether this node has attempted to announce itself
 638          * @todo        Add checking if this node has been announced to the sender node
 639          */
 640         public function ifNodeHasAnnounced () {
 641                 // Debug message
 642                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnounced(): state=' . $this->getStateInstance()->getStateName());
 643
 644                 // Simply check the state of this node
 645                 $hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncedState);
 646
 647                 // Debug message
 648                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced));
 649
 650                 // Return it
 651                 return $hasAnnounced;
 652         }
 653
 654         /**
 655          * Checks whether this node has attempted to announce itself and completed it
 656          *
 657          * @return      $hasAnnouncementCompleted       Whether this node has attempted to announce itself and completed it
 658          * @todo        Add checking if this node has been announced to the sender node
 659          */
 660         public function ifNodeHasAnnouncementCompleted () {
 661                 // Debug message
 662                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
 663
 664                 // Simply check the state of this node
 665                 $hasAnnouncementCompleted = ($this->getStateInstance() instanceof NodeAnnouncementCompletedState);
 666
 667                 // Debug message
 668                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
 669
 670                 // Return it
 671                 return $hasAnnouncementCompleted;
 672         }
 673
 674         /**
 675          * Enables whether this node accepts announcements
 676          *
 677          * @param       $acceptAnnouncements    Whether this node accepts announcements (default: true)
 678          * @return      void
 679          */
 680         protected final function enableAcceptingAnnouncements ($acceptAnnouncements = true) {
 681                 $this->acceptAnnouncements = $acceptAnnouncements;
 682         }
 683
 684         /**
 685          * Checks wether this node is accepting node-list requests
 686          *
 687          * @return      $acceptsRequest         Wether this node accepts node-list requests
 688          */
 689         public function isAcceptingNodeListRequests () {
 690                 /*
 691                  * Only 'regular' nodes does not accept such requests, checking
 692                  * HubRegularNode is faster, but if e.g. HubRegularI2PNode will be
 693                  * added then the next check will be true.
 694                  */
 695                 $acceptsRequest = ((!$this instanceof HubRegularNode) && ($this->getRequestInstance()->getRequestElement('mode') != self::NODE_TYPE_REGULAR));
 696
 697                 // Return it
 698                 return $acceptsRequest;
 699         }
 700
 701         /**
 702          * "Getter" for address:port combination
 703          *
 704          * @return      $addressPort    A address:port combination for this node
 705          */
 706         public final function getAddressPort () {
 707                 // Get IP and port
 708                 $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry('node_listen_port');
 709
 710                 // Return it
 711                 return $addressPort;
 712         }
 713
 714         /**
 715          * "Getter" for address:port array
 716          *
 717          * @return      $addressPortArray       An array of a address:port combination for this node
 718          */
 719         public final function getAddressPortArray () {
 720                 // Get IP and port
 721                 $addressPortArray = explode(':', $this->getAddressPort());
 722
 723                 // Return it
 724                 return $addressPortArray;
 725         }
 726
 727         /**
 728          * Updates/refreshes node data (e.g. status).
 729          *
 730          * @return      void
 731          * @todo        Find more to do here
 732          */
 733         public function updateNodeData () {
 734                 // Set some dummy configuration entries, e.g. node_status
 735                 $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
 736         }
 737
 738         /**
 739          * Handles message answer by given data array
 740          *
 741          * @param       $messageData            A valid answer message data array
 742          * @param       $packageInstance        An instance of a Receivable class
 743          * @return      void
 744          * @todo        Handle thrown exception
 745          */
 746         public function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance) {
 747                 // Is it not empty?
 748                 assert(!empty($messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]));
 749
 750                 // Construct configuration entry for handling class' name
 751                 $classConfigEntry = strtolower($messageData[NetworkPackage::MESSAGE_ARRAY_TYPE] . '_status_' . $messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]) . '_handler_class';
 752
 753                 // Try to get a class
 754                 $handlerInstance = ObjectFactory::createObjectByConfiguredName($classConfigEntry);
 755
 756                 // Handle it there
 757                 $handlerInstance->handleAnswerMessageData($messageData, $packageInstance);
 758         }
 759
 760         /**
 761          * "Getter" for an array of all accepted object types
 762          *
 763          * @return      $objectList             Array of all accepted object types
 764          */
 765         public function getListFromAcceptedObjectTypes () {
 766                 // Get registry instance
 767                 $objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
 768
 769                 // Get all entries
 770                 $objectList = $objectRegistryInstance->getEntries(XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_NAME);
 771
 772                 // ... and return it
 773                 return $objectList;
 774         }
 775 }
 776
 777 // [EOF]
 778 ?>