application/hub/main/handler/message-types/dht/class_NodeMessageDhtBootstrapHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageDhtBootstrap handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class NodeMessageDhtBootstrapHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set handler name
  35                 $this->setHandlerName('message_dht_bootstrap');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS,
  40                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_ADDRESS,
  41                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS,
  42                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_MODE,
  43                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID,
  44                 );
  45
  46                 // Init message-data->configuration translation array
  47                 $this->messageToConfig = array(
  48                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS => 'your_external_address',
  49                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_ADDRESS => 'your_internal_address',
  50                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID       => 'your_session_id'
  51                 );
  52
  53                 // Init config-copy array
  54                 $this->configCopy = array(
  55                         XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS => 'external_address',
  56                         XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_INTERNAL_ADDRESS => 'internal_address',
  57                         XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_NODE_STATUS      => 'node_status',
  58                         XmlDhtBootstrapAnswerTemplateEngine::DHT_BOOTSTRAP_DATA_SESSION_ID       => 'session_id',
  59                 );
  60
  61                 // Init array
  62                 $this->searchData = array(
  63                         XmlDhtBootstrapTemplateEngine::DHT_BOOTSTRAP_DATA_EXTERNAL_ADDRESS,
  64                 );
  65         }
  66
  67         /**
  68          * Creates an instance of this class
  69          *
  70          * @return      $handlerInstance        An instance of a HandleableMessage class
  71          */
  72         public final static function createNodeMessageDhtBootstrapHandler () {
  73                 // Get new instance
  74                 $handlerInstance = new NodeMessageDhtBootstrapHandler();
  75
  76                 // Get node instance
  77                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  78
  79                 // ... and set it here
  80                 $handlerInstance->setNodeInstance($nodeInstance);
  81
  82                 // Get a DHT instance
  83                 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
  84
  85                 // Set the DHT instance here
  86                 $handlerInstance->setDhtInstance($dhtInstance);
  87
  88                 // Return the prepared instance
  89                 return $handlerInstance;
  90         }
  91
  92         /**
  93          * Handles data array of the message
  94          *
  95          * @param       $messageData            An array with message data to handle
  96          * @param       $packageInstance        An instance of a Receivable class
  97          * @return      void
  98          * @throws      DhtBootstrapNotAcceptedException        If this node does not accept DHT bootstrap requests
  99          */
 100         public function handleMessageData (array $messageData, Receivable $packageInstance) {
 101                 // Is this node accepting DHT bootstrap requests?
 102                 if (!$this->getNodeInstance()->isAcceptingDhtBootstrap()) {
 103                         /*
 104                          * This node is not accepting DHT bootstrap requests.
 105                          */
 106                         throw new DhtBootstrapNotAcceptedException(array($this, $messageData), self::EXCEPTION_DHT_BOOTSTRAP_NOT_ACCEPTED);
 107                 } // END - if
 108
 109                 // Register the DHT bootstrap requesting node with this node
 110                 $this->registerNodeByMessageData($messageData);
 111
 112                 // Prepare answer message to be delivered back to the other node
 113                 $this->prepareAnswerMessage($messageData, $packageInstance);
 114         }
 115
 116         /**
 117          * Adds all required elements from given array into data set instance
 118          *
 119          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 120          * @param       $messageData            An array with all message data
 121          * @return      void
 122          */
 123         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 124                 // Add generic first
 125                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 126
 127                 // Add all ements
 128                 foreach ($this->messageDataElements as $key) {
 129                         // Is it there?
 130                         assert(isset($messageData[$key]));
 131
 132                         // Add it
 133                         $dataSetInstance->addCriteria($key, $messageData[$key]);
 134                 } // END - foreach
 135         }
 136
 137         /**
 138          * Initializes configuration data from given message data array
 139          *
 140          * @param       $messageData    An array with all message data
 141          * @return      void
 142          */
 143         protected function initMessageConfigurationData (array $messageData) {
 144                 // Debug message
 145                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-BOOTSTRAP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
 146
 147                 // "Walk" throught the translation array
 148                 foreach ($this->messageToConfig as $messageKey => $configKey) {
 149                         // Debug message
 150                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-BOOTSTRAP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Setting messageKey=' . $messageKey . ',configKey=' . $configKey . ':' . $messageData[$messageKey]);
 151
 152                         // Set the element in configuration
 153                         $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
 154                 } // END - foreach
 155
 156                 // "Walk" throught the config-copy array
 157                 foreach ($this->configCopy as $targetKey => $sourceKey) {
 158                         // Debug message
 159                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-BOOTSTRAP-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
 160
 161                         // Copy from source to target key
 162                         $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
 163                 } // END - foreach
 164
 165                 // Translate last exception into a status code
 166                 $statusCode = $this->getTranslatedStatusFromLastException();
 167
 168                 // Set it in configuration (temporarily)
 169                 $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $statusCode);
 170
 171                 /*
 172                  * Use the DHT instance to get a list of recipients. This means that all
 173                  * DHT nodes that accept bootstrap requests are read from the DHT
 174                  * database.
 175                  */
 176                 $nodeList = $this->getDhtInstance()->findRecipientsByKey(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ACCEPT_BOOTSTRAP, 'Y');
 177
 178                 // Make sure it is an array and has at least one entry
 179                 assert(is_array($nodeList));
 180                 assert(count($nodeList) > 0);
 181
 182                 // Set it in configuration
 183                 $this->getConfigInstance()->setConfigEntry('dht_nodes', base64_encode(serialize($nodeList)));
 184         }
 185
 186         /**
 187          * Removes configuration data with given message data array from global
 188          * configuration
 189          *
 190          * @param       $messageData    An array with all message data
 191          * @return      void
 192          */
 193         protected function removeMessageConfigurationData (array $messageData) {
 194                 // "Walk" throught the translation array again
 195                 foreach ($this->messageToConfig as $dummy => $configKey) {
 196                         // Now unset this configuration entry (to save some memory)
 197                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 198                 } // END - foreach
 199
 200                 // "Walk" throught the config-copy array again
 201                 foreach ($this->configCopy as $configKey => $dummy) {
 202                         // Now unset this configuration entry (to save some memory again)
 203                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 204                 } // END - foreach
 205
 206                 // Remove temporary "special" values as well
 207                 $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS);
 208                 $this->getConfigInstance()->unsetConfigEntry('dht_nodes');
 209         }
 210 }
 211
 212 // [EOF]
 213 ?>