mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-03-15 20:09:18 +01:00
listconfigs: show plugin options in 'configs' with normal options.
This integrates them with configvars properly: they almost "just work" in listconfigs now, and we don't put them in a special sub-object under their plugin. Unfortunately, this means `listconfigs` now has a loose schema: any plugin can add something to it. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: Plugins: reloaded plugins get passed any vars from configuration files. Changelog-Deprecated: Config: boolean plugin options set to `1` or `0` (use `true` and `false` like non-plugin options).
This commit is contained in:
Rusty Russell
parent
1b252f349f
commit
9cb2b2f13a
8 changed files with 320 additions and 246 deletions
|
|
@ -1713,7 +1713,7 @@ static void json_add_opt_subdaemons(struct json_stream *response,
|
|||
}
|
||||
|
||||
/* Canonicalize value they've given */
|
||||
static bool canon_bool(const char *val)
|
||||
bool opt_canon_bool(const char *val)
|
||||
{
|
||||
bool b;
|
||||
opt_set_bool_arg(val, &b);
|
||||
|
|
@ -1750,6 +1750,10 @@ static void add_config_deprecated(struct lightningd *ld,
|
|||
if (opt->desc == opt_hidden)
|
||||
return;
|
||||
|
||||
/* We print plugin options under plugins[] or important-plugins[] */
|
||||
if (is_plugin_opt(opt))
|
||||
return;
|
||||
|
||||
if (opt->type & OPT_NOARG) {
|
||||
if (opt->cb == (void *)opt_clear_plugins) {
|
||||
/* FIXME: we can't recover this. */
|
||||
|
|
@ -1801,12 +1805,9 @@ static void add_config_deprecated(struct lightningd *ld,
|
|||
feature_offered(ld->our_features
|
||||
->bits[INIT_FEATURE],
|
||||
OPT_QUIESCE));
|
||||
} else if (opt->cb == (void *)plugin_opt_flag_set) {
|
||||
/* Noop, they will get added below along with the
|
||||
* OPT_HASARG options. */
|
||||
} else {
|
||||
/* Insert more decodes here! */
|
||||
errx(1, "Unknown decode for %s", opt->names);
|
||||
errx(1, "Unknown nonarg decode for %s", opt->names);
|
||||
}
|
||||
} else if (opt->type & OPT_HASARG) {
|
||||
if (opt->show == (void *)opt_show_charp) {
|
||||
|
|
@ -1828,7 +1829,7 @@ static void add_config_deprecated(struct lightningd *ld,
|
|||
return;
|
||||
} else if (opt->type & OPT_SHOWBOOL) {
|
||||
/* We allow variants here. Json-ize */
|
||||
json_add_bool(response, name0, canon_bool(buf));
|
||||
json_add_bool(response, name0, opt_canon_bool(buf));
|
||||
return;
|
||||
}
|
||||
answer = buf;
|
||||
|
|
@ -1889,9 +1890,7 @@ static void add_config_deprecated(struct lightningd *ld,
|
|||
} else if (opt->cb_arg == (void *)opt_important_plugin) {
|
||||
/* Do nothing, this is already handled by
|
||||
* opt_add_plugin. */
|
||||
} else if (opt->cb_arg == (void *)opt_add_plugin_dir
|
||||
|| opt->cb_arg == (void *)plugin_opt_set
|
||||
|| opt->cb_arg == (void *)plugin_opt_flag_set) {
|
||||
} else if (opt->cb_arg == (void *)opt_add_plugin_dir) {
|
||||
/* FIXME: We actually treat it as if they specified
|
||||
* --plugin for each one, so ignore these */
|
||||
} else if (opt->cb_arg == (void *)opt_add_accept_htlc_tlv) {
|
||||
|
|
@ -1913,7 +1912,7 @@ static void add_config_deprecated(struct lightningd *ld,
|
|||
#endif
|
||||
} else {
|
||||
/* Insert more decodes here! */
|
||||
errx(1, "Unknown decode for %s", opt->names);
|
||||
errx(1, "Unknown arg decode for %s", opt->names);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -1974,6 +1973,10 @@ static const char *get_opt_val(const struct opt_table *ot,
|
|||
return *(char **)ot->u.carg;
|
||||
}
|
||||
if (ot->show) {
|
||||
/* Plugins options' show only shows defaults, so show val if
|
||||
* we have it */
|
||||
if (is_plugin_opt(ot) && cv)
|
||||
return cv->optarg;
|
||||
strcpy(buf + CONFIG_SHOW_BUFSIZE, "...");
|
||||
if (ot->show(buf, CONFIG_SHOW_BUFSIZE, ot->u.carg))
|
||||
return buf;
|
||||
|
|
@ -2025,7 +2028,7 @@ static void json_add_configval(struct json_stream *result,
|
|||
const char *str)
|
||||
{
|
||||
if (ot->type & OPT_SHOWBOOL) {
|
||||
json_add_bool(result, fieldname, canon_bool(str));
|
||||
json_add_bool(result, fieldname, opt_canon_bool(str));
|
||||
} else if (ot->type & (OPT_SHOWMSATS|OPT_SHOWINT)) {
|
||||
check_literal(ot->names, str);
|
||||
json_add_primitive(result, fieldname, str);
|
||||
|
|
@ -2068,11 +2071,6 @@ static void json_add_config(struct lightningd *ld,
|
|||
}
|
||||
|
||||
assert(ot->type & OPT_HASARG);
|
||||
|
||||
/* FIXME: handle plugin options: either the default or what they set */
|
||||
if (ot->cb_arg == (void *)plugin_opt_set)
|
||||
return;
|
||||
|
||||
if (ot->type & OPT_MULTI) {
|
||||
json_object_start(response, names[0]);
|
||||
json_array_start(response, configval_fieldname(ot));
|
||||
|
|
|
|||
|
|
@ -22,4 +22,6 @@ enum opt_autobool {
|
|||
char *opt_set_autobool_arg(const char *arg, enum opt_autobool *b);
|
||||
bool opt_show_autobool(char *buf, size_t len, const enum opt_autobool *b);
|
||||
|
||||
/* opt_bool is quite loose; you should use this if wanting to add it to JSON */
|
||||
bool opt_canon_bool(const char *val);
|
||||
#endif /* LIGHTNING_LIGHTNINGD_OPTIONS_H */
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@
|
|||
#include <ccan/tal/str/str.h>
|
||||
#include <ccan/utf8/utf8.h>
|
||||
#include <common/configdir.h>
|
||||
#include <common/configvar.h>
|
||||
#include <common/features.h>
|
||||
#include <common/json_command.h>
|
||||
#include <common/memleak.h>
|
||||
|
|
@ -819,95 +820,77 @@ struct io_plan *plugin_stdout_conn_init(struct io_conn *conn,
|
|||
plugin_read_json, plugin);
|
||||
}
|
||||
|
||||
|
||||
/* Returns NULL if invalid value for that type */
|
||||
static struct plugin_opt_value *plugin_opt_value(const tal_t *ctx,
|
||||
const char *type,
|
||||
const char *arg)
|
||||
static char *plugin_opt_check(struct plugin_opt *popt)
|
||||
{
|
||||
struct plugin_opt_value *v = tal(ctx, struct plugin_opt_value);
|
||||
|
||||
v->as_str = tal_strdup(v, arg);
|
||||
if (streq(type, "int")) {
|
||||
long long l;
|
||||
char *endp;
|
||||
|
||||
errno = 0;
|
||||
l = strtoll(arg, &endp, 0);
|
||||
if (errno || *endp)
|
||||
return tal_free(v);
|
||||
v->as_int = l;
|
||||
|
||||
/* Check if the number did not fit in `s64` (in case `long long`
|
||||
* is a bigger type). */
|
||||
if (v->as_int != l)
|
||||
return tal_free(v);
|
||||
} else if (streq(type, "bool")) {
|
||||
/* valid values are 'true', 'True', '1', '0', 'false', 'False', or '' */
|
||||
if (streq(arg, "true") || streq(arg, "True") || streq(arg, "1")) {
|
||||
v->as_bool = true;
|
||||
} else if (streq(arg, "false") || streq(arg, "False")
|
||||
|| streq(arg, "0")) {
|
||||
v->as_bool = false;
|
||||
} else
|
||||
return tal_free(v);
|
||||
} else if (streq(type, "flag")) {
|
||||
v->as_bool = true;
|
||||
}
|
||||
|
||||
return v;
|
||||
}
|
||||
|
||||
char *plugin_opt_flag_set(struct plugin_opt *popt)
|
||||
{
|
||||
/* A set flag is a true */
|
||||
tal_free(popt->values);
|
||||
popt->values = tal_arr(popt, struct plugin_opt_value *, 1);
|
||||
popt->values[0] = plugin_opt_value(popt->values, popt->type, "true");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
char *plugin_opt_set(const char *arg, struct plugin_opt *popt)
|
||||
{
|
||||
struct plugin_opt_value *v;
|
||||
|
||||
/* Warn them that this is deprecated */
|
||||
if (popt->deprecated && !deprecated_apis)
|
||||
return tal_fmt(tmpctx, "deprecated option (will be removed!)");
|
||||
|
||||
if (!popt->multi) {
|
||||
tal_free(popt->values);
|
||||
popt->values = tal_arr(popt, struct plugin_opt_value *, 0);
|
||||
}
|
||||
|
||||
v = plugin_opt_value(popt->values, popt->type, arg);
|
||||
if (!v)
|
||||
return tal_fmt(tmpctx, "%s does not parse as type %s",
|
||||
arg, popt->type);
|
||||
tal_arr_expand(&popt->values, v);
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* Returns true if "name" was already registered and now overwritten. */
|
||||
static bool plugin_opt_register(struct plugin_opt *popt)
|
||||
/* We merely check they're valid: the values stay in configvars */
|
||||
static char *plugin_opt_string_check(const char *arg, struct plugin_opt *popt)
|
||||
{
|
||||
bool was_registered = opt_unregister(popt->name);
|
||||
if (streq(popt->type, "flag"))
|
||||
opt_register_noarg(popt->name, plugin_opt_flag_set, popt,
|
||||
popt->description);
|
||||
else
|
||||
opt_register_arg(popt->name, plugin_opt_set, NULL, popt,
|
||||
popt->description);
|
||||
|
||||
return was_registered;
|
||||
return plugin_opt_check(popt);
|
||||
}
|
||||
|
||||
static void destroy_plugin_opt(struct plugin_opt *opt)
|
||||
static char *plugin_opt_long_check(const char *arg, struct plugin_opt *popt)
|
||||
{
|
||||
long v;
|
||||
char *ret = opt_set_longval(arg, &v);
|
||||
if (ret)
|
||||
return ret;
|
||||
return plugin_opt_check(popt);
|
||||
}
|
||||
|
||||
static char *plugin_opt_bool_check(const char *arg, struct plugin_opt *popt)
|
||||
{
|
||||
/* FIXME: For some reason, '1' and '0' were allowed here? */
|
||||
if (streq(arg, "1") || streq(arg, "0")) {
|
||||
if (!deprecated_apis)
|
||||
return "boolean plugin arguments must be true or false";
|
||||
} else {
|
||||
bool v;
|
||||
char *ret = opt_set_bool_arg(arg, &v);
|
||||
if (ret)
|
||||
return ret;
|
||||
}
|
||||
return plugin_opt_check(popt);
|
||||
}
|
||||
|
||||
static char *plugin_opt_flag_check(struct plugin_opt *popt)
|
||||
{
|
||||
return plugin_opt_check(popt);
|
||||
}
|
||||
|
||||
static bool popt_show_default(char *buf, size_t len,
|
||||
const struct plugin_opt *popt)
|
||||
{
|
||||
if (!popt->def)
|
||||
return false;
|
||||
strncpy(buf, popt->def, len);
|
||||
return true;
|
||||
}
|
||||
|
||||
static void destroy_plugin_opt(struct plugin_opt *opt,
|
||||
struct plugin *plugin)
|
||||
{
|
||||
/* does nothing when "name" registration replaced its double */
|
||||
opt_unregister(opt->name);
|
||||
list_del(&opt->list);
|
||||
list_del_from(&plugin->plugin_opts, &opt->list);
|
||||
/* If any configvars were added on `plugin start`, remove now */
|
||||
configvar_remove(&plugin->plugins->ld->configvars,
|
||||
opt->name + 2, /* Skip -- */
|
||||
CONFIGVAR_PLUGIN_START, NULL);
|
||||
}
|
||||
|
||||
bool is_plugin_opt(const struct opt_table *ot)
|
||||
{
|
||||
if (ot->type & OPT_NOARG)
|
||||
return ot->cb == (void *)plugin_opt_flag_check;
|
||||
|
||||
return ot->cb_arg == (void *)plugin_opt_string_check
|
||||
|| ot->cb_arg == (void *)plugin_opt_long_check
|
||||
|| ot->cb_arg == (void *)plugin_opt_bool_check;
|
||||
}
|
||||
|
||||
/* Add a single plugin option to the plugin as well as registering it with the
|
||||
|
|
@ -917,6 +900,9 @@ static const char *plugin_opt_add(struct plugin *plugin, const char *buffer,
|
|||
{
|
||||
const jsmntok_t *nametok, *typetok, *defaulttok, *desctok, *deptok, *multitok;
|
||||
struct plugin_opt *popt;
|
||||
bool multi;
|
||||
const char *name;
|
||||
|
||||
nametok = json_get_member(buffer, opt, "name");
|
||||
typetok = json_get_member(buffer, opt, "type");
|
||||
desctok = json_get_member(buffer, opt, "description");
|
||||
|
|
@ -930,80 +916,100 @@ static const char *plugin_opt_add(struct plugin *plugin, const char *buffer,
|
|||
}
|
||||
|
||||
popt = tal(plugin, struct plugin_opt);
|
||||
popt->values = tal_arr(popt, struct plugin_opt_value *, 0);
|
||||
popt->name = tal_fmt(popt, "--%s",
|
||||
json_strdup(tmpctx, buffer, nametok));
|
||||
name = popt->name + 2;
|
||||
popt->def = NULL;
|
||||
|
||||
popt->name = tal_fmt(popt, "--%.*s", nametok->end - nametok->start,
|
||||
buffer + nametok->start);
|
||||
/* Only allow sane option names */
|
||||
if (strspn(name, "0123456789" "abcdefghijklmnopqrstuvwxyz" "_-")
|
||||
!= strlen(name))
|
||||
return tal_fmt(plugin, "Option \"name\" must be lowercase alphanumeric, plus _ or -'");
|
||||
|
||||
/* an "|" alias could circumvent the unique-option-name check */
|
||||
if (strchr(popt->name, '|'))
|
||||
return tal_fmt(plugin, "Option \"name\" may not contain '|'");
|
||||
/* Don't allow duplicate names! */
|
||||
if (opt_find_long(name, NULL)) {
|
||||
/* Fail hard on startup */
|
||||
if (plugin->plugins->startup)
|
||||
fatal("error starting plugin '%s':"
|
||||
" option name '%s' is already taken",
|
||||
plugin->cmd, name);
|
||||
return tal_fmt(plugin, "Option \"%s\" already registered",
|
||||
name);
|
||||
}
|
||||
|
||||
popt->description = json_strdup(popt, buffer, desctok);
|
||||
if (deptok) {
|
||||
if (!json_to_bool(buffer, deptok, &popt->deprecated))
|
||||
return tal_fmt(plugin,
|
||||
"%s: invalid \"deprecated\" field %.*s",
|
||||
popt->name,
|
||||
name,
|
||||
deptok->end - deptok->start,
|
||||
buffer + deptok->start);
|
||||
} else
|
||||
popt->deprecated = false;
|
||||
|
||||
if (multitok) {
|
||||
if (!json_to_bool(buffer, multitok, &popt->multi))
|
||||
if (!json_to_bool(buffer, multitok, &multi))
|
||||
return tal_fmt(plugin,
|
||||
"%s: invalid \"multi\" field %.*s",
|
||||
popt->name,
|
||||
name,
|
||||
multitok->end - multitok->start,
|
||||
buffer + multitok->start);
|
||||
} else
|
||||
popt->multi = false;
|
||||
multi = false;
|
||||
|
||||
popt->def = NULL;
|
||||
if (json_tok_streq(buffer, typetok, "string")) {
|
||||
popt->type = "string";
|
||||
} else if (json_tok_streq(buffer, typetok, "int")) {
|
||||
popt->type = "int";
|
||||
} else if (json_tok_streq(buffer, typetok, "bool")
|
||||
|| json_tok_streq(buffer, typetok, "flag")) {
|
||||
popt->type = json_strdup(popt, buffer, typetok);
|
||||
if (popt->multi)
|
||||
return tal_fmt(plugin,
|
||||
"%s type \"%s\" cannot have multi",
|
||||
popt->name, popt->type);
|
||||
/* We default flags to false, the default token is ignored */
|
||||
if (json_tok_streq(buffer, typetok, "flag") && defaulttok) {
|
||||
if (json_tok_streq(buffer, typetok, "flag")) {
|
||||
if (defaulttok) {
|
||||
if (!deprecated_apis) {
|
||||
return tal_fmt(plugin, "%s type flag cannot have default",
|
||||
popt->name);
|
||||
}
|
||||
defaulttok = NULL;
|
||||
}
|
||||
if (multi)
|
||||
return tal_fmt(plugin, "flag type cannot be multi");
|
||||
clnopt_noarg(popt->name,
|
||||
0,
|
||||
plugin_opt_flag_check, popt,
|
||||
popt->description);
|
||||
} else {
|
||||
return tal_fmt(plugin,
|
||||
"Only \"string\", \"int\", \"bool\", and \"flag\" options are supported");
|
||||
}
|
||||
/* These all take an arg. */
|
||||
char *(*cb_arg)(const char *optarg, void *arg);
|
||||
enum opt_type optflags = multi ? OPT_MULTI : 0;
|
||||
|
||||
if (defaulttok && !json_tok_is_null(buffer, defaulttok)) {
|
||||
popt->def = plugin_opt_value(popt, popt->type,
|
||||
json_strdup(tmpctx, buffer, defaulttok));
|
||||
if (!popt->def)
|
||||
return tal_fmt(tmpctx, "default %.*s is not a valid %s",
|
||||
json_tok_full_len(defaulttok),
|
||||
json_tok_full(buffer, defaulttok),
|
||||
popt->type);
|
||||
}
|
||||
if (json_tok_streq(buffer, typetok, "string")) {
|
||||
cb_arg = (void *)plugin_opt_string_check;
|
||||
} else if (json_tok_streq(buffer, typetok, "int")) {
|
||||
cb_arg = (void *)plugin_opt_long_check;
|
||||
optflags |= OPT_SHOWINT;
|
||||
} else if (json_tok_streq(buffer, typetok, "bool")) {
|
||||
if (multi)
|
||||
return tal_fmt(plugin, "bool type cannot be multi");
|
||||
optflags |= OPT_SHOWBOOL;
|
||||
cb_arg = (void *)plugin_opt_bool_check;
|
||||
} else {
|
||||
return tal_fmt(plugin,
|
||||
"Only \"string\", \"int\", \"bool\", and \"flag\" options are supported");
|
||||
}
|
||||
|
||||
/* Now we know how to parse defaulttok */
|
||||
if (defaulttok && !json_tok_is_null(buffer, defaulttok)) {
|
||||
const char *problem;
|
||||
popt->def = json_strdup(popt, buffer, defaulttok);
|
||||
/* Parse it exactly like the normal code path. */
|
||||
problem = cb_arg(popt->def, popt);
|
||||
if (problem)
|
||||
return tal_fmt(plugin, "Invalid default '%s': %s",
|
||||
popt->def, tal_steal(tmpctx, problem));
|
||||
}
|
||||
/* show is only used for defaults: listconfigs uses
|
||||
* configvar if it's set. */
|
||||
clnopt_witharg(popt->name,
|
||||
optflags, cb_arg, popt_show_default, popt, popt->description);
|
||||
}
|
||||
|
||||
list_add_tail(&plugin->plugin_opts, &popt->list);
|
||||
|
||||
/* Command line options are parsed only during ld's startup and each "name"
|
||||
* only once. Always registers to satisfy destructor */
|
||||
if (plugin_opt_register(popt) && plugin->plugins->startup)
|
||||
fatal("error starting plugin '%s': option name '%s' is already taken", plugin->cmd, popt->name);
|
||||
|
||||
tal_add_destructor(popt, destroy_plugin_opt);
|
||||
tal_add_destructor2(popt, destroy_plugin_opt, plugin);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
|
@ -1014,6 +1020,8 @@ static const char *plugin_opts_add(struct plugin *plugin,
|
|||
const jsmntok_t *resulttok)
|
||||
{
|
||||
const jsmntok_t *options = json_get_member(buffer, resulttok, "options");
|
||||
size_t i;
|
||||
const jsmntok_t *t;
|
||||
|
||||
if (!options) {
|
||||
return tal_fmt(plugin,
|
||||
|
|
@ -1024,9 +1032,8 @@ static const char *plugin_opts_add(struct plugin *plugin,
|
|||
return tal_fmt(plugin, "\"result.options\" is not an array");
|
||||
}
|
||||
|
||||
for (size_t i = 0; i < options->size; i++) {
|
||||
const char *err;
|
||||
err = plugin_opt_add(plugin, buffer, json_get_arr(options, i));
|
||||
json_for_each_arr(i, t, options) {
|
||||
const char *err = plugin_opt_add(plugin, buffer, t);
|
||||
if (err)
|
||||
return err;
|
||||
}
|
||||
|
|
@ -1347,21 +1354,22 @@ static const char *plugin_hooks_add(struct plugin *plugin, const char *buffer,
|
|||
return NULL;
|
||||
}
|
||||
|
||||
static struct plugin_opt *plugin_opt_find(struct plugin *plugin,
|
||||
const char *name, size_t namelen)
|
||||
static struct plugin_opt *plugin_opt_find(const struct plugin *plugin,
|
||||
const char *name)
|
||||
{
|
||||
struct plugin_opt *opt;
|
||||
|
||||
list_for_each(&plugin->plugin_opts, opt, list) {
|
||||
/* Trim the `--` that we added before */
|
||||
if (memeqstr(name, namelen, opt->name + 2))
|
||||
if (streq(opt->name + 2, name))
|
||||
return opt;
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* start command might have included plugin-specific parameters */
|
||||
static const char *plugin_add_params(struct plugin *plugin)
|
||||
/* Start command might have included plugin-specific parameters.
|
||||
* We make sure they *are* parameters for this plugin, then add them
|
||||
* to our configvars. */
|
||||
static const char *plugin_add_params(const struct plugin *plugin)
|
||||
{
|
||||
size_t i;
|
||||
const jsmntok_t *t;
|
||||
|
|
@ -1370,22 +1378,38 @@ static const char *plugin_add_params(struct plugin *plugin)
|
|||
return NULL;
|
||||
|
||||
json_for_each_obj(i, t, plugin->params) {
|
||||
struct plugin_opt *popt;
|
||||
char *err;
|
||||
struct opt_table *ot;
|
||||
const char *name = json_strdup(tmpctx, plugin->parambuf, t);
|
||||
struct configvar *cv;
|
||||
const char *err;
|
||||
|
||||
popt = plugin_opt_find(plugin,
|
||||
plugin->parambuf + t->start,
|
||||
t->end - t->start);
|
||||
if (!popt) {
|
||||
return tal_fmt(plugin, "unknown parameter %.*s",
|
||||
json_tok_full_len(t),
|
||||
json_tok_full(plugin->parambuf, t));
|
||||
/* This serves two purposes; make sure we don't set an option
|
||||
* for a different pligin on the plugin start cmdline, and
|
||||
* make sure we clean it up, since we only clean our own
|
||||
* configvars in destroy_plugin_opt */
|
||||
if (!plugin_opt_find(plugin, name))
|
||||
return tal_fmt(plugin, "unknown parameter %s", name);
|
||||
|
||||
ot = opt_find_long(name, NULL);
|
||||
if (ot->type & OPT_HASARG) {
|
||||
name = tal_fmt(NULL, "%s=%.*s",
|
||||
name,
|
||||
t[1].end - t[1].start,
|
||||
plugin->parambuf + t[1].start);
|
||||
}
|
||||
err = plugin_opt_set(json_strdup(tmpctx, plugin->parambuf,
|
||||
t + 1), popt);
|
||||
cv = configvar_new(plugin->plugins->ld->configvars,
|
||||
CONFIGVAR_PLUGIN_START,
|
||||
NULL, 0, take(name));
|
||||
tal_arr_expand(&plugin->plugins->ld->configvars, cv);
|
||||
|
||||
/* If this fails, we free plugin and unregister the configvar */
|
||||
err = configvar_parse(cv, false, true, IFDEV(true, false));
|
||||
if (err)
|
||||
return err;
|
||||
}
|
||||
|
||||
/* We might have overridden previous configvars */
|
||||
configvar_finalize_overrides(plugin->plugins->ld->configvars);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
|
|
@ -1841,59 +1865,86 @@ static void plugin_config_cb(const char *buffer,
|
|||
check_plugins_initted(plugin->plugins);
|
||||
}
|
||||
|
||||
static void json_add_plugin_opt(struct json_stream *stream,
|
||||
static void json_add_plugin_val(struct json_stream *stream,
|
||||
const struct opt_table *ot,
|
||||
const char *name,
|
||||
const char *type,
|
||||
const struct plugin_opt_value *value)
|
||||
const char *val)
|
||||
{
|
||||
if (streq(type, "flag")) {
|
||||
/* We don't include 'flag' types if they're not
|
||||
* flagged on */
|
||||
if (value->as_bool)
|
||||
json_add_bool(stream, name, value->as_bool);
|
||||
} else if (streq(type, "bool")) {
|
||||
json_add_bool(stream, name, value->as_bool);
|
||||
} else if (streq(type, "string")) {
|
||||
json_add_string(stream, name, value->as_str);
|
||||
} else if (streq(type, "int")) {
|
||||
json_add_s64(stream, name, value->as_int);
|
||||
if ((ot->type & OPT_SHOWINT) || (ot->type & OPT_SHOWMSATS)) {
|
||||
json_add_primitive(stream, name, val);
|
||||
} else if (ot->type & OPT_SHOWBOOL) {
|
||||
/* We allow variants here. Json-ize */
|
||||
json_add_bool(stream, name, opt_canon_bool(val));
|
||||
} else {
|
||||
json_add_string(stream, name, val);
|
||||
}
|
||||
}
|
||||
|
||||
static void json_add_plugin_options(struct json_stream *stream,
|
||||
const char *fieldname,
|
||||
struct plugin *plugin,
|
||||
bool include_deprecated)
|
||||
{
|
||||
/* We don't allow multiple option names in plugins */
|
||||
struct lightningd *ld = plugin->plugins->ld;
|
||||
const char **namesarr = tal_arr(tmpctx, const char *, 1);
|
||||
struct plugin_opt *popt;
|
||||
|
||||
json_object_start(stream, fieldname);
|
||||
list_for_each(&plugin->plugin_opts, popt, list) {
|
||||
struct configvar *cv;
|
||||
const struct opt_table *ot;
|
||||
|
||||
if (popt->deprecated && !include_deprecated)
|
||||
continue;
|
||||
|
||||
namesarr[0] = popt->name + 2;
|
||||
cv = configvar_first(ld->configvars, namesarr);
|
||||
if (!cv && !popt->def)
|
||||
continue;
|
||||
|
||||
ot = opt_find_long(namesarr[0], NULL);
|
||||
if (ot->type & OPT_MULTI) {
|
||||
json_array_start(stream, namesarr[0]);
|
||||
if (!cv) {
|
||||
json_add_plugin_val(stream, ot, NULL,
|
||||
popt->def);
|
||||
} else {
|
||||
while (cv) {
|
||||
json_add_plugin_val(stream,
|
||||
ot, NULL,
|
||||
cv->optarg);
|
||||
cv = configvar_next(ld->configvars,
|
||||
cv, namesarr);
|
||||
}
|
||||
}
|
||||
json_array_end(stream);
|
||||
} else {
|
||||
if (!cv) {
|
||||
json_add_plugin_val(stream, ot,
|
||||
namesarr[0],
|
||||
popt->def);
|
||||
} else if (cv->optarg) {
|
||||
json_add_plugin_val(stream,
|
||||
ot,
|
||||
namesarr[0],
|
||||
cv->optarg);
|
||||
} else {
|
||||
/* We specify non-arg options as 'true' */
|
||||
json_add_bool(stream, namesarr[0], true);
|
||||
}
|
||||
}
|
||||
}
|
||||
json_object_end(stream);
|
||||
}
|
||||
|
||||
void
|
||||
plugin_populate_init_request(struct plugin *plugin, struct jsonrpc_request *req)
|
||||
{
|
||||
const char *name;
|
||||
struct plugin_opt *opt;
|
||||
struct lightningd *ld = plugin->plugins->ld;
|
||||
|
||||
/* Add .params.options */
|
||||
json_object_start(req->stream, "options");
|
||||
list_for_each(&plugin->plugin_opts, opt, list) {
|
||||
/* Trim the `--` that we added before */
|
||||
name = opt->name + 2;
|
||||
|
||||
/* If no values, assign default (if any!) */
|
||||
if (tal_count(opt->values) == 0) {
|
||||
if (opt->def)
|
||||
tal_arr_expand(&opt->values, opt->def);
|
||||
else
|
||||
continue;
|
||||
}
|
||||
|
||||
if (opt->multi) {
|
||||
json_array_start(req->stream, name);
|
||||
for (size_t i = 0; i < tal_count(opt->values); i++)
|
||||
json_add_plugin_opt(req->stream, NULL,
|
||||
opt->type, opt->values[i]);
|
||||
json_array_end(req->stream);
|
||||
} else {
|
||||
json_add_plugin_opt(req->stream, name,
|
||||
opt->type, opt->values[0]);
|
||||
}
|
||||
}
|
||||
json_object_end(req->stream); /* end of .params.options */
|
||||
|
||||
json_add_plugin_options(req->stream, "options", plugin, true);
|
||||
/* Add .params.configuration */
|
||||
json_object_start(req->stream, "configuration");
|
||||
json_add_string(req->stream, "lightning-dir", ld->config_netdir);
|
||||
|
|
@ -1970,8 +2021,6 @@ void json_add_opt_plugins_array(struct json_stream *response,
|
|||
bool important)
|
||||
{
|
||||
struct plugin *p;
|
||||
struct plugin_opt *opt;
|
||||
const char *opt_name;
|
||||
|
||||
/* we output 'plugins' and their options as an array of substructures */
|
||||
json_array_start(response, name);
|
||||
|
|
@ -1987,29 +2036,8 @@ void json_add_opt_plugins_array(struct json_stream *response,
|
|||
json_add_string(response, "name", p->shortname);
|
||||
|
||||
if (!list_empty(&p->plugin_opts)) {
|
||||
json_object_start(response, "options");
|
||||
list_for_each(&p->plugin_opts, opt, list) {
|
||||
if (!deprecated_apis && opt->deprecated)
|
||||
continue;
|
||||
|
||||
/* Trim the `--` that we added before */
|
||||
opt_name = opt->name + 2;
|
||||
if (opt->multi) {
|
||||
json_array_start(response, opt_name);
|
||||
for (size_t i = 0; i < tal_count(opt->values); i++)
|
||||
json_add_plugin_opt(response,
|
||||
NULL,
|
||||
opt->type,
|
||||
opt->values[i]);
|
||||
json_array_end(response);
|
||||
} else if (tal_count(opt->values)) {
|
||||
json_add_plugin_opt(response,
|
||||
opt_name,
|
||||
opt->type,
|
||||
opt->values[0]);
|
||||
}
|
||||
}
|
||||
json_object_end(response);
|
||||
json_add_plugin_options(response, "options", p,
|
||||
!deprecated_apis);
|
||||
}
|
||||
json_object_end(response);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -125,29 +125,18 @@ struct plugins {
|
|||
#endif /* DEVELOPER */
|
||||
};
|
||||
|
||||
/* The value of a plugin option, which can have different types.
|
||||
* The presence of the integer and boolean values will depend of
|
||||
* the option type, but the string value will always be filled.
|
||||
*/
|
||||
struct plugin_opt_value {
|
||||
char *as_str;
|
||||
s64 as_int;
|
||||
bool as_bool;
|
||||
};
|
||||
|
||||
/**
|
||||
* Simple storage for plugin options inbetween registering them on the
|
||||
* command line and passing them off to the plugin
|
||||
*/
|
||||
struct plugin_opt {
|
||||
/* off plugin->plugin_opts */
|
||||
struct list_node list;
|
||||
/* includes -- prefix! */
|
||||
const char *name;
|
||||
const char *type;
|
||||
const char *description;
|
||||
struct plugin_opt_value **values;
|
||||
/* Might be NULL if no default */
|
||||
struct plugin_opt_value *def;
|
||||
bool multi;
|
||||
/* NULL if no default */
|
||||
const char *def;
|
||||
bool deprecated;
|
||||
};
|
||||
|
||||
|
|
@ -367,4 +356,6 @@ struct log *plugin_get_log(struct plugin *plugin);
|
|||
void plugins_set_builtin_plugins_dir(struct plugins *plugins,
|
||||
const char *dir);
|
||||
|
||||
/* Is this option for a plugin? */
|
||||
bool is_plugin_opt(const struct opt_table *ot);
|
||||
#endif /* LIGHTNING_LIGHTNINGD_PLUGIN_H */
|
||||
|
|
|
|||
|
|
@ -1617,7 +1617,7 @@ static const char *init(struct plugin *p, const char *buf UNUSED,
|
|||
|
||||
rpc_scan(p, "listconfigs",
|
||||
take(json_out_obj(NULL, "config", "experimental-offers")),
|
||||
"{experimental-offers:%}",
|
||||
"{configs:{experimental-offers:{set:%}}}",
|
||||
JSON_SCAN(json_to_bool, &exp_offers));
|
||||
|
||||
if (!exp_offers)
|
||||
|
|
|
|||
|
|
@ -1050,7 +1050,9 @@ static const char *init(struct plugin *p,
|
|||
|
||||
rpc_scan(p, "listconfigs",
|
||||
take(json_out_obj(NULL, NULL, NULL)),
|
||||
"{cltv-final:%,experimental-offers:%}",
|
||||
"{configs:"
|
||||
"{cltv-final:{value_int:%},"
|
||||
"experimental-offers:{set:%}}}",
|
||||
JSON_SCAN(json_to_u16, &cltv_final),
|
||||
JSON_SCAN(json_to_bool, &offers_enabled));
|
||||
|
||||
|
|
|
|||
|
|
@ -582,7 +582,9 @@ static const char *init(struct plugin *p,
|
|||
|
||||
rpc_scan(p, "listconfigs",
|
||||
take(json_out_obj(NULL, NULL, NULL)),
|
||||
"{max-locktime-blocks:%,experimental-offers:%}",
|
||||
"{configs:"
|
||||
"{max-locktime-blocks:{value_int:%},"
|
||||
"experimental-offers:{set:%}}}",
|
||||
JSON_SCAN(json_to_number, &maxdelay_default),
|
||||
JSON_SCAN(json_to_bool, &exp_offers));
|
||||
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ def test_option_passthrough(node_factory, directory):
|
|||
], capture_output=True, check=True).stderr.decode('utf-8')
|
||||
|
||||
# first come first serve
|
||||
assert("error starting plugin '{}': option name '--greeting' is already taken".format(plugin_path2) in err_out)
|
||||
assert("error starting plugin '{}': option name 'greeting' is already taken".format(plugin_path2) in err_out)
|
||||
|
||||
|
||||
def test_option_types(node_factory):
|
||||
|
|
@ -113,27 +113,39 @@ def test_option_types(node_factory):
|
|||
# the node should fail after start, and we get a stderr msg
|
||||
n.daemon.start(wait_for_initialized=False, stderr_redir=True)
|
||||
assert n.daemon.wait() == 1
|
||||
wait_for(lambda: n.daemon.is_in_stderr('--bool_opt=!: ! does not parse as type bool'))
|
||||
wait_for(lambda: n.daemon.is_in_stderr("--bool_opt=!: Invalid argument '!'"))
|
||||
|
||||
# What happens if we give it a bad int-option?
|
||||
n = node_factory.get_node(options={
|
||||
'plugin': plugin_path,
|
||||
'str_opt': 'ok',
|
||||
'int_opt': 'notok',
|
||||
'bool_opt': 1,
|
||||
'bool_opt': True,
|
||||
}, may_fail=True, start=False)
|
||||
|
||||
# the node should fail after start, and we get a stderr msg
|
||||
n.daemon.start(wait_for_initialized=False, stderr_redir=True)
|
||||
assert n.daemon.wait() == 1
|
||||
assert n.daemon.is_in_stderr('--int_opt=notok: notok does not parse as type int')
|
||||
assert n.daemon.is_in_stderr("--int_opt=notok: 'notok' is not a number")
|
||||
|
||||
# We no longer allow '1' or '0' as boolean options
|
||||
n = node_factory.get_node(options={
|
||||
'plugin': plugin_path,
|
||||
'str_opt': 'ok',
|
||||
'bool_opt': '1',
|
||||
}, may_fail=True, start=False)
|
||||
|
||||
# the node should fail after start, and we get a stderr msg
|
||||
n.daemon.start(wait_for_initialized=False, stderr_redir=True)
|
||||
assert n.daemon.wait() == 1
|
||||
assert n.daemon.is_in_stderr("--bool_opt=1: boolean plugin arguments must be true or false")
|
||||
|
||||
# Flag opts shouldn't allow any input
|
||||
n = node_factory.get_node(options={
|
||||
'plugin': plugin_path,
|
||||
'str_opt': 'ok',
|
||||
'int_opt': 11,
|
||||
'bool_opt': 1,
|
||||
'bool_opt': True,
|
||||
'flag_opt': True,
|
||||
}, may_fail=True, start=False)
|
||||
|
||||
|
|
@ -4144,3 +4156,42 @@ def test_sql_deprecated(node_factory, bitcoind):
|
|||
|
||||
# ret = l1.rpc.sql("SELECT funding_local_msat, funding_remote_msat FROM peerchannels;")
|
||||
# assert ret == {'rows': []}
|
||||
|
||||
|
||||
def test_plugin_persist_option(node_factory):
|
||||
"""test that options from config file get remembered across plugin stop/start"""
|
||||
plugin_path = os.path.join(os.getcwd(), 'contrib/plugins/helloworld.py')
|
||||
|
||||
l1 = node_factory.get_node(options={"plugin": plugin_path,
|
||||
"greeting": "Static option"})
|
||||
assert l1.rpc.call("hello") == "Static option world"
|
||||
c = l1.rpc.listconfigs('greeting')['configs']['greeting']
|
||||
assert c['source'] == "cmdline"
|
||||
assert c['value_str'] == "Static option"
|
||||
l1.rpc.plugin_stop(plugin_path)
|
||||
assert 'greeting' not in l1.rpc.listconfigs()['configs']
|
||||
|
||||
# Restart works
|
||||
l1.rpc.plugin_start(plugin_path)
|
||||
c = l1.rpc.listconfigs('greeting')['configs']['greeting']
|
||||
assert c['source'] == "cmdline"
|
||||
assert c['value_str'] == "Static option"
|
||||
assert l1.rpc.call("hello") == "Static option world"
|
||||
l1.rpc.plugin_stop(plugin_path)
|
||||
assert 'greeting' not in l1.rpc.listconfigs()['configs']
|
||||
|
||||
# This overrides!
|
||||
l1.rpc.plugin_start(plugin_path, greeting="Dynamic option")
|
||||
c = l1.rpc.listconfigs('greeting')['configs']['greeting']
|
||||
assert c['source'] == "pluginstart"
|
||||
assert c['value_str'] == "Dynamic option"
|
||||
assert l1.rpc.call("hello") == "Dynamic option world"
|
||||
l1.rpc.plugin_stop(plugin_path)
|
||||
assert 'greeting' not in l1.rpc.listconfigs()['configs']
|
||||
|
||||
# Now restored!
|
||||
l1.rpc.plugin_start(plugin_path)
|
||||
c = l1.rpc.listconfigs('greeting')['configs']['greeting']
|
||||
assert c['source'] == "cmdline"
|
||||
assert c['value_str'] == "Static option"
|
||||
assert l1.rpc.call("hello") == "Static option world"
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue