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
  55         /**
  56          * Creates an instance of this class
  57          *
  58          * @return      $handlerInstance        An instance of a HandleableMessage class
  59          */
  60         public final static function createNodeMessageAnnouncementHandler () {
  61                 // Get new instance
  62                 $handlerInstance = new NodeMessageAnnouncementHandler();
  63
  64                 // Return the prepared instance
  65                 return $handlerInstance;
  66         }
  67
  68         /**
  69          * Handles data array of the message
  70          *
  71          * @param       $messageData            An array with message data to handle
  72          * @param       $packageInstance        An instance of a Receivable class
  73          * @return      void
  74          * @throws      AnnouncementNotAcceptedException        If this node does not accept announcements
  75          */
  76         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  77                 // Get node instance
  78                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  79
  80                 // Is this node accepting announcements?
  81                 if (!$nodeInstance->isAcceptingAnnouncements()) {
  82                         /*
  83                          * This node is not accepting announcements, then someone wants to
  84                          * announce his node to a non-bootstrap and non-master node.
  85                          */
  86                         throw new AnnouncementNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED);
  87                 } // END - if
  88
  89                 // Register the announcing node with this node
  90                 $this->registerNodeByMessageData($messageData);
  91
  92                 // Prepare answer message to be delivered back to the other node
  93                 $this->prepareAnswerMessage($messageData, $packageInstance);
  94         }
  95
  96         /**
  97          * Adds all required elements from given array into data set instance
  98          *
  99          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 100          * @param       $messageData            An array with all message data
 101          * @return      void
 102          */
 103         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 104                 // Add all ements
 105                 foreach ($this->messageDataElements as $key) {
 106                         // Is it there?
 107                         assert(isset($messageData[$key]));
 108
 109                         // Add it
 110                         $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
 111                 } // END - foreach
 112         }
 113
 114         /**
 115          * Initializes configuration data from given message data array
 116          *
 117          * @param       $messageData    An array with all message data
 118          * @return      void
 119          */
 120         protected function initMessageConfigurationData (array $messageData) {
 121                 // "Walk" throught the translation array
 122                 foreach ($this->messageToConfig as $messageKey => $configKey) {
 123                         // Set the element in configuration
 124                         $this->getConfigInstance()->setConfigEntry($configKey, $messageData[$messageKey]);
 125                 } // END - foreach
 126
 127                 // Translate last exception into a status code
 128                 $statusCode = $this->getTranslatedStatusFromLastException();
 129
 130                 // Set it in configuration (temporarily)
 131                 $this->getConfigInstance()->setConfigEntry('answer_status', $statusCode);
 132         }
 133
 134         /**
 135          * Removes configuration data with given message data array from global
 136          * configuration
 137          *
 138          * @param       $messageData    An array with all message data
 139          * @return      void
 140          */
 141         protected function removeMessageConfigurationData (array $messageData) {
 142                 // "Walk" throught the translation array again
 143                 foreach ($this->messageToConfig as $dummy => $configKey) {
 144                         // Now unset this configuration entry (to save some memory)
 145                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 146                 } // END - foreach
 147
 148                 // Remove 'answer_status' as well
 149                 $this->getConfigInstance()->unsetConfigEntry('answer_status');
 150         }
 151 }
 152
 153 // [EOF]
 154 ?>