-
Notifications
You must be signed in to change notification settings - Fork 2
/
ispdbmodel.py
571 lines (496 loc) · 22.3 KB
/
ispdbmodel.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
#!
# -*- coding: utf-8 -*-
"""
╔════════════════════════════════════════════════════════════════════════════════════╗
║ ║
║ Copyright (c) 2020 https://prrvchr.github.io ║
║ ║
║ Permission is hereby granted, free of charge, to any person obtaining ║
║ a copy of this software and associated documentation files (the "Software"), ║
║ to deal in the Software without restriction, including without limitation ║
║ the rights to use, copy, modify, merge, publish, distribute, sublicense, ║
║ and/or sell copies of the Software, and to permit persons to whom the Software ║
║ is furnished to do so, subject to the following conditions: ║
║ ║
║ The above copyright notice and this permission notice shall be included in ║
║ all copies or substantial portions of the Software. ║
║ ║
║ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, ║
║ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES ║
║ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. ║
║ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY ║
║ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, ║
║ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE ║
║ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ║
║ ║
╚════════════════════════════════════════════════════════════════════════════════════╝
"""
import uno
import unohelper
from com.sun.star.awt.FontWeight import BOLD
from com.sun.star.ucb.ConnectionMode import OFFLINE
from com.sun.star.logging.LogLevel import ALL
from com.sun.star.mail.MailServiceType import IMAP
from com.sun.star.mail.MailServiceType import SMTP
from com.sun.star.rest.HTTPStatusCode import NOT_FOUND
from com.sun.star.rest import HTTPException
from com.sun.star.rest import RequestException
from com.sun.star.uno import Exception as UnoException
from ..transferable import Transferable
from ..unotool import createService
from ..unotool import getConfiguration
from ..unotool import getConnectionMode
from ..unotool import getResourceLocation
from ..unotool import getStringResource
from ..unotool import getUrl
from ..unotool import hasInterface
from ..mailertool import getMailService
from ..mailertool import getMailMessage
from ..mailertool import getMessageImage
from ..logger import LogController
from ..logger import RollerHandler
from ..oauth2 import g_service
from ..configuration import g_identifier
from ..configuration import g_extension
from ..configuration import g_mailservicelog
from ..configuration import g_logo
from ..configuration import g_logourl
from ..configuration import g_chunk
from ..user import User
from .ispdbserver import IspdbServer
from email.utils import parseaddr
import xml.etree.ElementTree as ET
from time import sleep
from threading import Thread
import validators
import traceback
class IspdbModel(unohelper.Base):
def __init__(self, ctx, sender, readonly):
self._ctx = ctx
self._sender = sender
self._readonly = readonly
self._servers = None
self._services = [SMTP.value, IMAP.value]
self._offline = 0
self._diposed = False
self._version = 0
self._listener = None
secure = {0: 3, 1: 4, 2: 5}
unsecure = {0: 0, 1: 1, 2: 2}
self._levels = {0: unsecure, 1: secure, 2: secure}
self._connections = {0: 'Insecure', 1: 'SSL', 2: 'TLS'}
self._authentications = {0: 'None', 1: 'Login', 2: 'OAuth2'}
configuration = getConfiguration(ctx, g_identifier)
self._url = configuration.getByName('IspDBUrl')
self._timeout = configuration.getByName('ConnectTimeout')
self._logger = LogController(ctx, g_mailservicelog)
self._resolver = getStringResource(ctx, g_identifier, g_extension)
self._resources = {'Step': 'IspdbPage%s.Step',
'Title': 'IspdbPage%s.Title.%s',
'PageLabel': 'IspdbPage%s.Label1.Label',
'PagesLabel': 'IspdbPages.Label1.Label',
'Progress': 'IspdbPage2.Label2.Label.%s',
'Security': 'IspdbPages.Label10.Label.%s',
'SendTitle': 'SendDialog.Title',
'SendSubject': 'SendDialog.TextField2.Text',
'SendMessage': 'SendDialog.TextField3.Text',
'ThreadTitle': 'SendThread.Title'}
@property
def Email(self):
name, address = parseaddr(self._sender)
return address
@property
def Sender(self):
return self._sender
@Sender.setter
def Sender(self, sender):
self._sender = sender
@property
def Offline(self):
return self._offline
@Offline.setter
def Offline(self, offline):
self._offline = offline
def resolveString(self, resource):
return self._stringResource.resolveString(resource)
# IspdbModel getter methods called by IspdbWizard
def dispose(self):
self._diposed = True
if self._listener is not None:
self._logger.removeModifyListener(self._listener)
self._listener = None
# IspdbModel getter methods called by WizardPages 1
def getSender(self):
return self._sender, not self._readonly
# IspdbModel getter methods called by WizardPages 2 and 4
def isDisposed(self):
return self._diposed
# IspdbModel getter methods called by WizardPage1
def isEmailValid(self, sender):
name, address = parseaddr(sender)
if validators.email(address):
return True
return False
# IspdbModel getter methods called by WizardPage2
def getServerConfig(self, *args):
self._version += 1
Thread(target=self._getServerConfig, args=args).start()
def _getServerConfig(self, progress, update):
# FIXME: Because we call this thread in the WizardPage.activatePage(),
# FIXME: if we want to be able to navigate through the Wizard roadmap
# FIXME: without GUI refreshing problem then we need to pause this thread.
sleep(0.2)
auto = False
config = None
progress(10)
url = getUrl(self._ctx, self._url)
progress(20)
mode = getConnectionMode(self._ctx, url.Server)
progress(30)
user = User(self._ctx, self.Sender)
progress(40)
request = createService(self._ctx, g_service)
progress(50)
if request is None:
offset = 1 if user.isNew() else 2
status = (100, offset, BOLD)
elif mode == OFFLINE:
offset = 3 if user.isNew() else 4
status = (100, offset, BOLD)
else:
progress(60)
try:
config = self._getIspdbConfig(user, request, url.Complete)
except RequestException as e:
offset = 5 if user.isNew() else 6
status = (100, offset, BOLD)
else:
progress(80)
if not user.isNew():
status = (100, 7)
elif config is None:
status = (100, 8)
else:
auto = True
status = (100, 9)
self._servers = IspdbServer(user, config)
self._offline = mode
progress(*status)
update(self.getPageTitle(2), auto, user.getReplyToState(), user.ReplyToAddress, user.getImapState(), mode)
def _getIspdbConfig(self, user, request, url):
config = None
parameter = request.getRequestParameter('getIspdbConfig')
parameter.Url = '%s%s' % (url, user.getUserDomain())
parameter.NoAuth = True
response = request.execute(parameter)
if response.Ok:
config = self._parseIspdbConfig(user, response)
elif response.StatusCode != NOT_FOUND:
response.raiseForStatus()
response.close()
return config
def _parseIspdbConfig(self, user, response):
smtps = []
imaps = []
config = {}
map1 = {'plain': 0, 'SSL': 1, 'STARTTLS': 2}
map2 = {'none': 0, 'password-cleartext': 1, 'plain': 1,
'password-encrypted': 1, 'secure': 1, 'OAuth2': 2}
map3 = {'%EMAILLOCALPART%': 0, '%EMAILADDRESS%': 1, '%EMAILDOMAIN%': 2}
parser = ET.XMLPullParser(('end', ))
iterator = response.iterContent(g_chunk, False)
while iterator.hasMoreElements():
# FIXME: As Decode is False we obtain a sequence of bytes
parser.feed(iterator.nextElement().value)
for event, element in parser.read_events():
if element.tag != 'emailProvider':
continue
for child in element.findall('outgoingServer'):
if child.get('type') == 'smtp':
smtps.append(self._parseServer(child, map1, map2, map3))
for child in element.findall('incomingServer'):
if child.get('type') == 'imap':
imaps.append(self._parseServer(child, map1, map2, map3))
config[SMTP.value] = tuple(smtps)
config[IMAP.value] = tuple(imaps)
if user.isNew():
user.enableImap(len(imaps) > 0)
return config
def _parseServer(self, element, map1, map2, map3):
server = {}
server['ServerName'] = element.find('hostname').text
server['Port'] = int(element.find('port').text)
server['ConnectionType'] = map1.get(element.find('socketType').text, 1)
server['AuthenticationType'] = map2.get(element.find('authentication').text, 1)
server['LoginMode'] = map3.get(element.find('username').text, 1)
return server
# IspdbModel setter methods called by WizardPage2
def enableReplyTo(self, enabled):
self._servers.User.enableReplyTo(enabled)
return self._servers.User.ReplyToAddress
def setReplyToAddress(self, replyto):
self._servers.User.setReplyToAddress(replyto)
def enableIMAP(self, imap):
self._servers.User.enableImap(bool(imap))
return self._offline
# IspdbModel getter methods called by WizardPage3 / WizardPage4
def refreshView(self, version):
return version < self._version
def getVersion(self):
return self._version
def getConfig(self, service):
config = {}
config['First'] = self._servers.isFirst(service)
config['Last'] = self._servers.isLast(service)
config['Page'] = self._servers.getServerPage(service)
config['Default'] = self._servers.isDefaultPage(service)
config.update(self._servers.getCurrentServer(service))
config['UserName'] = self._getUserName(service)
config['Password'] = self._getPassword(service)
return config
def isConnectionValid(self, host, port):
return self._isHostValid(host) and self._isPortValid(port)
def isStringValid(self, value):
# FIXME: validators 0.22.0 seem to be buggy, as workaround we need to set max_val
# FIXME: see: https://github.com/python-validators/validators/issues/323)
max_val = max(1, len(value))
if validators.length(value, min_val=1, max_val=max_val):
return True
return False
def previousServerPage(self, service, server):
self._servers.updateCurrentServer(service, server)
self._servers.decrementIndex(service)
def nextServerPage(self, service, server):
self._servers.updateCurrentServer(service, server)
self._servers.incrementIndex(service)
def updateConfiguration(self, service, server, user):
self._servers.updateCurrentServer(service, server)
self._servers.User.updateConfig(service, user)
def saveConfiguration(self):
self._servers.User.saveConfig()
def getSecurity(self, i, j):
level = self._levels.get(i).get(j)
message = self.getSecurityMessage(level)
return message, level
# IspdbModel getter methods called by WizardPage5
def addLogListener(self, listener):
self._logger.addModifyListener(listener)
self._listener = listener
def getLogContent(self):
return self._logger.getLogContent(True)
def connectServers(self, *args):
Thread(target=self._connectServers, args=args).start()
def _connectServers(self, reset, progress, setlabel, setstep):
handler = RollerHandler(self._ctx, self._logger.Name)
level = self._getLogLevel(handler)
i = 0
connect = True
range = 100
count = 2 if self._servers.User.useIMAP() else 1
reset(count * range)
for service in self._services:
if service == SMTP.value or self._servers.User.useIMAP():
setlabel(service, self._getHost(service), self._getPort(service))
context = self._servers.User.getConnectionContext(service)
authenticator = self._servers.User.getAuthenticator(service)
if not self._connectServer(context, authenticator, service, i * range, progress):
connect = False
break
i += 1
self._setLogLevel(handler, level)
setstep(4 if connect else 2)
def _connectServer(self, context, authenticator, service, i, progress):
connect = False
progress(i + 25)
server = getMailService(self._ctx, service)
progress(i + 50)
try:
server.connect(context, authenticator)
except UnoException as e:
progress(i + 100)
else:
progress(i + 75)
if server.isConnected():
server.disconnect()
connect = True
progress(i + 100)
else:
progress(i + 100)
return connect
def _getHost(self, service):
return self._servers.getServerHost(service)
def _getPort(self, service):
return self._servers.getServerPort(service)
def sendMessage(self, *args):
Thread(target=self._sendMessage, args=args).start()
def _sendMessage(self, recipient, subject, message, reset, progress, setstep):
handler = RollerHandler(self._ctx, self._logger.Name)
level = self._getLogLevel(handler)
transferable = Transferable(self._ctx, self._logger)
if self._servers.User.useIMAP():
i = 100
reset(200)
threadid = self._uploadMessage(transferable, subject, progress)
else:
i = 0
reset(100)
threadid = None
progress(i + 5)
smtp = SMTP.value
context = self._servers.User.getConnectionContext(smtp)
authenticator = self._servers.User.getAuthenticator(smtp)
step = 3
progress(i + 25)
server = getMailService(self._ctx, smtp)
progress(i + 50)
try:
server.connect(context, authenticator)
except UnoException as e:
print("IspdbModel._sendMessage() 1 Error: %s" % e.Message)
else:
progress(i + 75)
if server.isConnected():
#body = MailTransferable(self._ctx, message, False)
body = transferable.getByString(message)
mail = getMailMessage(self._ctx, self.Sender, recipient, subject, body)
interface = 'com.sun.star.mail.XMailMessage2'
if hasInterface(mail, interface) and threadid is not None:
mail.ThreadId = threadid
print("IspdbModel._sendMessage() 2 ******************")
print("IspdbModel._sendMessage() 3: %s - %s" % (type(mail), mail))
try:
server.sendMailMessage(mail)
print("IspdbModel._sendMessage() 4: %s" % mail.MessageId)
except UnoException as e:
print("IspdbModel._sendMessage() 5 Error: %s - %s" % (e.Message, traceback.format_exc()))
else:
step = 5
server.disconnect()
progress(i + 100)
self._setLogLevel(handler, level)
setstep(step)
def _uploadMessage(self, transferable, subject, progress):
mail = msgid = None
imap = IMAP.value
context = self._servers.User.getConnectionContext(imap)
authenticator = self._servers.User.getAuthenticator(imap)
progress(10)
server = getMailService(self._ctx, imap)
progress(20)
try:
server.connect(context, authenticator)
except UnoException as e:
print("IspdbModel._uploadMessage() 1 Error: %s" % e.Message)
else:
progress(40)
if server.isConnected():
try:
folder = server.getSentFolder()
if server.hasFolder(folder):
message = self._getThreadMessage()
#body = MailTransferable(self._ctx, message, True)
body = transferable.getByString(message)
mail = getMailMessage(self._ctx, self.Sender, self.Email, subject, body)
progress(60)
server.uploadMessage(folder, mail)
except UnoException as e:
print("IspdbModel._uploadMessage() 2 Error: %s - %s" % (e.Message, traceback.format_exc()))
else:
interface = 'com.sun.star.mail.XMailMessage2'
if mail is not None and hasInterface(mail, interface):
msgid = mail.MessageId
print("IspdbModel._uploadMessage() 3 *****************")
progress(80)
server.disconnect()
progress(100)
print("IspdbModel._uploadMessage() 4 MessageId: %s" % msgid)
return msgid
def _getLogLevel(self, handler):
self._logger.addRollerHandler(handler)
level = self._logger.Level
self._logger.Level = ALL
return level
def _setLogLevel(self, handler, level):
self._logger.removeRollerHandler(handler)
self._logger.Level = level
# IspdbModel getter methods called by SendDialog
def validSend(self, recipient, subject, message):
enabled = all((self.isEmailValid(recipient),
self.isStringValid(subject),
self.isStringValid(message)))
return enabled
# IspdbModel private getter methods called by WizardPage3 / WizardPage4
def _getUserName(self, service):
if self._servers.User.isNew():
username = self._getUserNameFromEmail(service)
else:
username = self._servers.User.getUserName(service)
return username
def _getUserNameFromEmail(self, service):
mode = self._servers.getLoginMode(service)
return self.Email.partition('@')[mode] if mode != 1 else self.Email
def _getPassword(self, service):
return self._servers.User.getPassword(service)
def _isHostValid(self, host):
if validators.domain(host):
return True
return False
def _isPortValid(self, port):
if validators.between(port, min_val=1, max_val=1023):
return True
return False
# IspdbModel private getter methods called by WizardPage5
def _getThreadMessage(self):
title = self._getThreadTitle()
path = '%s/%s' % (g_extension, g_logo)
url = getResourceLocation(self._ctx, g_identifier, path)
logo = getMessageImage(self._ctx, url)
return '''\
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<img alt="%s Logo" src="data:image/png;charset=utf-8;base64,%s" src="%s" />
<h3 style="display:inline;" > %s</h3>
</body>
</html>
''' % (g_extension, logo, g_logourl, title)
# IspdbModel private shared methods
def _getServicesCount(self):
return len(self._services)
# IspdbModel StringResource methods
def getPageStep(self, pageid):
resource = self._resources.get('Step') % pageid
return self._resolver.resolveString(resource)
def getPageTitle(self, pageid):
resource = self._resources.get('Title') % (pageid, self._offline)
return self._resolver.resolveString(resource)
def getPageLabel(self, pageid, *format):
resource = self._resources.get('PageLabel') % pageid
return self._resolver.resolveString(resource) % format
def getPagesLabel(self, service):
resource = self._resources.get('PagesLabel')
label = self._resolver.resolveString(resource)
return label % (service, self.Email)
def getProgressMessage(self, value):
resource = self._resources.get('Progress') % value
return self._resolver.resolveString(resource)
def getSecurityMessage(self, level):
resource = self._resources.get('Security') % level
return self._resolver.resolveString(resource)
def getSendTitle(self):
resource = self._resources.get('SendTitle')
title = self._resolver.resolveString(resource)
return title % self.Email
def getSendSubject(self):
resource = self._resources.get('SendSubject')
return self._resolver.resolveString(resource)
def getSendMessage(self):
resource = self._resources.get('SendMessage')
return self._resolver.resolveString(resource)
def _getThreadTitle(self):
resource = self._resources.get('ThreadTitle')
return self._resolver.resolveString(resource) % g_extension