2 * Copyright (C) 2012 Jo-Philipp Wich <jow@openwrt.org>
3 * Copyright (C) 2012 John Crispin <blogic@openwrt.org>
4 * Copyright (C) 2016 Iain Fraser <iainf@netduma.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License version 2.1
8 * as published by the Free Software Foundation
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
18 #include <libubox/blobmsg.h>
19 #include <libubox/blobmsg_json.h>
23 #define MODNAME "ubus"
24 #define METANAME MODNAME ".meta"
26 static lua_State *state;
28 struct ubus_lua_connection {
31 struct ubus_context *ctx;
34 struct ubus_lua_object {
40 struct ubus_lua_event {
41 struct ubus_event_handler e;
45 struct ubus_lua_subscriber {
46 struct ubus_subscriber s;
52 ubus_lua_parse_blob(lua_State *L, struct blob_attr *attr, bool table);
55 ubus_lua_parse_blob_array(lua_State *L, struct blob_attr *attr, int len, bool table)
60 struct blob_attr *pos;
64 __blob_for_each_attr(pos, attr, rem)
66 rv = ubus_lua_parse_blob(L, pos, table);
71 lua_rawseti(L, -2, idx++);
78 ubus_lua_parse_blob(lua_State *L, struct blob_attr *attr, bool table)
84 if (!blobmsg_check_attr(attr, false))
87 if (table && blobmsg_name(attr)[0])
89 lua_pushstring(L, blobmsg_name(attr));
93 data = blobmsg_data(attr);
94 len = blobmsg_data_len(attr);
96 switch (blob_id(attr))
98 case BLOBMSG_TYPE_BOOL:
99 lua_pushboolean(L, *(uint8_t *)data);
102 case BLOBMSG_TYPE_INT16:
103 lua_pushinteger(L, be16_to_cpu(*(uint16_t *)data));
106 case BLOBMSG_TYPE_INT32:
107 lua_pushinteger(L, be32_to_cpu(*(uint32_t *)data));
110 case BLOBMSG_TYPE_INT64:
111 lua_pushnumber(L, (double) be64_to_cpu(*(uint64_t *)data));
114 case BLOBMSG_TYPE_STRING:
115 lua_pushstring(L, data);
118 case BLOBMSG_TYPE_ARRAY:
119 ubus_lua_parse_blob_array(L, data, len, false);
122 case BLOBMSG_TYPE_TABLE:
123 ubus_lua_parse_blob_array(L, data, len, true);
136 ubus_lua_format_blob_is_array(lua_State *L)
141 /* Find out whether table is array-like */
142 for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1))
145 if (lua_type(L, -2) != LUA_TNUMBER && lua_type(L, -2) != LUA_TINT)
147 if (lua_type(L, -2) != LUA_TNUMBER)
154 cur = lua_tointeger(L, -2);
156 if ((cur - 1) != prv)
169 ubus_lua_format_blob_array(lua_State *L, struct blob_buf *b, bool table);
172 ubus_lua_format_blob(lua_State *L, struct blob_buf *b, bool table)
176 const char *key = table ? lua_tostring(L, -2) : NULL;
178 switch (lua_type(L, -1))
181 blobmsg_add_u8(b, key, (uint8_t)lua_toboolean(L, -1));
188 blobmsg_add_u32(b, key, (uint32_t)lua_tointeger(L, -1));
193 case LUA_TLIGHTUSERDATA:
194 blobmsg_add_string(b, key, lua_tostring(L, -1));
198 if (ubus_lua_format_blob_is_array(L))
200 c = blobmsg_open_array(b, key);
201 rv = ubus_lua_format_blob_array(L, b, false);
202 blobmsg_close_array(b, c);
206 c = blobmsg_open_table(b, key);
207 rv = ubus_lua_format_blob_array(L, b, true);
208 blobmsg_close_table(b, c);
221 ubus_lua_format_blob_array(lua_State *L, struct blob_buf *b, bool table)
223 for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1))
225 if (!ubus_lua_format_blob(L, b, table))
237 ubus_lua_connect(lua_State *L)
239 struct ubus_lua_connection *c;
240 const char *sockpath = luaL_optstring(L, 1, NULL);
241 int timeout = luaL_optint(L, 2, 30);
243 if ((c = lua_newuserdata(L, sizeof(*c))) != NULL &&
244 (c->ctx = ubus_connect(sockpath)) != NULL)
246 ubus_add_uloop(c->ctx);
247 c->timeout = timeout;
248 memset(&c->buf, 0, sizeof(c->buf));
249 luaL_getmetatable(L, METANAME);
250 lua_setmetatable(L, -2);
254 /* NB: no errors from ubus_connect() yet */
256 lua_pushinteger(L, UBUS_STATUS_UNKNOWN_ERROR);
262 ubus_lua_objects_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
264 lua_State *L = (lua_State *)p;
266 lua_pushstring(L, o->path);
267 lua_rawseti(L, -2, lua_objlen(L, -2) + 1);
271 ubus_lua_objects(lua_State *L)
274 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
277 rv = ubus_lookup(c->ctx, NULL, ubus_lua_objects_cb, L);
279 if (rv != UBUS_STATUS_OK)
283 lua_pushinteger(L, rv);
291 ubus_method_handler(struct ubus_context *ctx, struct ubus_object *obj,
292 struct ubus_request_data *req, const char *method,
293 struct blob_attr *msg)
295 struct ubus_lua_object *o = container_of(obj, struct ubus_lua_object, o);
298 lua_getglobal(state, "__ubus_cb");
299 lua_rawgeti(state, -1, o->r);
300 lua_getfield(state, -1, method);
301 lua_remove(state, -2);
302 lua_remove(state, -2);
304 if (lua_isfunction(state, -1)) {
305 lua_pushlightuserdata(state, req);
309 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
310 lua_call(state, 2, 1);
311 if (lua_isnumber(state, -1))
312 rv = lua_tonumber(state, -1);
320 static int lua_gettablelen(lua_State *L, int index)
326 while (lua_next(L, index) != 0) {
334 static int ubus_lua_reply(lua_State *L)
336 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
337 struct ubus_request_data *req;
339 luaL_checktype(L, 3, LUA_TTABLE);
340 blob_buf_init(&c->buf, 0);
342 if (!ubus_lua_format_blob_array(L, &c->buf, true))
345 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
349 req = lua_touserdata(L, 2);
350 ubus_send_reply(c->ctx, req, c->buf.head);
355 static int ubus_lua_load_methods(lua_State *L, struct ubus_method *m)
357 struct blobmsg_policy *p;
361 /* get the function pointer */
362 lua_pushinteger(L, 1);
365 /* get the policy table */
366 lua_pushinteger(L, 2);
369 /* check if the method table is valid */
370 if ((lua_type(L, -2) != LUA_TFUNCTION) ||
371 (lua_type(L, -1) != LUA_TTABLE) ||
377 /* store function pointer */
378 lua_pushvalue(L, -2);
379 lua_setfield(L, -6, lua_tostring(L, -5));
381 m->name = lua_tostring(L, -4);
382 m->handler = ubus_method_handler;
384 plen = lua_gettablelen(L, -1);
386 /* exit if policy table is empty */
392 /* setup the policy pointers */
393 p = malloc(sizeof(struct blobmsg_policy) * plen);
397 memset(p, 0, sizeof(struct blobmsg_policy) * plen);
400 while (lua_next(L, -2) != 0) {
401 int val = lua_tointeger(L, -1);
403 /* check if the policy is valid */
404 if ((lua_type(L, -2) != LUA_TSTRING) ||
405 (lua_type(L, -1) != LUA_TNUMBER) ||
407 (val > BLOBMSG_TYPE_LAST)) {
411 p[pidx].name = lua_tostring(L, -2);
424 ubus_new_sub_cb(struct ubus_context *ctx, struct ubus_object *obj)
426 struct ubus_lua_object *luobj;
428 luobj = container_of(obj, struct ubus_lua_object, o);
430 lua_getglobal(state, "__ubus_cb_publisher");
431 lua_rawgeti(state, -1, luobj->rsubscriber);
432 lua_remove(state, -2);
434 if (lua_isfunction(state, -1)) {
435 lua_pushnumber(state, luobj->o.has_subscribers );
436 lua_call(state, 1, 0);
443 ubus_lua_load_newsub_cb( lua_State *L, struct ubus_lua_object *obj )
445 /* keep ref to func */
446 lua_getglobal(L, "__ubus_cb_publisher");
447 lua_pushvalue(L, -2);
448 obj->rsubscriber = luaL_ref(L, -2);
452 obj->o.subscribe_cb = ubus_new_sub_cb;
456 static struct ubus_object* ubus_lua_load_object(lua_State *L)
458 struct ubus_lua_object *obj = NULL;
459 int mlen = lua_gettablelen(L, -1);
460 struct ubus_method *m;
463 /* setup object pointers */
464 obj = malloc(sizeof(struct ubus_lua_object));
468 memset(obj, 0, sizeof(struct ubus_lua_object));
469 obj->o.name = lua_tostring(L, -2);
471 /* setup method pointers */
472 m = malloc(sizeof(struct ubus_method) * mlen);
473 memset(m, 0, sizeof(struct ubus_method) * mlen);
476 /* setup type pointers */
477 obj->o.type = malloc(sizeof(struct ubus_object_type));
483 memset(obj->o.type, 0, sizeof(struct ubus_object_type));
484 obj->o.type->name = lua_tostring(L, -2);
486 obj->o.type->methods = obj->o.methods;
488 /* create the callback lookup table */
489 lua_createtable(L, 1, 0);
490 lua_getglobal(L, "__ubus_cb");
491 lua_pushvalue(L, -2);
492 obj->r = luaL_ref(L, -2);
495 /* scan each method */
497 while (lua_next(L, -3) != 0) {
498 /* check if its the subscriber notification callback */
499 if( lua_type( L, -2 ) == LUA_TSTRING &&
500 lua_type( L, -1 ) == LUA_TFUNCTION ){
501 if( !strcmp( lua_tostring( L, -2 ), "__subscriber_cb" ) )
502 ubus_lua_load_newsub_cb( L, obj );
505 /* check if it looks like a method */
506 if ((lua_type(L, -2) != LUA_TSTRING) ||
507 (lua_type(L, -1) != LUA_TTABLE) ||
508 !lua_objlen(L, -1)) {
513 if (!ubus_lua_load_methods(L, &m[midx]))
518 obj->o.type->n_methods = obj->o.n_methods = midx;
520 /* pop the callback table */
526 static int ubus_lua_add(lua_State *L)
528 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
530 /* verify top level object */
531 if (lua_istable(L, 1)) {
532 lua_pushstring(L, "you need to pass a table");
537 /* scan each object */
539 while (lua_next(L, -2) != 0) {
540 struct ubus_object *obj = NULL;
542 /* check if the object has a table of methods */
543 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TTABLE)) {
544 obj = ubus_lua_load_object(L);
547 ubus_add_object(c->ctx, obj);
549 /* allow future reference of ubus obj */
550 lua_pushstring(state,"__ubusobj");
551 lua_pushlightuserdata(state, obj);
552 lua_settable(state,-3);
562 ubus_lua_notify( lua_State *L )
564 struct ubus_lua_connection *c;
565 struct ubus_object *obj;
568 c = luaL_checkudata(L, 1, METANAME);
569 method = luaL_checkstring(L, 3);
570 luaL_checktype(L, 4, LUA_TTABLE);
572 if( !lua_islightuserdata( L, 2 ) ){
573 lua_pushfstring( L, "Invald 2nd parameter, expected ubus obj ref" );
576 obj = lua_touserdata( L, 2 );
578 /* create parameters from table */
579 blob_buf_init(&c->buf, 0);
580 if( !ubus_lua_format_blob_array( L, &c->buf, true ) ){
581 lua_pushfstring( L, "Invalid 4th parameter, expected table of arguments" );
585 ubus_notify( c->ctx, obj, method, c->buf.head, -1 );
590 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
592 lua_State *L = (lua_State *)p;
597 ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
601 ubus_lua_signatures(lua_State *L)
604 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
605 const char *path = luaL_checkstring(L, 2);
607 rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
609 if (rv != UBUS_STATUS_OK)
613 lua_pushinteger(L, rv);
622 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
624 lua_State *L = (lua_State *)req->priv;
630 ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
634 ubus_lua_call(lua_State *L)
638 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
639 const char *path = luaL_checkstring(L, 2);
640 const char *func = luaL_checkstring(L, 3);
642 luaL_checktype(L, 4, LUA_TTABLE);
643 blob_buf_init(&c->buf, 0);
645 if (!ubus_lua_format_blob_array(L, &c->buf, true))
648 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
652 rv = ubus_lookup_id(c->ctx, path, &id);
657 lua_pushinteger(L, rv);
662 rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
664 if (rv != UBUS_STATUS_OK)
668 lua_pushinteger(L, rv);
672 return lua_gettop(L) - top;
676 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
677 const char *type, struct blob_attr *msg)
679 struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
681 lua_getglobal(state, "__ubus_cb_event");
682 lua_rawgeti(state, -1, listener->r);
683 lua_remove(state, -2);
685 if (lua_isfunction(state, -1)) {
686 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
687 lua_call(state, 1, 0);
693 static struct ubus_event_handler*
694 ubus_lua_load_event(lua_State *L)
696 struct ubus_lua_event* event = NULL;
698 event = malloc(sizeof(struct ubus_lua_event));
702 memset(event, 0, sizeof(struct ubus_lua_event));
703 event->e.cb = ubus_event_handler;
705 /* update the he callback lookup table */
706 lua_getglobal(L, "__ubus_cb_event");
707 lua_pushvalue(L, -2);
708 event->r = luaL_ref(L, -2);
709 lua_setfield(L, -1, lua_tostring(L, -3));
715 ubus_lua_listen(lua_State *L) {
716 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
718 /* verify top level object */
719 luaL_checktype(L, 2, LUA_TTABLE);
721 /* scan each object */
723 while (lua_next(L, -2) != 0) {
724 struct ubus_event_handler *listener;
726 /* check if the key is a string and the value is a method */
727 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TFUNCTION)) {
728 listener = ubus_lua_load_event(L);
729 if(listener != NULL) {
730 ubus_register_event_handler(c->ctx, listener, lua_tostring(L, -2));
739 ubus_sub_remove_handler(struct ubus_context *ctx, struct ubus_subscriber *s,
742 struct ubus_lua_subscriber *sub;
744 sub = container_of(s, struct ubus_lua_subscriber, s);
746 lua_getglobal(state, "__ubus_cb_subscribe");
747 lua_rawgeti(state, -1, sub->rremove);
748 lua_remove(state, -2);
750 if (lua_isfunction(state, -1)) {
751 lua_call(state, 0, 0);
758 ubus_sub_notify_handler(struct ubus_context *ctx, struct ubus_object *obj,
759 struct ubus_request_data *req, const char *method,
760 struct blob_attr *msg)
762 struct ubus_subscriber *s;
763 struct ubus_lua_subscriber *sub;
765 s = container_of(obj, struct ubus_subscriber, obj);
766 sub = container_of(s, struct ubus_lua_subscriber, s);
768 lua_getglobal(state, "__ubus_cb_subscribe");
769 lua_rawgeti(state, -1, sub->rnotify);
770 lua_remove(state, -2);
772 if (lua_isfunction(state, -1)) {
774 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
775 lua_call(state, 1, 0);
777 lua_call(state, 0, 0);
789 ubus_lua_do_subscribe( struct ubus_context *ctx, lua_State *L, const char* target,
790 int idxnotify, int idxremove )
794 struct ubus_lua_subscriber *sub;
796 if( ( status = ubus_lookup_id( ctx, target, &id ) ) ){
797 lua_pushfstring( L, "Unable find target, status=%d", status );
801 sub = malloc( sizeof( struct ubus_lua_subscriber ) );
802 memset( sub, 0, sizeof( struct ubus_lua_subscriber ) );
804 lua_pushstring( L, "Out of memory" );
809 lua_getglobal(L, "__ubus_cb_subscribe");
810 lua_pushvalue(L, idxnotify);
811 sub->rnotify = luaL_ref(L, -2);
813 sub->s.cb = ubus_sub_notify_handler;
817 lua_getglobal(L, "__ubus_cb_subscribe");
818 lua_pushvalue(L, idxnotify);
819 sub->rnotify = luaL_ref(L, -2);
821 sub->s.remove_cb = ubus_sub_remove_handler;
824 if( ( status = ubus_register_subscriber( ctx, &sub->s ) ) ){
825 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
829 if( ( status = ubus_subscribe( ctx, &sub->s, id) ) ){
830 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
836 ubus_lua_subscribe(lua_State *L) {
837 int idxnotify, idxremove, stackstart;
838 struct ubus_lua_connection *c;
841 idxnotify = idxremove = 0;
842 stackstart = lua_gettop( L );
845 c = luaL_checkudata(L, 1, METANAME);
846 target = luaL_checkstring(L, 2);
847 luaL_checktype(L, 3, LUA_TTABLE);
850 lua_pushstring( L, "notify");
851 lua_gettable( L, 3 );
852 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
853 idxnotify = lua_gettop( L );
858 lua_pushstring( L, "remove");
859 lua_gettable( L, 3 );
860 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
861 idxremove = lua_gettop( L );
867 ubus_lua_do_subscribe( c->ctx, L, target, idxnotify, idxremove );
869 if( lua_gettop( L ) > stackstart )
870 lua_pop( L, lua_gettop( L ) - stackstart );
876 ubus_lua_send(lua_State *L)
878 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
879 const char *event = luaL_checkstring(L, 2);
882 return luaL_argerror(L, 2, "no event name");
884 // Event content convert to ubus form
885 luaL_checktype(L, 3, LUA_TTABLE);
886 blob_buf_init(&c->buf, 0);
888 if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
890 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
895 ubus_send_event(c->ctx, event, c->buf.head);
903 ubus_lua__gc(lua_State *L)
905 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
907 blob_buf_free(&c->buf);
911 memset(c, 0, sizeof(*c));
917 static const luaL_Reg ubus[] = {
918 { "connect", ubus_lua_connect },
919 { "objects", ubus_lua_objects },
920 { "add", ubus_lua_add },
921 { "notify", ubus_lua_notify },
922 { "reply", ubus_lua_reply },
923 { "signatures", ubus_lua_signatures },
924 { "call", ubus_lua_call },
925 { "close", ubus_lua__gc },
926 { "listen", ubus_lua_listen },
927 { "send", ubus_lua_send },
928 { "subscribe", ubus_lua_subscribe },
929 { "__gc", ubus_lua__gc },
933 /* avoid missing prototype warning */
934 int luaopen_ubus(lua_State *L);
937 luaopen_ubus(lua_State *L)
939 /* create metatable */
940 luaL_newmetatable(L, METANAME);
942 /* metatable.__index = metatable */
943 lua_pushvalue(L, -1);
944 lua_setfield(L, -2, "__index");
947 luaL_register(L, NULL, ubus);
951 luaL_register(L, MODNAME, ubus);
953 /* set some enum defines */
954 lua_pushinteger(L, BLOBMSG_TYPE_ARRAY);
955 lua_setfield(L, -2, "ARRAY");
956 lua_pushinteger(L, BLOBMSG_TYPE_TABLE);
957 lua_setfield(L, -2, "TABLE");
958 lua_pushinteger(L, BLOBMSG_TYPE_STRING);
959 lua_setfield(L, -2, "STRING");
960 lua_pushinteger(L, BLOBMSG_TYPE_INT64);
961 lua_setfield(L, -2, "INT64");
962 lua_pushinteger(L, BLOBMSG_TYPE_INT32);
963 lua_setfield(L, -2, "INT32");
964 lua_pushinteger(L, BLOBMSG_TYPE_INT16);
965 lua_setfield(L, -2, "INT16");
966 lua_pushinteger(L, BLOBMSG_TYPE_INT8);
967 lua_setfield(L, -2, "INT8");
968 lua_pushinteger(L, BLOBMSG_TYPE_BOOL);
969 lua_setfield(L, -2, "BOOLEAN");
971 /* used in our callbacks */
974 /* create the callback table */
975 lua_createtable(L, 1, 0);
976 lua_setglobal(L, "__ubus_cb");
978 /* create the event table */
979 lua_createtable(L, 1, 0);
980 lua_setglobal(L, "__ubus_cb_event");
982 /* create the subscriber table */
983 lua_createtable(L, 1, 0);
984 lua_setglobal(L, "__ubus_cb_subscribe");
986 /* create the publisher table - notifications of new subs */
987 lua_createtable(L, 1, 0);
988 lua_setglobal(L, "__ubus_cb_publisher");