git.mxchange.org Git - hub.git/blob

   1 <?php
   2 // Own namespace
   3 namespace Org\Shipsimu\Hub\Handler\Node\Message\Request\NodeList;
   4
   5 // Import application-specific stuff
   6 use Org\Shipsimu\Hub\Database\Frontend\Node\Dht\NodeDistributedHashTableDatabaseWrapper;
   7 use Org\Shipsimu\Hub\Factory\Dht\DhtObjectFactory;
   8 use Org\Shipsimu\Hub\Factory\Node\NodeObjectFactory;
   9 use Org\Shipsimu\Hub\Handler\Message\BaseMessageHandler;
  10 use Org\Shipsimu\Hub\Handler\Message\HandleableMessage;
  11 use Org\Shipsimu\Hub\Network\Receive\Receivable;
  12 use Org\Shipsimu\Hub\Node\BaseHubNode;
  13 use Org\Shipsimu\Hub\Template\Engine\Xml\Request\NodeList\XmlRequestNodeListTemplateEngine;
  14
  15 // Import framework stuff
  16 use Org\Mxchange\CoreFramework\Criteria\Storing\StoreableCriteria;
  17 use Org\Mxchange\CoreFramework\Registry\Registerable;
  18
  19 /**
  20  * A NodeMessageRequestNodeList handler
  21  *
  22  * @author              Roland Haeder <webmaster@shipsimu.org>
  23  * @version             0.0.0
  24  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2018 Hub Developer Team
  25  * @license             GNU GPL 3.0 or any newer version
  26  * @link                http://www.shipsimu.org
  27  *
  28  * This program is free software: you can redistribute it and/or modify
  29  * it under the terms of the GNU General Public License as published by
  30  * the Free Software Foundation, either version 3 of the License, or
  31  * (at your option) any later version.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 class NodeMessageRequestNodeListHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
  42         /**
  43          * Protected constructor
  44          *
  45          * @return      void
  46          */
  47         protected function __construct () {
  48                 // Call parent constructor
  49                 parent::__construct(__CLASS__);
  50
  51                 // Set handler name
  52                 $this->setHandlerName('message_request_node_list');
  53
  54                 // Init message data array
  55                 $this->messageDataElements = array(
  56                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
  57                 );
  58
  59                 // Init config-copy array
  60                 $this->configCopy = array(
  61                 );
  62
  63                 // Init search data array
  64                 $this->searchData = array(
  65                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID,
  66                 );
  67         }
  68
  69         /**
  70          * Creates an instance of this class
  71          *
  72          * @return      $handlerInstance        An instance of a HandleableMessage class
  73          */
  74         public final static function createNodeMessageRequestNodeListHandler () {
  75                 // Get new instance
  76                 $handlerInstance = new NodeMessageRequestNodeListHandler();
  77
  78                 // Return the prepared instance
  79                 return $handlerInstance;
  80         }
  81
  82         /**
  83          * Handles data array of the message
  84          *
  85          * @param       $messageData            An array with message data to handle
  86          * @param       $packageInstance        An instance of a Receivable class
  87          * @return      void
  88          * @throws      RequestNotAcceptedException             If this node does not accept this request
  89          */
  90         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  91                 // Get node instance
  92                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  93
  94                 // Is this node accepting announcements?
  95                 if (!$nodeInstance->isAcceptingNodeListRequests()) {
  96                         /*
  97                          * This node is not accepting node list requests. Throw an
  98                          * exception to abort any further processing.
  99                          */
 100                         throw new RequestNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_REQUEST_NOT_ACCEPTED);
 101                 } // END - if
 102
 103                 // Register the announcing node with this node
 104                 $this->registerNodeByMessageData($messageData);
 105
 106                 // Prepare answer message to be delivered back to the other node
 107                 $this->prepareAnswerMessage($messageData, $packageInstance);
 108         }
 109
 110         /**
 111          * Adds all required elements from given array into data set instance
 112          *
 113          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 114          * @param       $messageData            An array with all message data
 115          * @return      void
 116          */
 117         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 118                 // Add generic first
 119                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 120
 121                 // Add all ements
 122                 foreach ($this->messageDataElements as $key) {
 123                         // Is it there?
 124                         assert(isset($messageData[$key]));
 125
 126                         // Add it
 127                         $dataSetInstance->addCriteria($key, $messageData[$key]);
 128                 } // END - foreach
 129         }
 130
 131         /**
 132          * Initializes configuration data from given message data array
 133          *
 134          * @param       $messageData    An array with all message data
 135          * @return      void
 136          */
 137         protected function initMessageConfigurationData (array $messageData) {
 138                 // Debug message
 139                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REQUEST-HANDLER: messageData=' . print_r($messageData, TRUE));
 140
 141                 // "Walk" throught the config-copy array
 142                 foreach ($this->configCopy as $targetKey => $sourceKey) {
 143                         // Debug message
 144                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REQUEST-HANDLER: Copying from sourceKey=' . $sourceKey . ' to targetKey=' . $targetKey . '...');
 145
 146                         // Copy from source to targetKey
 147                         $this->getConfigInstance()->setConfigEntry($targetKey, $this->getConfigInstance()->getConfigEntry($sourceKey));
 148                 } // END - foreach
 149
 150                 // Query local DHT for nodes except given session id
 151                 $nodeList = DhtObjectFactory::createDhtInstance('node')->queryLocalNodeListExceptByMessageData(
 152                         $messageData,
 153                         $this,
 154                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID,
 155                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
 156                         BaseHubNode::OBJECT_LIST_SEPARATOR
 157                 );
 158
 159                 // Debug message
 160                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('REQUEST-HANDLER: Got a node list of ' . count($nodeList) . ' entry/-ies back.');
 161
 162                 // Set it serialized in configuration (temporarily)
 163                 $this->getConfigInstance()->setConfigEntry('node_list', base64_encode(json_encode($nodeList)));
 164
 165                 // Translate last exception into a status code
 166                 $statusCode = $this->getTranslatedStatusFromLastException();
 167
 168                 // Set it in configuration (temporarily)
 169                 $this->getConfigInstance()->setConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $statusCode);
 170         }
 171
 172         /**
 173          * Removes configuration data with given message data array from global
 174          * configuration
 175          *
 176          * @param       $messageData    An array with all message data
 177          * @return      void
 178          */
 179         protected function removeMessageConfigurationData (array $messageData) {
 180                 // "Walk" throught the config-copy array again
 181                 foreach ($this->configCopy as $configKey => $dummy) {
 182                         // Now unset this configuration entry (to save some memory again)
 183                         $this->getConfigInstance()->unsetConfigEntry($configKey);
 184                 } // END - foreach
 185
 186                 // Remove answer status/node list as well
 187                 $this->getConfigInstance()->unsetConfigEntry(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_ANSWER_STATUS);
 188                 $this->getConfigInstance()->unsetConfigEntry('node_list');
 189         }
 190
 191 }