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