From da835c389121ce63f0111eb7fa83729112915f84 Mon Sep 17 00:00:00 2001 From: Roland 'Quix0r' Haeder Date: Fri, 14 Mar 2014 22:44:49 +0100 Subject: [PATCH] Added missing answer message handler for DHT bootstrap requests. Signed-off-by: Roland 'Quix0r' Haeder --- application/hub/config.php | 6 + .../hub/main/helper/node/answer/dht/.htaccess | 1 + ...ss_NodeDhtBootstrapMessageAnswerHelper.php | 104 ++++++++++++++++++ 3 files changed, 111 insertions(+) create mode 100644 application/hub/main/helper/node/answer/dht/.htaccess create mode 100644 application/hub/main/helper/node/answer/dht/class_NodeDhtBootstrapMessageAnswerHelper.php diff --git a/application/hub/config.php b/application/hub/config.php index d1d5b9545..1122e4ca9 100644 --- a/application/hub/config.php +++ b/application/hub/config.php @@ -234,6 +234,9 @@ $cfg->setConfigEntry('node_answer_message_announcement_helper_class', 'NodeAnnou // CFG: NODE-ANSWER-MESSAGE-REQUEST-NODE-LIST-HELPER-CLASS $cfg->setConfigEntry('node_answer_message_request_node_list_helper_class', 'NodeRequestNodeListMessageAnswerHelper'); +// CFG: NODE-ANSWER-MESSAGE-ANNOUNCEMENT-HELPER-CLASS +$cfg->setConfigEntry('node_answer_message_dht_bootstrap_helper_class', 'NodeDhtBootstrapMessageAnswerHelper'); + // CFG: NODE-NEXT-ANNOUNCEMENT-ANSWER-OKAY-HELPER-CLASS $cfg->setConfigEntry('node_next_announcement_answer_okay_helper_class', 'NodeRequestNodeListHelper'); @@ -249,6 +252,9 @@ $cfg->setConfigEntry('node_dht_bootstrap_template_class', 'XmlDhtBootstrapTempla // CFG: NODE-ANNOUNCEMENT-ANSWER-TEMPLATE-CLASS $cfg->setConfigEntry('node_announcement_answer_template_class', 'XmlAnnouncementAnswerTemplateEngine'); +// CFG: NODE-DHT-BOOTSTRAP-ANSWER-TEMPLATE-CLASS +$cfg->setConfigEntry('node_dht_bootstrap_answer_template_class', 'XmlDhtBootstrapAnswerTemplateEngine'); + // CFG: NODE-REQUEST-NODE-LIST-TEMPLATE-CLASS $cfg->setConfigEntry('node_request_node_list_template_class', 'XmlRequestNodeListTemplateEngine'); diff --git a/application/hub/main/helper/node/answer/dht/.htaccess b/application/hub/main/helper/node/answer/dht/.htaccess new file mode 100644 index 000000000..3a4288278 --- /dev/null +++ b/application/hub/main/helper/node/answer/dht/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/hub/main/helper/node/answer/dht/class_NodeDhtBootstrapMessageAnswerHelper.php b/application/hub/main/helper/node/answer/dht/class_NodeDhtBootstrapMessageAnswerHelper.php new file mode 100644 index 000000000..eebebd4ca --- /dev/null +++ b/application/hub/main/helper/node/answer/dht/class_NodeDhtBootstrapMessageAnswerHelper.php @@ -0,0 +1,104 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * @todo Find an interface for hub helper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class NodeDhtBootstrapMessageAnswerHelper extends BaseHubAnswerHelper implements HelpableNode { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + + // Init package tags + $this->setPackageTags(array('dht_bootstrap_answer')); + } + + /** + * Creates the helper class + * + * @param $messageData An array with all message data + * @return $helperInstance A prepared instance of this helper + */ + public final static function createNodeDhtBootstrapMessageAnswerHelper (array $messageData) { + // Get new instance + $helperInstance = new NodeDhtBootstrapMessageAnswerHelper(); + + // Set session id of other peer as recipient + $helperInstance->setRecipientType($messageData[XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID]); + + // Set message data + $helperInstance->setMessageData($messageData); + + // Return the prepared instance + return $helperInstance; + } + + /** + * Loads the descriptor XML file + * + * @param $nodeInstance An instance of a NodeHelper class + * @return void + */ + public function loadDescriptorXml (NodeHelper $nodeInstance) { + // Debug message + self::createDebugInstance(__CLASS__)->debugOutput('HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Attempting to answer a DHT bootstrap request...'); + + // Get a XML template instance + $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_dht_bootstrap_answer_template_class'); + + // Set it for later use + $this->setTemplateInstance($templateInstance); + + // Read the XML descriptor + $templateInstance->loadXmlTemplate(); + + // Render the XML content + $templateInstance->renderXmlContent(); + } + + /** + * Send out announcement answer package + * + * @param $nodeInstance An instance of a NodeHelper class + * @return void + */ + public function sendPackage (NodeHelper $nodeInstance) { + // Sanity check: Is the node in the approx. state? (active/reachable) + $nodeInstance->getStateInstance()->validateNodeStateIsActiveOrReachable(); + + // Compile the template, this inserts the loaded node data into the gaps. + $this->getTemplateInstance()->compileTemplate(); + + // Get a singleton network package instance + $packageInstance = NetworkPackageFactory::createNetworkPackageInstance(); + + // Next, feed the content in. The network package class is a pipe-through class. + $packageInstance->enqueueRawDataFromTemplate($this, NetworkPackage::PROTOCOL_TCP); + } +} + +// [EOF] +?> -- 2.39.5