application/hub/main/wrapper/node/class_NodeDistributedHashTableDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for distributed hash tables
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.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.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 NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implements NodeDhtWrapper, Registerable {
  25         /**
  26          * "Cached" results for dabase for looking for unpublished entries
  27          */
  28         private $unpublishedEntriesInstance = NULL;
  29
  30         // Constants for database table names
  31         const DB_TABLE_NODE_DHT = 'node_dht';
  32
  33         // Constants for database column names
  34         const DB_COLUMN_NODE_ID            = 'node_id';
  35         const DB_COLUMN_SESSION_ID         = 'session_id';
  36         const DB_COLUMN_EXTERNAL_IP        = 'external_ip';
  37         const DB_COLUMN_LISTEN_PORT        = 'listen_port';
  38         const DB_COLUMN_PRIVATE_KEY_HASH   = 'private_key_hash';
  39         const DB_COLUMN_NODE_MODE          = 'node_mode';
  40         const DB_COLUMN_ACCEPTED_OBJECTS   = 'accepted_object_types';
  41         const DB_COLUMN_NODE_LIST          = 'node_list';
  42         const DB_COLUMN_PUBLICATION_STATUS = 'publication_status';
  43         const DB_COLUMN_ANSWER_STATUS      = 'answer_status';
  44         const DB_COLUMN_ACCEPT_BOOTSTRAP   = 'accept_bootstrap';
  45
  46         // Publication status'
  47         const PUBLICATION_STATUS_PENDING = 'PENDING';
  48
  49         // Exception codes
  50         const EXCEPTION_NODE_ALREADY_REGISTERED = 0x800;
  51         const EXCEPTION_NODE_NOT_REGISTERED     = 0x801;
  52
  53         /**
  54          * Protected constructor
  55          *
  56          * @return      void
  57          */
  58         protected function __construct () {
  59                 // Call parent constructor
  60                 parent::__construct(__CLASS__);
  61         }
  62
  63         /**
  64          * Creates an instance of this database wrapper by a provided user class
  65          *
  66          * @return      $wrapperInstance        An instance of the created wrapper class
  67          */
  68         public static final function createNodeDistributedHashTableDatabaseWrapper () {
  69                 // Get a new instance
  70                 $wrapperInstance = new NodeDistributedHashTableDatabaseWrapper();
  71
  72                 // Set (primary!) table name
  73                 $wrapperInstance->setTableName(self::DB_TABLE_NODE_DHT);
  74
  75                 // Return the instance
  76                 return $wrapperInstance;
  77         }
  78
  79         /**
  80          * Static getter for an array of all DHT database entries
  81          *
  82          * @return      $elements       All elements for the DHT dabase
  83          */
  84         public static final function getAllElements () {
  85                 // Create array and ...
  86                 $elements = array(
  87                         self::DB_COLUMN_NODE_ID,
  88                         self::DB_COLUMN_SESSION_ID,
  89                         self::DB_COLUMN_EXTERNAL_IP,
  90                         self::DB_COLUMN_LISTEN_PORT,
  91                         self::DB_COLUMN_PRIVATE_KEY_HASH,
  92                         self::DB_COLUMN_NODE_MODE,
  93                         self::DB_COLUMN_ACCEPTED_OBJECTS,
  94                         self::DB_COLUMN_NODE_LIST
  95                 );
  96
  97                 // ... return it
  98                 return $elements;
  99         }
 100
 101         /**
 102          * Prepares a search instance for given node data
 103          *
 104          * @param       $nodeData                       An array with valid node data
 105          * @return      $searchInstance         An instance of a SearchCriteria class
 106          */
 107         private function prepareSearchInstance (array $nodeData) {
 108                 // Assert on array elements
 109                 assert(isset($nodeData[self::DB_COLUMN_NODE_ID]));
 110
 111                 // Get instance
 112                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 113
 114                 // Search for node id and limit it to one entry
 115                 $searchInstance->addCriteria(self::DB_COLUMN_NODE_ID, $nodeData[self::DB_COLUMN_NODE_ID]);
 116                 $searchInstance->setLimit(1);
 117
 118                 // Return it
 119                 return $searchInstance;
 120         }
 121
 122         /**
 123          * Getter for result instance for unpublished entries
 124          *
 125          * @return      $unpublishedEntriesInstance             Result instance
 126          */
 127         public final function getUnpublishedEntriesInstance () {
 128                 return $this->unpublishedEntriesInstance;
 129         }
 130
 131         /**
 132          * Prepares a "local" instance of a StoreableCriteria class with all node
 133          * data for insert/update queries. This data set contains data from *this*
 134          * (local) node.
 135          *
 136          * @return      $dataSetInstance        An instance of a StoreableCriteria class
 137          */
 138         private function prepareLocalDataSetInstance () {
 139                 // Get node/request instances
 140                 $nodeInstance = NodeObjectFactory::createNodeInstance();
 141                 $requestInstance = ApplicationHelper::getSelfInstance()->getRequestInstance();
 142
 143                 // Get a dataset instance
 144                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_DHT));
 145
 146                 // Set the primary key
 147                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
 148
 149                 // Get ip:port combination and "explode" it
 150                 $ipPort = $nodeInstance->getAddressPortArray();
 151
 152                 // Make sure both is valid
 153                 assert(($ipPort[0] !== 'invalid') && ($ipPort[1] !== 'invalid'));
 154
 155                 // Get an array of all accepted object types
 156                 $objectList = $nodeInstance->getListFromAcceptedObjectTypes();
 157
 158                 // Make sure this is an array
 159                 assert(is_array($objectList));
 160
 161                 // Add public node data
 162                 $dataSetInstance->addCriteria(self::DB_COLUMN_NODE_MODE       , $requestInstance->getRequestElement('mode'));
 163                 $dataSetInstance->addCriteria(self::DB_COLUMN_EXTERNAL_IP     , $ipPort[0]);
 164                 $dataSetInstance->addCriteria(self::DB_COLUMN_LISTEN_PORT     , $ipPort[1]);
 165                 $dataSetInstance->addCriteria(self::DB_COLUMN_NODE_ID         , $nodeInstance->getNodeId());
 166                 $dataSetInstance->addCriteria(self::DB_COLUMN_SESSION_ID      , $nodeInstance->getSessionId());
 167                 $dataSetInstance->addCriteria(self::DB_COLUMN_PRIVATE_KEY_HASH, $nodeInstance->getPrivateKeyHash());
 168                 $dataSetInstance->addCriteria(self::DB_COLUMN_ACCEPTED_OBJECTS, implode(BaseHubNode::OBJECT_LIST_SEPARATOR, $objectList));
 169                 $dataSetInstance->addCriteria(self::DB_COLUMN_ACCEPT_BOOTSTRAP, $this->translateBooleanToYesNo($nodeInstance->isAcceptingDhtBootstrap()));
 170
 171                 // Return it
 172                 return $dataSetInstance;
 173         }
 174
 175         /**
 176          * Checks whether the local (*this*) node is registered in the DHT by
 177          * checking if the external ip/port is found.
 178          *
 179          * @return      $isRegistered   Whether *this* node is registered in the DHT
 180          */
 181         public function isLocalNodeRegistered () {
 182                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 183
 184                 // Get a search criteria instance
 185                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 186
 187                 // Get node instance
 188                 $nodeInstance = NodeObjectFactory::createNodeInstance();
 189
 190                 // Get ip:port combination and "explode" it
 191                 $ipPort = $nodeInstance->getAddressPortArray();
 192
 193                 /*
 194                  * Make sure both is not 'invalid' which means that the resolver
 195                  * didn't work.
 196                  */
 197                 assert(($ipPort[0] !== 'invalid') && ($ipPort[1] !== 'invalid'));
 198
 199                 // Add ip:port/node id as criteria
 200                 $searchInstance->addCriteria(self::DB_COLUMN_EXTERNAL_IP, $ipPort[0]);
 201                 $searchInstance->addCriteria(self::DB_COLUMN_LISTEN_PORT, $ipPort[1]);
 202                 $searchInstance->addCriteria(self::DB_COLUMN_NODE_ID    , $nodeInstance->getNodeId());
 203                 $searchInstance->setLimit(1);
 204
 205                 // Query database and get a result instance back
 206                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 207
 208                 // Cache result of if there is an entry, valid() will tell us if an entry is there
 209                 $isRegistered = $resultInstance->valid();
 210
 211                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: isRegistered=' . intval($isRegistered) . ' - EXIT!');
 212
 213                 // Return result
 214                 return $isRegistered;
 215         }
 216
 217         /**
 218          * Registeres the local (*this*) node with its data in the DHT.
 219          *
 220          * @return      void
 221          */
 222         public function registerLocalNode () {
 223                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 224
 225                 // Assert to make sure this method is called with no record in DB (the actual backend of the DHT)
 226                 assert(!$this->isLocalNodeRegistered());
 227
 228                 // Get prepared data set instance
 229                 $dataSetInstance = $this->prepareLocalDataSetInstance();
 230
 231                 // "Insert" this dataset instance completely into the database
 232                 $this->queryInsertDataSet($dataSetInstance);
 233
 234                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
 235         }
 236
 237         /**
 238          * Updates local (*this*) node's data in DHT, this is but not limited to the
 239          * session id, ip number (and/or hostname) and port number.
 240          *
 241          * @return      void
 242          */
 243         public function updateLocalNode () {
 244                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 245
 246                 // Assert to make sure this method is called with one record in DB (the actual backend of the DHT)
 247                 assert($this->isLocalNodeRegistered());
 248
 249                 // Get node instance
 250                 $nodeInstance = NodeObjectFactory::createNodeInstance();
 251
 252                 // Get search criteria
 253                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 254
 255                 // Search for node id and limit it to one entry
 256                 $searchInstance->addCriteria(self::DB_COLUMN_NODE_ID, $nodeInstance->getNodeId());
 257                 $searchInstance->setLimit(1);
 258
 259                 // Get a prepared dataset instance
 260                 $dataSetInstance = $this->prepareLocalDataSetInstance();
 261
 262                 // Set search instance
 263                 $dataSetInstance->setSearchInstance($searchInstance);
 264
 265                 // Update DHT database record
 266                 $this->queryUpdateDataSet($dataSetInstance);
 267
 268                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
 269         }
 270
 271         /**
 272          * Finds a node locally by given session id
 273          *
 274          * @param       $sessionId      Session id to lookup
 275          * @return      $nodeData       Node data array
 276          */
 277         public function findNodeLocalBySessionId ($sessionId) {
 278                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: sessionId=' . $sessionId . ' - CALLED!');
 279
 280                 // Get search criteria
 281                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 282
 283                 // Search for session id and limit it to one entry
 284                 $searchInstance->addCriteria(self::DB_COLUMN_SESSION_ID, $sessionId);
 285                 $searchInstance->setLimit(1);
 286
 287                 // Query database and get a result instance back
 288                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 289
 290                 // Return result instance
 291                 return $resultInstance;
 292         }
 293
 294         /**
 295          * Registeres a node by given message data.
 296          *
 297          * @param       $messageData            An array of all message data
 298          * @param       $handlerInstance        An instance of a Handleable class
 299          * @return      void
 300          */
 301         public function registerNodeByMessageData (array $messageData, Handleable $handlerInstance) {
 302                 // Get a data set instance
 303                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_DHT));
 304
 305                 // Set primary key (session id)
 306                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_SESSION_ID);
 307
 308                 // Add all array elements
 309                 $handlerInstance->addArrayToDataSet($dataSetInstance, $messageData);
 310
 311                 // Remove 'node_list'
 312                 $dataSetInstance->unsetCriteria(self::DB_COLUMN_NODE_LIST);
 313
 314                 // Run the "INSERT" query
 315                 $this->queryInsertDataSet($dataSetInstance);
 316         }
 317
 318         /**
 319          * Updates an existing entry in node list
 320          *
 321          * @param       $messageData            An array of all message data
 322          * @param       $handlerInstance        An instance of a Handleable class
 323          * @param       $searchInstance         An instance of LocalSearchCriteria class
 324          * @return      void
 325          */
 326         public function updateNodeByMessageData (array $messageData, Handleable $handlerInstance, LocalSearchCriteria $searchInstance) {
 327                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 328
 329                 // Get a data set instance
 330                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_DHT));
 331
 332                 // Add search instance
 333                 $dataSetInstance->setSearchInstance($searchInstance);
 334
 335                 // Set primary key (session id)
 336                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_SESSION_ID);
 337
 338                 // Add all array elements
 339                 $handlerInstance->addArrayToDataSet($dataSetInstance, $messageData);
 340
 341                 // Remove 'node_list'
 342                 $dataSetInstance->unsetCriteria(self::DB_COLUMN_NODE_LIST);
 343
 344                 // Run the "UPDATE" query
 345                 $this->queryUpdateDataSet($dataSetInstance);
 346
 347                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
 348         }
 349
 350         /**
 351          * Determines whether the given node data is already inserted in the DHT
 352          *
 353          * @param       $nodeData               An array with valid node data
 354          * @return      $isRegistered   Whether the given node data is already inserted
 355          */
 356         public function isNodeRegistered (array $nodeData) {
 357                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 358
 359                 // Assert on array elements
 360                 assert(isset($nodeData[self::DB_COLUMN_NODE_ID]));
 361
 362                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: node-id=' . $nodeData[self::DB_COLUMN_NODE_ID]);
 363
 364                 // Get search criteria
 365                 $searchInstance = $this->prepareSearchInstance($nodeData);
 366
 367                 // Query database and get a result instance back
 368                 $resultInstance = $this->doSelectByCriteria(
 369                         // Search instance
 370                         $searchInstance,
 371                         // Only look for these array elements ("keys")
 372                         array(
 373                                 self::DB_COLUMN_NODE_ID     => TRUE,
 374                                 self::DB_COLUMN_EXTERNAL_IP => TRUE,
 375                                 self::DB_COLUMN_LISTEN_PORT => TRUE,
 376                         )
 377                 );
 378
 379                 // Check if there is an entry
 380                 $isRegistered = $resultInstance->valid();
 381
 382                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: isRegistered=' . intval($isRegistered) . ' - EXIT!');
 383
 384                 // Return registration status
 385                 return $isRegistered;
 386         }
 387
 388         /**
 389          * Registers a node with given data in the DHT. If the node is already
 390          * registered this method shall throw an exception.
 391          *
 392          * @param       $nodeData       An array with valid node data
 393          * @return      void
 394          * @throws      NodeAlreadyRegisteredException  If the node is already registered
 395          */
 396         public function registerNode (array $nodeData) {
 397                 // Assert on array elements
 398                 assert(isset($nodeData[self::DB_COLUMN_NODE_ID]));
 399
 400                 // Is the node registered?
 401                 if ($this->isNodeRegistered($nodeData)) {
 402                         // Throw an exception
 403                         throw new NodeAlreadyRegisteredException(array($this, $nodeData), self::EXCEPTION_NODE_ALREADY_REGISTERED);
 404                 } // END - if
 405
 406                 // @TODO Unimplemented part
 407                 $this->partialStub('nodeData=' . print_r($nodeData, TRUE));
 408         }
 409
 410         /**
 411          * Updates a node's entry in the DHT with given data. This will enrich or
 412          * just update already exsiting data. If the node is not found this method
 413          * shall throw an exception.
 414          *
 415          * @param       $nodeData       An array with valid node data
 416          * @return      void
 417          * @throws      NodeDataMissingException        If the node's data is missing
 418          */
 419         public function updateNode (array $nodeData) {
 420                 // Assert on array elements
 421                 assert(isset($nodeData[self::DB_COLUMN_NODE_ID]));
 422
 423                 // Debug message
 424                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: Updating DHT entry for node-id=' . $nodeData[self::DB_COLUMN_NODE_ID] . ' ...');
 425
 426                 // Is the node registered?
 427                 if (!$this->isNodeRegistered($nodeData)) {
 428                         // No, then throw an exception
 429                         throw new NodeDataMissingException(array($this, $nodeData), self::EXCEPTION_NODE_NOT_REGISTERED);
 430                 } // END - if
 431
 432                 // Get a search instance
 433                 $searchInstance = $this->prepareSearchInstance($nodeData);
 434
 435                 // Get a data set instance
 436                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_DHT));
 437
 438                 // Add search instance
 439                 $dataSetInstance->setSearchInstance($searchInstance);
 440
 441                 // Set primary key (session id)
 442                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_SESSION_ID);
 443
 444                 // Get node instance
 445                 $nodeInstance = NodeObjectFactory::createNodeInstance();
 446
 447                 // Debug message
 448                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: nodeData=' . print_r($nodeData, TRUE));
 449
 450                 // Add all array elements
 451                 $nodeInstance->addArrayToDataSet($dataSetInstance, $nodeData);
 452
 453                 // Remove 'node_list'
 454                 $dataSetInstance->unsetCriteria(self::DB_COLUMN_NODE_LIST);
 455
 456                 // Run the "UPDATE" query
 457                 $this->queryUpdateDataSet($dataSetInstance);
 458         }
 459
 460         /**
 461          * Checks whether there are unpublished entries
 462          *
 463          * @return      $hasUnpublished         Whether there are unpublished entries
 464          * @todo        Add minimum/maximum age limitations
 465          */
 466         public function hasUnpublishedEntries () {
 467                 // Get search instance
 468                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 469
 470                 // Add exclusion key which is the publish status
 471                 $searchInstance->addExcludeCriteria(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_PUBLICATION_STATUS, NodeDistributedHashTableDatabaseWrapper::PUBLICATION_STATUS_PENDING);
 472
 473                 // Remember search instance
 474                 $this->setSearchInstance($searchInstance);
 475
 476                 // Run the query
 477                 $this->unpublishedEntriesInstance = $this->doSelectByCriteria($searchInstance);
 478
 479                 // Check pending entries
 480                 $hasUnpublished = $this->unpublishedEntriesInstance->valid();
 481
 482                 // Return it
 483                 return $hasUnpublished;
 484         }
 485
 486         /**
 487          * Initializes publication of DHT entries. This does only prepare
 488          * publication. The next step is to pickup such prepared entries and publish
 489          * them by uploading to other (recently appeared) DHT members.
 490          *
 491          * @return      void
 492          * @todo        Add timestamp to dataset instance
 493          */
 494         public function initEntryPublication () {
 495                 /*
 496                  * Make sure that hasUnpublishedEntries() has been called first by
 497                  * asserting on the "cached" object instance. This "caching" saves some
 498                  * needless queries as this method shall be called immediately after
 499                  * hasUnpublishedEntries() returns TRUE.
 500                  */
 501                 assert($this->unpublishedEntriesInstance instanceof SearchableResult);
 502
 503                 // Result is still okay?
 504                 assert($this->unpublishedEntriesInstance->valid());
 505
 506                 // Remove 'publication_status'
 507                 $this->getSearchInstance()->unsetCriteria(self::DB_COLUMN_PUBLICATION_STATUS);
 508
 509                 // Make sure all entries are marked as pending, first get a dataset instance.
 510                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_DHT));
 511
 512                 // Add search instance
 513                 $dataSetInstance->setSearchInstance($this->getSearchInstance());
 514
 515                 // Set primary key (node id)
 516                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
 517
 518                 // Add criteria (that should be set)
 519                 $dataSetInstance->addCriteria(self::DB_COLUMN_PUBLICATION_STATUS, self::PUBLICATION_STATUS_PENDING);
 520
 521                 // Run the "UPDATE" query
 522                 $this->queryUpdateDataSet($dataSetInstance);
 523         }
 524
 525         /**
 526          * Removes non-public data from given array.
 527          *
 528          * @param       $data   An array with possible non-public data that needs to be removed.
 529          * @return      $data   A cleaned up array with only public data.
 530          */
 531         public function removeNonPublicDataFromArray(array $data) {
 532                 // Currently call only inner method
 533                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: Calling parent::removeNonPublicDataFromArray(data) ...');
 534                 $data = parent::removeNonPublicDataFromArray($data);
 535                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: data[]=' . gettype($data));
 536
 537                 // Return cleaned data
 538                 return $data;
 539         }
 540
 541         /**
 542          * Find recipients for given package data and exclude the sender
 543          *
 544          * @param       $packageData    An array of valid package data
 545          * @return      $recipients             An indexed array with DHT recipients
 546          */
 547         public function getResultFromExcludedSender (array $packageData) {
 548                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 549
 550                 // Assert on required array field
 551                 assert(isset($packageData[NetworkPackage::PACKAGE_DATA_SENDER]));
 552
 553                 // Get max recipients
 554                 $maxRecipients = $this->getConfigInstance()->getConfigEntry('max_dht_recipients');
 555
 556                 // First creata a search instance
 557                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 558
 559                 // Then exclude 'sender' field as the sender is the current (*this*) node
 560                 $searchInstance->addExcludeCriteria(NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_SESSION_ID, $packageData[NetworkPackage::PACKAGE_DATA_SENDER]);
 561
 562                 // Set limit to maximum DHT recipients
 563                 $searchInstance->setLimit($maxRecipients);
 564
 565                 // Get a result instance back from DHT database wrapper.
 566                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 567
 568                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
 569
 570                 // Return result instance
 571                 return $resultInstance;
 572         }
 573
 574         /**
 575          * Find recopients by given key/value pair. First look for the key and if it
 576          * matches, compare the value.
 577          *
 578          * @param       $key                    Key to look for
 579          * @param       $value                  Value to compare if key matches
 580          * @return      $recipients             An indexed array with DHT recipients
 581          */
 582         public function getResultFromKeyValue ($key, $value) {
 583                 // Get max recipients
 584                 $maxRecipients = $this->getConfigInstance()->getConfigEntry('max_dht_recipients');
 585
 586                 // First creata a search instance
 587                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 588
 589                 // Find the key/value pair
 590                 $searchInstance->addCriteria($key, $value);
 591
 592                 // Get a result instance back from DHT database wrapper.
 593                 $resultInstance = $this->doSelectByCriteria($searchInstance);
 594
 595                 // Return result instance
 596                 return $resultInstance;
 597         }
 598
 599         /**
 600          * Enable DHT bootstrap request acceptance for local node
 601          *
 602          * @return      void
 603          */
 604         public function enableAcceptDhtBootstrap () {
 605                 // Debug message
 606                 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: Enabling DHT bootstrap requests ...');
 607
 608                 // Is the node already registered?
 609                 if ($this->isLocalNodeRegistered()) {
 610                         // Just update our record
 611                         $this->updateLocalNode();
 612                 } else {
 613                         // Register it
 614                         $this->registerLocalNode();
 615                 }
 616         }
 617 }
 618
 619 // [EOF]
 620 ?>