Commit 60ebc137bc38a5cff67cf86023447111b96f7d4d
2018-08-10T14:53:09
config_entries: abstract away retrieval of config entries The code accessing config entries in the `git_config_entries` structure is still much too intimate with implementation details, directly accessing the maps and handling indices. Provide two new functions to get config entries from the internal map structure to decouple the interfaces and use them in the config file code. The function `git_config_entries_get` will simply look up the entry by name and, in the case of a multi-value, return the last occurrence of that entry. The second function, `git_config_entries_get_unique`, will only return an entry if it is unique and not included via another configuration file. This one is required to properly implement write operations for single entries, as we refuse to write to or delete a single entry if it is not clear which one was meant.
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 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
diff --git a/src/config_entries.c b/src/config_entries.c
index 576ddfd..a852045 100644
--- a/src/config_entries.c
+++ b/src/config_entries.c
@@ -113,6 +113,56 @@ int git_config_entries_append(git_config_entries *entries, git_config_entry *ent
return error;
}
+int config_entry_get(config_entry_list **out, git_config_entries *entries, const char *key)
+{
+ khiter_t pos;
+
+ pos = git_strmap_lookup_index(entries->map, key);
+
+ /* no error message; the config system will write one */
+ if (!git_strmap_valid_index(entries->map, pos))
+ return GIT_ENOTFOUND;
+
+ *out = git_strmap_value_at(entries->map, pos);
+
+ return 0;
+}
+
+int git_config_entries_get(git_config_entry **out, git_config_entries *entries, const char *key)
+{
+ config_entry_list *entry;
+ int error;
+
+ if ((error = config_entry_get(&entry, entries, key)) < 0)
+ return error;
+ *out = entry->last->entry;
+
+ return 0;
+}
+
+int git_config_entries_get_unique(git_config_entry **out, git_config_entries *entries, const char *key)
+{
+ config_entry_list *entry;
+ int error;
+
+ if ((error = config_entry_get(&entry, entries, key)) < 0)
+ return error;
+
+ if (entry->next != NULL) {
+ giterr_set(GITERR_CONFIG, "entry is not unique due to being a multivar");
+ return -1;
+ }
+
+ if (entry->entry->include_depth) {
+ giterr_set(GITERR_CONFIG, "entry is not unique due to being included");
+ return -1;
+ }
+
+ *out = entry->entry;
+
+ return 0;
+}
+
void config_iterator_free(
git_config_iterator* iter)
{
diff --git a/src/config_entries.h b/src/config_entries.h
index d74e172..555f9be 100644
--- a/src/config_entries.h
+++ b/src/config_entries.h
@@ -31,6 +31,8 @@ int git_config_entries_new(git_config_entries **out);
void git_config_entries_free(git_config_entries *entries);
/* Add or append the new config option */
int git_config_entries_append(git_config_entries *entries, git_config_entry *entry);
+int git_config_entries_get(git_config_entry **out, git_config_entries *entries, const char *key);
+int git_config_entries_get_unique(git_config_entry **out, git_config_entries *entries, const char *key);
void config_iterator_free(git_config_iterator* iter);
int config_iterator_next(git_config_entry **entry,
diff --git a/src/config_file.c b/src/config_file.c
index a93af53..71de2b6 100644
--- a/src/config_file.c
+++ b/src/config_file.c
@@ -260,64 +260,44 @@ static int config_set(git_config_backend *cfg, const char *name, const char *val
{
diskfile_backend *b = (diskfile_backend *)cfg;
git_config_entries *entries;
- git_strmap *entry_map;
+ git_config_entry *existing;
char *key, *esc_value = NULL;
- khiter_t pos;
- int rval, ret;
+ int error;
- if ((rval = git_config__normalize_name(name, &key)) < 0)
- return rval;
+ if ((error = git_config__normalize_name(name, &key)) < 0)
+ return error;
if ((entries = diskfile_entries_take(&b->header)) == NULL)
return -1;
- entry_map = entries->map;
-
- /*
- * Try to find it in the existing values and update it if it
- * only has one value.
- */
- pos = git_strmap_lookup_index(entry_map, key);
- if (git_strmap_valid_index(entry_map, pos)) {
- config_entry_list *existing = git_strmap_value_at(entry_map, pos);
- if (existing->next != NULL) {
- giterr_set(GITERR_CONFIG, "multivar incompatible with simple set");
- ret = -1;
+ /* Check whether we'd be modifying an included or multivar key */
+ if ((error = git_config_entries_get_unique(&existing, entries, key)) < 0) {
+ if (error != GIT_ENOTFOUND)
goto out;
- }
-
- if (existing->entry->include_depth) {
- giterr_set(GITERR_CONFIG, "modifying included variable is not supported");
- ret = -1;
- goto out;
- }
-
+ error = 0;
+ } else if ((!existing->value && !value) ||
+ (existing->value && value && !strcmp(existing->value, value))) {
/* don't update if old and new values already match */
- if ((!existing->entry->value && !value) ||
- (existing->entry->value && value &&
- !strcmp(existing->entry->value, value))) {
- ret = 0;
- goto out;
- }
+ error = 0;
+ goto out;
}
/* No early returns due to sanity checks, let's write it out and refresh */
-
if (value) {
esc_value = escape_value(value);
GITERR_CHECK_ALLOC(esc_value);
}
- if ((ret = config_write(b, name, key, NULL, esc_value)) < 0)
+ if ((error = config_write(b, name, key, NULL, esc_value)) < 0)
goto out;
- ret = config_refresh(cfg);
+ error = config_refresh(cfg);
out:
git_config_entries_free(entries);
git__free(esc_value);
git__free(key);
- return ret;
+ return error;
}
/* release the map containing the entry as an equivalent to freeing it */
@@ -333,10 +313,8 @@ static void free_diskfile_entry(git_config_entry *entry)
static int config_get(git_config_backend *cfg, const char *key, git_config_entry **out)
{
diskfile_header *h = (diskfile_header *)cfg;
- git_config_entries *entries;
- git_strmap *entry_map;
- khiter_t pos;
- config_entry_list *var;
+ git_config_entries *entries = NULL;
+ git_config_entry *entry;
int error = 0;
if (!h->parent.readonly && ((error = config_refresh(cfg)) < 0))
@@ -344,22 +322,17 @@ static int config_get(git_config_backend *cfg, const char *key, git_config_entry
if ((entries = diskfile_entries_take(h)) == NULL)
return -1;
- entry_map = entries->map;
-
- pos = git_strmap_lookup_index(entry_map, key);
- /* no error message; the config system will write one */
- if (!git_strmap_valid_index(entry_map, pos)) {
+ if ((error = (git_config_entries_get(&entry, entries, key))) < 0) {
git_config_entries_free(entries);
- return GIT_ENOTFOUND;
+ return error;
}
- var = git_strmap_value_at(entry_map, pos);
- *out = var->last->entry;
- (*out)->free = free_diskfile_entry;
- (*out)->payload = entries;
+ entry->free = free_diskfile_entry;
+ entry->payload = entries;
+ *out = entry;
- return error;
+ return 0;
}
static int config_set_multivar(
@@ -397,79 +370,61 @@ out:
static int config_delete(git_config_backend *cfg, const char *name)
{
- config_entry_list *var;
diskfile_backend *b = (diskfile_backend *)cfg;
- git_config_entries *entries;
- git_strmap *entry_map;
- char *key;
- int result;
- khiter_t pos;
+ git_config_entries *entries = NULL;
+ git_config_entry *entry;
+ char *key = NULL;
+ int error;
- if ((result = git_config__normalize_name(name, &key)) < 0)
- return result;
+ if ((error = git_config__normalize_name(name, &key)) < 0)
+ goto out;
if ((entries = diskfile_entries_take(&b->header)) == NULL)
- return -1;
- entry_map = b->header.entries->map;
-
- pos = git_strmap_lookup_index(entry_map, key);
- git__free(key);
-
- if (!git_strmap_valid_index(entry_map, pos)) {
- git_config_entries_free(entries);
- giterr_set(GITERR_CONFIG, "could not find key '%s' to delete", name);
- return GIT_ENOTFOUND;
- }
-
- var = git_strmap_value_at(entry_map, pos);
- git_config_entries_free(entries);
+ goto out;
- if (var->entry->include_depth) {
- giterr_set(GITERR_CONFIG, "cannot delete included variable");
- return -1;
+ /* Check whether we'd be modifying an included or multivar key */
+ if ((error = git_config_entries_get_unique(&entry, entries, key)) < 0) {
+ if (error == GIT_ENOTFOUND)
+ giterr_set(GITERR_CONFIG, "could not find key '%s' to delete", name);
+ goto out;
}
- if (var->next != NULL) {
- giterr_set(GITERR_CONFIG, "cannot delete multivar with a single delete");
- return -1;
- }
+ if ((error = config_write(b, name, entry->name, NULL, NULL)) < 0)
+ goto out;
- if ((result = config_write(b, name, var->entry->name, NULL, NULL)) < 0)
- return result;
+ if ((error = config_refresh(cfg)) < 0)
+ goto out;
- return config_refresh(cfg);
+out:
+ git_config_entries_free(entries);
+ git__free(key);
+ return error;
}
static int config_delete_multivar(git_config_backend *cfg, const char *name, const char *regexp)
{
diskfile_backend *b = (diskfile_backend *)cfg;
- git_config_entries *entries;
- git_strmap *entry_map;
- char *key;
- regex_t preg;
+ git_config_entries *entries = NULL;
+ git_config_entry *entry = NULL;
+ regex_t preg = { 0 };
+ char *key = NULL;
int result;
- khiter_t pos;
if ((result = git_config__normalize_name(name, &key)) < 0)
- return result;
-
- if ((entries = diskfile_entries_take(&b->header)) == NULL)
- return -1;
- entry_map = b->header.entries->map;
-
- pos = git_strmap_lookup_index(entry_map, key);
+ goto out;
- if (!git_strmap_valid_index(entry_map, pos)) {
- git_config_entries_free(entries);
- git__free(key);
- giterr_set(GITERR_CONFIG, "could not find key '%s' to delete", name);
- return GIT_ENOTFOUND;
+ if ((entries = diskfile_entries_take(&b->header)) == NULL) {
+ result = -1;
+ goto out;
}
- git_config_entries_free(entries);
+ if ((result = git_config_entries_get(&entry, entries, key)) < 0) {
+ if (result == GIT_ENOTFOUND)
+ giterr_set(GITERR_CONFIG, "could not find key '%s' to delete", name);
+ goto out;
+ }
- result = p_regcomp(&preg, regexp, REG_EXTENDED);
- if (result != 0) {
+ if ((result = p_regcomp(&preg, regexp, REG_EXTENDED)) != 0) {
giterr_set_regex(&preg, result);
result = -1;
goto out;
@@ -478,9 +433,11 @@ static int config_delete_multivar(git_config_backend *cfg, const char *name, con
if ((result = config_write(b, name, key, &preg, NULL)) < 0)
goto out;
- result = config_refresh(cfg);
+ if ((result = config_refresh(cfg)) < 0)
+ goto out;
out:
+ git_config_entries_free(entries);
git__free(key);
regfree(&preg);
return result;