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