builtin/fmt-merge-msg.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "commit.h"
   4 #include "diff.h"
   5 #include "revision.h"
   6 #include "tag.h"
   7 #include "string-list.h"
   8
   9 static const char * const fmt_merge_msg_usage[] = {
  10         "git fmt-merge-msg [-m <message>] [--log|--no-log] [--file <file>]",
  11         NULL
  12 };
  13
  14 static int merge_summary;
  15
  16 static int fmt_merge_msg_config(const char *key, const char *value, void *cb)
  17 {
  18         static int found_merge_log = 0;
  19         if (!strcmp("merge.log", key)) {
  20                 found_merge_log = 1;
  21                 merge_summary = git_config_bool(key, value);
  22         }
  23         if (!found_merge_log && !strcmp("merge.summary", key))
  24                 merge_summary = git_config_bool(key, value);
  25         return 0;
  26 }
  27
  28 struct src_data {
  29         struct string_list branch, tag, r_branch, generic;
  30         int head_status;
  31 };
  32
  33 void init_src_data(struct src_data *data)
  34 {
  35         data->branch.strdup_strings = 1;
  36         data->tag.strdup_strings = 1;
  37         data->r_branch.strdup_strings = 1;
  38         data->generic.strdup_strings = 1;
  39 }
  40
  41 static struct string_list srcs = STRING_LIST_INIT_DUP;
  42 static struct string_list origins = STRING_LIST_INIT_DUP;
  43
  44 static int handle_line(char *line)
  45 {
  46         int i, len = strlen(line);
  47         unsigned char *sha1;
  48         char *src, *origin;
  49         struct src_data *src_data;
  50         struct string_list_item *item;
  51         int pulling_head = 0;
  52
  53         if (len < 43 || line[40] != '\t')
  54                 return 1;
  55
  56         if (!prefixcmp(line + 41, "not-for-merge"))
  57                 return 0;
  58
  59         if (line[41] != '\t')
  60                 return 2;
  61
  62         line[40] = 0;
  63         sha1 = xmalloc(20);
  64         i = get_sha1(line, sha1);
  65         line[40] = '\t';
  66         if (i)
  67                 return 3;
  68
  69         if (line[len - 1] == '\n')
  70                 line[len - 1] = 0;
  71         line += 42;
  72
  73         src = strstr(line, " of ");
  74         if (src) {
  75                 *src = 0;
  76                 src += 4;
  77                 pulling_head = 0;
  78         } else {
  79                 src = line;
  80                 pulling_head = 1;
  81         }
  82
  83         item = unsorted_string_list_lookup(&srcs, src);
  84         if (!item) {
  85                 item = string_list_append(&srcs, src);
  86                 item->util = xcalloc(1, sizeof(struct src_data));
  87                 init_src_data(item->util);
  88         }
  89         src_data = item->util;
  90
  91         if (pulling_head) {
  92                 origin = src;
  93                 src_data->head_status |= 1;
  94         } else if (!prefixcmp(line, "branch ")) {
  95                 origin = line + 7;
  96                 string_list_append(&src_data->branch, origin);
  97                 src_data->head_status |= 2;
  98         } else if (!prefixcmp(line, "tag ")) {
  99                 origin = line;
 100                 string_list_append(&src_data->tag, origin + 4);
 101                 src_data->head_status |= 2;
 102         } else if (!prefixcmp(line, "remote branch ")) {
 103                 origin = line + 14;
 104                 string_list_append(&src_data->r_branch, origin);
 105                 src_data->head_status |= 2;
 106         } else {
 107                 origin = src;
 108                 string_list_append(&src_data->generic, line);
 109                 src_data->head_status |= 2;
 110         }
 111
 112         if (!strcmp(".", src) || !strcmp(src, origin)) {
 113                 int len = strlen(origin);
 114                 if (origin[0] == '\'' && origin[len - 1] == '\'')
 115                         origin = xmemdupz(origin + 1, len - 2);
 116         } else {
 117                 char *new_origin = xmalloc(strlen(origin) + strlen(src) + 5);
 118                 sprintf(new_origin, "%s of %s", origin, src);
 119                 origin = new_origin;
 120         }
 121         string_list_append(&origins, origin)->util = sha1;
 122         return 0;
 123 }
 124
 125 static void print_joined(const char *singular, const char *plural,
 126                 struct string_list *list, struct strbuf *out)
 127 {
 128         if (list->nr == 0)
 129                 return;
 130         if (list->nr == 1) {
 131                 strbuf_addf(out, "%s%s", singular, list->items[0].string);
 132         } else {
 133                 int i;
 134                 strbuf_addstr(out, plural);
 135                 for (i = 0; i < list->nr - 1; i++)
 136                         strbuf_addf(out, "%s%s", i > 0 ? ", " : "",
 137                                     list->items[i].string);
 138                 strbuf_addf(out, " and %s", list->items[list->nr - 1].string);
 139         }
 140 }
 141
 142 static void shortlog(const char *name, unsigned char *sha1,
 143                 struct commit *head, struct rev_info *rev, int limit,
 144                 struct strbuf *out)
 145 {
 146         int i, count = 0;
 147         struct commit *commit;
 148         struct object *branch;
 149         struct string_list subjects = STRING_LIST_INIT_DUP;
 150         int flags = UNINTERESTING | TREESAME | SEEN | SHOWN | ADDED;
 151         struct strbuf sb = STRBUF_INIT;
 152
 153         branch = deref_tag(parse_object(sha1), sha1_to_hex(sha1), 40);
 154         if (!branch || branch->type != OBJ_COMMIT)
 155                 return;
 156
 157         setup_revisions(0, NULL, rev, NULL);
 158         rev->ignore_merges = 1;
 159         add_pending_object(rev, branch, name);
 160         add_pending_object(rev, &head->object, "^HEAD");
 161         head->object.flags |= UNINTERESTING;
 162         if (prepare_revision_walk(rev))
 163                 die("revision walk setup failed");
 164         while ((commit = get_revision(rev)) != NULL) {
 165                 struct pretty_print_context ctx = {0};
 166
 167                 /* ignore merges */
 168                 if (commit->parents && commit->parents->next)
 169                         continue;
 170
 171                 count++;
 172                 if (subjects.nr > limit)
 173                         continue;
 174
 175                 format_commit_message(commit, "%s", &sb, &ctx);
 176                 strbuf_ltrim(&sb);
 177
 178                 if (!sb.len)
 179                         string_list_append(&subjects,
 180                                            sha1_to_hex(commit->object.sha1));
 181                 else
 182                         string_list_append(&subjects, strbuf_detach(&sb, NULL));
 183         }
 184
 185         if (count > limit)
 186                 strbuf_addf(out, "\n* %s: (%d commits)\n", name, count);
 187         else
 188                 strbuf_addf(out, "\n* %s:\n", name);
 189
 190         for (i = 0; i < subjects.nr; i++)
 191                 if (i >= limit)
 192                         strbuf_addf(out, "  ...\n");
 193                 else
 194                         strbuf_addf(out, "  %s\n", subjects.items[i].string);
 195
 196         clear_commit_marks((struct commit *)branch, flags);
 197         clear_commit_marks(head, flags);
 198         free_commit_list(rev->commits);
 199         rev->commits = NULL;
 200         rev->pending.nr = 0;
 201
 202         string_list_clear(&subjects, 0);
 203 }
 204
 205 static void do_fmt_merge_msg_title(struct strbuf *out,
 206         const char *current_branch) {
 207         int i = 0;
 208         char *sep = "";
 209
 210         strbuf_addstr(out, "Merge ");
 211         for (i = 0; i < srcs.nr; i++) {
 212                 struct src_data *src_data = srcs.items[i].util;
 213                 const char *subsep = "";
 214
 215                 strbuf_addstr(out, sep);
 216                 sep = "; ";
 217
 218                 if (src_data->head_status == 1) {
 219                         strbuf_addstr(out, srcs.items[i].string);
 220                         continue;
 221                 }
 222                 if (src_data->head_status == 3) {
 223                         subsep = ", ";
 224                         strbuf_addstr(out, "HEAD");
 225                 }
 226                 if (src_data->branch.nr) {
 227                         strbuf_addstr(out, subsep);
 228                         subsep = ", ";
 229                         print_joined("branch ", "branches ", &src_data->branch,
 230                                         out);
 231                 }
 232                 if (src_data->r_branch.nr) {
 233                         strbuf_addstr(out, subsep);
 234                         subsep = ", ";
 235                         print_joined("remote branch ", "remote branches ",
 236                                         &src_data->r_branch, out);
 237                 }
 238                 if (src_data->tag.nr) {
 239                         strbuf_addstr(out, subsep);
 240                         subsep = ", ";
 241                         print_joined("tag ", "tags ", &src_data->tag, out);
 242                 }
 243                 if (src_data->generic.nr) {
 244                         strbuf_addstr(out, subsep);
 245                         print_joined("commit ", "commits ", &src_data->generic,
 246                                         out);
 247                 }
 248                 if (strcmp(".", srcs.items[i].string))
 249                         strbuf_addf(out, " of %s", srcs.items[i].string);
 250         }
 251
 252         if (!strcmp("master", current_branch))
 253                 strbuf_addch(out, '\n');
 254         else
 255                 strbuf_addf(out, " into %s\n", current_branch);
 256 }
 257
 258 static int do_fmt_merge_msg(int merge_title, int merge_summary,
 259         struct strbuf *in, struct strbuf *out) {
 260         int limit = 20, i = 0, pos = 0;
 261         unsigned char head_sha1[20];
 262         const char *current_branch;
 263
 264         /* get current branch */
 265         current_branch = resolve_ref("HEAD", head_sha1, 1, NULL);
 266         if (!current_branch)
 267                 die("No current branch");
 268         if (!prefixcmp(current_branch, "refs/heads/"))
 269                 current_branch += 11;
 270
 271         /* get a line */
 272         while (pos < in->len) {
 273                 int len;
 274                 char *newline, *p = in->buf + pos;
 275
 276                 newline = strchr(p, '\n');
 277                 len = newline ? newline - p : strlen(p);
 278                 pos += len + !!newline;
 279                 i++;
 280                 p[len] = 0;
 281                 if (handle_line(p))
 282                         die ("Error in line %d: %.*s", i, len, p);
 283         }
 284
 285         if (!srcs.nr)
 286                 return 0;
 287
 288         if (merge_title)
 289                 do_fmt_merge_msg_title(out, current_branch);
 290
 291         if (merge_summary) {
 292                 struct commit *head;
 293                 struct rev_info rev;
 294
 295                 head = lookup_commit(head_sha1);
 296                 init_revisions(&rev, NULL);
 297                 rev.commit_format = CMIT_FMT_ONELINE;
 298                 rev.ignore_merges = 1;
 299                 rev.limited = 1;
 300
 301                 if (suffixcmp(out->buf, "\n"))
 302                         strbuf_addch(out, '\n');
 303
 304                 for (i = 0; i < origins.nr; i++)
 305                         shortlog(origins.items[i].string, origins.items[i].util,
 306                                         head, &rev, limit, out);
 307         }
 308         return 0;
 309 }
 310
 311 int fmt_merge_msg(int merge_summary, struct strbuf *in, struct strbuf *out) {
 312         return do_fmt_merge_msg(1, merge_summary, in, out);
 313 }
 314
 315 int fmt_merge_msg_shortlog(struct strbuf *in, struct strbuf *out) {
 316         return do_fmt_merge_msg(0, 1, in, out);
 317 }
 318
 319 int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix)
 320 {
 321         const char *inpath = NULL;
 322         const char *message = NULL;
 323         struct option options[] = {
 324                 OPT_BOOLEAN(0, "log",     &merge_summary, "populate log with the shortlog"),
 325                 { OPTION_BOOLEAN, 0, "summary", &merge_summary, NULL,
 326                   "alias for --log (deprecated)",
 327                   PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
 328                 OPT_STRING('m', "message", &message, "text",
 329                         "use <text> as start of message"),
 330                 OPT_FILENAME('F', "file", &inpath, "file to read from"),
 331                 OPT_END()
 332         };
 333
 334         FILE *in = stdin;
 335         struct strbuf input = STRBUF_INIT, output = STRBUF_INIT;
 336         int ret;
 337
 338         git_config(fmt_merge_msg_config, NULL);
 339         argc = parse_options(argc, argv, prefix, options, fmt_merge_msg_usage,
 340                              0);
 341         if (argc > 0)
 342                 usage_with_options(fmt_merge_msg_usage, options);
 343         if (message && !merge_summary) {
 344                 char nl = '\n';
 345                 write_in_full(STDOUT_FILENO, message, strlen(message));
 346                 write_in_full(STDOUT_FILENO, &nl, 1);
 347                 return 0;
 348         }
 349
 350         if (inpath && strcmp(inpath, "-")) {
 351                 in = fopen(inpath, "r");
 352                 if (!in)
 353                         die_errno("cannot open '%s'", inpath);
 354         }
 355
 356         if (strbuf_read(&input, fileno(in), 0) < 0)
 357                 die_errno("could not read input file");
 358         if (message) {
 359                 strbuf_addstr(&output, message);
 360                 ret = fmt_merge_msg_shortlog(&input, &output);
 361         } else {
 362                 ret = fmt_merge_msg(merge_summary, &input, &output);
 363         }
 364         if (ret)
 365                 return ret;
 366         write_in_full(STDOUT_FILENO, output.buf, output.len);
 367         return 0;
 368 }