application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageAnnouncement handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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_SESSION_ID,
  43                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT,
  44                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_UDP_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_TCP_PORT    => 'node_tcp_listen_port',
  61                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT    => 'node_udp_listen_port'
  62                 );
  63         }
  64
  65         /**
  66          * Creates an instance of this class
  67          *
  68          * @return      $handlerInstance        An instance of a HandleableMessage class
  69          */
  70         public final static function createNodeMessageAnnouncementHandler () {
  71                 // Get new instance
  72                 $handlerInstance = new NodeMessageAnnouncementHandler();
  73
  74                 // Return the prepared instance
  75                 return $handlerInstance;
  76         }
  77
  78         /**
  79          * Handles data array of the message
  80          *
  81          * @param       $messageData            An array with message data to handle
  82          * @param       $packageInstance        An instance of a Receivable class
  83          * @return      void
  84          * @throws      AnnouncementNotAcceptedException        If this node does not accept announcements
  85          */
  86         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  87                 // Get node instance
  88                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  89
  90                 // Is this node accepting announcements?
  91                 if (!$nodeInstance->isAcceptingAnnouncements()) {
  92                         /*
  93                          * This node is not accepting announcements, then someone wants to
  94                          * announce his node to a non-bootstrap and non-master node.
  95                          */
  96                         throw new AnnouncementNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED);
  97                 } // END - if
  98
  99                 // Register the announcing node with this node
 100                 $this->registerNodeByMessageData($messageData);
 101
 102                 // Prepare answer message to be delivered back to the other node
 103                 $this->prepareAnswerMessage($messageData, $packageInstance);
 104         }
 105
 106         /**
 107          * Adds all required elements from given array into data set instance
 108          *
 109          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 110          * @param       $messageData            An array with all message data
 111          * @return      void
 112          */
 113         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 114                 // Add all ements
 115                 foreach ($this->messageDataElements as $key) {
 116                         // Is it there?
 117                         assert(isset($messageData[$key]));
 118
 119                         // Add it
 120                         $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
 121                 } // END - foreach
 122         }
 123
 124         /**
 125          * Initializes configuration data from given message data array
 126          *
 127          * @param       $messageData    An array with all message data
 128          * @return      void
 129          */
 130         protected function initMessageConfigurationData (array $messageData) {
 131                 // Debug message
 132                 //* NOISY-DEBUG: */ $this->debugOutput('ANNOUNCEMENT-HANDLER: messageData=' . print_r($messageData, true));
 133
 134                 // "Walk" throught the translation array
 135                 foreach ($this->messageToConfig as $messageKey => $configKey) {
 136                         // Debug message
 137                         //* NOISY-DEBUG: */ $this->debugOutput('ANNOUNCEMENT-HANDLER: Setting messageKey=' . $messageKey . ',configKey=' . $configKey . ':' . $messageData[$messageKey]);
 138
 139                         // Set the element in configuration
 140                         $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
 141                 } // END - foreach
 142
 143                 // "Walk" throught the config-copy array
 144                 foreach ($this->configCopy as $targetKey => $sourceKey) {
 145                         // Debug message
 146                         //* NOISY-DEBUG: */ $this->debugOutput('ANNOUNCEMENT-HANDLER: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
 147
 148                         // Copy from source to targetKey
 149                         $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
 150                 } // END - foreach
 151
 152                 // Translate last exception into a status code
 153                 $statusCode = $this->getTranslatedStatusFromLastException();
 154
 155                 // Set it in configuration (temporarily)
 156                 $this->getConfigInstance()->setConfigEntry('answer_status', $statusCode);
 157         }
 158
 159         /**
 160          * Removes configuration data with given message data array from global
 161          * configuration
 162          *
 163          * @param       $messageData    An array with all message data
 164          * @return      void
 165          */
 166         protected function removeMessageConfigurationData (array $messageData) {
 167                 // "Walk" throught the translation array again
 168                 foreach ($this->messageToConfig as $dummy => $configKey) {
 169                         // Now unset this configuration entry (to save some memory)
 170                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 171                 } // END - foreach
 172
 173                 // "Walk" throught the config-copy array again
 174                 foreach ($this->configCopy as $configKey => $dummy) {
 175                         // Now unset this configuration entry (to save some memory again)
 176                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 177                 } // END - foreach
 178
 179                 // Remove 'answer_status' as well
 180                 $this->getConfigInstance()->unsetConfigEntry('answer_status');
 181         }
 182 }
 183
 184 // [EOF]
 185 ?>