diff options
author | Konstantin Ryabitsev <konstantin@linuxfoundation.org> | 2022-08-19 15:46:57 -0400 |
---|---|---|
committer | Konstantin Ryabitsev <konstantin@linuxfoundation.org> | 2022-08-19 15:46:57 -0400 |
commit | 1c51bebcfa329b2fb9cfae1107427399698817c5 (patch) | |
tree | 429124cb2cf81f75c297185d89466c0899f69a0e /b4 | |
parent | 224a5d15dec8691a45d5ba1ead5dea522f9b9e60 (diff) | |
download | b4-1c51bebcfa329b2fb9cfae1107427399698817c5.tar.gz |
ez: implement large chunk of web endpoint submission
This implements most of the web endpoint submission functionality.
Completely undocumented and needs a lot more testing before it's useful,
but we're getting close.
Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Diffstat (limited to 'b4')
-rw-r--r-- | b4/__init__.py | 160 | ||||
-rw-r--r-- | b4/ez.py | 64 | ||||
-rw-r--r-- | b4/mbox.py | 1 | ||||
-rw-r--r-- | b4/ty.py | 2 |
4 files changed, 139 insertions, 88 deletions
diff --git a/b4/__init__.py b/b4/__init__.py index fd70858..2b70c38 100644 --- a/b4/__init__.py +++ b/b4/__init__.py @@ -30,7 +30,7 @@ import requests from pathlib import Path from contextlib import contextmanager -from typing import Optional, Tuple, Set, List, TextIO, Union +from typing import Optional, Tuple, Set, List, TextIO, Union, Sequence from email import charset charset.add_charset('utf-8', None) @@ -1210,9 +1210,27 @@ class LoreMessage: if attpolicy == 'hardfail': critical = True else: + passing = False if not checkmark: checkmark = attestor.checkmark if attestor.check_identity(self.fromemail): + passing = True + else: + # Do we have an x-original-from? + xofh = self.msg.get('X-Original-From') + if xofh: + logger.debug('Using X-Original-From for identity check') + xpair = email.utils.getaddresses([xofh])[0] + if attestor.check_identity(xpair[1]): + passing = True + # Fix our fromname and fromemail, mostly for thanks-tracking + self.fromname = xpair[0] + self.fromemail = xpair[1] + # Drop the reply-to header if it's exactly the same + for header in list(self.msg._headers): # noqa + if header[0].lower() == 'reply-to' and header[1].find(xpair[1]) > 0: + self.msg._headers.remove(header) # noqa + if passing: trailers.append('%s Signed: %s' % (attestor.checkmark, attestor.trailer)) else: trailers.append('%s Signed: %s (From: %s)' % (attestor.checkmark, attestor.trailer, @@ -2858,62 +2876,100 @@ def patchwork_set_state(msgids: List[str], state: str) -> bool: logger.debug('Patchwork REST error: %s', ex) -def send_smtp(smtp: Union[smtplib.SMTP, smtplib.SMTP_SSL, None], msg: email.message.Message, - fromaddr: str, destaddrs: Optional[Union[Tuple, Set]] = None, +def send_mail(smtp: Union[smtplib.SMTP, smtplib.SMTP_SSL, None], msgs: Sequence[email.message.Message], + fromaddr: Optional[str], destaddrs: Optional[Union[set, list]] = None, patatt_sign: bool = False, dryrun: bool = False, maxheaderlen: Optional[int] = None, - write_to: Optional[str] = None) -> bool: + output_dir: Optional[str] = None) -> Optional[int]: - if write_to is not None: + tosend = list() + if output_dir is not None: dryrun = True - if not msg.get('X-Mailer'): - msg.add_header('X-Mailer', f'b4 {__VERSION__}') - msg.set_charset('utf-8') - msg.replace_header('Content-Transfer-Encoding', '8bit') - msg.policy = email.policy.EmailPolicy(utf8=True, cte_type='8bit') - # Python's sendmail implementation seems to have some logic problems where 8-bit messages are involved. - # As far as I understand the difference between 8BITMIME (supported by nearly all smtp servers) and - # SMTPUTF8 (supported by very few), SMTPUTF8 is only required when the addresses specified in either - # "MAIL FROM" or "RCPT TO" lines of the _protocol exchange_ themselves have 8bit characters, not - # anything in the From: header of the DATA payload. Python's smtplib seems to always try to encode - # strings as ascii regardless of what was policy was specified. - # Work around this by getting the payload as string and then encoding to bytes ourselves. - if maxheaderlen is None: + for msg in msgs: + if not msg.get('X-Mailer'): + msg.add_header('X-Mailer', f'b4 {__VERSION__}') + msg.set_charset('utf-8') + msg.replace_header('Content-Transfer-Encoding', '8bit') + msg.policy = email.policy.EmailPolicy(utf8=True, cte_type='8bit') + # Python's sendmail implementation seems to have some logic problems where 8-bit messages are involved. + # As far as I understand the difference between 8BITMIME (supported by nearly all smtp servers) and + # SMTPUTF8 (supported by very few), SMTPUTF8 is only required when the addresses specified in either + # "MAIL FROM" or "RCPT TO" lines of the _protocol exchange_ themselves have 8bit characters, not + # anything in the From: header of the DATA payload. Python's smtplib seems to always try to encode + # strings as ascii regardless of what was policy was specified. + # Work around this by getting the payload as string and then encoding to bytes ourselves. + if maxheaderlen is None: + if dryrun: + # Make it fit the terminal window, but no wider than 120 minus visual padding + ts = shutil.get_terminal_size((120, 20)) + maxheaderlen = ts.columns - 8 + if maxheaderlen > 112: + maxheaderlen = 112 + else: + # Use a sane-ish default (we don't need to stick to 80, but + # we need to make sure it's shorter than 255) + maxheaderlen = 120 + + emldata = msg.as_string(maxheaderlen=maxheaderlen) + # Force compliant eols + emldata = re.sub(r'\r\n|\n|\r(?!\n)', '\r\n', emldata) + bdata = emldata.encode() + if patatt_sign: + import patatt + # patatt.logger = logger + bdata = patatt.rfc2822_sign(bdata) if dryrun: - # Make it fit the terminal window, but no wider than 120 minus visual padding - ts = shutil.get_terminal_size((120, 20)) - maxheaderlen = ts.columns - 8 - if maxheaderlen > 112: - maxheaderlen = 112 - else: - # Use a sane-ish default (we don't need to stick to 80, but - # we need to make sure it's shorter than 255) - maxheaderlen = 120 - - emldata = msg.as_string(maxheaderlen=maxheaderlen) - # Force compliant eols - emldata = re.sub(r'\r\n|\n|\r(?!\n)', '\r\n', emldata) - bdata = emldata.encode() - if patatt_sign: - import patatt - # patatt.logger = logger - bdata = patatt.rfc2822_sign(bdata) - if dryrun or smtp is None: - if write_to: - with open(write_to, 'wb') as fh: - fh.write(bdata.replace(b'\r\n', b'\n')) - return True - logger.info(' --- DRYRUN: message follows ---') - logger.info(' | ' + bdata.decode().rstrip().replace('\n', '\n | ')) - logger.info(' --- DRYRUN: message ends ---') - return True - if not destaddrs: - alldests = email.utils.getaddresses([str(x) for x in msg.get_all('to', [])]) - alldests += email.utils.getaddresses([str(x) for x in msg.get_all('cc', [])]) - destaddrs = {x[1] for x in alldests} - smtp.sendmail(fromaddr, destaddrs, bdata) - # TODO: properly catch exceptions on sending - return True + if output_dir: + subject = msg.get('Subject', '') + ls = LoreSubject(subject) + filen = '%s.eml' % ls.get_slug(sep='-') + logger.info(' %s', filen) + write_to = os.path.join(output_dir, filen) + with open(write_to, 'wb') as fh: + fh.write(bdata) + continue + logger.info(' --- DRYRUN: message follows ---') + logger.info(' | ' + bdata.decode().rstrip().replace('\n', '\n | ')) + logger.info(' --- DRYRUN: message ends ---') + continue + if not destaddrs: + alldests = email.utils.getaddresses([str(x) for x in msg.get_all('to', [])]) + alldests += email.utils.getaddresses([str(x) for x in msg.get_all('cc', [])]) + destaddrs = {x[1] for x in alldests} + + tosend.append((destaddrs, bdata)) + + if not len(tosend): + return 0 + + # Do we have an endpoint defined? + config = get_main_config() + endpoint = config.get('send-endpoint-web') + if endpoint: + logger.info('Sending via web endpoint %s', endpoint) + req = { + 'action': 'receive', + 'messages': [x[1].decode() for x in tosend], + } + ses = get_requests_session() + res = ses.post(endpoint, json=req) + if res.status_code == 200: + try: + rdata = res.json() + if rdata.get('result') == 'success': + return len(tosend) + except Exception as ex: # noqa + logger.critical('Odd response from the endpoint: %s', res.text) + + logger.critical('500 response from the endpoint: %s', res.text) + return None + + if smtp: + sent = 0 + for destaddrs, bdata in tosend: + smtp.sendmail(fromaddr, destaddrs, bdata) + sent += 1 + return sent def git_get_current_branch(gitdir: Optional[str] = None, short: bool = True) -> Optional[str]: @@ -139,13 +139,7 @@ def auth_new(cmdargs: argparse.Namespace) -> None: } logger.info('Submitting new auth request to %s', endpoint) ses = b4.get_requests_session() - try: - res = ses.post(endpoint, json=req) - res.raise_for_status() - except Exception as ex: - logger.critical('CRITICAL: unable to send endpoint request') - logger.critical(' %s', ex) - sys.exit(1) + res = ses.post(endpoint, json=req) logger.info('---') if res.status_code == 200: try: @@ -186,13 +180,7 @@ def auth_verify(cmdargs: argparse.Namespace) -> None: } logger.info('Submitting verification to %s', endpoint) ses = b4.get_requests_session() - try: - res = ses.post(endpoint, json=req) - res.raise_for_status() - except Exception as ex: - logger.critical('CRITICAL: unable to send endpoint request') - logger.critical(' %s', ex) - sys.exit(1) + res = ses.post(endpoint, json=req) logger.info('---') if res.status_code == 200: try: @@ -1081,17 +1069,10 @@ def cmd_send(cmdargs: argparse.Namespace) -> None: sign = True if cmdargs.no_sign or config.get('send-no-patatt-sign', '').lower() in {'yes', 'true', 'y'}: sign = False - identity = config.get('sendemail-identity') - try: - smtp, fromaddr = b4.get_smtp(identity, dryrun=cmdargs.dryrun) - except Exception as ex: # noqa - logger.critical('Failed to configure the smtp connection:') - logger.critical(ex) - sys.exit(1) - counter = 0 cover_msgid = None # TODO: Need to send obsoleted-by follow-ups, just need to figure out where. + send_msgs = list() for commit, msg in patches: if not msg: continue @@ -1106,27 +1087,40 @@ def cmd_send(cmdargs: argparse.Namespace) -> None: msg.add_header('To', b4.format_addrs(allto)) if allcc: msg.add_header('Cc', b4.format_addrs(allcc)) - if cmdargs.output_dir: - subject = msg.get('Subject', '') - ls = b4.LoreSubject(subject) - filen = '%s.eml' % ls.get_slug(sep='-') - logger.info(' %s', filen) - write_to = os.path.join(cmdargs.output_dir, filen) - else: - write_to = None + if not cmdargs.output_dir: logger.info(' %s', re.sub(r'\s+', ' ', msg.get('Subject'))) - if b4.send_smtp(smtp, msg, fromaddr=fromaddr, destaddrs=alldests, patatt_sign=sign, - dryrun=cmdargs.dryrun, write_to=write_to): - counter += 1 + send_msgs.append(msg) + + if config.get('send-endpoint-web'): + # Web endpoint always requires signing + if not sign: + logger.critical('CRITICAL: Web endpoint is defined for sending, but signing is turned off') + logger.critical(' Please re-enable signing or use SMTP') + sys.exit(1) + + sent = b4.send_mail(None, send_msgs, fromaddr=None, destaddrs=None, patatt_sign=True, + dryrun=cmdargs.dryrun, output_dir=cmdargs.output_dir) + else: + identity = config.get('sendemail-identity') + try: + smtp, fromaddr = b4.get_smtp(identity, dryrun=cmdargs.dryrun) + except Exception as ex: # noqa + logger.critical('Failed to configure the smtp connection:') + logger.critical(ex) + sys.exit(1) + + sent = b4.send_mail(smtp, send_msgs, fromaddr=fromaddr, destaddrs=alldests, patatt_sign=sign, + dryrun=cmdargs.dryrun, output_dir=cmdargs.output_dir) logger.info('---') if cmdargs.dryrun: - logger.info('DRYRUN: Would have sent %s messages', counter) + logger.info('DRYRUN: Would have sent %s messages', len(send_msgs)) return else: - logger.info('Sent %s messages', counter) + logger.info('Sent %s messages', sent) + # TODO: need to make the reroll process smoother mybranch = b4.git_get_current_branch() revision = tracking['series']['revision'] @@ -456,6 +456,7 @@ def thanks_record_am(lser, cherrypick=None): allto = email.utils.getaddresses([str(x) for x in lmsg.msg.get_all('to', [])]) allcc = email.utils.getaddresses([str(x) for x in lmsg.msg.get_all('cc', [])]) + # TODO: check for reply-to and x-original-from out = { 'msgid': lmsg.msgid, 'subject': lmsg.full_subject, @@ -431,7 +431,7 @@ def send_messages(listing, branch, cmdargs): if not fromaddr: fromaddr = jsondata['myemail'] logger.info(' Sending: %s', msg.get('subject')) - b4.send_smtp(smtp, msg, fromaddr, dryrun=cmdargs.dryrun) + b4.send_mail(smtp, [msg], fromaddr, dryrun=cmdargs.dryrun) else: slug_from = re.sub(r'\W', '_', jsondata['fromemail']) slug_subj = re.sub(r'\W', '_', jsondata['subject']) |