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

[PATCH 03/27] [GSOC] ref-filter: --format=%(raw) support --perl

From
ZheNing Hu via GitGitGadget <gitgitgadget@gmail.com>
Date
Aug 13, 2021, 08:22 UTC
Message-ID
<452ea887e6123bc74b1a2f563ab0ea7c650867b9.1628842990.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1016.git.1628842990.gitgitgadget@gmail.com>
From: ZheNing Hu <adlternative@gmail.com>

Because the perl language can handle binary data correctly, add the function perl_quote_buf_with_len(), which can specify the length of the data and prevent the data from being truncated at '\0' to help `--format="%(raw)"` support `--perl`.

Reviewed-by: Jacob Keller <jacob.keller@gmail.com>
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
---
 Documentation/git-for-each-ref.txt |  4 ++--
 quote.c                            | 17 +++++++++++++++++
 quote.h                            |  1 +
 ref-filter.c                       | 15 +++++++++++----
 t/t6300-for-each-ref.sh            | 19 +++++++++++++++++--
 5 files changed, 48 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index cbb6f87d13f..6da899c6296 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -241,8 +241,8 @@ raw:size::
 	The raw data size of the object.
 
 Note that `--format=%(raw)` can not be used with `--python`, `--shell`, `--tcl`,
-`--perl` because such language may not support arbitrary binary data in their
-string variable type.
+because such language may not support arbitrary binary data in their string
+variable type.
 
 The message in a commit or a tag object is `contents`, from which
 `contents:<part>` can be used to extract various parts out of:
diff --git a/quote.c b/quote.c
index 8a3a5e39eb1..26719d21d1e 100644
--- a/quote.c
+++ b/quote.c
@@ -471,6 +471,23 @@ void perl_quote_buf(struct strbuf *sb, const char *src)
 	strbuf_addch(sb, sq);
 }
 
+void perl_quote_buf_with_len(struct strbuf *sb, const char *src, size_t len)
+{
+	const char sq = '\'';
+	const char bq = '\\';
+	const char *c = src;
+	const char *end = src + len;
+
+	strbuf_addch(sb, sq);
+	while (c != end) {
+		if (*c == sq || *c == bq)
+			strbuf_addch(sb, bq);
+		strbuf_addch(sb, *c);
+		c++;
+	}
+	strbuf_addch(sb, sq);
+}
+
 void python_quote_buf(struct strbuf *sb, const char *src)
 {
 	const char sq = '\'';
diff --git a/quote.h b/quote.h
index 049d8dd0b3d..87ff458b06d 100644
--- a/quote.h
+++ b/quote.h
@@ -95,6 +95,7 @@ char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigne
 
 /* quoting as a string literal for other languages */
 void perl_quote_buf(struct strbuf *sb, const char *src);
+void perl_quote_buf_with_len(struct strbuf *sb, const char *src, size_t len);
 void python_quote_buf(struct strbuf *sb, const char *src);
 void tcl_quote_buf(struct strbuf *sb, const char *src);
 void basic_regex_quote_buf(struct strbuf *sb, const char *src);
diff --git a/ref-filter.c b/ref-filter.c
index 1e660f60c4b..f2454d34ce8 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -747,7 +747,10 @@ static void quote_formatting(struct strbuf *s, const char *str, ssize_t len, int
 		sq_quote_buf(s, str);
 		break;
 	case QUOTE_PERL:
-		perl_quote_buf(s, str);
+		if (len < 0)
+			perl_quote_buf(s, str);
+		else
+			perl_quote_buf_with_len(s, str, len);
 		break;
 	case QUOTE_PYTHON:
 		python_quote_buf(s, str);
@@ -1010,10 +1013,14 @@ int verify_ref_format(struct ref_format *format)
 		at = parse_ref_filter_atom(format, sp + 2, ep, &err);
 		if (at < 0)
 			die("%s", err.buf);
-		if (format->quote_style && used_atom[at].atom_type == ATOM_RAW &&
-		    used_atom[at].u.raw_data.option == RAW_BARE)
+
+		if ((format->quote_style == QUOTE_PYTHON ||
+		     format->quote_style == QUOTE_SHELL ||
+		     format->quote_style == QUOTE_TCL) &&
+		     used_atom[at].atom_type == ATOM_RAW &&
+		     used_atom[at].u.raw_data.option == RAW_BARE)
 			die(_("--format=%.*s cannot be used with"
-			      "--python, --shell, --tcl, --perl"), (int)(ep - sp - 2), sp + 2);
+			      "--python, --shell, --tcl"), (int)(ep - sp - 2), sp + 2);
 		cp = ep + 1;
 
 		if (skip_prefix(used_atom[at].name, "color:", &color))
diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh
index 18554f62d94..3d15d0a5360 100755
--- a/t/t6300-for-each-ref.sh
+++ b/t/t6300-for-each-ref.sh
@@ -915,8 +915,23 @@ test_expect_success '%(raw) with --tcl must fail' '
 	test_must_fail git for-each-ref --format="%(raw)" --tcl
 '
 
