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                 // Init array
  65                 $this->searchData = array(
  66                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  67                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
  68                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT
  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 = Registry::getRegistry()->getInstance('node');
  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), self::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 all ements
 122                 foreach ($this->messageDataElements as $key) {
 123                         // Is it there?
 124                         assert(isset($messageData[$key]));
 125
 126                         // Add it
 127                         $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
 128                 } // END - foreach
 129         }
 130
 131         /**
 132          * Initializes configuration data from given message data array
 133          *
 134          * @param       $messageData    An array with all message data
 135          * @return      void
 136          */
 137         protected function initMessageConfigurationData (array $messageData) {
 138                 // Debug message
 139                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER: messageData=' . print_r($messageData, true));
 140
 141                 // "Walk" throught the translation array
 142                 foreach ($this->messageToConfig as $messageKey => $configKey) {
 143                         // Debug message
 144                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER: Setting messageKey=' . $messageKey . ',configKey=' . $configKey . ':' . $messageData[$messageKey]);
 145
 146                         // Set the element in configuration
 147                         $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
 148                 } // END - foreach
 149
 150                 // "Walk" throught the config-copy array
 151                 foreach ($this->configCopy as $targetKey => $sourceKey) {
 152                         // Debug message
 153                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANNOUNCEMENT-HANDLER: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
 154
 155                         // Copy from source to targetKey
 156                         $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
 157                 } // END - foreach
 158
 159                 // Translate last exception into a status code
 160                 $statusCode = $this->getTranslatedStatusFromLastException();
 161
 162                 // Set it in configuration (temporarily)
 163                 $this->getConfigInstance()->setConfigEntry('answer_status', $statusCode);
 164         }
 165
 166         /**
 167          * Removes configuration data with given message data array from global
 168          * configuration
 169          *
 170          * @param       $messageData    An array with all message data
 171          * @return      void
 172          */
 173         protected function removeMessageConfigurationData (array $messageData) {
 174                 // "Walk" throught the translation array again
 175                 foreach ($this->messageToConfig as $dummy => $configKey) {
 176                         // Now unset this configuration entry (to save some memory)
 177                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 178                 } // END - foreach
 179
 180                 // "Walk" throught the config-copy array again
 181                 foreach ($this->configCopy as $configKey => $dummy) {
 182                         // Now unset this configuration entry (to save some memory again)
 183                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 184                 } // END - foreach
 185
 186                 // Remove 'answer_status' as well
 187                 $this->getConfigInstance()->unsetConfigEntry('answer_status');
 188         }
 189 }
 190
 191 // [EOF]
 192 ?>