X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=07974fad42ddec9c2d308b124c7a67bac54eef84;hb=dfe38c5c2ff89adebea4f61364eb556a83da35a3;hp=a52541a2e8e8119cb2d1ed7a61875f3d17cf3e0a;hpb=c9d2506483b57950d5ff148b112e82a2e5713337;p=hub.git diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index a52541a2e..07974fad4 100644 --- a/application/hub/main/nodes/class_BaseHubNode.php +++ b/application/hub/main/nodes/class_BaseHubNode.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -23,9 +23,15 @@ */ class BaseHubNode extends BaseHubSystem implements Updateable { /** - * Node id + * Node types */ - private $nodeId = ''; + const NODE_TYPE_BOOT = 'boot'; + const NODE_TYPE_MASTER = 'master'; + const NODE_TYPE_LIST = 'list'; + const NODE_TYPE_REGULAR = 'regular'; + + // Exception constants + const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00; /** * IP/port number of bootstrapping node @@ -35,17 +41,23 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /** * Query connector instance */ - private $queryInstance = null; + private $queryConnectorInstance = NULL; /** - * Listener pool instance + * Queue connector instance */ - private $listenerPoolInstance = null; + private $queueConnectorInstance = NULL; /** - * Wether the hub is active (true/false) + * Whether this node is anncounced (KEEP ON false!) + * @deprecated */ - private $hubIsActive = false; + private $hubIsAnnounced = false; + + /** + * Whether this hub is active + */ + private $isActive = false; /** * Protected constructor @@ -56,6 +68,22 @@ class BaseHubNode extends BaseHubSystem implements Updateable { protected function __construct ($className) { // Call parent constructor parent::__construct($className); + + // Init state which sets the state to 'init' + $this->initState(); + } + + /** + * Initializes the node's state which sets it to 'init' + * + * @return void + */ + private function initState() { + /* + * Get the state factory and create the initial state, we don't need + * the state instance here + */ + NodeStateFactory::createNodeStateInstanceByName('init', $this); } /** @@ -65,30 +93,98 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ private final function setNodeId ($nodeId) { - $this->nodeId = (string) $nodeId; + // Set it config now + $this->getConfigInstance()->setConfigEntry('node_id', (string) $nodeId); } /** * Getter for node id * - * @return $nodeId Our new node id + * @return $nodeId Current node id */ private final function getNodeId () { - return $this->nodeId; + // Get it from config + return $this->getConfigInstance()->getConfigEntry('node_id'); + } + + /** + * Setter for session id + * + * @param $sessionId Our new session id + * @return void + */ + private final function setSessionId ($sessionId) { + $this->getConfigInstance()->setConfigEntry('session_id', (string) $sessionId); + } + + /** + * Getter for session id + * + * @return $sessionId Current session id + */ + public final function getSessionId () { + return $this->getConfigInstance()->getConfigEntry('session_id'); + } + + /** + * Setter for query instance + * + * @param $connectorInstance Our new query instance + * @return void + */ + private final function setQueryConnectorInstance (Connectable $connectorInstance) { + $this->queryConnectorInstance = $connectorInstance; + } + + /** + * Getter for query instance + * + * @return $connectorInstance Our new query instance + */ + public final function getQueryConnectorInstance () { + return $this->queryConnectorInstance; + } + + /** + * Setter for queue instance + * + * @param $connectorInstance Our new queue instance + * @return void + */ + private final function setQueueConnectorInstance (Connectable $connectorInstance) { + $this->queueConnectorInstance = $connectorInstance; } /** - * Checks wether the given IP address matches one of the bootstrapping nodes + * Getter for queue instance + * + * @return $connectorInstance Our new queue instance + */ + public final function getQueueConnectorInstance () { + return $this->queueConnectorInstance; + } + + /** + * Getter for boot IP/port combination + * + * @return $bootIpPort The IP/port combination of the boot node + */ + protected final function getBootIpPort () { + return $this->bootIpPort; + } + + /** + * Checks whether the given IP address matches one of the bootstrapping nodes * * @param $remoteAddr IP address to checkout against our bootstrapping list - * @return $isFound Wether the IP is found + * @return $isFound Whether the IP is found */ protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) { // By default nothing is found $isFound = false; // Run through all configured IPs - foreach (explode(',', $this->getConfigInstance()->readConfig('hub_bootstrap_nodes')) as $ipPort) { + foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) { // Split it up in IP/port $ipPortArray = explode(':', $ipPort); @@ -101,20 +197,20 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->bootIpPort = $ipPort; // Output message - $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP matches remote address ' . $ipPort . '.'); + $this->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.'); // Stop further searching break; - } elseif ($ipPortArray[0] == $this->getConfigInstance()->readConfig('node_listen_addr')) { + } elseif ($ipPortArray[0] == $this->getConfigInstance()->getConfigEntry('node_listen_addr')) { // IP matches listen address. At this point we really don't care - // if we can also listen on that address! + // if we can really listen on that address $isFound = true; // Remember the port number $this->bootIpPort = $ipPort; // Output message - $this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP matches listen address ' . $ipPort . '.'); + $this->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.'); // Stop further searching break; @@ -136,41 +232,14 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $app = $this->getApplicationInstance(); // Output all lines - $this->getDebugInstance()->output(' '); - $this->getDebugInstance()->output($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active'); - $this->getDebugInstance()->output('Copyright (c) 2007 - 2008 Roland Haeder, 2009 Hub Developer Team'); - $this->getDebugInstance()->output(' '); - $this->getDebugInstance()->output('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.'); - $this->getDebugInstance()->output('This is free software, and you are welcome to redistribute it under certain'); - $this->getDebugInstance()->output('conditions; see docs/COPYING for details.'); - $this->getDebugInstance()->output(' '); - } - - /** - * Do generic things for bootup phase. This can be e.g. checking if the - * right node mode is selected for this hub's IP number. - * - * @return void - * @todo This method is maybe not yet finished. - */ - protected function doGenericBootstrapping () { - // --------------------- Hub-id acquirement phase --------------------- - // Acquire a hub-id. This step generates on first launch a new one and - // on any later launches it will restore the hub-id from the database. - // A passed 'nickname=xxx' argument will be used to add some - // 'personality' to the hub. - $this->bootstrapAcquireHubId(); - - // ------------------- More generic bootstrap steps ------------------- - // Generate the session id which will only be stored in RAM and kept for - // the whole "session". - $this->bootstrapGenerateSessionId(); - - // Restore a previously downloaded bootstrap-node list. - $this->bootstrapRestoreNodeList(); - - // @TODO Add some generic bootstrap steps - $this->partialStub('Add some generic bootstrap steps here.'); + $this->debugOutput(' '); + $this->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active'); + $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2011 Hub Developer Team'); + $this->debugOutput(' '); + $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.'); + $this->debugOutput('This is free software, and you are welcome to redistribute it under certain'); + $this->debugOutput('conditions; see docs/COPYING for details.'); + $this->debugOutput(' '); } /** @@ -178,9 +247,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * based on many pseudo-random data. On any later run, unless the id * got not removed from database, it will be restored from the database. * + * @param $requestInstance A Requestable class + * @param $responseInstance A Responseable class * @return void */ - private function bootstrapAcquireHubId () { + public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) { // Get a wrapper instance $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); @@ -204,38 +275,84 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID)); // Output message - $this->getDebugInstance()->output('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . ''); + $this->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . ''); } else { // Get an RNG instance (Random Number Generator) $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); // Generate a pseudo-random string - $randomString = $rngInstance->randomString(255) . ':' . $this->getRequestInstance()->getRequestElement('mode'); + $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode'); // Get a crypto instance $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class'); - // Hash and encrypt the string so we become a "node id" aka Hub-Id + // Hash and encrypt the string so we become a node id (also documented as "hub id") $this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString))); // Register the node id with our wrapper $wrapperInstance->registerNodeId($this, $this->getRequestInstance()); // Output message - $this->getDebugInstance()->output('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . ''); + $this->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . ''); } } + /** + * Generates a session id which will be sent to the other hubs and peers + * + * @return void + */ + public function bootstrapGenerateSessionId () { + // Get an RNG instance + $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); + + // Generate a pseudo-random string + $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode'); + + // Get a crypto instance + $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class'); + + // Hash and encrypt the string so we become a "node id" aka Hub-Id + $this->setSessionId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString))); + + // Get a wrapper instance + $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); + + // Register the node id with our wrapper + $wrapperInstance->registerSessionId($this, $this->getRequestInstance()); + + // Output message + $this->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . ''); + + // Change the state because the node has auired a hub id + $this->getStateInstance()->nodeGeneratedSessionId(); + } + /** * Initializes queues which every node needs * * @return void */ protected function initGenericQueues () { - // Set it - $this->queryInstance = ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this)); + // Debug message + $this->debugOutput('BOOTSTRAP: Initialize queues: START'); + + // Set the query connector instance + $this->setQueryConnectorInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this))); + + // Run a test query + $this->getQueryConnectorInstance()->doTestQuery(); + + // Set the queue connector instance + $this->setQueueConnectorInstance(ObjectFactory::createObjectByConfiguredName('queue_connector_class', array($this))); + + // Run a test queue + $this->getQueueConnectorInstance()->doTestQueue(); + + // Debug message + $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED'); } - + /** * Adds hub data elements to a given dataset instance * @@ -250,6 +367,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Add the node id $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId()); + + // Add the session id if acquired + if ($this->getSessionId() != '') { + $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId()); + } // END - if } /** @@ -290,37 +412,99 @@ class BaseHubNode extends BaseHubSystem implements Updateable { } /** - * Getter for $hubIsActive attribute + * Announces this hub to the upper (bootstrap or list) hubs. After this is + * successfully done the given task is unregistered from the handler. This + * might look a bit overloaded here but the announcement phase isn't a + * simple "Hello there" message, it may later on also contain more + * informations like the object list. * - * @return $hubIsActive Wether the hub is activer + * @param $taskInstance The task instance running this announcement + * @return void + * @throws HubAlreadyAnnouncedException If this hub is already announced + * @todo Change the first if() block to check for a specific state + */ + public function announceSelfToUpperNodes (Taskable $taskInstance) { + // Is this hub node announced? + if ($this->hubIsAnnounced === true) { + // Already announced! + throw new HubAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED); + } // END - if + + // Debug output + $this->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); + + // Get a helper instance + $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this)); + + // Load the announcement descriptor + $helperInstance->loadDescriptorXml(); + + // Set some dummy configuration entries, e.g. node_status + $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName()); + + // Compile all variables + $helperInstance->getTemplateInstance()->compileConfigInVariables(); + + // "Publish" the descriptor by sending it to the bootstrap/list nodes + $helperInstance->sendPackage($this); + + // Change the state, this should be the last line except debug output + $this->getStateInstance()->nodeAnnouncedToUpperHubs(); + + // Debug output + $this->debugOutput('HUB-Announcement: FINISHED'); + } + + /** + * Does a self-connect attempt on the public IP address. This should make + * it sure, we are reachable from outside world. For this kind of package we + * don't need that overload we have in the announcement phase. + * + * @param $taskInstance The task instance running this announcement + * @return void */ - public final function isHubActive () { - return $this->hubIsActive; + public function doSelfConnection (Taskable $taskInstance) { + // Debug output + $this->debugOutput('HUB: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')'); + + // Get a helper instance + $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_self_connect_helper_class', array($this)); + + // Load the descriptor (XML) file + $helperInstance->loadDescriptorXml(); + + // And send the package away + $helperInstance->sendPackage($this); + + // Debug output + $this->debugOutput('HUB: Self Connection: FINISHED'); } /** * Activates the hub by doing some final preparation and setting * $hubIsActive to true * + * @param $requestInstance A Requestable class + * @param $responseInstance A Responseable class * @return void */ - public function activateHub () { - // Checks wether a listener is still active and shuts it down if one - // is still listening - if (($this->checkIfListenerIsActive()) && ($this->isHubActive())) { + public function activateNode (Requestable $requestInstance, Responseable $responseInstance) { + // Checks whether a listener is still active and shuts it down if one + // is still listening. + if (($this->determineIfListenerIsActive()) && ($this->getIsActive())) { // Shutdown them down before they can hurt anything $this->shutdownListenerPool(); } // END - if - // Initialize the TCP/UDP listener pool - $this->initializeListenerPool(); + // Get the controller here + $controllerInstance = Registry::getRegistry()->getInstance('controller'); - // @TODO Do some final preparation - $this->partialStub('Do some final preparation before the hub gots activated.'); + // Run all filters for the hub activation + $controllerInstance->executeActivationFilters($requestInstance, $responseInstance); // ----------------------- Last step from here ------------------------ // Activate the hub. This is ALWAYS the last step in this method - $this->hubIsActive = true; + $this->getStateInstance()->nodeIsActivated(); // ---------------------- Last step until here ------------------------ } @@ -329,15 +513,143 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * * @return void */ - private function initializeListenerPool () { + public function initializeListenerPool () { + // Debug output + $this->debugOutput('HUB: Initialize listener: START'); + // Get a new pool instance - $this->listenerPoolInstance = ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)); + $this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this))); + + // Get an instance of the low-level listener + $listenerInstance = ObjectFactory::createObjectByConfiguredName('tcp_listener_class', array($this)); + + // Setup address and port + $listenerInstance->setListenAddressByConfiguration('node_listen_addr'); + + /* + * All nodes can now use the same configuration entry because it can be + * customized in config-local.php. + */ + $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port'); + + // Initialize the listener + $listenerInstance->initListener(); + + // Get a decorator class + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_tcp_listener_class', array($listenerInstance)); + + // Add this listener to the pool + $this->getListenerPoolInstance()->addListener($decoratorInstance); + + // Get a decorator class + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance)); + + // Add this listener to the pool + $this->getListenerPoolInstance()->addListener($decoratorInstance); + + // Get an instance of the low-level listener + $listenerInstance = ObjectFactory::createObjectByConfiguredName('udp_listener_class', array($this)); + + // Setup address and port + $listenerInstance->setListenAddressByConfiguration('node_listen_addr'); + + /* + * All nodes can now use the same configuration entry because it can be + * customized in config-local.php. + */ + $listenerInstance->setListenPortByConfiguration('node_udp_listen_port'); + + // Initialize the listener + $listenerInstance->initListener(); + + // Get a decorator class + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_udp_listener_class', array($listenerInstance)); + + // Add this listener to the pool + $this->getListenerPoolInstance()->addListener($decoratorInstance); + + // Get a decorator class + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance)); + + // Add this listener to the pool + $this->getListenerPoolInstance()->addListener($decoratorInstance); + + // Debug output + $this->debugOutput('HUB: Initialize listener: FINISHED.'); + } + + /** + * Restores a previously stored node list from database + * + * @return void + */ + public function bootstrapRestoreNodeList () { + // Debug output + $this->debugOutput('HUB: Restore node list: START'); + + // Get a wrapper instance + $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class'); + + // Now get a search criteria instance + $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class'); + + // Search for the node number zero which is hard-coded the default + // @TODO Add some criteria, e.g. if the node is active or so + //$searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_NR, 1); + //$searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode')); + //$searchInstance->setLimit(1); + + // Get a result back + $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance); + + // Is it valid? + if ($resultInstance->next()) { + $this->partialStub('Do something for restoring the list.'); + // Output message + //$this->debugOutput('HUB: '); + } else { + // No previously saved node list found! + $this->debugOutput('HUB: No previously saved node list found. This is fine.'); + } + + // Debug output + $this->debugOutput('HUB: Restore node list: FINISHED.'); + } + + /** + * Getter for isActive attribute + * + * @return $isActive Whether the hub is active + */ + public final function getIsActive () { + return $this->isActive; + } + + /** + * Enables (default) or disables isActive flag + * + * @param $isActive Whether the hub is active + * @return void + */ + public final function enableIsActive ($isActive = true) { + $this->isActive = (bool) $isActive; + } + + /** + * "Getter for address:port combination + * + * @param $handlerInstance A valid Networkable instance + * @return $addressPort A address:port combination for this node + */ + public final function getAddressPort (Networkable $handlerInstance) { + // Construct config entry + $configEntry = 'node_' . $handlerInstance->getHandlerName() . '_listen_port'; - // Initialize the TCP listener - $tcpListenerInstance = ObjectFactory::createObjectByConfiguredName('tcp_listener_class', array($this)); + // Get IP and port + $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry($configEntry); - // Initialize the UDP listener - $udpListenerInstance = ObjectFactory::createObjectByConfiguredName('udp_listener_class', array($this)); + // Return it + return $addressPort; } }