application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php

   1 <?php
   2 /**
   3  * A AnnouncementAnswerOkay 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 AnnouncementAnswerOkayHandler extends BaseAnserStatusHandler implements HandleableAnswerStatus, 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('announcement_answer_okay');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @return      $handlerInstance        An instance of a HandleableMessage class
  42          */
  43         public final static function createAnnouncementAnswerOkayHandler () {
  44                 // Get new instance
  45                 $handlerInstance = new AnnouncementAnswerOkayHandler();
  46
  47                 // Return the prepared instance
  48                 return $handlerInstance;
  49         }
  50
  51         /**
  52          * Handles given message data array
  53          *
  54          * @param       $messageData            An array of message data
  55          * @param       $packageInstance        An instance of a Receivable class
  56          * @return      void
  57          * @throws      NodeSessionIdVerficationException       If the provided session id is not matching
  58          * @todo        Do some more here: Handle karma, et cetera?
  59          */
  60         public function handleAnswerMessageData (array $messageData, Receivable $packageInstance) {
  61                 // Get a database wrapper instance
  62                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
  63
  64                 // Get also a search criteria instance
  65                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  66
  67                 // Lookup external session id/external IP/port
  68                 $searchInstance->addCriteria('node_session_id' , $messageData[XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID]);
  69                 $searchInstance->addCriteria('node_external_ip', $messageData[XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP]);
  70                 $searchInstance->addCriteria('node_tcp_port'   , $messageData[XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT]);
  71
  72                 // Only one entry is fine
  73                 $searchInstance->setLimit(1);
  74
  75                 // Run the query
  76                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
  77
  78                 // Is there an try?
  79                 if (!$resultInstance->next()) {
  80                         // This is fatal, caused by "stolen" session id and/or not matching IP number/port combination
  81                         throw new NodeSessionIdVerficationException(array($this, $messageData), BaseHubSystem::EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING);
  82                 } // END - if
  83
  84                 // Update node data (include status code)
  85                 $wrapperInstance->updateNodeByMessageData($messageData, $this, $searchInstance);
  86
  87                 // Get the node instance
  88                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  89
  90                 // Change state
  91                 $nodeInstance->getStateInstance()->nodeAnnouncementSuccessful();
  92
  93                 // Prepare next message
  94                 $this->prepareNextMessage($messageData, $packageInstance);
  95         }
  96
  97         /**
  98          * Initializes configuration data from given message data array
  99          *
 100          * The following array is being handled over:
 101          *
 102          *     my-external-ip => 1.2.3.4
 103          *     my-internal-ip => 5.6.7.8
 104          *     my-status      => reachable
 105          *     my-session-id  => aaabbbcccdddeeefff123456789
 106          *     my-tcp-port    => 9060
 107          *     my-udp-port    => 9060
 108          *     answer-status  => OKAY
 109          *     message_type   => announcement_answer
 110          *
 111          * @param       $messageData    An array with all message data
 112          * @return      void
 113          */
 114         protected function initMessageConfigurationData (array $messageData) {
 115                 $this->partialStub('messageData=' . print_r($messageData, true));
 116         }
 117
 118         /**
 119          * Removes configuration data with given message data array from global
 120          * configuration. For content of $messageData see method comment above.
 121          *
 122          * @param       $messageData    An array with all message data
 123          * @return      void
 124          */
 125         protected function removeMessageConfigurationData (array $messageData) {
 126                 $this->partialStub('messageData=' . print_r($messageData, true));
 127         }
 128 }
 129
 130 // [EOF]
 131 ?>