git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 2/6] refactor git_getpass into generic prompt function

From
Jeff King <peff@peff.net>
Date
Nov 27, 2011, 08:29 UTC
Message-ID
<20111127082932.GB1702@sigill.intra.peff.net>
In-Reply-To
<20111127082744.GA32068@sigill.intra.peff.net>

This will allow callers to specify more options (e.g., leaving echo on). The original git_getpass becomes a slim wrapper around the new function.

Signed-off-by: Jeff King <peff@peff.net>
---
Making askpass optional isn't necessary for this series, but splitting
it actually makes the code a little cleaner, imho, and some callers
might eventually want to turn it off.
 prompt.c |   41 +++++++++++++++++++++++++----------------
 prompt.h |    3 +++
 2 files changed, 28 insertions(+), 16 deletions(-)
diff --git a/prompt.c b/prompt.c
index 42a1c9f..7c8f9aa 100644
--- a/prompt.c
+++ b/prompt.c
@@ -3,26 +3,13 @@
 #include "strbuf.h"
 #include "prompt.h"
 
-char *git_getpass(const char *prompt)
+static char *do_askpass(const char *cmd, const char *prompt, const char *name)
 {
-	const char *askpass;
 	struct child_process pass;
 	const char *args[3];
 	static struct strbuf buffer = STRBUF_INIT;
 
-	askpass = getenv("GIT_ASKPASS");
-	if (!askpass)
-		askpass = askpass_program;
-	if (!askpass)
-		askpass = getenv("SSH_ASKPASS");
-	if (!askpass || !(*askpass)) {
-		char *result = getpass(prompt);
-		if (!result)
-			die_errno("Could not read password");
-		return result;
-	}
-
-	args[0] = askpass;
+	args[0] = cmd;
 	args[1]	= prompt;
 	args[2] = NULL;
 
@@ -35,7 +22,7 @@
 
 	strbuf_reset(&buffer);
 	if (strbuf_read(&buffer, pass.out, 20) < 0)
-		die("failed to read password from %s\n", askpass);
+		die("failed to read %s from %s\n", name, cmd);
 
 	close(pass.out);
 
@@ -46,3 +33,25 @@
 
 	return buffer.buf;
 }
+
+char *git_prompt(const char *prompt, const char *name, int flags)
+{
+	if (flags & PROMPT_ASKPASS) {
+		const char *askpass;
+
+		askpass = getenv("GIT_ASKPASS");
+		if (!askpass)
+			askpass = askpass_program;
+		if (!askpass)
+			askpass = getenv("SSH_ASKPASS");
+		if (askpass && *askpass)
+			return do_askpass(askpass, prompt, name);
+	}
+
+	return getpass(prompt);
+}
+
+char *git_getpass(const char *prompt)
+{
+	return git_prompt(prompt, "password", PROMPT_ASKPASS);
+}
diff --git a/prompt.h b/prompt.h
index 0fd7bd9..18868c2 100644
--- a/prompt.h
+++ b/prompt.h
@@ -1,6 +1,9 @@
 #ifndef PROMPT_H
 #define PROMPT_H
 
+#define PROMPT_ASKPASS (1<<0)
+
+char *git_prompt(const char *prompt, const char *name, int flags);
 char *git_getpass(const char *prompt);
 
 #endif /* PROMPT_H */
-- 
1.7.7.4.7.g24824
Previous: Jeff KingNext: Jeff King
Message 37 of 49 in “credential helpers, take two”
  1. 0/13 credential helpers, take twoJeff King, Nov 24, 2011
  2. 01/13 test-lib: add test_config_global variantJeff King, Nov 24, 2011
  3. 02/13 t5550: fix typoJeff King, Nov 24, 2011
  4. 03/13 introduce credentials APIJeff King, Nov 24, 2011
  5. Junio C HamanoNov 28, 2011
  6. Jeff KingNov 29, 2011
  7. Junio C HamanoNov 29, 2011
  8. Jeff KingNov 29, 2011
  9. 04/13 credential: add function for parsing url componentsJeff King, Nov 24, 2011
  10. 05/13 http: use credential API to get passwordsJeff King, Nov 24, 2011
  11. 06/13 credential: apply helper configJeff King, Nov 24, 2011
  12. 07/13 credential: add credential.*.usernameJeff King, Nov 24, 2011
  13. 08/13 credential: make relevance of http path configurableJeff King, Nov 24, 2011
  14. 09/13 docs: end-user documentation for the credential subsystemJeff King, Nov 24, 2011
  15. 10/13 credentials: add "cache" helperJeff King, Nov 24, 2011
  16. Eric SunshineNov 24, 2011
  17. Junio C HamanoNov 29, 2011
  18. Jeff KingNov 29, 2011
  19. 11/13 strbuf: add strbuf_add*_urlencodeJeff King, Nov 24, 2011
  20. Junio C HamanoNov 29, 2011
  21. Jeff KingNov 29, 2011
  22. René ScharfeNov 29, 2011
  23. Jeff KingNov 30, 2011
  24. Junio C HamanoNov 30, 2011
  25. René ScharfeNov 30, 2011
  26. 12/13 credentials: add "store" helperJeff King, Nov 24, 2011
  27. Eric SunshineNov 24, 2011
  28. Jeff KingNov 24, 2011
  29. Junio C HamanoNov 29, 2011
  30. Jeff KingNov 29, 2011
  31. 13/13 t: add test harness for external credential helpersJeff King, Nov 24, 2011
  32. Erik Faye-LundNov 24, 2011
  33. Jeff KingNov 24, 2011
  34. Erik Faye-LundNov 24, 2011
  35. 0/6 echo usernames as they are typedJeff King, Nov 27, 2011
  36. 1/6 move git_getpass to its own source fileJeff King, Nov 27, 2011
  37. 2/6 refactor git_getpass into generic prompt functionJeff King, Nov 27, 2011
  38. 3/6 stub out getpass_echo functionJeff King, Nov 27, 2011
  39. 4/6 prompt: add PROMPT_ECHO flagJeff King, Nov 27, 2011
  40. 5/6 credential: use git_prompt instead of git_getpassJeff King, Nov 27, 2011
  41. 6/6 compat/getpass: add a /dev/tty implementationJeff King, Nov 27, 2011
  42. Junio C HamanoNov 27, 2011
  43. Erik Faye-LundNov 27, 2011
  44. Jeff KingNov 28, 2011
  45. Erik Faye-LundNov 28, 2011
  46. Jeff KingNov 28, 2011
  47. Frans KlaverNov 28, 2011
  48. Erik Faye-LundNov 28, 2011
  49. Jeff KingNov 28, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.