summaryrefslogtreecommitdiffstats
path: root/src/modules/dbus-util.c
blob: 48a45174650aaf0cc8b01d1d47234cd9b02c8fce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/* $Id$ */

/***
  This file is part of PulseAudio.

  Copyright 2006 Lennart Poettering
  Copyright 2006 Shams E. King

  PulseAudio is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2 of the License,
  or (at your option) any later version.

  PulseAudio is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with PulseAudio; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  USA.
***/

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <assert.h>
#include <pulsecore/log.h>
#include <pulsecore/props.h>
#include <pulse/xmalloc.h>
#include <pulse/timeval.h>

#include "dbus-util.h"

struct pa_dbus_connection {
    int refcount;
    pa_core *core;
    DBusConnection *connection;
    const char *property_name;
    pa_defer_event* dispatch_event;
};

static void dispatch_cb(pa_mainloop_api *ea, pa_defer_event *ev, void *userdata)
{
    DBusConnection *conn = (DBusConnection *) userdata;
    if (dbus_connection_dispatch(conn) == DBUS_DISPATCH_COMPLETE) {
        /* no more data to process, disable the deferred */
        ea->defer_enable(ev, 0);
    }
}

/* DBusDispatchStatusFunction callback for the pa mainloop */
static void dispatch_status(DBusConnection *conn, DBusDispatchStatus status,
                            void *userdata)
{
    pa_dbus_connection *c = (pa_dbus_connection*) userdata;
    switch(status) {
        case DBUS_DISPATCH_COMPLETE:
            c->core->mainloop->defer_enable(c->dispatch_event, 0);
            break;
        case DBUS_DISPATCH_DATA_REMAINS:
        case DBUS_DISPATCH_NEED_MEMORY:
        default:
            c->core->mainloop->defer_enable(c->dispatch_event, 1);
            break;
    }
}

static pa_io_event_flags_t
get_watch_flags(DBusWatch *watch)
{
    unsigned int flags = dbus_watch_get_flags(watch);
    pa_io_event_flags_t events = PA_IO_EVENT_HANGUP | PA_IO_EVENT_ERROR;

    /* no watch flags for disabled watches */
    if (!dbus_watch_get_enabled(watch))
        return PA_IO_EVENT_NULL;

    if (flags & DBUS_WATCH_READABLE)
        events |= PA_IO_EVENT_INPUT;
    if (flags & DBUS_WATCH_WRITABLE)
        events |= PA_IO_EVENT_OUTPUT;

    return events;
}

/* pa_io_event_cb_t IO event handler */
static void handle_io_event(PA_GCC_UNUSED pa_mainloop_api *ea, pa_io_event *e,
                            int fd, pa_io_event_flags_t events, void *userdata)
{
    unsigned int flags = 0;
    DBusWatch *watch = (DBusWatch*) userdata;

    assert(fd == dbus_watch_get_fd(watch));

    if (!dbus_watch_get_enabled(watch)) {
        pa_log_warn("Asked to handle disabled watch: %p %i",
                    (void *) watch, fd);
        return;
    }

    if (events & PA_IO_EVENT_INPUT)
        flags |= DBUS_WATCH_READABLE;
    if (events & PA_IO_EVENT_OUTPUT)
        flags |= DBUS_WATCH_WRITABLE;
    if (events & PA_IO_EVENT_HANGUP)
        flags |= DBUS_WATCH_HANGUP;
    if (events & PA_IO_EVENT_ERROR)
        flags |= DBUS_WATCH_ERROR;

    dbus_watch_handle(watch, flags);
}

/* pa_time_event_cb_t timer event handler */
static void handle_time_event(pa_mainloop_api *ea, pa_time_event* e,
                              const struct timeval *tv, void *userdata)
{
    DBusTimeout *timeout = (DBusTimeout*) userdata;

    if (dbus_timeout_get_enabled(timeout)) {
        struct timeval next = *tv;
        dbus_timeout_handle(timeout);

        /* restart it for the next scheduled time */
        pa_timeval_add(&next, dbus_timeout_get_interval(timeout) * 1000);
        ea->time_restart(e, &next);
    }
}

/* DBusAddWatchFunction callback for pa mainloop */
static dbus_bool_t add_watch(DBusWatch *watch, void *data)
{
    pa_io_event *ev;
    pa_core *c = (pa_core*) data;

    ev = c->mainloop->io_new(c->mainloop, dbus_watch_get_fd(watch),
                             get_watch_flags(watch),
                             handle_io_event, (void*) watch);
    if (NULL == ev)
        return FALSE;

    /* dbus_watch_set_data(watch, (void*) ev, c->mainloop->io_free); */
    dbus_watch_set_data(watch, (void*) ev, NULL);

    return TRUE;
}

/* DBusRemoveWatchFunction callback for pa mainloop */
static void remove_watch(DBusWatch *watch, void *data)
{
    pa_core *c = (pa_core*) data;
    pa_io_event *ev = (pa_io_event*) dbus_watch_get_data(watch);

    /* free the event */
    if (NULL != ev)
        c->mainloop->io_free(ev);
}

/* DBusWatchToggledFunction callback for pa mainloop */
static void toggle_watch(DBusWatch *watch, void *data)
{
    pa_core *c = (pa_core*) data;
    pa_io_event *ev = (pa_io_event*) dbus_watch_get_data(watch);

    /* get_watch_flags() checks if the watch is enabled */
    c->mainloop->io_enable(ev, get_watch_flags(watch));
}

