notes-utils.c

   1 #include "git-compat-util.h"
   2 #include "config.h"
   3 #include "commit.h"
   4 #include "environment.h"
   5 #include "gettext.h"
   6 #include "refs.h"
   7 #include "notes-utils.h"
   8 #include "repository.h"
   9 #include "strbuf.h"
  10
  11 void create_notes_commit(struct repository *r,
  12                          struct notes_tree *t,
  13                          struct commit_list *parents,
  14                          const char *msg, size_t msg_len,
  15                          struct object_id *result_oid)
  16 {
  17         struct object_id tree_oid;
  18
  19         assert(t->initialized);
  20
  21         if (write_notes_tree(t, &tree_oid))
  22                 die("Failed to write notes tree to database");
  23
  24         if (!parents) {
  25                 /* Deduce parent commit from t->ref */
  26                 struct object_id parent_oid;
  27                 if (!read_ref(t->ref, &parent_oid)) {
  28                         struct commit *parent = lookup_commit(r, &parent_oid);
  29                         if (repo_parse_commit(r, parent))
  30                                 die("Failed to find/parse commit %s", t->ref);
  31                         commit_list_insert(parent, &parents);
  32                 }
  33                 /* else: t->ref points to nothing, assume root/orphan commit */
  34         }
  35
  36         if (commit_tree(msg, msg_len, &tree_oid, parents, result_oid, NULL,
  37                         NULL))
  38                 die("Failed to commit notes tree to database");
  39 }
  40
  41 void commit_notes(struct repository *r, struct notes_tree *t, const char *msg)
  42 {
  43         struct strbuf buf = STRBUF_INIT;
  44         struct object_id commit_oid;
  45
  46         if (!t)
  47                 t = &default_notes_tree;
  48         if (!t->initialized || !t->update_ref || !*t->update_ref)
  49                 die(_("Cannot commit uninitialized/unreferenced notes tree"));
  50         if (!t->dirty)
  51                 return; /* don't have to commit an unchanged tree */
  52
  53         /* Prepare commit message and reflog message */
  54         strbuf_addstr(&buf, msg);
  55         strbuf_complete_line(&buf);
  56
  57         create_notes_commit(r, t, NULL, buf.buf, buf.len, &commit_oid);
  58         strbuf_insertstr(&buf, 0, "notes: ");
  59         update_ref(buf.buf, t->update_ref, &commit_oid, NULL, 0,
  60                    UPDATE_REFS_DIE_ON_ERR);
  61
  62         strbuf_release(&buf);
  63 }
  64
  65 int parse_notes_merge_strategy(const char *v, enum notes_merge_strategy *s)
  66 {
  67         if (!strcmp(v, "manual"))
  68                 *s = NOTES_MERGE_RESOLVE_MANUAL;
  69         else if (!strcmp(v, "ours"))
  70                 *s = NOTES_MERGE_RESOLVE_OURS;
  71         else if (!strcmp(v, "theirs"))
  72                 *s = NOTES_MERGE_RESOLVE_THEIRS;
  73         else if (!strcmp(v, "union"))
  74                 *s = NOTES_MERGE_RESOLVE_UNION;
  75         else if (!strcmp(v, "cat_sort_uniq"))
  76                 *s = NOTES_MERGE_RESOLVE_CAT_SORT_UNIQ;
  77         else
  78                 return -1;
  79
  80         return 0;
  81 }
  82
  83 static combine_notes_fn parse_combine_notes_fn(const char *v)
  84 {
  85         if (!strcasecmp(v, "overwrite"))
  86                 return combine_notes_overwrite;
  87         else if (!strcasecmp(v, "ignore"))
  88                 return combine_notes_ignore;
  89         else if (!strcasecmp(v, "concatenate"))
  90                 return combine_notes_concatenate;
  91         else if (!strcasecmp(v, "cat_sort_uniq"))
  92                 return combine_notes_cat_sort_uniq;
  93         else
  94                 return NULL;
  95 }
  96
  97 static int notes_rewrite_config(const char *k, const char *v,
  98                                 const struct config_context *ctx UNUSED,
  99                                 void *cb)
 100 {
 101         struct notes_rewrite_cfg *c = cb;
 102         if (starts_with(k, "notes.rewrite.") && !strcmp(k+14, c->cmd)) {
 103                 c->enabled = git_config_bool(k, v);
 104                 return 0;
 105         } else if (!c->mode_from_env && !strcmp(k, "notes.rewritemode")) {
 106                 if (!v)
 107                         return config_error_nonbool(k);
 108                 c->combine = parse_combine_notes_fn(v);
 109                 if (!c->combine) {
 110                         error(_("Bad notes.rewriteMode value: '%s'"), v);
 111                         return 1;
 112                 }
 113                 return 0;
 114         } else if (!c->refs_from_env && !strcmp(k, "notes.rewriteref")) {
 115                 if (!v)
 116                         return config_error_nonbool(k);
 117                 /* note that a refs/ prefix is implied in the
 118                  * underlying for_each_glob_ref */
 119                 if (starts_with(v, "refs/notes/"))
 120                         string_list_add_refs_by_glob(c->refs, v);
 121                 else
 122                         warning(_("Refusing to rewrite notes in %s"
 123                                 " (outside of refs/notes/)"), v);
 124                 return 0;
 125         }
 126
 127         return 0;
 128 }
 129
 130
 131 struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd)
 132 {
 133         struct notes_rewrite_cfg *c = xmalloc(sizeof(struct notes_rewrite_cfg));
 134         const char *rewrite_mode_env = getenv(GIT_NOTES_REWRITE_MODE_ENVIRONMENT);
 135         const char *rewrite_refs_env = getenv(GIT_NOTES_REWRITE_REF_ENVIRONMENT);
 136         c->cmd = cmd;
 137         c->enabled = 1;
 138         c->combine = combine_notes_concatenate;
 139         CALLOC_ARRAY(c->refs, 1);
 140         c->refs->strdup_strings = 1;
 141         c->refs_from_env = 0;
 142         c->mode_from_env = 0;
 143         if (rewrite_mode_env) {
 144                 c->mode_from_env = 1;
 145                 c->combine = parse_combine_notes_fn(rewrite_mode_env);
 146                 if (!c->combine)
 147                         /*
 148                          * TRANSLATORS: The first %s is the name of
 149                          * the environment variable, the second %s is
 150                          * its value.
 151                          */
 152                         error(_("Bad %s value: '%s'"), GIT_NOTES_REWRITE_MODE_ENVIRONMENT,
 153                                         rewrite_mode_env);
 154         }
 155         if (rewrite_refs_env) {
 156                 c->refs_from_env = 1;
 157                 string_list_add_refs_from_colon_sep(c->refs, rewrite_refs_env);
 158         }
 159         git_config(notes_rewrite_config, c);
 160         if (!c->enabled || !c->refs->nr) {
 161                 string_list_clear(c->refs, 0);
 162                 free(c->refs);
 163                 free(c);
 164                 return NULL;
 165         }
 166         c->trees = load_notes_trees(c->refs, NOTES_INIT_WRITABLE);
 167         string_list_clear(c->refs, 0);
 168         free(c->refs);
 169         return c;
 170 }
 171
 172 int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
 173                           const struct object_id *from_obj, const struct object_id *to_obj)
 174 {
 175         int ret = 0;
 176         int i;
 177         for (i = 0; c->trees[i]; i++)
 178                 ret = copy_note(c->trees[i], from_obj, to_obj, 1, c->combine) || ret;
 179         return ret;
 180 }
 181
 182 void finish_copy_notes_for_rewrite(struct repository *r,
 183                                    struct notes_rewrite_cfg *c,
 184                                    const char *msg)
 185 {
 186         int i;
 187         for (i = 0; c->trees[i]; i++) {
 188                 commit_notes(r, c->trees[i], msg);
 189                 free_notes(c->trees[i]);
 190         }
 191         free(c->trees);
 192         free(c);
 193 }