convert: move multiple file filter error handling to separate function
[gitweb.git] / convert.c
index 8d652bf27c9444d3696c4b942dc85f062e2bf53e..e55c034d86c7d28f5f90788a4e2c2dfb8a554cbe 100644 (file)
--- a/convert.c
+++ b/convert.c
@@ -4,6 +4,7 @@
 #include "quote.h"
 #include "sigchain.h"
 #include "pkt-line.h"
+#include "sub-process.h"
 
 /*
  * convert.c - convert a file when checking it out and checking it in.
@@ -497,126 +498,26 @@ static int apply_single_file_filter(const char *path, const char *src, size_t le
 #define CAP_SMUDGE   (1u<<1)
 
 struct cmd2process {
-       struct hashmap_entry ent; /* must be the first member! */
+       struct subprocess_entry subprocess; /* must be the first member! */
        unsigned int supported_capabilities;
-       const char *cmd;
-       struct child_process process;
 };
 
-static int cmd_process_map_initialized;
-static struct hashmap cmd_process_map;
-
-static int cmd2process_cmp(const struct cmd2process *e1,
-                          const struct cmd2process *e2,
-                          const void *unused)
-{
-       return strcmp(e1->cmd, e2->cmd);
-}
-
-static struct cmd2process *find_multi_file_filter_entry(struct hashmap *hashmap, const char *cmd)
-{
-       struct cmd2process key;
-       hashmap_entry_init(&key, strhash(cmd));
-       key.cmd = cmd;
-       return hashmap_get(hashmap, &key, NULL);
-}
-
-static int packet_write_list(int fd, const char *line, ...)
-{
-       va_list args;
-       int err;
-       va_start(args, line);
-       for (;;) {
-               if (!line)
-                       break;
-               if (strlen(line) > LARGE_PACKET_DATA_MAX)
-                       return -1;
-               err = packet_write_fmt_gently(fd, "%s\n", line);
-               if (err)
-                       return err;
-               line = va_arg(args, const char*);
-       }
-       va_end(args);
-       return packet_flush_gently(fd);
-}
-
-static void read_multi_file_filter_status(int fd, struct strbuf *status)
-{
-       struct strbuf **pair;
-       char *line;
-       for (;;) {
-               line = packet_read_line(fd, NULL);
-               if (!line)
-                       break;
-               pair = strbuf_split_str(line, '=', 2);
-               if (pair[0] && pair[0]->len && pair[1]) {
-                       /* the last "status=<foo>" line wins */
-                       if (!strcmp(pair[0]->buf, "status=")) {
-                               strbuf_reset(status);
-                               strbuf_addbuf(status, pair[1]);
-                       }
-               }
-               strbuf_list_free(pair);
-       }
-}
-
-static void kill_multi_file_filter(struct hashmap *hashmap, struct cmd2process *entry)
-{
-       if (!entry)
-               return;
-
-       entry->process.clean_on_exit = 0;
-       kill(entry->process.pid, SIGTERM);
-       finish_command(&entry->process);
-
-       hashmap_remove(hashmap, entry, NULL);
-       free(entry);
-}
-
-static void stop_multi_file_filter(struct child_process *process)
-{
-       sigchain_push(SIGPIPE, SIG_IGN);
-       /* Closing the pipe signals the filter to initiate a shutdown. */
-       close(process->in);
-       close(process->out);
-       sigchain_pop(SIGPIPE);
-       /* Finish command will wait until the shutdown is complete. */
-       finish_command(process);
-}
+static int subprocess_map_initialized;
+static struct hashmap subprocess_map;
 
