[thirdparty/git.git] / builtin-notes.c

/*
 * Builtin "git notes"
 *
 * Copyright (c) 2010 Johan Herland <johan@herland.net>
 *
 * Based on git-notes.sh by Johannes Schindelin,
 * and builtin-tag.c by Kristian Høgsberg and Carlos Rica.
 */

#include "cache.h"
#include "builtin.h"
#include "notes.h"
#include "blob.h"
#include "commit.h"
#include "refs.h"
#include "exec_cmd.h"
#include "run-command.h"
#include "parse-options.h"

static const char * const git_notes_usage[] = {
	"git notes [list [<object>]]",
	"git notes add [-f] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]",
	"git notes copy [-f] <from-object> <to-object>",
	"git notes append [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]",
	"git notes edit [<object>]",
	"git notes show [<object>]",
	"git notes remove [<object>]",
	"git notes prune",
	NULL
};

static const char note_template[] =
	"\n"
	"#\n"
	"# Write/edit the notes for the following object:\n"
	"#\n";

struct msg_arg {
	int given;
	int use_editor;
	struct strbuf buf;
};

static int list_each_note(const unsigned char *object_sha1,
		const unsigned char *note_sha1, char *note_path,
		void *cb_data)
{
	printf("%s %s\n", sha1_to_hex(note_sha1), sha1_to_hex(object_sha1));
	return 0;
}

static void write_note_data(int fd, const unsigned char *sha1)
{
	unsigned long size;
	enum object_type type;
	char *buf = read_sha1_file(sha1, &type, &size);
	if (buf) {
		if (size)
			write_or_die(fd, buf, size);
		free(buf);
	}
}

static void write_commented_object(int fd, const unsigned char *object)
{
	const char *show_args[5] =
		{"show", "--stat", "--no-notes", sha1_to_hex(object), NULL};
	struct child_process show;
	struct strbuf buf = STRBUF_INIT;
	FILE *show_out;

	/* Invoke "git show --stat --no-notes $object" */
	memset(&show, 0, sizeof(show));
	show.argv = show_args;
	show.no_stdin = 1;
	show.out = -1;
	show.err = 0;
	show.git_cmd = 1;
	if (start_command(&show))
		die("unable to start 'show' for object '%s'",
		    sha1_to_hex(object));

	/* Open the output as FILE* so strbuf_getline() can be used. */
	show_out = xfdopen(show.out, "r");
	if (show_out == NULL)
		die_errno("can't fdopen 'show' output fd");

	/* Prepend "# " to each output line and write result to 'fd' */
	while (strbuf_getline(&buf, show_out, '\n') != EOF) {
		write_or_die(fd, "# ", 2);
		write_or_die(fd, buf.buf, buf.len);
		write_or_die(fd, "\n", 1);
	}
	strbuf_release(&buf);
	if (fclose(show_out))
		die_errno("failed to close pipe to 'show' for object '%s'",
			  sha1_to_hex(object));
	if (finish_command(&show))
		die("failed to finish 'show' for object '%s'",
		    sha1_to_hex(object));
}

static void create_note(const unsigned char *object, struct msg_arg *msg,
			int append_only, const unsigned char *prev,
			unsigned char *result)
{
	char *path = NULL;

	if (msg->use_editor || !msg->given) {
		int fd;

		/* write the template message before editing: */
		path = git_pathdup("NOTES_EDITMSG");
		fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
		if (fd < 0)
			die_errno("could not create file '%s'", path);

		if (msg->given)
			write_or_die(fd, msg->buf.buf, msg->buf.len);
		else if (prev && !append_only)
			write_note_data(fd, prev);
		write_or_die(fd, note_template, strlen(note_template));

		write_commented_object(fd, object);

		close(fd);
		strbuf_reset(&(msg->buf));

		if (launch_editor(path, &(msg->buf), NULL)) {
			die("Please supply the note contents using either -m" \
			    " or -F option");
		}
		stripspace(&(msg->buf), 1);
	}

	if (prev && append_only) {
		/* Append buf to previous note contents */
		unsigned long size;
		enum object_type type;
		char *prev_buf = read_sha1_file(prev, &type, &size);

		strbuf_grow(&(msg->buf), size + 1);
		if (msg->buf.len && prev_buf && size)
			strbuf_insert(&(msg->buf), 0, "\n", 1);
		if (prev_buf && size)
			strbuf_insert(&(msg->buf), 0, prev_buf, size);
		free(prev_buf);
	}

	if (!msg->buf.len) {
		fprintf(stderr, "Removing note for object %s\n",
			sha1_to_hex(object));
		hashclr(result);
	} else {
		if (write_sha1_file(msg->buf.buf, msg->buf.len, blob_type, result)) {
			error("unable to write note object");
			if (path)
				error("The note contents has been left in %s",
				      path);
			exit(128);
		}
	}

	if (path) {
		unlink_or_warn(path);
		free(path);
	}
}

