2 * dbus.c - awesome dbus support
4 * Copyright © 2008-2009 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.
29 #include <dbus/dbus.h>
36 static DBusConnection
*dbus_connection_session
= NULL
;
37 static DBusConnection
*dbus_connection_system
= NULL
;
38 ev_io dbusio_ses
= { .fd
= -1 };
39 ev_io dbusio_sys
= { .fd
= -1 };
41 static signal_array_t dbus_signals
;
43 /** Clean up the D-Bus connection data members
44 * \param dbus_connection The D-Bus connection to clean up
45 * \param dbusio The D-Bus event watcher
48 a_dbus_cleanup_bus(DBusConnection
*dbus_connection
, ev_io
*dbusio
)
55 ev_ref(EV_DEFAULT_UC
);
56 ev_io_stop(EV_DEFAULT_UC_ dbusio
);
60 /* This is a shared connection owned by libdbus
61 * Do not close it, only unref
63 dbus_connection_unref(dbus_connection
);
66 /** Iterate through the D-Bus messages counting each or traverse each sub message.
67 * \param iter The D-Bus message iterator pointer
68 * \return The number of arguments in the iterator
71 a_dbus_message_iter(DBusMessageIter
*iter
)
77 switch(dbus_message_iter_get_arg_type(iter
))
80 lua_pushnil(globalconf
.L
);
83 case DBUS_TYPE_INVALID
:
85 case DBUS_TYPE_VARIANT
:
87 DBusMessageIter subiter
;
88 dbus_message_iter_recurse(iter
, &subiter
);
89 a_dbus_message_iter(&subiter
);
93 case DBUS_TYPE_DICT_ENTRY
:
95 DBusMessageIter subiter
;
97 /* initialize a sub iterator */
98 dbus_message_iter_recurse(iter
, &subiter
);
99 /* create a new table to store the dict */
100 a_dbus_message_iter(&subiter
);
104 case DBUS_TYPE_STRUCT
:
106 DBusMessageIter subiter
;
107 /* initialize a sub iterator */
108 dbus_message_iter_recurse(iter
, &subiter
);
110 int n
= a_dbus_message_iter(&subiter
);
112 /* create a new table to store all the value */
113 lua_createtable(globalconf
.L
, n
, 0);
114 /* move the table before array elements */
115 lua_insert(globalconf
.L
, - n
- 1);
117 for(int i
= n
; i
> 0; i
--)
118 lua_rawseti(globalconf
.L
, - i
- 1, i
);
122 case DBUS_TYPE_ARRAY
:
124 int array_type
= dbus_message_iter_get_element_type(iter
);
126 if(dbus_type_is_fixed(array_type
))
129 dbus_message_iter_recurse(iter
, &sub
);
134 #define DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(type, dbustype) \
138 dbus_message_iter_get_fixed_array(&sub, &data, &datalen); \
139 lua_createtable(globalconf.L, datalen, 0); \
140 for(int i = 0; i < datalen; i++) \
142 lua_pushnumber(globalconf.L, data[i]); \
143 lua_rawseti(globalconf.L, -2, i + 1); \
147 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(int16_t, DBUS_TYPE_INT16
)
148 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(uint16_t, DBUS_TYPE_UINT16
)
149 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(int32_t, DBUS_TYPE_INT32
)
150 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(uint32_t, DBUS_TYPE_UINT32
)
151 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(int64_t, DBUS_TYPE_INT64
)
152 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(uint64_t, DBUS_TYPE_UINT64
)
153 DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER(double, DBUS_TYPE_DOUBLE
)
154 #undef DBUS_MSG_HANDLE_ARRAY_TYPE_NUMBER
158 dbus_message_iter_get_fixed_array(&sub
, &c
, &datalen
);
159 lua_pushlstring(globalconf
.L
, c
, datalen
);
162 case DBUS_TYPE_BOOLEAN
:
164 const dbus_bool_t
*b
;
165 dbus_message_iter_get_fixed_array(&sub
, &b
, &datalen
);
166 lua_createtable(globalconf
.L
, datalen
, 0);
167 for(int i
= 0; i
< datalen
; i
++)
169 lua_pushboolean(globalconf
.L
, b
[i
]);
170 lua_rawseti(globalconf
.L
, -2, i
+ 1);
176 else if(array_type
== DBUS_TYPE_DICT_ENTRY
)
178 DBusMessageIter subiter
;
179 /* initialize a sub iterator */
180 dbus_message_iter_recurse(iter
, &subiter
);
182 /* get the keys and the values
183 * n is the number of entry in dict */
184 int n
= a_dbus_message_iter(&subiter
);
186 /* create a new table to store all the value */
187 lua_createtable(globalconf
.L
, n
, 0);
188 /* move the table before array elements */
189 lua_insert(globalconf
.L
, - (n
* 2) - 1);
191 for(int i
= 0; i
< n
; i
++)
192 lua_rawset(globalconf
.L
, - (n
* 2) - 1 + i
* 2);
196 DBusMessageIter subiter
;
197 /* prepare to dig into the array*/
198 dbus_message_iter_recurse(iter
, &subiter
);
200 /* now iterate over every element of the array */
201 int n
= a_dbus_message_iter(&subiter
);
203 /* create a new table to store all the value */
204 lua_createtable(globalconf
.L
, n
, 0);
205 /* move the table before array elements */
206 lua_insert(globalconf
.L
, - n
- 1);
208 for(int i
= n
; i
> 0; i
--)
209 lua_rawseti(globalconf
.L
, - i
- 1, i
);
214 case DBUS_TYPE_BOOLEAN
:
217 dbus_message_iter_get_basic(iter
, &b
);
218 lua_pushboolean(globalconf
.L
, b
);
225 dbus_message_iter_get_basic(iter
, &c
);
226 lua_pushlstring(globalconf
.L
, &c
, 1);
230 #define DBUS_MSG_HANDLE_TYPE_NUMBER(type, dbustype) \
234 dbus_message_iter_get_basic(iter, &ui); \
235 lua_pushnumber(globalconf.L, ui); \
239 DBUS_MSG_HANDLE_TYPE_NUMBER(int16_t, DBUS_TYPE_INT16
)
240 DBUS_MSG_HANDLE_TYPE_NUMBER(uint16_t, DBUS_TYPE_UINT16
)
241 DBUS_MSG_HANDLE_TYPE_NUMBER(int32_t, DBUS_TYPE_INT32
)
242 DBUS_MSG_HANDLE_TYPE_NUMBER(uint32_t, DBUS_TYPE_UINT32
)
243 DBUS_MSG_HANDLE_TYPE_NUMBER(int64_t, DBUS_TYPE_INT64
)
244 DBUS_MSG_HANDLE_TYPE_NUMBER(uint64_t, DBUS_TYPE_UINT64
)
245 #undef DBUS_MSG_HANDLE_TYPE_NUMBER
246 case DBUS_TYPE_STRING
:
249 dbus_message_iter_get_basic(iter
, &s
);
250 lua_pushstring(globalconf
.L
, s
);
255 } while(dbus_message_iter_next(iter
));
260 /** Process a single request from D-Bus
261 * \param dbus_connection The connection to the D-Bus server.
262 * \param msg The D-Bus message request being sent to the D-Bus connection.
265 a_dbus_process_request(DBusConnection
*dbus_connection
, DBusMessage
*msg
)
267 const char *interface
= dbus_message_get_interface(msg
);
269 lua_createtable(globalconf
.L
, 0, 5);
271 switch(dbus_message_get_type(msg
))
273 case DBUS_MESSAGE_TYPE_SIGNAL
:
274 lua_pushliteral(globalconf
.L
, "signal");
276 case DBUS_MESSAGE_TYPE_METHOD_CALL
:
277 lua_pushliteral(globalconf
.L
, "method_call");
279 case DBUS_MESSAGE_TYPE_METHOD_RETURN
:
280 lua_pushliteral(globalconf
.L
, "method_return");
282 case DBUS_MESSAGE_TYPE_ERROR
:
283 lua_pushliteral(globalconf
.L
, "error");
286 lua_pushliteral(globalconf
.L
, "unknown");
290 lua_setfield(globalconf
.L
, -2, "type");
292 lua_pushstring(globalconf
.L
, NONULL(interface
));
293 lua_setfield(globalconf
.L
, -2, "interface");
295 const char *s
= dbus_message_get_path(msg
);
296 lua_pushstring(globalconf
.L
, NONULL(s
));
297 lua_setfield(globalconf
.L
, -2, "path");
299 s
= dbus_message_get_member(msg
);
300 lua_pushstring(globalconf
.L
, NONULL(s
));
301 lua_setfield(globalconf
.L
, -2, "member");
303 if(dbus_connection
== dbus_connection_system
)
304 lua_pushliteral(globalconf
.L
, "system");
306 lua_pushliteral(globalconf
.L
, "session");
307 lua_setfield(globalconf
.L
, -2, "bus");
309 /* + 1 for the table above */
310 DBusMessageIter iter
;
313 if(dbus_message_iter_init(msg
, &iter
))
314 nargs
+= a_dbus_message_iter(&iter
);
316 if(dbus_message_get_no_reply(msg
))
318 signal_object_emit(globalconf
.L
, &dbus_signals
, interface
, nargs
);
321 signal_t
*sig
= signal_array_getbyid(&dbus_signals
,
322 a_strhash((const unsigned char *) interface
));
325 /* there can be only ONE handler to send reply */
326 void *func
= (void *) sig
->sigfuncs
.tab
[0];
328 int n
= lua_gettop(globalconf
.L
) - nargs
;
330 luaA_object_push(globalconf
.L
, (void *) func
);
331 luaA_dofunction(globalconf
.L
, nargs
, LUA_MULTRET
);
333 n
-= lua_gettop(globalconf
.L
);
335 DBusMessage
*reply
= dbus_message_new_method_return(msg
);
337 dbus_message_iter_init_append(reply
, &iter
);
340 for(int i
= n
; i
< 0; i
+= 2)
342 /* i is the type name, i+1 the value */
344 const char *type
= lua_tolstring(globalconf
.L
, i
, &len
);
346 if(!type
|| len
!= 1)
348 luaA_warn(globalconf
.L
,
349 "your D-Bus signal handling method returned bad data");
355 case DBUS_TYPE_BOOLEAN
:
357 dbus_bool_t b
= lua_toboolean(globalconf
.L
, i
+ 1);
358 dbus_message_iter_append_basic(&iter
, DBUS_TYPE_BOOLEAN
, &b
);
361 #define DBUS_MSG_RETURN_HANDLE_TYPE_STRING(dbustype) \
363 if((s = lua_tostring(globalconf.L, i + 1))) \
364 dbus_message_iter_append_basic(&iter, dbustype, &s); \
366 DBUS_MSG_RETURN_HANDLE_TYPE_STRING(DBUS_TYPE_STRING
)
367 DBUS_MSG_RETURN_HANDLE_TYPE_STRING(DBUS_TYPE_BYTE
)
368 #undef DBUS_MSG_RETURN_HANDLE_TYPE_STRING
369 #define DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(type, dbustype) \
372 type num = lua_tonumber(globalconf.L, i + 1); \
373 dbus_message_iter_append_basic(&iter, dbustype, &num); \
376 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(int16_t, DBUS_TYPE_INT16
)
377 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(uint16_t, DBUS_TYPE_UINT16
)
378 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(int32_t, DBUS_TYPE_INT32
)
379 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(uint32_t, DBUS_TYPE_UINT32
)
380 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(int64_t, DBUS_TYPE_INT64
)
381 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(uint64_t, DBUS_TYPE_UINT64
)
382 DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER(double, DBUS_TYPE_DOUBLE
)
383 #undef DBUS_MSG_RETURN_HANDLE_TYPE_NUMBER
386 lua_remove(globalconf
.L
, i
);
387 lua_remove(globalconf
.L
, i
+ 1);
390 dbus_connection_send(dbus_connection
, reply
, NULL
);
391 dbus_message_unref(reply
);
396 /** Attempt to process all the requests in the D-Bus connection.
397 * \param dbus_connection The D-Bus connection to process from
398 * \param dbusio The D-Bus event watcher
401 a_dbus_process_requests_on_bus(DBusConnection
*dbus_connection
, ev_io
*dbusio
)
408 dbus_connection_read_write(dbus_connection
, 0);
410 if(!(msg
= dbus_connection_pop_message(dbus_connection
)))
413 if(dbus_message_is_signal(msg
, DBUS_INTERFACE_LOCAL
, "Disconnected"))
415 a_dbus_cleanup_bus(dbus_connection
, dbusio
);
416 dbus_message_unref(msg
);
420 a_dbus_process_request(dbus_connection
, msg
);
422 dbus_message_unref(msg
);
428 dbus_connection_flush(dbus_connection
);
431 /** Foreword D-Bus process session requests on too the correct function.
432 * \param w The D-Bus event watcher
433 * \param revents (not used)
436 a_dbus_process_requests_session(EV_P_ ev_io
*w
, int revents
)
438 a_dbus_process_requests_on_bus(dbus_connection_session
, w
);
441 /** Foreword D-Bus process system requests on too the correct function.
442 * \param w The D-Bus event watcher
443 * \param revents (not used)
446 a_dbus_process_requests_system(EV_P_ ev_io
*w
, int revents
)
448 a_dbus_process_requests_on_bus(dbus_connection_system
, w
);
451 /** Attempt to request a D-Bus name
452 * \param dbus_connection The application's connection to D-Bus
453 * \param name The D-Bus connection name to be requested
454 * \return true if the name is primary owner or the name is already
455 * the owner, otherwise false.
458 a_dbus_request_name(DBusConnection
*dbus_connection
, const char *name
)
465 dbus_error_init(&err
);
467 int ret
= dbus_bus_request_name(dbus_connection
, name
, 0, &err
);
469 if(dbus_error_is_set(&err
))
471 warn("failed to request D-Bus name: %s", err
.message
);
472 dbus_error_free(&err
);
478 case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER
:
480 case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER
:
481 warn("already primary D-Bus name owner for %s", name
);
487 /** Attempt to release the D-Bus name owner
488 * \param dbus_connection The application's connection to the D-Bus
489 * \param name The name to be released
490 * \return True on success. False if the name is not
491 * the owner, or does not exist.
494 a_dbus_release_name(DBusConnection
*dbus_connection
, const char *name
)
501 dbus_error_init(&err
);
503 int ret
= dbus_bus_release_name(dbus_connection
, name
, &err
);
505 if(dbus_error_is_set(&err
))
507 warn("failed to release D-Bus name: %s", err
.message
);
508 dbus_error_free(&err
);
514 case DBUS_RELEASE_NAME_REPLY_NOT_OWNER
:
515 warn("not primary D-Bus name owner for %s", name
);
517 case DBUS_RELEASE_NAME_REPLY_NON_EXISTENT
:
518 warn("non existent D-Bus name: %s", name
);
524 /** Attempt to create a new connection to D-Bus
525 * \param type The bus type to use when connecting to D-Bus
526 * \param type_name The bus type name eg: "session" or "system"
527 * \param dbusio The D-Bus event watcher
528 * \param cb Function callback to use when processing requests
529 * \return The requested D-Bus connection on success, NULL on failure.
531 static DBusConnection
*
532 a_dbus_connect(DBusBusType type
, const char *type_name
,
533 ev_io
*dbusio
, void *cb
)
536 DBusConnection
*dbus_connection
;
539 dbus_error_init(&err
);
541 dbus_connection
= dbus_bus_get(type
, &err
);
542 if(dbus_error_is_set(&err
))
544 warn("D-Bus session bus %s failed: %s", type_name
, err
.message
);
545 dbus_connection
= NULL
;
546 dbus_error_free(&err
);
550 dbus_connection_set_exit_on_disconnect(dbus_connection
, false);
551 if(dbus_connection_get_unix_fd(dbus_connection
, &fd
))
553 fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
555 ev_io_init(dbusio
, cb
, fd
, EV_READ
);
556 ev_io_start(EV_DEFAULT_UC_ dbusio
);
557 ev_unref(EV_DEFAULT_UC
);
561 warn("cannot get D-Bus connection file descriptor");
562 a_dbus_cleanup_bus(dbus_connection
, dbusio
);
566 return dbus_connection
;
569 /** Initialize the D-Bus session and system
574 dbus_connection_session
= a_dbus_connect(DBUS_BUS_SESSION
, "session",
575 &dbusio_ses
, a_dbus_process_requests_session
);
576 dbus_connection_system
= a_dbus_connect(DBUS_BUS_SYSTEM
, "system",
577 &dbusio_sys
, a_dbus_process_requests_system
);
580 /** Cleanup the D-Bus session and system
585 a_dbus_cleanup_bus(dbus_connection_session
, &dbusio_ses
);
586 a_dbus_cleanup_bus(dbus_connection_system
, &dbusio_sys
);
589 /** Retrieve the D-Bus bus by it's name
590 * \param name The name of the bus
591 * \param len The length of the name variable
592 * \return The corresponding D-Bus connection
594 static DBusConnection
*
595 a_dbus_bus_getbyname(const char *name
, size_t len
)
597 switch(a_tokenize(name
, len
))
600 return dbus_connection_system
;
602 return dbus_connection_session
;
608 /** Register a D-Bus name to receive message from.
609 * \param L The Lua VM state.
610 * \return The number of elements pushed on stack.
612 * \lparam A string indicating if we are using system or session bus.
613 * \lparam A string with the name of the D-Bus name to register.
614 * \lreturn True if everything worked fine, false otherwise.
617 luaA_dbus_request_name(lua_State
*L
)
620 const char *bus
= luaL_checklstring(L
, 1, &len
);
621 const char *name
= luaL_checkstring(L
, 2);
622 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
623 lua_pushboolean(L
, a_dbus_request_name(dbus_connection
, name
));
627 /** Release a D-Bus name.
628 * \param L The Lua VM state.
629 * \return The number of elements pushed on stack.
631 * \lparam A string indicating if we are using system or session bus.
632 * \lparam A string with the name of the D-Bus name to unregister.
633 * \lreturn True if everything worked fine, false otherwise.
636 luaA_dbus_release_name(lua_State
*L
)
639 const char *bus
= luaL_checklstring(L
, 1, &len
);
640 const char *name
= luaL_checkstring(L
, 2);
641 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
642 lua_pushboolean(L
, a_dbus_release_name(dbus_connection
, name
));
646 /** Add a match rule to match messages going through the message bus.
647 * \param L The Lua VM state.
648 * \return The number of elements pushed on stack.
650 * \lparam A string indicating if we are using system or session bus.
651 * \lparam A string with the name of the match rule.
654 luaA_dbus_add_match(lua_State
*L
)
657 const char *bus
= luaL_checklstring(L
, 1, &len
);
658 const char *name
= luaL_checkstring(L
, 2);
659 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
663 dbus_bus_add_match(dbus_connection
, name
, NULL
);
664 dbus_connection_flush(dbus_connection
);
670 /** Remove a previously added match rule "by value"
671 * (the most recently-added identical rule gets removed).
672 * \param L The Lua VM state.
673 * \return The number of elements pushed on stack.
675 * \lparam A string indicating if we are using system or session bus.
676 * \lparam A string with the name of the match rule.
679 luaA_dbus_remove_match(lua_State
*L
)
682 const char *bus
= luaL_checklstring(L
, 1, &len
);
683 const char *name
= luaL_checkstring(L
, 2);
684 DBusConnection
*dbus_connection
= a_dbus_bus_getbyname(bus
, len
);
688 dbus_bus_remove_match(dbus_connection
, name
, NULL
);
689 dbus_connection_flush(dbus_connection
);
695 /** Add a signal receiver on the D-Bus.
696 * \param L The Lua VM state.
697 * \return The number of elements pushed on stack.
699 * \lparam A string with the interface name.
700 * \lparam The function to call.
703 luaA_dbus_add_signal(lua_State
*L
)
705 const char *name
= luaL_checkstring(L
, 1);
706 luaA_checkfunction(L
, 2);
707 signal_t
*sig
= signal_array_getbyid(&dbus_signals
,
708 a_strhash((const unsigned char *) name
));
710 luaA_warn(L
, "cannot add signal %s on D-Bus, already existing", name
);
712 signal_add(&dbus_signals
, name
, luaA_object_ref(L
, 2));
716 /** Add a signal receiver on the D-Bus.
717 * \param L The Lua VM state.
718 * \return The number of elements pushed on stack.
720 * \lparam A string with the interface name.
721 * \lparam The function to call.
724 luaA_dbus_remove_signal(lua_State
*L
)
726 const char *name
= luaL_checkstring(L
, 1);
727 luaA_checkfunction(L
, 2);
728 const void *func
= lua_topointer(L
, 2);
729 signal_remove(&dbus_signals
, name
, func
);
730 luaA_object_unref(L
, (void *) func
);
734 const struct luaL_reg awesome_dbus_lib
[] =
736 { "request_name", luaA_dbus_request_name
},
737 { "release_name", luaA_dbus_release_name
},
738 { "add_match", luaA_dbus_add_match
},
739 { "remove_match", luaA_dbus_remove_match
},
740 { "add_signal", luaA_dbus_add_signal
},
741 { "remove_signal", luaA_dbus_remove_signal
},
745 #else /* WITH_DBUS */
747 /** Empty stub if dbus is not enabled */
753 /** Empty stub if dbus is not enabled */
760 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80