3fad6259f43cb55fc5367d68d31b7936ea017a6a
[quix0rs-apt-p2p.git] / apt_dht / apt_dht_conf.py
1
2 import os, sys
3 from ConfigParser import SafeConfigParser
4
5 from twisted.python import log, versions
6
7 class ConfigError(Exception):
8     def __init__(self, message):
9         self.message = message
10     def __str__(self):
11         return repr(self.message)
12
13 version = versions.Version('apt-dht', 0, 0, 0)
14 home = os.path.expandvars('${HOME}')
15 if home == '${HOME}' or not os.path.isdir(home):
16     home = os.path.expanduser('~')
17     if not os.path.isdir(home):
18         home = os.path.abspath(os.path.dirname(sys.argv[0]))
19 DEFAULT_CONFIG_FILES=['/etc/apt-dht/apt-dht.conf',
20                       home + '/.apt-dht/apt-dht.conf']
21
22 DEFAULTS = {
23
24     # Port to listen on for all requests (TCP and UDP)
25     'PORT': '9977',
26     
27     # Directory to store the downloaded files in
28     'CACHE_DIR': home + '/.apt-dht/cache',
29     
30     # Other directories containing packages to share with others
31     # WARNING: all files in these directories will be hashed and available
32     #          for everybody to download
33     'OTHER_DIRS': """""",
34     
35     # User name to try and run as
36     'USERNAME': '',
37     
38     # Whether it's OK to use an IP addres from a known local/private range
39     'LOCAL_OK': 'no',
40
41     # Unload the packages cache after an interval of inactivity this long.
42     # The packages cache uses a lot of memory, and only takes a few seconds
43     # to reload when a new request arrives.
44     'UNLOAD_PACKAGES_CACHE': '5m',
45
46     # Refresh the DHT keys after this much time has passed.
47     # This should be a time slightly less than the DHT's KEY_EXPIRE value.
48     'KEY_REFRESH': '57m',
49
50     # Which DHT implementation to use.
51     # It must be possile to do "from <DHT>.DHT import DHT" to get a class that
52     # implements the IDHT interface.
53     'DHT': 'apt_dht_Khashmir',
54
55     # Whether to only run the DHT (for providing only a bootstrap node)
56     'DHT-ONLY': 'no',
57 }
58
59 DHT_DEFAULTS = {
60     # bootstrap nodes to contact to join the DHT
61     'BOOTSTRAP': """www.camrdale.org:9977
62         steveholt.hopto.org:9976""",
63     
64     # whether this node is a bootstrap node
65     'BOOTSTRAP_NODE': "no",
66     
67     # Kademlia "K" constant, this should be an even number
68     'K': '8',
69     
70     # SHA1 is 160 bits long
71     'HASH_LENGTH': '160',
72     
73     # checkpoint every this many seconds
74     'CHECKPOINT_INTERVAL': '5m', # five minutes
75     
76     ### SEARCHING/STORING
77     # concurrent xmlrpc calls per find node/value request!
78     'CONCURRENT_REQS': '4',
79     
80     # how many hosts to post to
81     'STORE_REDUNDANCY': '3',
82     
83     ###  ROUTING TABLE STUFF
84     # how many times in a row a node can fail to respond before it's booted from the routing table
85     'MAX_FAILURES': '3',
86     
87     # never ping a node more often than this
88     'MIN_PING_INTERVAL': '15m', # fifteen minutes
89     
90     # refresh buckets that haven't been touched in this long
91     'BUCKET_STALENESS': '1h', # one hour
92     
93     # expire entries older than this
94     'KEY_EXPIRE': '1h', # 60 minutes
95     
96     # whether to spew info about the requests/responses in the protocol
97     'SPEW': 'yes',
98 }
99
100 class AptDHTConfigParser(SafeConfigParser):
101     """
102     Adds 'gettime' to ConfigParser to interpret the suffixes.
103     """
104     time_multipliers={
105         's': 1,    #seconds
106         'm': 60,   #minutes
107         'h': 3600, #hours
108         'd': 86400,#days
109         }
110
111     def gettime(self, section, option):
112         mult = 1
113         value = self.get(section, option)
114         if len(value) == 0:
115             raise ConfigError("Configuration parse error: [%s] %s" % (section, option))
116         suffix = value[-1].lower()
117         if suffix in self.time_multipliers.keys():
118             mult = self.time_multipliers[suffix]
119             value = value[:-1]
120         return int(value)*mult
121     def getstring(self, section, option):
122         return self.get(section,option)
123     def getstringlist(self, section, option):
124         return self.get(section,option).split()
125     def optionxform(self, option):
126         return option.upper()
127
128 config = AptDHTConfigParser(DEFAULTS)
129 config.add_section(config.get('DEFAULT', 'DHT'))
130 for k in DHT_DEFAULTS:
131     config.set(config.get('DEFAULT', 'DHT'), k, DHT_DEFAULTS[k])