static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
{
	struct msg_arg *msg = opt->value;

	if (!arg)
		return -1;

	strbuf_grow(&(msg->buf), strlen(arg) + 2);
	if (msg->buf.len)
		strbuf_addstr(&(msg->buf), "\n");
	strbuf_addstr(&(msg->buf), arg);
	stripspace(&(msg->buf), 0);

	msg->given = 1;
	return 0;
}

static int parse_file_arg(const struct option *opt, const char *arg, int unset)
{
	struct msg_arg *msg = opt->value;

	if (!arg)
		return -1;

	if (msg->buf.len)
		strbuf_addstr(&(msg->buf), "\n");
	if (!strcmp(arg, "-")) {
		if (strbuf_read(&(msg->buf), 0, 1024) < 0)
			die_errno("cannot read '%s'", arg);
	} else if (strbuf_read_file(&(msg->buf), arg, 1024) < 0)
		die_errno("could not open or read '%s'", arg);
	stripspace(&(msg->buf), 0);

	msg->given = 1;
	return 0;
}

static int parse_reuse_arg(const struct option *opt, const char *arg, int unset)
{
	struct msg_arg *msg = opt->value;
	char *buf;
	unsigned char object[20];
	enum object_type type;
	unsigned long len;

	if (!arg)
		return -1;

	if (msg->buf.len)
		strbuf_addstr(&(msg->buf), "\n");

	if (get_sha1(arg, object))
		die("Failed to resolve '%s' as a valid ref.", arg);
	if (!(buf = read_sha1_file(object, &type, &len)) || !len) {
		free(buf);
		die("Failed to read object '%s'.", arg);;
	}
	strbuf_add(&(msg->buf), buf, len);
	free(buf);

	msg->given = 1;
	return 0;
}

static int parse_reedit_arg(const struct option *opt, const char *arg, int unset)
{
	struct msg_arg *msg = opt->value;
	msg->use_editor = 1;
	return parse_reuse_arg(opt, arg, unset);
}

int commit_notes(struct notes_tree *t, const char *msg)
{
	struct commit_list *parent;
	unsigned char tree_sha1[20], prev_commit[20], new_commit[20];
	struct strbuf buf = STRBUF_INIT;

	if (!t)
		t = &default_notes_tree;
	if (!t->initialized || !t->ref || !*t->ref)
		die("Cannot commit uninitialized/unreferenced notes tree");

	/* Prepare commit message and reflog message */
	strbuf_addstr(&buf, "notes: "); /* commit message starts at index 7 */
	strbuf_addstr(&buf, msg);
	if (buf.buf[buf.len - 1] != '\n')
		strbuf_addch(&buf, '\n'); /* Make sure msg ends with newline */

	/* Convert notes tree to tree object */
	if (write_notes_tree(t, tree_sha1))
		die("Failed to write current notes tree to database");

	/* Create new commit for the tree object */
	if (!read_ref(t->ref, prev_commit)) { /* retrieve parent commit */
		parent = xmalloc(sizeof(*parent));
		parent->item = lookup_commit(prev_commit);
		parent->next = NULL;
	} else {
		hashclr(prev_commit);
		parent = NULL;
	}
	if (commit_tree(buf.buf + 7, tree_sha1, parent, new_commit, NULL))
		die("Failed to commit notes tree to database");

	/* Update notes ref with new commit */
	update_ref(buf.buf, t->ref, new_commit, prev_commit, 0, DIE_ON_ERR);

	strbuf_release(&buf);
	return 0;
}

