Merge branch 'tb/pack-bitmap'
[git] / commit.c
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "commit-graph.h"
5 #include "repository.h"
6 #include "object-store.h"
7 #include "pkt-line.h"
8 #include "utf8.h"
9 #include "diff.h"
10 #include "revision.h"
11 #include "notes.h"
12 #include "alloc.h"
13 #include "gpg-interface.h"
14 #include "mergesort.h"
15 #include "commit-slab.h"
16 #include "prio-queue.h"
17 #include "sha1-lookup.h"
18 #include "wt-status.h"
19 #include "advice.h"
20 #include "refs.h"
21 #include "commit-reach.h"
22 #include "run-command.h"
23 #include "shallow.h"
24
25 static struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **);
26
27 int save_commit_buffer = 1;
28
29 const char *commit_type = "commit";
30
31 struct commit *lookup_commit_reference_gently(struct repository *r,
32                 const struct object_id *oid, int quiet)
33 {
34         struct object *obj = deref_tag(r,
35                                        parse_object(r, oid),
36                                        NULL, 0);
37
38         if (!obj)
39                 return NULL;
40         return object_as_type(obj, OBJ_COMMIT, quiet);
41 }
42
43 struct commit *lookup_commit_reference(struct repository *r, const struct object_id *oid)
44 {
45         return lookup_commit_reference_gently(r, oid, 0);
46 }
47
48 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name)
49 {
50         struct commit *c = lookup_commit_reference(the_repository, oid);
51         if (!c)
52                 die(_("could not parse %s"), ref_name);
53         if (!oideq(oid, &c->object.oid)) {
54                 warning(_("%s %s is not a commit!"),
55                         ref_name, oid_to_hex(oid));
56         }
57         return c;
58 }
59
60 struct commit *lookup_commit(struct repository *r, const struct object_id *oid)
61 {
62         struct object *obj = lookup_object(r, oid);
63         if (!obj)
64                 return create_object(r, oid, alloc_commit_node(r));
65         return object_as_type(obj, OBJ_COMMIT, 0);
66 }
67
68 struct commit *lookup_commit_reference_by_name(const char *name)
69 {
70         struct object_id oid;
71         struct commit *commit;
72
73         if (get_oid_committish(name, &oid))
74                 return NULL;
75         commit = lookup_commit_reference(the_repository, &oid);
76         if (parse_commit(commit))
77                 return NULL;
78         return commit;
79 }
80
81 static timestamp_t parse_commit_date(const char *buf, const char *tail)
82 {
83         const char *dateptr;
84
85         if (buf + 6 >= tail)
86                 return 0;
87         if (memcmp(buf, "author", 6))
88                 return 0;
89         while (buf < tail && *buf++ != '\n')
90                 /* nada */;
91         if (buf + 9 >= tail)
92                 return 0;
93         if (memcmp(buf, "committer", 9))
94                 return 0;
95         while (buf < tail && *buf++ != '>')
96                 /* nada */;
97         if (buf >= tail)
98                 return 0;
99         dateptr = buf;
100         while (buf < tail && *buf++ != '\n')
101                 /* nada */;
102         if (buf >= tail)
103                 return 0;
104         /* dateptr < buf && buf[-1] == '\n', so parsing will stop at buf-1 */
105         return parse_timestamp(dateptr, NULL, 10);
106 }
107
108 static const unsigned char *commit_graft_sha1_access(size_t index, void *table)
109 {
110         struct commit_graft **commit_graft_table = table;
111         return commit_graft_table[index]->oid.hash;
112 }
113
114 int commit_graft_pos(struct repository *r, const unsigned char *sha1)
115 {
116         return sha1_pos(sha1, r->parsed_objects->grafts,
117                         r->parsed_objects->grafts_nr,
118                         commit_graft_sha1_access);
119 }
120
121 int register_commit_graft(struct repository *r, struct commit_graft *graft,
122                           int ignore_dups)
123 {
124         int pos = commit_graft_pos(r, graft->oid.hash);
125
126         if (0 <= pos) {
127                 if (ignore_dups)
128                         free(graft);
129                 else {
130                         free(r->parsed_objects->grafts[pos]);
131                         r->parsed_objects->grafts[pos] = graft;
132                 }
133                 return 1;
134         }
135         pos = -pos - 1;
136         ALLOC_GROW(r->parsed_objects->grafts,
137                    r->parsed_objects->grafts_nr + 1,
138                    r->parsed_objects->grafts_alloc);
139         r->parsed_objects->grafts_nr++;
140         if (pos < r->parsed_objects->grafts_nr)
141                 memmove(r->parsed_objects->grafts + pos + 1,
142                         r->parsed_objects->grafts + pos,
143                         (r->parsed_objects->grafts_nr - pos - 1) *
144                         sizeof(*r->parsed_objects->grafts));
145         r->parsed_objects->grafts[pos] = graft;
146         return 0;
147 }
148
149 struct commit_graft *read_graft_line(struct strbuf *line)
150 {
151         /* The format is just "Commit Parent1 Parent2 ...\n" */
152         int i, phase;
153         const char *tail = NULL;
154         struct commit_graft *graft = NULL;
155         struct object_id dummy_oid, *oid;
156
157         strbuf_rtrim(line);
158         if (!line->len || line->buf[0] == '#')
159                 return NULL;
160         /*
161          * phase 0 verifies line, counts hashes in line and allocates graft
162          * phase 1 fills graft
163          */
164         for (phase = 0; phase < 2; phase++) {
165                 oid = graft ? &graft->oid : &dummy_oid;
166                 if (parse_oid_hex(line->buf, oid, &tail))
167                         goto bad_graft_data;
168                 for (i = 0; *tail != '\0'; i++) {
169                         oid = graft ? &graft->parent[i] : &dummy_oid;
170                         if (!isspace(*tail++) || parse_oid_hex(tail, oid, &tail))
171                                 goto bad_graft_data;
172                 }
173                 if (!graft) {
174                         graft = xmalloc(st_add(sizeof(*graft),
175                                                st_mult(sizeof(struct object_id), i)));
176                         graft->nr_parent = i;
177                 }
178         }
179         return graft;
180
181 bad_graft_data:
182         error("bad graft data: %s", line->buf);
183         assert(!graft);
184         return NULL;
185 }
186
187 static int read_graft_file(struct repository *r, const char *graft_file)
188 {
189         FILE *fp = fopen_or_warn(graft_file, "r");
190         struct strbuf buf = STRBUF_INIT;
191         if (!fp)
192                 return -1;
193         if (advice_graft_file_deprecated)
194                 advise(_("Support for <GIT_DIR>/info/grafts is deprecated\n"
195                          "and will be removed in a future Git version.\n"
196                          "\n"
197                          "Please use \"git replace --convert-graft-file\"\n"
198                          "to convert the grafts into replace refs.\n"
199                          "\n"
200                          "Turn this message off by running\n"
201                          "\"git config advice.graftFileDeprecated false\""));
202         while (!strbuf_getwholeline(&buf, fp, '\n')) {
203                 /* The format is just "Commit Parent1 Parent2 ...\n" */
204                 struct commit_graft *graft = read_graft_line(&buf);
205                 if (!graft)
206                         continue;
207                 if (register_commit_graft(r, graft, 1))
208                         error("duplicate graft data: %s", buf.buf);
209         }
210         fclose(fp);
211         strbuf_release(&buf);
212         return 0;
213 }
214
215 void prepare_commit_graft(struct repository *r)
216 {
217         char *graft_file;
218
219         if (r->parsed_objects->commit_graft_prepared)
220                 return;
221         if (!startup_info->have_repository)
222                 return;
223
224         graft_file = get_graft_file(r);
225         read_graft_file(r, graft_file);
226         /* make sure shallows are read */
227         is_repository_shallow(r);
228         r->parsed_objects->commit_graft_prepared = 1;
229 }
230
231 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid)
232 {
233         int pos;
234         prepare_commit_graft(r);
235         pos = commit_graft_pos(r, oid->hash);
236         if (pos < 0)
237                 return NULL;
238         return r->parsed_objects->grafts[pos];
239 }
240
241 int for_each_commit_graft(each_commit_graft_fn fn, void *cb_data)
242 {
243         int i, ret;
244         for (i = ret = 0; i < the_repository->parsed_objects->grafts_nr && !ret; i++)
245                 ret = fn(the_repository->parsed_objects->grafts[i], cb_data);
246         return ret;
247 }
248
249 struct commit_buffer {
250         void *buffer;
251         unsigned long size;
252 };
253 define_commit_slab(buffer_slab, struct commit_buffer);
254
255 struct buffer_slab *allocate_commit_buffer_slab(void)
256 {
257         struct buffer_slab *bs = xmalloc(sizeof(*bs));
258         init_buffer_slab(bs);
259         return bs;
260 }
261
262 void free_commit_buffer_slab(struct buffer_slab *bs)
263 {
264         clear_buffer_slab(bs);
265         free(bs);
266 }
267
268 void set_commit_buffer(struct repository *r, struct commit *commit, void *buffer, unsigned long size)
269 {
270         struct commit_buffer *v = buffer_slab_at(
271                 r->parsed_objects->buffer_slab, commit);
272         v->buffer = buffer;
273         v->size = size;
274 }
275
276 const void *get_cached_commit_buffer(struct repository *r, const struct commit *commit, unsigned long *sizep)
277 {
278         struct commit_buffer *v = buffer_slab_peek(
279                 r->parsed_objects->buffer_slab, commit);
280         if (!v) {
281                 if (sizep)
282                         *sizep = 0;
283                 return NULL;
284         }
285         if (sizep)
286                 *sizep = v->size;
287         return v->buffer;
288 }
289
290 const void *repo_get_commit_buffer(struct repository *r,
291                                    const struct commit *commit,
292                                    unsigned long *sizep)
293 {
294         const void *ret = get_cached_commit_buffer(r, commit, sizep);
295         if (!ret) {
296                 enum object_type type;
297                 unsigned long size;
298                 ret = repo_read_object_file(r, &commit->object.oid, &type, &size);
299                 if (!ret)
300                         die("cannot read commit object %s",
301                             oid_to_hex(&commit->object.oid));
302                 if (type != OBJ_COMMIT)
303                         die("expected commit for %s, got %s",
304                             oid_to_hex(&commit->object.oid), type_name(type));
305                 if (sizep)
306                         *sizep = size;
307         }
308         return ret;
309 }
310
311 void repo_unuse_commit_buffer(struct repository *r,
312                               const struct commit *commit,
313                               const void *buffer)
314 {
315         struct commit_buffer *v = buffer_slab_peek(
316                 r->parsed_objects->buffer_slab, commit);
317         if (!(v && v->buffer == buffer))
318                 free((void *)buffer);
319 }
320
321 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *commit)
322 {
323         struct commit_buffer *v = buffer_slab_peek(
324                 pool->buffer_slab, commit);
325         if (v) {
326                 FREE_AND_NULL(v->buffer);
327                 v->size = 0;
328         }
329 }
330
331 static inline void set_commit_tree(struct commit *c, struct tree *t)
332 {
333         c->maybe_tree = t;
334 }
335
336 struct tree *repo_get_commit_tree(struct repository *r,
337                                   const struct commit *commit)
338 {
339         if (commit->maybe_tree || !commit->object.parsed)
340                 return commit->maybe_tree;
341
342         if (commit_graph_position(commit) != COMMIT_NOT_FROM_GRAPH)
343                 return get_commit_tree_in_graph(r, commit);
344
345         return NULL;
346 }
347
348 struct object_id *get_commit_tree_oid(const struct commit *commit)
349 {
350         struct tree *tree = get_commit_tree(commit);
351         return tree ? &tree->object.oid : NULL;
352 }
353
354 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c)
355 {
356         set_commit_tree(c, NULL);
357         free_commit_buffer(pool, c);
358         c->index = 0;
359         free_commit_list(c->parents);
360
361         c->object.parsed = 0;
362 }
363
364 const void *detach_commit_buffer(struct commit *commit, unsigned long *sizep)
365 {
366         struct commit_buffer *v = buffer_slab_peek(
367                 the_repository->parsed_objects->buffer_slab, commit);
368         void *ret;
369
370         if (!v) {
371                 if (sizep)
372                         *sizep = 0;
373                 return NULL;
374         }
375         ret = v->buffer;
376         if (sizep)
377                 *sizep = v->size;
378
379         v->buffer = NULL;
380         v->size = 0;
381         return ret;
382 }
383
384 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph)
385 {
386         const char *tail = buffer;
387         const char *bufptr = buffer;
388         struct object_id parent;
389         struct commit_list **pptr;
390         struct commit_graft *graft;
391         const int tree_entry_len = the_hash_algo->hexsz + 5;
392         const int parent_entry_len = the_hash_algo->hexsz + 7;
393         struct tree *tree;
394
395         if (item->object.parsed)
396                 return 0;
397
398         if (item->parents) {
399                 /*
400                  * Presumably this is leftover from an earlier failed parse;
401                  * clear it out in preparation for us re-parsing (we'll hit the
402                  * same error, but that's good, since it lets our caller know
403                  * the result cannot be trusted.
404                  */
405                 free_commit_list(item->parents);
406                 item->parents = NULL;
407         }
408
409         tail += size;
410         if (tail <= bufptr + tree_entry_len + 1 || memcmp(bufptr, "tree ", 5) ||
411                         bufptr[tree_entry_len] != '\n')
412                 return error("bogus commit object %s", oid_to_hex(&item->object.oid));
413         if (get_oid_hex(bufptr + 5, &parent) < 0)
414                 return error("bad tree pointer in commit %s",
415                              oid_to_hex(&item->object.oid));
416         tree = lookup_tree(r, &parent);
417         if (!tree)
418                 return error("bad tree pointer %s in commit %s",
419                              oid_to_hex(&parent),
420                              oid_to_hex(&item->object.oid));
421         set_commit_tree(item, tree);
422         bufptr += tree_entry_len + 1; /* "tree " + "hex sha1" + "\n" */
423         pptr = &item->parents;
424
425         graft = lookup_commit_graft(r, &item->object.oid);
426         if (graft)
427                 r->parsed_objects->substituted_parent = 1;
428         while (bufptr + parent_entry_len < tail && !memcmp(bufptr, "parent ", 7)) {
429                 struct commit *new_parent;
430
431                 if (tail <= bufptr + parent_entry_len + 1 ||
432                     get_oid_hex(bufptr + 7, &parent) ||
433                     bufptr[parent_entry_len] != '\n')
434                         return error("bad parents in commit %s", oid_to_hex(&item->object.oid));
435                 bufptr += parent_entry_len + 1;
436                 /*
437                  * The clone is shallow if nr_parent < 0, and we must
438                  * not traverse its real parents even when we unhide them.
439                  */
440                 if (graft && (graft->nr_parent < 0 || grafts_replace_parents))
441                         continue;
442                 new_parent = lookup_commit(r, &parent);
443                 if (!new_parent)
444                         return error("bad parent %s in commit %s",
445                                      oid_to_hex(&parent),
446                                      oid_to_hex(&item->object.oid));
447                 pptr = &commit_list_insert(new_parent, pptr)->next;
448         }
449         if (graft) {
450                 int i;
451                 struct commit *new_parent;
452                 for (i = 0; i < graft->nr_parent; i++) {
453                         new_parent = lookup_commit(r,
454                                                    &graft->parent[i]);
455                         if (!new_parent)
456                                 return error("bad graft parent %s in commit %s",
457                                              oid_to_hex(&graft->parent[i]),
458                                              oid_to_hex(&item->object.oid));
459                         pptr = &commit_list_insert(new_parent, pptr)->next;
460                 }
461         }
462         item->date = parse_commit_date(bufptr, tail);
463
464         if (check_graph)
465                 load_commit_graph_info(r, item);
466
467         item->object.parsed = 1;
468         return 0;
469 }
470
471 int repo_parse_commit_internal(struct repository *r,
472                                struct commit *item,
473                                int quiet_on_missing,
474                                int use_commit_graph)
475 {
476         enum object_type type;
477         void *buffer;
478         unsigned long size;
479         int ret;
480
481         if (!item)
482                 return -1;
483         if (item->object.parsed)
484                 return 0;
485         if (use_commit_graph && parse_commit_in_graph(r, item))
486                 return 0;
487         buffer = repo_read_object_file(r, &item->object.oid, &type, &size);
488         if (!buffer)
489                 return quiet_on_missing ? -1 :
490                         error("Could not read %s",
491                              oid_to_hex(&item->object.oid));
492         if (type != OBJ_COMMIT) {
493                 free(buffer);
494                 return error("Object %s not a commit",
495                              oid_to_hex(&item->object.oid));
496         }
497
498         ret = parse_commit_buffer(r, item, buffer, size, 0);
499         if (save_commit_buffer && !ret) {
500                 set_commit_buffer(r, item, buffer, size);
501                 return 0;
502         }
503         free(buffer);
504         return ret;
505 }
506
507 int repo_parse_commit_gently(struct repository *r,
508                              struct commit *item, int quiet_on_missing)
509 {
510         return repo_parse_commit_internal(r, item, quiet_on_missing, 1);
511 }
512
513 void parse_commit_or_die(struct commit *item)
514 {
515         if (parse_commit(item))
516                 die("unable to parse commit %s",
517                     item ? oid_to_hex(&item->object.oid) : "(null)");
518 }
519
520 int find_commit_subject(const char *commit_buffer, const char **subject)
521 {
522         const char *eol;
523         const char *p = commit_buffer;
524
525         while (*p && (*p != '\n' || p[1] != '\n'))
526                 p++;
527         if (*p) {
528                 p = skip_blank_lines(p + 2);
529                 eol = strchrnul(p, '\n');
530         } else
531                 eol = p;
532
533         *subject = p;
534
535         return eol - p;
536 }
537
538 struct commit_list *commit_list_insert(struct commit *item, struct commit_list **list_p)
539 {
540         struct commit_list *new_list = xmalloc(sizeof(struct commit_list));
541         new_list->item = item;
542         new_list->next = *list_p;
543         *list_p = new_list;
544         return new_list;
545 }
546
547 int commit_list_contains(struct commit *item, struct commit_list *list)
548 {
549         while (list) {
550                 if (list->item == item)
551                         return 1;
552                 list = list->next;
553         }
554
555         return 0;
556 }
557
558 unsigned commit_list_count(const struct commit_list *l)
559 {
560         unsigned c = 0;
561         for (; l; l = l->next )
562                 c++;
563         return c;
564 }
565
566 struct commit_list *copy_commit_list(struct commit_list *list)
567 {
568         struct commit_list *head = NULL;
569         struct commit_list **pp = &head;
570         while (list) {
571                 pp = commit_list_append(list->item, pp);
572                 list = list->next;
573         }
574         return head;
575 }
576
577 void free_commit_list(struct commit_list *list)
578 {
579         while (list)
580                 pop_commit(&list);
581 }
582
583 struct commit_list * commit_list_insert_by_date(struct commit *item, struct commit_list **list)
584 {
585         struct commit_list **pp = list;
586         struct commit_list *p;
587         while ((p = *pp) != NULL) {
588                 if (p->item->date < item->date) {
589                         break;
590                 }
591                 pp = &p->next;
592         }
593         return commit_list_insert(item, pp);
594 }
595
596 static int commit_list_compare_by_date(const void *a, const void *b)
597 {
598         timestamp_t a_date = ((const struct commit_list *)a)->item->date;
599         timestamp_t b_date = ((const struct commit_list *)b)->item->date;
600         if (a_date < b_date)
601                 return 1;
602         if (a_date > b_date)
603                 return -1;
604         return 0;
605 }
606
607 static void *commit_list_get_next(const void *a)
608 {
609         return ((const struct commit_list *)a)->next;
610 }
611
612 static void commit_list_set_next(void *a, void *next)
613 {
614         ((struct commit_list *)a)->next = next;
615 }
616
617 void commit_list_sort_by_date(struct commit_list **list)
618 {
619         *list = llist_mergesort(*list, commit_list_get_next, commit_list_set_next,
620                                 commit_list_compare_by_date);
621 }
622
623 struct commit *pop_most_recent_commit(struct commit_list **list,
624                                       unsigned int mark)
625 {
626         struct commit *ret = pop_commit(list);
627         struct commit_list *parents = ret->parents;
628
629         while (parents) {
630                 struct commit *commit = parents->item;
631                 if (!parse_commit(commit) && !(commit->object.flags & mark)) {
632                         commit->object.flags |= mark;
633                         commit_list_insert_by_date(commit, list);
634                 }
635                 parents = parents->next;
636         }
637         return ret;
638 }
639
640 static void clear_commit_marks_1(struct commit_list **plist,
641                                  struct commit *commit, unsigned int mark)
642 {
643         while (commit) {
644                 struct commit_list *parents;
645
646                 if (!(mark & commit->object.flags))
647                         return;
648
649                 commit->object.flags &= ~mark;
650
651                 parents = commit->parents;
652                 if (!parents)
653                         return;
654
655                 while ((parents = parents->next))
656                         commit_list_insert(parents->item, plist);
657
658                 commit = commit->parents->item;
659         }
660 }
661
662 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark)
663 {
664         struct commit_list *list = NULL;
665
666         while (nr--) {
667                 clear_commit_marks_1(&list, *commit, mark);
668                 commit++;
669         }
670         while (list)
671                 clear_commit_marks_1(&list, pop_commit(&list), mark);
672 }
673
674 void clear_commit_marks(struct commit *commit, unsigned int mark)
675 {
676         clear_commit_marks_many(1, &commit, mark);
677 }
678
679 struct commit *pop_commit(struct commit_list **stack)
680 {
681         struct commit_list *top = *stack;
682         struct commit *item = top ? top->item : NULL;
683
684         if (top) {
685                 *stack = top->next;
686                 free(top);
687         }
688         return item;
689 }
690
691 /*
692  * Topological sort support
693  */
694
695 /* count number of children that have not been emitted */
696 define_commit_slab(indegree_slab, int);
697
698 define_commit_slab(author_date_slab, timestamp_t);
699
700 void record_author_date(struct author_date_slab *author_date,
701                         struct commit *commit)
702 {
703         const char *buffer = get_commit_buffer(commit, NULL);
704         struct ident_split ident;
705         const char *ident_line;
706         size_t ident_len;
707         char *date_end;
708         timestamp_t date;
709
710         ident_line = find_commit_header(buffer, "author", &ident_len);
711         if (!ident_line)
712                 goto fail_exit; /* no author line */
713         if (split_ident_line(&ident, ident_line, ident_len) ||
714             !ident.date_begin || !ident.date_end)
715                 goto fail_exit; /* malformed "author" line */
716
717         date = parse_timestamp(ident.date_begin, &date_end, 10);
718         if (date_end != ident.date_end)
719                 goto fail_exit; /* malformed date */
720         *(author_date_slab_at(author_date, commit)) = date;
721
722 fail_exit:
723         unuse_commit_buffer(commit, buffer);
724 }
725
726 int compare_commits_by_author_date(const void *a_, const void *b_,
727                                    void *cb_data)
728 {
729         const struct commit *a = a_, *b = b_;
730         struct author_date_slab *author_date = cb_data;
731         timestamp_t a_date = *(author_date_slab_at(author_date, a));
732         timestamp_t b_date = *(author_date_slab_at(author_date, b));
733
734         /* newer commits with larger date first */
735         if (a_date < b_date)
736                 return 1;
737         else if (a_date > b_date)
738                 return -1;
739         return 0;
740 }
741
742 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused)
743 {
744         const struct commit *a = a_, *b = b_;
745         const uint32_t generation_a = commit_graph_generation(a),
746                        generation_b = commit_graph_generation(b);
747
748         /* newer commits first */
749         if (generation_a < generation_b)
750                 return 1;
751         else if (generation_a > generation_b)
752                 return -1;
753
754         /* use date as a heuristic when generations are equal */
755         if (a->date < b->date)
756                 return 1;
757         else if (a->date > b->date)
758                 return -1;
759         return 0;
760 }
761
762 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused)
763 {
764         const struct commit *a = a_, *b = b_;
765         /* newer commits with larger date first */
766         if (a->date < b->date)
767                 return 1;
768         else if (a->date > b->date)
769                 return -1;
770         return 0;
771 }
772
773 /*
774  * Performs an in-place topological sort on the list supplied.
775  */
776 void sort_in_topological_order(struct commit_list **list, enum rev_sort_order sort_order)
777 {
778         struct commit_list *next, *orig = *list;
779         struct commit_list **pptr;
780         struct indegree_slab indegree;
781         struct prio_queue queue;
782         struct commit *commit;
783         struct author_date_slab author_date;
784
785         if (!orig)
786                 return;
787         *list = NULL;
788
789         init_indegree_slab(&indegree);
790         memset(&queue, '\0', sizeof(queue));
791
792         switch (sort_order) {
793         default: /* REV_SORT_IN_GRAPH_ORDER */
794                 queue.compare = NULL;
795                 break;
796         case REV_SORT_BY_COMMIT_DATE:
797                 queue.compare = compare_commits_by_commit_date;
798                 break;
799         case REV_SORT_BY_AUTHOR_DATE:
800                 init_author_date_slab(&author_date);
801                 queue.compare = compare_commits_by_author_date;
802                 queue.cb_data = &author_date;
803                 break;
804         }
805
806         /* Mark them and clear the indegree */
807         for (next = orig; next; next = next->next) {
808                 struct commit *commit = next->item;
809                 *(indegree_slab_at(&indegree, commit)) = 1;
810                 /* also record the author dates, if needed */
811                 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
812                         record_author_date(&author_date, commit);
813         }
814
815         /* update the indegree */
816         for (next = orig; next; next = next->next) {
817                 struct commit_list *parents = next->item->parents;
818                 while (parents) {
819                         struct commit *parent = parents->item;
820                         int *pi = indegree_slab_at(&indegree, parent);
821
822                         if (*pi)
823                                 (*pi)++;
824                         parents = parents->next;
825                 }
826         }
827
828         /*
829          * find the tips
830          *
831          * tips are nodes not reachable from any other node in the list
832          *
833          * the tips serve as a starting set for the work queue.
834          */
835         for (next = orig; next; next = next->next) {
836                 struct commit *commit = next->item;
837
838                 if (*(indegree_slab_at(&indegree, commit)) == 1)
839                         prio_queue_put(&queue, commit);
840         }
841
842         /*
843          * This is unfortunate; the initial tips need to be shown
844          * in the order given from the revision traversal machinery.
845          */
846         if (sort_order == REV_SORT_IN_GRAPH_ORDER)
847                 prio_queue_reverse(&queue);
848
849         /* We no longer need the commit list */
850         free_commit_list(orig);
851
852         pptr = list;
853         *list = NULL;
854         while ((commit = prio_queue_get(&queue)) != NULL) {
855                 struct commit_list *parents;
856
857                 for (parents = commit->parents; parents ; parents = parents->next) {
858                         struct commit *parent = parents->item;
859                         int *pi = indegree_slab_at(&indegree, parent);
860
861                         if (!*pi)
862                                 continue;
863
864                         /*
865                          * parents are only enqueued for emission
866                          * when all their children have been emitted thereby
867                          * guaranteeing topological order.
868                          */
869                         if (--(*pi) == 1)
870                                 prio_queue_put(&queue, parent);
871                 }
872                 /*
873                  * all children of commit have already been
874                  * emitted. we can emit it now.
875                  */
876                 *(indegree_slab_at(&indegree, commit)) = 0;
877
878                 pptr = &commit_list_insert(commit, pptr)->next;
879         }
880
881         clear_indegree_slab(&indegree);
882         clear_prio_queue(&queue);
883         if (sort_order == REV_SORT_BY_AUTHOR_DATE)
884                 clear_author_date_slab(&author_date);
885 }
886
887 struct rev_collect {
888         struct commit **commit;
889         int nr;
890         int alloc;
891         unsigned int initial : 1;
892 };
893
894 static void add_one_commit(struct object_id *oid, struct rev_collect *revs)
895 {
896         struct commit *commit;
897
898         if (is_null_oid(oid))
899                 return;
900
901         commit = lookup_commit(the_repository, oid);
902         if (!commit ||
903             (commit->object.flags & TMP_MARK) ||
904             parse_commit(commit))
905                 return;
906
907         ALLOC_GROW(revs->commit, revs->nr + 1, revs->alloc);
908         revs->commit[revs->nr++] = commit;
909         commit->object.flags |= TMP_MARK;
910 }
911
912 static int collect_one_reflog_ent(struct object_id *ooid, struct object_id *noid,
913                                   const char *ident, timestamp_t timestamp,
914                                   int tz, const char *message, void *cbdata)
915 {
916         struct rev_collect *revs = cbdata;
917
918         if (revs->initial) {
919                 revs->initial = 0;
920                 add_one_commit(ooid, revs);
921         }
922         add_one_commit(noid, revs);
923         return 0;
924 }
925
926 struct commit *get_fork_point(const char *refname, struct commit *commit)
927 {
928         struct object_id oid;
929         struct rev_collect revs;
930         struct commit_list *bases;
931         int i;
932         struct commit *ret = NULL;
933         char *full_refname;
934
935         switch (dwim_ref(refname, strlen(refname), &oid, &full_refname, 0)) {
936         case 0:
937                 die("No such ref: '%s'", refname);
938         case 1:
939                 break; /* good */
940         default:
941                 die("Ambiguous refname: '%s'", refname);
942         }
943
944         memset(&revs, 0, sizeof(revs));
945         revs.initial = 1;
946         for_each_reflog_ent(full_refname, collect_one_reflog_ent, &revs);
947
948         if (!revs.nr)
949                 add_one_commit(&oid, &revs);
950
951         for (i = 0; i < revs.nr; i++)
952                 revs.commit[i]->object.flags &= ~TMP_MARK;
953
954         bases = get_merge_bases_many(commit, revs.nr, revs.commit);
955
956         /*
957          * There should be one and only one merge base, when we found
958          * a common ancestor among reflog entries.
959          */
960         if (!bases || bases->next)
961                 goto cleanup_return;
962
963         /* And the found one must be one of the reflog entries */
964         for (i = 0; i < revs.nr; i++)
965                 if (&bases->item->object == &revs.commit[i]->object)
966                         break; /* found */
967         if (revs.nr <= i)
968                 goto cleanup_return;
969
970         ret = bases->item;
971
972 cleanup_return:
973         free_commit_list(bases);
974         free(full_refname);
975         return ret;
976 }
977
978 /*
979  * Indexed by hash algorithm identifier.
980  */
981 static const char *gpg_sig_headers[] = {
982         NULL,
983         "gpgsig",
984         "gpgsig-sha256",
985 };
986
987 static int do_sign_commit(struct strbuf *buf, const char *keyid)
988 {
989         struct strbuf sig = STRBUF_INIT;
990         int inspos, copypos;
991         const char *eoh;
992         const char *gpg_sig_header = gpg_sig_headers[hash_algo_by_ptr(the_hash_algo)];
993         int gpg_sig_header_len = strlen(gpg_sig_header);
994
995         /* find the end of the header */
996         eoh = strstr(buf->buf, "\n\n");
997         if (!eoh)
998                 inspos = buf->len;
999         else
1000                 inspos = eoh - buf->buf + 1;
1001
1002         if (!keyid || !*keyid)
1003                 keyid = get_signing_key();
1004         if (sign_buffer(buf, &sig, keyid)) {
1005                 strbuf_release(&sig);
1006                 return -1;
1007         }
1008
1009         for (copypos = 0; sig.buf[copypos]; ) {
1010                 const char *bol = sig.buf + copypos;
1011                 const char *eol = strchrnul(bol, '\n');
1012                 int len = (eol - bol) + !!*eol;
1013
1014                 if (!copypos) {
1015                         strbuf_insert(buf, inspos, gpg_sig_header, gpg_sig_header_len);
1016                         inspos += gpg_sig_header_len;
1017                 }
1018                 strbuf_insertstr(buf, inspos++, " ");
1019                 strbuf_insert(buf, inspos, bol, len);
1020                 inspos += len;
1021                 copypos += len;
1022         }
1023         strbuf_release(&sig);
1024         return 0;
1025 }
1026
1027 int parse_signed_commit(const struct commit *commit,
1028                         struct strbuf *payload, struct strbuf *signature)
1029 {
1030
1031         unsigned long size;
1032         const char *buffer = get_commit_buffer(commit, &size);
1033         int in_signature, saw_signature = -1;
1034         const char *line, *tail;
1035         const char *gpg_sig_header = gpg_sig_headers[hash_algo_by_ptr(the_hash_algo)];
1036         int gpg_sig_header_len = strlen(gpg_sig_header);
1037
1038         line = buffer;
1039         tail = buffer + size;
1040         in_signature = 0;
1041         saw_signature = 0;
1042         while (line < tail) {
1043                 const char *sig = NULL;
1044                 const char *next = memchr(line, '\n', tail - line);
1045
1046                 next = next ? next + 1 : tail;
1047                 if (in_signature && line[0] == ' ')
1048                         sig = line + 1;
1049                 else if (starts_with(line, gpg_sig_header) &&
1050                          line[gpg_sig_header_len] == ' ')
1051                         sig = line + gpg_sig_header_len + 1;
1052                 if (sig) {
1053                         strbuf_add(signature, sig, next - sig);
1054                         saw_signature = 1;
1055                         in_signature = 1;
1056                 } else {
1057                         if (*line == '\n')
1058                                 /* dump the whole remainder of the buffer */
1059                                 next = tail;
1060                         strbuf_add(payload, line, next - line);
1061                         in_signature = 0;
1062                 }
1063                 line = next;
1064         }
1065         unuse_commit_buffer(commit, buffer);
1066         return saw_signature;
1067 }
1068
1069 int remove_signature(struct strbuf *buf)
1070 {
1071         const char *line = buf->buf;
1072         const char *tail = buf->buf + buf->len;
1073         int in_signature = 0;
1074         const char *sig_start = NULL;
1075         const char *sig_end = NULL;
1076
1077         while (line < tail) {
1078                 const char *next = memchr(line, '\n', tail - line);
1079                 next = next ? next + 1 : tail;
1080
1081                 if (in_signature && line[0] == ' ')
1082                         sig_end = next;
1083                 else if (starts_with(line, "gpgsig")) {
1084                         int i;
1085                         for (i = 1; i < GIT_HASH_NALGOS; i++) {
1086                                 const char *p;
1087                                 if (skip_prefix(line, gpg_sig_headers[i], &p) &&
1088                                     *p == ' ') {
1089                                         sig_start = line;
1090                                         sig_end = next;
1091                                         in_signature = 1;
1092                                 }
1093                         }
1094                 } else {
1095                         if (*line == '\n')
1096                                 /* dump the whole remainder of the buffer */
1097                                 next = tail;
1098                         in_signature = 0;
1099                 }
1100                 line = next;
1101         }
1102
1103         if (sig_start)
1104                 strbuf_remove(buf, sig_start - buf->buf, sig_end - sig_start);
1105
1106         return sig_start != NULL;
1107 }
1108
1109 static void handle_signed_tag(struct commit *parent, struct commit_extra_header ***tail)
1110 {
1111         struct merge_remote_desc *desc;
1112         struct commit_extra_header *mergetag;
1113         char *buf;
1114         unsigned long size, len;
1115         enum object_type type;
1116
1117         desc = merge_remote_util(parent);
1118         if (!desc || !desc->obj)
1119                 return;
1120         buf = read_object_file(&desc->obj->oid, &type, &size);
1121         if (!buf || type != OBJ_TAG)
1122                 goto free_return;
1123         len = parse_signature(buf, size);
1124         if (size == len)
1125                 goto free_return;
1126         /*
1127          * We could verify this signature and either omit the tag when
1128          * it does not validate, but the integrator may not have the
1129          * public key of the signer of the tag he is merging, while a
1130          * later auditor may have it while auditing, so let's not run
1131          * verify-signed-buffer here for now...
1132          *
1133          * if (verify_signed_buffer(buf, len, buf + len, size - len, ...))
1134          *      warn("warning: signed tag unverified.");
1135          */
1136         mergetag = xcalloc(1, sizeof(*mergetag));
1137         mergetag->key = xstrdup("mergetag");
1138         mergetag->value = buf;
1139         mergetag->len = size;
1140
1141         **tail = mergetag;
1142         *tail = &mergetag->next;
1143         return;
1144
1145 free_return:
1146         free(buf);
1147 }
1148
1149 int check_commit_signature(const struct commit *commit, struct signature_check *sigc)
1150 {
1151         struct strbuf payload = STRBUF_INIT;
1152         struct strbuf signature = STRBUF_INIT;
1153         int ret = 1;
1154
1155         sigc->result = 'N';
1156
1157         if (parse_signed_commit(commit, &payload, &signature) <= 0)
1158                 goto out;
1159         ret = check_signature(payload.buf, payload.len, signature.buf,
1160                 signature.len, sigc);
1161
1162  out:
1163         strbuf_release(&payload);
1164         strbuf_release(&signature);
1165
1166         return ret;
1167 }
1168
1169 void verify_merge_signature(struct commit *commit, int verbosity,
1170                             int check_trust)
1171 {
1172         char hex[GIT_MAX_HEXSZ + 1];
1173         struct signature_check signature_check;
1174         int ret;
1175         memset(&signature_check, 0, sizeof(signature_check));
1176
1177         ret = check_commit_signature(commit, &signature_check);
1178
1179         find_unique_abbrev_r(hex, &commit->object.oid, DEFAULT_ABBREV);
1180         switch (signature_check.result) {
1181         case 'G':
1182                 if (ret || (check_trust && signature_check.trust_level < TRUST_MARGINAL))
1183                         die(_("Commit %s has an untrusted GPG signature, "
1184                               "allegedly by %s."), hex, signature_check.signer);
1185                 break;
1186         case 'B':
1187                 die(_("Commit %s has a bad GPG signature "
1188                       "allegedly by %s."), hex, signature_check.signer);
1189         default: /* 'N' */
1190                 die(_("Commit %s does not have a GPG signature."), hex);
1191         }
1192         if (verbosity >= 0 && signature_check.result == 'G')
1193                 printf(_("Commit %s has a good GPG signature by %s\n"),
1194                        hex, signature_check.signer);
1195
1196         signature_check_clear(&signature_check);
1197 }
1198
1199 void append_merge_tag_headers(struct commit_list *parents,
1200                               struct commit_extra_header ***tail)
1201 {
1202         while (parents) {
1203                 struct commit *parent = parents->item;
1204                 handle_signed_tag(parent, tail);
1205                 parents = parents->next;
1206         }
1207 }
1208
1209 static void add_extra_header(struct strbuf *buffer,
1210                              struct commit_extra_header *extra)
1211 {
1212         strbuf_addstr(buffer, extra->key);
1213         if (extra->len)
1214                 strbuf_add_lines(buffer, " ", extra->value, extra->len);
1215         else
1216                 strbuf_addch(buffer, '\n');
1217 }
1218
1219 struct commit_extra_header *read_commit_extra_headers(struct commit *commit,
1220                                                       const char **exclude)
1221 {
1222         struct commit_extra_header *extra = NULL;
1223         unsigned long size;
1224         const char *buffer = get_commit_buffer(commit, &size);
1225         extra = read_commit_extra_header_lines(buffer, size, exclude);
1226         unuse_commit_buffer(commit, buffer);
1227         return extra;
1228 }
1229
1230 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data)
1231 {
1232         struct commit_extra_header *extra, *to_free;
1233         int res = 0;
1234
1235         to_free = read_commit_extra_headers(commit, NULL);
1236         for (extra = to_free; !res && extra; extra = extra->next) {
1237                 if (strcmp(extra->key, "mergetag"))
1238                         continue; /* not a merge tag */
1239                 res = fn(commit, extra, data);
1240         }
1241         free_commit_extra_headers(to_free);
1242         return res;
1243 }
1244
1245 static inline int standard_header_field(const char *field, size_t len)
1246 {
1247         return ((len == 4 && !memcmp(field, "tree", 4)) ||
1248                 (len == 6 && !memcmp(field, "parent", 6)) ||
1249                 (len == 6 && !memcmp(field, "author", 6)) ||
1250                 (len == 9 && !memcmp(field, "committer", 9)) ||
1251                 (len == 8 && !memcmp(field, "encoding", 8)));
1252 }
1253
1254 static int excluded_header_field(const char *field, size_t len, const char **exclude)
1255 {
1256         if (!exclude)
1257                 return 0;
1258
1259         while (*exclude) {
1260                 size_t xlen = strlen(*exclude);
1261                 if (len == xlen && !memcmp(field, *exclude, xlen))
1262                         return 1;
1263                 exclude++;
1264         }
1265         return 0;
1266 }
1267
1268 static struct commit_extra_header *read_commit_extra_header_lines(
1269         const char *buffer, size_t size,
1270         const char **exclude)
1271 {
1272         struct commit_extra_header *extra = NULL, **tail = &extra, *it = NULL;
1273         const char *line, *next, *eof, *eob;
1274         struct strbuf buf = STRBUF_INIT;
1275
1276         for (line = buffer, eob = line + size;
1277              line < eob && *line != '\n';
1278              line = next) {
1279                 next = memchr(line, '\n', eob - line);
1280                 next = next ? next + 1 : eob;
1281                 if (*line == ' ') {
1282                         /* continuation */
1283                         if (it)
1284                                 strbuf_add(&buf, line + 1, next - (line + 1));
1285                         continue;
1286                 }
1287                 if (it)
1288                         it->value = strbuf_detach(&buf, &it->len);
1289                 strbuf_reset(&buf);
1290                 it = NULL;
1291
1292                 eof = memchr(line, ' ', next - line);
1293                 if (!eof)
1294                         eof = next;
1295                 else if (standard_header_field(line, eof - line) ||
1296                          excluded_header_field(line, eof - line, exclude))
1297                         continue;
1298
1299                 it = xcalloc(1, sizeof(*it));
1300                 it->key = xmemdupz(line, eof-line);
1301                 *tail = it;
1302                 tail = &it->next;
1303                 if (eof + 1 < next)
1304                         strbuf_add(&buf, eof + 1, next - (eof + 1));
1305         }
1306         if (it)
1307                 it->value = strbuf_detach(&buf, &it->len);
1308         return extra;
1309 }
1310
1311 void free_commit_extra_headers(struct commit_extra_header *extra)
1312 {
1313         while (extra) {
1314                 struct commit_extra_header *next = extra->next;
1315                 free(extra->key);
1316                 free(extra->value);
1317                 free(extra);
1318                 extra = next;
1319         }
1320 }
1321
1322 int commit_tree(const char *msg, size_t msg_len, const struct object_id *tree,
1323                 struct commit_list *parents, struct object_id *ret,
1324                 const char *author, const char *sign_commit)
1325 {
1326         struct commit_extra_header *extra = NULL, **tail = &extra;
1327         int result;
1328
1329         append_merge_tag_headers(parents, &tail);
1330         result = commit_tree_extended(msg, msg_len, tree, parents, ret, author,
1331                                       NULL, sign_commit, extra);
1332         free_commit_extra_headers(extra);
1333         return result;
1334 }
1335
1336 static int find_invalid_utf8(const char *buf, int len)
1337 {
1338         int offset = 0;
1339         static const unsigned int max_codepoint[] = {
1340                 0x7f, 0x7ff, 0xffff, 0x10ffff
1341         };
1342
1343         while (len) {
1344                 unsigned char c = *buf++;
1345                 int bytes, bad_offset;
1346                 unsigned int codepoint;
1347                 unsigned int min_val, max_val;
1348
1349                 len--;
1350                 offset++;
1351
1352                 /* Simple US-ASCII? No worries. */
1353                 if (c < 0x80)
1354                         continue;
1355
1356                 bad_offset = offset-1;
1357
1358                 /*
1359                  * Count how many more high bits set: that's how
1360                  * many more bytes this sequence should have.
1361                  */
1362                 bytes = 0;
1363                 while (c & 0x40) {
1364                         c <<= 1;
1365                         bytes++;
1366                 }
1367
1368                 /*
1369                  * Must be between 1 and 3 more bytes.  Longer sequences result in
1370                  * codepoints beyond U+10FFFF, which are guaranteed never to exist.
1371                  */
1372                 if (bytes < 1 || 3 < bytes)
1373                         return bad_offset;
1374
1375                 /* Do we *have* that many bytes? */
1376                 if (len < bytes)
1377                         return bad_offset;
1378
1379                 /*
1380                  * Place the encoded bits at the bottom of the value and compute the
1381                  * valid range.
1382                  */
1383                 codepoint = (c & 0x7f) >> bytes;
1384                 min_val = max_codepoint[bytes-1] + 1;
1385                 max_val = max_codepoint[bytes];
1386
1387                 offset += bytes;
1388                 len -= bytes;
1389
1390                 /* And verify that they are good continuation bytes */
1391                 do {
1392                         codepoint <<= 6;
1393                         codepoint |= *buf & 0x3f;
1394                         if ((*buf++ & 0xc0) != 0x80)
1395                                 return bad_offset;
1396                 } while (--bytes);
1397
1398                 /* Reject codepoints that are out of range for the sequence length. */
1399                 if (codepoint < min_val || codepoint > max_val)
1400                         return bad_offset;
1401                 /* Surrogates are only for UTF-16 and cannot be encoded in UTF-8. */
1402                 if ((codepoint & 0x1ff800) == 0xd800)
1403                         return bad_offset;
1404                 /* U+xxFFFE and U+xxFFFF are guaranteed non-characters. */
1405                 if ((codepoint & 0xfffe) == 0xfffe)
1406                         return bad_offset;
1407                 /* So are anything in the range U+FDD0..U+FDEF. */
1408                 if (codepoint >= 0xfdd0 && codepoint <= 0xfdef)
1409                         return bad_offset;
1410         }
1411         return -1;
1412 }
1413
1414 /*
1415  * This verifies that the buffer is in proper utf8 format.
1416  *
1417  * If it isn't, it assumes any non-utf8 characters are Latin1,
1418  * and does the conversion.
1419  */
1420 static int verify_utf8(struct strbuf *buf)
1421 {
1422         int ok = 1;
1423         long pos = 0;
1424
1425         for (;;) {
1426                 int bad;
1427                 unsigned char c;
1428                 unsigned char replace[2];
1429
1430                 bad = find_invalid_utf8(buf->buf + pos, buf->len - pos);
1431                 if (bad < 0)
1432                         return ok;
1433                 pos += bad;
1434                 ok = 0;
1435                 c = buf->buf[pos];
1436                 strbuf_remove(buf, pos, 1);
1437
1438                 /* We know 'c' must be in the range 128-255 */
1439                 replace[0] = 0xc0 + (c >> 6);
1440                 replace[1] = 0x80 + (c & 0x3f);
1441                 strbuf_insert(buf, pos, replace, 2);
1442                 pos += 2;
1443         }
1444 }
1445
1446 static const char commit_utf8_warn[] =
1447 N_("Warning: commit message did not conform to UTF-8.\n"
1448    "You may want to amend it after fixing the message, or set the config\n"
1449    "variable i18n.commitencoding to the encoding your project uses.\n");
1450
1451 int commit_tree_extended(const char *msg, size_t msg_len,
1452                          const struct object_id *tree,
1453                          struct commit_list *parents, struct object_id *ret,
1454                          const char *author, const char *committer,
1455                          const char *sign_commit,
1456                          struct commit_extra_header *extra)
1457 {
1458         int result;
1459         int encoding_is_utf8;
1460         struct strbuf buffer;
1461
1462         assert_oid_type(tree, OBJ_TREE);
1463
1464         if (memchr(msg, '\0', msg_len))
1465                 return error("a NUL byte in commit log message not allowed.");
1466
1467         /* Not having i18n.commitencoding is the same as having utf-8 */
1468         encoding_is_utf8 = is_encoding_utf8(git_commit_encoding);
1469
1470         strbuf_init(&buffer, 8192); /* should avoid reallocs for the headers */
1471         strbuf_addf(&buffer, "tree %s\n", oid_to_hex(tree));
1472
1473         /*
1474          * NOTE! This ordering means that the same exact tree merged with a
1475          * different order of parents will be a _different_ changeset even
1476          * if everything else stays the same.
1477          */
1478         while (parents) {
1479                 struct commit *parent = pop_commit(&parents);
1480                 strbuf_addf(&buffer, "parent %s\n",
1481                             oid_to_hex(&parent->object.oid));
1482         }
1483
1484         /* Person/date information */
1485         if (!author)
1486                 author = git_author_info(IDENT_STRICT);
1487         strbuf_addf(&buffer, "author %s\n", author);
1488         if (!committer)
1489                 committer = git_committer_info(IDENT_STRICT);
1490         strbuf_addf(&buffer, "committer %s\n", committer);
1491         if (!encoding_is_utf8)
1492                 strbuf_addf(&buffer, "encoding %s\n", git_commit_encoding);
1493
1494         while (extra) {
1495                 add_extra_header(&buffer, extra);
1496                 extra = extra->next;
1497         }
1498         strbuf_addch(&buffer, '\n');
1499
1500         /* And add the comment */
1501         strbuf_add(&buffer, msg, msg_len);
1502
1503         /* And check the encoding */
1504         if (encoding_is_utf8 && !verify_utf8(&buffer))
1505                 fprintf(stderr, _(commit_utf8_warn));
1506
1507         if (sign_commit && do_sign_commit(&buffer, sign_commit)) {
1508                 result = -1;
1509                 goto out;
1510         }
1511
1512         result = write_object_file(buffer.buf, buffer.len, commit_type, ret);
1513 out:
1514         strbuf_release(&buffer);
1515         return result;
1516 }
1517
1518 define_commit_slab(merge_desc_slab, struct merge_remote_desc *);
1519 static struct merge_desc_slab merge_desc_slab = COMMIT_SLAB_INIT(1, merge_desc_slab);
1520
1521 struct merge_remote_desc *merge_remote_util(struct commit *commit)
1522 {
1523         return *merge_desc_slab_at(&merge_desc_slab, commit);
1524 }
1525
1526 void set_merge_remote_desc(struct commit *commit,
1527                            const char *name, struct object *obj)
1528 {
1529         struct merge_remote_desc *desc;
1530         FLEX_ALLOC_STR(desc, name, name);
1531         desc->obj = obj;
1532         *merge_desc_slab_at(&merge_desc_slab, commit) = desc;
1533 }
1534
1535 struct commit *get_merge_parent(const char *name)
1536 {
1537         struct object *obj;
1538         struct commit *commit;
1539         struct object_id oid;
1540         if (get_oid(name, &oid))
1541                 return NULL;
1542         obj = parse_object(the_repository, &oid);
1543         commit = (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
1544         if (commit && !merge_remote_util(commit))
1545                 set_merge_remote_desc(commit, name, obj);
1546         return commit;
1547 }
1548
1549 /*
1550  * Append a commit to the end of the commit_list.
1551  *
1552  * next starts by pointing to the variable that holds the head of an
1553  * empty commit_list, and is updated to point to the "next" field of
1554  * the last item on the list as new commits are appended.
1555  *
1556  * Usage example:
1557  *
1558  *     struct commit_list *list;
1559  *     struct commit_list **next = &list;
1560  *
1561  *     next = commit_list_append(c1, next);
1562  *     next = commit_list_append(c2, next);
1563  *     assert(commit_list_count(list) == 2);
1564  *     return list;
1565  */
1566 struct commit_list **commit_list_append(struct commit *commit,
1567                                         struct commit_list **next)
1568 {
1569         struct commit_list *new_commit = xmalloc(sizeof(struct commit_list));
1570         new_commit->item = commit;
1571         *next = new_commit;
1572         new_commit->next = NULL;
1573         return &new_commit->next;
1574 }
1575
1576 const char *find_commit_header(const char *msg, const char *key, size_t *out_len)
1577 {
1578         int key_len = strlen(key);
1579         const char *line = msg;
1580
1581         while (line) {
1582                 const char *eol = strchrnul(line, '\n');
1583
1584                 if (line == eol)
1585                         return NULL;
1586
1587                 if (eol - line > key_len &&
1588                     !strncmp(line, key, key_len) &&
1589                     line[key_len] == ' ') {
1590                         *out_len = eol - line - key_len - 1;
1591                         return line + key_len + 1;
1592                 }
1593                 line = *eol ? eol + 1 : NULL;
1594         }
1595         return NULL;
1596 }
1597
1598 /*
1599  * Inspect the given string and determine the true "end" of the log message, in
1600  * order to find where to put a new Signed-off-by trailer.  Ignored are
1601  * trailing comment lines and blank lines.  To support "git commit -s
1602  * --amend" on an existing commit, we also ignore "Conflicts:".  To
1603  * support "git commit -v", we truncate at cut lines.
1604  *
1605  * Returns the number of bytes from the tail to ignore, to be fed as
1606  * the second parameter to append_signoff().
1607  */
1608 size_t ignore_non_trailer(const char *buf, size_t len)
1609 {
1610         size_t boc = 0;
1611         size_t bol = 0;
1612         int in_old_conflicts_block = 0;
1613         size_t cutoff = wt_status_locate_end(buf, len);
1614
1615         while (bol < cutoff) {
1616                 const char *next_line = memchr(buf + bol, '\n', len - bol);
1617
1618                 if (!next_line)
1619                         next_line = buf + len;
1620                 else
1621                         next_line++;
1622
1623                 if (buf[bol] == comment_line_char || buf[bol] == '\n') {
1624                         /* is this the first of the run of comments? */
1625                         if (!boc)
1626                                 boc = bol;
1627                         /* otherwise, it is just continuing */
1628                 } else if (starts_with(buf + bol, "Conflicts:\n")) {
1629                         in_old_conflicts_block = 1;
1630                         if (!boc)
1631                                 boc = bol;
1632                 } else if (in_old_conflicts_block && buf[bol] == '\t') {
1633                         ; /* a pathname in the conflicts block */
1634                 } else if (boc) {
1635                         /* the previous was not trailing comment */
1636                         boc = 0;
1637                         in_old_conflicts_block = 0;
1638                 }
1639                 bol = next_line - buf;
1640         }
1641         return boc ? len - boc : len - cutoff;
1642 }
1643
1644 int run_commit_hook(int editor_is_used, const char *index_file,
1645                     const char *name, ...)
1646 {
1647         struct strvec hook_env = STRVEC_INIT;
1648         va_list args;
1649         int ret;
1650
1651         strvec_pushf(&hook_env, "GIT_INDEX_FILE=%s", index_file);
1652
1653         /*
1654          * Let the hook know that no editor will be launched.
1655          */
1656         if (!editor_is_used)
1657                 strvec_push(&hook_env, "GIT_EDITOR=:");
1658
1659         va_start(args, name);
1660         ret = run_hook_ve(hook_env.v, name, args);
1661         va_end(args);
1662         strvec_clear(&hook_env);
1663
1664         return ret;
1665 }