2 * Copyright (C) 2012 Jo-Philipp Wich <jow@openwrt.org>
3 * Copyright (C) 2012 John Crispin <blogic@openwrt.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License version 2.1
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.
17 #include <libubox/blobmsg.h>
18 #include <libubox/blobmsg_json.h>
22 #define MODNAME "ubus"
23 #define METANAME MODNAME ".meta"
25 static lua_State
*state
;
27 struct ubus_lua_connection
{
30 struct ubus_context
*ctx
;
33 struct ubus_lua_object
{
38 struct ubus_lua_event
{
39 struct ubus_event_handler e
;
44 ubus_lua_parse_blob(lua_State
*L
, struct blob_attr
*attr
, bool table
);
47 ubus_lua_parse_blob_array(lua_State
*L
, struct blob_attr
*attr
, int len
, bool table
)
52 struct blob_attr
*pos
;
56 __blob_for_each_attr(pos
, attr
, rem
)
58 rv
= ubus_lua_parse_blob(L
, pos
, table
);
63 lua_rawseti(L
, -2, idx
++);
70 ubus_lua_parse_blob(lua_State
*L
, struct blob_attr
*attr
, bool table
)
76 if (!blobmsg_check_attr(attr
, false))
79 if (table
&& blobmsg_name(attr
)[0])
81 lua_pushstring(L
, blobmsg_name(attr
));
85 data
= blobmsg_data(attr
);
86 len
= blobmsg_data_len(attr
);
88 switch (blob_id(attr
))
90 case BLOBMSG_TYPE_BOOL
:
91 lua_pushboolean(L
, *(uint8_t *)data
);
94 case BLOBMSG_TYPE_INT16
:
95 lua_pushinteger(L
, be16_to_cpu(*(uint16_t *)data
));
98 case BLOBMSG_TYPE_INT32
:
99 lua_pushinteger(L
, be32_to_cpu(*(uint32_t *)data
));
102 case BLOBMSG_TYPE_INT64
:
103 lua_pushnumber(L
, (double) be64_to_cpu(*(uint64_t *)data
));
106 case BLOBMSG_TYPE_STRING
:
107 lua_pushstring(L
, data
);
110 case BLOBMSG_TYPE_ARRAY
:
111 ubus_lua_parse_blob_array(L
, data
, len
, false);
114 case BLOBMSG_TYPE_TABLE
:
115 ubus_lua_parse_blob_array(L
, data
, len
, true);
128 ubus_lua_format_blob_is_array(lua_State
*L
)
133 /* Find out whether table is array-like */
134 for (lua_pushnil(L
); lua_next(L
, -2); lua_pop(L
, 1))
137 if (lua_type(L
, -2) != LUA_TNUMBER
&& lua_type(L
, -2) != LUA_TINT
)
139 if (lua_type(L
, -2) != LUA_TNUMBER
)
146 cur
= lua_tointeger(L
, -2);
148 if ((cur
- 1) != prv
)
161 ubus_lua_format_blob_array(lua_State
*L
, struct blob_buf
*b
, bool table
);
164 ubus_lua_format_blob(lua_State
*L
, struct blob_buf
*b
, bool table
)
168 const char *key
= table
? lua_tostring(L
, -2) : NULL
;
170 switch (lua_type(L
, -1))
173 blobmsg_add_u8(b
, key
, (uint8_t)lua_toboolean(L
, -1));
180 blobmsg_add_u32(b
, key
, (uint32_t)lua_tointeger(L
, -1));
185 case LUA_TLIGHTUSERDATA
:
186 blobmsg_add_string(b
, key
, lua_tostring(L
, -1));
190 if (ubus_lua_format_blob_is_array(L
))
192 c
= blobmsg_open_array(b
, key
);
193 rv
= ubus_lua_format_blob_array(L
, b
, false);
194 blobmsg_close_array(b
, c
);
198 c
= blobmsg_open_table(b
, key
);
199 rv
= ubus_lua_format_blob_array(L
, b
, true);
200 blobmsg_close_table(b
, c
);
213 ubus_lua_format_blob_array(lua_State
*L
, struct blob_buf
*b
, bool table
)
215 for (lua_pushnil(L
); lua_next(L
, -2); lua_pop(L
, 1))
217 if (!ubus_lua_format_blob(L
, b
, table
))
229 ubus_lua_connect(lua_State
*L
)
231 struct ubus_lua_connection
*c
;
232 const char *sockpath
= luaL_optstring(L
, 1, NULL
);
233 int timeout
= luaL_optint(L
, 2, 30);
235 if ((c
= lua_newuserdata(L
, sizeof(*c
))) != NULL
&&
236 (c
->ctx
= ubus_connect(sockpath
)) != NULL
)
238 ubus_add_uloop(c
->ctx
);
239 c
->timeout
= timeout
;
240 memset(&c
->buf
, 0, sizeof(c
->buf
));
241 luaL_getmetatable(L
, METANAME
);
242 lua_setmetatable(L
, -2);
246 /* NB: no errors from ubus_connect() yet */
248 lua_pushinteger(L
, UBUS_STATUS_UNKNOWN_ERROR
);
254 ubus_lua_objects_cb(struct ubus_context
*c
, struct ubus_object_data
*o
, void *p
)
256 lua_State
*L
= (lua_State
*)p
;
258 lua_pushstring(L
, o
->path
);
259 lua_rawseti(L
, -2, lua_objlen(L
, -2) + 1);
263 ubus_lua_objects(lua_State
*L
)
266 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
269 rv
= ubus_lookup(c
->ctx
, NULL
, ubus_lua_objects_cb
, L
);
271 if (rv
!= UBUS_STATUS_OK
)
275 lua_pushinteger(L
, rv
);
283 ubus_method_handler(struct ubus_context
*ctx
, struct ubus_object
*obj
,
284 struct ubus_request_data
*req
, const char *method
,
285 struct blob_attr
*msg
)
287 struct ubus_lua_object
*o
= container_of(obj
, struct ubus_lua_object
, o
);
290 lua_getglobal(state
, "__ubus_cb");
291 lua_rawgeti(state
, -1, o
->r
);
292 lua_getfield(state
, -1, method
);
293 lua_remove(state
, -2);
294 lua_remove(state
, -2);
296 if (lua_isfunction(state
, -1)) {
297 lua_pushlightuserdata(state
, req
);
301 ubus_lua_parse_blob_array(state
, blob_data(msg
), blob_len(msg
), true);
302 lua_call(state
, 2, 1);
303 if (lua_isnumber(state
, -1))
304 rv
= lua_tonumber(state
, -1);
311 static int lua_gettablelen(lua_State
*L
, int index
)
317 while (lua_next(L
, index
) != 0) {
325 static int ubus_lua_reply(lua_State
*L
)
327 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
328 struct ubus_request_data
*req
;
330 luaL_checktype(L
, 3, LUA_TTABLE
);
331 blob_buf_init(&c
->buf
, 0);
333 if (!ubus_lua_format_blob_array(L
, &c
->buf
, true))
336 lua_pushinteger(L
, UBUS_STATUS_INVALID_ARGUMENT
);
340 req
= lua_touserdata(L
, 2);
341 ubus_send_reply(c
->ctx
, req
, c
->buf
.head
);
346 static int ubus_lua_load_methods(lua_State
*L
, struct ubus_method
*m
)
348 struct blobmsg_policy
*p
;
352 /* get the function pointer */
353 lua_pushinteger(L
, 1);
356 /* get the policy table */
357 lua_pushinteger(L
, 2);
360 /* check if the method table is valid */
361 if ((lua_type(L
, -2) != LUA_TFUNCTION
) ||
362 (lua_type(L
, -1) != LUA_TTABLE
) ||
368 /* store function pointer */
369 lua_pushvalue(L
, -2);
370 lua_setfield(L
, -6, lua_tostring(L
, -5));
372 m
->name
= lua_tostring(L
, -4);
373 m
->handler
= ubus_method_handler
;
375 plen
= lua_gettablelen(L
, -1);
377 /* exit if policy table is empty */
383 /* setup the policy pointers */
384 p
= malloc(sizeof(struct blobmsg_policy
) * plen
);
388 memset(p
, 0, sizeof(struct blobmsg_policy
) * plen
);
391 while (lua_next(L
, -2) != 0) {
392 int val
= lua_tointeger(L
, -1);
394 /* check if the policy is valid */
395 if ((lua_type(L
, -2) != LUA_TSTRING
) ||
396 (lua_type(L
, -1) != LUA_TNUMBER
) ||
398 (val
> BLOBMSG_TYPE_LAST
)) {
402 p
[pidx
].name
= lua_tostring(L
, -2);
414 static struct ubus_object
* ubus_lua_load_object(lua_State
*L
)
416 struct ubus_lua_object
*obj
= NULL
;
417 int mlen
= lua_gettablelen(L
, -1);
418 struct ubus_method
*m
;
421 /* setup object pointers */
422 obj
= malloc(sizeof(struct ubus_lua_object
));
426 memset(obj
, 0, sizeof(struct ubus_lua_object
));
427 obj
->o
.name
= lua_tostring(L
, -2);
429 /* setup method pointers */
430 m
= malloc(sizeof(struct ubus_method
) * mlen
);
431 memset(m
, 0, sizeof(struct ubus_method
) * mlen
);
434 /* setup type pointers */
435 obj
->o
.type
= malloc(sizeof(struct ubus_object_type
));
441 memset(obj
->o
.type
, 0, sizeof(struct ubus_object_type
));
442 obj
->o
.type
->name
= lua_tostring(L
, -2);
444 obj
->o
.type
->methods
= obj
->o
.methods
;
446 /* create the callback lookup table */
447 lua_createtable(L
, 1, 0);
448 lua_getglobal(L
, "__ubus_cb");
449 lua_pushvalue(L
, -2);
450 obj
->r
= luaL_ref(L
, -2);
453 /* scan each method */
455 while (lua_next(L
, -3) != 0) {
456 /* check if it looks like a method */
457 if ((lua_type(L
, -2) != LUA_TSTRING
) ||
458 (lua_type(L
, -1) != LUA_TTABLE
) ||
459 !lua_objlen(L
, -1)) {
464 if (!ubus_lua_load_methods(L
, &m
[midx
]))
469 obj
->o
.type
->n_methods
= obj
->o
.n_methods
= midx
;
471 /* pop the callback table */
477 static int ubus_lua_add(lua_State
*L
)
479 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
481 /* verify top level object */
482 if (lua_istable(L
, 1)) {
483 lua_pushstring(L
, "you need to pass a table");
488 /* scan each object */
490 while (lua_next(L
, -2) != 0) {
491 struct ubus_object
*obj
= NULL
;
493 /* check if the object has a table of methods */
494 if ((lua_type(L
, -2) == LUA_TSTRING
) && (lua_type(L
, -1) == LUA_TTABLE
)) {
495 obj
= ubus_lua_load_object(L
);
498 ubus_add_object(c
->ctx
, obj
);
507 ubus_lua_signatures_cb(struct ubus_context
*c
, struct ubus_object_data
*o
, void *p
)
509 lua_State
*L
= (lua_State
*)p
;
514 ubus_lua_parse_blob_array(L
, blob_data(o
->signature
), blob_len(o
->signature
), true);
518 ubus_lua_signatures(lua_State
*L
)
521 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
522 const char *path
= luaL_checkstring(L
, 2);
524 rv
= ubus_lookup(c
->ctx
, path
, ubus_lua_signatures_cb
, L
);
526 if (rv
!= UBUS_STATUS_OK
)
530 lua_pushinteger(L
, rv
);
539 ubus_lua_call_cb(struct ubus_request
*req
, int type
, struct blob_attr
*msg
)
541 lua_State
*L
= (lua_State
*)req
->priv
;
547 ubus_lua_parse_blob_array(L
, blob_data(msg
), blob_len(msg
), true);
551 ubus_lua_call(lua_State
*L
)
555 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
556 const char *path
= luaL_checkstring(L
, 2);
557 const char *func
= luaL_checkstring(L
, 3);
559 luaL_checktype(L
, 4, LUA_TTABLE
);
560 blob_buf_init(&c
->buf
, 0);
562 if (!ubus_lua_format_blob_array(L
, &c
->buf
, true))
565 lua_pushinteger(L
, UBUS_STATUS_INVALID_ARGUMENT
);
569 rv
= ubus_lookup_id(c
->ctx
, path
, &id
);
574 lua_pushinteger(L
, rv
);
579 rv
= ubus_invoke(c
->ctx
, id
, func
, c
->buf
.head
, ubus_lua_call_cb
, L
, c
->timeout
* 1000);
581 if (rv
!= UBUS_STATUS_OK
)
585 lua_pushinteger(L
, rv
);
589 return lua_gettop(L
) - top
;
593 ubus_event_handler(struct ubus_context
*ctx
, struct ubus_event_handler
*ev
,
594 const char *type
, struct blob_attr
*msg
)
596 struct ubus_lua_event
*listener
= container_of(ev
, struct ubus_lua_event
, e
);
598 lua_getglobal(state
, "__ubus_cb_event");
599 lua_rawgeti(state
, -1, listener
->r
);
601 if (lua_isfunction(state
, -1)) {
602 ubus_lua_parse_blob_array(state
, blob_data(msg
), blob_len(msg
), true);
603 lua_call(state
, 1, 0);
607 static struct ubus_event_handler
*
608 ubus_lua_load_event(lua_State
*L
)
610 struct ubus_lua_event
* event
= NULL
;
612 event
= malloc(sizeof(struct ubus_lua_event
));
616 memset(event
, 0, sizeof(struct ubus_lua_event
));
617 event
->e
.cb
= ubus_event_handler
;
619 /* update the he callback lookup table */
620 lua_getglobal(L
, "__ubus_cb_event");
621 lua_pushvalue(L
, -2);
622 event
->r
= luaL_ref(L
, -2);
623 lua_setfield(L
, -1, lua_tostring(L
, -3));
629 ubus_lua_listen(lua_State
*L
) {
630 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
632 /* verify top level object */
633 luaL_checktype(L
, 2, LUA_TTABLE
);
635 /* scan each object */
637 while (lua_next(L
, -2) != 0) {
638 struct ubus_event_handler
*listener
;
640 /* check if the key is a string and the value is a method */
641 if ((lua_type(L
, -2) == LUA_TSTRING
) && (lua_type(L
, -1) == LUA_TFUNCTION
)) {
642 listener
= ubus_lua_load_event(L
);
643 if(listener
!= NULL
) {
644 ubus_register_event_handler(c
->ctx
, listener
, lua_tostring(L
, -2));
653 ubus_lua_send(lua_State
*L
)
655 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
656 const char *event
= luaL_checkstring(L
, 2);
659 return luaL_argerror(L
, 2, "no event name");
661 // Event content convert to ubus form
662 luaL_checktype(L
, 3, LUA_TTABLE
);
663 blob_buf_init(&c
->buf
, 0);
665 if (!ubus_lua_format_blob_array(L
, &c
->buf
, true)) {
667 lua_pushinteger(L
, UBUS_STATUS_INVALID_ARGUMENT
);
672 ubus_send_event(c
->ctx
, event
, c
->buf
.head
);
680 ubus_lua__gc(lua_State
*L
)
682 struct ubus_lua_connection
*c
= luaL_checkudata(L
, 1, METANAME
);
684 blob_buf_free(&c
->buf
);
688 memset(c
, 0, sizeof(*c
));
694 static const luaL_Reg ubus
[] = {
695 { "connect", ubus_lua_connect
},
696 { "objects", ubus_lua_objects
},
697 { "add", ubus_lua_add
},
698 { "reply", ubus_lua_reply
},
699 { "signatures", ubus_lua_signatures
},
700 { "call", ubus_lua_call
},
701 { "close", ubus_lua__gc
},
702 { "listen", ubus_lua_listen
},
703 { "send", ubus_lua_send
},
704 { "__gc", ubus_lua__gc
},
708 /* avoid missing prototype warning */
709 int luaopen_ubus(lua_State
*L
);
712 luaopen_ubus(lua_State
*L
)
714 /* create metatable */
715 luaL_newmetatable(L
, METANAME
);
717 /* metatable.__index = metatable */
718 lua_pushvalue(L
, -1);
719 lua_setfield(L
, -2, "__index");
722 luaL_register(L
, NULL
, ubus
);
726 luaL_register(L
, MODNAME
, ubus
);
728 /* set some enum defines */
729 lua_pushinteger(L
, BLOBMSG_TYPE_ARRAY
);
730 lua_setfield(L
, -2, "ARRAY");
731 lua_pushinteger(L
, BLOBMSG_TYPE_TABLE
);
732 lua_setfield(L
, -2, "TABLE");
733 lua_pushinteger(L
, BLOBMSG_TYPE_STRING
);
734 lua_setfield(L
, -2, "STRING");
735 lua_pushinteger(L
, BLOBMSG_TYPE_INT64
);
736 lua_setfield(L
, -2, "INT64");
737 lua_pushinteger(L
, BLOBMSG_TYPE_INT32
);
738 lua_setfield(L
, -2, "INT32");
739 lua_pushinteger(L
, BLOBMSG_TYPE_INT16
);
740 lua_setfield(L
, -2, "INT16");
741 lua_pushinteger(L
, BLOBMSG_TYPE_INT8
);
742 lua_setfield(L
, -2, "INT8");
743 lua_pushinteger(L
, BLOBMSG_TYPE_BOOL
);
744 lua_setfield(L
, -2, "BOOLEAN");
746 /* used in our callbacks */
749 /* create the callback table */
750 lua_createtable(L
, 1, 0);
751 lua_setglobal(L
, "__ubus_cb");
753 /* create the event table */
754 lua_createtable(L
, 1, 0);
755 lua_setglobal(L
, "__ubus_cb_event");