3 * A NodeMessageDhtBootstrap handler
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class NodeMessageDhtBootstrapHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_dht_bootstrap');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP,
40 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_IP,
41 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS,
42 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_MODE,
43 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID,
44 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_LISTEN_PORT,
47 // Init message-data->configuration translation array
48 $this->messageToConfig = array(
49 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP => 'your_external_ip',
50 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_IP => 'your_internal_ip',
51 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID => 'your_session_id'
54 // Init config-copy array
55 $this->configCopy = array(
56 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP => 'external_ip',
57 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_IP => 'internal_ip',
58 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS => 'node_status',
59 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID => 'session_id',
60 XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_LISTEN_PORT => 'node_listen_port',
64 $this->searchData = array(
65 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_IP,
66 XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_LISTEN_PORT
71 * Creates an instance of this class
73 * @return $handlerInstance An instance of a HandleableMessage class
75 public final static function createNodeMessageDhtBootstrapHandler () {
77 $handlerInstance = new NodeMessageDhtBootstrapHandler();
80 $nodeInstance = NodeObjectFactory::createNodeInstance();
82 // ... and set it here
83 $handlerInstance->setNodeInstance($nodeInstance);
86 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
88 // Set the DHT instance here
89 $handlerInstance->setDhtInstance($dhtInstance);
91 // Return the prepared instance
92 return $handlerInstance;
96 * Handles data array of the message
98 * @param $messageData An array with message data to handle
99 * @param $packageInstance An instance of a Receivable class
101 * @throws DhtBootstrapNotAcceptedException If this node does not accept DHT bootstrap requests
103 public function handleMessageData (array $messageData, Receivable $packageInstance) {
104 // Is this node accepting DHT bootstrap requests?
105 if (!$this->getNodeInstance()->isAcceptingDhtBootstrap()) {
107 * This node is not accepting DHT bootstrap requests.
109 throw new DhtBootstrapNotAcceptedException(array($this, $messageData), self::EXCEPTION_DHT_BOOTSTRAP_NOT_ACCEPTED);
112 // Register the DHT bootstrap requesting node with this node
113 $this->registerNodeByMessageData($messageData);
115 // Prepare answer message to be delivered back to the other node
116 $this->prepareAnswerMessage($messageData, $packageInstance);
120 * Adds all required elements from given array into data set instance
122 * @param $dataSetInstance An instance of a StoreableCriteria class
123 * @param $messageData An array with all message data
126 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
128 parent::addArrayToDataSet($dataSetInstance, $messageData);
131 foreach ($this->messageDataElements as $key) {
133 assert(isset($messageData[$key]));
136 $dataSetInstance->addCriteria($key, $messageData[$key]);
141 * Initializes configuration data from given message data array
143 * @param $messageData An array with all message data
146 protected function initMessageConfigurationData (array $messageData) {
148 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-BOOTSTRAP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
150 // "Walk" throught the translation array
151 foreach ($this->messageToConfig as $messageKey => $configKey) {
153 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-BOOTSTRAP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Setting messageKey=' . $messageKey . ',configKey=' . $configKey . ':' . $messageData[$messageKey]);
155 // Set the element in configuration
156 $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
159 // "Walk" throught the config-copy array
160 foreach ($this->configCopy as $targetKey => $sourceKey) {
162 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-BOOTSTRAP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
164 // Copy from source to target key
165 $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
168 // Translate last exception into a status code
169 $statusCode = $this->getTranslatedStatusFromLastException();
171 // Set it in configuration (temporarily)
172 $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $statusCode);
175 * Use the DHT instance to get a list of recipients. This means that all
176 * DHT nodes that accept bootstrap requests are read from the DHT
179 $nodeList = $this->getDhtInstance()->findRecipientsByKey(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ACCEPT_BOOTSTRAP, 'Y');
181 // Make sure it is an array and has at least one entry
182 assert(is_array($nodeList));
183 assert(count($nodeList) > 0);
185 // Set it in configuration
186 $this->getConfigInstance()->setConfigEntry('dht_nodes', base64_encode(serialize($nodeList)));
190 * Removes configuration data with given message data array from global
193 * @param $messageData An array with all message data
196 protected function removeMessageConfigurationData (array $messageData) {
197 // "Walk" throught the translation array again
198 foreach ($this->messageToConfig as $dummy => $configKey) {
199 // Now unset this configuration entry (to save some memory)
200 $this->getConfigInstance()->unsetConfigEntry($configKey);
203 // "Walk" throught the config-copy array again
204 foreach ($this->configCopy as $configKey => $dummy) {
205 // Now unset this configuration entry (to save some memory again)
206 $this->getConfigInstance()->unsetConfigEntry($configKey);
209 // Remove temporary "special" values as well
210 $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS);
211 $this->getConfigInstance()->unsetConfigEntry('dht_nodes');