Bitmessage/PyBitmessage-2024-12-02
Archived
2
0
Fork 0
Code Issues 168 Pull Requests 53 Actions Packages Projects Releases 5 Wiki Activity

Convert 'API Error' to raise APIError()

Browse Source 
Catch of unhandled exceptions and return them as new API Error 21 - Unexpected API Failure

_decode method that transforms "!!!".decode('hex')errors to new API Error 22: Decode Error
This commit is contained in:
Grant T. Olson 2013-08-11 15:50:47 -04:00
parent ac4146904b
commit 2526608c39
1 changed files with 118 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

210
src/bitmessagemain.py
View File

@ -53,6 +53,13 @@ def connectToStream(streamNumber):
a.start() a.start()
class APIError(Exception):
def __init__(self, error_number, error_message):
self.error_number = error_number
self.error_message = error_message
def __str__(self):
return "API Error %04i: %s" % (self.error_number, self.error_message)
# This is one of several classes that constitute the API # This is one of several classes that constitute the API
# This class was written by Vaibhav Bhatia. Modified by Jonathan Warren (Atheros). # This class was written by Vaibhav Bhatia. Modified by Jonathan Warren (Atheros).
# http://code.activestate.com/recipes/501148-xmlrpc-serverclient-which-does-cookie-handling-and/ # http://code.activestate.com/recipes/501148-xmlrpc-serverclient-which-does-cookie-handling-and/
@ -132,14 +139,13 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return False return False
def _dispatch(self, method, params): def _decode(self, text, decode_type):
self.cookies = [] try:
return text.decode(decode_type)
except TypeError as e:
raise APIError(22, "Decode error - " + str(e))
validuser = self.APIAuthenticateClient() def _handle_request(self, method, params):
if not validuser:
time.sleep(2)
return "RPC Username or password incorrect or HTTP header lacks authentication at all."
# handle request
if method == 'helloWorld': if method == 'helloWorld':
(a, b) = params (a, b) = params
return a + '-' + b return a + '-' + b
@ -165,7 +171,7 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'createRandomAddress': elif method == 'createRandomAddress':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
elif len(params) == 1: elif len(params) == 1:
label, = params label, = params
eighteenByteRipe = False eighteenByteRipe = False
@ -192,12 +198,12 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
payloadLengthExtraBytes = int( payloadLengthExtraBytes = int(
shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty) shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty)
else: else:
return 'API Error 0000: Too many parameters!' raise APIError(0, 'Too many parameters!')
label = label.decode('base64') label = self._decode(label, "base64")
try: try:
unicode(label, 'utf-8') unicode(label, 'utf-8')
except: except:
return 'API Error 0017: Label is not valid UTF-8 data.' raise APIError(17, 'Label is not valid UTF-8 data.')
shared.apiAddressGeneratorReturnQueue.queue.clear() shared.apiAddressGeneratorReturnQueue.queue.clear()
streamNumberForAddress = 1 streamNumberForAddress = 1
shared.addressGeneratorQueue.put(( shared.addressGeneratorQueue.put((
@ -205,7 +211,7 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return shared.apiAddressGeneratorReturnQueue.get() return shared.apiAddressGeneratorReturnQueue.get()
elif method == 'createDeterministicAddresses': elif method == 'createDeterministicAddresses':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
elif len(params) == 1: elif len(params) == 1:
passphrase, = params passphrase, = params
numberOfAddresses = 1 numberOfAddresses = 1
@ -259,22 +265,22 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
payloadLengthExtraBytes = int( payloadLengthExtraBytes = int(
shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty) shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty)
else: else:
return 'API Error 0000: Too many parameters!' raise APIError(0, 'Too many parameters!')
if len(passphrase) == 0: if len(passphrase) == 0:
return 'API Error 0001: The specified passphrase is blank.' raise APIError(1, 'The specified passphrase is blank.')
passphrase = passphrase.decode('base64') passphrase = self._decode(passphrase, "base64")
if addressVersionNumber == 0: # 0 means "just use the proper addressVersionNumber" if addressVersionNumber == 0: # 0 means "just use the proper addressVersionNumber"
addressVersionNumber = 3 addressVersionNumber = 3
if addressVersionNumber != 3: if addressVersionNumber != 3:
return 'API Error 0002: The address version number currently must be 3 (or 0 which means auto-select). ' + addressVersionNumber + ' isn\'t supported.' raise APIError(2,'The address version number currently must be 3 (or 0 which means auto-select). ' + addressVersionNumber + ' isn\'t supported.')
if streamNumber == 0: # 0 means "just use the most available stream" if streamNumber == 0: # 0 means "just use the most available stream"
streamNumber = 1 streamNumber = 1
if streamNumber != 1: if streamNumber != 1:
return 'API Error 0003: The stream number must be 1 (or 0 which means auto-select). Others aren\'t supported.' raise APIError(3,'The stream number must be 1 (or 0 which means auto-select). Others aren\'t supported.')
if numberOfAddresses == 0: if numberOfAddresses == 0:
return 'API Error 0004: Why would you ask me to generate 0 addresses for you?' raise APIError(4, 'Why would you ask me to generate 0 addresses for you?')
if numberOfAddresses > 999: if numberOfAddresses > 999:
return 'API Error 0005: You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message.' raise APIError(5, 'You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message.')
shared.apiAddressGeneratorReturnQueue.queue.clear() shared.apiAddressGeneratorReturnQueue.queue.clear()
print 'Requesting that the addressGenerator create', numberOfAddresses, 'addresses.' print 'Requesting that the addressGenerator create', numberOfAddresses, 'addresses.'
shared.addressGeneratorQueue.put( shared.addressGeneratorQueue.put(
@ -290,17 +296,17 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'getDeterministicAddress': elif method == 'getDeterministicAddress':
if len(params) != 3: if len(params) != 3:
return 'API Error 0000: I need exactly 3 parameters.' raise APIError(0, 'I need exactly 3 parameters.')
passphrase, addressVersionNumber, streamNumber = params passphrase, addressVersionNumber, streamNumber = params
numberOfAddresses = 1 numberOfAddresses = 1
eighteenByteRipe = False eighteenByteRipe = False
if len(passphrase) == 0: if len(passphrase) == 0:
return 'API Error 0001: The specified passphrase is blank.' raise APIError(1, 'The specified passphrase is blank.')
passphrase = passphrase.decode('base64') passphrase = self._decode(passphrase, "base64")
if addressVersionNumber != 3: if addressVersionNumber != 3:
return 'API Error 0002: The address version number currently must be 3. ' + addressVersionNumber + ' isn\'t supported.' raise APIError(2, 'The address version number currently must be 3. ' + addressVersionNumber + ' isn\'t supported.')
if streamNumber != 1: if streamNumber != 1:
return 'API Error 0003: The stream number must be 1. Others aren\'t supported.' raise APIError(3, ' The stream number must be 1. Others aren\'t supported.')
shared.apiAddressGeneratorReturnQueue.queue.clear() shared.apiAddressGeneratorReturnQueue.queue.clear()
print 'Requesting that the addressGenerator create', numberOfAddresses, 'addresses.' print 'Requesting that the addressGenerator create', numberOfAddresses, 'addresses.'
shared.addressGeneratorQueue.put( shared.addressGeneratorQueue.put(
@ -342,8 +348,8 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'getInboxMessageById' or method == 'getInboxMessageByID': elif method == 'getInboxMessageById' or method == 'getInboxMessageByID':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
msgid = params[0].decode('hex') msgid = self._decode(params[0], "hex")
v = (msgid,) v = (msgid,)
shared.sqlLock.acquire() shared.sqlLock.acquire()
shared.sqlSubmitQueue.put('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox WHERE msgid=?''') shared.sqlSubmitQueue.put('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox WHERE msgid=?''')
@ -390,7 +396,7 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'getInboxMessagesByReceiver' or method == 'getInboxMessagesByAddress': #after some time getInboxMessagesByAddress should be removed elif method == 'getInboxMessagesByReceiver' or method == 'getInboxMessagesByAddress': #after some time getInboxMessagesByAddress should be removed
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
toAddress = params[0] toAddress = params[0]
v = (toAddress,) v = (toAddress,)
shared.sqlLock.acquire() shared.sqlLock.acquire()
@ -410,8 +416,8 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'getSentMessageById' or method == 'getSentMessageByID': elif method == 'getSentMessageById' or method == 'getSentMessageByID':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
msgid = params[0].decode('hex') msgid = self._decode(params[0], "hex")
v = (msgid,) v = (msgid,)
shared.sqlLock.acquire() shared.sqlLock.acquire()
shared.sqlSubmitQueue.put('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE msgid=?''') shared.sqlSubmitQueue.put('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE msgid=?''')
@ -428,7 +434,7 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'getSentMessagesByAddress' or method == 'getSentMessagesBySender': elif method == 'getSentMessagesByAddress' or method == 'getSentMessagesBySender':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
fromAddress = params[0] fromAddress = params[0]
v = (fromAddress,) v = (fromAddress,)
shared.sqlLock.acquire() shared.sqlLock.acquire()
@ -448,8 +454,8 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'getSentMessageByAckData': elif method == 'getSentMessageByAckData':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
ackData = params[0].decode('hex') ackData = self._decode(params[0], "hex")
v = (ackData,) v = (ackData,)
shared.sqlLock.acquire() shared.sqlLock.acquire()
shared.sqlSubmitQueue.put('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE ackdata=?''') shared.sqlSubmitQueue.put('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE ackdata=?''')
@ -466,8 +472,8 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return data return data
elif method == 'trashMessage': elif method == 'trashMessage':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
msgid = params[0].decode('hex') msgid = self._decode(params[0], "hex")
# Trash if in inbox table # Trash if in inbox table
helper_inbox.trash(msgid) helper_inbox.trash(msgid)
@ -483,14 +489,14 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return 'Trashed message (assuming message existed).' return 'Trashed message (assuming message existed).'
elif method == 'trashInboxMessage': elif method == 'trashInboxMessage':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
msgid = params[0].decode('hex') msgid = self._decode(params[0], "hex")
helper_inbox.trash(msgid) helper_inbox.trash(msgid)
return 'Trashed inbox message (assuming message existed).' return 'Trashed inbox message (assuming message existed).'
elif method == 'trashSentMessage': elif method == 'trashSentMessage':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
msgid = params[0].decode('hex') msgid = self._decode(params[0], "hex")
t = (msgid,) t = (msgid,)
shared.sqlLock.acquire() shared.sqlLock.acquire()
shared.sqlSubmitQueue.put('''UPDATE sent SET folder='trash' WHERE msgid=?''') shared.sqlSubmitQueue.put('''UPDATE sent SET folder='trash' WHERE msgid=?''')
@ -502,16 +508,16 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return 'Trashed sent message (assuming message existed).' return 'Trashed sent message (assuming message existed).'
elif method == 'sendMessage': elif method == 'sendMessage':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
elif len(params) == 4: elif len(params) == 4:
toAddress, fromAddress, subject, message = params toAddress, fromAddress, subject, message = params
encodingType = 2 encodingType = 2
elif len(params) == 5: elif len(params) == 5:
toAddress, fromAddress, subject, message, encodingType = params toAddress, fromAddress, subject, message, encodingType = params
if encodingType != 2: if encodingType != 2:
return 'API Error 0006: The encoding type must be 2 because that is the only one this program currently supports.' raise APIError(6, 'The encoding type must be 2 because that is the only one this program currently supports.')
subject = subject.decode('base64') subject = self._decode(subject, "base64")
message = message.decode('base64') message = self._decode(message, "base64")
status, addressVersionNumber, streamNumber, toRipe = decodeAddress( status, addressVersionNumber, streamNumber, toRipe = decodeAddress(
toAddress) toAddress)
if status != 'success': if status != 'success':
@ -519,16 +525,16 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
print 'API Error 0007: Could not decode address:', toAddress, ':', status print 'API Error 0007: Could not decode address:', toAddress, ':', status
if status == 'checksumfailed': if status == 'checksumfailed':
return 'API Error 0008: Checksum failed for address: ' + toAddress raise APIError(8, 'Checksum failed for address: ' + toAddress)
if status == 'invalidcharacters': if status == 'invalidcharacters':
return 'API Error 0009: Invalid characters in address: ' + toAddress raise APIError(9, 'Invalid characters in address: ' + toAddress)
if status == 'versiontoohigh': if status == 'versiontoohigh':
return 'API Error 0010: Address version number too high (or zero) in address: ' + toAddress raise APIError(10, 'Address version number too high (or zero) in address: ' + toAddress)
return 'API Error 0007: Could not decode address: ' + toAddress + ' : ' + status raise APIError(7, 'Could not decode address: ' + toAddress + ' : ' + status)
if addressVersionNumber < 2 or addressVersionNumber > 3: if addressVersionNumber < 2 or addressVersionNumber > 3:
return 'API Error 0011: The address version number currently must be 2 or 3. Others aren\'t supported. Check the toAddress.' raise APIError(11, 'The address version number currently must be 2 or 3. Others aren\'t supported. Check the toAddress.')
if streamNumber != 1: if streamNumber != 1:
return 'API Error 0012: The stream number must be 1. Others aren\'t supported. Check the toAddress.' raise APIError(12, 'The stream number must be 1. Others aren\'t supported. Check the toAddress.')
status, addressVersionNumber, streamNumber, fromRipe = decodeAddress( status, addressVersionNumber, streamNumber, fromRipe = decodeAddress(
fromAddress) fromAddress)
if status != 'success': if status != 'success':
@ -536,25 +542,25 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
print 'API Error 0007: Could not decode address:', fromAddress, ':', status print 'API Error 0007: Could not decode address:', fromAddress, ':', status
if status == 'checksumfailed': if status == 'checksumfailed':
return 'API Error 0008: Checksum failed for address: ' + fromAddress raise APIError(8, 'Checksum failed for address: ' + fromAddress)
if status == 'invalidcharacters': if status == 'invalidcharacters':
return 'API Error 0009: Invalid characters in address: ' + fromAddress raise APIError(9, 'Invalid characters in address: ' + fromAddress)
if status == 'versiontoohigh': if status == 'versiontoohigh':
return 'API Error 0010: Address version number too high (or zero) in address: ' + fromAddress raise APIError(10, 'Address version number too high (or zero) in address: ' + fromAddress)
return 'API Error 0007: Could not decode address: ' + fromAddress + ' : ' + status raise APIError(7, 'Could not decode address: ' + fromAddress + ' : ' + status)
if addressVersionNumber < 2 or addressVersionNumber > 3: if addressVersionNumber < 2 or addressVersionNumber > 3:
return 'API Error 0011: The address version number currently must be 2 or 3. Others aren\'t supported. Check the fromAddress.' raise APIError(11, 'The address version number currently must be 2 or 3. Others aren\'t supported. Check the fromAddress.')
if streamNumber != 1: if streamNumber != 1:
return 'API Error 0012: The stream number must be 1. Others aren\'t supported. Check the fromAddress.' raise APIError(12, 'The stream number must be 1. Others aren\'t supported. Check the fromAddress.')
toAddress = addBMIfNotPresent(toAddress) toAddress = addBMIfNotPresent(toAddress)
fromAddress = addBMIfNotPresent(fromAddress) fromAddress = addBMIfNotPresent(fromAddress)
try: try:
fromAddressEnabled = shared.config.getboolean( fromAddressEnabled = shared.config.getboolean(
fromAddress, 'enabled') fromAddress, 'enabled')
except: except:
return 'API Error 0013: Could not find your fromAddress in the keys.dat file.' raise APIError(13, 'Could not find your fromAddress in the keys.dat file.')
if not fromAddressEnabled: if not fromAddressEnabled:
return 'API Error 0014: Your fromAddress is disabled. Cannot send.' raise APIError(14, 'Your fromAddress is disabled. Cannot send.')
ackdata = OpenSSL.rand(32) ackdata = OpenSSL.rand(32)
@ -583,16 +589,16 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
elif method == 'sendBroadcast': elif method == 'sendBroadcast':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
if len(params) == 3: if len(params) == 3:
fromAddress, subject, message = params fromAddress, subject, message = params
encodingType = 2 encodingType = 2
elif len(params) == 4: elif len(params) == 4:
fromAddress, subject, message, encodingType = params fromAddress, subject, message, encodingType = params
if encodingType != 2: if encodingType != 2:
return 'API Error 0006: The encoding type must be 2 because that is the only one this program currently supports.' raise APIError(6, 'The encoding type must be 2 because that is the only one this program currently supports.')
subject = subject.decode('base64') subject = self._decode(subject, "base64")
message = message.decode('base64') message = self._decode(message, "base64")
status, addressVersionNumber, streamNumber, fromRipe = decodeAddress( status, addressVersionNumber, streamNumber, fromRipe = decodeAddress(
fromAddress) fromAddress)
@ -601,22 +607,22 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
print 'API Error 0007: Could not decode address:', fromAddress, ':', status print 'API Error 0007: Could not decode address:', fromAddress, ':', status
if status == 'checksumfailed': if status == 'checksumfailed':
return 'API Error 0008: Checksum failed for address: ' + fromAddress raise APIError(8, 'Checksum failed for address: ' + fromAddress)
if status == 'invalidcharacters': if status == 'invalidcharacters':
return 'API Error 0009: Invalid characters in address: ' + fromAddress raise APIError(9, 'Invalid characters in address: ' + fromAddress)
if status == 'versiontoohigh': if status == 'versiontoohigh':
return 'API Error 0010: Address version number too high (or zero) in address: ' + fromAddress raise APIError(10, 'Address version number too high (or zero) in address: ' + fromAddress)
return 'API Error 0007: Could not decode address: ' + fromAddress + ' : ' + status raise APIError(7, 'Could not decode address: ' + fromAddress + ' : ' + status)
if addressVersionNumber < 2 or addressVersionNumber > 3: if addressVersionNumber < 2 or addressVersionNumber > 3:
return 'API Error 0011: the address version number currently must be 2 or 3. Others aren\'t supported. Check the fromAddress.' raise APIError(11, 'the address version number currently must be 2 or 3. Others aren\'t supported. Check the fromAddress.')
if streamNumber != 1: if streamNumber != 1:
return 'API Error 0012: the stream number must be 1. Others aren\'t supported. Check the fromAddress.' raise APIError(12, 'the stream number must be 1. Others aren\'t supported. Check the fromAddress.')
fromAddress = addBMIfNotPresent(fromAddress) fromAddress = addBMIfNotPresent(fromAddress)
try: try:
fromAddressEnabled = shared.config.getboolean( fromAddressEnabled = shared.config.getboolean(
fromAddress, 'enabled') fromAddress, 'enabled')
except: except:
return 'API Error 0013: could not find your fromAddress in the keys.dat file.' raise APIError(13, 'could not find your fromAddress in the keys.dat file.')
ackdata = OpenSSL.rand(32) ackdata = OpenSSL.rand(32)
toAddress = '[Broadcast subscribers]' toAddress = '[Broadcast subscribers]'
ripe = '' ripe = ''
@ -634,14 +640,15 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return ackdata.encode('hex') return ackdata.encode('hex')
elif method == 'getStatus': elif method == 'getStatus':
if len(params) != 1: if len(params) != 1:
return 'API Error 0000: I need one parameter!' raise APIError(0, 'I need one parameter!')
ackdata, = params ackdata, = params
if len(ackdata) != 64: if len(ackdata) != 64:
return 'API Error 0015: The length of ackData should be 32 bytes (encoded in hex thus 64 characters).' raise APIError(15, 'The length of ackData should be 32 bytes (encoded in hex thus 64 characters).')
ackdata = self._decode(ackdata, "hex")
shared.sqlLock.acquire() shared.sqlLock.acquire()
shared.sqlSubmitQueue.put( shared.sqlSubmitQueue.put(
'''SELECT status FROM sent where ackdata=?''') '''SELECT status FROM sent where ackdata=?''')
shared.sqlSubmitQueue.put((ackdata.decode('hex'),)) shared.sqlSubmitQueue.put((ackdata,))
queryreturn = shared.sqlReturnQueue.get() queryreturn = shared.sqlReturnQueue.get()
shared.sqlLock.release() shared.sqlLock.release()
if queryreturn == []: if queryreturn == []:
@ -651,19 +658,19 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
return status return status
elif method == 'addSubscription': elif method == 'addSubscription':
if len(params) == 0: if len(params) == 0:
return 'API Error 0000: I need parameters!' raise APIError(0, 'I need parameters!')
if len(params) == 1: if len(params) == 1:
address, = params address, = params
label == '' label == ''
if len(params) == 2: if len(params) == 2:
address, label = params address, label = params
label = label.decode('base64') label = self._decode(label, "base64")
try: try:
unicode(label, 'utf-8') unicode(label, 'utf-8')
except: except:
return 'API Error 0017: Label is not valid UTF-8 data.' raise APIError(17, 'Label is not valid UTF-8 data.')
if len(params) > 2: if len(params) > 2:
return 'API Error 0000: I need either 1 or 2 parameters!' raise APIError(0, 'I need either 1 or 2 parameters!')
address = addBMIfNotPresent(address) address = addBMIfNotPresent(address)
status, addressVersionNumber, streamNumber, toRipe = decodeAddress( status, addressVersionNumber, streamNumber, toRipe = decodeAddress(
address) address)
@ -672,16 +679,16 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
print 'API Error 0007: Could not decode address:', address, ':', status print 'API Error 0007: Could not decode address:', address, ':', status
if status == 'checksumfailed': if status == 'checksumfailed':
return 'API Error 0008: Checksum failed for address: ' + address raise APIError(8, 'Checksum failed for address: ' + address)
if status == 'invalidcharacters': if status == 'invalidcharacters':
return 'API Error 0009: Invalid characters in address: ' + address raise APIError(9, 'Invalid characters in address: ' + address)
if status == 'versiontoohigh': if status == 'versiontoohigh':
return 'API Error 0010: Address version number too high (or zero) in address: ' + address raise APIError(10, 'Address version number too high (or zero) in address: ' + address)
return 'API Error 0007: Could not decode address: ' + address + ' : ' + status raise APIError(7, 'Could not decode address: ' + address + ' : ' + status)
if addressVersionNumber < 2 or addressVersionNumber > 3: if addressVersionNumber < 2 or addressVersionNumber > 3:
return 'API Error 0011: The address version number currently must be 2 or 3. Others aren\'t supported.' raise APIError(11, 'The address version number currently must be 2 or 3. Others aren\'t supported.')
if streamNumber != 1: if streamNumber != 1:
return 'API Error 0012: The stream number must be 1. Others aren\'t supported.' raise APIError(12, 'The stream number must be 1. Others aren\'t supported.')
# First we must check to see if the address is already in the # First we must check to see if the address is already in the
# subscriptions list. # subscriptions list.
shared.sqlLock.acquire() shared.sqlLock.acquire()
@ -692,7 +699,7 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
queryreturn = shared.sqlReturnQueue.get() queryreturn = shared.sqlReturnQueue.get()
shared.sqlLock.release() shared.sqlLock.release()
if queryreturn != []: if queryreturn != []:
return 'API Error 0016: You are already subscribed to that address.' raise APIError(16, 'You are already subscribed to that address.')
t = (label, address, True) t = (label, address, True)
shared.sqlLock.acquire() shared.sqlLock.acquire()
shared.sqlSubmitQueue.put( shared.sqlSubmitQueue.put(
@ -708,7 +715,7 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
elif method == 'deleteSubscription': elif method == 'deleteSubscription':
if len(params) != 1: if len(params) != 1:
return 'API Error 0000: I need 1 parameter!' raise APIError(0, 'I need 1 parameter!')
address, = params address, = params
address = addBMIfNotPresent(address) address = addBMIfNotPresent(address)
t = (address,) t = (address,)
@ -745,9 +752,9 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
# object and sends it out to the rest of the Bitmessage network as if it had generated the # object and sends it out to the rest of the Bitmessage network as if it had generated the
# message itself. Please do not yet add this to the api doc. # message itself. Please do not yet add this to the api doc.
if len(params) != 1: if len(params) != 1:
return 'API Error 0000: I need 1 parameter!' raise APIError(0, 'I need 1 parameter!')
encryptedPayload, = params encryptedPayload, = params
encryptedPayload = encryptedPayload.decode('hex') encryptedPayload = self._decode(encryptedPayload, "hex")
toStreamNumber = decodeVarint(encryptedPayload[16:26])[0] toStreamNumber = decodeVarint(encryptedPayload[16:26])[0]
inventoryHash = calculateInventoryHash(encryptedPayload) inventoryHash = calculateInventoryHash(encryptedPayload)
objectType = 'msg' objectType = 'msg'
@ -764,9 +771,9 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
# rest of the Bitmessage network as if it had generated the pubkey object itself. Please # rest of the Bitmessage network as if it had generated the pubkey object itself. Please
# do not yet add this to the api doc. # do not yet add this to the api doc.
if len(params) != 1: if len(params) != 1:
return 'API Error 0000: I need 1 parameter!' raise APIError(0, 'I need 1 parameter!')
payload, = params payload, = params
payload = payload.decode('hex') payload = self._decode(payload, "hex")
pubkeyReadPosition = 8 # bypass the nonce pubkeyReadPosition = 8 # bypass the nonce
if payload[pubkeyReadPosition:pubkeyReadPosition+4] == '\x00\x00\x00\x00': # if this pubkey uses 8 byte time if payload[pubkeyReadPosition:pubkeyReadPosition+4] == '\x00\x00\x00\x00': # if this pubkey uses 8 byte time
pubkeyReadPosition += 8 pubkeyReadPosition += 8
@ -789,11 +796,11 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
# doc. # doc.
if len(params) != 1: if len(params) != 1:
return 'API Error 0000: I need 1 parameter!' raise APIError(0, 'I need 1 parameter!')
requestedHash, = params requestedHash, = params
if len(requestedHash) != 40: if len(requestedHash) != 40:
return 'API Error 0019: The length of hash should be 20 bytes (encoded in hex thus 40 characters).' raise APIError(19, 'The length of hash should be 20 bytes (encoded in hex thus 40 characters).')
requestedHash = requestedHash.decode('hex') requestedHash = self._decode(requestedHash, "hex")
# This is not a particularly commonly used API function. Before we # This is not a particularly commonly used API function. Before we
# use it we'll need to fill out a field in our inventory database # use it we'll need to fill out a field in our inventory database
@ -831,11 +838,11 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
# Method will eventually be used by a particular Android app to # Method will eventually be used by a particular Android app to
# retrieve pubkeys. Please do not yet add this to the api docs. # retrieve pubkeys. Please do not yet add this to the api docs.
if len(params) != 1: if len(params) != 1:
return 'API Error 0000: I need 1 parameter!' raise APIError(0, 'I need 1 parameter!')
requestedHash, = params requestedHash, = params
if len(requestedHash) != 40: if len(requestedHash) != 40:
return 'API Error 0019: The length of hash should be 20 bytes (encoded in hex thus 40 characters).' raise APIError(19, 'The length of hash should be 20 bytes (encoded in hex thus 40 characters).')
requestedHash = requestedHash.decode('hex') requestedHash = self._decode(requestedHash, "hex")
parameters = (requestedHash,) parameters = (requestedHash,)
with shared.sqlLock: with shared.sqlLock:
shared.sqlSubmitQueue.put('''SELECT transmitdata FROM pubkeys WHERE hash = ? ; ''') shared.sqlSubmitQueue.put('''SELECT transmitdata FROM pubkeys WHERE hash = ? ; ''')
@ -850,7 +857,24 @@ class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
elif method == 'clientStatus': elif method == 'clientStatus':
return '{ "networkConnections" : "%s" }' % str(len(shared.connectedHostsList)) return '{ "networkConnections" : "%s" }' % str(len(shared.connectedHostsList))
else: else:
return 'API Error 0020: Invalid method: %s' % method raise APIError(20, 'Invalid method: %s' % method)
def _dispatch(self, method, params):
self.cookies = []
validuser = self.APIAuthenticateClient()
if not validuser:
time.sleep(2)
return "RPC Username or password incorrect or HTTP header lacks authentication at all."
try:
return self._handle_request(method, params)
except APIError as e:
return str(e)
except Exception as e:
print(e)
print(sys.exc_info()[0])
return "API Error 0021: Unexpected API Failure - %s" % str(e)
# This thread, of which there is only one, runs the API. # This thread, of which there is only one, runs the API.