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

[PATCH 3/7] archive: support user tar-filters via --format

From
Jeff King <peff@peff.net>
Date
Jun 15, 2011, 22:33 UTC
Message-ID
<20110615223312.GC16807@sigill.intra.peff.net>
In-Reply-To
<20110615223030.GA16110@sigill.intra.peff.net>

The previous commit set up the infrastructure to read tar-filter configuration. This commit actually uses it to pipe the tar output through the specified filter.

Signed-off-by: Jeff King <peff@peff.net>
---
 archive-tar-filter.c |   48 ++++++++++++++++++++++++++++++++++++++++++++++++
 archive.c            |   16 +++++++++++++---
 archive.h            |    2 ++
 t/t5000-tar-tree.sh  |    6 +++---
 4 files changed, 66 insertions(+), 6 deletions(-)
diff --git a/archive-tar-filter.c b/archive-tar-filter.c
index 211f1df..ffe510e 100644
--- a/archive-tar-filter.c
+++ b/archive-tar-filter.c
@@ -1,5 +1,6 @@
 #include "cache.h"
 #include "archive.h"
+#include "run-command.h"
 
 struct tar_filter *tar_filters;
 static struct tar_filter **tar_filters_tail = &tar_filters;
@@ -110,3 +111,50 @@ extern void tar_filter_load_config(void)
 	git_config(tar_filter_config, NULL);
 	remove_filters_without_command();
 }
+
+static int write_tar_to_filter(struct archiver_args *args, const char *cmd)
+{
+	struct child_process filter;
+	const char *argv[2];
+	int r;
+
+	memset(&filter, 0, sizeof(filter));
+	argv[0] = cmd;
+	argv[1] = NULL;
+	filter.argv = argv;
+	filter.use_shell = 1;
+	filter.in = -1;
+
+	if (start_command(&filter) < 0)
+		die_errno("unable to start '%s' filter", argv[0]);
+	close(1);
+	if (dup2(filter.in, 1) < 0)
+		die_errno("unable to redirect descriptor");
+	close(filter.in);
+
+	r = write_tar_archive(args);
+
+	close(1);
+	if (finish_command(&filter) != 0)
+		die("'%s' filter reported error", argv[0]);
+
+	return r;
+}
+
+int write_tar_filter_archive(struct archiver_args *args)
+{
+	struct strbuf cmd = STRBUF_INIT;
+	int r;
+
+	if (!args->tar_filter)
+		die("BUG: tar-filter archiver called with no filter defined");
+
+	strbuf_addstr(&cmd, args->tar_filter->command);
+	if (args->tar_filter->use_compression && args->compression_level >= 0)
+		strbuf_addf(&cmd, " -%d", args->compression_level);
+
+	r = write_tar_to_filter(args, cmd.buf);
+
+	strbuf_release(&cmd);
+	return r;
+}
diff --git a/archive.c b/archive.c
index 2ed9259..cf58faa 100644
--- a/archive.c
+++ b/archive.c
@@ -24,6 +24,9 @@ static const struct archiver {
 	{ "tar", write_tar_archive },
 	{ "zip", write_zip_archive, USES_ZLIB_COMPRESSION },
 };
