1 #include "cache.h"
2 #include "config.h"
3 #include "string-list.h"
4 #include "run-command.h"
5 #include "commit.h"
6 #include "tempfile.h"
7 #include "trailer.h"
8 #include "list.h"
9 /*
10  * Copyright (c) 2013, 2014 Christian Couder <chriscool@tuxfamily.org>
11  */
12 
13 struct conf_info {
14 	char *name;
15 	char *key;
16 	char *command;
17 	char *cmd;
18 	enum trailer_where where;
19 	enum trailer_if_exists if_exists;
20 	enum trailer_if_missing if_missing;
21 };
22 
23 static struct conf_info default_conf_info;
24 
25 struct trailer_item {
26 	struct list_head list;
27 	/*
28 	 * If this is not a trailer line, the line is stored in value
29 	 * (excluding the terminating newline) and token is NULL.
30 	 */
31 	char *token;
32 	char *value;
33 };
34 
35 struct arg_item {
36 	struct list_head list;
37 	char *token;
38 	char *value;
39 	struct conf_info conf;
40 };
41 
42 static LIST_HEAD(conf_head);
43 
44 static char *separators = ":";
45 
46 static int configured;
47 
48 #define TRAILER_ARG_STRING "$ARG"
49 
50 static const char *git_generated_prefixes[] = {
51 	"Signed-off-by: ",
52 	"(cherry picked from commit ",
53 	NULL
54 };
55 
56 /* Iterate over the elements of the list. */
57 #define list_for_each_dir(pos, head, is_reverse) \
58 	for (pos = is_reverse ? (head)->prev : (head)->next; \
59 		pos != (head); \
60 		pos = is_reverse ? pos->prev : pos->next)
61 
after_or_end(enum trailer_where where)62 static int after_or_end(enum trailer_where where)
63 {
64 	return (where == WHERE_AFTER) || (where == WHERE_END);
65 }
66 
67 /*
68  * Return the length of the string not including any final
69  * punctuation. E.g., the input "Signed-off-by:" would return
70  * 13, stripping the trailing punctuation but retaining
71  * internal punctuation.
72  */
token_len_without_separator(const char * token,size_t len)73 static size_t token_len_without_separator(const char *token, size_t len)
74 {
75 	while (len > 0 && !isalnum(token[len - 1]))
76 		len--;
77 	return len;
78 }
79 
same_token(struct trailer_item * a,struct arg_item * b)80 static int same_token(struct trailer_item *a, struct arg_item *b)
81 {
82 	size_t a_len, b_len, min_len;
83 
84 	if (!a->token)
85 		return 0;
86 
87 	a_len = token_len_without_separator(a->token, strlen(a->token));
88 	b_len = token_len_without_separator(b->token, strlen(b->token));
89 	min_len = (a_len > b_len) ? b_len : a_len;
90 
91 	return !strncasecmp(a->token, b->token, min_len);
92 }
93 
same_value(struct trailer_item * a,struct arg_item * b)94 static int same_value(struct trailer_item *a, struct arg_item *b)
95 {
96 	return !strcasecmp(a->value, b->value);
97 }
98 
same_trailer(struct trailer_item * a,struct arg_item * b)99 static int same_trailer(struct trailer_item *a, struct arg_item *b)
100 {
101 	return same_token(a, b) && same_value(a, b);
102 }
103 
is_blank_line(const char * str)104 static inline int is_blank_line(const char *str)
105 {
106 	const char *s = str;
107 	while (*s && *s != '\n' && isspace(*s))
108 		s++;
109 	return !*s || *s == '\n';
110 }
111 
strbuf_replace(struct strbuf * sb,const char * a,const char * b)112 static inline void strbuf_replace(struct strbuf *sb, const char *a, const char *b)
113 {
114 	const char *ptr = strstr(sb->buf, a);
115 	if (ptr)
116 		strbuf_splice(sb, ptr - sb->buf, strlen(a), b, strlen(b));
117 }
118 
free_trailer_item(struct trailer_item * item)119 static void free_trailer_item(struct trailer_item *item)
120 {
121 	free(item->token);
122 	free(item->value);
123 	free(item);
124 }
125 
free_arg_item(struct arg_item * item)126 static void free_arg_item(struct arg_item *item)
127 {
128 	free(item->conf.name);
129 	free(item->conf.key);
130 	free(item->conf.command);
131 	free(item->conf.cmd);
132 	free(item->token);
133 	free(item->value);
134 	free(item);
135 }
136 
last_non_space_char(const char * s)137 static char last_non_space_char(const char *s)
138 {
139 	int i;
140 	for (i = strlen(s) - 1; i >= 0; i--)
141 		if (!isspace(s[i]))
142 			return s[i];
143 	return '\0';
144 }
145 
print_tok_val(FILE * outfile,const char * tok,const char * val)146 static void print_tok_val(FILE *outfile, const char *tok, const char *val)
147 {
148 	char c;
149 
150 	if (!tok) {
151 		fprintf(outfile, "%s\n", val);
152 		return;
153 	}
154 
155 	c = last_non_space_char(tok);
156 	if (!c)
157 		return;
158 	if (strchr(separators, c))
159 		fprintf(outfile, "%s%s\n", tok, val);
160 	else
161 		fprintf(outfile, "%s%c %s\n", tok, separators[0], val);
162 }
163 
print_all(FILE * outfile,struct list_head * head,const struct process_trailer_options * opts)164 static void print_all(FILE *outfile, struct list_head *head,
165 		      const struct process_trailer_options *opts)
166 {
167 	struct list_head *pos;
168 	struct trailer_item *item;
169 	list_for_each(pos, head) {
170 		item = list_entry(pos, struct trailer_item, list);
171 		if ((!opts->trim_empty || strlen(item->value) > 0) &&
172 		    (!opts->only_trailers || item->token))
173 			print_tok_val(outfile, item->token, item->value);
174 	}
175 }
176 
trailer_from_arg(struct arg_item * arg_tok)177 static struct trailer_item *trailer_from_arg(struct arg_item *arg_tok)
178 {
179 	struct trailer_item *new_item = xcalloc(1, sizeof(*new_item));
180 	new_item->token = arg_tok->token;
181 	new_item->value = arg_tok->value;
182 	arg_tok->token = arg_tok->value = NULL;
183 	free_arg_item(arg_tok);
184 	return new_item;
185 }
186 
add_arg_to_input_list(struct trailer_item * on_tok,struct arg_item * arg_tok)187 static void add_arg_to_input_list(struct trailer_item *on_tok,
188 				  struct arg_item *arg_tok)
189 {
190 	int aoe = after_or_end(arg_tok->conf.where);
191 	struct trailer_item *to_add = trailer_from_arg(arg_tok);
192 	if (aoe)
193 		list_add(&to_add->list, &on_tok->list);
194 	else
195 		list_add_tail(&to_add->list, &on_tok->list);
196 }
197 
check_if_different(struct trailer_item * in_tok,struct arg_item * arg_tok,int check_all,struct list_head * head)198 static int check_if_different(struct trailer_item *in_tok,
199 			      struct arg_item *arg_tok,
200 			      int check_all,
201 			      struct list_head *head)
202 {
203 	enum trailer_where where = arg_tok->conf.where;
204 	struct list_head *next_head;
205 	do {
206 		if (same_trailer(in_tok, arg_tok))
207 			return 0;
208 		/*
209 		 * if we want to add a trailer after another one,
210 		 * we have to check those before this one
211 		 */
212 		next_head = after_or_end(where) ? in_tok->list.prev
213 						: in_tok->list.next;
214 		if (next_head == head)
215 			break;
216 		in_tok = list_entry(next_head, struct trailer_item, list);
217 	} while (check_all);
218 	return 1;
219 }
220 
apply_command(struct conf_info * conf,const char * arg)221 static char *apply_command(struct conf_info *conf, const char *arg)
222 {
223 	struct strbuf cmd = STRBUF_INIT;
224 	struct strbuf buf = STRBUF_INIT;
225 	struct child_process cp = CHILD_PROCESS_INIT;
226 	char *result;
227 
228 	if (conf->cmd) {
229 		strbuf_addstr(&cmd, conf->cmd);
230 		strvec_push(&cp.args, cmd.buf);
231 		if (arg)
232 			strvec_push(&cp.args, arg);
233 	} else if (conf->command) {
234 		strbuf_addstr(&cmd, conf->command);
235 		if (arg)
236 			strbuf_replace(&cmd, TRAILER_ARG_STRING, arg);
237 		strvec_push(&cp.args, cmd.buf);
238 	}
239 	cp.env = local_repo_env;
240 	cp.no_stdin = 1;
241 	cp.use_shell = 1;
242 
243 	if (capture_command(&cp, &buf, 1024)) {
244 		error(_("running trailer command '%s' failed"), cmd.buf);
245 		strbuf_release(&buf);
246 		result = xstrdup("");
247 	} else {
248 		strbuf_trim(&buf);
249 		result = strbuf_detach(&buf, NULL);
250 	}
251 
252 	strbuf_release(&cmd);
253 	return result;
254 }
255 
apply_item_command(struct trailer_item * in_tok,struct arg_item * arg_tok)256 static void apply_item_command(struct trailer_item *in_tok, struct arg_item *arg_tok)
257 {
258 	if (arg_tok->conf.command || arg_tok->conf.cmd) {
259 		const char *arg;
260 		if (arg_tok->value && arg_tok->value[0]) {
261 			arg = arg_tok->value;
262 		} else {
263 			if (in_tok && in_tok->value)
264 				arg = xstrdup(in_tok->value);
265 			else
266 				arg = xstrdup("");
267 		}
268 		arg_tok->value = apply_command(&arg_tok->conf, arg);
269 		free((char *)arg);
270 	}
271 }
272 
apply_arg_if_exists(struct trailer_item * in_tok,struct arg_item * arg_tok,struct trailer_item * on_tok,struct list_head * head)273 static void apply_arg_if_exists(struct trailer_item *in_tok,
274 				struct arg_item *arg_tok,
275 				struct trailer_item *on_tok,
276 				struct list_head *head)
277 {
278 	switch (arg_tok->conf.if_exists) {
279 	case EXISTS_DO_NOTHING:
280 		free_arg_item(arg_tok);
281 		break;
282 	case EXISTS_REPLACE:
283 		apply_item_command(in_tok, arg_tok);
284 		add_arg_to_input_list(on_tok, arg_tok);
285 		list_del(&in_tok->list);
286 		free_trailer_item(in_tok);
287 		break;
288 	case EXISTS_ADD:
289 		apply_item_command(in_tok, arg_tok);
290 		add_arg_to_input_list(on_tok, arg_tok);
291 		break;
292 	case EXISTS_ADD_IF_DIFFERENT:
293 		apply_item_command(in_tok, arg_tok);
294 		if (check_if_different(in_tok, arg_tok, 1, head))
295 			add_arg_to_input_list(on_tok, arg_tok);
296 		else
297 			free_arg_item(arg_tok);
298 		break;
299 	case EXISTS_ADD_IF_DIFFERENT_NEIGHBOR:
300 		apply_item_command(in_tok, arg_tok);
301 		if (check_if_different(on_tok, arg_tok, 0, head))
302 			add_arg_to_input_list(on_tok, arg_tok);
303 		else
304 			free_arg_item(arg_tok);
305 		break;
306 	default:
307 		BUG("trailer.c: unhandled value %d",
308 		    arg_tok->conf.if_exists);
309 	}
310 }
311 
apply_arg_if_missing(struct list_head * head,struct arg_item * arg_tok)312 static void apply_arg_if_missing(struct list_head *head,
313 				 struct arg_item *arg_tok)
314 {
315 	enum trailer_where where;
316 	struct trailer_item *to_add;
317 
318 	switch (arg_tok->conf.if_missing) {
319 	case MISSING_DO_NOTHING:
320 		free_arg_item(arg_tok);
321 		break;
322 	case MISSING_ADD:
323 		where = arg_tok->conf.where;
324 		apply_item_command(NULL, arg_tok);
325 		to_add = trailer_from_arg(arg_tok);
326 		if (after_or_end(where))
327 			list_add_tail(&to_add->list, head);
328 		else
329 			list_add(&to_add->list, head);
330 		break;
331 	default:
332 		BUG("trailer.c: unhandled value %d",
333 		    arg_tok->conf.if_missing);
334 	}
335 }
336 
find_same_and_apply_arg(struct list_head * head,struct arg_item * arg_tok)337 static int find_same_and_apply_arg(struct list_head *head,
338 				   struct arg_item *arg_tok)
339 {
340 	struct list_head *pos;
341 	struct trailer_item *in_tok;
342 	struct trailer_item *on_tok;
343 
344 	enum trailer_where where = arg_tok->conf.where;
345 	int middle = (where == WHERE_AFTER) || (where == WHERE_BEFORE);
346 	int backwards = after_or_end(where);
347 	struct trailer_item *start_tok;
348 
349 	if (list_empty(head))
350 		return 0;
351 
352 	start_tok = list_entry(backwards ? head->prev : head->next,
353 			       struct trailer_item,
354 			       list);
355 
356 	list_for_each_dir(pos, head, backwards) {
357 		in_tok = list_entry(pos, struct trailer_item, list);
358 		if (!same_token(in_tok, arg_tok))
359 			continue;
360 		on_tok = middle ? in_tok : start_tok;
361 		apply_arg_if_exists(in_tok, arg_tok, on_tok, head);
362 		return 1;
363 	}
364 	return 0;
365 }
366 
process_trailers_lists(struct list_head * head,struct list_head * arg_head)367 static void process_trailers_lists(struct list_head *head,
368 				   struct list_head *arg_head)
369 {
370 	struct list_head *pos, *p;
371 	struct arg_item *arg_tok;
372 
373 	list_for_each_safe(pos, p, arg_head) {
374 		int applied = 0;
375 		arg_tok = list_entry(pos, struct arg_item, list);
376 
377 		list_del(pos);
378 
379 		applied = find_same_and_apply_arg(head, arg_tok);
380 
381 		if (!applied)
382 			apply_arg_if_missing(head, arg_tok);
383 	}
384 }
385 
trailer_set_where(enum trailer_where * item,const char * value)386 int trailer_set_where(enum trailer_where *item, const char *value)
387 {
388 	if (!value)
389 		*item = WHERE_DEFAULT;
390 	else if (!strcasecmp("after", value))
391 		*item = WHERE_AFTER;
392 	else if (!strcasecmp("before", value))
393 		*item = WHERE_BEFORE;
394 	else if (!strcasecmp("end", value))
395 		*item = WHERE_END;
396 	else if (!strcasecmp("start", value))
397 		*item = WHERE_START;
398 	else
399 		return -1;
400 	return 0;
401 }
402 
trailer_set_if_exists(enum trailer_if_exists * item,const char * value)403 int trailer_set_if_exists(enum trailer_if_exists *item, const char *value)
404 {
405 	if (!value)
406 		*item = EXISTS_DEFAULT;
407 	else if (!strcasecmp("addIfDifferent", value))
408 		*item = EXISTS_ADD_IF_DIFFERENT;
409 	else if (!strcasecmp("addIfDifferentNeighbor", value))
410 		*item = EXISTS_ADD_IF_DIFFERENT_NEIGHBOR;
411 	else if (!strcasecmp("add", value))
412 		*item = EXISTS_ADD;
413 	else if (!strcasecmp("replace", value))
414 		*item = EXISTS_REPLACE;
415 	else if (!strcasecmp("doNothing", value))
416 		*item = EXISTS_DO_NOTHING;
417 	else
418 		return -1;
419 	return 0;
420 }
421 
trailer_set_if_missing(enum trailer_if_missing * item,const char * value)422 int trailer_set_if_missing(enum trailer_if_missing *item, const char *value)
423 {
424 	if (!value)
425 		*item = MISSING_DEFAULT;
426 	else if (!strcasecmp("doNothing", value))
427 		*item = MISSING_DO_NOTHING;
428 	else if (!strcasecmp("add", value))
429 		*item = MISSING_ADD;
430 	else
431 		return -1;
432 	return 0;
433 }
434 
duplicate_conf(struct conf_info * dst,const struct conf_info * src)435 static void duplicate_conf(struct conf_info *dst, const struct conf_info *src)
436 {
437 	*dst = *src;
438 	dst->name = xstrdup_or_null(src->name);
439 	dst->key = xstrdup_or_null(src->key);
440 	dst->command = xstrdup_or_null(src->command);
441 	dst->cmd = xstrdup_or_null(src->cmd);
442 }
443 
get_conf_item(const char * name)444 static struct arg_item *get_conf_item(const char *name)
445 {
446 	struct list_head *pos;
447 	struct arg_item *item;
448 
449 	/* Look up item with same name */
450 	list_for_each(pos, &conf_head) {
451 		item = list_entry(pos, struct arg_item, list);
452 		if (!strcasecmp(item->conf.name, name))
453 			return item;
454 	}
455 
456 	/* Item does not already exists, create it */
457 	CALLOC_ARRAY(item, 1);
458 	duplicate_conf(&item->conf, &default_conf_info);
459 	item->conf.name = xstrdup(name);
460 
461 	list_add_tail(&item->list, &conf_head);
462 
463 	return item;
464 }
465 
466 enum trailer_info_type { TRAILER_KEY, TRAILER_COMMAND, TRAILER_CMD,
467 			TRAILER_WHERE, TRAILER_IF_EXISTS, TRAILER_IF_MISSING };
468 
469 static struct {
470 	const char *name;
471 	enum trailer_info_type type;
472 } trailer_config_items[] = {
473 	{ "key", TRAILER_KEY },
474 	{ "command", TRAILER_COMMAND },
475 	{ "cmd", TRAILER_CMD },
476 	{ "where", TRAILER_WHERE },
477 	{ "ifexists", TRAILER_IF_EXISTS },
478 	{ "ifmissing", TRAILER_IF_MISSING }
479 };
480 
git_trailer_default_config(const char * conf_key,const char * value,void * cb)481 static int git_trailer_default_config(const char *conf_key, const char *value, void *cb)
482 {
483 	const char *trailer_item, *variable_name;
484 
485 	if (!skip_prefix(conf_key, "trailer.", &trailer_item))
486 		return 0;
487 
488 	variable_name = strrchr(trailer_item, '.');
489 	if (!variable_name) {
490 		if (!strcmp(trailer_item, "where")) {
491 			if (trailer_set_where(&default_conf_info.where,
492 					      value) < 0)
493 				warning(_("unknown value '%s' for key '%s'"),
494 					value, conf_key);
495 		} else if (!strcmp(trailer_item, "ifexists")) {
496 			if (trailer_set_if_exists(&default_conf_info.if_exists,
497 						  value) < 0)
498 				warning(_("unknown value '%s' for key '%s'"),
499 					value, conf_key);
500 		} else if (!strcmp(trailer_item, "ifmissing")) {
501 			if (trailer_set_if_missing(&default_conf_info.if_missing,
502 						   value) < 0)
503 				warning(_("unknown value '%s' for key '%s'"),
504 					value, conf_key);
505 		} else if (!strcmp(trailer_item, "separators")) {
506 			separators = xstrdup(value);
507 		}
508 	}
509 	return 0;
510 }
511 
git_trailer_config(const char * conf_key,const char * value,void * cb)512 static int git_trailer_config(const char *conf_key, const char *value, void *cb)
513 {
514 	const char *trailer_item, *variable_name;
515 	struct arg_item *item;
516 	struct conf_info *conf;
517 	char *name = NULL;
518 	enum trailer_info_type type;
519 	int i;
520 
521 	if (!skip_prefix(conf_key, "trailer.", &trailer_item))
522 		return 0;
523 
524 	variable_name = strrchr(trailer_item, '.');
525 	if (!variable_name)
526 		return 0;
527 
528 	variable_name++;
529 	for (i = 0; i < ARRAY_SIZE(trailer_config_items); i++) {
530 		if (strcmp(trailer_config_items[i].name, variable_name))
531 			continue;
532 		name = xstrndup(trailer_item,  variable_name - trailer_item - 1);
533 		type = trailer_config_items[i].type;
534 		break;
535 	}
536 
537 	if (!name)
538 		return 0;
539 
540 	item = get_conf_item(name);
541 	conf = &item->conf;
542 	free(name);
543 
544 	switch (type) {
545 	case TRAILER_KEY:
546 		if (conf->key)
547 			warning(_("more than one %s"), conf_key);
548 		conf->key = xstrdup(value);
549 		break;
550 	case TRAILER_COMMAND:
551 		if (conf->command)
552 			warning(_("more than one %s"), conf_key);
553 		conf->command = xstrdup(value);
554 		break;
555 	case TRAILER_CMD:
556 		if (conf->cmd)
557 			warning(_("more than one %s"), conf_key);
558 		conf->cmd = xstrdup(value);
559 		break;
560 	case TRAILER_WHERE:
561 		if (trailer_set_where(&conf->where, value))
562 			warning(_("unknown value '%s' for key '%s'"), value, conf_key);
563 		break;
564 	case TRAILER_IF_EXISTS:
565 		if (trailer_set_if_exists(&conf->if_exists, value))
566 			warning(_("unknown value '%s' for key '%s'"), value, conf_key);
567 		break;
568 	case TRAILER_IF_MISSING:
569 		if (trailer_set_if_missing(&conf->if_missing, value))
570 			warning(_("unknown value '%s' for key '%s'"), value, conf_key);
571 		break;
572 	default:
573 		BUG("trailer.c: unhandled type %d", type);
574 	}
575 	return 0;
576 }
577 
ensure_configured(void)578 static void ensure_configured(void)
579 {
580 	if (configured)
581 		return;
582 
583 	/* Default config must be setup first */
584 	default_conf_info.where = WHERE_END;
585 	default_conf_info.if_exists = EXISTS_ADD_IF_DIFFERENT_NEIGHBOR;
586 	default_conf_info.if_missing = MISSING_ADD;
587 	git_config(git_trailer_default_config, NULL);
588 	git_config(git_trailer_config, NULL);
589 	configured = 1;
590 }
591 
token_from_item(struct arg_item * item,char * tok)592 static const char *token_from_item(struct arg_item *item, char *tok)
593 {
594 	if (item->conf.key)
595 		return item->conf.key;
596 	if (tok)
597 		return tok;
598 	return item->conf.name;
599 }
600 
token_matches_item(const char * tok,struct arg_item * item,size_t tok_len)601 static int token_matches_item(const char *tok, struct arg_item *item, size_t tok_len)
602 {
603 	if (!strncasecmp(tok, item->conf.name, tok_len))
604 		return 1;
605 	return item->conf.key ? !strncasecmp(tok, item->conf.key, tok_len) : 0;
606 }
607 
608 /*
609  * If the given line is of the form
610  * "<token><optional whitespace><separator>..." or "<separator>...", return the
611  * location of the separator. Otherwise, return -1.  The optional whitespace
612  * is allowed there primarily to allow things like "Bug #43" where <token> is
613  * "Bug" and <separator> is "#".
614  *
615  * The separator-starts-line case (in which this function returns 0) is
616  * distinguished from the non-well-formed-line case (in which this function
617  * returns -1) because some callers of this function need such a distinction.
618  */
find_separator(const char * line,const char * separators)619 static ssize_t find_separator(const char *line, const char *separators)
620 {
621 	int whitespace_found = 0;
622 	const char *c;
623 	for (c = line; *c; c++) {
624 		if (strchr(separators, *c))
625 			return c - line;
626 		if (!whitespace_found && (isalnum(*c) || *c == '-'))
627 			continue;
628 		if (c != line && (*c == ' ' || *c == '\t')) {
629 			whitespace_found = 1;
630 			continue;
631 		}
632 		break;
633 	}
634 	return -1;
635 }
636 
637 /*
638  * Obtain the token, value, and conf from the given trailer.
639  *
640  * separator_pos must not be 0, since the token cannot be an empty string.
641  *
642  * If separator_pos is -1, interpret the whole trailer as a token.
643  */
parse_trailer(struct strbuf * tok,struct strbuf * val,const struct conf_info ** conf,const char * trailer,ssize_t separator_pos)644 static void parse_trailer(struct strbuf *tok, struct strbuf *val,
645 			 const struct conf_info **conf, const char *trailer,
646 			 ssize_t separator_pos)
647 {
648 	struct arg_item *item;
649 	size_t tok_len;
650 	struct list_head *pos;
651 
652 	if (separator_pos != -1) {
653 		strbuf_add(tok, trailer, separator_pos);
654 		strbuf_trim(tok);
655 		strbuf_addstr(val, trailer + separator_pos + 1);
656 		strbuf_trim(val);
657 	} else {
658 		strbuf_addstr(tok, trailer);
659 		strbuf_trim(tok);
660 	}
661 
662 	/* Lookup if the token matches something in the config */
663 	tok_len = token_len_without_separator(tok->buf, tok->len);
664 	if (conf)
665 		*conf = &default_conf_info;
666 	list_for_each(pos, &conf_head) {
667 		item = list_entry(pos, struct arg_item, list);
668 		if (token_matches_item(tok->buf, item, tok_len)) {
669 			char *tok_buf = strbuf_detach(tok, NULL);
670 			if (conf)
671 				*conf = &item->conf;
672 			strbuf_addstr(tok, token_from_item(item, tok_buf));
673 			free(tok_buf);
674 			break;
675 		}
676 	}
677 }
678 
add_trailer_item(struct list_head * head,char * tok,char * val)679 static struct trailer_item *add_trailer_item(struct list_head *head, char *tok,
680 					     char *val)
681 {
682 	struct trailer_item *new_item = xcalloc(1, sizeof(*new_item));
683 	new_item->token = tok;
684 	new_item->value = val;
685 	list_add_tail(&new_item->list, head);
686 	return new_item;
687 }
688 
add_arg_item(struct list_head * arg_head,char * tok,char * val,const struct conf_info * conf,const struct new_trailer_item * new_trailer_item)689 static void add_arg_item(struct list_head *arg_head, char *tok, char *val,
690 			 const struct conf_info *conf,
691 			 const struct new_trailer_item *new_trailer_item)
692 {
693 	struct arg_item *new_item = xcalloc(1, sizeof(*new_item));
694 	new_item->token = tok;
695 	new_item->value = val;
696 	duplicate_conf(&new_item->conf, conf);
697 	if (new_trailer_item) {
698 		if (new_trailer_item->where != WHERE_DEFAULT)
699 			new_item->conf.where = new_trailer_item->where;
700 		if (new_trailer_item->if_exists != EXISTS_DEFAULT)
701 			new_item->conf.if_exists = new_trailer_item->if_exists;
702 		if (new_trailer_item->if_missing != MISSING_DEFAULT)
703 			new_item->conf.if_missing = new_trailer_item->if_missing;
704 	}
705 	list_add_tail(&new_item->list, arg_head);
706 }
707 
process_command_line_args(struct list_head * arg_head,struct list_head * new_trailer_head)708 static void process_command_line_args(struct list_head *arg_head,
709 				      struct list_head *new_trailer_head)
710 {
711 	struct arg_item *item;
712 	struct strbuf tok = STRBUF_INIT;
713 	struct strbuf val = STRBUF_INIT;
714 	const struct conf_info *conf;
715 	struct list_head *pos;
716 
717 	/*
718 	 * In command-line arguments, '=' is accepted (in addition to the
719 	 * separators that are defined).
720 	 */
721 	char *cl_separators = xstrfmt("=%s", separators);
722 
723 	/* Add an arg item for each configured trailer with a command */
724 	list_for_each(pos, &conf_head) {
725 		item = list_entry(pos, struct arg_item, list);
726 		if (item->conf.command)
727 			add_arg_item(arg_head,
728 				     xstrdup(token_from_item(item, NULL)),
729 				     xstrdup(""),
730 				     &item->conf, NULL);
731 	}
732 
733 	/* Add an arg item for each trailer on the command line */
734 	list_for_each(pos, new_trailer_head) {
735 		struct new_trailer_item *tr =
736 			list_entry(pos, struct new_trailer_item, list);
737 		ssize_t separator_pos = find_separator(tr->text, cl_separators);
738 
739 		if (separator_pos == 0) {
740 			struct strbuf sb = STRBUF_INIT;
741 			strbuf_addstr(&sb, tr->text);
742 			strbuf_trim(&sb);
743 			error(_("empty trailer token in trailer '%.*s'"),
744 			      (int) sb.len, sb.buf);
745 			strbuf_release(&sb);
746 		} else {
747 			parse_trailer(&tok, &val, &conf, tr->text,
748 				      separator_pos);
749 			add_arg_item(arg_head,
750 				     strbuf_detach(&tok, NULL),
751 				     strbuf_detach(&val, NULL),
752 				     conf, tr);
753 		}
754 	}
755 
756 	free(cl_separators);
757 }
758 
read_input_file(struct strbuf * sb,const char * file)759 static void read_input_file(struct strbuf *sb, const char *file)
760 {
761 	if (file) {
762 		if (strbuf_read_file(sb, file, 0) < 0)
763 			die_errno(_("could not read input file '%s'"), file);
764 	} else {
765 		if (strbuf_read(sb, fileno(stdin), 0) < 0)
766 			die_errno(_("could not read from stdin"));
767 	}
768 }
769 
next_line(const char * str)770 static const char *next_line(const char *str)
771 {
772 	const char *nl = strchrnul(str, '\n');
773 	return nl + !!*nl;
774 }
775 
776 /*
777  * Return the position of the start of the last line. If len is 0, return -1.
778  */
last_line(const char * buf,size_t len)779 static ssize_t last_line(const char *buf, size_t len)
780 {
781 	ssize_t i;
782 	if (len == 0)
783 		return -1;
784 	if (len == 1)
785 		return 0;
786 	/*
787 	 * Skip the last character (in addition to the null terminator),
788 	 * because if the last character is a newline, it is considered as part
789 	 * of the last line anyway.
790 	 */
791 	i = len - 2;
792 
793 	for (; i >= 0; i--) {
794 		if (buf[i] == '\n')
795 			return i + 1;
796 	}
797 	return 0;
798 }
799 
800 /*
801  * Return the position of the start of the patch or the length of str if there
802  * is no patch in the message.
803  */
find_patch_start(const char * str)804 static size_t find_patch_start(const char *str)
805 {
806 	const char *s;
807 
808 	for (s = str; *s; s = next_line(s)) {
809 		const char *v;
810 
811 		if (skip_prefix(s, "---", &v) && isspace(*v))
812 			return s - str;
813 	}
814 
815 	return s - str;
816 }
817 
818 /*
819  * Return the position of the first trailer line or len if there are no
820  * trailers.
821  */
find_trailer_start(const char * buf,size_t len)822 static size_t find_trailer_start(const char *buf, size_t len)
823 {
824 	const char *s;
825 	ssize_t end_of_title, l;
826 	int only_spaces = 1;
827 	int recognized_prefix = 0, trailer_lines = 0, non_trailer_lines = 0;
828 	/*
829 	 * Number of possible continuation lines encountered. This will be
830 	 * reset to 0 if we encounter a trailer (since those lines are to be
831 	 * considered continuations of that trailer), and added to
832 	 * non_trailer_lines if we encounter a non-trailer (since those lines
833 	 * are to be considered non-trailers).
834 	 */
835 	int possible_continuation_lines = 0;
836 
837 	/* The first paragraph is the title and cannot be trailers */
838 	for (s = buf; s < buf + len; s = next_line(s)) {
839 		if (s[0] == comment_line_char)
840 			continue;
841 		if (is_blank_line(s))
842 			break;
843 	}
844 	end_of_title = s - buf;
845 
846 	/*
847 	 * Get the start of the trailers by looking starting from the end for a
848 	 * blank line before a set of non-blank lines that (i) are all
849 	 * trailers, or (ii) contains at least one Git-generated trailer and
850 	 * consists of at least 25% trailers.
851 	 */
852 	for (l = last_line(buf, len);
853 	     l >= end_of_title;
854 	     l = last_line(buf, l)) {
855 		const char *bol = buf + l;
856 		const char **p;
857 		ssize_t separator_pos;
858 
859 		if (bol[0] == comment_line_char) {
860 			non_trailer_lines += possible_continuation_lines;
861 			possible_continuation_lines = 0;
862 			continue;
863 		}
864 		if (is_blank_line(bol)) {
865 			if (only_spaces)
866 				continue;
867 			non_trailer_lines += possible_continuation_lines;
868 			if (recognized_prefix &&
869 			    trailer_lines * 3 >= non_trailer_lines)
870 				return next_line(bol) - buf;
871 			else if (trailer_lines && !non_trailer_lines)
872 				return next_line(bol) - buf;
873 			return len;
874 		}
875 		only_spaces = 0;
876 
877 		for (p = git_generated_prefixes; *p; p++) {
878 			if (starts_with(bol, *p)) {
879 				trailer_lines++;
880 				possible_continuation_lines = 0;
881 				recognized_prefix = 1;
882 				goto continue_outer_loop;
883 			}
884 		}
885 
886 		separator_pos = find_separator(bol, separators);
887 		if (separator_pos >= 1 && !isspace(bol[0])) {
888 			struct list_head *pos;
889 
890 			trailer_lines++;
891 			possible_continuation_lines = 0;
892 			if (recognized_prefix)
893 				continue;
894 			list_for_each(pos, &conf_head) {
895 				struct arg_item *item;
896 				item = list_entry(pos, struct arg_item, list);
897 				if (token_matches_item(bol, item,
898 						       separator_pos)) {
899 					recognized_prefix = 1;
900 					break;
901 				}
902 			}
903 		} else if (isspace(bol[0]))
904 			possible_continuation_lines++;
905 		else {
906 			non_trailer_lines++;
907 			non_trailer_lines += possible_continuation_lines;
908 			possible_continuation_lines = 0;
909 		}
910 continue_outer_loop:
911 		;
912 	}
913 
914 	return len;
915 }
916 
917 /* Return the position of the end of the trailers. */
find_trailer_end(const char * buf,size_t len)918 static size_t find_trailer_end(const char *buf, size_t len)
919 {
920 	return len - ignore_non_trailer(buf, len);
921 }
922 
ends_with_blank_line(const char * buf,size_t len)923 static int ends_with_blank_line(const char *buf, size_t len)
924 {
925 	ssize_t ll = last_line(buf, len);
926 	if (ll < 0)
927 		return 0;
928 	return is_blank_line(buf + ll);
929 }
930 
unfold_value(struct strbuf * val)931 static void unfold_value(struct strbuf *val)
932 {
933 	struct strbuf out = STRBUF_INIT;
934 	size_t i;
935 
936 	strbuf_grow(&out, val->len);
937 	i = 0;
938 	while (i < val->len) {
939 		char c = val->buf[i++];
940 		if (c == '\n') {
941 			/* Collapse continuation down to a single space. */
942 			while (i < val->len && isspace(val->buf[i]))
943 				i++;
944 			strbuf_addch(&out, ' ');
945 		} else {
946 			strbuf_addch(&out, c);
947 		}
948 	}
949 
950 	/* Empty lines may have left us with whitespace cruft at the edges */
951 	strbuf_trim(&out);
952 
953 	/* output goes back to val as if we modified it in-place */
954 	strbuf_swap(&out, val);
955 	strbuf_release(&out);
956 }
957 
process_input_file(FILE * outfile,const char * str,struct list_head * head,const struct process_trailer_options * opts)958 static size_t process_input_file(FILE *outfile,
959 				 const char *str,
960 				 struct list_head *head,
961 				 const struct process_trailer_options *opts)
962 {
963 	struct trailer_info info;
964 	struct strbuf tok = STRBUF_INIT;
965 	struct strbuf val = STRBUF_INIT;
966 	size_t i;
967 
968 	trailer_info_get(&info, str, opts);
969 
970 	/* Print lines before the trailers as is */
971 	if (!opts->only_trailers)
972 		fwrite(str, 1, info.trailer_start - str, outfile);
973 
974 	if (!opts->only_trailers && !info.blank_line_before_trailer)
975 		fprintf(outfile, "\n");
976 
977 	for (i = 0; i < info.trailer_nr; i++) {
978 		int separator_pos;
979 		char *trailer = info.trailers[i];
980 		if (trailer[0] == comment_line_char)
981 			continue;
982 		separator_pos = find_separator(trailer, separators);
983 		if (separator_pos >= 1) {
984 			parse_trailer(&tok, &val, NULL, trailer,
985 				      separator_pos);
986 			if (opts->unfold)
987 				unfold_value(&val);
988 			add_trailer_item(head,
989 					 strbuf_detach(&tok, NULL),
990 					 strbuf_detach(&val, NULL));
991 		} else if (!opts->only_trailers) {
992 			strbuf_addstr(&val, trailer);
993 			strbuf_strip_suffix(&val, "\n");
994 			add_trailer_item(head,
995 					 NULL,
996 					 strbuf_detach(&val, NULL));
997 		}
998 	}
999 
1000 	trailer_info_release(&info);
1001 
1002 	return info.trailer_end - str;
1003 }
1004 
free_all(struct list_head * head)1005 static void free_all(struct list_head *head)
1006 {
1007 	struct list_head *pos, *p;
1008 	list_for_each_safe(pos, p, head) {
1009 		list_del(pos);
1010 		free_trailer_item(list_entry(pos, struct trailer_item, list));
1011 	}
1012 }
1013 
1014 static struct tempfile *trailers_tempfile;
1015 
create_in_place_tempfile(const char * file)1016 static FILE *create_in_place_tempfile(const char *file)
1017 {
1018 	struct stat st;
1019 	struct strbuf filename_template = STRBUF_INIT;
1020 	const char *tail;
1021 	FILE *outfile;
1022 
1023 	if (stat(file, &st))
1024 		die_errno(_("could not stat %s"), file);
1025 	if (!S_ISREG(st.st_mode))
1026 		die(_("file %s is not a regular file"), file);
1027 	if (!(st.st_mode & S_IWUSR))
1028 		die(_("file %s is not writable by user"), file);
1029 
1030 	/* Create temporary file in the same directory as the original */
1031 	tail = strrchr(file, '/');
1032 	if (tail != NULL)
1033 		strbuf_add(&filename_template, file, tail - file + 1);
1034 	strbuf_addstr(&filename_template, "git-interpret-trailers-XXXXXX");
1035 
1036 	trailers_tempfile = xmks_tempfile_m(filename_template.buf, st.st_mode);
1037 	strbuf_release(&filename_template);
1038 	outfile = fdopen_tempfile(trailers_tempfile, "w");
1039 	if (!outfile)
1040 		die_errno(_("could not open temporary file"));
1041 
1042 	return outfile;
1043 }
1044 
process_trailers(const char * file,const struct process_trailer_options * opts,struct list_head * new_trailer_head)1045 void process_trailers(const char *file,
1046 		      const struct process_trailer_options *opts,
1047 		      struct list_head *new_trailer_head)
1048 {
1049 	LIST_HEAD(head);
1050 	struct strbuf sb = STRBUF_INIT;
1051 	size_t trailer_end;
1052 	FILE *outfile = stdout;
1053 
1054 	ensure_configured();
1055 
1056 	read_input_file(&sb, file);
1057 
1058 	if (opts->in_place)
1059 		outfile = create_in_place_tempfile(file);
1060 
1061 	/* Print the lines before the trailers */
1062 	trailer_end = process_input_file(outfile, sb.buf, &head, opts);
1063 
1064 	if (!opts->only_input) {
1065 		LIST_HEAD(arg_head);
1066 		process_command_line_args(&arg_head, new_trailer_head);
1067 		process_trailers_lists(&head, &arg_head);
1068 	}
1069 
1070 	print_all(outfile, &head, opts);
1071 
1072 	free_all(&head);
1073 
1074 	/* Print the lines after the trailers as is */
1075 	if (!opts->only_trailers)
1076 		fwrite(sb.buf + trailer_end, 1, sb.len - trailer_end, outfile);
1077 
1078 	if (opts->in_place)
1079 		if (rename_tempfile(&trailers_tempfile, file))
1080 			die_errno(_("could not rename temporary file to %s"), file);
1081 
1082 	strbuf_release(&sb);
1083 }
1084 
trailer_info_get(struct trailer_info * info,const char * str,const struct process_trailer_options * opts)1085 void trailer_info_get(struct trailer_info *info, const char *str,
1086 		      const struct process_trailer_options *opts)
1087 {
1088 	int patch_start, trailer_end, trailer_start;
1089 	struct strbuf **trailer_lines, **ptr;
1090 	char **trailer_strings = NULL;
1091 	size_t nr = 0, alloc = 0;
1092 	char **last = NULL;
1093 
1094 	ensure_configured();
1095 
1096 	if (opts->no_divider)
1097 		patch_start = strlen(str);
1098 	else
1099 		patch_start = find_patch_start(str);
1100 
1101 	trailer_end = find_trailer_end(str, patch_start);
1102 	trailer_start = find_trailer_start(str, trailer_end);
1103 
1104 	trailer_lines = strbuf_split_buf(str + trailer_start,
1105 					 trailer_end - trailer_start,
1106 					 '\n',
1107 					 0);
1108 	for (ptr = trailer_lines; *ptr; ptr++) {
1109 		if (last && isspace((*ptr)->buf[0])) {
1110 			struct strbuf sb = STRBUF_INIT;
1111 			strbuf_attach(&sb, *last, strlen(*last), strlen(*last));
1112 			strbuf_addbuf(&sb, *ptr);
1113 			*last = strbuf_detach(&sb, NULL);
1114 			continue;
1115 		}
1116 		ALLOC_GROW(trailer_strings, nr + 1, alloc);
1117 		trailer_strings[nr] = strbuf_detach(*ptr, NULL);
1118 		last = find_separator(trailer_strings[nr], separators) >= 1
1119 			? &trailer_strings[nr]
1120 			: NULL;
1121 		nr++;
1122 	}
1123 	strbuf_list_free(trailer_lines);
1124 
1125 	info->blank_line_before_trailer = ends_with_blank_line(str,
1126 							       trailer_start);
1127 	info->trailer_start = str + trailer_start;
1128 	info->trailer_end = str + trailer_end;
1129 	info->trailers = trailer_strings;
1130 	info->trailer_nr = nr;
1131 }
1132 
trailer_info_release(struct trailer_info * info)1133 void trailer_info_release(struct trailer_info *info)
1134 {
1135 	size_t i;
1136 	for (i = 0; i < info->trailer_nr; i++)
1137 		free(info->trailers[i]);
1138 	free(info->trailers);
1139 }
1140 
format_trailer_info(struct strbuf * out,const struct trailer_info * info,const struct process_trailer_options * opts)1141 static void format_trailer_info(struct strbuf *out,
1142 				const struct trailer_info *info,
1143 				const struct process_trailer_options *opts)
1144 {
1145 	size_t origlen = out->len;
1146 	size_t i;
1147 
1148 	/* If we want the whole block untouched, we can take the fast path. */
1149 	if (!opts->only_trailers && !opts->unfold && !opts->filter &&
1150 	    !opts->separator && !opts->key_only && !opts->value_only &&
1151 	    !opts->key_value_separator) {
1152 		strbuf_add(out, info->trailer_start,
1153 			   info->trailer_end - info->trailer_start);
1154 		return;
1155 	}
1156 
1157 	for (i = 0; i < info->trailer_nr; i++) {
1158 		char *trailer = info->trailers[i];
1159 		ssize_t separator_pos = find_separator(trailer, separators);
1160 
1161 		if (separator_pos >= 1) {
1162 			struct strbuf tok = STRBUF_INIT;
1163 			struct strbuf val = STRBUF_INIT;
1164 
1165 			parse_trailer(&tok, &val, NULL, trailer, separator_pos);
1166 			if (!opts->filter || opts->filter(&tok, opts->filter_data)) {
1167 				if (opts->unfold)
1168 					unfold_value(&val);
1169 
1170 				if (opts->separator && out->len != origlen)
1171 					strbuf_addbuf(out, opts->separator);
1172 				if (!opts->value_only)
1173 					strbuf_addbuf(out, &tok);
1174 				if (!opts->key_only && !opts->value_only) {
1175 					if (opts->key_value_separator)
1176 						strbuf_addbuf(out, opts->key_value_separator);
1177 					else
1178 						strbuf_addstr(out, ": ");
1179 				}
1180 				if (!opts->key_only)
1181 					strbuf_addbuf(out, &val);
1182 				if (!opts->separator)
1183 					strbuf_addch(out, '\n');
1184 			}
1185 			strbuf_release(&tok);
1186 			strbuf_release(&val);
1187 
1188 		} else if (!opts->only_trailers) {
1189 			if (opts->separator && out->len != origlen) {
1190 				strbuf_addbuf(out, opts->separator);
1191 			}
1192 			strbuf_addstr(out, trailer);
1193 			if (opts->separator) {
1194 				strbuf_rtrim(out);
1195 			}
1196 		}
1197 	}
1198 
1199 }
1200 
format_trailers_from_commit(struct strbuf * out,const char * msg,const struct process_trailer_options * opts)1201 void format_trailers_from_commit(struct strbuf *out, const char *msg,
1202 				 const struct process_trailer_options *opts)
1203 {
1204 	struct trailer_info info;
1205 
1206 	trailer_info_get(&info, msg, opts);
1207 	format_trailer_info(out, &info, opts);
1208 	trailer_info_release(&info);
1209 }
1210 
trailer_iterator_init(struct trailer_iterator * iter,const char * msg)1211 void trailer_iterator_init(struct trailer_iterator *iter, const char *msg)
1212 {
1213 	struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
1214 	strbuf_init(&iter->key, 0);
1215 	strbuf_init(&iter->val, 0);
1216 	opts.no_divider = 1;
1217 	trailer_info_get(&iter->info, msg, &opts);
1218 	iter->cur = 0;
1219 }
1220 
trailer_iterator_advance(struct trailer_iterator * iter)1221 int trailer_iterator_advance(struct trailer_iterator *iter)
1222 {
1223 	while (iter->cur < iter->info.trailer_nr) {
1224 		char *trailer = iter->info.trailers[iter->cur++];
1225 		int separator_pos = find_separator(trailer, separators);
1226 
1227 		if (separator_pos < 1)
1228 			continue; /* not a real trailer */
1229 
1230 		strbuf_reset(&iter->key);
1231 		strbuf_reset(&iter->val);
1232 		parse_trailer(&iter->key, &iter->val, NULL,
1233 			      trailer, separator_pos);
1234 		unfold_value(&iter->val);
1235 		return 1;
1236 	}
1237 	return 0;
1238 }
1239 
trailer_iterator_release(struct trailer_iterator * iter)1240 void trailer_iterator_release(struct trailer_iterator *iter)
1241 {
1242 	trailer_info_release(&iter->info);
1243 	strbuf_release(&iter->val);
1244 	strbuf_release(&iter->key);
1245 }
1246