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

[PATCH v7 06/45] builtin-am: auto-detect mbox patches

From
Paul Tan <pyokagan@gmail.com>
Date
Aug 4, 2015, 13:51 UTC
Message-ID
<1438696326-19590-7-git-send-email-pyokagan@gmail.com>
In-Reply-To
<1438696326-19590-1-git-send-email-pyokagan@gmail.com>

Since 15ced75 (git-am foreign patch support: autodetect some patch formats, 2009-05-27), git-am.sh is able to autodetect mbox, stgit and mercurial patches through heuristics.

Re-implement support for autodetecting mbox/maildir files in builtin/am.c.

RFC 2822 requires that lines are terminated by "\r\n". To support this, implement strbuf_getline_crlf(), which will remove both '\n' and "\r\n" from the end of the line.

Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Helped-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Paul Tan <pyokagan@gmail.com>
---
 builtin/am.c | 109 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 109 insertions(+)
diff --git a/builtin/am.c b/builtin/am.c
index 5f3c131..c12566a 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -10,6 +10,21 @@
 #include "dir.h"
 #include "run-command.h"
 
+/**
+ * Like strbuf_getline(), but treats both '\n' and "\r\n" as line terminators.
+ */
+static int strbuf_getline_crlf(struct strbuf *sb, FILE *fp)
+{
+	if (strbuf_getwholeline(sb, fp, '\n'))
+		return EOF;
+	if (sb->buf[sb->len - 1] == '\n') {
+		strbuf_setlen(sb, sb->len - 1);
+		if (sb->len > 0 && sb->buf[sb->len - 1] == '\r')
+			strbuf_setlen(sb, sb->len - 1);
+	}
+	return 0;
+}
+
 enum patch_format {
 	PATCH_FORMAT_UNKNOWN = 0,
 	PATCH_FORMAT_MBOX
@@ -128,6 +143,92 @@ static void am_destroy(const struct am_state *state)
 }
 
 /**
+ * Determines if the file looks like a piece of RFC2822 mail by grabbing all
+ * non-indented lines and checking if they look like they begin with valid
+ * header field names.
+ *
+ * Returns 1 if the file looks like a piece of mail, 0 otherwise.
+ */
+static int is_mail(FILE *fp)
+{
+	const char *header_regex = "^[!-9;-~]+:";
+	struct strbuf sb = STRBUF_INIT;
+	regex_t regex;
+	int ret = 1;
+
+	if (fseek(fp, 0L, SEEK_SET))
+		die_errno(_("fseek failed"));
+
+	if (regcomp(&regex, header_regex, REG_NOSUB | REG_EXTENDED))
+		die("invalid pattern: %s", header_regex);
+
+	while (!strbuf_getline_crlf(&sb, fp)) {
+		if (!sb.len)
+			break; /* End of header */
+
+		/* Ignore indented folded lines */
+		if (*sb.buf == '\t' || *sb.buf == ' ')
+			continue;
+
+		/* It's a header if it matches header_regex */
+		if (regexec(&regex, sb.buf, 0, NULL, 0)) {
+			ret = 0;
+			goto done;
+		}
+	}
+
+done:
+	regfree(&regex);
+	strbuf_release(&sb);
+	return ret;
+}
+
+/**
+ * Attempts to detect the patch_format of the patches contained in `paths`,
+ * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
+ * detection fails.
+ */
+static int detect_patch_format(const char **paths)
+{
+	enum patch_format ret = PATCH_FORMAT_UNKNOWN;
+	struct strbuf l1 = STRBUF_INIT;
+	FILE *fp;
+
+	/*
+	 * We default to mbox format if input is from stdin and for directories
+	 */
+	if (!*paths || !strcmp(*paths, "-") || is_directory(*paths))
+		return PATCH_FORMAT_MBOX;
+
+	/*
+	 * Otherwise, check the first few lines of the first patch, starting
+	 * from the first non-blank line, to try to detect its format.
+	 */
+
+	fp = xfopen(*paths, "r");
+
+	while (!strbuf_getline_crlf(&l1, fp)) {
+		if (l1.len)
+			break;
+	}
+
+	if (starts_with(l1.buf, "From ") || starts_with(l1.buf, "From: ")) {
+		ret = PATCH_FORMAT_MBOX;
+		goto done;
+	}
+
+	if (l1.len && is_mail(fp)) {
+		ret = PATCH_FORMAT_MBOX;
+		goto done;
+	}
+
+done:
+	fclose(fp);
+	strbuf_release(&l1);
+	return ret;
+}
+
+/**
  * Splits out individual email patches from `paths`, where each path is either
  * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
  */
