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