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