/* DBusAddTimeoutFunction callback for pa mainloop */
static dbus_bool_t add_timeout(DBusTimeout *timeout, void *data)
{
    struct timeval tv;
    pa_time_event *ev;
    pa_core *c = (pa_core*) data;

    if (!dbus_timeout_get_enabled(timeout))
        return FALSE;

    if (!pa_gettimeofday(&tv))
        return -1;

    pa_timeval_add(&tv, dbus_timeout_get_interval(timeout) * 1000);

    ev = c->mainloop->time_new(c->mainloop, &tv, handle_time_event,
                               (void*) timeout);
    if (NULL == ev)
        return FALSE;

    /* dbus_timeout_set_data(timeout, (void*) ev, c->mainloop->time_free); */
    dbus_timeout_set_data(timeout, (void*) ev, NULL);

    return TRUE;
}

/* DBusRemoveTimeoutFunction callback for pa mainloop */
static void remove_timeout(DBusTimeout *timeout, void *data)
{
    pa_core *c = (pa_core*) data;
    pa_time_event *ev = (pa_time_event*) dbus_timeout_get_data(timeout);

    /* free the event */
    if (NULL != ev)
        c->mainloop->time_free(ev);
}

/* DBusTimeoutToggledFunction callback for pa mainloop */
static void toggle_timeout(DBusTimeout *timeout, void *data)
{
    struct timeval tv;
    pa_core *c = (pa_core*) data;
    pa_time_event *ev = (pa_time_event*) dbus_timeout_get_data(timeout);

    if (dbus_timeout_get_enabled(timeout)) {
        pa_gettimeofday(&tv);
        pa_timeval_add(&tv, dbus_timeout_get_interval(timeout) * 1000);
        c->mainloop->time_restart(ev, &tv);
    } else {
        /* disable the timeout */
        c->mainloop->time_restart(ev, NULL);
    }
}

static void
pa_dbus_connection_free(pa_dbus_connection *c)
{
    assert(c);
    assert(!dbus_connection_get_is_connected(c->connection));

    /* already disconnected, just free */
    pa_property_remove(c->core, c->property_name);
    c->core->mainloop->defer_free(c->dispatch_event);
    dbus_connection_unref(c->connection);
    pa_xfree(c);
}

static void
wakeup_main(void *userdata)
{
    pa_dbus_connection *c = (pa_dbus_connection*) userdata;
    /* this will wakeup the mainloop and dispatch events, although
     * it may not be the cleanest way of accomplishing it */
    c->core->mainloop->defer_enable(c->dispatch_event, 1);
}

static pa_dbus_connection* pa_dbus_connection_new(pa_core* c, DBusConnection *conn, const char* name)
{
    pa_dbus_connection *pconn = pa_xnew(pa_dbus_connection, 1);

    pconn->refcount = 1;
    pconn->core = c;
    pconn->property_name = name;
    pconn->connection = conn;
    pconn->dispatch_event = c->mainloop->defer_new(c->mainloop, dispatch_cb,
                                                   (void*) conn);

    pa_property_set(c, name, pconn);

    return pconn;
}

DBusConnection* pa_dbus_connection_get(pa_dbus_connection *c)
{
    assert(c && c->connection);
    return c->connection;
}

void pa_dbus_connection_unref(pa_dbus_connection *c)
{
    assert(c);

    /* non-zero refcount, still outstanding refs */
    if (--(c->refcount))
        return;

    /* refcount is zero */
    if (dbus_connection_get_is_connected(c->connection)) {
        /* disconnect as we have no more internal references */
        dbus_connection_close(c->connection);
        /* must process remaining messages, bit of a kludge to
         * handle both unload and shutdown */
        while(dbus_connection_read_write_dispatch(c->connection, -1));
    }
    pa_dbus_connection_free(c);
}

pa_dbus_connection* pa_dbus_connection_ref(pa_dbus_connection *c)
{
    assert(c);

    ++(c->refcount);

    return c;
}

pa_dbus_connection* pa_dbus_bus_get(pa_core *c, DBusBusType type,
                                    DBusError *error)
{
    const char* name;
    DBusConnection *conn;
    pa_dbus_connection *pconn;

    switch (type) {
        case DBUS_BUS_SYSTEM:
            name = "dbus-connection-system";
            break;
        case DBUS_BUS_SESSION:
            name = "dbus-connection-session";
            break;
        case DBUS_BUS_STARTER:
            name = "dbus-connection-starter";
            break;
        default:
            assert(0); /* never reached */
            break;
    }

    if ((pconn = pa_property_get(c, name)))
        return pa_dbus_connection_ref(pconn);

    /* else */
    conn = dbus_bus_get_private(type, error);
    if (conn == NULL || dbus_error_is_set(error)) {
        return NULL;
    }

    pconn = pa_dbus_connection_new(c, conn, name);

    /* don't exit on disconnect */
    dbus_connection_set_exit_on_disconnect(conn, FALSE);
    /* set up the DBUS call backs */
    dbus_connection_set_dispatch_status_function(conn, dispatch_status,
                                                 (void*) pconn, NULL);
    dbus_connection_set_watch_functions(conn,
                                        add_watch,
                                        remove_watch,
                                        toggle_watch,
                                        (void*) c, NULL);
    dbus_connection_set_timeout_functions(conn,
                                          add_timeout,
                                          remove_timeout,
                                          toggle_timeout,
                                          (void*) c, NULL);
    dbus_connection_set_wakeup_main_function(conn, wakeup_main, pconn, NULL);

    return pconn;
}