application/hub/classes/handler/message-types/requests/class_NodeMessageRequestNodeListHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageRequestNodeList handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 NodeMessageRequestNodeListHandler 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_request_node_list');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
  40                 );
  41
  42                 // Init config-copy array
  43                 $this->configCopy = array(
  44                 );
  45
  46                 // Init search data array
  47                 $this->searchData = array(
  48                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID,
  49                 );
  50         }
  51
  52         /**
  53          * Creates an instance of this class
  54          *
  55          * @return      $handlerInstance        An instance of a HandleableMessage class
  56          */
  57         public final static function createNodeMessageRequestNodeListHandler () {
  58                 // Get new instance
  59                 $handlerInstance = new NodeMessageRequestNodeListHandler();
  60
  61                 // Return the prepared instance
  62                 return $handlerInstance;
  63         }
  64
  65         /**
  66          * Handles data array of the message
  67          *
  68          * @param       $messageData            An array with message data to handle
  69          * @param       $packageInstance        An instance of a Receivable class
  70          * @return      void
  71          * @throws      RequestNotAcceptedException             If this node does not accept this request
  72          */
  73         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  74                 // Get node instance
  75                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  76
  77                 // Is this node accepting announcements?
  78                 if (!$nodeInstance->isAcceptingNodeListRequests()) {
  79                         /*
  80                          * This node is not accepting node list requests. Throw an
  81                          * exception to abort any further processing.
  82                          */
  83                         throw new RequestNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_REQUEST_NOT_ACCEPTED);
  84                 } // END - if
  85
  86                 // Register the announcing node with this node
  87                 $this->registerNodeByMessageData($messageData);
  88
  89                 // Prepare answer message to be delivered back to the other node
  90                 $this->prepareAnswerMessage($messageData, $packageInstance);
  91         }
  92
  93         /**
  94          * Adds all required elements from given array into data set instance
  95          *
  96          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  97          * @param       $messageData            An array with all message data
  98          * @return      void
  99          */
 100         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 101                 // Add generic first
 102                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 103
 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($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                 // Debug message
 122                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REQUEST-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
 123
 124                 // "Walk" throught the config-copy array
 125                 foreach ($this->configCopy as $targetKey => $sourceKey) {
 126                         // Debug message
 127                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REQUEST-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
 128
 129                         // Copy from source to targetKey
 130                         $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
 131                 } // END - foreach
 132
 133                 // Query local DHT for nodes except given session id
 134                 $nodeList = $this->getDhtInstance()->queryLocalNodeListExceptByMessageData(
 135                         $messageData,
 136                         $this,
 137                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID,
 138                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
 139                         BaseHubNode::OBJECT_LIST_SEPARATOR
 140                 );
 141
 142                 // Debug message
 143                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('REQUEST-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: Got a node list of ' . count($nodeList) . ' entry/-ies back.');
 144
 145                 // Set it serialized in configuration (temporarily)
 146                 $this->getConfigInstance()->setConfigEntry('node_list', base64_encode(json_encode($nodeList)));
 147
 148                 // Translate last exception into a status code
 149                 $statusCode = $this->getTranslatedStatusFromLastException();
 150
 151                 // Set it in configuration (temporarily)
 152                 $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $statusCode);
 153         }
 154
 155         /**
 156          * Removes configuration data with given message data array from global
 157          * configuration
 158          *
 159          * @param       $messageData    An array with all message data
 160          * @return      void
 161          */
 162         protected function removeMessageConfigurationData (array $messageData) {
 163                 // "Walk" throught the config-copy array again
 164                 foreach ($this->configCopy as $configKey => $dummy) {
 165                         // Now unset this configuration entry (to save some memory again)
 166                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 167                 } // END - foreach
 168
 169                 // Remove answer status/node list as well
 170                 $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS);
 171                 $this->getConfigInstance()->unsetConfigEntry('node_list');
 172         }
 173 }
 174
 175 // [EOF]
 176 ?>