[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"
#include "string-list.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;
}


combine_notes_fn *parse_combine_notes_fn(const char *v)
{
	if (!strcasecmp(v, "overwrite"))
		return combine_notes_overwrite;
	else if (!strcasecmp(v, "ignore"))
		return combine_notes_ignore;
	else if (!strcasecmp(v, "concatenate"))
		return combine_notes_concatenate;
	else
		return NULL;
}

static int notes_rewrite_config(const char *k, const char *v, void *cb)
{
	struct notes_rewrite_cfg *c = cb;
	if (!prefixcmp(k, "notes.rewrite.") && !strcmp(k+14, c->cmd)) {
		c->enabled = git_config_bool(k, v);
		return 0;
	} else if (!c->mode_from_env && !strcmp(k, "notes.rewritemode")) {
		if (!v)
			config_error_nonbool(k);
		c->combine = parse_combine_notes_fn(v);
		if (!c->combine) {
			error("Bad notes.rewriteMode value: '%s'", v);
			return 1;
		}
		return 0;
	} else if (!c->refs_from_env && !strcmp(k, "notes.rewriteref")) {
		/* note that a refs/ prefix is implied in the
		 * underlying for_each_glob_ref */
		if (!prefixcmp(v, "refs/notes/"))
			string_list_add_refs_by_glob(c->refs, v);
		else
			warning("Refusing to rewrite notes in %s"
				" (outside of refs/notes/)", v);
		return 0;
	}

	return 0;
}


struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd)
{
	struct notes_rewrite_cfg *c = xmalloc(sizeof(struct notes_rewrite_cfg));
	const char *rewrite_mode_env = getenv(GIT_NOTES_REWRITE_MODE_ENVIRONMENT);
	const char *rewrite_refs_env = getenv(GIT_NOTES_REWRITE_REF_ENVIRONMENT);
	c->cmd = cmd;
	c->enabled = 1;
	c->combine = combine_notes_concatenate;
	c->refs = xcalloc(1, sizeof(struct string_list));
	c->refs->strdup_strings = 1;
	c->refs_from_env = 0;
	c->mode_from_env = 0;
	if (rewrite_mode_env) {
		c->mode_from_env = 1;
		c->combine = parse_combine_notes_fn(rewrite_mode_env);
		if (!c->combine)
			error("Bad " GIT_NOTES_REWRITE_MODE_ENVIRONMENT
			      " value: '%s'", rewrite_mode_env);
	}
	if (rewrite_refs_env) {
		c->refs_from_env = 1;
		string_list_add_refs_from_colon_sep(c->refs, rewrite_refs_env);
	}
	git_config(notes_rewrite_config, c);
	if (!c->enabled || !c->refs->nr) {
		string_list_clear(c->refs, 0);
		free(c->refs);
		free(c);
		return NULL;
	}
	c->trees = load_notes_trees(c->refs);
	string_list_clear(c->refs, 0);
	free(c->refs);
	return c;
}

int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
			  const unsigned char *from_obj, const unsigned char *to_obj)
{
	int ret = 0;
	int i;
	for (i = 0; c->trees[i]; i++)
		ret = copy_note(c->trees[i], from_obj, to_obj, 1, c->combine) || ret;
	return ret;
}

void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg *c)
{
	int i;
	for (i = 0; c->trees[i]; i++) {
		commit_notes(c->trees[i], "Notes added by 'git notes copy'");
		free_notes(c->trees[i]);
	}
	free(c->trees);
	free(c);
}

