PyBitmessage/src/bitmessagemain.py

#!/usr/bin/env python2.7
# Copyright (c) 2012 Jonathan Warren
# Copyright (c) 2012 The Bitmessage developers
# Distributed under the MIT/X11 software license. See the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.

#Right now, PyBitmessage only support connecting to stream 1. It doesn't yet contain logic to expand into further streams.

softwareVersion = '0.2.8'
verbose = 1
maximumAgeOfAnObjectThatIAmWillingToAccept = 216000 #Equals two days and 12 hours.
lengthOfTimeToLeaveObjectsInInventory = 237600 #Equals two days and 18 hours. This should be longer than maximumAgeOfAnObjectThatIAmWillingToAccept so that we don't process messages twice.
lengthOfTimeToHoldOnToAllPubkeys = 2419200 #Equals 4 weeks. You could make this longer if you want but making it shorter would not be advisable because there is a very small possibility that it could keep you from obtaining a needed pubkey for a period of time.
maximumAgeOfObjectsThatIAdvertiseToOthers = 216000 #Equals two days and 12 hours
maximumAgeOfNodesThatIAdvertiseToOthers = 10800 #Equals three hours
storeConfigFilesInSameDirectoryAsProgramByDefault = False #The user may de-select Portable Mode in the settings if they want the config files to stay in the application data folder.
useVeryEasyProofOfWorkForTesting = False #If you set this to True while on the normal network, you won't be able to send or sometimes receive messages.

import sys
try:
    from PyQt4.QtCore import *
    from PyQt4.QtGui import *
except Exception, err:
    print 'PyBitmessage requires PyQt. You can download it from http://www.riverbankcomputing.com/software/pyqt/download   or by searching Google for \'PyQt Download\' (without quotes).'
    print 'Error message:', err
    sys.exit()
import ConfigParser
from bitmessageui import *
from newaddressdialog import *
from newsubscriptiondialog import *
from regenerateaddresses import *
from specialaddressbehavior import *
from settings import *
from about import *
from help import *
from iconglossary import *
from addresses import *
import Queue
from defaultKnownNodes import *
import time
import socket
import threading
import hashlib
from struct import *
import pickle
import random
import sqlite3
import threading #used for the locks, not for the threads
from time import strftime, localtime, gmtime
import os
import shutil #used for moving the messages.dat file
import string
import socks
import highlevelcrypto
from pyelliptic.openssl import OpenSSL
import ctypes
from pyelliptic import arithmetic
#The next 3 are used for the API
from SimpleXMLRPCServer import *
import json
from subprocess import call #used when the API must execute an outside program

