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