send-email: expose header information to git-send-email's sendemail-validate hook
v7 cover send-email: expose header information to git-send-email's sendemail-validate hook
Thank you both for the input on v6. I believe that I have incorporated all of your feedback. I decided to keep a few examples of headers in the documentation as I believe if I were someone wanting to write a hook I would find the example helpful. It points out unobvious things like Cc being capitalized as it is and also how multiple lines work.
Michael Strawbridge (2):
send-email: refactor header generation functions
send-email: expose header information to git-send-email's
sendemail-validate hook
Documentation/githooks.txt | 28 +++++++++++-- git-send-email.perl | 80 +++++++++++++++++++++++++------------- t/t9001-send-email.sh | 39 ++++++++++++++++++- 3 files changed, 113 insertions(+), 34 deletions(-)
Signature · 1 line
2.34.1
PATCH v7 1/2 send-email: refactor header generation functions
Split process_file and send_message into easier to use functions. Making SMTP header information widely available.
--- git-send-email.perl | 49 ++++++++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 18 deletions(-)
git-send-email.perl +31 -18
@@ -1495,16 +1495,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 +1537,22 @@ sub send_message { if (@xh) { $header .= join("\n", @xh) . "\n"; } + my $recipients_ref = \@recipients; + return ($recipients_ref, $to, $date, $gitversion, $cc, $ccline, $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_ref, $to, $date, $gitversion, $cc, $ccline, $header) = gen_header(); + my @recipients = @$recipients_ref; my @sendmail_parameters = ('-i', @recipients); my $raw_from = $sender;
@@ -1735,11 +1742,8 @@ sub send_message { $references = $initial_in_reply_to || ''; $message_num = 0; -# Prepares the email, prompts the user, sends it out -# Returns 0 if an edit was done and the function should be called again, or 1 -# otherwise. -sub process_file { - my ($t) = @_; +sub pre_process_file { + my ($t, $quiet) = @_; open my $fh, "<", $t or die sprintf(__("can't open file %s"), $t);
@@ -1893,9 +1897,9 @@ sub process_file { } close $fh; - push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t) + push @to, recipients_cmd("to-cmd", "to", $to_cmd, $t, $quiet) if defined $to_cmd; - push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t) + push @cc, recipients_cmd("cc-cmd", "cc", $cc_cmd, $t, $quiet) if defined $cc_cmd && !$suppress_cc{'cccmd'}; if ($broken_encoding{$t} && !$has_content_type) {
@@ -1954,6 +1958,15 @@ sub process_file { @initial_to = @to; } } +} + +# Prepares the email, prompts the user, and sends it out +# Returns 0 if an edit was done and the function should be called again, or 1 +# on the email being successfully sent out. +sub process_file { + my ($t) = @_; + + pre_process_file($t, $quiet); my $message_was_sent = send_message(); if ($message_was_sent == -1) {
@@ -2002,7 +2015,7 @@ sub process_file { # Execute a command (e.g. $to_cmd) to get a list of email addresses # and return a results array sub recipients_cmd { - my ($prefix, $what, $cmd, $file) = @_; + my ($prefix, $what, $cmd, $file, $quiet) = @_; my @addresses = (); open my $fh, "-|", "$cmd \Q$file\E"
Signature · 1 line
2.34.1
PATCH v7 2/2 send-email: expose header information to git-send-email's sendemail-validate hook
In reply to Strawbridge, MichaelTo allow further flexibility in the Git hook, the SMTP header information of the email which git-send-email intends to send, is now passed as the 2nd argument to the sendemail-validate hook.
As an example, this can be useful for acting upon keywords in the subject or specific email addresses.
--- Documentation/githooks.txt | 28 +++++++++++++++++++++++---- git-send-email.perl | 31 ++++++++++++++++++++---------- t/t9001-send-email.sh | 39 ++++++++++++++++++++++++++++++++++++-- 3 files changed, 82 insertions(+), 16 deletions(-)
Documentation/githooks.txt +24 -4
@@ -583,10 +583,30 @@ 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 these command line arguments. They are, +1. the name of the file which holds the contents of the email to be sent. +2. The name of the file which holds the SMTP envelope and headers of the email. + +The SMTP envelope and headers are passed in the exact same way as they +are passed to the user's Mail Transport Agent (MTA). In effect, the email +given to the user's MTA, is the contents of $2 followed by the contents +of $1. + +Below is an example for a few common headers. Take notice of the +capitalization and multi-line tab structure. + + From: Example <[email protected]> + To: [email protected] + Cc: [email protected], + A <[email protected]>, + One <[email protected]>, + [email protected] + Subject: PATCH-STRING + +Exiting with a non-zero status causes `git send-email` to abort +before sending any e-mails. fsmonitor-watchman ~~~~~~~~~~~~~~~~~~
git-send-email.perl +21 -10
@@ -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);
@@ -1738,6 +1730,16 @@ sub send_message { return 1; } +if ($validate) { + foreach my $f (@files) { + unless (-p $f) { + pre_process_file($f, 1); + + validate_patch($f, $target_xfer_encoding); + } + } +} + $in_reply_to = $initial_in_reply_to; $references = $initial_in_reply_to || ''; $message_num = 0;
@@ -2101,11 +2103,20 @@ sub validate_patch { chdir($repo->wc_path() or $repo->repo_path()) or die("chdir: $!"); local $ENV{"GIT_DIR"} = $repo->repo_path(); + + my ($recipients_ref, $to, $date, $gitversion, $cc, $ccline, $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) {
t/t9001-send-email.sh +37 -2
@@ -540,7 +540,7 @@ test_expect_success $PREREQ "--validate respects relative core.hooksPath path" ' test_path_is_file my-hooks.ran && cat >expect <<-EOF && fatal: longline.patch: rejected by sendemail-validate hook - fatal: command '"'"'git hook run --ignore-missing sendemail-validate -- <patch>'"'"' died with exit code 1 + fatal: command '"'"'git hook run --ignore-missing sendemail-validate -- <patch> <header>'"'"' died with exit code 1 warning: no patches were sent EOF test_cmp expect actual
@@ -559,12 +559,47 @@ test_expect_success $PREREQ "--validate respects absolute core.hooksPath path" ' test_path_is_file my-hooks.ran && cat >expect <<-EOF && fatal: longline.patch: rejected by sendemail-validate hook - fatal: command '"'"'git hook run --ignore-missing sendemail-validate -- <patch>'"'"' died with exit code 1 + fatal: command '"'"'git hook run --ignore-missing sendemail-validate -- <patch> <header>'"'"' died with exit code 1 warning: no patches were sent EOF test_cmp expect actual ' +test_expect_success $PREREQ 'setup expect' " +cat >expected-headers <<\EOF +From: Example <[email protected]> +To: [email protected] +Cc: [email protected], + A <[email protected]>, + One <[email protected]>, + [email protected] +Subject: [PATCH 1/1] Second. +Date: DATE-STRING +Message-Id: MESSAGE-ID-STRING +X-Mailer: X-MAILER-STRING +Reply-To: Reply <[email protected]> +MIME-Version: 1.0 +Content-Transfer-Encoding: quoted-printable +EOF +" + +test_expect_success $PREREQ "--validate hook supports header argument" ' + write_script my-hooks/sendemail-validate <<-\EOF && + grep "X-test-header: v1.0" "$2" + EOF + test_config core.hooksPath "my-hooks" && + rm -fr outdir && + git format-patch \ + --add-header="X-test-header: v1.0" \ + -n HEAD^1 -o outdir && + git send-email \ + --dry-run \ + [email protected] \ + --smtp-server="$(pwd)/fake.sendmail" \ + --validate \ + outdir/000?-*.patch +' + for enc in 7bit 8bit quoted-printable base64 do test_expect_success $PREREQ "--transfer-encoding=$enc produces correct header" '
Signature · 1 line
2.34.1
Documentation/githooks.txt processed by rebase. · line 590
Quoted 5 lines · Michael
Documentation/githooks.txt +5
-0+This hook is invoked by linkgit:git-send-email[1]. + +It takes these command line arguments. They are, +1. the name of the file which holds the contents of the email to be sent. +2. The name of the file which holds the SMTP envelope and headers of the email.
The previous iteration said SMTP headers, but now this talks about envelope. I however did not think we have direct access to any envelope information [*] (i.e. such a feature is necessary if we want to send to one set of recipients by specifying their addresses in the envelope, while recording different set of recipients to the e-mail headers' To: and Cc: list)?
Side note. We can specify different sender and it gets passed as a command line argument "-f $sender" to the sendmail program, which is used in "MAIL FROM" SMTP envelope. But I do not think we muck with the list of recipients that appear in the header when we formulate "RCPT TO". And I do not see where you give "MAIL FROM" value in the input to the hook in the patch.
If we say "we will give your hook information in the envelope and headers" to those who know the distinction between the two, they will inevitably say "that is great. Now how do I tell which in file $2 are in the envelope and which are in the header, when some of them are different?"
We just hand the message plus the header, and let $sendmail_cmd come up with the envelope info using what is in the header, no? I am not sure we want to mention envelope as that would give readers a false impression that we may treat it separately from the headers.
Thanks.
Quoted 29 lines · Junio C Hamano
Documentation/githooks.txt processed by rebase. · line 590
Quoted 5 lines · Michael
Documentation/githooks.txt +5
-0+This hook is invoked by linkgit:git-send-email[1]. + +It takes these command line arguments. They are, +1. the name of the file which holds the contents of the email to be sent. +2. The name of the file which holds the SMTP envelope and headers of the email.The previous iteration said SMTP headers, but now this talks about envelope. I however did not think we have direct access to any envelope information [*] (i.e. such a feature is necessary if we want to send to one set of recipients by specifying their addresses in the envelope, while recording different set of recipients to the e-mail headers' To: and Cc: list)?
Side note. We can specify different sender and it gets passed as a command line argument "-f $sender" to the sendmail program, which is used in "MAIL FROM" SMTP envelope. But I do not think we muck with the list of recipients that appear in the header when we formulate "RCPT TO". And I do not see where you give "MAIL FROM" value in the input to the hook in the patch.
If we say "we will give your hook information in the envelope and headers" to those who know the distinction between the two, they will inevitably say "that is great. Now how do I tell which in file $2 are in the envelope and which are in the header, when some of them are different?"
Quoted 6 lines
We just hand the message plus the header, and let $sendmail_cmd come up with the envelope info using what is in the header, no? I am not sure we want to mention envelope as that would give readers a false impression that we may treat it separately from the headers.
Thanks.
That's fair. I will remove the mention of envelope.