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