int notes_copy_from_stdin(int force, const char *rewrite_cmd)
{
	struct strbuf buf = STRBUF_INIT;
	struct notes_rewrite_cfg *c = NULL;
	struct notes_tree *t;
	int ret = 0;

	if (rewrite_cmd) {
		c = init_copy_notes_for_rewrite(rewrite_cmd);
		if (!c)
			return 0;
	} else {
		init_notes(NULL, NULL, NULL, 0);
		t = &default_notes_tree;
	}

	while (strbuf_getline(&buf, stdin, '\n') != EOF) {
		unsigned char from_obj[20], to_obj[20];
		struct strbuf **split;
		int err;

		split = strbuf_split(&buf, ' ');
		if (!split[0] || !split[1])
			die("Malformed input line: '%s'.", buf.buf);
		strbuf_rtrim(split[0]);
		strbuf_rtrim(split[1]);
		if (get_sha1(split[0]->buf, from_obj))
			die("Failed to resolve '%s' as a valid ref.", split[0]->buf);
		if (get_sha1(split[1]->buf, to_obj))
			die("Failed to resolve '%s' as a valid ref.", split[1]->buf);

		if (rewrite_cmd)
			err = copy_note_for_rewrite(c, from_obj, to_obj);
		else
			err = copy_note(t, from_obj, to_obj, force,
					combine_notes_overwrite);

		if (err) {
			error("Failed to copy notes from '%s' to '%s'",
			      split[0]->buf, split[1]->buf);
			ret = 1;
		}

		strbuf_list_free(split);
	}

	if (!rewrite_cmd) {
		commit_notes(t, "Notes added by 'git notes copy'");
		free_notes(t);
	} else {
		finish_copy_notes_for_rewrite(c);
	}
	return ret;
}

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, from_stdin = 0;
	int given_object = 0, i = 1, retval = 0;
	struct msg_arg msg = { 0, 0, STRBUF_INIT };
	const char *rewrite_cmd = NULL;
	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_BOOLEAN(0, "stdin", &from_stdin, "read objects from stdin"),
		OPT_STRING(0, "for-rewrite", &rewrite_cmd, "command",
			   "load rewriting config for <command> (implies --stdin)"),
		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 && rewrite_cmd) {
		error("cannot use --for-rewrite with %s subcommand.", argv[0]);
		usage_with_options(git_notes_usage, options);
	}
	if (!copy && from_stdin) {
		error("cannot use --stdin with %s subcommand.", argv[0]);
		usage_with_options(git_notes_usage, options);
	}

	if (copy) {
		const char *from_ref;
		if (from_stdin || rewrite_cmd) {
			if (argc > 1) {
				error("too many parameters");
				usage_with_options(git_notes_usage, options);
			} else {
				return notes_copy_from_stdin(force, rewrite_cmd);
			}
		}
		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"
6956f858	19	#include "string-list.h"
cd067d3b JH	20
cd067d3b JH	21	static const char * const git_notes_usage[] = {
e397421a	22	"git notes [list [<object>]]",
0691cff7	23	"git notes add [-f] [-m <msg> \| -F <file> \| (-c \| -C) <object>] [<object>]",
e73bbd96	24	"git notes copy [-f] <from-object> <to-object>",
0691cff7	25	"git notes append [-m <msg> \| -F <file> \| (-c \| -C) <object>] [<object>]",
aaec9bcf	26	"git notes edit [<object>]",
cd067d3b	27	"git notes show [<object>]",
92b3385f	28	"git notes remove [<object>]",
d6576e1f	29	"git notes prune",
cd067d3b JH	30	NULL
	31	};
	32
	33	static const char note_template[] =
	34	"\n"
	35	"#\n"
	36	"# Write/edit the notes for the following object:\n"
	37	"#\n";
	38
348f199b JH	39	struct msg_arg {
348f199b JH	40	int given;
0691cff7	41	int use_editor;
348f199b JH	42	struct strbuf buf;
	43	};
	44
e397421a JH	45	static int list_each_note(const unsigned char *object_sha1,
	46	const unsigned char note_sha1, char note_path,
	47	void *cb_data)
	48	{
	49	printf("%s %s\n", sha1_to_hex(note_sha1), sha1_to_hex(object_sha1));
	50	return 0;
	51	}
	52
cd067d3b JH	53	static void write_note_data(int fd, const unsigned char *sha1)
	54	{
	55	unsigned long size;
	56	enum object_type type;
	57	char *buf = read_sha1_file(sha1, &type, &size);
	58	if (buf) {
	59	if (size)
	60	write_or_die(fd, buf, size);
	61	free(buf);
	62	}
	63	}
	64
	65	static void write_commented_object(int fd, const unsigned char *object)
	66	{
	67	const char *show_args[5] =
	68	{"show", "--stat", "--no-notes", sha1_to_hex(object), NULL};
	69	struct child_process show;
	70	struct strbuf buf = STRBUF_INIT;
	71	FILE *show_out;
	72
	73	/* Invoke "git show --stat --no-notes $object" */
	74	memset(&show, 0, sizeof(show));
	75	show.argv = show_args;
	76	show.no_stdin = 1;
	77	show.out = -1;
	78	show.err = 0;
	79	show.git_cmd = 1;
	80	if (start_command(&show))
	81	die("unable to start 'show' for object '%s'",
	82	sha1_to_hex(object));
	83
	84	/* Open the output as FILE* so strbuf_getline() can be used. */
	85	show_out = xfdopen(show.out, "r");
	86	if (show_out == NULL)
	87	die_errno("can't fdopen 'show' output fd");
	88
	89	/* Prepend "# " to each output line and write result to 'fd' */
	90	while (strbuf_getline(&buf, show_out, '\n') != EOF) {
	91	write_or_die(fd, "# ", 2);
	92	write_or_die(fd, buf.buf, buf.len);
	93	write_or_die(fd, "\n", 1);
	94	}
	95	strbuf_release(&buf);
	96	if (fclose(show_out))
	97	die_errno("failed to close pipe to 'show' for object '%s'",
	98	sha1_to_hex(object));
	99	if (finish_command(&show))
	100	die("failed to finish 'show' for object '%s'",
	101	sha1_to_hex(object));
	102	}
	103
348f199b JH	104	static void create_note(const unsigned char object, struct msg_arg msg,
348f199b JH	105	int append_only, const unsigned char *prev,
cd067d3b JH	106	unsigned char *result)
	107	{
	108	char *path = NULL;
	109
0691cff7	110	if (msg->use_editor \|\| !msg->given) {
cd067d3b JH	111	int fd;
	112
	113	/* write the template message before editing: */
	114	path = git_pathdup("NOTES_EDITMSG");
	115	fd = open(path, O_CREAT \| O_TRUNC \| O_WRONLY, 0600);
	116	if (fd < 0)
	117	die_errno("could not create file '%s'", path);
	118
0691cff7 JH	119	if (msg->given)
	120	write_or_die(fd, msg->buf.buf, msg->buf.len);
	121	else if (prev && !append_only)
cd067d3b JH	122	write_note_data(fd, prev);
	123	write_or_die(fd, note_template, strlen(note_template));
	124
	125	write_commented_object(fd, object);
	126
	127	close(fd);
0691cff7	128	strbuf_reset(&(msg->buf));
cd067d3b	129
348f199b	130	if (launch_editor(path, &(msg->buf), NULL)) {
cd067d3b JH	131	die("Please supply the note contents using either -m" \
	132	" or -F option");
	133	}
348f199b	134	stripspace(&(msg->buf), 1);
cd067d3b JH	135	}
cd067d3b JH	136
2347fae5 JH	137	if (prev && append_only) {
	138	/* Append buf to previous note contents */
	139	unsigned long size;
	140	enum object_type type;
	141	char *prev_buf = read_sha1_file(prev, &type, &size);
	142
348f199b JH	143	strbuf_grow(&(msg->buf), size + 1);
	144	if (msg->buf.len && prev_buf && size)
	145	strbuf_insert(&(msg->buf), 0, "\n", 1);
2347fae5	146	if (prev_buf && size)
348f199b	147	strbuf_insert(&(msg->buf), 0, prev_buf, size);
2347fae5 JH	148	free(prev_buf);
	149	}
	150
348f199b	151	if (!msg->buf.len) {
cd067d3b JH	152	fprintf(stderr, "Removing note for object %s\n",
	153	sha1_to_hex(object));
	154	hashclr(result);
	155	} else {
348f199b	156	if (write_sha1_file(msg->buf.buf, msg->buf.len, blob_type, result)) {
cd067d3b JH	157	error("unable to write note object");
	158	if (path)
	159	error("The note contents has been left in %s",
	160	path);
	161	exit(128);
	162	}
	163	}
	164
	165	if (path) {
	166	unlink_or_warn(path);
	167	free(path);
	168	}
	169	}
	170
cd067d3b JH	171	static int parse_msg_arg(const struct option opt, const char arg, int unset)
	172	{
	173	struct msg_arg *msg = opt->value;
	174
	175	if (!arg)
	176	return -1;
348f199b JH	177
348f199b JH	178	strbuf_grow(&(msg->buf), strlen(arg) + 2);
cd067d3b	179	if (msg->buf.len)
348f199b	180	strbuf_addstr(&(msg->buf), "\n");
cd067d3b	181	strbuf_addstr(&(msg->buf), arg);
348f199b JH	182	stripspace(&(msg->buf), 0);
	183
	184	msg->given = 1;
	185	return 0;
	186	}
	187
	188	static int parse_file_arg(const struct option opt, const char arg, int unset)
	189	{
	190	struct msg_arg *msg = opt->value;
	191
	192	if (!arg)
	193	return -1;
	194
	195	if (msg->buf.len)
	196	strbuf_addstr(&(msg->buf), "\n");
	197	if (!strcmp(arg, "-")) {
	198	if (strbuf_read(&(msg->buf), 0, 1024) < 0)
	199	die_errno("cannot read '%s'", arg);
	200	} else if (strbuf_read_file(&(msg->buf), arg, 1024) < 0)
	201	die_errno("could not open or read '%s'", arg);
	202	stripspace(&(msg->buf), 0);
	203
cd067d3b JH	204	msg->given = 1;
	205	return 0;
	206	}
	207
0691cff7 JH	208	static int parse_reuse_arg(const struct option opt, const char arg, int unset)
	209	{
	210	struct msg_arg *msg = opt->value;
	211	char *buf;
	212	unsigned char object[20];
	213	enum object_type type;
	214	unsigned long len;
	215
	216	if (!arg)
	217	return -1;
	218
	219	if (msg->buf.len)
	220	strbuf_addstr(&(msg->buf), "\n");
	221
	222	if (get_sha1(arg, object))
	223	die("Failed to resolve '%s' as a valid ref.", arg);
	224	if (!(buf = read_sha1_file(object, &type, &len)) \|\| !len) {
	225	free(buf);
	226	die("Failed to read object '%s'.", arg);;
	227	}
	228	strbuf_add(&(msg->buf), buf, len);
	229	free(buf);
	230
	231	msg->given = 1;
	232	return 0;
	233	}
	234
	235	static int parse_reedit_arg(const struct option opt, const char arg, int unset)
	236	{
	237	struct msg_arg *msg = opt->value;
	238	msg->use_editor = 1;
	239	return parse_reuse_arg(opt, arg, unset);
	240	}
	241
cd067d3b JH	242	int commit_notes(struct notes_tree t, const char msg)
	243	{
	244	struct commit_list *parent;
	245	unsigned char tree_sha1[20], prev_commit[20], new_commit[20];
	246	struct strbuf buf = STRBUF_INIT;
	247
	248	if (!t)
	249	t = &default_notes_tree;
	250	if (!t->initialized \|\| !t->ref \|\| !*t->ref)
	251	die("Cannot commit uninitialized/unreferenced notes tree");
	252
	253	/* Prepare commit message and reflog message */
	254	strbuf_addstr(&buf, "notes: "); /* commit message starts at index 7 */
	255	strbuf_addstr(&buf, msg);
	256	if (buf.buf[buf.len - 1] != '\n')
	257	strbuf_addch(&buf, '\n'); /* Make sure msg ends with newline */
	258
	259	/* Convert notes tree to tree object */
	260	if (write_notes_tree(t, tree_sha1))
	261	die("Failed to write current notes tree to database");
	262
	263	/* Create new commit for the tree object */
	264	if (!read_ref(t->ref, prev_commit)) { /* retrieve parent commit */
	265	parent = xmalloc(sizeof(*parent));
	266	parent->item = lookup_commit(prev_commit);
	267	parent->next = NULL;
	268	} else {
	269	hashclr(prev_commit);
	270	parent = NULL;
	271	}
	272	if (commit_tree(buf.buf + 7, tree_sha1, parent, new_commit, NULL))
	273	die("Failed to commit notes tree to database");
	274
	275	/* Update notes ref with new commit */
	276	update_ref(buf.buf, t->ref, new_commit, prev_commit, 0, DIE_ON_ERR);
	277
	278	strbuf_release(&buf);
	279	return 0;
	280	}
	281
6956f858 TR	282
	283	combine_notes_fn parse_combine_notes_fn(const char v)
	284	{
	285	if (!strcasecmp(v, "overwrite"))
	286	return combine_notes_overwrite;
	287	else if (!strcasecmp(v, "ignore"))
	288	return combine_notes_ignore;
	289	else if (!strcasecmp(v, "concatenate"))
	290	return combine_notes_concatenate;
	291	else
	292	return NULL;
	293	}
	294
	295	static int notes_rewrite_config(const char k, const char v, void *cb)
	296	{
	297	struct notes_rewrite_cfg *c = cb;
	298	if (!prefixcmp(k, "notes.rewrite.") && !strcmp(k+14, c->cmd)) {
	299	c->enabled = git_config_bool(k, v);
	300	return 0;
	301	} else if (!c->mode_from_env && !strcmp(k, "notes.rewritemode")) {
	302	if (!v)
	303	config_error_nonbool(k);
	304	c->combine = parse_combine_notes_fn(v);
	305	if (!c->combine) {
	306	error("Bad notes.rewriteMode value: '%s'", v);
	307	return 1;
	308	}
	309	return 0;
	310	} else if (!c->refs_from_env && !strcmp(k, "notes.rewriteref")) {
	311	/* note that a refs/ prefix is implied in the
	312	* underlying for_each_glob_ref */
	313	if (!prefixcmp(v, "refs/notes/"))
	314	string_list_add_refs_by_glob(c->refs, v);
	315	else
	316	warning("Refusing to rewrite notes in %s"
	317	" (outside of refs/notes/)", v);
	318	return 0;
	319	}
	320
	321	return 0;
	322	}
	323
	324
	325	struct notes_rewrite_cfg init_copy_notes_for_rewrite(const char cmd)
	326	{
	327	struct notes_rewrite_cfg *c = xmalloc(sizeof(struct notes_rewrite_cfg));
	328	const char *rewrite_mode_env = getenv(GIT_NOTES_REWRITE_MODE_ENVIRONMENT);
	329	const char *rewrite_refs_env = getenv(GIT_NOTES_REWRITE_REF_ENVIRONMENT);
	330	c->cmd = cmd;
	331	c->enabled = 1;
	332	c->combine = combine_notes_concatenate;
	333	c->refs = xcalloc(1, sizeof(struct string_list));
	334	c->refs->strdup_strings = 1;
	335	c->refs_from_env = 0;
	336	c->mode_from_env = 0;
	337	if (rewrite_mode_env) {
	338	c->mode_from_env = 1;
	339	c->combine = parse_combine_notes_fn(rewrite_mode_env);
	340	if (!c->combine)
	341	error("Bad " GIT_NOTES_REWRITE_MODE_ENVIRONMENT
	342	" value: '%s'", rewrite_mode_env);
	343	}
	344	if (rewrite_refs_env) {
	345	c->refs_from_env = 1;
346	string_list_add_refs_from_colon_sep(c->refs, rewrite_refs_env);
347	}
348	git_config(notes_rewrite_config, c);
349	if (!c->enabled \|\| !c->refs->nr) {
350	string_list_clear(c->refs, 0);
351	free(c->refs);
352	free(c);
353	return NULL;
354	}
355	c->trees = load_notes_trees(c->refs);
356	string_list_clear(c->refs, 0);
357	free(c->refs);
358	return c;
359	}
360
361	int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
362	const unsigned char from_obj, const unsigned char to_obj)
363	{
364	int ret = 0;
365	int i;
366	for (i = 0; c->trees[i]; i++)
367	ret = copy_note(c->trees[i], from_obj, to_obj, 1, c->combine) \|\| ret;
368	return ret;
369	}
370
371	void finish_copy_notes_for_rewrite(struct notes_rewrite_cfg *c)
372	{
373	int i;
374	for (i = 0; c->trees[i]; i++) {
375	commit_notes(c->trees[i], "Notes added by 'git notes copy'");
376	free_notes(c->trees[i]);
377	}
378	free(c->trees);
379	free(c);
380	}
381
382	int notes_copy_from_stdin(int force, const char *rewrite_cmd)
160baa0d TR	383	{
160baa0d TR	384	struct strbuf buf = STRBUF_INIT;
6956f858	385	struct notes_rewrite_cfg *c = NULL;
160baa0d TR	386	struct notes_tree *t;
	387	int ret = 0;
	388
6956f858 TR	389	if (rewrite_cmd) {
	390	c = init_copy_notes_for_rewrite(rewrite_cmd);
	391	if (!c)
	392	return 0;
	393	} else {
	394	init_notes(NULL, NULL, NULL, 0);
	395	t = &default_notes_tree;
	396	}
160baa0d TR	397
	398	while (strbuf_getline(&buf, stdin, '\n') != EOF) {
	399	unsigned char from_obj[20], to_obj[20];
	400	struct strbuf **split;
	401	int err;
	402
	403	split = strbuf_split(&buf, ' ');
	404	if (!split[0] \|\| !split[1])
	405	die("Malformed input line: '%s'.", buf.buf);
	406	strbuf_rtrim(split[0]);
	407	strbuf_rtrim(split[1]);
	408	if (get_sha1(split[0]->buf, from_obj))
	409	die("Failed to resolve '%s' as a valid ref.", split[0]->buf);
	410	if (get_sha1(split[1]->buf, to_obj))
	411	die("Failed to resolve '%s' as a valid ref.", split[1]->buf);
	412
6956f858 TR	413	if (rewrite_cmd)
	414	err = copy_note_for_rewrite(c, from_obj, to_obj);
	415	else
	416	err = copy_note(t, from_obj, to_obj, force,
	417	combine_notes_overwrite);
160baa0d TR	418
	419	if (err) {
	420	error("Failed to copy notes from '%s' to '%s'",
	421	split[0]->buf, split[1]->buf);
	422	ret = 1;
	423	}
	424
	425	strbuf_list_free(split);
	426	}
	427
6956f858 TR	428	if (!rewrite_cmd) {
	429	commit_notes(t, "Notes added by 'git notes copy'");
	430	free_notes(t);
	431	} else {
	432	finish_copy_notes_for_rewrite(c);
	433	}
160baa0d TR	434	return ret;
	435	}
	436
