Added exceptions + some code:

[hub.git] / application / hub / main / database / wrapper / node / class_NodeDistributedHashTableDatabaseWrapper.php

diff --git a/application/hub/main/database/wrapper/node/class_NodeDistributedHashTableDatabaseWrapper.php b/application/hub/main/database/wrapper/node/class_NodeDistributedHashTableDatabaseWrapper.php
index dc494d5bc59fe78c3d84ffbe2417dbd50987f508..0beb31c0d3f02e1f81520bb205ab4824279a1b51 100644 (file)
--- a/application/hub/main/database/wrapper/node/class_NodeDistributedHashTableDatabaseWrapper.php
+++ b/application/hub/main/database/wrapper/node/class_NodeDistributedHashTableDatabaseWrapper.php
@@ -32,7 +32,13 @@ class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implem
        const DB_COLUMN_LISTEN_PORT      = 'listen_port';
        const DB_COLUMN_PRIVATE_KEY      = 'private_key';
        const DB_COLUMN_PRIVATE_KEY_HASH = 'private_key_hash';
-       const DB_COLUMN_NODE_TYPE        = 'node_type';
+       const DB_COLUMN_NODE_MODE        = 'node_mode';
+       const DB_COLUMN_ACCEPTED_OBJECTS = 'accepted_object_types';
+       const DB_COLUMN_NODE_LIST        = 'node_list';
+
+       // Exception codes
+       const EXCEPTION_NODE_ALREADY_REGISTERED = 0x800;
+       const EXCEPTION_NODE_NOT_REGISTERED     = 0x801;
 
        /**
         * Protected constructor
@@ -84,13 +90,20 @@ class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implem
                // Make sure both is valid
                assert(($ipPort[0] !== 'invalid') && ($ipPort[1] !== 'invalid'));
 
+               // Get an array of all accepted object types
+               $objectList = $nodeInstance->getListFromAcceptedObjectTypes();
+
+               // Make sure this is an array
+               assert(is_array($objectList));
+
                // Add public node data
-               $dataSetInstance->addCriteria(self::DB_COLUMN_NODE_TYPE       , $requestInstance->getRequestElement('mode'));
+               $dataSetInstance->addCriteria(self::DB_COLUMN_NODE_MODE       , $requestInstance->getRequestElement('mode'));
                $dataSetInstance->addCriteria(self::DB_COLUMN_EXTERNAL_IP     , $ipPort[0]);
                $dataSetInstance->addCriteria(self::DB_COLUMN_LISTEN_PORT     , $ipPort[1]);
                $dataSetInstance->addCriteria(self::DB_COLUMN_NODE_ID         , $nodeInstance->getNodeId());
                $dataSetInstance->addCriteria(self::DB_COLUMN_SESSION_ID      , $nodeInstance->getSessionId());
                $dataSetInstance->addCriteria(self::DB_COLUMN_PRIVATE_KEY_HASH, $nodeInstance->getPrivateKeyHash());
+               $dataSetInstance->addCriteria(self::DB_COLUMN_ACCEPTED_OBJECTS, implode(BaseHubNode::OBJECT_LIST_SEPARATOR, $objectList));
 
                // Return it
                return $dataSetInstance;
@@ -114,7 +127,10 @@ class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implem
                        // Get ip:port combination and "explode" it
                        $ipPort = $nodeInstance->getAddressPortArray();
 
-                       // Make sure both is valid
+                       /*
+                        * Make sure both is not 'invalid' which means that the resolver
+                        * didn't work.
+                        */
                        assert(($ipPort[0] !== 'invalid') && ($ipPort[1] !== 'invalid'));
 
                        // Add ip:port/node id as criteria
@@ -126,8 +142,8 @@ class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implem
                        // Query database and get a result instance back
                        $resultInstance = $this->doSelectByCriteria($searchInstance);
 
-                       // Cache result of if there is an entry, next() will tell us if the next entry is valid
-                       $GLOBALS[__METHOD__] = $resultInstance->next();
+                       // Cache result of if there is an entry, valid() will tell us if an entry is there
+                       $GLOBALS[__METHOD__] = $resultInstance->valid();
                } // END - if
 
                // Return result
@@ -218,6 +234,9 @@ class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implem
                // Add all array elements
                $handlerInstance->addArrayToDataSet($dataSetInstance, $messageData);
 
+               // Remove 'node_list'
+               $dataSetInstance->unsetCriteria(self::DB_COLUMN_NODE_LIST);
+
                // Run the "INSERT" query
                $this->queryInsertDataSet($dataSetInstance);
        }
@@ -243,9 +262,75 @@ class NodeDistributedHashTableDatabaseWrapper extends BaseDatabaseWrapper implem
                // Add all array elements
                $handlerInstance->addArrayToDataSet($dataSetInstance, $messageData);
 
+               // Remove 'node_list'
+               $dataSetInstance->unsetCriteria(self::DB_COLUMN_NODE_LIST);
+
                // Run the "UPDATE" query
                $this->queryUpdateDataSet($dataSetInstance);
        }
+
+       /**
+        * Determines whether the given node data is already inserted in the DHT
+        *
+        * @param       $nodeData               An array with valid node data
+        * @return      $isRegistered   Whether the given node data is already inserted
+        */
+       public function isNodeRegistered (array $nodeData) {
+               // Get search criteria
+               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
+
+               // Search for node id and limit it to one entry
+               $searchInstance->addCriteria(self::DB_COLUMN_NODE_ID, $nodeData[self::DB_COLUMN_NODE_ID]);
+               $searchInstance->setLimit(1);
+
+               // Query database and get a result instance back
+               $resultInstance = $this->doSelectByCriteria($searchInstance);
+
+               // Check if there is an entry
+               $isRegistered = $resultInstance->valid();
+
+               // Return registration status
+               return $isRegistered;
+       }
+
+       /**
+        * Registers a node with given data in the DHT. If the node is already
+        * registered this method shall throw an exception.
+        *
+        * @param       $nodeData       An array with valid node data
+        * @return      void
+        * @throws      NodeAlreadyRegisteredException  If the node is already registered
+        */
+       public function registerNode (array $nodeData) {
+               // Is the node registered?
+               if ($this->isNodeRegistered($nodeData)) {
+                       // Throw an exception
+                       throw new NodeAlreadyRegisteredException(array($this, $nodeData), self::EXCEPTION_NODE_ALREADY_REGISTERED);
+               } // END - if
+
+               // @TODO Unimplemented part
+               $this->partialStub('nodeData=' . print_r($nodeData, TRUE));
+       }
+
+       /**
+        * Updates a node's entry in the DHT with given data. This will enrich or
+        * just update already exsiting data. If the node is not found this method
+        * shall throw an exception.
+        *
+        * @param       $nodeData       An array with valid node data
+        * @return      void
+        * @throws      NodeDataMissingException        If the node's data is missing
+        */
+       public function updateNode (array $nodeData) {
+               // Is the node registered?
+               if (!$this->isNodeRegistered($nodeData)) {
+                       // No, then throw an exception
+                       throw new NodeDataMissingException(array($this, $nodeData), self::EXCEPTION_NODE_NOT_REGISTERED);
+               } // END - if
+
+               // @TODO Unimplemented part
+               $this->partialStub('nodeData=' . print_r($nodeData, TRUE));
+       }
 }
 
 // [EOF]