Expose header information to git-send-email's sendemail-validate hook
v3 cover Expose header information to git-send-email's sendemail-validate hook
I accidentally missed previous feedback to squash doc edit into main change of git-send-email.
Michael
Michael Strawbridge (1):
Expose header information to git-send-email's sendemail-validate hook
Documentation/githooks.txt | 8 +++--- git-send-email.perl | 57 +++++++++++++++++++++++++------------- 2 files changed, 41 insertions(+), 24 deletions(-)
Signature · 1 line
2.34.1
PATCH v3 1/1 Expose header information to git-send-email's sendemail-validate hook
To allow further flexibility in the git hook, the smtp header information of the email that git-send-email intends to send, is now passed as a 2nd argument to the sendemail-validate hook. Docs are also updated.
As an example, this can be useful for acting upon keywords in the subject or specific email addresses.
--- Documentation/githooks.txt | 8 +++--- git-send-email.perl | 57 +++++++++++++++++++++++++------------- 2 files changed, 41 insertions(+), 24 deletions(-)
Documentation/githooks.txt +4 -4
@@ -583,10 +583,10 @@ processed by rebase. sendemail-validate ~~~~~~~~~~~~~~~~~~ -This hook is invoked by linkgit:git-send-email[1]. It takes a single parameter, -the name of the file that holds the e-mail to be sent. Exiting with a -non-zero status causes `git send-email` to abort before sending any -e-mails. +This hook is invoked by linkgit:git-send-email[1]. It takes two parameters, +the name of a file that holds the patch and the name of a file that holds the +SMTP headers. Exiting with a non-zero status causes `git send-email` to abort +before sending any e-mails. fsmonitor-watchman ~~~~~~~~~~~~~~~~~~
git-send-email.perl +37 -20
90 lines not on this page · raw message
Signature · 1 line
2.34.1
Hi Michael,
Quoted 7 lines · Michael
To allow further flexibility in the git hook, the smtp header information of the email that git-send-email intends to send, is now passed as a 2nd argument to the sendemail-validate hook. Docs are also updated.
As an example, this can be useful for acting upon keywords in the subject or specific email addresses.
This patch seems to break t9001:
Error: failed: t9001.9 Verify commandline failure: t9001.9 Verify commandline test_cmp expected commandline1 + test_cmp expected commandline1 + test 2 -ne 2 + eval diff -u "$@" + diff -u expected commandline1 --- expected 2022-11-12 01:49:23.477741140 +0000 +++ commandline1 2022-11-12 01:49:21.921718804 +0000 @@ -1,4 +1 @@ [email protected]! [email protected]! [email protected]! [email protected]! error: last command exited with $?=1 not ok 9 - Verify commandline # # test_cmp expected # commandline1 #
See
https://github.com/gitgitgadget/git/actions/runs/3448445848/jobs/5755529504#step:4:1791
for details.
If you need help with debugging this, I would like to point you to the information I wrote up for the Git for Windows project (but it applies here, too):
https://github.com/git-for-windows/git/wiki/Running-Git's-regression-tests#running-individual-tests
Ciao,
Johannes
Quoted 131 lines
Cc Luben Tuikov <[email protected]>Cc brian m. carlson <[email protected]>Signed-off-by Michael Strawbridge <[email protected]>--- Documentation/githooks.txt | 8 +++--- git-send-email.perl | 57 +++++++++++++++++++++++++------------- 2 files changed, 41 insertions(+), 24 deletions(-)Documentation/githooks.txt +4
-4@@ -583,10 +583,10 @@ processed by rebase. sendemail-validate ~~~~~~~~~~~~~~~~~~ -This hook is invoked by linkgit:git-send-email[1]. It takes a single parameter, -the name of the file that holds the e-mail to be sent. Exiting with a -non-zero status causes `git send-email` to abort before sending any -e-mails. +This hook is invoked by linkgit:git-send-email[1]. It takes two parameters, +the name of a file that holds the patch and the name of a file that holds the +SMTP headers. Exiting with a non-zero status causes `git send-email` to abort +before sending any e-mails. fsmonitor-watchman ~~~~~~~~~~~~~~~~~~git-send-email.perl +37
-21@@ -787,14 +787,6 @@ sub is_format_patch_arg { @files = handle_backup_files(@files); -if ($validate) { - foreach my $f (@files) { - unless (-p $f) { - validate_patch($f, $target_xfer_encoding); - } - } -} - if (@files) { unless ($quiet) { print $_,"\n" for (@files);@@ -1495,16 +1487,7 @@ sub file_name_is_absolute { return File::Spec::Functions::file_name_is_absolute($path); } -# Prepares the email, then asks the user what to do. -# -# If the user chooses to send the email, it's sent and 1 is returned. -# If the user chooses not to send the email, 0 is returned. -# If the user decides they want to make further edits, -1 is returned and the -# caller is expected to call send_message again after the edits are performed. -# -# If an error occurs sending the email, this just dies. - -sub send_message { +sub gen_header { my @recipients = unique_email_list(@to); @cc = (grep { my $cc = extract_valid_address_or_die($_); not grep { $cc eq $_ || $_ =~ /<\Q${cc}\E>$/ } @recipients@@ -1546,6 +1529,22 @@ sub send_message { if (@xh) { $header .= join("\n", @xh) . "\n"; } + return $header; +} + +# Prepares the email, then asks the user what to do. +# +# If the user chooses to send the email, it's sent and 1 is returned. +# If the user chooses not to send the email, 0 is returned. +# If the user decides they want to make further edits, -1 is returned and the +# caller is expected to call send_message again after the edits are performed. +# +# If an error occurs sending the email, this just dies. + +sub send_message { + my @recipients = unique_email_list(@to); + + my $header = gen_header(); my @sendmail_parameters = ('-i', @recipients); my $raw_from = $sender;@@ -1955,6 +1954,15 @@ sub process_file { } } + + if ($validate) { + foreach my $f (@files) { + unless (-p $f) { + validate_patch($f, $target_xfer_encoding); + } + } + } + my $message_was_sent = send_message(); if ($message_was_sent == -1) { do_edit($t);@@ -2088,11 +2096,20 @@ sub validate_patch { chdir($repo->wc_path() or $repo->repo_path()) or die("chdir: $!"); local $ENV{"GIT_DIR"} = $repo->repo_path(); + + my $header = gen_header(); + + require File::Temp; + my ($header_filehandle, $header_filename) = File::Temp::tempfile( + ".gitsendemail.header.XXXXXX", DIR => $repo->repo_path()); + print $header_filehandle $header; + my @cmd = ("git", "hook", "run", "--ignore-missing", $hook_name, "--"); - my @cmd_msg = (@cmd, "<patch>"); - my @cmd_run = (@cmd, $target); + my @cmd_msg = (@cmd, "<patch>", "<header>"); + my @cmd_run = (@cmd, $target, $header_filename); $hook_error = system_or_msg(\@cmd_run, undef, "@cmd_msg"); + unlink($header_filehandle); chdir($cwd_save) or die("chdir: $!"); } if ($hook_error) { --2.34.1