#For each stream to which we connect, several outgoingSynSender threads will exist and will collectively create 8 connections with peers.
class outgoingSynSender(QThread):
    def __init__(self, parent = None):
        QThread.__init__(self, parent)

    def setup(self,streamNumber):
        self.streamNumber = streamNumber

    def run(self):
        time.sleep(1)
        global alreadyAttemptedConnectionsListResetTime
        while True:
            #time.sleep(999999)#I sometimes use this to prevent connections for testing.
            if len(selfInitiatedConnections[self.streamNumber]) < 8: #maximum number of outgoing connections = 8
                random.seed()
                HOST, = random.sample(knownNodes[self.streamNumber],  1)
                alreadyAttemptedConnectionsListLock.acquire()
                while HOST in alreadyAttemptedConnectionsList or HOST in connectedHostsList:
                    alreadyAttemptedConnectionsListLock.release()
                    #print 'choosing new sample'
                    random.seed()
                    HOST, = random.sample(knownNodes[self.streamNumber],  1)
                    time.sleep(1)
                    #Clear out the alreadyAttemptedConnectionsList every half hour so that this program will again attempt a connection to any nodes, even ones it has already tried.
                    if (time.time() - alreadyAttemptedConnectionsListResetTime) > 1800:
                        alreadyAttemptedConnectionsList.clear()
                        alreadyAttemptedConnectionsListResetTime = int(time.time())
                    alreadyAttemptedConnectionsListLock.acquire()
                alreadyAttemptedConnectionsList[HOST] = 0
                alreadyAttemptedConnectionsListLock.release()
                PORT, timeNodeLastSeen = knownNodes[self.streamNumber][HOST]
                sock = socks.socksocket(socket.AF_INET, socket.SOCK_STREAM)
                sock.settimeout(20)
                if config.get('bitmessagesettings', 'socksproxytype') == 'none' and verbose >= 2:
                    printLock.acquire()
                    print 'Trying an outgoing connection to', HOST, ':', PORT
                    printLock.release()
                    #sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
                elif config.get('bitmessagesettings', 'socksproxytype') == 'SOCKS4a':
                    if verbose >= 2:
                        printLock.acquire()
                        print '(Using SOCKS4a) Trying an outgoing connection to', HOST, ':', PORT
                        printLock.release()
                    proxytype = socks.PROXY_TYPE_SOCKS4
                    sockshostname = config.get('bitmessagesettings', 'sockshostname')
                    socksport = config.getint('bitmessagesettings', 'socksport')
                    rdns = True #Do domain name lookups through the proxy; though this setting doesn't really matter since we won't be doing any domain name lookups anyway.
                    if config.getboolean('bitmessagesettings', 'socksauthentication'):
                        socksusername = config.get('bitmessagesettings', 'socksusername')
                        sockspassword = config.get('bitmessagesettings', 'sockspassword')
                        sock.setproxy(proxytype, sockshostname, socksport, rdns, socksusername, sockspassword)
                    else:
                        sock.setproxy(proxytype, sockshostname, socksport, rdns)
                elif config.get('bitmessagesettings', 'socksproxytype') == 'SOCKS5':
                    if verbose >= 2:
                        printLock.acquire()
                        print '(Using SOCKS5) Trying an outgoing connection to', HOST, ':', PORT
                        printLock.release()
                    proxytype = socks.PROXY_TYPE_SOCKS5
                    sockshostname = config.get('bitmessagesettings', 'sockshostname')
                    socksport = config.getint('bitmessagesettings', 'socksport')
                    rdns = True #Do domain name lookups through the proxy; though this setting doesn't really matter since we won't be doing any domain name lookups anyway.
                    if config.getboolean('bitmessagesettings', 'socksauthentication'):
                        socksusername = config.get('bitmessagesettings', 'socksusername')
                        sockspassword = config.get('bitmessagesettings', 'sockspassword')
                        sock.setproxy(proxytype, sockshostname, socksport, rdns, socksusername, sockspassword)
                    else:
                        sock.setproxy(proxytype, sockshostname, socksport, rdns)

                try:
                    sock.connect((HOST, PORT))
                    rd = receiveDataThread()
                    self.emit(SIGNAL("passObjectThrough(PyQt_PyObject)"),rd)
                    objectsOfWhichThisRemoteNodeIsAlreadyAware = {}
                    rd.setup(sock,HOST,PORT,self.streamNumber,objectsOfWhichThisRemoteNodeIsAlreadyAware)
                    rd.start()
                    printLock.acquire()
                    print self, 'connected to', HOST, 'during an outgoing attempt.'
                    printLock.release()

                    sd = sendDataThread()
                    sd.setup(sock,HOST,PORT,self.streamNumber,objectsOfWhichThisRemoteNodeIsAlreadyAware)
                    sd.start()
                    sd.sendVersionMessage()

                except socks.GeneralProxyError, err:
                    if verbose >= 2:
                        printLock.acquire()
                        print 'Could NOT connect to', HOST, 'during outgoing attempt.', err
                        printLock.release()
                    PORT, timeLastSeen = knownNodes[self.streamNumber][HOST]
                    if (int(time.time())-timeLastSeen) > 172800 and len(knownNodes[self.streamNumber]) > 1000: # for nodes older than 48 hours old if we have more than 1000 hosts in our list, delete from the knownNodes data-structure.
                        knownNodesLock.acquire()
                        del knownNodes[self.streamNumber][HOST]
                        knownNodesLock.release()
                        print 'deleting ', HOST, 'from knownNodes because it is more than 48 hours old and we could not connect to it.'
                except socks.Socks5AuthError, err:
                    self.emit(SIGNAL("updateStatusBar(PyQt_PyObject)"),"SOCKS5 Authentication problem: "+str(err))
                except socks.Socks5Error, err:
                    pass
                    print 'SOCKS5 error. (It is possible that the server wants authentication).)' ,str(err)
                    #self.emit(SIGNAL("updateStatusBar(PyQt_PyObject)"),"SOCKS5 error. Server might require authentication. "+str(err))
                except socks.Socks4Error, err:
                    print 'Socks4Error:', err
                    #self.emit(SIGNAL("updateStatusBar(PyQt_PyObject)"),"SOCKS4 error: "+str(err))
                except socket.error, err:
                    if config.get('bitmessagesettings', 'socksproxytype')[0:5] == 'SOCKS':
                        print 'Bitmessage MIGHT be having trouble connecting to the SOCKS server. '+str(err)
                        #self.emit(SIGNAL("updateStatusBar(PyQt_PyObject)"),"Problem: Bitmessage can not connect to the SOCKS server. "+str(err))
                    else:
                        if verbose >= 1:
                            printLock.acquire()
                            print 'Could NOT connect to', HOST, 'during outgoing attempt.', err
                            printLock.release()
                        PORT, timeLastSeen = knownNodes[self.streamNumber][HOST]
                        if (int(time.time())-timeLastSeen) > 172800 and len(knownNodes[self.streamNumber]) > 1000: # for nodes older than 48 hours old if we have more than 1000 hosts in our list, delete from the knownNodes data-structure.
                            knownNodesLock.acquire()
                            del knownNodes[self.streamNumber][HOST]
                            knownNodesLock.release()
                            print 'deleting ', HOST, 'from knownNodes because it is more than 48 hours old and we could not connect to it.'
                except Exception, err:
                    sys.stderr.write('An exception has occurred in the outgoingSynSender thread that was not caught by other exception types: %s\n' % err)
            time.sleep(0.1)

#Only one singleListener thread will ever exist. It creates the receiveDataThread and sendDataThread for each incoming connection. Note that it cannot set the stream number because it is not known yet- the other node will have to tell us its stream number in a version message. If we don't care about their stream, we will close the connection (within the recversion function of the recieveData thread)
class singleListener(QThread):
    def __init__(self, parent = None):
        QThread.__init__(self, parent)


    def run(self):
        #We don't want to accept incoming connections if the user is using a SOCKS proxy. If they eventually select proxy 'none' then this will start listening for connections.
        while config.get('bitmessagesettings', 'socksproxytype')[0:5] == 'SOCKS':
            time.sleep(300)

        print 'Listening for incoming connections.'
        HOST = '' # Symbolic name meaning all available interfaces
        PORT = config.getint('bitmessagesettings', 'port')
        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        #This option apparently avoids the TIME_WAIT state so that we can rebind faster
        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        sock.bind((HOST, PORT))
        sock.listen(2)


        while True:
            #We don't want to accept incoming connections if the user is using a SOCKS proxy. If the user eventually select proxy 'none' then this will start listening for connections.
            while config.get('bitmessagesettings', 'socksproxytype')[0:5] == 'SOCKS':
                time.sleep(10)
            a,(HOST,PORT) = sock.accept()
            #Users are finding that if they run more than one node in the same network (thus with the same public IP), they can not connect with the second node. This is because this section of code won't accept the connection from the same IP. This problem will go away when the Bitmessage network grows beyond being tiny but in the mean time I'll comment out this code section.
            """while HOST in connectedHostsList:
                print 'incoming connection is from a host in connectedHostsList (we are already connected to it). Ignoring it.'
                a.close()
                a,(HOST,PORT) = sock.accept()"""
            rd = receiveDataThread()
            self.emit(SIGNAL("passObjectThrough(PyQt_PyObject)"),rd)
            objectsOfWhichThisRemoteNodeIsAlreadyAware = {}
            rd.setup(a,HOST,PORT,-1,objectsOfWhichThisRemoteNodeIsAlreadyAware)
            printLock.acquire()
            print self, 'connected to', HOST,'during INCOMING request.'
            printLock.release()
            rd.start()

            sd = sendDataThread()
            sd.setup(a,HOST,PORT,-1,objectsOfWhichThisRemoteNodeIsAlreadyAware)
            sd.start()


