update default servers
[electrum-nvc.git] / lib / network.py
1 import threading, time, Queue, os, sys, shutil, random
2 from util import user_dir, appdata_dir, print_error, print_msg
3 from bitcoin import *
4 import interface
5 from blockchain import Blockchain
6
7 DEFAULT_PORTS = {'t':'50001', 's':'50002', 'h':'8081', 'g':'8082'}
8
9 DEFAULT_SERVERS = {
10     'ecdsa.org': DEFAULT_PORTS,
11     'ecdsa.net': DEFAULT_PORTS,
12     'electrum.hachre.de': DEFAULT_PORTS,
13     'electrum.novit.ro': DEFAULT_PORTS,
14     'electrum.coinwallet.me': DEFAULT_PORTS,
15     'cube.l0g.in': DEFAULT_PORTS,
16     'bitcoin.epicinet.net': DEFAULT_PORTS,
17     'h.1209k.com': DEFAULT_PORTS,
18     'electrum.electricnewyear.net': DEFAULT_PORTS,
19     'erbium.sytes.net': DEFAULT_PORTS,
20     'e2.pdmc.net':DEFAULT_PORTS,
21     'electrum.thwg.org':DEFAULT_PORTS,
22 }
23
24
25 def parse_servers(result):
26     """ parse servers list into dict format"""
27     from version import PROTOCOL_VERSION
28     servers = {}
29     for item in result:
30         host = item[1]
31         out = {}
32         version = None
33         pruning_level = '-'
34         if len(item) > 2:
35             for v in item[2]:
36                 if re.match("[stgh]\d*", v):
37                     protocol, port = v[0], v[1:]
38                     if port == '': port = DEFAULT_PORTS[protocol]
39                     out[protocol] = port
40                 elif re.match("v(.?)+", v):
41                     version = v[1:]
42                 elif re.match("p\d*", v):
43                     pruning_level = v[1:]
44                 if pruning_level == '': pruning_level = '0'
45         try: 
46             is_recent = float(version)>=float(PROTOCOL_VERSION)
47         except Exception:
48             is_recent = False
49
50         if out and is_recent:
51             out['pruning'] = pruning_level
52             servers[host] = out
53
54     return servers
55
56
57
58 def filter_protocol(servers, p):
59     l = []
60     for k, protocols in servers.items():
61         if p in protocols:
62             l.append( ':'.join([k, protocols[p], p]) )
63     return l
64     
65
66 def pick_random_server(p='s'):
67     return random.choice( filter_protocol(DEFAULT_SERVERS,p) )
68
69 from simple_config import SimpleConfig
70
71 class Network(threading.Thread):
72
73     def __init__(self, config = {}):
74         threading.Thread.__init__(self)
75         self.daemon = True
76         self.config = SimpleConfig(config) if type(config) == type({}) else config
77         self.lock = threading.Lock()
78         self.num_server = 8 if not self.config.get('oneserver') else 0
79         self.blockchain = Blockchain(self.config, self)
80         self.interfaces = {}
81         self.queue = Queue.Queue()
82         self.callbacks = {}
83         self.protocol = self.config.get('protocol','s')
84         self.running = False
85
86         # Server for addresses and transactions
87         self.default_server = self.config.get('server')
88         if not self.default_server:
89             self.default_server = pick_random_server(self.protocol)
90
91         self.irc_servers = [] # returned by interface (list from irc)
92         self.pending_servers = set([])
93         self.disconnected_servers = set([])
94         self.recent_servers = self.config.get('recent_servers',[]) # successful connections
95
96         self.banner = ''
97         self.interface = None
98         self.proxy = self.config.get('proxy')
99         self.heights = {}
100         self.merkle_roots = {}
101         self.utxo_roots = {}
102         self.server_lag = 0
103
104         dir_path = os.path.join( self.config.path, 'certs')
105         if not os.path.exists(dir_path):
106             os.mkdir(dir_path)
107
108         # default subscriptions
109         self.subscriptions = {}
110         self.subscriptions[self.on_banner] = [('server.banner',[])]
111         self.subscriptions[self.on_peers] = [('server.peers.subscribe',[])]
112
113
114     def is_connected(self):
115         return self.interface and self.interface.is_connected
116
117
118     def is_up_to_date(self):
119         return self.interface.is_up_to_date()
120
121
122     def main_server(self):
123         return self.interface.server
124
125
126     def send_subscriptions(self):
127         for cb, sub in self.subscriptions.items():
128             self.interface.send(sub, cb)
129
130
131     def subscribe(self, messages, callback):
132         with self.lock:
133             if self.subscriptions.get(callback) is None: 
134                 self.subscriptions[callback] = []
135             for message in messages:
136                 if message not in self.subscriptions[callback]:
137                     self.subscriptions[callback].append(message)
138
139         if self.is_connected():
140             self.interface.send( messages, callback )
141
142
143     def send(self, messages, callback):
144         if self.is_connected():
145             self.interface.send( messages, callback )
146             return True
147         else:
148             return False
149
150
151     def register_callback(self, event, callback):
152         with self.lock:
153             if not self.callbacks.get(event):
154                 self.callbacks[event] = []
155             self.callbacks[event].append(callback)
156
157
158     def trigger_callback(self, event):
159         with self.lock:
160             callbacks = self.callbacks.get(event,[])[:]
161         if callbacks:
162             [callback() for callback in callbacks]
163
164
165     def random_server(self):
166         choice_list = []
167         l = filter_protocol(self.get_servers(), self.protocol)
168         for s in l:
169             if s in self.pending_servers or s in self.disconnected_servers or s in self.interfaces.keys():
170                 continue
171             else:
172                 choice_list.append(s)
173         
174         if not choice_list: 
175             if not self.interfaces:
176                 # we are probably offline, retry later
177                 self.disconnected_servers = set([])
178             return
179         
180         server = random.choice( choice_list )
181         return server
182
183
184     def get_servers(self):
185         out = self.irc_servers if self.irc_servers else DEFAULT_SERVERS
186         for s in self.recent_servers:
187             host, port, protocol = s.split(':')
188             if host not in out:
189                 out[host] = { protocol:port }
190         return out
191
192     def start_interface(self, server):
193         if server in self.interfaces.keys():
194             return
195         i = interface.Interface(server, self.config)
196         self.pending_servers.add(server)
197         i.start(self.queue)
198         return i 
199
200     def start_random_interface(self):
201         server = self.random_server()
202         if server:
203             self.start_interface(server)
204
205     def start_interfaces(self):
206         self.interface = self.start_interface(self.default_server)
207
208         for i in range(self.num_server):
209             self.start_random_interface()
210             
211
212     def start(self, wait=False):
213         self.start_interfaces()
214         threading.Thread.start(self)
215         if wait:
216             return self.wait_until_connected()
217
218     def wait_until_connected(self):
219         "wait until connection status is known"
220         if self.config.get('auto_cycle'): 
221             # self.random_server() returns None if all servers have been tried
222             while not self.is_connected() and self.random_server():
223                 time.sleep(0.1)
224         else:
225             self.interface.connect_event.wait()
226
227         return self.interface.is_connected
228
229
230     def set_parameters(self, host, port, protocol, proxy, auto_connect):
231
232         self.config.set_key('auto_cycle', auto_connect, True)
233         self.config.set_key("proxy", proxy, True)
234         self.config.set_key("protocol", protocol, True)
235         server = ':'.join([ host, port, protocol ])
236         self.config.set_key("server", server, True)
237
238         if self.proxy != proxy or self.protocol != protocol:
239             self.proxy = proxy
240             self.protocol = protocol
241             for i in self.interfaces.values(): i.stop()
242             if auto_connect:
243                 #self.interface = None
244                 return
245
246         if auto_connect:
247             if not self.interface.is_connected:
248                 self.switch_to_random_interface()
249             else:
250                 if self.server_lag > 0:
251                     self.stop_interface()
252         else:
253             self.set_server(server)
254
255
256     def switch_to_random_interface(self):
257         if self.interfaces:
258             self.switch_to_interface(random.choice(self.interfaces.values()))
259
260     def switch_to_interface(self, interface):
261         assert not self.interface.is_connected
262         server = interface.server
263         print_error("switching to", server)
264         self.interface = interface
265         h =  self.heights.get(server)
266         if h:
267             self.server_lag = self.blockchain.height() - h
268         self.config.set_key('server', server, False)
269         self.default_server = server
270         self.send_subscriptions()
271         self.trigger_callback('connected')
272
273
274     def stop_interface(self):
275         self.interface.stop() 
276
277
278     def set_server(self, server):
279         if self.default_server == server and self.interface.is_connected:
280             return
281
282         if self.protocol != server.split(':')[2]:
283             return
284
285         # stop the interface in order to terminate subscriptions
286         if self.interface.is_connected:
287             self.stop_interface()
288
289         # notify gui
290         self.trigger_callback('disconnecting')
291         # start interface
292         self.default_server = server
293         self.config.set_key("server", server, True)
294
295         if server in self.interfaces.keys():
296             self.switch_to_interface( self.interfaces[server] )
297         else:
298             self.interface = self.start_interface(server)
299         
300
301     def add_recent_server(self, i):
302         # list is ordered
303         s = i.server
304         if s in self.recent_servers:
305             self.recent_servers.remove(s)
306         self.recent_servers.insert(0,s)
307         self.recent_servers = self.recent_servers[0:20]
308         self.config.set_key('recent_servers', self.recent_servers)
309
310
311     def new_blockchain_height(self, blockchain_height, i):
312         if self.is_connected():
313             h = self.heights.get(self.interface.server)
314             if h:
315                 self.server_lag = blockchain_height - h
316                 if self.server_lag > 1:
317                     print_error( "Server is lagging", blockchain_height, h)
318                     if self.config.get('auto_cycle'):
319                         self.set_server(i.server)
320             else:
321                 print_error('no height for main interface')
322         
323         self.trigger_callback('updated')
324
325
326     def run(self):
327         self.blockchain.start()
328
329         with self.lock:
330             self.running = True
331
332         while self.is_running():
333             try:
334                 i = self.queue.get(timeout = 30 if self.interfaces else 3)
335             except Queue.Empty:
336                 if len(self.interfaces) < self.num_server:
337                     self.start_random_interface()
338                 continue
339
340             if i.server in self.pending_servers:
341                 self.pending_servers.remove(i.server)
342
343             if i.is_connected:
344                 #if i.server in self.interfaces: raise
345                 self.interfaces[i.server] = i
346                 self.add_recent_server(i)
347                 i.send([ ('blockchain.headers.subscribe',[])], self.on_header)
348                 if i == self.interface:
349                     print_error('sending subscriptions to', self.interface.server)
350                     self.send_subscriptions()
351                     self.trigger_callback('connected')
352             else:
353                 self.disconnected_servers.add(i.server)
354                 if i.server in self.interfaces:
355                     self.interfaces.pop(i.server)
356                 if i.server in self.heights:
357                     self.heights.pop(i.server)
358                 if i == self.interface:
359                     #self.interface = None
360                     self.trigger_callback('disconnected')
361
362             if not self.interface.is_connected and self.config.get('auto_cycle'):
363                 self.switch_to_random_interface()
364
365
366     def on_header(self, i, r):
367         result = r.get('result')
368         if not result: return
369         height = result.get('block_height')
370         self.heights[i.server] = height
371         self.merkle_roots[i.server] = result.get('merkle_root')
372         self.utxo_roots[i.server] = result.get('utxo_root')
373         # notify blockchain about the new height
374         self.blockchain.queue.put((i,result))
375
376         if i == self.interface:
377             self.server_lag = self.blockchain.height() - height
378             if self.server_lag > 1 and self.config.get('auto_cycle'):
379                 print_error( "Server lagging, stopping interface")
380                 self.stop_interface()
381
382             self.trigger_callback('updated')
383
384
385     def on_peers(self, i, r):
386         if not r: return
387         self.irc_servers = parse_servers(r.get('result'))
388         self.trigger_callback('peers')
389
390     def on_banner(self, i, r):
391         self.banner = r.get('result')
392         self.trigger_callback('banner')
393
394     def stop(self):
395         with self.lock: self.running = False
396
397     def is_running(self):
398         with self.lock: return self.running
399
400     
401     def synchronous_get(self, requests, timeout=100000000):
402         return self.interface.synchronous_get(requests)
403
404
405     def get_header(self, tx_height):
406         return self.blockchain.read_header(tx_height)
407
408     def get_local_height(self):
409         return self.blockchain.height()
410
411
412
413     #def retrieve_transaction(self, tx_hash, tx_height=0):
414     #    import transaction
415     #    r = self.synchronous_get([ ('blockchain.transaction.get',[tx_hash, tx_height]) ])[0]
416     #    if r:
417     #        return transaction.Transaction(r)
418
419
420
421
422
423 if __name__ == "__main__":
424     network = NetworkProxy({})
425     network.start()
426     print network.get_servers()
427
428     q = Queue.Queue()
429     network.send([('blockchain.headers.subscribe',[])], q.put)
430     while True:
431         r = q.get(timeout=10000)
432         print r
433