+static const struct archiver tar_filter_archiver = {
+	"tar-filter", write_tar_filter_archive
+};
 
 static void format_subst(const struct commit *commit,
                          const char *src, size_t len,
@@ -364,12 +367,19 @@ static int parse_archive_args(int argc, const char **argv,
 	if (argc < 1)
 		usage_with_options(archive_usage, opts);
 	*ar = lookup_archiver(format);
-	if (!*ar)
-		die("Unknown archive format '%s'", format);
+
+	/* Fallback to user-configured tar filters */
+	if (!*ar) {
+		args->tar_filter = tar_filter_by_name(format);
+		if (!args->tar_filter)
+			die("Unknown archive format '%s'", format);
+		*ar = &tar_filter_archiver;
+	}
 
 	args->compression_level = Z_DEFAULT_COMPRESSION;
 	if (compression_level != -1) {
-		if ((*ar)->flags & USES_ZLIB_COMPRESSION)
+		if ((*ar)->flags & USES_ZLIB_COMPRESSION ||
+		    (args->tar_filter && args->tar_filter->use_compression))
 			args->compression_level = compression_level;
 		else {
 			die("Argument not supported for format '%s': -%d",
diff --git a/archive.h b/archive.h
index 8386c46..fb2bb9e 100644
--- a/archive.h
+++ b/archive.h
@@ -14,6 +14,7 @@ struct archiver_args {
 	unsigned int verbose : 1;
 	unsigned int worktree_attributes : 1;
 	int compression_level;
+	struct tar_filter *tar_filter;
 };
 
 typedef int (*write_archive_fn_t)(struct archiver_args *);
@@ -25,6 +26,7 @@ typedef int (*write_archive_entry_fn_t)(struct archiver_args *args, const unsign
  */
 extern int write_tar_archive(struct archiver_args *);
 extern int write_zip_archive(struct archiver_args *);
+extern int write_tar_filter_archive(struct archiver_args *);
 
 extern int write_archive_entries(struct archiver_args *args, write_archive_entry_fn_t write_entry);
 extern int write_archive(int argc, const char **argv, const char *prefix, int setup_prefix);
diff --git a/t/t5000-tar-tree.sh b/t/t5000-tar-tree.sh
index c3e1a4e..2b2b128 100755
--- a/t/t5000-tar-tree.sh
+++ b/t/t5000-tar-tree.sh
@@ -256,11 +256,11 @@ test_expect_success 'setup fake tar filter' '
 	git config tarfilter.fake.command "cat >/dev/null; echo args: "
 '
 
-test_expect_failure 'filter does not allow compression levels by default' '
+test_expect_success 'filter does not allow compression levels by default' '
 	test_must_fail git archive --format=fake -9 HEAD >output
 '
 
-test_expect_failure 'filters can allow compression levels' '
+test_expect_success 'filters can allow compression levels' '
 	git config tarfilter.fake.compressionlevels true &&
 	echo "args: -9" >expect &&
 	git archive --format=fake -9 HEAD >output &&
@@ -283,7 +283,7 @@ test_expect_success 'setup slightly more useful tar filter' '
 	git config --add tarfilter.foo.extension bar
 '
 
-test_expect_failure 'archive outputs in configurable format' '
+test_expect_success 'archive outputs in configurable format' '
 	git archive --format=foo HEAD >config.tar.foo &&
 	tr ab ba <config.tar.foo >config.tar &&
 	test_cmp b.tar config.tar

-- 
1.7.6.rc1.4.g49204
Previous: Jeff KingNext: Jeff King
Message 13 of 56 in “archive: factor out write phase of tar format”
  1. 1/2 archive: factor out write phase of tar formatJeff King, Jun 14, 2011
  2. 2/2 archive: support gzipped tar filesJeff King, Jun 14, 2011
  3. J.H.Jun 14, 2011
  4. Jeff KingJun 14, 2011
  5. René ScharfeJun 14, 2011
  6. Jeff KingJun 14, 2011
  7. Jeff KingJun 14, 2011
  8. 0/7 user-configurable git-archive output formatsJeff King, Jun 15, 2011
  9. 1/7 archive: reorder option parsing and config readingJeff King, Jun 15, 2011
  10. 2/7 archive: add user-configurable tar-filter infrastructureJeff King, Jun 15, 2011
  11. Junio C HamanoJun 15, 2011
  12. Jeff KingJun 16, 2011
  13. 3/7 archive: support user tar-filters via --formatJeff King, Jun 15, 2011
  14. 4/7 archive: advertise user tar-filters in --listJeff King, Jun 15, 2011
  15. 5/7 archive: refactor format-guessing from filenameJeff King, Jun 15, 2011
  16. Junio C HamanoJun 15, 2011
  17. Jeff KingJun 16, 2011
  18. 6/7 archive: match extensions from user-configured formatsJeff King, Jun 15, 2011
  19. 7/7 archive: provide builtin .tar.gz filterJeff King, Jun 15, 2011
  20. Junio C HamanoJun 15, 2011
  21. Junio C HamanoJun 15, 2011
  22. Jeff KingJun 16, 2011
  23. Junio C HamanoJun 16, 2011
  24. Jeff KingJun 16, 2011
  25. Chris WebbJun 16, 2011
  26. Jeff KingJun 16, 2011
  27. Junio C HamanoJun 16, 2011
  28. Jeff KingJun 16, 2011
  29. John SzakmeisterJun 16, 2011
  30. Junio C HamanoJun 16, 2011
  31. Jeff KingJun 16, 2011
  32. René ScharfeJun 18, 2011
  33. Jakub NarebskiJun 18, 2011
  34. Junio C HamanoJun 20, 2011
  35. 0/9 configurable tar compressorsJeff King, Jun 22, 2011
  36. 1/9 archive: reorder option parsing and config readingJeff King, Jun 22, 2011
  37. 2/9 archive-tar: don't reload default config optionsJeff King, Jun 22, 2011
  38. 3/9 archive: refactor list of archive formatsJeff King, Jun 22, 2011
  39. Thiago FarinaJun 23, 2011
  40. Jeff KingJun 23, 2011
  41. 4/9 archive: pass archiver struct to write_archive callbackJeff King, Jun 22, 2011
  42. 5/9 archive: move file extension format-guessing lowerJeff King, Jun 22, 2011
  43. 6/9 archive: refactor file extension format-guessingJeff King, Jun 22, 2011
  44. 7/9 archive: implement configurable tar filtersJeff King, Jun 22, 2011
  45. Jeff KingJun 22, 2011
  46. René ScharfeJun 22, 2011
  47. Jeff KingJun 22, 2011
  48. 8/9 archive: provide builtin .tar.gz filterJeff King, Jun 22, 2011
  49. 9/9 upload-archive: allow user to turn off filtersJeff King, Jun 22, 2011
  50. Jeff KingJun 22, 2011
  51. Jeff KingJun 21, 2011
  52. René ScharfeJun 18, 2011
  53. Junio C HamanoJun 14, 2011
  54. Jeff KingJun 14, 2011
  55. Miles BaderJun 14, 2011
  56. Jeff KingJun 15, 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.