int cmd_notes(int argc, const char **argv, const char *prefix)
{
	struct notes_tree *t;
	unsigned char object[20], from_obj[20], new_note[20];
	const unsigned char *note;
	const char *object_ref;
	char logmsg[100];

	int list = 0, add = 0, copy = 0, append = 0, edit = 0, show = 0,
	    remove = 0, prune = 0, force = 0;
	int given_object = 0, i = 1, retval = 0;
	struct msg_arg msg = { 0, 0, STRBUF_INIT };
	struct option options[] = {
		OPT_GROUP("Notes options"),
		OPT_CALLBACK('m', "message", &msg, "MSG",
			     "note contents as a string", parse_msg_arg),
		OPT_CALLBACK('F', "file", &msg, "FILE",
			     "note contents in a file", parse_file_arg),
		OPT_CALLBACK('c', "reedit-message", &msg, "OBJECT",
			   "reuse and edit specified note object", parse_reedit_arg),
		OPT_CALLBACK('C', "reuse-message", &msg, "OBJECT",
			   "reuse specified note object", parse_reuse_arg),
		OPT_BOOLEAN('f', "force", &force, "replace existing notes"),
		OPT_END()
	};

	git_config(git_default_config, NULL);

	argc = parse_options(argc, argv, prefix, options, git_notes_usage, 0);

	if (argc && !strcmp(argv[0], "list"))
		list = 1;
	else if (argc && !strcmp(argv[0], "add"))
		add = 1;
	else if (argc && !strcmp(argv[0], "copy"))
		copy = 1;
	else if (argc && !strcmp(argv[0], "append"))
		append = 1;
	else if (argc && !strcmp(argv[0], "edit"))
		edit = 1;
	else if (argc && !strcmp(argv[0], "show"))
		show = 1;
	else if (argc && !strcmp(argv[0], "remove"))
		remove = 1;
	else if (argc && !strcmp(argv[0], "prune"))
		prune = 1;
	else if (!argc) {
		list = 1; /* Default to 'list' if no other subcommand given */
		i = 0;
	}

	if (list + add + copy + append + edit + show + remove + prune != 1)
		usage_with_options(git_notes_usage, options);

	if (msg.given && !(add || append || edit)) {
		error("cannot use -m/-F/-c/-C options with %s subcommand.",
		      argv[0]);
		usage_with_options(git_notes_usage, options);
	}

	if (msg.given && edit) {
		fprintf(stderr, "The -m/-F/-c/-C options have been deprecated "
			"for the 'edit' subcommand.\n"
			"Please use 'git notes add -f -m/-F/-c/-C' instead.\n");
	}

	if (force && !(add || copy)) {
		error("cannot use -f option with %s subcommand.", argv[0]);
		usage_with_options(git_notes_usage, options);
	}

	if (copy) {
		const char *from_ref;
		if (argc < 3) {
			error("too few parameters");
			usage_with_options(git_notes_usage, options);
		}
		from_ref = argv[i++];
		if (get_sha1(from_ref, from_obj))
			die("Failed to resolve '%s' as a valid ref.", from_ref);
	}

	given_object = argc > i;
	object_ref = given_object ? argv[i++] : "HEAD";

	if (argc > i || (prune && given_object)) {
		error("too many parameters");
		usage_with_options(git_notes_usage, options);
	}

	if (get_sha1(object_ref, object))
		die("Failed to resolve '%s' as a valid ref.", object_ref);

	init_notes(NULL, NULL, NULL, 0);
	t = &default_notes_tree;

	if (prefixcmp(t->ref, "refs/notes/"))
		die("Refusing to %s notes in %s (outside of refs/notes/)",
		    argv[0], t->ref);

	note = get_note(t, object);

	/* list command */

	if (list) {
		if (given_object) {
			if (note) {
				puts(sha1_to_hex(note));
				goto end;
			}
		} else {
			retval = for_each_note(t, 0, list_each_note, NULL);
			goto end;
		}
	}

	/* show command */

	if ((list || show) && !note) {
		error("No note found for object %s.", sha1_to_hex(object));
		retval = 1;
		goto end;
	} else if (show) {
		const char *show_args[3] = {"show", sha1_to_hex(note), NULL};
		retval = execv_git_cmd(show_args);
		goto end;
	}

	/* add/append/edit/remove/prune command */

	if ((add || copy) && note) {
		if (!force) {
			error("Cannot %s notes. Found existing notes for object"
			      " %s. Use '-f' to overwrite existing notes",
			      argv[0], sha1_to_hex(object));
			retval = 1;
			goto end;
		}
		fprintf(stderr, "Overwriting existing notes for object %s\n",
			sha1_to_hex(object));
	}

	if (remove) {
		msg.given = 1;
		msg.use_editor = 0;
		strbuf_reset(&(msg.buf));
	}

	if (prune) {
		hashclr(new_note);
		prune_notes(t);
		goto commit;
	} else if (copy) {
		const unsigned char *from_note = get_note(t, from_obj);
		if (!from_note) {
			error("Missing notes on source object %s. Cannot copy.",
			      sha1_to_hex(from_obj));
			retval = 1;
			goto end;
		}
		hashcpy(new_note, from_note);
	} else
		create_note(object, &msg, append, note, new_note);

	if (is_null_sha1(new_note))
		remove_note(t, object);
	else
		add_note(t, object, new_note, combine_notes_overwrite);

commit:
	snprintf(logmsg, sizeof(logmsg), "Notes %s by 'git notes %s'",
		 is_null_sha1(new_note) ? "removed" : "added", argv[0]);
	commit_notes(t, logmsg);

end:
	free_notes(t);
	strbuf_release(&(msg.buf));
	return retval;
}
Commit	Line	Data
cd067d3b JH	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
	20	static const char * const git_notes_usage[] = {
e397421a	21	"git notes [list [<object>]]",
0691cff7	22	"git notes add [-f] [-m <msg> \| -F <file> \| (-c \| -C) <object>] [<object>]",
e73bbd96	23	"git notes copy [-f] <from-object> <to-object>",
0691cff7	24	"git notes append [-m <msg> \| -F <file> \| (-c \| -C) <object>] [<object>]",
aaec9bcf	25	"git notes edit [<object>]",
cd067d3b	26	"git notes show [<object>]",
92b3385f	27	"git notes remove [<object>]",
d6576e1f	28	"git notes prune",
cd067d3b JH	29	NULL
	30	};
	31
	32	static const char note_template[] =
	33	"\n"
	34	"#\n"
	35	"# Write/edit the notes for the following object:\n"
	36	"#\n";
	37
