mail.py
461 lines
| 14.8 KiB
| text/x-python
|
PythonLexer
/ mercurial / mail.py
|
r2889 | # mail.py - mail sending bits for mercurial | ||
# | ||||
# Copyright 2006 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r2889 | |||
|
r30325 | from __future__ import absolute_import | ||
|
r25957 | |||
|
r19790 | import email | ||
|
r30089 | import email.charset | ||
|
r30072 | import email.header | ||
|
r34311 | import email.message | ||
|
r38354 | import email.parser | ||
import io | ||||
|
r25957 | import os | ||
import smtplib | ||||
import socket | ||||
import time | ||||
from .i18n import _ | ||||
from . import ( | ||||
encoding, | ||||
|
r26587 | error, | ||
|
r36064 | pycompat, | ||
|
r25957 | sslutil, | ||
util, | ||||
) | ||||
|
r37102 | from .utils import ( | ||
|
r37138 | procutil, | ||
|
r37102 | stringutil, | ||
) | ||||
|
r2889 | |||
|
r43346 | |||
|
r18885 | class STARTTLS(smtplib.SMTP): | ||
'''Derived class to verify the peer certificate for STARTTLS. | ||||
This class allows to pass any keyword arguments to SSL socket creation. | ||||
''' | ||||
|
r43346 | |||
|
r29251 | def __init__(self, ui, host=None, **kwargs): | ||
|
r18885 | smtplib.SMTP.__init__(self, **kwargs) | ||
|
r29248 | self._ui = ui | ||
|
r28935 | self._host = host | ||
|
r18885 | |||
def starttls(self, keyfile=None, certfile=None): | ||||
|
r43347 | if not self.has_extn(b"starttls"): | ||
msg = b"STARTTLS extension not supported by server" | ||||
|
r18885 | raise smtplib.SMTPException(msg) | ||
|
r43347 | (resp, reply) = self.docmd(b"STARTTLS") | ||
|
r18885 | if resp == 220: | ||
|
r43346 | self.sock = sslutil.wrapsocket( | ||
self.sock, | ||||
keyfile, | ||||
certfile, | ||||
ui=self._ui, | ||||
serverhostname=self._host, | ||||
) | ||||
|
r18885 | self.file = smtplib.SSLFakeFile(self.sock) | ||
self.helo_resp = None | ||||
self.ehlo_resp = None | ||||
self.esmtp_features = {} | ||||
self.does_esmtp = 0 | ||||
return (resp, reply) | ||||
|
r43346 | |||
|
r26673 | class SMTPS(smtplib.SMTP): | ||
'''Derived class to verify the peer certificate for SMTPS. | ||||
|
r18886 | |||
|
r26673 | This class allows to pass any keyword arguments to SSL socket creation. | ||
''' | ||||
|
r43346 | |||
def __init__(self, ui, keyfile=None, certfile=None, host=None, **kwargs): | ||||
|
r26673 | self.keyfile = keyfile | ||
self.certfile = certfile | ||||
smtplib.SMTP.__init__(self, **kwargs) | ||||
|
r28935 | self._host = host | ||
|
r26673 | self.default_port = smtplib.SMTP_SSL_PORT | ||
|
r29248 | self._ui = ui | ||
|
r26673 | |||
def _get_socket(self, host, port, timeout): | ||||
if self.debuglevel > 0: | ||||
|
r43347 | self._ui.debug(b'connect: %r\n' % ((host, port),)) | ||
|
r26673 | new_socket = socket.create_connection((host, port), timeout) | ||
|
r43346 | new_socket = sslutil.wrapsocket( | ||
new_socket, | ||||
self.keyfile, | ||||
self.certfile, | ||||
ui=self._ui, | ||||
serverhostname=self._host, | ||||
) | ||||
|
r39061 | self.file = new_socket.makefile(r'rb') | ||
|
r26673 | return new_socket | ||
|
r18886 | |||
|
r43346 | |||
|
r39060 | def _pyhastls(): | ||
"""Returns true iff Python has TLS support, false otherwise.""" | ||||
try: | ||||
import ssl | ||||
|
r43346 | |||
|
r39060 | getattr(ssl, 'HAS_TLS', False) | ||
return True | ||||
except ImportError: | ||||
return False | ||||
|
r43346 | |||
|
r2889 | def _smtp(ui): | ||
|
r5973 | '''build an smtp connection and return a function to send mail''' | ||
|
r43347 | local_hostname = ui.config(b'smtp', b'local_hostname') | ||
tls = ui.config(b'smtp', b'tls') | ||||
|
r13201 | # backward compatible: when tls = true, we use starttls. | ||
|
r43347 | starttls = tls == b'starttls' or stringutil.parsebool(tls) | ||
smtps = tls == b'smtps' | ||||
|
r39060 | if (starttls or smtps) and not _pyhastls(): | ||
|
r43347 | raise error.Abort(_(b"can't use TLS: Python SSL support not installed")) | ||
mailhost = ui.config(b'smtp', b'host') | ||||
|
r2889 | if not mailhost: | ||
|
r43347 | raise error.Abort(_(b'smtp.host not configured - cannot send mail')) | ||
|
r18888 | if smtps: | ||
|
r43347 | ui.note(_(b'(using smtps)\n')) | ||
|
r29251 | s = SMTPS(ui, local_hostname=local_hostname, host=mailhost) | ||
|
r18888 | elif starttls: | ||
|
r29251 | s = STARTTLS(ui, local_hostname=local_hostname, host=mailhost) | ||
|
r18888 | else: | ||
s = smtplib.SMTP(local_hostname=local_hostname) | ||||
|
r19050 | if smtps: | ||
defaultport = 465 | ||||
else: | ||||
defaultport = 25 | ||||
|
r43347 | mailport = util.getport(ui.config(b'smtp', b'port', defaultport)) | ||
ui.note(_(b'sending mail: smtp host %s, port %d\n') % (mailhost, mailport)) | ||||
|
r2889 | s.connect(host=mailhost, port=mailport) | ||
|
r13201 | if starttls: | ||
|
r43347 | ui.note(_(b'(using starttls)\n')) | ||
|
r2889 | s.ehlo() | ||
s.starttls() | ||||
s.ehlo() | ||||
|
r29285 | if starttls or smtps: | ||
|
r43347 | ui.note(_(b'(verifying remote certificate)\n')) | ||
|
r29285 | sslutil.validatesocket(s.sock) | ||
|
r43347 | username = ui.config(b'smtp', b'username') | ||
password = ui.config(b'smtp', b'password') | ||||
|
r5749 | if username and not password: | ||
password = ui.getpass() | ||||
|
r2889 | if username and password: | ||
|
r43347 | ui.note(_(b'(authenticating to mail server as %s)\n') % username) | ||
|
r9246 | try: | ||
s.login(username, password) | ||||
|
r25660 | except smtplib.SMTPException as inst: | ||
|
r26587 | raise error.Abort(inst) | ||
|
r2889 | |||
|
r5973 | def send(sender, recipients, msg): | ||
try: | ||||
return s.sendmail(sender, recipients, msg) | ||||
|
r25660 | except smtplib.SMTPRecipientsRefused as inst: | ||
|
r5973 | recipients = [r[1] for r in inst.recipients.values()] | ||
|
r43347 | raise error.Abort(b'\n' + b'\n'.join(recipients)) | ||
|
r25660 | except smtplib.SMTPException as inst: | ||
|
r26587 | raise error.Abort(inst) | ||
|
r5947 | |||
|
r5973 | return send | ||
|
r5947 | |||
|
r43346 | |||
|
r5973 | def _sendmail(ui, sender, recipients, msg): | ||
'''send mail using sendmail.''' | ||||
|
r43347 | program = ui.config(b'email', b'method') | ||
|
r43289 | stremail = lambda x: ( | ||
|
r43346 | procutil.quote(stringutil.email(encoding.strtolocal(x))) | ||
) | ||||
|
r43347 | cmdline = b'%s -f %s %s' % ( | ||
|
r43346 | program, | ||
stremail(sender), | ||||
|
r43347 | b' '.join(map(stremail, recipients)), | ||
|
r43346 | ) | ||
|
r43347 | ui.note(_(b'sending mail: %s\n') % cmdline) | ||
fp = procutil.popen(cmdline, b'wb') | ||||
|
r37476 | fp.write(util.tonativeeol(msg)) | ||
|
r5973 | ret = fp.close() | ||
if ret: | ||||
|
r43346 | raise error.Abort( | ||
|
r43347 | b'%s %s' | ||
|
r43346 | % ( | ||
os.path.basename(program.split(None, 1)[0]), | ||||
procutil.explainexit(ret), | ||||
) | ||||
) | ||||
|
r2889 | |||
|
r15560 | def _mbox(mbox, sender, recipients, msg): | ||
'''write mails to mbox''' | ||||
|
r43347 | fp = open(mbox, b'ab+') | ||
|
r15560 | # Should be time.asctime(), but Windows prints 2-characters day | ||
# of month instead of one. Make them print the same thing. | ||||
|
r35152 | date = time.strftime(r'%a %b %d %H:%M:%S %Y', time.localtime()) | ||
|
r43346 | fp.write( | ||
|
r43347 | b'From %s %s\n' | ||
|
r43346 | % (encoding.strtolocal(sender), encoding.strtolocal(date)) | ||
) | ||||
|
r15560 | fp.write(msg) | ||
|
r43347 | fp.write(b'\n\n') | ||
|
r15560 | fp.close() | ||
|
r43346 | |||
|
r15560 | def connect(ui, mbox=None): | ||
|
r5973 | '''make a mail connection. return a function to send mail. | ||
|
r2889 | call as sendmail(sender, list-of-recipients, msg).''' | ||
|
r15560 | if mbox: | ||
|
r43347 | open(mbox, b'wb').close() | ||
|
r15560 | return lambda s, r, m: _mbox(mbox, s, r, m) | ||
|
r43347 | if ui.config(b'email', b'method') == b'smtp': | ||
|
r5947 | return _smtp(ui) | ||
|
r5973 | return lambda s, r, m: _sendmail(ui, s, r, m) | ||
|
r2889 | |||
|
r43346 | |||
|
r15561 | def sendmail(ui, sender, recipients, msg, mbox=None): | ||
send = connect(ui, mbox=mbox) | ||||
|
r5973 | return send(sender, recipients, msg) | ||
|
r4489 | |||
|
r43346 | |||
|
r4489 | def validateconfig(ui): | ||
'''determine if we have enough config data to try sending email.''' | ||||
|
r43347 | method = ui.config(b'email', b'method') | ||
if method == b'smtp': | ||||
if not ui.config(b'smtp', b'host'): | ||||
|
r43346 | raise error.Abort( | ||
_( | ||||
|
r43347 | b'smtp specified as email transport, ' | ||
b'but no smtp host configured' | ||||
|
r43346 | ) | ||
) | ||||
|
r4489 | else: | ||
|
r37138 | if not procutil.findexe(method): | ||
|
r43346 | raise error.Abort( | ||
|
r43347 | _(b'%r specified as email transport, ' b'but not in PATH') | ||
|
r43346 | % method | ||
) | ||||
|
r7114 | |||
|
r30089 | def codec2iana(cs): | ||
'''''' | ||||
|
r36136 | cs = pycompat.sysbytes(email.charset.Charset(cs).input_charset.lower()) | ||
|
r30089 | |||
# "latin1" normalizes to "iso8859-1", standard calls for "iso-8859-1" | ||||
|
r43347 | if cs.startswith(b"iso") and not cs.startswith(b"iso-"): | ||
return b"iso-" + cs[3:] | ||||
|
r30089 | return cs | ||
|
r43346 | |||
|
r43347 | def mimetextpatch(s, subtype=b'plain', display=False): | ||
|
r15562 | '''Return MIME message suitable for a patch. | ||
|
r30089 | Charset will be detected by first trying to decode as us-ascii, then utf-8, | ||
and finally the global encodings. If all those fail, fall back to | ||||
ISO-8859-1, an encoding with that allows all byte sequences. | ||||
|
r15562 | Transfer encodings will be used if necessary.''' | ||
|
r8332 | |||
|
r43347 | cs = [b'us-ascii', b'utf-8', encoding.encoding, encoding.fallbackencoding] | ||
|
r30089 | if display: | ||
|
r43347 | cs = [b'us-ascii'] | ||
|
r30089 | for charset in cs: | ||
|
r8332 | try: | ||
|
r36135 | s.decode(pycompat.sysstr(charset)) | ||
|
r30089 | return mimetextqp(s, subtype, codec2iana(charset)) | ||
|
r8332 | except UnicodeDecodeError: | ||
|
r30089 | pass | ||
|
r8332 | |||
|
r43347 | return mimetextqp(s, subtype, b"iso-8859-1") | ||
|
r15562 | |||
|
r43346 | |||
|
r15562 | def mimetextqp(body, subtype, charset): | ||
'''Return MIME message. | ||||
|
r17424 | Quoted-printable transfer encoding will be used if necessary. | ||
|
r15562 | ''' | ||
|
r34311 | cs = email.charset.Charset(charset) | ||
msg = email.message.Message() | ||||
|
r43347 | msg.set_type(pycompat.sysstr(b'text/' + subtype)) | ||
|
r34311 | |||
|
r15562 | for line in body.splitlines(): | ||
if len(line) > 950: | ||||
|
r34311 | cs.body_encoding = email.charset.QP | ||
|
r15562 | break | ||
|
r41450 | # On Python 2, this simply assigns a value. Python 3 inspects | ||
# body and does different things depending on whether it has | ||||
# encode() or decode() attributes. We can get the old behavior | ||||
# if we pass a str and charset is None and we call set_charset(). | ||||
# But we may get into trouble later due to Python attempting to | ||||
# encode/decode using the registered charset (or attempting to | ||||
# use ascii in the absence of a charset). | ||||
|
r34311 | msg.set_payload(body, cs) | ||
|
r8332 | return msg | ||
|
r7191 | |||
|
r43346 | |||
|
r7114 | def _charsets(ui): | ||
'''Obtains charsets to send mail parts not containing patches.''' | ||||
|
r43347 | charsets = [cs.lower() for cs in ui.configlist(b'email', b'charsets')] | ||
|
r43346 | fallbacks = [ | ||
encoding.fallbackencoding.lower(), | ||||
encoding.encoding.lower(), | ||||
|
r43347 | b'utf-8', | ||
|
r43346 | ] | ||
for cs in fallbacks: # find unique charsets while keeping order | ||||
|
r7114 | if cs not in charsets: | ||
charsets.append(cs) | ||||
|
r43347 | return [cs for cs in charsets if not cs.endswith(b'ascii')] | ||
|
r7114 | |||
|
r43346 | |||
|
r7114 | def _encode(ui, s, charsets): | ||
'''Returns (converted) string, charset tuple. | ||||
Finds out best charset by cycling through sendcharsets in descending | ||||
|
r7948 | order. Tries both encoding and fallbackencoding for input. Only as | ||
|
r7114 | last resort send as is in fake ascii. | ||
Caveat: Do not use for mail parts containing patches!''' | ||||
|
r39058 | sendcharsets = charsets or _charsets(ui) | ||
if not isinstance(s, bytes): | ||||
# We have unicode data, which we need to try and encode to | ||||
# some reasonable-ish encoding. Try the encodings the user | ||||
# wants, and fall back to garbage-in-ascii. | ||||
for ocs in sendcharsets: | ||||
try: | ||||
return s.encode(pycompat.sysstr(ocs)), ocs | ||||
except UnicodeEncodeError: | ||||
pass | ||||
except LookupError: | ||||
|
r43347 | ui.warn(_(b'ignoring invalid sendcharset: %s\n') % ocs) | ||
|
r39058 | else: | ||
# Everything failed, ascii-armor what we've got and send it. | ||||
return s.encode('ascii', 'backslashreplace') | ||||
# We have a bytes of unknown encoding. We'll try and guess a valid | ||||
# encoding, falling back to pretending we had ascii even though we | ||||
# know that's wrong. | ||||
|
r7114 | try: | ||
s.decode('ascii') | ||||
except UnicodeDecodeError: | ||||
|
r7948 | for ics in (encoding.encoding, encoding.fallbackencoding): | ||
|
r7114 | try: | ||
u = s.decode(ics) | ||||
except UnicodeDecodeError: | ||||
continue | ||||
for ocs in sendcharsets: | ||||
try: | ||||
|
r39058 | return u.encode(pycompat.sysstr(ocs)), ocs | ||
|
r7114 | except UnicodeEncodeError: | ||
pass | ||||
except LookupError: | ||||
|
r43347 | ui.warn(_(b'ignoring invalid sendcharset: %s\n') % ocs) | ||
|
r7114 | # if ascii, or all conversion attempts fail, send (broken) ascii | ||
|
r43347 | return s, b'us-ascii' | ||
|
r7114 | |||
|
r43346 | |||
|
r7114 | def headencode(ui, s, charsets=None, display=False): | ||
'''Returns RFC-2047 compliant header from given string.''' | ||||
if not display: | ||||
# split into words? | ||||
s, cs = _encode(ui, s, charsets) | ||||
|
r30072 | return str(email.header.Header(s, cs)) | ||
|
r7114 | return s | ||
|
r43346 | |||
|
r9948 | def _addressencode(ui, name, addr, charsets=None): | ||
|
r39142 | assert isinstance(addr, bytes) | ||
|
r7114 | name = headencode(ui, name, charsets) | ||
try: | ||||
|
r43347 | acc, dom = addr.split(b'@') | ||
|
r39143 | acc.decode('ascii') | ||
|
r39144 | dom = dom.decode(pycompat.sysstr(encoding.encoding)).encode('idna') | ||
|
r43347 | addr = b'%s@%s' % (acc, dom) | ||
|
r7114 | except UnicodeDecodeError: | ||
|
r43347 | raise error.Abort(_(b'invalid email address: %s') % addr) | ||
|
r7114 | except ValueError: | ||
try: | ||||
# too strict? | ||||
|
r39143 | addr.decode('ascii') | ||
|
r7114 | except UnicodeDecodeError: | ||
|
r43347 | raise error.Abort(_(b'invalid local address: %s') % addr) | ||
|
r39059 | return pycompat.bytesurl( | ||
|
r43346 | email.utils.formataddr((name, encoding.strfromlocal(addr))) | ||
) | ||||
|
r7114 | |||
|
r9948 | def addressencode(ui, address, charsets=None, display=False): | ||
'''Turns address into RFC-2047 compliant header.''' | ||||
if display or not address: | ||||
|
r43347 | return address or b'' | ||
|
r39059 | name, addr = email.utils.parseaddr(encoding.strfromlocal(address)) | ||
|
r39142 | return _addressencode(ui, name, encoding.strtolocal(addr), charsets) | ||
|
r9948 | |||
|
r43346 | |||
|
r9948 | def addrlistencode(ui, addrs, charsets=None, display=False): | ||
'''Turns a list of addresses into a list of RFC-2047 compliant headers. | ||||
A single element of input list may contain multiple addresses, but output | ||||
always has one address per item''' | ||||
|
r39059 | for a in addrs: | ||
|
r43346 | assert isinstance(a, bytes), r'%r unexpectedly not a bytestr' % a | ||
|
r9948 | if display: | ||
return [a.strip() for a in addrs if a.strip()] | ||||
result = [] | ||||
|
r39059 | for name, addr in email.utils.getaddresses( | ||
|
r43346 | [encoding.strfromlocal(a) for a in addrs] | ||
): | ||||
|
r9948 | if name or addr: | ||
|
r39142 | r = _addressencode(ui, name, encoding.strtolocal(addr), charsets) | ||
result.append(r) | ||||
|
r39141 | return result | ||
|
r9948 | |||
|
r43346 | |||
|
r7114 | def mimeencode(ui, s, charsets=None, display=False): | ||
'''creates mime text object, encodes it if needed, and sets | ||||
charset and transfer-encoding accordingly.''' | ||||
|
r43347 | cs = b'us-ascii' | ||
|
r7114 | if not display: | ||
s, cs = _encode(ui, s, charsets) | ||||
|
r43347 | return mimetextqp(s, b'plain', cs) | ||
|
r28341 | |||
|
r43346 | |||
|
r38354 | if pycompat.ispy3: | ||
|
r43346 | |||
|
r38354 | def parse(fp): | ||
ep = email.parser.Parser() | ||||
# disable the "universal newlines" mode, which isn't binary safe. | ||||
# I have no idea if ascii/surrogateescape is correct, but that's | ||||
# what the standard Python email parser does. | ||||
|
r43346 | fp = io.TextIOWrapper( | ||
fp, encoding=r'ascii', errors=r'surrogateescape', newline=chr(10) | ||||
) | ||||
|
r38354 | try: | ||
return ep.parse(fp) | ||||
finally: | ||||
fp.detach() | ||||
|
r43346 | |||
|
r38354 | else: | ||
|
r43346 | |||
|
r38354 | def parse(fp): | ||
ep = email.parser.Parser() | ||||
return ep.parse(fp) | ||||
|
r43346 | |||
|
r28341 | def headdecode(s): | ||
'''Decodes RFC-2047 header''' | ||||
uparts = [] | ||||
|
r30072 | for part, charset in email.header.decode_header(s): | ||
|
r28341 | if charset is not None: | ||
try: | ||||
uparts.append(part.decode(charset)) | ||||
continue | ||||
except UnicodeDecodeError: | ||||
pass | ||||
|
r37487 | # On Python 3, decode_header() may return either bytes or unicode | ||
# depending on whether the header has =?<charset>? or not | ||||
if isinstance(part, type(u'')): | ||||
uparts.append(part) | ||||
continue | ||||
|
r28341 | try: | ||
uparts.append(part.decode('UTF-8')) | ||||
continue | ||||
except UnicodeDecodeError: | ||||
pass | ||||
uparts.append(part.decode('ISO-8859-1')) | ||||
|
r31447 | return encoding.unitolocal(u' '.join(uparts)) | ||