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);
289 lua_getglobal(state, "__ubus_cb");
290 lua_rawgeti(state, -1, o->r);
291 lua_getfield(state, -1, method);
293 if (lua_isfunction(state, -1)) {
294 lua_pushlightuserdata(state, req);
298 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
299 lua_call(state, 2, 0);
304 static int lua_gettablelen(lua_State *L, int index)
310 while (lua_next(L, index) != 0) {
318 static int ubus_lua_reply(lua_State *L)
320 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
321 struct ubus_request_data *req;
323 luaL_checktype(L, 3, LUA_TTABLE);
324 blob_buf_init(&c->buf, 0);
326 if (!ubus_lua_format_blob_array(L, &c->buf, true))
329 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
333 req = lua_touserdata(L, 2);
334 ubus_send_reply(c->ctx, req, c->buf.head);
339 static int ubus_lua_load_methods(lua_State *L, struct ubus_method *m)
341 struct blobmsg_policy *p;
345 /* get the function pointer */
346 lua_pushinteger(L, 1);
349 /* get the policy table */
350 lua_pushinteger(L, 2);
352 plen = lua_gettablelen(L, -1);
354 /* check if the method table is valid */
355 if ((lua_type(L, -2) != LUA_TFUNCTION) ||
356 (lua_type(L, -1) != LUA_TTABLE) ||
357 lua_objlen(L, -1) || !plen) {
362 /* store function pointer */
363 lua_pushvalue(L, -2);
364 lua_setfield(L, -6, lua_tostring(L, -5));
366 /* setup the policy pointers */
367 p = malloc(sizeof(struct blobmsg_policy) * plen);
368 memset(p, 0, sizeof(struct blobmsg_policy) * plen);
371 while (lua_next(L, -2) != 0) {
372 int val = lua_tointeger(L, -1);
374 /* check if the policy is valid */
375 if ((lua_type(L, -2) != LUA_TSTRING) ||
376 (lua_type(L, -1) != LUA_TNUMBER) ||
378 (val > BLOBMSG_TYPE_LAST)) {
382 p[pidx].name = lua_tostring(L, -2);
389 m->name = lua_tostring(L, -4);
390 m->handler = ubus_method_handler;
396 static struct ubus_object* ubus_lua_load_object(lua_State *L)
398 struct ubus_lua_object *obj = NULL;
399 int mlen = lua_gettablelen(L, -1);
400 struct ubus_method *m;
403 /* setup object pointers */
404 obj = malloc(sizeof(struct ubus_lua_object));
405 memset(obj, 0, sizeof(struct ubus_lua_object));
406 obj->o.name = lua_tostring(L, -2);
408 /* setup method pointers */
409 m = malloc(sizeof(struct ubus_method) * mlen);
410 memset(m, 0, sizeof(struct ubus_method) * mlen);
413 /* setup type pointers */
414 obj->o.type = malloc(sizeof(struct ubus_object_type));
415 memset(obj->o.type, 0, sizeof(struct ubus_object_type));
416 obj->o.type->name = lua_tostring(L, -2);
418 obj->o.type->methods = obj->o.methods;
420 /* create the callback lookup table */
421 lua_createtable(L, 1, 0);
422 lua_getglobal(L, "__ubus_cb");
423 lua_pushvalue(L, -2);
424 obj->r = luaL_ref(L, -2);
427 /* scan each method */
429 while (lua_next(L, -3) != 0) {
430 /* check if it looks like a method */
431 if ((lua_type(L, -2) != LUA_TSTRING) ||
432 (lua_type(L, -1) != LUA_TTABLE) ||
433 !lua_objlen(L, -1)) {
438 if (!ubus_lua_load_methods(L, &m[midx]))
443 obj->o.type->n_methods = obj->o.n_methods = midx;
445 /* pop the callback table */
451 static int ubus_lua_add(lua_State *L)
453 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
455 /* verify top level object */
456 if (lua_istable(L, 1)) {
457 lua_pushstring(L, "you need to pass a table");
462 /* scan each object */
464 while (lua_next(L, -2) != 0) {
465 struct ubus_object *obj = NULL;
467 /* check if the object has a table of methods */
468 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TTABLE)) {
469 obj = ubus_lua_load_object(L);
472 ubus_add_object(c->ctx, obj);
481 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
483 lua_State *L = (lua_State *)p;
488 ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
492 ubus_lua_signatures(lua_State *L)
495 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
496 const char *path = luaL_checkstring(L, 2);
498 rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
500 if (rv != UBUS_STATUS_OK)
504 lua_pushinteger(L, rv);
513 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
515 lua_State *L = (lua_State *)req->priv;
520 ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
524 ubus_lua_call(lua_State *L)
528 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
529 const char *path = luaL_checkstring(L, 2);
530 const char *func = luaL_checkstring(L, 3);
532 luaL_checktype(L, 4, LUA_TTABLE);
533 blob_buf_init(&c->buf, 0);
535 if (!ubus_lua_format_blob_array(L, &c->buf, true))
538 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
542 rv = ubus_lookup_id(c->ctx, path, &id);
547 lua_pushinteger(L, rv);
552 rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
554 if (rv != UBUS_STATUS_OK)
558 lua_pushinteger(L, rv);
562 return lua_gettop(L) - top;
566 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
567 const char *type, struct blob_attr *msg)
569 struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
571 lua_getglobal(state, "__ubus_cb_event");
572 lua_rawgeti(state, -1, listener->r);
574 if (lua_isfunction(state, -1)) {
575 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
576 lua_call(state, 1, 0);
580 static struct ubus_event_handler*
581 ubus_lua_load_event(lua_State *L)
583 struct ubus_lua_event* event = NULL;
585 event = malloc(sizeof(struct ubus_lua_event));
586 memset(event, 0, sizeof(struct ubus_lua_event));
587 event->e.cb = ubus_event_handler;
589 /* update the he callback lookup table */
590 lua_getglobal(L, "__ubus_cb_event");
591 lua_pushvalue(L, -2);
592 event->r = luaL_ref(L, -2);
593 lua_setfield(L, -1, lua_tostring(L, -3));
599 ubus_lua_listen(lua_State *L) {
600 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
602 /* verify top level object */
603 luaL_checktype(L, 2, LUA_TTABLE);
605 /* scan each object */
607 while (lua_next(L, -2) != 0) {
608 struct ubus_event_handler *listener;
610 /* check if the key is a string and the value is a method */
611 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TFUNCTION)) {
612 listener = ubus_lua_load_event(L);
613 if(listener != NULL) {
614 ubus_register_event_handler(c->ctx, listener, lua_tostring(L, -2));
623 ubus_lua_send(lua_State *L)
625 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
626 const char *event = luaL_checkstring(L, 2);
629 return luaL_argerror(L, 2, "no event name");
631 // Event content convert to ubus form
632 luaL_checktype(L, 3, LUA_TTABLE);
633 blob_buf_init(&c->buf, 0);
635 if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
637 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
642 ubus_send_event(c->ctx, event, c->buf.head);
650 ubus_lua__gc(lua_State *L)
652 struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
657 memset(c, 0, sizeof(*c));
663 static const luaL_Reg ubus[] = {
664 { "connect", ubus_lua_connect },
665 { "objects", ubus_lua_objects },
666 { "add", ubus_lua_add },
667 { "reply", ubus_lua_reply },
668 { "signatures", ubus_lua_signatures },
669 { "call", ubus_lua_call },
670 { "close", ubus_lua__gc },
671 { "listen", ubus_lua_listen },
672 { "send", ubus_lua_send },
673 { "__gc", ubus_lua__gc },
677 /* avoid missing prototype warning */
678 int luaopen_ubus(lua_State *L);
681 luaopen_ubus(lua_State *L)
683 /* create metatable */
684 luaL_newmetatable(L, METANAME);
686 /* metatable.__index = metatable */
687 lua_pushvalue(L, -1);
688 lua_setfield(L, -2, "__index");
691 luaL_register(L, NULL, ubus);
695 luaL_register(L, MODNAME, ubus);
697 /* set some enum defines */
698 lua_pushinteger(L, BLOBMSG_TYPE_ARRAY);
699 lua_setfield(L, -2, "ARRAY");
700 lua_pushinteger(L, BLOBMSG_TYPE_TABLE);
701 lua_setfield(L, -2, "TABLE");
702 lua_pushinteger(L, BLOBMSG_TYPE_STRING);
703 lua_setfield(L, -2, "STRING");
704 lua_pushinteger(L, BLOBMSG_TYPE_INT64);
705 lua_setfield(L, -2, "INT64");
706 lua_pushinteger(L, BLOBMSG_TYPE_INT32);
707 lua_setfield(L, -2, "INT32");
708 lua_pushinteger(L, BLOBMSG_TYPE_INT16);
709 lua_setfield(L, -2, "INT16");
710 lua_pushinteger(L, BLOBMSG_TYPE_INT8);
711 lua_setfield(L, -2, "INT8");
712 lua_pushinteger(L, BLOBMSG_TYPE_BOOL);
713 lua_setfield(L, -2, "BOOLEAN");
715 /* used in our callbacks */
718 /* create the callback table */
719 lua_createtable(L, 1, 0);
720 lua_setglobal(L, "__ubus_cb");
722 /* create the event table */
723 lua_createtable(L, 1, 0);
724 lua_setglobal(L, "__ubus_cb_event");