summaryrefslogtreecommitdiff
path: root/sleekxmpp/xmlstream/xmlstream.py
diff options
context:
space:
mode:
authorNathan Fritz <fritzy@netflint.net>2009-06-03 22:56:51 +0000
committerNathan Fritz <fritzy@netflint.net>2009-06-03 22:56:51 +0000
commit96b103b27599e5af247c1e3b95d62c80c1e32a63 (patch)
tree0527b1607b16adb020759ee9a944e1b22e3e0e6b /sleekxmpp/xmlstream/xmlstream.py
downloadslixmpp-96b103b27599e5af247c1e3b95d62c80c1e32a63.tar.gz
slixmpp-96b103b27599e5af247c1e3b95d62c80c1e32a63.tar.bz2
slixmpp-96b103b27599e5af247c1e3b95d62c80c1e32a63.tar.xz
slixmpp-96b103b27599e5af247c1e3b95d62c80c1e32a63.zip
moved seesmic branch to trunk
Diffstat (limited to 'sleekxmpp/xmlstream/xmlstream.py')
-rw-r--r--sleekxmpp/xmlstream/xmlstream.py388
1 files changed, 388 insertions, 0 deletions
diff --git a/sleekxmpp/xmlstream/xmlstream.py b/sleekxmpp/xmlstream/xmlstream.py
new file mode 100644
index 00000000..ad2c5a1c
--- /dev/null
+++ b/sleekxmpp/xmlstream/xmlstream.py
@@ -0,0 +1,388 @@
+from __future__ import with_statement
+import Queue
+from . import statemachine
+from . stanzabase import StanzaBase
+from xml.etree import cElementTree
+from xml.parsers import expat
+import logging
+import socket
+import thread
+import time
+import traceback
+import types
+import xml.sax.saxutils
+
+ssl_support = True
+try:
+ from tlslite.api import *
+except ImportError:
+ ssl_support = False
+
+
+class RestartStream(Exception):
+ pass
+
+class CloseStream(Exception):
+ pass
+
+stanza_extensions = {}
+
+class _fileobject(object): # we still need this because Socket.makefile is broken in python2.5 (but it works fine in 3.0)
+
+ def __init__(self, sock, mode='rb', bufsize=-1):
+ self._sock = sock
+ if bufsize <= 0:
+ bufsize = 1024
+ self.bufsize = bufsize
+ self.softspace = False
+
+ def read(self, size=-1):
+ if size <= 0:
+ size = sys.maxint
+ blocks = []
+ #while size > 0:
+ # b = self._sock.recv(min(size, self.bufsize))
+ # size -= len(b)
+ # if not b:
+ # break
+ # blocks.append(b)
+ # print size
+ #return "".join(blocks)
+ buff = self._sock.recv(self.bufsize)
+ logging.debug("RECV: %s" % buff)
+ return buff
+
+ def readline(self, size=-1):
+ return self.read(size)
+ if size < 0:
+ size = sys.maxint
+ blocks = []
+ read_size = min(20, size)
+ found = 0
+ while size and not found:
+ b = self._sock.recv(read_size, MSG_PEEK)
+ if not b:
+ break
+ found = b.find('\n') + 1
+ length = found or len(b)
+ size -= length
+ blocks.append(self._sock.recv(length))
+ read_size = min(read_size * 2, size, self.bufsize)
+ return "".join(blocks)
+
+ def write(self, data):
+ self._sock.sendall(str(data))
+
+ def writelines(self, lines):
+ # This version mimics the current writelines, which calls
+ # str() on each line, but comments that we should reject
+ # non-string non-buffers. Let's omit the next line.
+ lines = [str(s) for s in lines]
+ self._sock.sendall(''.join(lines))
+
+ def flush(self):
+ pass
+
+ def close(self):
+ self._sock.close()
+
+
+class XMLStream(object):
+ "A connection manager with XML events."
+
+ def __init__(self, socket=None, host='', port=0, escape_quotes=False):
+ global ssl_support
+ self.ssl_support = ssl_support
+ self.escape_quotes = escape_quotes
+ self.state = statemachine.StateMachine()
+ self.state.addStates({'connected':False, 'is client':False, 'ssl':False, 'tls':False, 'reconnect':True, 'processing':False}) #set initial states
+
+ self.setSocket(socket)
+ self.address = (host, int(port))
+
+ self.__thread = {}
+
+ self.__root_stanza = {}
+ self.__stanza = {}
+ self.__stanza_extension = {}
+ self.__handlers = []
+
+ self.__tls_socket = None
+ self.use_ssl = False
+ self.use_tls = False
+
+ self.stream_header = "<stream>"
+ self.stream_footer = "</stream>"
+
+ self.namespace_map = {}
+
+ def setSocket(self, socket):
+ "Set the socket"
+ self.socket = socket
+ if socket is not None:
+ self.filesocket = socket.makefile('rb', 0) # ElementTree.iterparse requires a file. 0 buffer files have to be binary
+ self.state.set('connected', True)
+
+
+ def setFileSocket(self, filesocket):
+ self.filesocket = filesocket
+
+ def connect(self, host='', port=0, use_ssl=False, use_tls=True):
+ "Link to connectTCP"
+ return self.connectTCP(host, port, use_ssl, use_tls)
+
+ def connectTCP(self, host='', port=0, use_ssl=None, use_tls=None, reattempt=True):
+ "Connect and create socket"
+ while reattempt and not self.state['connected']:
+ if host and port:
+ self.address = (host, int(port))
+ if use_ssl is not None:
+ self.use_ssl = use_ssl
+ if use_tls is not None:
+ self.use_tls = use_tls
+ self.state.set('is client', True)
+ self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ if self.use_ssl and self.ssl_support:
+ logging.debug("Socket Wrapped for SSL")
+ self.socket = ssl.wrap_socket(self.socket)
+ try:
+ self.socket.connect(self.address)
+ self.state.set('connected', True)
+ return True
+ except socket.error,(errno, strerror):
+ logging.error("Could not connect. Socket Error #%s: %s" % (errno, strerror))
+ time.sleep(1)
+
+ def connectUnix(self, filepath):
+ "Connect to Unix file and create socket"
+
+ def startTLS(self):
+ "Handshakes for TLS"
+ #self.socket = ssl.wrap_socket(self.socket, ssl_version=ssl.PROTOCOL_TLSv1, do_handshake_on_connect=False)
+ #self.socket.do_handshake()
+ if self.ssl_support:
+ self.realsocket = self.socket
+ self.socket = TLSConnection(self.socket)
+ self.socket.handshakeClientCert()
+ self.file = _fileobject(self.socket)
+ return True
+ else:
+ logging.warning("Tried to enable TLS, but tlslite module not found.")
+ return False
+ raise RestartStream()
+
+ def process(self, threaded=True):
+ #self.__thread['process'] = threading.Thread(name='process', target=self._process)
+ #self.__thread['process'].start()
+ if threaded:
+ thread.start_new(self._process, tuple())
+ else:
+ self._process()
+
+ def _process(self):
+ "Start processing the socket."
+ firstrun = True
+ while firstrun or self.state['reconnect']:
+ self.state.set('processing', True)
+ firstrun = False
+ try:
+ if self.state['is client']:
+ self.sendRaw(self.stream_header)
+ while self.__readXML():
+ if self.state['is client']:
+ self.sendRaw(self.stream_header)
+ except KeyboardInterrupt:
+ logging.debug("Keyboard Escape Detected")
+ self.state.set('processing', False)
+ self.disconnect()
+ raise
+ except:
+ self.state.set('processing', False)
+ traceback.print_exc()
+ self.disconnect(reconnect=True)
+ if self.state['reconnect']:
+ self.reconnect()
+ self.state.set('processing', False)
+ #self.__thread['readXML'] = threading.Thread(name='readXML', target=self.__readXML)
+ #self.__thread['readXML'].start()
+ #self.__thread['spawnEvents'] = threading.Thread(name='spawnEvents', target=self.__spawnEvents)
+ #self.__thread['spawnEvents'].start()
+
+ def __readXML(self):
+ "Parses the incoming stream, adding to xmlin queue as it goes"
+ #build cElementTree object from expat was we go
+ #self.filesocket = self.socket.makefile('rb',0) #this is broken in python2.5, but works in python3.0
+ self.filesocket = _fileobject(self.socket)
+ edepth = 0
+ root = None
+ for (event, xmlobj) in cElementTree.iterparse(self.filesocket, ('end', 'start')):
+ if edepth == 0: # and xmlobj.tag.split('}', 1)[-1] == self.basetag:
+ if event == 'start':
+ root = xmlobj
+ self.start_stream_handler(root)
+ if event == 'end':
+ edepth += -1
+ if edepth == 0 and event == 'end':
+ return False
+ elif edepth == 1:
+ #self.xmlin.put(xmlobj)
+ try:
+ self.__spawnEvent(xmlobj)
+ except RestartStream:
+ return True
+ except CloseStream:
+ return False
+ if root:
+ root.clear()
+ if event == 'start':
+ edepth += 1
+
+ def sendRaw(self, data):
+ logging.debug("SEND: %s" % data)
+ if type(data) == type(u''):
+ data = data.encode('utf-8')
+ try:
+ self.socket.send(data)
+ except socket.error,(errno, strerror):
+ logging.error("Disconnected. Socket Error #%s: %s" % (errno,strerror))
+ self.state.set('connected', False)
+ self.disconnect(reconnect=True)
+ return False
+ return True
+
+ def disconnect(self, reconnect=False):
+ self.state.set('reconnect', reconnect)
+ if self.state['connected']:
+ self.sendRaw(self.stream_footer)
+ #send end of stream
+ #wait for end of stream back
+ try:
+ self.socket.close()
+ self.filesocket.close()
+ self.socket.shutdown(socket.SHUT_RDWR)
+ except socket.error,(errno,strerror):
+ logging.warning("Error while disconnecting. Socket Error #%s: %s" % (errno, strerror))
+ if self.state['processing']:
+ raise
+
+ def reconnect(self):
+ self.state.set('tls',False)
+ self.state.set('ssl',False)
+ time.sleep(1)
+ self.connect()
+
+ def __spawnEvent(self, xmlobj):
+ "watching xmlOut and processes handlers"
+ #convert XML into Stanza
+ logging.debug("PROCESSING: %s" % xmlobj.tag)
+ stanza = None
+ for stanza_class in self.__root_stanza:
+ if self.__root_stanza[stanza_class].match(xmlobj):
+ stanza = stanza_class(self, xmlobj)
+ break
+ if stanza is None:
+ stanza = StanzaBase(self, xmlobj)
+ for handler in self.__handlers:
+ if handler.match(xmlobj):
+ handler.run(stanza)
+ if handler.checkDelete(): self.__handlers.pop(self.__handlers.index(handler))
+
+ #loop through handlers and test match
+ #spawn threads as necessary, call handlers, sending Stanza
+
+ def registerHandler(self, handler, before=None, after=None):
+ "Add handler with matcher class and parameters."
+ self.__handlers.append(handler)
+
+ def removeHandler(self, name):
+ "Removes the handler."
+ idx = 0
+ for handler in self.__handlers:
+ if handler.name == name:
+ self.__handlers.pop(idx)
+ return
+ idx += 1
+
+ def registerStanza(self, matcher, stanza_class, root=True):
+ "Adds stanza. If root stanzas build stanzas sent in events while non-root stanzas build substanza objects."
+ if root:
+ self.__root_stanza[stanza_class] = matcher
+ else:
+ self.__stanza[stanza_class] = matcher
+
+ def registerStanzaExtension(self, stanza_class, stanza_extension):
+ if stanza_class not in stanza_extensions:
+ stanza_extensions[stanza_class] = [stanza_extension]
+ else:
+ stanza_extensions[stanza_class].append(stanza_extension)
+
+ def removeStanza(self, stanza_class, root=False):
+ "Removes the stanza's registration."
+ if root:
+ del self.__root_stanza[stanza_class]
+ else:
+ del self.__stanza[stanza_class]
+
+ def removeStanzaExtension(self, stanza_class, stanza_extension):
+ stanza_extension[stanza_class].pop(stanza_extension)
+
+ def tostring(self, xml, xmlns='', stringbuffer=''):
+ newoutput = [stringbuffer]
+ #TODO respect ET mapped namespaces
+ itag = xml.tag.split('}', 1)[-1]
+ if '}' in xml.tag:
+ ixmlns = xml.tag.split('}', 1)[0][1:]
+ else:
+ ixmlns = ''
+ nsbuffer = ''
+ if xmlns != ixmlns and ixmlns != '':
+ if ixmlns in self.namespace_map:
+ if self.namespace_map[ixmlns] != '':
+ itag = "%s:%s" % (self.namespace_map[ixmlns], itag)
+ else:
+ nsbuffer = """ xmlns="%s\"""" % ixmlns
+ newoutput.append("<%s" % itag)
+ newoutput.append(nsbuffer)
+ for attrib in xml.attrib:
+ newoutput.append(""" %s="%s\"""" % (attrib, self.xmlesc(xml.attrib[attrib])))
+ if len(xml) or xml.text or xml.tail:
+ newoutput.append(">")
+ if xml.text:
+ newoutput.append(self.xmlesc(xml.text))
+ if len(xml):
+ for child in xml.getchildren():
+ newoutput.append(self.tostring(child, ixmlns))
+ newoutput.append("</%s>" % (itag, ))
+ if xml.tail:
+ newoutput.append(self.xmlesc(xml.tail))
+ elif xml.text:
+ newoutput.append(">%s</%s>" % (self.xmlesc(xml.text), itag))
+ else:
+ newoutput.append(" />")
+ return ''.join(newoutput)
+
+ def xmlesc(self, text):
+ if type(text) != types.UnicodeType:
+ text = list(unicode(text, 'utf-8', 'ignore'))
+ else:
+ text = list(text)
+ cc = 0
+ matches = ('&', '<', '"', '>', "'")
+ for c in text:
+ if c in matches:
+ if c == '&':
+ text[cc] = u'&amp;'
+ elif c == '<':
+ text[cc] = u'&lt;'
+ elif c == '>':
+ text[cc] = u'&gt;'
+ elif c == "'":
+ text[cc] = u'&apos;'
+ elif self.escape_quotes:
+ text[cc] = u'&quot;'
+ cc += 1
+ return ''.join(text)
+
+ def start_stream_handler(self, xml):
+ """Meant to be overridden"""
+ pass