don't use recent_servers if list from irc is available
[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         if self.irc_servers:
186             out = self.irc_servers  
187         else:
188             out = DEFAULT_SERVERS
189             for s in self.recent_servers:
190                 host, port, protocol = s.split(':')
191                 if host not in out:
192                     out[host] = { protocol:port }
193         return out
194
195     def start_interface(self, server):
196         if server in self.interfaces.keys():
197             return
198         i = interface.Interface(server, self.config)
199         self.pending_servers.add(server)
200         i.start(self.queue)
201         return i 
202
203     def start_random_interface(self):
204         server = self.random_server()
205         if server:
206             self.start_interface(server)
207
208     def start_interfaces(self):
209         self.interface = self.start_interface(self.default_server)
210
211         for i in range(self.num_server):
212             self.start_random_interface()
213             
214
215     def start(self, wait=False):
216         self.start_interfaces()
217         threading.Thread.start(self)
218         if wait:
219             return self.wait_until_connected()
220
221     def wait_until_connected(self):
222         "wait until connection status is known"
223         if self.config.get('auto_cycle'): 
224             # self.random_server() returns None if all servers have been tried
225             while not self.is_connected() and self.random_server():
226                 time.sleep(0.1)
227         else:
228             self.interface.connect_event.wait()
229
230         return self.interface.is_connected
231
232
233     def set_parameters(self, host, port, protocol, proxy, auto_connect):
234
235         self.config.set_key('auto_cycle', auto_connect, True)
236         self.config.set_key("proxy", proxy, True)
237         self.config.set_key("protocol", protocol, True)
238         server = ':'.join([ host, port, protocol ])
239         self.config.set_key("server", server, True)
240
241         if self.proxy != proxy or self.protocol != protocol:
242             self.proxy = proxy
243             self.protocol = protocol
244             for i in self.interfaces.values(): i.stop()
245             if auto_connect:
246                 #self.interface = None
247                 return
248
249         if auto_connect:
250             if not self.interface.is_connected:
251                 self.switch_to_random_interface()
252             else:
253                 if self.server_lag > 0:
254                     self.stop_interface()
255         else:
256             self.set_server(server)
257
258
259     def switch_to_random_interface(self):
260         if self.interfaces:
261             self.switch_to_interface(random.choice(self.interfaces.values()))
262
263     def switch_to_interface(self, interface):
264         assert not self.interface.is_connected
265         server = interface.server
266         print_error("switching to", server)
267         self.interface = interface
268         h =  self.heights.get(server)
269         if h:
270             self.server_lag = self.blockchain.height() - h
271         self.config.set_key('server', server, False)
272         self.default_server = server
273         self.send_subscriptions()
274         self.trigger_callback('connected')
275
276
277     def stop_interface(self):
278         self.interface.stop() 
279
280
281     def set_server(self, server):
282         if self.default_server == server and self.interface.is_connected:
283             return
284
285         if self.protocol != server.split(':')[2]:
286             return
287
288         # stop the interface in order to terminate subscriptions
289         if self.interface.is_connected:
290             self.stop_interface()
291
292         # notify gui
293         self.trigger_callback('disconnecting')
294         # start interface
295         self.default_server = server
296         self.config.set_key("server", server, True)
297
298         if server in self.interfaces.keys():
299             self.switch_to_interface( self.interfaces[server] )
300         else:
301             self.interface = self.start_interface(server)
302         
303
304     def add_recent_server(self, i):
305         # list is ordered
306         s = i.server
307         if s in self.recent_servers:
308             self.recent_servers.remove(s)
309         self.recent_servers.insert(0,s)
310         self.recent_servers = self.recent_servers[0:20]
311         self.config.set_key('recent_servers', self.recent_servers)
312
313
314     def new_blockchain_height(self, blockchain_height, i):
315         if self.is_connected():
316             h = self.heights.get(self.interface.server)
317             if h:
318                 self.server_lag = blockchain_height - h
319                 if self.server_lag > 1:
320                     print_error( "Server is lagging", blockchain_height, h)
321                     if self.config.get('auto_cycle'):
322                         self.set_server(i.server)
323             else:
324                 print_error('no height for main interface')
325         
326         self.trigger_callback('updated')
327
328
329     def run(self):
330         self.blockchain.start()
331
332         with self.lock:
333             self.running = True
334
335         while self.is_running():
336             try:
337                 i = self.queue.get(timeout = 30 if self.interfaces else 3)
338             except Queue.Empty:
339                 if len(self.interfaces) < self.num_server:
340                     self.start_random_interface()
341                 continue
342
343             if i.server in self.pending_servers:
344                 self.pending_servers.remove(i.server)
345
346             if i.is_connected:
347                 #if i.server in self.interfaces: raise
348                 self.interfaces[i.server] = i
349                 self.add_recent_server(i)
350                 i.send([ ('blockchain.headers.subscribe',[])], self.on_header)
351                 if i == self.interface:
352                     print_error('sending subscriptions to', self.interface.server)
353                     self.send_subscriptions()
354                     self.trigger_callback('connected')
355             else:
356                 self.disconnected_servers.add(i.server)
357                 if i.server in self.interfaces:
358                     self.interfaces.pop(i.server)
359                 if i.server in self.heights:
360                     self.heights.pop(i.server)
361                 if i == self.interface:
362                     #self.interface = None
363                     self.trigger_callback('disconnected')
364
365             if not self.interface.is_connected and self.config.get('auto_cycle'):
366                 self.switch_to_random_interface()
367
368
369     def on_header(self, i, r):
370         result = r.get('result')
371         if not result: return
372         height = result.get('block_height')
373         self.heights[i.server] = height
374         self.merkle_roots[i.server] = result.get('merkle_root')
375         self.utxo_roots[i.server] = result.get('utxo_root')
376         # notify blockchain about the new height
377         self.blockchain.queue.put((i,result))
378
379         if i == self.interface:
380             self.server_lag = self.blockchain.height() - height
381             if self.server_lag > 1 and self.config.get('auto_cycle'):
382                 print_error( "Server lagging, stopping interface")
383                 self.stop_interface()
384
385             self.trigger_callback('updated')
386
387
388     def on_peers(self, i, r):
389         if not r: return
390         self.irc_servers = parse_servers(r.get('result'))
391         self.trigger_callback('peers')
392
393     def on_banner(self, i, r):
394         self.banner = r.get('result')
395         self.trigger_callback('banner')
396
397     def stop(self):
398         with self.lock: self.running = False
399
400     def is_running(self):
401         with self.lock: return self.running
402
403     
404     def synchronous_get(self, requests, timeout=100000000):
405         return self.interface.synchronous_get(requests)
406
407
408     def get_header(self, tx_height):
409         return self.blockchain.read_header(tx_height)
410
411     def get_local_height(self):
412         return self.blockchain.height()
413
414
415
416     #def retrieve_transaction(self, tx_hash, tx_height=0):
417     #    import transaction
418     #    r = self.synchronous_get([ ('blockchain.transaction.get',[tx_hash, tx_height]) ])[0]
419     #    if r:
420     #        return transaction.Transaction(r)
421
422
423
424
425
426 if __name__ == "__main__":
427     network = NetworkProxy({})
428     network.start()
429     print network.get_servers()
430
431     q = Queue.Queue()
432     network.send([('blockchain.headers.subscribe',[])], q.put)
433     while True:
434         r = q.get(timeout=10000)
435         print r
436