*/
private $nodeId = '';
+ /**
+ * Session id
+ */
+ private $sessionId = '';
+
/**
* IP/port number of bootstrapping node
*/
/**
* Query connector instance
*/
- private $queryInstance = null;
+ private $connectorInstance = null;
/**
* Listener pool instance
return $this->nodeId;
}
+ /**
+ * 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 session id
+ *
+ * @param $sessionId Our new session id
+ * @return void
+ */
+ private final function setSessionId ($sessionId) {
+ $this->sessionId = (string) $sessionId;
+ }
+
+ /**
+ * Getter for session id
+ *
+ * @return $sessionId Our new session id
+ */
+ public final function getSessionId () {
+ return $this->sessionId;
+ }
+
+ /**
+ * Setter for query instance
+ *
+ * @param $connectorInstance Our new query instance
+ * @return void
+ */
+ private final function setQueryConnectorInstance (Connectable $connectorInstance) {
+ $this->connectorInstance = $connectorInstance;
+ }
+
+ /**
+ * Getter for query instance
+ *
+ * @return $connectorInstance Our new query instance
+ */
+ 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;
+ }
+
/**
* Checks wether the given IP address matches one of the bootstrapping nodes
*
$isFound = false;
// Run through all configured IPs
- foreach (explode(',', $this->getConfigInstance()->readConfig('hub_bootstrap_nodes')) as $ipPort) {
+ foreach (explode(',', $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
// Split it up in IP/port
$ipPortArray = explode(':', $ipPort);
$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!
$isFound = true;
$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;
$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 bootstrapGenericBootstrapping () {
- // --------------------- 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 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(' ');
}
/**
*
* @return void
*/
- private function bootstrapAcquireHubId () {
+ public function bootstrapAcquireHubId () {
// Get a wrapper instance
$wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
$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');
$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() . '');
}
}
/**
- * Getter for boot IP/port combination
+ * Generates a session id which will be sent to the other hubs and clients
*
- * @return $bootIpPort The IP/port combination of the boot node
+ * @return void
*/
- protected final function getBootIpPort () {
- return $this->bootIpPort;
+ 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() . '');
}
/**
* @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();
+
+ // Debug message
+ $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED');
}
-
+
+ /**
+ * Publish our hub descriptor to the upper hub(s)
+ *
+ * @return void
+ * @todo This should be implemented in a generic way to keep things easy.
+ */
+ protected function publishHubDescriptor () {
+ $this->partialStub('Unfinished method.');
+ }
+
/**
* Adds hub data elements to a given dataset instance
*
// 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
}
/**
return $this->hubIsActive;
}
+ /**
+ * Setter for $hubIsActive attribute
+ *
+ * @param $hubIsActive Wether the hub is activer
+ */
+ public final function enableHubIsActive ($hubIsActive = true) {
+ $this->hubIsActive = $hubIsActive;
+ }
+
/**
* 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 () {
+ 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->checkIfListenerIsActive()) && ($this->isHubActive())) {
+ if (($this->determineIfListenerIsActive()) && ($this->isHubActive())) {
// 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->enableHubIsActive();
// ---------------------- Last step until here ------------------------
}
*
* @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)));
- // Initialize both listeners
- foreach (array('tcp', 'udp') as $protocol) {
- // Get an instance
- $listenerInstance = ObjectFactory::createObjectByConfiguredName($protocol . '_listener_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');
- $listenerInstance->setListenPortByConfiguration('node_' . $protocol . '_listen_port');
+ // Setup address and port
+ $listenerInstance->setListenAddressByConfiguration('node_listen_addr');
+ $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port');
- // Initialize the listener
- $listenerInstance->initListener();
+ // Initialize the listener
+ $listenerInstance->initListener();
- // Add this listener to the pool
- $this->listenerPoolInstance->addListener($listenerInstance);
- } // END - foreach
+ // 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');
+ $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.');
}
}
projects / hub.git / blobdiff