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