fetch-pack: use DEFINE_LIST_SORT
[git/debian.git] / commit.c
blob5799c16244d5f39e550d46c1a808e09093e2d457
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 "hash-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 #include "hook.h"
26 static struct commit_extra_header *read_commit_extra_header_lines(const char *buf, size_t len, const char **);
28 int save_commit_buffer = 1;
29 int no_graft_file_deprecated_advice;
31 const char *commit_type = "commit";
33 struct commit *lookup_commit_reference_gently(struct repository *r,
34 const struct object_id *oid, int quiet)
36 struct object *obj = deref_tag(r,
37 parse_object(r, oid),
38 NULL, 0);
40 if (!obj)
41 return NULL;
42 return object_as_type(obj, OBJ_COMMIT, quiet);
45 struct commit *lookup_commit_reference(struct repository *r, const struct object_id *oid)
47 return lookup_commit_reference_gently(r, oid, 0);
50 struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name)
52 struct commit *c = lookup_commit_reference(the_repository, oid);
53 if (!c)
54 die(_("could not parse %s"), ref_name);
55 if (!oideq(oid, &c->object.oid)) {
56 warning(_("%s %s is not a commit!"),
57 ref_name, oid_to_hex(oid));
59 return c;
62 struct commit *lookup_commit(struct repository *r, const struct object_id *oid)
64 struct object *obj = lookup_object(r, oid);
65 if (!obj)
66 return create_object(r, oid, alloc_commit_node(r));
67 return object_as_type(obj, OBJ_COMMIT, 0);
70 struct commit *lookup_commit_reference_by_name(const char *name)
72 struct object_id oid;
73 struct commit *commit;
75 if (get_oid_committish(name, &oid))
76 return NULL;
77 commit = lookup_commit_reference(the_repository, &oid);
78 if (parse_commit(commit))
79 return NULL;
80 return commit;
83 static timestamp_t parse_commit_date(const char *buf, const char *tail)
85 const char *dateptr;
87 if (buf + 6 >= tail)
88 return 0;
89 if (memcmp(buf, "author", 6))
90 return 0;
91 while (buf < tail && *buf++ != '\n')
92 /* nada */;
93 if (buf + 9 >= tail)
94 return 0;
95 if (memcmp(buf, "committer", 9))
96 return 0;
97 while (buf < tail && *buf++ != '>')
98 /* nada */;
99 if (buf >= tail)
100 return 0;
101 dateptr = buf;
102 while (buf < tail && *buf++ != '\n')
103 /* nada */;
104 if (buf >= tail)
105 return 0;
106 /* dateptr < buf && buf[-1] == '\n', so parsing will stop at buf-1 */
107 return parse_timestamp(dateptr, NULL, 10);
110 static const struct object_id *commit_graft_oid_access(size_t index, const void *table)
112 const struct commit_graft * const *commit_graft_table = table;
113 return &commit_graft_table[index]->oid;
116 int commit_graft_pos(struct repository *r, const struct object_id *oid)
118 return oid_pos(oid, r->parsed_objects->grafts,
119 r->parsed_objects->grafts_nr,
120 commit_graft_oid_access);
123 int register_commit_graft(struct repository *r, struct commit_graft *graft,
124 int ignore_dups)
126 int pos = commit_graft_pos(r, &graft->oid);
128 if (0 <= pos) {
129 if (ignore_dups)
130 free(graft);
131 else {
132 free(r->parsed_objects->grafts[pos]);
133 r->parsed_objects->grafts[pos] = graft;
135 return 1;
137 pos = -pos - 1;
138 ALLOC_GROW(r->parsed_objects->grafts,
139 r->parsed_objects->grafts_nr + 1,
140 r->parsed_objects->grafts_alloc);
141 r->parsed_objects->grafts_nr++;
142 if (pos < r->parsed_objects->grafts_nr)
143 memmove(r->parsed_objects->grafts + pos + 1,
144 r->parsed_objects->grafts + pos,
145 (r->parsed_objects->grafts_nr - pos - 1) *
146 sizeof(*r->parsed_objects->grafts));
147 r->parsed_objects->grafts[pos] = graft;
148 return 0;
151 struct commit_graft *read_graft_line(struct strbuf *line)
153 /* The format is just "Commit Parent1 Parent2 ...\n" */
154 int i, phase;
155 const char *tail = NULL;
156 struct commit_graft *graft = NULL;
157 struct object_id dummy_oid, *oid;
159 strbuf_rtrim(line);
160 if (!line->len || line->buf[0] == '#')
161 return NULL;
163 * phase 0 verifies line, counts hashes in line and allocates graft
164 * phase 1 fills graft
166 for (phase = 0; phase < 2; phase++) {
167 oid = graft ? &graft->oid : &dummy_oid;
168 if (parse_oid_hex(line->buf, oid, &tail))
169 goto bad_graft_data;
170 for (i = 0; *tail != '\0'; i++) {
171 oid = graft ? &graft->parent[i] : &dummy_oid;
172 if (!isspace(*tail++) || parse_oid_hex(tail, oid, &tail))
173 goto bad_graft_data;
175 if (!graft) {
176 graft = xmalloc(st_add(sizeof(*graft),
177 st_mult(sizeof(struct object_id), i)));
178 graft->nr_parent = i;
181 return graft;
183 bad_graft_data:
184 error("bad graft data: %s", line->buf);
185 assert(!graft);
186 return NULL;
189 static int read_graft_file(struct repository *r, const char *graft_file)
191 FILE *fp = fopen_or_warn(graft_file, "r");
192 struct strbuf buf = STRBUF_INIT;
193 if (!fp)
194 return -1;
195 if (!no_graft_file_deprecated_advice &&
196 advice_enabled(ADVICE_GRAFT_FILE_DEPRECATED))
197 advise(_("Support for <GIT_DIR>/info/grafts is deprecated\n"
198 "and will be removed in a future Git version.\n"
199 "\n"
200 "Please use \"git replace --convert-graft-file\"\n"
201 "to convert the grafts into replace refs.\n"
202 "\n"
203 "Turn this message off by running\n"
204 "\"git config advice.graftFileDeprecated false\""));
205 while (!strbuf_getwholeline(&buf, fp, '\n')) {
206 /* The format is just "Commit Parent1 Parent2 ...\n" */
207 struct commit_graft *graft = read_graft_line(&buf);
208 if (!graft)
209 continue;
210 if (register_commit_graft(r, graft, 1))
211 error("duplicate graft data: %s", buf.buf);
213 fclose(fp);
214 strbuf_release(&buf);
215 return 0;
218 void prepare_commit_graft(struct repository *r)
220 char *graft_file;
222 if (r->parsed_objects->commit_graft_prepared)
223 return;
224 if (!startup_info->have_repository)
225 return;
227 graft_file = get_graft_file(r);
228 read_graft_file(r, graft_file);
229 /* make sure shallows are read */
230 is_repository_shallow(r);
231 r->parsed_objects->commit_graft_prepared = 1;
234 struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid)
236 int pos;
237 prepare_commit_graft(r);
238 pos = commit_graft_pos(r, oid);
239 if (pos < 0)
240 return NULL;
241 return r->parsed_objects->grafts[pos];
244 int for_each_commit_graft(each_commit_graft_fn fn, void *cb_data)
246 int i, ret;
247 for (i = ret = 0; i < the_repository->parsed_objects->grafts_nr && !ret; i++)
248 ret = fn(the_repository->parsed_objects->grafts[i], cb_data);
249 return ret;
252 void reset_commit_grafts(struct repository *r)
254 int i;
256 for (i = 0; i < r->parsed_objects->grafts_nr; i++)
257 free(r->parsed_objects->grafts[i]);
258 r->parsed_objects->grafts_nr = 0;
259 r->parsed_objects->commit_graft_prepared = 0;
262 struct commit_buffer {
263 void *buffer;
264 unsigned long size;
266 define_commit_slab(buffer_slab, struct commit_buffer);
268 struct buffer_slab *allocate_commit_buffer_slab(void)
270 struct buffer_slab *bs = xmalloc(sizeof(*bs));
271 init_buffer_slab(bs);
272 return bs;
275 void free_commit_buffer_slab(struct buffer_slab *bs)
277 clear_buffer_slab(bs);
278 free(bs);
281 void set_commit_buffer(struct repository *r, struct commit *commit, void *buffer, unsigned long size)
283 struct commit_buffer *v = buffer_slab_at(
284 r->parsed_objects->buffer_slab, commit);
285 v->buffer = buffer;
286 v->size = size;
289 const void *get_cached_commit_buffer(struct repository *r, const struct commit *commit, unsigned long *sizep)
291 struct commit_buffer *v = buffer_slab_peek(
292 r->parsed_objects->buffer_slab, commit);
293 if (!v) {
294 if (sizep)
295 *sizep = 0;
296 return NULL;
298 if (sizep)
299 *sizep = v->size;
300 return v->buffer;
303 const void *repo_get_commit_buffer(struct repository *r,
304 const struct commit *commit,
305 unsigned long *sizep)
307 const void *ret = get_cached_commit_buffer(r, commit, sizep);
308 if (!ret) {
309 enum object_type type;
310 unsigned long size;
311 ret = repo_read_object_file(r, &commit->object.oid, &type, &size);
312 if (!ret)
313 die("cannot read commit object %s",
314 oid_to_hex(&commit->object.oid));
315 if (type != OBJ_COMMIT)
316 die("expected commit for %s, got %s",
317 oid_to_hex(&commit->object.oid), type_name(type));
318 if (sizep)
319 *sizep = size;
321 return ret;
324 void repo_unuse_commit_buffer(struct repository *r,
325 const struct commit *commit,
326 const void *buffer)
328 struct commit_buffer *v = buffer_slab_peek(
329 r->parsed_objects->buffer_slab, commit);
330 if (!(v && v->buffer == buffer))
331 free((void *)buffer);
334 void free_commit_buffer(struct parsed_object_pool *pool, struct commit *commit)
336 struct commit_buffer *v = buffer_slab_peek(
337 pool->buffer_slab, commit);
338 if (v) {
339 FREE_AND_NULL(v->buffer);
340 v->size = 0;
344 static inline void set_commit_tree(struct commit *c, struct tree *t)
346 c->maybe_tree = t;
349 struct tree *repo_get_commit_tree(struct repository *r,
350 const struct commit *commit)
352 if (commit->maybe_tree || !commit->object.parsed)
353 return commit->maybe_tree;
355 if (commit_graph_position(commit) != COMMIT_NOT_FROM_GRAPH)
356 return get_commit_tree_in_graph(r, commit);
358 return NULL;
361 struct object_id *get_commit_tree_oid(const struct commit *commit)
363 struct tree *tree = get_commit_tree(commit);
364 return tree ? &tree->object.oid : NULL;
367 void release_commit_memory(struct parsed_object_pool *pool, struct commit *c)
369 set_commit_tree(c, NULL);
370 free_commit_buffer(pool, c);
371 c->index = 0;
372 free_commit_list(c->parents);
374 c->object.parsed = 0;
377 const void *detach_commit_buffer(struct commit *commit, unsigned long *sizep)
379 struct commit_buffer *v = buffer_slab_peek(
380 the_repository->parsed_objects->buffer_slab, commit);
381 void *ret;
383 if (!v) {
384 if (sizep)
385 *sizep = 0;
386 return NULL;
388 ret = v->buffer;
389 if (sizep)
390 *sizep = v->size;
392 v->buffer = NULL;
393 v->size = 0;
394 return ret;
397 int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph)
399 const char *tail = buffer;
400 const char *bufptr = buffer;
401 struct object_id parent;
402 struct commit_list **pptr;
403 struct commit_graft *graft;
404 const int tree_entry_len = the_hash_algo->hexsz + 5;
405 const int parent_entry_len = the_hash_algo->hexsz + 7;
406 struct tree *tree;
408 if (item->object.parsed)
409 return 0;
411 if (item->parents) {
413 * Presumably this is leftover from an earlier failed parse;
414 * clear it out in preparation for us re-parsing (we'll hit the
415 * same error, but that's good, since it lets our caller know
416 * the result cannot be trusted.
418 free_commit_list(item->parents);
419 item->parents = NULL;
422 tail += size;
423 if (tail <= bufptr + tree_entry_len + 1 || memcmp(bufptr, "tree ", 5) ||
424 bufptr[tree_entry_len] != '\n')
425 return error("bogus commit object %s", oid_to_hex(&item->object.oid));
426 if (get_oid_hex(bufptr + 5, &parent) < 0)
427 return error("bad tree pointer in commit %s",
428 oid_to_hex(&item->object.oid));
429 tree = lookup_tree(r, &parent);
430 if (!tree)
431 return error("bad tree pointer %s in commit %s",
432 oid_to_hex(&parent),
433 oid_to_hex(&item->object.oid));
434 set_commit_tree(item, tree);
435 bufptr += tree_entry_len + 1; /* "tree " + "hex sha1" + "\n" */
436 pptr = &item->parents;
438 graft = lookup_commit_graft(r, &item->object.oid);
439 if (graft)
440 r->parsed_objects->substituted_parent = 1;
441 while (bufptr + parent_entry_len < tail && !memcmp(bufptr, "parent ", 7)) {
442 struct commit *new_parent;
444 if (tail <= bufptr + parent_entry_len + 1 ||
445 get_oid_hex(bufptr + 7, &parent) ||
446 bufptr[parent_entry_len] != '\n')
447 return error("bad parents in commit %s", oid_to_hex(&item->object.oid));
448 bufptr += parent_entry_len + 1;
450 * The clone is shallow if nr_parent < 0, and we must
451 * not traverse its real parents even when we unhide them.
453 if (graft && (graft->nr_parent < 0 || grafts_replace_parents))
454 continue;
455 new_parent = lookup_commit(r, &parent);
456 if (!new_parent)
457 return error("bad parent %s in commit %s",
458 oid_to_hex(&parent),
459 oid_to_hex(&item->object.oid));
460 pptr = &commit_list_insert(new_parent, pptr)->next;
462 if (graft) {
463 int i;
464 struct commit *new_parent;
465 for (i = 0; i < graft->nr_parent; i++) {
466 new_parent = lookup_commit(r,
467 &graft->parent[i]);
468 if (!new_parent)
469 return error("bad graft parent %s in commit %s",
470 oid_to_hex(&graft->parent[i]),
471 oid_to_hex(&item->object.oid));
472 pptr = &commit_list_insert(new_parent, pptr)->next;
475 item->date = parse_commit_date(bufptr, tail);
477 if (check_graph)
478 load_commit_graph_info(r, item);
480 item->object.parsed = 1;
481 return 0;
484 int repo_parse_commit_internal(struct repository *r,
485 struct commit *item,
486 int quiet_on_missing,
487 int use_commit_graph)
489 enum object_type type;
490 void *buffer;
491 unsigned long size;
492 int ret;
494 if (!item)
495 return -1;
496 if (item->object.parsed)
497 return 0;
498 if (use_commit_graph && parse_commit_in_graph(r, item))
499 return 0;
500 buffer = repo_read_object_file(r, &item->object.oid, &type, &size);
501 if (!buffer)
502 return quiet_on_missing ? -1 :
503 error("Could not read %s",
504 oid_to_hex(&item->object.oid));
505 if (type != OBJ_COMMIT) {
506 free(buffer);
507 return error("Object %s not a commit",
508 oid_to_hex(&item->object.oid));
511 ret = parse_commit_buffer(r, item, buffer, size, 0);
512 if (save_commit_buffer && !ret) {
513 set_commit_buffer(r, item, buffer, size);
514 return 0;
516 free(buffer);
517 return ret;
520 int repo_parse_commit_gently(struct repository *r,
521 struct commit *item, int quiet_on_missing)
523 return repo_parse_commit_internal(r, item, quiet_on_missing, 1);
526 void parse_commit_or_die(struct commit *item)
528 if (parse_commit(item))
529 die("unable to parse commit %s",
530 item ? oid_to_hex(&item->object.oid) : "(null)");
533 int find_commit_subject(const char *commit_buffer, const char **subject)
535 const char *eol;
536 const char *p = commit_buffer;
538 while (*p && (*p != '\n' || p[1] != '\n'))
539 p++;
540 if (*p) {
541 p = skip_blank_lines(p + 2);
542 eol = strchrnul(p, '\n');
543 } else
544 eol = p;
546 *subject = p;
548 return eol - p;
551 size_t commit_subject_length(const char *body)
553 const char *p = body;
554 while (*p) {
555 const char *next = skip_blank_lines(p);
556 if (next != p)
557 break;
558 p = strchrnul(p, '\n');
559 if (*p)
560 p++;
562 return p - body;
565 struct commit_list *commit_list_insert(struct commit *item, struct commit_list **list_p)
567 struct commit_list *new_list = xmalloc(sizeof(struct commit_list));
568 new_list->item = item;
569 new_list->next = *list_p;
570 *list_p = new_list;
571 return new_list;
574 int commit_list_contains(struct commit *item, struct commit_list *list)
576 while (list) {
577 if (list->item == item)
578 return 1;
579 list = list->next;
582 return 0;
585 unsigned commit_list_count(const struct commit_list *l)
587 unsigned c = 0;
588 for (; l; l = l->next )
589 c++;
590 return c;
593 struct commit_list *copy_commit_list(struct commit_list *list)
595 struct commit_list *head = NULL;
596 struct commit_list **pp = &head;
597 while (list) {
598 pp = commit_list_append(list->item, pp);
599 list = list->next;
601 return head;
604 struct commit_list *reverse_commit_list(struct commit_list *list)
606 struct commit_list *next = NULL, *current, *backup;
607 for (current = list; current; current = backup) {
608 backup = current->next;
609 current->next = next;
610 next = current;
612 return next;
615 void free_commit_list(struct commit_list *list)
617 while (list)
618 pop_commit(&list);
621 struct commit_list * commit_list_insert_by_date(struct commit *item, struct commit_list **list)
623 struct commit_list **pp = list;
624 struct commit_list *p;
625 while ((p = *pp) != NULL) {
626 if (p->item->date < item->date) {
627 break;
629 pp = &p->next;
631 return commit_list_insert(item, pp);
634 static int commit_list_compare_by_date(const struct commit_list *a,
635 const struct commit_list *b)
637 timestamp_t a_date = a->item->date;
638 timestamp_t b_date = b->item->date;
639 if (a_date < b_date)
640 return 1;
641 if (a_date > b_date)
642 return -1;
643 return 0;
646 DEFINE_LIST_SORT(static, commit_list_sort, struct commit_list, next);
648 void commit_list_sort_by_date(struct commit_list **list)
650 commit_list_sort(list, commit_list_compare_by_date);
653 struct commit *pop_most_recent_commit(struct commit_list **list,
654 unsigned int mark)
656 struct commit *ret = pop_commit(list);
657 struct commit_list *parents = ret->parents;
659 while (parents) {
660 struct commit *commit = parents->item;
661 if (!parse_commit(commit) && !(commit->object.flags & mark)) {
662 commit->object.flags |= mark;
663 commit_list_insert_by_date(commit, list);
665 parents = parents->next;
667 return ret;
670 static void clear_commit_marks_1(struct commit_list **plist,
671 struct commit *commit, unsigned int mark)
673 while (commit) {
674 struct commit_list *parents;
676 if (!(mark & commit->object.flags))
677 return;
679 commit->object.flags &= ~mark;
681 parents = commit->parents;
682 if (!parents)
683 return;
685 while ((parents = parents->next))
686 commit_list_insert(parents->item, plist);
688 commit = commit->parents->item;
692 void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark)
694 struct commit_list *list = NULL;
696 while (nr--) {
697 clear_commit_marks_1(&list, *commit, mark);
698 commit++;
700 while (list)
701 clear_commit_marks_1(&list, pop_commit(&list), mark);
704 void clear_commit_marks(struct commit *commit, unsigned int mark)
706 clear_commit_marks_many(1, &commit, mark);
709 struct commit *pop_commit(struct commit_list **stack)
711 struct commit_list *top = *stack;
712 struct commit *item = top ? top->item : NULL;
714 if (top) {
715 *stack = top->next;
716 free(top);
718 return item;
722 * Topological sort support
725 /* count number of children that have not been emitted */
726 define_commit_slab(indegree_slab, int);
728 define_commit_slab(author_date_slab, timestamp_t);
730 void record_author_date(struct author_date_slab *author_date,
731 struct commit *commit)
733 const char *buffer = get_commit_buffer(commit, NULL);
734 struct ident_split ident;
735 const char *ident_line;
736 size_t ident_len;
737 char *date_end;
738 timestamp_t date;
740 ident_line = find_commit_header(buffer, "author", &ident_len);
741 if (!ident_line)
742 goto fail_exit; /* no author line */
743 if (split_ident_line(&ident, ident_line, ident_len) ||
744 !ident.date_begin || !ident.date_end)
745 goto fail_exit; /* malformed "author" line */
747 date = parse_timestamp(ident.date_begin, &date_end, 10);
748 if (date_end != ident.date_end)
749 goto fail_exit; /* malformed date */
750 *(author_date_slab_at(author_date, commit)) = date;
752 fail_exit:
753 unuse_commit_buffer(commit, buffer);
756 int compare_commits_by_author_date(const void *a_, const void *b_,
757 void *cb_data)
759 const struct commit *a = a_, *b = b_;
760 struct author_date_slab *author_date = cb_data;
761 timestamp_t a_date = *(author_date_slab_at(author_date, a));
762 timestamp_t b_date = *(author_date_slab_at(author_date, b));
764 /* newer commits with larger date first */
765 if (a_date < b_date)
766 return 1;
767 else if (a_date > b_date)
768 return -1;
769 return 0;
772 int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused)
774 const struct commit *a = a_, *b = b_;
775 const timestamp_t generation_a = commit_graph_generation(a),
776 generation_b = commit_graph_generation(b);
778 /* newer commits first */
779 if (generation_a < generation_b)
780 return 1;
781 else if (generation_a > generation_b)
782 return -1;
784 /* use date as a heuristic when generations are equal */
785 if (a->date < b->date)
786 return 1;
787 else if (a->date > b->date)
788 return -1;
789 return 0;
792 int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused)
794 const struct commit *a = a_, *b = b_;
795 /* newer commits with larger date first */
796 if (a->date < b->date)
797 return 1;
798 else if (a->date > b->date)
799 return -1;
800 return 0;
804 * Performs an in-place topological sort on the list supplied.
806 void sort_in_topological_order(struct commit_list **list, enum rev_sort_order sort_order)
808 struct commit_list *next, *orig = *list;
809 struct commit_list **pptr;
810 struct indegree_slab indegree;
811 struct prio_queue queue;
812 struct commit *commit;
813 struct author_date_slab author_date;
815 if (!orig)
816 return;
817 *list = NULL;
819 init_indegree_slab(&indegree);
820 memset(&queue, '\0', sizeof(queue));
822 switch (sort_order) {
823 default: /* REV_SORT_IN_GRAPH_ORDER */
824 queue.compare = NULL;
825 break;
826 case REV_SORT_BY_COMMIT_DATE:
827 queue.compare = compare_commits_by_commit_date;
828 break;
829 case REV_SORT_BY_AUTHOR_DATE:
830 init_author_date_slab(&author_date);
831 queue.compare = compare_commits_by_author_date;
832 queue.cb_data = &author_date;
833 break;
836 /* Mark them and clear the indegree */
837 for (next = orig; next; next = next->next) {
838 struct commit *commit = next->item;
839 *(indegree_slab_at(&indegree, commit)) = 1;
840 /* also record the author dates, if needed */
841 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
842 record_author_date(&author_date, commit);
845 /* update the indegree */
846 for (next = orig; next; next = next->next) {
847 struct commit_list *parents = next->item->parents;
848 while (parents) {
849 struct commit *parent = parents->item;
850 int *pi = indegree_slab_at(&indegree, parent);
852 if (*pi)
853 (*pi)++;
854 parents = parents->next;
859 * find the tips
861 * tips are nodes not reachable from any other node in the list
863 * the tips serve as a starting set for the work queue.
865 for (next = orig; next; next = next->next) {
866 struct commit *commit = next->item;
868 if (*(indegree_slab_at(&indegree, commit)) == 1)
869 prio_queue_put(&queue, commit);
873 * This is unfortunate; the initial tips need to be shown
874 * in the order given from the revision traversal machinery.
876 if (sort_order == REV_SORT_IN_GRAPH_ORDER)
877 prio_queue_reverse(&queue);
879 /* We no longer need the commit list */
880 free_commit_list(orig);
882 pptr = list;
883 *list = NULL;
884 while ((commit = prio_queue_get(&queue)) != NULL) {
885 struct commit_list *parents;
887 for (parents = commit->parents; parents ; parents = parents->next) {
888 struct commit *parent = parents->item;
889 int *pi = indegree_slab_at(&indegree, parent);
891 if (!*pi)
892 continue;
895 * parents are only enqueued for emission
896 * when all their children have been emitted thereby
897 * guaranteeing topological order.
899 if (--(*pi) == 1)
900 prio_queue_put(&queue, parent);
903 * all children of commit have already been
904 * emitted. we can emit it now.
906 *(indegree_slab_at(&indegree, commit)) = 0;
908 pptr = &commit_list_insert(commit, pptr)->next;
911 clear_indegree_slab(&indegree);
912 clear_prio_queue(&queue);
913 if (sort_order == REV_SORT_BY_AUTHOR_DATE)
914 clear_author_date_slab(&author_date);
917 struct rev_collect {
918 struct commit **commit;
919 int nr;
920 int alloc;
921 unsigned int initial : 1;
924 static void add_one_commit(struct object_id *oid, struct rev_collect *revs)
926 struct commit *commit;
928 if (is_null_oid(oid))
929 return;
931 commit = lookup_commit(the_repository, oid);
932 if (!commit ||
933 (commit->object.flags & TMP_MARK) ||
934 parse_commit(commit))
935 return;
937 ALLOC_GROW(revs->commit, revs->nr + 1, revs->alloc);
938 revs->commit[revs->nr++] = commit;
939 commit->object.flags |= TMP_MARK;
942 static int collect_one_reflog_ent(struct object_id *ooid, struct object_id *noid,
943 const char *ident, timestamp_t timestamp,
944 int tz, const char *message, void *cbdata)
946 struct rev_collect *revs = cbdata;
948 if (revs->initial) {
949 revs->initial = 0;
950 add_one_commit(ooid, revs);
952 add_one_commit(noid, revs);
953 return 0;
956 struct commit *get_fork_point(const char *refname, struct commit *commit)
958 struct object_id oid;
959 struct rev_collect revs;
960 struct commit_list *bases;
961 int i;
962 struct commit *ret = NULL;
963 char *full_refname;
965 switch (dwim_ref(refname, strlen(refname), &oid, &full_refname, 0)) {
966 case 0:
967 die("No such ref: '%s'", refname);
968 case 1:
969 break; /* good */
970 default:
971 die("Ambiguous refname: '%s'", refname);
974 memset(&revs, 0, sizeof(revs));
975 revs.initial = 1;
976 for_each_reflog_ent(full_refname, collect_one_reflog_ent, &revs);
978 if (!revs.nr)
979 add_one_commit(&oid, &revs);
981 for (i = 0; i < revs.nr; i++)
982 revs.commit[i]->object.flags &= ~TMP_MARK;
984 bases = get_merge_bases_many(commit, revs.nr, revs.commit);
987 * There should be one and only one merge base, when we found
988 * a common ancestor among reflog entries.
990 if (!bases || bases->next)
991 goto cleanup_return;
993 /* And the found one must be one of the reflog entries */
994 for (i = 0; i < revs.nr; i++)
995 if (&bases->item->object == &revs.commit[i]->object)
996 break; /* found */
997 if (revs.nr <= i)
998 goto cleanup_return;
1000 ret = bases->item;
1002 cleanup_return:
1003 free_commit_list(bases);
1004 free(full_refname);
1005 return ret;
1009 * Indexed by hash algorithm identifier.
1011 static const char *gpg_sig_headers[] = {
1012 NULL,
1013 "gpgsig",
1014 "gpgsig-sha256",
1017 int sign_with_header(struct strbuf *buf, const char *keyid)
1019 struct strbuf sig = STRBUF_INIT;
1020 int inspos, copypos;
1021 const char *eoh;
1022 const char *gpg_sig_header = gpg_sig_headers[hash_algo_by_ptr(the_hash_algo)];
1023 int gpg_sig_header_len = strlen(gpg_sig_header);
1025 /* find the end of the header */
1026 eoh = strstr(buf->buf, "\n\n");
1027 if (!eoh)
1028 inspos = buf->len;
1029 else
1030 inspos = eoh - buf->buf + 1;
1032 if (!keyid || !*keyid)
1033 keyid = get_signing_key();
1034 if (sign_buffer(buf, &sig, keyid)) {
1035 strbuf_release(&sig);
1036 return -1;
1039 for (copypos = 0; sig.buf[copypos]; ) {
1040 const char *bol = sig.buf + copypos;
1041 const char *eol = strchrnul(bol, '\n');
1042 int len = (eol - bol) + !!*eol;
1044 if (!copypos) {
1045 strbuf_insert(buf, inspos, gpg_sig_header, gpg_sig_header_len);
1046 inspos += gpg_sig_header_len;
1048 strbuf_insertstr(buf, inspos++, " ");
1049 strbuf_insert(buf, inspos, bol, len);
1050 inspos += len;
1051 copypos += len;
1053 strbuf_release(&sig);
1054 return 0;
1059 int parse_signed_commit(const struct commit *commit,
1060 struct strbuf *payload, struct strbuf *signature,
1061 const struct git_hash_algo *algop)
1063 unsigned long size;
1064 const char *buffer = get_commit_buffer(commit, &size);
1065 int ret = parse_buffer_signed_by_header(buffer, size, payload, signature, algop);
1067 unuse_commit_buffer(commit, buffer);
1068 return ret;
1071 int parse_buffer_signed_by_header(const char *buffer,
1072 unsigned long size,
1073 struct strbuf *payload,
1074 struct strbuf *signature,
1075 const struct git_hash_algo *algop)
1077 int in_signature = 0, saw_signature = 0, other_signature = 0;
1078 const char *line, *tail, *p;
1079 const char *gpg_sig_header = gpg_sig_headers[hash_algo_by_ptr(algop)];
1081 line = buffer;
1082 tail = buffer + size;
1083 while (line < tail) {
1084 const char *sig = NULL;
1085 const char *next = memchr(line, '\n', tail - line);
1087 next = next ? next + 1 : tail;
1088 if (in_signature && line[0] == ' ')
1089 sig = line + 1;
1090 else if (skip_prefix(line, gpg_sig_header, &p) &&
1091 *p == ' ') {
1092 sig = line + strlen(gpg_sig_header) + 1;
1093 other_signature = 0;
1095 else if (starts_with(line, "gpgsig"))
1096 other_signature = 1;
1097 else if (other_signature && line[0] != ' ')
1098 other_signature = 0;
1099 if (sig) {
1100 strbuf_add(signature, sig, next - sig);
1101 saw_signature = 1;
1102 in_signature = 1;
1103 } else {
1104 if (*line == '\n')
1105 /* dump the whole remainder of the buffer */
1106 next = tail;
1107 if (!other_signature)
1108 strbuf_add(payload, line, next - line);
1109 in_signature = 0;
1111 line = next;
1113 return saw_signature;
1116 int remove_signature(struct strbuf *buf)
1118 const char *line = buf->buf;
1119 const char *tail = buf->buf + buf->len;
1120 int in_signature = 0;
1121 struct sigbuf {
1122 const char *start;
1123 const char *end;
1124 } sigs[2], *sigp = &sigs[0];
1125 int i;
1126 const char *orig_buf = buf->buf;
1128 memset(sigs, 0, sizeof(sigs));
1130 while (line < tail) {
1131 const char *next = memchr(line, '\n', tail - line);
1132 next = next ? next + 1 : tail;
1134 if (in_signature && line[0] == ' ')
1135 sigp->end = next;
1136 else if (starts_with(line, "gpgsig")) {
1137 int i;
1138 for (i = 1; i < GIT_HASH_NALGOS; i++) {
1139 const char *p;
1140 if (skip_prefix(line, gpg_sig_headers[i], &p) &&
1141 *p == ' ') {
1142 sigp->start = line;
1143 sigp->end = next;
1144 in_signature = 1;
1147 } else {
1148 if (*line == '\n')
1149 /* dump the whole remainder of the buffer */
1150 next = tail;
1151 if (in_signature && sigp - sigs != ARRAY_SIZE(sigs))
1152 sigp++;
1153 in_signature = 0;
1155 line = next;
1158 for (i = ARRAY_SIZE(sigs) - 1; i >= 0; i--)
1159 if (sigs[i].start)
1160 strbuf_remove(buf, sigs[i].start - orig_buf, sigs[i].end - sigs[i].start);
1162 return sigs[0].start != NULL;
1165 static void handle_signed_tag(struct commit *parent, struct commit_extra_header ***tail)
1167 struct merge_remote_desc *desc;
1168 struct commit_extra_header *mergetag;
1169 char *buf;
1170 unsigned long size;
1171 enum object_type type;
1172 struct strbuf payload = STRBUF_INIT;
1173 struct strbuf signature = STRBUF_INIT;
1175 desc = merge_remote_util(parent);
1176 if (!desc || !desc->obj)
1177 return;
1178 buf = read_object_file(&desc->obj->oid, &type, &size);
1179 if (!buf || type != OBJ_TAG)
1180 goto free_return;
1181 if (!parse_signature(buf, size, &payload, &signature))
1182 goto free_return;
1184 * We could verify this signature and either omit the tag when
1185 * it does not validate, but the integrator may not have the
1186 * public key of the signer of the tag being merged, while a
1187 * later auditor may have it while auditing, so let's not run
1188 * verify-signed-buffer here for now...
1190 * if (verify_signed_buffer(buf, len, buf + len, size - len, ...))
1191 * warn("warning: signed tag unverified.");
1193 CALLOC_ARRAY(mergetag, 1);
1194 mergetag->key = xstrdup("mergetag");
1195 mergetag->value = buf;
1196 mergetag->len = size;
1198 **tail = mergetag;
1199 *tail = &mergetag->next;
1200 strbuf_release(&payload);
1201 strbuf_release(&signature);
1202 return;
1204 free_return:
1205 free(buf);
1208 int check_commit_signature(const struct commit *commit, struct signature_check *sigc)
1210 struct strbuf payload = STRBUF_INIT;
1211 struct strbuf signature = STRBUF_INIT;
1212 int ret = 1;
1214 sigc->result = 'N';
1216 if (parse_signed_commit(commit, &payload, &signature, the_hash_algo) <= 0)
1217 goto out;
1219 sigc->payload_type = SIGNATURE_PAYLOAD_COMMIT;
1220 sigc->payload = strbuf_detach(&payload, &sigc->payload_len);
1221 ret = check_signature(sigc, signature.buf, signature.len);
1223 out:
1224 strbuf_release(&payload);
1225 strbuf_release(&signature);
1227 return ret;
1230 void verify_merge_signature(struct commit *commit, int verbosity,
1231 int check_trust)
1233 char hex[GIT_MAX_HEXSZ + 1];
1234 struct signature_check signature_check;
1235 int ret;
1236 memset(&signature_check, 0, sizeof(signature_check));
1238 ret = check_commit_signature(commit, &signature_check);
1240 find_unique_abbrev_r(hex, &commit->object.oid, DEFAULT_ABBREV);
1241 switch (signature_check.result) {
1242 case 'G':
1243 if (ret || (check_trust && signature_check.trust_level < TRUST_MARGINAL))
1244 die(_("Commit %s has an untrusted GPG signature, "
1245 "allegedly by %s."), hex, signature_check.signer);
1246 break;
1247 case 'B':
1248 die(_("Commit %s has a bad GPG signature "
1249 "allegedly by %s."), hex, signature_check.signer);
1250 default: /* 'N' */
1251 die(_("Commit %s does not have a GPG signature."), hex);
1253 if (verbosity >= 0 && signature_check.result == 'G')
1254 printf(_("Commit %s has a good GPG signature by %s\n"),
1255 hex, signature_check.signer);
1257 signature_check_clear(&signature_check);
1260 void append_merge_tag_headers(struct commit_list *parents,
1261 struct commit_extra_header ***tail)
1263 while (parents) {
1264 struct commit *parent = parents->item;
1265 handle_signed_tag(parent, tail);
1266 parents = parents->next;
1270 static void add_extra_header(struct strbuf *buffer,
1271 struct commit_extra_header *extra)
1273 strbuf_addstr(buffer, extra->key);
1274 if (extra->len)
1275 strbuf_add_lines(buffer, " ", extra->value, extra->len);
1276 else
1277 strbuf_addch(buffer, '\n');
1280 struct commit_extra_header *read_commit_extra_headers(struct commit *commit,
1281 const char **exclude)
1283 struct commit_extra_header *extra = NULL;
1284 unsigned long size;
1285 const char *buffer = get_commit_buffer(commit, &size);
1286 extra = read_commit_extra_header_lines(buffer, size, exclude);
1287 unuse_commit_buffer(commit, buffer);
1288 return extra;
1291 int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data)
1293 struct commit_extra_header *extra, *to_free;
1294 int res = 0;
1296 to_free = read_commit_extra_headers(commit, NULL);
1297 for (extra = to_free; !res && extra; extra = extra->next) {
1298 if (strcmp(extra->key, "mergetag"))
1299 continue; /* not a merge tag */
1300 res = fn(commit, extra, data);
1302 free_commit_extra_headers(to_free);
1303 return res;
1306 static inline int standard_header_field(const char *field, size_t len)
1308 return ((len == 4 && !memcmp(field, "tree", 4)) ||
1309 (len == 6 && !memcmp(field, "parent", 6)) ||
1310 (len == 6 && !memcmp(field, "author", 6)) ||
1311 (len == 9 && !memcmp(field, "committer", 9)) ||
1312 (len == 8 && !memcmp(field, "encoding", 8)));
1315 static int excluded_header_field(const char *field, size_t len, const char **exclude)
1317 if (!exclude)
1318 return 0;
1320 while (*exclude) {
1321 size_t xlen = strlen(*exclude);
1322 if (len == xlen && !memcmp(field, *exclude, xlen))
1323 return 1;
1324 exclude++;
1326 return 0;
1329 static struct commit_extra_header *read_commit_extra_header_lines(
1330 const char *buffer, size_t size,
1331 const char **exclude)
1333 struct commit_extra_header *extra = NULL, **tail = &extra, *it = NULL;
1334 const char *line, *next, *eof, *eob;
1335 struct strbuf buf = STRBUF_INIT;
1337 for (line = buffer, eob = line + size;
1338 line < eob && *line != '\n';
1339 line = next) {
1340 next = memchr(line, '\n', eob - line);
1341 next = next ? next + 1 : eob;
1342 if (*line == ' ') {
1343 /* continuation */
1344 if (it)
1345 strbuf_add(&buf, line + 1, next - (line + 1));
1346 continue;
1348 if (it)
1349 it->value = strbuf_detach(&buf, &it->len);
1350 strbuf_reset(&buf);
1351 it = NULL;
1353 eof = memchr(line, ' ', next - line);
1354 if (!eof)
1355 eof = next;
1356 else if (standard_header_field(line, eof - line) ||
1357 excluded_header_field(line, eof - line, exclude))
1358 continue;
1360 CALLOC_ARRAY(it, 1);
1361 it->key = xmemdupz(line, eof-line);
1362 *tail = it;
1363 tail = &it->next;
1364 if (eof + 1 < next)
1365 strbuf_add(&buf, eof + 1, next - (eof + 1));
1367 if (it)
1368 it->value = strbuf_detach(&buf, &it->len);
1369 return extra;
1372 void free_commit_extra_headers(struct commit_extra_header *extra)
1374 while (extra) {
1375 struct commit_extra_header *next = extra->next;
1376 free(extra->key);
1377 free(extra->value);
1378 free(extra);
1379 extra = next;
1383 int commit_tree(const char *msg, size_t msg_len, const struct object_id *tree,
1384 struct commit_list *parents, struct object_id *ret,
1385 const char *author, const char *sign_commit)
1387 struct commit_extra_header *extra = NULL, **tail = &extra;
1388 int result;
1390 append_merge_tag_headers(parents, &tail);
1391 result = commit_tree_extended(msg, msg_len, tree, parents, ret, author,
1392 NULL, sign_commit, extra);
1393 free_commit_extra_headers(extra);
1394 return result;
1397 static int find_invalid_utf8(const char *buf, int len)
1399 int offset = 0;
1400 static const unsigned int max_codepoint[] = {
1401 0x7f, 0x7ff, 0xffff, 0x10ffff
1404 while (len) {
1405 unsigned char c = *buf++;
1406 int bytes, bad_offset;
1407 unsigned int codepoint;
1408 unsigned int min_val, max_val;
1410 len--;
1411 offset++;
1413 /* Simple US-ASCII? No worries. */
1414 if (c < 0x80)
1415 continue;
1417 bad_offset = offset-1;
1420 * Count how many more high bits set: that's how
1421 * many more bytes this sequence should have.
1423 bytes = 0;
1424 while (c & 0x40) {
1425 c <<= 1;
1426 bytes++;
1430 * Must be between 1 and 3 more bytes. Longer sequences result in
1431 * codepoints beyond U+10FFFF, which are guaranteed never to exist.
1433 if (bytes < 1 || 3 < bytes)
1434 return bad_offset;
1436 /* Do we *have* that many bytes? */
1437 if (len < bytes)
1438 return bad_offset;
1441 * Place the encoded bits at the bottom of the value and compute the
1442 * valid range.
1444 codepoint = (c & 0x7f) >> bytes;
1445 min_val = max_codepoint[bytes-1] + 1;
1446 max_val = max_codepoint[bytes];
1448 offset += bytes;
1449 len -= bytes;
1451 /* And verify that they are good continuation bytes */
1452 do {
1453 codepoint <<= 6;
1454 codepoint |= *buf & 0x3f;
1455 if ((*buf++ & 0xc0) != 0x80)
1456 return bad_offset;
1457 } while (--bytes);
1459 /* Reject codepoints that are out of range for the sequence length. */
1460 if (codepoint < min_val || codepoint > max_val)
1461 return bad_offset;
1462 /* Surrogates are only for UTF-16 and cannot be encoded in UTF-8. */
1463 if ((codepoint & 0x1ff800) == 0xd800)
1464 return bad_offset;
1465 /* U+xxFFFE and U+xxFFFF are guaranteed non-characters. */
1466 if ((codepoint & 0xfffe) == 0xfffe)
1467 return bad_offset;
1468 /* So are anything in the range U+FDD0..U+FDEF. */
1469 if (codepoint >= 0xfdd0 && codepoint <= 0xfdef)
1470 return bad_offset;
1472 return -1;
1476 * This verifies that the buffer is in proper utf8 format.
1478 * If it isn't, it assumes any non-utf8 characters are Latin1,
1479 * and does the conversion.
1481 static int verify_utf8(struct strbuf *buf)
1483 int ok = 1;
1484 long pos = 0;
1486 for (;;) {
1487 int bad;
1488 unsigned char c;
1489 unsigned char replace[2];
1491 bad = find_invalid_utf8(buf->buf + pos, buf->len - pos);
1492 if (bad < 0)
1493 return ok;
1494 pos += bad;
1495 ok = 0;
1496 c = buf->buf[pos];
1497 strbuf_remove(buf, pos, 1);
1499 /* We know 'c' must be in the range 128-255 */
1500 replace[0] = 0xc0 + (c >> 6);
1501 replace[1] = 0x80 + (c & 0x3f);
1502 strbuf_insert(buf, pos, replace, 2);
1503 pos += 2;
1507 static const char commit_utf8_warn[] =
1508 N_("Warning: commit message did not conform to UTF-8.\n"
1509 "You may want to amend it after fixing the message, or set the config\n"
1510 "variable i18n.commitencoding to the encoding your project uses.\n");
1512 int commit_tree_extended(const char *msg, size_t msg_len,
1513 const struct object_id *tree,
1514 struct commit_list *parents, struct object_id *ret,
1515 const char *author, const char *committer,
1516 const char *sign_commit,
1517 struct commit_extra_header *extra)
1519 int result;
1520 int encoding_is_utf8;
1521 struct strbuf buffer;
1523 assert_oid_type(tree, OBJ_TREE);
1525 if (memchr(msg, '\0', msg_len))
1526 return error("a NUL byte in commit log message not allowed.");
1528 /* Not having i18n.commitencoding is the same as having utf-8 */
1529 encoding_is_utf8 = is_encoding_utf8(git_commit_encoding);
1531 strbuf_init(&buffer, 8192); /* should avoid reallocs for the headers */
1532 strbuf_addf(&buffer, "tree %s\n", oid_to_hex(tree));
1535 * NOTE! This ordering means that the same exact tree merged with a
1536 * different order of parents will be a _different_ changeset even
1537 * if everything else stays the same.
1539 while (parents) {
1540 struct commit *parent = pop_commit(&parents);
1541 strbuf_addf(&buffer, "parent %s\n",
1542 oid_to_hex(&parent->object.oid));
1545 /* Person/date information */
1546 if (!author)
1547 author = git_author_info(IDENT_STRICT);
1548 strbuf_addf(&buffer, "author %s\n", author);
1549 if (!committer)
1550 committer = git_committer_info(IDENT_STRICT);
1551 strbuf_addf(&buffer, "committer %s\n", committer);
1552 if (!encoding_is_utf8)
1553 strbuf_addf(&buffer, "encoding %s\n", git_commit_encoding);
1555 while (extra) {
1556 add_extra_header(&buffer, extra);
1557 extra = extra->next;
1559 strbuf_addch(&buffer, '\n');
1561 /* And add the comment */
1562 strbuf_add(&buffer, msg, msg_len);
1564 /* And check the encoding */
1565 if (encoding_is_utf8 && !verify_utf8(&buffer))
1566 fprintf(stderr, _(commit_utf8_warn));
1568 if (sign_commit && sign_with_header(&buffer, sign_commit)) {
1569 result = -1;
1570 goto out;
1573 result = write_object_file(buffer.buf, buffer.len, OBJ_COMMIT, ret);
1574 out:
1575 strbuf_release(&buffer);
1576 return result;
1579 define_commit_slab(merge_desc_slab, struct merge_remote_desc *);
1580 static struct merge_desc_slab merge_desc_slab = COMMIT_SLAB_INIT(1, merge_desc_slab);
1582 struct merge_remote_desc *merge_remote_util(struct commit *commit)
1584 return *merge_desc_slab_at(&merge_desc_slab, commit);
1587 void set_merge_remote_desc(struct commit *commit,
1588 const char *name, struct object *obj)
1590 struct merge_remote_desc *desc;
1591 FLEX_ALLOC_STR(desc, name, name);
1592 desc->obj = obj;
1593 *merge_desc_slab_at(&merge_desc_slab, commit) = desc;
1596 struct commit *get_merge_parent(const char *name)
1598 struct object *obj;
1599 struct commit *commit;
1600 struct object_id oid;
1601 if (get_oid(name, &oid))
1602 return NULL;
1603 obj = parse_object(the_repository, &oid);
1604 commit = (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
1605 if (commit && !merge_remote_util(commit))
1606 set_merge_remote_desc(commit, name, obj);
1607 return commit;
1611 * Append a commit to the end of the commit_list.
1613 * next starts by pointing to the variable that holds the head of an
1614 * empty commit_list, and is updated to point to the "next" field of
1615 * the last item on the list as new commits are appended.
1617 * Usage example:
1619 * struct commit_list *list;
1620 * struct commit_list **next = &list;
1622 * next = commit_list_append(c1, next);
1623 * next = commit_list_append(c2, next);
1624 * assert(commit_list_count(list) == 2);
1625 * return list;
1627 struct commit_list **commit_list_append(struct commit *commit,
1628 struct commit_list **next)
1630 struct commit_list *new_commit = xmalloc(sizeof(struct commit_list));
1631 new_commit->item = commit;
1632 *next = new_commit;
1633 new_commit->next = NULL;
1634 return &new_commit->next;
1637 const char *find_header_mem(const char *msg, size_t len,
1638 const char *key, size_t *out_len)
1640 int key_len = strlen(key);
1641 const char *line = msg;
1644 * NEEDSWORK: It's possible for strchrnul() to scan beyond the range
1645 * given by len. However, current callers are safe because they compute
1646 * len by scanning a NUL-terminated block of memory starting at msg.
1647 * Nonetheless, it would be better to ensure the function does not look
1648 * at msg beyond the len provided by the caller.
1650 while (line && line < msg + len) {
1651 const char *eol = strchrnul(line, '\n');
1653 if (line == eol)
1654 return NULL;
1656 if (eol - line > key_len &&
1657 !strncmp(line, key, key_len) &&
1658 line[key_len] == ' ') {
1659 *out_len = eol - line - key_len - 1;
1660 return line + key_len + 1;
1662 line = *eol ? eol + 1 : NULL;
1664 return NULL;
1667 const char *find_commit_header(const char *msg, const char *key, size_t *out_len)
1669 return find_header_mem(msg, strlen(msg), key, out_len);
1672 * Inspect the given string and determine the true "end" of the log message, in
1673 * order to find where to put a new Signed-off-by trailer. Ignored are
1674 * trailing comment lines and blank lines. To support "git commit -s
1675 * --amend" on an existing commit, we also ignore "Conflicts:". To
1676 * support "git commit -v", we truncate at cut lines.
1678 * Returns the number of bytes from the tail to ignore, to be fed as
1679 * the second parameter to append_signoff().
1681 size_t ignore_non_trailer(const char *buf, size_t len)
1683 size_t boc = 0;
1684 size_t bol = 0;
1685 int in_old_conflicts_block = 0;
1686 size_t cutoff = wt_status_locate_end(buf, len);
1688 while (bol < cutoff) {
1689 const char *next_line = memchr(buf + bol, '\n', len - bol);
1691 if (!next_line)
1692 next_line = buf + len;
1693 else
1694 next_line++;
1696 if (buf[bol] == comment_line_char || buf[bol] == '\n') {
1697 /* is this the first of the run of comments? */
1698 if (!boc)
1699 boc = bol;
1700 /* otherwise, it is just continuing */
1701 } else if (starts_with(buf + bol, "Conflicts:\n")) {
1702 in_old_conflicts_block = 1;
1703 if (!boc)
1704 boc = bol;
1705 } else if (in_old_conflicts_block && buf[bol] == '\t') {
1706 ; /* a pathname in the conflicts block */
1707 } else if (boc) {
1708 /* the previous was not trailing comment */
1709 boc = 0;
1710 in_old_conflicts_block = 0;
1712 bol = next_line - buf;
1714 return boc ? len - boc : len - cutoff;
1717 int run_commit_hook(int editor_is_used, const char *index_file,
1718 int *invoked_hook, const char *name, ...)
1720 struct run_hooks_opt opt = RUN_HOOKS_OPT_INIT;
1721 va_list args;
1722 const char *arg;
1724 strvec_pushf(&opt.env, "GIT_INDEX_FILE=%s", index_file);
1727 * Let the hook know that no editor will be launched.
1729 if (!editor_is_used)
1730 strvec_push(&opt.env, "GIT_EDITOR=:");
1732 va_start(args, name);
1733 while ((arg = va_arg(args, const char *)))
1734 strvec_push(&opt.args, arg);
1735 va_end(args);
1737 opt.invoked_hook = invoked_hook;
1738 return run_hooks_opt(name, &opt);