summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-server-debug.c
blob: 513e1df2662e82b8740ff2d10768655bd16eea4a (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
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-server-debug.h In-proc debug server implementation 
 *
 * Copyright (C) 2003  CodeFactory AB
 *
 * Licensed under the Academic Free License version 1.2
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include "dbus-internals.h"
#include "dbus-server-debug.h"
#include "dbus-transport-debug.h"
#include "dbus-connection-internal.h"
#include "dbus-hash.h"

#ifdef DBUS_BUILD_TESTS

/**
 * @defgroup DBusServerDebug DBusServerDebug
 * @ingroup  DBusInternals
 * @brief In-process debug server used in unit tests.
 *
 * Types and functions related to DBusServerDebug.
 * This is used for unit testing.
 *
 * @{
 */

/**
 * Default timeout interval when reading or writing.
 */
#define DEFAULT_INTERVAL 1

/**
 * Opaque object representing a debug server implementation.
 */
typedef struct DBusServerDebug DBusServerDebug;

/**
 * Implementation details of DBusServerDebug. All members
 * are private.
 */
struct DBusServerDebug
{
  DBusServer base;  /**< Parent class members. */

  char *name; /**< Server name. */
};

/* Not thread safe, but OK since we don't use
 * threads in the bus
 */
static DBusHashTable *server_hash;

static void
debug_finalize (DBusServer *server)
{
}

static dbus_bool_t
debug_handle_watch (DBusServer  *server,
		    DBusWatch   *watch,
		    unsigned int flags)
{
  return TRUE;
}

static void
debug_disconnect (DBusServer *server)
{
}

static DBusServerVTable debug_vtable = {
  debug_finalize,
  debug_handle_watch,
  debug_disconnect
};

/**
 * Looks up a server by its name.
 *
 * @param server_name the server name.
 * @returns the server, or #NULL if none exists.
 */
DBusServer*
_dbus_server_debug_lookup (const char *server_name)
{
  if (!server_hash)
    return NULL;

  return _dbus_hash_table_lookup_string (server_hash, server_name);
}

/**
 * Creates a new debug server.
 *
 * @param server_name the name of the server.
 * @param error address where an error can be returned.
 * @returns a new server, or #NULL on failure.
 */
DBusServer*
_dbus_server_debug_new (const char     *server_name,
                        DBusError      *error)
{
  DBusServerDebug *debug_server;
  DBusString address;
  
  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
  
  if (!server_hash)
    {
      server_hash = _dbus_hash_table_new (DBUS_HASH_STRING, NULL, NULL);

      if (!server_hash)
	{
	  dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
	  return NULL;
	}
    }

  if (_dbus_hash_table_lookup_string (server_hash, server_name) != NULL)
    {
      dbus_set_error (error, DBUS_ERROR_ADDRESS_IN_USE,
                      NULL);
      return NULL;
    }
  
  debug_server = dbus_new0 (DBusServerDebug, 1);

  if (debug_server == NULL)
    return NULL;

  if (!_dbus_string_init (&address))
    goto nomem_0;

  if (!_dbus_string_append (&address, "debug:name=") ||
      !_dbus_string_append (&address, server_name))
    goto nomem_1;
  
  debug_server->name = _dbus_strdup (server_name);
  if (debug_server->name == NULL)
    goto nomem_1;
  
  if (!_dbus_server_init_base (&debug_server->base,
			       &debug_vtable,
                               &address))
    goto nomem_2;

  if (!_dbus_hash_table_insert_string (server_hash,
				       debug_server->name,
				       debug_server))
    goto nomem_3;

  _dbus_string_free (&address);
  
  return (DBusServer *)debug_server;

 nomem_3:
  _dbus_server_finalize_base (&debug_server->base);
 nomem_2:
  dbus_free (debug_server->name);
 nomem_1:
  _dbus_string_free (&address);
 nomem_0:
  dbus_free (debug_server);

  dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
  
  return NULL;
}

typedef struct
{
  DBusServer *server;
  DBusTransport *transport;
  DBusTimeout *timeout;
} ServerAndTransport;

static dbus_bool_t
handle_new_client (void *data)
{
  ServerAndTransport *st = data;
  DBusTransport *transport;
  DBusConnection *connection;

  _dbus_verbose ("  new debug client transport %p connecting to server\n",
                 st->transport);
  
  transport = _dbus_transport_debug_server_new (st->transport);
  if (transport == NULL)
    return FALSE;

  connection = _dbus_connection_new_for_transport (transport);
  _dbus_transport_unref (transport);

  if (connection == NULL)
    return FALSE;

  /* See if someone wants to handle this new connection,
   * self-referencing for paranoia
   */
  if (st->server->new_connection_function)
    {
      dbus_server_ref (st->server);
      
      (* st->server->new_connection_function) (st->server, connection,
					       st->server->new_connection_data);
      dbus_server_unref (st->server);
    }

  _dbus_server_remove_timeout (st->server, st->timeout);
  
  /* If no one grabbed a reference, the connection will die. */
  dbus_connection_unref (connection);

  /* killing timeout frees both "st" and "timeout" */
  _dbus_timeout_unref (st->timeout);

  return TRUE;
}

/**
 * Tells the server to accept a transport so the transport
 * can send messages to it.
 *
 * @param server the server
 * @param transport the transport
 * @returns #TRUE on success.
 */
dbus_bool_t
_dbus_server_debug_accept_transport (DBusServer     *server,
				     DBusTransport  *transport)
{
  ServerAndTransport *st = NULL;

  st = dbus_new (ServerAndTransport, 1);
  if (st == NULL)
    return FALSE;

  st->transport = transport;
  st->server = server;
  
  st->timeout = _dbus_timeout_new (DEFAULT_INTERVAL, handle_new_client, st,
                                   dbus_free);

  if (st->timeout == NULL)
    goto failed;

  if (!_dbus_server_add_timeout (server, st->timeout))
    goto failed;
  
  return TRUE;

 failed:
  if (st->timeout)
    _dbus_timeout_unref (st->timeout);
  dbus_free (st);
  return FALSE;
}

/** @} */

#endif /* DBUS_BUILD_TESTS */