application/hub/main/dht/node/class_NodeDhtFacade.php

   1 <?php
   2 /**
   3  * A Node DHT facade class
   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 NodeDhtFacade extends BaseDht implements Distributable, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $dhtInstance    An instance of a Distributable class
  39          */
  40         public final static function createNodeDhtFacade () {
  41                 // Get new instance
  42                 $dhtInstance = new NodeDhtFacade();
  43
  44                 // Get a database wrapper instance
  45                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_dht_db_wrapper_class');
  46
  47                 // Set it in this class
  48                 $dhtInstance->setWrapperInstance($wrapperInstance);
  49
  50                 // Return the prepared instance
  51                 return $dhtInstance;
  52         }
  53
  54         /**
  55          * Initializes the distributed hash table (DHT)
  56          *
  57          * @return      void
  58          */
  59         public function initDht () {
  60                 // Is the local node registered?
  61                 if ($this->getWrapperInstance()->isLocalNodeRegistered()) {
  62                         // Then only update session id
  63                         $this->getWrapperInstance()->updateLocalNode();
  64                 } else {
  65                         // No, so register it
  66                         $this->getWrapperInstance()->registerLocalNode();
  67                 }
  68
  69                 // Change state
  70                 $this->getStateInstance()->dhtHasInitialized();
  71         }
  72
  73         /**
  74          * Bootstraps the DHT by sending out a message to all available nodes
  75          * (including itself). This step helps the node to get to know more nodes
  76          * which can be queried later for object distribution.
  77          *
  78          * @return      void
  79          */
  80         public function bootstrapDht () {
  81                 // Get a helper instance
  82                 $helperInstance = ObjectFactory::createObjectByConfiguredName('dht_bootstrap_helper_class');
  83
  84                 // Load the announcement descriptor
  85                 $helperInstance->loadDescriptorXml($this);
  86
  87                 // Compile all variables
  88                 $helperInstance->getTemplateInstance()->compileConfigInVariables();
  89
  90                 // "Publish" the descriptor by sending it to the bootstrap/list nodes
  91                 $helperInstance->sendPackage($this);
  92
  93                 // Change state
  94                 $this->getStateInstance()->dhtHasBooted();
  95         }
  96
  97         /**
  98          * Finds a node locally by given session id
  99          *
 100          * @param       $sessionId      Session id to lookup
 101          * @return      $nodeData       Node-data array
 102          */
 103         public function findNodeLocalBySessionId ($sessionId) {
 104                 // Default is empty data array
 105                 $nodeData = array();
 106
 107                 /*
 108                  * Call the wrapper to do the job and get back a result instance. There
 109                  * will come back zero or one entry from the wrapper.
 110                  */
 111                 $resultInstance = $this->getWrapperInstance()->findNodeLocalBySessionId($sessionId);
 112
 113                 // Is the next entry valid?
 114                 if ($resultInstance->next()) {
 115                         /*
 116                          * Then load the first entry (more entries are being ignored and
 117                          * should not happen).
 118                          */
 119                         $nodeData = $resultInstance->current();
 120                 } // END - if
 121
 122                 // Return node data
 123                 return $nodeData;
 124         }
 125
 126         /**
 127          * Registers an other node with this node by given message data. The
 128          * following data must always be present:
 129          *
 130          * - session-id  (for finding the node's record together with below data)
 131          * - external-ip (hostname or IP number)
 132          * - listen-port (TCP/UDP listen port for inbound connections)
 133          *
 134          * @param       $messageArray           An array with all minimum message data
 135          * @param       $handlerInstance        An instance of a Handleable class
 136          * @param       $forceUpdate            Optionally force update, don't register (default: register if not found)
 137          * @return      void
 138          * @throws      NodeSessionIdVerficationException       If the node was not found and update is forced
 139          */
 140         public function registerNodeByMessageData (array $messageData, Handleable $handlerInstance, $forceUpdate = FALSE) {
 141                 // Get a search criteria class
 142                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 143
 144                 // Debug message
 145                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE: messageData=' . print_r($messageData, true));
 146
 147                 // Search for the node's session id and external IP/hostname + TCP/UDP listen port
 148                 foreach ($handlerInstance->getSearchData() as $key) {
 149                         // Debug message
 150                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE: messageData[' . $key . ']=' . $messageData[$key]);
 151
 152                         // Is it there?
 153                         assert(isset($messageData[$key]));
 154
 155                         // Add criteria
 156                         $searchInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
 157                 } // END - foreach
 158
 159                 // Only one entry is fine
 160                 $searchInstance->setLimit(1);
 161
 162                 // Run the query
 163                 $resultInstance = $this->getWrapperInstance()->doSelectByCriteria($searchInstance);
 164
 165                 // Is there already an entry?
 166                 if ($resultInstance->next()) {
 167                         // Entry found, so update it
 168                         $this->getWrapperInstance()->updateNodeByMessageData($messageData, $handlerInstance, $searchInstance);
 169                 } elseif ($forceUpdate === FALSE) {
 170                         // Nothing found, so register it
 171                         $this->getWrapperInstance()->registerNodeByMessageData($messageData, $handlerInstance);
 172                 } else {
 173                         /*
 174                          * Do not register non-existent nodes here. This is maybe fatal,
 175                          * caused by "stolen" session id and/or not matching IP
 176                          * number/port combination.
 177                          */
 178                         throw new NodeSessionIdVerficationException(array($this, $messageData), BaseHubSystem::EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING);
 179                 }
 180
 181                 // Save last exception
 182                 $handlerInstance->setLastException($this->getWrapperInstance()->getLastException());
 183         }
 184
 185         /**
 186          * Queries the local DHT data(base) for a node list with all supported
 187          * object types except the node by given session id.
 188          *
 189          * @param       $messageData            An array with message data from a node_list request
 190          * @param       $handlerInstance        An instance of a Handleable class
 191          * @param       $excludeKey                     Array key which should be excluded
 192          * @param       $andKey                         Array of $separator-separated list of elements which all must match
 193          * @param       $separator                      Sepator char (1st parameter for explode() call)
 194          * @return      $nodeList                       An array with all found nodes
 195          */
 196         public function queryLocalNodeListExceptByMessageData (array $messageData, Handleable $handlerInstance, $excludeKey, $andKey, $separator) {
 197                 // Make sure both keys are there
 198                 assert((isset($messageData[$excludeKey])) && (isset($messageData[$andKey])));
 199
 200                 // Debug message
 201                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE: messageData=' . print_r($messageData, true));
 202
 203                 // Get a search criteria class
 204                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 205
 206                 // Add all keys
 207                 foreach (explode($separator, $messageData[$andKey]) as $criteria) {
 208                         // Debug message
 209                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE: andKey=' . $andKey . ',criteria=' . $criteria);
 210
 211                         // Add it and leave any 'my-' prefix out
 212                         $searchInstance->addChoiceCriteria(str_replace('my-', '', $andKey), $criteria);
 213                 } // END - foreach
 214
 215                 // Add exclusion key
 216                 $searchInstance->addExcludeCriteria(str_replace('my-', '', $excludeKey), $messageData[$excludeKey]);
 217
 218                 // Only X entries are fine
 219                 $searchInstance->setLimit($this->getConfigInstance()->getConfigEntry('node_dht_list_limit'));
 220
 221                 // Run the query
 222                 $resultInstance = $this->getWrapperInstance()->doSelectByCriteria($searchInstance);
 223
 224                 // Get node list
 225                 $nodeList = array();
 226                 while ($resultInstance->next()) {
 227                         // Add this entry
 228                         array_push($nodeList, $resultInstance->current());
 229                 } // END - while
 230
 231                 // Save last exception
 232                 $handlerInstance->setLastException($this->getWrapperInstance()->getLastException());
 233
 234                 // Return node list (array)
 235                 return $nodeList;
 236         }
 237
 238         /**
 239          * Inserts given node list array (from earlier database result produced by
 240          * an other node) into the DHT. This array origins from above method
 241          * queryLocalNodeListExceptByMessageData().
 242          *
 243          * @param       $nodeList       An array from an earlier database result instance
 244          * @return      void
 245          */
 246         public function insertNodeList (array $nodeList) {
 247                 // If no node is in the list (array), skip the rest of this method silently
 248                 if (count($nodeList) == 0) {
 249                         // Debug message
 250                         self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE: No node record has been returned.');
 251
 252                         // Abort here
 253                         return;
 254                 } // END - if
 255
 256                 // @TODO Not finish yet
 257                 $this->partialStub('DHT: Needs implementing to insert ' . count($nodeList) . ' entry(-ies) into DHT.');
 258         }
 259 }
 260
 261 // [EOF]
 262 ?>