root/trunk/RBTelepathy/RBTelepathy/ErrorTypes.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 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

import logging as _logging

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

class RBTelepathyError(StandardError):
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    __slots__ = ('message', 'log', 'report', 'reraise', 'shutdown')

    message = 'Unknown Error'
    logtype = _logging.DEBUG
    logtraceback = False
    report = True
    shutdown = False
    #errortype = property(_get_errortype)

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def __init__(self, message, **kw):
        self.message = message
        for name, value in kw.iteritems():
            setattr(self, name, value)

    def __str__(self):
        return self.message

    def GetStreamHeader(self):
        return self._toXML()

    def GetStreamData(self):
        return ''

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

    def _toXML(self, *args, **kw):
        return ''

    def _get_errortype(self):
        return self.__class__.__name__
    errortype = property(_get_errortype)

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

class StreamError(RBTelepathyError):
    pass
class StreamProtocolError(StreamError):
    pass
class StreamQuotaError(StreamError): 
    log = _logging.WARN

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

class PacketError(StreamProtocolError):
    shutdown = True
class PacketIncompleteError(PacketError):
    shutdown = True
class PacketInvalidXMLError(PacketError):
    shutdown = True
class PacketMalformedError(PacketError):
    shutdown = False

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

class ConnectionError(RBTelepathyError):
    pass
class AuthenticationError(ConnectionError):
    log = _logging.WARN
    shutdown = True
class PermissionsError(ConnectionError):
    log = _logging.WARN
class PacketHandlerError(ConnectionError):
    pass

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

class RoutingError(ConnectionError):
    pass