-static struct cmd2process *start_multi_file_filter(struct hashmap *hashmap, const char *cmd)
+static int start_multi_file_filter_fn(struct subprocess_entry *subprocess)
 {
        int err;
-       struct cmd2process *entry;
-       struct child_process *process;
-       const char *argv[] = { cmd, NULL };
+       struct cmd2process *entry = (struct cmd2process *)subprocess;
        struct string_list cap_list = STRING_LIST_INIT_NODUP;
        char *cap_buf;
        const char *cap_name;
-
-       entry = xmalloc(sizeof(*entry));
-       entry->cmd = cmd;
-       entry->supported_capabilities = 0;
-       process = &entry->process;
-
-       child_process_init(process);
-       process->argv = argv;
-       process->use_shell = 1;
-       process->in = -1;
-       process->out = -1;
-       process->clean_on_exit = 1;
-       process->clean_on_exit_handler = stop_multi_file_filter;
-
-       if (start_command(process)) {
-               error("cannot fork to run external filter '%s'", cmd);
-               return NULL;
-       }
-
-       hashmap_entry_init(entry, strhash(cmd));
+       struct child_process *process = &subprocess->process;
+       const char *cmd = subprocess->cmd;
 
        sigchain_push(SIGPIPE, SIG_IGN);
 
-       err = packet_write_list(process->in, "git-filter-client", "version=2", NULL);
+       err = packet_writel(process->in, "git-filter-client", "version=2", NULL);
        if (err)
                goto done;
 
@@ -632,7 +533,7 @@ static struct cmd2process *start_multi_file_filter(struct hashmap *hashmap, cons
        if (err)
                goto done;
 
-       err = packet_write_list(process->in, "capability=clean", "capability=smudge", NULL);
+       err = packet_writel(process->in, "capability=clean", "capability=smudge", NULL);
 
        for (;;) {
                cap_buf = packet_read_line(process->out, NULL);
@@ -661,14 +562,30 @@ static struct cmd2process *start_multi_file_filter(struct hashmap *hashmap, cons
 done:
        sigchain_pop(SIGPIPE);
 
-       if (err || errno == EPIPE) {
-               error("initialization for external filter '%s' failed", cmd);
-               kill_multi_file_filter(hashmap, entry);
-               return NULL;
-       }
+       return err;
+}
 
-       hashmap_add(hashmap, entry);
-       return entry;
+static void handle_filter_error(const struct strbuf *filter_status,
+                               struct cmd2process *entry,
+                               const unsigned int wanted_capability) {
+       if (!strcmp(filter_status->buf, "error"))
+               ; /* The filter signaled a problem with the file. */
+       else if (!strcmp(filter_status->buf, "abort") && wanted_capability) {
+               /*
+                * The filter signaled a permanent problem. Don't try to filter
+                * files with the same command for the lifetime of the current
+                * Git process.
+                */
+                entry->supported_capabilities &= ~wanted_capability;
+       } else {
+               /*
+                * Something went wrong with the protocol filter.
+                * Force shutdown and restart if another blob requires filtering.
+                */
+               error("external filter '%s' failed", entry->subprocess.cmd);
+               subprocess_stop(&subprocess_map, &entry->subprocess);
+               free(entry);
+       }
 }
 
 static int apply_multi_file_filter(const char *path, const char *src, size_t len,
@@ -682,29 +599,33 @@ static int apply_multi_file_filter(const char *path, const char *src, size_t len
        struct strbuf filter_status = STRBUF_INIT;
        const char *filter_type;
 
-       if (!cmd_process_map_initialized) {
-               cmd_process_map_initialized = 1;
-               hashmap_init(&cmd_process_map, (hashmap_cmp_fn) cmd2process_cmp, 0);
+       if (!subprocess_map_initialized) {
+               subprocess_map_initialized = 1;
+               hashmap_init(&subprocess_map, (hashmap_cmp_fn) cmd2process_cmp, 0);
                entry = NULL;
        } else {
-               entry = find_multi_file_filter_entry(&cmd_process_map, cmd);
+               entry = (struct cmd2process *)subprocess_find_entry(&subprocess_map, cmd);
        }
 
        fflush(NULL);
 
        if (!entry) {
-               entry = start_multi_file_filter(&cmd_process_map, cmd);
-               if (!entry)
+               entry = xmalloc(sizeof(*entry));
+               entry->supported_capabilities = 0;
+
+               if (subprocess_start(&subprocess_map, &entry->subprocess, cmd, start_multi_file_filter_fn)) {
+                       free(entry);
                        return 0;
+               }
        }
-       process = &entry->process;
+       process = &entry->subprocess.process;
 
-       if (!(wanted_capability & entry->supported_capabilities))
+       if (!(entry->supported_capabilities & wanted_capability))
                return 0;
 
-       if (CAP_CLEAN & wanted_capability)
+       if (wanted_capability & CAP_CLEAN)
                filter_type = "clean";
-       else if (CAP_SMUDGE & wanted_capability)
+       else if (wanted_capability & CAP_SMUDGE)
                filter_type = "smudge";
        else
                die("unexpected filter type");
@@ -737,7 +658,10 @@ static int apply_multi_file_filter(const char *path, const char *src, size_t len
        if (err)
                goto done;
 
-       read_multi_file_filter_status(process->out, &filter_status);
+       err = subprocess_read_status(process->out, &filter_status);
+       if (err)
+               goto done;
+
        err = strcmp(filter_status.buf, "success");
        if (err)
                goto done;
@@ -746,33 +670,19 @@ static int apply_multi_file_filter(const char *path, const char *src, size_t len
        if (err)
                goto done;
 
-       read_multi_file_filter_status(process->out, &filter_status);
+       err = subprocess_read_status(process->out, &filter_status);
+       if (err)
+               goto done;
+
        err = strcmp(filter_status.buf, "success");
 
 done:
        sigchain_pop(SIGPIPE);
 
-       if (err || errno == EPIPE) {
-               if (!strcmp(filter_status.buf, "error")) {
-                       /* The filter signaled a problem with the file. */
-               } else if (!strcmp(filter_status.buf, "abort")) {
-                       /*
-                        * The filter signaled a permanent problem. Don't try to filter
-                        * files with the same command for the lifetime of the current
-                        * Git process.
-                        */
-                        entry->supported_capabilities &= ~wanted_capability;
-               } else {
-                       /*
-                        * Something went wrong with the protocol filter.
-                        * Force shutdown and restart if another blob requires filtering.
-                        */
-                       error("external filter '%s' failed", cmd);
-                       kill_multi_file_filter(&cmd_process_map, entry);
-               }
-       } else {
+       if (err)
+               handle_filter_error(&filter_status, entry, wanted_capability);
+       else
                strbuf_swap(dst, &nbuf);
-       }
        strbuf_release(&nbuf);
        return !err;
 }
@@ -798,9 +708,9 @@ static int apply_filter(const char *path, const char *src, size_t len,
        if (!dst)
                return 1;
 
-       if ((CAP_CLEAN & wanted_capability) && !drv->process && drv->clean)
+       if ((wanted_capability & CAP_CLEAN) && !drv->process && drv->clean)
                cmd = drv->clean;
-       else if ((CAP_SMUDGE & wanted_capability) && !drv->process && drv->smudge)
+       else if ((wanted_capability & CAP_SMUDGE) && !drv->process && drv->smudge)
                cmd = drv->smudge;
 
        if (cmd && *cmd)