This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10471

mail: split out the SMTP login to allow the keyring extension to wrap it
ClosedPublic

Authored by mharbison72 on Apr 19 2021, 7:40 PM.

Details

Reviewers
marmoute
Group Reviewers
hg-reviewers
Commits
rHG83c0d144ef8d: mail: split out the SMTP login to allow the keyring extension to wrap it
Summary

The keyring extension only needs to tweak this tiny section of the larger
function. But without any place to intercept the username/password fetching, it
copy/pasted the entire function, and has grown a bunch of compatibility hacks to
support older versions of Mercurial as well.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

mharbison72 created this revision.Apr 19 2021, 7:40 PM
marmoute accepted this revision.Apr 20 2021, 5:38 AM
mharbison72 added a commit: rHG83c0d144ef8d: mail: split out the SMTP login to allow the keyring extension to wrap it.Apr 20 2021, 10:23 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG83c0d144ef8d: mail: split out the SMTP login to allow the keyring extension to wrap it (authored by mharbison72). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/mail.py (42 lines)

Diff 27124

mercurial/mail.py

if starttls: if starttls:
ui.note(_(b'(using starttls)\n')) ui.note(_(b'(using starttls)\n'))
s.ehlo() s.ehlo()
s.starttls() s.starttls()
s.ehlo() s.ehlo()
if starttls or smtps: if starttls or smtps:
ui.note(_(b'(verifying remote certificate)\n')) ui.note(_(b'(verifying remote certificate)\n'))
sslutil.validatesocket(s.sock) sslutil.validatesocket(s.sock)
username = ui.config(b'smtp', b'username')
password = ui.config(b'smtp', b'password')
if username:
if password:
password = encoding.strfromlocal(password)
else:
password = ui.getpass()
if password is not None:
password = encoding.strfromlocal(password)
if username and password:
ui.note(_(b'(authenticating to mail server as %s)\n') % username)
username = encoding.strfromlocal(username)
try: try:
s.login(username, password) _smtp_login(ui, s, mailhost, mailport)
except smtplib.SMTPException as inst: except smtplib.SMTPException as inst:
raise error.Abort(stringutil.forcebytestr(inst)) raise error.Abort(stringutil.forcebytestr(inst))
def send(sender, recipients, msg): def send(sender, recipients, msg):
try: try:
return s.sendmail(sender, recipients, msg) return s.sendmail(sender, recipients, msg)
except smtplib.SMTPRecipientsRefused as inst: except smtplib.SMTPRecipientsRefused as inst:
recipients = [r[1] for r in inst.recipients.values()] recipients = [r[1] for r in inst.recipients.values()]
raise error.Abort(b'\n' + b'\n'.join(recipients)) raise error.Abort(b'\n' + b'\n'.join(recipients))
except smtplib.SMTPException as inst: except smtplib.SMTPException as inst:
raise error.Abort(inst) raise error.Abort(inst)
return send return send
def _smtp_login(ui, smtp, mailhost, mailport):
"""A hook for the keyring extension to perform the actual SMTP login.
An already connected SMTP object of the proper type is provided, based on
the current configuration. The host and port to which the connection was
established are provided for accessibility, since the SMTP object doesn't
provide an accessor. ``smtplib.SMTPException`` is raised on error.
"""
username = ui.config(b'smtp', b'username')
password = ui.config(b'smtp', b'password')
if username:
if password:
password = encoding.strfromlocal(password)
else:
password = ui.getpass()
if password is not None:
password = encoding.strfromlocal(password)
if username and password:
ui.note(_(b'(authenticating to mail server as %s)\n') % username)
username = encoding.strfromlocal(username)
smtp.login(username, password)
def _sendmail(ui, sender, recipients, msg): def _sendmail(ui, sender, recipients, msg):
'''send mail using sendmail.''' '''send mail using sendmail.'''
program = ui.config(b'email', b'method') program = ui.config(b'email', b'method')
def stremail(x): def stremail(x):
return procutil.shellquote(stringutil.email(encoding.strtolocal(x))) return procutil.shellquote(stringutil.email(encoding.strtolocal(x)))
cmdline = b'%s -f %s %s' % ( cmdline = b'%s -f %s %s' % (