Sync with maint
[git] / builtin / notes.c
1 /*
2  * Builtin "git notes"
3  *
4  * Copyright (c) 2010 Johan Herland <johan@herland.net>
5  *
6  * Based on git-notes.sh by Johannes Schindelin,
7  * and builtin/tag.c by Kristian Høgsberg and Carlos Rica.
8  */
9
10 #include "cache.h"
11 #include "config.h"
12 #include "builtin.h"
13 #include "notes.h"
14 #include "blob.h"
15 #include "commit.h"
16 #include "refs.h"
17 #include "exec_cmd.h"
18 #include "run-command.h"
19 #include "parse-options.h"
20 #include "string-list.h"
21 #include "notes-merge.h"
22 #include "notes-utils.h"
23 #include "worktree.h"
24
25 static const char * const git_notes_usage[] = {
26         N_("git notes [--ref <notes-ref>] [list [<object>]]"),
27         N_("git notes [--ref <notes-ref>] add [-f] [--allow-empty] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
28         N_("git notes [--ref <notes-ref>] copy [-f] <from-object> <to-object>"),
29         N_("git notes [--ref <notes-ref>] append [--allow-empty] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
30         N_("git notes [--ref <notes-ref>] edit [--allow-empty] [<object>]"),
31         N_("git notes [--ref <notes-ref>] show [<object>]"),
32         N_("git notes [--ref <notes-ref>] merge [-v | -q] [-s <strategy>] <notes-ref>"),
33         N_("git notes merge --commit [-v | -q]"),
34         N_("git notes merge --abort [-v | -q]"),
35         N_("git notes [--ref <notes-ref>] remove [<object>...]"),
36         N_("git notes [--ref <notes-ref>] prune [-n | -v]"),
37         N_("git notes [--ref <notes-ref>] get-ref"),
38         NULL
39 };
40
41 static const char * const git_notes_list_usage[] = {
42         N_("git notes [list [<object>]]"),
43         NULL
44 };
45
46 static const char * const git_notes_add_usage[] = {
47         N_("git notes add [<options>] [<object>]"),
48         NULL
49 };
50
51 static const char * const git_notes_copy_usage[] = {
52         N_("git notes copy [<options>] <from-object> <to-object>"),
53         N_("git notes copy --stdin [<from-object> <to-object>]..."),
54         NULL
55 };
56
57 static const char * const git_notes_append_usage[] = {
58         N_("git notes append [<options>] [<object>]"),
59         NULL
60 };
61
62 static const char * const git_notes_edit_usage[] = {
63         N_("git notes edit [<object>]"),
64         NULL
65 };
66
67 static const char * const git_notes_show_usage[] = {
68         N_("git notes show [<object>]"),
69         NULL
70 };
71
72 static const char * const git_notes_merge_usage[] = {
73         N_("git notes merge [<options>] <notes-ref>"),
74         N_("git notes merge --commit [<options>]"),
75         N_("git notes merge --abort [<options>]"),
76         NULL
77 };
78
79 static const char * const git_notes_remove_usage[] = {
80         N_("git notes remove [<object>]"),
81         NULL
82 };
83
84 static const char * const git_notes_prune_usage[] = {
85         N_("git notes prune [<options>]"),
86         NULL
87 };
88
89 static const char * const git_notes_get_ref_usage[] = {
90         N_("git notes get-ref"),
91         NULL
92 };
93
94 static const char note_template[] =
95         N_("Write/edit the notes for the following object:");
96
97 struct note_data {
98         int given;
99         int use_editor;
100         char *edit_path;
101         struct strbuf buf;
102 };
103
104 static void free_note_data(struct note_data *d)
105 {
106         if (d->edit_path) {
107                 unlink_or_warn(d->edit_path);
108                 free(d->edit_path);
109         }
110         strbuf_release(&d->buf);
111 }
112
113 static int list_each_note(const struct object_id *object_oid,
114                 const struct object_id *note_oid, char *note_path,
115                 void *cb_data)
116 {
117         printf("%s %s\n", oid_to_hex(note_oid), oid_to_hex(object_oid));
118         return 0;
119 }
120
121 static void copy_obj_to_fd(int fd, const unsigned char *sha1)
122 {
123         unsigned long size;
124         enum object_type type;
125         char *buf = read_sha1_file(sha1, &type, &size);
126         if (buf) {
127                 if (size)
128                         write_or_die(fd, buf, size);
129                 free(buf);
130         }
131 }
132
133 static void write_commented_object(int fd, const struct object_id *object)
134 {
135         const char *show_args[5] =
136                 {"show", "--stat", "--no-notes", oid_to_hex(object), NULL};
137         struct child_process show = CHILD_PROCESS_INIT;
138         struct strbuf buf = STRBUF_INIT;
139         struct strbuf cbuf = STRBUF_INIT;
140
141         /* Invoke "git show --stat --no-notes $object" */
142         show.argv = show_args;
143         show.no_stdin = 1;
144         show.out = -1;
145         show.err = 0;
146         show.git_cmd = 1;
147         if (start_command(&show))
148                 die(_("unable to start 'show' for object '%s'"),
149                     oid_to_hex(object));
150
151         if (strbuf_read(&buf, show.out, 0) < 0)
152                 die_errno(_("could not read 'show' output"));
153         strbuf_add_commented_lines(&cbuf, buf.buf, buf.len);
154         write_or_die(fd, cbuf.buf, cbuf.len);
155
156         strbuf_release(&cbuf);
157         strbuf_release(&buf);
158
159         if (finish_command(&show))
160                 die(_("failed to finish 'show' for object '%s'"),
161                     oid_to_hex(object));
162 }
163
164 static void prepare_note_data(const struct object_id *object, struct note_data *d,
165                 const unsigned char *old_note)
166 {
167         if (d->use_editor || !d->given) {
168                 int fd;
169                 struct strbuf buf = STRBUF_INIT;
170
171                 /* write the template message before editing: */
172                 d->edit_path = git_pathdup("NOTES_EDITMSG");
173                 fd = open(d->edit_path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
174                 if (fd < 0)
175                         die_errno(_("could not create file '%s'"), d->edit_path);
176
177                 if (d->given)
178                         write_or_die(fd, d->buf.buf, d->buf.len);
179                 else if (old_note)
180                         copy_obj_to_fd(fd, old_note);
181
182                 strbuf_addch(&buf, '\n');
183                 strbuf_add_commented_lines(&buf, "\n", strlen("\n"));
184                 strbuf_add_commented_lines(&buf, _(note_template), strlen(_(note_template)));
185                 strbuf_addch(&buf, '\n');
186                 write_or_die(fd, buf.buf, buf.len);
187
188                 write_commented_object(fd, object);
189
190                 close(fd);
191                 strbuf_release(&buf);
192                 strbuf_reset(&d->buf);
193
194                 if (launch_editor(d->edit_path, &d->buf, NULL)) {
195                         die(_("please supply the note contents using either -m or -F option"));
196                 }
197                 strbuf_stripspace(&d->buf, 1);
198         }
199 }
200
201 static void write_note_data(struct note_data *d, unsigned char *sha1)
202 {
203         if (write_sha1_file(d->buf.buf, d->buf.len, blob_type, sha1)) {
204                 error(_("unable to write note object"));
205                 if (d->edit_path)
206                         error(_("the note contents have been left in %s"),
207                                 d->edit_path);
208                 exit(128);
209         }
210 }
211
212 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
213 {
214         struct note_data *d = opt->value;
215
216         strbuf_grow(&d->buf, strlen(arg) + 2);
217         if (d->buf.len)
218                 strbuf_addch(&d->buf, '\n');
219         strbuf_addstr(&d->buf, arg);
220         strbuf_stripspace(&d->buf, 0);
221
222         d->given = 1;
223         return 0;
224 }
225
226 static int parse_file_arg(const struct option *opt, const char *arg, int unset)
227 {
228         struct note_data *d = opt->value;
229
230         if (d->buf.len)
231                 strbuf_addch(&d->buf, '\n');
232         if (!strcmp(arg, "-")) {
233                 if (strbuf_read(&d->buf, 0, 1024) < 0)
234                         die_errno(_("cannot read '%s'"), arg);
235         } else if (strbuf_read_file(&d->buf, arg, 1024) < 0)
236                 die_errno(_("could not open or read '%s'"), arg);
237         strbuf_stripspace(&d->buf, 0);
238
239         d->given = 1;
240         return 0;
241 }
242
243 static int parse_reuse_arg(const struct option *opt, const char *arg, int unset)
244 {
245         struct note_data *d = opt->value;
246         char *buf;
247         struct object_id object;
248         enum object_type type;
249         unsigned long len;
250
251         if (d->buf.len)
252                 strbuf_addch(&d->buf, '\n');
253
254         if (get_oid(arg, &object))
255                 die(_("failed to resolve '%s' as a valid ref."), arg);
256         if (!(buf = read_sha1_file(object.hash, &type, &len))) {
257                 free(buf);
258                 die(_("failed to read object '%s'."), arg);
259         }
260         if (type != OBJ_BLOB) {
261                 free(buf);
262                 die(_("cannot read note data from non-blob object '%s'."), arg);
263         }
264         strbuf_add(&d->buf, buf, len);
265         free(buf);
266
267         d->given = 1;
268         return 0;
269 }
270
271 static int parse_reedit_arg(const struct option *opt, const char *arg, int unset)
272 {
273         struct note_data *d = opt->value;
274         d->use_editor = 1;
275         return parse_reuse_arg(opt, arg, unset);
276 }
277
278 static int notes_copy_from_stdin(int force, const char *rewrite_cmd)
279 {
280         struct strbuf buf = STRBUF_INIT;
281         struct notes_rewrite_cfg *c = NULL;
282         struct notes_tree *t = NULL;
283         int ret = 0;
284         const char *msg = "Notes added by 'git notes copy'";
285
286         if (rewrite_cmd) {
287                 c = init_copy_notes_for_rewrite(rewrite_cmd);
288                 if (!c)
289                         return 0;
290         } else {
291                 init_notes(NULL, NULL, NULL, NOTES_INIT_WRITABLE);
292                 t = &default_notes_tree;
293         }
294
295         while (strbuf_getline_lf(&buf, stdin) != EOF) {
296                 struct object_id from_obj, to_obj;
297                 struct strbuf **split;
298                 int err;
299
300                 split = strbuf_split(&buf, ' ');
301                 if (!split[0] || !split[1])
302                         die(_("malformed input line: '%s'."), buf.buf);
303                 strbuf_rtrim(split[0]);
304                 strbuf_rtrim(split[1]);
305                 if (get_oid(split[0]->buf, &from_obj))
306                         die(_("failed to resolve '%s' as a valid ref."), split[0]->buf);
307                 if (get_oid(split[1]->buf, &to_obj))
308                         die(_("failed to resolve '%s' as a valid ref."), split[1]->buf);
309
310                 if (rewrite_cmd)
311                         err = copy_note_for_rewrite(c, &from_obj, &to_obj);
312                 else
313                         err = copy_note(t, &from_obj, &to_obj, force,
314                                         combine_notes_overwrite);
315
316                 if (err) {
317                         error(_("failed to copy notes from '%s' to '%s'"),
318                               split[0]->buf, split[1]->buf);
319                         ret = 1;
320                 }
321
322                 strbuf_list_free(split);
323         }
324
325         if (!rewrite_cmd) {
326                 commit_notes(t, msg);
327                 free_notes(t);
328         } else {
329                 finish_copy_notes_for_rewrite(c, msg);
330         }
331         strbuf_release(&buf);
332         return ret;
333 }
334
335 static struct notes_tree *init_notes_check(const char *subcommand,
336                                            int flags)
337 {
338         struct notes_tree *t;
339         const char *ref;
340         init_notes(NULL, NULL, NULL, flags);
341         t = &default_notes_tree;
342
343         ref = (flags & NOTES_INIT_WRITABLE) ? t->update_ref : t->ref;
344         if (!starts_with(ref, "refs/notes/"))
345                 /*
346                  * TRANSLATORS: the first %s will be replaced by a git
347                  * notes command: 'add', 'merge', 'remove', etc.
348                  */
349                 die(_("refusing to %s notes in %s (outside of refs/notes/)"),
350                     subcommand, ref);
351         return t;
352 }
353
354 static int list(int argc, const char **argv, const char *prefix)
355 {
356         struct notes_tree *t;
357         struct object_id object;
358         const struct object_id *note;
359         int retval = -1;
360         struct option options[] = {
361                 OPT_END()
362         };
363
364         if (argc)
365                 argc = parse_options(argc, argv, prefix, options,
366                                      git_notes_list_usage, 0);
367
368         if (1 < argc) {
369                 error(_("too many parameters"));
370                 usage_with_options(git_notes_list_usage, options);
371         }
372
373         t = init_notes_check("list", 0);
374         if (argc) {
375                 if (get_oid(argv[0], &object))
376                         die(_("failed to resolve '%s' as a valid ref."), argv[0]);
377                 note = get_note(t, &object);
378                 if (note) {
379                         puts(oid_to_hex(note));
380                         retval = 0;
381                 } else
382                         retval = error(_("no note found for object %s."),
383                                        oid_to_hex(&object));
384         } else
385                 retval = for_each_note(t, 0, list_each_note, NULL);
386
387         free_notes(t);
388         return retval;
389 }
390
391 static int append_edit(int argc, const char **argv, const char *prefix);
392
393 static int add(int argc, const char **argv, const char *prefix)
394 {
395         int force = 0, allow_empty = 0;
396         const char *object_ref;
397         struct notes_tree *t;
398         struct object_id object, new_note;
399         const struct object_id *note;
400         struct note_data d = { 0, 0, NULL, STRBUF_INIT };
401         struct option options[] = {
402                 { OPTION_CALLBACK, 'm', "message", &d, N_("message"),
403                         N_("note contents as a string"), PARSE_OPT_NONEG,
404                         parse_msg_arg},
405                 { OPTION_CALLBACK, 'F', "file", &d, N_("file"),
406                         N_("note contents in a file"), PARSE_OPT_NONEG,
407                         parse_file_arg},
408                 { OPTION_CALLBACK, 'c', "reedit-message", &d, N_("object"),
409                         N_("reuse and edit specified note object"), PARSE_OPT_NONEG,
410                         parse_reedit_arg},
411                 { OPTION_CALLBACK, 'C', "reuse-message", &d, N_("object"),
412                         N_("reuse specified note object"), PARSE_OPT_NONEG,
413                         parse_reuse_arg},
414                 OPT_BOOL(0, "allow-empty", &allow_empty,
415                         N_("allow storing empty note")),
416                 OPT__FORCE(&force, N_("replace existing notes")),
417                 OPT_END()
418         };
419
420         argc = parse_options(argc, argv, prefix, options, git_notes_add_usage,
421                              PARSE_OPT_KEEP_ARGV0);
422
423         if (2 < argc) {
424                 error(_("too many parameters"));
425                 usage_with_options(git_notes_add_usage, options);
426         }
427
428         object_ref = argc > 1 ? argv[1] : "HEAD";
429
430         if (get_oid(object_ref, &object))
431                 die(_("failed to resolve '%s' as a valid ref."), object_ref);
432
433         t = init_notes_check("add", NOTES_INIT_WRITABLE);
434         note = get_note(t, &object);
435
436         if (note) {
437                 if (!force) {
438                         free_notes(t);
439                         if (d.given) {
440                                 free_note_data(&d);
441                                 return error(_("Cannot add notes. "
442                                         "Found existing notes for object %s. "
443                                         "Use '-f' to overwrite existing notes"),
444                                         oid_to_hex(&object));
445                         }
446                         /*
447                          * Redirect to "edit" subcommand.
448                          *
449                          * We only end up here if none of -m/-F/-c/-C or -f are
450                          * given. The original args are therefore still in
451                          * argv[0-1].
452                          */
453                         argv[0] = "edit";
454                         return append_edit(argc, argv, prefix);
455                 }
456                 fprintf(stderr, _("Overwriting existing notes for object %s\n"),
457                         oid_to_hex(&object));
458         }
459
460         prepare_note_data(&object, &d, note ? note->hash : NULL);
461         if (d.buf.len || allow_empty) {
462                 write_note_data(&d, new_note.hash);
463                 if (add_note(t, &object, &new_note, combine_notes_overwrite))
464                         die("BUG: combine_notes_overwrite failed");
465                 commit_notes(t, "Notes added by 'git notes add'");
466         } else {
467                 fprintf(stderr, _("Removing note for object %s\n"),
468                         oid_to_hex(&object));
469                 remove_note(t, object.hash);
470                 commit_notes(t, "Notes removed by 'git notes add'");
471         }
472
473         free_note_data(&d);
474         free_notes(t);
475         return 0;
476 }
477
478 static int copy(int argc, const char **argv, const char *prefix)
479 {
480         int retval = 0, force = 0, from_stdin = 0;
481         const struct object_id *from_note, *note;
482         const char *object_ref;
483         struct object_id object, from_obj;
484         struct notes_tree *t;
485         const char *rewrite_cmd = NULL;
486         struct option options[] = {
487                 OPT__FORCE(&force, N_("replace existing notes")),
488                 OPT_BOOL(0, "stdin", &from_stdin, N_("read objects from stdin")),
489                 OPT_STRING(0, "for-rewrite", &rewrite_cmd, N_("command"),
490                            N_("load rewriting config for <command> (implies "
491                               "--stdin)")),
492                 OPT_END()
493         };
494
495         argc = parse_options(argc, argv, prefix, options, git_notes_copy_usage,
496                              0);
497
498         if (from_stdin || rewrite_cmd) {
499                 if (argc) {
500                         error(_("too many parameters"));
501                         usage_with_options(git_notes_copy_usage, options);
502                 } else {
503                         return notes_copy_from_stdin(force, rewrite_cmd);
504                 }
505         }
506
507         if (argc < 2) {
508                 error(_("too few parameters"));
509                 usage_with_options(git_notes_copy_usage, options);
510         }
511         if (2 < argc) {
512                 error(_("too many parameters"));
513                 usage_with_options(git_notes_copy_usage, options);
514         }
515
516         if (get_oid(argv[0], &from_obj))
517                 die(_("failed to resolve '%s' as a valid ref."), argv[0]);
518
519         object_ref = 1 < argc ? argv[1] : "HEAD";
520
521         if (get_oid(object_ref, &object))
522                 die(_("failed to resolve '%s' as a valid ref."), object_ref);
523
524         t = init_notes_check("copy", NOTES_INIT_WRITABLE);
525         note = get_note(t, &object);
526
527         if (note) {
528                 if (!force) {
529                         retval = error(_("Cannot copy notes. Found existing "
530                                        "notes for object %s. Use '-f' to "
531                                        "overwrite existing notes"),
532                                        oid_to_hex(&object));
533                         goto out;
534                 }
535                 fprintf(stderr, _("Overwriting existing notes for object %s\n"),
536                         oid_to_hex(&object));
537         }
538
539         from_note = get_note(t, &from_obj);
540         if (!from_note) {
541                 retval = error(_("missing notes on source object %s. Cannot "
542                                "copy."), oid_to_hex(&from_obj));
543                 goto out;
544         }
545
546         if (add_note(t, &object, from_note, combine_notes_overwrite))
547                 die("BUG: combine_notes_overwrite failed");
548         commit_notes(t, "Notes added by 'git notes copy'");
549 out:
550         free_notes(t);
551         return retval;
552 }
553
554 static int append_edit(int argc, const char **argv, const char *prefix)
555 {
556         int allow_empty = 0;
557         const char *object_ref;
558         struct notes_tree *t;
559         struct object_id object, new_note;
560         const struct object_id *note;
561         char *logmsg;
562         const char * const *usage;
563         struct note_data d = { 0, 0, NULL, STRBUF_INIT };
564         struct option options[] = {
565                 { OPTION_CALLBACK, 'm', "message", &d, N_("message"),
566                         N_("note contents as a string"), PARSE_OPT_NONEG,
567                         parse_msg_arg},
568                 { OPTION_CALLBACK, 'F', "file", &d, N_("file"),
569                         N_("note contents in a file"), PARSE_OPT_NONEG,
570                         parse_file_arg},
571                 { OPTION_CALLBACK, 'c', "reedit-message", &d, N_("object"),
572                         N_("reuse and edit specified note object"), PARSE_OPT_NONEG,
573                         parse_reedit_arg},
574                 { OPTION_CALLBACK, 'C', "reuse-message", &d, N_("object"),
575                         N_("reuse specified note object"), PARSE_OPT_NONEG,
576                         parse_reuse_arg},
577                 OPT_BOOL(0, "allow-empty", &allow_empty,
578                         N_("allow storing empty note")),
579                 OPT_END()
580         };
581         int edit = !strcmp(argv[0], "edit");
582
583         usage = edit ? git_notes_edit_usage : git_notes_append_usage;
584         argc = parse_options(argc, argv, prefix, options, usage,
585                              PARSE_OPT_KEEP_ARGV0);
586
587         if (2 < argc) {
588                 error(_("too many parameters"));
589                 usage_with_options(usage, options);
590         }
591
592         if (d.given && edit)
593                 fprintf(stderr, _("The -m/-F/-c/-C options have been deprecated "
594                         "for the 'edit' subcommand.\n"
595                         "Please use 'git notes add -f -m/-F/-c/-C' instead.\n"));
596
597         object_ref = 1 < argc ? argv[1] : "HEAD";
598
599         if (get_oid(object_ref, &object))
600                 die(_("failed to resolve '%s' as a valid ref."), object_ref);
601
602         t = init_notes_check(argv[0], NOTES_INIT_WRITABLE);
603         note = get_note(t, &object);
604
605         prepare_note_data(&object, &d, edit && note ? note->hash : NULL);
606
607         if (note && !edit) {
608                 /* Append buf to previous note contents */
609                 unsigned long size;
610                 enum object_type type;
611                 char *prev_buf = read_sha1_file(note->hash, &type, &size);
612
613                 strbuf_grow(&d.buf, size + 1);
614                 if (d.buf.len && prev_buf && size)
615                         strbuf_insert(&d.buf, 0, "\n", 1);
616                 if (prev_buf && size)
617                         strbuf_insert(&d.buf, 0, prev_buf, size);
618                 free(prev_buf);
619         }
620
621         if (d.buf.len || allow_empty) {
622                 write_note_data(&d, new_note.hash);
623                 if (add_note(t, &object, &new_note, combine_notes_overwrite))
624                         die("BUG: combine_notes_overwrite failed");
625                 logmsg = xstrfmt("Notes added by 'git notes %s'", argv[0]);
626         } else {
627                 fprintf(stderr, _("Removing note for object %s\n"),
628                         oid_to_hex(&object));
629                 remove_note(t, object.hash);
630                 logmsg = xstrfmt("Notes removed by 'git notes %s'", argv[0]);
631         }
632         commit_notes(t, logmsg);
633
634         free(logmsg);
635         free_note_data(&d);
636         free_notes(t);
637         return 0;
638 }
639
640 static int show(int argc, const char **argv, const char *prefix)
641 {
642         const char *object_ref;
643         struct notes_tree *t;
644         struct object_id object;
645         const struct object_id *note;
646         int retval;
647         struct option options[] = {
648                 OPT_END()
649         };
650
651         argc = parse_options(argc, argv, prefix, options, git_notes_show_usage,
652                              0);
653
654         if (1 < argc) {
655                 error(_("too many parameters"));
656                 usage_with_options(git_notes_show_usage, options);
657         }
658
659         object_ref = argc ? argv[0] : "HEAD";
660
661         if (get_oid(object_ref, &object))
662                 die(_("failed to resolve '%s' as a valid ref."), object_ref);
663
664         t = init_notes_check("show", 0);
665         note = get_note(t, &object);
666
667         if (!note)
668                 retval = error(_("no note found for object %s."),
669                                oid_to_hex(&object));
670         else {
671                 const char *show_args[3] = {"show", oid_to_hex(note), NULL};
672                 retval = execv_git_cmd(show_args);
673         }
674         free_notes(t);
675         return retval;
676 }
677
678 static int merge_abort(struct notes_merge_options *o)
679 {
680         int ret = 0;
681
682         /*
683          * Remove .git/NOTES_MERGE_PARTIAL and .git/NOTES_MERGE_REF, and call
684          * notes_merge_abort() to remove .git/NOTES_MERGE_WORKTREE.
685          */
686
687         if (delete_ref(NULL, "NOTES_MERGE_PARTIAL", NULL, 0))
688                 ret += error(_("failed to delete ref NOTES_MERGE_PARTIAL"));
689         if (delete_ref(NULL, "NOTES_MERGE_REF", NULL, REF_NODEREF))
690                 ret += error(_("failed to delete ref NOTES_MERGE_REF"));
691         if (notes_merge_abort(o))
692                 ret += error(_("failed to remove 'git notes merge' worktree"));
693         return ret;
694 }
695
696 static int merge_commit(struct notes_merge_options *o)
697 {
698         struct strbuf msg = STRBUF_INIT;
699         struct object_id oid, parent_oid;
700         struct notes_tree *t;
701         struct commit *partial;
702         struct pretty_print_context pretty_ctx;
703         void *local_ref_to_free;
704         int ret;
705
706         /*
707          * Read partial merge result from .git/NOTES_MERGE_PARTIAL,
708          * and target notes ref from .git/NOTES_MERGE_REF.
709          */
710
711         if (get_oid("NOTES_MERGE_PARTIAL", &oid))
712                 die(_("failed to read ref NOTES_MERGE_PARTIAL"));
713         else if (!(partial = lookup_commit_reference(&oid)))
714                 die(_("could not find commit from NOTES_MERGE_PARTIAL."));
715         else if (parse_commit(partial))
716                 die(_("could not parse commit from NOTES_MERGE_PARTIAL."));
717
718         if (partial->parents)
719                 oidcpy(&parent_oid, &partial->parents->item->object.oid);
720         else
721                 oidclr(&parent_oid);
722
723         t = xcalloc(1, sizeof(struct notes_tree));
724         init_notes(t, "NOTES_MERGE_PARTIAL", combine_notes_overwrite, 0);
725
726         o->local_ref = local_ref_to_free =
727                 resolve_refdup("NOTES_MERGE_REF", 0, oid.hash, NULL);
728         if (!o->local_ref)
729                 die(_("failed to resolve NOTES_MERGE_REF"));
730
731         if (notes_merge_commit(o, t, partial, &oid))
732                 die(_("failed to finalize notes merge"));
733
734         /* Reuse existing commit message in reflog message */
735         memset(&pretty_ctx, 0, sizeof(pretty_ctx));
736         format_commit_message(partial, "%s", &msg, &pretty_ctx);
737         strbuf_trim(&msg);
738         strbuf_insert(&msg, 0, "notes: ", 7);
739         update_ref(msg.buf, o->local_ref, oid.hash,
740                    is_null_oid(&parent_oid) ? NULL : parent_oid.hash,
741                    0, UPDATE_REFS_DIE_ON_ERR);
742
743         free_notes(t);
744         strbuf_release(&msg);
745         ret = merge_abort(o);
746         free(local_ref_to_free);
747         return ret;
748 }
749
750 static int git_config_get_notes_strategy(const char *key,
751                                          enum notes_merge_strategy *strategy)
752 {
753         char *value;
754
755         if (git_config_get_string(key, &value))
756                 return 1;
757         if (parse_notes_merge_strategy(value, strategy))
758                 git_die_config(key, _("unknown notes merge strategy %s"), value);
759
760         free(value);
761         return 0;
762 }
763
764 static int merge(int argc, const char **argv, const char *prefix)
765 {
766         struct strbuf remote_ref = STRBUF_INIT, msg = STRBUF_INIT;
767         struct object_id result_oid;
768         struct notes_tree *t;
769         struct notes_merge_options o;
770         int do_merge = 0, do_commit = 0, do_abort = 0;
771         int verbosity = 0, result;
772         const char *strategy = NULL;
773         struct option options[] = {
774                 OPT_GROUP(N_("General options")),
775                 OPT__VERBOSITY(&verbosity),
776                 OPT_GROUP(N_("Merge options")),
777                 OPT_STRING('s', "strategy", &strategy, N_("strategy"),
778                            N_("resolve notes conflicts using the given strategy "
779                               "(manual/ours/theirs/union/cat_sort_uniq)")),
780                 OPT_GROUP(N_("Committing unmerged notes")),
781                 { OPTION_SET_INT, 0, "commit", &do_commit, NULL,
782                         N_("finalize notes merge by committing unmerged notes"),
783                         PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, 1},
784                 OPT_GROUP(N_("Aborting notes merge resolution")),
785                 { OPTION_SET_INT, 0, "abort", &do_abort, NULL,
786                         N_("abort notes merge"),
787                         PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, 1},
788                 OPT_END()
789         };
790
791         argc = parse_options(argc, argv, prefix, options,
792                              git_notes_merge_usage, 0);
793
794         if (strategy || do_commit + do_abort == 0)
795                 do_merge = 1;
796         if (do_merge + do_commit + do_abort != 1) {
797                 error(_("cannot mix --commit, --abort or -s/--strategy"));
798                 usage_with_options(git_notes_merge_usage, options);
799         }
800
801         if (do_merge && argc != 1) {
802                 error(_("must specify a notes ref to merge"));
803                 usage_with_options(git_notes_merge_usage, options);
804         } else if (!do_merge && argc) {
805                 error(_("too many parameters"));
806                 usage_with_options(git_notes_merge_usage, options);
807         }
808
809         init_notes_merge_options(&o);
810         o.verbosity = verbosity + NOTES_MERGE_VERBOSITY_DEFAULT;
811
812         if (do_abort)
813                 return merge_abort(&o);
814         if (do_commit)
815                 return merge_commit(&o);
816
817         o.local_ref = default_notes_ref();
818         strbuf_addstr(&remote_ref, argv[0]);
819         expand_loose_notes_ref(&remote_ref);
820         o.remote_ref = remote_ref.buf;
821
822         t = init_notes_check("merge", NOTES_INIT_WRITABLE);
823
824         if (strategy) {
825                 if (parse_notes_merge_strategy(strategy, &o.strategy)) {
826                         error(_("unknown -s/--strategy: %s"), strategy);
827                         usage_with_options(git_notes_merge_usage, options);
828                 }
829         } else {
830                 struct strbuf merge_key = STRBUF_INIT;
831                 const char *short_ref = NULL;
832
833                 if (!skip_prefix(o.local_ref, "refs/notes/", &short_ref))
834                         die("BUG: local ref %s is outside of refs/notes/",
835                             o.local_ref);
836
837                 strbuf_addf(&merge_key, "notes.%s.mergeStrategy", short_ref);
838
839                 if (git_config_get_notes_strategy(merge_key.buf, &o.strategy))
840                         git_config_get_notes_strategy("notes.mergeStrategy", &o.strategy);
841
842                 strbuf_release(&merge_key);
843         }
844
845         strbuf_addf(&msg, "notes: Merged notes from %s into %s",
846                     remote_ref.buf, default_notes_ref());
847         strbuf_add(&(o.commit_msg), msg.buf + 7, msg.len - 7); /* skip "notes: " */
848
849         result = notes_merge(&o, t, &result_oid);
850
851         if (result >= 0) /* Merge resulted (trivially) in result_oid */
852                 /* Update default notes ref with new commit */
853                 update_ref(msg.buf, default_notes_ref(), result_oid.hash, NULL,
854                            0, UPDATE_REFS_DIE_ON_ERR);
855         else { /* Merge has unresolved conflicts */
856                 const struct worktree *wt;
857                 /* Update .git/NOTES_MERGE_PARTIAL with partial merge result */
858                 update_ref(msg.buf, "NOTES_MERGE_PARTIAL", result_oid.hash, NULL,
859                            0, UPDATE_REFS_DIE_ON_ERR);
860                 /* Store ref-to-be-updated into .git/NOTES_MERGE_REF */
861                 wt = find_shared_symref("NOTES_MERGE_REF", default_notes_ref());
862                 if (wt)
863                         die(_("a notes merge into %s is already in-progress at %s"),
864                             default_notes_ref(), wt->path);
865                 if (create_symref("NOTES_MERGE_REF", default_notes_ref(), NULL))
866                         die(_("failed to store link to current notes ref (%s)"),
867                             default_notes_ref());
868                 printf(_("Automatic notes merge failed. Fix conflicts in %s and "
869                          "commit the result with 'git notes merge --commit', or "
870                          "abort the merge with 'git notes merge --abort'.\n"),
871                        git_path(NOTES_MERGE_WORKTREE));
872         }
873
874         free_notes(t);
875         strbuf_release(&remote_ref);
876         strbuf_release(&msg);
877         return result < 0; /* return non-zero on conflicts */
878 }
879
880 #define IGNORE_MISSING 1
881
882 static int remove_one_note(struct notes_tree *t, const char *name, unsigned flag)
883 {
884         int status;
885         struct object_id oid;
886         if (get_oid(name, &oid))
887                 return error(_("Failed to resolve '%s' as a valid ref."), name);
888         status = remove_note(t, oid.hash);
889         if (status)
890                 fprintf(stderr, _("Object %s has no note\n"), name);
891         else
892                 fprintf(stderr, _("Removing note for object %s\n"), name);
893         return (flag & IGNORE_MISSING) ? 0 : status;
894 }
895
896 static int remove_cmd(int argc, const char **argv, const char *prefix)
897 {
898         unsigned flag = 0;
899         int from_stdin = 0;
900         struct option options[] = {
901                 OPT_BIT(0, "ignore-missing", &flag,
902                         N_("attempt to remove non-existent note is not an error"),
903                         IGNORE_MISSING),
904                 OPT_BOOL(0, "stdin", &from_stdin,
905                             N_("read object names from the standard input")),
906                 OPT_END()
907         };
908         struct notes_tree *t;
909         int retval = 0;
910
911         argc = parse_options(argc, argv, prefix, options,
912                              git_notes_remove_usage, 0);
913
914         t = init_notes_check("remove", NOTES_INIT_WRITABLE);
915
916         if (!argc && !from_stdin) {
917                 retval = remove_one_note(t, "HEAD", flag);
918         } else {
919                 while (*argv) {
920                         retval |= remove_one_note(t, *argv, flag);
921                         argv++;
922                 }
923         }
924         if (from_stdin) {
925                 struct strbuf sb = STRBUF_INIT;
926                 while (strbuf_getwholeline(&sb, stdin, '\n') != EOF) {
927                         strbuf_rtrim(&sb);
928                         retval |= remove_one_note(t, sb.buf, flag);
929                 }
930                 strbuf_release(&sb);
931         }
932         if (!retval)
933                 commit_notes(t, "Notes removed by 'git notes remove'");
934         free_notes(t);
935         return retval;
936 }
937
938 static int prune(int argc, const char **argv, const char *prefix)
939 {
940         struct notes_tree *t;
941         int show_only = 0, verbose = 0;
942         struct option options[] = {
943                 OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
944                 OPT__VERBOSE(&verbose, N_("report pruned notes")),
945                 OPT_END()
946         };
947
948         argc = parse_options(argc, argv, prefix, options, git_notes_prune_usage,
949                              0);
950
951         if (argc) {
952                 error(_("too many parameters"));
953                 usage_with_options(git_notes_prune_usage, options);
954         }
955
956         t = init_notes_check("prune", NOTES_INIT_WRITABLE);
957
958         prune_notes(t, (verbose ? NOTES_PRUNE_VERBOSE : 0) |
959                 (show_only ? NOTES_PRUNE_VERBOSE|NOTES_PRUNE_DRYRUN : 0) );
960         if (!show_only)
961                 commit_notes(t, "Notes removed by 'git notes prune'");
962         free_notes(t);
963         return 0;
964 }
965
966 static int get_ref(int argc, const char **argv, const char *prefix)
967 {
968         struct option options[] = { OPT_END() };
969         argc = parse_options(argc, argv, prefix, options,
970                              git_notes_get_ref_usage, 0);
971
972         if (argc) {
973                 error(_("too many parameters"));
974                 usage_with_options(git_notes_get_ref_usage, options);
975         }
976
977         puts(default_notes_ref());
978         return 0;
979 }
980
981 int cmd_notes(int argc, const char **argv, const char *prefix)
982 {
983         int result;
984         const char *override_notes_ref = NULL;
985         struct option options[] = {
986                 OPT_STRING(0, "ref", &override_notes_ref, N_("notes-ref"),
987                            N_("use notes from <notes-ref>")),
988                 OPT_END()
989         };
990
991         git_config(git_default_config, NULL);
992         argc = parse_options(argc, argv, prefix, options, git_notes_usage,
993                              PARSE_OPT_STOP_AT_NON_OPTION);
994
995         if (override_notes_ref) {
996                 struct strbuf sb = STRBUF_INIT;
997                 strbuf_addstr(&sb, override_notes_ref);
998                 expand_notes_ref(&sb);
999                 setenv("GIT_NOTES_REF", sb.buf, 1);
1000                 strbuf_release(&sb);
1001         }
1002
1003         if (argc < 1 || !strcmp(argv[0], "list"))
1004                 result = list(argc, argv, prefix);
1005         else if (!strcmp(argv[0], "add"))
1006                 result = add(argc, argv, prefix);
1007         else if (!strcmp(argv[0], "copy"))
1008                 result = copy(argc, argv, prefix);
1009         else if (!strcmp(argv[0], "append") || !strcmp(argv[0], "edit"))
1010                 result = append_edit(argc, argv, prefix);
1011         else if (!strcmp(argv[0], "show"))
1012                 result = show(argc, argv, prefix);
1013         else if (!strcmp(argv[0], "merge"))
1014                 result = merge(argc, argv, prefix);
1015         else if (!strcmp(argv[0], "remove"))
1016                 result = remove_cmd(argc, argv, prefix);
1017         else if (!strcmp(argv[0], "prune"))
1018                 result = prune(argc, argv, prefix);
1019         else if (!strcmp(argv[0], "get-ref"))
1020                 result = get_ref(argc, argv, prefix);
1021         else {
1022                 result = error(_("unknown subcommand: %s"), argv[0]);
1023                 usage_with_options(git_notes_usage, options);
1024         }
1025
1026         return result ? 1 : 0;
1027 }