348f199b JH	38	struct msg_arg {
348f199b JH	39	int given;
0691cff7	40	int use_editor;
348f199b JH	41	struct strbuf buf;
	42	};
	43
e397421a JH	44	static int list_each_note(const unsigned char *object_sha1,
	45	const unsigned char note_sha1, char note_path,
	46	void *cb_data)
	47	{
	48	printf("%s %s\n", sha1_to_hex(note_sha1), sha1_to_hex(object_sha1));
	49	return 0;
	50	}
	51
cd067d3b JH	52	static void write_note_data(int fd, const unsigned char *sha1)
	53	{
	54	unsigned long size;
	55	enum object_type type;
	56	char *buf = read_sha1_file(sha1, &type, &size);
	57	if (buf) {
	58	if (size)
	59	write_or_die(fd, buf, size);
	60	free(buf);
	61	}
	62	}
	63
	64	static void write_commented_object(int fd, const unsigned char *object)
	65	{
	66	const char *show_args[5] =
	67	{"show", "--stat", "--no-notes", sha1_to_hex(object), NULL};
	68	struct child_process show;
	69	struct strbuf buf = STRBUF_INIT;
	70	FILE *show_out;
	71
	72	/* Invoke "git show --stat --no-notes $object" */
	73	memset(&show, 0, sizeof(show));
	74	show.argv = show_args;
	75	show.no_stdin = 1;
	76	show.out = -1;
	77	show.err = 0;
	78	show.git_cmd = 1;
	79	if (start_command(&show))
	80	die("unable to start 'show' for object '%s'",
	81	sha1_to_hex(object));
	82
	83	/* Open the output as FILE* so strbuf_getline() can be used. */
	84	show_out = xfdopen(show.out, "r");
	85	if (show_out == NULL)
	86	die_errno("can't fdopen 'show' output fd");
	87
	88	/* Prepend "# " to each output line and write result to 'fd' */
	89	while (strbuf_getline(&buf, show_out, '\n') != EOF) {
	90	write_or_die(fd, "# ", 2);
	91	write_or_die(fd, buf.buf, buf.len);
	92	write_or_die(fd, "\n", 1);
	93	}
	94	strbuf_release(&buf);
	95	if (fclose(show_out))
	96	die_errno("failed to close pipe to 'show' for object '%s'",
	97	sha1_to_hex(object));
	98	if (finish_command(&show))
	99	die("failed to finish 'show' for object '%s'",
	100	sha1_to_hex(object));
	101	}
	102
