Set initial 'running' attribute in Network class
[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.interface and self.interface.is_connected:
98             self.interface.send( messages, callback )
99
100
101     def send(self, messages, callback):
102         if self.interface and self.interface.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         self.interfaces[server] = i
155         i.start(self.queue)
156
157     def start_random_interface(self):
158         server = self.random_server()
159         if server:
160             self.start_interface(server)
161
162     def start_interfaces(self):
163         self.start_interface(self.default_server)
164         self.interface = self.interfaces[self.default_server]
165
166         for i in range(self.num_server):
167             self.start_random_interface()
168             
169         if not self.interface:
170             self.interface = self.interfaces.values()[0]
171
172
173     def start(self, wait=False):
174         self.start_interfaces()
175         threading.Thread.start(self)
176         if wait:
177             self.interface.connect_event.wait()
178             return self.interface.is_connected
179
180
181     def wait_until_connected(self):
182         while not self.interface:
183             time.sleep(1)
184         self.interface.connect_event.wait()
185
186
187     def set_parameters(self, host, port, protocol, proxy, auto_connect):
188
189         self.config.set_key('auto_cycle', auto_connect, True)
190         self.config.set_key("proxy", proxy, True)
191         self.config.set_key("protocol", protocol, True)
192         server = ':'.join([ host, port, protocol ])
193         self.config.set_key("server", server, True)
194
195         if self.proxy != proxy or self.protocol != protocol:
196             self.proxy = proxy
197             self.protocol = protocol
198             for i in self.interfaces.values(): i.stop()
199             if auto_connect:
200                 self.interface = None
201                 return
202
203         if auto_connect:
204             if not self.interface:
205                 self.switch_to_random_interface()
206             else:
207                 if self.server_lag > 0:
208                     self.stop_interface()
209         else:
210             self.set_server(server)
211
212
213     def switch_to_random_interface(self):
214         if self.interfaces:
215             self.switch_to_interface(random.choice(self.interfaces.values()))
216
217     def switch_to_interface(self, interface):
218         assert self.interface is None
219         server = interface.server
220         print_error("switching to", server)
221         self.interface = interface
222         h =  self.heights.get(server)
223         if h:
224             self.server_lag = self.blockchain.height() - h
225         self.config.set_key('server', server, False)
226         self.default_server = server
227         self.send_subscriptions()
228         self.trigger_callback('connected')
229
230
231     def stop_interface(self):
232         self.interface.stop() 
233         self.interface = None
234
235     def set_server(self, server):
236         if self.default_server == server and self.interface:
237             return
238
239         if self.protocol != server.split(':')[2]:
240             return
241
242         # stop the interface in order to terminate subscriptions
243         if self.interface:
244             self.stop_interface()
245
246         # notify gui
247         self.trigger_callback('disconnecting')
248         # start interface
249         self.default_server = server
250         self.config.set_key("server", server, True)
251
252         if server in self.interfaces.keys():
253             self.switch_to_interface( self.interfaces[server] )
254         else:
255             self.start_interface(server)
256             self.interface = self.interfaces[server]
257         
258
259     def add_recent_server(self, i):
260         # list is ordered
261         s = i.server
262         if s in self.recent_servers:
263             self.recent_servers.remove(s)
264         self.recent_servers.insert(0,s)
265         self.recent_servers = self.recent_servers[0:20]
266         self.config.set_key('recent_servers', self.recent_servers)
267
268
269     def new_blockchain_height(self, blockchain_height, i):
270         if self.is_connected():
271             h = self.heights.get(self.interface.server)
272             if h:
273                 self.server_lag = blockchain_height - h
274                 if self.server_lag > 1:
275                     print_error( "Server is lagging", blockchain_height, h)
276                     if self.config.get('auto_cycle'):
277                         self.set_server(i.server)
278             else:
279                 print_error('no height for main interface')
280         
281         self.trigger_callback('updated')
282
283
284     def run(self):
285         self.blockchain.start()
286
287         with self.lock:
288             self.running = True
289
290         while self.is_running():
291             try:
292                 i = self.queue.get(timeout = 30 if self.interfaces else 3)
293             except Queue.Empty:
294                 if len(self.interfaces) < self.num_server:
295                     self.start_random_interface()
296                 continue
297
298             if i.is_connected:
299                 self.add_recent_server(i)
300                 i.send([ ('blockchain.headers.subscribe',[])], self.on_header)
301                 if i == self.interface:
302                     print_error('sending subscriptions to', self.interface.server)
303                     self.send_subscriptions()
304                     self.trigger_callback('connected')
305             else:
306                 self.disconnected_servers.append(i.server)
307                 self.interfaces.pop(i.server)
308                 if i.server in self.heights:
309                     self.heights.pop(i.server)
310                 if i == self.interface:
311                     self.interface = None
312                     self.trigger_callback('disconnected')
313
314             if self.interface is None and self.config.get('auto_cycle'):
315                 self.switch_to_random_interface()
316
317
318     def on_header(self, i, r):
319         result = r.get('result')
320         if not result: return
321         height = result.get('block_height')
322         self.heights[i.server] = height
323         # notify blockchain about the new height
324         self.blockchain.queue.put((i,result))
325
326         if i == self.interface:
327             self.server_lag = self.blockchain.height() - height
328             if self.server_lag > 1 and self.config.get('auto_cycle'):
329                 print_error( "Server lagging, stopping interface")
330                 self.stop_interface()
331
332             self.trigger_callback('updated')
333
334
335     def on_peers(self, i, r):
336         if not r: return
337         self.irc_servers = self.parse_servers(r.get('result'))
338         self.trigger_callback('peers')
339
340     def on_banner(self, i, r):
341         self.banner = r.get('result')
342         self.trigger_callback('banner')
343
344     def stop(self):
345         with self.lock: self.running = False
346
347     def is_running(self):
348         with self.lock: return self.running
349
350     
351     def synchronous_get(self, requests, timeout=100000000):
352         queue = Queue.Queue()
353         ids = self.interface.send(requests, lambda i,r: queue.put(r))
354         id2 = ids[:]
355         res = {}
356         while ids:
357             r = queue.get(True, timeout)
358             _id = r.get('id')
359             if _id in ids:
360                 ids.remove(_id)
361                 res[_id] = r.get('result')
362         out = []
363         for _id in id2:
364             out.append(res[_id])
365         return out
366
367
368     def retrieve_transaction(self, tx_hash, tx_height=0):
369         import transaction
370         r = self.synchronous_get([ ('blockchain.transaction.get',[tx_hash, tx_height]) ])[0]
371         if r:
372             return transaction.Transaction(r)
373
374
375     def parse_servers(self, result):
376         """ parse servers list into dict format"""
377         from version import PROTOCOL_VERSION
378         servers = {}
379         for item in result:
380             host = item[1]
381             out = {}
382             version = None
383             pruning_level = '-'
384             if len(item) > 2:
385                 for v in item[2]:
386                     if re.match("[stgh]\d*", v):
387                         protocol, port = v[0], v[1:]
388                         if port == '': port = DEFAULT_PORTS[protocol]
389                         out[protocol] = port
390                     elif re.match("v(.?)+", v):
391                         version = v[1:]
392                     elif re.match("p\d*", v):
393                         pruning_level = v[1:]
394                     if pruning_level == '': pruning_level = '0'
395             try: 
396                 is_recent = float(version)>=float(PROTOCOL_VERSION)
397             except Exception:
398                 is_recent = False
399
400             if out and is_recent:
401                 out['pruning'] = pruning_level
402                 servers[host] = out
403
404         return servers
405
406
407
408
409 if __name__ == "__main__":
410     import simple_config
411     config = simple_config.SimpleConfig({'verbose':True, 'server':'ecdsa.org:50002:s'})
412     network = Network(config)
413     network.start()
414
415     while 1:
416         time.sleep(1)
417
418
419