mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-19 15:14:23 +01:00
datastore: turn keys into arrays
After some discussion with @shesek, and my own usage, we agreed that a more comprehensive interface, which explicitly supports grouping, is desirable. Thus keys are now arrays, with the semantic that a key is either a parent or has a value, never both. For convenience in the JSON schema, we always return them as arrays, though we accept simple strings as arguments. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
Rusty Russell
committed by
Christian Decker
Christian Decker
parent
533571a655
commit
fe86c117d9
@@ -5,16 +5,23 @@
|
||||
#include <wallet/wallet.h>
|
||||
|
||||
static void json_add_datastore(struct json_stream *response,
|
||||
const char *key, const u8 *data,
|
||||
const char **key, const u8 *data,
|
||||
u64 generation)
|
||||
{
|
||||
const char *str;
|
||||
json_add_string(response, "key", key);
|
||||
json_add_u64(response, "generation", generation);
|
||||
json_add_hex(response, "hex", data, tal_bytelen(data));
|
||||
str = utf8_str(response, data, tal_bytelen(data));
|
||||
if (str)
|
||||
json_add_string(response, "string", str);
|
||||
json_array_start(response, "key");
|
||||
for (size_t i = 0; i < tal_count(key); i++)
|
||||
json_add_string(response, NULL, key[i]);
|
||||
json_array_end(response);
|
||||
|
||||
if (data) {
|
||||
const char *str;
|
||||
|
||||
json_add_u64(response, "generation", generation);
|
||||
json_add_hex(response, "hex", data, tal_bytelen(data));
|
||||
str = utf8_str(response, data, tal_bytelen(data));
|
||||
if (str)
|
||||
json_add_string(response, "string", str);
|
||||
}
|
||||
}
|
||||
|
||||
enum ds_mode {
|
||||
@@ -51,19 +58,78 @@ static struct command_result *param_mode(struct command *cmd,
|
||||
return NULL;
|
||||
}
|
||||
|
||||
static struct command_result *param_list_or_string(struct command *cmd,
|
||||
const char *name,
|
||||
const char *buffer,
|
||||
const jsmntok_t *tok,
|
||||
const char ***str)
|
||||
{
|
||||
if (tok->type == JSMN_ARRAY) {
|
||||
size_t i;
|
||||
const jsmntok_t *t;
|
||||
*str = tal_arr(cmd, const char *, tok->size);
|
||||
json_for_each_arr(i, t, tok) {
|
||||
if (t->type != JSMN_STRING && t->type != JSMN_PRIMITIVE)
|
||||
return command_fail_badparam(cmd, name,
|
||||
buffer, t,
|
||||
"should be string");
|
||||
(*str)[i] = json_strdup(*str, buffer, t);
|
||||
}
|
||||
} else if (tok->type == JSMN_STRING || tok->type == JSMN_PRIMITIVE) {
|
||||
*str = tal_arr(cmd, const char *, 1);
|
||||
(*str)[0] = json_strdup(*str, buffer, tok);
|
||||
} else
|
||||
return command_fail_badparam(cmd, name,
|
||||
buffer, tok,
|
||||
"should be string or array");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* Does k1 match k2 as far as k2 goes? */
|
||||
static bool datastore_key_startswith(const char **k1, const char **k2)
|
||||
{
|
||||
size_t k1len = tal_count(k1), k2len = tal_count(k2);
|
||||
|
||||
if (k2len > k1len)
|
||||
return false;
|
||||
|
||||
for (size_t i = 0; i < k2len; i++) {
|
||||
if (!streq(k1[i], k2[i]))
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
static bool datastore_key_eq(const char **k1, const char **k2)
|
||||
{
|
||||
return tal_count(k1) == tal_count(k2)
|
||||
&& datastore_key_startswith(k1, k2);
|
||||
}
|
||||
|
||||
static char *datastore_key_fmt(const tal_t *ctx, const char **key)
|
||||
{
|
||||
char *ret = tal_strdup(ctx, "[");
|
||||
for (size_t i = 0; i < tal_count(key); i++)
|
||||
tal_append_fmt(&ret, "%s%s", i ? "," : "", key[i]);
|
||||
tal_append_fmt(&ret, "]");
|
||||
return ret;
|
||||
}
|
||||
|
||||
static struct command_result *json_datastore(struct command *cmd,
|
||||
const char *buffer,
|
||||
const jsmntok_t *obj UNNEEDED,
|
||||
const jsmntok_t *params)
|
||||
{
|
||||
struct json_stream *response;
|
||||
const char *key, *strdata;
|
||||
u8 *data, *prevdata;
|
||||
const char **key, *strdata, **k;
|
||||
u8 *data;
|
||||
const u8 *prevdata;
|
||||
enum ds_mode *mode;
|
||||
u64 *generation, actual_gen;
|
||||
struct db_stmt *stmt;
|
||||
|
||||
if (!param(cmd, buffer, params,
|
||||
p_req("key", param_string, &key),
|
||||
p_req("key", param_list_or_string, &key),
|
||||
p_opt("string", param_string, &strdata),
|
||||
p_opt("hex", param_bin_from_hex, &data),
|
||||
p_opt_def("mode", param_mode, &mode, DS_MUST_NOT_EXIST),
|
||||
@@ -87,8 +153,40 @@ static struct command_result *json_datastore(struct command *cmd,
|
||||
"generation only valid with must-replace"
|
||||
" or must-append");
|
||||
|
||||
prevdata = wallet_datastore_fetch(cmd, cmd->ld->wallet, key,
|
||||
&actual_gen);
|
||||
/* Fetch, and make sure we don't have children! */
|
||||
stmt = wallet_datastore_first(cmd, cmd->ld->wallet, key,
|
||||
&k, &prevdata, &actual_gen);
|
||||
tal_free(stmt);
|
||||
|
||||
/* We use prevdata as a "does it exist?" flag */
|
||||
if (!stmt)
|
||||
prevdata = NULL;
|
||||
else if (!datastore_key_eq(k, key)) {
|
||||
prevdata = tal_free(prevdata);
|
||||
/* Make sure we don't have a child! */
|
||||
if (datastore_key_startswith(k, key))
|
||||
return command_fail(cmd, DATASTORE_UPDATE_HAS_CHILDREN,
|
||||
"Key has children already");
|
||||
}
|
||||
|
||||
/* We have to make sure that parents don't exist. */
|
||||
if (!prevdata) {
|
||||
for (size_t i = 1; i < tal_count(key); i++) {
|
||||
const char **parent;
|
||||
parent = tal_dup_arr(cmd, const char *, key, i, 0);
|
||||
|
||||
stmt = wallet_datastore_first(cmd, cmd->ld->wallet,
|
||||
parent, &k, NULL, NULL);
|
||||
tal_free(stmt);
|
||||
if (stmt && datastore_key_eq(k, parent))
|
||||
return command_fail(cmd,
|
||||
DATASTORE_UPDATE_NO_CHILDREN,
|
||||
"Parent key %s exists",
|
||||
datastore_key_fmt(tmpctx,
|
||||
parent));
|
||||
}
|
||||
}
|
||||
|
||||
if ((*mode & DS_MUST_NOT_EXIST) && prevdata)
|
||||
return command_fail(cmd, DATASTORE_UPDATE_ALREADY_EXISTS,
|
||||
"Key already exists");
|
||||
@@ -103,9 +201,10 @@ static struct command_result *json_datastore(struct command *cmd,
|
||||
|
||||
if ((*mode & DS_APPEND) && prevdata) {
|
||||
size_t prevlen = tal_bytelen(prevdata);
|
||||
tal_resize(&prevdata, prevlen + tal_bytelen(data));
|
||||
memcpy(prevdata + prevlen, data, tal_bytelen(data));
|
||||
data = prevdata;
|
||||
u8 *newdata = tal_arr(cmd, u8, prevlen + tal_bytelen(data));
|
||||
memcpy(newdata, prevdata, prevlen);
|
||||
memcpy(newdata + prevlen, data, tal_bytelen(data));
|
||||
data = newdata;
|
||||
}
|
||||
|
||||
if (prevdata) {
|
||||
@@ -127,36 +226,50 @@ static struct command_result *json_listdatastore(struct command *cmd,
|
||||
const jsmntok_t *params)
|
||||
{
|
||||
struct json_stream *response;
|
||||
const char *key;
|
||||
const char **key, **k, **prev_k = NULL;
|
||||
const u8 *data;
|
||||
u64 generation;
|
||||
struct db_stmt *stmt;
|
||||
|
||||
if (!param(cmd, buffer, params,
|
||||
p_opt("key", param_string, &key),
|
||||
p_opt("key", param_list_or_string, &key),
|
||||
NULL))
|
||||
return command_param_failed();
|
||||
|
||||
if (key)
|
||||
log_debug(cmd->ld->log, "Looking for %s",
|
||||
datastore_key_fmt(tmpctx, key));
|
||||
|
||||
response = json_stream_success(cmd);
|
||||
json_array_start(response, "datastore");
|
||||
if (key) {
|
||||
data = wallet_datastore_fetch(cmd, cmd->ld->wallet, key,
|
||||
&generation);
|
||||
if (data) {
|
||||
json_object_start(response, NULL);
|
||||
json_add_datastore(response, key, data, generation);
|
||||
json_object_end(response);
|
||||
}
|
||||
} else {
|
||||
struct db_stmt *stmt;
|
||||
|
||||
for (stmt = wallet_datastore_first(cmd, cmd->ld->wallet,
|
||||
&key, &data, &generation);
|
||||
stmt;
|
||||
stmt = wallet_datastore_next(cmd, cmd->ld->wallet,
|
||||
stmt, &key, &data,
|
||||
&generation)) {
|
||||
for (stmt = wallet_datastore_first(cmd, cmd->ld->wallet, key,
|
||||
&k, &data, &generation);
|
||||
stmt;
|
||||
stmt = wallet_datastore_next(cmd, cmd->ld->wallet,
|
||||
stmt, &k, &data,
|
||||
&generation)) {
|
||||
log_debug(cmd->ld->log, "Got %s",
|
||||
datastore_key_fmt(tmpctx, k));
|
||||
|
||||
/* Don't list children, except implicitly */
|
||||
if (tal_count(k) > tal_count(key) + 1) {
|
||||
log_debug(cmd->ld->log, "Too long");
|
||||
if (!prev_k || !datastore_key_startswith(k, prev_k)) {
|
||||
prev_k = tal_dup_arr(cmd, const char *, k,
|
||||
tal_count(key) + 1, 0);
|
||||
json_object_start(response, NULL);
|
||||
json_add_datastore(response, prev_k, NULL, 0);
|
||||
json_object_end(response);
|
||||
}
|
||||
} else if (key && !datastore_key_startswith(k, key)) {
|
||||
log_debug(cmd->ld->log, "Not interested");
|
||||
tal_free(stmt);
|
||||
break;
|
||||
} else {
|
||||
log_debug(cmd->ld->log, "Printing");
|
||||
json_object_start(response, NULL);
|
||||
json_add_datastore(response, key, data, generation);
|
||||
json_add_datastore(response, k, data, generation);
|
||||
json_object_end(response);
|
||||
}
|
||||
}
|
||||
@@ -170,28 +283,31 @@ static struct command_result *json_deldatastore(struct command *cmd,
|
||||
const jsmntok_t *params)
|
||||
{
|
||||
struct json_stream *response;
|
||||
const char *key;
|
||||
u8 *data;
|
||||
const char **key, **k;
|
||||
const u8 *data;
|
||||
u64 *generation;
|
||||
u64 actual_gen;
|
||||
struct db_stmt *stmt;
|
||||
|
||||
if (!param(cmd, buffer, params,
|
||||
p_req("key", param_string, &key),
|
||||
p_req("key", param_list_or_string, &key),
|
||||
p_opt("generation", param_u64, &generation),
|
||||
NULL))
|
||||
return command_param_failed();
|
||||
|
||||
if (generation) {
|
||||
data = wallet_datastore_fetch(cmd, cmd->ld->wallet, key,
|
||||
&actual_gen);
|
||||
if (data && actual_gen != *generation)
|
||||
return command_fail(cmd, DATASTORE_DEL_WRONG_GENERATION,
|
||||
"generation is different");
|
||||
}
|
||||
data = wallet_datastore_remove(cmd, cmd->ld->wallet, key, &actual_gen);
|
||||
if (!data)
|
||||
stmt = wallet_datastore_first(cmd, cmd->ld->wallet, key,
|
||||
&k, &data, &actual_gen);
|
||||
tal_free(stmt);
|
||||
|
||||
if (!stmt || !datastore_key_eq(k, key)) {
|
||||
return command_fail(cmd, DATASTORE_DEL_DOES_NOT_EXIST,
|
||||
"Key does not exist");
|
||||
}
|
||||
if (generation && actual_gen != *generation)
|
||||
return command_fail(cmd, DATASTORE_DEL_WRONG_GENERATION,
|
||||
"generation is different");
|
||||
|
||||
wallet_datastore_remove(cmd->ld->wallet, key);
|
||||
|
||||
response = json_stream_success(cmd);
|
||||
json_add_datastore(response, key, data, actual_gen);
|
||||
|
||||
Reference in New Issue
Block a user