iro/newinterface.py
author Sandro Knauß <knauss@netzguerilla.net>
Sun, 18 Dec 2011 16:43:22 +0100
branchdevel
changeset 80 265124610789
parent 79 iro/newuser.py@17a00b99b9fd
child 81 fea4c6760ca5
permissions -rw-r--r--
renaming newuser->newinterface
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
#Copyright (C) 2009  Sandro Knauß <bugs@sandroknauss.de>
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
f2f247a5b6c9 update Documentation
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
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
#of the GNU General Public License as published by the Free Software Foundation;
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
#either version 3 of the License, or any later version.
f2f247a5b6c9 update Documentation
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;
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
#without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
#See the GNU General Public License for more details.
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
#You should have received a copy of the GNU General Public License
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
#along with this program; if not, see <http://www.gnu.org/licenses/>.
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    13
from twisted.web import soap, xmlrpc, resource, server
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    14
import logging
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    15
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(name)s(%(processName)s)-%(levelname)s: %(message)s')
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
    17
class Interface(object):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    18
    '''class for a xmlrpc user
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    19
    '''
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    20
    
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
    def status(self, apikey, id=None, detailed=False):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    22
        '''Gibt den aktuellen Status eines Auftrages zurück.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
        id[hash]: Eine Auftragsnummer
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
        detailed[boolean]: Details ausgeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    29
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    30
        jobs[list]: Eine Liste der Aufträge.
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    31
        job.name[string]: Angebener Name
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
        job.status[string]: Status des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    34
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    36
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    38
    def stop(self, apikey,id):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    39
        '''Stoppt den angegeben Auftrag.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    41
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    42
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    43
        id[hash]: Eine Auftragsnummer
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    47
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    48
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
    
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
    def sms(self, apikey, message, recipients, route="default"):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    51
        '''Versendet eine SMS.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    53
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
        message[string]: Nachricht
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    56
        recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
        route[string|list]: Route über den geschickt werden soll, 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    58
                            oder eine Liste von Routen, um Fallbacks anzugeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    59
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
        id[hash]: Die ID des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    64
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    65
   
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    66
    
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    67
    def fax(self, apikey, subject, fax, recipients, route="default"):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    68
        '''Versendet ein FAX.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    69
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    70
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    71
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    72
        subject[string]: Der Betreff
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    73
        fax[string]: Das PDF base64 kodiert
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    74
        recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    75
        route[string|list]: Route über den geschickt werden soll, 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    76
                            oder eine Liste von Routen, um Fallbacks anzugeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    77
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    78
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    79
        id[hash]: Die ID des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    80
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    82
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    83
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    84
    def mail(self, apikey, subject,  body, recipients, frm, route="default"):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    85
        '''Versendet eine Email.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    86
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    87
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    88
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    89
        subject[string]: Der Betreff
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    90
        body[string]: Der Email Body
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    91
        recipients[list]: Eine Liste von Emailadressen
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    92
        frm[string]: Die Absender Emailadresse
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    93
        route[string|list]: Route über den geschickt werden soll, 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    94
                            oder eine Liste von Routen, um Fallbacks anzugeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    95
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    96
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    97
        id[hash]: Die ID des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    98
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    99
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   100
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   101
       
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   102
    def routes(self, apikey, typ):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   103
        '''Gibt eine Liste aller verfügbaren Provider zurück.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   104
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   105
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   106
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   107
        typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   108
                     Einer der Liste ["sms","fax","mail"]
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   109
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   110
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   111
        providerlist[list]: Eine Liste aller möglichen Provider
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   112
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   113
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   114
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   115
        
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   116
    def defaultRoute(self, apikey, typ):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   117
        '''Gibt den Standardprovider zurück.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   118
 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   119
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   120
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   121
        typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   122
                     Einer der Liste ["sms","fax","mail"]
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   123
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   124
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   125
        provider[string]: Der Standardprovider für den angeben Typ
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   126
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   127
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   128
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   129
        return ""
75
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   130
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   131
    def statistic(self,apikey):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   132
        '''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises.
75
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   133
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   134
        Keywords:
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   135
        apikey[string]: Der API Key
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   136
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   137
        Return:
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   138
        statistic[list]: Eine Liste nach Nachrichtentypen
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   139
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   140
        return ""
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   141
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   142
    def listMethods(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   143
        """Since we override lookupProcedure, its suggested to override
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   144
        listProcedures too.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   145
        """
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   146
        return self.listProcedures()
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   147
  
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   148
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   149
    def listProcedures(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   150
        """Since we override lookupProcedure, its suggested to override
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   151
        listProcedures too.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   152
        """
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   153
        return ['listMethods','status','stop','sms','fax','mail','routes','defaultRoute','statistic']
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   154
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   155
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   156
class XMLRPCInterface(Interface,xmlrpc.XMLRPC): 
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   157
    def __init__(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   158
        xmlrpc.XMLRPC.__init__(self) 
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   159
        Interface.__init__(self)
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   160
        self.allowNone = True
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   161
    
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   162
    def lookupProcedure(self, procedurePath):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   163
        logging.debug("lookupProcedure('%s')"%procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   164
        if procedurePath not in self.listProcedures():
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   165
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   166
                        "procedure %s not found" % procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   167
        try:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   168
            return getattr(self,procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   169
        except KeyError:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   170
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   171
                        "procedure %s not found" % procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   172
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   173
class SOAPInterface(Interface,soap.SOAPPublisher): 
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   174
    def __init__(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   175
        soap.SOAPPublisher.__init__(self) 
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   176
        Interface.__init__(self)
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   177
        
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   178
    def lookupFunction(self, functionName):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   179
        """Lookup published SOAP function.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   180
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   181
        Override in subclasses. Default behaviour - publish methods
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   182
        starting with soap_, if they have true attribute useKeywords
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   183
        they are expected to accept keywords.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   184
        
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   185
        @return: tuple (callable, useKeywords), or (None, None) if not found.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   186
        """
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   187
        if functionName in self.listProcedures():
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   188
            function = getattr(self, functionName, None)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   189
            if function:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   190
                return function, getattr(function, "useKeywords", False)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   191
            return None
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   192
        else:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   193
            return None
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   194
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   195
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   196
def main():
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   197
    from twisted.internet import reactor
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   198
    root = resource.Resource()
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   199
    root.putChild('RPC2', XMLRPCInterface())
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   200
    root.putChild('SOAP', SOAPInterface())
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   201
    reactor.listenTCP(7080, server.Site(root))
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   202
    reactor.run()
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   203
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   204
if __name__ == '__main__':
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   205
    main()