Skip to contentSkip to conversation

Expose header information to git-send-email's sendemail-validate hook

PATCH In review Michael Strawbridge 3 participants 7 messages Apr 19, 2023 – May 2, 2023 1 message not in the archive Documentation

lore
Share & tools
lore
#0 lore raw

v10 cover Expose header information to git-send-email's sendemail-validate hook

My appologies for taking a while to get back to this. Here is a reroll with the latest suggestions from Luben.

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 | 27 +++++++++--
 git-send-email.perl        | 97 +++++++++++++++++++++++---------------
 t/t9001-send-email.sh      | 27 ++++++++++-
 3 files changed, 108 insertions(+), 43 deletions(-)
Signature · 1 line
2.34.1
#1 lore raw

PATCH v10 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.

Cc Luben Tuikov <[email protected]>
Cc Junio C Hamano <[email protected]>
Cc Ævar Arnfjörð Bjarmason <[email protected]>
---
 git-send-email.perl | 49 ++++++++++++++++++++++++++++-----------------
 1 file changed, 31 insertions(+), 18 deletions(-)
git-send-email.perl +31 -18
index 07f2a0cbea..0a44c0e5cb 100755
@@ -1502,16 +1502,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
@@ -1553,6 +1544,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;
@@ -1742,11 +1749,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);
 
@@ -1900,9 +1904,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) {
@@ -1961,6 +1965,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) {
@@ -2009,7 +2022,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
#2 lore raw

PATCH v10 2/2 send-email: expose header information to git-send-email's sendemail-validate hook

In reply to Michael Strawbridge

To 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.

Cc Luben Tuikov <[email protected]>
Cc Junio C Hamano <[email protected]>
Cc Ævar Arnfjörð Bjarmason <[email protected]>
---
 Documentation/githooks.txt | 27 +++++++++++++++++----
 git-send-email.perl        | 48 +++++++++++++++++++++++---------------
 t/t9001-send-email.sh      | 27 +++++++++++++++++++--
 3 files changed, 77 insertions(+), 25 deletions(-)
Documentation/githooks.txt +23 -4
index 62908602e7..9896ffafaf 100644
@@ -595,10 +595,29 @@ 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 headers of the email.
+
+The SMTP 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.
+
+An example of a few common headers is shown below. 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 +29 -19

83 lines not on this page · raw message

t/t9001-send-email.sh +25 -2
index 323952a572..e8c96d0d4e 100755
@@ -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,35 @@ 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 "--validate hook supports header argument" '
+	write_script my-hooks/sendemail-validate <<-\EOF &&
+	if test "$#" -ge 2
+	then
+		grep "X-test-header: v1.0" "$2"
+	else
+		echo "No header arg passed"
+		exit 1
+	fi
+	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
#3 lore raw

Re: [PATCH v10 2/2] send-email: expose header information to git-send-email's sendemail-validate hook

Quoted 4 lines · Michael Strawbridge

To 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.

Quoted 8 lines

As an example, this can be useful for acting upon keywords in the subject or specific email addresses.

Cc Luben Tuikov <[email protected]>
Cc Junio C Hamano <[email protected]>
Cc Ævar Arnfjörð Bjarmason <[email protected]>

Thanks for posting this Michael. Perhaps this should be pushed now.

Regards,
Luben

Quoted 185 lines
---
 Documentation/githooks.txt | 27 +++++++++++++++++----
 git-send-email.perl        | 48 +++++++++++++++++++++++---------------
 t/t9001-send-email.sh      | 27 +++++++++++++++++++--
 3 files changed, 77 insertions(+), 25 deletions(-)
Documentation/githooks.txt +23 -4
index 62908602e7..9896ffafaf 100644
@@ -595,10 +595,29 @@ 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 headers of the email.
+
+The SMTP 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.
+
+An example of a few common headers is shown below. 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 +29 -19
index 0a44c0e5cb..a3bc7b33d4 100755
@@ -792,16 +792,31 @@ sub is_format_patch_arg {
 				    @rev_list_opts);
 }
 
-@files = handle_backup_files(@files);
+if (defined $sender) {
+	$sender =~ s/^\s+|\s+$//g;
+	($sender) = expand_aliases($sender);
+} else {
+	$sender = $repoauthor->() || $repocommitter->() || '';
+}
+
+# $sender could be an already sanitized address
+# (e.g. sendemail.from could be manually sanitized by user).
+# But it's a no-op to run sanitize_address on an already sanitized address.
+$sender = sanitize_address($sender);
+
+$time = time - scalar $#files;
 
 if ($validate) {
 	foreach my $f (@files) {
 		unless (-p $f) {
+		        pre_process_file($f, 1);
 			validate_patch($f, $target_xfer_encoding);
 		}
 	}
 }
 
+@files = handle_backup_files(@files);
+
 if (@files) {
 	unless ($quiet) {
 		print $_,"\n" for (@files);
@@ -1050,18 +1065,6 @@ sub file_declares_8bit_cte {
 	}
 }
 
-if (defined $sender) {
-	$sender =~ s/^\s+|\s+$//g;
-	($sender) = expand_aliases($sender);
-} else {
-	$sender = $repoauthor->() || $repocommitter->() || '';
-}
-
-# $sender could be an already sanitized address
-# (e.g. sendemail.from could be manually sanitized by user).
-# But it's a no-op to run sanitize_address on an already sanitized address.
-$sender = sanitize_address($sender);
-
 my $to_whom = __("To whom should the emails be sent (if anyone)?");
 my $prompting = 0;
 if (!@initial_to && !defined $to_cmd) {
@@ -1221,10 +1224,6 @@ sub make_message_id {
 	#print "new message id = $message_id\n"; # Was useful for debugging
 }
 
-
-
-$time = time - scalar $#files;
-
 sub unquote_rfc2047 {
 	local ($_) = @_;
 	my $charset;
@@ -2108,10 +2107,21 @@ 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(
+                            TEMPLATE => ".gitsendemail.header.XXXXXX",
+                            DIR => $repo->repo_path(),
+                            UNLINK => 1,
+                        );
+			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");
 			chdir($cwd_save) or die("chdir: $!");
 		}
t/t9001-send-email.sh +25 -2
index 323952a572..e8c96d0d4e 100755
@@ -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,35 @@ 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 "--validate hook supports header argument" '
+	write_script my-hooks/sendemail-validate <<-\EOF &&
+	if test "$#" -ge 2
+	then
+		grep "X-test-header: v1.0" "$2"
+	else
+		echo "No header arg passed"
+		exit 1
+	fi
+	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" '
#4 lore raw
In reply to Michael Strawbridge
Quoted 7 lines · Michael Strawbridge

My appologies for taking a while to get back to this. Here is a reroll with the latest suggestions from Luben.

Michael Strawbridge (2):
send-email: refactor header generation functions
send-email: expose header information to git-send-email's
sendemail-validate hook

This round did not see any further comments. Is everybody happy to see us declare victory on this front and merge it down to 'next'?

The topic does not make itself a reply to previous iterations, and the cover letter does not CC: anybody who gave reviews to earlier rounds, so it is a bit hard to answer the above question myself, unfortunately. I manually picked off a few names after finding v9 and v8 from the list archive and added them to Cc: of this message.

Thanks.

A message that is not in the archive (sent off-list or not yet received): [email protected]

#6 lore raw
Quoted 28 lines · Luben Tuikov

Begin forwarded message:

Quoted 26 lines

*From:* Junio C Hamano <[email protected]>
*Date:* May 1, 2023 at 17:58:41 EDT
*To:* Michael Strawbridge <[email protected]>
*Cc:* [email protected], Luben Tuikov <[email protected]>, Ævar Arnfjörð Bjarmason <[email protected]> *Subject:* *Re: [PATCH v10 0/2] Expose header information to git-send-email's sendemail-validate hook*

Quoted 7 lines · Michael Strawbridge

My appologies for taking a while to get back to this.  Here is a reroll with the latest suggestions from Luben.

Michael Strawbridge (2):
 send-email: refactor header generation functions
 send-email: expose header information to git-send-email's sendemail-validate hook

This round did not see any further comments.  Is everybody happy to see us declare victory on this front and merge it down to 'next'?

The topic does not make itself a reply to previous iterations, and the cover letter does not CC: anybody who gave reviews to earlier rounds, so it is a bit hard to answer the above question myself, unfortunately.  I manually picked off a few names after finding v9 and v8 from the list archive and added them to Cc: of this message.

Thanks.

Sounds good to me.

Signature · 2 lines
Regards,
Luben
#7 lore raw

Thanks.  I will do that in the future.

Quoted 29 lines · Luben Tuikov
Quoted 27 lines · Luben Tuikov

Begin forwarded message:

Quoted 25 lines

*From:* Junio C Hamano <[email protected]>
*Date:* May 1, 2023 at 17:58:41 EDT
*To:* Michael Strawbridge <[email protected]>
*Cc:* [email protected], Luben Tuikov <[email protected]>, Ævar Arnfjörð Bjarmason <[email protected]> *Subject:* *Re: [PATCH v10 0/2] Expose header information to git-send-email's sendemail-validate hook*

Quoted 7 lines · Michael Strawbridge

My appologies for taking a while to get back to this.  Here is a reroll with the latest suggestions from Luben.

Michael Strawbridge (2):
 send-email: refactor header generation functions
 send-email: expose header information to git-send-email's sendemail-validate hook

This round did not see any further comments.  Is everybody happy to see us declare victory on this front and merge it down to 'next'?

The topic does not make itself a reply to previous iterations, and the cover letter does not CC: anybody who gave reviews to earlier rounds, so it is a bit hard to answer the above question myself, unfortunately.  I manually picked off a few names after finding v9 and v8 from the list archive and added them to Cc: of this message.

Thanks.

Sounds good to me.