iro/controller/viewinterface.py
author Sandro Knauß <knauss@netzguerilla.net>
Sun, 25 Mar 2012 20:14:35 +0200
branchdevel
changeset 253 e8d56537c9cc
parent 250 91890ea7ed81
child 268 d0fcb1cde990
permissions -rw-r--r--
start documenting with reST syntax.
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 -*-
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
     2
from ..model.decorators import vUser, vRoute, dbdefer, vTyp
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     3
from ..model.message import SMS, Fax, Mail
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     4
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
     5
from ..validate import validate, vBool, vTel, vEmail, vInteger
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
     6
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     7
from .task import createJob
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
     8
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
class Interface(object):
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    10
    '''Interface for views.'''
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
    
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    12
    @validate(kwd="detailed", func=vBool, need=False)
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    13
    @validate(kwd="id", func=vInteger, minv=0, need=False, none_allowed=True)
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    14
    @vUser
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    15
    @dbdefer
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    16
    def status(self, session, user, id=None, detailed=False):
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    17
        '''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    19
        :param string apikey: der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    20
        :param hash id: Eine Auftragsnummer
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    21
        :param `boolean` detailed: Details ausgeben
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    22
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    23
        :return dict: 
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    24
           - `key` ist die Auftragsnummer
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    25
           - [`key`][**'status'**] -- Status des Auftrages
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    27
        .. warning:: detailed is not used yet.
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    28
        
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    29
        >>> status(APIKEY)
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    30
        {"1":  {"status":"sended"},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    31
         "2":  {"status":"error"},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    32
         "10": {"status":"sending"}}
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    34
        >>> status(APIKEY,"10")
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    35
        {"10": {"status":"sending"}}
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
        '''
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    37
        user = session.merge(user)
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    38
        ret={}
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    39
        if not id:
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    40
            for job in  user.jobs:
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    41
                ret[str(job.id)]={"status":job.status}
114
1ed072cc6793 reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents: 109
diff changeset
    42
        else:
136
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    43
            ret[str(id)]={"status":user.job(id).status}
ca926774e16c now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    44
        
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
    45
        return ret
200
01c34f22be42 deleting stop function from iro.controller.viewinterface
Sandro Knauß <knauss@netzguerilla.net>
parents: 199
diff changeset
    46
   
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    47
    @validate(kwd="recipients",func=vTel)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    48
    @vUser
210
3763babd5e10 refactoring vRoute
Sandro Knauß <knauss@netzguerilla.net>
parents: 206
diff changeset
    49
    @validate(kwd="route", func=vRoute, typ="sms")
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    50
    def sms(self, user, message, recipients, route="default", info=""):
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    51
        '''Versendet eine SMS.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    53
        :param string apikey: Der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    54
        :param string message: Nachricht
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    55
        :param list recipients: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    56
        :param route: Route über den geschickt werden soll, 
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
                            oder eine Liste von Routen, um Fallbacks anzugeben
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    58
        :type route: string|list
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    59
        :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    61
        :return hash: Die ID des Auftrages
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
        '''
191
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    64
        d = createJob(user, recipients, SMS(message), route, info)
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    65
        def ret(job):
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    66
            return job.dbjob
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    67
        d.addCallback(ret)
1816e97881ce test viewinterface.sms added
Sandro Knauß <knauss@netzguerilla.net>
parents: 136
diff changeset
    68
        return d
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    69
   
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    70
    @validate(kwd="recipients",func=vTel)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    71
    @vUser
210
3763babd5e10 refactoring vRoute
Sandro Knauß <knauss@netzguerilla.net>
parents: 206
diff changeset
    72
    @validate(kwd="route",func=vRoute, typ="fax")
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    73
    def fax(self, user, subject, fax, recipients, route="default", info=""):
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    74
        '''Versendet ein FAX.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    75
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    76
        :param string apikey: Der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    77
        :param string subject: Der Betreff
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    78
        :param string fax: Der base64 kodierte content
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    79
        :param list recipients: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    80
        :param route: Route über den geschickt werden soll, 
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
                            oder eine Liste von Routen, um Fallbacks anzugeben
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    82
        :type route: string|list
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    83
        :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    84
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
    85
        :return hash: Die ID des Auftrages
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    86
        '''
