iro/newinterface.py
author Sandro Knauß <knauss@netzguerilla.net>
Sat, 28 Jan 2012 04:03:46 +0100
branchdevel
changeset 120 7bde35ad89e0
parent 85 edf7e94cd607
permissions -rw-r--r--
function defaultRoute complemented
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
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    17
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    18
class User(object):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    19
    def __init__(self,name,userhash):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    20
        self.name=name
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    21
        self.userhash=userhash
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    22
    
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    23
    def __repr__(self):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    24
        return"User<'%s','%s'>"%(self.name,self.userhash)
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    25
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    26
users={"1":User("spam","1"),
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    27
       "2":User("foo","2")
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    28
}
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    29
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    30
def getuser(userhash):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    31
    try:
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    32
        return users[userhash]
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    33
    except KeyError:
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    34
        raise UserNotFound()
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    35
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    36
def with_user(f):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    37
    def new_f(*args,**kargs):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    38
        args=list(args)
85
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    39
        logging.debug("Entering %s"%f.__name__)
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    40
        try:
85
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    41
            kargs["user"]=getuser(kargs["apikey"])
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    42
            del kargs["apikey"]
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    43
        except KeyError:
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    44
            kargs["user"]=getuser(args[1])
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    45
            del args[1]
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    46
        ret=f(*args,**kargs)
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    47
        logging.debug("Exited %s"%f.__name__)
edf7e94cd607 user Decorator in einen try block
Sandro Knauß <knauss@netzguerilla.net>
parents: 81
diff changeset
    48
        return ret
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    49
    new_f.__name__ = f.__name__
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    50
    return new_f
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    51
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    52
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    53
class InterfaceException(Exception):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    54
    def __init__(self, code=999, msg="Unbekannter Fehler."):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    55
        self.code=code
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    56
        self.msg=msg
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    57
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    58
    def dict(self):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    59
        return {"code":self.code,
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    60
                "msg":self.msg,
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    61
                }
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    62
    def __str__(self):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    63
        return "%i:%s"%(self.code,self.msg)
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    64
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    65
class UserNotFound(InterfaceException):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    66
    def __init__(self):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    67
        InterfaceException.__init__(self, 901, "Der API-Key ist ungültig.")
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    68
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    69
class ExternalException(InterfaceException):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    70
    def __init__(self):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    71
        InterfaceException.__init__(self, 950, "Fehler in externer API.")
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    72
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    73
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
    74
class Interface(object):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    75
    '''class for a xmlrpc user
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    76
    '''
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    77
    
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    78
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    79
    def status(self, user, id=None, detailed=False):
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    80
        '''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    82
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    83
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    84
        id[hash]: Eine Auftragsnummer
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    85
        detailed[boolean]: Details ausgeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    86
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    87
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    88
        jobs[list]: Eine Liste der Aufträge.
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    89
        job.name[string]: Angebener Name
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    90
        job.status[string]: Status des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    91
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    92
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    93
        '''
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    94
        #return user.status(id,detailed)
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
    95
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    96
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    97
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
    98
    def stop(self, user, id):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
    99
        '''Stoppt den angegeben Auftrag.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   100
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   101
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   102
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   103
        id[hash]: Eine Auftragsnummer
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   104
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   105
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   106
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   107
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   108
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   109
    
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   110
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   111
    def sms(self, user, message, recipients, route="default"):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   112
        '''Versendet eine SMS.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   113
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   114
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   115
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   116
        message[string]: Nachricht
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   117
        recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   118
        route[string|list]: Route über den geschickt werden soll, 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   119
                            oder eine Liste von Routen, um Fallbacks anzugeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   120
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   121
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   122
        id[hash]: Die ID des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   123
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   124
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   125
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   126
   
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   127
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   128
    def fax(self, user, subject, fax, recipients, route="default"):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   129
        '''Versendet ein FAX.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   130
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   131
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   132
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   133
        subject[string]: Der Betreff
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   134
        fax[string]: Das PDF base64 kodiert
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   135
        recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   136
        route[string|list]: Route über den geschickt werden soll, 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   137
                            oder eine Liste von Routen, um Fallbacks anzugeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   138
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   139
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   140
        id[hash]: Die ID des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   141
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   142
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   143
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   144
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   145
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   146
    def mail(self, user, subject,  body, recipients, frm, route="default"):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   147
        '''Versendet eine Email.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   148
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   149
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   150
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   151
        subject[string]: Der Betreff
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   152
        body[string]: Der Email Body
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   153
        recipients[list]: Eine Liste von Emailadressen
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   154
        frm[string]: Die Absender Emailadresse
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   155
        route[string|list]: Route über den geschickt werden soll, 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   156
                            oder eine Liste von Routen, um Fallbacks anzugeben
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   157
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   158
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   159
        id[hash]: Die ID des Auftrages
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   160
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   161
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   162
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   163
       
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   164
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   165
    def routes(self, user, typ):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   166
        '''Gibt eine Liste aller verfügbaren Provider zurück.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   167
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   168
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   169
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   170
        typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   171
                     Einer der Liste ["sms","fax","mail"]
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   172
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   173
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   174
        providerlist[list]: Eine Liste aller möglichen Provider
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   175
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   176
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   177
        return ""
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   178
        
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   179
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   180
    def defaultRoute(self, user, typ):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   181
        '''Gibt den Standardprovider zurück.
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   182
 
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   183
        Keywords:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   184
        apikey[string]: Der API Key
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   185
        typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   186
                     Einer der Liste ["sms","fax","mail"]
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   187
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   188
        Return:
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   189
        provider[string]: Der Standardprovider für den angeben Typ
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   190
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   191
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   192
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   193
        return ""
