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_defer_request(lua_State *L)
357 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
358 struct ubus_request_data *req = lua_touserdata(L, 2);
359 struct ubus_request_data *new_req = lua_newuserdata(L, sizeof(struct ubus_request_data));
360 ubus_defer_request(c->ctx, req, new_req);
365 static int ubus_lua_complete_deferred_request(lua_State *L)
367 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
368 struct ubus_request_data *req = lua_touserdata(L, 2);
369 int ret = luaL_checkinteger(L, 3);
370 ubus_complete_deferred_request(c->ctx, req, ret);
375 static int ubus_lua_load_methods(lua_State *L, struct ubus_method *m)
377 struct blobmsg_policy *p;
381 /* get the function pointer */
382 lua_pushinteger(L, 1);
385 /* get the policy table */
386 lua_pushinteger(L, 2);
389 /* check if the method table is valid */
390 if ((lua_type(L, -2) != LUA_TFUNCTION) ||
391 (lua_type(L, -1) != LUA_TTABLE) ||
397 /* store function pointer */
398 lua_pushvalue(L, -2);
399 lua_setfield(L, -6, lua_tostring(L, -5));
401 m->name = lua_tostring(L, -4);
402 m->handler = ubus_method_handler;
404 plen = lua_gettablelen(L, -1);
406 /* exit if policy table is empty */
412 /* setup the policy pointers */
413 p = calloc(plen, sizeof(struct blobmsg_policy));
419 while (lua_next(L, -2) != 0) {
420 int val = lua_tointeger(L, -1);
422 /* check if the policy is valid */
423 if ((lua_type(L, -2) != LUA_TSTRING) ||
424 (lua_type(L, -1) != LUA_TNUMBER) ||
426 (val > BLOBMSG_TYPE_LAST)) {
430 p[pidx].name = lua_tostring(L, -2);
443 ubus_new_sub_cb(struct ubus_context *ctx, struct ubus_object *obj)
445 struct ubus_lua_object *luobj;
447 luobj = container_of(obj, struct ubus_lua_object, o);
449 lua_getglobal(state, "__ubus_cb_publisher");
450 lua_rawgeti(state, -1, luobj->rsubscriber);
451 lua_remove(state, -2);
453 if (lua_isfunction(state, -1)) {
454 lua_pushnumber(state, luobj->o.has_subscribers );
455 lua_call(state, 1, 0);
462 ubus_lua_load_newsub_cb( lua_State *L, struct ubus_lua_object *obj )
464 /* keep ref to func */
465 lua_getglobal(L, "__ubus_cb_publisher");
466 lua_pushvalue(L, -2);
467 obj->rsubscriber = luaL_ref(L, -2);
471 obj->o.subscribe_cb = ubus_new_sub_cb;
475 static struct ubus_object* ubus_lua_load_object(lua_State *L)
477 struct ubus_lua_object *obj = NULL;
478 int mlen = lua_gettablelen(L, -1);
479 struct ubus_method *m;
482 /* setup object pointers */
483 obj = calloc(1, sizeof(struct ubus_lua_object));
487 obj->o.name = lua_tostring(L, -2);
489 /* setup method pointers */
490 m = calloc(mlen, sizeof(struct ubus_method));
493 /* setup type pointers */
494 obj->o.type = calloc(1, sizeof(struct ubus_object_type));
500 obj->o.type->name = lua_tostring(L, -2);
502 obj->o.type->methods = obj->o.methods;
504 /* create the callback lookup table */
505 lua_createtable(L, 1, 0);
506 lua_getglobal(L, "__ubus_cb");
507 lua_pushvalue(L, -2);
508 obj->r = luaL_ref(L, -2);
511 /* scan each method */
513 while (lua_next(L, -3) != 0) {
514 /* check if its the subscriber notification callback */
515 if( lua_type( L, -2 ) == LUA_TSTRING &&
516 lua_type( L, -1 ) == LUA_TFUNCTION ){
517 if( !strcmp( lua_tostring( L, -2 ), "__subscriber_cb" ) )
518 ubus_lua_load_newsub_cb( L, obj );
521 /* check if it looks like a method */
522 if ((lua_type(L, -2) != LUA_TSTRING) ||
523 (lua_type(L, -1) != LUA_TTABLE) ||
524 !lua_objlen(L, -1)) {
529 if (!ubus_lua_load_methods(L, &m[midx]))
534 obj->o.type->n_methods = obj->o.n_methods = midx;
536 /* pop the callback table */
542 static int ubus_lua_add(lua_State *L)
544 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
546 /* verify top level object */
547 if (lua_istable(L, 1)) {
548 lua_pushstring(L, "you need to pass a table");
553 /* scan each object */
555 while (lua_next(L, -2) != 0) {
556 struct ubus_object *obj = NULL;
558 /* check if the object has a table of methods */
559 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TTABLE)) {
560 obj = ubus_lua_load_object(L);
563 ubus_add_object(c->ctx, obj);
565 /* allow future reference of ubus obj */
566 lua_pushstring(state,"__ubusobj");
567 lua_pushlightuserdata(state, obj);
568 lua_settable(state,-3);
578 ubus_lua_notify( lua_State *L )
580 struct ubus_lua_connection *c;
581 struct ubus_object *obj;
584 c = luaL_checkudata(L, 1, METANAME);
585 method = luaL_checkstring(L, 3);
586 luaL_checktype(L, 4, LUA_TTABLE);
588 if( !lua_islightuserdata( L, 2 ) ){
589 lua_pushfstring( L, "Invald 2nd parameter, expected ubus obj ref" );
592 obj = lua_touserdata( L, 2 );
594 /* create parameters from table */
595 blob_buf_init(&c->buf, 0);
596 if( !ubus_lua_format_blob_array( L, &c->buf, true ) ){
597 lua_pushfstring( L, "Invalid 4th parameter, expected table of arguments" );
601 ubus_notify( c->ctx, obj, method, c->buf.head, -1 );
606 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
608 lua_State *L = (lua_State *)p;
613 ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
617 ubus_lua_signatures(lua_State *L)
620 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
621 const char *path = luaL_checkstring(L, 2);
623 rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
625 if (rv != UBUS_STATUS_OK)
629 lua_pushinteger(L, rv);
638 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
640 lua_State *L = (lua_State *)req->priv;
646 ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
650 ubus_lua_call(lua_State *L)
654 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
655 const char *path = luaL_checkstring(L, 2);
656 const char *func = luaL_checkstring(L, 3);
658 luaL_checktype(L, 4, LUA_TTABLE);
659 blob_buf_init(&c->buf, 0);
661 if (!ubus_lua_format_blob_array(L, &c->buf, true))
664 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
668 rv = ubus_lookup_id(c->ctx, path, &id);
673 lua_pushinteger(L, rv);
678 rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
680 if (rv != UBUS_STATUS_OK)
684 lua_pushinteger(L, rv);
688 return lua_gettop(L) - top;
692 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
693 const char *type, struct blob_attr *msg)
695 struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
697 lua_getglobal(state, "__ubus_cb_event");
698 lua_rawgeti(state, -1, listener->r);
699 lua_remove(state, -2);
701 if (lua_isfunction(state, -1)) {
702 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
703 lua_call(state, 1, 0);
709 static struct ubus_event_handler*
710 ubus_lua_load_event(lua_State *L)
712 struct ubus_lua_event* event = NULL;
714 event = calloc(1, sizeof(struct ubus_lua_event));
718 event->e.cb = ubus_event_handler;
720 /* update the he callback lookup table */
721 lua_getglobal(L, "__ubus_cb_event");
722 lua_pushvalue(L, -2);
723 event->r = luaL_ref(L, -2);
724 lua_setfield(L, -1, lua_tostring(L, -3));
730 ubus_lua_listen(lua_State *L) {
731 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
733 /* verify top level object */
734 luaL_checktype(L, 2, LUA_TTABLE);
736 /* scan each object */
738 while (lua_next(L, -2) != 0) {
739 struct ubus_event_handler *listener;
741 /* check if the key is a string and the value is a method */
742 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TFUNCTION)) {
743 listener = ubus_lua_load_event(L);
744 if(listener != NULL) {
745 ubus_register_event_handler(c->ctx, listener, lua_tostring(L, -2));
754 ubus_sub_remove_handler(struct ubus_context *ctx, struct ubus_subscriber *s,
757 struct ubus_lua_subscriber *sub;
759 sub = container_of(s, struct ubus_lua_subscriber, s);
761 lua_getglobal(state, "__ubus_cb_subscribe");
762 lua_rawgeti(state, -1, sub->rremove);
763 lua_remove(state, -2);
765 if (lua_isfunction(state, -1)) {
766 lua_call(state, 0, 0);
773 ubus_sub_notify_handler(struct ubus_context *ctx, struct ubus_object *obj,
774 struct ubus_request_data *req, const char *method,
775 struct blob_attr *msg)
777 struct ubus_subscriber *s;
778 struct ubus_lua_subscriber *sub;
780 s = container_of(obj, struct ubus_subscriber, obj);
781 sub = container_of(s, struct ubus_lua_subscriber, s);
783 lua_getglobal(state, "__ubus_cb_subscribe");
784 lua_rawgeti(state, -1, sub->rnotify);
785 lua_remove(state, -2);
787 if (lua_isfunction(state, -1)) {
789 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
790 lua_call(state, 1, 0);
792 lua_call(state, 0, 0);
804 ubus_lua_do_subscribe( struct ubus_context *ctx, lua_State *L, const char* target,
805 int idxnotify, int idxremove )
809 struct ubus_lua_subscriber *sub;
811 if( ( status = ubus_lookup_id( ctx, target, &id ) ) ){
812 lua_pushfstring( L, "Unable find target, status=%d", status );
816 sub = calloc( 1, sizeof( struct ubus_lua_subscriber ) );
818 lua_pushstring( L, "Out of memory" );
823 lua_getglobal(L, "__ubus_cb_subscribe");
824 lua_pushvalue(L, idxnotify);
825 sub->rnotify = luaL_ref(L, -2);
827 sub->s.cb = ubus_sub_notify_handler;
831 lua_getglobal(L, "__ubus_cb_subscribe");
832 lua_pushvalue(L, idxnotify);
833 sub->rnotify = luaL_ref(L, -2);
835 sub->s.remove_cb = ubus_sub_remove_handler;
838 if( ( status = ubus_register_subscriber( ctx, &sub->s ) ) ){
839 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
843 if( ( status = ubus_subscribe( ctx, &sub->s, id) ) ){
844 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
850 ubus_lua_subscribe(lua_State *L) {
851 int idxnotify, idxremove, stackstart;
852 struct ubus_lua_connection *c;
855 idxnotify = idxremove = 0;
856 stackstart = lua_gettop( L );
859 c = luaL_checkudata(L, 1, METANAME);
860 target = luaL_checkstring(L, 2);
861 luaL_checktype(L, 3, LUA_TTABLE);
864 lua_pushstring( L, "notify");
865 lua_gettable( L, 3 );
866 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
867 idxnotify = lua_gettop( L );
872 lua_pushstring( L, "remove");
873 lua_gettable( L, 3 );
874 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
875 idxremove = lua_gettop( L );
881 ubus_lua_do_subscribe( c->ctx, L, target, idxnotify, idxremove );
883 if( lua_gettop( L ) > stackstart )
884 lua_pop( L, lua_gettop( L ) - stackstart );
890 ubus_lua_send(lua_State *L)
892 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
893 const char *event = luaL_checkstring(L, 2);
896 return luaL_argerror(L, 2, "no event name");
898 // Event content convert to ubus form
899 luaL_checktype(L, 3, LUA_TTABLE);
900 blob_buf_init(&c->buf, 0);
902 if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
904 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
909 ubus_send_event(c->ctx, event, c->buf.head);
917 ubus_lua__gc(lua_State *L)
919 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
921 blob_buf_free(&c->buf);
925 memset(c, 0, sizeof(*c));
931 static const luaL_Reg ubus[] = {
932 { "connect", ubus_lua_connect },
933 { "objects", ubus_lua_objects },
934 { "add", ubus_lua_add },
935 { "notify", ubus_lua_notify },
936 { "reply", ubus_lua_reply },
937 { "defer_request", ubus_lua_defer_request },
938 { "complete_deferred_request", ubus_lua_complete_deferred_request },
939 { "signatures", ubus_lua_signatures },
940 { "call", ubus_lua_call },
941 { "close", ubus_lua__gc },
942 { "listen", ubus_lua_listen },
943 { "send", ubus_lua_send },
944 { "subscribe", ubus_lua_subscribe },
945 { "__gc", ubus_lua__gc },
949 /* avoid missing prototype warning */
950 int luaopen_ubus(lua_State *L);
953 luaopen_ubus(lua_State *L)
955 /* create metatable */
956 luaL_newmetatable(L, METANAME);
958 /* metatable.__index = metatable */
959 lua_pushvalue(L, -1);
960 lua_setfield(L, -2, "__index");
963 luaL_register(L, NULL, ubus);
967 luaL_register(L, MODNAME, ubus);
969 /* set some enum defines */
970 lua_pushinteger(L, BLOBMSG_TYPE_ARRAY);
971 lua_setfield(L, -2, "ARRAY");
972 lua_pushinteger(L, BLOBMSG_TYPE_TABLE);
973 lua_setfield(L, -2, "TABLE");
974 lua_pushinteger(L, BLOBMSG_TYPE_STRING);
975 lua_setfield(L, -2, "STRING");
976 lua_pushinteger(L, BLOBMSG_TYPE_INT64);
977 lua_setfield(L, -2, "INT64");
978 lua_pushinteger(L, BLOBMSG_TYPE_INT32);
979 lua_setfield(L, -2, "INT32");
980 lua_pushinteger(L, BLOBMSG_TYPE_INT16);
981 lua_setfield(L, -2, "INT16");
982 lua_pushinteger(L, BLOBMSG_TYPE_INT8);
983 lua_setfield(L, -2, "INT8");
984 lua_pushinteger(L, BLOBMSG_TYPE_BOOL);
985 lua_setfield(L, -2, "BOOLEAN");
987 /* used in our callbacks */
990 /* create the callback table */
991 lua_createtable(L, 1, 0);
992 lua_setglobal(L, "__ubus_cb");
994 /* create the event table */
995 lua_createtable(L, 1, 0);
996 lua_setglobal(L, "__ubus_cb_event");
998 /* create the subscriber table */
999 lua_createtable(L, 1, 0);
1000 lua_setglobal(L, "__ubus_cb_subscribe");
1002 /* create the publisher table - notifications of new subs */
1003 lua_createtable(L, 1, 0);
1004 lua_setglobal(L, "__ubus_cb_publisher");