application/hub/main/handler/answer-status/requests/class_RequestNodeListAnswerOkayHandler.php

   1 <?php
   2 /**
   3  * A RequestNodeListAnswerOkay 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 RequestNodeListAnswerOkayHandler 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('request_node_list_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 createRequestNodeListAnswerOkayHandler () {
  44                 // Get new instance
  45                 $handlerInstance = new RequestNodeListAnswerOkayHandler();
  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          * @todo        Rewrite this to use DHT
  60          */
  61         public function handleAnswerMessageData (array $messageData, Receivable $packageInstance) {
  62                 // Get a database wrapper instance
  63                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
  64
  65                 // Get also a search criteria instance
  66                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  67
  68                 // Lookup external session id/external IP/port
  69                 $searchInstance->addCriteria('session_id' , $messageData[XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID]);
  70
  71                 // Only one entry is fine
  72                 $searchInstance->setLimit(1);
  73
  74                 // Run the query
  75                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
  76
  77                 // Is there an try?
  78                 if (!$resultInstance->next()) {
  79                         // This is fatal, caused by "stolen" session id and/or not matching IP number/port combination
  80                         throw new NodeSessionIdVerficationException(array($this, $messageData), BaseHubSystem::EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING);
  81                 } // END - if
  82
  83                 // Get the node instance
  84                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  85
  86                 // Change state
  87                 $nodeInstance->getStateInstance()->nodeRequestNodeListSuccessful();
  88
  89                 // Prepare next message ("hello" message to all returned nodes)
  90                 $this->prepareNextMessage($messageData, $packageInstance);
  91         }
  92
  93         /**
  94          * Initializes configuration data from given message data array
  95          *
  96          * The following array is being handled over:
  97          *
  98          *   session-id    => aaabbbcccdddeeefff123456789
  99          *   node-list     => aabb:ccdd:eeff
 100          *   answer-status => OKAY
 101          *   message_type  => request_node_list_answer
 102          *
 103          * @param       $messageData    An array with all message data
 104          * @return      void
 105          * @todo        0% done
 106          */
 107         protected function initMessageConfigurationData (array $messageData) {
 108                 $this->partialStub('Please implement this method.');
 109         }
 110
 111         /**
 112          * Removes configuration data with given message data array from global
 113          * configuration. For content of $messageData see method comment above.
 114          *
 115          * @param       $messageData    An array with all message data
 116          * @return      void
 117          * @todo        0% done
 118          */
 119         protected function removeMessageConfigurationData (array $messageData) {
 120                 $this->partialStub('Please implement this method.');
 121         }
 122 }
 123
 124 // [EOF]
 125 ?>