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         plen = lua_gettablelen(L, -1);
 353
 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) {
 358                 lua_pop(L, 2);
 359                 return 1;
 360         }
 361
 362         /* store function pointer */
 363         lua_pushvalue(L, -2);
 364         lua_setfield(L, -6, lua_tostring(L, -5));
 365
 366         /* setup the policy pointers */
 367         p = malloc(sizeof(struct blobmsg_policy) * plen);
 368         memset(p, 0, sizeof(struct blobmsg_policy) * plen);
 369         m->policy = p;
 370         lua_pushnil(L);
 371         while (lua_next(L, -2) != 0) {
 372                 int val = lua_tointeger(L, -1);
 373
 374                 /* check if the policy is valid */
 375                 if ((lua_type(L, -2) != LUA_TSTRING) ||
 376                                 (lua_type(L, -1) != LUA_TNUMBER) ||
 377                                 (val < 0) ||
 378                                 (val > BLOBMSG_TYPE_LAST)) {
 379                         lua_pop(L, 1);
 380                         continue;
 381                 }
 382                 p[pidx].name = lua_tostring(L, -2);
 383                 p[pidx].type = val;
 384                 lua_pop(L, 1);
 385                 pidx++;
 386         }
 387
 388         m->n_policy = pidx;
 389         m->name = lua_tostring(L, -4);
 390         m->handler = ubus_method_handler;
 391         lua_pop(L, 2);
 392
 393         return 0;
 394 }
 395
 396 static struct ubus_object* ubus_lua_load_object(lua_State *L)
 397 {
 398         struct ubus_lua_object *obj = NULL;
 399         int mlen = lua_gettablelen(L, -1);
 400         struct ubus_method *m;
 401         int midx = 0;
 402
 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);
 407
 408         /* setup method pointers */
 409         m = malloc(sizeof(struct ubus_method) * mlen);
 410         memset(m, 0, sizeof(struct ubus_method) * mlen);
 411         obj->o.methods = m;
 412
 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);
 417         obj->o.type->id = 0;
 418         obj->o.type->methods = obj->o.methods;
 419
 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);
 425         lua_pop(L, 1);
 426
 427         /* scan each method */
 428         lua_pushnil(L);
 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)) {
 434                         lua_pop(L, 1);
 435                         continue;
 436                 }
 437
 438                 if (!ubus_lua_load_methods(L, &m[midx]))
 439                         midx++;
 440                 lua_pop(L, 1);
 441         }
 442
 443         obj->o.type->n_methods = obj->o.n_methods = midx;
 444
 445         /* pop the callback table */
 446         lua_pop(L, 1);
 447
 448         return &obj->o;
 449 }
 450
 451 static int ubus_lua_add(lua_State *L)
 452 {
 453         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
 454
 455         /* verify top level object */
 456         if (lua_istable(L, 1)) {
 457                 lua_pushstring(L, "you need to pass a table");
 458                 lua_error(L);
 459                 return 0;
 460         }
 461
 462         /* scan each object */
 463         lua_pushnil(L);
 464         while (lua_next(L, -2) != 0) {
 465                 struct ubus_object *obj = NULL;
 466
 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);
 470
 471                         if (obj)
 472                                 ubus_add_object(c->ctx, obj);
 473                 }
 474                 lua_pop(L, 1);
 475         }
 476
 477         return 0;
 478 }
 479
 480 static void
 481 ubus_lua_signatures_cb(struct ubus_context *c, struct ubus_object_data *o, void *p)
 482 {
 483         lua_State *L = (lua_State *)p;
 484
 485         if (!o->signature)
 486                 return;
 487
 488         ubus_lua_parse_blob_array(L, blob_data(o->signature), blob_len(o->signature), true);
 489 }
 490
 491 static int
 492 ubus_lua_signatures(lua_State *L)
 493 {
 494         int rv;
 495         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
 496         const char *path = luaL_checkstring(L, 2);
 497
 498         rv = ubus_lookup(c->ctx, path, ubus_lua_signatures_cb, L);
 499
 500         if (rv != UBUS_STATUS_OK)
 501         {
 502                 lua_pop(L, 1);
 503                 lua_pushnil(L);
 504                 lua_pushinteger(L, rv);
 505                 return 2;
 506         }
 507
 508         return 1;
 509 }
 510
 511
 512 static void
 513 ubus_lua_call_cb(struct ubus_request *req, int type, struct blob_attr *msg)
 514 {
 515         lua_State *L = (lua_State *)req->priv;
 516
 517         if (!msg)
 518                 lua_pushnil(L);
 519
 520         ubus_lua_parse_blob_array(L, blob_data(msg), blob_len(msg), true);
 521 }
 522
 523 static int
 524 ubus_lua_call(lua_State *L)
 525 {
 526         int rv, top;
 527         uint32_t id;
 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);
 531
 532         luaL_checktype(L, 4, LUA_TTABLE);
 533         blob_buf_init(&c->buf, 0);
 534
 535         if (!ubus_lua_format_blob_array(L, &c->buf, true))
 536         {
 537                 lua_pushnil(L);
 538                 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
 539                 return 2;
 540         }
 541
 542         rv = ubus_lookup_id(c->ctx, path, &id);
 543
 544         if (rv)
 545         {
 546                 lua_pushnil(L);
 547                 lua_pushinteger(L, rv);
 548                 return 2;
 549         }
 550
 551         top = lua_gettop(L);
 552         rv = ubus_invoke(c->ctx, id, func, c->buf.head, ubus_lua_call_cb, L, c->timeout * 1000);
 553
 554         if (rv != UBUS_STATUS_OK)
 555         {
 556                 lua_pop(L, 1);
 557                 lua_pushnil(L);
 558                 lua_pushinteger(L, rv);
 559                 return 2;
 560         }
 561
 562         return lua_gettop(L) - top;
 563 }
 564
 565 static void
 566 ubus_event_handler(struct ubus_context *ctx, struct ubus_event_handler *ev,
 567                         const char *type, struct blob_attr *msg)
 568 {
 569         struct ubus_lua_event *listener = container_of(ev, struct ubus_lua_event, e);
 570
 571         lua_getglobal(state, "__ubus_cb_event");
 572         lua_rawgeti(state, -1, listener->r);
 573
 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);
 577         }
 578 }
 579
 580 static struct ubus_event_handler*
 581 ubus_lua_load_event(lua_State *L)
 582 {
 583         struct ubus_lua_event* event = NULL;
 584
 585         event = malloc(sizeof(struct ubus_lua_event));
 586         memset(event, 0, sizeof(struct ubus_lua_event));
 587         event->e.cb = ubus_event_handler;
 588
 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));
 594
 595         return &event->e;
 596 }
 597
 598 static int
 599 ubus_lua_listen(lua_State *L) {
 600         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
 601
 602         /* verify top level object */
 603         luaL_checktype(L, 2, LUA_TTABLE);
 604
 605         /* scan each object */
 606         lua_pushnil(L);
 607         while (lua_next(L, -2) != 0) {
 608                 struct ubus_event_handler *listener;
 609
 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));
 615                         }
 616                 }
 617                 lua_pop(L, 1);
 618         }
 619         return 0;
 620 }
 621
 622 static int
 623 ubus_lua_send(lua_State *L)
 624 {
 625         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
 626         const char *event = luaL_checkstring(L, 2);
 627
 628         if (*event == 0)
 629                 return luaL_argerror(L, 2, "no event name");
 630
 631         // Event content convert to ubus form
 632         luaL_checktype(L, 3, LUA_TTABLE);
 633         blob_buf_init(&c->buf, 0);
 634
 635         if (!ubus_lua_format_blob_array(L, &c->buf, true)) {
 636                 lua_pushnil(L);
 637                 lua_pushinteger(L, UBUS_STATUS_INVALID_ARGUMENT);
 638                 return 2;
 639         }
 640
 641         // Send the event
 642         ubus_send_event(c->ctx, event, c->buf.head);
 643
 644         return 0;
 645 }
 646
 647
 648
 649 static int
 650 ubus_lua__gc(lua_State *L)
 651 {
 652         struct ubus_lua_connection *c = luaL_checkudata(L, 1, METANAME);
 653
 654         if (c->ctx != NULL)
 655         {
 656                 ubus_free(c->ctx);
 657                 memset(c, 0, sizeof(*c));
 658         }
 659
 660         return 0;
 661 }
 662
 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 },
 674         { NULL, NULL },
 675 };
 676
 677 /* avoid missing prototype warning */
 678 int luaopen_ubus(lua_State *L);
 679
 680 int
 681 luaopen_ubus(lua_State *L)
 682 {
 683         /* create metatable */
 684         luaL_newmetatable(L, METANAME);
 685
 686         /* metatable.__index = metatable */
 687         lua_pushvalue(L, -1);
 688         lua_setfield(L, -2, "__index");
 689
 690         /* fill metatable */
 691         luaL_register(L, NULL, ubus);
 692         lua_pop(L, 1);
 693
 694         /* create module */
 695         luaL_register(L, MODNAME, ubus);
 696
 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");
 714
 715         /* used in our callbacks */
 716         state = L;
 717
 718         /* create the callback table */
 719         lua_createtable(L, 1, 0);
 720         lua_setglobal(L, "__ubus_cb");
 721
 722         /* create the event table */
 723         lua_createtable(L, 1, 0);
 724         lua_setglobal(L, "__ubus_cb_event");
 725
 726         return 0;
 727 }