← Back to branch summary

~ubuntu-branches/ubuntu/trusty/geis/trusty

« back to all changes in this revision

Viewing changes to libgeis/backend/dbus/geis_dbus_locator.c

  • Committer: Package Import Robot
  • Author(s): Chase Douglas
  • Date: 2012-07-30 08:51:42 UTC
  • Revision ID: package-import@ubuntu.com-20120730085142-jrc33ygjvt0ob1wl
Tags: upstream-2.2.11
Import upstream version 2.2.11

Show diffs side-by-side

added added

removed removed

Lines of Context:
libgeis/backend/dbus/geis_dbus_locator.c
 
1
/**
 
2
 * @file geis_dbus_locator.c
 
3
 * @brief Implementation of the GEIS DBus locator.
 
4
 */
 
5
 
 
6
/*
 
7
 * Copyright 2011 Canonical Ltd.
 
8
 *
 
9
 * This library is free software; you can redistribute it and/or modify it under
 
10
 * the terms of the GNU Lesser General Public License as published by the Free
 
11
 * Software Foundation; either version 3 of the License, or (at your option) any
 
12
 * later version.
 
13
 *
 
14
 * This library is distributed in the hope that it will be useful, but WITHOUT
 
15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 
16
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 
17
 * details.
 
18
 *
 
19
 * You should have received a copy of the GNU General Public License
 
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
 */
 
22
#include "geis_config.h"
 
23
#include "geis_dbus_locator.h"
 
24
 
 
25
#include <dbus/dbus.h>
 
26
#include "geis_dbus.h"
 
27
#include "geis_logging.h"
 
28
#include <stdio.h>
 
29
#include <stdlib.h>
 
30
#include <string.h>
 
31
 
 
32
 
 
33
typedef enum GeisDBusLocatorState
 
34
{
 
35
  GEIS_DBUS_LOCATOR_STATE_INITIALIZING,
 
36
  GEIS_DBUS_LOCATOR_STATE_LOCATING,
 
37
  GEIS_DBUS_LOCATOR_STATE_WAITING,
 
38
  GEIS_DBUS_LOCATOR_STATE_FINALIZING
 
39
} GeisDBusLocatorState;
 
40
 
 
41
 
 
42
struct GeisDBusLocator 
 
43
{
 
44
  GeisDBusClient        client;
 
45
  GeisDBusLocatorState  state;
 
46
  DBusConnection       *session_bus;
 
47
  char                 *server_address;
 
48
  dbus_uint32_t         serial;
 
49
};
 
50
 
 
51
 
 
52
/*
 
53
 * Performs the act of actually locating the server.
 
54
 */
 
55
static void
 
56
_locator_find_server(GeisDBusLocator locator)
 
57
{
 
58
  locator->state = GEIS_DBUS_LOCATOR_STATE_LOCATING;
 
59
  DBusMessage *msg = dbus_message_new_method_call(GEIS_DBUS_SERVICE_INTERFACE,
 
60
                                                  GEIS_DBUS_SERVICE_PATH,
 
61
                                                  GEIS_DBUS_SERVICE_INTERFACE,
 
62
                                                  GEIS_DBUS_GET_SERVER_ADDRESS);
 
63
  dbus_connection_send(locator->session_bus, msg, &locator->serial);
 
64
  dbus_message_unref(msg);
 
65
}
 
66
 
 
67
 
 
68
/*
 
69
 * A generic message handler function.
 
70
 */
 
71
static DBusHandlerResult
 
72
_locator_message_handler(DBusConnection *connection GEIS_UNUSED,
 
73
                         DBusMessage    *message,
 
74
                         void           *user_data)
 
