iro/view/xmlrpc.py
author Sandro Knauß <knauss@netzguerilla.net>
Thu, 29 Mar 2012 18:44:28 +0200
branchdevel
changeset 265 f6c906b40cce
parent 200 01c34f22be42
child 291 84eb5a7a715a
permissions -rw-r--r--
iro.view: adding docstrings

# -*- coding: utf-8 -*-
#Copyright (C) 2009  Sandro Knauß <bugs@sandroknauss.de>

#This program is free software; you can redistribute it and/or modify it under the terms
#of the GNU General Public License as published by the Free Software Foundation;
#either version 3 of the License, or any later version.
#This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
#without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#See the GNU General Public License for more details.

#You should have received a copy of the GNU General Public License
#along with this program; if not, see <http://www.gnu.org/licenses/>.
from twisted.web import soap, xmlrpc

from ..controller.viewinterface import Interface

from ..error import InterfaceException, ValidateException

class TwistedInterface(Interface):
    """Class that addes needed function for XML-RPC/SOAP"""
    def __init__(self):
        Interface.__init__(self)

    def listMethods(self):
        """Since we override lookupProcedure, its suggested to override
        listProcedures too.
        """
        return self.listProcedures()
  

    def listProcedures(self):
        """returns a list of all functions that are allowed to call via XML-RPC."""
        return ['listMethods','status','sms','fax','mail','routes','defaultRoute','bill','telnumber','email']


class XMLRPCInterface(TwistedInterface,xmlrpc.XMLRPC): 
    """XML-RPC interface"""
    def __init__(self):
        xmlrpc.XMLRPC.__init__(self) 
        TwistedInterface.__init__(self)
    
    def lookupProcedure(self, procedurePath):
        if procedurePath not in self.listProcedures():
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
                        "procedure %s not found" % procedurePath)
        try:
            return getattr(self,procedurePath)
        except KeyError:
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
                        "procedure %s not found" % procedurePath)

    def _ebRender(self, failure):
        if isinstance(failure.value, InterfaceException):
            return xmlrpc.Fault(failure.value.code, failure.value.msg)
        if isinstance(failure.value, ValidateException):
            return xmlrpc.Fault(failure.value.code, failure.value.msg)
        return xmlrpc.XMLRPC._ebRender(self, failure)


class SOAPInterface(TwistedInterface,soap.SOAPPublisher): 
    """SOAP interface"""
    def __init__(self):
        soap.SOAPPublisher.__init__(self) 
        TwistedInterface.__init__(self)
        
    def lookupFunction(self, functionName):
        if functionName in self.listProcedures():
            function = getattr(self, functionName, None)
            if function:
                return function, getattr(function, "useKeywords", False)
            return None
        else:
            return None

def appendResource(root):
    """adding XML-RPC and SOAP to root."""
    root.putChild('RPC2', XMLRPCInterface())
    root.putChild('SOAP', SOAPInterface())
    return root

if __name__ == '__main__':
    from twisted.web import resource, server
    from twisted.internet import reactor
    
    root = resource.Resource()
    root = appendResource(root)
    reactor.listenTCP(7080, server.Site(root))
    reactor.run()