@@ -185,6 +286,14 @@ static int split_mail(struct am_state *state, enum patch_format patch_format,
 static void am_setup(struct am_state *state, enum patch_format patch_format,
 			const char **paths)
 {
+	if (!patch_format)
+		patch_format = detect_patch_format(paths);
+
+	if (!patch_format) {
+		fprintf_ln(stderr, _("Patch format detection failed."));
+		exit(128);
+	}
+
 	if (mkdir(state->dir, 0777) < 0 && errno != EEXIST)
 		die_errno(_("failed to create directory '%s'"), state->dir);
 
-- 
2.5.0.280.gd88bd6e
Previous: Paul TanNext: Paul Tan
Message 7 of 46 in “Make git-am a builtin”
  1. 00/45 Make git-am a builtinPaul Tan, Aug 4, 2015
  2. 01/45 wrapper: implement xopen()Paul Tan, Aug 4, 2015
  3. 02/45 wrapper: implement xfopen()Paul Tan, Aug 4, 2015
  4. 03/45 builtin-am: implement skeletal builtin amPaul Tan, Aug 4, 2015
  5. 04/45 builtin-am: implement patch queue mechanismPaul Tan, Aug 4, 2015
  6. 05/45 builtin-am: split out mbox/maildir patches with git-mailsplitPaul Tan, Aug 4, 2015
  7. 06/45 builtin-am: auto-detect mbox patchesPaul Tan, Aug 4, 2015
  8. 07/45 builtin-am: extract patch and commit info with git-mailinfoPaul Tan, Aug 4, 2015
  9. 08/45 builtin-am: apply patch with git-applyPaul Tan, Aug 4, 2015
  10. 09/45 builtin-am: implement committing applied patchPaul Tan, Aug 4, 2015
  11. 10/45 builtin-am: refuse to apply patches if index is dirtyPaul Tan, Aug 4, 2015
  12. 11/45 builtin-am: implement --resolved/--continuePaul Tan, Aug 4, 2015
  13. 12/45 builtin-am: don't parse mail when resumingPaul Tan, Aug 4, 2015
  14. 13/45 builtin-am: implement --skipPaul Tan, Aug 4, 2015
  15. 14/45 builtin-am: implement --abortPaul Tan, Aug 4, 2015
  16. 15/45 builtin-am: reject patches when there's a session in progressPaul Tan, Aug 4, 2015
  17. 16/45 builtin-am: implement -q/--quietPaul Tan, Aug 4, 2015
  18. 17/45 builtin-am: exit with user friendly message on failurePaul Tan, Aug 4, 2015
  19. 18/45 builtin-am: implement -s/--signoffPaul Tan, Aug 4, 2015
  20. 19/45 cache-tree: introduce write_index_as_tree()Paul Tan, Aug 4, 2015
  21. 20/45 builtin-am: implement --3wayPaul Tan, Aug 4, 2015
  22. 21/45 builtin-am: implement --rebasing modePaul Tan, Aug 4, 2015
  23. 22/45 builtin-am: bypass git-mailinfo when --rebasingPaul Tan, Aug 4, 2015
  24. 23/45 builtin-am: handle stray state directoryPaul Tan, Aug 4, 2015
  25. 24/45 builtin-am: implement -u/--utf8Paul Tan, Aug 4, 2015
  26. 25/45 builtin-am: implement -k/--keep, --keep-non-patchPaul Tan, Aug 4, 2015
  27. 26/45 builtin-am: implement --[no-]message-id, am.messageidPaul Tan, Aug 4, 2015
  28. 27/45 builtin-am: support --keep-cr, am.keepcrPaul Tan, Aug 4, 2015
  29. 28/45 builtin-am: implement --[no-]scissorsPaul Tan, Aug 4, 2015
  30. 29/45 builtin-am: pass git-apply's options to git-applyPaul Tan, Aug 4, 2015
  31. 30/45 builtin-am: implement --ignore-datePaul Tan, Aug 4, 2015
  32. 31/45 builtin-am: implement --committer-date-is-author-datePaul Tan, Aug 4, 2015
  33. 32/45 builtin-am: implement -S/--gpg-sign, commit.gpgsignPaul Tan, Aug 4, 2015
  34. 33/45 builtin-am: invoke post-rewrite hookPaul Tan, Aug 4, 2015
  35. 34/45 builtin-am: support automatic notes copyingPaul Tan, Aug 4, 2015
  36. 35/45 builtin-am: invoke applypatch-msg hookPaul Tan, Aug 4, 2015
  37. 36/45 builtin-am: invoke pre-applypatch hookPaul Tan, Aug 4, 2015
  38. 37/45 builtin-am: invoke post-applypatch hookPaul Tan, Aug 4, 2015
  39. 38/45 builtin-am: rerere supportPaul Tan, Aug 4, 2015
  40. 39/45 builtin-am: support and auto-detect StGit patchesPaul Tan, Aug 4, 2015
  41. 40/45 builtin-am: support and auto-detect StGit series filesPaul Tan, Aug 4, 2015
  42. 41/45 builtin-am: support and auto-detect mercurial patchesPaul Tan, Aug 4, 2015
  43. 42/45 builtin-am: implement -i/--interactivePaul Tan, Aug 4, 2015
  44. 43/45 builtin-am: implement legacy -b/--binary optionPaul Tan, Aug 4, 2015
  45. 44/45 builtin-am: check for valid committer identPaul Tan, Aug 4, 2015
  46. 45/45 builtin-am: remove redirection to git-am.shPaul Tan, Aug 4, 2015

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.