annotate roundup/mailgw.py @ 5542:29346d92d80c

Fix email interfaces with Python 3 (issue 2550974, issue 2551000). This patch fixes various issues handling incoming email with roundup-mailgw with Python 3. Incoming email must always be handled as bytes, not strings, because it may contain 8-bit-encoded MIME parts with different encodings in each part. When handling piped input, that means using sys.stdin.buffer in Python 3 for binary input, along with message_from_binary_file, not sys.stdin which is text input and may be for the wrong encoding and not message_from_file. (In turn, tests that use MailGW.main with text input are affected so an s2b call is inserted in the test code and it is made to use BytesIO not StringIO. Properly all the test messages in test_mailgw.py ought to use b'' explicitly rather than having such an s2b conversion, and there ought to be test messages using 8-bit encodings with non-ASCII characters to verify that that case works.) imaplib and poplib return bytes not strings with Python 3 (from inspection of the code, not tested), as is necessary for the above reasons. Thus, the handling of IMAP and POP messages must expect bytes and handle the data accordingly. For messages from mailboxes, I saw the same problem described in issue 2551000 for a multipart message with a single (non-ASCII) part. The Roundup code requires RoundupMessage not email.message.Message to be used recursively for all MIME parts of a message. Because the mailbox module uses email.message_from_* directly without passing the _class argument to them, fixing this requires temporarily patching the email module to ensure _class=RoundupMessage gets passed to those methods.
author Joseph Myers <jsm@polyomino.org.uk>
date Sun, 16 Sep 2018 13:55:53 +0000
parents b7fa56ced601
children 081be318661b
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
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
98 import base64, re, os, smtplib, socket, binascii, io, functools
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
99 import time, sys, logging
5416
56c9bcdea47f Python 3 preparation: unicode.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5401
diff changeset
100 import codecs
4980
13f8f88ad984 Replace rfc822 imports with email package (issue2550870)
John Kristensen <john@jerrykan.com>
parents: 4781
diff changeset
101 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
102 import email
4980
13f8f88ad984 Replace rfc822 imports with email package (issue2550870)
John Kristensen <john@jerrykan.com>
parents: 4781
diff changeset
103 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
104 from email.generator import Generator
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
106 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
107 message_from_binary_file
5401
4cf48ff01e04 Python 3 preparation: replace raw_input uses.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5396
diff changeset
108 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
109
4981
7f8f27ce1a06 Remove rfc2822.py
John Kristensen <john@jerrykan.com>
parents: 4980
diff changeset
110 from roundup import configuration, hyperdb, date, password, exceptions
3371
4f3285913a8c discard, don't bounce messages to the mailgw when the messages's sender...
Richard Jones <richard@users.sourceforge.net>
parents: 3367
diff changeset
111 from roundup.mailer import Mailer, MessageSendError
3600
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
112 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
113 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
114 from roundup.anypy.strings import StringIO, b2s, u2s
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
115 import roundup.anypy.random_ as random_
1383
f19dde90e473 applied unicode patch
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1359
diff changeset
116
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
117 try:
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
118 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
119 except ImportError:
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
120 gpg = None
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
121
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 467
diff changeset
122 SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 467
diff changeset
123
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
124 class MailGWError(ValueError):
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
125 pass
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
126
221
152fedaab07c Added better error handling to mailgw.
Richard Jones <richard@users.sourceforge.net>
parents: 218
diff changeset
127 class MailUsageError(ValueError):
152fedaab07c Added better error handling to mailgw.
Richard Jones <richard@users.sourceforge.net>
parents: 218
diff changeset
128 pass
152fedaab07c Added better error handling to mailgw.
Richard Jones <richard@users.sourceforge.net>
parents: 218
diff changeset
129
5264
32f95ec6bd8e Python 2 and 3 support. Convert Exception into BaseException in core code.
John Rouillard <rouilj@ieee.org>
parents: 5248
diff changeset
130 class MailUsageHelp(BaseException):
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
131 """ 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
132 pass
328d68db2ef8 - detect and break email loops [SF#640854]
Richard Jones <richard@users.sourceforge.net>
parents: 1320
diff changeset
133
5264
32f95ec6bd8e Python 2 and 3 support. Convert Exception into BaseException in core code.
John Rouillard <rouilj@ieee.org>
parents: 5248
diff changeset
134 class Unauthorized(BaseException):
467
103f521810f7 Features added:
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 464
diff changeset
135 """ Access denied """
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
136 pass
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
137
5264
32f95ec6bd8e Python 2 and 3 support. Convert Exception into BaseException in core code.
John Rouillard <rouilj@ieee.org>
parents: 5248
diff changeset
138 class IgnoreMessage(BaseException):
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
139 """ 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
140 pass
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
141 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
142 """ 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
143 pass
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
144 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
145 """ 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
146 pass
467
103f521810f7 Features added:
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 464
diff changeset
147
902
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
148 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
149 ''' 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
150
b0d3d3535998 Bugger it. Here's the current shape of the new security implementation.
Richard Jones <richard@users.sourceforge.net>
parents: 880
diff changeset
151 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
152 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
153 '''
948
8d8db618c2c3 grant email access to admin too ;)
Richard Jones <richard@users.sourceforge.net>
parents: 928
diff changeset
154 p = security.addPermission(name="Email Access",
928
23c9d4f86380 Added the web access and email access permissions..
Richard Jones <richard@users.sourceforge.net>
parents: 905
diff changeset
155 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
156 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
157
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
158 def gpgh_key_getall(key, attr):
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
159 ''' 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
160 a key
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
161 '''
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
162 for u in key.uids:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
163 yield getattr(u, attr)
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
164
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
165 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
166 ''' Theoretically a PGP message can have several signatures. GPGME
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
167 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
168 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
169 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
170 invalid signature.
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
171 '''
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
172 for sig in sigs:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
173 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
174 # 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
175 # submitted the email
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
176 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
177 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
178 return True
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
179 else:
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
180 # 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
181 # 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
182 if sig.summary & gpg.constants.sigsum.KEY_MISSING:
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
183 raise MailUsageError( \
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
184 _("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
185 elif sig.summary & gpg.constants.sigsum.KEY_EXPIRED:
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
186 raise MailUsageError( \
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
187 _("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
188 elif sig.summary & gpg.constants.sigsum.KEY_REVOKED:
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
189 raise MailUsageError( \
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
190 _("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
191 else:
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
192 raise MailUsageError( \
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
193 _("Invalid PGP signature detected."))
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
194
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
195 # 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
196 if sigs:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
197 raise MailUsageError(_("Message signed with unknown key: %s") % sig.fpr)
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
198 elif not may_be_unsigned:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
199 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
200
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
201 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
202 def _decode_header(self, hdr):
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
203 parts = []
4505
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
204 for part, encoding in decode_header(hdr):
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
205 if encoding:
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
206 part = part.decode(encoding)
a00e0e73bb26 Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4503
diff changeset
207 # 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
208 # 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
209 # 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
210 # 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
211 # 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
212 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
213
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
214 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
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 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
217 fp = StringIO()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
218 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
219 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
220 return fp.getvalue()
4093
1ebab2e397d0 Add some new encoding tests to mailgw:
Richard Jones <richard@users.sourceforge.net>
parents: 4092
diff changeset
221
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
222 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
223 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
224
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
225 if value:
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
226 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
227
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
228 return value
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
229
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
230 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
231 addresses = []
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
232
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
233 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
234 addresses.append((self._decode_header(name), addr))
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
235
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
236 return addresses
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
237
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
238 def get_body(self):
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
239 """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
240 content = self.get_payload(decode=True)
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
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 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
243 charset = self.get_content_charset()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
244 content = u2s(content.decode(charset or 'iso8859-1', 'replace'))
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
245
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
246 return content
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
247
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
248 # General multipart handling:
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
249 # 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
250 # attachment.
2364
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
251 # multipart/mixed:
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
252 # Multiple "unrelated" parts.
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
253 # multipart/Alternative (rfc 1521):
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
254 # 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
255 # alternatives. Generally a top-level part from MUAs sending HTML
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
256 # mail - there will be a text/plain version.
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
257 # multipart/signed (rfc 1847):
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
258 # 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
259 # required body parts.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
260 # 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
261 # multipart/encrypted (rfc 1847):
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
262 # 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
263 # required body parts.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
264 # ACTION: Not handleable as the content is encrypted.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
265 # multipart/related (rfc 1872, 2112, 2387):
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
266 # The Multipart/Related content-type addresses the MIME
2364
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
267 # representation of compound objects, usually HTML mail with embedded
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
268 # images. Usually appears as an alternative.
dfce8454848d fix comment
Richard Jones <richard@users.sourceforge.net>
parents: 2231
diff changeset
269 # ACTION: Default, if we must.
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
270 # multipart/report (rfc 1892):
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
271 # e.g. mail system delivery status reports.
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
272 # 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
273 # flagging.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
274 # multipart/form-data:
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
275 # For web forms only.
4424
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
276 # message/rfc822:
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
277 # Only if configured in [mailgw] unpack_rfc822
f1affb6b7a08 Mail gateway fixes and improvements.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4420
diff changeset
278 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
279 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
280 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
281 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
282
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
283 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
284 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
285 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
286
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
287 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
288 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
289 ignored.
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
290 """
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
291 content_type = self.get_content_type()
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
292 content = None
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
293 attachments = []
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
294 html_part = False
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
295
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
296 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
297 content = self.get_body()
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
298 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
299 # 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
300 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
301 attachments.append(self.as_attachment())
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
302 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
303 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
304 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
305 elif self.is_multipart():
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
306 content_found = False
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
307 ig = ignore_alternatives
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
308 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
309 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
310 new_content, new_attach, html_part = part.extract_content(
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
311 content_type, not content and ig, unpack_rfc822,
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
312 html2text)
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
313
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
314 # 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
315 # otherwise make it an attachment.
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
316 if not content:
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
317 content = new_content
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
318 cpart = part
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
319 if html_part:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
320 html_part_found = True
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
321 elif new_content:
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
322 if html_part:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
323 # attachment should be added elsewhere.
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
324 pass
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
325 elif content_found or content_type != 'multipart/alternative':
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
326 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
327 elif html_part_found:
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
328 # 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
329 # 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
330 # 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
331 content = new_content
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
332 cpart = part
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
333 else:
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
334 # if we have found a text/plain in the current
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
335 # multipart/alternative and find another one, we
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
336 # use the first as an attachment (if configured)
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
337 # and use the second one because rfc 2046, sec.
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
338 # 5.1.4. specifies that later parts are better
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
339 # (thanks to Philipp Gortan for pointing this
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
340 # out)
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
341 attachments.append(cpart.text_as_attachment())
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
342 content = new_content
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
343 cpart = part
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
344
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
345 attachments.extend(new_attach)
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
346 if ig and content_type == 'multipart/alternative' and content:
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
347 attachments = []
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
348 html_part = False
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
349 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
350 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
351 # Don't save signatures for signed messages as attachments
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
352 pass
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
353 else:
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
354 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
355
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
356 return content, attachments, html_part
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
357
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
358 def text_as_attachment(self):
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
359 """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
360 if not self.is_multipart():
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
361 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
362 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
363 if part.is_multipart():
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
364 p = part.text_as_attachment()
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
365 if p:
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
366 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
367 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
368 return part.as_attachment()
3945
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
369 return None
1dd64778bc45 Mail improvements:
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 3922
diff changeset
370
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
371 def as_attachment(self):
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
372 """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
373 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
374 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
375 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
376
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
377 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
378 # 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
379 # 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
380 # 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
381 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
382 if subject:
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
383 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
384
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
385 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
386
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
387 return (filename, content_type, content)
1975
30a444b7b212 *** empty log message ***
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1960
diff changeset
388
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
389 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
390 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
391 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
392 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
393 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
394 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
395
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
396 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
397 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
398 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
399 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
400 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
401 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
402
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
403 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
404 '''
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
405 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
406
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
407 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
408 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
409 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
410 '''
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
411 (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
412 # 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
413 # 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
414 # 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
415 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
416 hdr.get_content_type() != 'application/pgp-encrypted'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
417 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
418
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
419 context = gpg.core.Context()
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
420 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
421 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
422
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
423 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
424
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
425 if result:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
426 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
427
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
428 # 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
429 # 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
430 # 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
431 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
432 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
433 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
434
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
435 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
436 # 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
437 # 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
438 # 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
439 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
440
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
441 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
442 """
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
443 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
444
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
445 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
446 '-----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
447 """
3915
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
448 # 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
449 # 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
450 (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
451
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
452 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
453 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
454
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
455 # 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
456 # 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
457 # 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
458 # 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
459 # canonical <CR><LF> sequence."
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
460 # 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
461 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
462 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
463 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
464
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
465 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
466 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
467
6b3919328381 support for receiving OpenPGP MIME messages (signed or encrypted)
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3876
diff changeset
468 # 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
469 result = context.op_verify_result()
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
470 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
471
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
472 class parsedMessage:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
473
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
474 def __init__(self, mailgw, message):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
475 self.mailgw = mailgw
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
476 self.config = mailgw.instance.config
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
477 self.db = mailgw.db
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
478 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
479 self.subject = message.get_header('subject', '')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
480 self.has_prefix = False
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
481 self.matches = dict.fromkeys(['refwd', 'quote', 'classname',
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
482 '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
483 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
484 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
485 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
486 else:
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
487 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
488 message.get_address_list('from'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
489 self.pfxmode = self.config['MAILGW_SUBJECT_PREFIX_PARSING']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
490 self.sfxmode = self.config['MAILGW_SUBJECT_SUFFIX_PARSING']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
491 # these are filled in by subsequent parsing steps
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
492 self.classname = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
493 self.properties = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
494 self.cl = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
495 self.nodeid = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
496 self.author = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
497 self.recipients = None
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
498 self.msg_props = {}
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
499 self.props = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
500 self.content = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
501 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
502 self.crypt = False
4468
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 handle_ignore(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
505 ''' Check to see if message can be safely ignored:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
506 detect loops and
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
507 Precedence: Bulk, or Microsoft Outlook autoreplies
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
508 '''
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
509 if self.message.get_header('x-roundup-loop', ''):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
510 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
511 if (self.message.get_header('precedence', '') == 'bulk'
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
512 or self.subject.lower().find("autoreply") > 0):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
513 raise IgnoreBulk
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
514
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
515 def handle_help(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
516 ''' 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
517 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
518 if self.subject.strip().lower() == 'help':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
519 raise MailUsageHelp
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
520
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
521 def check_subject(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
522 ''' 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
523 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
524 if not self.subject:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
525 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
526 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
527 """))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
528
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
529 def parse_subject(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
530 ''' Matches subjects like:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
531 Re: "[issue1234] title of issue [status=resolved]"
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
532
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
533 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
534 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
535 returned
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
536 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
537
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
538 tmpsubject = self.subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
539
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
540 sd_open, sd_close = self.config['MAILGW_SUBJECT_SUFFIX_DELIMITERS']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
541 delim_open = re.escape(sd_open)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
542 if delim_open in '[(': delim_open = '\\' + delim_open
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
543 delim_close = re.escape(sd_close)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
544 if delim_close in '[(': delim_close = '\\' + delim_close
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
545
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
546 # 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
547 re_re = r"(?P<refwd>%s)\s*" % self.config["MAILGW_REFWD_RE"].pattern
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
548 m = re.match(re_re, tmpsubject, re.IGNORECASE|re.VERBOSE|re.UNICODE)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
549 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
550 m = m.groupdict()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
551 if m['refwd']:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
552 self.matches.update(m)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
553 tmpsubject = tmpsubject[len(m['refwd']):] # Consume Re:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
554
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
555 # Look for Leading "
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
556 m = re.match(r'(?P<quote>\s*")', tmpsubject,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
557 re.IGNORECASE)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
558 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
559 self.matches.update(m.groupdict())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
560 tmpsubject = tmpsubject[len(self.matches['quote']):] # Consume quote
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 # Check if the subject includes a prefix
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
563 self.has_prefix = re.search(r'^%s(\w+)%s'%(delim_open,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
564 delim_close), tmpsubject.strip())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
565
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
566 # Match the classname if specified
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
567 class_re = r'%s(?P<classname>(%s))(?P<nodeid>\d+)?%s'%(delim_open,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
568 "|".join(self.db.getclasses()), delim_close)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
569 # 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
570 # (mailing list prefix, etc.) before the class identifier
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
571 m = re.search(class_re, tmpsubject, re.IGNORECASE)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
572 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
573 self.matches.update(m.groupdict())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
574 # Skip to the end of the class identifier, including any
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
575 # garbage before it.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
576
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
577 tmpsubject = tmpsubject[m.end():]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
578
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
579 # Match any arguments specified *from the end*
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
580 # 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
581 # may put there, e.g.
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
582 # Re: "[issue1] bla blah [<args>]"
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
583 q = ''
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
584 if self.matches['quote']:
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
585 q = '"?'
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
586 args_re = r'(?P<argswhole>%s(?P<args>[^%s]*)%s)%s$'%(delim_open,
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
587 delim_close, delim_close, q)
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
588 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
589 if m:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
590 self.matches.update(m.groupdict())
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
591 tmpsubject = tmpsubject [:m.start()]
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
592 else:
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
593 self.matches['argswhole'] = self.matches['args'] = None
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
594
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
595 # The title of the subject is the remaining tmpsubject.
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
596 self.matches ['title'] = tmpsubject.strip ()
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
597
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
598 # 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
599 # Re: "[issue1] bla blah"
5151
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
600 # 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
601 # already have consumed the quote after the subject)
6bbb6dd97458 Fix subject parsing in mail gateway.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5117
diff changeset
602 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
603 and self.matches['title'].endswith('"'):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
604 self.matches['title'] = self.matches['title'][:-1]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
605
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
606 def rego_confirm(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
607 ''' Check for registration OTK and confirm the registration if found
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
608 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
609
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
610 if self.config['EMAIL_REGISTRATION_CONFIRMATION']:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
611 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
612 otk = otk_re.search(self.matches['title'] or '')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
613 if otk:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
614 self.db.confirm_registration(otk.group('otk'))
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
615 subject = 'Your registration to %s is complete' % \
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
616 self.config['TRACKER_NAME']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
617 sendto = [self.from_list[0][1]]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
618 self.mailgw.mailer.standard_message(sendto, subject, '')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
619 return 1
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
620 return 0
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
621
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
622 def get_classname(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
623 ''' Determine the classname of the node being created/edited
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
624 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
625 subject = self.subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
626
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
627 # get the classname
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
628 if self.pfxmode == 'none':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
629 classname = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
630 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
631 classname = self.matches['classname']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
632
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
633 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
634 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
635 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
636 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
637 'topic' of the message. For example:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
638 Subject: [issue] This is a new issue
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
639 - 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
640 a new issue'.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
641 Subject: [issue1234] This is a followup to issue 1234
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
642 - 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
643 in the tracker.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
644
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
645 Subject was: '%(subject)s'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
646 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
647
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
648 # 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
649 # back on the default
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
650 attempts = []
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
651 if classname:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
652 attempts.append(classname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
653
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
654 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
655 attempts.append(self.mailgw.default_class)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
656 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
657 attempts.append(self.config['MAILGW_DEFAULT_CLASS'])
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
658
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
659 # first valid class name wins
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
660 self.cl = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
661 for trycl in attempts:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
662 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
663 self.cl = self.db.getclass(trycl)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
664 classname = self.classname = trycl
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
665 break
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
666 except KeyError:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
667 pass
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 if not self.cl:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
670 validname = ', '.join(self.db.getclasses())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
671 if classname:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
672 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
673 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
674 not exist in the database.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
675
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
676 Valid class names are: %(validname)s
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
677 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
678 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
679 else:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
680 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
681 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
682 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
683 designator to indicate the 'topic' of the message. For example:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
684 Subject: [issue] This is a new issue
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
685 - 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
686 a new issue'.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
687 Subject: [issue1234] This is a followup to issue 1234
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
688 - 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
689 in the tracker.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
690
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
691 Subject was: '%(subject)s'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
692 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
693 # get the class properties
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
694 self.properties = self.cl.getprops()
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
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
697 def get_nodeid(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
698 ''' 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
699 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
700 title = self.matches['title']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
701 subject = self.subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
702
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
703 if self.pfxmode == 'none':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
704 nodeid = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
705 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
706 nodeid = self.matches['nodeid']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
707
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
708 # 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
709 inreplyto = self.message.get_header('in-reply-to') or ''
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
710 if nodeid is None and inreplyto:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
711 l = self.db.getclass('msg').stringFind(messageid=inreplyto)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
712 if l:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
713 nodeid = self.cl.filter(None, {'messages':l})[0]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
714
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
715
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
716 # but we do need either a title or a nodeid...
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
717 if nodeid is None and not title:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
718 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
719 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
720 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
721 previous subject title intact so I can match that.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
722
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
723 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
724 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
725
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
726 # 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
727 # 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
728 # 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
729 # 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
730 # recent...). The subject_content_match config may specify an
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
731 # additional restriction based on the matched node's creation or
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
732 # activity.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
733 tmatch_mode = self.config['MAILGW_SUBJECT_CONTENT_MATCH']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
734 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
735 l = self.cl.stringFind(title=title)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
736 limit = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
737 if (tmatch_mode.startswith('creation') or
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
738 tmatch_mode.startswith('activity')):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
739 limit, interval = tmatch_mode.split(' ', 1)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
740 threshold = date.Date('.') - date.Interval(interval)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
741 for id in l:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
742 if limit:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
743 if threshold < self.cl.get(id, limit):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
744 nodeid = id
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
745 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
746 nodeid = id
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
747
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
748 # if a nodeid was specified, make sure it's valid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
749 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
750 if self.pfxmode == 'strict':
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
751 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
752 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
753 ("%(nodeid)s") does not exist.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
754
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
755 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
756 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
757 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
758 nodeid = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
759 self.nodeid = nodeid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
760
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
761 def get_author_id(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
762 ''' 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
763 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
764 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
765 # 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
766 create = 1
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
767 anonid = self.db.user.lookup('anonymous')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
768 if not (self.db.security.hasPermission('Register', anonid, 'user')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
769 and self.db.security.hasPermission('Email Access', anonid)):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
770 create = 0
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
771
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
772 # 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
773 # "create" flag is true
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
774 author = uidFromAddress(self.db, self.from_list[0], create=create)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
775
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
776 # 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
777 # must be anonymous
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
778 if not author:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
779 author = anonid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
780
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
781 # 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
782 if not self.db.security.hasPermission('Email Access', author):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
783 if author == anonid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
784 # 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
785 from_address = self.from_list[0][1]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
786 registration_info = ""
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
787 if self.db.security.hasPermission('Web Access', author) and \
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
788 self.db.security.hasPermission('Register', anonid, 'user'):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
789 tracker_web = self.config.TRACKER_WEB
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
790 registration_info = """ Please register at:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
791
4580
782737d1a2d7 issue2431638 wrong registration link in bounce mail.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4579
diff changeset
792 %(tracker_web)suser?@template=register
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
793
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
794 ...before sending mail to the tracker.""" % locals()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
795
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
796 raise Unauthorized(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
797 You are not a registered user.%(registration_info)s
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
798
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
799 Unknown address: %(from_address)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
800 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
801 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
802 # 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
803 raise Unauthorized(_(
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
804 'You are not permitted to access this tracker.'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
805 self.author = author
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
806
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
807 def check_permissions(self):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
808 ''' 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
809 class of node
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
810 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
811 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
812 if not self.db.security.hasPermission('Edit', self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
813 self.classname, itemid=self.nodeid):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
814 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
815 '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
816 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
817 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
818 if not self.db.security.hasPermission('Create', self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
819 self.classname):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
820 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
821 '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
822 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
823
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
824 def commit_and_reopen_as_author(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
825 ''' 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
826 committed before we reopen the database
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
827 then re-open the database as the author
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
828 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
829 self.db.commit()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
830
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
831 # set the database user as the author
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
832 username = self.db.user.get(self.author, 'username')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
833 self.db.setCurrentUser(username)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
834
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
835 # re-get the class with the new database connection
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
836 self.cl = self.db.getclass(self.classname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
837
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
838 def get_recipients(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
839 ''' 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
840 register them as users if possible
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
841 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
842 # 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
843 create = 1
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
844 anonid = self.db.user.lookup('anonymous')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
845 if not (self.db.security.hasPermission('Register', anonid, 'user')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
846 and self.db.security.hasPermission('Email Access', anonid)):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
847 create = 0
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
848
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
849 # get the user class arguments from the commandline
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
850 user_props = self.mailgw.get_class_arguments('user')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
851
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
852 # now update the recipients list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
853 recipients = []
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
854 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
855 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
856 msg_cc = self.message.get_address_list('cc')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
857 for recipient in msg_to + msg_cc:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
858 r = recipient[1].strip().lower()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
859 if r == tracker_email or not r:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
860 continue
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
861
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
862 # look up the recipient - create if necessary (and we're
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
863 # allowed to)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
864 recipient = uidFromAddress(self.db, recipient, create, **user_props)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
865
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
866 # if all's well, add the recipient to the list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
867 if recipient:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
868 recipients.append(recipient)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
869 self.recipients = recipients
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 def get_props(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
872 ''' 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
873 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
874 subject = self.subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
875
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
876 # get the commandline arguments for issues
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
877 issue_props = self.mailgw.get_class_arguments('issue', self.classname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
878
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
879 #
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
880 # handle the subject argument list
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 # figure what the properties of this Class are
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
883 props = {}
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
884 args = self.matches['args']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
885 argswhole = self.matches['argswhole']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
886 title = self.matches['title']
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
887
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
888 # Reform the title
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
889 if self.matches['nodeid'] and self.nodeid is None:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
890 title = subject
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 if args:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
893 if self.sfxmode == 'none':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
894 title += ' ' + argswhole
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
895 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
896 errors, props = setPropArrayFromString(self, self.cl, args,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
897 self.nodeid)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
898 # handle any errors parsing the argument list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
899 if errors:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
900 if self.sfxmode == 'strict':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
901 errors = '\n- '.join(map(str, errors))
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
902 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
903 There were problems handling your subject line argument list:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
904 - %(errors)s
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
905
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
906 Subject was: "%(subject)s"
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
907 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
908 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
909 title += ' ' + argswhole
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
910
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 # set the issue title to the subject
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
913 title = title.strip()
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
914 if (title and 'title' in self.properties and 'title' not in issue_props):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
915 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
916 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
917 self.config['MAILGW_SUBJECT_UPDATES_TITLE']):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
918 issue_props['title'] = self.cl.get(self.nodeid,'title')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
919
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
920 # merge the command line props defined in issue_props into
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
921 # the props dictionary because function(**props, **issue_props)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
922 # is a syntax error.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
923 for prop in issue_props.keys() :
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
924 if prop not in props :
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
925 props[prop] = issue_props[prop]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
926
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
927 self.props = props
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
928
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
929 def get_pgp_message(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
930 ''' If they've enabled PGP processing then verify the signature
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
931 or decrypt the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
932 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
933 def pgp_role():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
934 """ 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
935 or we will skip PGP processing
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
936 """
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
937 if self.config.PGP_ROLES:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
938 return self.db.user.has_role(self.author,
4540
bf67fed13ef9 Fix PGP implementation
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4539
diff changeset
939 *iter_roles(self.config.PGP_ROLES))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
940 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
941 return True
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
942
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
943 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
944 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
945 self.crypt = True
5494
b7fa56ced601 use gpg module instead of pyme module for PGP encryption
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5493
diff changeset
946 assert gpg, 'gpg is not installed'
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
947 # signed/encrypted mail must come from the primary address
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
948 author_address = self.db.user.get(self.author, 'address')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
949 if self.config.PGP_HOMEDIR:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
950 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
951 if self.config.PGP_REQUIRE_INCOMING in ('encrypted', 'both') \
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
952 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
953 raise MailUsageError(_(
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
954 "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
955 "be PGP encrypted."))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
956 if self.message.pgp_signed():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
957 self.message.verify_signature(author_address)
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
958 # signature has been verified
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
959 self.db.tx_Source = "email-sig-openpgp"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
960
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
961 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
962 # Replace message with the contents of the decrypted
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
963 # 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
964 # 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
965 # 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
966 # 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
967 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
968 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
969 self.crypt = True
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
970 try:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
971 # see if the message has a valid signature
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
972 message = self.message.decrypt(author_address,
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
973 may_be_unsigned = False)
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
974 # only set if MailUsageError is not raised
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
975 # indicating that we have a valid signature
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
976 self.db.tx_Source = "email-sig-openpgp"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
977 except MailUsageError:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
978 # if there is no signature or an error in the message
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
979 # we get here. Try decrypting it again if we don't
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
980 # need signatures.
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
981 if encr_only:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
982 message = self.message.decrypt(author_address,
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
983 may_be_unsigned = encr_only)
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
984 else:
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
985 # something failed with the message decryption/sig
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
986 # chain. Pass the error up.
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
987 raise
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
988 # store the decrypted message
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
989 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
990 elif pgp_role():
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
991 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
992 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
993 encrypted."""))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
994
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
995 def get_content_and_attachments(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
996 ''' get the attachments and first text part from the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
997 '''
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
998 from roundup.dehtml import dehtml
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
999 html2text=dehtml(self.config['MAILGW_CONVERT_HTMLTOTEXT']).html2text
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1000
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1001 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
1002 self.message.instance = self.mailgw.instance
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1003 self.content, self.attachments, html_part = self.message.extract_content(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1004 ignore_alternatives=ig,
5305
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1005 unpack_rfc822=self.config.MAILGW_UNPACK_RFC822,
e20f472fde7d issue2550799: provide basic support for handling html only emails
John Rouillard <rouilj@ieee.org>
parents: 5264
diff changeset
1006 html2text=html2text )
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1007
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1008 def create_files(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1009 ''' Create a file for each attachment in the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1010 '''
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
1011 if 'files' not in self.properties:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1012 return
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1013 files = []
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1014 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
1015
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1016 if self.attachments:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1017 for (name, mime_type, data) in self.attachments:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1018 if not self.db.security.hasPermission('Create', self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1019 'file'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1020 raise Unauthorized(_(
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1021 'You are not permitted to create files.'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1022 if not name:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1023 name = "unnamed"
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1024 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1025 fileid = self.db.file.create(type=mime_type, name=name,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1026 content=data, **file_props)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1027 except exceptions.Reject:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1028 pass
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1029 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1030 files.append(fileid)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1031 # allowed to attach the files to an existing node?
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1032 if self.nodeid and not self.db.security.hasPermission('Edit',
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1033 self.author, self.classname, 'files'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1034 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1035 '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
1036 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1037
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
1038 self.msg_props['files'] = files
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1039 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1040 # extend the existing files list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1041 fileprop = self.cl.get(self.nodeid, 'files')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1042 fileprop.extend(files)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1043 files = fileprop
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1044
4498
8df9492c2746 Fix file-unlink bug in mailgw
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4486
diff changeset
1045 self.props['files'] = files
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1046
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1047 def create_msg(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1048 ''' Create msg containing all the relevant information from the message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1049 '''
5381
0942fe89e82e Python 3 preparation: change "x.has_key(y)" to "y in x".
Joseph Myers <jsm@polyomino.org.uk>
parents: 5378
diff changeset
1050 if 'messages' not in self.properties:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1051 return
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1052 msg_props = self.mailgw.get_class_arguments('msg')
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
1053 self.msg_props.update (msg_props)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1054
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1055 # 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
1056 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
1057 messageid = self.message.get_header('message-id')
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1058 # generate a messageid if there isn't one
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1059 if not messageid:
5488
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
1060 messageid = "<%s.%s.%s%s@%s>"%(time.time(),
52cb53eedf77 reworked random number use
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5463
diff changeset
1061 b2s(base64.b32encode(random_.token_bytes(10))),
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1062 self.classname, self.nodeid, self.config['MAIL_DOMAIN'])
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1063
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1064 if self.content is None:
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1065 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1066 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
1067 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
1068 """))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1069 # parse the body of the message, stripping out bits as appropriate
5117
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1070 summary, content = parseContent(self.content, config=self.config, is_new_issue = not bool(self.nodeid))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1071 content = content.strip()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1072
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1073 if content:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1074 if not self.db.security.hasPermission('Create', self.author, 'msg'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1075 raise Unauthorized(_(
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1076 'You are not permitted to create messages.'))
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1077
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1078 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1079 message_id = self.db.msg.create(author=self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1080 recipients=self.recipients, date=date.Date('.'),
4498
8df9492c2746 Fix file-unlink bug in mailgw
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4486
diff changeset
1081 summary=summary, content=content,
4503
9f488541802f Yet another fix to the mail gateway...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4498
diff changeset
1082 messageid=messageid, inreplyto=inreplyto, **self.msg_props)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1083 except exceptions.Reject as error:
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1084 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1085 Mail message was rejected by a detector.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1086 %(error)s
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1087 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1088 # allowed to attach the message to the existing node?
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1089 if self.nodeid and not self.db.security.hasPermission('Edit',
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1090 self.author, self.classname, 'messages'):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1091 raise Unauthorized(_(
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1092 '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
1093 ) % self.__dict__)
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1094
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1095 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1096 # add the message to the node's list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1097 messages = self.cl.get(self.nodeid, 'messages')
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1098 messages.append(message_id)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1099 self.props['messages'] = messages
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1100 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1101 # pre-load the messages list
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1102 self.props['messages'] = [message_id]
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1103
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1104 def create_node(self):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1105 ''' Create/update a node using self.props
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1106 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1107 classname = self.classname
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1108 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1109 if self.nodeid:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1110 # Check permissions for each property
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1111 for prop in self.props.keys():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1112 if not self.db.security.hasPermission('Edit', self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1113 classname, prop):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1114 raise Unauthorized(_('You are not permitted to edit '
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1115 'property %(prop)s of class %(classname)s.'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1116 ) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1117 self.cl.set(self.nodeid, **self.props)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1118 else:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1119 # Check permissions for each property
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1120 for prop in self.props.keys():
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1121 if not self.db.security.hasPermission('Create', self.author,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1122 classname, prop):
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1123 raise Unauthorized(_('You are not permitted to set '
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1124 'property %(prop)s of class %(classname)s.'
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1125 ) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1126 self.nodeid = self.cl.create(**self.props)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1127 except (TypeError, IndexError, ValueError, exceptions.Reject) as message:
5085
d3d9d1402763 issue2550823 Improve mailgw logging for node creation errors. Add a
John Rouillard <rouilj@ieee.org>
parents: 5056
diff changeset
1128 self.mailgw.logger.exception("Rejecting email due to node creation error:")
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1129 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1130 There was a problem with the message you sent:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1131 %(message)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1132 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1133
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1134 return self.nodeid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1135
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1136 # 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
1137 # "[^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
1138 # 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
1139 # 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
1140 # 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
1141 # if issue_re:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1142 # 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
1143 # 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
1144 # if addresses:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1145 # # 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
1146 # 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
1147 # if issue:
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1148 # 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
1149 # 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
1150 # break
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1151
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1152 # 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
1153 # 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
1154 # 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
1155 # 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
1156 # 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
1157 method_list = [
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1158 # Filter out messages to ignore
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1159 ("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
1160 # Check for usage/help requests
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1161 ("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
1162 # Check if the subject line is valid
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1163 ("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
1164 # get importants parts from subject
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1165 ("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
1166 # check for registration OTK
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1167 ("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
1168 # get the classname
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1169 ("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
1170 # get the optional nodeid:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1171 ("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
1172 # Determine who the author is:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1173 ("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
1174 # allowed to edit or create this class?
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1175 ("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
1176 # 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
1177 # 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
1178 ("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
1179 # Get the recipients list
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1180 ("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
1181 # get the new/updated node props
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1182 ("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
1183 # Handle PGP signed or encrypted messages
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1184 ("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
1185 # extract content and attachments from message body:
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1186 ("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
1187 # 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
1188 ("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
1189 # 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
1190 ("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
1191 ]
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1192
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1193
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1194 def parse (self):
4545
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1195 for methodname, flag in self.method_list:
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1196 method = getattr (self, methodname)
3f4179eb348f - fix mailgw list of methods
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4541
diff changeset
1197 ret = method()
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1198 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
1199 return
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1200 # 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
1201 return self.create_node()
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1202
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1203
1677
d4e615fcbe04 Made subject_re an attribute of MailGW...
Jean Jordaan <neaj@users.sourceforge.net>
parents: 1665
diff changeset
1204 class MailGW:
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1205
4469
90aae2faac72 Add parsedMessage class as class variable to MailGW to allow easier override
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4468
diff changeset
1206 # 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
1207 # 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
1208 # 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
1209 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
1210
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1211 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
1212 self.instance = instance
1462
285934a04a6c fix for [SF#691046]
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
1213 self.arguments = arguments
2672
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1214 self.default_class = None
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1215 for option, value in self.arguments:
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1216 if option == '-c':
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1217 self.default_class = value.strip()
437775793d8e mailgw can override the MAIL_DEFUALT_CLASS
Richard Jones <richard@users.sourceforge.net>
parents: 2670
diff changeset
1218
1799
071ea6fc803f Extracted duplicated mail-sending code...
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1793
diff changeset
1219 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
1220 self.logger = logging.getLogger('roundup.mailgw')
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1221
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
1222 # 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
1223 # (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
1224 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
1225
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1226 def do_pipe(self):
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1227 """ 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
1228
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1229 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
1230 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
1231
8b766547d4b8 store PIPE messages so we can re-send them on errors
Richard Jones <richard@users.sourceforge.net>
parents: 1249
diff changeset
1232 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
1233 """
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1234 s = io.BytesIO()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1235 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
1236 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
1237 else:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1238 stdin = sys.stdin
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1239 s.write(stdin.read())
1281
284a9d6b3cf9 bugfixes to pipe bugfix
Richard Jones <richard@users.sourceforge.net>
parents: 1280
diff changeset
1240 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
1241 self.main(s)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1242 return 0
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1243
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1244 def do_mailbox(self, filename):
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1245 """ 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
1246 pass each to the mail handler.
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1247 """
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1248 import mailbox
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1249
5493
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1250 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
1251 pass
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1252
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1253 # 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
1254 # 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
1255 # 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
1256 # 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
1257 # 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
1258 # pass _class.
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1259 try:
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1260 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
1261 '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
1262 orig_methods = {}
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1263 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
1264 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
1265 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
1266 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
1267 setattr(email, method,
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1268 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
1269 try:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1270 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
1271 create=False)
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1272 mbox.lock()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1273 except (mailbox.NoSuchMailboxError, mailbox.ExternalClashError) as e:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1274 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
1275 mbox.close()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1276 traceback.print_exc()
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1277 return 1
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1278
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1279 try:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1280 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
1281 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
1282 mbox.remove(key)
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1283 finally:
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1284 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
1285 mbox.close()
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1286 finally:
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1287 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
1288 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
1289
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1290 return 0
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1291
4345
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1292 def do_imap(self, server, user='', password='', mailbox='', ssl=0,
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1293 cram=0):
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1294 ''' Do an IMAP connection
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1295 '''
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1296 import getpass, imaplib, socket
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1297 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1298 if not user:
5401
4cf48ff01e04 Python 3 preparation: replace raw_input uses.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5396
diff changeset
1299 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
1300 if not password:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1301 password = getpass.getpass()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1302 except (KeyboardInterrupt, EOFError):
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1303 # 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
1304 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
1305 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1306 # 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
1307 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1308 if ssl:
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1309 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
1310 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
1311 else:
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1312 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
1313 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
1314 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
1315 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
1316 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1317
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1318 try:
4345
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1319 if cram:
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1320 server.login_cram_md5(user, password)
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1321 else:
38265325492a support CRAM-MD5 for IMAPS
Richard Jones <richard@users.sourceforge.net>
parents: 4306
diff changeset
1322 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
1323 except imaplib.IMAP4.error as e:
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1324 self.logger.exception('IMAP login failure')
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1325 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1326
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1327 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1328 if not mailbox:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1329 (typ, data) = server.select()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1330 else:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1331 (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
1332 if typ != 'OK':
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1333 self.logger.error('Failed to get mailbox %r: %s'%(mailbox,
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1334 data))
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1335 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1336 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1337 numMessages = int(data[0])
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1338 except ValueError as value:
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1339 self.logger.error('Invalid message count from mailbox %r'%
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1340 data[0])
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1341 return 1
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1342 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
1343 (typ, data) = server.fetch(str(i), '(RFC822)')
2211
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1344
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1345 # 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
1346 server.store(str(i), '+FLAGS', r'(\Deleted)')
2211
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1347
272b654b1227 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2210
diff changeset
1348 # process the message
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1349 s = io.BytesIO(data[0][1])
2210
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1350 s.seek(0)
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1351 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
1352 server.close()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1353 finally:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1354 try:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1355 server.expunge()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1356 except:
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1357 pass
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1358 server.logout()
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1359
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1360 return 0
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1361
b61640273061 added IMAP support to mail gateway (rfe [SF#934000])
Richard Jones <richard@users.sourceforge.net>
parents: 2129
diff changeset
1362
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1363 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
1364 ''' Do authentication POP
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1365 '''
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1366 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
1367
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1368 def do_pop(self, server, user='', password='', ssl=False):
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1369 ''' Do plain POP
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1370 '''
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1371 self._do_pop(server, user, password, False, ssl)
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1372
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1373 def _do_pop(self, server, user, password, apop, ssl):
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1374 '''Read a series of messages from the specified POP server.
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1375 '''
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1376 import getpass, poplib, socket
5331
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1377 # 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
1378 # 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
1379 # 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
1380 # to all email content
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1381 # See, e.g.,
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1382 # 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
1383 # 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
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1384 if 0 < getattr (poplib, '_MAXLINE', -1) < 100*1024:
57caeefb2f81 Work around a line-length limit in poplib
Ralf Schlatterbeck <rsc@runtux.com>
parents: 5306
diff changeset
1385 poplib._MAXLINE = 100*1024
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1386 try:
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1387 if not user:
5401
4cf48ff01e04 Python 3 preparation: replace raw_input uses.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5396
diff changeset
1388 user = my_input('User: ')
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1389 if not password:
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1390 password = getpass.getpass()
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1391 except (KeyboardInterrupt, EOFError):
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1392 # 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
1393 print("\nAborted by user.")
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1394 return 1
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1395
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1396 # open a connection to the server and retrieve all messages
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1397 try:
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1398 if ssl:
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1399 klass = poplib.POP3_SSL
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1400 else:
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1401 klass = poplib.POP3
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3724
diff changeset
1402 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
1403 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
1404 self.logger.exception('POP server error')
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1405 return 1
1547
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1406 if apop:
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1407 server.apop(user, password)
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1408 else:
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1409 server.user(user)
f478c236b1f6 roundup mailgw now handles apop
Richard Jones <richard@users.sourceforge.net>
parents: 1477
diff changeset
1410 server.pass_(password)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1411 numMessages = len(server.list()[1])
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1412 for i in range(1, numMessages+1):
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
1413 # retr: returns
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1414 # [ pop response e.g. '+OK 459 octets',
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1415 # [ array of message lines ],
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1416 # number of octets ]
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1417 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
1418 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
1419 message_from_bytes(b'\n'.join(lines), RoundupMessage))
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1420 # delete the message
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1421 server.dele(i)
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1422
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1423 # quit the server to commit changes.
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1424 server.quit()
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1425 return 0
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1426
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1427 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
1428 ''' 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
1429 '''
5542
29346d92d80c Fix email interfaces with Python 3 (issue 2550974, issue 2551000).
Joseph Myers <jsm@polyomino.org.uk>
parents: 5494
diff changeset
1430 return self.handle_Message(message_from_binary_file(fp, 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
1431
343
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1432 def handle_Message(self, message):
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1433 """Handle an RFC822 Message
343
ab16997d9cda Started work on supporting a pop3-fetching server
Richard Jones <richard@users.sourceforge.net>
parents: 339
diff changeset
1434
391
399340646765 handle the case where there is no file attached
Richard Jones <richard@users.sourceforge.net>
parents: 389
diff changeset
1435 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
1436 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
1437 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
1438 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
1439 handle errors in a different manner.
1788
e5a17d4dd2c2 Normalize multiline strings for emacs.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1712
diff changeset
1440 """
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1441 # 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
1442 # 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
1443
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1444 self.parsed_message = None
4573
8b2ccf6f2cf7 Fix initialisation of crypt option.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4570
diff changeset
1445 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
1446 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
1447 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
1448 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
1449 if not sendto:
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1450 # 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
1451 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
1452 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
1453 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
1454 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
1455 return
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2005
diff changeset
1456
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1457 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
1458 if message.get_header('message-id'):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1459 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
1460 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
1461
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1462 # try normal message-handling
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1463 if not self.trapExceptions:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1464 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
1465
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1466 # 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
1467 # 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
1468 # 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
1469 # 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
1470 # 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
1471 # 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
1472 # 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
1473 try:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1474 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
1475 except MailUsageHelp:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1476 # 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
1477 self.logger.debug("MailUsageHelp raised, bouncing.")
5433
86b6cea7a975 Python 3 preparation: avoid string.split().
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
1478 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
1479 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1480 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
1481 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
1482 self.mailer.bounce_message(message, [sendto[0][1]], m,
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1483 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
1484 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
1485 # 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
1486 self.logger.debug("MailUsageError raised, bouncing.")
5433
86b6cea7a975 Python 3 preparation: avoid string.split().
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
1487 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
1488 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1489 m.append(str(value))
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1490 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
1491 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
1492 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
1493 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
1494 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
1495 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
1496 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
1497 # 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
1498 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
1499 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1500 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
1501 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
1502 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
1503 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
1504 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
1505 except IgnoreMessage:
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1506 # 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
1507 # 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
1508 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
1509 if message.get_header('message-id'):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1510 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
1511 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
1512 return
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1513 except:
2571
58848e3b6bb8 roundup-mailgw now logs fatal exceptions rather than mailing them to admin
Richard Jones <richard@users.sourceforge.net>
parents: 2364
diff changeset
1514 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
1515 if message.get_header('message-id'):
725266c03eab updated mailgw to no longer use mimetools based on jerrykan's patch
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5488
diff changeset
1516 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
1517 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
1518
1945
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1519 # 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
1520 # 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
1521 m = ['']
7e4058dfb29b ignore incoming email with "Precedence: bulk" (patch [SF#843489])
Richard Jones <richard@users.sourceforge.net>
parents: 1915
diff changeset
1522 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
1523 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
1524 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
1525 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
1526 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
1527 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
1528 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
1529
81531a2aed59 Admin copy of error email from mailgw includes traceback
Richard Jones <richard@users.sourceforge.net>
parents: 3945
diff changeset
1530 m.append('----------------')
81531a2aed59 Admin copy of error email from mailgw includes traceback
Richard Jones <richard@users.sourceforge.net>
parents: 3945
diff changeset
1531 m.append(traceback.format_exc())
81531a2aed59 Admin copy of error email from mailgw includes traceback
Richard Jones <richard@users.sourceforge.net>
parents: 3945
diff changeset
1532 self.mailer.bounce_message(message, [self.instance.config.ADMIN_EMAIL], m)
379
c7b5b1aa6b4a More error handling fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 367
diff changeset
1533
25
4cf1daf2f2eb More Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1534 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
1535 ''' 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
1536
19686b60e410 Multipart message class has the getPart method now. Added some tests for it.
Richard Jones <richard@users.sourceforge.net>
parents: 103
diff changeset
1537 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
1538 '''
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1539 # get database handle for handling one email
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1540 self.db = self.instance.open ('admin')
4781
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1541
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1542 self.db.tx_Source = "email"
6e9b9743de89 Implementation for:
John Rouillard <rouilj@ieee.org>
parents: 4581
diff changeset
1543
4211
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1544 try:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1545 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
1546 finally:
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1547 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
1548
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1549 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
1550 ''' 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
1551
61cf00ca920a Process each message through the mail gateway as a separate transaction.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4101
diff changeset
1552 Parse the message as per the module docstring.
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1553 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
1554 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
1555 '''
4539
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1556 self.parsed_message = self.parsed_message_class(self, message)
c246f176e7bb - put all methods for parsing a message into a list...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4531
diff changeset
1557 nodeid = self.parsed_message.parse ()
1217
984c498e7deb handle stupid mailers quoting subject lines
Richard Jones <richard@users.sourceforge.net>
parents: 1209
diff changeset
1558
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1559 # commit the changes to the DB
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1560 self.db.commit()
411
a6088556e9ba Features and fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 406
diff changeset
1561
4541
62239a524beb PGP support is again working (pyme API has changed significantly)...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4540
diff changeset
1562 self.parsed_message = None
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1563 return nodeid
411
a6088556e9ba Features and fixes.
Richard Jones <richard@users.sourceforge.net>
parents: 406
diff changeset
1564
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1565 def get_class_arguments(self, class_type, classname=None):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1566 ''' class_type - a valid node class type:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1567 - 'user' refers to the author of a message
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1568 - 'issue' refers to an issue-type class (to which the
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1569 message is appended) specified in parameter classname
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1570 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
1571 the real classname used as a parameter (from previous
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1572 message-parsing steps)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1573 - 'file' specifies a file-type class
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1574 - 'msg' is the message-class
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1575 classname - the name of the current issue-type class
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1576
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1577 Parse the commandline arguments and retrieve the properties that
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1578 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
1579 per class_type (-C option).
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1580 '''
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1581 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
1582
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1583 classname = classname or class_type
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1584 cls_lookup = { 'issue' : classname }
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1585
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1586 # Allow other issue-type classes -- take the real classname from
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1587 # previous parsing-steps of the message:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1588 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
1589
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1590 # check if the clsname is valid
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1591 try:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1592 self.db.getclass(clsname)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1593 except KeyError:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1594 mailadmin = self.instance.config['ADMIN_EMAIL']
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1595 raise MailUsageError(_("""
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1596 The mail gateway is not properly set up. Please contact
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1597 %(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
1598 %(clsname)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1599 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1600
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1601 if self.arguments:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1602 # The default type on the commandline is msg
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1603 if class_type == 'msg':
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1604 current_type = class_type
3417
07c696890f55 mailgw subject parsing has configurable levels of strictness
Richard Jones <richard@users.sourceforge.net>
parents: 3415
diff changeset
1605 else:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1606 current_type = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1607
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1608 # Handle the arguments specified by the email gateway command line.
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1609 # 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
1610 # 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
1611 for option, propstring in self.arguments:
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1612 if option in ( '-C', '--class'):
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1613 current_type = propstring.strip()
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1614
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1615 if current_type != class_type:
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1616 current_type = None
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1617
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1618 elif current_type and option in ('-S', '--set'):
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1619 cls = cls_lookup.get (current_type, current_type)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1620 temp_cl = self.db.getclass(cls)
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1621 errors, props = setPropArrayFromString(self,
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1622 temp_cl, propstring.strip())
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1623
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1624 if errors:
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1625 mailadmin = self.instance.config['ADMIN_EMAIL']
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1626 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
1627 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
1628 %(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
1629 %(errors)s
5378
35ea9b1efc14 Python 3 preparation: "raise" syntax.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
1630 """) % locals())
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1631 allprops.update(props)
3922
586679a314f7 role checking for PGP mail and docs
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3917
diff changeset
1632
4468
502a1a8620e6 Tests and fixes.
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4425
diff changeset
1633 return allprops
699
676d4cfde9a5 Nosy list improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 694
diff changeset
1634
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
1635
1905
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1636 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
1637 ''' 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
1638 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
1639 '''
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1640 props = {}
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1641 errors = []
5433
86b6cea7a975 Python 3 preparation: avoid string.split().
Joseph Myers <jsm@polyomino.org.uk>
parents: 5418
diff changeset
1642 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
1643 # 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
1644 try:
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1645 propname, value = prop.split('=')
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1646 except ValueError as message:
3600
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
1647 errors.append(_('not of form [arg=value,value,...;'
1113e1456093 translate UI messages (patch [SF#1462491])
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3583
diff changeset
1648 '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
1649 return (errors, props)
1905
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1650 # 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
1651 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
1652 try:
1905
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1653 props[propname] = hyperdb.rawToHyperdb(self.db, cl, nodeid,
dc43e339e607 Centralised conversion of user-input data to hyperdb values
Richard Jones <richard@users.sourceforge.net>
parents: 1887
diff changeset
1654 propname, value)
5248
198b6e810c67 Use Python-3-compatible 'as' syntax for except statements
Eric S. Raymond <esr@thyrsus.com>
parents: 5240
diff changeset
1655 except hyperdb.HyperdbValueError as message:
2920
98e6219ddb83 merge maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2906
diff changeset
1656 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
1657 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
1658
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1659
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
1660 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
1661 '''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
1662 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
1663 '''
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1664 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
1665 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
1666 # 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
1667 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
1668 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
1669 # 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
1670 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
1671 # 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
1672 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
1673 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
1674 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
1675 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
1676
1358
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1677
e0bf31867fa5 support propety setting on message and file through web and email interface
Richard Jones <richard@users.sourceforge.net>
parents: 1347
diff changeset
1678 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
1679 ''' 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
1680
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1681 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
1682 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
1683 '''
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1684 (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
1685
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1686 # 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
1687 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
1688 if user is not None:
ed725179953d Added password reset facility for forgotten passwords.
Richard Jones <richard@users.sourceforge.net>
parents: 1462
diff changeset
1689 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
1690
502a5ae11cc5 Very close now. The cgi and mailgw now use the new security API.
Richard Jones <richard@users.sourceforge.net>
parents: 902
diff changeset
1691 # 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
1692 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
1693 if 'alternate_addresses' in props:
1249
6c24a86a12ae Fixes for SourceForge tracker bugs.
Richard Jones <richard@users.sourceforge.net>
parents: 1244
diff changeset
1694 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
1695 # 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
1696 # 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
1697 # 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
1698 found_users = []
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1699 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
1700 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
1701 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
1702 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
1703 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
1704 break
ddff9669361b Fix matching of incoming email addresses to the alternate_addresses field...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4505
diff changeset
1705 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
1706 if user is not None:
ed725179953d Added password reset facility for forgotten passwords.
Richard Jones <richard@users.sourceforge.net>
parents: 1462
diff changeset
1707 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
1708
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 # 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
1710 # 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
1711 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
1712
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 # 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
1714 if create:
1592
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1715 # generate a username
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1716 if '@' in address:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1717 username = address.split('@')[0]
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1718 else:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1719 username = address
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1720 trying = username
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1721 n = 0
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1722 while 1:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1723 try:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1724 # does this username exist already?
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1725 db.user.lookup(trying)
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1726 except KeyError:
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1727 break
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1728 n += 1
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1729 trying = username + str(n)
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1730
4074e2336eed fixes to unit tests for recent changes
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
1731 # create!
2129
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1732 try:
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1733 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
1734 realname=realname, roles=db.config.NEW_EMAIL_USER_ROLES,
4486
693c75d56ebe Add new config-option 'password_pbkdf2_default_rounds'...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4477
diff changeset
1735 password=password.Password(password.generatePassword(), config=db.config),
2129
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1736 **user_props)
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1737 except exceptions.Reject:
3fd672293712 add and use Reject exception [SF#700265]
Richard Jones <richard@users.sourceforge.net>
parents: 2123
diff changeset
1738 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
1739 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
1740 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
1741
5117
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1742 def parseContent(content, keep_citations=None, keep_body=None, 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
1743 """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
1744
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1745 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
1746 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
1747 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
1748 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
1749
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1750 Arguments:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1751
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1752 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
1753 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
1754
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1755 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
1756 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
1757
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1758 config: tracker configuration object.
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1759 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
1760
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1761 """
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1762 if config is None:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1763 config = configuration.CoreConfig()
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1764 if keep_citations is None:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1765 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
1766 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
1767 # 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
1768 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
1769 keep_citations = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1770 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1771 keep_citations = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1772 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
1773 keep_citations = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1774 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1775 keep_citations = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1776
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1777 if keep_body is None:
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1778 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
1779 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
1780 # 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
1781 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
1782 keep_body = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1783 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1784 keep_body = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1785 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
1786 keep_body = True
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1787 else:
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1788 keep_body = False
14abd0a67207 Fix issue934009: Have New Issues Submitted By Email *Not* Change Body!
John Rouillard <rouilj@ieee.org>
parents: 5085
diff changeset
1789
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1790 eol = config["MAILGW_EOL_RE"]
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1791 signature = config["MAILGW_SIGN_RE"]
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1792 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
1793
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1794 # strip off leading carriage-returns / newlines
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1795 i = 0
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1796 for i in range(len(content)):
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1797 if content[i] not in '\r\n':
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1798 break
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1799 if i > 0:
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1800 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
1801 else:
3836
5bc54cb1d5d0 parseContent API modified to take single config argument
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3833
diff changeset
1802 sections = config["MAILGW_BLANKLINE_RE"].split(content)
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1803
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1804 # 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
1805 summary = ''
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1806 l = []
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1807 # find last non-empty section for signature matching
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1808 last_nonempty = len(sections) -1
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1809 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
1810 last_nonempty -= 1
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1811 for ns, section in enumerate(sections):
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 321
diff changeset
1812 #section = section.strip()
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1813 if not section:
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1814 continue
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1815 lines = eol.split(section)
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1816 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
1817 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
1818 if quote_1st or quote_2nd:
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1819 # 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
1820 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
1821 # 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
1822 if not lines[0].endswith(':'):
f1d6e2b2eb64 Fix quote-stripping in mail gateway again.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4580
diff changeset
1823 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
1824 # 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
1825 # 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
1826 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
1827 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
1828 break
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1829 else:
694
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1830 # 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
1831 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
1832 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
1833 continue
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1834 # 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
1835 if not keep_citations:
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1836 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
1837 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
1838
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1839 is_last = ns == last_nonempty
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1840 # 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
1841 # our summary
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1842 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
1843 # 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
1844 # section
1299
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1845 summary = section
4579
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1846 # match signature only in last section
ba4c632143f6 issue2550535 Fix keep_quoted_text=yes setting.
Ralf Schlatterbeck <rsc@runtux.com>
parents: 4575
diff changeset
1847 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
1848 # lose any signature
7ba403bffed5 Tweaking the signature deletion from mail messages.
Richard Jones <richard@users.sourceforge.net>
parents: 699
diff changeset
1849 break
1344
f2f553611ce0 applied patches for handling Outlook quirks...
Richard Jones <richard@users.sourceforge.net>
parents: 1329
diff changeset
1850 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
1851 # ditch the stupid Outlook quoting of the entire original message
454
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 453
diff changeset
1852 break
510
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1853
3f6107488465 followup lines directly after a quoted section were being eaten.
Richard Jones <richard@users.sourceforge.net>
parents: 499
diff changeset
1854 # 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
1855 l.append(section)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1856
1299
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1857 # figure the summary - find the first sentence-ending punctuation or the
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1858 # first whole line, whichever is longest
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1859 sentence = re.search(r'^([^!?\.]+[!?\.])', summary)
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1860 if sentence:
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1861 sentence = sentence.group(1)
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1862 else:
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1863 sentence = ''
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1864 first = eol.split(summary)[0]
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1865 summary = max(sentence, first)
b2d04ce03802 Email improvements.
Richard Jones <richard@users.sourceforge.net>
parents: 1294
diff changeset
1866
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1867 # 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
1868 # about.
694
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1869 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
1870 content = '\n\n'.join(l)
1107
1c1ccfc9673d reorganised mailgw code
Richard Jones <richard@users.sourceforge.net>
parents: 1103
diff changeset
1871
694
34dbcdfb2fe1 stripping of email message body can be controlled through config variables...
Roche Compaan <rochecompaan@users.sourceforge.net>
parents: 661
diff changeset
1872 return summary, content
198
eda506860b32 Implemented correct mail splitting (was taking a shortcut).
Richard Jones <richard@users.sourceforge.net>
parents: 172
diff changeset
1873
2631
2bbcfc80ba5b MailGW.handle_message():
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2571
diff changeset
1874 # vim: set filetype=python sts=4 sw=4 et si :

Roundup Issue Tracker: http://roundup-tracker.org/