From 5bf7da153e965b59e44ee0df77c589a9e0a8bacc Mon Sep 17 00:00:00 2001 From: Daniel Kahn Gillmor Date: Tue, 3 Dec 2019 16:48:18 -0500 Subject: email-print-mime-structure: Avoid test suite dependency on dirmngr There is no clear reason why gpgsm should try to invoke dirmngr (see https://dev.gnupg.org/T4765), but for now we can explicitly avoid the checks. Signed-off-by: Daniel Kahn Gillmor --- debian/control | 1 - tests/email-print-mime-structure.sh | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/debian/control b/debian/control index 3de5b11..bc8268a 100644 --- a/debian/control +++ b/debian/control @@ -7,7 +7,6 @@ Build-Depends: bash-completion, debhelper (>= 10), dh-elpa, - dirmngr , gnutls-bin , gpg , gpg-agent , diff --git a/tests/email-print-mime-structure.sh b/tests/email-print-mime-structure.sh index b45294e..dd14e44 100755 --- a/tests/email-print-mime-structure.sh +++ b/tests/email-print-mime-structure.sh @@ -30,7 +30,7 @@ for eml in tests/email-print-mime-structure/*.eml; do testgpghome=$(mktemp -d) printf "Testing %s (GnuPG S/MIME)\n" "${eml##*/}" - gpgsm --pinentry-mode=loopback --passphrase-fd 4 4<<<'' --homedir="$testgpghome" --batch --quiet --import <"$p12key" + gpgsm --disable-dirmngr --pinentry-mode=loopback --passphrase-fd 4 4<<<'' --homedir="$testgpghome" --batch --quiet --import <"$p12key" GNUPGHOME="$testgpghome" test_eml "$base" --use-gpg-agent rm -rf "$testgpghome" else -- cgit v1.2.3 From fddc2559107e954c30b9900812c53ad0d67eb029 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Wed, 4 Dec 2019 07:17:59 -0700 Subject: changelog Signed-off-by: Sean Whitton --- debian/changelog | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/debian/changelog b/debian/changelog index dd8d9aa..7aac730 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,11 @@ +mailscripts (0.16-2) UNRELEASED; urgency=medium + + * email-print-mime-structure: pass --disable-dirmngr to gpgsm and drop + build-dep on dirmngr (Closes: #946111). + Thanks to Daniel Kahn Gillmor for a patch. + + -- Sean Whitton Wed, 04 Dec 2019 07:16:54 -0700 + mailscripts (0.16-1) unstable; urgency=medium email-print-mime-structure: -- cgit v1.2.3 From f80ebce51666980e345b734e1c446ed5ee8a8be2 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Wed, 12 Feb 2020 10:04:32 -0700 Subject: update/format some copyright notices Signed-off-by: Sean Whitton --- debian/copyright | 4 ++-- notmuch-extract-patch/notmuch-extract-patch | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/debian/copyright b/debian/copyright index f6f2e0e..b26b25f 100644 --- a/debian/copyright +++ b/debian/copyright @@ -1,9 +1,9 @@ mailscripts Collection of scripts for manipulating e-mail on Debian -Copyright (C)2017 Aurelien Aptel +Copyright (C)2017 Aurelien Aptel Copyright (C)2017-2019 Sean Whitton -Copyright (C)2019 Daniel Kahn Gillmor +Copyright (C)2019 Daniel Kahn Gillmor These programs are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as diff --git a/notmuch-extract-patch/notmuch-extract-patch b/notmuch-extract-patch/notmuch-extract-patch index d67e542..f9e03f2 100755 --- a/notmuch-extract-patch/notmuch-extract-patch +++ b/notmuch-extract-patch/notmuch-extract-patch @@ -3,6 +3,7 @@ # Extract git patchset from notmuch emails # # Copyright (C) 2017 Aurelien Aptel +# Copyright (C) 2019 Sean Whitton # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by -- cgit v1.2.3 From d5d771291fb4c3996ebfc31a9964917313c6345a Mon Sep 17 00:00:00 2001 From: Daniel Kahn Gillmor Date: Sat, 8 Feb 2020 12:37:12 -0500 Subject: Add imap-dl, a simple imap downloader getmail upstream appears to have no plans to convert to python3 in the near future. Some of us use only a minimal subset of features of getmail, and it would be nice to have something simpler, with the main complexity offloaded to the modern python3 stdlib. This patch represents a squashed series of changes from both Jameson Graef Rollins and Daniel Kahn Gillmor (dkg), though dkg is primarily responsible for any remaining bugs. Thanks to Sean Whitton for useful and significant feedback. Signed-off-by: Jameson Graef Rollins Signed-off-by: Daniel Kahn Gillmor --- Makefile | 4 +- debian/control | 2 + debian/mailscripts.bash-completion | 1 + debian/mailscripts.install | 1 + debian/mailscripts.manpages | 1 + imap-dl | 278 +++++++++++++++++++++++++++++++++++++ imap-dl.1.pod | 88 ++++++++++++ 7 files changed, 374 insertions(+), 1 deletion(-) create mode 100755 imap-dl create mode 100644 imap-dl.1.pod diff --git a/Makefile b/Makefile index af30616..ec3d851 100644 --- a/Makefile +++ b/Makefile @@ -1,15 +1,17 @@ MANPAGES=mdmv.1 mbox2maildir.1 \ notmuch-slurp-debbug.1 notmuch-extract-patch.1 maildir-import-patch.1 \ + imap-dl.1 \ email-extract-openpgp-certs.1 \ email-print-mime-structure.1 \ notmuch-import-patch.1 -COMPLETIONS=completions/bash/email-print-mime-structure +COMPLETIONS=completions/bash/email-print-mime-structure completions/bash/imap-dl all: $(MANPAGES) $(COMPLETIONS) check: ./tests/email-print-mime-structure.sh mypy --strict ./email-print-mime-structure + mypy --strict ./imap-dl clean: rm -f $(MANPAGES) diff --git a/debian/control b/debian/control index bc8268a..21afa45 100644 --- a/debian/control +++ b/debian/control @@ -77,3 +77,5 @@ Description: collection of scripts for manipulating e-mail on Debian email-print-mime-structure -- tree view of a message's MIME structure . email-extract-openpgp-certs -- extract OpenPGP certificates from a message + . + imap-dl -- download messages from an IMAP mailbox to a maildir diff --git a/debian/mailscripts.bash-completion b/debian/mailscripts.bash-completion index 435576f..657de01 100644 --- a/debian/mailscripts.bash-completion +++ b/debian/mailscripts.bash-completion @@ -1 +1,2 @@ completions/bash/email-print-mime-structure +completions/bash/imap-dl diff --git a/debian/mailscripts.install b/debian/mailscripts.install index 2c060df..3739c49 100644 --- a/debian/mailscripts.install +++ b/debian/mailscripts.install @@ -1,5 +1,6 @@ email-extract-openpgp-certs /usr/bin email-print-mime-structure /usr/bin +imap-dl /usr/bin maildir-import-patch /usr/bin mbox2maildir /usr/bin mdmv /usr/bin diff --git a/debian/mailscripts.manpages b/debian/mailscripts.manpages index 1de088f..a915617 100644 --- a/debian/mailscripts.manpages +++ b/debian/mailscripts.manpages @@ -1,5 +1,6 @@ email-extract-openpgp-certs.1 email-print-mime-structure.1 +imap-dl.1 maildir-import-patch.1 mbox2maildir.1 mdmv.1 diff --git a/imap-dl b/imap-dl new file mode 100755 index 0000000..318c0bc --- /dev/null +++ b/imap-dl @@ -0,0 +1,278 @@ +#!/usr/bin/python3 +# PYTHON_ARGCOMPLETE_OK +# -*- coding: utf-8 -*- + +# Copyright (C) 2019 Daniel Kahn Gillmor +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or (at +# your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +DESCRIPTION = '''A simple replacement for a minimalist use of getmail. + +In particular, if you use getmail to reach an IMAP server as though it +were POP (retrieving from the server and optionally deleting), you can +point this script to the getmail config and it should do the same +thing. + +It tries to ensure that the configuration file is of the expected +type, and will terminate raising an exception, and it should not lose +messages. + +If there's any interest in supporting other similarly simple use cases +for getmail, patches are welcome. + +If you've never used getmail, you can make the simplest possible +config file like so: + +---------- +[retriever] +server = mail.example.net +username = foo +password = sekr1t! + +[destination] +path = /home/foo/Maildir + +[options] +delete = True +---------- +''' + +import re +import sys +import ssl +import enum +import time +import imaplib +import logging +import mailbox +import os.path +import argparse +import statistics +import configparser + +from typing import Dict, List, Union, Tuple + +try: + import argcomplete #type: ignore +except ImportError: + argcomplete = None + +class Splitter(object): + def __init__(self, name:str, match:bytes): + self._splitter = re.compile(match) + self._name = name + def breakup(self, line:bytes) -> Dict[str,int]: + match = self._splitter.match(line) + if not match: + raise Exception(f'malformed {self._name} line {line!r}') + ret:Dict[str,int] = {} + i:str + for i in ['id', 'uid', 'size']: + ret[i] = int(match[i]) + return ret + +OnSizeMismatch = enum.Enum('OnSizeMismatch', 'warn error none') + +# b'1 (UID 160 RFC822.SIZE 1867)' -> {id: 1, uid: 160, size: 1867} +_summary_re = rb'^(?P[0-9]+) \(UID (?P[0-9]+) RFC822.SIZE (?P[0-9]+)\)$' +summary_splitter = Splitter('summary', _summary_re) +# b'1 (UID 160 BODY[] {1867}' -> {id: 1, uid: 160, size: 1867} +_fetch_re = rb'^(?P[0-9]+) \(UID (?P[0-9]+) (FLAGS \([\\A-Za-z ]*\) )?BODY\[\] \{(?P[0-9]+)\}$' +fetch_splitter = Splitter('fetch', _fetch_re) + +def scan_msgs(configfile:str, verbose:bool) -> None: + conf = configparser.ConfigParser() + conf.read_file(open(configfile, 'r')) + oldloglevel = logging.getLogger().getEffectiveLevel() + conf_verbose = conf.getint('options', 'verbose', fallback=1) + if conf_verbose > 1: + verbose = True + if verbose: + logging.getLogger().setLevel(logging.INFO) + logging.info('pulling from config file %s', configfile) + delete = conf.getboolean('options', 'delete', fallback=False) + read_all = conf.getboolean('options', 'read_all', fallback=True) + if not read_all: + raise NotImplementedError('imap-dl only supports options.read_all=True, got False') + rtype = conf.get('retriever', 'type', fallback='SimpleIMAPSSLRetriever') + if rtype.lower() != 'simpleimapsslretriever': + raise NotImplementedError(f'imap-dl only supports retriever.type=SimpleIMAPSSLRetriever, got {rtype}') + # FIXME: handle `retriever.record_mailbox` + dtype = conf.get('destination', 'type', fallback='Maildir') + if dtype.lower() != 'maildir': + raise NotImplementedError(f'imap-dl only supports destination.type=Maildir, got {dtype}') + dst = conf.get('destination', 'path') + dst = os.path.expanduser(dst) + if os.path.exists(dst) and not os.path.isdir(dst): + raise Exception('expected destination directory, but %s is not a directory'%(dst,)) + mdst:mailbox.Maildir = mailbox.Maildir(dst, create=True) + ca_certs = conf.get('retriever', 'ca_certs', fallback=None) + on_size_mismatch_str:str = conf.get('options', 'on_size_mismatch', fallback='error').lower() + try: + on_size_mismatch:OnSizeMismatch = OnSizeMismatch.__members__[on_size_mismatch_str] + except KeyError: + raise Exception(f'options.on_size_mismatch value should be one of:\n' + '{list(OnSizeMismatch.__members__.keys())}\n' + '(found "{on_size_mismatch_str}")') + + ctx = ssl.create_default_context(cafile=ca_certs) + server:str = conf.get('retriever', 'server') + with imaplib.IMAP4_SSL(host=server, #type: ignore + port=int(conf.get('retriever', 'port', fallback=993)), + ssl_context=ctx) as imap: + username:str = conf.get('retriever', 'username') + logging.info('Logging in as %s', username) + resp:Tuple[str, List[Union[bytes,Tuple[bytes,bytes]]]] + resp = imap.login(username, conf.get('retriever', 'password')) + if resp[0] != 'OK': + raise Exception(f'login failed with {resp} as user {username} on {server}') + if verbose: # only enable debugging after login to avoid leaking credentials in the log + imap.debug = 4 + logging.info("capabilities reported: %s", ', '.join(imap.capabilities)) + resp = imap.select(readonly=not delete) + if resp[0] != 'OK': + raise Exception(f'selection failed: {resp}') + if len(resp[1]) != 1: + raise Exception(f'expected exactly one EXISTS response from select, got {resp[1]}') + data:Union[bytes,Tuple[bytes,bytes]] = resp[1][0] + if not isinstance(data, bytes): + raise Exception(f'expected bytes in response to SELECT, got {data}') + n:int = int(data) + if n == 0: + logging.info('No messages to retrieve') + else: + pull_msgs(imap, n, mdst, on_size_mismatch, delete) + logging.getLogger().setLevel(oldloglevel) + +def pull_msgs(imap:imaplib.IMAP4_SSL, n:int, mdst:mailbox.Maildir, + on_size_mismatch:OnSizeMismatch, delete:bool) -> None: + sizes_mismatched:List[int] = [] + resp:Tuple[str, List[Union[bytes,Tuple[bytes,bytes]]]] + resp = imap.fetch('1:%d'%(n), '(UID RFC822.SIZE)') + if resp[0] != 'OK': + raise Exception(f'initial FETCH 1:{n} not OK ({resp})') + + pending:List[Dict[str,int]] = [] + for data in resp[1]: + if not isinstance(data, bytes): + raise TypeError(f'Expected bytes, got {type(data)}') + pending.append(summary_splitter.breakup(data)) + + sizes:Dict[int,int] = {} + for m in pending: + sizes[m['uid']] = m['size'] + fetched:Dict[int,int] = {} + uids = ','.join(map(str, sorted([x['uid'] for x in pending]))) + totalbytes = sum([x['size'] for x in pending]) + logging.info('Fetching %d messages, expecting %d bytes of message content', + len(pending), totalbytes) + # FIXME: sort by size? + # FIXME: fetch in batches or singly instead of all-at-once? + # FIXME: rolling deletion? + # FIXME: asynchronous work? + before = time.perf_counter() + resp = imap.uid('FETCH', uids, '(UID BODY.PEEK[])') + after = time.perf_counter() + if resp[0] != 'OK': + raise Exception('UID fetch failed {resp[0]}') + expected_objects:int = len(pending) * 2 + if len(resp[1]) != expected_objects: + raise Exception(f'expected {expected_objects} responses for fetch, got {len(resp[1])}') + for n in range(0, expected_objects, 2): + # expected response is one "fetch" line, followed by a close-paren item + data = resp[1][n] + if not isinstance(data, tuple) or len(data) != 2: + raise Exception(f'expected 2-part tuple, got {type(data)}') + + closeparen = resp[1][n+1] + if not isinstance(closeparen, bytes) or closeparen != b')': + raise Exception('Expected close parenthesis after message fetch') + + m = fetch_splitter.breakup(data[0]) + if m['size'] != len(data[1]): + raise Exception(f'expected {m["size"]} octets, got {len(data[1])}') + if m['size'] != sizes[m['uid']]: + if on_size_mismatch == OnSizeMismatch.warn: + if len(sizes_mismatched) == 0: + logging.warning('size mismatch: summary said %d octets, fetch sent %d', + sizes[m['uid']], m['size']) + elif len(sizes_mismatched) == 1: + logging.warning('size mismatch: (mismatches after the first suppressed until summary)') + sizes_mismatched.append(sizes[m['uid']] - m['size']) + elif on_size_mismatch == OnSizeMismatch.error: + raise Exception(f"size mismatch: summary said {sizes[m['uid']]} octets, " + "fetch sent {m['size']}\n" + "(set options.on_size_mismatch to none or warn to avoid hard failure)") + # convert any CRLF line-endings to UNIX standard line- + # endings: + fname = mdst.add(data[1].replace(b'\r\n', b'\n')) + logging.info('stored message %d/%d (uid %d, %d bytes) in %s', + len(fetched) + 1, len(pending), m['uid'], m['size'], fname) + del sizes[m['uid']] + fetched[m['uid']] = m['size'] + if sizes: + logging.warning('unhandled UIDs: %s', sizes) + logging.info('%d bytes of %d messages fetched in %g seconds (~%g KB/s)', + sum(fetched.values()), len(fetched), after - before, + sum(fetched.values())/((after - before)*1024)) + if on_size_mismatch == OnSizeMismatch.warn and len(sizes_mismatched) > 1: + logging.warning('%d size mismatches out of %d messages (mismatches in bytes: mean %f, stddev %f)', + len(sizes_mismatched), len(fetched), + statistics.mean(sizes_mismatched), + statistics.stdev(sizes_mismatched)) + if delete: + logging.info('trying to delete %d messages from IMAP store', len(fetched)) + resp = imap.uid('STORE', ','.join(map(str, fetched.keys())), '+FLAGS', r'(\Deleted)') + if resp[0] != 'OK': + raise Exception(f'failed to set \\Deleted flag: {resp}') + resp = imap.expunge() + if resp[0] != 'OK': + raise Exception(f'failed to expunge! {resp}') + else: + logging.info('not deleting any messages, since options.delete is not set') + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description=DESCRIPTION, + formatter_class=argparse.RawDescriptionHelpFormatter, + ) + parser.add_argument( + 'config', nargs='+', metavar='CONFIG', + help="configuration file") + parser.add_argument( + '-v', '--verbose', action='store_true', + help="verbose log output") + + if argcomplete: + argcomplete.autocomplete(parser) + elif '_ARGCOMPLETE' in os.environ: + logging.error('Argument completion requested but the "argcomplete" ' + 'module is not installed. ' + 'Maybe you want to "apt install python3-argcomplete"') + sys.exit(1) + + args = parser.parse_args() + + if args.verbose: + logging.getLogger().setLevel(logging.INFO) + + errs = {} + for confname in args.config: + try: + scan_msgs(confname, args.verbose) + except imaplib.IMAP4.error as e: + logging.error('IMAP failure for config file %s: %s', confname, e) + errs[confname] = e + if errs: + exit(1) diff --git a/imap-dl.1.pod b/imap-dl.1.pod new file mode 100644 index 0000000..9fb77c3 --- /dev/null +++ b/imap-dl.1.pod @@ -0,0 +1,88 @@ +=encoding utf8 + +=head1 NAME + +imap-dl -- a simple replacement for a minimalist user of getmail + +=head1 SYNOPSIS + +B [B<-v>|B<--verbose>] B... + +=head1 DESCRIPTION + +If you use getmail to reach an IMAP server as though it were POP +(retrieving from the server, storing it in a maildir and optionally +deleting), you can point this script to the getmail config and it +should do the same thing. + +It tries to ensure that the configuration file is of the expected +type, and otherwise it will terminate with an error. It should not +lose e-mail messages. + +If there's any interest in supporting other similarly simple use cases +for getmail, patches are welcome. + +=head1 OPTIONS + +B<-v> or B<--verbose> causes B to print more details +about what it is doing. + +In addition to parts of the standard B configuration, +B supports the following keywords in the config file: + +B can be set to B, B, or +B. This governs what to do when the remote IMAP server claims a +different size in the message summary list than the actual message +retrieval (default: B). + +=head1 EXAMPLE CONFIG + +If you've never used getmail, you can make the simplest possible +config file like so: + +=over 4 + + [retriever] + server = mail.example.net + username = foo + password = sekr1t! + + [destination] + path = /home/foo/Maildir + + [options] + delete = True + +=back + +=head1 LIMITATIONS + +B is currently deliberately minimal. It is designed to be +used by someone who treats their IMAP mailbox like a POP server. + +It works with IMAP-over-TLS only, and it just fetches all messages +from the default IMAP folder. It does not support all the various +features of getmail. + +B is deliberately implemented in a modern version of python3, +and tries to use just the standard library. It will not be backported +to python2. + +B uses imaplib, which means that it does synchronous calls to +the imap server. A more clever implementation would use asynchronous +python to avoid latency/roundtrips. + +B does not know how to wait and listen for new mail using +IMAP IDLE. This would be a nice additional feature. + +B does not yet know how to deliver to an MDA (or to +B). This would be a nice thing to be able to do. + +=head1 SEE ALSO + +https://tools.ietf.org/html/rfc3501, http://pyropus.ca/software/getmail/ + +=head1 AUTHOR + +B and this manpage were written by Daniel Kahn Gillmor, +inspired by some functionality from the getmail project. -- cgit v1.2.3 From cb7f1b2183754e7eb5de610707c3e92f75a0baa7 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Fri, 14 Feb 2020 07:56:34 -0700 Subject: changelog Signed-off-by: Sean Whitton --- debian/changelog | 5 ++++- mailscripts.el | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/debian/changelog b/debian/changelog index 7aac730..e6d41f8 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,8 +1,11 @@ -mailscripts (0.16-2) UNRELEASED; urgency=medium +mailscripts (0.17-1) UNRELEASED; urgency=medium * email-print-mime-structure: pass --disable-dirmngr to gpgsm and drop build-dep on dirmngr (Closes: #946111). Thanks to Daniel Kahn Gillmor for a patch. + * New script: imap-dl (Closes: #940461). + Thanks to Daniel Kahn Gillmor and Jameson Rollins for the patch, and + others for testing out the new tool. -- Sean Whitton Wed, 04 Dec 2019 07:16:54 -0700 diff --git a/mailscripts.el b/mailscripts.el index 6872dd6..5009e7e 100644 --- a/mailscripts.el +++ b/mailscripts.el @@ -1,7 +1,7 @@ ;;; mailscripts.el --- functions to access tools in the mailscripts package ;; Author: Sean Whitton -;; Version: 0.16 +;; Version: 0.17 ;; Package-Requires: (notmuch projectile) ;; Copyright (C) 2018, 2019 Sean Whitton -- cgit v1.2.3 From eb2384dc77dd9755b08dfbacb201d6d84b1c802d Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Fri, 14 Feb 2020 10:10:51 -0700 Subject: update some more copyright notices Signed-off-by: Sean Whitton --- debian/copyright | 2 +- imap-dl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/debian/copyright b/debian/copyright index b26b25f..f55e591 100644 --- a/debian/copyright +++ b/debian/copyright @@ -3,7 +3,7 @@ Collection of scripts for manipulating e-mail on Debian Copyright (C)2017 Aurelien Aptel Copyright (C)2017-2019 Sean Whitton -Copyright (C)2019 Daniel Kahn Gillmor +Copyright (C)2019-2020 Daniel Kahn Gillmor These programs are free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as diff --git a/imap-dl b/imap-dl index 318c0bc..469b81d 100755 --- a/imap-dl +++ b/imap-dl @@ -2,7 +2,7 @@ # PYTHON_ARGCOMPLETE_OK # -*- coding: utf-8 -*- -# Copyright (C) 2019 Daniel Kahn Gillmor +# Copyright (C) 2019-2020 Daniel Kahn Gillmor # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by -- cgit v1.2.3 From 10a13114833731a370b56f743bb43636a5eada8d Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Fri, 14 Feb 2020 10:37:07 -0700 Subject: release 0.17 (-1 to Debian unstable) Signed-off-by: Sean Whitton --- debian/changelog | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/debian/changelog b/debian/changelog index e6d41f8..102f687 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,4 @@ -mailscripts (0.17-1) UNRELEASED; urgency=medium +mailscripts (0.17-1) unstable; urgency=medium * email-print-mime-structure: pass --disable-dirmngr to gpgsm and drop build-dep on dirmngr (Closes: #946111). @@ -7,7 +7,7 @@ mailscripts (0.17-1) UNRELEASED; urgency=medium Thanks to Daniel Kahn Gillmor and Jameson Rollins for the patch, and others for testing out the new tool. - -- Sean Whitton Wed, 04 Dec 2019 07:16:54 -0700 + -- Sean Whitton Fri, 14 Feb 2020 10:37:02 -0700 mailscripts (0.16-1) unstable; urgency=medium -- cgit v1.2.3 From 3810cdf4464b16484fe1672765b01d9734bed318 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sat, 15 Feb 2020 15:03:23 -0700 Subject: notmuch-extract-patch: rewrite & split out mbox-extract-patch Signed-off-by: Sean Whitton --- Makefile | 1 + debian/changelog | 14 + debian/control | 4 + debian/copyright | 7 +- debian/mailscripts.install | 3 +- debian/mailscripts.manpages | 1 + mailscripts.el | 2 +- mbox-extract-patch | 223 +++++++++ mbox-extract-patch.1.pod | 70 +++ notmuch-extract-patch | 51 +++ notmuch-extract-patch.1.pod | 54 +-- notmuch-extract-patch/LICENSE | 674 ---------------------------- notmuch-extract-patch/README.md | 30 -- notmuch-extract-patch/notmuch-extract-patch | 100 ----- 14 files changed, 389 insertions(+), 845 deletions(-) create mode 100755 mbox-extract-patch create mode 100644 mbox-extract-patch.1.pod create mode 100755 notmuch-extract-patch delete mode 100644 notmuch-extract-patch/LICENSE delete mode 100644 notmuch-extract-patch/README.md delete mode 100755 notmuch-extract-patch/notmuch-extract-patch diff --git a/Makefile b/Makefile index ec3d851..e2ae233 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,6 @@ MANPAGES=mdmv.1 mbox2maildir.1 \ notmuch-slurp-debbug.1 notmuch-extract-patch.1 maildir-import-patch.1 \ + mbox-extract-patch.1 \ imap-dl.1 \ email-extract-openpgp-certs.1 \ email-print-mime-structure.1 \ diff --git a/debian/changelog b/debian/changelog index 102f687..aa988d0 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,17 @@ +mailscripts (0.18-1) UNRELEASED; urgency=medium + + * notmuch-extract-patch: rewrite: + - Split into notmuch-extract-patch(1) and mbox-extract-patch(1). + - Don't require -v when only one series in thread (Closes: #951218). + + When there is no -v, extract the patch series with the highest + reroll count that we see. + - New --trailers and --cover-letter-trailers features (Closes: #951211). + + --trailers is on by default; use --no-trailers to disable. + - Stop outputting message subjects on standard error. + * New dependencies on liblist-moreutils-perl, libmail-box-perl. + + -- Sean Whitton Sat, 15 Feb 2020 09:06:56 -0700 + mailscripts (0.17-1) unstable; urgency=medium * email-print-mime-structure: pass --disable-dirmngr to gpgsm and drop diff --git a/debian/control b/debian/control index 21afa45..613335c 100644 --- a/debian/control +++ b/debian/control @@ -41,6 +41,8 @@ Depends: libconfig-tiny-perl, libfile-which-perl, libipc-system-simple-perl, + liblist-moreutils-perl, + libmail-box-perl, libmime-tools-perl, python3, ${misc:Depends}, @@ -70,6 +72,8 @@ Description: collection of scripts for manipulating e-mail on Debian . notmuch-extract-patch -- extract a git patch series from notmuch . + mbox-extract-patch -- extract a git patch series from an mbox + . maildir-import-patch -- import a git patch series into a maildir . notmuch-import-patch -- import a git patch series into notmuch diff --git a/debian/copyright b/debian/copyright index f55e591..17997a8 100644 --- a/debian/copyright +++ b/debian/copyright @@ -1,8 +1,7 @@ mailscripts Collection of scripts for manipulating e-mail on Debian -Copyright (C)2017 Aurelien Aptel -Copyright (C)2017-2019 Sean Whitton +Copyright (C)2017-2020 Sean Whitton Copyright (C)2019-2020 Daniel Kahn Gillmor These programs are free software: you can redistribute it and/or @@ -19,10 +18,6 @@ A copy of the GNU General Public License v3 can be found in /usr/share/common-licenses/GPL-3. -The contents of the notmuch-extract-patch/ directory was imported from -https://github.com/aaptel/notmuch-extract-patch/ using git-subtree(1) - - Contributions are accepted upstream under the same terms (or another DFSG-compatible license for completely new scripts); please sign off your patches (by writing an approprite Signed-Off-By tag in your diff --git a/debian/mailscripts.install b/debian/mailscripts.install index 3739c49..df220b3 100644 --- a/debian/mailscripts.install +++ b/debian/mailscripts.install @@ -4,6 +4,7 @@ imap-dl /usr/bin maildir-import-patch /usr/bin mbox2maildir /usr/bin mdmv /usr/bin -notmuch-extract-patch/notmuch-extract-patch /usr/bin +mbox-extract-patch /usr/bin +notmuch-extract-patch /usr/bin notmuch-import-patch /usr/bin notmuch-slurp-debbug /usr/bin diff --git a/debian/mailscripts.manpages b/debian/mailscripts.manpages index a915617..345053a 100644 --- a/debian/mailscripts.manpages +++ b/debian/mailscripts.manpages @@ -4,6 +4,7 @@ imap-dl.1 maildir-import-patch.1 mbox2maildir.1 mdmv.1 +mbox-extract-patch.1 notmuch-extract-patch.1 notmuch-import-patch.1 notmuch-slurp-debbug.1 diff --git a/mailscripts.el b/mailscripts.el index 5009e7e..3d65006 100644 --- a/mailscripts.el +++ b/mailscripts.el @@ -61,7 +61,7 @@ The target branch may or may not already exist. With an optional prefix numeric argument REROLL-COUNT, try to extract the nth revision of a series. See the --reroll-count -option detailed in notmuch-extract-patch(1). +option detailed in mbox-extract-patch(1). See notmuch-extract-patch(1) manpage for limitations: in particular, this Emacs Lisp function supports passing only entire diff --git a/mbox-extract-patch b/mbox-extract-patch new file mode 100755 index 0000000..276895b --- /dev/null +++ b/mbox-extract-patch @@ -0,0 +1,223 @@ +#!/usr/bin/perl + +# mbox-extract-patch -- extract a git patch series from an mbox +# +# Copyright (C) 2020 Sean Whitton +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or (at +# your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +use 5.028; +use strict; +use warnings; + +use Getopt::Long; +use Mail::Box::Mbox; +use File::Temp (); +use List::Util qw(max); + +our $patch_tag_re = qr/\[(.*PATCH.*)\]/; +our $trailer_re = qr/^[A-Z][a-z-]+: .+$/; +# ordering here is from Konstantin Ryabitsev's get-lore-mbox.py +our @trailer_order = ( + "fixes", "reported", "suggested", "original", + "co-", "signed-off", "tested", "reviewed", + "acked", "cc", "link", "", +); + +# empty STDIN into a temporary file +my $mbox = File::Temp->new; +binmode STDIN; +binmode $mbox; +my $BUFSIZ = 64 * (2**10); +while (read STDIN, my $buf, $BUFSIZ) { + print $mbox $buf + or die "couldn't write to " . $mbox->filename . ": $!"; +} +$mbox->close; # close filehandle for writing; keeps the file + +# command line arguments +my $extract_trailers = 1; +my ($reroll_count, $cover_letter_trailers); +Getopt::Long::Configure("bundling"); +GetOptions + "reroll-count|v=i" => \$reroll_count, + "trailers!" => \$extract_trailers, + "cover-letter-trailers!" => \$cover_letter_trailers; + +my $folder = Mail::Box::Mbox->new(folder => $mbox->filename, access => "rw"); + +# first pass: extract info from messages, and delete some known not to +# be wanted patches +my (@reroll_counts, %trailers, %covers); +foreach my $message ($folder->messages) { + # we assume that the first text/plain part we find is the + # patch/message, and if none, we give up on the message + $message->delete, next unless defined $message->first_text_plain_part; + + my $subject = $message->study("subject"); + $subject =~ /$patch_tag_re/, my $subject_front = $` if defined $subject; + my @lines = $message->first_text_plain_part->body->decoded->lines; + + # $is_cover is a bit simplistic right now + my $is_patch = grep /^@@ [0-9 +,-]+ @@/, @lines; + my $is_cover + = defined $message->patch_count + && $message->patch_count == 0 + && defined $subject_front + && $subject_front !~ /Re: \z/i; + + if ($is_patch) { + $message->delete, next + if $reroll_count and $reroll_count != $message->reroll_count; + # record reroll counts seen so we can determine, later, + # whether there is more than one version of the patch series + # in our input + push @reroll_counts, $message->reroll_count; + } elsif ($is_cover) { + # all we need from covers is their msgids so we can look for + # trailers sent in reply to those covers + $covers{ $message->reroll_count } = $message->messageId; + $message->delete; + } else { + my $in_replies_to = $message->get("In-Reply-To"); + if ($in_replies_to and my @ids = $in_replies_to =~ m/\<([^>]+)\>/g) { + warn "In-Reply-To field with more than one Message-Id; using first" + if @ids > 1; + my $id = $ids[0]; + my @ts = grep /$trailer_re/, @lines; + push $trailers{$id}->@*, @ts; + } + $message->delete; + } +} +# expunge deleted messages +$folder->write or die "failed to update mbox!"; + +# second pass requires $reroll_count to be set, and we can now +# determine what it should be based on information gathered during the +# first pass +unless ($reroll_count) { + if (@reroll_counts > 0) { + # we saw one or more series, and user did not specify a reroll + # count, so we extract the series with the highest version number + $reroll_count = max @reroll_counts; + } else { + # we didn't see any reroll counts, so we mustn't have seen any + # patches + exit; + } +} + +# second pass: edits to patch messages, and delete remaining unwanted +# messages. note that only patches remain in the mbox after first +# pass +foreach my $message ($folder->messages) { + $message->delete, next + unless $reroll_count == $message->reroll_count; + + my @ts; + my $id = $message->messageId; + my $cid = $covers{ $message->reroll_count }; + @ts = $trailers{$id}->@* if $extract_trailers and $trailers{$id}; + push @ts, $trailers{$cid}->@* + if $cover_letter_trailers and $trailers{$cid}; + $message->insert_trailers(@ts) if @ts; + + # if Subject: contains [PATCH nn/mm] then any text before that + # should be stripped, as it should not form part of the commit + # message. (The debbugs system prepends 'Bug#nnnnnn: ') + my $subject = $message->study("subject"); + $subject =~ /$patch_tag_re.*$/; + $message->head->set(Subject => $&); +} + +# save mbox and output +$folder->close or die "failed to update & close mbox!"; +exit unless -e $mbox->filename; # no patches to extract +open my $fh, "< :raw :bytes", $mbox->filename + or die "couldn't open " . $mbox->filename . " for reading"; +while (read $fh, my $buf, $BUFSIZ) { + print $buf; +} + +package Mail::Message { + use Carp; + use Mail::Message::Body; + use List::MoreUtils qw(first_index); + + sub insert_trailers { + my ($self, @ts) = @_; + my $part = $self->first_text_plain_part; + return unless defined $part; + my @lines = $part->body->decoded->lines; + my $i = my $j = first_index { /^---$/ } @lines; + carp "couldn't find cut; not daring insert any trailers", return + if $i == -1; + $i-- while $i > 0 and $lines[$i - 1] =~ /$trailer_re/; + unshift @ts, splice @lines, $i, $j - $i; + + # algorithm based on Konstantin Ryabitsev's in his get-lore-mbox.py + my (@new_ts, %added); + foreach my $pat (@trailer_order) { + foreach my $t (@ts) { + next if exists $added{$t}; + next unless $t =~ /^$pat(?:-by)?:/i; + push @new_ts, $t; + $added{$t} = undef; + } + } + + splice @lines, $i, 0, @new_ts; + my $body = Mail::Message::Body->new( + charset => "PERL", + data => \@lines + ); + $body->encode; + $part->body($body); + } + + sub first_text_plain_part { + my $self = shift; + if ($self->isMultipart) { + for ($self->parts("RECURSE")) { + return $_ if $_->body->mimeType eq "text/plain"; + } + } else { + return $self if $self->body->mimeType eq "text/plain"; + } + return; + } + + sub reroll_count { + for (shift->_subject_patch_components) { + /\Av([0-9]+)\z/ and return $1; + } + return 1; + } + + sub patch_count { + for (shift->_subject_patch_components) { + m#\A([0-9]+)/[0-9]+\z# and return $1; + } + return; + } + + sub _subject_patch_components { + my $subject = shift->study("subject"); + return unless defined $subject; + $subject =~ /$patch_tag_re/; + return unless defined $1; + split " ", $1; + } +} diff --git a/mbox-extract-patch.1.pod b/mbox-extract-patch.1.pod new file mode 100644 index 0000000..943c322 --- /dev/null +++ b/mbox-extract-patch.1.pod @@ -0,0 +1,70 @@ +=head1 NAME + +mbox-extract-patch - extract a git patch series from an mbox + +=head1 SYNOPSIS + +B [I] + +=head1 DESCRIPTION + +B extracts a series of git patches from an mbox. +It is designed to extract patches that were originally sent using +git-send-email(1). It skips cover letters and replies/reviews in its +output. + +=head1 OPTIONS + +=over 4 + +=item B<-v>|B<--reroll-count=>I + +Try to extract the Ith version of a patch series, where these +patches are identified by subject prefixes like "[PATCH vI 1/3]". + +If this option is not specified, and there is more than one series, +default to extracting the version of the patch series with the highest +version number we find. + +Note that this option should not usually be needed, because best +practices when sharing patches with git-send-email(1) include starting +a new thread when posting a revised series. The I<--in-reply-to> +option to git-format-patch(1) is used mainly for posting a patch +series in reply to a bug report. + +=item B<--trailers> + +Extract and add to patches lines like + + Acked-by: A. Developer + +sent in reply to those patches. B<--trailers> is on by default, and +B<--no-trailers> can be used to disable adding the trailers. + +=item B<--cover-letter-trailers> + +Additionally add to all patches in the series any trailers sent in +reply to the cover letter of the patch series. + +=back + +=head1 EXAMPLE + +=over 4 + + % git checkout -b test-feature + % mbox-extract-patch diff --git a/notmuch-extract-patch b/notmuch-extract-patch new file mode 100755 index 0000000..9ed3b64 --- /dev/null +++ b/notmuch-extract-patch @@ -0,0 +1,51 @@ +#!/usr/bin/perl + +# notmuch-extract-patch -- extract a git patch series from notmuch +# +# Copyright (C) 2020 Sean Whitton +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or (at +# your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +use 5.028; +use strict; +use warnings; + +use IO::Pipe; + +my (@ARGV_notmuch, @ARGV_extract, $no_more_extract); +for (@ARGV) { + if (/\A--\z/) { + $no_more_extract = 1; + } elsif (/\A-/ and not $no_more_extract) { + push @ARGV_extract, $_; + } else { + push @ARGV_notmuch, $_; + } +} + +$SIG{CHLD} = "IGNORE"; +my $pipe = IO::Pipe->new; + +my $notmuch_pid = fork; +die "fork() failed: $!" unless defined $notmuch_pid; +unless ($notmuch_pid) { + $pipe->writer; + open STDOUT, ">&=", $pipe->fileno + or die "couldn't reopen child's STDOUT: $!"; + exec qw(notmuch show --format=mbox), @ARGV_notmuch; +} +$pipe->reader; +open STDIN, "<&=", $pipe->fileno + or die "couldn't reopen parent's STDIN: $!"; +exec "mbox-extract-patch", @ARGV_extract; diff --git a/notmuch-extract-patch.1.pod b/notmuch-extract-patch.1.pod index a18cc22..242a704 100644 --- a/notmuch-extract-patch.1.pod +++ b/notmuch-extract-patch.1.pod @@ -4,34 +4,15 @@ notmuch-extract-patch - extract a git patch series from notmuch =head1 SYNOPSIS -B [B<-v>|B<--reroll-count=>I] I +B [I] [I<-->] I =head1 DESCRIPTION -B extracts a series of git patches from your -notmuch database. It is designed to extract patches that were -originally sent using git-send-email(1). It skips cover letters and -replies/reviews. - -=head1 OPTIONS - -=over 4 - -=item B<-v>|B<--reroll-count=>I - -Try to extract the Ith version of a patch series, where these -patches are identified by subject prefixes like "[PATCH vI 1/3]". - -If this option is not specified, default to extracting the first -version of the patch series. - -Note that this option should not usually be needed, because best -practices when sharing patches with git-send-email(1) include starting -a new thread when posting a revised series. The I<--in-reply-to> -option to git-format-patch(1) is used mainly for posting a patch -series in reply to a bug report. - -=back +B is a wrapper around mbox-extract-patch(1) to +extract a series of git patches from your notmuch database. It is +designed to extract patches that were originally sent using +git-send-email(1). It skips cover letters and replies/reviews in its +output. =head1 EXAMPLE @@ -44,18 +25,25 @@ series in reply to a bug report. =head1 LIMITATIONS +We inherit limitations of mbox-extract-patch(1). + B can select patches to extract based on the -reroll count, but otherwise assumes that there is only one patch -series in a thread. If this assumption is violated, you would need to -construct a notmuch query that includes only the patches you want to -extract, which somewhat defeats the purpose of this script. +reroll count (see -v in mbox-extract-patch(1)), but otherwise typical +usage assumes that there is only one patch series in a thread. + +If this assumption is violated, you would need to construct a notmuch +query that includes only the patches you want to extract, which +somewhat defeats the purpose of having this script. =head1 SEE ALSO -notmuch(1), git-send-email(1) +notmuch(1), git-send-email(1), mbox-extract-patch(1) + +Emacs functions 'notmuch-extract-thread-patches' and +'notmuch-extract-message-patches', provided by mailscripts.el =head1 AUTHOR -B was written by Aurelien Aptel. This manpage -was written by Sean Whitton for the Debian -system, but may be used by others. +Sean Whitton + +Rewrite, with additional features, of a script by Aurelien Aptel. diff --git a/notmuch-extract-patch/LICENSE b/notmuch-extract-patch/LICENSE deleted file mode 100644 index e600086..0000000 --- a/notmuch-extract-patch/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/notmuch-extract-patch/README.md b/notmuch-extract-patch/README.md deleted file mode 100644 index ecd1ba7..0000000 --- a/notmuch-extract-patch/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Usage - -Let's say you use notmuch as your email client and you want to try out -one of those git patchset sent on a mailing list with all diffs -grouped in a thread, one patch per email. ("[PATCH 1/15] do blah..."). - -Simply exporting the thread is not enough, you need to skip any -feedbacks or cover letters that have been posted on the thread. - -This is what this script does. - -Example usage: - - $ notmuch-extract-patchset thread:000000000000265f > feature.patchset - $ git checkout -b test-feature - $ git am feature.patchet - - -You can use the following to use it directly from emacs: - - (defun apply-thread-patchset (repo branch) - (interactive "Dgit repo: \nsnew branch name: ") - (let ((tid notmuch-show-thread-id) - (tmp "/tmp/notmuch-patchset")) - (shell-command (format "notmuch-extract-patch %s > %s && ( cd %s && git checkout -b %s && git am %s )" - (shell-quote-argument tid) - (shell-quote-argument tmp) - (shell-quote-argument (expand-file-name repo)) - (shell-quote-argument branch) - (shell-quote-argument tmp))))) diff --git a/notmuch-extract-patch/notmuch-extract-patch b/notmuch-extract-patch/notmuch-extract-patch deleted file mode 100755 index f9e03f2..0000000 --- a/notmuch-extract-patch/notmuch-extract-patch +++ /dev/null @@ -1,100 +0,0 @@ -#!/usr/bin/env python3 -# -# Extract git patchset from notmuch emails -# -# Copyright (C) 2017 Aurelien Aptel -# Copyright (C) 2019 Sean Whitton -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . - -import mailbox -import sys -import tempfile -import subprocess -import re -import getopt - -def get_body(message): - body = None - if message.is_multipart(): - for part in message.walk(): - if part.is_multipart(): - for subpart in part.walk(): - if subpart.get_content_type() == 'text/plain': - body = subpart.get_payload(decode=True) - elif part.get_content_type() == 'text/plain': - body = part.get_payload(decode=True) - elif message.get_content_type() == 'text/plain': - body = message.get_payload(decode=True) - - if isinstance(body, bytes): - body = body.decode('utf-8') - return body - - -def is_git_patch(msg): - # we want to skip cover letters, hence why we look for @@ - body = get_body(msg) - match = re.search(r'''\n@@ [0-9 +,-]+ @@''', body) - # return ("git-send-email" in msg['x-mailer'] and match) - return match - -def has_reroll_count(msg, v): - subject_prefix = get_subject_prefix(msg['subject']) - if subject_prefix is not None: - return "v"+str(v) in subject_prefix \ - or (v == 1 and not any(entry[0] == 'v' for entry in subject_prefix)) - -def get_subject_prefix(s): - match = re.search(r'''\[(.*PATCH.*)\]''', s) - if match: - return match.group(1).split() - -# if Subject: contains [PATCH nn/mm] then any text before that should -# be stripped, as it should not form part of the commit message. (The -# debbugs system prepends 'Bug#nnnnnn: ') -def munge_subject(msg): - match = re.search(r'''\[(.*PATCH.*)\].*$''', msg['subject']) - if match: - del msg['subject'] - msg['subject'] = match.group(0) - -def main(): - try: - opts, query = getopt.getopt(sys.argv[1:], "v:", ["reroll-count="]) - except getopt.GetoptError as err: - sys.stderr.write(str(err)+"\n") - sys.exit(2) - reroll_count = 1 - for o, a in opts: - if o in ("-v", "--reroll-count"): - reroll_count = int(a) - with tempfile.NamedTemporaryFile() as in_mb_file: - out = subprocess.check_output(['notmuch', 'show', '--format=mbox']+query) - in_mb_file.write(out) - in_mb_file.flush() - - in_mb = mailbox.mbox(in_mb_file.name) - with tempfile.NamedTemporaryFile() as out_mb_file: - out_mb = mailbox.mbox(out_mb_file.name) - for m in in_mb: - if is_git_patch(m) and has_reroll_count(m, reroll_count): - sys.stderr.write(m['subject']+"\n") - munge_subject(m) - out_mb.add(m) - out_mb.flush() - print(open(out_mb_file.name).read()) - -if __name__ == '__main__': - main() -- cgit v1.2.3 From 8d52c3f7200582d4711ef0a189a535892ce9d652 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sat, 15 Feb 2020 15:05:30 -0700 Subject: mailscripts.el: don't always pass --reroll-count Signed-off-by: Sean Whitton --- debian/changelog | 3 +++ mailscripts.el | 15 ++++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/debian/changelog b/debian/changelog index aa988d0..076bc77 100644 --- a/debian/changelog +++ b/debian/changelog @@ -9,6 +9,9 @@ mailscripts (0.18-1) UNRELEASED; urgency=medium + --trailers is on by default; use --no-trailers to disable. - Stop outputting message subjects on standard error. * New dependencies on liblist-moreutils-perl, libmail-box-perl. + * mailscripts.el: instead of defaulting to passing --reroll-count=1 to + notmuch-extract-patch, don't pass any reroll count unless there is a + prefix arg. -- Sean Whitton Sat, 15 Feb 2020 09:06:56 -0700 diff --git a/mailscripts.el b/mailscripts.el index 3d65006..fd60222 100644 --- a/mailscripts.el +++ b/mailscripts.el @@ -67,7 +67,7 @@ See notmuch-extract-patch(1) manpage for limitations: in particular, this Emacs Lisp function supports passing only entire threads to the notmuch-extract-patch(1) command." (interactive - "Dgit repo: \nsbranch name (or leave blank to apply to current HEAD): \np") + "Dgit repo: \nsbranch name (or leave blank to apply to current HEAD): \nP") (let ((thread-id ;; If `notmuch-show' was called with a notmuch query rather ;; than a thread ID, as `org-notmuch-follow-link' in @@ -82,9 +82,12 @@ threads to the notmuch-extract-patch(1) command." (default-directory (expand-file-name repo))) (mailscripts--check-out-branch branch) (shell-command - (format "notmuch-extract-patch -v%d %s | git am" - (if reroll-count reroll-count 1) - (shell-quote-argument thread-id)) + (if reroll-count + (format "notmuch-extract-patch -v%d %s | git am" + (prefix-numeric-value reroll-count) + (shell-quote-argument thread-id)) + (format "notmuch-extract-patch %s | git am" + (shell-quote-argument thread-id))) "*notmuch-apply-thread-series*"))) ;;;###autoload @@ -92,7 +95,9 @@ threads to the notmuch-extract-patch(1) command." "Like `notmuch-extract-thread-patches', but use projectile to choose the repo." (interactive) (mailscripts--projectile-repo-and-branch - 'notmuch-extract-thread-patches (prefix-numeric-value current-prefix-arg))) + 'notmuch-extract-thread-patches + (when current-prefix-arg + (prefix-numeric-value current-prefix-arg)))) ;;;###autoload (defun notmuch-extract-message-patches (repo branch) -- cgit v1.2.3 From 0c5cc9ebfe5ab119f5e6701f4b9228e3ededd5d8 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sat, 15 Feb 2020 15:08:57 -0700 Subject: fix version Signed-off-by: Sean Whitton --- mailscripts.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mailscripts.el b/mailscripts.el index fd60222..0658c76 100644 --- a/mailscripts.el +++ b/mailscripts.el @@ -1,7 +1,7 @@ ;;; mailscripts.el --- functions to access tools in the mailscripts package ;; Author: Sean Whitton -;; Version: 0.17 +;; Version: 0.18 ;; Package-Requires: (notmuch projectile) ;; Copyright (C) 2018, 2019 Sean Whitton -- cgit v1.2.3 From bbf1fc63fa1d88ea204a8cf272511ca85a828794 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sat, 15 Feb 2020 15:11:00 -0700 Subject: release 0.18 (-1 to Debian unstable) Signed-off-by: Sean Whitton --- debian/changelog | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/debian/changelog b/debian/changelog index 076bc77..418b1c9 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,4 @@ -mailscripts (0.18-1) UNRELEASED; urgency=medium +mailscripts (0.18-1) unstable; urgency=medium * notmuch-extract-patch: rewrite: - Split into notmuch-extract-patch(1) and mbox-extract-patch(1). @@ -13,7 +13,7 @@ mailscripts (0.18-1) UNRELEASED; urgency=medium notmuch-extract-patch, don't pass any reroll count unless there is a prefix arg. - -- Sean Whitton Sat, 15 Feb 2020 09:06:56 -0700 + -- Sean Whitton Sat, 15 Feb 2020 15:10:56 -0700 mailscripts (0.17-1) unstable; urgency=medium -- cgit v1.2.3