apt_p2p_Khashmir/util.py

   1 ## Copyright 2002-2003 Andrew Loewenstern, All Rights Reserved
   2 # see LICENSE.txt for license information
   3
   4 """Some utitlity functions for use in apt-p2p's khashmir DHT."""
   5
   6 from twisted.trial import unittest
   7
   8 def bucket_stats(l):
   9     """Given a list of khashmir instances, finds min, max, and average number of nodes in tables."""
  10     max = avg = 0
  11     min = None
  12     def count(buckets):
  13         c = 0
  14         for bucket in buckets:
  15             c = c + len(bucket.l)
  16         return c
  17     for node in l:
  18         c = count(node.table.buckets)
  19         if min == None:
  20             min = c
  21         elif c < min:
  22             min = c
  23         if c > max:
  24             max = c
  25         avg = avg + c
  26     avg = avg / len(l)
  27     return {'min':min, 'max':max, 'avg':avg}
  28
  29 def uncompact(s):
  30     """Extract the contact info from a compact node representation.
  31
  32     @type s: C{string}
  33     @param s: the compact representation
  34     @rtype: C{dictionary}
  35     @return: the node ID, IP address and port to contact the node on
  36     @raise ValueError: if the compact representation doesn't exist
  37     """
  38     if (len(s) != 26):
  39         raise ValueError
  40     id = s[:20]
  41     host = '.'.join([str(ord(i)) for i in s[20:24]])
  42     port = (ord(s[24]) << 8) | ord(s[25])
  43     return {'id': id, 'host': host, 'port': port}
  44
  45 def compact(id, host, port):
  46     """Create a compact representation of node contact info.
  47
  48     @type id: C{string}
  49     @param id: the node ID
  50     @type host: C{string}
  51     @param host: the IP address of the node
  52     @type port: C{int}
  53     @param port: the port number to contact the node on
  54     @rtype: C{string}
  55     @return: the compact representation
  56     @raise ValueError: if the compact representation doesn't exist
  57     """
  58
  59     s = id + ''.join([chr(int(i)) for i in host.split('.')]) + \
  60           chr((port & 0xFF00) >> 8) + chr(port & 0xFF)
  61     if len(s) != 26:
  62         raise ValueError
  63     return s
  64
  65 class TestUtil(unittest.TestCase):
  66     """Tests for the utilities."""
  67
  68     timeout = 5
  69     myid = '\xca\xec\xb8\x0c\x00\xe7\x07\xf8~])\x8f\x9d\xe5_B\xff\x1a\xc4!'
  70     host = '165.234.1.34'
  71     port = 61234
  72
  73     def test_compact(self):
  74         d = uncompact(compact(self.myid, self.host, self.port))
  75         self.failUnlessEqual(d['id'], self.myid)
  76         self.failUnlessEqual(d['host'], self.host)
  77         self.failUnlessEqual(d['port'], self.port)
  78