2 # Copyright(C) 2012 thomasv@gitorious
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU Affero General Public License as
6 # published by the Free Software Foundation, either version 3 of the
7 # License, or (at your option) any later version.
9 # This program is distributed in the hope that it will be useful, but
10 # WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 # Affero General Public License for more details.
14 # You should have received a copy of the GNU Affero General Public
15 # License along with this program. If not, see
16 # <http://www.gnu.org/licenses/agpl.html>.
20 * server should check and return bitcoind status..
21 * improve txpoint sorting
22 * command to check cache
24 mempool transactions do not need to be added to the database; it slows it down
32 import time, json, socket, operator, thread, ast, sys, re, traceback
34 from json import dumps, loads
38 config = ConfigParser.ConfigParser()
39 # set some defaults, which will be overwritten by the config file
40 config.add_section('server')
41 config.set('server','banner', 'Welcome to Electrum!')
42 config.set('server', 'host', 'localhost')
43 config.set('server', 'port', '50000')
44 config.set('server', 'password', '')
45 config.set('server', 'irc', 'yes')
46 config.set('server', 'ircname', 'Electrum server')
47 config.add_section('database')
48 config.set('database', 'type', 'psycopg2')
49 config.set('database', 'database', 'abe')
52 f = open('/etc/electrum.conf','r')
56 print "Could not read electrum.conf. I will use the default values."
59 f = open('/etc/electrum.banner','r')
60 config.set('server','banner', f.read())
66 password = config.get('server','password')
71 sessions_sub_numblocks = {} # sessions that have subscribed to the service
73 m_sessions = [{}] # served by http
77 wallets = {} # for ultra-light clients such as bccapi
79 from Queue import Queue
81 output_queue = Queue()
88 return ''.join(random.choice(string.ascii_uppercase + string.digits) for x in range(N))
92 def cmd_stop(_,__,pw):
98 return 'wrong password'
100 def cmd_load(_,__,pw):
102 return repr( len(sessions) )
104 return 'wrong password'
110 def modified_addresses(a_session):
113 session = copy.deepcopy(a_session)
114 addresses = session['addresses']
115 session['last_time'] = time.time()
118 for addr in addresses:
119 status = store.get_status( addr )
120 msg_id, last_status = addresses.get( addr )
121 if last_status != status:
122 addresses[addr] = msg_id, status
125 #t2 = time.time() - t1
126 #if t2 > 10: print "high load:", session_id, "%d/%d"%(k,len(addresses)), t2
127 return ret, addresses
130 def poll_session(session_id):
132 session = sessions.get(session_id)
134 print time.asctime(), "session not found", session_id
137 sessions[session_id]['last_time'] = time.time()
138 ret, addresses = modified_addresses(session)
139 if ret: sessions[session_id]['addresses'] = addresses
140 return repr( (block_number,ret))
143 def poll_session_json(session_id, message_id):
144 session = m_sessions[0].get(session_id)
146 raise BaseException("session not found %s"%session_id)
148 m_sessions[0][session_id]['last_time'] = time.time()
150 ret, addresses = modified_addresses(session)
152 m_sessions[0][session_id]['addresses'] = addresses
154 msg_id, status = addresses[addr]
155 out.append( { 'id':msg_id, 'result':status } )
157 msg_id, last_nb = session.get('numblocks')
159 if last_nb != block_number:
160 m_sessions[0][session_id]['numblocks'] = msg_id, block_number
161 out.append( {'id':msg_id, 'result':block_number} )
166 def do_update_address(addr):
167 # an address was involved in a transaction; we check if it was subscribed to in a session
168 # the address can be subscribed in several sessions; the cache should ensure that we don't do redundant requests
170 for session_id in sessions.keys():
171 session = sessions[session_id]
172 if session.get('type') != 'persistent': continue
173 addresses = session['addresses'].keys()
175 if addr in addresses:
176 status = store.get_status( addr )
177 message_id, last_status = session['addresses'][addr]
178 if last_status != status:
179 #print "sending new status for %s:"%addr, status
180 send_status(session_id,message_id,addr,status)
181 sessions[session_id]['addresses'][addr] = (message_id,status)
185 def send_numblocks(session_id):
186 message_id = sessions_sub_numblocks[session_id]
187 out = json.dumps( {'id':message_id, 'result':block_number} )
188 output_queue.put((session_id, out))
190 def send_status(session_id, message_id, address, status):
191 out = json.dumps( { 'id':message_id, 'result':status } )
192 output_queue.put((session_id, out))
194 def address_get_history_json(_,message_id,address):
195 return store.get_history(address)
197 def subscribe_to_numblocks(session_id, message_id):
198 sessions_sub_numblocks[session_id] = message_id
199 send_numblocks(session_id)
201 def subscribe_to_numblocks_json(session_id, message_id):
203 m_sessions[0][session_id]['numblocks'] = message_id,block_number
206 def subscribe_to_address(session_id, message_id, address):
207 status = store.get_status(address)
208 sessions[session_id]['addresses'][address] = (message_id, status)
209 sessions[session_id]['last_time'] = time.time()
210 send_status(session_id, message_id, address, status)
212 def add_address_to_session_json(session_id, message_id, address):
214 sessions = m_sessions[0]
215 status = store.get_status(address)
216 sessions[session_id]['addresses'][address] = (message_id, status)
217 sessions[session_id]['last_time'] = time.time()
218 m_sessions[0] = sessions
221 def add_address_to_session(session_id, address):
222 status = store.get_status(address)
223 sessions[session_id]['addresses'][address] = ("", status)
224 sessions[session_id]['last_time'] = time.time()
227 def new_session(version, addresses):
228 session_id = random_string(10)
229 sessions[session_id] = { 'addresses':{}, 'version':version }
231 sessions[session_id]['addresses'][a] = ('','')
232 out = repr( (session_id, config.get('server','banner').replace('\\n','\n') ) )
233 sessions[session_id]['last_time'] = time.time()
237 def client_version_json(session_id, _, version):
239 sessions = m_sessions[0]
240 sessions[session_id]['version'] = version
241 m_sessions[0] = sessions
243 def create_session_json(_, __):
244 sessions = m_sessions[0]
245 session_id = random_string(10)
246 print "creating session", session_id
247 sessions[session_id] = { 'addresses':{}, 'numblocks':('','') }
248 sessions[session_id]['last_time'] = time.time()
249 m_sessions[0] = sessions
254 def get_banner(_,__):
255 return config.get('server','banner').replace('\\n','\n')
257 def update_session(session_id,addresses):
258 """deprecated in 0.42"""
259 sessions[session_id]['addresses'] = {}
261 sessions[session_id]['addresses'][a] = ''
262 sessions[session_id]['last_time'] = time.time()
265 def native_server_thread():
266 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
267 s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
268 s.bind((config.get('server','host'), config.getint('server','port')))
271 conn, addr = s.accept()
273 thread.start_new_thread(native_client_thread, (addr, conn,))
275 # can't start new thread if there is no memory..
276 traceback.print_exc(file=sys.stdout)
279 def native_client_thread(ipaddr,conn):
280 #print "client thread", ipaddr
290 msg = msg.split('#', 1)[0]
293 cmd, data = ast.literal_eval(msg)
295 print "syntax error", repr(msg), ipaddr
299 out = do_command(cmd, data, ipaddr)
301 #print ipaddr, cmd, len(out)
305 print "error, could not send"
312 return time.strftime("[%d/%m/%Y-%H:%M:%S]")
314 # used by the native handler
315 def do_command(cmd, data, ipaddr):
318 out = "%d"%block_number
320 elif cmd in ['session','new_session']:
323 addresses = ast.literal_eval(data)
326 version, addresses = ast.literal_eval(data)
327 if version[0]=="0": version = "v" + version
331 print timestr(), "new session", ipaddr, addresses[0] if addresses else addresses, len(addresses), version
332 out = new_session(version, addresses)
334 elif cmd=='address.subscribe':
336 session_id, addr = ast.literal_eval(data)
338 traceback.print_exc(file=sys.stdout)
341 out = add_address_to_session(session_id,addr)
343 elif cmd=='update_session':
345 session_id, addresses = ast.literal_eval(data)
347 traceback.print_exc(file=sys.stdout)
349 print timestr(), "update session", ipaddr, addresses[0] if addresses else addresses, len(addresses)
350 out = update_session(session_id,addresses)
353 out = poll_session(data)
358 out = repr( store.get_history( address ) )
361 out = cmd_load(None,None,data)
364 out = store.send_tx(data)
365 print timestr(), "sent tx:", ipaddr, out
371 out = repr(peer_list.values())
380 ####################################################################
382 def tcp_server_thread():
383 thread.start_new_thread(process_input_queue, ())
384 thread.start_new_thread(process_output_queue, ())
386 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
387 s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
388 s.bind((config.get('server','host'), 50001))
391 conn, addr = s.accept()
393 thread.start_new_thread(tcp_client_thread, (addr, conn,))
395 # can't start new thread if there is no memory..
396 traceback.print_exc(file=sys.stdout)
399 def close_session(session_id):
400 #print "lost connection", session_id
401 sessions.pop(session_id)
402 if session_id in sessions_sub_numblocks:
403 sessions_sub_numblocks.pop(session_id)
406 # one thread per client. put requests in a queue.
407 def tcp_client_thread(ipaddr,conn):
408 """ use a persistent connection. put commands in a queue."""
410 print timestr(), "TCP session", ipaddr
413 session_id = random_string(10)
414 sessions[session_id] = { 'conn':conn, 'addresses':{}, 'version':'unknown', 'type':'persistent' }
425 close_session(session_id)
438 close_session(session_id)
443 print "json error", repr(c)
446 message_id = c.get('id')
447 method = c.get('method')
448 params = c.get('params')
450 print "syntax error", repr(c), ipaddr
454 input_queue.put((session_id, message_id, method, params))
458 # read commands from the input queue. perform requests, etc. this should be called from the main thread.
459 def process_input_queue():
461 session_id, message_id, method, data = input_queue.get()
462 if session_id not in sessions.keys():
465 if method == 'address.subscribe':
467 subscribe_to_address(session_id,message_id,address)
468 elif method == 'numblocks.subscribe':
469 subscribe_to_numblocks(session_id,message_id)
470 elif method == 'client.version':
471 sessions[session_id]['version'] = data[0]
472 elif method == 'server.banner':
473 out = { 'result':config.get('server','banner').replace('\\n','\n') }
474 elif method == 'server.peers':
475 out = { 'result':peer_list.values() }
476 elif method == 'address.get_history':
478 out = { 'result':store.get_history( address ) }
479 elif method == 'transaction.broadcast':
480 txo = store.send_tx(data[0])
481 print "sent tx:", txo
482 out = {'result':txo }
484 print "unknown command", method
486 out['id'] = message_id
487 out = json.dumps( out )
488 output_queue.put((session_id, out))
490 # this is a separate thread
491 def process_output_queue():
493 session_id, out = output_queue.get()
494 session = sessions.get(session_id)
497 conn = session.get('conn')
500 close_session(session_id)
505 ####################################################################
510 def clean_session_thread():
514 for k,s in sessions.items():
515 if s.get('type') == 'persistent': continue
519 print "lost session", k
524 NICK = 'E_'+random_string(10)
528 s.connect(('irc.freenode.net', 6667))
529 s.send('USER electrum 0 * :'+config.get('server','host')+' '+config.get('server','ircname')+'\n')
530 s.send('NICK '+NICK+'\n')
531 s.send('JOIN #electrum\n')
532 sf = s.makefile('r', 0)
536 line = line.rstrip('\r\n')
539 s.send('PONG '+line[1]+'\n')
540 elif '353' in line: # answer to /names
541 k = line.index('353')
542 for item in line[k+1:]:
543 if item[0:2] == 'E_':
544 s.send('WHO %s\n'%item)
545 elif '352' in line: # answer to /who
546 # warning: this is a horrible hack which apparently works
547 k = line.index('352')
549 ip = socket.gethostbyname(ip)
552 peer_list[name] = (ip,host)
553 if time.time() - t > 5*60:
554 s.send('NAMES #electrum\n')
558 traceback.print_exc(file=sys.stdout)
564 def get_peers_json(_,__):
565 return peer_list.values()
567 def http_server_thread():
568 # see http://code.google.com/p/jsonrpclib/
569 from SocketServer import ThreadingMixIn
570 from StratumJSONRPCServer import StratumJSONRPCServer
571 class StratumThreadedJSONRPCServer(ThreadingMixIn, StratumJSONRPCServer): pass
572 server = StratumThreadedJSONRPCServer(( config.get('server','host'), 8081))
573 server.register_function(get_peers_json, 'server.peers')
574 server.register_function(cmd_stop, 'stop')
575 server.register_function(cmd_load, 'load')
576 server.register_function(get_banner, 'server.banner')
577 server.register_function(lambda a,b,c: store.send_tx(c), 'transaction.broadcast')
578 server.register_function(address_get_history_json, 'address.get_history')
579 server.register_function(add_address_to_session_json, 'address.subscribe')
580 server.register_function(subscribe_to_numblocks_json, 'numblocks.subscribe')
581 server.register_function(client_version_json, 'client.version')
582 server.register_function(create_session_json, 'session.create') # internal message (not part of protocol)
583 server.register_function(poll_session_json, 'session.poll') # internal message (not part of protocol)
584 server.serve_forever()
587 if __name__ == '__main__':
591 server = jsonrpclib.Server('http://%s:8081'%config.get('server','host'))
594 out = server.load(password)
596 out = server.server.peers()
598 out = server.stop(password)
599 elif cmd == 'clear_cache':
600 out = server.clear_cache(password)
601 elif cmd == 'get_cache':
602 out = server.get_cache(password,sys.argv[2])
604 out = server.address.get_history(sys.argv[2])
606 out = server.transaction.broadcast(sys.argv[2])
608 out = server.numblocks.subscribe()
610 out = "Unknown command: '%s'" % cmd
615 store = abe_backend.AbeStore(config)
617 # supported protocols
618 thread.start_new_thread(native_server_thread, ())
619 thread.start_new_thread(tcp_server_thread, ())
620 thread.start_new_thread(http_server_thread, ())
621 thread.start_new_thread(clean_session_thread, ())
623 if (config.get('server','irc') == 'yes' ):
624 thread.start_new_thread(irc_thread, ())
626 print "starting Electrum server"
628 old_block_number = None
630 block_number = store.main_iteration()
632 if block_number != old_block_number:
633 old_block_number = block_number
634 for session_id in sessions_sub_numblocks.keys():
635 send_numblocks(session_id)
638 addr = store.address_queue.get(False)
641 do_update_address(addr)
644 print "server stopped"