X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=898f925d793f2a523ff881615c312cbf4ae86b28;hb=ecad51210a3cead4d1d70cf83f546a8e7cae9523;hp=58cdde153701ad7f9ecb5a54b1d8861214752e67;hpb=37e7eb9f12c84af31a73ffb34cdb7b77c8277161;p=hub.git diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index 58cdde153..898f925d7 100644 --- a/application/hub/main/nodes/class_BaseHubNode.php +++ b/application/hub/main/nodes/class_BaseHubNode.php @@ -21,7 +21,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class BaseHubNode extends BaseHubSystem implements Updateable { +class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria { /** * Node types */ @@ -33,6 +33,9 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Exception constants const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00; + // Other constants + const OBJECT_LIST_SEPARATOR = ','; + /** * IP/port number of bootstrapping node */ @@ -74,6 +77,18 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Call parent constructor parent::__construct($className); + // Get a wrapper instance + $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_info_db_wrapper_class'); + + // Set it here + $this->setWrapperInstance($wrapperInstance); + + // 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(); } @@ -91,6 +106,49 @@ class BaseHubNode extends BaseHubSystem implements Updateable { 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) + * + * @param $searchInstance An instance of a LocalSearchCriteria class + * @return void + */ + private function generatePrivateKeyAndHash (LocalSearchCriteria $searchInstance) { + // Generate a pseudo-random string + $randomString = $this->getCryptoInstance()->randomString(255); + + // Hash and encrypt the string so we become a node id (also documented as "hub id") + $this->setPrivateKey($this->getCryptoInstance()->encryptString($randomString)); + $this->setPrivateKeyHash($this->getCryptoInstance()->hashString($this->getPrivateKey())); + + // Register the node id with our wrapper + $this->getWrapperInstance()->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance); + + // Output message + self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . ''); + } + /** * Setter for query instance * @@ -162,20 +220,22 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $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; @@ -197,14 +257,14 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $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(' '); } /** @@ -217,48 +277,25 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) { - // Get a wrapper instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_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 - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1); - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::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()) { - // Save the result instance in this class - $this->setResultInstance($resultInstance); - + // Is there a node id? + if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) { // Get the node id from result and set it $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->getCryptoInstance()->randomString(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()); + $this->getWrapperInstance()->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() . ''); } } @@ -268,54 +305,64 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ public function bootstrapGenerateSessionId () { - // Get an RNG instance - $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); + // Now get a search criteria instance + $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class'); - // Generate a pseudo-random string - $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode'); + // Search for the node number one which is hard-coded the default + $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR , 1); + $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_MODE, $this->getRequestInstance()->getRequestElement('mode')); + $searchInstance->setLimit(1); - // Get a crypto instance - $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class'); + // Remember it for later usage + $this->setSearchInstance($searchInstance); - // Hash and encrypt the string so we become a "node id" aka Hub-Id - $this->setSessionId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString))); + // Get a random string + $randomString = $this->generateRamdomString(255); - // Get a wrapper instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); + // Hash and encrypt the string so we become a "node id" aka Hub-Id + $this->setSessionId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString))); // Register the node id with our wrapper - $wrapperInstance->registerSessionId($this, $this->getRequestInstance()); + $this->getWrapperInstance()->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(); } /** - * Initializes queues which every node needs + * Generate a private key for en-/decryption * * @return void */ - protected function initGenericQueues () { - // 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(); + public function bootstrapGeneratePrivateKey () { + // Is it valid? + if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) { + // Is the element set? + if (is_null($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))) { + /* + * Auto-generate the private key for e.g. out-dated database + * "tables". This allows a smooth update for the underlaying + * database table. + */ + $this->generatePrivateKeyAndHash($this->getSearchInstance()); + } else { + // Get the node id from result and set it + $this->setPrivateKey(base64_decode($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))); + $this->setPrivateKeyHash($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH)); - // Debug message - $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED'); + // Output message + self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found private key hash: ' . $this->getPrivateKeyHash() . ''); + } + } else { + /* + * Generate it in a private method (no confusion with 'private + * method access' and 'private key' here! ;-)). + */ + $this->generatePrivateKeyAndHash($this->getSearchInstance()); + } } /** @@ -325,10 +372,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @param $requestInstance An instance of a Requestable class * @return void */ - public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance) { + public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) { + // Make sure request instance is set as it is not optional + assert($requestInstance instanceof Requestable); + // Add node number and type - $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1); - $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $requestInstance->getRequestElement('mode')); + $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR , 1); + $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_MODE, $requestInstance->getRequestElement('mode')); // Add the node id $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId()); @@ -337,6 +387,12 @@ class BaseHubNode extends BaseHubSystem implements Updateable { if ($this->getSessionId() != '') { $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId()); } // END - if + + // Add the private key if acquired + if ($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 } /** @@ -385,27 +441,24 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * * @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) { + public function announceToUpperNodes (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 - // Set some dummy configuration entries, e.g. node_status - $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName()); - // 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'); + $helperInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_helper_class'); // Load the announcement descriptor - $helperInstance->loadDescriptorXml(); + $helperInstance->loadDescriptorXml($this); // Compile all variables $helperInstance->getTemplateInstance()->compileConfigInVariables(); @@ -417,7 +470,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->getStateInstance()->nodeAnnouncedToUpperHubs(); // Debug output - $this->debugOutput('HUB-Announcement: FINISHED'); + self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: FINISHED'); } /** @@ -430,13 +483,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ 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)); + $helperInstance = ObjectFactory::createObjectByConfiguredName('node_self_connect_helper_class', array($this)); // Load the descriptor (XML) file - $helperInstance->loadDescriptorXml(); + $helperInstance->loadDescriptorXml($this); // Compile all variables $helperInstance->getTemplateInstance()->compileConfigInVariables(); @@ -445,7 +498,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $helperInstance->sendPackage($this); // Debug output - $this->debugOutput('HUB: Self Connection: FINISHED'); + self::createDebugInstance(__CLASS__)->debugOutput('HUB: Self Connection: FINISHED'); } /** @@ -483,7 +536,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ 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))); @@ -498,13 +551,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * All nodes can now use the same configuration entry because it can be * customized in config-local.php. */ - $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port'); + $listenerInstance->setListenPortByConfiguration('node_listen_port'); // Initialize the listener $listenerInstance->initListener(); // Get a decorator class - $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_tcp_listener_class', array($listenerInstance)); + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool $this->getListenerPoolInstance()->addListener($decoratorInstance); @@ -525,13 +578,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * All nodes can now use the same configuration entry because it can be * customized in config-local.php. */ - $listenerInstance->setListenPortByConfiguration('node_udp_listen_port'); + $listenerInstance->setListenPortByConfiguration('node_listen_port'); // Initialize the listener $listenerInstance->initListener(); // Get a decorator class - $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_udp_listener_class', array($listenerInstance)); + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_udp_listener_class', array($listenerInstance)); // Add this listener to the pool $this->getListenerPoolInstance()->addListener($decoratorInstance); @@ -543,45 +596,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $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.'); + self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: FINISHED.'); } /** @@ -616,6 +631,46 @@ class BaseHubNode extends BaseHubSystem implements Updateable { return $acceptAnnouncements; } + /** + * 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 * @@ -625,24 +680,98 @@ class BaseHubNode extends BaseHubSystem implements Updateable { protected final function enableAcceptingAnnouncements ($acceptAnnouncements = true) { $this->acceptAnnouncements = $acceptAnnouncements; } - - + /** - * "Getter for address:port combination + * Checks wether this node is accepting node-list requests * - * @param $handlerInstance A valid Networkable instance - * @return $addressPort A address:port combination for this node + * @return $acceptsRequest Wether this node accepts node-list requests */ - public final function getAddressPort (Networkable $handlerInstance) { - // Construct config entry - $configEntry = 'node_' . $handlerInstance->getHandlerName() . '_listen_port'; + 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 + * + * @return $addressPort A address:port combination for this node + */ + public final function getAddressPort () { // Get IP and port - $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry($configEntry); + $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry('node_listen_port'); // Return it return $addressPort; } + + /** + * "Getter" for address:port array + * + * @return $addressPortArray An array of a address:port combination for this node + */ + public final function getAddressPortArray () { + // Get IP and port + $addressPortArray = explode(':', $this->getAddressPort()); + + // Return it + return $addressPortArray; + } + + /** + * Updates/refreshes node data (e.g. status). + * + * @return void + * @todo Find more to do here + */ + public function updateNodeData () { + // Set some dummy configuration entries, e.g. node_status + $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName()); + } + + /** + * Handles message answer by given 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, Receivable $packageInstance) { + // Is it not empty? + assert(!empty($messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS])); + + // Construct configuration entry for handling class' name + $classConfigEntry = strtolower($messageData[NetworkPackage::MESSAGE_ARRAY_TYPE] . '_status_' . $messageData[BaseXmlAnswerTemplateEngine::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; + } } // [EOF]