X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=f9d1cdf9c6425fe44b6d21b902650faf98457242;hb=f7e3ad3f9e2322a6a8837409038c151bec2094f5;hp=ecf088899c3c1d27999a025ed6154b29fe4c6e7b;hpb=101074ad123680dcafef4dfdd3c8a7af01868177;p=hub.git diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index ecf088899..f9d1cdf9c 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, 2010 Hub Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -22,15 +22,8 @@ * along with this program. If not, see . */ class BaseHubNode extends BaseHubSystem implements Updateable { - /** - * Node id - */ - private $nodeId = ''; - - /** - * Session id - */ - private $sessionId = ''; + // Exception constants + const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00; /** * IP/port number of bootstrapping node @@ -40,7 +33,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /** * Query connector instance */ - private $queryInstance = null; + private $connectorInstance = null; /** * Listener pool instance @@ -48,9 +41,15 @@ class BaseHubNode extends BaseHubSystem implements Updateable { private $listenerPoolInstance = null; /** - * Wether the hub is active (true/false) + * Wether this node is anncounced (KEEP ON false!) + * @deprecated + */ + private $hubIsAnnounced = false; + + /** + * State instance */ - private $hubIsActive = false; + private $stateInstance = null; /** * Protected constructor @@ -61,6 +60,20 @@ 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 + StateFactory::createStateInstanceByName('init', $this); } /** @@ -70,16 +83,56 @@ 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 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; } /** @@ -89,35 +142,64 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ private final function setSessionId ($sessionId) { - $this->sessionId = (string) $sessionId; + $this->getConfigInstance()->setConfigEntry('session_id', (string) $sessionId); } /** * Getter for session id * - * @return $sessionId Our new session id + * @return $sessionId Current session id */ - private final function getSessionId () { - return $this->sessionId; + public final function getSessionId () { + return $this->getConfigInstance()->getConfigEntry('session_id'); } /** * Setter for query instance * - * @param $queryInstance Our new query instance + * @param $connectorInstance Our new query instance * @return void */ - private final function setQueryInstance (Queryable $queryInstance) { - $this->queryInstance = $queryInstance; + private final function setQueryConnectorInstance (Connectable $connectorInstance) { + $this->connectorInstance = $connectorInstance; } /** * Getter for query instance * - * @return $queryInstance Our new query instance + * @return $connectorInstance Our new query instance */ - protected final function getQueryInstance () { - return $this->queryInstance; + public final function getQueryConnectorInstance () { + return $this->connectorInstance; + } + + /** + * Getter for boot IP/port combination + * + * @return $bootIpPort The IP/port combination of the boot node + */ + protected final function getBootIpPort () { + return $this->bootIpPort; + } + + /** + * "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; } /** @@ -181,7 +263,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 Hub Developer Team'); + $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009, 2010 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'); @@ -194,9 +276,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 */ - public function bootstrapAcquireHubId () { + public function bootstrapAcquireHubId (Requestable $requestInstance, Responseable $responseInstance) { // Get a wrapper instance $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); @@ -268,15 +352,9 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Output message $this->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . ''); - } - /** - * Getter for boot IP/port combination - * - * @return $bootIpPort The IP/port combination of the boot node - */ - protected final function getBootIpPort () { - return $this->bootIpPort; + // Change the state because the node has auired a hub id + $this->getStateInstance()->nodeGeneratedSessionId(); } /** @@ -289,15 +367,15 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->debugOutput('BOOTSTRAP: Initialize queues: START'); // Set the query connector instance - $this->setQueryInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this))); + $this->setQueryConnectorInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this))); // Run a test query - $this->getQueryInstance()->doTestQuery(); + $this->getQueryConnectorInstance()->doTestQuery(); // Debug message $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED'); } - + /** * Adds hub data elements to a given dataset instance * @@ -312,6 +390,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 } /** @@ -352,21 +435,44 @@ 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. * - * @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 final function isHubActive () { - return $this->hubIsActive; - } + 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 - /** - * Setter for $hubIsActive attribute - * - * @param $hubIsActive Wether the hub is activer - */ - public final function enableHubIsActive ($hubIsActive = true) { - $this->hubIsActive = $hubIsActive; + // Debug output + $this->debugOutput('HUB: Self-announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); + + // Get a helper instance + $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this)); + + // Load the announcement descriptor + $helperInstance->loadAnnouncementDescriptor(); + + // 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->publishAnnouncementDescriptor(); + + // Change the state, this should be the last line except debug output + $this->getStateInstance()->nodeAnnouncedToUpperHubs(); + + // Debug output + $this->debugOutput('HUB: Self-announcement: FINISHED'); } /** @@ -379,8 +485,8 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ public function activateHub (Requestable $requestInstance, Responseable $responseInstance) { // Checks wether a listener is still active and shuts it down if one - // is still listening - if (($this->determineIfListenerIsActive()) && ($this->isHubActive())) { + // is still listening. + if (($this->determineIfListenerIsActive()) && ($this->determineIfHubIsActive())) { // Shutdown them down before they can hurt anything $this->shutdownListenerPool(); } // END - if @@ -389,11 +495,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $controllerInstance = Registry::getRegistry()->getInstance('controller'); // Run all filters for the hub activation - $controllerInstance->executeHubActivationFilters($requestInstance, $responseInstance); + $controllerInstance->executeActivationFilters($requestInstance, $responseInstance); // ----------------------- Last step from here ------------------------ // Activate the hub. This is ALWAYS the last step in this method - $this->enableHubIsActive(); + $this->getStateInstance()->nodeIsActivated(); // ---------------------- Last step until here ------------------------ } @@ -407,7 +513,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $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)); @@ -423,13 +529,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get a decorator class $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get an instance of the low-level listener $listenerInstance = ObjectFactory::createObjectByConfiguredName('udp_listener_class', array($this)); @@ -445,13 +551,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_udp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get a decorator class $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Debug output $this->debugOutput('HUB: Initialize listener: FINISHED.'); @@ -485,12 +591,29 @@ class BaseHubNode extends BaseHubSystem implements Updateable { if ($resultInstance->next()) { $this->partialStub('Do something for restoring the list.'); // Output message - //$this->debugOutput('BOOTSTRAP: '); - } // END - if + //$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.'); } + + /** + * Determines wether the hub is active by checking its current state + * + * @return $isActive Wether the hub is active + */ + public function determineIfHubIsActive () { + // Check the state + // @TODO Add more states e.g. 'firewalled', 'senior' + $isActive = ($this->getStateInstance() instanceof NodeActiveState); + + // Return value + return $isActive; + } } // [EOF]