Clarify and improve k5_json_object_set

Document that k5_json_object_set can be used to overwrite an existing
key, and make it possible to remove a key by setting it to NULL.

2 files changed, 25 insertions, 3 deletions

diff --git a/src/util/support/json.c b/src/util/support/json.c
index b2dd1333e7..b99fabd496 100644
--- a/src/util/support/json.c
+++ b/src/util/support/json.c
@@ -429,15 +429,28 @@ int
 k5_json_object_set(k5_json_object obj, const char *key, k5_json_value val)
 {
     struct entry *ent, *ptr;
-    size_t new_alloc;
+    size_t new_alloc, i;
 
     ent = object_search(obj, key);
-    if (ent) {
+    if (ent != NULL) {
         k5_json_release(ent->value);
-        ent->value = k5_json_retain(val);
+        if (val == NULL) {
+            /* Remove this key. */
+            free(ent->key);
+            for (i = ent - obj->entries; i < obj->len - 1; i++)
+                obj->entries[i] = obj->entries[i + 1];
+            obj->len--;
+        } else {
+            /* Overwrite this key's value with the new one. */
+            ent->value = k5_json_retain(val);
+        }
         return 0;
     }
 
+    /* If didn't find a key the caller asked to remove, do nothing. */
+    if (val == NULL)
+        return 0;
+
     if (obj->len >= obj->allocated) {
         /* Increase the number of slots by 50% (16 slots minimum). */
         new_alloc = obj->len + 1 + (obj->len >> 1);
diff --git a/src/util/support/t_json.c b/src/util/support/t_json.c
index 040a85a914..1f229247b4 100644
--- a/src/util/support/t_json.c
+++ b/src/util/support/t_json.c
@@ -165,6 +165,15 @@ test_object(void)
     if (strcmp(k5_json_string_utf8(s), "hejsan") != 0)
         err("Retrieving key2 from object failed");
 
+    check(k5_json_object_get(object, "key3") == NULL,
+          "object nonexistent key");
+
+    k5_json_object_set(object, "key1", NULL);
+    check(k5_json_object_get(object, "key1") == NULL,
+          "object removed key");
+    check(k5_json_object_get(object, "key2") != NULL,
+          "object remaining key");
+
     k5_json_release(v1);
     k5_json_release(v2);
     k5_json_release(object);