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