note: use a git_buf to return the default namespace The caller has otherwise no way to know how long the string will be allocated or ability to free it. This fixes #2944.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 34553aa..112b8e9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -86,6 +86,9 @@ v0.22 + 1
non-snapshot configuration, as there can be no guarantee that the
returned pointer is valid.
+* `git_note_default_ref()` now uses a `git_buf` to return the string,
+ as the string is otherwise not guaranteed to stay allocated.
+
v0.22
------
diff --git a/include/git2/notes.h b/include/git2/notes.h
index bb7c02d..3a626ca 100644
--- a/include/git2/notes.h
+++ b/include/git2/notes.h
@@ -183,12 +183,12 @@ GIT_EXTERN(void) git_note_free(git_note *note);
/**
* Get the default notes reference for a repository
*
- * @param out Pointer to the default notes reference
+ * @param out buffer in which to store the name of the default notes reference
* @param repo The Git repository
*
* @return 0 or an error code
*/
-GIT_EXTERN(int) git_note_default_ref(const char **out, git_repository *repo);
+GIT_EXTERN(int) git_note_default_ref(git_buf *out, git_repository *repo);
/**
* Loop over all the notes within a specified namespace
diff --git a/src/notes.c b/src/notes.c
index 1850e81..ef4b41b 100644
--- a/src/notes.c
+++ b/src/notes.c
@@ -388,7 +388,7 @@ cleanup:
return error;
}
-static int note_get_default_ref(const char **out, git_repository *repo)
+static int note_get_default_ref(char **out, git_repository *repo)
{
git_config *cfg;
int ret = git_repository_config__weakptr(&cfg, repo);
@@ -399,27 +399,31 @@ static int note_get_default_ref(const char **out, git_repository *repo)
return ret;
}
-static int normalize_namespace(const char **notes_ref, git_repository *repo)
+static int normalize_namespace(char **out, git_repository *repo, const char *notes_ref)
{
- if (*notes_ref)
+ if (notes_ref) {
+ *out = git__strdup(notes_ref);
+ GITERR_CHECK_ALLOC(*out);
return 0;
+ }
- return note_get_default_ref(notes_ref, repo);
+ return note_get_default_ref(out, repo);
}
static int retrieve_note_tree_and_commit(
git_tree **tree_out,
git_commit **commit_out,
+ char **notes_ref_out,
git_repository *repo,
- const char **notes_ref)
+ const char *notes_ref)
{
int error;
git_oid oid;
- if ((error = normalize_namespace(notes_ref, repo)) < 0)
+ if ((error = normalize_namespace(notes_ref_out, repo, notes_ref)) < 0)
return error;
- if ((error = git_reference_name_to_id(&oid, repo, *notes_ref)) < 0)
+ if ((error = git_reference_name_to_id(&oid, repo, *notes_ref_out)) < 0)
return error;
if (git_commit_lookup(commit_out, repo, &oid) < 0)
@@ -432,10 +436,10 @@ static int retrieve_note_tree_and_commit(
}
int git_note_read(git_note **out, git_repository *repo,
- const char *notes_ref, const git_oid *oid)
+ const char *notes_ref_in, const git_oid *oid)
{
int error;
- char *target = NULL;
+ char *target = NULL, *notes_ref = NULL;
git_tree *tree = NULL;
git_commit *commit = NULL;
@@ -443,9 +447,10 @@ int git_note_read(git_note **out, git_repository *repo,
GITERR_CHECK_ALLOC(target);
if (!(error = retrieve_note_tree_and_commit(
- &tree, &commit, repo, ¬es_ref)))
+ &tree, &commit, ¬es_ref, repo, notes_ref_in)))
error = note_lookup(out, repo, commit, tree, target);
+ git__free(notes_ref);
git__free(target);
git_tree_free(tree);
git_commit_free(commit);
@@ -455,7 +460,7 @@ int git_note_read(git_note **out, git_repository *repo,
int git_note_create(
git_oid *out,
git_repository *repo,
- const char *notes_ref,
+ const char *notes_ref_in,
const git_signature *author,
const git_signature *committer,
const git_oid *oid,
@@ -463,14 +468,14 @@ int git_note_create(
int allow_note_overwrite)
{
int error;
- char *target = NULL;
+ char *target = NULL, *notes_ref = NULL;
git_commit *commit = NULL;
git_tree *tree = NULL;
target = git_oid_allocfmt(oid);
GITERR_CHECK_ALLOC(target);
- error = retrieve_note_tree_and_commit(&tree, &commit, repo, ¬es_ref);
+ error = retrieve_note_tree_and_commit(&tree, &commit, ¬es_ref, repo, notes_ref_in);
if (error < 0 && error != GIT_ENOTFOUND)
goto cleanup;
@@ -479,18 +484,19 @@ int git_note_create(
note, tree, target, &commit, allow_note_overwrite);
cleanup:
+ git__free(notes_ref);
git__free(target);
git_commit_free(commit);
git_tree_free(tree);
return error;
}
-int git_note_remove(git_repository *repo, const char *notes_ref,
+int git_note_remove(git_repository *repo, const char *notes_ref_in,
const git_signature *author, const git_signature *committer,
const git_oid *oid)
{
int error;
- char *target = NULL;
+ char *target = NULL, *notes_ref;
git_commit *commit = NULL;
git_tree *tree = NULL;
@@ -498,20 +504,31 @@ int git_note_remove(git_repository *repo, const char *notes_ref,
GITERR_CHECK_ALLOC(target);
if (!(error = retrieve_note_tree_and_commit(
- &tree, &commit, repo, ¬es_ref)))
+ &tree, &commit, ¬es_ref, repo, notes_ref_in)))
error = note_remove(
repo, author, committer, notes_ref, tree, target, &commit);
+ git__free(notes_ref);
git__free(target);
git_commit_free(commit);
git_tree_free(tree);
return error;
}
-int git_note_default_ref(const char **out, git_repository *repo)
+int git_note_default_ref(git_buf *out, git_repository *repo)
{
- assert(repo);
- return note_get_default_ref(out, repo);
+ char *default_ref;
+ int error;
+
+ assert(out && repo);
+
+ git_buf_sanitize(out);
+
+ if ((error = note_get_default_ref(&default_ref, repo)) < 0)
+ return error;
+
+ git_buf_attach(out, default_ref, strlen(default_ref));
+ return 0;
}
const git_signature *git_note_committer(const git_note *note)
@@ -635,13 +652,14 @@ void git_note_iterator_free(git_note_iterator *it)
int git_note_iterator_new(
git_note_iterator **it,
git_repository *repo,
- const char *notes_ref)
+ const char *notes_ref_in)
{
int error;
git_commit *commit = NULL;
git_tree *tree = NULL;
+ char *notes_ref;
- error = retrieve_note_tree_and_commit(&tree, &commit, repo, ¬es_ref);
+ error = retrieve_note_tree_and_commit(&tree, &commit, ¬es_ref, repo, notes_ref_in);
if (error < 0)
goto cleanup;
@@ -649,6 +667,7 @@ int git_note_iterator_new(
git_iterator_free(*it);
cleanup:
+ git__free(notes_ref);
git_tree_free(tree);
git_commit_free(commit);
diff --git a/tests/notes/notes.c b/tests/notes/notes.c
index d3b915e..a91bf5b 100644
--- a/tests/notes/notes.c
+++ b/tests/notes/notes.c
@@ -1,5 +1,7 @@
#include "clar_libgit2.h"
+#include "buffer.h"
+
static git_repository *_repo;
static git_signature *_sig;
@@ -150,7 +152,7 @@ void test_notes_notes__inserting_a_note_without_passing_a_namespace_uses_the_def
{
git_oid note_oid, target_oid;
git_note *note, *default_namespace_note;
- const char *default_ref;
+ git_buf default_ref = GIT_BUF_INIT;
cl_git_pass(git_oid_fromstr(&target_oid, "08b041783f40edfe12bb406c9c9a8a040177c125"));
cl_git_pass(git_note_default_ref(&default_ref, _repo));
@@ -158,11 +160,12 @@ void test_notes_notes__inserting_a_note_without_passing_a_namespace_uses_the_def
create_note(¬e_oid, NULL, "08b041783f40edfe12bb406c9c9a8a040177c125", "hello world\n");
cl_git_pass(git_note_read(¬e, _repo, NULL, &target_oid));
- cl_git_pass(git_note_read(&default_namespace_note, _repo, default_ref, &target_oid));
+ cl_git_pass(git_note_read(&default_namespace_note, _repo, git_buf_cstr(&default_ref), &target_oid));
assert_note_equal(note, "hello world\n", ¬e_oid);
assert_note_equal(default_namespace_note, "hello world\n", ¬e_oid);
+ git_buf_free(&default_ref);
git_note_free(note);
git_note_free(default_namespace_note);
}
diff --git a/tests/notes/notesref.c b/tests/notes/notesref.c
index 11391e4..4159ddc 100644
--- a/tests/notes/notesref.c
+++ b/tests/notes/notesref.c
@@ -1,6 +1,7 @@
#include "clar_libgit2.h"
#include "notes.h"
+#include "buffer.h"
static git_repository *_repo;
static git_note *_note;
@@ -33,7 +34,7 @@ void test_notes_notesref__cleanup(void)
void test_notes_notesref__config_corenotesref(void)
{
git_oid oid, note_oid;
- const char *default_ref;
+ git_buf default_ref = GIT_BUF_INIT;
cl_git_pass(git_signature_now(&_sig, "alice", "alice@example.com"));
cl_git_pass(git_oid_fromstr(&oid, "8496071c1b46c854b31185ea97743be6a8774479"));
@@ -55,10 +56,13 @@ void test_notes_notesref__config_corenotesref(void)
cl_assert_equal_oid(git_note_id(_note), ¬e_oid);
cl_git_pass(git_note_default_ref(&default_ref, _repo));
- cl_assert_equal_s("refs/notes/mydefaultnotesref", default_ref);
+ cl_assert_equal_s("refs/notes/mydefaultnotesref", default_ref.ptr);
+ git_buf_clear(&default_ref);
cl_git_pass(git_config_delete_entry(_cfg, "core.notesRef"));
cl_git_pass(git_note_default_ref(&default_ref, _repo));
- cl_assert_equal_s(GIT_NOTES_DEFAULT_REF, default_ref);
+ cl_assert_equal_s(GIT_NOTES_DEFAULT_REF, default_ref.ptr);
+
+ git_buf_free(&default_ref);
}