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