application/hub/classes/handler/message-types/announcement/class_NodeMessageAnnouncementHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageAnnouncement handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 NodeMessageAnnouncementHandler 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_announcement');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
  40                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
  41                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
  42                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_MODE,
  43                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_ID,
  44                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  45                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH,
  46                 );
  47
  48                 // Init message-data->configuration translation array
  49                 $this->messageToConfig = array(
  50                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'your_external_address',
  51                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'your_internal_address',
  52                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_ID          => 'your_node_id',
  53                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID       => 'your_session_id',
  54                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => 'your_private_key_hash',
  55                 );
  56
  57                 // Init config-copy array
  58                 $this->configCopy = array(
  59                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => 'external_address',
  60                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => 'internal_address',
  61                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS      => 'node_status',
  62                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID       => 'session_id',
  63                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => 'private_key_hash',
  64                 );
  65
  66                 // Init array
  67                 $this->searchData = array(
  68                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS
  69                 );
  70         }
  71
  72         /**
  73          * Creates an instance of this class
  74          *
  75          * @return      $handlerInstance        An instance of a HandleableMessage class
  76          */
  77         public final static function createNodeMessageAnnouncementHandler () {
  78                 // Get new instance
  79                 $handlerInstance = new NodeMessageAnnouncementHandler();
  80
  81                 // Return the prepared instance
  82                 return $handlerInstance;
  83         }
  84
  85         /**
  86          * Handles data array of the message
  87          *
  88          * @param       $messageData            An array with message data to handle
  89          * @param       $packageInstance        An instance of a Receivable class
  90          * @return      void
  91          * @throws      AnnouncementNotAcceptedException        If this node does not accept announcements
  92          */
  93         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  94                 // Get node instance
  95                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  96
  97                 // Is this node accepting announcements?
  98                 if (!$nodeInstance->isAcceptingAnnouncements()) {
  99                         /*
 100                          * This node is not accepting announcements, then someone wants to
 101                          * announce his node to a non-bootstrap and non-master node.
 102                          */
 103                         throw new AnnouncementNotAcceptedException(array($this, $nodeInstance, $messageData), BaseHubSystem::EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED);
 104                 } // END - if
 105
 106                 // Register the announcing node with this node
 107                 $this->registerNodeByMessageData($messageData);
 108
 109                 // Prepare answer message to be delivered back to the other node
 110                 $this->prepareAnswerMessage($messageData, $packageInstance);
 111         }
 112
 113         /**
 114          * Adds all required elements from given array into data set instance
 115          *
 116          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 117          * @param       $messageData            An array with all message data
 118          * @return      void
 119          */
 120         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 121                 // Add generic first
 122                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 123
 124                 // Add all ements
 125                 foreach ($this->messageDataElements as $key) {
 126                         // Is it there?
 127                         assert(isset($messageData[$key]));
 128
 129                         // Add it
 130                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Adding messageData[' . $key . ']=' . $messageData[$key] . ' ...');
 131                         $dataSetInstance->addCriteria($key, $messageData[$key]);
 132                 } // END - foreach
 133         }
 134
 135         /**
 136          * Initializes configuration data from given message data array
 137          *
 138          * @param       $messageData    An array with all message data
 139          * @return      void
 140          */
 141         protected function initMessageConfigurationData (array $messageData) {
 142                 // Debug message
 143                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
 144
 145                 // "Walk" throught the translation array
 146                 foreach ($this->messageToConfig as $messageKey => $configKey) {
 147                         // Debug message
 148                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Setting messageKey=' . $messageKey . ',configKey=' . $configKey . ':' . $messageData[$messageKey]);
 149
 150                         // Set the element in configuration
 151                         $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
 152                 } // END - foreach
 153
 154                 // "Walk" throught the config-copy array
 155                 foreach ($this->configCopy as $targetKey => $sourceKey) {
 156                         // Debug message
 157                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
 158
 159                         // Copy from source to targetKey
 160                         $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
 161                 } // END - foreach
 162
 163                 // Translate last exception into a status code
 164                 $statusCode = $this->getTranslatedStatusFromLastException();
 165
 166                 // Set it in configuration (temporarily)
 167                 $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $statusCode);
 168         }
 169
 170         /**
 171          * Removes configuration data with given message data array from global
 172          * configuration
 173          *
 174          * @param       $messageData    An array with all message data
 175          * @return      void
 176          */
 177         protected function removeMessageConfigurationData (array $messageData) {
 178                 // "Walk" throught the translation array again
 179                 foreach ($this->messageToConfig as $dummy => $configKey) {
 180                         // Now unset this configuration entry (to save some memory)
 181                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 182                 } // END - foreach
 183
 184                 // "Walk" throught the config-copy array again
 185                 foreach ($this->configCopy as $configKey => $dummy) {
 186                         // Now unset this configuration entry (to save some memory again)
 187                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 188                 } // END - foreach
 189
 190                 // Remove NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS as well
 191                 $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS);
 192         }
 193 }
 194
 195 // [EOF]
 196 ?>