75
{
 
76
  DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 
77
  GeisDBusLocator locator = (GeisDBusLocator)user_data;
 
78
  int type = dbus_message_get_type(message);
 
79
 
 
80
  if (dbus_message_is_signal(message, DBUS_INTERFACE_DBUS, "NameOwnerChanged"))
 
81
  {
 
82
    char *name;
 
83
    char *old_owner;
 
84
    char *new_owner;
 
85
    dbus_message_get_args(message, NULL,
 
86
                          DBUS_TYPE_STRING, &name,
 
87
                          DBUS_TYPE_STRING, &old_owner,
 
88
                          DBUS_TYPE_STRING, &new_owner,
 
89
                          DBUS_TYPE_INVALID);
 
90
    if (strlen(old_owner))
 
91
    {
 
92
      geis_debug("%s has gone away", name);
 
93
      geis_dbus_client_server_dislocated(locator->client);
 
94
      result = DBUS_HANDLER_RESULT_HANDLED;
 
95
    }
 
96
    else if (strlen(new_owner))
 
97
    {
 
98
      geis_debug("%s has appeared", name);
 
99
      _locator_find_server(locator);
 
100
      result = DBUS_HANDLER_RESULT_HANDLED;
 
101
    }
 
102
  }
 
103
  else if (type == DBUS_MESSAGE_TYPE_METHOD_RETURN)
 
104
  {
 
105
    if (locator->serial == dbus_message_get_reply_serial(message))
 
106
    {
 
107
      const char *s = NULL;
 
108
      dbus_message_get_args(message, NULL,
 
109
                            DBUS_TYPE_STRING, &s,
 
110
                            DBUS_TYPE_INVALID);
 
111
      locator->server_address = strdup(s);
 
112
      geis_dbus_client_server_located(locator->client);
 
113
      result = DBUS_HANDLER_RESULT_HANDLED;
 
114
    }
 
115
  }
 
116
  else if (type == DBUS_MESSAGE_TYPE_ERROR)
 
117
  {
 
118
    if (dbus_message_is_error(message, DBUS_ERROR_SERVICE_UNKNOWN))
 
119
    {
 
120
      geis_warning("server not found!");
 
121
      geis_dbus_client_server_dislocated(locator->client);
 
122
      result = DBUS_HANDLER_RESULT_HANDLED;
 
123
    }
 
124
    else
 
125
    {
 
126
      const char *str = NULL;
 
127
      dbus_message_get_args(message, NULL,
 
128
                            DBUS_TYPE_STRING, &str,
 
129
                            DBUS_TYPE_INVALID);
 
130
      geis_warning("error %s: %s", dbus_message_get_error_name(message), str);
 
131
    }
 
132
  }
 
133
 
 
134
  return result;
 
135
}
 
136
 
 
137
 
 
138
/*
 
139
 * Adds the locator watches to the dispatcher watch list.
 
140
 */
 
141
static dbus_bool_t
 
142
_locator_add_watch(DBusWatch *watch, void *data)
 
143
{
 
144
  dbus_bool_t status = TRUE;
 
145
  GeisDBusLocator locator = (GeisDBusLocator)data;
 
146
  GeisDBusDispatcher dispatcher = geis_dbus_client_dispatcher(locator->client);
 
147
 
 
148
  geis_dbus_dispatcher_register(dispatcher, locator->session_bus, watch);
 
149
  return status;
 
150
}
 
151
 
 
152
 
 
153
/*
 
154
 * Toggles the enabled/disabled status of the locator watches.
 
155
 */
 
156
static void
 
157
_locator_toggle_watch(DBusWatch *watch, void *data)
 
158
{
 
159
  GeisDBusLocator locator = (GeisDBusLocator)data;
 
160
  GeisDBusDispatcher dispatcher = geis_dbus_client_dispatcher(locator->client);
 
161
 
 
162
  geis_dbus_dispatcher_toggle_watch(dispatcher, watch);
 
163
}
 
164
 
 
165
 
 
166
/*
 
167
 * Removes the locator watches from the dispatcher watch list.
 
168
 */
 
169
static void
 
170
_locator_remove_watch(DBusWatch *watch, void *data)
 
171
{
 
172
  GeisDBusLocator locator = (GeisDBusLocator)data;
 
173
  GeisDBusDispatcher dispatcher = geis_dbus_client_dispatcher(locator->client);
 
174
 
 
175
  geis_dbus_dispatcher_unregister(dispatcher, watch);
 
176
}
 
177
 
 
178
 
 
179
/*
 
180
 * Creates a new GeisDBusLocator object.
 
181
 */
 
