1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-server-unix.c Server implementation for Unix network protocols.
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 1.2
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "dbus-internals.h"
25 #include "dbus-server-unix.h"
26 #include "dbus-transport-unix.h"
27 #include "dbus-connection-internal.h"
28 #include <sys/types.h>
32 * @defgroup DBusServerUnix DBusServer implementations for UNIX
33 * @ingroup DBusInternals
34 * @brief Implementation details of DBusServer on UNIX
40 * Opaque object representing a Unix server implementation.
42 typedef struct DBusServerUnix DBusServerUnix;
45 * Implementation details of DBusServerUnix. All members
50 DBusServer base; /**< Parent class members. */
51 int fd; /**< File descriptor or -1 if disconnected. */
52 DBusWatch *watch; /**< File descriptor watch. */
53 char *socket_name; /**< Name of domain socket, to unlink if appropriate */
57 unix_finalize (DBusServer *server)
59 DBusServerUnix *unix_server = (DBusServerUnix*) server;
61 if (unix_server->watch)
62 _dbus_watch_unref (unix_server->watch);
64 dbus_free (unix_server->socket_name);
66 _dbus_server_finalize_base (server);
72 * @todo unreffing the connection at the end may cause
73 * us to drop the last ref to the connection before
74 * disconnecting it. That is invalid.
76 /* Return value is just for memory, not other failures. */
78 handle_new_client_fd (DBusServer *server,
81 DBusConnection *connection;
82 DBusTransport *transport;
84 _dbus_verbose ("Creating new client connection with fd %d\n", client_fd);
86 if (!_dbus_set_fd_nonblocking (client_fd, NULL))
89 transport = _dbus_transport_new_for_fd (client_fd, TRUE, NULL);
90 if (transport == NULL)
96 if (!_dbus_transport_set_auth_mechanisms (transport,
97 (const char **) server->auth_mechanisms))
99 _dbus_transport_unref (transport);
103 /* note that client_fd is now owned by the transport, and will be
104 * closed on transport disconnection/finalization
107 connection = _dbus_connection_new_for_transport (transport);
108 _dbus_transport_unref (transport);
110 if (connection == NULL)
113 /* See if someone wants to handle this new connection,
114 * self-referencing for paranoia
116 if (server->new_connection_function)
118 dbus_server_ref (server);
120 (* server->new_connection_function) (server, connection,
121 server->new_connection_data);
122 dbus_server_unref (server);
125 /* If no one grabbed a reference, the connection will die. */
126 dbus_connection_unref (connection);
132 unix_handle_watch (DBusWatch *watch,
136 DBusServer *server = data;
137 DBusServerUnix *unix_server = data;
139 _dbus_assert (watch == unix_server->watch);
141 _dbus_verbose ("Handling client connection, flags 0x%x\n", flags);
143 if (flags & DBUS_WATCH_READABLE)
148 listen_fd = dbus_watch_get_fd (watch);
150 client_fd = _dbus_accept (listen_fd);
154 /* EINTR handled for us */
156 if (errno == EAGAIN || errno == EWOULDBLOCK)
157 _dbus_verbose ("No client available to accept after all\n");
159 _dbus_verbose ("Failed to accept a client connection: %s\n",
160 _dbus_strerror (errno));
164 _dbus_fd_set_close_on_exec (client_fd);
166 if (!handle_new_client_fd (server, client_fd))
167 _dbus_verbose ("Rejected client connection due to lack of memory\n");
171 if (flags & DBUS_WATCH_ERROR)
172 _dbus_verbose ("Error on server listening socket\n");
174 if (flags & DBUS_WATCH_HANGUP)
175 _dbus_verbose ("Hangup on server listening socket\n");
181 unix_disconnect (DBusServer *server)
183 DBusServerUnix *unix_server = (DBusServerUnix*) server;
185 if (unix_server->watch)
187 _dbus_server_remove_watch (server,
189 _dbus_watch_unref (unix_server->watch);
190 unix_server->watch = NULL;
193 close (unix_server->fd);
194 unix_server->fd = -1;
196 if (unix_server->socket_name != NULL)
199 _dbus_string_init_const (&tmp, unix_server->socket_name);
200 _dbus_delete_file (&tmp, NULL);
204 static DBusServerVTable unix_vtable = {
210 * Creates a new server listening on the given file descriptor. The
211 * file descriptor should be nonblocking (use
212 * _dbus_set_fd_nonblocking() to make it so). The file descriptor
213 * should be listening for connections, that is, listen() should have
214 * been successfully invoked on it. The server will use accept() to
215 * accept new client connections.
217 * @param fd the file descriptor.
218 * @param address the server's address
219 * @returns the new server, or #NULL if no memory.
223 _dbus_server_new_for_fd (int fd,
224 const DBusString *address)
226 DBusServerUnix *unix_server;
229 unix_server = dbus_new0 (DBusServerUnix, 1);
230 if (unix_server == NULL)
233 watch = _dbus_watch_new (fd,
236 unix_handle_watch, unix_server,
240 dbus_free (unix_server);
244 if (!_dbus_server_init_base (&unix_server->base,
245 &unix_vtable, address))
247 _dbus_watch_unref (watch);
248 dbus_free (unix_server);
252 if (!_dbus_server_add_watch (&unix_server->base,
255 _dbus_server_finalize_base (&unix_server->base);
256 _dbus_watch_unref (watch);
257 dbus_free (unix_server);
261 unix_server->fd = fd;
262 unix_server->watch = watch;
264 return (DBusServer*) unix_server;
268 * Creates a new server listening on the given Unix domain socket.
270 * @param path the path for the domain socket.
271 * @param abstract #TRUE to use abstract socket namespace
272 * @param error location to store reason for failure.
273 * @returns the new server, or #NULL on failure.
276 _dbus_server_new_for_domain_socket (const char *path,
277 dbus_bool_t abstract,
281 DBusServerUnix *unix_server;
286 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
288 if (!_dbus_string_init (&address))
290 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
295 !_dbus_string_append (&address, "unix:abstract=")) ||
297 !_dbus_string_append (&address, "unix:path=")) ||
298 !_dbus_string_append (&address, path))
300 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
304 path_copy = _dbus_strdup (path);
305 if (path_copy == NULL)
307 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
311 listen_fd = _dbus_listen_unix_socket (path, abstract, error);
312 _dbus_fd_set_close_on_exec (listen_fd);
316 _DBUS_ASSERT_ERROR_IS_SET (error);
320 server = _dbus_server_new_for_fd (listen_fd, &address);
323 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
327 unix_server = (DBusServerUnix*) server;
328 unix_server->socket_name = path_copy;
330 _dbus_string_free (&address);
335 _dbus_close (listen_fd, NULL);
337 dbus_free (path_copy);
339 _dbus_string_free (&address);
345 * Creates a new server listening on the given hostname and port.
346 * If the hostname is NULL, listens on localhost.
348 * @param host the hostname to listen on.
349 * @param port the port to listen on.
350 * @param error location to store reason for failure.
351 * @returns the new server, or #NULL on failure.
354 _dbus_server_new_for_tcp_socket (const char *host,
362 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
364 if (!_dbus_string_init (&address))
366 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
370 if (!_dbus_string_append (&address, "tcp:host=") ||
371 !_dbus_string_append (&address, host) ||
372 !_dbus_string_append (&address, ",port=") ||
373 !_dbus_string_append_int (&address, port))
375 _dbus_string_free (&address);
376 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
380 listen_fd = _dbus_listen_tcp_socket (host, port, error);
381 _dbus_fd_set_close_on_exec (listen_fd);
385 _dbus_string_free (&address);
389 server = _dbus_server_new_for_fd (listen_fd, &address);
392 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
394 _dbus_string_free (&address);
398 _dbus_string_free (&address);