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