348f199b JH	103	static void create_note(const unsigned char object, struct msg_arg msg,
348f199b JH	104	int append_only, const unsigned char *prev,
cd067d3b JH	105	unsigned char *result)
	106	{
	107	char *path = NULL;
	108
0691cff7	109	if (msg->use_editor \|\| !msg->given) {
cd067d3b JH	110	int fd;
	111
	112	/* write the template message before editing: */
	113	path = git_pathdup("NOTES_EDITMSG");
	114	fd = open(path, O_CREAT \| O_TRUNC \| O_WRONLY, 0600);
	115	if (fd < 0)
	116	die_errno("could not create file '%s'", path);
	117
0691cff7 JH	118	if (msg->given)
	119	write_or_die(fd, msg->buf.buf, msg->buf.len);
	120	else if (prev && !append_only)
cd067d3b JH	121	write_note_data(fd, prev);
	122	write_or_die(fd, note_template, strlen(note_template));
	123
	124	write_commented_object(fd, object);
	125
	126	close(fd);
0691cff7	127	strbuf_reset(&(msg->buf));
cd067d3b	128
348f199b	129	if (launch_editor(path, &(msg->buf), NULL)) {
cd067d3b JH	130	die("Please supply the note contents using either -m" \
	131	" or -F option");
	132	}
348f199b	133	stripspace(&(msg->buf), 1);
cd067d3b JH	134	}
cd067d3b JH	135
2347fae5 JH	136	if (prev && append_only) {
	137	/* Append buf to previous note contents */
	138	unsigned long size;
	139	enum object_type type;
	140	char *prev_buf = read_sha1_file(prev, &type, &size);
	141
348f199b JH	142	strbuf_grow(&(msg->buf), size + 1);
	143	if (msg->buf.len && prev_buf && size)
	144	strbuf_insert(&(msg->buf), 0, "\n", 1);
2347fae5	145	if (prev_buf && size)
348f199b	146	strbuf_insert(&(msg->buf), 0, prev_buf, size);
2347fae5 JH	147	free(prev_buf);
	148	}
	149
348f199b	150	if (!msg->buf.len) {
cd067d3b JH	151	fprintf(stderr, "Removing note for object %s\n",
	152	sha1_to_hex(object));
	153	hashclr(result);
	154	} else {
348f199b	155	if (write_sha1_file(msg->buf.buf, msg->buf.len, blob_type, result)) {
cd067d3b JH	156	error("unable to write note object");
	157	if (path)
	158	error("The note contents has been left in %s",
	159	path);
	160	exit(128);
	161	}
	162	}
	163
	164	if (path) {
	165	unlink_or_warn(path);
	166	free(path);
	167	}
	168	}
	169