cd067d3b JH	437	int cmd_notes(int argc, const char *argv, const char prefix)
cd067d3b JH	438	{
cd067d3b	439	struct notes_tree *t;
e73bbd96	440	unsigned char object[20], from_obj[20], new_note[20];
cd067d3b	441	const unsigned char *note;
92b3385f JH	442	const char *object_ref;
92b3385f JH	443	char logmsg[100];
a0b4dfa9	444
e73bbd96	445	int list = 0, add = 0, copy = 0, append = 0, edit = 0, show = 0,
160baa0d	446	remove = 0, prune = 0, force = 0, from_stdin = 0;
5848769f	447	int given_object = 0, i = 1, retval = 0;
0691cff7	448	struct msg_arg msg = { 0, 0, STRBUF_INIT };
6956f858	449	const char *rewrite_cmd = NULL;
cd067d3b	450	struct option options[] = {
aaec9bcf	451	OPT_GROUP("Notes options"),
348f199b	452	OPT_CALLBACK('m', "message", &msg, "MSG",
cd067d3b	453	"note contents as a string", parse_msg_arg),
348f199b JH	454	OPT_CALLBACK('F', "file", &msg, "FILE",
348f199b JH	455	"note contents in a file", parse_file_arg),
0691cff7 JH	456	OPT_CALLBACK('c', "reedit-message", &msg, "OBJECT",
	457	"reuse and edit specified note object", parse_reedit_arg),
	458	OPT_CALLBACK('C', "reuse-message", &msg, "OBJECT",
	459	"reuse specified note object", parse_reuse_arg),
7aa4754e	460	OPT_BOOLEAN('f', "force", &force, "replace existing notes"),
160baa0d	461	OPT_BOOLEAN(0, "stdin", &from_stdin, "read objects from stdin"),
6956f858 TR	462	OPT_STRING(0, "for-rewrite", &rewrite_cmd, "command",
6956f858 TR	463	"load rewriting config for <command> (implies --stdin)"),
cd067d3b JH	464	OPT_END()
	465	};
	466
	467	git_config(git_default_config, NULL);
	468
	469	argc = parse_options(argc, argv, prefix, options, git_notes_usage, 0);
	470
e397421a JH	471	if (argc && !strcmp(argv[0], "list"))
e397421a JH	472	list = 1;
7aa4754e JH	473	else if (argc && !strcmp(argv[0], "add"))
7aa4754e JH	474	add = 1;
e73bbd96 JH	475	else if (argc && !strcmp(argv[0], "copy"))
e73bbd96 JH	476	copy = 1;
2347fae5 JH	477	else if (argc && !strcmp(argv[0], "append"))
2347fae5 JH	478	append = 1;
e397421a	479	else if (argc && !strcmp(argv[0], "edit"))
cd067d3b JH	480	edit = 1;
	481	else if (argc && !strcmp(argv[0], "show"))
	482	show = 1;
92b3385f JH	483	else if (argc && !strcmp(argv[0], "remove"))
92b3385f JH	484	remove = 1;
d6576e1f JH	485	else if (argc && !strcmp(argv[0], "prune"))
d6576e1f JH	486	prune = 1;
5848769f	487	else if (!argc) {
e397421a	488	list = 1; /* Default to 'list' if no other subcommand given */
5848769f JH	489	i = 0;
5848769f JH	490	}
cd067d3b	491
e73bbd96	492	if (list + add + copy + append + edit + show + remove + prune != 1)
cd067d3b JH	493	usage_with_options(git_notes_usage, options);
cd067d3b JH	494
348f199b	495	if (msg.given && !(add \|\| append \|\| edit)) {
0691cff7 JH	496	error("cannot use -m/-F/-c/-C options with %s subcommand.",
0691cff7 JH	497	argv[0]);
92b3385f JH	498	usage_with_options(git_notes_usage, options);
	499	}
	500
348f199b	501	if (msg.given && edit) {
0691cff7 JH	502	fprintf(stderr, "The -m/-F/-c/-C options have been deprecated "
	503	"for the 'edit' subcommand.\n"
	504	"Please use 'git notes add -f -m/-F/-c/-C' instead.\n");
aaec9bcf JH	505	}
aaec9bcf JH	506
e73bbd96	507	if (force && !(add \|\| copy)) {
7aa4754e JH	508	error("cannot use -f option with %s subcommand.", argv[0]);
	509	usage_with_options(git_notes_usage, options);
	510	}
	511
6956f858 TR	512	if (!copy && rewrite_cmd) {
	513	error("cannot use --for-rewrite with %s subcommand.", argv[0]);
	514	usage_with_options(git_notes_usage, options);
	515	}
160baa0d TR	516	if (!copy && from_stdin) {
	517	error("cannot use --stdin with %s subcommand.", argv[0]);
	518	usage_with_options(git_notes_usage, options);
	519	}
	520
e73bbd96 JH	521	if (copy) {
e73bbd96 JH	522	const char *from_ref;
6956f858	523	if (from_stdin \|\| rewrite_cmd) {
160baa0d TR	524	if (argc > 1) {
	525	error("too many parameters");
	526	usage_with_options(git_notes_usage, options);
	527	} else {
6956f858	528	return notes_copy_from_stdin(force, rewrite_cmd);
160baa0d TR	529	}
160baa0d TR	530	}
e73bbd96 JH	531	if (argc < 3) {
	532	error("too few parameters");
	533	usage_with_options(git_notes_usage, options);
	534	}
	535	from_ref = argv[i++];
	536	if (get_sha1(from_ref, from_obj))
	537	die("Failed to resolve '%s' as a valid ref.", from_ref);
	538	}
	539
5848769f JH	540	given_object = argc > i;
	541	object_ref = given_object ? argv[i++] : "HEAD";
	542
	543	if (argc > i \|\| (prune && given_object)) {
cd067d3b JH	544	error("too many parameters");
	545	usage_with_options(git_notes_usage, options);
	546	}
	547
	548	if (get_sha1(object_ref, object))
	549	die("Failed to resolve '%s' as a valid ref.", object_ref);
	550
	551	init_notes(NULL, NULL, NULL, 0);
	552	t = &default_notes_tree;
	553
	554	if (prefixcmp(t->ref, "refs/notes/"))
	555	die("Refusing to %s notes in %s (outside of refs/notes/)",
92b3385f	556	argv[0], t->ref);
cd067d3b JH	557
	558	note = get_note(t, object);
	559
e397421a JH	560	/* list command */
	561
	562	if (list) {
	563	if (given_object) {
	564	if (note) {
	565	puts(sha1_to_hex(note));
5848769f	566	goto end;
e397421a	567	}
5848769f JH	568	} else {
	569	retval = for_each_note(t, 0, list_each_note, NULL);
	570	goto end;
	571	}
e397421a JH	572	}
e397421a JH	573
cd067d3b JH	574	/* show command */
cd067d3b JH	575
e397421a	576	if ((list \|\| show) && !note) {
cd067d3b	577	error("No note found for object %s.", sha1_to_hex(object));
5848769f JH	578	retval = 1;
5848769f JH	579	goto end;
cd067d3b JH	580	} else if (show) {
cd067d3b JH	581	const char *show_args[3] = {"show", sha1_to_hex(note), NULL};
5848769f JH	582	retval = execv_git_cmd(show_args);
5848769f JH	583	goto end;
cd067d3b JH	584	}
cd067d3b JH	585
2347fae5	586	/* add/append/edit/remove/prune command */
7aa4754e	587
e73bbd96	588	if ((add \|\| copy) && note) {
5848769f	589	if (!force) {
e73bbd96	590	error("Cannot %s notes. Found existing notes for object"
5848769f	591	" %s. Use '-f' to overwrite existing notes",
e73bbd96	592	argv[0], sha1_to_hex(object));
5848769f JH	593	retval = 1;
5848769f JH	594	goto end;
7aa4754e	595	}
5848769f JH	596	fprintf(stderr, "Overwriting existing notes for object %s\n",
5848769f JH	597	sha1_to_hex(object));
7aa4754e	598	}
92b3385f	599
348f199b JH	600	if (remove) {
348f199b JH	601	msg.given = 1;
0691cff7	602	msg.use_editor = 0;
348f199b	603	strbuf_reset(&(msg.buf));
cd067d3b JH	604	}
cd067d3b JH	605
d6576e1f JH	606	if (prune) {
	607	hashclr(new_note);
	608	prune_notes(t);
5848769f	609	goto commit;
e73bbd96 JH	610	} else if (copy) {
	611	const unsigned char *from_note = get_note(t, from_obj);
	612	if (!from_note) {
	613	error("Missing notes on source object %s. Cannot copy.",
	614	sha1_to_hex(from_obj));
	615	retval = 1;
	616	goto end;
	617	}
	618	hashcpy(new_note, from_note);
5848769f	619	} else
348f199b	620	create_note(object, &msg, append, note, new_note);
5848769f JH	621
	622	if (is_null_sha1(new_note))
	623	remove_note(t, object);
	624	else
	625	add_note(t, object, new_note, combine_notes_overwrite);
	626
	627	commit:
	628	snprintf(logmsg, sizeof(logmsg), "Notes %s by 'git notes %s'",
92b3385f	629	is_null_sha1(new_note) ? "removed" : "added", argv[0]);
a0b4dfa9	630	commit_notes(t, logmsg);
cd067d3b	631
5848769f	632	end:
cd067d3b	633	free_notes(t);
348f199b	634	strbuf_release(&(msg.buf));
5848769f	635	return retval;
cd067d3b	636	}