application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageAnnouncementAnswer 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 NodeMessageAnnouncementAnswerHandler 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_answer');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
  40                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP,
  41                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
  42                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  43                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT,
  44                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT,
  45                         BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
  46                 );
  47
  48                 // Init message-data->configuration translation array
  49                 $this->messageToConfig = array(
  50                 /*
  51                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP => 'your_external_ip',
  52                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP => 'your_internal_ip',
  53                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID  => 'your_session_id'
  54                 */
  55                 );
  56
  57                 // Init config-copy array
  58                 $this->configCopy = array(
  59                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP => 'external_ip',
  60                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP => 'internal_ip',
  61                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS => 'node_status',
  62                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID  => 'session_id',
  63                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT    => 'node_tcp_listen_port',
  64                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT    => 'node_udp_listen_port'
  65                 );
  66
  67                 // Init array
  68                 $this->searchData = array(
  69                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  70                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
  71                         XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT
  72                 );
  73         }
  74
  75         /**
  76          * Creates an instance of this class
  77          *
  78          * @return      $handlerInstance        An instance of a HandleableMessage class
  79          */
  80         public final static function createNodeMessageAnnouncementAnswerHandler () {
  81                 // Get new instance
  82                 $handlerInstance = new NodeMessageAnnouncementAnswerHandler();
  83
  84                 // Return the prepared instance
  85                 return $handlerInstance;
  86         }
  87
  88         /**
  89          * Handles data array of the message
  90          *
  91          * @param       $messageData            An array with message data to handle
  92          * @param       $packageInstance        An instance of a Receivable class
  93          * @return      void
  94          * @throws      NoAnnouncementAttemptedException        If this node has not attempted to announce itself
  95          */
  96         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  97                 // Get node instance
  98                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  99
 100                 // Has this node attempted to announce itself?
 101                 if (!$nodeInstance->ifNodeHasAnnounced()) {
 102                         /*
 103                          * This node has never announced itself, so it doesn't expect
 104                          * announcement answer messages.
 105                          */
 106                         throw new NoAnnouncementAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
 107                 } // END - if
 108
 109                 // Register the announcing node with this node
 110                 $this->registerNodeByMessageData($messageData);
 111
 112                 // Handle the answer status element
 113                 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
 114         }
 115
 116         /**
 117          * Adds all required elements from given array into data set instance
 118          *
 119          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 120          * @param       $messageData            An array with all message data
 121          * @return      void
 122          */
 123         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 124                 // Add all ements
 125                 foreach ($this->messageDataElements as $key) {
 126                         // Is it there?
 127                         assert(isset($messageData[$key]));
 128
 129                         /*
 130                          * Add it, but remove any 'my-' prefixes as they are not used in
 131                          * database layer.
 132                          */
 133                         $dataSetInstance->addCriteria('node_' . str_replace('my-', '', $key), $messageData[$key]);
 134                 } // END - foreach
 135         }
 136
 137         /**
 138          * Initializes configuration data from given message data array
 139          *
 140          * @param       $messageData    An array with all message data
 141          * @return      void
 142          * @throws      UnsupportedOperationException   If this method is called
 143          */
 144         protected function initMessageConfigurationData (array $messageData) {
 145                 // Please don't call this method
 146                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 147         }
 148
 149         /**
 150          * Removes configuration data with given message data array from global
 151          * configuration
 152          *
 153          * @param       $messageData    An array with all message data
 154          * @return      void
 155          * @throws      UnsupportedOperationException   If this method is called
 156          */
 157         protected function removeMessageConfigurationData (array $messageData) {
 158                 // Please don't call this method
 159                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 160         }
 161 }
 162
 163 // [EOF]
 164 ?>