75
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   194
81
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   195
    @with_user
fea4c6760ca5 ein wenig aufräumen
Sandro Knauß <knauss@netzguerilla.net>
parents: 80
diff changeset
   196
    def statistic(self, user):
76
9f7da8dc8df8 using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents: 75
diff changeset
   197
        '''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
   198
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   199
        Keywords:
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   200
        apikey[string]: Der API Key
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   201
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   202
        Return:
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   203
        statistic[list]: Eine Liste nach Nachrichtentypen
c6a281dafa7a adding statistic method for new api
Sandro Knauß <knauss@netzguerilla.net>
parents: 73
diff changeset
   204
        '''
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   205
        return ""
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   206
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   207
    def listMethods(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   208
        """Since we override lookupProcedure, its suggested to override
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   209
        listProcedures too.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   210
        """
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   211
        return self.listProcedures()
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   212
  
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   213
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   214
    def listProcedures(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   215
        """Since we override lookupProcedure, its suggested to override
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   216
        listProcedures too.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   217
        """
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   218
        return ['listMethods','status','stop','sms','fax','mail','routes','defaultRoute','statistic']
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   219
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   220
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   221
class XMLRPCInterface(Interface,xmlrpc.XMLRPC): 
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   222
    def __init__(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   223
        xmlrpc.XMLRPC.__init__(self) 
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   224
        Interface.__init__(self)
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   225
    
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   226
    def lookupProcedure(self, procedurePath):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   227
        logging.debug("lookupProcedure('%s')"%procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   228
        if procedurePath not in self.listProcedures():
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   229
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   230
                        "procedure %s not found" % procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   231
        try:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   232
            return getattr(self,procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   233
        except KeyError:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   234
            raise xmlrpc.NoSuchFunction(self.NOT_FOUND,
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   235
                        "procedure %s not found" % procedurePath)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   236
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   237
class SOAPInterface(Interface,soap.SOAPPublisher): 
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   238
    def __init__(self):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   239
        soap.SOAPPublisher.__init__(self) 
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   240
        Interface.__init__(self)
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   241
        
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   242
    def lookupFunction(self, functionName):
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   243
        """Lookup published SOAP function.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   244
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   245
        Override in subclasses. Default behaviour - publish methods
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   246
        starting with soap_, if they have true attribute useKeywords
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   247
        they are expected to accept keywords.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   248
        
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   249
        @return: tuple (callable, useKeywords), or (None, None) if not found.
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   250
        """
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   251
        if functionName in self.listProcedures():
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   252
            function = getattr(self, functionName, None)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   253
            if function:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   254
                return function, getattr(function, "useKeywords", False)
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   255
            return None
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   256
        else:
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   257
            return None
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   258
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   259
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   260
def main():
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   261
    from twisted.internet import reactor
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   262
    root = resource.Resource()
80
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   263
    root.putChild('RPC2', XMLRPCInterface())
265124610789 renaming newuser->newinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 79
diff changeset
   264
    root.putChild('SOAP', SOAPInterface())
79
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   265
    reactor.listenTCP(7080, server.Site(root))
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   266
    reactor.run()
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   267
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   268
if __name__ == '__main__':
17a00b99b9fd twisted XMLRPC&SOAP support
Sandro Knauß <knauss@netzguerilla.net>
parents: 76
diff changeset
   269
    main()