lua: allow methods with no arguments
[project/ubus.git] / lua / ubus.c
1 /*
2  * Copyright (C) 2012 Jo-Philipp Wich <jow@openwrt.org>
3  * Copyright (C) 2012 John Crispin <blogic@openwrt.org>
4  *
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
8  *
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.
13  */
14
15 #include <unistd.h>
16 #include <libubus.h>
17 #include <libubox/blobmsg.h>
18 #include <libubox/blobmsg_json.h>
19 #include <lauxlib.h>
20 #include <lua.h>
21
22 #define MODNAME         "ubus"
23 #define METANAME        MODNAME ".meta"
24
25 static lua_State *state;
26
27 struct ubus_lua_connection {
28         int timeout;
29         struct blob_buf buf;
30         struct ubus_context *ctx;
31 };
32
33 struct ubus_lua_object {
34         struct ubus_object o;
35         int r;
36 };
37
38 struct ubus_lua_event {
39         struct ubus_event_handler e;
40         int r;
41 };
42
43 static int
44 ubus_lua_parse_blob(lua_State *L, struct blob_attr *attr, bool table);
45
46 static int
47 ubus_lua_parse_blob_array(lua_State *L, struct blob_attr *attr, int len, bool table)
48 {
49         int rv;
50         int idx = 1;
51         int rem = len;
52         struct blob_attr *pos;
53
54         lua_newtable(L);
55
56         __blob_for_each_attr(pos, attr, rem)
57         {
58                 rv = ubus_lua_parse_blob(L, pos, table);
59
60                 if (rv > 1)
61                         lua_rawset(L, -3);
62                 else if (rv > 0)
63                         lua_rawseti(L, -2, idx++);
64         }
65
66         return 1;
67 }
68
69 static int
70 ubus_lua_parse_blob(lua_State *L, struct blob_attr *attr, bool table)
71 {
72         int len;
73         int off = 0;
74         void *data;
75
76         if (!blobmsg_check_attr(attr, false))
77                 return 0;
78
79         if (table && blobmsg_name(attr)[0])
80         {
81                 lua_pushstring(L, blobmsg_name(attr));
82                 off++;
83         }
84
85         data = blobmsg_data(attr);
86         len = blobmsg_data_len(attr);
87
88         switch (blob_id(attr))
89         {
90         case BLOBMSG_TYPE_BOOL:
91                 lua_pushboolean(L, *(uint8_t *)data);
92                 break;
93
94         case BLOBMSG_TYPE_INT16:
95                 lua_pushinteger(L, be16_to_cpu(*(uint16_t *)data));
96                 break;
97
98         case BLOBMSG_TYPE_INT32:
99                 lua_pushinteger(L, be32_to_cpu(*(uint32_t *)data));
100                 break;
101
102         case BLOBMSG_TYPE_INT64:
103                 lua_pushnumber(L, (double) be64_to_cpu(*(uint64_t *)data));
104                 break;
105
106         case BLOBMSG_TYPE_STRING:
107                 lua_pushstring(L, data);
108                 break;
109
110         case BLOBMSG_TYPE_ARRAY:
111                 ubus_lua_parse_blob_array(L, data, len, false);
112                 break;
113
114         case BLOBMSG_TYPE_TABLE:
115                 ubus_lua_parse_blob_array(L, data, len, true);
116                 break;
117
118         default:
119                 lua_pushnil(L);
120                 break;
121         }
122
123         return off + 1;
124 }
125
126
127 static bool
128 ubus_lua_format_blob_is_array(lua_State *L)
129 {
130         lua_Integer prv = 0;
131         lua_Integer cur = 0;
132
133         /* Find out whether table is array-like */
134         for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1))
135         {
136 #ifdef LUA_TINT
137                 if (lua_type(L, -2) != LUA_TNUMBER && lua_type(L, -2) != LUA_TINT)
138 #else
139                 if (lua_type(L, -2) != LUA_TNUMBER)
140 #endif
141                 {
142                         lua_pop(L, 2);
143                         return false;
144                 }
145
146                 cur = lua_tointeger(L, -2);
147
148                 if ((cur - 1) != prv)
149                 {
150                         lua_pop(L, 2);
151                         return false;
152                 }
153
154                 prv = cur;
155         }
156
157         return true;
158 }
159
160 static int
161 ubus_lua_format_blob_array(lua_State *L, struct blob_buf *b, bool table);
162
163 static int
164 ubus_lua_format_blob(lua_State *L, struct blob_buf *b, bool table)
165 {
166         void *c;
167         bool rv = true;
168         const char *key = table ? lua_tostring(L, -2) : NULL;
169
170         switch (lua_type(L, -1))
171         {
172         case LUA_TBOOLEAN:
173                 blobmsg_add_u8(b, key, (uint8_t)lua_toboolean(L, -1));
174                 break;
175
176 #ifdef LUA_TINT
177         case LUA_TINT:
178 #endif
179         case LUA_TNUMBER:
180                 blobmsg_add_u32(b, key, (uint32_t)lua_tointeger(L, -1));
181                 break;
182
183         case LUA_TSTRING:
184         case LUA_TUSERDATA:
185         case LUA_TLIGHTUSERDATA:
186                 blobmsg_add_string(b, key, lua_tostring(L, -1));
187                 break;
188
189         case LUA_TTABLE:
190                 if (ubus_lua_format_blob_is_array(L))
191                 {
192                         c = blobmsg_open_array(b, key);
193                         rv = ubus_lua_format_blob_array(L, b, false);
194                         blobmsg_close_array(b, c);
195                 }
196                 else
197                 {
198                         c = blobmsg_open_table(b, key);
199                         rv = ubus_lua_format_blob_array(L, b, true);
200                         blobmsg_close_table(b, c);
201                 }
202                 break;
203
204         default:
205                 rv = false;
206                 break;
207         }
208
209         return rv;
210 }
211
212 static int
213 ubus_lua_format_blob_array(lua_State *L, struct blob_buf *b, bool table)
214 {
215         for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1))
216         {
217                 if (!ubus_lua_format_blob(L, b, table))
218                 {
219                         lua_pop(L, 1);
220                         return false;
221                 }
222         }
223
224         return true;
225 }
226
227
228 static int
229 ubus_lua_connect(lua_State *L)
230 {
231         struct ubus_lua_connection *c;
232         const char *sockpath = luaL_optstring(L, 1, NULL);
233         int timeout = luaL_optint(L, 2, 30);
234
235         if ((c = lua_newuserdata(L, sizeof(*c))) != NULL &&
236                 (c->ctx = ubus_connect(sockpath)) != NULL)
237         {
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);
243                 return 1;
244         }
245
246         /* NB: no errors from ubus_connect() yet */
247         lua_pushnil(L);
248         lua_pushinteger(L, UBUS_STATUS_UNKNOWN_ERROR);
249         return 2;
250 }
251
252
253 static void
254 ubus_lua_objects_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
255 {
256         lua_State *L = (lua_State *)p;
257
258         lua_pushstring(L, o->path);
259         lua_rawseti(L, -2, lua_objlen(L, -2) + 1);
260 }
261
262 static int
263 ubus_lua_objects(lua_State *L)
264 {
265         int rv;
266         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
267
268         lua_newtable(L);
269         rv = ubus_lookup(c->ctx, NULL, ubus_lua_objects_cb, L);
270
271         if (rv != UBUS_STATUS_OK)
272         {
273                 lua_pop(L, 1);
274                 lua_pushnil(L);
275                 lua_pushinteger(L, rv);
276                 return 2;
277         }
278
279         return 1;
280 }
281
282 static int
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)
286 {
287         struct ubus_lua_object *o = container_of(obj, struct ubus_lua_object, o);
288
289         lua_getglobal(state, "__ubus_cb");
290         lua_rawgeti(state, -1, o->r);
291         lua_getfield(state, -1, method);
292
293         if (lua_isfunction(state, -1)) {
294                 lua_pushlightuserdata(state, req);
295                 if (!msg)
296                         lua_pushnil(state);
297                 else
298                         ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
299                 lua_call(state, 2, 0);
300         }
301         return 0;
302 }
303
304 static int lua_gettablelen(lua_State *L, int index)
305 {
306         int cnt = 0;
307
308         lua_pushnil(L);
309         index -= 1;
310         while (lua_next(L, index) != 0) {
311                 cnt++;
312                 lua_pop(L, 1);
313         }
314
315         return cnt;
316 }
317
318 static int ubus_lua_reply(lua_State *L)
319 {
320         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
321         struct ubus_request_data *req;
322
323         luaL_checktype(L, 3, LUA_TTABLE);
324         blob_buf_init(&c->buf, 0);
325
326         if (!ubus_lua_format_blob_array(L, &c->buf, true))
327         {
328                 lua_pushnil(L);
329                 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
330                 return 2;
331         }
332
333         req = lua_touserdata(L, 2);
334         ubus_send_reply(c->ctx, req, c->buf.head);
335
336         return 0;
337 }
338
339 static int ubus_lua_load_methods(lua_State *L, struct ubus_method *m)
340 {
341         struct blobmsg_policy *p;
342         int plen;
343         int pidx = 0;
344
345         /* get the function pointer */
346         lua_pushinteger(L, 1);
347         lua_gettable(L, -2);
348
349         /* get the policy table */
350         lua_pushinteger(L, 2);
351         lua_gettable(L, -3);
352
353         /* check if the method table is valid */
354         if ((lua_type(L, -2) != LUA_TFUNCTION) ||
355                         (lua_type(L, -1) != LUA_TTABLE) ||
356                         lua_objlen(L, -1)) {
357                 lua_pop(L, 2);
358                 return 1;
359         }
360
361         /* store function pointer */
362         lua_pushvalue(L, -2);
363         lua_setfield(L, -6, lua_tostring(L, -5));
364
365         m->name = lua_tostring(L, -4);
366         m->handler = ubus_method_handler;
367
368         plen = lua_gettablelen(L, -1);
369
370         /* exit if policy table is empty */
371         if (!plen) {
372                 lua_pop(L, 2);
373                 return 0;
374         }
375
376         /* setup the policy pointers */
377         p = malloc(sizeof(struct blobmsg_policy) * plen);
378         memset(p, 0, sizeof(struct blobmsg_policy) * plen);
379         m->policy = p;
380         lua_pushnil(L);
381         while (lua_next(L, -2) != 0) {
382                 int val = lua_tointeger(L, -1);
383
384                 /* check if the policy is valid */
385                 if ((lua_type(L, -2) != LUA_TSTRING) ||
386                                 (lua_type(L, -1) != LUA_TNUMBER) ||
387                                 (val < 0) ||
388                                 (val > BLOBMSG_TYPE_LAST)) {
389                         lua_pop(L, 1);
390                         continue;
391                 }
392                 p[pidx].name = lua_tostring(L, -2);
393                 p[pidx].type = val;
394                 lua_pop(L, 1);
395                 pidx++;
396         }
397
398         m->n_policy = pidx;
399         lua_pop(L, 2);
400
401         return 0;
402 }
403
404 static struct ubus_object* ubus_lua_load_object(lua_State *L)
405 {
406         struct ubus_lua_object *obj = NULL;
407         int mlen = lua_gettablelen(L, -1);
408         struct ubus_method *m;
409         int midx = 0;
410
411         /* setup object pointers */
412         obj = malloc(sizeof(struct ubus_lua_object));
413         memset(obj, 0, sizeof(struct ubus_lua_object));
414         obj->o.name = lua_tostring(L, -2);
415
416         /* setup method pointers */
417         m = malloc(sizeof(struct ubus_method) * mlen);
418         memset(m, 0, sizeof(struct ubus_method) * mlen);
419         obj->o.methods = m;
420
421         /* setup type pointers */
422         obj->o.type = malloc(sizeof(struct ubus_object_type));
423         memset(obj->o.type, 0, sizeof(struct ubus_object_type));
424         obj->o.type->name = lua_tostring(L, -2);
425         obj->o.type->id = 0;
426         obj->o.type->methods = obj->o.methods;
427
428         /* create the callback lookup table */
429         lua_createtable(L, 1, 0);
430         lua_getglobal(L, "__ubus_cb");
431         lua_pushvalue(L, -2);
432         obj->r = luaL_ref(L, -2);
433         lua_pop(L, 1);
434
435         /* scan each method */
436         lua_pushnil(L);
437         while (lua_next(L, -3) != 0) {
438                 /* check if it looks like a method */
439                 if ((lua_type(L, -2) != LUA_TSTRING) ||
440                                 (lua_type(L, -1) != LUA_TTABLE) ||
441                                 !lua_objlen(L, -1)) {
442                         lua_pop(L, 1);
443                         continue;
444                 }
445
446                 if (!ubus_lua_load_methods(L, &m[midx]))
447                         midx++;
448                 lua_pop(L, 1);
449         }
450
451         obj->o.type->n_methods = obj->o.n_methods = midx;
452
453         /* pop the callback table */
454         lua_pop(L, 1);
455
456         return &obj->o;
457 }
458
459 static int ubus_lua_add(lua_State *L)
460 {
461         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
462
463         /* verify top level object */
464         if (lua_istable(L, 1)) {
465                 lua_pushstring(L, "you need to pass a table");
466                 lua_error(L);
467                 return 0;
468         }
469
470         /* scan each object */
471         lua_pushnil(L);
472         while (lua_next(L, -2) != 0) {
473                 struct ubus_object *obj = NULL;
474
475                 /* check if the object has a table of methods */
476                 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TTABLE)) {
477                         obj = ubus_lua_load_object(L);
478
479                         if (obj)
480                                 ubus_add_object(c->ctx, obj);
481                 }
482                 lua_pop(L, 1);
483         }
484
485         return 0;
486 }
487
488 static void
489 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
490 {
491         lua_State *L = (lua_State *)p;
492
493         if (!o->signature)
494                 return;
495
496         ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
497 }
498
499 static int
500 ubus_lua_signatures(lua_State *L)
501 {
502         int rv;
503         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
504         const char *path = luaL_checkstring(L, 2);
505
506         rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
507
508         if (rv != UBUS_STATUS_OK)
509         {
510                 lua_pop(L, 1);
511                 lua_pushnil(L);
512                 lua_pushinteger(L, rv);
513                 return 2;
514         }
515
516         return 1;
517 }
518
519
520 static void
521 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
522 {
523         lua_State *L = (lua_State *)req->priv;
524
525         if (!msg)
526                 lua_pushnil(L);
527
528         ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
529 }
530
531 static int
532 ubus_lua_call(lua_State *L)
533 {
534         int rv, top;
535         uint32_t id;
536         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
537         const char *path = luaL_checkstring(L, 2);
538         const char *func = luaL_checkstring(L, 3);
539
540         luaL_checktype(L, 4, LUA_TTABLE);
541         blob_buf_init(&c->buf, 0);
542
543         if (!ubus_lua_format_blob_array(L, &c->buf, true))
544         {
545                 lua_pushnil(L);
546                 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
547                 return 2;
548         }
549
550         rv = ubus_lookup_id(c->ctx, path, &id);
551
552         if (rv)
553         {
554                 lua_pushnil(L);
555                 lua_pushinteger(L, rv);
556                 return 2;
557         }
558
559         top = lua_gettop(L);
560         rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
561
562         if (rv != UBUS_STATUS_OK)
563         {
564                 lua_pop(L, 1);
565                 lua_pushnil(L);
566                 lua_pushinteger(L, rv);
567                 return 2;
568         }
569
570         return lua_gettop(L) - top;
571 }
572
573 static void
574 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
575                         const char *type, struct blob_attr *msg)
576 {
577         struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
578
579         lua_getglobal(state, "__ubus_cb_event");
580         lua_rawgeti(state, -1, listener->r);
581
582         if (lua_isfunction(state, -1)) {
583                 ubus_lua_parse_blob_array(state, blob_data(msg), blob_len(msg), true);
584                 lua_call(state, 1, 0);
585         }
586 }
587
588 static struct ubus_event_handler*
589 ubus_lua_load_event(lua_State *L)
590 {
591         struct ubus_lua_event* event = NULL;
592
593         event = malloc(sizeof(struct ubus_lua_event));
594         memset(event, 0, sizeof(struct ubus_lua_event));
595         event->e.cb = ubus_event_handler;
596
597         /* update the he callback lookup table */
598         lua_getglobal(L, "__ubus_cb_event");
599         lua_pushvalue(L, -2);
600         event->r = luaL_ref(L, -2);
601         lua_setfield(L, -1, lua_tostring(L, -3));
602
603         return &event->e;
604 }
605
606 static int
607 ubus_lua_listen(lua_State *L) {
608         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
609
610         /* verify top level object */
611         luaL_checktype(L, 2, LUA_TTABLE);
612
613         /* scan each object */
614         lua_pushnil(L);
615         while (lua_next(L, -2) != 0) {
616                 struct ubus_event_handler *listener;
617
618                 /* check if the key is a string and the value is a method */
619                 if ((lua_type(L, -2) == LUA_TSTRING) && (lua_type(L, -1) == LUA_TFUNCTION)) {
620                         listener = ubus_lua_load_event(L);
621                         if(listener != NULL) {
622                                 ubus_register_event_handler(c->ctx, listener, lua_tostring(L, -2));
623                         }
624                 }
625                 lua_pop(L, 1);
626         }
627         return 0;
628 }
629
630 static int
631 ubus_lua_send(lua_State *L)
632 {
633         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
634         const char *event = luaL_checkstring(L, 2);
635
636         if (*event == 0)
637                 return luaL_argerror(L, 2, "no event name");
638
639         // Event content convert to ubus form
640         luaL_checktype(L, 3, LUA_TTABLE);
641         blob_buf_init(&c->buf, 0);
642
643         if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
644                 lua_pushnil(L);
645                 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
646                 return 2;
647         }
648
649         // Send the event
650         ubus_send_event(c->ctx, event, c->buf.head);
651
652         return 0;
653 }
654
655
656
657 static int
658 ubus_lua__gc(lua_State *L)
659 {
660         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
661
662         if (c->ctx != NULL)
663         {
664                 ubus_free(c->ctx);
665                 memset(c, 0, sizeof(*c));
666         }
667
668         return 0;
669 }
670
671 static const luaL_Reg ubus[] = {
672         { "connect", ubus_lua_connect },
673         { "objects", ubus_lua_objects },
674         { "add", ubus_lua_add },
675         { "reply", ubus_lua_reply },
676         { "signatures", ubus_lua_signatures },
677         { "call", ubus_lua_call },
678         { "close", ubus_lua__gc },
679         { "listen", ubus_lua_listen },
680         { "send", ubus_lua_send },
681         { "__gc", ubus_lua__gc },
682         { NULL, NULL },
683 };
684
685 /* avoid missing prototype warning */
686 int luaopen_ubus(lua_State *L);
687
688 int
689 luaopen_ubus(lua_State *L)
690 {
691         /* create metatable */
692         luaL_newmetatable(L, METANAME);
693
694         /* metatable.__index = metatable */
695         lua_pushvalue(L, -1);
696         lua_setfield(L, -2, "__index");
697
698         /* fill metatable */
699         luaL_register(L, NULL, ubus);
700         lua_pop(L, 1);
701
702         /* create module */
703         luaL_register(L, MODNAME, ubus);
704
705         /* set some enum defines */
706         lua_pushinteger(L, BLOBMSG_TYPE_ARRAY);
707         lua_setfield(L, -2, "ARRAY");
708         lua_pushinteger(L, BLOBMSG_TYPE_TABLE);
709         lua_setfield(L, -2, "TABLE");
710         lua_pushinteger(L, BLOBMSG_TYPE_STRING);
711         lua_setfield(L, -2, "STRING");
712         lua_pushinteger(L, BLOBMSG_TYPE_INT64);
713         lua_setfield(L, -2, "INT64");
714         lua_pushinteger(L, BLOBMSG_TYPE_INT32);
715         lua_setfield(L, -2, "INT32");
716         lua_pushinteger(L, BLOBMSG_TYPE_INT16);
717         lua_setfield(L, -2, "INT16");
718         lua_pushinteger(L, BLOBMSG_TYPE_INT8);
719         lua_setfield(L, -2, "INT8");
720         lua_pushinteger(L, BLOBMSG_TYPE_BOOL);
721         lua_setfield(L, -2, "BOOLEAN");
722
723         /* used in our callbacks */
724         state = L;
725
726         /* create the callback table */
727         lua_createtable(L, 1, 0);
728         lua_setglobal(L, "__ubus_cb");
729
730         /* create the event table */
731         lua_createtable(L, 1, 0);
732         lua_setglobal(L, "__ubus_cb_event");
733
734         return 0;
735 }