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, size_t 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_DOUBLE:
120 v.u64 = be64_to_cpu(*(uint64_t *)data);
121 lua_pushnumber(L, v.d);
125 case BLOBMSG_TYPE_STRING:
126 lua_pushstring(L, data);
129 case BLOBMSG_TYPE_ARRAY:
130 ubus_lua_parse_blob_array(L, data, len, false);
133 case BLOBMSG_TYPE_TABLE:
134 ubus_lua_parse_blob_array(L, data, len, true);
147 ubus_lua_format_blob_is_array(lua_State *L)
152 /* Find out whether table is array-like */
153 for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1))
156 if (lua_type(L, -2) != LUA_TNUMBER && lua_type(L, -2) != LUA_TINT)
158 if (lua_type(L, -2) != LUA_TNUMBER)
165 cur = lua_tointeger(L, -2);
167 if ((cur - 1) != prv)
180 ubus_lua_format_blob_array(lua_State *L, struct blob_buf *b, bool table);
183 ubus_lua_format_blob(lua_State *L, struct blob_buf *b, bool table)
187 const char *key = table ? lua_tostring(L, -2) : NULL;
189 switch (lua_type(L, -1))
192 blobmsg_add_u8(b, key, (uint8_t)lua_toboolean(L, -1));
199 if ((uint64_t)lua_tonumber(L, -1) > INT_MAX)
200 blobmsg_add_u64(b, key, (uint64_t)lua_tonumber(L, -1));
202 blobmsg_add_u32(b, key, (uint32_t)lua_tointeger(L, -1));
207 case LUA_TLIGHTUSERDATA:
208 blobmsg_add_string(b, key, lua_tostring(L, -1));
212 if (ubus_lua_format_blob_is_array(L))
214 c = blobmsg_open_array(b, key);
215 rv = ubus_lua_format_blob_array(L, b, false);
216 blobmsg_close_array(b, c);
220 c = blobmsg_open_table(b, key);
221 rv = ubus_lua_format_blob_array(L, b, true);
222 blobmsg_close_table(b, c);
235 ubus_lua_format_blob_array(lua_State *L, struct blob_buf *b, bool table)
237 for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1))
239 if (!ubus_lua_format_blob(L, b, table))
251 ubus_lua_connect(lua_State *L)
253 struct ubus_lua_connection *c;
254 const char *sockpath = luaL_optstring(L, 1, NULL);
255 int timeout = luaL_optint(L, 2, 30);
257 if ((c = lua_newuserdata(L, sizeof(*c))) != NULL &&
258 (c->ctx = ubus_connect(sockpath)) != NULL)
260 ubus_add_uloop(c->ctx);
261 c->timeout = timeout;
262 memset(&c->buf, 0, sizeof(c->buf));
263 luaL_getmetatable(L, METANAME);
264 lua_setmetatable(L, -2);
268 /* NB: no errors from ubus_connect() yet */
270 lua_pushinteger(L, UBUS_STATUS_UNKNOWN_ERROR);
276 ubus_lua_objects_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
278 lua_State *L = (lua_State *)p;
280 lua_pushstring(L, o->path);
281 lua_rawseti(L, -2, lua_objlen(L, -2) + 1);
285 ubus_lua_objects(lua_State *L)
288 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
291 rv = ubus_lookup(c->ctx, NULL, ubus_lua_objects_cb, L);
293 if (rv != UBUS_STATUS_OK)
297 lua_pushinteger(L, rv);
305 ubus_method_handler(struct ubus_context *ctx, struct ubus_object *obj,
306 struct ubus_request_data *req, const char *method,
307 struct blob_attr *msg)
309 struct ubus_lua_object *o = container_of(obj, struct ubus_lua_object, o);
312 lua_getglobal(state, "__ubus_cb");
313 lua_rawgeti(state, -1, o->r);
314 lua_getfield(state, -1, method);
315 lua_remove(state, -2);
316 lua_remove(state, -2);
318 if (lua_isfunction(state, -1)) {
319 lua_pushlightuserdata(state, req);
323 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
324 lua_call(state, 2, 1);
325 if (lua_isnumber(state, -1))
326 rv = lua_tonumber(state, -1);
334 static int lua_gettablelen(lua_State *L, int index)
340 while (lua_next(L, index) != 0) {
348 static int ubus_lua_reply(lua_State *L)
350 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
351 struct ubus_request_data *req;
353 luaL_checktype(L, 3, LUA_TTABLE);
354 blob_buf_init(&c->buf, 0);
356 if (!ubus_lua_format_blob_array(L, &c->buf, true))
359 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
363 req = lua_touserdata(L, 2);
364 ubus_send_reply(c->ctx, req, c->buf.head);
369 static int ubus_lua_defer_request(lua_State *L)
371 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
372 struct ubus_request_data *req = lua_touserdata(L, 2);
373 struct ubus_request_data *new_req = lua_newuserdata(L, sizeof(struct ubus_request_data));
374 ubus_defer_request(c->ctx, req, new_req);
379 static int ubus_lua_complete_deferred_request(lua_State *L)
381 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
382 struct ubus_request_data *req = lua_touserdata(L, 2);
383 int ret = luaL_checkinteger(L, 3);
384 ubus_complete_deferred_request(c->ctx, req, ret);
389 static int ubus_lua_load_methods(lua_State *L, struct ubus_method *m)
391 struct blobmsg_policy *p;
395 /* get the function pointer */
396 lua_pushinteger(L, 1);
399 /* get the policy table */
400 lua_pushinteger(L, 2);
403 /* check if the method table is valid */
404 if ((lua_type(L, -2) != LUA_TFUNCTION) ||
405 (lua_type(L, -1) != LUA_TTABLE) ||
411 /* store function pointer */
412 lua_pushvalue(L, -2);
413 lua_setfield(L, -6, lua_tostring(L, -5));
415 m->name = lua_tostring(L, -4);
416 m->handler = ubus_method_handler;
418 plen = lua_gettablelen(L, -1);
420 /* exit if policy table is empty */
426 /* setup the policy pointers */
427 p = calloc(plen, sizeof(struct blobmsg_policy));
433 while (lua_next(L, -2) != 0) {
434 int val = lua_tointeger(L, -1);
436 /* check if the policy is valid */
437 if ((lua_type(L, -2) != LUA_TSTRING) ||
438 (lua_type(L, -1) != LUA_TNUMBER) ||
440 (val > BLOBMSG_TYPE_LAST)) {
444 p[pidx].name = lua_tostring(L, -2);
457 ubus_new_sub_cb(struct ubus_context *ctx, struct ubus_object *obj)
459 struct ubus_lua_object *luobj;
461 luobj = container_of(obj, struct ubus_lua_object, o);
463 lua_getglobal(state, "__ubus_cb_publisher");
464 lua_rawgeti(state, -1, luobj->rsubscriber);
465 lua_remove(state, -2);
467 if (lua_isfunction(state, -1)) {
468 lua_pushnumber(state, luobj->o.has_subscribers );
469 lua_call(state, 1, 0);
476 ubus_lua_load_newsub_cb( lua_State *L, struct ubus_lua_object *obj )
478 /* keep ref to func */
479 lua_getglobal(L, "__ubus_cb_publisher");
480 lua_pushvalue(L, -2);
481 obj->rsubscriber = luaL_ref(L, -2);
485 obj->o.subscribe_cb = ubus_new_sub_cb;
489 static struct ubus_object* ubus_lua_load_object(lua_State *L)
491 struct ubus_lua_object *obj = NULL;
492 int mlen = lua_gettablelen(L, -1);
493 struct ubus_method *m;
496 /* setup object pointers */
497 obj = calloc(1, sizeof(struct ubus_lua_object));
501 obj->o.name = lua_tostring(L, -2);
503 /* setup method pointers */
504 m = calloc(mlen, sizeof(struct ubus_method));
507 /* setup type pointers */
508 obj->o.type = calloc(1, sizeof(struct ubus_object_type));
514 obj->o.type->name = lua_tostring(L, -2);
516 obj->o.type->methods = obj->o.methods;
518 /* create the callback lookup table */
519 lua_createtable(L, 1, 0);
520 lua_getglobal(L, "__ubus_cb");
521 lua_pushvalue(L, -2);
522 obj->r = luaL_ref(L, -2);
525 /* scan each method */
527 while (lua_next(L, -3) != 0) {
528 /* check if its the subscriber notification callback */
529 if( lua_type( L, -2 ) == LUA_TSTRING &&
530 lua_type( L, -1 ) == LUA_TFUNCTION ){
531 if( !strcmp( lua_tostring( L, -2 ), "__subscriber_cb" ) )
532 ubus_lua_load_newsub_cb( L, obj );
535 /* check if it looks like a method */
536 if ((lua_type(L, -2) != LUA_TSTRING) ||
537 (lua_type(L, -1) != LUA_TTABLE) ||
538 !lua_objlen(L, -1)) {
543 if (!ubus_lua_load_methods(L, &m[midx]))
548 obj->o.type->n_methods = obj->o.n_methods = midx;
550 /* pop the callback table */
556 static int ubus_lua_add(lua_State *L)
558 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
560 /* verify top level object */
561 if (lua_istable(L, 1)) {
562 lua_pushstring(L, "you need to pass a table");
566 /* scan each object */
568 while (lua_next(L, -2) != 0) {
569 struct ubus_object *obj = NULL;
571 /* check if the object has a table of methods */
572 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TTABLE)) {
573 obj = ubus_lua_load_object(L);
576 ubus_add_object(c->ctx, obj);
578 /* allow future reference of ubus obj */
579 lua_pushstring(state,"__ubusobj");
580 lua_pushlightuserdata(state, obj);
581 lua_settable(state,-3);
591 ubus_lua_notify( lua_State *L )
593 struct ubus_lua_connection *c;
594 struct ubus_object *obj;
597 c = luaL_checkudata(L, 1, METANAME);
598 method = luaL_checkstring(L, 3);
599 luaL_checktype(L, 4, LUA_TTABLE);
601 if( !lua_islightuserdata( L, 2 ) ){
602 lua_pushfstring( L, "Invald 2nd parameter, expected ubus obj ref" );
603 return lua_error( L );
605 obj = lua_touserdata( L, 2 );
607 /* create parameters from table */
608 blob_buf_init(&c->buf, 0);
609 if( !ubus_lua_format_blob_array( L, &c->buf, true ) ){
610 lua_pushfstring( L, "Invalid 4th parameter, expected table of arguments" );
611 return lua_error( L );
614 ubus_notify( c->ctx, obj, method, c->buf.head, -1 );
619 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
621 lua_State *L = (lua_State *)p;
626 ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
630 ubus_lua_signatures(lua_State *L)
633 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
634 const char *path = luaL_checkstring(L, 2);
636 rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
638 if (rv != UBUS_STATUS_OK)
642 lua_pushinteger(L, rv);
651 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
653 lua_State *L = (lua_State *)req->priv;
659 ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
663 ubus_lua_call(lua_State *L)
667 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
668 const char *path = luaL_checkstring(L, 2);
669 const char *func = luaL_checkstring(L, 3);
671 luaL_checktype(L, 4, LUA_TTABLE);
672 blob_buf_init(&c->buf, 0);
674 if (!ubus_lua_format_blob_array(L, &c->buf, true))
677 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
681 rv = ubus_lookup_id(c->ctx, path, &id);
686 lua_pushinteger(L, rv);
691 rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
693 if (rv != UBUS_STATUS_OK)
697 lua_pushinteger(L, rv);
701 return lua_gettop(L) - top;
705 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
706 const char *type, struct blob_attr *msg)
708 struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
710 lua_getglobal(state, "__ubus_cb_event");
711 lua_rawgeti(state, -1, listener->r);
712 lua_remove(state, -2);
714 if (lua_isfunction(state, -1)) {
715 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
716 lua_call(state, 1, 0);
722 static struct ubus_event_handler*
723 ubus_lua_load_event(lua_State *L)
725 struct ubus_lua_event* event = NULL;
727 event = calloc(1, sizeof(struct ubus_lua_event));
731 event->e.cb = ubus_event_handler;
733 /* update the he callback lookup table */
734 lua_getglobal(L, "__ubus_cb_event");
735 lua_pushvalue(L, -2);
736 event->r = luaL_ref(L, -2);
737 lua_setfield(L, -1, lua_tostring(L, -3));
743 ubus_lua_listen(lua_State *L) {
744 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
746 /* verify top level object */
747 luaL_checktype(L, 2, LUA_TTABLE);
749 /* scan each object */
751 while (lua_next(L, -2) != 0) {
752 struct ubus_event_handler *listener;
754 /* check if the key is a string and the value is a method */
755 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TFUNCTION)) {
756 listener = ubus_lua_load_event(L);
757 if(listener != NULL) {
758 ubus_register_event_handler(c->ctx, listener, lua_tostring(L, -2));
767 ubus_sub_remove_handler(struct ubus_context *ctx, struct ubus_subscriber *s,
770 struct ubus_lua_subscriber *sub;
772 sub = container_of(s, struct ubus_lua_subscriber, s);
774 lua_getglobal(state, "__ubus_cb_subscribe");
775 lua_rawgeti(state, -1, sub->rremove);
776 lua_remove(state, -2);
778 if (lua_isfunction(state, -1)) {
779 lua_call(state, 0, 0);
786 ubus_sub_notify_handler(struct ubus_context *ctx, struct ubus_object *obj,
787 struct ubus_request_data *req, const char *method,
788 struct blob_attr *msg)
790 struct ubus_subscriber *s;
791 struct ubus_lua_subscriber *sub;
793 s = container_of(obj, struct ubus_subscriber, obj);
794 sub = container_of(s, struct ubus_lua_subscriber, s);
796 lua_getglobal(state, "__ubus_cb_subscribe");
797 lua_rawgeti(state, -1, sub->rnotify);
798 lua_remove(state, -2);
800 if (lua_isfunction(state, -1)) {
802 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
806 lua_pushstring(state, method);
807 lua_call(state, 2, 0);
818 ubus_lua_do_subscribe( struct ubus_context *ctx, lua_State *L, const char* target,
819 int idxnotify, int idxremove )
823 struct ubus_lua_subscriber *sub;
825 if( ( status = ubus_lookup_id( ctx, target, &id ) ) ){
826 lua_pushfstring( L, "Unable find target, status=%d", status );
827 return lua_error( L );
830 sub = calloc( 1, sizeof( struct ubus_lua_subscriber ) );
832 lua_pushstring( L, "Out of memory" );
833 return lua_error( L );
837 lua_getglobal(L, "__ubus_cb_subscribe");
838 lua_pushvalue(L, idxnotify);
839 sub->rnotify = luaL_ref(L, -2);
841 sub->s.cb = ubus_sub_notify_handler;
845 lua_getglobal(L, "__ubus_cb_subscribe");
846 lua_pushvalue(L, idxremove);
847 sub->rremove = luaL_ref(L, -2);
849 sub->s.remove_cb = ubus_sub_remove_handler;
852 if( ( status = ubus_register_subscriber( ctx, &sub->s ) ) ){
853 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
854 return lua_error( L );
857 if( ( status = ubus_subscribe( ctx, &sub->s, id) ) ){
858 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
859 return lua_error( L );
866 ubus_lua_subscribe(lua_State *L) {
867 int idxnotify, idxremove, stackstart;
868 struct ubus_lua_connection *c;
871 idxnotify = idxremove = 0;
872 stackstart = lua_gettop( L );
875 c = luaL_checkudata(L, 1, METANAME);
876 target = luaL_checkstring(L, 2);
877 luaL_checktype(L, 3, LUA_TTABLE);
880 lua_pushstring( L, "notify");
881 lua_gettable( L, 3 );
882 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
883 idxnotify = lua_gettop( L );
888 lua_pushstring( L, "remove");
889 lua_gettable( L, 3 );
890 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
891 idxremove = lua_gettop( L );
897 ubus_lua_do_subscribe( c->ctx, L, target, idxnotify, idxremove );
899 if( lua_gettop( L ) > stackstart )
900 lua_pop( L, lua_gettop( L ) - stackstart );
906 ubus_lua_send(lua_State *L)
908 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
909 const char *event = luaL_checkstring(L, 2);
912 return luaL_argerror(L, 2, "no event name");
914 // Event content convert to ubus form
915 luaL_checktype(L, 3, LUA_TTABLE);
916 blob_buf_init(&c->buf, 0);
918 if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
920 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
925 ubus_send_event(c->ctx, event, c->buf.head);
933 ubus_lua__gc(lua_State *L)
935 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
937 blob_buf_free(&c->buf);
941 memset(c, 0, sizeof(*c));
947 static const luaL_Reg ubus[] = {
948 { "connect", ubus_lua_connect },
949 { "objects", ubus_lua_objects },
950 { "add", ubus_lua_add },
951 { "notify", ubus_lua_notify },
952 { "reply", ubus_lua_reply },
953 { "defer_request", ubus_lua_defer_request },
954 { "complete_deferred_request", ubus_lua_complete_deferred_request },
955 { "signatures", ubus_lua_signatures },
956 { "call", ubus_lua_call },
957 { "close", ubus_lua__gc },
958 { "listen", ubus_lua_listen },
959 { "send", ubus_lua_send },
960 { "subscribe", ubus_lua_subscribe },
961 { "__gc", ubus_lua__gc },
965 /* avoid missing prototype warning */
966 int luaopen_ubus(lua_State *L);
969 luaopen_ubus(lua_State *L)
971 /* create metatable */
972 luaL_newmetatable(L, METANAME);
974 /* metatable.__index = metatable */
975 lua_pushvalue(L, -1);
976 lua_setfield(L, -2, "__index");
979 luaL_register(L, NULL, ubus);
983 luaL_register(L, MODNAME, ubus);
985 /* set some enum defines */
986 lua_pushinteger(L, BLOBMSG_TYPE_ARRAY);
987 lua_setfield(L, -2, "ARRAY");
988 lua_pushinteger(L, BLOBMSG_TYPE_TABLE);
989 lua_setfield(L, -2, "TABLE");
990 lua_pushinteger(L, BLOBMSG_TYPE_STRING);
991 lua_setfield(L, -2, "STRING");
992 lua_pushinteger(L, BLOBMSG_TYPE_INT64);
993 lua_setfield(L, -2, "INT64");
994 lua_pushinteger(L, BLOBMSG_TYPE_INT32);
995 lua_setfield(L, -2, "INT32");
996 lua_pushinteger(L, BLOBMSG_TYPE_INT16);
997 lua_setfield(L, -2, "INT16");
998 lua_pushinteger(L, BLOBMSG_TYPE_INT8);
999 lua_setfield(L, -2, "INT8");
1000 lua_pushinteger(L, BLOBMSG_TYPE_DOUBLE);
1001 lua_setfield(L, -2, "DOUBLE");
1002 lua_pushinteger(L, BLOBMSG_TYPE_BOOL);
1003 lua_setfield(L, -2, "BOOLEAN");
1005 /* used in our callbacks */
1008 /* create the callback table */
1009 lua_createtable(L, 1, 0);
1010 lua_setglobal(L, "__ubus_cb");
1012 /* create the event table */
1013 lua_createtable(L, 1, 0);
1014 lua_setglobal(L, "__ubus_cb_event");
1016 /* create the subscriber table */
1017 lua_createtable(L, 1, 0);
1018 lua_setglobal(L, "__ubus_cb_subscribe");
1020 /* create the publisher table - notifications of new subs */
1021 lua_createtable(L, 1, 0);
1022 lua_setglobal(L, "__ubus_cb_publisher");