#This thread is created either by the synSenderThread(for outgoing connections) or the singleListenerThread(for incoming connectiosn).
class receiveDataThread(QThread):
    def __init__(self, parent = None):
        QThread.__init__(self, parent)
        self.data = ''
        self.verackSent = False
        self.verackReceived = False

    def setup(self,sock,HOST,port,streamNumber,objectsOfWhichThisRemoteNodeIsAlreadyAware):
        self.sock = sock
        self.HOST = HOST
        self.PORT = port
        self.sock.settimeout(600) #We'll send out a pong every 5 minutes to make sure the connection stays alive if there has been no other traffic to send lately.
        self.streamNumber = streamNumber
        self.payloadLength = 0 #This is the protocol payload length thus it doesn't include the 24 byte message header
        self.receivedgetbiginv = False #Gets set to true once we receive a getbiginv message from our peer. An abusive peer might request it too much so we use this variable to check whether they have already asked for a big inv message.
        self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave = {}
        connectedHostsList[self.HOST] = 0 #The very fact that this receiveData thread exists shows that we are connected to the remote host. Let's add it to this list so that an outgoingSynSender thread doesn't try to connect to it.
        self.connectionIsOrWasFullyEstablished = False #set to true after the remote node and I accept each other's version messages. This is needed to allow the user interface to accurately reflect the current number of connections.
        if self.streamNumber == -1: #This was an incoming connection. Send out a version message if we accept the other node's version message.
            self.initiatedConnection = False
        else:
            self.initiatedConnection = True
            selfInitiatedConnections[streamNumber][self] = 0
        self.ackDataThatWeHaveYetToSend = [] #When we receive a message bound for us, we store the acknowledgement that we need to send (the ackdata) here until we are done processing all other data received from this peer.
        self.objectsOfWhichThisRemoteNodeIsAlreadyAware = objectsOfWhichThisRemoteNodeIsAlreadyAware

    def run(self):

        while True:
            try:
                self.data += self.sock.recv(4096)
            except socket.timeout:
                printLock.acquire()
                print 'Timeout occurred waiting for data. Closing receiveData thread.'
                printLock.release()
                break
            except Exception, err:
                printLock.acquire()
                print 'sock.recv error. Closing receiveData thread.', err
                printLock.release()
                break
            #print 'Received', repr(self.data)
            if self.data == "":
                printLock.acquire()
                print 'Connection closed. Closing receiveData thread.'
                printLock.release()
                break
            else:
                self.processData()



        try:
            self.sock.close()
        except Exception, err:
            print 'Within receiveDataThread run(), self.sock.close() failed.', err

        try:
            del selfInitiatedConnections[self.streamNumber][self]
            printLock.acquire()
            print 'removed self (a receiveDataThread) from ConnectionList'
            printLock.release()
        except:
            pass
        broadcastToSendDataQueues((0, 'shutdown', self.HOST))
        if self.connectionIsOrWasFullyEstablished: #We don't want to decrement the number of connections and show the result if we never incremented it in the first place (which we only do if the connection is fully established- meaning that both nodes accepted each other's version packets.)
            connectionsCountLock.acquire()
            connectionsCount[self.streamNumber] -= 1
            self.emit(SIGNAL("updateNetworkStatusTab(PyQt_PyObject,PyQt_PyObject)"),self.streamNumber,connectionsCount[self.streamNumber])
            printLock.acquire()
            print 'Updating network status tab with current connections count:', connectionsCount[self.streamNumber]
            printLock.release()
            connectionsCountLock.release()
        try:
            del connectedHostsList[self.HOST]
        except Exception, err:
            print 'Could not delete', self.HOST, 'from connectedHostsList.', err
        printLock.acquire()
        print 'The size of the connectedHostsList is now:', len(connectedHostsList)
        printLock.release()

    def processData(self):
        global verbose
        #if verbose >= 3:
            #printLock.acquire()
            #print 'self.data is currently ', repr(self.data)
            #printLock.release()
        if len(self.data) < 20: #if so little of the data has arrived that we can't even unpack the payload length
            pass
        elif self.data[0:4] != '\xe9\xbe\xb4\xd9':
            if verbose >= 1:
                printLock.acquire()
                sys.stderr.write('The magic bytes were not correct. First 40 bytes of data: %s\n' % repr(self.data[0:40]))
                print 'self.data:', self.data.encode('hex')
                printLock.release()
            self.data = ""
        else:
            self.payloadLength, = unpack('>L',self.data[16:20])
            if len(self.data) >= self.payloadLength+24: #check if the whole message has arrived yet. If it has,...
                if self.data[20:24] == hashlib.sha512(self.data[24:self.payloadLength+24]).digest()[0:4]:#test the checksum in the message. If it is correct...
                    #print 'message checksum is correct'
                    #The time we've last seen this node is obviously right now since we just received valid data from it. So update the knownNodes list so that other peers can be made aware of its existance.
                    if self.initiatedConnection: #The remote port is only something we should share with others if it is the remote node's incoming port (rather than some random operating-system-assigned outgoing port).
                        knownNodesLock.acquire()
                        knownNodes[self.streamNumber][self.HOST] = (self.PORT,int(time.time()))
                        knownNodesLock.release()
                    if self.payloadLength <= 180000000: #If the size of the message is greater than 180MB, ignore it. (I get memory errors when processing messages much larger than this though it is concievable that this value will have to be lowered if some systems are less tolarant of large messages.)
                        remoteCommand = self.data[4:16]
                        printLock.acquire()
                        print 'remoteCommand', repr(remoteCommand.replace('\x00','')), ' from', self.HOST
                        printLock.release()
                        if remoteCommand == 'version\x00\x00\x00\x00\x00':
                            self.recversion(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'verack\x00\x00\x00\x00\x00\x00':
                            self.recverack()
                        elif remoteCommand == 'addr\x00\x00\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recaddr(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'getpubkey\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recgetpubkey(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'pubkey\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recpubkey(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'inv\x00\x00\x00\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recinv(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'getdata\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recgetdata(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'getbiginv\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.sendBigInv()
                        elif remoteCommand == 'msg\x00\x00\x00\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recmsg(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'broadcast\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.recbroadcast(self.data[24:self.payloadLength+24])
                        elif remoteCommand == 'getaddr\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.sendaddr()
                        elif remoteCommand == 'ping\x00\x00\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            self.sendpong()
                        elif remoteCommand == 'pong\x00\x00\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            pass
                        elif remoteCommand == 'alert\x00\x00\x00\x00\x00\x00\x00' and self.connectionIsOrWasFullyEstablished:
                            pass

                    self.data = self.data[self.payloadLength+24:]#take this message out and then process the next message
                    if self.data == '':
                        while len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave) > 0:
                            random.seed()
                            objectHash, = random.sample(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave,  1)
                            if objectHash in inventory:
                                printLock.acquire()
                                print 'Inventory (in memory) already has object listed in inv message.'
                                printLock.release()
                                del self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave[objectHash]
                            elif isInSqlInventory(objectHash):
                                if verbose >= 3:
                                    printLock.acquire()
                                    print 'Inventory (SQL on disk) already has object listed in inv message.'
                                    printLock.release()
                                del self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave[objectHash]
                            else:
                                self.sendgetdata(objectHash)
                                del self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave[objectHash] #It is possible that the remote node doesn't respond with the object. In that case, we'll very likely get it from someone else anyway.
                                if len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave) == 0:
                                    printLock.acquire()
                                    print '(concerning', self.HOST + ')', 'number of objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave is now', len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave)
                                    printLock.release()
                                break
                            if len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave) == 0:
                                printLock.acquire()
                                print '(concerning', self.HOST + ')', 'number of objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave is now', len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave)
                                printLock.release()
                        if len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave) > 0:
                            printLock.acquire()
                            print '(concerning', self.HOST + ')', 'number of objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave is now', len(self.objectsThatWeHaveYetToCheckAndSeeWhetherWeAlreadyHave)
                            printLock.release()
                        if len(self.ackDataThatWeHaveYetToSend) > 0:
                            self.data = self.ackDataThatWeHaveYetToSend.pop()
                    self.processData()
                else:
                    print 'Checksum incorrect. Clearing this message.'
                    self.data = self.data[self.payloadLength+24:]

    def isProofOfWorkSufficient(self,data,nonceTrialsPerByte=0,payloadLengthExtraBytes=0):
        if nonceTrialsPerByte < networkDefaultProofOfWorkNonceTrialsPerByte:
            nonceTrialsPerByte = networkDefaultProofOfWorkNonceTrialsPerByte
        if payloadLengthExtraBytes < networkDefaultPayloadLengthExtraBytes:
            payloadLengthExtraBytes = networkDefaultPayloadLengthExtraBytes
        POW, = unpack('>Q',hashlib.sha512(hashlib.sha512(data[:8]+ hashlib.sha512(data[8:]).digest()).digest()).digest()[0:8])
        #print 'POW:', POW
        return POW <= 2**64 / ((len(data)+payloadLengthExtraBytes) * (nonceTrialsPerByte))

    def sendpong(self):
        print 'Sending pong'
        self.sock.sendall('\xE9\xBE\xB4\xD9\x70\x6F\x6E\x67\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xcf\x83\xe1\x35')

    def recverack(self):
        print 'verack received'
        self.verackReceived = True
        if self.verackSent == True:
            #We have thus both sent and received a verack.
            self.connectionFullyEstablished()

    def connectionFullyEstablished(self):
        self.connectionIsOrWasFullyEstablished = True
        if not self.initiatedConnection:
            self.emit(SIGNAL("setStatusIcon(PyQt_PyObject)"),'green')
        #Update the 'Network Status' tab
        connectionsCountLock.acquire()
        connectionsCount[self.streamNumber] += 1
        self.emit(SIGNAL("updateNetworkStatusTab(PyQt_PyObject,PyQt_PyObject)"),self.streamNumber,connectionsCount[self.streamNumber])
        connectionsCountLock.release()
        remoteNodeIncomingPort, remoteNodeSeenTime = knownNodes[self.streamNumber][self.HOST]
        printLock.acquire()
        print 'Connection fully established with', self.HOST, remoteNodeIncomingPort
        print 'broadcasting addr from within connectionFullyEstablished function.'
        printLock.release()
        self.broadcastaddr([(int(time.time()), self.streamNumber, 1, self.HOST, remoteNodeIncomingPort)]) #This lets all of our peers know about this new node.
        self.sendaddr() #This is one large addr message to this one peer.
        if not self.initiatedConnection and connectionsCount[self.streamNumber] > 150:
            printLock.acquire()
            print 'We are connected to too many people. Closing connection.'
            printLock.release()
            self.sock.close()
            return
        self.sendBigInv()

    def sendBigInv(self): #I used capitals in for this function name because there is no such Bitmessage command as 'biginv'.
        if self.receivedgetbiginv:
            print 'We have already sent a big inv message to this peer. Ignoring request.'
            return
        else:
            self.receivedgetbiginv = True
            sqlLock.acquire()
            #Select all hashes which are younger than two days old and in this stream.
            t = (int(time.time())-maximumAgeOfObjectsThatIAdvertiseToOthers,int(time.time())-lengthOfTimeToHoldOnToAllPubkeys,self.streamNumber)
            sqlSubmitQueue.put('''SELECT hash FROM inventory WHERE ((receivedtime>? and objecttype<>'pubkey') or (receivedtime>? and objecttype='pubkey')) and streamnumber=?''')
            sqlSubmitQueue.put(t)
            queryreturn = sqlReturnQueue.get()
            sqlLock.release()
            bigInvList = {}
            for row in queryreturn:
                hash, = row
                if hash not in self.objectsOfWhichThisRemoteNodeIsAlreadyAware:
                    bigInvList[hash] = 0
                else:
                    printLock.acquire()
                    print 'Not including an object hash in a big inv message because the remote node is already aware of it.'#This line is here to check that this feature is working.
                    printLock.release()
            #We also have messages in our inventory in memory (which is a python dictionary). Let's fetch those too.
            for hash, storedValue in inventory.items():
                if hash not in self.objectsOfWhichThisRemoteNodeIsAlreadyAware:
                    objectType, streamNumber, payload, receivedTime = storedValue
                    if streamNumber == self.streamNumber and receivedTime > int(time.time())-maximumAgeOfObjectsThatIAdvertiseToOthers:
                        bigInvList[hash] = 0
                else:
                    printLock.acquire()
                    print 'Not including an object hash in a big inv message because the remote node is already aware of it.'#This line is here to check that this feature is working.
                    printLock.release()
            numberOfObjectsInInvMessage = 0
            payload = ''
            #Now let us start appending all of these hashes together. They will be sent out in a big inv message to our new peer.
            for hash, storedValue in bigInvList.items():
                payload += hash
                numberOfObjectsInInvMessage += 1
                if numberOfObjectsInInvMessage >= 50000: #We can only send a max of 50000 items per inv message but we may have more objects to advertise. They must be split up into multiple inv messages.
                    self.sendinvMessageToJustThisOnePeer(numberOfObjectsInInvMessage,payload)
                    payload = ''
                    numberOfObjectsInInvMessage = 0
            if numberOfObjectsInInvMessage > 0:
                self.sendinvMessageToJustThisOnePeer(numberOfObjectsInInvMessage,payload)

    #Self explanatory. Notice that there is also a broadcastinv function for broadcasting invs to everyone in our stream.
    def sendinvMessageToJustThisOnePeer(self,numberOfObjects,payload):
        payload = encodeVarint(numberOfObjects) + payload
        headerData = '\xe9\xbe\xb4\xd9' #magic bits, slighly different from Bitcoin's magic bits.
        headerData += 'inv\x00\x00\x00\x00\x00\x00\x00\x00\x00'
        headerData += pack('>L',len(payload))
        headerData += hashlib.sha512(payload).digest()[:4]
        printLock.acquire()
        print 'Sending huge inv message with', numberOfObjects, 'objects to just this one peer'
        printLock.release()
        self.sock.sendall(headerData + payload)

    #We have received a broadcast message
    def recbroadcast(self,data):
        self.messageProcessingStartTime = time.time()
        #First we must check to make sure the proof of work is sufficient.
        if not self.isProofOfWorkSufficient(data):
            print 'Proof of work in broadcast message insufficient.'
            return
        readPosition = 8 #bypass the nonce
        embeddedTime, = unpack('>I',data[readPosition:readPosition+4])

        #This section is used for the transition from 32 bit time to 64 bit time in the protocol.
        if embeddedTime == 0:
            embeddedTime, = unpack('>Q',data[readPosition:readPosition+8])
            readPosition += 8
        else:
            readPosition += 4

        if embeddedTime > (int(time.time())+10800): #prevent funny business
            print 'The embedded time in this broadcast message is more than three hours in the future. That doesn\'t make sense. Ignoring message.'
            return
        if embeddedTime < (int(time.time())-maximumAgeOfAnObjectThatIAmWillingToAccept):
            print 'The embedded time in this broadcast message is too old. Ignoring message.'
            return
        if len(data) < 180:
            print 'The payload length of this broadcast packet is unreasonably low. Someone is probably trying funny business. Ignoring message.'
            return
        #Let us check to make sure the stream number is correct (thus preventing an individual from sending broadcasts out on the wrong streams or all streams).
        broadcastVersion, broadcastVersionLength = decodeVarint(data[readPosition:readPosition+10])
        if broadcastVersion >= 2:
            streamNumber = decodeVarint(data[readPosition+broadcastVersionLength:readPosition+broadcastVersionLength+10])
            if streamNumber != self.streamNumber:
                print 'The stream number encoded in this broadcast message (' + str(streamNumber) + ') does not match the stream number on which it was received. Ignoring it.'
                return

        inventoryLock.acquire()
        self.inventoryHash = calculateInventoryHash(data)
        if self.inventoryHash in inventory:
            print 'We have already received this broadcast object. Ignoring.'
            inventoryLock.release()
            return
        elif isInSqlInventory(self.inventoryHash):
            print 'We have already received this broadcast object (it is stored on disk in the SQL inventory). Ignoring it.'
            inventoryLock.release()
            return
        #It is valid so far. Let's let our peers know about it.
        objectType = 'broadcast'
        inventory[self.inventoryHash] = (objectType, self.streamNumber, data, embeddedTime)
        inventoryLock.release()
        self.broadcastinv(self.inventoryHash)
        self.emit(SIGNAL("incrementNumberOfBroadcastsProcessed()"))


        self.processbroadcast(readPosition,data)#When this function returns, we will have either successfully processed this broadcast because we are interested in it, ignored it because we aren't interested in it, or found problem with the broadcast that warranted ignoring it.

        # Let us now set lengthOfTimeWeShouldUseToProcessThisMessage. If we haven't used the specified amount of time, we shall sleep. These values are mostly the same values used for msg messages although broadcast messages are processed faster.
        if len(data) > 100000000: #Size is greater than 100 megabytes
            lengthOfTimeWeShouldUseToProcessThisMessage = 100 #seconds.
        elif len(data) > 10000000: #Between 100 and 10 megabytes
            lengthOfTimeWeShouldUseToProcessThisMessage = 20 #seconds.
        elif len(data) > 1000000: #Between 10 and 1 megabyte
            lengthOfTimeWeShouldUseToProcessThisMessage = 3 #seconds.
        else: #Less than 1 megabyte
            lengthOfTimeWeShouldUseToProcessThisMessage = .1 #seconds.


        sleepTime = lengthOfTimeWeShouldUseToProcessThisMessage - (time.time()- self.messageProcessingStartTime)
        if sleepTime > 0:
            printLock.acquire()
            print 'Timing attack mitigation: Sleeping for', sleepTime ,'seconds.'
            printLock.release()
            time.sleep(sleepTime)
        printLock.acquire()
        print 'Total message processing time:', time.time()- self.messageProcessingStartTime, 'seconds.'
        printLock.release()

    #A broadcast message has a valid time and POW and requires processing. The recbroadcast function calls this one.
    def processbroadcast(self,readPosition,data):
        broadcastVersion, broadcastVersionLength = decodeVarint(data[readPosition:readPosition+9])
        readPosition += broadcastVersionLength
        if broadcastVersion < 1 or broadcastVersion > 2:
            #Cannot decode incoming broadcast versions higher than 2. Assuming the sender isn\' being silly, you should upgrade Bitmessage because this message shall be ignored.
            return
        if broadcastVersion == 1:
            beginningOfPubkeyPosition = readPosition #used when we add the pubkey to our pubkey table
            sendersAddressVersion, sendersAddressVersionLength = decodeVarint(data[readPosition:readPosition+9])
            if sendersAddressVersion <= 1 or sendersAddressVersion >=3:
                #Cannot decode senderAddressVersion higher than 2. Assuming the sender isn\' being silly, you should upgrade Bitmessage because this message shall be ignored.
                return
            readPosition += sendersAddressVersionLength
            if sendersAddressVersion == 2:
                sendersStream, sendersStreamLength = decodeVarint(data[readPosition:readPosition+9])
                readPosition += sendersStreamLength
                behaviorBitfield = data[readPosition:readPosition+4]
                readPosition += 4
                sendersPubSigningKey = '\x04' + data[readPosition:readPosition+64]
                readPosition += 64
                sendersPubEncryptionKey = '\x04' + data[readPosition:readPosition+64]
                readPosition += 64
                endOfPubkeyPosition = readPosition
                sendersHash = data[readPosition:readPosition+20]
                if sendersHash not in broadcastSendersForWhichImWatching:
                    #Display timing data
                    printLock.acquire()
                    print 'Time spent deciding that we are not interested in this broadcast:', time.time()- self.messageProcessingStartTime
                    printLock.release()
                    return
                #At this point, this message claims to be from sendersHash and we are interested in it. We still have to hash the public key to make sure it is truly the key that matches the hash, and also check the signiture.
                readPosition += 20

                sha = hashlib.new('sha512')
                sha.update(sendersPubSigningKey+sendersPubEncryptionKey)
                ripe = hashlib.new('ripemd160')
                ripe.update(sha.digest())
                if ripe.digest() != sendersHash:
                    #The sender of this message lied.
                    return
                messageEncodingType, messageEncodingTypeLength = decodeVarint(data[readPosition:readPosition+9])
                if messageEncodingType == 0:
                    return
                readPosition += messageEncodingTypeLength
                messageLength, messageLengthLength = decodeVarint(data[readPosition:readPosition+9])
                readPosition += messageLengthLength
                message = data[readPosition:readPosition+messageLength]
                readPosition += messageLength
                readPositionAtBottomOfMessage = readPosition
                signatureLength, signatureLengthLength = decodeVarint(data[readPosition:readPosition+9])
                readPosition += signatureLengthLength
                signature = data[readPosition:readPosition+signatureLength]
                try:
                    highlevelcrypto.verify(data[12:readPositionAtBottomOfMessage],signature,sendersPubSigningKey.encode('hex'))
                    print 'ECDSA verify passed'
                except Exception, err:
                    print 'ECDSA verify failed', err
                    return
                #verify passed

                #Let's store the public key in case we want to reply to this person.
                #We don't have the correct nonce or time (which would let us send out a pubkey message) so we'll just fill it with 1's. We won't be able to send this pubkey to others (without doing the proof of work ourselves, which this program is programmed to not do.)
                t = (ripe.digest(),'\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF'+'\xFF\xFF\xFF\xFF'+data[beginningOfPubkeyPosition:endOfPubkeyPosition],int(time.time()),'yes')
                sqlLock.acquire()
                sqlSubmitQueue.put('''INSERT INTO pubkeys VALUES (?,?,?,?)''')
                sqlSubmitQueue.put(t)
                sqlReturnQueue.get()
                sqlSubmitQueue.put('commit')
                sqlLock.release()
                workerQueue.put(('newpubkey',(sendersAddressVersion,sendersStream,ripe.digest()))) #This will check to see whether we happen to be awaiting this pubkey in order to send a message. If we are, it will do the POW and send it.

                fromAddress = encodeAddress(sendersAddressVersion,sendersStream,ripe.digest())
                printLock.acquire()
                print 'fromAddress:', fromAddress
                printLock.release()
                if messageEncodingType == 2:
                    bodyPositionIndex = string.find(message,'\nBody:')
                    if bodyPositionIndex > 1:
                        subject = message[8:bodyPositionIndex]
                        body = message[bodyPositionIndex+6:]
                    else:
                        subject = ''
                        body = message
                elif messageEncodingType == 1:
                    body = message
                    subject = ''
                elif messageEncodingType == 0:
                    print 'messageEncodingType == 0. Doing nothing with the message.'
                else:
                    body = 'Unknown encoding type.\n\n' + repr(message)
                    subject = ''

                toAddress = '[Broadcast subscribers]'
                if messageEncodingType <> 0:
                    sqlLock.acquire()
                    t = (self.inventoryHash,toAddress,fromAddress,subject,int(time.time()),body,'inbox',messageEncodingType,0)
                    sqlSubmitQueue.put('''INSERT INTO inbox VALUES (?,?,?,?,?,?,?,?,?)''')
                    sqlSubmitQueue.put(t)
                    sqlReturnQueue.get()
                    sqlSubmitQueue.put('commit')
                    sqlLock.release()
                    self.emit(SIGNAL("displayNewInboxMessage(PyQt_PyObject,PyQt_PyObject,PyQt_PyObject,PyQt_PyObject,PyQt_PyObject)"),self.inventoryHash,toAddress,fromAddress,subject,body)

                    #If we are behaving as an API then we might need to run an outside command to let some program know that a new message has arrived.
                    if safeConfigGetBoolean('bitmessagesettings','apienabled'):
                        try:
                            apiNotifyPath = config.get('bitmessagesettings','apinotifypath')
                        except:
                            apiNotifyPath = ''
                        if apiNotifyPath != '':
                            call([apiNotifyPath, "newBroadcast"])

                #Display timing data
                printLock.acquire()
                print 'Time spent processing this interesting broadcast:', time.time()- self.messageProcessingStartTime
                printLock.release()
        if broadcastVersion == 2:
            cleartextStreamNumber, cleartextStreamNumberLength = decodeVarint(data[readPosition:readPosition+10])
            readPosition += streamNumberLength
            initialDecryptionSuccessful = False

            for key, cryptorObject in MyECSubscriptionCryptorObjects.items():
                try:
                    decryptedData = cryptorObject.decrypt(data[readPosition:])
                    toRipe = key #This is the RIPE hash of the sender's pubkey. We need this below to compare to the RIPE hash of the sender's address to verify that it was encrypted by with their key rather than some other key.
                    initialDecryptionSuccessful = True
                    print 'EC decryption successful using key associated with ripe hash:', key.encode('hex')
                    break
                except Exception, err:
                    pass
                    #print 'cryptorObject.decrypt Exception:', err
            if not initialDecryptionSuccessful:
                #This is not a message bound for me.
                printLock.acquire()
                print 'Length of time program spent failing to decrypt this broadcast:', time.time()- self.messageProcessingStartTime, 'seconds.'
                printLock.release()
            else:
                #This is a broadcast I have decrypted and thus am interested in.
                signedBroadcastVersion, readPosition = decodeVarint(decryptedData[:10])
                beginningOfPubkeyPosition = readPosition #used when we add the pubkey to our pubkey table
                sendersAddressVersion, sendersAddressVersionLength = decodeVarint(decryptedData[readPosition:readPosition+9])
                if sendersAddressVersion < 2 or sendersAddressVersion > 3:
                    print 'Cannot decode senderAddressVersion other than 2 or 3. Assuming the sender isn\' being silly, you should upgrade Bitmessage because this message shall be ignored.'
                    return
                readPosition += sendersAddressVersionLength
                sendersStream, sendersStreamLength = decodeVarint(decryptedData[readPosition:readPosition+9])
                if sendersStream != cleartextStreamNumber:
                    print 'The stream number outside of the encryption on which the POW was completed doesn\'t match the stream number inside the encryption. Ignoring broadcast.'
                    return
                readPosition += sendersStreamLength
                behaviorBitfield = decryptedData[readPosition:readPosition+4]
                readPosition += 4
                sendersPubSigningKey = '\x04' + decryptedData[readPosition:readPosition+64]
                readPosition += 64
                sendersPubEncryptionKey = '\x04' + decryptedData[readPosition:readPosition+64]
                readPosition += 64
                if sendersAddressVersion >= 3:
                    requiredAverageProofOfWorkNonceTrialsPerByte, varintLength = decodeVarint(decryptedData[readPosition:readPosition+10])
                    readPosition += varintLength
                    print 'sender\'s requiredAverageProofOfWorkNonceTrialsPerByte is', requiredAverageProofOfWorkNonceTrialsPerByte
                    requiredPayloadLengthExtraBytes, varintLength = decodeVarint(decryptedData[readPosition:readPosition+10])
                    readPosition += varintLength
                    print 'sender\'s requiredPayloadLengthExtraBytes is', requiredPayloadLengthExtraBytes
                endOfPubkeyPosition = readPosition

                sha = hashlib.new('sha512')
                sha.update(sendersPubSigningKey+sendersPubEncryptionKey)
                ripe = hashlib.new('ripemd160')
                ripe.update(sha.digest())

                messageEncodingType, messageEncodingTypeLength = decodeVarint(decryptedData[readPosition:readPosition+9])
                if messageEncodingType == 0:
                    return
                readPosition += messageEncodingTypeLength
                messageLength, messageLengthLength = decodeVarint(decryptedData[readPosition:readPosition+9])
                readPosition += messageLengthLength
                message = decryptedData[readPosition:readPosition+messageLength]
                readPosition += messageLength
                readPositionAtBottomOfMessage = readPosition
                signatureLength, signatureLengthLength = decodeVarint(decryptedData[readPosition:readPosition+9])
                readPosition += signatureLengthLength
                signature = decryptedData[readPosition:readPosition+signatureLength]
                try:
                    highlevelcrypto.verify(decryptedData[:readPositionAtBottomOfMessage],signature,sendersPubSigningKey.encode('hex'))
                    print 'ECDSA verify passed'
                except Exception, err:
                    print 'ECDSA verify failed', err
                    return
                #verify passed

                #Let's store the public key in case we want to reply to this person.
                t = (ripe.digest(),'\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF'+'\xFF\xFF\xFF\xFF'+decryptedData[beginningOfPubkeyPosition:endOfPubkeyPosition],int(time.time()),'yes')
                sqlLock.acquire()
                sqlSubmitQueue.put('''INSERT INTO pubkeys VALUES (?,?,?,?)''')
                sqlSubmitQueue.put(t)
                sqlReturnQueue.get()
                sqlSubmitQueue.put('commit')
                sqlLock.release()
                workerQueue.put(('newpubkey',(sendersAddressVersion,sendersStream,ripe.digest()))) #This will check to see whether we happen to be awaiting this pubkey in order to send a message. If we are, it will do the POW and send it.

                fromAddress = encodeAddress(sendersAddressVersion,sendersStream,ripe.digest())
                printLock.acquire()
                print 'fromAddress:', fromAddress
                printLock.release()
                if messageEncodingType == 2:
                    bodyPositionIndex = string.find(message,'\nBody:')
                    if bodyPositionIndex > 1:
                        subject = message[8:bodyPositionIndex]
                        body = message[bodyPositionIndex+6:]
                    else:
                        subject = ''
                        body = message
                elif messageEncodingType == 1:
                    body = message
                    subject = ''
                elif messageEncodingType == 0:
                    print 'messageEncodingType == 0. Doing nothing with the message.'
                else:
                    body = 'Unknown encoding type.\n\n' + repr(message)
                    subject = ''

                toAddress = '[Broadcast subscribers]'
                if messageEncodingType <> 0:
                    sqlLock.acquire()
                    t = (self.inventoryHash,toAddress,fromAddress,subject,int(time.time()),body,'inbox',messageEncodingType,0)
                    sqlSubmitQueue.put('''INSERT INTO inbox VALUES (?,?,?,?,?,?,?,?,?)''')
                    sqlSubmitQueue.put(t)
                    sqlReturnQueue.get()
                    sqlSubmitQueue.put('commit')
                    sqlLock.release()
                    self.emit(SIGNAL("displayNewInboxMessage(PyQt_PyObject,PyQt_PyObject,PyQt_PyObject,PyQt_PyObject,PyQt_PyObject)"),self.inventoryHash,toAddress,fromAddress,subject,body)

                    #If we are behaving as an API then we might need to run an outside command to let some program know that a new message has arrived.
                    if safeConfigGetBoolean('bitmessagesettings','apienabled'):
                        try:
                            apiNotifyPath = config.get('bitmessagesettings','apinotifypath')
                        except:
                            apiNotifyPath = ''
                        if apiNotifyPath != '':
                            call([apiNotifyPath, "newBroadcast"])

                #Display timing data
                printLock.acquire()
                print 'Time spent processing this interesting broadcast:', time.time()- self.messageProcessingStartTime
                printLock.release()


    #We have received a msg message.
    def recmsg(self,data):
        self.messageProcessingStartTime = time.time()
        #First we must check to make sure the proof of work is sufficient.
        if not self.isProofOfWorkSufficient(data):
            print 'Proof of work in msg message insufficient.'
            return

        readPosition = 8
        embeddedTime, = unpack('>I',data[readPosition:readPosition+4])

        #This section is used for the transition from 32 bit time to 64 bit time in the protocol.
        if embeddedTime == 0:
            embeddedTime, = unpack('>Q',data[readPosition:readPosition+8])
            readPosition += 8
        else:
            readPosition += 4

        if embeddedTime > int(time.time())+10800:
            print 'The time in the msg message is too new. Ignoring it. Time:', embeddedTime
            return
        if embeddedTime < int(time.time())-maximumAgeOfAnObjectThatIAmWillingToAccept:
            print 'The time in the msg message is too old. Ignoring it. Time:', embeddedTime
            return
        streamNumberAsClaimedByMsg, streamNumberAsClaimedByMsgLength = decodeVarint(data[readPosition:readPosition+9])
        if streamNumberAsClaimedByMsg != self.streamNumber:
            print 'The stream number encoded in this msg (' + str(streamNumberAsClaimedByMsg) + ') message does not match the stream number on which it was received. Ignoring it.'
            return
        readPosition += streamNumberAsClaimedByMsgLength
        self.inventoryHash = calculateInventoryHash(data)
        inventoryLock.acquire()
        if self.inventoryHash in inventory:
            print 'We have already received this msg message. Ignoring.'
            inventoryLock.release()
            return
        elif isInSqlInventory(self.inventoryHash):
            print 'We have already received this msg message (it is stored on disk in the SQL inventory). Ignoring it.'
            inventoryLock.release()
            return
        #This msg message is valid. Let's let our peers know about it.
        objectType = 'msg'
        inventory[self.inventoryHash] = (objectType, self.streamNumber, data, embeddedTime)
        inventoryLock.release()
        self.broadcastinv(self.inventoryHash)
        self.emit(SIGNAL("incrementNumberOfMessagesProcessed()"))

        self.processmsg(readPosition,data) #When this function returns, we will have either successfully processed the message bound for us, ignored it because it isn't bound for us, or found problem with the message that warranted ignoring it.

        # Let us now set lengthOfTimeWeShouldUseToProcessThisMessage. If we haven't used the specified amount of time, we shall sleep. These values are based on test timings and you may change them at-will.
        if len(data) > 100000000: #Size is greater than 100 megabytes
            lengthOfTimeWeShouldUseToProcessThisMessage = 100 #seconds. Actual length of time it took my computer to decrypt and verify the signature of a 100 MB message: 3.7 seconds.
        elif len(data) > 10000000: #Between 100 and 10 megabytes
            lengthOfTimeWeShouldUseToProcessThisMessage = 20 #seconds. Actual length of time it took my computer to decrypt and verify the signature of a 10 MB message: 0.53 seconds. Actual length of time it takes in practice when processing a real message: 1.44 seconds.
        elif len(data) > 1000000: #Between 10 and 1 megabyte
            lengthOfTimeWeShouldUseToProcessThisMessage = 3 #seconds. Actual length of time it took my computer to decrypt and verify the signature of a 1 MB message: 0.18 seconds. Actual length of time it takes in practice when processing a real message: 0.30 seconds.
        else: #Less than 1 megabyte
            lengthOfTimeWeShouldUseToProcessThisMessage = .6 #seconds. Actual length of time it took my computer to decrypt and verify the signature of a 100 KB message: 0.15 seconds. Actual length of time it takes in practice when processing a real message: 0.25 seconds.


        sleepTime = lengthOfTimeWeShouldUseToProcessThisMessage - (time.time()- self.messageProcessingStartTime)
        if sleepTime > 0: