git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
	git@drmicha.warpmail.net,
	"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
Subject: [PATCH] git.c: fix help.autocorrect after 57ea712 breaks it
Date: Tue, 26 Jan 2016 20:26:41 +0700	[thread overview]
Message-ID: <1453814801-1925-1-git-send-email-pclouds@gmail.com> (raw)
In-Reply-To: <56A72235.9080602@drmicha.warpmail.net>

Commit 57ea712 (git.c: make sure we do not leak GIT_* to alias scripts -
2015-12-20) does not realize that handle_alias() can be called multiple
times because of the forever loop in run_argv(). The commit breaks alias
chains.

Suppose you have an alias "abc" that resolves to another alias "def",
which finally resolve to "git status". handle_alias() is called twice.
save_env() and restore_env() are also called twice. But because of the
check save_env_before_alias in save_env(), we save once while trying to
restore twice. Consequences are left for the reader's imagination.

Fortunately, you cannot make an alias of another alias. At least not
yet. Unfortunately it can still happen with help.autocorrect, where your
alias typo is treated as the first "alias", and it can be resolved to
the second alias. Then boom.

Make sure we call save_env() and restore_env() in pairs. While at there,
set orig_cwd to NULL after freeing it for hygiene.

Reported-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 git.c                  | 11 ++++++++---
 t/t1300-repo-config.sh |  8 ++++++++
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/git.c b/git.c
index da278c3..cd733f7 100644
--- a/git.c
+++ b/git.c
@@ -25,14 +25,15 @@ static const char *env_names[] = {
 	GIT_PREFIX_ENVIRONMENT
 };
 static char *orig_env[4];
-static int saved_env_before_alias;
+static int saved_env_before_alias, saved;
 
 static void save_env_before_alias(void)
 {
 	int i;
-	if (saved_env_before_alias)
-		return;
+	if (saved)
+		die("BUG: uneven pair of save_env/restore_env calls");
 	saved_env_before_alias = 1;
+	saved = 1;
 	orig_cwd = xgetcwd();
 	for (i = 0; i < ARRAY_SIZE(env_names); i++) {
 		orig_env[i] = getenv(env_names[i]);
@@ -44,9 +45,13 @@ static void save_env_before_alias(void)
 static void restore_env(int external_alias)
 {
 	int i;
+	if (saved != 1)
+		die("BUG: uneven pair of save_env/restore_env calls");
 	if (!external_alias && orig_cwd && chdir(orig_cwd))
 		die_errno("could not move to %s", orig_cwd);
 	free(orig_cwd);
+	orig_cwd = NULL;
+	saved = 0;
 	for (i = 0; i < ARRAY_SIZE(env_names); i++) {
 		if (external_alias &&
 		    !strcmp(env_names[i], GIT_PREFIX_ENVIRONMENT))
diff --git a/t/t1300-repo-config.sh b/t/t1300-repo-config.sh
index 52678e7..3f95285 100755
--- a/t/t1300-repo-config.sh
+++ b/t/t1300-repo-config.sh
@@ -1201,4 +1201,12 @@ test_expect_success POSIXPERM,PERL 'preserves existing permissions' '
 	  "die q(badrename) if ((stat(q(.git/config)))[2] & 07777) != 0600"
 '
 
+test_expect_success 'autocorrect and save_env/restore_env' '
+	git config alias.ss status &&
+	git config help.autocorrect 1 &&
+	git sss --porcelain | grep actual >actual &&
+	echo "?? actual" >expected &&
+	test_cmp expected actual
+'
+
 test_done
-- 
2.7.0.288.g1d8ad15

  parent reply	other threads:[~2016-01-26 13:29 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-26  7:37 [BUG] typo DWIMery with alias broken (cd to random dir) Michael J Gruber
2016-01-26 12:50 ` Duy Nguyen
2016-01-26 13:26 ` Nguyễn Thái Ngọc Duy [this message]
2016-01-26 14:39   ` [PATCH] git.c: fix help.autocorrect after 57ea712 breaks it Michael J Gruber
2016-01-26 17:44     ` Junio C Hamano
2016-01-26 19:02   ` Junio C Hamano
2016-01-26 20:11   ` Junio C Hamano
2016-01-27  6:49     ` Junio C Hamano
2016-01-27  6:50       ` [PATCH 2/3] git: protect against unbalanced calls to {save,restore}_env() Junio C Hamano
2016-01-27 23:19         ` [PATCH v2 " Junio C Hamano
2016-01-27  6:52       ` [PATCH 3/3] git: simplify environment save/restore logic Junio C Hamano
2016-01-27 23:22         ` [PATCH v2 " Junio C Hamano
2016-01-27 23:47           ` Junio C Hamano
2016-01-27  9:14       ` [PATCH] git.c: fix help.autocorrect after 57ea712 breaks it Duy Nguyen
2016-01-27 12:01         ` Junio C Hamano
2016-01-27 23:18           ` [PATCH v2 1/3] git: remove an early return from save_env_before_alias() Junio C Hamano
2016-02-02 23:47             ` [PATCH v3 1/4] " Junio C Hamano
2016-02-02 23:47             ` [PATCH v3 2/4] git: protect against unbalanced calls to {save,restore}_env() Junio C Hamano
2016-02-02 23:48             ` [PATCH v3 3/4] git: simplify environment save/restore logic Junio C Hamano
2016-02-02 23:50             ` [PATCH v3 4/4] restore_env(): free the saved environment variable once we are done Junio C Hamano
2016-02-03  1:47               ` Eric Sunshine
2016-02-03  2:19                 ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1453814801-1925-1-git-send-email-pclouds@gmail.com \
    --to=pclouds@gmail.com \
    --cc=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).