182
GeisDBusLocator
 
183
geis_dbus_locator_new(GeisDBusClient client)
 
184
{
 
185
  GeisDBusLocator locator = NULL;
 
186
 
 
187
  /* Fail to locate Geis on the DBus if there is no DBus session. */
 
188
  if (NULL == getenv("DBUS_SESSION_BUS_ADDRESS"))
 
189
  {
 
190
    goto final_exit;
 
191
  }
 
192
 
 
193
  locator = calloc(1, sizeof(struct GeisDBusLocator));
 
194
  if (!locator)
 
195
  {
 
196
    goto final_exit;
 
197
  }
 
198
 
 
199
  locator->client = client;
 
200
  locator->state = GEIS_DBUS_LOCATOR_STATE_INITIALIZING;
 
201
 
 
202
  /* Connect to the DBus session bus. */
 
203
  DBusError error = DBUS_ERROR_INIT;
 
204
  locator->session_bus = dbus_bus_get(DBUS_BUS_SESSION, &error);
 
205
  if (!locator->session_bus || dbus_error_is_set(&error))
 
206
  {
 
207
    char msg[512];
 
208
    snprintf(msg, sizeof(msg), "error %s connecting to session bus: %s",
 
209
            error.name, error.message);
 
210
    geis_error("%s", msg);
 
211
    goto unwind_error;
 
212
  }
 
213
 
 
214
  /* Integrate with the app event loop via the GEIS multiplexor. */
 
215
  dbus_connection_set_watch_functions(locator->session_bus,
 
216
                                      _locator_add_watch,
 
217
                                      _locator_remove_watch,
 
218
                                      _locator_toggle_watch,
 
219
                                      locator, 0);
 
220
 
 
221
  /* Look for server-connect and server-disconnect messages. */
 
222
  dbus_bus_add_match(locator->session_bus,
 
223
                     "type='signal',sender='" DBUS_SERVICE_DBUS "'," \
 
224
                     "interface='" DBUS_INTERFACE_DBUS "'," \
 
225
                     "member='NameOwnerChanged'," \
 
226
                     "arg0='" GEIS_DBUS_SERVICE_INTERFACE "'",
 
227
                     &error);
 
228
  if (dbus_error_is_set(&error))
 
229
  {
 
230
    char msg[512];
 
231
    snprintf(msg, sizeof(msg), "error %s adding match to session bus: %s",
 
232
            error.name, error.message);
 
233
    geis_error("%s", msg);
 
234
    goto unwind_error;
 
235
  }
 
236
 
 
237
  /* Install a handler for any and all messages. */
 
238
  dbus_connection_add_filter(locator->session_bus,
 
239
                             _locator_message_handler,
 
240
                             locator, 0);
 
241
 
 
242
  /* OK, go eh? */
 
243
  _locator_find_server(locator);
 
244
 
 
245
unwind_error:
 
246
  dbus_error_free(&error);
 
247
final_exit:
 
248
  return locator;
 
249
}
 
250
 
 
251
 
 
252
/*
 
253
 * Destroys a %GeisDBusLocator object.
 
254
 */
 
255
void
 
256
geis_dbus_locator_delete(GeisDBusLocator locator)
 
257
{
 
258
  if (locator)
 
259
  {
 
260
    if (locator->server_address)
 
261
    {
 
262
      free(locator->server_address);
 
263
    }
 
264
    if (locator->session_bus)
 
265
    {
 
266
      dbus_connection_set_watch_functions(locator->session_bus,
 
267
                                          NULL,
 
268
                                          NULL,
 
269
                                          NULL,
 
270
                                          NULL, 0);
 
271
      dbus_connection_remove_filter(locator->session_bus,
 
272
                                    _locator_message_handler,
 
273
                                    locator);
 
274
      dbus_connection_unref(locator->session_bus);
 
275
    }
 
276
    free(locator);
 
277
  }
 
278
}
 
279
 
 
280
 
 
281
char *
 
282
geis_dbus_locator_server_address(GeisDBusLocator locator)
 
283
{
 
284
  return locator->server_address;
 
285
}
 
286