]> git.mxchange.org Git - quix0rs-apt-p2p.git/blobdiff - apt_dht_Khashmir/DHT.py
DHT normalizes key lengths by chopping or adding 0.
[quix0rs-apt-p2p.git] / apt_dht_Khashmir / DHT.py
index 78d913b225767dc581a0326f38101245491430b7..42e2e9afd4489f33a1ddc385f1938b18301f5ec4 100644 (file)
 
+import os, sha, random
+
+from twisted.internet import defer, reactor
+from twisted.internet.abstract import isIPAddress
+from twisted.trial import unittest
 from zope.interface import implements
 
 from apt_dht.interfaces import IDHT
+from khashmir import Khashmir
+
+class DHTError(Exception):
+    """Represents errors that occur in the DHT."""
 
 class DHT:
     
     implements(IDHT)
     
     def __init__(self):
-        pass
\ No newline at end of file
+        self.config = None
+        self.cache_dir = ''
+        self.bootstrap = []
+        self.bootstrap_node = False
+        self.joining = None
+        self.joined = False
+        self.storing = {}
+        self.retrieving = {}
+        self.retrieved = {}
+    
+    def loadConfig(self, config, section):
+        """See L{apt_dht.interfaces.IDHT}."""
+        self.config_parser = config
+        self.section = section
+        self.config = {}
+        self.cache_dir = self.config_parser.get('DEFAULT', 'cache_dir')
+        self.bootstrap = self.config_parser.getstringlist(section, 'BOOTSTRAP')
+        self.bootstrap_node = self.config_parser.getboolean(section, 'BOOTSTRAP_NODE')
+        for k in self.config_parser.options(section):
+            if k in ['K', 'HASH_LENGTH', 'CONCURRENT_REQS', 'STORE_REDUNDANCY', 
+                     'MAX_FAILURES', 'PORT']:
+                self.config[k] = self.config_parser.getint(section, k)
+            elif k in ['CHECKPOINT_INTERVAL', 'MIN_PING_INTERVAL', 
+                       'BUCKET_STALENESS', 'KEINITIAL_DELAY', 'KE_DELAY', 'KE_AGE']:
+                self.config[k] = self.config_parser.gettime(section, k)
+            else:
+                self.config[k] = self.config_parser.get(section, k)
+        if 'PORT' not in self.config:
+            self.config['PORT'] = self.config_parser.getint('DEFAULT', 'PORT')
+    
+    def join(self):
+        """See L{apt_dht.interfaces.IDHT}."""
+        if self.config is None:
+            raise DHTError, "configuration not loaded"
+        if self.joining:
+            raise DHTError, "a join is already in progress"
+
+        self.khashmir = Khashmir(self.config, self.cache_dir)
+        
+        self.joining = defer.Deferred()
+        for node in self.bootstrap:
+            host, port = node.rsplit(':', 1)
+            port = int(port)
+            if isIPAddress(host):
+                self._join_gotIP(host, port)
+            else:
+                reactor.resolve(host).addCallback(self._join_gotIP, port)
+        
+        return self.joining
+
+    def _join_gotIP(self, ip, port):
+        """Called after an IP address has been found for a single bootstrap node."""
+        self.khashmir.addContact(ip, port, self._join_single)
+    
+    def _join_single(self):
+        """Called when a single bootstrap node has been added."""
+        self.khashmir.findCloseNodes(self._join_complete)
+    
+    def _join_complete(self, result):
+        """Called when the tables have been initialized with nodes."""
+        if not self.joined:
+            self.joined = True
+            if len(result) > 0 or self.bootstrap_node:
+                df = self.joining
+                self.joining = None
+                df.callback(result)
+            else:
+                df = self.joining
+                self.joining = None
+                df.errback(DHTError('could not find any nodes to bootstrap to'))
+        
+    def leave(self):
+        """See L{apt_dht.interfaces.IDHT}."""
+        if self.config is None:
+            raise DHTError, "configuration not loaded"
+        
+        if self.joined or self.joining:
+            if self.joining:
+                self.joining.errback(DHTError('still joining when leave was called'))
+                self.joining = None
+            self.joined = False
+            self.khashmir.shutdown()
+        
+    def normalizeKey(self, key):
+        """Normalize a key's length suitable for insertion in the DHT."""
+        key_bytes = (self.config['HASH_LENGTH'] - 1) // 8 + 1
+        if len(key) < key_bytes:
+            key = key + '\000'*(key_bytes - len(key))
+        elif len(key) > key_bytes:
+            key = key[:key_bytes]
+        return key
+    
+    def getValue(self, key):
+        """See L{apt_dht.interfaces.IDHT}."""
+        if self.config is None:
+            raise DHTError, "configuration not loaded"
+        if not self.joined:
+            raise DHTError, "have not joined a network yet"
+
+        d = defer.Deferred()
+        key = self.normalizeKey(key)
+        if key not in self.retrieving:
+            self.khashmir.valueForKey(key, self._getValue)
+        self.retrieving.setdefault(key, []).append(d)
+        return d
+        
+    def _getValue(self, key, result):
+        if result:
+            self.retrieved.setdefault(key, []).extend(result)
+        else:
+            final_result = []
+            if key in self.retrieved:
+                final_result = self.retrieved[key]
+                del self.retrieved[key]
+            for i in range(len(self.retrieving[key])):
+                d = self.retrieving[key].pop(0)
+                d.callback(final_result)
+            del self.retrieving[key]
+
+    def storeValue(self, key, value):
+        """See L{apt_dht.interfaces.IDHT}."""
+        if self.config is None:
+            raise DHTError, "configuration not loaded"
+        if not self.joined:
+            raise DHTError, "have not joined a network yet"
+
+        key = self.normalizeKey(key)
+        if key in self.storing and value in self.storing[key]:
+            raise DHTError, "already storing that key with the same value"
+
+        d = defer.Deferred()
+        self.khashmir.storeValueForKey(key, value, self._storeValue)
+        self.storing.setdefault(key, {})[value] = d
+        return d
+    
+    def _storeValue(self, key, value, result):
+        if key in self.storing and value in self.storing[key]:
+            if len(result) > 0:
+                self.storing[key][value].callback(result)
+            else:
+                self.storing[key][value].errback(DHTError('could not store value %s in key %s' % (value, key)))
+            del self.storing[key][value]
+            if len(self.storing[key].keys()) == 0:
+                del self.storing[key]
+
+class TestSimpleDHT(unittest.TestCase):
+    """Unit tests for the DHT."""
+    
+    timeout = 2
+    DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
+                    'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
+                    'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
+                    'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
+                    'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
+                    'KE_AGE': 3600, }
+
+    def setUp(self):
+        self.a = DHT()
+        self.b = DHT()
+        self.a.config = self.DHT_DEFAULTS.copy()
+        self.a.config['PORT'] = 4044
+        self.a.bootstrap = ["127.0.0.1:4044"]
+        self.a.bootstrap_node = True
+        self.a.cache_dir = '/tmp'
+        self.b.config = self.DHT_DEFAULTS.copy()
+        self.b.config['PORT'] = 4045
+        self.b.bootstrap = ["127.0.0.1:4044"]
+        self.b.cache_dir = '/tmp'
+        
+    def test_normalizeKey(self):
+        self.failUnless(self.a.normalizeKey('12345678901234567890') == '12345678901234567890')
+        self.failUnless(self.a.normalizeKey('12345678901234567') == '12345678901234567\000\000\000')
+        self.failUnless(self.a.normalizeKey('1234567890123456789012345') == '12345678901234567890')
+        self.failUnless(self.a.normalizeKey('1234567890123456789') == '1234567890123456789\000')
+        self.failUnless(self.a.normalizeKey('123456789012345678901') == '12345678901234567890')
+    
+    def test_bootstrap_join(self):
+        d = self.a.join()
+        return d
+        
+    def node_join(self, result):
+        d = self.b.join()
+        return d
+    
+    def test_join(self):
+        self.lastDefer = defer.Deferred()
+        d = self.a.join()
+        d.addCallback(self.node_join)
+        d.addCallback(self.lastDefer.callback)
+        return self.lastDefer
+
+    def value_stored(self, result, value):
+        self.stored -= 1
+        if self.stored == 0:
+            self.get_values()
+        
+    def store_values(self, result):
+        self.stored = 3
+        d = self.a.storeValue(sha.new('4045').digest(), str(4045*3))
+        d.addCallback(self.value_stored, 4045)
+        d = self.a.storeValue(sha.new('4044').digest(), str(4044*2))
+        d.addCallback(self.value_stored, 4044)
+        d = self.b.storeValue(sha.new('4045').digest(), str(4045*2))
+        d.addCallback(self.value_stored, 4045)
+
+    def check_values(self, result, values):
+        self.checked -= 1
+        self.failUnless(len(result) == len(values))
+        for v in result:
+            self.failUnless(v in values)
+        if self.checked == 0:
+            self.lastDefer.callback(1)
+    
+    def get_values(self):
+        self.checked = 4
+        d = self.a.getValue(sha.new('4044').digest())
+        d.addCallback(self.check_values, [str(4044*2)])
+        d = self.b.getValue(sha.new('4044').digest())
+        d.addCallback(self.check_values, [str(4044*2)])
+        d = self.a.getValue(sha.new('4045').digest())
+        d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
+        d = self.b.getValue(sha.new('4045').digest())
+        d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
+
+    def test_store(self):
+        from twisted.internet.base import DelayedCall
+        DelayedCall.debug = True
+        self.lastDefer = defer.Deferred()
+        d = self.a.join()
+        d.addCallback(self.node_join)
+        d.addCallback(self.store_values)
+        return self.lastDefer
+
+    def tearDown(self):
+        self.a.leave()
+        try:
+            os.unlink(self.a.khashmir.db)
+        except:
+            pass
+        self.b.leave()
+        try:
+            os.unlink(self.b.khashmir.db)
+        except:
+            pass
+
+class TestMultiDHT(unittest.TestCase):
+    
+    timeout = 60
+    num = 20
+    DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
+                    'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
+                    'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
+                    'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
+                    'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
+                    'KE_AGE': 3600, }
+
+    def setUp(self):
+        self.l = []
+        self.startport = 4081
+        for i in range(self.num):
+            self.l.append(DHT())
+            self.l[i].config = self.DHT_DEFAULTS.copy()
+            self.l[i].config['PORT'] = self.startport + i
+            self.l[i].bootstrap = ["127.0.0.1:" + str(self.startport)]
+            self.l[i].cache_dir = '/tmp'
+        self.l[0].bootstrap_node = True
+        
+    def node_join(self, result, next_node):
+        d = self.l[next_node].join()
+        if next_node + 1 < len(self.l):
+            d.addCallback(self.node_join, next_node + 1)
+        else:
+            d.addCallback(self.lastDefer.callback)
+    
+    def test_join(self):
+        self.timeout = 2
+        self.lastDefer = defer.Deferred()
+        d = self.l[0].join()
+        d.addCallback(self.node_join, 1)
+        return self.lastDefer
+        
+    def value_stored(self, result, value):
+        self.stored -= 1
+        if self.stored == 0:
+            self.get_values()
+        
+    def store_values(self, result):
+        self.stored = 0
+        for i in range(len(self.l)):
+            for j in range(0, i+1):
+                self.stored += 1
+                d = self.l[j].storeValue(sha.new(str(self.startport+i)).digest(), str((self.startport+i)*(j+1)))
+                d.addCallback(self.value_stored, self.startport+i)
+    
+    def check_values(self, result, values):
+        self.checked -= 1
+        self.failUnless(len(result) == len(values))
+        for v in result:
+            self.failUnless(v in values)
+        if self.checked == 0:
+            self.lastDefer.callback(1)
+    
+    def get_values(self):
+        self.checked = 0
+        for i in range(len(self.l)):
+            for j in random.sample(xrange(len(self.l)), 4):
+                self.checked += 1
+                d = self.l[i].getValue(sha.new(str(self.startport+j)).digest())
+                check = []
+                for k in range(self.startport+j, (self.startport+j)*(j+1)+1, self.startport+j):
+                    check.append(str(k))
+                d.addCallback(self.check_values, check)
+
+    def store_join(self, result, next_node):
+        d = self.l[next_node].join()
+        if next_node + 1 < len(self.l):
+            d.addCallback(self.store_join, next_node + 1)
+        else:
+            d.addCallback(self.store_values)
+    
+    def test_store(self):
+        from twisted.internet.base import DelayedCall
+        DelayedCall.debug = True
+        self.lastDefer = defer.Deferred()
+        d = self.l[0].join()
+        d.addCallback(self.store_join, 1)
+        return self.lastDefer
+
+    def tearDown(self):
+        for i in self.l:
+            try:
+                i.leave()
+                os.unlink(i.khashmir.db)
+            except:
+                pass