2 * dbus.c - awesome dbus support
4 * Copyright © 2008 Julien Danjou <julien@danjou.info>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 #include <dbus/dbus.h>
35 static DBusConnection
*dbus_connection_session
= NULL
;
36 static DBusConnection
*dbus_connection_system
= NULL
;
37 ev_io dbusio_ses
= { .fd
= -1 };
38 ev_io dbusio_sys
= { .fd
= -1 };
40 static signal_array_t dbus_signals
;
43 a_dbus_cleanup_bus(DBusConnection
*dbus_connection
, ev_io
*dbusio
)
50 ev_ref(EV_DEFAULT_UC
);
51 ev_io_stop(EV_DEFAULT_UC_ dbusio
);
55 /* This is a shared connection owned by libdbus
56 * Do not close it, only unref
58 dbus_connection_unref(dbus_connection
);
62 a_dbus_message_iter(DBusMessageIter
*iter
)
68 switch(dbus_message_iter_get_arg_type(iter
))
71 lua_pushnil(globalconf
.L
);
74 case DBUS_TYPE_INVALID
:
76 case DBUS_TYPE_VARIANT
:
78 DBusMessageIter subiter
;
79 dbus_message_iter_recurse(iter
, &subiter
);
80 a_dbus_message_iter(&subiter
);
84 case DBUS_TYPE_DICT_ENTRY
:
86 DBusMessageIter subiter
;
88 /* initialize a sub iterator */
89 dbus_message_iter_recurse(iter
, &subiter
);
90 /* create a new table to store the dict */
91 a_dbus_message_iter(&subiter
);
95 case DBUS_TYPE_STRUCT
:
97 DBusMessageIter subiter
;
98 /* initialize a sub iterator */
99 dbus_message_iter_recurse(iter
, &subiter
);
101 int n
= a_dbus_message_iter(&subiter
);
103 /* create a new table to store all the value */
104 lua_createtable(globalconf
.L
, n
, 0);
105 /* move the table before array elements */
106 lua_insert(globalconf
.L
, - n
- 1);
108 for(int i
= n
; i
> 0; i
--)
109 lua_rawseti(globalconf
.L
, - i
- 1, i
);
113 case DBUS_TYPE_ARRAY
:
115 int array_type
= dbus_message_iter_get_element_type(iter
);
117 if(dbus_type_is_fixed(array_type
))
120 dbus_message_iter_recurse(iter
, &sub
);
125 #define DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(type, dbustype) \
129 dbus_message_iter_get_fixed_array(&sub, &data, &datalen); \
130 lua_createtable(globalconf.L, datalen, 0); \
131 for(int i = 0; i < datalen; i++) \
133 lua_pushnumber(globalconf.L, data[i]); \
134 lua_rawseti(globalconf.L, -2, i + 1); \
138 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(int16_t, DBUS_TYPE_INT16
)
139 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(uint16_t, DBUS_TYPE_UINT16
)
140 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(int32_t, DBUS_TYPE_INT32
)
141 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(uint32_t, DBUS_TYPE_UINT32
)
142 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(int64_t, DBUS_TYPE_INT64
)
143 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(uint64_t, DBUS_TYPE_UINT64
)
144 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(double, DBUS_TYPE_DOUBLE
)
145 #undef DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER
149 dbus_message_iter_get_fixed_array(&sub
, &c
, &datalen
);
150 lua_pushlstring(globalconf
.L
, c
, datalen
);
153 case DBUS_TYPE_BOOLEAN
:
155 const dbus_bool_t
*b
;
156 dbus_message_iter_get_fixed_array(&sub
, &b
, &datalen
);
157 lua_createtable(globalconf
.L
, datalen
, 0);
158 for(int i
= 0; i
< datalen
; i
++)
160 lua_pushboolean(globalconf
.L
, b
[i
]);
161 lua_rawseti(globalconf
.L
, -2, i
+ 1);
167 else if(array_type
== DBUS_TYPE_DICT_ENTRY
)
169 DBusMessageIter subiter
;
170 /* initialize a sub iterator */
171 dbus_message_iter_recurse(iter
, &subiter
);
173 /* get the keys and the values
174 * n is the number of entry in dict */
175 int n
= a_dbus_message_iter(&subiter
);
177 /* create a new table to store all the value */
178 lua_createtable(globalconf
.L
, n
, 0);
179 /* move the table before array elements */
180 lua_insert(globalconf
.L
, - (n
* 2) - 1);
182 for(int i
= 0; i
< n
; i
++)
183 lua_rawset(globalconf
.L
, - (n
* 2) - 1 + i
* 2);
187 DBusMessageIter subiter
;
188 /* prepare to dig into the array*/
189 dbus_message_iter_recurse(iter
, &subiter
);
191 /* now iterate over every element of the array */
192 int n
= a_dbus_message_iter(&subiter
);
194 /* create a new table to store all the value */
195 lua_createtable(globalconf
.L
, n
, 0);
196 /* move the table before array elements */
197 lua_insert(globalconf
.L
, - n
- 1);
199 for(int i
= n
; i
> 0; i
--)
200 lua_rawseti(globalconf
.L
, - i
- 1, i
);
205 case DBUS_TYPE_BOOLEAN
:
208 dbus_message_iter_get_basic(iter
, &b
);
209 lua_pushboolean(globalconf
.L
, b
);
216 dbus_message_iter_get_basic(iter
, &c
);
217 lua_pushlstring(globalconf
.L
, &c
, 1);
221 #define DBUS_MSG_HANDLE_TYPE_NUMBER(type, dbustype) \
225 dbus_message_iter_get_basic(iter, &ui); \
226 lua_pushnumber(globalconf.L, ui); \
230 DBUS_MSG_HANDLE_TYPE_NUMBER(int16_t, DBUS_TYPE_INT16
)
231 DBUS_MSG_HANDLE_TYPE_NUMBER(uint16_t, DBUS_TYPE_UINT16
)
232 DBUS_MSG_HANDLE_TYPE_NUMBER(int32_t, DBUS_TYPE_INT32
)
233 DBUS_MSG_HANDLE_TYPE_NUMBER(uint32_t, DBUS_TYPE_UINT32
)
234 DBUS_MSG_HANDLE_TYPE_NUMBER(int64_t, DBUS_TYPE_INT64
)
235 DBUS_MSG_HANDLE_TYPE_NUMBER(uint64_t, DBUS_TYPE_UINT64
)
236 #undef DBUS_MSG_HANDLE_TYPE_NUMBER
237 case DBUS_TYPE_STRING
:
240 dbus_message_iter_get_basic(iter
, &s
);
241 lua_pushstring(globalconf
.L
, s
);
246 } while(dbus_message_iter_next(iter
));
252 a_dbus_process_request(DBusConnection
*dbus_connection
, DBusMessage
*msg
)
254 const char *interface
= dbus_message_get_interface(msg
);
255 signal_t
*sig
= signal_array_getbyid(&dbus_signals
,
256 a_strhash((const unsigned char *) interface
));
261 lua_createtable(globalconf
.L
, 0, 5);
263 switch(dbus_message_get_type(msg
))
265 case DBUS_MESSAGE_TYPE_SIGNAL
:
266 lua_pushliteral(globalconf
.L
, "signal");
268 case DBUS_MESSAGE_TYPE_METHOD_CALL
:
269 lua_pushliteral(globalconf
.L
, "method_call");
271 case DBUS_MESSAGE_TYPE_METHOD_RETURN
:
272 lua_pushliteral(globalconf
.L
, "method_return");
274 case DBUS_MESSAGE_TYPE_ERROR
:
275 lua_pushliteral(globalconf
.L
, "error");
278 lua_pushliteral(globalconf
.L
, "unknown");
282 lua_setfield(globalconf
.L
, -2, "type");
284 lua_pushstring(globalconf
.L
, NONULL(interface
));
285 lua_setfield(globalconf
.L
, -2, "interface");
287 const char *s
= dbus_message_get_path(msg
);
288 lua_pushstring(globalconf
.L
, NONULL(s
));
289 lua_setfield(globalconf
.L
, -2, "path");
291 s
= dbus_message_get_member(msg
);
292 lua_pushstring(globalconf
.L
, NONULL(s
));
293 lua_setfield(globalconf
.L
, -2, "member");
295 if(dbus_connection
== dbus_connection_system
)
296 lua_pushliteral(globalconf
.L
, "system");
298 lua_pushliteral(globalconf
.L
, "session");
299 lua_setfield(globalconf
.L
, -2, "bus");
301 /* + 1 for the table above */
302 DBusMessageIter iter
;
305 if(dbus_message_iter_init(msg
, &iter
))
306 nargs
+= a_dbus_message_iter(&iter
);
308 if(dbus_message_get_no_reply(msg
))
310 foreach(func
, sig
->sigfuncs
)
312 for(int i
= 0; i
< nargs
; i
++)
313 lua_pushvalue(globalconf
.L
, - nargs
);
314 luaA_object_push(globalconf
.L
, (void *) *func
);
315 luaA_dofunction(globalconf
.L
, nargs
, 0);
318 foreach(func
, sig
->sigfuncs
)
320 int n
= lua_gettop(globalconf
.L
);
322 for(int i
= 0; i
< nargs
; i
++)
323 lua_pushvalue(globalconf
.L
, - nargs
);
324 luaA_object_push(globalconf
.L
, (void *) *func
);
325 luaA_dofunction(globalconf
.L
, nargs
, LUA_MULTRET
);
327 n
-= lua_gettop(globalconf
.L
);
329 DBusMessage
*reply
= dbus_message_new_method_return(msg
);
331 dbus_message_iter_init_append(reply
, &iter
);
334 for(int i
= n
; i
< 0; i
+= 2)
336 /* i is the type name, i+1 the value */
338 const char *type
= lua_tolstring(globalconf
.L
, i
, &len
);
340 if(!type
|| len
!= 1)
342 luaA_warn(globalconf
.L
,
343 "your D-Bus signal handling method returned bad data");
349 case DBUS_TYPE_BOOLEAN
:
351 dbus_bool_t b
= lua_toboolean(globalconf
.L
, i
+ 1);
352 dbus_message_iter_append_basic(&iter
, DBUS_TYPE_BOOLEAN
, &b
);
355 #define DBUS_MSG_RETURN_HANDLE_TYPE_STRING(dbustype) \
357 if((s = lua_tostring(globalconf.L, i + 1))) \
358 dbus_message_iter_append_basic(&iter, dbustype, &s); \
360 DBUS_MSG_RETURN_HANDLE_TYPE_STRING(DBUS_TYPE_STRING
)
361 DBUS_MSG_RETURN_HANDLE_TYPE_STRING(DBUS_TYPE_BYTE
)
362 #undef DBUS_MSG_RETURN_HANDLE_TYPE_STRING
363 #define DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(type, dbustype) \
366 type num = lua_tonumber(globalconf.L, i + 1); \
367 dbus_message_iter_append_basic(&iter, dbustype, &num); \
370 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(int16_t, DBUS_TYPE_INT16
)
371 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(uint16_t, DBUS_TYPE_UINT16
)
372 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(int32_t, DBUS_TYPE_INT32
)
373 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(uint32_t, DBUS_TYPE_UINT32
)
374 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(int64_t, DBUS_TYPE_INT64
)
375 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(uint64_t, DBUS_TYPE_UINT64
)
376 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(double, DBUS_TYPE_DOUBLE
)
377 #undef DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER
380 lua_remove(globalconf
.L
, i
);
381 lua_remove(globalconf
.L
, i
+ 1);
384 dbus_connection_send(dbus_connection
, reply
, NULL
);
385 dbus_message_unref(reply
);
387 lua_pop(globalconf
.L
, nargs
);
391 a_dbus_process_requests_on_bus(DBusConnection
*dbus_connection
, ev_io
*dbusio
)
398 dbus_connection_read_write(dbus_connection
, 0);
400 if(!(msg
= dbus_connection_pop_message(dbus_connection
)))
403 if(dbus_message_is_signal(msg
, DBUS_INTERFACE_LOCAL
, "Disconnected"))
405 a_dbus_cleanup_bus(dbus_connection
, dbusio
);
406 dbus_message_unref(msg
);
410 a_dbus_process_request(dbus_connection
, msg
);
412 dbus_message_unref(msg
);
418 dbus_connection_flush(dbus_connection
);
422 a_dbus_process_requests_session(EV_P_ ev_io
*w
, int revents
)
424 a_dbus_process_requests_on_bus(dbus_connection_session
, w
);
428 a_dbus_process_requests_system(EV_P_ ev_io
*w
, int revents
)
430 a_dbus_process_requests_on_bus(dbus_connection_system
, w
);
434 a_dbus_request_name(DBusConnection
*dbus_connection
, const char *name
)
441 dbus_error_init(&err
);
443 int ret
= dbus_bus_request_name(dbus_connection
, name
, 0, &err
);
445 if(dbus_error_is_set(&err
))
447 warn("failed to request D-Bus name: %s", err
.message
);
448 dbus_error_free(&err
);
454 case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
:
456 case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER
:
457 warn("already primary D-Bus name owner for %s", name
);
464 a_dbus_release_name(DBusConnection
*dbus_connection
, const char *name
)
471 dbus_error_init(&err
);
473 int ret
= dbus_bus_release_name(dbus_connection
, name
, &err
);
475 if(dbus_error_is_set(&err
))
477 warn("failed to release D-Bus name: %s", err
.message
);
478 dbus_error_free(&err
);
484 case DBUS_RELEASE_NAME_REPLY_NOT_OWNER
:
485 warn("not primary D-Bus name owner for %s", name
);
487 case DBUS_RELEASE_NAME_REPLY_NON_EXISTENT
:
488 warn("non existent D-Bus name: %s", name
);
494 static DBusConnection
*
495 a_dbus_connect(DBusBusType type
, const char *type_name
,
496 ev_io
*dbusio
, void *cb
)
499 DBusConnection
*dbus_connection
;
502 dbus_error_init(&err
);
504 dbus_connection
= dbus_bus_get(type
, &err
);
505 if(dbus_error_is_set(&err
))
507 warn("D-Bus session bus %s failed: %s", type_name
, err
.message
);
508 dbus_connection
= NULL
;
509 dbus_error_free(&err
);
513 dbus_connection_set_exit_on_disconnect(dbus_connection
, false);
514 if(dbus_connection_get_unix_fd(dbus_connection
, &fd
))
516 fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
518 ev_io_init(dbusio
, cb
, fd
, EV_READ
);
519 ev_io_start(EV_DEFAULT_UC_ dbusio
);
520 ev_unref(EV_DEFAULT_UC
);
524 warn("cannot get D-Bus connection file descriptor");
525 a_dbus_cleanup_bus(dbus_connection
, dbusio
);
529 return dbus_connection
;
535 dbus_connection_session
= a_dbus_connect(DBUS_BUS_SESSION
, "session",
536 &dbusio_ses
, a_dbus_process_requests_session
);
537 dbus_connection_system
= a_dbus_connect(DBUS_BUS_SYSTEM
, "system",
538 &dbusio_sys
, a_dbus_process_requests_system
);
544 a_dbus_cleanup_bus(dbus_connection_session
, &dbusio_ses
);
545 a_dbus_cleanup_bus(dbus_connection_system
, &dbusio_sys
);
548 static DBusConnection
*
549 a_dbus_bus_getbyname(const char *name
, size_t len
)
551 switch(a_tokenize(name
, len
))
554 return dbus_connection_system
;
556 return dbus_connection_session
;
562 /** Register a D-Bus name to receive message from.
563 * \param L The Lua VM state.
564 * \return The number of elements pushed on stack.
566 * \lparam A string indicating if we are using system or session bus.
567 * \lparam A string with the name of the D-Bus name to register.
568 * \lreturn True if everything worked fine, false otherwise.
571 luaA_dbus_request_name(lua_State
*L
)
574 const char *bus
= luaL_checklstring(L
, 1, &len
);
575 const char *name
= luaL_checkstring(L
, 2);
576 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
577 lua_pushboolean(L
, a_dbus_request_name(dbus_connection
, name
));
581 /** Release a D-Bus name.
582 * \param L The Lua VM state.
583 * \return The number of elements pushed on stack.
585 * \lparam A string indicating if we are using system or session bus.
586 * \lparam A string with the name of the D-Bus name to unregister.
587 * \lreturn True if everything worked fine, false otherwise.
590 luaA_dbus_release_name(lua_State
*L
)
593 const char *bus
= luaL_checklstring(L
, 1, &len
);
594 const char *name
= luaL_checkstring(L
, 2);
595 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
596 lua_pushboolean(L
, a_dbus_release_name(dbus_connection
, name
));
600 /** Add a match rule to match messages going through the message bus.
601 * \param L The Lua VM state.
602 * \return The number of elements pushed on stack.
604 * \lparam A string indicating if we are using system or session bus.
605 * \lparam A string with the name of the match rule.
608 luaA_dbus_add_match(lua_State
*L
)
611 const char *bus
= luaL_checklstring(L
, 1, &len
);
612 const char *name
= luaL_checkstring(L
, 2);
613 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
617 dbus_bus_add_match(dbus_connection
, name
, NULL
);
618 dbus_connection_flush(dbus_connection
);
624 /** Remove a previously added match rule "by value"
625 * (the most recently-added identical rule gets removed).
626 * \param L The Lua VM state.
627 * \return The number of elements pushed on stack.
629 * \lparam A string indicating if we are using system or session bus.
630 * \lparam A string with the name of the match rule.
633 luaA_dbus_remove_match(lua_State
*L
)
636 const char *bus
= luaL_checklstring(L
, 1, &len
);
637 const char *name
= luaL_checkstring(L
, 2);
638 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
642 dbus_bus_remove_match(dbus_connection
, name
, NULL
);
643 dbus_connection_flush(dbus_connection
);
649 /** Add a signal receiver on the D-Bus.
650 * \param L The Lua VM state.
651 * \return The number of elements pushed on stack.
653 * \lparam A string with the interface name.
654 * \lparam The function to call.
657 luaA_dbus_add_signal(lua_State
*L
)
659 const char *name
= luaL_checkstring(L
, 1);
660 luaA_checkfunction(L
, 2);
661 signal_add(&dbus_signals
, name
, luaA_object_ref(L
, 2));
665 /** Add a signal receiver on the D-Bus.
666 * \param L The Lua VM state.
667 * \return The number of elements pushed on stack.
669 * \lparam A string with the interface name.
670 * \lparam The function to call.
673 luaA_dbus_remove_signal(lua_State
*L
)
675 const char *name
= luaL_checkstring(L
, 1);
676 luaA_checkfunction(L
, 2);
677 const void *func
= lua_topointer(L
, 2);
678 signal_remove(&dbus_signals
, name
, func
);
679 luaA_object_unref(L
, (void *) func
);
683 const struct luaL_reg awesome_dbus_lib
[] =
685 { "request_name", luaA_dbus_request_name
},
686 { "release_name", luaA_dbus_release_name
},
687 { "add_match", luaA_dbus_add_match
},
688 { "remove_match", luaA_dbus_remove_match
},
689 { "add_signal", luaA_dbus_add_signal
},
690 { "remove_signal", luaA_dbus_remove_signal
},
694 #else /* HAVE_DBUS */
707 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80