cd067d3b JH	170	static int parse_msg_arg(const struct option opt, const char arg, int unset)
	171	{
	172	struct msg_arg *msg = opt->value;
	173
	174	if (!arg)
	175	return -1;
348f199b JH	176
348f199b JH	177	strbuf_grow(&(msg->buf), strlen(arg) + 2);
cd067d3b	178	if (msg->buf.len)
348f199b	179	strbuf_addstr(&(msg->buf), "\n");
cd067d3b	180	strbuf_addstr(&(msg->buf), arg);
348f199b JH	181	stripspace(&(msg->buf), 0);
	182
	183	msg->given = 1;
	184	return 0;
	185	}
	186
	187	static int parse_file_arg(const struct option opt, const char arg, int unset)
	188	{
	189	struct msg_arg *msg = opt->value;
	190
	191	if (!arg)
	192	return -1;
	193
	194	if (msg->buf.len)
	195	strbuf_addstr(&(msg->buf), "\n");
	196	if (!strcmp(arg, "-")) {
	197	if (strbuf_read(&(msg->buf), 0, 1024) < 0)
	198	die_errno("cannot read '%s'", arg);
	199	} else if (strbuf_read_file(&(msg->buf), arg, 1024) < 0)
	200	die_errno("could not open or read '%s'", arg);
	201	stripspace(&(msg->buf), 0);
	202
cd067d3b JH	203	msg->given = 1;
	204	return 0;
	205	}
	206
0691cff7 JH	207	static int parse_reuse_arg(const struct option opt, const char arg, int unset)
	208	{
	209	struct msg_arg *msg = opt->value;
	210	char *buf;
	211	unsigned char object[20];
	212	enum object_type type;
	213	unsigned long len;
	214
	215	if (!arg)
	216	return -1;
	217
	218	if (msg->buf.len)
	219	strbuf_addstr(&(msg->buf), "\n");
	220
	221	if (get_sha1(arg, object))
	222	die("Failed to resolve '%s' as a valid ref.", arg);
	223	if (!(buf = read_sha1_file(object, &type, &len)) \|\| !len) {
	224	free(buf);
	225	die("Failed to read object '%s'.", arg);;
	226	}
	227	strbuf_add(&(msg->buf), buf, len);
	228	free(buf);
	229
	230	msg->given = 1;
	231	return 0;
	232	}
	233
	234	static int parse_reedit_arg(const struct option opt, const char arg, int unset)
	235	{
	236	struct msg_arg *msg = opt->value;
	237	msg->use_editor = 1;
	238	return parse_reuse_arg(opt, arg, unset);
	239	}
	240
