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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
#Copyright (C) 2009  Sandro Knauß <bugs@sandroknauss.de>
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
#This program is free software; you can redistribute it and/or modify it under the terms
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
#of the GNU General Public License as published by the Free Software Foundation;
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
#either version 3 of the License, or any later version.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
#This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
#without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
#See the GNU General Public License for more details.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
#You should have received a copy of the GNU General Public License
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
#along with this program; if not, see <http://www.gnu.org/licenses/>.
112
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    13
from twisted.web import soap, xmlrpc
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    14
93
ee10253258ad now right relative imports
Sandro Knauß <knauss@netzguerilla.net>
parents: 92
diff changeset
    15
from ..controller.viewinterface import Interface
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
110
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    17
from ..error import InterfaceException, ValidateException
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    19
class TwistedInterface(Interface):
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    20
    """Class that addes needed function for XML-RPC/SOAP"""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
    def __init__(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
        Interface.__init__(self)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
    def listMethods(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
        """Since we override lookupProcedure, its suggested to override
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
        listProcedures too.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
        """
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
        return self.listProcedures()
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    29
  
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    30
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    31
    def listProcedures(self):
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    32
        """returns a list of all functions that are allowed to call via XML-RPC."""
200
01c34f22be42 deleting stop function from iro.controller.viewinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
    33
        return ['listMethods','status','sms','fax','mail','routes','defaultRoute','bill','telnumber','email']
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    34
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
class XMLRPCInterface(TwistedInterface,xmlrpc.XMLRPC): 
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    37
    """XML-RPC interface"""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    38
    def __init__(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
        xmlrpc.XMLRPC.__init__(self) 
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
        TwistedInterface.__init__(self)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    41
    
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    42
    def lookupProcedure(self, procedurePath):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    43
        if procedurePath not in self.listProcedures():
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
                        "procedure %s not found" % procedurePath)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
        try:
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    47
            return getattr(self,procedurePath)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
        except KeyError:
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
                        "procedure %s not found" % procedurePath)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    51
110
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    52
    def _ebRender(self, failure):
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    53
        if isinstance(failure.value, InterfaceException):
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    54
            return xmlrpc.Fault(failure.value.code, failure.value.msg)
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    55
        if isinstance(failure.value, ValidateException):
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    56
            return xmlrpc.Fault(failure.value.code, failure.value.msg)
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    57
        return xmlrpc.XMLRPC._ebRender(self, failure)
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    58
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    59
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
class SOAPInterface(TwistedInterface,soap.SOAPPublisher): 
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    61
    """SOAP interface"""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
    def __init__(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
        soap.SOAPPublisher.__init__(self) 
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    64
        TwistedInterface.__init__(self)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    65
        
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    66
    def lookupFunction(self, functionName):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    67
        if functionName in self.listProcedures():
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    68
            function = getattr(self, functionName, None)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    69
            if function:
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    70
                return function, getattr(function, "useKeywords", False)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    71
            return None
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    72
        else:
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    73
            return None
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    74
112
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    75
def appendResource(root):
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    76
    """adding XML-RPC and SOAP to root."""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    77
    root.putChild('RPC2', XMLRPCInterface())
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    78
    root.putChild('SOAP', SOAPInterface())
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    79
    return root
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    80
112
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    81
if __name__ == '__main__':
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    82
    from twisted.web import resource, server
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    83
    from twisted.internet import reactor
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    84
    
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    85
    root = resource.Resource()
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    86
    root = appendResource(root)
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    87
    reactor.listenTCP(7080, server.Site(root))
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    88
    reactor.run()