Skip to content

gh-79986: Add parsing for References/In-Reply-To email headers #137201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions Lib/email/_header_value_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,12 @@ class MessageID(MsgID):
class InvalidMessageID(MessageID):
token_type = 'invalid-message-id'

class MessageIDList(TokenList):
token_type = 'message-id-list'

@property
def message_ids(self):
return [x for x in self if x.token_type=='msg-id']

class Header(TokenList):
token_type = 'header'
Expand Down Expand Up @@ -2171,6 +2177,32 @@ def parse_message_id(value):

return message_id

def parse_message_ids(value):
"""in-reply-to = "In-Reply-To:" 1*msg-id CRLF
references = "References:" 1*msg-id CRLF
"""
message_ids = MessageIDList()
while value:
# message id list separated with commas - this is invalid,
# but happens rather frequently in the wild
if value and value[0] == ',':
message_ids.defects.append(
errors.InvalidHeaderDefect("msg-id separated with comma"))
value = value[1:]
continue

try:
token, value = get_msg_id(value)
message_ids.append(token)
except errors.HeaderParseError as ex:
token = get_unstructured(value)
message_ids.append(InvalidMessageID(token))
message_ids.defects.append(
errors.InvalidHeaderDefect("Invalid msg-id: {!r}".format(ex)))
break

return message_ids

#
# XXX: As I begin to add additional header parsers, I'm realizing we probably
# have two level of parser routines: the get_XXX methods that get a token in
Expand Down
14 changes: 14 additions & 0 deletions Lib/email/headerregistry.py
Original file line number Diff line number Diff line change
Expand Up @@ -534,6 +534,18 @@ def parse(cls, value, kwds):
kwds['defects'].extend(parse_tree.all_defects)


class ReferencesHeader:

max_count = 1
value_parser = staticmethod(parser.parse_message_ids)

@classmethod
def parse(cls, value, kwds):
kwds['parse_tree'] = parse_tree = cls.value_parser(value)
kwds['decoded'] = ' '.join((str(i) for i in parse_tree.message_ids))
kwds['defects'].extend(parse_tree.all_defects)


# The header factory #

_default_header_map = {
Expand All @@ -557,6 +569,8 @@ def parse(cls, value, kwds):
'content-disposition': ContentDispositionHeader,
'content-transfer-encoding': ContentTransferEncodingHeader,
'message-id': MessageIDHeader,
'in-reply-to': ReferencesHeader,
'references': ReferencesHeader,
}

class HeaderRegistry:
Expand Down
63 changes: 63 additions & 0 deletions Lib/test/test_email/test__header_value_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -2867,6 +2867,69 @@ def test_get_msg_id_ws_only_local(self):
)
self.assertEqual(msg_id.token_type, 'msg-id')

def test_parse_message_ids_valid(self):
message_ids = self._test_parse_x(
parser.parse_message_ids,
"<foo@bar> <bar@foo>",
"<foo@bar> <bar@foo>",
"<foo@bar> <bar@foo>",
[],
)
self.assertEqual(message_ids.token_type, 'message-id-list')

def test_parse_message_ids_empty(self):
message_ids = self._test_parse_x(
parser.parse_message_ids,
" ",
" ",
" ",
[errors.InvalidHeaderDefect],
)
self.assertEqual(message_ids.token_type, 'message-id-list')

def test_parse_message_ids_comment(self):
message_ids = self._test_parse_x(
parser.parse_message_ids,
"<foo@bar> (foo's message from \"bar\")",
"<foo@bar> (foo's message from \"bar\")",
"<foo@bar> ",
[],
)
self.assertEqual(message_ids.message_ids[0].value, '<foo@bar> ')
self.assertEqual(message_ids.token_type, 'message-id-list')

def test_parse_message_ids_comma_sep(self):
message_ids = self._test_parse_x(
parser.parse_message_ids,
"<foo@bar>,<bar@foo>",
"<foo@bar><bar@foo>",
"<foo@bar><bar@foo>",
[errors.InvalidHeaderDefect],
)
self.assertEqual(message_ids.message_ids[0].value, '<foo@bar>')
self.assertEqual(message_ids.message_ids[1].value, '<bar@foo>')
self.assertEqual(message_ids.token_type, 'message-id-list')

def test_parse_message_ids_invalid_id(self):
message_ids = self._test_parse_x(
parser.parse_message_ids,
"<Date: Wed, 08 Jun 2002 09:78:58 +0600>",
"<Date: Wed, 08 Jun 2002 09:78:58 +0600>",
"<Date: Wed, 08 Jun 2002 09:78:58 +0600>",
[errors.InvalidHeaderDefect]*2,
)
self.assertEqual(message_ids.token_type, 'message-id-list')

def test_parse_message_ids_broken_ang(self):
message_ids = self._test_parse_x(
parser.parse_message_ids,
"<foo@bar> >bar@foo",
"<foo@bar> >bar@foo",
"<foo@bar> >bar@foo",
[errors.InvalidHeaderDefect]*1,
)
self.assertEqual(message_ids.token_type, 'message-id-list')



@parameterize
Expand Down
13 changes: 13 additions & 0 deletions Lib/test/test_email/test_headerregistry.py
Original file line number Diff line number Diff line change
Expand Up @@ -1812,5 +1812,18 @@ def test_message_id_header_is_not_folded(self):
h.fold(policy=policy.default.clone(max_line_length=20)),
'Message-ID:\n <ईमेलfromMessage@wők.com>\n')

def test_fold_references(self):
h = self.make_header(
'References',
'<referenceid1thatislongerthan@maxlinelength.com> '
'<referenceid2thatislongerthan@maxlinelength.com>'
)
self.assertEqual(
h.fold(policy=policy.default.clone(max_line_length=20)),
'References: '
'<referenceid1thatislongerthan@maxlinelength.com>\n'
' <referenceid2thatislongerthan@maxlinelength.com>\n')


if __name__ == '__main__':
unittest.main()
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add parsing for References/In-Reply-To email headers, preventing them from
being folded.
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy