Merge branch 'jk/output-prefix-cleanup'
[git/gitster.git] / fmt-merge-msg.c
blob6acb37b48020c1f0ce2d5034c478cbb783409502
1 #define USE_THE_REPOSITORY_VARIABLE
3 #include "git-compat-util.h"
4 #include "config.h"
5 #include "environment.h"
6 #include "refs.h"
7 #include "object-name.h"
8 #include "object-store-ll.h"
9 #include "diff.h"
10 #include "diff-merges.h"
11 #include "hex.h"
12 #include "revision.h"
13 #include "tag.h"
14 #include "string-list.h"
15 #include "branch.h"
16 #include "fmt-merge-msg.h"
17 #include "commit-reach.h"
18 #include "gpg-interface.h"
19 #include "wildmatch.h"
21 static int use_branch_desc;
22 static int suppress_dest_pattern_seen;
23 static struct string_list suppress_dest_patterns = STRING_LIST_INIT_DUP;
25 int fmt_merge_msg_config(const char *key, const char *value,
26 const struct config_context *ctx, void *cb)
28 if (!strcmp(key, "merge.log") || !strcmp(key, "merge.summary")) {
29 int is_bool;
30 merge_log_config = git_config_bool_or_int(key, value, ctx->kvi, &is_bool);
31 if (!is_bool && merge_log_config < 0)
32 return error("%s: negative length %s", key, value);
33 if (is_bool && merge_log_config)
34 merge_log_config = DEFAULT_MERGE_LOG_LEN;
35 } else if (!strcmp(key, "merge.branchdesc")) {
36 use_branch_desc = git_config_bool(key, value);
37 } else if (!strcmp(key, "merge.suppressdest")) {
38 if (!value)
39 return config_error_nonbool(key);
40 if (!*value)
41 string_list_clear(&suppress_dest_patterns, 0);
42 else
43 string_list_append(&suppress_dest_patterns, value);
44 suppress_dest_pattern_seen = 1;
45 } else {
46 return git_default_config(key, value, ctx, cb);
48 return 0;
51 /* merge data per repository where the merged tips came from */
52 struct src_data {
53 struct string_list branch, tag, r_branch, generic;
54 int head_status;
57 struct origin_data {
58 struct object_id oid;
59 unsigned is_local_branch:1;
62 static void init_src_data(struct src_data *data)
64 data->branch.strdup_strings = 1;
65 data->tag.strdup_strings = 1;
66 data->r_branch.strdup_strings = 1;
67 data->generic.strdup_strings = 1;
70 static struct string_list srcs = STRING_LIST_INIT_DUP;
71 static struct string_list origins = STRING_LIST_INIT_DUP;
73 struct merge_parents {
74 int alloc, nr;
75 struct merge_parent {
76 struct object_id given;
77 struct object_id commit;
78 unsigned char used;
79 } *item;
83 * I know, I know, this is inefficient, but you won't be pulling and merging
84 * hundreds of heads at a time anyway.
86 static struct merge_parent *find_merge_parent(struct merge_parents *table,
87 struct object_id *given,
88 struct object_id *commit)
90 int i;
91 for (i = 0; i < table->nr; i++) {
92 if (given && !oideq(&table->item[i].given, given))
93 continue;
94 if (commit && !oideq(&table->item[i].commit, commit))
95 continue;
96 return &table->item[i];
98 return NULL;
101 static void add_merge_parent(struct merge_parents *table,
102 struct object_id *given,
103 struct object_id *commit)
105 if (table->nr && find_merge_parent(table, given, commit))
106 return;
107 ALLOC_GROW(table->item, table->nr + 1, table->alloc);
108 oidcpy(&table->item[table->nr].given, given);
109 oidcpy(&table->item[table->nr].commit, commit);
110 table->item[table->nr].used = 0;
111 table->nr++;
114 static int handle_line(char *line, struct merge_parents *merge_parents)
116 int i, len = strlen(line);
117 struct origin_data *origin_data;
118 char *src;
119 const char *origin, *tag_name;
120 char *to_free = NULL;
121 struct src_data *src_data;
122 struct string_list_item *item;
123 int pulling_head = 0;
124 struct object_id oid;
125 const unsigned hexsz = the_hash_algo->hexsz;
127 if (len < hexsz + 3 || line[hexsz] != '\t')
128 return 1;
130 if (starts_with(line + hexsz + 1, "not-for-merge"))
131 return 0;
133 if (line[hexsz + 1] != '\t')
134 return 2;
136 i = get_oid_hex(line, &oid);
137 if (i)
138 return 3;
140 if (!find_merge_parent(merge_parents, &oid, NULL))
141 return 0; /* subsumed by other parents */
143 CALLOC_ARRAY(origin_data, 1);
144 oidcpy(&origin_data->oid, &oid);
146 if (line[len - 1] == '\n')
147 line[len - 1] = 0;
148 line += hexsz + 2;
151 * At this point, line points at the beginning of comment e.g.
152 * "branch 'frotz' of git://that/repository.git".
153 * Find the repository name and point it with src.
155 src = strstr(line, " of ");
156 if (src) {
157 *src = 0;
158 src += 4;
159 pulling_head = 0;
160 } else {
161 src = line;
162 pulling_head = 1;
165 item = unsorted_string_list_lookup(&srcs, src);
166 if (!item) {
167 item = string_list_append(&srcs, src);
168 item->util = xcalloc(1, sizeof(struct src_data));
169 init_src_data(item->util);
171 src_data = item->util;
173 if (pulling_head) {
174 origin = src;
175 src_data->head_status |= 1;
176 } else if (skip_prefix(line, "branch ", &origin)) {
177 origin_data->is_local_branch = 1;
178 string_list_append(&src_data->branch, origin);
179 src_data->head_status |= 2;
180 } else if (skip_prefix(line, "tag ", &tag_name)) {
181 origin = line;
182 string_list_append(&src_data->tag, tag_name);
183 src_data->head_status |= 2;
184 } else if (skip_prefix(line, "remote-tracking branch ", &origin)) {
185 string_list_append(&src_data->r_branch, origin);
186 src_data->head_status |= 2;
187 } else {
188 origin = src;
189 string_list_append(&src_data->generic, line);
190 src_data->head_status |= 2;
193 if (!strcmp(".", src) || !strcmp(src, origin)) {
194 int len = strlen(origin);
195 if (origin[0] == '\'' && origin[len - 1] == '\'')
196 origin = to_free = xmemdupz(origin + 1, len - 2);
197 } else
198 origin = to_free = xstrfmt("%s of %s", origin, src);
199 if (strcmp(".", src))
200 origin_data->is_local_branch = 0;
201 string_list_append(&origins, origin)->util = origin_data;
202 free(to_free);
203 return 0;
206 static void print_joined(const char *singular, const char *plural,
207 struct string_list *list, struct strbuf *out)
209 if (list->nr == 0)
210 return;
211 if (list->nr == 1) {
212 strbuf_addf(out, "%s%s", singular, list->items[0].string);
213 } else {
214 int i;
215 strbuf_addstr(out, plural);
216 for (i = 0; i < list->nr - 1; i++)
217 strbuf_addf(out, "%s%s", i > 0 ? ", " : "",
218 list->items[i].string);
219 strbuf_addf(out, " and %s", list->items[list->nr - 1].string);
223 static void add_branch_desc(struct strbuf *out, const char *name)
225 struct strbuf desc = STRBUF_INIT;
227 if (!read_branch_desc(&desc, name)) {
228 const char *bp = desc.buf;
229 while (*bp) {
230 const char *ep = strchrnul(bp, '\n');
231 if (*ep)
232 ep++;
233 strbuf_addf(out, " : %.*s", (int)(ep - bp), bp);
234 bp = ep;
236 strbuf_complete_line(out);
238 strbuf_release(&desc);
241 #define util_as_integral(elem) ((intptr_t)((elem)->util))
243 static void record_person_from_buf(int which, struct string_list *people,
244 const char *buffer)
246 char *name_buf, *name, *name_end;
247 struct string_list_item *elem;
248 const char *field;
250 field = (which == 'a') ? "\nauthor " : "\ncommitter ";
251 name = strstr(buffer, field);
252 if (!name)
253 return;
254 name += strlen(field);
255 name_end = strchrnul(name, '<');
256 if (*name_end)
257 name_end--;
258 while (isspace(*name_end) && name <= name_end)
259 name_end--;
260 if (name_end < name)
261 return;
262 name_buf = xmemdupz(name, name_end - name + 1);
264 elem = string_list_lookup(people, name_buf);
265 if (!elem) {
266 elem = string_list_insert(people, name_buf);
267 elem->util = (void *)0;
269 elem->util = (void*)(util_as_integral(elem) + 1);
270 free(name_buf);
274 static void record_person(int which, struct string_list *people,
275 struct commit *commit)
277 const char *buffer = repo_get_commit_buffer(the_repository, commit,
278 NULL);
279 record_person_from_buf(which, people, buffer);
280 repo_unuse_commit_buffer(the_repository, commit, buffer);
283 static int cmp_string_list_util_as_integral(const void *a_, const void *b_)
285 const struct string_list_item *a = a_, *b = b_;
286 return util_as_integral(b) - util_as_integral(a);
289 static void add_people_count(struct strbuf *out, struct string_list *people)
291 if (people->nr == 1)
292 strbuf_addstr(out, people->items[0].string);
293 else if (people->nr == 2)
294 strbuf_addf(out, "%s (%d) and %s (%d)",
295 people->items[0].string,
296 (int)util_as_integral(&people->items[0]),
297 people->items[1].string,
298 (int)util_as_integral(&people->items[1]));
299 else if (people->nr)
300 strbuf_addf(out, "%s (%d) and others",
301 people->items[0].string,
302 (int)util_as_integral(&people->items[0]));
305 static void credit_people(struct strbuf *out,
306 struct string_list *them,
307 int kind)
309 const char *label;
310 const char *me;
312 if (kind == 'a') {
313 label = "By";
314 me = git_author_info(IDENT_NO_DATE);
315 } else {
316 label = "Via";
317 me = git_committer_info(IDENT_NO_DATE);
320 if (!them->nr ||
321 (them->nr == 1 &&
322 me &&
323 skip_prefix(me, them->items->string, &me) &&
324 starts_with(me, " <")))
325 return;
326 strbuf_addf(out, "\n%s %s ", comment_line_str, label);
327 add_people_count(out, them);
330 static void add_people_info(struct strbuf *out,
331 struct string_list *authors,
332 struct string_list *committers)
334 QSORT(authors->items, authors->nr,
335 cmp_string_list_util_as_integral);
336 QSORT(committers->items, committers->nr,
337 cmp_string_list_util_as_integral);
339 credit_people(out, authors, 'a');
340 credit_people(out, committers, 'c');
343 static void shortlog(const char *name,
344 struct origin_data *origin_data,
345 struct commit *head,
346 struct rev_info *rev,
347 struct fmt_merge_msg_opts *opts,
348 struct strbuf *out)
350 int i, count = 0;
351 struct commit *commit;
352 struct object *branch;
353 struct string_list subjects = STRING_LIST_INIT_DUP;
354 struct string_list authors = STRING_LIST_INIT_DUP;
355 struct string_list committers = STRING_LIST_INIT_DUP;
356 int flags = UNINTERESTING | TREESAME | SEEN | SHOWN | ADDED;
357 struct strbuf sb = STRBUF_INIT;
358 const struct object_id *oid = &origin_data->oid;
359 int limit = opts->shortlog_len;
361 branch = deref_tag(the_repository, parse_object(the_repository, oid),
362 oid_to_hex(oid),
363 the_hash_algo->hexsz);
364 if (!branch || branch->type != OBJ_COMMIT)
365 return;
367 setup_revisions(0, NULL, rev, NULL);
368 add_pending_object(rev, branch, name);
369 add_pending_object(rev, &head->object, "^HEAD");
370 head->object.flags |= UNINTERESTING;
371 if (prepare_revision_walk(rev))
372 die("revision walk setup failed");
373 while ((commit = get_revision(rev)) != NULL) {
374 struct pretty_print_context ctx = {0};
376 if (commit->parents && commit->parents->next) {
377 /* do not list a merge but count committer */
378 if (opts->credit_people)
379 record_person('c', &committers, commit);
380 continue;
382 if (!count && opts->credit_people)
383 /* the 'tip' committer */
384 record_person('c', &committers, commit);
385 if (opts->credit_people)
386 record_person('a', &authors, commit);
387 count++;
388 if (subjects.nr > limit)
389 continue;
391 repo_format_commit_message(the_repository, commit, "%s", &sb,
392 &ctx);
393 strbuf_ltrim(&sb);
395 if (!sb.len)
396 string_list_append(&subjects,
397 oid_to_hex(&commit->object.oid));
398 else
399 string_list_append_nodup(&subjects,
400 strbuf_detach(&sb, NULL));
403 if (opts->credit_people)
404 add_people_info(out, &authors, &committers);
405 if (count > limit)
406 strbuf_addf(out, "\n* %s: (%d commits)\n", name, count);
407 else
408 strbuf_addf(out, "\n* %s:\n", name);
410 if (origin_data->is_local_branch && use_branch_desc)
411 add_branch_desc(out, name);
413 for (i = 0; i < subjects.nr; i++)
414 if (i >= limit)
415 strbuf_addstr(out, " ...\n");
416 else
417 strbuf_addf(out, " %s\n", subjects.items[i].string);
419 clear_commit_marks((struct commit *)branch, flags);
420 clear_commit_marks(head, flags);
421 free_commit_list(rev->commits);
422 rev->commits = NULL;
423 rev->pending.nr = 0;
425 string_list_clear(&authors, 0);
426 string_list_clear(&committers, 0);
427 string_list_clear(&subjects, 0);
431 * See if dest_branch matches with any glob pattern on the
432 * suppress_dest_patterns list.
434 * We may want to also allow negative matches e.g. ":!glob" like we do
435 * for pathspec, but for now, let's keep it simple and stupid.
437 static int dest_suppressed(const char *dest_branch)
439 struct string_list_item *item;
441 for_each_string_list_item(item, &suppress_dest_patterns) {
442 if (!wildmatch(item->string, dest_branch, WM_PATHNAME))
443 return 1;
445 return 0;
448 static void fmt_merge_msg_title(struct strbuf *out,
449 const char *current_branch)
451 int i = 0;
452 const char *sep = "";
454 strbuf_addstr(out, "Merge ");
455 for (i = 0; i < srcs.nr; i++) {
456 struct src_data *src_data = srcs.items[i].util;
457 const char *subsep = "";
459 strbuf_addstr(out, sep);
460 sep = "; ";
462 if (src_data->head_status == 1) {
463 strbuf_addstr(out, srcs.items[i].string);
464 continue;
466 if (src_data->head_status == 3) {
467 subsep = ", ";
468 strbuf_addstr(out, "HEAD");
470 if (src_data->branch.nr) {
471 strbuf_addstr(out, subsep);
472 subsep = ", ";
473 print_joined("branch ", "branches ", &src_data->branch,
474 out);
476 if (src_data->r_branch.nr) {
477 strbuf_addstr(out, subsep);
478 subsep = ", ";
479 print_joined("remote-tracking branch ", "remote-tracking branches ",
480 &src_data->r_branch, out);
482 if (src_data->tag.nr) {
483 strbuf_addstr(out, subsep);
484 subsep = ", ";
485 print_joined("tag ", "tags ", &src_data->tag, out);
487 if (src_data->generic.nr) {
488 strbuf_addstr(out, subsep);
489 print_joined("commit ", "commits ", &src_data->generic,
490 out);
492 if (strcmp(".", srcs.items[i].string))
493 strbuf_addf(out, " of %s", srcs.items[i].string);
496 if (!dest_suppressed(current_branch))
497 strbuf_addf(out, " into %s", current_branch);
498 strbuf_addch(out, '\n');
501 static void fmt_tag_signature(struct strbuf *tagbuf,
502 struct strbuf *sig,
503 const char *buf,
504 unsigned long len)
506 const char *tag_body = strstr(buf, "\n\n");
507 if (tag_body) {
508 tag_body += 2;
509 strbuf_add(tagbuf, tag_body, buf + len - tag_body);
511 strbuf_complete_line(tagbuf);
512 if (sig->len) {
513 strbuf_addch(tagbuf, '\n');
514 strbuf_add_commented_lines(tagbuf, sig->buf, sig->len,
515 comment_line_str);
519 static void fmt_merge_msg_sigs(struct strbuf *out)
521 int i, tag_number = 0, first_tag = 0;
522 struct strbuf tagbuf = STRBUF_INIT;
524 for (i = 0; i < origins.nr; i++) {
525 struct object_id *oid = origins.items[i].util;
526 enum object_type type;
527 unsigned long size;
528 char *buf = repo_read_object_file(the_repository, oid, &type,
529 &size);
530 char *origbuf = buf;
531 unsigned long len = size;
532 struct signature_check sigc = { NULL };
533 struct strbuf payload = STRBUF_INIT, sig = STRBUF_INIT;
535 if (!buf || type != OBJ_TAG)
536 goto next;
538 if (!parse_signature(buf, size, &payload, &sig))
539 ;/* merely annotated */
540 else {
541 buf = payload.buf;
542 len = payload.len;
543 sigc.payload_type = SIGNATURE_PAYLOAD_TAG;
544 sigc.payload = strbuf_detach(&payload, &sigc.payload_len);
545 if (check_signature(&sigc, sig.buf, sig.len) &&
546 !sigc.output)
547 strbuf_addstr(&sig, "gpg verification failed.\n");
548 else
549 strbuf_addstr(&sig, sigc.output);
552 if (!tag_number++) {
553 fmt_tag_signature(&tagbuf, &sig, buf, len);
554 first_tag = i;
555 } else {
556 if (tag_number == 2) {
557 struct strbuf tagline = STRBUF_INIT;
558 strbuf_addch(&tagline, '\n');
559 strbuf_add_commented_lines(&tagline,
560 origins.items[first_tag].string,
561 strlen(origins.items[first_tag].string),
562 comment_line_str);
563 strbuf_insert(&tagbuf, 0, tagline.buf,
564 tagline.len);
565 strbuf_release(&tagline);
567 strbuf_addch(&tagbuf, '\n');
568 strbuf_add_commented_lines(&tagbuf,
569 origins.items[i].string,
570 strlen(origins.items[i].string),
571 comment_line_str);
572 fmt_tag_signature(&tagbuf, &sig, buf, len);
574 strbuf_release(&payload);
575 strbuf_release(&sig);
576 signature_check_clear(&sigc);
577 next:
578 free(origbuf);
580 if (tagbuf.len) {
581 strbuf_addch(out, '\n');
582 strbuf_addbuf(out, &tagbuf);
584 strbuf_release(&tagbuf);
587 static void find_merge_parents(struct merge_parents *result,
588 struct strbuf *in, struct object_id *head)
590 struct commit_list *parents;
591 struct commit *head_commit;
592 int pos = 0, i, j;
594 parents = NULL;
595 while (pos < in->len) {
596 int len;
597 char *p = in->buf + pos;
598 char *newline = strchr(p, '\n');
599 const char *q;
600 struct object_id oid;
601 struct commit *parent;
602 struct object *obj;
604 len = newline ? newline - p : strlen(p);
605 pos += len + !!newline;
607 if (parse_oid_hex(p, &oid, &q) ||
608 q[0] != '\t' ||
609 q[1] != '\t')
610 continue; /* skip not-for-merge */
612 * Do not use get_merge_parent() here; we do not have
613 * "name" here and we do not want to contaminate its
614 * util field yet.
616 obj = parse_object(the_repository, &oid);
617 parent = (struct commit *)repo_peel_to_type(the_repository,
618 NULL, 0, obj,
619 OBJ_COMMIT);
620 if (!parent)
621 continue;
622 commit_list_insert(parent, &parents);
623 add_merge_parent(result, &obj->oid, &parent->object.oid);
625 head_commit = lookup_commit(the_repository, head);
626 if (head_commit)
627 commit_list_insert(head_commit, &parents);
628 reduce_heads_replace(&parents);
630 while (parents) {
631 struct commit *cmit = pop_commit(&parents);
632 for (i = 0; i < result->nr; i++)
633 if (oideq(&result->item[i].commit, &cmit->object.oid))
634 result->item[i].used = 1;
637 for (i = j = 0; i < result->nr; i++) {
638 if (result->item[i].used) {
639 if (i != j)
640 result->item[j] = result->item[i];
641 j++;
644 result->nr = j;
648 int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
649 struct fmt_merge_msg_opts *opts)
651 int i = 0, pos = 0;
652 struct object_id head_oid;
653 const char *current_branch;
654 void *current_branch_to_free;
655 struct merge_parents merge_parents;
657 if (!suppress_dest_pattern_seen) {
658 string_list_append(&suppress_dest_patterns, "main");
659 string_list_append(&suppress_dest_patterns, "master");
662 memset(&merge_parents, 0, sizeof(merge_parents));
664 /* learn the commit that we merge into and the current branch name */
665 current_branch = current_branch_to_free =
666 refs_resolve_refdup(get_main_ref_store(the_repository),
667 "HEAD", RESOLVE_REF_READING, &head_oid,
668 NULL);
669 if (!current_branch)
670 die("No current branch");
672 if (opts->into_name)
673 current_branch = opts->into_name;
674 else if (starts_with(current_branch, "refs/heads/"))
675 current_branch += 11;
677 find_merge_parents(&merge_parents, in, &head_oid);
679 /* get a line */
680 while (pos < in->len) {
681 int len;
682 char *newline, *p = in->buf + pos;
684 newline = strchr(p, '\n');
685 len = newline ? newline - p : strlen(p);
686 pos += len + !!newline;
687 i++;
688 p[len] = 0;
689 if (handle_line(p, &merge_parents))
690 die("error in line %d: %.*s", i, len, p);
693 if (opts->add_title && srcs.nr)
694 fmt_merge_msg_title(out, current_branch);
696 if (origins.nr)
697 fmt_merge_msg_sigs(out);
699 if (opts->shortlog_len) {
700 struct commit *head;
701 struct rev_info rev;
703 head = lookup_commit_or_die(&head_oid, "HEAD");
704 repo_init_revisions(the_repository, &rev, NULL);
705 rev.commit_format = CMIT_FMT_ONELINE;
706 diff_merges_suppress(&rev);
707 rev.limited = 1;
709 strbuf_complete_line(out);
711 for (i = 0; i < origins.nr; i++)
712 shortlog(origins.items[i].string,
713 origins.items[i].util,
714 head, &rev, opts, out);
715 release_revisions(&rev);
718 strbuf_complete_line(out);
719 free(current_branch_to_free);
720 free(merge_parents.item);
721 return 0;