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
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
|
# Copyright (C) 2011-2012 Patrick Totzke <patricktotzke@gmail.com>
# Copyright © 2018 Dylan Baker
# This file is released under the GNU GPL, version 3 or a later revision.
# For further details see the COPYING file
import argparse
import datetime
import email
import email.policy
import glob
import logging
import os
import re
import tempfile
import textwrap
import traceback
from . import Command, registerCommand
from . import globals
from . import utils
from .. import buffers
from .. import commands
from .. import crypto
from ..account import SendingMailFailed, StoreMailError
from ..db.errors import DatabaseError
from ..errors import GPGProblem
from ..settings.const import settings
from ..settings.errors import NoMatchingAccount
from ..utils import argparse as cargparse
from ..utils.collections import OrderedSet
MODE = 'envelope'
@registerCommand(
MODE, 'attach',
arguments=[(['path'], {'help': 'file(s) to attach (accepts wildcads)'})])
class AttachCommand(Command):
"""attach files to the mail"""
repeatable = True
def __init__(self, path, **kwargs):
"""
:param path: files to attach (globable string)
:type path: str
"""
super().__init__(**kwargs)
self.path = path
def apply(self, ui):
envelope = ui.current_buffer.envelope
files = [g for g in glob.glob(os.path.expanduser(self.path))
if os.path.isfile(g)]
if not files:
ui.notify('no matches, abort')
return
logging.info("attaching: %s", files)
for path in files:
envelope.attach(path)
ui.current_buffer.rebuild()
@registerCommand(MODE, 'unattach', arguments=[
(['hint'], {'nargs': '?', 'help': 'which attached file to remove'}),
])
class UnattachCommand(Command):
"""remove attachments from current envelope"""
repeatable = True
def __init__(self, hint=None, **kwargs):
"""
:param hint: which attached file to remove
:type hint: str
"""
super().__init__(**kwargs)
self.hint = hint
def apply(self, ui):
envelope = ui.current_buffer.envelope
if self.hint is not None:
for a in envelope.attachments:
if self.hint in a.get_filename():
envelope.attachments.remove(a)
else:
envelope.attachments = []
ui.current_buffer.rebuild()
@registerCommand(MODE, 'refine', arguments=[
(['key'], {'help': 'header to refine'})])
class RefineCommand(Command):
"""prompt to change the value of a header"""
def __init__(self, key='', **kwargs):
"""
:param key: key of the header to change
:type key: str
"""
super().__init__(**kwargs)
self.key = key
async def apply(self, ui):
value = ui.current_buffer.envelope.get(self.key, '')
cmdstring = 'set %s %s' % (self.key, value)
await ui.apply_command(globals.PromptCommand(cmdstring))
@registerCommand(MODE, 'save')
class SaveCommand(Command):
"""save draft"""
async def apply(self, ui):
envelope = ui.current_buffer.envelope
# determine account to use
if envelope.account is None:
try:
envelope.account = settings.account_matching_address(
envelope['From'], return_default=True)
except NoMatchingAccount:
ui.notify('no accounts set.', priority='error')
return
account = envelope.account
if account.draft_box is None:
msg = 'abort: Account for {} has no draft_box'
ui.notify(msg.format(account.address), priority='error')
return
mail = envelope.construct_mail()
# store mail locally
path = account.store_draft_mail(
mail.as_string(policy=email.policy.SMTP))
msg = 'draft saved successfully'
# add mail to index if maildir path available
if path is not None:
ui.notify(msg + ' to %s' % path)
logging.debug('adding new mail to index')
try:
await ui.dbman.msg_add(path, account.draft_tags | envelope.tags)
await ui.apply_command(commands.globals.BufferCloseCommand())
except DatabaseError as e:
logging.error(str(e))
ui.notify('could not index message:\n%s' % str(e),
priority='error',
block=True)
else:
await ui.apply_command(commands.globals.BufferCloseCommand())
@registerCommand(MODE, 'send')
class SendCommand(Command):
"""send mail"""
def __init__(self, mail = None):
"""
:param mail: email to send
:type email: email.message.Message
"""
super().__init__()
self.mail = mail
def _get_keys_addresses(self, envelope):
addresses = set()
for key in envelope.encrypt_keys.values():
for uid in key.uids:
addresses.add(uid.email)
return addresses
def _get_recipients_addresses(self, envelope):
tos = envelope.headers.get('To', [])
ccs = envelope.headers.get('Cc', [])
return {a for (_, a) in email.utils.getaddresses(tos + ccs)}
def _is_encrypted_to_all_recipients(self, envelope):
recipients_addresses = self._get_recipients_addresses(envelope)
keys_addresses = self._get_keys_addresses(envelope)
return recipients_addresses.issubset(keys_addresses)
async def apply(self, ui):
envelope = None
envelope_buffer = None
if self.mail is None:
# needed to close later
envelope_buffer = ui.current_buffer
envelope = envelope_buffer.envelope
# This is to warn the user before re-sending
# an already sent message in case the envelope buffer
# was not closed because it was the last remaining buffer.
if envelope.sent_time:
mod = envelope.modified_since_sent
when = envelope.sent_time
warning = 'A modified version of ' * mod
warning += 'this message has been sent at %s.' % when
warning += ' Do you want to resend?'
if (await ui.choice(warning, cancel='no',
msg_position='left')) == 'no':
return
# don't do anything if another SendCommand is in the middle of
# sending the message and we were triggered accidentally
if envelope.sending:
logging.debug('sending this message already!')
return
# Before attempting to construct mail, ensure that we're not trying
# to encrypt a message with a BCC, since any BCC recipients will
# receive a message that they cannot read!
if envelope.headers.get('Bcc') and envelope.encrypt:
warning = textwrap.dedent("""\
Any BCC recipients will not be able to decrypt this
message. Do you want to send anyway?""").replace('\n', ' ')
if (await ui.choice(warning, cancel='no',
msg_position='left')) == 'no':
return
# Check if an encrypted message is indeed encrypted to all its
# recipients.
if (envelope.encrypt
and not self._is_encrypted_to_all_recipients(envelope)):
warning = textwrap.dedent("""\
Message is not encrypted to all recipients. This means that
not everyone will be able to decode and read this message.
Do you want to send anyway?""").replace('\n', ' ')
if (await ui.choice(warning, cancel='no',
msg_position='left')) == 'no':
return
clearme = ui.notify('constructing mail (GPG, attachments)…',
timeout=-1)
try:
self.mail = envelope.construct_mail()
self.mail = self.mail.as_string(policy=email.policy.SMTP)
except GPGProblem as e:
ui.clear_notify(clearme)
ui.notify(str(e), priority='error')
return
ui.clear_notify(clearme)
# determine account to use for sending
msg = self.mail
if not isinstance(msg, email.message.Message):
msg = email.message_from_string(
self.mail, policy=email.policy.SMTP)
address = msg.get('Resent-From', False) or msg.get('From', '')
logging.debug("FROM: \"%s\"" % address)
try:
account = settings.account_matching_address(address,
return_default=True)
except NoMatchingAccount:
ui.notify('no accounts set', priority='error')
return
logging.debug("ACCOUNT: \"%s\"" % account.address)
# send out
clearme = ui.notify('sending..', timeout=-1)
if envelope is not None:
envelope.sending = True
# FIXME XXX horrible hack, fix the type fuckery
to_send = self.mail
if isinstance(to_send, str):
to_send = to_send.encode('ascii')
else:
to_send = to_send.as_bytes()
try:
await account.send_mail(to_send)
except SendingMailFailed as e:
if envelope is not None:
envelope.account = account
envelope.sending = False
ui.clear_notify(clearme)
logging.error(traceback.format_exc())
errmsg = 'failed to send: {}'.format(e)
ui.notify(errmsg, priority='error', block=True)
except StoreMailError as e:
ui.clear_notify(clearme)
logging.error(traceback.format_exc())
errmsg = 'could not store mail: {}'.format(e)
ui.notify(errmsg, priority='error', block=True)
else:
initial_tags = frozenset()
if envelope is not None:
envelope.sending = False
envelope.sent_time = datetime.datetime.now()
initial_tags = envelope.tags
logging.debug('mail sent successfully')
ui.clear_notify(clearme)
if envelope_buffer is not None:
cmd = commands.globals.BufferCloseCommand(envelope_buffer)
await ui.apply_command(cmd)
ui.notify('mail sent successfully')
if envelope is not None:
if envelope.replied:
await envelope.replied.tags_add(account.replied_tags)
if envelope.passed:
await envelope.passed.tags_add(account.passed_tags)
# store mail locally
# This can raise StoreMailError
path = account.store_sent_mail(self.mail)
# add mail to index if maildir path available
if path is not None:
logging.debug('adding new mail to index')
await ui.dbman.msg_add(path, account.sent_tags | initial_tags)
@registerCommand(MODE, 'edit', arguments=[
(['--spawn'], {'action': cargparse.BooleanAction, 'default': None,
'help': 'spawn editor in new terminal'}),
(['--refocus'], {'action': cargparse.BooleanAction, 'default': True,
'help': 'refocus envelope after editing'})])
class EditCommand(Command):
"""edit mail"""
def __init__(self, envelope=None, spawn=None, refocus=True, **kwargs):
"""
:param envelope: email to edit
:type envelope: :class:`~alot.db.envelope.Envelope`
:param spawn: force spawning of editor in a new terminal
:type spawn: bool
:param refocus: m
"""
self.envelope = envelope
self.openNew = (envelope is not None)
self.force_spawn = spawn
self.refocus = refocus
self.edit_only_body = False
super().__init__(**kwargs)
async def apply(self, ui):
ebuffer = ui.current_buffer
if not self.envelope:
self.envelope = ui.current_buffer.envelope
# determine editable headers
edit_headers = OrderedSet(settings.get('edit_headers_whitelist'))
if '*' in edit_headers:
edit_headers = OrderedSet(self.envelope.headers)
blacklist = set(settings.get('edit_headers_blacklist'))
if '*' in blacklist:
blacklist = set(self.envelope.headers)
edit_headers = edit_headers - blacklist
logging.info('editable headers: %s', edit_headers)
def openEnvelopeFromTmpfile():
# This parses the input from the tempfile.
# we do this ourselves here because we want to be able to
# just type utf-8 encoded stuff into the tempfile and let alot
# worry about encodings.
# get input
# tempfile will be removed on buffer cleanup
enc = settings.get('editor_writes_encoding')
with open(self.envelope.tmpfile.name, 'rb') as f:
template = f.read().decode(enc)
# call post-edit translate hook
translate = settings.get_hook('post_edit_translate')
if translate:
template = translate(template, ui=ui, dbm=ui.dbman)
self.envelope.parse_template(template,
only_body=self.edit_only_body)
if self.openNew:
ui.buffer_open(buffers.EnvelopeBuffer(self.envelope))
else:
ebuffer.envelope = self.envelope
ebuffer.rebuild()
# decode header
headertext = ''
for key in edit_headers:
vlist = self.envelope.get_all(key)
if not vlist:
# ensure editable headers are present in template
vlist = ['']
else:
# remove to be edited lines from envelope
del self.envelope[key]
for value in vlist:
# newlines (with surrounding spaces) by spaces in values
value = value.strip()
value = re.sub('[ \t\r\f\v]*\n[ \t\r\f\v]*', ' ', value)
headertext += '%s: %s\n' % (key, value)
# determine editable content
bodytext = self.envelope.body
if headertext:
content = '%s\n%s' % (headertext, bodytext)
self.edit_only_body = False
else:
content = bodytext
self.edit_only_body = True
# call pre-edit translate hook
translate = settings.get_hook('pre_edit_translate')
if translate:
content = translate(content, ui=ui, dbm=ui.dbman)
# write stuff to tempfile
old_tmpfile = None
if self.envelope.tmpfile:
old_tmpfile = self.envelope.tmpfile
with tempfile.NamedTemporaryFile(
delete=False, prefix='alot.', suffix='.eml') as tmpfile:
tmpfile.write(content.encode('utf-8'))
tmpfile.flush()
self.envelope.tmpfile = tmpfile
if old_tmpfile:
os.unlink(old_tmpfile.name)
cmd = globals.EditCommand(self.envelope.tmpfile.name,
on_success=openEnvelopeFromTmpfile,
spawn=self.force_spawn,
thread=self.force_spawn,
refocus=self.refocus)
await ui.apply_command(cmd)
@registerCommand(MODE, 'set', arguments=[
(['--append'], {'action': 'store_true', 'help': 'keep previous values'}),
(['key'], {'help': 'header to refine'}),
(['value'], {'nargs': '+', 'help': 'value'})])
class SetCommand(Command):
"""set header value"""
def __init__(self, key, value, append=False, **kwargs):
"""
:param key: key of the header to change
:type key: str
:param value: new value
:type value: str
"""
self.key = key
self.value = ' '.join(value)
self.reset = not append
super().__init__(**kwargs)
async def apply(self, ui):
envelope = ui.current_buffer.envelope
if self.reset:
if self.key in envelope:
del envelope[self.key]
envelope.add(self.key, self.value)
# FIXME: handle BCC as well
# Currently we don't handle bcc because it creates a side channel leak,
# as the key of the person BCC'd will be available to other recievers,
# defeating the purpose of BCCing them
if self.key.lower() in ['to', 'from', 'cc'] and envelope.encrypt:
await utils.update_keys(ui, envelope)
ui.current_buffer.rebuild()
@registerCommand(MODE, 'unset', arguments=[
(['key'], {'help': 'header to refine'})])
class UnsetCommand(Command):
"""remove header field"""
def __init__(self, key, **kwargs):
"""
:param key: key of the header to remove
:type key: str
"""
self.key = key
super().__init__(**kwargs)
async def apply(self, ui):
del ui.current_buffer.envelope[self.key]
# FIXME: handle BCC as well
# Currently we don't handle bcc because it creates a side channel leak,
# as the key of the person BCC'd will be available to other recievers,
# defeating the purpose of BCCing them
if self.key.lower() in ['to', 'from', 'cc']:
await utils.update_keys(ui, ui.current_buffer.envelope)
ui.current_buffer.rebuild()
@registerCommand(MODE, 'toggleheaders')
class ToggleHeaderCommand(Command):
"""toggle display of all headers"""
repeatable = True
def apply(self, ui):
ui.current_buffer.toggle_all_headers()
@registerCommand(
MODE, 'sign', forced={'action': 'sign'},
arguments=[
(['keyid'],
{'nargs': argparse.REMAINDER, 'help': 'which key id to use'})],
help='mark mail to be signed before sending')
@registerCommand(MODE, 'unsign', forced={'action': 'unsign'},
help='mark mail not to be signed before sending')
@registerCommand(
MODE, 'togglesign', forced={'action': 'toggle'}, arguments=[
(['keyid'],
{'nargs': argparse.REMAINDER, 'help': 'which key id to use'})],
help='toggle sign status')
class SignCommand(Command):
"""toggle signing this email"""
repeatable = True
def __init__(self, action=None, keyid=None, **kwargs):
"""
:param action: whether to sign/unsign/toggle
:type action: str
:param keyid: which key id to use
:type keyid: str
"""
self.action = action
self.keyid = keyid
super().__init__(**kwargs)
def apply(self, ui):
sign = None
envelope = ui.current_buffer.envelope
# sign status
if self.action == 'sign':
sign = True
elif self.action == 'unsign':
sign = False
elif self.action == 'toggle':
sign = not envelope.sign
envelope.sign = sign
if sign:
if self.keyid:
# try to find key if hint given as parameter
keyid = str(' '.join(self.keyid))
try:
envelope.sign_key = crypto.get_key(keyid, validate=True,
sign=True)
except GPGProblem as e:
envelope.sign = False
ui.notify(str(e), priority='error')
return
else:
if envelope.account is None:
try:
envelope.account = settings.account_matching_address(
envelope['From'])
except NoMatchingAccount:
envelope.sign = False
ui.notify('Unable to find a matching account',
priority='error')
return
acc = envelope.account
if not acc.gpg_key:
envelope.sign = False
msg = 'Account for {} has no gpg key'
ui.notify(msg.format(acc.address), priority='error')
return
envelope.sign_key = acc.gpg_key
else:
envelope.sign_key = None
# reload buffer
ui.current_buffer.rebuild()
@registerCommand(
MODE, 'encrypt', forced={'action': 'encrypt'}, arguments=[
(['--trusted'], {'action': 'store_true',
'help': 'only add trusted keys'}),
(['keyids'], {'nargs': argparse.REMAINDER,
'help': 'keyid of the key to encrypt with'})],
help='request encryption of message before sendout')
@registerCommand(
MODE, 'unencrypt', forced={'action': 'unencrypt'},
help='remove request to encrypt message before sending')
@registerCommand(
MODE, 'toggleencrypt', forced={'action': 'toggleencrypt'},
arguments=[
(['--trusted'], {'action': 'store_true',
'help': 'only add trusted keys'}),
(['keyids'], {'nargs': argparse.REMAINDER,
'help': 'keyid of the key to encrypt with'})],
help='toggle if message should be encrypted before sendout')
@registerCommand(
MODE, 'rmencrypt', forced={'action': 'rmencrypt'},
arguments=[
(['keyids'], {'nargs': argparse.REMAINDER,
'help': 'keyid of the key to encrypt with'})],
help='do not encrypt to given recipient key')
class EncryptCommand(Command):
def __init__(self, action=None, keyids=None, trusted=False, **kwargs):
"""
:param action: wether to encrypt/unencrypt/toggleencrypt
:type action: str
:param keyid: the id of the key to encrypt
:type keyid: str
:param trusted: wether to filter keys and only use trusted ones
:type trusted: bool
"""
self.encrypt_keys = keyids
self.action = action
self.trusted = trusted
super().__init__(**kwargs)
async def apply(self, ui):
envelope = ui.current_buffer.envelope
if self.action == 'rmencrypt':
try:
for keyid in self.encrypt_keys:
tmp_key = crypto.get_key(keyid)
del envelope.encrypt_keys[tmp_key.fpr]
except GPGProblem as e:
ui.notify(str(e), priority='error')
if not envelope.encrypt_keys:
envelope.encrypt = False
ui.current_buffer.rebuild()
return
elif self.action == 'encrypt':
encrypt = True
elif self.action == 'unencrypt':
encrypt = False
elif self.action == 'toggleencrypt':
encrypt = not envelope.encrypt
if encrypt:
if self.encrypt_keys:
for keyid in self.encrypt_keys:
tmp_key = crypto.get_key(keyid)
envelope.encrypt_keys[tmp_key.fpr] = tmp_key
else:
await utils.update_keys(ui, envelope, signed_only=self.trusted)
envelope.encrypt = encrypt
if not envelope.encrypt:
# This is an extra conditional as it can even happen if encrypt is
# True.
envelope.encrypt_keys = {}
# reload buffer
ui.current_buffer.rebuild()
@registerCommand(
MODE, 'tag', forced={'action': 'add'},
arguments=[(['tags'], {'help': 'comma separated list of tags'})],
help='add tags to message',
)
@registerCommand(
MODE, 'retag', forced={'action': 'set'},
arguments=[(['tags'], {'help': 'comma separated list of tags'})],
help='set message tags',
)
@registerCommand(
MODE, 'untag', forced={'action': 'remove'},
arguments=[(['tags'], {'help': 'comma separated list of tags'})],
help='remove tags from message',
)
@registerCommand(
MODE, 'toggletags', forced={'action': 'toggle'},
arguments=[(['tags'], {'help': 'comma separated list of tags'})],
help='flip presence of tags on message',
)
class TagCommand(Command):
"""manipulate message tags"""
repeatable = True
def __init__(self, tags='', action='add', **kwargs):
"""
:param tags: comma separated list of tagstrings to set
:type tags: str
:param action: adds tags if 'add', removes them if 'remove', adds tags
and removes all other if 'set' or toggle individually if
'toggle'
:type action: str
"""
assert isinstance(tags, str), 'tags should be a unicode string'
self.tagsstring = tags
self.action = action
super().__init__(**kwargs)
def apply(self, ui):
ebuffer = ui.current_buffer
envelope = ebuffer.envelope
tags = {t for t in self.tagsstring.split(',') if t}
old = set(envelope.tags)
if self.action == 'add':
new = old.union(tags)
elif self.action == 'remove':
new = old.difference(tags)
elif self.action == 'set':
new = tags
elif self.action == 'toggle':
new = old.symmetric_difference(tags)
envelope.tags = sorted(new)
# reload buffer
ui.current_buffer.rebuild()
|