-test_expect_success '%(raw) with --perl must fail' '
-	test_must_fail git for-each-ref --format="%(raw)" --perl
+test_expect_success '%(raw) with --perl' '
+	git for-each-ref --format="\$name= %(raw);
+print \"\$name\"" refs/myblobs/blob1 --perl | perl >actual &&
+	cmp blob1 actual &&
+	git for-each-ref --format="\$name= %(raw);
+print \"\$name\"" refs/myblobs/blob3 --perl | perl >actual &&
+	cmp blob3 actual &&
+	git for-each-ref --format="\$name= %(raw);
+print \"\$name\"" refs/myblobs/blob8 --perl | perl >actual &&
+	cmp blob8 actual &&
+	git for-each-ref --format="\$name= %(raw);
+print \"\$name\"" refs/myblobs/first --perl | perl >actual &&
+	cmp one actual &&
+	git cat-file tree refs/mytrees/first > expected &&
+	git for-each-ref --format="\$name= %(raw);
+print \"\$name\"" refs/mytrees/first --perl | perl >actual &&
+	cmp expected actual
 '
 
 test_expect_success '%(raw) with --shell must fail' '

-- 
gitgitgadget
Previous: ZheNing Hu via GitGitGadgetNext: ZheNing Hu via GitGitGadget
Message 4 of 28 in “[GSOC] [RFC] cat-file: reuse ref-filter logic”
  1. 00/27 [GSOC] [RFC] cat-file: reuse ref-filter logicZheNing Hu via GitGitGadget, Aug 13, 2021
  2. 02/27 [GSOC] ref-filter: add %(raw) atomZheNing Hu via GitGitGadget, Aug 13, 2021
  3. 01/27 [GSOC] ref-filter: add obj-type check in grab contentsZheNing Hu via GitGitGadget, Aug 13, 2021
  4. 03/27 [GSOC] ref-filter: --format=%(raw) support --perlZheNing Hu via GitGitGadget, Aug 13, 2021
  5. 04/27 [GSOC] ref-filter: use non-const ref_format in *_atom_parser()ZheNing Hu via GitGitGadget, Aug 13, 2021
  6. 07/27 [GSOC] ref-filter: introduce free_ref_array_item_value() functionZheNing Hu via GitGitGadget, Aug 13, 2021
  7. 05/27 [GSOC] ref-filter: add %(rest) atomZheNing Hu via GitGitGadget, Aug 13, 2021
  8. 06/27 [GSOC] ref-filter: pass get_object() return value to their callersZheNing Hu via GitGitGadget, Aug 13, 2021
  9. 08/27 [GSOC] ref-filter: add cat_file_mode to ref_formatZheNing Hu via GitGitGadget, Aug 13, 2021
  10. 10/27 [GSOC] cat-file: add has_object_file() checkZheNing Hu via GitGitGadget, Aug 13, 2021
  11. 09/27 [GSOC] ref-filter: modify the error message and value in get_objectZheNing Hu via GitGitGadget, Aug 13, 2021
  12. 11/27 [GSOC] cat-file: change batch_objects parameter nameZheNing Hu via GitGitGadget, Aug 13, 2021
  13. 12/27 [GSOC] cat-file: create p1006-cat-file.shZheNing Hu via GitGitGadget, Aug 13, 2021
  14. 13/27 [GSOC] cat-file: reuse ref-filter logicZheNing Hu via GitGitGadget, Aug 13, 2021
  15. 14/27 [GSOC] cat-file: reuse err buf in batch_object_write()ZheNing Hu via GitGitGadget, Aug 13, 2021
  16. 15/27 [GSOC] cat-file: re-implement --textconv, --filters optionsZheNing Hu via GitGitGadget, Aug 13, 2021
  17. 16/27 [GSOC] ref-filter: remove grab_oid() functionZheNing Hu via GitGitGadget, Aug 13, 2021
  18. 17/27 [GSOC] ref-filter: performance optimization by skip parse_object_bufferZheNing Hu via GitGitGadget, Aug 13, 2021
  19. 18/27 [GSOC] ref-filter: use atom_type and merge two for loop in grab_personZheNing Hu via GitGitGadget, Aug 13, 2021
  20. 19/27 [GSOC] ref-filter: remove strlen from find_subposZheNing Hu via GitGitGadget, Aug 13, 2021
  21. 20/27 [GSOC] ref-filter: introducing xstrvfmt_len() and xstrfmt_len()ZheNing Hu via GitGitGadget, Aug 13, 2021
  22. 21/27 [GSOC] ref-filter: remove second parsing in format_ref_array_itemZheNing Hu via GitGitGadget, Aug 13, 2021
  23. 22/27 [GSOC] ref-filter: introduction ref_filter_slopbufZheNing Hu via GitGitGadget, Aug 13, 2021
  24. 23/27 [GSOC] ref-filter: add deref member to struct used_atomZheNing Hu via GitGitGadget, Aug 13, 2021
  25. 24/27 [GSOC] ref-filter: introduce symref_atom_parser()ZheNing Hu via GitGitGadget, Aug 13, 2021
  26. 25/27 [GSOC] ref-filter: use switch case instread of if elseZheNing Hu via GitGitGadget, Aug 13, 2021
  27. 27/27 [GSOC] ref-filter: add need_get_object_info flag to struct expand_dataZheNing Hu via GitGitGadget, Aug 13, 2021
  28. 26/27 [GSOC] ref-filter: reuse finnal buffer if no stack needZheNing Hu via GitGitGadget, Aug 13, 2021

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.