iro/view/xmlrpc.py
author Sandro Knauß <bugs@sandroknauss.de>
Tue, 15 Apr 2025 01:22:19 +0200
changeset 316 63c681b8e92c
parent 312 42fd5075a5d1
permissions -rw-r--r--
fix link to about.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
294
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     1
# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net>
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     2
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     3
# This file is part of Iro.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     4
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     5
# Permission is hereby granted, free of charge, to any person obtaining a copy of
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     6
# this software and associated documentation files (the "Software"), to deal in
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     7
# the Software without restriction, including without limitation the rights to use,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     8
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
     9
# #Software, and to permit persons to whom the Software is furnished to do so,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    10
# subject to the following conditions:
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    11
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    12
# The above copyright notice and this permission notice shall be included in
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    13
# all copies or substantial portions of the Software.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    14
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    15
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    16
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    17
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    18
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    19
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    20
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 291
diff changeset
    21
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
# -*- coding: utf-8 -*-
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    23
#from twisted.web import soap
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    24
from twisted.web import xmlrpc
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
93
ee10253258ad now right relative imports
Sandro Knauß <knauss@netzguerilla.net>
parents: 92
diff changeset
    26
from ..controller.viewinterface import Interface
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
110
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    28
from ..error import InterfaceException, ValidateException
92
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
class TwistedInterface(Interface):
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    31
    """Class that addes needed function for XML-RPC/SOAP"""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
    def __init__(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
        Interface.__init__(self)
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
    def listMethods(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
        """Since we override lookupProcedure, its suggested to override
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
        listProcedures too.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    38
        """
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
        return self.listProcedures()
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
  
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 listProcedures(self):
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    43
        """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
    44
        return ['listMethods','status','sms','fax','mail','routes','defaultRoute','bill','telnumber','email']
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    47
class XMLRPCInterface(TwistedInterface,xmlrpc.XMLRPC): 
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    48
    """XML-RPC interface"""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
    def __init__(self):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
        xmlrpc.XMLRPC.__init__(self) 
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    51
        TwistedInterface.__init__(self)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
    
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    53
    def lookupProcedure(self, procedurePath):
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
        if procedurePath not in self.listProcedures():
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    56
                        "procedure %s not found" % procedurePath)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
        try:
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    58
            return getattr(self,procedurePath)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    59
        except KeyError:
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
                        "procedure %s not found" % procedurePath)
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
110
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    63
    def _ebRender(self, failure):
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    64
        if isinstance(failure.value, InterfaceException):
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    65
            return xmlrpc.Fault(failure.value.code, failure.value.msg)
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    66
        if isinstance(failure.value, ValidateException):
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    67
            return xmlrpc.Fault(failure.value.code, failure.value.msg)
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    68
        return xmlrpc.XMLRPC._ebRender(self, failure)
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    69
601fc908d9f1 exception handling for xmprpc
Sandro Knauß <knauss@netzguerilla.net>
parents: 93
diff changeset
    70
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    71
#class SOAPInterface(TwistedInterface,soap.SOAPPublisher): 
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    72
#    """SOAP interface"""
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    73
#    def __init__(self):
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    74
#        soap.SOAPPublisher.__init__(self) 
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    75
#        TwistedInterface.__init__(self)
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    76
#        
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    77
#    def lookupFunction(self, functionName):
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    78
#        if functionName in self.listProcedures():
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    79
#            function = getattr(self, functionName, None)
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    80
#            if function:
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    81
#                return function, getattr(function, "useKeywords", False)
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    82
#            return None
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    83
#        else:
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    84
#            return None
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    85
112
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    86
def appendResource(root):
265
f6c906b40cce iro.view: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
    87
    """adding XML-RPC and SOAP to root."""
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    88
    root.putChild('RPC2', XMLRPCInterface())
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 296
diff changeset
    89
    #root.putChild('SOAP', SOAPInterface())
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    90
112
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    91
if __name__ == '__main__':
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    92
    from twisted.web import resource, server
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    93
    from twisted.internet import reactor
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    94
    
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    95
    root = resource.Resource()
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    96
    root = appendResource(root)
ea437d1e7b65 reactor is now started my iro.main
Sandro Knauß <knauss@netzguerilla.net>
parents: 110
diff changeset
    97
    reactor.listenTCP(7080, server.Site(root))
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    98
    reactor.run()