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