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