| author | Sandro Knauß <knauss@netzguerilla.net> |
| Mon, 13 Feb 2012 15:38:50 +0100 | |
| branch | devel |
| changeset 144 | 1cc164bbb068 |
| parent 136 | ca926774e16c |
| child 191 | 1816e97881ce |
| permissions | -rw-r--r-- |
| 92 | 1 |
# -*- coding: utf-8 -*- |
| 117 | 2 |
from ..model.decorators import vUser, vRoute, dbdefer, vTyp |
| 135 | 3 |
from ..model.message import SMS, Fax, Mail |
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 | 7 |
from .task import createJob |
8 |
||
| 92 | 9 |
class Interface(object): |
10 |
'''class for a xmlrpc user |
|
11 |
''' |
|
12 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
13 |
@validate(kwd="detailed", func=vBool, need=False) |
|
136
ca926774e16c
now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents:
135
diff
changeset
|
14 |
@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
|
15 |
@vUser |
|
125
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
16 |
@dbdefer |
|
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
17 |
def status(self, session, user, id=None, detailed=False): |
| 92 | 18 |
'''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück. |
19 |
||
20 |
Keywords: |
|
21 |
apikey[string]: Der API Key |
|
22 |
id[hash]: Eine Auftragsnummer |
|
23 |
detailed[boolean]: Details ausgeben |
|
24 |
||
25 |
Return: |
|
26 |
jobs[list]: Eine Liste der Aufträge. |
|
27 |
job.name[string]: Angebener Name |
|
28 |
job.status[string]: Status des Auftrages |
|
29 |
||
30 |
||
31 |
''' |
|
|
125
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
32 |
user = session.merge(user) |
|
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
33 |
ret={} |
|
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
34 |
if not id: |
|
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
35 |
for job in user.jobs: |
|
136
ca926774e16c
now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents:
135
diff
changeset
|
36 |
ret[str(job.id)]={"status":job.status} |
|
114
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
37 |
else: |
|
136
ca926774e16c
now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents:
135
diff
changeset
|
38 |
ret[str(id)]={"status":user.job(id).status} |
|
ca926774e16c
now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents:
135
diff
changeset
|
39 |
|
|
125
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
40 |
return ret |
| 92 | 41 |
|
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
42 |
@vUser |
|
136
ca926774e16c
now using job.id - integer autoincrement
Sandro Knauß <knauss@netzguerilla.net>
parents:
135
diff
changeset
|
43 |
@validate(kwd="id", func=vInteger, minv=0) |
| 92 | 44 |
def stop(self, user, id): |
45 |
'''Stoppt den angegeben Auftrag. |
|
46 |
||
47 |
Keywords: |
|
48 |
apikey[string]: Der API Key |
|
49 |
id[hash]: Eine Auftragsnummer |
|
50 |
||
51 |
Return: |
|
52 |
||
53 |
''' |
|
54 |
return "" |
|
55 |
||
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
56 |
@validate(kwd="recipients",func=vTel) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
57 |
@vUser |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
58 |
@vRoute(typ="sms") |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
59 |
def sms(self, user, message, recipients, route="default", info=""): |
| 92 | 60 |
'''Versendet eine SMS. |
61 |
||
62 |
Keywords: |
|
63 |
apikey[string]: Der API Key |
|
64 |
message[string]: Nachricht |
|
65 |
recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
66 |
route[string|list]: Route über den geschickt werden soll, |
|
67 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
68 |
||
69 |
Return: |
|
70 |
id[hash]: Die ID des Auftrages |
|
71 |
||
72 |
''' |
|
| 135 | 73 |
job = createJob(recipients, SMS(message), info, route) |
74 |
return job.id |
|
| 92 | 75 |
|
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
76 |
@validate(kwd="recipients",func=vTel) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
77 |
@vUser |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
78 |
@vRoute(typ="fax") |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
79 |
def fax(self, user, subject, fax, recipients, route="default", info=""): |
| 92 | 80 |
'''Versendet ein FAX. |
81 |
||
82 |
Keywords: |
|
83 |
apikey[string]: Der API Key |
|
84 |
subject[string]: Der Betreff |
|
85 |
fax[string]: Das PDF base64 kodiert |
|
86 |
recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
87 |
route[string|list]: Route über den geschickt werden soll, |
|
88 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
89 |
||
90 |
Return: |
|
91 |
id[hash]: Die ID des Auftrages |
|
92 |
||
93 |
''' |
|
| 135 | 94 |
job = createJob(recipients, Fax(subject, fax), info, route) |
95 |
return job.id |
|
| 92 | 96 |
|
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
97 |
@validate(kwd="recipients",func=vEmail) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
98 |
@vUser |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
99 |
@vRoute(typ="mail") |
| 135 | 100 |
def mail(self, user, subject, body, recipients, frm=None, route="default", info=""): |
| 92 | 101 |
'''Versendet eine Email. |
102 |
||
103 |
Keywords: |
|
104 |
apikey[string]: Der API Key |
|
105 |
subject[string]: Der Betreff |
|
106 |
body[string]: Der Email Body |
|
107 |
recipients[list]: Eine Liste von Emailadressen |
|
108 |
frm[string]: Die Absender Emailadresse |
|
109 |
route[string|list]: Route über den geschickt werden soll, |
|
110 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
111 |
||
112 |
Return: |
|
113 |
id[hash]: Die ID des Auftrages |
|
114 |
||
115 |
''' |
|
| 135 | 116 |
|
117 |
job = createJob(recipients, Mail(frm, subject, body), info, route) |
|
118 |
return job.id |
|
| 92 | 119 |
|
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
120 |
@validate(kwd="typ", func=vTyp) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
121 |
@vUser |
| 117 | 122 |
@dbdefer |
|
125
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
123 |
def routes(self, session, user, typ): |
| 92 | 124 |
'''Gibt eine Liste aller verfügbaren Provider zurück. |
125 |
||
126 |
Keywords: |
|
127 |
apikey[string]: Der API Key |
|
128 |
typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
|
129 |
Einer der Liste ["sms","fax","mail"] |
|
130 |
||
131 |
Return: |
|
132 |
providerlist[list]: Eine Liste aller möglichen Provider |
|
133 |
||
134 |
''' |
|
|
121
ca63b6776231
putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
120
diff
changeset
|
135 |
user = session.merge(user) |
|
ca63b6776231
putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
120
diff
changeset
|
136 |
offers = user.routes(typ) |
|
119
3462c2c90f95
function routes complemented
Sandro Knauß <knauss@netzguerilla.net>
parents:
117
diff
changeset
|
137 |
return [u[0] for u in offers] |
| 92 | 138 |
|
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
139 |
@validate(kwd="typ", func=vTyp) |
|
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
140 |
@vUser |
| 117 | 141 |
@dbdefer |
|
125
19b3f383c9ce
getting job status form db
Sandro Knauß <knauss@netzguerilla.net>
parents:
121
diff
changeset
|
142 |
def defaultRoute(self, session, user, typ): |
| 92 | 143 |
'''Gibt den Standardprovider zurück. |
144 |
|
|
145 |
Keywords: |
|
146 |
apikey[string]: Der API Key |
|
| 109 | 147 |
typ[string]: Der Typ zu dem die Providerliste ausgeben werden soll |
| 92 | 148 |
Einer der Liste ["sms","fax","mail"] |
149 |
||
150 |
Return: |
|
151 |
provider[string]: Der Standardprovider für den angeben Typ |
|
152 |
||
153 |
||
154 |
''' |
|
|
121
ca63b6776231
putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
120
diff
changeset
|
155 |
user = session.merge(user) |
|
ca63b6776231
putting routes logic to schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
120
diff
changeset
|
156 |
offers = user.routes(typ, isDefault=True) |
|
120
7bde35ad89e0
function defaultRoute complemented
Sandro Knauß <knauss@netzguerilla.net>
parents:
119
diff
changeset
|
157 |
return [u[0] for u in offers] |
| 92 | 158 |
|
|
115
323d06431100
restructering validate
Sandro Knauß <knauss@netzguerilla.net>
parents:
114
diff
changeset
|
159 |
@vUser |
|
127
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
160 |
@dbdefer |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
161 |
def bill(self, session, user): |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
162 |
'''Gibt eine Rechnung zurück über die noch nicht abgerechneten Nachrichten und des Preises. |
| 92 | 163 |
|
164 |
Keywords: |
|
165 |
apikey[string]: Der API Key |
|
166 |
||
167 |
Return: |
|
|
127
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
168 |
bills[dict]: Eine Liste nach Nachrichtentypen |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
169 |
bill[route][info].anz: Anzahl der verschickten Nachrichten pro "Infoklasse" |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
170 |
bill[route][info].price: Preis pro "Infoklasse" |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
171 |
bill[route].anz: Anzahl der verschickten Nachrichten pro Route |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
172 |
bill[route].price: Preis für eine Route |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
173 |
total.price: der Gesammtpreis |
|
79966b937274
made bill (aka statistic) function ready
Sandro Knauß <knauss@netzguerilla.net>
parents:
126
diff
changeset
|
174 |
total.anz: die Gesammtanzahl |
| 92 | 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 | 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 |
|
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
196 |
Keywords: |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
197 |
recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
| 92 | 198 |
|
|
126
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
199 |
Return: |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
200 |
True: alle übergebene Nummern sind valide |
|
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 |
return True |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
203 |
|
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
204 |
@validate(kwd="recipients",func=vEmail) |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
205 |
def email(self,recipients): |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
206 |
'''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
|
207 |
|
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
208 |
Keywords: |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
209 |
recipients[list]: Eine Liste von Emailadressen |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
210 |
|
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
211 |
Return: |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
212 |
True: alle übergebene Nummern sind valide |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
213 |
''' |
|
1ac2439a68b5
adding test function for email- and telefonnumbers.
Sandro Knauß <knauss@netzguerilla.net>
parents:
125
diff
changeset
|
214 |
return True |