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