2 #include "string-list.h"
3 #include "run-command.h"
7 * Copyright (c) 2013, 2014 Christian Couder <chriscool@tuxfamily.org>
10 enum action_where { WHERE_END, WHERE_AFTER, WHERE_BEFORE, WHERE_START };
11 enum action_if_exists { EXISTS_ADD_IF_DIFFERENT_NEIGHBOR, EXISTS_ADD_IF_DIFFERENT,
12 EXISTS_ADD, EXISTS_REPLACE, EXISTS_DO_NOTHING };
13 enum action_if_missing { MISSING_ADD, MISSING_DO_NOTHING };
19 enum action_where where;
20 enum action_if_exists if_exists;
21 enum action_if_missing if_missing;
24 static struct conf_info default_conf_info;
27 struct trailer_item *previous;
28 struct trailer_item *next;
31 struct conf_info conf;
34 static struct trailer_item *first_conf_item;
36 static char *separators = ":";
38 #define TRAILER_ARG_STRING "$ARG"
40 static int after_or_end(enum action_where where)
42 return (where == WHERE_AFTER) || (where == WHERE_END);
46 * Return the length of the string not including any final
47 * punctuation. E.g., the input "Signed-off-by:" would return
48 * 13, stripping the trailing punctuation but retaining
49 * internal punctuation.
51 static size_t token_len_without_separator(const char *token, size_t len)
53 while (len > 0 && !isalnum(token[len - 1]))
58 static int same_token(struct trailer_item *a, struct trailer_item *b)
60 size_t a_len = token_len_without_separator(a->token, strlen(a->token));
61 size_t b_len = token_len_without_separator(b->token, strlen(b->token));
62 size_t min_len = (a_len > b_len) ? b_len : a_len;
64 return !strncasecmp(a->token, b->token, min_len);
67 static int same_value(struct trailer_item *a, struct trailer_item *b)
69 return !strcasecmp(a->value, b->value);
72 static int same_trailer(struct trailer_item *a, struct trailer_item *b)
74 return same_token(a, b) && same_value(a, b);
77 static inline int contains_only_spaces(const char *str)
80 while (*s && isspace(*s))
85 static inline void strbuf_replace(struct strbuf *sb, const char *a, const char *b)
87 const char *ptr = strstr(sb->buf, a);
89 strbuf_splice(sb, ptr - sb->buf, strlen(a), b, strlen(b));
92 static void free_trailer_item(struct trailer_item *item)
94 free(item->conf.name);
96 free(item->conf.command);
97 free((char *)item->token);
98 free((char *)item->value);
102 static char last_non_space_char(const char *s)
105 for (i = strlen(s) - 1; i >= 0; i--)
111 static void print_tok_val(const char *tok, const char *val)
113 char c = last_non_space_char(tok);
116 if (strchr(separators, c))
117 printf("%s%s\n", tok, val);
119 printf("%s%c %s\n", tok, separators[0], val);
122 static void print_all(struct trailer_item *first, int trim_empty)
124 struct trailer_item *item;
125 for (item = first; item; item = item->next) {
126 if (!trim_empty || strlen(item->value) > 0)
127 print_tok_val(item->token, item->value);
131 static void update_last(struct trailer_item **last)
134 while ((*last)->next != NULL)
135 *last = (*last)->next;
138 static void update_first(struct trailer_item **first)
141 while ((*first)->previous != NULL)
142 *first = (*first)->previous;
145 static void add_arg_to_input_list(struct trailer_item *on_tok,
146 struct trailer_item *arg_tok,
147 struct trailer_item **first,
148 struct trailer_item **last)
150 if (after_or_end(arg_tok->conf.where)) {
151 arg_tok->next = on_tok->next;
152 on_tok->next = arg_tok;
153 arg_tok->previous = on_tok;
155 arg_tok->next->previous = arg_tok;
158 arg_tok->previous = on_tok->previous;
159 on_tok->previous = arg_tok;
160 arg_tok->next = on_tok;
161 if (arg_tok->previous)
162 arg_tok->previous->next = arg_tok;
167 static int check_if_different(struct trailer_item *in_tok,
168 struct trailer_item *arg_tok,
171 enum action_where where = arg_tok->conf.where;
175 if (same_trailer(in_tok, arg_tok))
178 * if we want to add a trailer after another one,
179 * we have to check those before this one
181 in_tok = after_or_end(where) ? in_tok->previous : in_tok->next;
186 static void remove_from_list(struct trailer_item *item,
187 struct trailer_item **first,
188 struct trailer_item **last)
190 struct trailer_item *next = item->next;
191 struct trailer_item *previous = item->previous;
194 item->next->previous = previous;
200 item->previous->next = next;
201 item->previous = NULL;
206 static struct trailer_item *remove_first(struct trailer_item **first)
208 struct trailer_item *item = *first;
211 item->next->previous = NULL;
217 static int read_from_command(struct child_process *cp, struct strbuf *buf)
220 return error("running trailer command '%s' failed", cp->argv[0]);
221 if (strbuf_read(buf, cp->out, 1024) < 1)
222 return error("reading from trailer command '%s' failed", cp->argv[0]);
227 static const char *apply_command(const char *command, const char *arg)
229 struct strbuf cmd = STRBUF_INIT;
230 struct strbuf buf = STRBUF_INIT;
231 struct child_process cp = CHILD_PROCESS_INIT;
232 const char *argv[] = {NULL, NULL};
235 strbuf_addstr(&cmd, command);
237 strbuf_replace(&cmd, TRAILER_ARG_STRING, arg);
241 cp.env = local_repo_env;
246 if (read_from_command(&cp, &buf)) {
247 strbuf_release(&buf);
248 result = xstrdup("");
250 result = strbuf_detach(&buf, NULL);
252 strbuf_release(&cmd);
256 static void apply_item_command(struct trailer_item *in_tok, struct trailer_item *arg_tok)
258 if (arg_tok->conf.command) {
260 if (arg_tok->value && arg_tok->value[0]) {
261 arg = arg_tok->value;
263 if (in_tok && in_tok->value)
264 arg = xstrdup(in_tok->value);
268 arg_tok->value = apply_command(arg_tok->conf.command, arg);
273 static void apply_arg_if_exists(struct trailer_item *in_tok,
274 struct trailer_item *arg_tok,
275 struct trailer_item *on_tok,
276 struct trailer_item **in_tok_first,
277 struct trailer_item **in_tok_last)
279 switch (arg_tok->conf.if_exists) {
280 case EXISTS_DO_NOTHING:
281 free_trailer_item(arg_tok);
284 apply_item_command(in_tok, arg_tok);
285 add_arg_to_input_list(on_tok, arg_tok,
286 in_tok_first, in_tok_last);
287 remove_from_list(in_tok, in_tok_first, in_tok_last);
288 free_trailer_item(in_tok);
291 apply_item_command(in_tok, arg_tok);
292 add_arg_to_input_list(on_tok, arg_tok,
293 in_tok_first, in_tok_last);
295 case EXISTS_ADD_IF_DIFFERENT:
296 apply_item_command(in_tok, arg_tok);
297 if (check_if_different(in_tok, arg_tok, 1))
298 add_arg_to_input_list(on_tok, arg_tok,
299 in_tok_first, in_tok_last);
301 free_trailer_item(arg_tok);
303 case EXISTS_ADD_IF_DIFFERENT_NEIGHBOR:
304 apply_item_command(in_tok, arg_tok);
305 if (check_if_different(on_tok, arg_tok, 0))
306 add_arg_to_input_list(on_tok, arg_tok,
307 in_tok_first, in_tok_last);
309 free_trailer_item(arg_tok);
314 static void apply_arg_if_missing(struct trailer_item **in_tok_first,
315 struct trailer_item **in_tok_last,
316 struct trailer_item *arg_tok)
318 struct trailer_item **in_tok;
319 enum action_where where;
321 switch (arg_tok->conf.if_missing) {
322 case MISSING_DO_NOTHING:
323 free_trailer_item(arg_tok);
326 where = arg_tok->conf.where;
327 in_tok = after_or_end(where) ? in_tok_last : in_tok_first;
328 apply_item_command(NULL, arg_tok);
330 add_arg_to_input_list(*in_tok, arg_tok,
331 in_tok_first, in_tok_last);
333 *in_tok_first = arg_tok;
334 *in_tok_last = arg_tok;
340 static int find_same_and_apply_arg(struct trailer_item **in_tok_first,
341 struct trailer_item **in_tok_last,
342 struct trailer_item *arg_tok)
344 struct trailer_item *in_tok;
345 struct trailer_item *on_tok;
346 struct trailer_item *following_tok;
348 enum action_where where = arg_tok->conf.where;
349 int middle = (where == WHERE_AFTER) || (where == WHERE_BEFORE);
350 int backwards = after_or_end(where);
351 struct trailer_item *start_tok = backwards ? *in_tok_last : *in_tok_first;
353 for (in_tok = start_tok; in_tok; in_tok = following_tok) {
354 following_tok = backwards ? in_tok->previous : in_tok->next;
355 if (!same_token(in_tok, arg_tok))
357 on_tok = middle ? in_tok : start_tok;
358 apply_arg_if_exists(in_tok, arg_tok, on_tok,
359 in_tok_first, in_tok_last);
365 static void process_trailers_lists(struct trailer_item **in_tok_first,
366 struct trailer_item **in_tok_last,
367 struct trailer_item **arg_tok_first)
369 struct trailer_item *arg_tok;
370 struct trailer_item *next_arg;
375 for (arg_tok = *arg_tok_first; arg_tok; arg_tok = next_arg) {
378 next_arg = arg_tok->next;
379 remove_from_list(arg_tok, arg_tok_first, NULL);
381 applied = find_same_and_apply_arg(in_tok_first,
386 apply_arg_if_missing(in_tok_first,
392 static int set_where(struct conf_info *item, const char *value)
394 if (!strcasecmp("after", value))
395 item->where = WHERE_AFTER;
396 else if (!strcasecmp("before", value))
397 item->where = WHERE_BEFORE;
398 else if (!strcasecmp("end", value))
399 item->where = WHERE_END;
400 else if (!strcasecmp("start", value))
401 item->where = WHERE_START;
407 static int set_if_exists(struct conf_info *item, const char *value)
409 if (!strcasecmp("addIfDifferent", value))
410 item->if_exists = EXISTS_ADD_IF_DIFFERENT;
411 else if (!strcasecmp("addIfDifferentNeighbor", value))
412 item->if_exists = EXISTS_ADD_IF_DIFFERENT_NEIGHBOR;
413 else if (!strcasecmp("add", value))
414 item->if_exists = EXISTS_ADD;
415 else if (!strcasecmp("replace", value))
416 item->if_exists = EXISTS_REPLACE;
417 else if (!strcasecmp("doNothing", value))
418 item->if_exists = EXISTS_DO_NOTHING;
424 static int set_if_missing(struct conf_info *item, const char *value)
426 if (!strcasecmp("doNothing", value))
427 item->if_missing = MISSING_DO_NOTHING;
428 else if (!strcasecmp("add", value))
429 item->if_missing = MISSING_ADD;
435 static void duplicate_conf(struct conf_info *dst, struct conf_info *src)
439 dst->name = xstrdup(src->name);
441 dst->key = xstrdup(src->key);
443 dst->command = xstrdup(src->command);
446 static struct trailer_item *get_conf_item(const char *name)
448 struct trailer_item *item;
449 struct trailer_item *previous;
451 /* Look up item with same name */
452 for (previous = NULL, item = first_conf_item;
454 previous = item, item = item->next) {
455 if (!strcasecmp(item->conf.name, name))
459 /* Item does not already exists, create it */
460 item = xcalloc(sizeof(struct trailer_item), 1);
461 duplicate_conf(&item->conf, &default_conf_info);
462 item->conf.name = xstrdup(name);
465 first_conf_item = item;
467 previous->next = item;
468 item->previous = previous;
474 enum trailer_info_type { TRAILER_KEY, TRAILER_COMMAND, TRAILER_WHERE,
475 TRAILER_IF_EXISTS, TRAILER_IF_MISSING };
479 enum trailer_info_type type;
480 } trailer_config_items[] = {
481 { "key", TRAILER_KEY },
482 { "command", TRAILER_COMMAND },
483 { "where", TRAILER_WHERE },
484 { "ifexists", TRAILER_IF_EXISTS },
485 { "ifmissing", TRAILER_IF_MISSING }
488 static int git_trailer_default_config(const char *conf_key, const char *value, void *cb)
490 const char *trailer_item, *variable_name;
492 if (!skip_prefix(conf_key, "trailer.", &trailer_item))
495 variable_name = strrchr(trailer_item, '.');
496 if (!variable_name) {
497 if (!strcmp(trailer_item, "where")) {
498 if (set_where(&default_conf_info, value) < 0)
499 warning(_("unknown value '%s' for key '%s'"),
501 } else if (!strcmp(trailer_item, "ifexists")) {
502 if (set_if_exists(&default_conf_info, value) < 0)
503 warning(_("unknown value '%s' for key '%s'"),
505 } else if (!strcmp(trailer_item, "ifmissing")) {
506 if (set_if_missing(&default_conf_info, value) < 0)
507 warning(_("unknown value '%s' for key '%s'"),
509 } else if (!strcmp(trailer_item, "separators")) {
510 separators = xstrdup(value);
516 static int git_trailer_config(const char *conf_key, const char *value, void *cb)
518 const char *trailer_item, *variable_name;
519 struct trailer_item *item;
520 struct conf_info *conf;
522 enum trailer_info_type type;
525 if (!skip_prefix(conf_key, "trailer.", &trailer_item))
528 variable_name = strrchr(trailer_item, '.');
533 for (i = 0; i < ARRAY_SIZE(trailer_config_items); i++) {
534 if (strcmp(trailer_config_items[i].name, variable_name))
536 name = xstrndup(trailer_item, variable_name - trailer_item - 1);
537 type = trailer_config_items[i].type;
544 item = get_conf_item(name);
551 warning(_("more than one %s"), conf_key);
552 conf->key = xstrdup(value);
554 case TRAILER_COMMAND:
556 warning(_("more than one %s"), conf_key);
557 conf->command = xstrdup(value);
560 if (set_where(conf, value))
561 warning(_("unknown value '%s' for key '%s'"), value, conf_key);
563 case TRAILER_IF_EXISTS:
564 if (set_if_exists(conf, value))
565 warning(_("unknown value '%s' for key '%s'"), value, conf_key);
567 case TRAILER_IF_MISSING:
568 if (set_if_missing(conf, value))
569 warning(_("unknown value '%s' for key '%s'"), value, conf_key);
572 die("internal bug in trailer.c");
577 static int parse_trailer(struct strbuf *tok, struct strbuf *val, const char *trailer)
580 struct strbuf seps = STRBUF_INIT;
581 strbuf_addstr(&seps, separators);
582 strbuf_addch(&seps, '=');
583 len = strcspn(trailer, seps.buf);
584 strbuf_release(&seps);
586 int l = strlen(trailer);
587 while (l > 0 && isspace(trailer[l - 1]))
589 return error(_("empty trailer token in trailer '%.*s'"), l, trailer);
591 if (len < strlen(trailer)) {
592 strbuf_add(tok, trailer, len);
594 strbuf_addstr(val, trailer + len + 1);
597 strbuf_addstr(tok, trailer);
603 static const char *token_from_item(struct trailer_item *item, char *tok)
606 return item->conf.key;
609 return item->conf.name;
612 static struct trailer_item *new_trailer_item(struct trailer_item *conf_item,
613 char *tok, char *val)
615 struct trailer_item *new = xcalloc(sizeof(*new), 1);
616 new->value = val ? val : xstrdup("");
619 duplicate_conf(&new->conf, &conf_item->conf);
620 new->token = xstrdup(token_from_item(conf_item, tok));
623 duplicate_conf(&new->conf, &default_conf_info);
630 static int token_matches_item(const char *tok, struct trailer_item *item, int tok_len)
632 if (!strncasecmp(tok, item->conf.name, tok_len))
634 return item->conf.key ? !strncasecmp(tok, item->conf.key, tok_len) : 0;
637 static struct trailer_item *create_trailer_item(const char *string)
639 struct strbuf tok = STRBUF_INIT;
640 struct strbuf val = STRBUF_INIT;
641 struct trailer_item *item;
644 if (parse_trailer(&tok, &val, string))
647 tok_len = token_len_without_separator(tok.buf, tok.len);
649 /* Lookup if the token matches something in the config */
650 for (item = first_conf_item; item; item = item->next) {
651 if (token_matches_item(tok.buf, item, tok_len))
652 return new_trailer_item(item,
653 strbuf_detach(&tok, NULL),
654 strbuf_detach(&val, NULL));
657 return new_trailer_item(NULL,
658 strbuf_detach(&tok, NULL),
659 strbuf_detach(&val, NULL));
662 static void add_trailer_item(struct trailer_item **first,
663 struct trailer_item **last,
664 struct trailer_item *new)
673 new->previous = *last;
678 static struct trailer_item *process_command_line_args(struct string_list *trailers)
680 struct trailer_item *arg_tok_first = NULL;
681 struct trailer_item *arg_tok_last = NULL;
682 struct string_list_item *tr;
683 struct trailer_item *item;
685 /* Add a trailer item for each configured trailer with a command */
686 for (item = first_conf_item; item; item = item->next) {
687 if (item->conf.command) {
688 struct trailer_item *new = new_trailer_item(item, NULL, NULL);
689 add_trailer_item(&arg_tok_first, &arg_tok_last, new);
693 /* Add a trailer item for each trailer on the command line */
694 for_each_string_list_item(tr, trailers) {
695 struct trailer_item *new = create_trailer_item(tr->string);
696 add_trailer_item(&arg_tok_first, &arg_tok_last, new);
699 return arg_tok_first;
702 static struct strbuf **read_input_file(const char *file)
704 struct strbuf **lines;
705 struct strbuf sb = STRBUF_INIT;
708 if (strbuf_read_file(&sb, file, 0) < 0)
709 die_errno(_("could not read input file '%s'"), file);
711 if (strbuf_read(&sb, fileno(stdin), 0) < 0)
712 die_errno(_("could not read from stdin"));
715 lines = strbuf_split(&sb, '\n');
723 * Return the (0 based) index of the start of the patch or the line
724 * count if there is no patch in the message.
726 static int find_patch_start(struct strbuf **lines, int count)
730 /* Get the start of the patch part if any */
731 for (i = 0; i < count; i++) {
732 if (starts_with(lines[i]->buf, "---"))
740 * Return the (0 based) index of the first trailer line or count if
741 * there are no trailers. Trailers are searched only in the lines from
742 * index (count - 1) down to index 0.
744 static int find_trailer_start(struct strbuf **lines, int count)
746 int start, only_spaces = 1;
749 * Get the start of the trailers by looking starting from the end
750 * for a line with only spaces before lines with one separator.
752 for (start = count - 1; start >= 0; start--) {
753 if (lines[start]->buf[0] == comment_line_char)
755 if (contains_only_spaces(lines[start]->buf)) {
760 if (strcspn(lines[start]->buf, separators) < lines[start]->len) {
768 return only_spaces ? count : 0;
771 /* Get the index of the end of the trailers */
772 static int find_trailer_end(struct strbuf **lines, int patch_start)
774 struct strbuf sb = STRBUF_INIT;
777 for (i = 0; i < patch_start; i++)
778 strbuf_addbuf(&sb, lines[i]);
779 ignore_bytes = ignore_non_trailer(&sb);
781 for (i = patch_start - 1; i >= 0 && ignore_bytes > 0; i--)
782 ignore_bytes -= lines[i]->len;
787 static int has_blank_line_before(struct strbuf **lines, int start)
789 for (;start >= 0; start--) {
790 if (lines[start]->buf[0] == comment_line_char)
792 return contains_only_spaces(lines[start]->buf);
797 static void print_lines(struct strbuf **lines, int start, int end)
800 for (i = start; lines[i] && i < end; i++)
801 printf("%s", lines[i]->buf);
804 static int process_input_file(struct strbuf **lines,
805 struct trailer_item **in_tok_first,
806 struct trailer_item **in_tok_last)
809 int patch_start, trailer_start, trailer_end, i;
811 /* Get the line count */
815 patch_start = find_patch_start(lines, count);
816 trailer_end = find_trailer_end(lines, patch_start);
817 trailer_start = find_trailer_start(lines, trailer_end);
819 /* Print lines before the trailers as is */
820 print_lines(lines, 0, trailer_start);
822 if (!has_blank_line_before(lines, trailer_start - 1))
825 /* Parse trailer lines */
826 for (i = trailer_start; i < trailer_end; i++) {
827 if (lines[i]->buf[0] != comment_line_char) {
828 struct trailer_item *new = create_trailer_item(lines[i]->buf);
829 add_trailer_item(in_tok_first, in_tok_last, new);
836 static void free_all(struct trailer_item **first)
839 struct trailer_item *item = remove_first(first);
840 free_trailer_item(item);
844 void process_trailers(const char *file, int trim_empty, struct string_list *trailers)
846 struct trailer_item *in_tok_first = NULL;
847 struct trailer_item *in_tok_last = NULL;
848 struct trailer_item *arg_tok_first;
849 struct strbuf **lines;
852 /* Default config must be setup first */
853 git_config(git_trailer_default_config, NULL);
854 git_config(git_trailer_config, NULL);
856 lines = read_input_file(file);
858 /* Print the lines before the trailers */
859 trailer_end = process_input_file(lines, &in_tok_first, &in_tok_last);
861 arg_tok_first = process_command_line_args(trailers);
863 process_trailers_lists(&in_tok_first, &in_tok_last, &arg_tok_first);
865 print_all(in_tok_first, trim_empty);
867 free_all(&in_tok_first);
869 /* Print the lines after the trailers as is */
870 print_lines(lines, trailer_end, INT_MAX);
872 strbuf_list_free(lines);