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