// Exception constants
const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00;
+ // Other constants
+ const OBJECT_LIST_SEPARATOR = ',';
+
/**
* IP/port number of bootstrapping node
*/
// Call parent constructor
parent::__construct($className);
+ // Get a crypto instance
+ $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
+
+ // Set it here
+ $this->setCryptoInstance($cryptoInstance);
+
// Init state which sets the state to 'init'
$this->initState();
}
NodeStateFactory::createNodeStateInstanceByName('init', $this);
}
+ /**
+ * Generates a random string from various data inluding UUID if PECL
+ * extension uuid is installed.
+ *
+ * @param $length Length of the random part
+ * @return $randomString Random string
+ * @todo Make this code more generic and move it to CryptoHelper or
+ */
+ protected function generateRamdomString ($length) {
+ // Get an RNG instance
+ $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
+
+ // Generate a pseudo-random string
+ $randomString = $rngInstance->randomString($length) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
+
+ // Add UUID for even more entropy for the hasher
+ $randomString .= $this->getCryptoInstance()->createUuid();
+
+ // Return it
+ return $randomString;
+ }
+
/**
* Generates a private key and hashes it (for speeding up things)
*
* @return void
*/
private function generatePrivateKeyAndHash (LocalSearchCriteria $searchInstance) {
- // Get an RNG instance (Random Number Generator)
- $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');
+ $randomString = $this->generateRandomString(255);
// Hash and encrypt the string so we become a node id (also documented as "hub id")
- $this->setPrivateKey($cryptoInstance->encryptString($randomString));
- $this->setPrivateKeyHash($cryptoInstance->hashString($this->getPrivateKey()));
+ $this->setPrivateKey($this->getCryptoInstance()->encryptString($randomString));
+ $this->setPrivateKeyHash($this->getCryptoInstance()->hashString($this->getPrivateKey()));
// Get a wrapper instance
$wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
$wrapperInstance->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance);
// Output message
- $this->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . '');
}
/**
$this->bootIpPort = $ipPort;
// Output message
- $this->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
// Stop further searching
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 really listen on that address
+ /*
+ * IP matches listen address. At this point we really don't care
+ * if we can really listen on that address
+ */
$isFound = true;
// Remember the port number
$this->bootIpPort = $ipPort;
// Output message
- $this->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
// Stop further searching
break;
$app = $this->getApplicationInstance();
// 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 - 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');
- $this->debugOutput('conditions; see docs/COPYING for details.');
- $this->debugOutput(' ');
+ self::createDebugInstance(__CLASS__)->debugOutput(' ');
+ self::createDebugInstance(__CLASS__)->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
+ self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Hub Developer Team');
+ self::createDebugInstance(__CLASS__)->debugOutput(' ');
+ self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
+ self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
+ self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
+ self::createDebugInstance(__CLASS__)->debugOutput(' ');
}
/**
$this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID));
// Output message
- $this->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . '');
+ self::createDebugInstance(__CLASS__)->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->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
-
- // Get a crypto instance
- $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
+ $randomString = $this->generateRandomString(255);
// Hash and encrypt the string so we become a node id (also documented as "hub id")
- $this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
+ $this->setNodeId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
// Register the node id with our wrapper
$wrapperInstance->registerNodeId($this, $this->getRequestInstance());
// Output message
- $this->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . '');
}
}
$searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode'));
$searchInstance->setLimit(1);
- // 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');
+ // Get a random string
+ $randomString = $this->generateRamdomString(255);
// Hash and encrypt the string so we become a "node id" aka Hub-Id
- $this->setSessionId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
+ $this->setSessionId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
// Get a wrapper instance
$wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
$wrapperInstance->registerSessionId($this, $this->getRequestInstance(), $searchInstance);
// Output message
- $this->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
// Change the state because the node has auired a hub id
$this->getStateInstance()->nodeGeneratedSessionId();
$this->generatePrivateKeyAndHash($searchInstance);
} else {
// Get the node id from result and set it
- $this->setPrivateKey($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY));
+ $this->setPrivateKey(base64_decode($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY)));
$this->setPrivateKeyHash($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH));
// Output message
- $this->debugOutput('BOOTSTRAP: Re-using found private key hash: ' . $this->getPrivateKeyHash() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found private key hash: ' . $this->getPrivateKeyHash() . '');
}
} else {
/*
*/
protected function initGenericQueues () {
// Debug message
- $this->debugOutput('BOOTSTRAP: Initialize queues: START');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Initialize queues: START');
// Set the query connector instance
$this->setQueryConnectorInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this)));
$this->getQueueConnectorInstance()->doTestQueue();
// Debug message
- $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Initialize queues: FINISHED');
}
/**
// Add the private key if acquired
if ($this->getPrivateKey() != '') {
- $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY, $this->getPrivateKey());
+ $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY, base64_encode($this->getPrivateKey()));
$criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH, $this->getPrivateKeyHash());
} // END - if
}
*
* @param $taskInstance The task instance running this announcement
* @return void
- * @throws HubAlreadyAnnouncedException If this hub is already announced
+ * @throws NodeAlreadyAnnouncedException 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);
+ throw new NodeAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED);
} // END - if
// Debug output
- $this->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
// Get a helper instance
$helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class');
// Load the announcement descriptor
- $helperInstance->loadDescriptorXml();
+ $helperInstance->loadDescriptorXml($this);
// Compile all variables
$helperInstance->getTemplateInstance()->compileConfigInVariables();
$this->getStateInstance()->nodeAnnouncedToUpperHubs();
// Debug output
- $this->debugOutput('HUB-Announcement: FINISHED');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: FINISHED');
}
/**
*/
public function doSelfConnection (Taskable $taskInstance) {
// Debug output
- $this->debugOutput('HUB: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
+ self::createDebugInstance(__CLASS__)->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();
+ $helperInstance->loadDescriptorXml($this);
// Compile all variables
$helperInstance->getTemplateInstance()->compileConfigInVariables();
$helperInstance->sendPackage($this);
// Debug output
- $this->debugOutput('HUB: Self Connection: FINISHED');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB: Self Connection: FINISHED');
}
/**
*/
public function initializeListenerPool () {
// Debug output
- $this->debugOutput('HUB: Initialize listener: START');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: START');
// Get a new pool instance
$this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)));
$this->getListenerPoolInstance()->addListener($decoratorInstance);
// Debug output
- $this->debugOutput('HUB: Initialize listener: FINISHED.');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: FINISHED.');
}
/**
*/
public function bootstrapRestoreNodeList () {
// Debug output
- $this->debugOutput('HUB: Restore node list: START');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB: Restore node list: START');
// Get a wrapper instance
$wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
if ($resultInstance->next()) {
$this->partialStub('Do something for restoring the list.');
// Output message
- //$this->debugOutput('HUB: ');
+ //self::createDebugInstance(__CLASS__)->debugOutput('HUB: ');
} else {
// No previously saved node list found!
- $this->debugOutput('HUB: No previously saved node list found. This is fine.');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB: No previously saved node list found. This is fine.');
}
// Debug output
- $this->debugOutput('HUB: Restore node list: FINISHED.');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB: Restore node list: FINISHED.');
}
/**
* Checks whether this node has attempted to announce itself
*
* @return $hasAnnounced Whether this node has attempted to announce itself
+ * @todo Add checking if this node has been announced to the sender node
*/
public function ifNodeHasAnnounced () {
+ // Debug message
+ /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnounced(): state=' . $this->getStateInstance()->getStateName());
+
// Simply check the state of this node
$hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncedState);
+ // Debug message
+ /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced));
+
// Return it
return $hasAnnounced;
}
+ /**
+ * Checks whether this node has attempted to announce itself and completed it
+ *
+ * @return $hasAnnouncementCompleted Whether this node has attempted to announce itself and completed it
+ * @todo Add checking if this node has been announced to the sender node
+ */
+ public function ifNodeHasAnnouncementCompleted () {
+ // Debug message
+ /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
+
+ // Simply check the state of this node
+ $hasAnnouncementCompleted = ($this->getStateInstance() instanceof NodeAnnouncementCompletedState);
+
+ // Debug message
+ /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
+
+ // Return it
+ return $hasAnnouncementCompleted;
+ }
+
/**
* Enables whether this node accepts announcements
*
protected final function enableAcceptingAnnouncements ($acceptAnnouncements = true) {
$this->acceptAnnouncements = $acceptAnnouncements;
}
-
-
+
+ /**
+ * Checks wether this node is accepting node-list requests
+ *
+ * @return $acceptsRequest Wether this node accepts node-list requests
+ */
+ public function isAcceptingNodeListRequests () {
+ /*
+ * Only 'regular' nodes does not accept such requests, checking
+ * HubRegularNode is faster, but if e.g. HubRegularI2PNode will be
+ * added then the next check will be true.
+ */
+ $acceptsRequest = ((!$this instanceof HubRegularNode) && ($this->getRequestInstance()->getRequestElement('mode') != self::NODE_TYPE_REGULAR));
+
+ // Return it
+ return $acceptsRequest;
+ }
+
/**
- * "Getter for address:port combination
+ * "Getter" for address:port combination
*
- * @param $handlerInstance A valid Networkable instance
+ * @param $handlerInstance An instance of a Networkable class
* @return $addressPort A address:port combination for this node
*/
public final function getAddressPort (Networkable $handlerInstance) {
}
/**
- * Updates/refreshes node data (e.g. state).
+ * Updates/refreshes node data (e.g. status).
*
* @return void
* @todo Find more to do here
/**
* Handles message answer by given data array
*
- * @param $messageData A valid answer message data array
+ * @param $messageData A valid answer message data array
+ * @param $packageInstance An instance of a Receivable class
* @return void
+ * @todo Handle thrown exception
*/
- public function handleAnswerStatusByMessageData (array $messageData) {
- die('messageData=' . print_r($messageData, true));
+ public function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance) {
+ // Is it not empty?
+ assert(!empty($messageData[NetworkPackage::MESSAGE_DATA_ANSWER_STATUS]));
+
+ // Construct configuration entry for handling class' name
+ $classConfigEntry = strtolower($messageData[NetworkPackage::MESSAGE_ARRAY_TYPE] . '_status_' . $messageData[NetworkPackage::MESSAGE_DATA_ANSWER_STATUS]) . '_handler_class';
+
+ // Try to get a class
+ $handlerInstance = ObjectFactory::createObjectByConfiguredName($classConfigEntry);
+
+ // Handle it there
+ $handlerInstance->handleAnswerMessageData($messageData, $packageInstance);
+ }
+
+ /**
+ * "Getter" for an array of all accepted object types
+ *
+ * @return $objectList Array of all accepted object types
+ */
+ public function getListFromAcceptedObjectTypes () {
+ // Get registry instance
+ $objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
+
+ // Get all entries
+ $objectList = $objectRegistryInstance->getEntries(XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_NAME);
+
+ // ... and return it
+ return $objectList;
}
}
projects / hub.git / blobdiff