application/hub/main/nodes/class_BaseHubNode.php

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