cd067d3b JH	241	int commit_notes(struct notes_tree t, const char msg)
	242	{
	243	struct commit_list *parent;
	244	unsigned char tree_sha1[20], prev_commit[20], new_commit[20];
	245	struct strbuf buf = STRBUF_INIT;
	246
	247	if (!t)
	248	t = &default_notes_tree;
	249	if (!t->initialized \|\| !t->ref \|\| !*t->ref)
	250	die("Cannot commit uninitialized/unreferenced notes tree");
	251
	252	/* Prepare commit message and reflog message */
	253	strbuf_addstr(&buf, "notes: "); /* commit message starts at index 7 */
	254	strbuf_addstr(&buf, msg);
	255	if (buf.buf[buf.len - 1] != '\n')
	256	strbuf_addch(&buf, '\n'); /* Make sure msg ends with newline */
	257
	258	/* Convert notes tree to tree object */
	259	if (write_notes_tree(t, tree_sha1))
	260	die("Failed to write current notes tree to database");
	261
	262	/* Create new commit for the tree object */
	263	if (!read_ref(t->ref, prev_commit)) { /* retrieve parent commit */
	264	parent = xmalloc(sizeof(*parent));
	265	parent->item = lookup_commit(prev_commit);
	266	parent->next = NULL;
	267	} else {
	268	hashclr(prev_commit);
	269	parent = NULL;
	270	}
	271	if (commit_tree(buf.buf + 7, tree_sha1, parent, new_commit, NULL))
	272	die("Failed to commit notes tree to database");
	273
	274	/* Update notes ref with new commit */
	275	update_ref(buf.buf, t->ref, new_commit, prev_commit, 0, DIE_ON_ERR);
	276
	277	strbuf_release(&buf);
	278	return 0;
	279	}
	280
	281	int cmd_notes(int argc, const char *argv, const char prefix)
	282	{
cd067d3b	283	struct notes_tree *t;
e73bbd96	284	unsigned char object[20], from_obj[20], new_note[20];
cd067d3b	285	const unsigned char *note;
92b3385f JH	286	const char *object_ref;
92b3385f JH	287	char logmsg[100];
a0b4dfa9	288
e73bbd96 JH	289	int list = 0, add = 0, copy = 0, append = 0, edit = 0, show = 0,
e73bbd96 JH	290	remove = 0, prune = 0, force = 0;
5848769f	291	int given_object = 0, i = 1, retval = 0;
0691cff7	292	struct msg_arg msg = { 0, 0, STRBUF_INIT };
cd067d3b	293	struct option options[] = {
aaec9bcf	294	OPT_GROUP("Notes options"),
348f199b	295	OPT_CALLBACK('m', "message", &msg, "MSG",
cd067d3b	296	"note contents as a string", parse_msg_arg),
348f199b JH	297	OPT_CALLBACK('F', "file", &msg, "FILE",
348f199b JH	298	"note contents in a file", parse_file_arg),
0691cff7 JH	299	OPT_CALLBACK('c', "reedit-message", &msg, "OBJECT",
	300	"reuse and edit specified note object", parse_reedit_arg),
	301	OPT_CALLBACK('C', "reuse-message", &msg, "OBJECT",
	302	"reuse specified note object", parse_reuse_arg),
7aa4754e	303	OPT_BOOLEAN('f', "force", &force, "replace existing notes"),
cd067d3b JH	304	OPT_END()
	305	};
	306
	307	git_config(git_default_config, NULL);
	308
	309	argc = parse_options(argc, argv, prefix, options, git_notes_usage, 0);
	310
e397421a JH	311	if (argc && !strcmp(argv[0], "list"))
e397421a JH	312	list = 1;
7aa4754e JH	313	else if (argc && !strcmp(argv[0], "add"))
7aa4754e JH	314	add = 1;
e73bbd96 JH	315	else if (argc && !strcmp(argv[0], "copy"))
e73bbd96 JH	316	copy = 1;
2347fae5 JH	317	else if (argc && !strcmp(argv[0], "append"))
2347fae5 JH	318	append = 1;
e397421a	319	else if (argc && !strcmp(argv[0], "edit"))
cd067d3b JH	320	edit = 1;
	321	else if (argc && !strcmp(argv[0], "show"))
	322	show = 1;
92b3385f JH	323	else if (argc && !strcmp(argv[0], "remove"))
92b3385f JH	324	remove = 1;
d6576e1f JH	325	else if (argc && !strcmp(argv[0], "prune"))
d6576e1f JH	326	prune = 1;
5848769f	327	else if (!argc) {
e397421a	328	list = 1; /* Default to 'list' if no other subcommand given */
5848769f JH	329	i = 0;
5848769f JH	330	}
cd067d3b	331
e73bbd96	332	if (list + add + copy + append + edit + show + remove + prune != 1)
cd067d3b JH	333	usage_with_options(git_notes_usage, options);
cd067d3b JH	334
348f199b	335	if (msg.given && !(add \|\| append \|\| edit)) {
0691cff7 JH	336	error("cannot use -m/-F/-c/-C options with %s subcommand.",
0691cff7 JH	337	argv[0]);
92b3385f JH	338	usage_with_options(git_notes_usage, options);
	339	}
	340
348f199b	341	if (msg.given && edit) {
0691cff7 JH	342	fprintf(stderr, "The -m/-F/-c/-C options have been deprecated "
	343	"for the 'edit' subcommand.\n"
	344	"Please use 'git notes add -f -m/-F/-c/-C' instead.\n");
aaec9bcf JH	345	}
aaec9bcf JH	346
e73bbd96	347	if (force && !(add \|\| copy)) {
7aa4754e JH	348	error("cannot use -f option with %s subcommand.", argv[0]);
	349	usage_with_options(git_notes_usage, options);
	350	}
	351
e73bbd96 JH	352	if (copy) {
	353	const char *from_ref;
	354	if (argc < 3) {
	355	error("too few parameters");
	356	usage_with_options(git_notes_usage, options);
	357	}
	358	from_ref = argv[i++];
	359	if (get_sha1(from_ref, from_obj))
	360	die("Failed to resolve '%s' as a valid ref.", from_ref);
	361	}
	362
5848769f JH	363	given_object = argc > i;
	364	object_ref = given_object ? argv[i++] : "HEAD";
	365
	366	if (argc > i \|\| (prune && given_object)) {
cd067d3b JH	367	error("too many parameters");
	368	usage_with_options(git_notes_usage, options);
	369	}
	370
	371	if (get_sha1(object_ref, object))
	372	die("Failed to resolve '%s' as a valid ref.", object_ref);
	373
	374	init_notes(NULL, NULL, NULL, 0);
	375	t = &default_notes_tree;
	376
	377	if (prefixcmp(t->ref, "refs/notes/"))
	378	die("Refusing to %s notes in %s (outside of refs/notes/)",
92b3385f	379	argv[0], t->ref);
cd067d3b JH	380
	381	note = get_note(t, object);
	382
e397421a JH	383	/* list command */
	384
	385	if (list) {
	386	if (given_object) {
	387	if (note) {
	388	puts(sha1_to_hex(note));
5848769f	389	goto end;
e397421a	390	}
5848769f JH	391	} else {
	392	retval = for_each_note(t, 0, list_each_note, NULL);
	393	goto end;
	394	}
e397421a JH	395	}
e397421a JH	396
cd067d3b JH	397	/* show command */
cd067d3b JH	398
e397421a	399	if ((list \|\| show) && !note) {
cd067d3b	400	error("No note found for object %s.", sha1_to_hex(object));
5848769f JH	401	retval = 1;
5848769f JH	402	goto end;
cd067d3b JH	403	} else if (show) {
cd067d3b JH	404	const char *show_args[3] = {"show", sha1_to_hex(note), NULL};
5848769f JH	405	retval = execv_git_cmd(show_args);
5848769f JH	406	goto end;
cd067d3b JH	407	}
cd067d3b JH	408
2347fae5	409	/* add/append/edit/remove/prune command */
7aa4754e	410
e73bbd96	411	if ((add \|\| copy) && note) {
5848769f	412	if (!force) {
e73bbd96	413	error("Cannot %s notes. Found existing notes for object"
5848769f	414	" %s. Use '-f' to overwrite existing notes",
e73bbd96	415	argv[0], sha1_to_hex(object));
5848769f JH	416	retval = 1;
5848769f JH	417	goto end;
7aa4754e	418	}
5848769f JH	419	fprintf(stderr, "Overwriting existing notes for object %s\n",
5848769f JH	420	sha1_to_hex(object));
7aa4754e	421	}
92b3385f	422
348f199b JH	423	if (remove) {
348f199b JH	424	msg.given = 1;
0691cff7	425	msg.use_editor = 0;
348f199b	426	strbuf_reset(&(msg.buf));
cd067d3b JH	427	}
cd067d3b JH	428
d6576e1f JH	429	if (prune) {
	430	hashclr(new_note);
	431	prune_notes(t);
5848769f	432	goto commit;
e73bbd96 JH	433	} else if (copy) {
	434	const unsigned char *from_note = get_note(t, from_obj);
	435	if (!from_note) {
	436	error("Missing notes on source object %s. Cannot copy.",
	437	sha1_to_hex(from_obj));
	438	retval = 1;
	439	goto end;
	440	}
	441	hashcpy(new_note, from_note);
5848769f	442	} else
348f199b	443	create_note(object, &msg, append, note, new_note);
5848769f JH	444
	445	if (is_null_sha1(new_note))
	446	remove_note(t, object);
	447	else
	448	add_note(t, object, new_note, combine_notes_overwrite);
	449
	450	commit:
	451	snprintf(logmsg, sizeof(logmsg), "Notes %s by 'git notes %s'",
92b3385f	452	is_null_sha1(new_note) ? "removed" : "added", argv[0]);
a0b4dfa9	453	commit_notes(t, logmsg);
cd067d3b	454
5848769f	455	end:
cd067d3b	456	free_notes(t);
348f199b	457	strbuf_release(&(msg.buf));
5848769f	458	return retval;
cd067d3b	459	}