3 * A Node DHT facade class
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
24 class NodeDhtFacade extends BaseDht implements DistributableNode, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $dhtInstance An instance of a Distributable class
40 public final static function createNodeDhtFacade () {
42 $dhtInstance = new NodeDhtFacade();
44 // Get a database wrapper instance
45 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_dht_db_wrapper_class');
47 // Set it in this class
48 $dhtInstance->setWrapperInstance($wrapperInstance);
50 // Return the prepared instance
55 * Registers/updates an entry in the DHT with given data from $dhtData
56 * array. Different DHT implemtations may handle this differently as they
57 * may enrich the data with more meta data.
59 * @param $dhtData A valid array with DHT-related data (e.g. node/peer data)
61 * @todo Does this data need to be enriched with more meta data?
63 protected function insertDataIntoDht (array $dhtData) {
64 // Check if there is already an entry for given node_id
65 if ($this->getWrapperInstance()->isNodeRegistered($dhtData)) {
67 * Update existing record. Please note that this step is not secure
68 * (e.g. DHT poisoning) it would be good to implement some checks if
69 * the both node owner trust each other (see sub-project 'DSHT').
71 $this->getWrapperInstance()->updateNode($dhtData);
74 * Inserts given node data into the DHT. As above, this step does
75 * currently not perform any security checks.
77 $this->getWrapperInstance()->registerNode($dhtData);
82 * Initializes the distributed hash table (DHT)
86 public function initDht () {
87 // Is the local node registered?
88 if ($this->getWrapperInstance()->isLocalNodeRegistered()) {
89 // Then only update session id
90 $this->getWrapperInstance()->updateLocalNode();
93 $this->getWrapperInstance()->registerLocalNode();
97 $this->getStateInstance()->dhtHasInitialized();
101 * Bootstraps the DHT by sending out a message to all available nodes
102 * (including itself). This step helps the node to get to know more nodes
103 * which can be queried later for object distribution.
107 public function bootstrapDht () {
108 // Get a helper instance
109 $helperInstance = ObjectFactory::createObjectByConfiguredName('dht_bootstrap_helper_class');
111 // Load the announcement descriptor
112 $helperInstance->loadDescriptorXml($this);
114 // Compile all variables
115 $helperInstance->getTemplateInstance()->compileConfigInVariables();
117 // "Publish" the descriptor by sending it to the bootstrap/list nodes
118 $helperInstance->sendPackage($this);
121 $this->getStateInstance()->dhtIsBooting();
125 * Finds a node locally by given session id
127 * @param $sessionId Session id to lookup
128 * @return $nodeData Node-data array
130 public function findNodeLocalBySessionId ($sessionId) {
131 // Default is empty data array
135 * Call the wrapper to do the job and get back a result instance. There
136 * will come back zero or one entry from the wrapper.
138 $resultInstance = $this->getWrapperInstance()->findNodeLocalBySessionId($sessionId);
140 // Make sure the result instance is valid
141 assert($resultInstance instanceof SearchableResult);
142 assert($resultInstance->valid());
144 // Is the next entry valid?
145 if (($resultInstance->valid()) && ($resultInstance->next())) {
147 * Then load the first entry (more entries are being ignored and
148 * should not happen).
150 $nodeData = $resultInstance->current();
158 * Registers an other node with this node by given message data. The
159 * following data must always be present:
161 * - session-id (for finding the node's record together with below data)
162 * - external-ip (hostname or IP number)
163 * - listen-port (TCP/UDP listen port for inbound connections)
165 * @param $messageArray An array with all minimum message data
166 * @param $handlerInstance An instance of a Handleable class
167 * @param $forceUpdate Optionally force update, don't register (default: register if not found)
169 * @throws NodeSessionIdVerficationException If the node was not found and update is forced
171 public function registerNodeByMessageData (array $messageData, Handleable $handlerInstance, $forceUpdate = FALSE) {
172 // Get a search criteria class
173 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
176 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: state=' . $this->getPrintableState() . ',messageData=' . print_r($messageData, TRUE) . ',handlerInstance=' . $handlerInstance->__toString() . ',forceUpdate=' . intval($forceUpdate) . ',count(getSearchData())=' . count($handlerInstance->getSearchData()));
178 // Search for the node's session id and external IP/hostname + TCP/UDP listen port
179 foreach ($handlerInstance->getSearchData() as $key) {
181 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: state=' . $this->getPrintableState() . ',key=' . $key);
184 assert(isset($messageData[$key]));
187 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: state=' . $this->getPrintableState() . ',messageData[' . $key . ']=' . $messageData[$key]);
190 $searchInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
193 // Only one entry is fine
194 $searchInstance->setLimit(1);
197 $resultInstance = $this->getWrapperInstance()->doSelectByCriteria($searchInstance);
199 // Make sure the result instance is valid
200 assert($resultInstance instanceof SearchableResult);
202 // Is there already an entry?
203 if ($resultInstance->valid()) {
204 // Entry found, so update it
205 $this->getWrapperInstance()->updateNodeByMessageData($messageData, $handlerInstance, $searchInstance);
206 } elseif ($forceUpdate === FALSE) {
207 // Nothing found, so register it
208 $this->getWrapperInstance()->registerNodeByMessageData($messageData, $handlerInstance);
211 * Do not register non-existent nodes here. This is maybe fatal,
212 * caused by "stolen" session id and/or not matching IP
213 * number/port combination.
215 throw new NodeSessionIdVerficationException(array($this, $messageData), BaseHubSystem::EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING);
218 // Save last exception
219 $handlerInstance->setLastException($this->getWrapperInstance()->getLastException());
223 * Queries the local DHT data(base) for a node list with all supported
224 * object types except the node by given session id.
226 * @param $messageData An array with message data from a node_list request
227 * @param $handlerInstance An instance of a Handleable class
228 * @param $excludeKey Array key which should be excluded
229 * @param $andKey Array of $separator-separated list of elements which all must match
230 * @param $separator Sepator char (1st parameter for explode() call)
231 * @return $nodeList An array with all found nodes
233 public function queryLocalNodeListExceptByMessageData (array $messageData, Handleable $handlerInstance, $excludeKey, $andKey, $separator) {
234 // Make sure both keys are there
235 assert((isset($messageData[$excludeKey])) && (isset($messageData[$andKey])));
238 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: state=' . $this->getPrintableState() . ',messageData=' . print_r($messageData, TRUE));
240 // Get a search criteria class
241 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
244 foreach (explode($separator, $messageData[$andKey]) as $criteria) {
246 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: andKey=' . $andKey . ',criteria=' . $criteria);
248 // Add it and leave any 'my-' prefix out
249 $searchInstance->addChoiceCriteria(str_replace('my-', '', $andKey), $criteria);
253 $searchInstance->addExcludeCriteria(str_replace('my-', '', $excludeKey), $messageData[$excludeKey]);
255 // Only X entries are fine
256 $searchInstance->setLimit($this->getConfigInstance()->getConfigEntry('node_dht_list_limit'));
259 $resultInstance = $this->getWrapperInstance()->doSelectByCriteria($searchInstance);
261 // Make sure the result instance is valid
262 assert($resultInstance instanceof SearchableResult);
263 assert($resultInstance->valid());
269 while ($resultInstance->next()) {
270 // Get current element (it should be an array, and have at least 1 entry)
271 $current = $resultInstance->current();
272 assert(is_array($current));
273 assert(count($current) > 0);
276 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: current(' . count($current) . ')[' . gettype($current) . ']=' . print_r($current, TRUE));
279 * Remove some keys as they should not be published.
281 unset($current[$this->getWrapperInstance()->getIndexKey()]);
284 array_push($nodeList, $current);
287 // Save last exception
288 $handlerInstance->setLastException($this->getWrapperInstance()->getLastException());
290 // Return node list (array)
295 * Inserts given node list array (from earlier database result produced by
296 * an other node) into the DHT. This array origins from above method
297 * queryLocalNodeListExceptByMessageData().
299 * @param $nodeList An array from an earlier database result instance
302 public function insertNodeList (array $nodeList) {
303 // If no node is in the list (array), skip the rest of this method
304 if (count($nodeList) == 0) {
306 self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: No node record has been returned.');
312 // Put them all into a stack
313 foreach ($nodeList as $nodeData) {
314 // Insert all entries
315 $this->getStackInstance()->pushNamed(self::STACKER_NAME_INSERT_NODE, $nodeData);
320 * Find recipients for given package data
322 * @param $packageData An array of valid package data
323 * @return $recipients An indexed array with DHT recipients
325 public function findRecipientsByPackageData (array $packageData) {
326 // Query get a result instance back from DHT database wrapper.
327 $resultInstance = $this->getWrapperInstance()->getResultFromExcludedSender($packageData);
329 // Make sure the result instance is valid
330 assert($resultInstance instanceof SearchableResult);
333 if (!$resultInstance->valid()) {
334 // Then skip below loop
339 $recipients = array();
341 // Search for all recipients
342 while ($resultInstance->next()) {
344 $current = $resultInstance->current();
345 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DHT-FACADE[' . __METHOD__ . ':' . __LINE__ . ']: current=' . print_r($current, TRUE));
347 // Add instance to recipient list
348 array_push($recipients, $current);
351 // Return filled array
356 * Finds DHT recipients by given key/value pair
358 * @param $key Key to search for
359 * @param $value Value to check on found key
360 * @return $recipiens Array with DHT recipients from given key/value pair
362 public function findRecipientsByKey ($key, $value) {
363 // Look for all suitable nodes
364 $resultInstance = $this->getWrapperInstance()->getResultFromKeyValue($key, $value);
366 // Make sure the result instance is valid
367 assert($resultInstance instanceof SearchableResult);
368 assert($resultInstance->valid());
371 $recipients = array();
373 // "Walk" through all entries
374 while ($resultInstance->next()) {
376 $current = $resultInstance->current();
378 // Add instance to recipient list
379 array_push($recipients, $current);
382 // Return filled array