2 * libuci plugin for Lua
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2
7 * as published by the Free Software Foundation
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #include <sys/types.h>
28 #define METANAME MODNAME ".meta"
32 #define DPRINTF(...) fprintf(stderr, __VA_ARGS__)
34 #define DPRINTF(...) do {} while (0)
37 #if !defined LUA_VERSION_NUM || LUA_VERSION_NUM==501
40 * ** Adapted from Lua 5.2.0
42 static void luaL_setfuncs (lua_State *L, const luaL_Reg *l, int nup) {
43 luaL_checkstack(L, nup+1, "too many upvalues");
44 for (; l->name != NULL; l++) { /* fill the table with given functions */
46 lua_pushstring(L, l->name);
47 for (i = 0; i < nup; i++) /* copy upvalues to the top */
48 lua_pushvalue(L, -(nup+1));
49 lua_pushcclosure(L, l->func, nup); /* closure with those upvalues */
50 lua_settable(L, -(nup + 3));
52 lua_pop(L, nup); /* remove upvalues */
55 #define lua_rawlen(L, i) lua_objlen(L, i)
59 static struct uci_context *global_ctx = NULL;
61 static struct uci_context *
62 find_context(lua_State *L, int *offset)
64 struct uci_context **ctx;
65 if (!lua_isuserdata(L, 1)) {
67 global_ctx = uci_alloc_context();
69 luaL_error(L, "failed to allocate UCI context");
79 ctx = luaL_checkudata(L, 1, METANAME);
81 luaL_error(L, "failed to get UCI context");
88 static struct uci_package *
89 find_package(lua_State *L, struct uci_context *ctx, const char *str, bool al)
91 struct uci_package *p = NULL;
92 struct uci_element *e;
96 sep = strchr(str, '.');
98 name = malloc(1 + sep - str);
100 luaL_error(L, "out of memory");
103 strncpy(name, str, sep - str);
108 uci_foreach_element(&ctx->root, e) {
109 if (strcmp(e->name, name) != 0)
112 p = uci_to_package(e);
117 uci_load(ctx, name, &p);
126 lookup_extended(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended)
129 struct uci_ptr lookup;
131 /* use a copy of the passed ptr since failing lookups will
132 * clobber the state */
134 lookup.flags |= UCI_LOOKUP_EXTENDED;
136 rv = uci_lookup_ptr(ctx, &lookup, str, extended);
138 /* copy to passed ptr on success */
146 lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended)
148 if (ptr && !ptr->s && ptr->section && *ptr->section == '@')
149 return lookup_extended(ctx, ptr, str, extended);
151 return uci_lookup_ptr(ctx, ptr, str, extended);
155 lookup_args(lua_State *L, struct uci_context *ctx, int offset, struct uci_ptr *ptr, char **buf)
161 luaL_checkstring(L, 1 + offset);
162 s = strdup(lua_tostring(L, 1 + offset));
166 memset(ptr, 0, sizeof(struct uci_ptr));
167 if (!find_package(L, ctx, s, true))
170 switch (n - offset) {
173 ptr->option = luaL_checkstring(L, 3 + offset);
176 ptr->section = luaL_checkstring(L, 2 + offset);
177 ptr->package = luaL_checkstring(L, 1 + offset);
178 if (lookup_ptr(ctx, ptr, NULL, true) != UCI_OK)
182 if (lookup_ptr(ctx, ptr, s, true) != UCI_OK)
186 luaL_error(L, "invalid argument count");
200 uci_push_status(lua_State *L, struct uci_context *ctx, bool hasarg)
205 lua_pushboolean(L, (ctx->err == UCI_OK));
207 uci_get_errorstr(ctx, &str, MODNAME);
209 lua_pushstring(L, str);
218 uci_push_option(lua_State *L, struct uci_option *o)
220 struct uci_element *e;
224 case UCI_TYPE_STRING:
225 lua_pushstring(L, o->v.string);
229 uci_foreach_element(&o->v.list, e) {
231 lua_pushstring(L, e->name);
232 lua_rawseti(L, -2, i);
242 uci_push_section(lua_State *L, struct uci_section *s, int index)
244 struct uci_element *e;
247 lua_pushboolean(L, s->anonymous);
248 lua_setfield(L, -2, ".anonymous");
249 lua_pushstring(L, s->type);
250 lua_setfield(L, -2, ".type");
251 lua_pushstring(L, s->e.name);
252 lua_setfield(L, -2, ".name");
254 lua_pushinteger(L, index);
255 lua_setfield(L, -2, ".index");
258 uci_foreach_element(&s->options, e) {
259 struct uci_option *o = uci_to_option(e);
260 uci_push_option(L, o);
261 lua_setfield(L, -2, o->e.name);
266 uci_push_package(lua_State *L, struct uci_package *p)
268 struct uci_element *e;
272 uci_foreach_element(&p->sections, e) {
273 uci_push_section(L, uci_to_section(e), i);
274 lua_setfield(L, -2, e->name);
280 uci_lua_unload(lua_State *L)
282 struct uci_context *ctx;
283 struct uci_package *p;
287 ctx = find_context(L, &offset);
288 luaL_checkstring(L, 1 + offset);
289 s = lua_tostring(L, 1 + offset);
290 p = find_package(L, ctx, s, false);
293 return uci_push_status(L, ctx, false);
295 lua_pushboolean(L, 0);
301 uci_lua_load(lua_State *L)
303 struct uci_context *ctx;
304 struct uci_package *p = NULL;
308 ctx = find_context(L, &offset);
310 lua_pop(L, 1); /* bool ret value of unload */
311 s = lua_tostring(L, -1);
313 uci_load(ctx, s, &p);
314 return uci_push_status(L, ctx, false);
319 uci_lua_foreach(lua_State *L)
321 struct uci_context *ctx;
322 struct uci_package *p;
323 struct uci_element *e, *tmp;
324 const char *package, *type;
329 ctx = find_context(L, &offset);
330 package = luaL_checkstring(L, 1 + offset);
332 if (lua_isnil(L, 2 + offset))
335 type = luaL_checkstring(L, 2 + offset);
337 if (!lua_isfunction(L, 3 + offset) || !package)
338 return luaL_error(L, "Invalid argument");
340 p = find_package(L, ctx, package, true);
344 uci_foreach_element_safe(&p->sections, tmp, e) {
345 struct uci_section *s = uci_to_section(e);
349 if (type && (strcmp(s->type, type) != 0))
352 lua_pushvalue(L, 3 + offset); /* iterator function */
353 uci_push_section(L, s, i - 1);
354 if (lua_pcall(L, 1, 1, 0) == 0) {
356 if (lua_isboolean(L, -1) && !lua_toboolean(L, -1))
367 lua_pushboolean(L, ret);
372 uci_lua_get_any(lua_State *L, bool all)
374 struct uci_context *ctx;
375 struct uci_element *e = NULL;
380 int err = UCI_ERR_NOTFOUND;
382 ctx = find_context(L, &offset);
384 if (lookup_args(L, ctx, offset, &ptr, &s))
387 lookup_ptr(ctx, &ptr, NULL, true);
388 if (!all && !ptr.s) {
392 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
393 err = UCI_ERR_NOTFOUND;
400 case UCI_TYPE_PACKAGE:
401 uci_push_package(L, ptr.p);
403 case UCI_TYPE_SECTION:
405 uci_push_section(L, ptr.s, -1);
408 lua_pushstring(L, ptr.s->type);
409 lua_pushstring(L, ptr.s->e.name);
413 case UCI_TYPE_OPTION:
414 uci_push_option(L, ptr.o);
430 return uci_push_status(L, ctx, true);
434 uci_lua_get(lua_State *L)
436 return uci_lua_get_any(L, false);
440 uci_lua_get_all(lua_State *L)
442 return uci_lua_get_any(L, true);
446 uci_lua_add(lua_State *L)
448 struct uci_context *ctx;
449 struct uci_section *s = NULL;
450 struct uci_package *p;
453 const char *name = NULL;
456 ctx = find_context(L, &offset);
457 package = luaL_checkstring(L, 1 + offset);
458 type = luaL_checkstring(L, 2 + offset);
459 p = find_package(L, ctx, package, true);
463 if (uci_add_section(ctx, p, type, &s) || !s)
467 lua_pushstring(L, name);
472 return uci_push_status(L, ctx, true);
476 uci_lua_delete(lua_State *L)
478 struct uci_context *ctx;
483 ctx = find_context(L, &offset);
485 if (lookup_args(L, ctx, offset, &ptr, &s))
488 uci_delete(ctx, &ptr);
493 return uci_push_status(L, ctx, false);
497 uci_lua_rename(lua_State *L)
499 struct uci_context *ctx;
501 int err = UCI_ERR_MEM;
503 int nargs, offset = 0;
505 ctx = find_context(L, &offset);
506 nargs = lua_gettop(L);
507 if (lookup_args(L, ctx, offset, &ptr, &s))
510 switch(nargs - offset) {
512 /* Format: uci.set("p.s.o=v") or uci.set("p.s=v") */
515 /* Format: uci.set("p", "s", "o", "v") */
516 ptr.value = luaL_checkstring(L, nargs);
519 /* Format: uci.set("p", "s", "v") */
520 ptr.value = ptr.option;
528 err = lookup_ptr(ctx, &ptr, NULL, true);
532 if (((ptr.s == NULL) && (ptr.option != NULL)) || (ptr.value == NULL)) {
537 err = uci_rename(ctx, &ptr);
544 return uci_push_status(L, ctx, false);
548 uci_lua_reorder(lua_State *L)
550 struct uci_context *ctx;
552 int err = UCI_ERR_MEM;
554 int nargs, offset = 0;
556 ctx = find_context(L, &offset);
557 nargs = lua_gettop(L);
558 if (lookup_args(L, ctx, offset, &ptr, &s))
561 switch(nargs - offset) {
563 /* Format: uci.set("p.s=v") or uci.set("p.s=v") */
570 /* Format: uci.set("p", "s", "v") */
571 ptr.value = ptr.option;
579 err = lookup_ptr(ctx, &ptr, NULL, true);
583 if ((ptr.s == NULL) || (ptr.value == NULL)) {
588 err = uci_reorder_section(ctx, ptr.s, strtoul(ptr.value, NULL, 10));
595 return uci_push_status(L, ctx, false);
600 uci_lua_set(lua_State *L)
602 struct uci_context *ctx;
604 bool istable = false;
605 int err = UCI_ERR_MEM;
609 int nargs, offset = 0;
611 ctx = find_context(L, &offset);
612 nargs = lua_gettop(L);
613 if (lookup_args(L, ctx, offset, &ptr, &s))
616 switch(nargs - offset) {
618 /* Format: uci.set("p.s.o=v") or uci.set("p.s=v") */
621 /* Format: uci.set("p", "s", "o", "v") */
622 if (lua_istable(L, nargs)) {
623 if (lua_rawlen(L, nargs) < 1)
624 return luaL_error(L, "Cannot set an uci option to an empty table value");
625 lua_rawgeti(L, nargs, 1);
626 ptr.value = luaL_checkstring(L, -1);
630 ptr.value = luaL_checkstring(L, nargs);
634 /* Format: uci.set("p", "s", "v") */
635 ptr.value = ptr.option;
643 err = lookup_ptr(ctx, &ptr, NULL, true);
647 if (((ptr.s == NULL) && (ptr.option != NULL)) || (ptr.value == NULL)) {
653 if (lua_rawlen(L, nargs) == 1) {
658 err = uci_delete(ctx, &ptr);
665 err = uci_set(ctx, &ptr);
670 for (; i <= lua_rawlen(L, nargs); i++) {
671 lua_rawgeti(L, nargs, i);
672 ptr.value = luaL_checkstring(L, -1);
673 err = uci_add_list(ctx, &ptr);
679 err = uci_set(ctx, &ptr);
688 return uci_push_status(L, ctx, false);
698 uci_lua_package_cmd(lua_State *L, enum pkg_cmd cmd)
700 struct uci_context *ctx;
701 struct uci_element *e, *tmp;
704 int nargs, offset = 0;
706 ctx = find_context(L, &offset);
707 nargs = lua_gettop(L);
708 if ((cmd != CMD_REVERT) && (nargs - offset > 1))
711 if (lookup_args(L, ctx, offset, &ptr, &s))
714 lookup_ptr(ctx, &ptr, NULL, true);
716 uci_foreach_element_safe(&ctx->root, tmp, e) {
717 struct uci_package *p = uci_to_package(e);
719 if (ptr.p && (ptr.p != p))
725 uci_commit(ctx, &p, false);
731 uci_revert(ctx, &ptr);
739 return uci_push_status(L, ctx, false);
743 uci_lua_save(lua_State *L)
745 return uci_lua_package_cmd(L, CMD_SAVE);
749 uci_lua_commit(lua_State *L)
751 return uci_lua_package_cmd(L, CMD_COMMIT);
755 uci_lua_revert(lua_State *L)
757 return uci_lua_package_cmd(L, CMD_REVERT);
761 uci_lua_add_change(lua_State *L, struct uci_element *e)
771 lua_getfield(L, -1, h->section);
772 if (lua_isnil(L, -1)) {
775 lua_pushvalue(L, -1); /* copy for setfield */
776 lua_setfield(L, -3, h->section);
780 value = h->value ? h->value : "";
783 lua_getfield(L, -1, name);
785 /* this delta is a list add operation */
786 if (h->cmd == UCI_CMD_LIST_ADD) {
787 /* there seems to be no table yet */
788 if (!lua_istable(L, -1)) {
791 /* if there is a value on the stack already, add */
792 if (!lua_isnil(L, -2)) {
793 lua_pushvalue(L, -2);
794 lua_rawseti(L, -2, 1);
795 lua_pushstring(L, value);
796 lua_rawseti(L, -2, 2);
798 /* this is the first table item */
800 lua_pushstring(L, value);
801 lua_rawseti(L, -2, 1);
804 lua_setfield(L, -3, name);
806 /* a table is on the top of the stack and this is a subsequent,
807 * list_add, append this value to table */
809 lua_pushstring(L, value);
810 lua_rawseti(L, -2, lua_rawlen(L, -2) + 1);
813 /* non-list change, simply set/replace field */
815 lua_pushstring(L, value);
816 lua_setfield(L, -3, name);
821 lua_pushstring(L, value);
822 lua_setfield(L, -2, ".type");
829 uci_lua_changes_pkg(lua_State *L, struct uci_context *ctx, const char *package)
831 struct uci_package *p = NULL;
832 struct uci_element *e;
833 bool autoload = false;
835 p = find_package(L, ctx, package, false);
838 p = find_package(L, ctx, package, true);
843 if (uci_list_empty(&p->delta) && uci_list_empty(&p->saved_delta))
847 uci_foreach_element(&p->saved_delta, e) {
848 uci_lua_add_change(L, e);
850 uci_foreach_element(&p->delta, e) {
851 uci_lua_add_change(L, e);
853 lua_setfield(L, -2, p->e.name);
861 uci_lua_changes(lua_State *L)
863 struct uci_context *ctx;
864 const char *package = NULL;
865 char **config = NULL;
869 ctx = find_context(L, &offset);
870 nargs = lua_gettop(L);
871 switch(nargs - offset) {
873 package = luaL_checkstring(L, 1 + offset);
877 return luaL_error(L, "invalid argument count");
882 uci_lua_changes_pkg(L, ctx, package);
886 if ((uci_list_configs(ctx, &config) != UCI_OK) || !config)
889 for (i = 0; config[i] != NULL; i++) {
890 uci_lua_changes_pkg(L, ctx, config[i]);
898 uci_lua_get_confdir(lua_State *L)
900 struct uci_context *ctx = find_context(L, NULL);
901 lua_pushstring(L, ctx->confdir);
906 uci_lua_set_confdir(lua_State *L)
908 struct uci_context *ctx;
911 ctx = find_context(L, &offset);
912 luaL_checkstring(L, 1 + offset);
913 uci_set_confdir(ctx, lua_tostring(L, -1));
914 return uci_push_status(L, ctx, false);
918 uci_lua_get_savedir(lua_State *L)
920 struct uci_context *ctx = find_context(L, NULL);
921 lua_pushstring(L, ctx->savedir);
926 uci_lua_add_delta(lua_State *L)
928 struct uci_context *ctx;
931 ctx = find_context(L, &offset);
932 luaL_checkstring(L, 1 + offset);
933 uci_add_delta_path(ctx, lua_tostring(L, -1));
934 return uci_push_status(L, ctx, false);
938 uci_lua_set_savedir(lua_State *L)
940 struct uci_context *ctx;
943 ctx = find_context(L, &offset);
944 luaL_checkstring(L, 1 + offset);
945 uci_set_savedir(ctx, lua_tostring(L, -1));
946 return uci_push_status(L, ctx, false);
950 uci_lua_list_configs(lua_State *L)
952 struct uci_context *ctx;
953 char **configs = NULL;
957 ctx = find_context(L, NULL);
958 if ((uci_list_configs(ctx, &configs) != UCI_OK) || !configs)
959 return uci_push_status(L, ctx, false);
961 for (ptr = configs; *ptr; ptr++) {
962 lua_pushstring(L, *ptr);
963 lua_rawseti(L, -2, i++);
970 uci_lua_gc(lua_State *L)
972 struct uci_context **ctx;
974 if (!lua_isuserdata(L, 1)) {
979 ctx = luaL_checkudata(L, 1, METANAME);
983 uci_free_context(*ctx);
989 uci_lua_cursor(lua_State *L)
991 struct uci_context **u;
992 int argc = lua_gettop(L);
994 u = lua_newuserdata(L, sizeof(struct uci_context *));
995 luaL_getmetatable(L, METANAME);
996 lua_setmetatable(L, -2);
998 *u = uci_alloc_context();
1000 return luaL_error(L, "Cannot allocate UCI context");
1003 if (lua_isstring(L, 2) &&
1004 (uci_set_savedir(*u, luaL_checkstring(L, 2)) != UCI_OK))
1005 return luaL_error(L, "Unable to set savedir");
1008 if (lua_isstring(L, 1) &&
1009 (uci_set_confdir(*u, luaL_checkstring(L, 1)) != UCI_OK))
1010 return luaL_error(L, "Unable to set confdir");
1018 static const luaL_Reg uci[] = {
1019 { "__gc", uci_lua_gc },
1020 { "close", uci_lua_gc },
1021 { "cursor", uci_lua_cursor },
1022 { "load", uci_lua_load },
1023 { "unload", uci_lua_unload },
1024 { "get", uci_lua_get },
1025 { "get_all", uci_lua_get_all },
1026 { "add", uci_lua_add },
1027 { "set", uci_lua_set },
1028 { "rename", uci_lua_rename },
1029 { "save", uci_lua_save },
1030 { "delete", uci_lua_delete },
1031 { "commit", uci_lua_commit },
1032 { "revert", uci_lua_revert },
1033 { "reorder", uci_lua_reorder },
1034 { "changes", uci_lua_changes },
1035 { "foreach", uci_lua_foreach },
1036 { "add_history", uci_lua_add_delta },
1037 { "add_delta", uci_lua_add_delta },
1038 { "get_confdir", uci_lua_get_confdir },
1039 { "set_confdir", uci_lua_set_confdir },
1040 { "get_savedir", uci_lua_get_savedir },
1041 { "set_savedir", uci_lua_set_savedir },
1042 { "list_configs", uci_lua_list_configs },
1048 luaopen_uci(lua_State *L)
1050 /* create metatable */
1051 luaL_newmetatable(L, METANAME);
1053 /* metatable.__index = metatable */
1054 lua_pushvalue(L, -1);
1055 lua_setfield(L, -2, "__index");
1057 /* fill metatable */
1058 luaL_setfuncs(L, uci, 0);
1063 lua_pushvalue(L, -1);
1064 luaL_setfuncs(L, uci, 0);
1065 lua_setglobal(L, MODNAME);