198
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    87
        d = createJob(user, recipients, Fax(subject, fax), route, info)
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    88
        def ret(job):
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    89
            return job.dbjob
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    90
        d.addCallback(ret)
85ede27b1add tests for controller.viewinterface.fax added
Sandro Knauß <knauss@netzguerilla.net>
parents: 192
diff changeset
    91
        return d
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    92
199
1bcca1a40769 test for nor explicit frm mailaddress
Sandro Knauß <knauss@netzguerilla.net>
parents: 198
diff changeset
    93
    @validate(kwd="recipients",func=vEmail, allowString=False)
1bcca1a40769 test for nor explicit frm mailaddress
Sandro Knauß <knauss@netzguerilla.net>
parents: 198
diff changeset
    94
    @validate(kwd="frm",func=vEmail, need=False, allowList=False)
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
    95
    @vUser
210
3763babd5e10 refactoring vRoute
Sandro Knauß <knauss@netzguerilla.net>
parents: 206
diff changeset
    96
    @validate(kwd="route",func=vRoute, typ="mail")
192
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
    97
    def mail(self, user, subject, body, recipients, frm=None, route="default", info=""):
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    98
        '''Versendet eine Email.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    99
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   100
        :param string apikey: Der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   101
        :param string subject: Der Betreff
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   102
        :param string body: Der Email Body
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   103
        :param list recipients: Eine Liste von Emailadressen
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   104
        :param string frm: Die Absender Emailadresse
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   105
        :param route: Route über den geschickt werden soll, 
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   106
                            oder eine Liste von Routen, um Fallbacks anzugeben
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   107
        :type route: string|list
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   108
        :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   109
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   110
        :return hash: Die ID des Auftrages
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   111
        '''
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents: 127
diff changeset
   112
192
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   113
        d = createJob(user, recipients, Mail(subject, body, frm), route, info)
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   114
        def ret(job):
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   115
            return job.dbjob
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   116
        d.addCallback(ret)
6c708c334f37 test for controller.viewinterface.mail
Sandro Knauß <knauss@netzguerilla.net>
parents: 191
diff changeset
   117
        return d
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   118
       
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   119
    @validate(kwd="typ", func=vTyp)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   120
    @vUser
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
   121
    @dbdefer
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
   122
    def routes(self, session, user, typ):
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   123
        '''Gibt eine Liste aller verfügbaren Provider zurück.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   124
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   125
        :param string apikey: Der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   126
        :param string typ: Der Typ zu dem die Providerloste ausgeben werden soll
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   127
                     Einer der Liste ["sms","fax","mail"]
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   128
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   129
        :return list: Eine Liste aller möglichen Provider
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   130
        '''
121
ca63b6776231 putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents: 120
diff changeset
   131
        user = session.merge(user)
ca63b6776231 putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents: 120
diff changeset
   132
        offers = user.routes(typ)
119
3462c2c90f95 function routes complemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 117
diff changeset
   133
        return [u[0] for u in offers]
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   134
        
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   135
    @validate(kwd="typ", func=vTyp)
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   136
    @vUser
117
351a02310dd8 model restructuring
Sandro Knauß <knauss@netzguerilla.net>
parents: 115
diff changeset
   137
    @dbdefer
125
19b3f383c9ce getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents: 121
diff changeset
   138
    def defaultRoute(self, session, user, typ):
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   139
        '''Gibt den Standardprovider zurück.
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   140
 
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   141
        :param string apikey: Der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   142
        :param string typ: Der Typ zu dem die Providerliste ausgeben werden soll
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   143
                     Einer der Liste ["sms","fax","mail"]
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   144
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   145
        :return string: Der Standardprovider für den angeben Typ
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   146
        '''
121
ca63b6776231 putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents: 120
diff changeset
   147
        user = session.merge(user)
201
843a7bcecbc8 renameing Userright.isDefault(bool) -> default(int)
Sandro Knauß <knauss@netzguerilla.net>
parents: 200
diff changeset
   148
        offers = user.routes(typ, default=True)
120
7bde35ad89e0 function defaultRoute complemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 119
diff changeset
   149
        return [u[0] for u in offers]
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   150
115
323d06431100 restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents: 114
diff changeset
   151
    @vUser
127
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   152
    @dbdefer
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   153
    def bill(self, session, user):
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   154
        '''Gibt eine Rechnung zurück über die noch nicht abgerechneten Nachrichten und des Preises.
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   155
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   156
        :param string apikey: Der API Key
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   157
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   158
        :return dict:
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   159
            - `route` -- Entspricht einer Route; **"total"** für die Gesammtübersicht
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   160
            - [`route`][`info`][**anz**] -- Anzahl der verschickten Nachrichten pro "Infoklasse"
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   161
            - [`route`][`info`][**price**] -- Preis pro "Infoklasse"
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   162
            - [`route` | **total**][**anz**] -- Anzahl der verschickten Nachrichten pro Route 
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   163
            - [`route` | **total**][**price**] -- Preis für eine Route
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   164
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   165
        >>> bill(APIKEY)
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   166
        {"route1": {"info1":{"anz":1,"price":2.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   167
                    "info2":{"anz":2,"price":5.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   168
                    "anz":3,"price":7.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   169
        "route2":  {"info1":{"anz":3, "price":1.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   170
                    "info3":{"anz":4, "price":8.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   171
                    "anz":7, "price":9.00},
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   172
        "total":   {"anz":10, "price":16.00}
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   173
        }
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   174
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   175
        '''
127
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   176
        ret={'total':{'price':0, 'anz':0}}
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   177
        user=session.merge(user)
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   178
        for route in user.rights:
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   179
            n=route.offer_name
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   180
            ret[n]={'price':0, 'anz':0, 'info':{}}
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   181
            for bill in route.bill:
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   182
                ret[n]['info'][bill.info]={'price':float(bill.price),'anz':bill.anz}
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   183
                ret[n]['price'] += bill.price
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   184
                ret[n]['anz'] += bill.anz
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   185
            ret['total']['price'] += ret[n]['price'] 
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   186
            ret['total']['anz'] += ret[n]['anz'] 
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   187
            ret[n]['price'] = float(ret[n]['price'])
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   188
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   189
        ret['total']['price'] = float(ret['total']['price'])
79966b937274 made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents: 126
diff changeset
   190
        return ret
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   191
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   192
    @validate(kwd="recipients",func=vTel)
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   193
    def telnumber(self,recipients):
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   194
        '''Gibt True zurück, falls alle übergebene Telefonnummern valide sind.
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   195
        
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   196
        :param list recipients: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
92
f479738b4879 umbau zu MVC
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   197
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   198
        :return: True -- alle übergebene Nummern sind valide
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   199
        '''
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   200
        return True
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   201
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   202
    @validate(kwd="recipients",func=vEmail)
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   203
    def email(self,recipients):
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   204
        '''Gibt True zurück, falls alle übergebene Emailadressen valide sind.
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   205
        
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   206
        :param list recipients: Eine Liste von Emailadressen
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   207
253
e8d56537c9cc start documenting with reST syntax.
Sandro Knauß <knauss@netzguerilla.net>
parents: 250
diff changeset
   208
        :return: True -- alle übergebene Nummern sind valide
126
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   209
        '''
1ac2439a68b5 adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents: 125
diff changeset
   210
        return True