X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=8a091325e91c7ab85a4ef569f78462620f3d1279;hb=f8fb89d6b4f9b4bfbd5498f784043542ea23ec88;hp=f27af3018a6feac0903708cd8be4a509ee6f29f4;hpb=3702d6e3f543a30966f23ef978dfdb9a5cbdebbe;p=hub.git diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index f27af3018..8a091325e 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, 2010 Hub Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -22,6 +22,14 @@ * along with this program. If not, see . */ class BaseHubNode extends BaseHubSystem implements Updateable { + /** + * Node types + */ + 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; @@ -33,28 +41,28 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /** * Query connector instance */ - private $connectorInstance = null; + private $queryConnectorInstance = NULL; /** - * Listener pool instance + * Queue connector instance */ - private $listenerPoolInstance = null; + private $queueConnectorInstance = NULL; /** - * Wether this node is anncounced (KEEP ON false!) + * Whether this node is anncounced (KEEP ON false!) * @deprecated */ private $hubIsAnnounced = false; /** - * State instance + * Whether this hub is active (default: false) */ - private $stateInstance = null; + private $isActive = false; /** - * Wether this hub is active + * Whether this node accepts announcements (default: false) */ - private $isActive = false; + private $acceptAnnouncements = false; /** * Protected constructor @@ -76,106 +84,49 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ private function initState() { - // Get the state factory and create the initial state, we don't need - // the state instance here - StateFactory::createStateInstanceByName('init', $this); - } - - /** - * Setter for node id - * - * @param $nodeId Our new node id - * @return void - */ - private final function setNodeId ($nodeId) { - // Set it config now - $this->getConfigInstance()->setConfigEntry('node_id', (string) $nodeId); + /* + * Get the state factory and create the initial state, we don't need + * the state instance here + */ + NodeStateFactory::createNodeStateInstanceByName('init', $this); } /** - * Getter for node id - * - * @return $nodeId Current node id - */ - private final function getNodeId () { - // Get it from config - return $this->getConfigInstance()->getConfigEntry('node_id'); - } - - /** - * Setter for listener pool instance - * - * @param $listenerPoolInstance Our new listener pool instance - * @return void - */ - private final function setListenerPoolInstance (PoolableListener $listenerPoolInstance) { - $this->listenerPoolInstance = $listenerPoolInstance; - } - - /** - * Getter for listener pool instance - * - * @return $listenerPoolInstance Our current listener pool instance - */ - public final function getListenerPoolInstance () { - return $this->listenerPoolInstance; - } - - /** - * Setter for state instance - * - * @param $stateInstance Node's current state instance - * @return void - */ - public final function setStateInstance (Stateable $stateInstance) { - $this->stateInstance = $stateInstance; - } - - /** - * Getter for state instance - * - * @return $stateInstance Node's current state instance - */ - public final function getStateInstance () { - return $this->stateInstance; - } - - /** - * Setter for session id + * Setter for query instance * - * @param $sessionId Our new session id + * @param $connectorInstance Our new query instance * @return void */ - private final function setSessionId ($sessionId) { - $this->getConfigInstance()->setConfigEntry('session_id', (string) $sessionId); + private final function setQueryConnectorInstance (Connectable $connectorInstance) { + $this->queryConnectorInstance = $connectorInstance; } /** - * Getter for session id + * Getter for query instance * - * @return $sessionId Current session id + * @return $connectorInstance Our new query instance */ - public final function getSessionId () { - return $this->getConfigInstance()->getConfigEntry('session_id'); + public final function getQueryConnectorInstance () { + return $this->queryConnectorInstance; } /** - * Setter for query instance + * Setter for queue instance * - * @param $connectorInstance Our new query instance + * @param $connectorInstance Our new queue instance * @return void */ - private final function setQueryConnectorInstance (Connectable $connectorInstance) { - $this->connectorInstance = $connectorInstance; + private final function setQueueConnectorInstance (Connectable $connectorInstance) { + $this->queueConnectorInstance = $connectorInstance; } /** - * Getter for query instance + * Getter for queue instance * - * @return $connectorInstance Our new query instance + * @return $connectorInstance Our new queue instance */ - public final function getQueryConnectorInstance () { - return $this->connectorInstance; + public final function getQueueConnectorInstance () { + return $this->queueConnectorInstance; } /** @@ -188,37 +139,17 @@ class BaseHubNode extends BaseHubSystem implements Updateable { } /** - * "Getter" for a printable state name - */ - public final function getPrintableState () { - // Default is 'null' - $stateName = 'null'; - - // Get the state instance - $stateInstance = $this->getStateInstance(); - - // Is it an instance of Stateable? - if ($stateInstance instanceof Stateable) { - // Then use that state name - $stateName = $stateInstance->getStateName(); - } // END - if - - // Return result - return $stateName; - } - - /** - * Checks wether the given IP address matches one of the bootstrapping nodes + * 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()->getConfigEntry('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); @@ -237,7 +168,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { break; } 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 @@ -268,7 +199,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Output all lines $this->debugOutput(' '); $this->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active'); - $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009, 2010 Hub Developer Team'); + $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 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'); @@ -285,7 +216,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @param $responseInstance A Responseable class * @return void */ - public function bootstrapAcquireHubId (Requestable $requestInstance, Responseable $responseInstance) { + public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) { // Get a wrapper instance $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); @@ -320,7 +251,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // 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 @@ -377,6 +308,12 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // 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'); } @@ -458,29 +395,29 @@ class BaseHubNode extends BaseHubSystem implements Updateable { throw new HubAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED); } // END - if + // Set some dummy configuration entries, e.g. node_status + $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName()); + // Debug output - $this->debugOutput('HUB: Self Announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); + $this->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); // Get a helper instance - $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this)); + $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class'); // Load the announcement descriptor - $helperInstance->loadAnnouncementDescriptor(); - - // Set some dummy configuration entries, e.g. node_status - $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName()); + $helperInstance->loadDescriptorXml(); // Compile all variables $helperInstance->getTemplateInstance()->compileConfigInVariables(); // "Publish" the descriptor by sending it to the bootstrap/list nodes - $helperInstance->publishAnnouncementDescriptor(); + $helperInstance->sendPackage($this); // Change the state, this should be the last line except debug output $this->getStateInstance()->nodeAnnouncedToUpperHubs(); // Debug output - $this->debugOutput('HUB: Self Announcement: FINISHED'); + $this->debugOutput('HUB-Announcement: FINISHED'); } /** @@ -498,8 +435,14 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Get a helper instance $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_self_connect_helper_class', array($this)); + // Load the descriptor (XML) file + $helperInstance->loadDescriptorXml(); + + // Compile all variables + $helperInstance->getTemplateInstance()->compileConfigInVariables(); + // And send the package away - $helperInstance->doSelfConnect(); + $helperInstance->sendPackage($this); // Debug output $this->debugOutput('HUB: Self Connection: FINISHED'); @@ -513,10 +456,10 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @param $responseInstance A Responseable class * @return void */ - public function activateHub (Requestable $requestInstance, Responseable $responseInstance) { - // Checks wether a listener is still active and shuts it down if one + 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())) { + if (($this->determineIfListenerIsActive()) && ($this->isNodeActive()())) { // Shutdown them down before they can hurt anything $this->shutdownListenerPool(); } // END - if @@ -550,6 +493,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // 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 @@ -562,7 +510,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get a decorator class - $decoratorInstance = ObjectFactory::createObjectByConfiguredName('peer_tcp_listener_class', array($listenerInstance)); + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool $this->getListenerPoolInstance()->addListener($decoratorInstance); @@ -572,6 +520,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // 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 @@ -584,7 +537,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get a decorator class - $decoratorInstance = ObjectFactory::createObjectByConfiguredName('peer_udp_listener_class', array($listenerInstance)); + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance)); // Add this listener to the pool $this->getListenerPoolInstance()->addListener($decoratorInstance); @@ -634,21 +587,62 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /** * Getter for isActive attribute * - * @return $isActive Wether the hub is active + * @return $isActive Whether the hub is active */ - public final function getIsActive () { + public final function isNodeActive() () { return $this->isActive; } /** * Enables (default) or disables isActive flag * - * @param $isActive Wether the hub is active + * @param $isActive Whether the hub is active * @return void */ public final function enableIsActive ($isActive = true) { $this->isActive = (bool) $isActive; } + + /** + * Checks whether this node accepts announcements + * + * @return $acceptsAnnouncements Whether this node accepts announcements + */ + public final function isAcceptingAnnouncements () { + // Check it (this node must be active and not shutdown!) + $acceptsAnnouncements = (($this->acceptsAnnouncements === true) && ($this->isNodeActive()()); + + // Return it + return $acceptsAnnouncements; + } + + /** + * Enables whether this node accepts announcements + * + * @param $acceptsAnnouncements Whether this node accepts announcements (default: true) + * @return void + */ + protected final function enableAcceptingAnnouncements ($acceptsAnnouncements = true) { + $this->acceptAnnouncements = $acceptsAnnouncements; + } + + + /** + * "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'; + + // Get IP and port + $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry($configEntry); + + // Return it + return $addressPort; + } } // [EOF]