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

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