Mercurial > p > roundup > code

annotate roundup/mailgw.py @ 6334:eeddc4e03742

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented possible use of __redirect_to for edit function.
author John Rouillard <rouilj@ieee.org>
date Wed, 10 Mar 2021 16:08:38 -0500
parents ca0915457761
children 14c9284a8bad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3831
14ec78618bd5 Allow customisation of regular expressions used in email parsing...
Richard Jones <richard@users.sourceforge.net>
parents: 3815
diff changeset
1 # -*- coding: utf-8 -*-
213
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
2 #
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
3 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
4 # This module is free software, and you may redistribute it and/or modify
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
5 # under the same terms as Python, so long as this copyright message and
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
6 # disclaimer are retained in their original form.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
7 #
214
18134bffab37 stupid typo
Richard Jones <richard@users.sourceforge.net>
parents: 213
diff changeset
8 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
213
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
9 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
10 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
11 # POSSIBILITY OF SUCH DAMAGE.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
12 #
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
13 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
14 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
15 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
16 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 202
diff changeset
17 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
406
bdc2ea127ae9 Added module docstrings to all modules.
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 391
diff changeset
18 #
bdc2ea127ae9 Added module docstrings to all modules.
Jürgen Hermann <jhermann@users.sourceforge.net>
parents: 391
diff changeset
19
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1982
diff changeset
20 """An e-mail gateway for Roundup.
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
22 Incoming messages are examined for multiple parts:
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
23 . In a multipart/mixed message or part, each subpart is extracted and
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
24 examined. The text/plain subparts are assembled to form the textual
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
25 body of the message, to be stored in the file associated with a "msg"
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
26 class node. Any parts of other types are each stored in separate files
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
27 and given "file" class nodes that are linked to the "msg" node.
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
28 . In a multipart/alternative message or part, we look for a text/plain
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
29 subpart and ignore the other parts.
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
30 . A message/rfc822 is treated similar to multipart/mixed (except for
4424
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
31 special handling of the first text part) if unpack_rfc822 is set in
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
32 the mailgw config section.
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
33
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
34 Addresses
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
35 ---------
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 All of the addresses in the To: and Cc: headers of the incoming message are
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 looked up among the user nodes, and the corresponding users are placed in
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 the "recipients" property on the new "msg" node. The address in the From:
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 header similarly determines the "author" property of the new "msg"
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 node. The default handling for addresses that don't have corresponding
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 users is to create new users with no passwords and a username equal to the
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 address. (The web interface does not permit logins for users with no
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 passwords.) If we prefer to reject mail from outside sources, we can simply
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 register an auditor on the "user" class that prevents the creation of user
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
45 nodes with no passwords.
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
47 Actions
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
48 -------
5056
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
49 The subject line of the incoming message is examined to determine
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
50 whether the message is an attempt to create a new item, discuss an
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
51 existing item, or execute some other command.
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
52
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
53 If the subject consists of one of the following (case insensitive),
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
54 the corresponding action is taken:
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
55
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
56 help
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
57 Respond with an explanation of this interface.
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
58
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
59 If the subject contains the following, the corresponding action is
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
60 taken:
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
61
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
62 -- key <OneTimeKey>
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
63 Complete an in-progress user registration.
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
64
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
65 If the email is not a command, it is either a new item or a message
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
66 associated with an existing item. A designator enclosed in square
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
67 brackets is sought as the first thing on the subject line (after
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
68 skipping any "Fwd:" or "Re:" prefixes).
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 If an item designator (class name and id number) is found there, the newly
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 created "msg" node is added to the "messages" property for that item, and
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
72 any new "file" nodes are added to the "files" property for the item.
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74 If just an item class name is found there, we attempt to create a new item
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 of that class with its "messages" property initialized to contain the new
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 "msg" node and its "files" property initialized to contain any new "file"
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
77 nodes.
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
5056
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
79 Summary
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
80 -------
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
81 The "summary" property on message nodes is taken from the first non-quoting
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
82 section in the message body. The message body is divided into sections by
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
83 blank lines. Sections where the second and all subsequent lines begin with
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
84 a ">" or "|" character are considered "quoting sections". The first line of
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
85 the first non-quoting section becomes the summary of the message.
d995ee7d49bf issue2550757: one bug raised by issue fixed. Patch created by
John Rouillard <rouilj@ieee.org>
parents: 5045
diff changeset
86
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
87 Triggers
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
88 --------
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 Both cases may trigger detectors (in the first case we are calling the
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 set() method to add the message to the item's spool; in the second case we
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91 are calling the create() method to create a new node). If an auditor raises
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 an exception, the original message is bounced back to the sender with the
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
93 explanatory message given in the exception.
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
94 """
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
95 from __future__ import print_function
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 1982
diff changeset
96 __docformat__ = 'restructuredtext'
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
98 import base64, re, os, io, functools
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
99 import time, sys, logging
4980
13f8f88ad984 Replace rfc822 imports with email package (issue2550870)
John Kristensen <john@jerrykan.com>
parents: 4781
diff changeset
100 import traceback
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
101 import email
4980
13f8f88ad984 Replace rfc822 imports with email package (issue2550870)
John Kristensen <john@jerrykan.com>
parents: 4781
diff changeset
102 import email.utils
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
103 from email.generator import Generator
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
105 from roundup.anypy.email_ import decode_header, message_from_bytes, \
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
106 message_from_binary_file
5401
4cf48ff01e04 Python 3 preparation: replace raw_input uses.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5396
diff changeset
107 from roundup.anypy.my_input import my_input
4093
1ebab2e397d0 Add some new encoding tests to mailgw:
Richard Jones <richard@users.sourceforge.net>
parents: 4092
diff changeset
108
4981
7f8f27ce1a06 Remove rfc2822.py
John Kristensen <john@jerrykan.com>
parents: 4980
diff changeset
109 from roundup import configuration, hyperdb, date, password, exceptions
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
110 from roundup.mailer import Mailer
3600
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
111 from roundup.i18n import _
4306
966592263fb8 Clean up all the places where role processing occurs.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4301
diff changeset
112 from roundup.hyperdb import iter_roles
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
113 from roundup.anypy.strings import StringIO, b2s, u2s
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
114 import roundup.anypy.random_ as random_
1383
f19dde90e473 applied unicode patch
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1359
diff changeset
115
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
116 try:
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
117 import gpg, gpg.core, gpg.constants, gpg.constants.sigsum
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
118 except ImportError:
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
119 gpg = None
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
120
6127
80915fd9ad24 Fix broken import
John Rouillard <rouilj@ieee.org>
parents: 6123
diff changeset
121 from roundup.exceptions import RoundupException
6123
c177e7128dc9 issue2551083 Replace BaseException and Exception with RoundupException
John Rouillard <rouilj@ieee.org>
parents: 6019
diff changeset
122
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 467
diff changeset
123 SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 467
diff changeset
124
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
125
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
126 class MailGWError(ValueError):
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
127 pass
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
128
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
129
221
152fedaab07c Added better error handling to mailgw.
Richard Jones <richard@users.sourceforge.net>
parents: 218
diff changeset
130 class MailUsageError(ValueError):
152fedaab07c Added better error handling to mailgw.
Richard Jones <richard@users.sourceforge.net>
parents: 218
diff changeset
131 pass
152fedaab07c Added better error handling to mailgw.
Richard Jones <richard@users.sourceforge.net>
parents: 218
diff changeset
132
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
133
6123
c177e7128dc9 issue2551083 Replace BaseException and Exception with RoundupException
John Rouillard <rouilj@ieee.org>
parents: 6019
diff changeset
134 class MailUsageHelp(RoundupException):
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
135 """ We need to send the help message to the user. """
1321
328d68db2ef8 - detect and break email loops [SF#640854]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
136 pass
328d68db2ef8 - detect and break email loops [SF#640854]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
137
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
138
6123
c177e7128dc9 issue2551083 Replace BaseException and Exception with RoundupException
John Rouillard <rouilj@ieee.org>
parents: 6019
diff changeset
139 class Unauthorized(RoundupException):
467
103f521810f7 Features added:
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 464
diff changeset
140 """ Access denied """
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
141 pass
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
142
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
143
6123
c177e7128dc9 issue2551083 Replace BaseException and Exception with RoundupException
John Rouillard <rouilj@ieee.org>
parents: 6019
diff changeset
144 class IgnoreMessage(RoundupException):
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
145 """ A general class of message that we should ignore. """
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
146 pass
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
147
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
148
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
149 class IgnoreBulk(IgnoreMessage):
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
150 """ This is email from a mailing list or from a vacation program. """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
151 pass
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
152
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
153
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
154 class IgnoreLoop(IgnoreMessage):
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
155 """ We've seen this message before... """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
156 pass
467
103f521810f7 Features added:
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 464
diff changeset
157
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
158
902
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
159 def initialiseSecurity(security):
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
160 ''' Create some Permissions and Roles on the security object
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
161
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
162 This function is directly invoked by security.Security.__init__()
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
163 as a part of the Security object instantiation.
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
164 '''
948
8d8db618c2c3 grant email access to admin too ;)
Richard Jones <richard@users.sourceforge.net>
parents: 928
diff changeset
165 p = security.addPermission(name="Email Access",
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
166 description="User may use the email interface")
948
8d8db618c2c3 grant email access to admin too ;)
Richard Jones <richard@users.sourceforge.net>
parents: 928
diff changeset
167 security.addPermissionToRole('Admin', p)
902
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
168
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
169
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
170 def gpgh_key_getall(key, attr):
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
171 ''' return list of given attribute for all uids in
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
172 a key
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
173 '''
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
174 for u in key.uids:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
175 yield getattr(u, attr)
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
176
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
177
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
178 def check_pgp_sigs(sigs, gpgctx, author, may_be_unsigned=False):
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
179 ''' Theoretically a PGP message can have several signatures. GPGME
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
180 returns status on all signatures in a list. Walk that list
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
181 looking for the author's signature. Note that even if incoming
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
182 signatures are not required, the processing fails if there is an
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
183 invalid signature.
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
184 '''
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
185 for sig in sigs:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
186 key = gpgctx.get_key(sig.fpr, False)
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
187 # we really only care about the signature of the user who
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
188 # submitted the email
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
189 if key and (author in gpgh_key_getall(key, 'email')):
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
190 if sig.summary & gpg.constants.sigsum.VALID:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
191 return True
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
192 else:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
193 # try to narrow down the actual problem to give a more useful
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
194 # message in our bounce
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
195 if sig.summary & gpg.constants.sigsum.KEY_MISSING:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
196 raise MailUsageError(
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
197 _("Message signed with unknown key: %s") % sig.fpr)
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
198 elif sig.summary & gpg.constants.sigsum.KEY_EXPIRED:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
199 raise MailUsageError(
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
200 _("Message signed with an expired key: %s") % sig.fpr)
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
201 elif sig.summary & gpg.constants.sigsum.KEY_REVOKED:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
202 raise MailUsageError(
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
203 _("Message signed with a revoked key: %s") % sig.fpr)
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
204 else:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
205 raise MailUsageError(
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
206 _("Invalid PGP signature detected."))
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
207
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
208 # we couldn't find a key belonging to the author of the email
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
209 if sigs:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
210 raise MailUsageError(_("Message signed with unknown key: %s") %
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
211 sig.fpr)
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
212 elif not may_be_unsigned:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
213 raise MailUsageError(_("Unsigned Message"))
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
214
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
215
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
216 class RoundupMessage(email.message.Message):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
217 def _decode_header(self, hdr):
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
218 parts = []
4505
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
219 for part, encoding in decode_header(hdr):
5764
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
220 # decode_header might return either bytes or unicode,
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
221 # see https://bugs.python.org/issue21492
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
222 # If part is bytes, try to decode it with the specified
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
223 # encoding if it's provided, otherwise try utf-8 and
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
224 # fallback on iso-8859-1 if that fails.
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
225 if isinstance(part, bytes):
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
226 if encoding:
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
227 part = part.decode(encoding)
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
228 else:
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
229 try:
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
230 part = part.decode('utf-8')
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
231 except UnicodeDecodeError:
611737bc7261 Handle the issue in _decode_header by decoding only when decode_header returns bytes.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5763
diff changeset
232 part = part.decode('iso-8859-1')
4505
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
233 # RFC 2047 specifies that between encoded parts spaces are
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
234 # swallowed while at the borders from encoded to non-encoded
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
235 # or vice-versa we must preserve a space. Multiple adjacent
4575
c426cb251bc7 Be more tolerant when parsing RFC2047 encoded mail headers.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4573
diff changeset
236 # non-encoded parts should not occur. This is now
c426cb251bc7 Be more tolerant when parsing RFC2047 encoded mail headers.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4573
diff changeset
237 # implemented in our patched decode_header method in anypy
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
238 parts.append(part)
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
239
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
240 return ''.join([u2s(p) for p in parts])
4505
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
241
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
242 def flatten(self):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
243 fp = StringIO()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
244 generator = Generator(fp, mangle_from_=False)
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
245 generator.flatten(self)
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
246 return fp.getvalue()
4093
1ebab2e397d0 Add some new encoding tests to mailgw:
Richard Jones <richard@users.sourceforge.net>
parents: 4092
diff changeset
247
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
248 def get_header(self, header, default=None):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
249 value = self.get(header, default)
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
250
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
251 if value:
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
252 return self._decode_header(value.replace('\n', ''))
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
253
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
254 return value
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
255
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
256 def get_address_list(self, header):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
257 addresses = []
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
258
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
259 for name, addr in email.utils.getaddresses(self.get_all(header, [])):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
260 addresses.append((self._decode_header(name), addr))
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
261
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
262 return addresses
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
263
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
264 def get_body(self):
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
265 """Get the decoded message body."""
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
266 content = self.get_payload(decode=True)
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
267
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
268 if content is not None:
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
269 charset = self.get_content_charset()
5547
081be318661b Do not transcode binary email attachments (issue2551004).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5542
diff changeset
270 if charset or self.get_content_maintype() == 'text':
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
271 content = u2s(content.decode(
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
272 charset or 'iso8859-1', 'replace'))
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
273
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
274 return content
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
275
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
276 # General multipart handling:
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
277 # Take the first text/plain part, anything else is considered an
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
278 # attachment.
2364
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
279 # multipart/mixed:
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
280 # Multiple "unrelated" parts.
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
281 # multipart/Alternative (rfc 1521):
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
282 # Like multipart/mixed, except that we'd only want one of the
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
283 # alternatives. Generally a top-level part from MUAs sending HTML
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
284 # mail - there will be a text/plain version.
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
285 # multipart/signed (rfc 1847):
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
286 # The control information is carried in the second of the two
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
287 # required body parts.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
288 # ACTION: Default, so if content is text/plain we get it.
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
289 # multipart/encrypted (rfc 1847):
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
290 # The control information is carried in the first of the two
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
291 # required body parts.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
292 # ACTION: Not handleable as the content is encrypted.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
293 # multipart/related (rfc 1872, 2112, 2387):
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
294 # The Multipart/Related content-type addresses the MIME
2364
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
295 # representation of compound objects, usually HTML mail with embedded
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
296 # images. Usually appears as an alternative.
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
297 # ACTION: Default, if we must.
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
298 # multipart/report (rfc 1892):
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
299 # e.g. mail system delivery status reports.
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
300 # ACTION: Default. Could be ignored or used for Delivery Notification
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
301 # flagging.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
302 # multipart/form-data:
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
303 # For web forms only.
4424
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
304 # message/rfc822:
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
305 # Only if configured in [mailgw] unpack_rfc822
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
306 def extract_content(self, parent_type=None, ignore_alternatives=False,
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
307 unpack_rfc822=False, html2text=None):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
308 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
309 Extract the body and the attachments recursively.
3976
7dc74da6c3e8 Fix mailgw total failure bounce message generation (thanks Bradley Dean)
Richard Jones <richard@users.sourceforge.net>
parents: 3964
diff changeset
310
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
311 If the content is hidden inside a multipart/alternative part, we use
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
312 the *last* text/plain part of the *first* multipart/alternative in
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
313 the whole message.
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
314
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
315 If ignore_alteratives is True then only the alternative parts in the
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
316 same multipart/alternative part as where the content is found are
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
317 ignored.
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
318 """
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
319 content_type = self.get_content_type()
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
320 content = None
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
321 attachments = []
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
322 html_part = False
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
323
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
324 if content_type == 'text/plain':
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
325 content = self.get_body()
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
326 elif content_type == 'text/html' and html2text:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
327 # if user allows html conversion run this.
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
328 content = html2text(self.get_body())
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
329 attachments.append(self.as_attachment())
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
330 html_part = True
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
331 elif content_type == 'message/rfc822' and not unpack_rfc822:
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
332 attachments.append(self.as_attachment())
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
333 elif self.is_multipart():
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
334 content_found = False
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
335 ig = ignore_alternatives
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
336 html_part_found = False
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
337 for part in self.get_payload():
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
338 new_content, new_attach, html_part = part.extract_content(
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
339 content_type, not content and ig, unpack_rfc822,
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
340 html2text)
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
341
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
342 # If we haven't found a text/plain part yet, take this one,
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
343 # otherwise make it an attachment.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
344 if not content:
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
345 content = new_content
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
346 cpart = part
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
347 if html_part:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
348 html_part_found = True
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
349 elif new_content:
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
350 if html_part:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
351 # attachment should be added elsewhere.
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
352 pass
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
353 elif content_found or content_type != \
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
354 'multipart/alternative':
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
355 attachments.append(part.text_as_attachment())
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
356 elif html_part_found:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
357 # text/plain part found after html
5306
91354bf0b683 Codecov showed text/html followed by text/plain not tested. Fixed bug
John Rouillard <rouilj@ieee.org>
parents: 5305
diff changeset
358 # text/html already stored as attachment,
91354bf0b683 Codecov showed text/html followed by text/plain not tested. Fixed bug
John Rouillard <rouilj@ieee.org>
parents: 5305
diff changeset
359 # so just use the text as the content.
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
360 content = new_content
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
361 cpart = part
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
362 else:
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
363 # if we have found a text/plain in the current
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
364 # multipart/alternative and find another one, we
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
365 # use the first as an attachment (if configured)
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
366 # and use the second one because rfc 2046, sec.
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
367 # 5.1.4. specifies that later parts are better
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
368 # (thanks to Philipp Gortan for pointing this
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
369 # out)
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
370 attachments.append(cpart.text_as_attachment())
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
371 content = new_content
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
372 cpart = part
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
373
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
374 attachments.extend(new_attach)
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
375 if ig and content_type == 'multipart/alternative' and content:
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
376 attachments = []
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
377 html_part = False
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
378 elif (parent_type == 'multipart/signed' and
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
379 content_type == 'application/pgp-signature'):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
380 # Don't save signatures for signed messages as attachments
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
381 pass
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
382 else:
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
383 attachments.append(self.as_attachment())
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
384
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
385 return content, attachments, html_part
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
386
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
387 def text_as_attachment(self):
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
388 """Return first text/plain part as Message"""
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
389 if not self.is_multipart():
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
390 return self.as_attachment()
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
391 for part in self.get_payload():
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
392 if part.is_multipart():
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
393 p = part.text_as_attachment()
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
394 if p:
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
395 return p
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
396 elif part.get_content_type() == 'text/plain':
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
397 return part.as_attachment()
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
398 return None
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
399
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
400 def as_attachment(self):
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
401 """Return this message as an attachment."""
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
402 filename = self.get_filename()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
403 content_type = self.get_content_type()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
404 content = self.get_body()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
405
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
406 if content is None and self.get_content_type() == 'message/rfc822':
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
407 # handle message/rfc822 specially - the name should be
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
408 # the subject of the actual e-mail embedded here
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
409 # we add a '.eml' extension like other email software does it
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
410 subject = self.get_payload(0).get('subject')
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
411 if subject:
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
412 filename = '{0}.eml'.format(subject)
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
413
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
414 content = self.get_payload(0).flatten()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
415
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
416 return (filename, content_type, content)
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
417
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
418 def pgp_signed(self):
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
419 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
420 RFC 3156 requires OpenPGP MIME mail to have the protocol parameter
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
421 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
422 return (self.get_content_type() == 'multipart/signed' and
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
423 self.get_param('protocol') == 'application/pgp-signature')
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
424
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
425 def pgp_encrypted(self):
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
426 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
427 RFC 3156 requires OpenPGP MIME mail to have the protocol parameter
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
428 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
429 return (self.get_content_type() == 'multipart/encrypted' and
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
430 self.get_param('protocol') == 'application/pgp-encrypted')
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
431
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
432 def decrypt(self, author, may_be_unsigned=False):
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
433 '''
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
434 Decrypt an OpenPGP MIME message
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
435
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
436 This message must be signed as well as encrypted using the "combined"
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
437 method if incoming signatures are configured. The decrypted contents
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
438 are returned as a new message.
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
439 '''
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
440 (hdr, msg) = self.get_payload()
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
441 # According to the RFC 3156 encrypted mail must have exactly two parts.
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
442 # The first part contains the control information. Let's verify that
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
443 # the message meets the RFC before we try to decrypt it.
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
444 if (hdr.get_payload().strip() != 'Version: 1' or
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
445 hdr.get_content_type() != 'application/pgp-encrypted'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
446 raise MailUsageError(_("Unknown multipart/encrypted version."))
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
447
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
448 context = gpg.core.Context()
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
449 ciphertext = gpg.core.Data(msg.get_payload())
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
450 plaintext = gpg.core.Data()
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
451
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
452 result = context.op_decrypt_verify(ciphertext, plaintext)
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
453
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
454 if result:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
455 raise MailUsageError(_("Unable to decrypt your message."))
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
456
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
457 # we've decrypted it but that just means they used our public
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
458 # key to send it to us. now check the signatures to see if it
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
459 # was signed by someone we trust
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
460 result = context.op_verify_result()
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
461 check_pgp_sigs(result.signatures, context, author,
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
462 may_be_unsigned=may_be_unsigned)
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
463
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
464 plaintext.seek(0, 0)
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
465 # gpg.core.Data implements a seek method with a different signature
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
466 # than roundup can handle. So we'll put the data in a container that
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
467 # the Message class can work with.
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
468 return message_from_bytes(plaintext.read(), RoundupMessage)
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
469
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
470 def verify_signature(self, author):
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
471 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
472 Verify the signature of an OpenPGP MIME message
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
473
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
474 This only handles detached signatures. Old style PGP mail (i.e.
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
475 '-----BEGIN PGP SIGNED MESSAGE----') is archaic and not supported :)
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
476 """
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
477 # we don't check the micalg parameter...gpgme seems to
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
478 # figure things out on its own
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
479 (msg, sig) = self.get_payload()
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
480
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
481 if sig.get_content_type() != 'application/pgp-signature':
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
482 raise MailUsageError(_("No PGP signature found in message."))
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
483
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
484 # according to rfc 3156 the data "MUST first be converted
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
485 # to its content-type specific canonical form. For
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
486 # text/plain this means conversion to an appropriate
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
487 # character set and conversion of line endings to the
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
488 # canonical <CR><LF> sequence."
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
489 # TODO: what about character set conversion?
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
490 canonical_msg = re.sub('(?<!\r)\n', '\r\n', msg.flatten())
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
491 msg_data = gpg.core.Data(canonical_msg)
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
492 sig_data = gpg.core.Data(sig.get_payload())
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
493
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
494 context = gpg.core.Context()
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
495 context.op_verify(sig_data, msg_data, None)
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
496
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
497 # check all signatures for validity
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
498 result = context.op_verify_result()
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
499 check_pgp_sigs(result.signatures, context, author)
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
500
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
501
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
502 class parsedMessage:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
503
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
504 def __init__(self, mailgw, message):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
505 self.mailgw = mailgw
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
506 self.config = mailgw.instance.config
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
507 self.db = mailgw.db
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
508 self.message = message
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
509 self.subject = message.get_header('subject', '')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
510 self.has_prefix = False
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
511 self.matches = dict.fromkeys(['refwd', 'quote', 'classname',
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
512 'nodeid', 'title', 'args', 'argswhole'])
5045
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4981
diff changeset
513 self.keep_real_from = self.config['EMAIL_KEEP_REAL_FROM']
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4981
diff changeset
514 if self.keep_real_from:
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
515 self.from_list = message.get_address_list('from')
5045
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4981
diff changeset
516 else:
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
517 self.from_list = (message.get_address_list('resent-from') or
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
518 message.get_address_list('from'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
519 self.pfxmode = self.config['MAILGW_SUBJECT_PREFIX_PARSING']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
520 self.sfxmode = self.config['MAILGW_SUBJECT_SUFFIX_PARSING']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
521 # these are filled in by subsequent parsing steps
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
522 self.classname = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
523 self.properties = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
524 self.cl = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
525 self.nodeid = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
526 self.author = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
527 self.recipients = None
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
528 self.msg_props = {}
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
529 self.props = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
530 self.content = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
531 self.attachments = None
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
532 self.crypt = False
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
533
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
534 def handle_ignore(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
535 ''' Check to see if message can be safely ignored:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
536 detect loops and
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
537 Precedence: Bulk, or Microsoft Outlook autoreplies
6247
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
538 Auto-Submitted not equal to no, so auto-generated,
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
539 auto-replied and auto-notified are dropped. rstrip
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
540 auto-submitted value because trailing comment/whitespace
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
541 is allowed per RFC3834. Note that we only handle whitespace.
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
542 Lowercase the value as references say No and no as possible
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
543 values.
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
544 '''
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
545 if self.message.get_header('x-roundup-loop', ''):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
546 raise IgnoreLoop
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
547 if (self.message.get_header('precedence', '') == 'bulk'
6247
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
548 or self.message.get_header('auto-submitted', 'no').rstrip().lower() \
ca0915457761 Handle auto-submitted header on inbound email like bulk.
John Rouillard <rouilj@ieee.org>
parents: 6127
diff changeset
549 != 'no'
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
550 or self.subject.lower().find("autoreply") > 0):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
551 raise IgnoreBulk
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
552
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
553 def handle_help(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
554 ''' Check to see if the message contains a usage/help request
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
555 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
556 if self.subject.strip().lower() == 'help':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
557 raise MailUsageHelp
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
558
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
559 def check_subject(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
560 ''' Check to see if the message contains a valid subject line
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
561 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
562 if not self.subject:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
563 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
564 Emails to Roundup trackers must include a Subject: line!
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
565 """))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
566
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
567 def parse_subject(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
568 ''' Matches subjects like:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
569 Re: "[issue1234] title of issue [status=resolved]"
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
570
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
571 Each part of the subject is matched, stored, then removed from the
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
572 start of the subject string as needed. The stored values are then
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
573 returned
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
574 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
575
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
576 tmpsubject = self.subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
577
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
578 sd_open, sd_close = self.config['MAILGW_SUBJECT_SUFFIX_DELIMITERS']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
579 delim_open = re.escape(sd_open)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
580 if delim_open in '[(': delim_open = '\\' + delim_open
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
581 delim_close = re.escape(sd_close)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
582 if delim_close in '[(': delim_close = '\\' + delim_close
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
583
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
584 # Look for Re: et. al. Used later on for MAILGW_SUBJECT_CONTENT_MATCH
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
585 re_re = r"(?P<refwd>%s)\s*" % self.config["MAILGW_REFWD_RE"].pattern
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
586 m = re.match(re_re, tmpsubject,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
587 re.IGNORECASE | re.VERBOSE | re.UNICODE)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
588 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
589 m = m.groupdict()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
590 if m['refwd']:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
591 self.matches.update(m)
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
592 tmpsubject = tmpsubject[len(m['refwd']):] # Consume Re:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
593
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
594 # Look for Leading "
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
595 m = re.match(r'(?P<quote>\s*")', tmpsubject,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
596 re.IGNORECASE)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
597 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
598 self.matches.update(m.groupdict())
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
599 # Consume quote
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
600 tmpsubject = tmpsubject[len(self.matches['quote']):]
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
601
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
602 # Check if the subject includes a prefix
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
603 self.has_prefix = re.search(r'^%s(\w+)%s' % (delim_open,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
604 delim_close),
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
605 tmpsubject.strip())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
606
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
607 # Match the classname if specified
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
608 class_re = r'%s(?P<classname>(%s))(?P<nodeid>\d+)?%s' % \
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
609 (delim_open, "|".join(self.db.getclasses()),
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
610 delim_close)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
611 # Note: re.search, not re.match as there might be garbage
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
612 # (mailing list prefix, etc.) before the class identifier
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
613 m = re.search(class_re, tmpsubject, re.IGNORECASE)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
614 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
615 self.matches.update(m.groupdict())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
616 # Skip to the end of the class identifier, including any
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
617 # garbage before it.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
618
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
619 tmpsubject = tmpsubject[m.end():]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
620
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
621 # Match any arguments specified *from the end*
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
622 # Optionally match and strip quote at the end that dumb mailers
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
623 # may put there, e.g.
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
624 # Re: "[issue1] bla blah [<args>]"
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
625 q = ''
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
626 if self.matches['quote']:
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
627 q = '"?'
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
628 args_re = r'(?P<argswhole>%s(?P<args>[^%s]*)%s)%s$' % (delim_open,
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
629 delim_close, delim_close, q)
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
630 m = re.search(args_re, tmpsubject.strip(), re.IGNORECASE | re.VERBOSE)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
631 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
632 self.matches.update(m.groupdict())
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
633 tmpsubject = tmpsubject[:m.start()]
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
634 else:
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
635 self.matches['argswhole'] = self.matches['args'] = None
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
636
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
637 # The title of the subject is the remaining tmpsubject.
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
638 self.matches['title'] = tmpsubject.strip()
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
639
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
640 # strip off the quotes that dumb emailers put around the subject, like
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
641 # Re: "[issue1] bla blah"
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
642 # but only if we didn't match arguments at the end (which would
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
643 # already have consumed the quote after the subject)
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
644 if self.matches['quote'] and not self.matches['argswhole'] \
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
645 and self.matches['title'].endswith('"'):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
646 self.matches['title'] = self.matches['title'][:-1]
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
647
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
648 def rego_confirm(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
649 ''' Check for registration OTK and confirm the registration if found
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
650 '''
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
651
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
652 if self.config['EMAIL_REGISTRATION_CONFIRMATION']:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
653 otk_re = re.compile('-- key (?P<otk>[a-zA-Z0-9]{32})')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
654 otk = otk_re.search(self.matches['title'] or '')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
655 if otk:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
656 self.db.confirm_registration(otk.group('otk'))
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
657 subject = 'Your registration to %s is complete' % \
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
658 self.config['TRACKER_NAME']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
659 sendto = [self.from_list[0][1]]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
660 self.mailgw.mailer.standard_message(sendto, subject, '')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
661 return 1
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
662 return 0
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
663
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
664 def get_classname(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
665 ''' Determine the classname of the node being created/edited
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
666 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
667 subject = self.subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
668
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
669 # get the classname
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
670 if self.pfxmode == 'none':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
671 classname = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
672 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
673 classname = self.matches['classname']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
674
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
675 if not classname and self.has_prefix and self.pfxmode == 'strict':
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
676 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
677 The message you sent to roundup did not contain a properly formed subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
678 line. The subject must contain a class name or designator to indicate the
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
679 'topic' of the message. For example:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
680 Subject: [issue] This is a new issue
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
681 - this will create a new issue in the tracker with the title 'This is
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
682 a new issue'.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
683 Subject: [issue1234] This is a followup to issue 1234
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
684 - this will append the message's contents to the existing issue 1234
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
685 in the tracker.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
686
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
687 Subject was: '%(subject)s'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
688 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
689
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
690 # try to get the class specified - if "loose" or "none" then fall
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
691 # back on the default
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
692 attempts = []
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
693 if classname:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
694 attempts.append(classname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
695
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
696 if self.mailgw.default_class:
4477
9be284ce56b7 Fixed bug in mailgw refactoring, patch issue2550697 (thanks Hubert Touvet)
Richard Jones <richard@users.sourceforge.net>
parents: 4469
diff changeset
697 attempts.append(self.mailgw.default_class)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
698 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
699 attempts.append(self.config['MAILGW_DEFAULT_CLASS'])
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
700
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
701 # first valid class name wins
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
702 self.cl = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
703 for trycl in attempts:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
704 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
705 self.cl = self.db.getclass(trycl)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
706 classname = self.classname = trycl
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
707 break
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
708 except KeyError:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
709 pass
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
710
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
711 if not self.cl:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
712 validname = ', '.join(self.db.getclasses())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
713 if classname:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
714 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
715 The class name you identified in the subject line ("%(classname)s") does
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
716 not exist in the database.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
717
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
718 Valid class names are: %(validname)s
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
719 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
720 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
721 else:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
722 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
723 You did not identify a class name in the subject line and there is no
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
724 default set for this tracker. The subject must contain a class name or
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
725 designator to indicate the 'topic' of the message. For example:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
726 Subject: [issue] This is a new issue
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
727 - this will create a new issue in the tracker with the title 'This is
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
728 a new issue'.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
729 Subject: [issue1234] This is a followup to issue 1234
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
730 - this will append the message's contents to the existing issue 1234
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
731 in the tracker.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
732
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
733 Subject was: '%(subject)s'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
734 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
735 # get the class properties
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
736 self.properties = self.cl.getprops()
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
737
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
738 def get_nodeid(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
739 ''' Determine the nodeid from the message and return it if found
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
740 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
741 title = self.matches['title']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
742 subject = self.subject
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
743
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
744 if self.pfxmode == 'none':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
745 nodeid = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
746 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
747 nodeid = self.matches['nodeid']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
748
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
749 # try in-reply-to to match the message if there's no nodeid
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
750 inreplyto = self.message.get_header('in-reply-to') or ''
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
751 if nodeid is None and inreplyto:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
752 l = self.db.getclass('msg').stringFind(messageid=inreplyto)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
753 if l:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
754 nodeid = self.cl.filter(None, {'messages': l})[0]
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
755
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
756 # but we do need either a title or a nodeid...
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
757 if nodeid is None and not title:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
758 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
759 I cannot match your message to a node in the database - you need to either
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
760 supply a full designator (with number, eg "[issue123]") or keep the
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
761 previous subject title intact so I can match that.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
762
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
763 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
764 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
765
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
766 # If there's no nodeid, check to see if this is a followup and
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
767 # maybe someone's responded to the initial mail that created an
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
768 # entry. Try to find the matching nodes with the same title, and
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
769 # use the _last_ one matched (since that'll _usually_ be the most
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
770 # recent...). The subject_content_match config may specify an
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
771 # additional restriction based on the matched node's creation or
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
772 # activity.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
773 tmatch_mode = self.config['MAILGW_SUBJECT_CONTENT_MATCH']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
774 if tmatch_mode != 'never' and nodeid is None and self.matches['refwd']:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
775 l = self.cl.stringFind(title=title)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
776 limit = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
777 if (tmatch_mode.startswith('creation') or
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
778 tmatch_mode.startswith('activity')):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
779 limit, interval = tmatch_mode.split(' ', 1)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
780 threshold = date.Date('.') - date.Interval(interval)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
781 for id in l:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
782 if limit:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
783 if threshold < self.cl.get(id, limit):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
784 nodeid = id
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
785 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
786 nodeid = id
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
787
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
788 # if a nodeid was specified, make sure it's valid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
789 if nodeid is not None and not self.cl.hasnode(nodeid):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
790 if self.pfxmode == 'strict':
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
791 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
792 The node specified by the designator in the subject of your message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
793 ("%(nodeid)s") does not exist.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
794
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
795 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
796 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
797 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
798 nodeid = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
799 self.nodeid = nodeid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
800
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
801 def get_author_id(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
802 ''' Attempt to get the author id from the existing registered users,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
803 otherwise attempt to register a new user and return their id
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
804 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
805 # Don't create users if anonymous isn't allowed to register
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
806 create = 1
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
807 anonid = self.db.user.lookup('anonymous')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
808 if not (self.db.security.hasPermission('Register', anonid, 'user')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
809 and self.db.security.hasPermission('Email Access', anonid)):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
810 create = 0
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
811
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
812 # ok, now figure out who the author is - create a new user if the
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
813 # "create" flag is true
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
814 author = uidFromAddress(self.db, self.from_list[0], create=create)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
815
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
816 # if we're not recognised, and we don't get added as a user, then we
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
817 # must be anonymous
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
818 if not author:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
819 author = anonid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
820
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
821 # make sure the author has permission to use the email interface
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
822 if not self.db.security.hasPermission('Email Access', author):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
823 if author == anonid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
824 # we're anonymous and we need to be a registered user
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
825 from_address = self.from_list[0][1]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
826 registration_info = ""
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
827 if self.db.security.hasPermission('Web Access', author) and \
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
828 self.db.security.hasPermission('Register', anonid, 'user'):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
829 tracker_web = self.config.TRACKER_WEB
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
830 registration_info = """ Please register at:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
831
4580
782737d1a2d7 issue2431638 wrong registration link in bounce mail.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4579
diff changeset
832 %(tracker_web)suser?@template=register
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
833
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
834 ...before sending mail to the tracker.""" % locals()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
835
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
836 raise Unauthorized(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
837 You are not a registered user.%(registration_info)s
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
838
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
839 Unknown address: %(from_address)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
840 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
841 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
842 # we're registered and we're _still_ not allowed access
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
843 raise Unauthorized(_(
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
844 'You are not permitted to access this tracker.'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
845 self.author = author
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
846
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
847 def check_permissions(self):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
848 ''' Check if the author has permission to edit or create this
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
849 class of node
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
850 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
851 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
852 if not self.db.security.hasPermission('Edit', self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
853 self.classname, itemid=self.nodeid):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
854 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
855 'You are not permitted to edit %(classname)s.'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
856 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
857 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
858 if not self.db.security.hasPermission('Create', self.author,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
859 self.classname):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
860 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
861 'You are not permitted to create %(classname)s.'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
862 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
863
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
864 def commit_and_reopen_as_author(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
865 ''' the author may have been created - make sure the change is
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
866 committed before we reopen the database
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
867 then re-open the database as the author
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
868 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
869 self.db.commit()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
870
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
871 # set the database user as the author
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
872 username = self.db.user.get(self.author, 'username')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
873 self.db.setCurrentUser(username)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
874
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
875 # re-get the class with the new database connection
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
876 self.cl = self.db.getclass(self.classname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
877
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
878 def get_recipients(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
879 ''' Get the list of recipients who were included in message and
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
880 register them as users if possible
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
881 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
882 # Don't create users if anonymous isn't allowed to register
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
883 create = 1
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
884 anonid = self.db.user.lookup('anonymous')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
885 if not (self.db.security.hasPermission('Register', anonid, 'user')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
886 and self.db.security.hasPermission('Email Access', anonid)):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
887 create = 0
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
888
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
889 # get the user class arguments from the commandline
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
890 user_props = self.mailgw.get_class_arguments('user')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
891
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
892 # now update the recipients list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
893 recipients = []
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
894 tracker_email = self.config['TRACKER_EMAIL'].lower()
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
895 msg_to = self.message.get_address_list('to')
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
896 msg_cc = self.message.get_address_list('cc')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
897 for recipient in msg_to + msg_cc:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
898 r = recipient[1].strip().lower()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
899 if r == tracker_email or not r:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
900 continue
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
901
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
902 # look up the recipient - create if necessary (and we're
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
903 # allowed to)
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
904 recipient = uidFromAddress(self.db, recipient, create,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
905 **user_props)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
906
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
907 # if all's well, add the recipient to the list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
908 if recipient:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
909 recipients.append(recipient)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
910 self.recipients = recipients
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
911
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
912 def get_props(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
913 ''' Generate all the props for the new/updated node and return them
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
914 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
915 subject = self.subject
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
916
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
917 # get the commandline arguments for issues
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
918 issue_props = self.mailgw.get_class_arguments('issue', self.classname)
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
919
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
920 #
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
921 # handle the subject argument list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
922 #
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
923 # figure what the properties of this Class are
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
924 props = {}
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
925 args = self.matches['args']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
926 argswhole = self.matches['argswhole']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
927 title = self.matches['title']
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
928
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
929 # Reform the title
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
930 if self.matches['nodeid'] and self.nodeid is None:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
931 title = subject
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
932
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
933 if args:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
934 if self.sfxmode == 'none':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
935 title += ' ' + argswhole
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
936 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
937 errors, props = setPropArrayFromString(self, self.cl, args,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
938 self.nodeid)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
939 # handle any errors parsing the argument list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
940 if errors:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
941 if self.sfxmode == 'strict':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
942 errors = '\n- '.join(map(str, errors))
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
943 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
944 There were problems handling your subject line argument list:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
945 - %(errors)s
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
946
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
947 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
948 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
949 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
950 title += ' ' + argswhole
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
951
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
952 # set the issue title to the subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
953 title = title.strip()
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
954 if (title and 'title' in self.properties and 'title'
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
955 not in issue_props):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
956 issue_props['title'] = title
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
957 if (self.nodeid and 'title' in self.properties and not
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
958 self.config['MAILGW_SUBJECT_UPDATES_TITLE']):
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
959 issue_props['title'] = self.cl.get(self.nodeid, 'title')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
960
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
961 # merge the command line props defined in issue_props into
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
962 # the props dictionary because function(**props, **issue_props)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
963 # is a syntax error.
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
964 for prop in issue_props.keys():
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
965 if prop not in props:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
966 props[prop] = issue_props[prop]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
967
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
968 self.props = props
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
969
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
970 def get_pgp_message(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
971 ''' If they've enabled PGP processing then verify the signature
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
972 or decrypt the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
973 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
974 def pgp_role():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
975 """ if PGP_ROLES is specified the user must have a Role in the list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
976 or we will skip PGP processing
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
977 """
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
978 if self.config.PGP_ROLES:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
979 return self.db.user.has_role(self.author,
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
980 *iter_roles(self.config.PGP_ROLES))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
981 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
982 return True
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
983
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
984 if self.config.PGP_ENABLE:
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
985 if pgp_role() and self.config.PGP_ENCRYPT:
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
986 self.crypt = True
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
987 assert gpg, 'gpg is not installed'
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
988 # signed/encrypted mail must come from the primary address
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
989 author_address = self.db.user.get(self.author, 'address')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
990 if self.config.PGP_HOMEDIR:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
991 os.environ['GNUPGHOME'] = self.config.PGP_HOMEDIR
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
992 if self.config.PGP_REQUIRE_INCOMING in ('encrypted', 'both') \
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
993 and pgp_role() and not self.message.pgp_encrypted():
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
994 raise MailUsageError(_(
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
995 "This tracker has been configured to require all email "
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
996 "be PGP encrypted."))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
997 if self.message.pgp_signed():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
998 self.message.verify_signature(author_address)
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
999 # signature has been verified
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1000 self.db.tx_Source = "email-sig-openpgp"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1001
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1002 elif self.message.pgp_encrypted():
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1003 # Replace message with the contents of the decrypted
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1004 # message for content extraction
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1005 # Note: the bounce-handling code now makes sure that
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1006 # either the encrypted mail received is sent back or
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1007 # that the error message is encrypted if needed.
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1008 encr_only = self.config.PGP_REQUIRE_INCOMING == 'encrypted'
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1009 encr_only = encr_only or not pgp_role()
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1010 self.crypt = True
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1011 try:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1012 # see if the message has a valid signature
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1013 message = self.message.decrypt(author_address,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1014 may_be_unsigned=False)
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1015 # only set if MailUsageError is not raised
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1016 # indicating that we have a valid signature
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1017 self.db.tx_Source = "email-sig-openpgp"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1018 except MailUsageError:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1019 # if there is no signature or an error in the message
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1020 # we get here. Try decrypting it again if we don't
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1021 # need signatures.
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1022 if encr_only:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1023 message = self.message.decrypt(author_address,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1024 may_be_unsigned=encr_only)
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1025 else:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1026 # something failed with the message decryption/sig
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1027 # chain. Pass the error up.
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1028 raise
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1029 # store the decrypted message
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1030 self.message = message
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1031 elif pgp_role():
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1032 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1033 This tracker has been configured to require all email be PGP signed or
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1034 encrypted."""))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1035
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1036 def get_content_and_attachments(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1037 ''' get the attachments and first text part from the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1038 '''
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1039 from roundup.dehtml import dehtml
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1040 html2text = dehtml(self.config['MAILGW_CONVERT_HTMLTOTEXT']).html2text
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1041
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1042 ig = self.config.MAILGW_IGNORE_ALTERNATIVES
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1043 self.message.instance = self.mailgw.instance
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1044 self.content, self.attachments, html_part = \
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1045 self.message.extract_content(
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1046 ignore_alternatives=ig,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1047 unpack_rfc822=self.config.MAILGW_UNPACK_RFC822,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1048 html2text=html2text)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1049
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1050 def create_files(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1051 ''' Create a file for each attachment in the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1052 '''
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
1053 if 'files' not in self.properties:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1054 return
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1055 files = []
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1056 file_props = self.mailgw.get_class_arguments('file')
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1057
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1058 if self.attachments:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1059 for (name, mime_type, data) in self.attachments:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1060 if not self.db.security.hasPermission('Create', self.author,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1061 'file'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1062 raise Unauthorized(_(
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1063 'You are not permitted to create files.'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1064 if not name:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1065 name = "unnamed"
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1066 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1067 fileid = self.db.file.create(type=mime_type, name=name,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1068 content=data, **file_props)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1069 except exceptions.Reject:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1070 pass
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1071 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1072 files.append(fileid)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1073 # allowed to attach the files to an existing node?
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1074 if self.nodeid and not self.db.security.hasPermission('Edit',
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1075 self.author, self.classname, 'files'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1076 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1077 'You are not permitted to add files to %(classname)s.'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1078 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1079
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
1080 self.msg_props['files'] = files
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1081 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1082 # extend the existing files list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1083 fileprop = self.cl.get(self.nodeid, 'files')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1084 fileprop.extend(files)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1085 files = fileprop
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1086
4498
8df9492c2746 Fix file-unlink bug in mailgw
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4486
diff changeset
1087 self.props['files'] = files
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1088
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1089 def create_msg(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1090 ''' Create msg containing all the relevant information from the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1091 '''
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
1092 if 'messages' not in self.properties:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1093 return
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1094 msg_props = self.mailgw.get_class_arguments('msg')
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1095 self.msg_props.update(msg_props)
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1096
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1097 # Get the message ids
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1098 inreplyto = self.message.get_header('in-reply-to') or ''
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1099 messageid = self.message.get_header('message-id')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1100 # generate a messageid if there isn't one
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1101 if not messageid:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1102 messageid = "<%s.%s.%s%s@%s>" % (time.time(),
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
1103 b2s(base64.b32encode(random_.token_bytes(10))),
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1104 self.classname, self.nodeid, self.config['MAIL_DOMAIN'])
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1105
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1106 if self.content is None:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1107 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1108 Roundup requires the submission to be plain text. The message parser could
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1109 not find a text/plain part to use.
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1110 """))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1111 # parse the body of the message, stripping out bits as appropriate
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1112 summary, content = parseContent(self.content, config=self.config,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1113 is_new_issue=not bool(self.nodeid))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1114 content = content.strip()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1115
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1116 if content:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1117 if not self.db.security.hasPermission('Create',
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1118 self.author, 'msg'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1119 raise Unauthorized(_(
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1120 'You are not permitted to create messages.'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1121
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1122 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1123 message_id = self.db.msg.create(author=self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1124 recipients=self.recipients, date=date.Date('.'),
4498
8df9492c2746 Fix file-unlink bug in mailgw
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4486
diff changeset
1125 summary=summary, content=content,
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
1126 messageid=messageid, inreplyto=inreplyto, **self.msg_props)
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1127 except exceptions.Reject as error: # noqa error is used
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1128 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1129 Mail message was rejected by a detector.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1130 %(error)s
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1131 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1132 # allowed to attach the message to the existing node?
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1133 if self.nodeid and not self.db.security.hasPermission('Edit',
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1134 self.author, self.classname, 'messages'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1135 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1136 'You are not permitted to add messages to %(classname)s.'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1137 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1138
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1139 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1140 # add the message to the node's list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1141 messages = self.cl.get(self.nodeid, 'messages')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1142 messages.append(message_id)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1143 self.props['messages'] = messages
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1144 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1145 # pre-load the messages list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1146 self.props['messages'] = [message_id]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1147
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1148 def create_node(self):
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1149 ''' Create/update a node using self.props
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1150 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1151 classname = self.classname
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1152 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1153 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1154 # Check permissions for each property
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1155 for prop in self.props.keys():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1156 if not self.db.security.hasPermission('Edit', self.author,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1157 classname, prop):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1158 raise Unauthorized(_('You are not permitted to edit '
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1159 'property %(prop)s of class %(classname)s.') %
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1160 locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1161 self.cl.set(self.nodeid, **self.props)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1162 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1163 # Check permissions for each property
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1164 for prop in self.props.keys():
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1165 if not self.db.security.hasPermission('Create',
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1166 self.author, classname, prop):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1167 raise Unauthorized(_('You are not permitted to set '
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1168 'property %(prop)s of class %(classname)s.') %
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1169 locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1170 self.nodeid = self.cl.create(**self.props)
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1171 except (TypeError, IndexError,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1172 ValueError, exceptions.Reject) as message: # noqa: F841
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1173 self.mailgw.logger.exception(
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1174 "Rejecting email due to node creation error:")
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1175 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1176 There was a problem with the message you sent:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1177 %(message)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1178 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1179
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1180 return self.nodeid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1181
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1182 # XXX Don't enable. This doesn't work yet.
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1183 # "[^A-z.]tracker\+(?P<classname>[^\d\s]+)(?P<nodeid>\d+)\@some.dom.ain[^A-z.]"
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1184 # handle delivery to addresses like:tracker+issue25@some.dom.ain
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1185 # use the embedded issue number as our issue
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1186 # issue_re = config['MAILGW_ISSUE_ADDRESS_RE']
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1187 # if issue_re:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1188 # for header in ['to', 'cc', 'bcc']:
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1189 # addresses = message.get_header(header, '')
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1190 # if addresses:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1191 # # FIXME, this only finds the first match in the addresses.
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1192 # issue = re.search(issue_re, addresses, 'i')
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1193 # if issue:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1194 # classname = issue.group('classname')
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1195 # nodeid = issue.group('nodeid')
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1196 # break
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1197
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1198 # Default sequence of methods to be called on message. Use this for
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1199 # easier override of the default message processing
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1200 # list consists of tuples (method, return_if_true), the parsing
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1201 # returns if the return_if_true flag is set for a method *and* the
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1202 # method returns something that evaluates to True.
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1203 method_list = [
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1204 # Filter out messages to ignore
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1205 ("handle_ignore", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1206 # Check for usage/help requests
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1207 ("handle_help", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1208 # Check if the subject line is valid
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1209 ("check_subject", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1210 # get importants parts from subject
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1211 ("parse_subject", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1212 # check for registration OTK
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1213 ("rego_confirm", True),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1214 # get the classname
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1215 ("get_classname", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1216 # get the optional nodeid:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1217 ("get_nodeid", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1218 # Determine who the author is:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1219 ("get_author_id", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1220 # allowed to edit or create this class?
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1221 ("check_permissions", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1222 # author may have been created:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1223 # commit author to database and re-open as author
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1224 ("commit_and_reopen_as_author", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1225 # Get the recipients list
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1226 ("get_recipients", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1227 # get the new/updated node props
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1228 ("get_props", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1229 # Handle PGP signed or encrypted messages
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1230 ("get_pgp_message", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1231 # extract content and attachments from message body:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1232 ("get_content_and_attachments", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1233 # put attachments into files linked to the issue:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1234 ("create_files", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1235 # create the message if there's a message body (content):
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1236 ("create_msg", False),
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1237 ]
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1238
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1239 def parse(self):
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1240 for methodname, flag in self.method_list:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1241 method = getattr(self, methodname)
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1242 ret = method()
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1243 if flag and ret:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1244 return
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1245 # perform the node change / create:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1246 return self.create_node()
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1247
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1248
1677
d4e615fcbe04 Made subject_re an attribute of MailGW...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1665
diff changeset
1249 class MailGW:
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1250
4469
90aae2faac72 Add parsedMessage class as class variable to MailGW to allow easier override
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4468
diff changeset
1251 # To override the message parsing, derive your own class from
90aae2faac72 Add parsedMessage class as class variable to MailGW to allow easier override
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4468
diff changeset
1252 # parsedMessage and assign to parsed_message_class in a derived
90aae2faac72 Add parsedMessage class as class variable to MailGW to allow easier override
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4468
diff changeset
1253 # class of MailGW
90aae2faac72 Add parsedMessage class as class variable to MailGW to allow easier override
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4468
diff changeset
1254 parsed_message_class = parsedMessage
90aae2faac72 Add parsedMessage class as class variable to MailGW to allow easier override
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4468
diff changeset
1255
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1256 def __init__(self, instance, arguments=()):
389
7d7cb5319fc0 re-open the database as the author in mail handling
Richard Jones <richard@users.sourceforge.net>
parents: 382
diff changeset
1257 self.instance = instance
1462
285934a04a6c fix for [SF#691046]
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
1258 self.arguments = arguments
2672
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1259 self.default_class = None
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1260 for option, value in self.arguments:
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1261 if option == '-c':
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1262 self.default_class = value.strip()
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1263
1799
071ea6fc803f Extracted duplicated mail-sending code...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1793
diff changeset
1264 self.mailer = Mailer(instance.config)
4420
9655a1b65974 - more logger fixes -- use correct hierarchical logger names...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4405
diff changeset
1265 self.logger = logging.getLogger('roundup.mailgw')
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1266
824
34eacaa7e313 Added ability for unit tests to turn off exception handling in mailgw so
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
1267 # should we trap exceptions (normal usage) or pass them through
34eacaa7e313 Added ability for unit tests to turn off exception handling in mailgw so
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
1268 # (for testing)
34eacaa7e313 Added ability for unit tests to turn off exception handling in mailgw so
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
1269 self.trapExceptions = 1
34eacaa7e313 Added ability for unit tests to turn off exception handling in mailgw so
Richard Jones <richard@users.sourceforge.net>
parents: 753
diff changeset
1270
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1271 def do_pipe(self):
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1272 """ Read a message from standard input and pass it to the mail handler.
1280
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1273
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1274 Read into an internal structure that we can seek on (in case
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1275 there's an error).
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1276
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1277 XXX: we may want to read this into a temporary file instead...
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1278 """
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1279 s = io.BytesIO()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1280 if sys.version_info[0] > 2:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1281 stdin = sys.stdin.buffer
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1282 else:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1283 stdin = sys.stdin
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1284 s.write(stdin.read())
1281
284a9d6b3cf9 bugfixes to pipe bugfix
Richard Jones <richard@users.sourceforge.net>
parents: 1280
diff changeset
1285 s.seek(0)
1280
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1286 self.main(s)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1287 return 0
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1288
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1289 def do_mailbox(self, filename):
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1290 """ Read a series of messages from the specified unix mailbox file and
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1291 pass each to the mail handler.
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1292 """
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1293 import mailbox
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1294
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1295 class mboxRoundupMessage(mailbox.mboxMessage, RoundupMessage):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1296 pass
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1297
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1298 # The mailbox class constructs email.message.Message objects
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1299 # using various email.message_from_* methods, without allowing
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1300 # control over the _class argument passed to them to specify a
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1301 # subclass to be used. We need RoundupMessage to be used for
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1302 # subparts of multipart messages, so patch those methods to
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1303 # pass _class.
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1304 try:
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1305 patch_methods = ('message_from_bytes', 'message_from_string',
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1306 'message_from_file', 'message_from_binary_file')
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1307 orig_methods = {}
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1308 for method in patch_methods:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1309 if hasattr(email, method):
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1310 orig = getattr(email, method)
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1311 orig_methods[method] = orig
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1312 setattr(email, method,
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1313 functools.partial(orig, _class=RoundupMessage))
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1314 try:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1315 mbox = mailbox.mbox(filename, factory=mboxRoundupMessage,
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1316 create=False)
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1317 mbox.lock()
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1318 except (mailbox.NoSuchMailboxError,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1319 mailbox.ExternalClashError) as e:
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1320 if isinstance(e, mailbox.ExternalClashError):
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1321 mbox.close()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1322 traceback.print_exc()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1323 return 1
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1324
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1325 try:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1326 for key in mbox.keys():
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1327 self.handle_Message(mbox.get(key))
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1328 mbox.remove(key)
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1329 finally:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1330 mbox.unlock()
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1331 mbox.close()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1332 finally:
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1333 for method in orig_methods:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1334 setattr(email, method, orig)
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1335
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1336 return 0
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1337
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1338 def do_imap(self, server, user='', password='', mailbox='', ssl=0, cram=0):
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1339 ''' Do an IMAP connection
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1340 '''
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1341 import getpass, imaplib, socket
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1342 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1343 if not user:
5401
4cf48ff01e04 Python 3 preparation: replace raw_input uses.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5396
diff changeset
1344 user = my_input('User: ')
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1345 if not password:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1346 password = getpass.getpass()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1347 except (KeyboardInterrupt, EOFError):
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1348 # Ctrl C or D maybe also Ctrl Z under Windows.
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
1349 print("\nAborted by user.")
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1350 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1351 # open a connection to the server and retrieve all messages
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1352 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1353 if ssl:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1354 self.logger.debug('Trying server %r with ssl' % server)
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1355 server = imaplib.IMAP4_SSL(server)
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1356 else:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1357 self.logger.debug('Trying server %r without ssl' % server)
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1358 server = imaplib.IMAP4(server)
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1359 except (imaplib.IMAP4.error, socket.error, socket.sslerror):
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1360 self.logger.exception('IMAP server error')
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1361 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1362
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1363 try:
4345
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1364 if cram:
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1365 server.login_cram_md5(user, password)
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1366 else:
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1367 server.login(user, password)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1368 except imaplib.IMAP4.error as e:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1369 self.logger.exception('IMAP login failure: %s' % e)
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1370 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1371
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1372 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1373 if not mailbox:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1374 (typ, data) = server.select()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1375 else:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1376 (typ, data) = server.select(mailbox=mailbox)
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1377 if typ != 'OK':
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1378 self.logger.error('Failed to get mailbox %r: %s' % (mailbox,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1379 data))
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1380 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1381 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1382 numMessages = int(data[0])
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1383 except ValueError:
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1384 self.logger.error('Invalid message count from mailbox %r' %
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1385 data[0])
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1386 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1387 for i in range(1, numMessages+1):
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1388 (typ, data) = server.fetch(str(i), '(RFC822)')
2211
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1389
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1390 # mark the message as deleted.
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1391 server.store(str(i), '+FLAGS', r'(\Deleted)')
2211
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1392
5912
7264b2e79a31 Fix mailgw IMAP message handling
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5764
diff changeset
1393 # process the message, data[0][1] is of type 'bytes' for
7264b2e79a31 Fix mailgw IMAP message handling
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5764
diff changeset
1394 # python3 and a string for python2.
7264b2e79a31 Fix mailgw IMAP message handling
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5764
diff changeset
1395 s = data[0][1]
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1396 self.handle_Message(message_from_bytes(s, RoundupMessage))
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1397 server.close()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1398 finally:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1399 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1400 server.expunge()
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1401 except (imaplib.IMAP4.error, socket.error, socket.sslerror):
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1402 pass
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1403 server.logout()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1404
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1405 return 0
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1406
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1407 def do_apop(self, server, user='', password='', ssl=False):
1547
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1408 ''' Do authentication POP
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1409 '''
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1410 self._do_pop(server, user, password, True, ssl)
1547
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1411
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1412 def do_pop(self, server, user='', password='', ssl=False):
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1413 ''' Do plain POP
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1414 '''
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1415 self._do_pop(server, user, password, False, ssl)
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1416
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1417 def _do_pop(self, server, user, password, apop, ssl):
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1418 '''Read a series of messages from the specified POP server.
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1419 '''
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1420 import getpass, poplib, socket
5331
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1421 # Monkey-patch poplib to have a large line-limit
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1422 # Seems that in python2.7 poplib applies a line-length limit not
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1423 # just to the lines that take care of the pop3 protocol but also
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1424 # to all email content
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1425 # See, e.g.,
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1426 # https://readlist.com/lists/python.org/python-list/69/346982.html
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1427 # https://stackoverflow.com/questions/30976106/python-poplib-error-proto-line-too-+long?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1428 if 0 < getattr(poplib, '_MAXLINE', -1) < 100*1024:
5331
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1429 poplib._MAXLINE = 100*1024
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1430 try:
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1431 if not user:
5401
4cf48ff01e04 Python 3 preparation: replace raw_input uses.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5396
diff changeset
1432 user = my_input('User: ')
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1433 if not password:
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1434 password = getpass.getpass()
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1435 except (KeyboardInterrupt, EOFError):
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1436 # Ctrl C or D maybe also Ctrl Z under Windows.
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5356
diff changeset
1437 print("\nAborted by user.")
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1438 return 1
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1439
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1440 # open a connection to the server and retrieve all messages
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1441 try:
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1442 if ssl:
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1443 klass = poplib.POP3_SSL
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1444 else:
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1445 klass = poplib.POP3
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1446 server = klass(server)
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1447 except socket.error:
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1448 self.logger.exception('POP server error')
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1449 return 1
1547
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1450 if apop:
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1451 server.apop(user, password)
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1452 else:
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1453 server.user(user)
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1454 server.pass_(password)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1455 numMessages = len(server.list()[1])
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1456 for i in range(1, numMessages+1):
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
1457 # retr: returns
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1458 # [ pop response e.g. '+OK 459 octets',
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1459 # [ array of message lines ],
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1460 # number of octets ]
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1461 lines = server.retr(i)[1]
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1462 self.handle_Message(
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1463 message_from_bytes(b'\n'.join(lines), RoundupMessage))
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1464 # delete the message
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1465 server.dele(i)
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1466
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1467 # quit the server to commit changes.
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1468 server.quit()
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1469 return 0
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1470
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1471 def main(self, fp):
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1472 ''' fp - the file from which to read the Message.
343
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1473 '''
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1474 return self.handle_Message(message_from_binary_file(fp,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1475 RoundupMessage))
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1476
343
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1477 def handle_Message(self, message):
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1478 """Handle an RFC822 Message
343
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1479
391
399340646765 handle the case where there is no file attached
Richard Jones <richard@users.sourceforge.net>
parents: 389
diff changeset
1480 Handle the Message object by calling handle_message() and then cope
343
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1481 with any errors raised by handle_message.
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1482 This method's job is to make that call and handle any
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1483 errors in a sane manner. It should be replaced if you wish to
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1484 handle errors in a different manner.
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1485 """
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1486 # in some rare cases, a particularly stuffed-up e-mail will make
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1487 # its way into here... try to handle it gracefully
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2005
diff changeset
1488
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1489 self.parsed_message = None
4573
8b2ccf6f2cf7 Fix initialisation of crypt option.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4570
diff changeset
1490 crypt = False
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1491 sendto = message.get_address_list('resent-from')
5045
a46d5d0fd5f8 Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM
Peter Funk <pf@artcom-gmbh.de>
parents: 4981
diff changeset
1492 if not sendto or self.instance.config['EMAIL_KEEP_REAL_FROM']:
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1493 sendto = message.get_address_list('from')
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1494 if not sendto:
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1495 # very bad-looking message - we don't even know who sent it
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1496 msg = ['Badly formed message from mail gateway. Headers:']
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1497 msg.extend([': '.join(args) for args in message.items()])
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1498 msg = '\n'.join(map(str, msg))
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1499 self.logger.error(msg)
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1500 return
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2005
diff changeset
1501
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1502 msg = 'Handling message'
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1503 if message.get_header('message-id'):
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1504 msg += ' (Message-id=%r)' % message.get_header('message-id')
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1505 self.logger.info(msg)
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1506
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1507 # try normal message-handling
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1508 if not self.trapExceptions:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1509 return self.handle_message(message)
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1510
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1511 # no, we want to trap exceptions
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1512 # Note: by default we return the message received not the
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1513 # internal state of the parsedMessage -- except for
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1514 # MailUsageError, Unauthorized and for unknown exceptions. For
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1515 # the latter cases we make sure the error message is encrypted
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1516 # if needed (if it either was received encrypted or pgp
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1517 # processing is turned on for the user).
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1518 try:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1519 return self.handle_message(message)
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1520 except MailUsageHelp:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1521 # bounce the message back to the sender with the usage message
5240
86190260f077 Mailgw: Improves diagnostic messages for DEBUG.
Bernhard Reiter <bernhard@intevation.de>
parents: 5151
diff changeset
1522 self.logger.debug("MailUsageHelp raised, bouncing.")
5433
86b6cea7a975 Python 3 preparation: avoid string.split().
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
1523 fulldoc = '\n'.join(__doc__.split('\n')[2:])
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1524 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1525 m.append('\n\nMail Gateway Help\n=================')
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1526 m.append(fulldoc)
2123
95da13c1bdbd have bounce_message do the error_messages_to heavy-lifting
Richard Jones <richard@users.sourceforge.net>
parents: 2119
diff changeset
1527 self.mailer.bounce_message(message, [sendto[0][1]], m,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1528 subject="Mail Gateway Help")
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1529 except MailUsageError as value:
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1530 # bounce the message back to the sender with the usage message
5240
86190260f077 Mailgw: Improves diagnostic messages for DEBUG.
Bernhard Reiter <bernhard@intevation.de>
parents: 5151
diff changeset
1531 self.logger.debug("MailUsageError raised, bouncing.")
5433
86b6cea7a975 Python 3 preparation: avoid string.split().
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
1532 fulldoc = '\n'.join(__doc__.split('\n')[2:])
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1533 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1534 m.append(str(value))
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1535 m.append('\n\nMail Gateway Help\n=================')
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1536 m.append(fulldoc)
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1537 if self.parsed_message:
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1538 message = self.parsed_message.message
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1539 crypt = self.parsed_message.crypt
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1540 self.mailer.bounce_message(message, [sendto[0][1]], m, crypt=crypt)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1541 except Unauthorized as value:
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1542 # just inform the user that he is not authorized
5240
86190260f077 Mailgw: Improves diagnostic messages for DEBUG.
Bernhard Reiter <bernhard@intevation.de>
parents: 5151
diff changeset
1543 self.logger.debug("Unauthorized raised, bouncing.")
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1544 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1545 m.append(str(value))
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1546 if self.parsed_message:
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1547 message = self.parsed_message.message
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1548 crypt = self.parsed_message.crypt
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1549 self.mailer.bounce_message(message, [sendto[0][1]], m, crypt=crypt)
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1550 except IgnoreMessage:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1551 # do not take any action
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1552 # this exception is thrown when email should be ignored
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1553 msg = 'IgnoreMessage raised'
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1554 if message.get_header('message-id'):
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1555 msg += ' (Message-id=%r)' % message.get_header('message-id')
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1556 self.logger.info(msg)
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1557 return
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1558 except Exception:
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1559 msg = 'Exception handling message'
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1560 if message.get_header('message-id'):
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1561 msg += ' (Message-id=%r)' % message.get_header('message-id')
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1562 self.logger.exception(msg)
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1563
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1564 # bounce the message back to the sender with the error message
2123
95da13c1bdbd have bounce_message do the error_messages_to heavy-lifting
Richard Jones <richard@users.sourceforge.net>
parents: 2119
diff changeset
1565 # let the admin know that something very bad is happening
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1566 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1567 m.append('An unexpected error occurred during the processing')
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1568 m.append('of your message. The tracker administrator is being')
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1569 m.append('notified.\n')
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1570 if self.parsed_message:
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1571 message = self.parsed_message.message
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1572 crypt = self.parsed_message.crypt
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1573 self.mailer.bounce_message(message, [sendto[0][1]], m, crypt=crypt)
3948
81531a2aed59 Admin copy of error email from mailgw includes traceback
Richard Jones <richard@users.sourceforge.net>
parents: 3945
diff changeset
1574
81531a2aed59 Admin copy of error email from mailgw includes traceback
Richard Jones <richard@users.sourceforge.net>
parents: 3945
diff changeset
1575 m.append('----------------')
81531a2aed59 Admin copy of error email from mailgw includes traceback
Richard Jones <richard@users.sourceforge.net>
parents: 3945
diff changeset
1576 m.append(traceback.format_exc())
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1577 self.mailer.bounce_message(message,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1578 [self.instance.config.ADMIN_EMAIL], m)
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1579
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1580 def handle_message(self, message):
110
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1581 ''' message - a Message instance
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1582
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1583 Parse the message as per the module docstring.
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1584 '''
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1585 # get database handle for handling one email
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1586 self.db = self.instance.open('admin')
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1587
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1588 self.db.tx_Source = "email"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1589
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1590 try:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1591 return self._handle_message(message)
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1592 finally:
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1593 self.db.close()
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1594
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1595 def _handle_message(self, message):
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1596 ''' message - a Message instance
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1597
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1598 Parse the message as per the module docstring.
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1599 The following code expects an opened database and a try/finally
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1600 that closes the database.
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1601 '''
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1602 self.parsed_message = self.parsed_message_class(self, message)
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1603 nodeid = self.parsed_message.parse()
1217
984c498e7deb handle stupid mailers quoting subject lines
Richard Jones <richard@users.sourceforge.net>
parents: 1209
diff changeset
1604
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1605 # commit the changes to the DB
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1606 self.db.commit()
411
a6088556e9ba Features and fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 406
diff changeset
1607
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1608 self.parsed_message = None
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1609 return nodeid
411
a6088556e9ba Features and fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 406
diff changeset
1610
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1611 def get_class_arguments(self, class_type, classname=None):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1612 ''' class_type - a valid node class type:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1613 - 'user' refers to the author of a message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1614 - 'issue' refers to an issue-type class (to which the
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1615 message is appended) specified in parameter classname
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1616 Note that this need not be the real classname, we get
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1617 the real classname used as a parameter (from previous
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1618 message-parsing steps)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1619 - 'file' specifies a file-type class
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1620 - 'msg' is the message-class
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1621 classname - the name of the current issue-type class
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1622
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1623 Parse the commandline arguments and retrieve the properties that
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1624 are relevant to the class_type. We now allow multiple -S options
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1625 per class_type (-C option).
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1626 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1627 allprops = {}
286
2313560b8477 Initial cut at trying to handle people responding to CC'ed messages...
Richard Jones <richard@users.sourceforge.net>
parents: 270
diff changeset
1628
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1629 classname = classname or class_type
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1630 cls_lookup = {'issue': classname}
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1631
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1632 # Allow other issue-type classes -- take the real classname from
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1633 # previous parsing-steps of the message:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1634 clsname = cls_lookup.get(class_type, class_type)
753
938edfdeac6e Sorry about this huge checkin!
Richard Jones <richard@users.sourceforge.net>
parents: 736
diff changeset
1635
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1636 # check if the clsname is valid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1637 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1638 self.db.getclass(clsname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1639 except KeyError:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1640 mailadmin = self.instance.config['ADMIN_EMAIL']
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1641 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1642 The mail gateway is not properly set up. Please contact
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1643 %(mailadmin)s and have them fix the incorrect class specified as:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1644 %(clsname)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1645 """) % locals())
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1646
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1647 if self.arguments:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1648 # The default type on the commandline is msg
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1649 if class_type == 'msg':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1650 current_type = class_type
3417
07c696890f55 mailgw subject parsing has configurable levels of strictness
Richard Jones <richard@users.sourceforge.net>
parents: 3415
diff changeset
1651 else:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1652 current_type = None
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1653
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1654 # Handle the arguments specified by the email gateway command line.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1655 # We do this by looping over the list of self.arguments looking for
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1656 # a -C to match the class we want, then use the -S setting string.
1359
ebfd8dd1cce7 missed this part of the patch, added doc
Richard Jones <richard@users.sourceforge.net>
parents: 1358
diff changeset
1657 for option, propstring in self.arguments:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1658 if option in ('-C', '--class'):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1659 current_type = propstring.strip()
5763
945051a69d85 Remove trailing whitespace.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 5761
diff changeset
1660
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1661 if current_type != class_type:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1662 current_type = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1663
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1664 elif current_type and option in ('-S', '--set'):
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1665 cls = cls_lookup.get(current_type, current_type)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1666 temp_cl = self.db.getclass(cls)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1667 errors, props = setPropArrayFromString(self,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1668 temp_cl, propstring.strip())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1669
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1670 if errors:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1671 mailadmin = self.instance.config['ADMIN_EMAIL']
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1672 raise MailUsageError(_("""
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1673 The mail gateway is not properly set up. Please contact
3600
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
1674 %(mailadmin)s and have them fix the incorrect properties:
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
1675 %(errors)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1676 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1677 allprops.update(props)
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
1678
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1679 return allprops
699
676d4cfde9a5 Nosy list improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 694
diff changeset
1680
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
1681
1905
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1682 def setPropArrayFromString(self, cl, propString, nodeid=None):
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1683 ''' takes string of form prop=value,value;prop2=value
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1684 and returns (error, prop[..])
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1685 '''
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1686 props = {}
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1687 errors = []
5433
86b6cea7a975 Python 3 preparation: avoid string.split().
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
1688 for prop in propString.split(';'):
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1689 # extract the property name and value
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1690 try:
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1691 propname, value = prop.split('=')
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1692 except ValueError:
3600
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
1693 errors.append(_('not of form [arg=value,value,...;'
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1694 'arg=value,value,...]'))
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1695 return (errors, props)
1905
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1696 # convert the value to a hyperdb-usable value
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1697 propname = propname.strip()
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1698 try:
1905
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1699 props[propname] = hyperdb.rawToHyperdb(self.db, cl, nodeid,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1700 propname, value)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1701 except hyperdb.HyperdbValueError as message:
2920
98e6219ddb83 merge maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2906
diff changeset
1702 errors.append(str(message))
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1703 return errors, props
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1704
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1705
905
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1706 def extractUserFromList(userClass, users):
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1707 '''Given a list of users, try to extract the first non-anonymous user
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1708 and return that user, otherwise return None
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1709 '''
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1710 if len(users) > 1:
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1711 for user in users:
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1712 # make sure we don't match the anonymous or admin user
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1713 if userClass.get(user, 'username') in ('admin', 'anonymous'):
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1714 continue
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1715 # first valid match will do
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1716 return user
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1717 # well, I guess we have no choice
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1718 return user[0]
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1719 elif users:
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1720 return users[0]
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1721 return None
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1722
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1723
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1724 def uidFromAddress(db, address, create=1, **user_props):
905
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1725 ''' address is from the rfc822 module, and therefore is (name, addr)
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1726
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1727 user is created if they don't exist in the db already
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1728 user_props may supply additional user information
905
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1729 '''
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1730 (realname, address) = address
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1731
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1732 # try a straight match of the address
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1733 user = extractUserFromList(db.user, db.user.stringFind(address=address))
1477
ed725179953d Added password reset facility for forgotten passwords.
Richard Jones <richard@users.sourceforge.net>
parents: 1462
diff changeset
1734 if user is not None:
ed725179953d Added password reset facility for forgotten passwords.
Richard Jones <richard@users.sourceforge.net>
parents: 1462
diff changeset
1735 return user
905
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1736
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1737 # try the user alternate addresses if possible
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1738 props = db.user.getprops()
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
1739 if 'alternate_addresses' in props:
1249
6c24a86a12ae Fixes for SourceForge tracker bugs.
Richard Jones <richard@users.sourceforge.net>
parents: 1244
diff changeset
1740 users = db.user.filter(None, {'alternate_addresses': address})
4531
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1741 # We want an exact match of the email, not just a substring
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1742 # match. Otherwise e.g. support@example.com would match
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1743 # discuss-support@example.com which is not what we want.
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1744 found_users = []
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1745 for u in users:
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1746 alt = db.user.get(u, 'alternate_addresses').split('\n')
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1747 for a in alt:
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1748 if a.strip().lower() == address.lower():
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1749 found_users.append(u)
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1750 break
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1751 user = extractUserFromList(db.user, found_users)
1477
ed725179953d Added password reset facility for forgotten passwords.
Richard Jones <richard@users.sourceforge.net>
parents: 1462
diff changeset
1752 if user is not None:
ed725179953d Added password reset facility for forgotten passwords.
Richard Jones <richard@users.sourceforge.net>
parents: 1462
diff changeset
1753 return user
905
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1754
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1755 # try to match the username to the address (for local
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1756 # submissions where the address is empty)
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1757 user = extractUserFromList(db.user, db.user.stringFind(username=address))
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1758
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1759 # couldn't match address or username, so create a new user
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1760 if create:
1592
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1761 # generate a username
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1762 if '@' in address:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1763 username = address.split('@')[0]
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1764 else:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1765 username = address
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1766 trying = username
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1767 n = 0
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1768 while 1:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1769 try:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1770 # does this username exist already?
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1771 db.user.lookup(trying)
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1772 except KeyError:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1773 break
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1774 n += 1
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1775 trying = username + str(n)
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1776
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1777 # create!
2129
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1778 try:
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1779 return db.user.create(username=trying, address=address,
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1780 realname=realname, roles=db.config.NEW_EMAIL_USER_ROLES,
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1781 password=password.Password(password.generatePassword(),
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1782 config=db.config),
2129
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1783 **user_props)
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1784 except exceptions.Reject:
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1785 return 0
905
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1786 else:
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1787 return 0
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1788
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1789
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1790 def parseContent(content, keep_citations=None, keep_body=None,
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1791 config=None, is_new_issue=False):
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1792 """Parse mail message; return message summary and stripped content
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1793
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1794 The message body is divided into sections by blank lines.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1795 Sections where the second and all subsequent lines begin with a ">"
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1796 or "|" character are considered "quoting sections". The first line of
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1797 the first non-quoting section becomes the summary of the message.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1798
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1799 Arguments:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1800
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1801 keep_citations: declared for backward compatibility.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1802 If omitted or None, use config["MAILGW_KEEP_QUOTED_TEXT"]
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1803
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1804 keep_body: declared for backward compatibility.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1805 If omitted or None, use config["MAILGW_LEAVE_BODY_UNCHANGED"]
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1806
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1807 config: tracker configuration object.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1808 If omitted or None, use default configuration.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1809
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1810 """
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1811 if config is None:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1812 config = configuration.CoreConfig()
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1813 if keep_citations is None:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1814 keep_citations = config["MAILGW_KEEP_QUOTED_TEXT"]
5117
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1815 if keep_citations == "new":
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1816 # don't strip citations if we are a new issue
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1817 if is_new_issue:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1818 keep_citations = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1819 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1820 keep_citations = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1821 elif keep_citations == "yes":
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1822 keep_citations = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1823 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1824 keep_citations = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1825
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1826 if keep_body is None:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1827 keep_body = config["MAILGW_LEAVE_BODY_UNCHANGED"]
5117
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1828 if keep_body == "new":
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1829 # don't strip citations if we are a new issue
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1830 if is_new_issue:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1831 keep_body = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1832 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1833 keep_body = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1834 elif keep_body == "yes":
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1835 keep_body = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1836 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1837 keep_body = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1838
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1839 eol = config["MAILGW_EOL_RE"]
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1840 signature = config["MAILGW_SIGN_RE"]
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1841 original_msg = config["MAILGW_ORIGMSG_RE"]
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1842
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1843 # strip off leading carriage-returns / newlines
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1844 i = 0
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1845 for i in range(len(content)):
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1846 if content[i] not in '\r\n':
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1847 break
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1848 if i > 0:
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1849 sections = config["MAILGW_BLANKLINE_RE"].split(content[i:])
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1850 else:
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1851 sections = config["MAILGW_BLANKLINE_RE"].split(content)
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1852
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1853 # extract out the summary from the message
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1854 summary = ''
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1855 l = []
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1856 # find last non-empty section for signature matching
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1857 last_nonempty = len(sections) - 1
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1858 while last_nonempty and not sections[last_nonempty]:
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1859 last_nonempty -= 1
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1860 for ns, section in enumerate(sections):
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1861 # section = section.strip()
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1862 if not section:
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1863 continue
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1864 lines = eol.split(section)
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1865 quote_1st = lines[0] and lines[0][0] in '>|'
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1866 quote_2nd = len(lines) > 1 and lines[1] and lines[1][0] in '>|'
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1867 if quote_1st or quote_2nd:
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1868 # don't drop non-quoted first line of intermediate section:
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1869 if ns and not quote_1st and lines[0] and not keep_citations:
4581
f1d6e2b2eb64 Fix quote-stripping in mail gateway again.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4580
diff changeset
1870 # we drop only first-lines ending in ':' (e.g. 'XXX wrote:')
f1d6e2b2eb64 Fix quote-stripping in mail gateway again.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4580
diff changeset
1871 if not lines[0].endswith(':'):
f1d6e2b2eb64 Fix quote-stripping in mail gateway again.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4580
diff changeset
1872 l.append(lines[0])
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1873 # see if there's a response somewhere inside this section (ie.
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1874 # no blank line between quoted message and response)
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1875 for n, line in enumerate(lines[1:]):
1209
e47d9bb1455b [SF#614188] Exception in mailgw.py
Richard Jones <richard@users.sourceforge.net>
parents: 1204
diff changeset
1876 if line and line[0] not in '>|':
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1877 break
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1878 else:
694
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1879 # we keep quoted bits if specified in the config
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1880 if keep_citations:
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1881 l.append(section)
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1882 continue
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1883 # keep this section - it has reponse stuff in it
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1884 if not keep_citations:
6019
a328f9e3307b Flake8 fixes; remove unused imports; format changes.
John Rouillard <rouilj@ieee.org>
parents: 5912
diff changeset
1885 lines = lines[n + 1:]
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1886 section = '\n'.join(lines)
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1887
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1888 is_last = ns == last_nonempty
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1889 # and while we're at it, use the first non-quoted bit as
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1890 # our summary
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1891 if not summary:
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1892 # if we don't have our summary yet use the first line of this
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1893 # section
1299
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1894 summary = section
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1895 # match signature only in last section
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1896 elif is_last and signature.match(lines[0]) and 2 <= len(lines) <= 10:
706
7ba403bffed5 Tweaking the signature deletion from mail messages.
Richard Jones <richard@users.sourceforge.net>
parents: 699
diff changeset
1897 # lose any signature
7ba403bffed5 Tweaking the signature deletion from mail messages.
Richard Jones <richard@users.sourceforge.net>
parents: 699
diff changeset
1898 break
1344
f2f553611ce0 applied patches for handling Outlook quirks...
Richard Jones <richard@users.sourceforge.net>
parents: 1329
diff changeset
1899 elif original_msg.match(lines[0]):
706
7ba403bffed5 Tweaking the signature deletion from mail messages.
Richard Jones <richard@users.sourceforge.net>
parents: 699
diff changeset
1900 # ditch the stupid Outlook quoting of the entire original message
454
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 453
diff changeset
1901 break
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1902
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1903 # and add the section to the output
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1904 l.append(section)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1905
1299
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1906 # figure the summary - find the first sentence-ending punctuation or the
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1907 # first whole line, whichever is longest
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1908 sentence = re.search(r'^([^!?\.]+[!?\.])', summary)
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1909 if sentence:
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1910 sentence = sentence.group(1)
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1911 else:
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1912 sentence = ''
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1913 first = eol.split(summary)[0]
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1914 summary = max(sentence, first)
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1915
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1916 # Now reconstitute the message content minus the bits we don't care
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1917 # about.
694
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1918 if not keep_body:
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1919 content = '\n\n'.join(l)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1920
694
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1921 return summary, content
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1922
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
1923 # vim: set filetype=python sts=4 sw=4 et si :
Roundup Issue Tracker: http://roundup-tracker.org/