1484 lines
60 KiB
Python
1484 lines
60 KiB
Python
# pylint: disable=too-many-locals,too-many-lines,no-self-use,too-many-public-methods,too-many-branches
|
|
# pylint: disable=too-many-statements
|
|
|
|
# Copyright (c) 2012-2016 Jonathan Warren
|
|
# Copyright (c) 2012-2019 The Bitmessage developers
|
|
|
|
"""
|
|
This is not what you run to run the Bitmessage API. Instead, enable the API
|
|
( https://bitmessage.org/wiki/API ) and optionally enable daemon mode
|
|
( https://bitmessage.org/wiki/Daemon ) then run bitmessagemain.py.
|
|
"""
|
|
|
|
import base64
|
|
import errno
|
|
import hashlib
|
|
import json
|
|
import random # nosec
|
|
import socket
|
|
import subprocess
|
|
import time
|
|
from binascii import hexlify, unhexlify
|
|
from SimpleXMLRPCServer import SimpleXMLRPCRequestHandler, SimpleXMLRPCServer
|
|
from struct import pack
|
|
|
|
from version import softwareVersion
|
|
|
|
import defaults
|
|
import helper_inbox
|
|
import helper_sent
|
|
import network.stats
|
|
import proofofwork
|
|
import queues
|
|
import shared
|
|
import shutdown
|
|
import state
|
|
from addresses import addBMIfNotPresent, calculateInventoryHash, decodeAddress, decodeVarint, varintDecodeError
|
|
from bmconfigparser import BMConfigParser
|
|
from debug import logger
|
|
from helper_ackPayload import genAckPayload
|
|
from helper_sql import SqlBulkExecute, sqlExecute, sqlQuery, sqlStoredProcedure
|
|
from inventory import Inventory
|
|
from network.threads import StoppableThread
|
|
|
|
str_chan = '[chan]'
|
|
|
|
|
|
class APIError(Exception):
|
|
"""APIError exception class"""
|
|
|
|
def __init__(self, error_number, error_message):
|
|
super(APIError, self).__init__()
|
|
self.error_number = error_number
|
|
self.error_message = error_message
|
|
|
|
def __str__(self):
|
|
return "API Error %04i: %s" % (self.error_number, self.error_message)
|
|
|
|
|
|
class StoppableXMLRPCServer(SimpleXMLRPCServer):
|
|
"""A SimpleXMLRPCServer that honours state.shutdown"""
|
|
allow_reuse_address = True
|
|
|
|
def serve_forever(self):
|
|
"""Start the SimpleXMLRPCServer"""
|
|
# pylint: disable=arguments-differ
|
|
while state.shutdown == 0:
|
|
self.handle_request()
|
|
|
|
|
|
# This thread, of which there is only one, runs the API.
|
|
class singleAPI(StoppableThread):
|
|
"""API thread"""
|
|
|
|
name = "singleAPI"
|
|
|
|
def stopThread(self):
|
|
super(singleAPI, self).stopThread()
|
|
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
try:
|
|
s.connect((
|
|
BMConfigParser().get('bitmessagesettings', 'apiinterface'),
|
|
BMConfigParser().getint('bitmessagesettings', 'apiport')
|
|
))
|
|
s.shutdown(socket.SHUT_RDWR)
|
|
s.close()
|
|
except BaseException:
|
|
pass
|
|
|
|
def run(self):
|
|
port = BMConfigParser().getint('bitmessagesettings', 'apiport')
|
|
try:
|
|
getattr(errno, 'WSAEADDRINUSE')
|
|
except AttributeError:
|
|
errno.WSAEADDRINUSE = errno.EADDRINUSE
|
|
for attempt in range(50):
|
|
try:
|
|
if attempt > 0:
|
|
logger.warning(
|
|
'Failed to start API listener on port %s', port)
|
|
port = random.randint(32767, 65535)
|
|
se = StoppableXMLRPCServer(
|
|
(BMConfigParser().get(
|
|
'bitmessagesettings', 'apiinterface'),
|
|
port),
|
|
MySimpleXMLRPCRequestHandler, True, True)
|
|
except socket.error as e:
|
|
if e.errno in (errno.EADDRINUSE, errno.WSAEADDRINUSE):
|
|
continue
|
|
else:
|
|
if attempt > 0:
|
|
logger.warning('Setting apiport to %s', port)
|
|
BMConfigParser().set(
|
|
'bitmessagesettings', 'apiport', str(port))
|
|
BMConfigParser().save()
|
|
break
|
|
se.register_introspection_functions()
|
|
|
|
apiNotifyPath = BMConfigParser().safeGet(
|
|
'bitmessagesettings', 'apinotifypath')
|
|
|
|
if apiNotifyPath:
|
|
logger.info('Trying to call %s', apiNotifyPath)
|
|
try:
|
|
subprocess.call([apiNotifyPath, "startingUp"])
|
|
except OSError:
|
|
logger.warning(
|
|
'Failed to call %s, removing apinotifypath setting',
|
|
apiNotifyPath)
|
|
BMConfigParser().remove_option(
|
|
'bitmessagesettings', 'apinotifypath')
|
|
|
|
se.serve_forever()
|
|
|
|
|
|
class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
|
|
"""
|
|
This is one of several classes that constitute the API
|
|
|
|
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/
|
|
"""
|
|
|
|
def do_POST(self):
|
|
"""
|
|
Handles the HTTP POST request.
|
|
|
|
Attempts to interpret all HTTP POST requests as XML-RPC calls,
|
|
which are forwarded to the server's _dispatch method for handling.
|
|
|
|
Note: this method is the same as in SimpleXMLRPCRequestHandler,
|
|
just hacked to handle cookies
|
|
"""
|
|
|
|
# Check that the path is legal
|
|
if not self.is_rpc_path_valid():
|
|
self.report_404()
|
|
return
|
|
|
|
try:
|
|
# Get arguments by reading body of request.
|
|
# We read this in chunks to avoid straining
|
|
# socket.read(); around the 10 or 15Mb mark, some platforms
|
|
# begin to have problems (bug #792570).
|
|
max_chunk_size = 10 * 1024 * 1024
|
|
size_remaining = int(self.headers["content-length"])
|
|
L = []
|
|
while size_remaining:
|
|
chunk_size = min(size_remaining, max_chunk_size)
|
|
L.append(self.rfile.read(chunk_size))
|
|
size_remaining -= len(L[-1])
|
|
data = ''.join(L)
|
|
|
|
# In previous versions of SimpleXMLRPCServer, _dispatch
|
|
# could be overridden in this class, instead of in
|
|
# SimpleXMLRPCDispatcher. To maintain backwards compatibility,
|
|
# check to see if a subclass implements _dispatch and dispatch
|
|
# using that method if present.
|
|
response = self.server._marshaled_dispatch( # pylint: disable=protected-access
|
|
data, getattr(self, '_dispatch', None)
|
|
)
|
|
except BaseException: # This should only happen if the module is buggy
|
|
# internal error, report as HTTP server error
|
|
self.send_response(500)
|
|
self.end_headers()
|
|
else:
|
|
# got a valid XML RPC response
|
|
self.send_response(200)
|
|
self.send_header("Content-type", "text/xml")
|
|
self.send_header("Content-length", str(len(response)))
|
|
|
|
# HACK :start -> sends cookies here
|
|
if self.cookies:
|
|
for cookie in self.cookies:
|
|
self.send_header('Set-Cookie', cookie.output(header=''))
|
|
# HACK :end
|
|
|
|
self.end_headers()
|
|
self.wfile.write(response)
|
|
|
|
# shut down the connection
|
|
self.wfile.flush()
|
|
self.connection.shutdown(1)
|
|
|
|
# actually handle shutdown command after sending response
|
|
if state.shutdown is False:
|
|
shutdown.doCleanShutdown()
|
|
|
|
def APIAuthenticateClient(self):
|
|
"""Predicate to check for valid API credentials in the request header"""
|
|
|
|
if 'Authorization' in self.headers:
|
|
# handle Basic authentication
|
|
_, encstr = self.headers.get('Authorization').split()
|
|
emailid, password = encstr.decode('base64').split(':')
|
|
return (
|
|
emailid == BMConfigParser().get('bitmessagesettings', 'apiusername') and
|
|
password == BMConfigParser().get('bitmessagesettings', 'apipassword')
|
|
)
|
|
else:
|
|
logger.warning(
|
|
'Authentication failed because header lacks'
|
|
' Authentication field')
|
|
time.sleep(2)
|
|
|
|
return False
|
|
|
|
def _decode(self, text, decode_type):
|
|
try:
|
|
if decode_type == 'hex':
|
|
return unhexlify(text)
|
|
elif decode_type == 'base64':
|
|
return base64.b64decode(text)
|
|
except Exception as e:
|
|
raise APIError(
|
|
22, "Decode error - %s. Had trouble while decoding string: %r"
|
|
% (e, text)
|
|
)
|
|
return None
|
|
|
|
def _verifyAddress(self, address):
|
|
status, addressVersionNumber, streamNumber, ripe = \
|
|
decodeAddress(address)
|
|
if status != 'success':
|
|
logger.warning(
|
|
'API Error 0007: Could not decode address %s. Status: %s.',
|
|
address, status
|
|
)
|
|
|
|
if status == 'checksumfailed':
|
|
raise APIError(8, 'Checksum failed for address: ' + address)
|
|
if status == 'invalidcharacters':
|
|
raise APIError(9, 'Invalid characters in address: ' + address)
|
|
if status == 'versiontoohigh':
|
|
raise APIError(10, 'Address version number too high (or zero) in address: ' + address)
|
|
if status == 'varintmalformed':
|
|
raise APIError(26, 'Malformed varint in address: ' + address)
|
|
raise APIError(7, 'Could not decode address: %s : %s' % (address, status))
|
|
if addressVersionNumber < 2 or addressVersionNumber > 4:
|
|
raise APIError(
|
|
11, 'The address version number currently must be 2, 3 or 4.'
|
|
' Others aren\'t supported. Check the address.'
|
|
)
|
|
if streamNumber != 1:
|
|
raise APIError(
|
|
12, 'The stream number must be 1. Others aren\'t supported.'
|
|
' Check the address.'
|
|
)
|
|
|
|
return (status, addressVersionNumber, streamNumber, ripe)
|
|
|
|
# Request Handlers
|
|
|
|
def HandleListAddresses(self, method):
|
|
"""Handle a request to list addresses"""
|
|
|
|
data = '{"addresses":['
|
|
for addressInKeysFile in BMConfigParser().addresses():
|
|
status, addressVersionNumber, streamNumber, hash01 = decodeAddress( # pylint: disable=unused-variable
|
|
addressInKeysFile)
|
|
if len(data) > 20:
|
|
data += ','
|
|
if BMConfigParser().has_option(addressInKeysFile, 'chan'):
|
|
chan = BMConfigParser().getboolean(addressInKeysFile, 'chan')
|
|
else:
|
|
chan = False
|
|
label = BMConfigParser().get(addressInKeysFile, 'label')
|
|
if method == 'listAddresses2':
|
|
label = base64.b64encode(label)
|
|
data += json.dumps({
|
|
'label': label,
|
|
'address': addressInKeysFile,
|
|
'stream': streamNumber,
|
|
'enabled':
|
|
BMConfigParser().getboolean(addressInKeysFile, 'enabled'),
|
|
'chan': chan
|
|
}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleListAddressBookEntries(self, params):
|
|
"""Handle a request to list address book entries"""
|
|
|
|
if len(params) == 1:
|
|
label, = params
|
|
label = self._decode(label, "base64")
|
|
queryreturn = sqlQuery(
|
|
"SELECT label, address from addressbook WHERE label = ?",
|
|
label)
|
|
elif len(params) > 1:
|
|
raise APIError(0, "Too many paremeters, max 1")
|
|
else:
|
|
queryreturn = sqlQuery("SELECT label, address from addressbook")
|
|
data = '{"addresses":['
|
|
for row in queryreturn:
|
|
label, address = row
|
|
label = shared.fixPotentiallyInvalidUTF8Data(label)
|
|
if len(data) > 20:
|
|
data += ','
|
|
data += json.dumps({
|
|
'label': base64.b64encode(label),
|
|
'address': address}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleAddAddressBookEntry(self, params):
|
|
"""Handle a request to add an address book entry"""
|
|
|
|
if len(params) != 2:
|
|
raise APIError(0, "I need label and address")
|
|
address, label = params
|
|
label = self._decode(label, "base64")
|
|
address = addBMIfNotPresent(address)
|
|
self._verifyAddress(address)
|
|
queryreturn = sqlQuery(
|
|
"SELECT address FROM addressbook WHERE address=?", address)
|
|
if queryreturn != []:
|
|
raise APIError(
|
|
16, 'You already have this address in your address book.')
|
|
|
|
sqlExecute("INSERT INTO addressbook VALUES(?,?)", label, address)
|
|
queues.UISignalQueue.put(('rerenderMessagelistFromLabels', ''))
|
|
queues.UISignalQueue.put(('rerenderMessagelistToLabels', ''))
|
|
queues.UISignalQueue.put(('rerenderAddressBook', ''))
|
|
return "Added address %s to address book" % address
|
|
|
|
def HandleDeleteAddressBookEntry(self, params):
|
|
"""Handle a request to delete an address book entry"""
|
|
|
|
if len(params) != 1:
|
|
raise APIError(0, "I need an address")
|
|
address, = params
|
|
address = addBMIfNotPresent(address)
|
|
self._verifyAddress(address)
|
|
sqlExecute('DELETE FROM addressbook WHERE address=?', address)
|
|
queues.UISignalQueue.put(('rerenderMessagelistFromLabels', ''))
|
|
queues.UISignalQueue.put(('rerenderMessagelistToLabels', ''))
|
|
queues.UISignalQueue.put(('rerenderAddressBook', ''))
|
|
return "Deleted address book entry for %s if it existed" % address
|
|
|
|
def HandleCreateRandomAddress(self, params):
|
|
"""Handle a request to create a random address"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
|
|
elif len(params) == 1:
|
|
label, = params
|
|
eighteenByteRipe = False
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
elif len(params) == 2:
|
|
label, eighteenByteRipe = params
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
elif len(params) == 3:
|
|
label, eighteenByteRipe, totalDifficulty = params
|
|
nonceTrialsPerByte = int(
|
|
defaults.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty)
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
elif len(params) == 4:
|
|
label, eighteenByteRipe, totalDifficulty, \
|
|
smallMessageDifficulty = params
|
|
nonceTrialsPerByte = int(
|
|
defaults.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty)
|
|
payloadLengthExtraBytes = int(
|
|
defaults.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty)
|
|
else:
|
|
raise APIError(0, 'Too many parameters!')
|
|
label = self._decode(label, "base64")
|
|
try:
|
|
unicode(label, 'utf-8')
|
|
except BaseException:
|
|
raise APIError(17, 'Label is not valid UTF-8 data.')
|
|
queues.apiAddressGeneratorReturnQueue.queue.clear()
|
|
streamNumberForAddress = 1
|
|
queues.addressGeneratorQueue.put((
|
|
'createRandomAddress', 4, streamNumberForAddress, label, 1, "",
|
|
eighteenByteRipe, nonceTrialsPerByte, payloadLengthExtraBytes
|
|
))
|
|
return queues.apiAddressGeneratorReturnQueue.get()
|
|
|
|
def HandleCreateDeterministicAddresses(self, params):
|
|
"""Handle a request to create a deterministic address"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
|
|
elif len(params) == 1:
|
|
passphrase, = params
|
|
numberOfAddresses = 1
|
|
addressVersionNumber = 0
|
|
streamNumber = 0
|
|
eighteenByteRipe = False
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
|
|
elif len(params) == 2:
|
|
passphrase, numberOfAddresses = params
|
|
addressVersionNumber = 0
|
|
streamNumber = 0
|
|
eighteenByteRipe = False
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
|
|
elif len(params) == 3:
|
|
passphrase, numberOfAddresses, addressVersionNumber = params
|
|
streamNumber = 0
|
|
eighteenByteRipe = False
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
|
|
elif len(params) == 4:
|
|
passphrase, numberOfAddresses, addressVersionNumber, \
|
|
streamNumber = params
|
|
eighteenByteRipe = False
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
|
|
elif len(params) == 5:
|
|
passphrase, numberOfAddresses, addressVersionNumber, \
|
|
streamNumber, eighteenByteRipe = params
|
|
nonceTrialsPerByte = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultnoncetrialsperbyte')
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
|
|
elif len(params) == 6:
|
|
passphrase, numberOfAddresses, addressVersionNumber, \
|
|
streamNumber, eighteenByteRipe, totalDifficulty = params
|
|
nonceTrialsPerByte = int(
|
|
defaults.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty)
|
|
payloadLengthExtraBytes = BMConfigParser().get(
|
|
'bitmessagesettings', 'defaultpayloadlengthextrabytes')
|
|
|
|
elif len(params) == 7:
|
|
passphrase, numberOfAddresses, addressVersionNumber, \
|
|
streamNumber, eighteenByteRipe, totalDifficulty, \
|
|
smallMessageDifficulty = params
|
|
nonceTrialsPerByte = int(
|
|
defaults.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty)
|
|
payloadLengthExtraBytes = int(
|
|
defaults.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty)
|
|
else:
|
|
raise APIError(0, 'Too many parameters!')
|
|
if not passphrase:
|
|
raise APIError(1, 'The specified passphrase is blank.')
|
|
if not isinstance(eighteenByteRipe, bool):
|
|
raise APIError(
|
|
23, 'Bool expected in eighteenByteRipe, saw %s instead' %
|
|
type(eighteenByteRipe))
|
|
passphrase = self._decode(passphrase, "base64")
|
|
# 0 means "just use the proper addressVersionNumber"
|
|
if addressVersionNumber == 0:
|
|
addressVersionNumber = 4
|
|
if addressVersionNumber != 3 and addressVersionNumber != 4:
|
|
raise APIError(
|
|
2, 'The address version number currently must be 3, 4, or 0'
|
|
' (which means auto-select). %i isn\'t supported.' %
|
|
addressVersionNumber)
|
|
if streamNumber == 0: # 0 means "just use the most available stream"
|
|
streamNumber = 1
|
|
if streamNumber != 1:
|
|
raise APIError(
|
|
3, 'The stream number must be 1 (or 0 which means'
|
|
' auto-select). Others aren\'t supported.')
|
|
if numberOfAddresses == 0:
|
|
raise APIError(
|
|
4, 'Why would you ask me to generate 0 addresses for you?')
|
|
if numberOfAddresses > 999:
|
|
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.')
|
|
queues.apiAddressGeneratorReturnQueue.queue.clear()
|
|
logger.debug(
|
|
'Requesting that the addressGenerator create %s addresses.',
|
|
numberOfAddresses)
|
|
queues.addressGeneratorQueue.put((
|
|
'createDeterministicAddresses', addressVersionNumber, streamNumber,
|
|
'unused API address', numberOfAddresses, passphrase,
|
|
eighteenByteRipe, nonceTrialsPerByte, payloadLengthExtraBytes
|
|
))
|
|
data = '{"addresses":['
|
|
queueReturn = queues.apiAddressGeneratorReturnQueue.get()
|
|
for item in queueReturn:
|
|
if len(data) > 20:
|
|
data += ','
|
|
data += "\"" + item + "\""
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetDeterministicAddress(self, params):
|
|
"""Handle a request to get a deterministic address"""
|
|
|
|
if len(params) != 3:
|
|
raise APIError(0, 'I need exactly 3 parameters.')
|
|
passphrase, addressVersionNumber, streamNumber = params
|
|
numberOfAddresses = 1
|
|
eighteenByteRipe = False
|
|
if not passphrase:
|
|
raise APIError(1, 'The specified passphrase is blank.')
|
|
passphrase = self._decode(passphrase, "base64")
|
|
if addressVersionNumber != 3 and addressVersionNumber != 4:
|
|
raise APIError(
|
|
2, 'The address version number currently must be 3 or 4. %i'
|
|
' isn\'t supported.' % addressVersionNumber)
|
|
if streamNumber != 1:
|
|
raise APIError(
|
|
3, ' The stream number must be 1. Others aren\'t supported.')
|
|
queues.apiAddressGeneratorReturnQueue.queue.clear()
|
|
logger.debug(
|
|
'Requesting that the addressGenerator create %s addresses.',
|
|
numberOfAddresses)
|
|
queues.addressGeneratorQueue.put((
|
|
'getDeterministicAddress', addressVersionNumber, streamNumber,
|
|
'unused API address', numberOfAddresses, passphrase,
|
|
eighteenByteRipe
|
|
))
|
|
return queues.apiAddressGeneratorReturnQueue.get()
|
|
|
|
def HandleCreateChan(self, params):
|
|
"""Handle a request to create a chan"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters.')
|
|
|
|
elif len(params) == 1:
|
|
passphrase, = params
|
|
passphrase = self._decode(passphrase, "base64")
|
|
|
|
if not passphrase:
|
|
raise APIError(1, 'The specified passphrase is blank.')
|
|
# It would be nice to make the label the passphrase but it is
|
|
# possible that the passphrase contains non-utf-8 characters.
|
|
try:
|
|
unicode(passphrase, 'utf-8')
|
|
label = str_chan + ' ' + passphrase
|
|
except BaseException:
|
|
label = str_chan + ' ' + repr(passphrase)
|
|
|
|
addressVersionNumber = 4
|
|
streamNumber = 1
|
|
queues.apiAddressGeneratorReturnQueue.queue.clear()
|
|
logger.debug(
|
|
'Requesting that the addressGenerator create chan %s.', passphrase)
|
|
queues.addressGeneratorQueue.put((
|
|
'createChan', addressVersionNumber, streamNumber, label,
|
|
passphrase, True
|
|
))
|
|
queueReturn = queues.apiAddressGeneratorReturnQueue.get()
|
|
if not queueReturn:
|
|
raise APIError(24, 'Chan address is already present.')
|
|
address = queueReturn[0]
|
|
return address
|
|
|
|
def HandleJoinChan(self, params):
|
|
"""Handle a request to join a chan"""
|
|
|
|
if len(params) < 2:
|
|
raise APIError(0, 'I need two parameters.')
|
|
elif len(params) == 2:
|
|
passphrase, suppliedAddress = params
|
|
passphrase = self._decode(passphrase, "base64")
|
|
if not passphrase:
|
|
raise APIError(1, 'The specified passphrase is blank.')
|
|
# It would be nice to make the label the passphrase but it is
|
|
# possible that the passphrase contains non-utf-8 characters.
|
|
try:
|
|
unicode(passphrase, 'utf-8')
|
|
label = str_chan + ' ' + passphrase
|
|
except BaseException:
|
|
label = str_chan + ' ' + repr(passphrase)
|
|
|
|
status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress( # pylint: disable=unused-variable
|
|
suppliedAddress)
|
|
suppliedAddress = addBMIfNotPresent(suppliedAddress)
|
|
queues.apiAddressGeneratorReturnQueue.queue.clear()
|
|
queues.addressGeneratorQueue.put((
|
|
'joinChan', suppliedAddress, label, passphrase, True
|
|
))
|
|
addressGeneratorReturnValue = \
|
|
queues.apiAddressGeneratorReturnQueue.get()
|
|
|
|
if addressGeneratorReturnValue[0] == \
|
|
'chan name does not match address':
|
|
raise APIError(18, 'Chan name does not match address.')
|
|
if not addressGeneratorReturnValue:
|
|
raise APIError(24, 'Chan address is already present.')
|
|
return "success"
|
|
|
|
def HandleLeaveChan(self, params):
|
|
"""Handle a request to leave a chan"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters.')
|
|
elif len(params) == 1:
|
|
address, = params
|
|
# pylint: disable=unused-variable
|
|
status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(address)
|
|
address = addBMIfNotPresent(address)
|
|
if not BMConfigParser().has_section(address):
|
|
raise APIError(
|
|
13, 'Could not find this address in your keys.dat file.')
|
|
if not BMConfigParser().safeGetBoolean(address, 'chan'):
|
|
raise APIError(
|
|
25, 'Specified address is not a chan address.'
|
|
' Use deleteAddress API call instead.')
|
|
BMConfigParser().remove_section(address)
|
|
with open(state.appdata + 'keys.dat', 'wb') as configfile:
|
|
BMConfigParser().write(configfile)
|
|
return 'success'
|
|
|
|
def HandleDeleteAddress(self, params):
|
|
"""Handle a request to delete an address"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters.')
|
|
elif len(params) == 1:
|
|
address, = params
|
|
# pylint: disable=unused-variable
|
|
status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(address)
|
|
address = addBMIfNotPresent(address)
|
|
if not BMConfigParser().has_section(address):
|
|
raise APIError(
|
|
13, 'Could not find this address in your keys.dat file.')
|
|
BMConfigParser().remove_section(address)
|
|
with open(state.appdata + 'keys.dat', 'wb') as configfile:
|
|
BMConfigParser().write(configfile)
|
|
queues.UISignalQueue.put(('writeNewAddressToTable', ('', '', '')))
|
|
shared.reloadMyAddressHashes()
|
|
return 'success'
|
|
|
|
def HandleGetAllInboxMessages(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to get all inbox messages"""
|
|
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, received, message,"
|
|
" encodingtype, read FROM inbox where folder='inbox'"
|
|
" ORDER BY received"
|
|
)
|
|
data = '{"inboxMessages":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, received, message, \
|
|
encodingtype, read = row
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'receivedTime': received,
|
|
'read': read}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetAllInboxMessageIds(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to get all inbox message IDs"""
|
|
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid FROM inbox where folder='inbox' ORDER BY received")
|
|
data = '{"inboxMessageIds":['
|
|
for row in queryreturn:
|
|
msgid = row[0]
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps(
|
|
{'msgid': hexlify(msgid)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetInboxMessageById(self, params):
|
|
"""Handle a request to get an inbox messsage by ID"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
elif len(params) == 1:
|
|
msgid = self._decode(params[0], "hex")
|
|
elif len(params) >= 2:
|
|
msgid = self._decode(params[0], "hex")
|
|
readStatus = params[1]
|
|
if not isinstance(readStatus, bool):
|
|
raise APIError(
|
|
23, 'Bool expected in readStatus, saw %s instead.' %
|
|
type(readStatus))
|
|
queryreturn = sqlQuery(
|
|
"SELECT read FROM inbox WHERE msgid=?", msgid)
|
|
# UPDATE is slow, only update if status is different
|
|
if queryreturn != [] and (queryreturn[0][0] == 1) != readStatus:
|
|
sqlExecute(
|
|
"UPDATE inbox set read = ? WHERE msgid=?",
|
|
readStatus, msgid)
|
|
queues.UISignalQueue.put(('changedInboxUnread', None))
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, received, message,"
|
|
" encodingtype, read FROM inbox WHERE msgid=?", msgid
|
|
)
|
|
data = '{"inboxMessage":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, received, message, \
|
|
encodingtype, read = row
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'receivedTime': received,
|
|
'read': read}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetAllSentMessages(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to get all sent messages"""
|
|
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, lastactiontime,"
|
|
" message, encodingtype, status, ackdata FROM sent"
|
|
" WHERE folder='sent' ORDER BY lastactiontime"
|
|
)
|
|
data = '{"sentMessages":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, lastactiontime, message, \
|
|
encodingtype, status, ackdata = row
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'lastActionTime': lastactiontime,
|
|
'status': status,
|
|
'ackData': hexlify(ackdata)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetAllSentMessageIds(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to get all sent message IDs"""
|
|
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid FROM sent where folder='sent'"
|
|
" ORDER BY lastactiontime"
|
|
)
|
|
data = '{"sentMessageIds":['
|
|
for row in queryreturn:
|
|
msgid = row[0]
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps(
|
|
{'msgid': hexlify(msgid)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleInboxMessagesByReceiver(self, params):
|
|
"""Handle a request to get inbox messages by receiver"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
toAddress = params[0]
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, received, message,"
|
|
" encodingtype FROM inbox WHERE folder='inbox' AND toAddress=?",
|
|
toAddress)
|
|
data = '{"inboxMessages":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, received, message, \
|
|
encodingtype = row
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'receivedTime': received}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetSentMessageById(self, params):
|
|
"""Handle a request to get a sent message by ID"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
msgid = self._decode(params[0], "hex")
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, lastactiontime,"
|
|
" message, encodingtype, status, ackdata FROM sent WHERE msgid=?",
|
|
msgid
|
|
)
|
|
data = '{"sentMessage":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, lastactiontime, message, \
|
|
encodingtype, status, ackdata = row
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'lastActionTime': lastactiontime,
|
|
'status': status,
|
|
'ackData': hexlify(ackdata)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetSentMessagesByAddress(self, params):
|
|
"""Handle a request to get sent messages by address"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
fromAddress = params[0]
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, lastactiontime,"
|
|
" message, encodingtype, status, ackdata FROM sent"
|
|
" WHERE folder='sent' AND fromAddress=? ORDER BY lastactiontime",
|
|
fromAddress
|
|
)
|
|
data = '{"sentMessages":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, lastactiontime, message, \
|
|
encodingtype, status, ackdata = row # pylint: disable=unused-variable
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'lastActionTime': lastactiontime,
|
|
'status': status,
|
|
'ackData': hexlify(ackdata)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleGetSentMessagesByAckData(self, params):
|
|
"""Handle a request to get sent messages by ack data"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
ackData = self._decode(params[0], "hex")
|
|
queryreturn = sqlQuery(
|
|
"SELECT msgid, toaddress, fromaddress, subject, lastactiontime,"
|
|
" message, encodingtype, status, ackdata FROM sent"
|
|
" WHERE ackdata=?", ackData
|
|
)
|
|
data = '{"sentMessage":['
|
|
for row in queryreturn:
|
|
msgid, toAddress, fromAddress, subject, lastactiontime, message, \
|
|
encodingtype, status, ackdata = row
|
|
subject = shared.fixPotentiallyInvalidUTF8Data(subject)
|
|
message = shared.fixPotentiallyInvalidUTF8Data(message)
|
|
data += json.dumps({
|
|
'msgid': hexlify(msgid),
|
|
'toAddress': toAddress,
|
|
'fromAddress': fromAddress,
|
|
'subject': base64.b64encode(subject),
|
|
'message': base64.b64encode(message),
|
|
'encodingType': encodingtype,
|
|
'lastActionTime': lastactiontime,
|
|
'status': status,
|
|
'ackData': hexlify(ackdata)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleTrashMessage(self, params):
|
|
"""Handle a request to trash a message by ID"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
msgid = self._decode(params[0], "hex")
|
|
|
|
# Trash if in inbox table
|
|
helper_inbox.trash(msgid)
|
|
# Trash if in sent table
|
|
sqlExecute('''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid)
|
|
return 'Trashed message (assuming message existed).'
|
|
|
|
def HandleTrashInboxMessage(self, params):
|
|
"""Handle a request to trash an inbox message by ID"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
msgid = self._decode(params[0], "hex")
|
|
helper_inbox.trash(msgid)
|
|
return 'Trashed inbox message (assuming message existed).'
|
|
|
|
def HandleTrashSentMessage(self, params):
|
|
"""Handle a request to trash a sent message by ID"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
msgid = self._decode(params[0], "hex")
|
|
sqlExecute('''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid)
|
|
return 'Trashed sent message (assuming message existed).'
|
|
|
|
def HandleSendMessage(self, params):
|
|
"""Handle a request to send a message"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
|
|
elif len(params) == 4:
|
|
toAddress, fromAddress, subject, message = params
|
|
encodingType = 2
|
|
TTL = 4 * 24 * 60 * 60
|
|
|
|
elif len(params) == 5:
|
|
toAddress, fromAddress, subject, message, encodingType = params
|
|
TTL = 4 * 24 * 60 * 60
|
|
|
|
elif len(params) == 6:
|
|
toAddress, fromAddress, subject, message, encodingType, TTL = \
|
|
params
|
|
|
|
if encodingType not in [2, 3]:
|
|
raise APIError(6, 'The encoding type must be 2 or 3.')
|
|
subject = self._decode(subject, "base64")
|
|
message = self._decode(message, "base64")
|
|
if len(subject + message) > (2 ** 18 - 500):
|
|
raise APIError(27, 'Message is too long.')
|
|
if TTL < 60 * 60:
|
|
TTL = 60 * 60
|
|
if TTL > 28 * 24 * 60 * 60:
|
|
TTL = 28 * 24 * 60 * 60
|
|
toAddress = addBMIfNotPresent(toAddress)
|
|
fromAddress = addBMIfNotPresent(fromAddress)
|
|
# pylint: disable=unused-variable
|
|
status, addressVersionNumber, streamNumber, toRipe = \
|
|
self._verifyAddress(toAddress)
|
|
self._verifyAddress(fromAddress)
|
|
try:
|
|
fromAddressEnabled = BMConfigParser().getboolean(
|
|
fromAddress, 'enabled')
|
|
except BaseException:
|
|
raise APIError(
|
|
13, 'Could not find your fromAddress in the keys.dat file.')
|
|
if not fromAddressEnabled:
|
|
raise APIError(14, 'Your fromAddress is disabled. Cannot send.')
|
|
|
|
stealthLevel = BMConfigParser().safeGetInt(
|
|
'bitmessagesettings', 'ackstealthlevel')
|
|
ackdata = genAckPayload(streamNumber, stealthLevel)
|
|
|
|
t = ('',
|
|
toAddress,
|
|
toRipe,
|
|
fromAddress,
|
|
subject,
|
|
message,
|
|
ackdata,
|
|
int(time.time()), # sentTime (this won't change)
|
|
int(time.time()), # lastActionTime
|
|
0,
|
|
'msgqueued',
|
|
0,
|
|
'sent',
|
|
2,
|
|
TTL)
|
|
helper_sent.insert(t)
|
|
|
|
toLabel = ''
|
|
queryreturn = sqlQuery(
|
|
"SELECT label FROM addressbook WHERE address=?", toAddress)
|
|
if queryreturn != []:
|
|
for row in queryreturn:
|
|
toLabel, = row
|
|
queues.UISignalQueue.put(('displayNewSentMessage', (
|
|
toAddress, toLabel, fromAddress, subject, message, ackdata)))
|
|
|
|
queues.workerQueue.put(('sendmessage', toAddress))
|
|
|
|
return hexlify(ackdata)
|
|
|
|
def HandleSendBroadcast(self, params):
|
|
"""Handle a request to send a broadcast message"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
|
|
if len(params) == 3:
|
|
fromAddress, subject, message = params
|
|
encodingType = 2
|
|
TTL = 4 * 24 * 60 * 60
|
|
|
|
elif len(params) == 4:
|
|
fromAddress, subject, message, encodingType = params
|
|
TTL = 4 * 24 * 60 * 60
|
|
elif len(params) == 5:
|
|
fromAddress, subject, message, encodingType, TTL = params
|
|
|
|
if encodingType not in [2, 3]:
|
|
raise APIError(6, 'The encoding type must be 2 or 3.')
|
|
|
|
subject = self._decode(subject, "base64")
|
|
message = self._decode(message, "base64")
|
|
if len(subject + message) > (2 ** 18 - 500):
|
|
raise APIError(27, 'Message is too long.')
|
|
if TTL < 60 * 60:
|
|
TTL = 60 * 60
|
|
if TTL > 28 * 24 * 60 * 60:
|
|
TTL = 28 * 24 * 60 * 60
|
|
fromAddress = addBMIfNotPresent(fromAddress)
|
|
self._verifyAddress(fromAddress)
|
|
try:
|
|
BMConfigParser().getboolean(fromAddress, 'enabled')
|
|
except BaseException:
|
|
raise APIError(
|
|
13, 'could not find your fromAddress in the keys.dat file.')
|
|
streamNumber = decodeAddress(fromAddress)[2]
|
|
ackdata = genAckPayload(streamNumber, 0)
|
|
toAddress = '[Broadcast subscribers]'
|
|
ripe = ''
|
|
|
|
t = ('',
|
|
toAddress,
|
|
ripe,
|
|
fromAddress,
|
|
subject,
|
|
message,
|
|
ackdata,
|
|
int(time.time()), # sentTime (this doesn't change)
|
|
int(time.time()), # lastActionTime
|
|
0,
|
|
'broadcastqueued',
|
|
0,
|
|
'sent',
|
|
2,
|
|
TTL)
|
|
helper_sent.insert(t)
|
|
|
|
toLabel = '[Broadcast subscribers]'
|
|
queues.UISignalQueue.put(('displayNewSentMessage', (
|
|
toAddress, toLabel, fromAddress, subject, message, ackdata)))
|
|
queues.workerQueue.put(('sendbroadcast', ''))
|
|
|
|
return hexlify(ackdata)
|
|
|
|
def HandleGetStatus(self, params):
|
|
"""Handle a request to get the status of a sent message"""
|
|
|
|
if len(params) != 1:
|
|
raise APIError(0, 'I need one parameter!')
|
|
ackdata, = params
|
|
if len(ackdata) < 76:
|
|
# The length of ackData should be at least 38 bytes (76 hex digits)
|
|
raise APIError(15, 'Invalid ackData object size.')
|
|
ackdata = self._decode(ackdata, "hex")
|
|
queryreturn = sqlQuery(
|
|
"SELECT status FROM sent where ackdata=?", ackdata)
|
|
if queryreturn == []:
|
|
return 'notfound'
|
|
for row in queryreturn:
|
|
status, = row
|
|
return status
|
|
|
|
def HandleAddSubscription(self, params):
|
|
"""Handle a request to add a subscription"""
|
|
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
if len(params) == 1:
|
|
address, = params
|
|
label = ''
|
|
if len(params) == 2:
|
|
address, label = params
|
|
label = self._decode(label, "base64")
|
|
try:
|
|
unicode(label, 'utf-8')
|
|
except BaseException:
|
|
raise APIError(17, 'Label is not valid UTF-8 data.')
|
|
if len(params) > 2:
|
|
raise APIError(0, 'I need either 1 or 2 parameters!')
|
|
address = addBMIfNotPresent(address)
|
|
self._verifyAddress(address)
|
|
# First we must check to see if the address is already in the
|
|
# subscriptions list.
|
|
queryreturn = sqlQuery(
|
|
"SELECT * FROM subscriptions WHERE address=?", address)
|
|
if queryreturn != []:
|
|
raise APIError(16, 'You are already subscribed to that address.')
|
|
sqlExecute(
|
|
"INSERT INTO subscriptions VALUES (?,?,?)", label, address, True)
|
|
shared.reloadBroadcastSendersForWhichImWatching()
|
|
queues.UISignalQueue.put(('rerenderMessagelistFromLabels', ''))
|
|
queues.UISignalQueue.put(('rerenderSubscriptions', ''))
|
|
return 'Added subscription.'
|
|
|
|
def HandleDeleteSubscription(self, params):
|
|
"""Handle a request to delete a subscription"""
|
|
|
|
if len(params) != 1:
|
|
raise APIError(0, 'I need 1 parameter!')
|
|
address, = params
|
|
address = addBMIfNotPresent(address)
|
|
sqlExecute('''DELETE FROM subscriptions WHERE address=?''', address)
|
|
shared.reloadBroadcastSendersForWhichImWatching()
|
|
queues.UISignalQueue.put(('rerenderMessagelistFromLabels', ''))
|
|
queues.UISignalQueue.put(('rerenderSubscriptions', ''))
|
|
return 'Deleted subscription if it existed.'
|
|
|
|
def ListSubscriptions(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to list susbcriptions"""
|
|
|
|
# pylint: disable=unused-variable
|
|
queryreturn = sqlQuery(
|
|
"SELECT label, address, enabled FROM subscriptions")
|
|
data = {'subscriptions': []}
|
|
for row in queryreturn:
|
|
label, address, enabled = row
|
|
label = shared.fixPotentiallyInvalidUTF8Data(label)
|
|
data['subscriptions'].append({
|
|
'label': base64.b64encode(label),
|
|
'address': address,
|
|
'enabled': enabled == 1
|
|
})
|
|
return json.dumps(data, indent=4, separators=(',', ': '))
|
|
|
|
def HandleDisseminatePreEncryptedMsg(self, params):
|
|
"""Handle a request to disseminate an encrypted message"""
|
|
|
|
# The device issuing this command to PyBitmessage supplies a msg
|
|
# object that has already been encrypted but which still needs the POW
|
|
# to be done. PyBitmessage accepts this msg 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.
|
|
if len(params) != 3:
|
|
raise APIError(0, 'I need 3 parameter!')
|
|
encryptedPayload, requiredAverageProofOfWorkNonceTrialsPerByte, \
|
|
requiredPayloadLengthExtraBytes = params
|
|
encryptedPayload = self._decode(encryptedPayload, "hex")
|
|
# Let us do the POW and attach it to the front
|
|
target = 2**64 / (
|
|
(
|
|
len(encryptedPayload) + requiredPayloadLengthExtraBytes + 8
|
|
) * requiredAverageProofOfWorkNonceTrialsPerByte
|
|
)
|
|
with shared.printLock:
|
|
print(
|
|
'(For msg message via API) Doing proof of work. Total required difficulty:',
|
|
float(
|
|
requiredAverageProofOfWorkNonceTrialsPerByte
|
|
) / defaults.networkDefaultProofOfWorkNonceTrialsPerByte,
|
|
'Required small message difficulty:',
|
|
float(requiredPayloadLengthExtraBytes) / defaults.networkDefaultPayloadLengthExtraBytes,
|
|
)
|
|
powStartTime = time.time()
|
|
initialHash = hashlib.sha512(encryptedPayload).digest()
|
|
trialValue, nonce = proofofwork.run(target, initialHash)
|
|
with shared.printLock:
|
|
print '(For msg message via API) Found proof of work', trialValue, 'Nonce:', nonce
|
|
try:
|
|
print(
|
|
'POW took', int(time.time() - powStartTime), 'seconds.',
|
|
nonce / (time.time() - powStartTime), 'nonce trials per second.',
|
|
)
|
|
except BaseException:
|
|
pass
|
|
encryptedPayload = pack('>Q', nonce) + encryptedPayload
|
|
toStreamNumber = decodeVarint(encryptedPayload[16:26])[0]
|
|
inventoryHash = calculateInventoryHash(encryptedPayload)
|
|
objectType = 2
|
|
TTL = 2.5 * 24 * 60 * 60
|
|
Inventory()[inventoryHash] = (
|
|
objectType, toStreamNumber, encryptedPayload,
|
|
int(time.time()) + TTL, ''
|
|
)
|
|
with shared.printLock:
|
|
print 'Broadcasting inv for msg(API disseminatePreEncryptedMsg command):', hexlify(inventoryHash)
|
|
queues.invQueue.put((toStreamNumber, inventoryHash))
|
|
|
|
def HandleTrashSentMessageByAckDAta(self, params):
|
|
"""Handle a request to trash a sent message by ackdata"""
|
|
|
|
# This API method should only be used when msgid is not available
|
|
if not params:
|
|
raise APIError(0, 'I need parameters!')
|
|
ackdata = self._decode(params[0], "hex")
|
|
sqlExecute("UPDATE sent SET folder='trash' WHERE ackdata=?", ackdata)
|
|
return 'Trashed sent message (assuming message existed).'
|
|
|
|
def HandleDissimatePubKey(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to disseminate a public key"""
|
|
|
|
# The device issuing this command to PyBitmessage supplies a pubkey
|
|
# object to be disseminated to the rest of the Bitmessage network.
|
|
# PyBitmessage accepts this pubkey object and sends it out to the rest
|
|
# of the Bitmessage network as if it had generated the pubkey object
|
|
# itself. Please do not yet add this to the api doc.
|
|
if len(params) != 1:
|
|
raise APIError(0, 'I need 1 parameter!')
|
|
payload, = params
|
|
payload = self._decode(payload, "hex")
|
|
|
|
# Let us do the POW
|
|
target = 2 ** 64 / ((
|
|
len(payload) + defaults.networkDefaultPayloadLengthExtraBytes + 8
|
|
) * defaults.networkDefaultProofOfWorkNonceTrialsPerByte)
|
|
print '(For pubkey message via API) Doing proof of work...'
|
|
initialHash = hashlib.sha512(payload).digest()
|
|
trialValue, nonce = proofofwork.run(target, initialHash)
|
|
print '(For pubkey message via API) Found proof of work', trialValue, 'Nonce:', nonce
|
|
payload = pack('>Q', nonce) + payload
|
|
|
|
pubkeyReadPosition = 8 # bypass the nonce
|
|
if payload[pubkeyReadPosition:pubkeyReadPosition + 4] == \
|
|
'\x00\x00\x00\x00': # if this pubkey uses 8 byte time
|
|
pubkeyReadPosition += 8
|
|
else:
|
|
pubkeyReadPosition += 4
|
|
# pylint: disable=unused-variable
|
|
addressVersion, addressVersionLength = decodeVarint(
|
|
payload[pubkeyReadPosition:pubkeyReadPosition + 10])
|
|
pubkeyReadPosition += addressVersionLength
|
|
pubkeyStreamNumber = decodeVarint(
|
|
payload[pubkeyReadPosition:pubkeyReadPosition + 10])[0]
|
|
inventoryHash = calculateInventoryHash(payload)
|
|
objectType = 1 # .. todo::: support v4 pubkeys
|
|
TTL = 28 * 24 * 60 * 60
|
|
Inventory()[inventoryHash] = (
|
|
objectType, pubkeyStreamNumber, payload, int(time.time()) + TTL, ''
|
|
)
|
|
with shared.printLock:
|
|
print 'broadcasting inv within API command disseminatePubkey with hash:', hexlify(inventoryHash)
|
|
queues.invQueue.put((pubkeyStreamNumber, inventoryHash))
|
|
|
|
def HandleGetMessageDataByDestinationHash(self, params):
|
|
"""Handle a request to get message data by destination hash"""
|
|
|
|
# Method will eventually be used by a particular Android app to
|
|
# select relevant messages. Do not yet add this to the api
|
|
# doc.
|
|
if len(params) != 1:
|
|
raise APIError(0, 'I need 1 parameter!')
|
|
requestedHash, = params
|
|
if len(requestedHash) != 32:
|
|
raise APIError(
|
|
19, 'The length of hash should be 32 bytes (encoded in hex'
|
|
' thus 64 characters).')
|
|
requestedHash = self._decode(requestedHash, "hex")
|
|
|
|
# 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
|
|
# which is blank by default (first20bytesofencryptedmessage).
|
|
queryreturn = sqlQuery(
|
|
"SELECT hash, payload FROM inventory WHERE tag = ''"
|
|
" and objecttype = 2")
|
|
with SqlBulkExecute() as sql:
|
|
for row in queryreturn:
|
|
hash01, payload = row
|
|
readPosition = 16 # Nonce length + time length
|
|
# Stream Number length
|
|
readPosition += decodeVarint(
|
|
payload[readPosition:readPosition + 10])[1]
|
|
t = (payload[readPosition:readPosition + 32], hash01)
|
|
sql.execute("UPDATE inventory SET tag=? WHERE hash=?", *t)
|
|
|
|
queryreturn = sqlQuery(
|
|
"SELECT payload FROM inventory WHERE tag = ?", requestedHash)
|
|
data = '{"receivedMessageDatas":['
|
|
for row in queryreturn:
|
|
payload, = row
|
|
if len(data) > 25:
|
|
data += ','
|
|
data += json.dumps(
|
|
{'data': hexlify(payload)}, indent=4, separators=(',', ': '))
|
|
data += ']}'
|
|
return data
|
|
|
|
def HandleClientStatus(self, params): # pylint: disable=unused-argument
|
|
"""Handle a request to get the status of the client"""
|
|
|
|
connections_num = len(network.stats.connectedHostsList())
|
|
if connections_num == 0:
|
|
networkStatus = 'notConnected'
|
|
elif shared.clientHasReceivedIncomingConnections:
|
|
networkStatus = 'connectedAndReceivingIncomingConnections'
|
|
else:
|
|
networkStatus = 'connectedButHaveNotReceivedIncomingConnections'
|
|
return json.dumps({
|
|
'networkConnections': connections_num,
|
|
'numberOfMessagesProcessed': shared.numberOfMessagesProcessed,
|
|
'numberOfBroadcastsProcessed': shared.numberOfBroadcastsProcessed,
|
|
'numberOfPubkeysProcessed': shared.numberOfPubkeysProcessed,
|
|
'networkStatus': networkStatus,
|
|
'softwareName': 'PyBitmessage',
|
|
'softwareVersion': softwareVersion
|
|
}, indent=4, separators=(',', ': '))
|
|
|
|
def HandleDecodeAddress(self, params):
|
|
"""Handle a request to decode an address"""
|
|
|
|
# Return a meaningful decoding of an address.
|
|
if len(params) != 1:
|
|
raise APIError(0, 'I need 1 parameter!')
|
|
address, = params
|
|
status, addressVersion, streamNumber, ripe = decodeAddress(address)
|
|
return json.dumps({
|
|
'status': status,
|
|
'addressVersion': addressVersion,
|
|
'streamNumber': streamNumber,
|
|
'ripe': base64.b64encode(ripe)
|
|
}, indent=4, separators=(',', ': '))
|
|
|
|
def HandleHelloWorld(self, params):
|
|
"""Test two string params"""
|
|
|
|
a, b = params
|
|
return a + '-' + b
|
|
|
|
def HandleAdd(self, params):
|
|
"""Test two numeric params"""
|
|
|
|
a, b = params
|
|
return a + b
|
|
|
|
def HandleStatusBar(self, params):
|
|
"""Handle a request to update the status bar"""
|
|
|
|
message, = params
|
|
queues.UISignalQueue.put(('updateStatusBar', message))
|
|
|
|
def HandleDeleteAndVacuum(self, params):
|
|
"""Handle a request to run the deleteandvacuum stored procedure"""
|
|
|
|
if not params:
|
|
sqlStoredProcedure('deleteandvacuume')
|
|
return 'done'
|
|
return None
|
|
|
|
def HandleShutdown(self, params):
|
|
"""Handle a request to shutdown the node"""
|
|
|
|
if not params:
|
|
# backward compatible trick because False == 0 is True
|
|
state.shutdown = False
|
|
return 'done'
|
|
return None
|
|
|
|
handlers = {}
|
|
handlers['helloWorld'] = HandleHelloWorld
|
|
handlers['add'] = HandleAdd
|
|
handlers['statusBar'] = HandleStatusBar
|
|
handlers['listAddresses'] = HandleListAddresses
|
|
handlers['listAddressBookEntries'] = HandleListAddressBookEntries
|
|
# the listAddressbook alias should be removed eventually.
|
|
handlers['listAddressbook'] = HandleListAddressBookEntries
|
|
handlers['addAddressBookEntry'] = HandleAddAddressBookEntry
|
|
# the addAddressbook alias should be deleted eventually.
|
|
handlers['addAddressbook'] = HandleAddAddressBookEntry
|
|
handlers['deleteAddressBookEntry'] = HandleDeleteAddressBookEntry
|
|
# The deleteAddressbook alias should be deleted eventually.
|
|
handlers['deleteAddressbook'] = HandleDeleteAddressBookEntry
|
|
handlers['createRandomAddress'] = HandleCreateRandomAddress
|
|
handlers['createDeterministicAddresses'] = \
|
|
HandleCreateDeterministicAddresses
|
|
handlers['getDeterministicAddress'] = HandleGetDeterministicAddress
|
|
handlers['createChan'] = HandleCreateChan
|
|
handlers['joinChan'] = HandleJoinChan
|
|
handlers['leaveChan'] = HandleLeaveChan
|
|
handlers['deleteAddress'] = HandleDeleteAddress
|
|
handlers['getAllInboxMessages'] = HandleGetAllInboxMessages
|
|
handlers['getAllInboxMessageIds'] = HandleGetAllInboxMessageIds
|
|
handlers['getAllInboxMessageIDs'] = HandleGetAllInboxMessageIds
|
|
handlers['getInboxMessageById'] = HandleGetInboxMessageById
|
|
handlers['getInboxMessageByID'] = HandleGetInboxMessageById
|
|
handlers['getAllSentMessages'] = HandleGetAllSentMessages
|
|
handlers['getAllSentMessageIds'] = HandleGetAllSentMessageIds
|
|
handlers['getAllSentMessageIDs'] = HandleGetAllSentMessageIds
|
|
handlers['getInboxMessagesByReceiver'] = HandleInboxMessagesByReceiver
|
|
# after some time getInboxMessagesByAddress should be removed
|
|
handlers['getInboxMessagesByAddress'] = HandleInboxMessagesByReceiver
|
|
handlers['getSentMessageById'] = HandleGetSentMessageById
|
|
handlers['getSentMessageByID'] = HandleGetSentMessageById
|
|
handlers['getSentMessagesByAddress'] = HandleGetSentMessagesByAddress
|
|
handlers['getSentMessagesBySender'] = HandleGetSentMessagesByAddress
|
|
handlers['getSentMessageByAckData'] = HandleGetSentMessagesByAckData
|
|
handlers['trashMessage'] = HandleTrashMessage
|
|
handlers['trashInboxMessage'] = HandleTrashInboxMessage
|
|
handlers['trashSentMessage'] = HandleTrashSentMessage
|
|
handlers['trashSentMessageByAckData'] = HandleTrashSentMessageByAckDAta
|
|
handlers['sendMessage'] = HandleSendMessage
|
|
handlers['sendBroadcast'] = HandleSendBroadcast
|
|
handlers['getStatus'] = HandleGetStatus
|
|
handlers['addSubscription'] = HandleAddSubscription
|
|
handlers['deleteSubscription'] = HandleDeleteSubscription
|
|
handlers['listSubscriptions'] = ListSubscriptions
|
|
handlers['disseminatePreEncryptedMsg'] = HandleDisseminatePreEncryptedMsg
|
|
handlers['disseminatePubkey'] = HandleDissimatePubKey
|
|
handlers['getMessageDataByDestinationHash'] = \
|
|
HandleGetMessageDataByDestinationHash
|
|
handlers['getMessageDataByDestinationTag'] = \
|
|
HandleGetMessageDataByDestinationHash
|
|
handlers['clientStatus'] = HandleClientStatus
|
|
handlers['decodeAddress'] = HandleDecodeAddress
|
|
handlers['deleteAndVacuum'] = HandleDeleteAndVacuum
|
|
handlers['shutdown'] = HandleShutdown
|
|
|
|
def _handle_request(self, method, params):
|
|
if method not in self.handlers:
|
|
raise APIError(20, 'Invalid method: %s' % method)
|
|
result = self.handlers[method](self, params)
|
|
state.last_api_response = time.time()
|
|
return result
|
|
|
|
def _dispatch(self, method, params):
|
|
# pylint: disable=attribute-defined-outside-init
|
|
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 varintDecodeError as e:
|
|
logger.error(e)
|
|
return "API Error 0026: Data contains a malformed varint. Some details: %s" % e
|
|
except Exception as e:
|
|
logger.exception(e)
|
|
|
|
return "API Error 0021: Unexpected API Failure - %s" % e
|