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 = malloc(sizeof(struct blobmsg_policy) * plen);
417 memset(p, 0, sizeof(struct blobmsg_policy) * plen);
420 while (lua_next(L, -2) != 0) {
421 int val = lua_tointeger(L, -1);
423 /* check if the policy is valid */
424 if ((lua_type(L, -2) != LUA_TSTRING) ||
425 (lua_type(L, -1) != LUA_TNUMBER) ||
427 (val > BLOBMSG_TYPE_LAST)) {
431 p[pidx].name = lua_tostring(L, -2);
444 ubus_new_sub_cb(struct ubus_context *ctx, struct ubus_object *obj)
446 struct ubus_lua_object *luobj;
448 luobj = container_of(obj, struct ubus_lua_object, o);
450 lua_getglobal(state, "__ubus_cb_publisher");
451 lua_rawgeti(state, -1, luobj->rsubscriber);
452 lua_remove(state, -2);
454 if (lua_isfunction(state, -1)) {
455 lua_pushnumber(state, luobj->o.has_subscribers );
456 lua_call(state, 1, 0);
463 ubus_lua_load_newsub_cb( lua_State *L, struct ubus_lua_object *obj )
465 /* keep ref to func */
466 lua_getglobal(L, "__ubus_cb_publisher");
467 lua_pushvalue(L, -2);
468 obj->rsubscriber = luaL_ref(L, -2);
472 obj->o.subscribe_cb = ubus_new_sub_cb;
476 static struct ubus_object* ubus_lua_load_object(lua_State *L)
478 struct ubus_lua_object *obj = NULL;
479 int mlen = lua_gettablelen(L, -1);
480 struct ubus_method *m;
483 /* setup object pointers */
484 obj = malloc(sizeof(struct ubus_lua_object));
488 memset(obj, 0, sizeof(struct ubus_lua_object));
489 obj->o.name = lua_tostring(L, -2);
491 /* setup method pointers */
492 m = malloc(sizeof(struct ubus_method) * mlen);
493 memset(m, 0, sizeof(struct ubus_method) * mlen);
496 /* setup type pointers */
497 obj->o.type = malloc(sizeof(struct ubus_object_type));
503 memset(obj->o.type, 0, sizeof(struct ubus_object_type));
504 obj->o.type->name = lua_tostring(L, -2);
506 obj->o.type->methods = obj->o.methods;
508 /* create the callback lookup table */
509 lua_createtable(L, 1, 0);
510 lua_getglobal(L, "__ubus_cb");
511 lua_pushvalue(L, -2);
512 obj->r = luaL_ref(L, -2);
515 /* scan each method */
517 while (lua_next(L, -3) != 0) {
518 /* check if its the subscriber notification callback */
519 if( lua_type( L, -2 ) == LUA_TSTRING &&
520 lua_type( L, -1 ) == LUA_TFUNCTION ){
521 if( !strcmp( lua_tostring( L, -2 ), "__subscriber_cb" ) )
522 ubus_lua_load_newsub_cb( L, obj );
525 /* check if it looks like a method */
526 if ((lua_type(L, -2) != LUA_TSTRING) ||
527 (lua_type(L, -1) != LUA_TTABLE) ||
528 !lua_objlen(L, -1)) {
533 if (!ubus_lua_load_methods(L, &m[midx]))
538 obj->o.type->n_methods = obj->o.n_methods = midx;
540 /* pop the callback table */
546 static int ubus_lua_add(lua_State *L)
548 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
550 /* verify top level object */
551 if (lua_istable(L, 1)) {
552 lua_pushstring(L, "you need to pass a table");
557 /* scan each object */
559 while (lua_next(L, -2) != 0) {
560 struct ubus_object *obj = NULL;
562 /* check if the object has a table of methods */
563 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TTABLE)) {
564 obj = ubus_lua_load_object(L);
567 ubus_add_object(c->ctx, obj);
569 /* allow future reference of ubus obj */
570 lua_pushstring(state,"__ubusobj");
571 lua_pushlightuserdata(state, obj);
572 lua_settable(state,-3);
582 ubus_lua_notify( lua_State *L )
584 struct ubus_lua_connection *c;
585 struct ubus_object *obj;
588 c = luaL_checkudata(L, 1, METANAME);
589 method = luaL_checkstring(L, 3);
590 luaL_checktype(L, 4, LUA_TTABLE);
592 if( !lua_islightuserdata( L, 2 ) ){
593 lua_pushfstring( L, "Invald 2nd parameter, expected ubus obj ref" );
596 obj = lua_touserdata( L, 2 );
598 /* create parameters from table */
599 blob_buf_init(&c->buf, 0);
600 if( !ubus_lua_format_blob_array( L, &c->buf, true ) ){
601 lua_pushfstring( L, "Invalid 4th parameter, expected table of arguments" );
605 ubus_notify( c->ctx, obj, method, c->buf.head, -1 );
610 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
612 lua_State *L = (lua_State *)p;
617 ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
621 ubus_lua_signatures(lua_State *L)
624 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
625 const char *path = luaL_checkstring(L, 2);
627 rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
629 if (rv != UBUS_STATUS_OK)
633 lua_pushinteger(L, rv);
642 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
644 lua_State *L = (lua_State *)req->priv;
650 ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
654 ubus_lua_call(lua_State *L)
658 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
659 const char *path = luaL_checkstring(L, 2);
660 const char *func = luaL_checkstring(L, 3);
662 luaL_checktype(L, 4, LUA_TTABLE);
663 blob_buf_init(&c->buf, 0);
665 if (!ubus_lua_format_blob_array(L, &c->buf, true))
668 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
672 rv = ubus_lookup_id(c->ctx, path, &id);
677 lua_pushinteger(L, rv);
682 rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
684 if (rv != UBUS_STATUS_OK)
688 lua_pushinteger(L, rv);
692 return lua_gettop(L) - top;
696 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
697 const char *type, struct blob_attr *msg)
699 struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
701 lua_getglobal(state, "__ubus_cb_event");
702 lua_rawgeti(state, -1, listener->r);
703 lua_remove(state, -2);
705 if (lua_isfunction(state, -1)) {
706 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
707 lua_call(state, 1, 0);
713 static struct ubus_event_handler*
714 ubus_lua_load_event(lua_State *L)
716 struct ubus_lua_event* event = NULL;
718 event = malloc(sizeof(struct ubus_lua_event));
722 memset(event, 0, sizeof(struct ubus_lua_event));
723 event->e.cb = ubus_event_handler;
725 /* update the he callback lookup table */
726 lua_getglobal(L, "__ubus_cb_event");
727 lua_pushvalue(L, -2);
728 event->r = luaL_ref(L, -2);
729 lua_setfield(L, -1, lua_tostring(L, -3));
735 ubus_lua_listen(lua_State *L) {
736 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
738 /* verify top level object */
739 luaL_checktype(L, 2, LUA_TTABLE);
741 /* scan each object */
743 while (lua_next(L, -2) != 0) {
744 struct ubus_event_handler *listener;
746 /* check if the key is a string and the value is a method */
747 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TFUNCTION)) {
748 listener = ubus_lua_load_event(L);
749 if(listener != NULL) {
750 ubus_register_event_handler(c->ctx, listener, lua_tostring(L, -2));
759 ubus_sub_remove_handler(struct ubus_context *ctx, struct ubus_subscriber *s,
762 struct ubus_lua_subscriber *sub;
764 sub = container_of(s, struct ubus_lua_subscriber, s);
766 lua_getglobal(state, "__ubus_cb_subscribe");
767 lua_rawgeti(state, -1, sub->rremove);
768 lua_remove(state, -2);
770 if (lua_isfunction(state, -1)) {
771 lua_call(state, 0, 0);
778 ubus_sub_notify_handler(struct ubus_context *ctx, struct ubus_object *obj,
779 struct ubus_request_data *req, const char *method,
780 struct blob_attr *msg)
782 struct ubus_subscriber *s;
783 struct ubus_lua_subscriber *sub;
785 s = container_of(obj, struct ubus_subscriber, obj);
786 sub = container_of(s, struct ubus_lua_subscriber, s);
788 lua_getglobal(state, "__ubus_cb_subscribe");
789 lua_rawgeti(state, -1, sub->rnotify);
790 lua_remove(state, -2);
792 if (lua_isfunction(state, -1)) {
794 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
795 lua_call(state, 1, 0);
797 lua_call(state, 0, 0);
809 ubus_lua_do_subscribe( struct ubus_context *ctx, lua_State *L, const char* target,
810 int idxnotify, int idxremove )
814 struct ubus_lua_subscriber *sub;
816 if( ( status = ubus_lookup_id( ctx, target, &id ) ) ){
817 lua_pushfstring( L, "Unable find target, status=%d", status );
821 sub = malloc( sizeof( struct ubus_lua_subscriber ) );
822 memset( sub, 0, sizeof( struct ubus_lua_subscriber ) );
824 lua_pushstring( L, "Out of memory" );
829 lua_getglobal(L, "__ubus_cb_subscribe");
830 lua_pushvalue(L, idxnotify);
831 sub->rnotify = luaL_ref(L, -2);
833 sub->s.cb = ubus_sub_notify_handler;
837 lua_getglobal(L, "__ubus_cb_subscribe");
838 lua_pushvalue(L, idxnotify);
839 sub->rnotify = luaL_ref(L, -2);
841 sub->s.remove_cb = ubus_sub_remove_handler;
844 if( ( status = ubus_register_subscriber( ctx, &sub->s ) ) ){
845 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
849 if( ( status = ubus_subscribe( ctx, &sub->s, id) ) ){
850 lua_pushfstring( L, "Failed to register subscriber, status=%d", status );
856 ubus_lua_subscribe(lua_State *L) {
857 int idxnotify, idxremove, stackstart;
858 struct ubus_lua_connection *c;
861 idxnotify = idxremove = 0;
862 stackstart = lua_gettop( L );
865 c = luaL_checkudata(L, 1, METANAME);
866 target = luaL_checkstring(L, 2);
867 luaL_checktype(L, 3, LUA_TTABLE);
870 lua_pushstring( L, "notify");
871 lua_gettable( L, 3 );
872 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
873 idxnotify = lua_gettop( L );
878 lua_pushstring( L, "remove");
879 lua_gettable( L, 3 );
880 if( lua_type( L, -1 ) == LUA_TFUNCTION ){
881 idxremove = lua_gettop( L );
887 ubus_lua_do_subscribe( c->ctx, L, target, idxnotify, idxremove );
889 if( lua_gettop( L ) > stackstart )
890 lua_pop( L, lua_gettop( L ) - stackstart );
896 ubus_lua_send(lua_State *L)
898 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
899 const char *event = luaL_checkstring(L, 2);
902 return luaL_argerror(L, 2, "no event name");
904 // Event content convert to ubus form
905 luaL_checktype(L, 3, LUA_TTABLE);
906 blob_buf_init(&c->buf, 0);
908 if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
910 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
915 ubus_send_event(c->ctx, event, c->buf.head);
923 ubus_lua__gc(lua_State *L)
925 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
927 blob_buf_free(&c->buf);
931 memset(c, 0, sizeof(*c));
937 static const luaL_Reg ubus[] = {
938 { "connect", ubus_lua_connect },
939 { "objects", ubus_lua_objects },
940 { "add", ubus_lua_add },
941 { "notify", ubus_lua_notify },
942 { "reply", ubus_lua_reply },
943 { "defer_request", ubus_lua_defer_request },
944 { "complete_deferred_request", ubus_lua_complete_deferred_request },
945 { "signatures", ubus_lua_signatures },
946 { "call", ubus_lua_call },
947 { "close", ubus_lua__gc },
948 { "listen", ubus_lua_listen },
949 { "send", ubus_lua_send },
950 { "subscribe", ubus_lua_subscribe },
951 { "__gc", ubus_lua__gc },
955 /* avoid missing prototype warning */
956 int luaopen_ubus(lua_State *L);
959 luaopen_ubus(lua_State *L)
961 /* create metatable */
962 luaL_newmetatable(L, METANAME);
964 /* metatable.__index = metatable */
965 lua_pushvalue(L, -1);
966 lua_setfield(L, -2, "__index");
969 luaL_register(L, NULL, ubus);
973 luaL_register(L, MODNAME, ubus);
975 /* set some enum defines */
976 lua_pushinteger(L, BLOBMSG_TYPE_ARRAY);
977 lua_setfield(L, -2, "ARRAY");
978 lua_pushinteger(L, BLOBMSG_TYPE_TABLE);
979 lua_setfield(L, -2, "TABLE");
980 lua_pushinteger(L, BLOBMSG_TYPE_STRING);
981 lua_setfield(L, -2, "STRING");
982 lua_pushinteger(L, BLOBMSG_TYPE_INT64);
983 lua_setfield(L, -2, "INT64");
984 lua_pushinteger(L, BLOBMSG_TYPE_INT32);
985 lua_setfield(L, -2, "INT32");
986 lua_pushinteger(L, BLOBMSG_TYPE_INT16);
987 lua_setfield(L, -2, "INT16");
988 lua_pushinteger(L, BLOBMSG_TYPE_INT8);
989 lua_setfield(L, -2, "INT8");
990 lua_pushinteger(L, BLOBMSG_TYPE_BOOL);
991 lua_setfield(L, -2, "BOOLEAN");
993 /* used in our callbacks */
996 /* create the callback table */
997 lua_createtable(L, 1, 0);
998 lua_setglobal(L, "__ubus_cb");
1000 /* create the event table */
1001 lua_createtable(L, 1, 0);
1002 lua_setglobal(L, "__ubus_cb_event");
1004 /* create the subscriber table */
1005 lua_createtable(L, 1, 0);
1006 lua_setglobal(L, "__ubus_cb_subscribe");
1008 /* create the publisher table - notifications of new subs */
1009 lua_createtable(L, 1, 0);
1010 lua_setglobal(L, "__ubus_cb_publisher");