root/trunk/RBTelepathy/RBTelepathy/Packet/Builder.py

#!/usr/bin/env python
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##~ License 
##~ 
##- The RuneBlade Foundation library is intended to ease some 
##- aspects of writing intricate Jabber, XML, and User Interface (wxPython, etc.) 
##- applications, while providing the flexibility to modularly change the 
##- architecture. Enjoy.
##~ 
##~ Copyright (C) 2002  TechGame Networks, LLC.
##~ 
##~ This library is free software; you can redistribute it and/or
##~ modify it under the terms of the BSD style License as found in the 
##~ LICENSE file included with this distribution.
##~ 
##~ TechGame Networks, LLC can be reached at:
##~ 3578 E. Hartsel Drive #211
##~ Colorado Springs, Colorado, USA, 80920
##~
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Imports 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

from __future__ import generators

import weakref
from xml.parsers.expat import ExpatError

from RBFoundation import XMLClassBuilder
from RBTelepathy import ErrorTypes

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Constants / Variables / Etc. 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

EF = XMLClassBuilder.ElementFactory

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Definitions 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class ChildELementErrorFactory(object):
    def __call__(self, owner, parent, node, attributes, namespacemap):
        raise KeyError, '"%s" is not a valid subchild of "%s"' % (node[1], parent.__node__)

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class RootMessageErrorFactory(object):
    def __call__(self, owner, parent, node, attributes, namespacemap):
        raise KeyError, '"%s" is not a valid topl level element' % (node[1], )

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class PacketFactorySet(XMLClassBuilder.ElementFactorySet):
    def _GetElementFactoryIndices(self, (namespace, node)):
        yield (namespace, node)
        yield (namespace, )
        yield node
        yield None

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class StreamPacketBuilder(XMLClassBuilder.XMLClassBuilder):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    ElementFactories = PacketFactorySet()

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def BuildPacket(self, *args, **kw):
        try:
            return self.Parse(*args, **kw)
        except ErrorTypes.RBTelepathyError, e:
            raise # Pass these along...
        except ExpatError, e:
            raise ErrorTypes.PacketInvalidXMLError(str(e))
        except StandardError, e:
            # XXX: Change these to PacketErrors
            #raise ErrorTypes.PacketError(str(e))
            raise

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Protected Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def _xmlChildFactory(self, owner, parent, node, attributes, namespacemap):
        try:
            XMLClassBuilder.XMLClassBuilder._xmlChildFactory(self, owner, parent, node, attributes, namespacemap)
        except KeyError, e:
            # Well, we don't seem to have a packet for that... Error!  =)
            raise ErrorTypes.PacketHandlerError(str(e))

    def RootElement(self):
        if self._elements: 
            return self._elements[0]
        else: 
            return None