1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-server.c DBusServer object
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-server.h"
25 #include "dbus-server-unix.h"
26 #ifdef DBUS_BUILD_TESTS
27 #include "dbus-server-debug.h"
28 #include "dbus-server-debug-pipe.h"
30 #include "dbus-address.h"
33 * @defgroup DBusServer DBusServer
35 * @brief Server that listens for new connections.
37 * Types and functions related to DBusServer.
38 * A DBusServer represents a server that other applications
39 * can connect to. Each connection from another application
40 * is represented by a DBusConnection.
42 * @todo Thread safety hasn't been looked at for #DBusServer
43 * @todo Need notification to apps of disconnection, may matter for some transports
47 * @defgroup DBusServerInternals DBusServer implementation details
48 * @ingroup DBusInternals
49 * @brief Implementation details of DBusServer
55 * Initializes the members of the DBusServer base class.
56 * Chained up to by subclass constructors.
58 * @param server the server.
59 * @param vtable the vtable for the subclass.
60 * @param address the server's address
61 * @returns #TRUE on success.
64 _dbus_server_init_base (DBusServer *server,
65 const DBusServerVTable *vtable,
66 const DBusString *address)
68 server->vtable = vtable;
71 server->address = NULL;
72 server->watches = NULL;
73 server->timeouts = NULL;
75 if (!_dbus_string_copy_data (address, &server->address))
78 server->watches = _dbus_watch_list_new ();
79 if (server->watches == NULL)
82 server->timeouts = _dbus_timeout_list_new ();
83 if (server->timeouts == NULL)
86 _dbus_data_slot_list_init (&server->slot_list);
88 _dbus_verbose ("Initialized server on address %s\n", server->address);
95 _dbus_watch_list_free (server->watches);
96 server->watches = NULL;
100 _dbus_timeout_list_free (server->timeouts);
101 server->timeouts = NULL;
105 dbus_free (server->address);
106 server->address = NULL;
113 * Finalizes the members of the DBusServer base class.
114 * Chained up to by subclass finalizers.
116 * @param server the server.
119 _dbus_server_finalize_base (DBusServer *server)
121 /* calls out to application code... */
122 _dbus_data_slot_list_free (&server->slot_list);
124 dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
126 if (!server->disconnected)
127 dbus_server_disconnect (server);
129 _dbus_watch_list_free (server->watches);
130 _dbus_timeout_list_free (server->timeouts);
132 dbus_free (server->address);
134 dbus_free_string_array (server->auth_mechanisms);
138 * Adds a watch for this server, chaining out to application-provided
141 * @param server the server.
142 * @param watch the watch to add.
145 _dbus_server_add_watch (DBusServer *server,
148 return _dbus_watch_list_add_watch (server->watches, watch);
152 * Removes a watch previously added with _dbus_server_remove_watch().
154 * @param server the server.
155 * @param watch the watch to remove.
158 _dbus_server_remove_watch (DBusServer *server,
161 _dbus_watch_list_remove_watch (server->watches, watch);
165 * Toggles a watch and notifies app via server's
166 * DBusWatchToggledFunction if available. It's an error to call this
167 * function on a watch that was not previously added.
169 * @param server the server.
170 * @param watch the watch to toggle.
171 * @param enabled whether to enable or disable
174 _dbus_server_toggle_watch (DBusServer *server,
178 if (server->watches) /* null during finalize */
179 _dbus_watch_list_toggle_watch (server->watches,
184 * Adds a timeout for this server, chaining out to
185 * application-provided timeout handlers. The timeout should be
186 * repeatedly handled with dbus_timeout_handle() at its given interval
187 * until it is removed.
189 * @param server the server.
190 * @param timeout the timeout to add.
193 _dbus_server_add_timeout (DBusServer *server,
194 DBusTimeout *timeout)
196 return _dbus_timeout_list_add_timeout (server->timeouts, timeout);
200 * Removes a timeout previously added with _dbus_server_add_timeout().
202 * @param server the server.
203 * @param timeout the timeout to remove.
206 _dbus_server_remove_timeout (DBusServer *server,
207 DBusTimeout *timeout)
209 _dbus_timeout_list_remove_timeout (server->timeouts, timeout);
213 * Toggles a timeout and notifies app via server's
214 * DBusTimeoutToggledFunction if available. It's an error to call this
215 * function on a timeout that was not previously added.
217 * @param server the server.
218 * @param timeout the timeout to toggle.
219 * @param enabled whether to enable or disable
222 _dbus_server_toggle_timeout (DBusServer *server,
223 DBusTimeout *timeout,
226 if (server->timeouts) /* null during finalize */
227 _dbus_timeout_list_toggle_timeout (server->timeouts,
235 * @addtogroup DBusServer
242 * @typedef DBusServer
244 * An opaque object representing a server that listens for
245 * connections from other applications. Each time a connection
246 * is made, a new DBusConnection is created and made available
247 * via an application-provided DBusNewConnectionFunction.
248 * The DBusNewConnectionFunction is provided with
249 * dbus_server_set_new_connection_function().
254 * Listens for new connections on the given address.
255 * Returns #NULL if listening fails for any reason.
256 * Otherwise returns a new #DBusServer.
257 * dbus_server_set_new_connection_function() and
258 * dbus_server_set_watch_functions() should be called
259 * immediately to render the server fully functional.
261 * @todo error messages on bad address could really be better.
262 * DBusResultCode is a bit limiting here.
264 * @param address the address of this server.
265 * @param error location to store rationale for failure.
266 * @returns a new DBusServer, or #NULL on failure.
270 dbus_server_listen (const char *address,
274 DBusAddressEntry **entries;
276 const char *address_problem_type;
277 const char *address_problem_field;
278 const char *address_problem_other;
280 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
282 if (!dbus_parse_address (address, &entries, &len, error))
286 address_problem_type = NULL;
287 address_problem_field = NULL;
288 address_problem_other = NULL;
290 for (i = 0; i < len; i++)
292 const char *method = dbus_address_entry_get_method (entries[i]);
294 if (strcmp (method, "unix") == 0)
296 const char *path = dbus_address_entry_get_value (entries[i], "path");
297 const char *tmpdir = dbus_address_entry_get_value (entries[i], "tmpdir");
299 if (path == NULL && tmpdir == NULL)
301 address_problem_type = "unix";
302 address_problem_field = "path or tmpdir";
308 address_problem_other = "cannot specify both \"path\" and \"tmpdir\" at the same time";
314 DBusString full_path;
317 if (!_dbus_string_init (&full_path))
319 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
323 if (!_dbus_string_init (&filename))
325 _dbus_string_free (&full_path);
326 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
330 if (!_dbus_string_append (&filename,
332 !_dbus_generate_random_ascii (&filename, 10) ||
333 !_dbus_string_append (&full_path, tmpdir) ||
334 !_dbus_concat_dir_and_file (&full_path, &filename))
336 _dbus_string_free (&full_path);
337 _dbus_string_free (&filename);
338 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
342 /* FIXME - we will unconditionally unlink() the path.
343 * unlink() does not follow symlinks, but would like
344 * independent confirmation this is safe enough. See
345 * also _dbus_listen_unix_socket() and comments therein.
349 _dbus_server_new_for_domain_socket (_dbus_string_get_const_data (&full_path),
352 _dbus_string_free (&full_path);
353 _dbus_string_free (&filename);
357 server = _dbus_server_new_for_domain_socket (path, error);
360 else if (strcmp (method, "tcp") == 0)
362 const char *host = dbus_address_entry_get_value (entries[i], "host");
363 const char *port = dbus_address_entry_get_value (entries[i], "port");
370 address_problem_type = "tcp";
371 address_problem_field = "port";
375 _dbus_string_init_const (&str, port);
376 sresult = _dbus_string_parse_int (&str, 0, &lport, NULL);
377 _dbus_string_free (&str);
379 if (sresult == FALSE || lport <= 0 || lport > 65535)
381 address_problem_other = "Port is not an integer between 0 and 65535";
385 server = _dbus_server_new_for_tcp_socket (host, lport, error);
390 #ifdef DBUS_BUILD_TESTS
391 else if (strcmp (method, "debug") == 0)
393 const char *name = dbus_address_entry_get_value (entries[i], "name");
397 address_problem_type = "debug";
398 address_problem_field = "name";
402 server = _dbus_server_debug_new (name, error);
404 else if (strcmp (method, "debug-pipe") == 0)
406 const char *name = dbus_address_entry_get_value (entries[i], "name");
410 address_problem_type = "debug-pipe";
411 address_problem_field = "name";
415 server = _dbus_server_debug_pipe_new (name, error);
420 address_problem_other = "Unknown address type (examples of valid types are \"unix\" and \"tcp\")";
430 dbus_address_entries_free (entries);
434 dbus_address_entries_free (entries);
435 if (address_problem_type != NULL)
436 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
437 "Server address of type %s was missing argument %s",
438 address_problem_type, address_problem_field);
440 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
441 "Could not parse server address: %s",
442 address_problem_other);
448 * Increments the reference count of a DBusServer.
450 * @param server the server.
453 dbus_server_ref (DBusServer *server)
455 server->refcount += 1;
459 * Decrements the reference count of a DBusServer. Finalizes the
460 * server if the reference count reaches zero. The server connection
461 * will be closed as with dbus_server_disconnect() when the server is
464 * @param server the server.
467 dbus_server_unref (DBusServer *server)
469 _dbus_assert (server != NULL);
470 _dbus_assert (server->refcount > 0);
472 server->refcount -= 1;
473 if (server->refcount == 0)
475 _dbus_assert (server->vtable->finalize != NULL);
477 (* server->vtable->finalize) (server);
482 * Releases the server's address and stops listening for
483 * new clients. If called more than once, only the first
484 * call has an effect. Does not modify the server's
487 * @param server the server.
490 dbus_server_disconnect (DBusServer *server)
492 _dbus_assert (server->vtable->disconnect != NULL);
494 if (server->disconnected)
497 (* server->vtable->disconnect) (server);
498 server->disconnected = TRUE;
502 * Returns #TRUE if the server is still listening for new connections.
504 * @param server the server.
507 dbus_server_get_is_connected (DBusServer *server)
509 return !server->disconnected;
513 * Returns the address of the server, as a newly-allocated
514 * string which must be freed by the caller.
516 * @param server the server
517 * @returns the address or #NULL if no memory
520 dbus_server_get_address (DBusServer *server)
522 return _dbus_strdup (server->address);
526 * Sets a function to be used for handling new connections. The given
527 * function is passed each new connection as the connection is
528 * created. If the new connection function increments the connection's
529 * reference count, the connection will stay alive. Otherwise, the
530 * connection will be unreferenced and closed.
532 * @param server the server.
533 * @param function a function to handle new connections.
534 * @param data data to pass to the new connection handler.
535 * @param free_data_function function to free the data.
538 dbus_server_set_new_connection_function (DBusServer *server,
539 DBusNewConnectionFunction function,
541 DBusFreeFunction free_data_function)
543 if (server->new_connection_free_data_function != NULL)
544 (* server->new_connection_free_data_function) (server->new_connection_data);
546 server->new_connection_function = function;
547 server->new_connection_data = data;
548 server->new_connection_free_data_function = free_data_function;
552 * Sets the watch functions for the connection. These functions are
553 * responsible for making the application's main loop aware of file
554 * descriptors that need to be monitored for events.
556 * This function behaves exactly like dbus_connection_set_watch_functions();
557 * see the documentation for that routine.
559 * @param server the server.
560 * @param add_function function to begin monitoring a new descriptor.
561 * @param remove_function function to stop monitoring a descriptor.
562 * @param toggled_function function to notify when the watch is enabled/disabled
563 * @param data data to pass to add_function and remove_function.
564 * @param free_data_function function to be called to free the data.
565 * @returns #FALSE on failure (no memory)
568 dbus_server_set_watch_functions (DBusServer *server,
569 DBusAddWatchFunction add_function,
570 DBusRemoveWatchFunction remove_function,
571 DBusWatchToggledFunction toggled_function,
573 DBusFreeFunction free_data_function)
575 return _dbus_watch_list_set_functions (server->watches,
584 * Sets the timeout functions for the connection. These functions are
585 * responsible for making the application's main loop aware of timeouts.
587 * This function behaves exactly like dbus_connection_set_timeout_functions();
588 * see the documentation for that routine.
590 * @param server the server.
591 * @param add_function function to add a timeout.
592 * @param remove_function function to remove a timeout.
593 * @param toggled_function function to notify when the timeout is enabled/disabled
594 * @param data data to pass to add_function and remove_function.
595 * @param free_data_function function to be called to free the data.
596 * @returns #FALSE on failure (no memory)
599 dbus_server_set_timeout_functions (DBusServer *server,
600 DBusAddTimeoutFunction add_function,
601 DBusRemoveTimeoutFunction remove_function,
602 DBusTimeoutToggledFunction toggled_function,
604 DBusFreeFunction free_data_function)
606 return _dbus_timeout_list_set_functions (server->timeouts,
607 add_function, remove_function,
609 data, free_data_function);
613 * Called to notify the server when a previously-added watch
614 * is ready for reading or writing, or has an exception such
617 * If this function returns #FALSE, then the file descriptor may still
618 * be ready for reading or writing, but more memory is needed in order
619 * to do the reading or writing. If you ignore the #FALSE return, your
620 * application may spin in a busy loop on the file descriptor until
621 * memory becomes available, but nothing more catastrophic should
624 * @param server the server.
625 * @param watch the watch.
626 * @param condition the current condition of the file descriptors being watched.
629 dbus_server_handle_watch (DBusServer *server,
631 unsigned int condition)
633 _dbus_assert (server->vtable->handle_watch != NULL);
635 _dbus_watch_sanitize_condition (watch, &condition);
637 return (* server->vtable->handle_watch) (server, watch, condition);
641 * Sets the authentication mechanisms that this server offers
642 * to clients, as a list of SASL mechanisms. This function
643 * only affects connections created *after* it is called.
644 * Pass #NULL instead of an array to use all available mechanisms.
646 * @param server the server
647 * @param mechanisms #NULL-terminated array of mechanisms
648 * @returns #FALSE if no memory
651 dbus_server_set_auth_mechanisms (DBusServer *server,
652 const char **mechanisms)
656 if (mechanisms != NULL)
658 copy = _dbus_dup_string_array (mechanisms);
665 dbus_free_string_array (server->auth_mechanisms);
666 server->auth_mechanisms = copy;
672 static DBusDataSlotAllocator slot_allocator;
673 _DBUS_DEFINE_GLOBAL_LOCK (server_slots);
676 * Allocates an integer ID to be used for storing application-specific
677 * data on any DBusServer. The allocated ID may then be used
678 * with dbus_server_set_data() and dbus_server_get_data().
679 * If allocation fails, -1 is returned. Again, the allocated
680 * slot is global, i.e. all DBusServer objects will
681 * have a slot with the given integer ID reserved.
683 * @returns -1 on failure, otherwise the data slot ID
686 dbus_server_allocate_data_slot (void)
688 return _dbus_data_slot_allocator_alloc (&slot_allocator,
689 _DBUS_LOCK_NAME (server_slots));
693 * Deallocates a global ID for server data slots.
694 * dbus_server_get_data() and dbus_server_set_data()
695 * may no longer be used with this slot.
696 * Existing data stored on existing DBusServer objects
697 * will be freed when the server is finalized,
698 * but may not be retrieved (and may only be replaced
699 * if someone else reallocates the slot).
701 * @param slot the slot to deallocate
704 dbus_server_free_data_slot (int slot)
706 _dbus_data_slot_allocator_free (&slot_allocator, slot);
710 * Stores a pointer on a DBusServer, along
711 * with an optional function to be used for freeing
712 * the data when the data is set again, or when
713 * the server is finalized. The slot number
714 * must have been allocated with dbus_server_allocate_data_slot().
716 * @param server the server
717 * @param slot the slot number
718 * @param data the data to store
719 * @param free_data_func finalizer function for the data
720 * @returns #TRUE if there was enough memory to store the data
723 dbus_server_set_data (DBusServer *server,
726 DBusFreeFunction free_data_func)
728 DBusFreeFunction old_free_func;
733 dbus_mutex_lock (server->mutex);
736 retval = _dbus_data_slot_list_set (&slot_allocator,
738 slot, data, free_data_func,
739 &old_free_func, &old_data);
742 dbus_mutex_unlock (server->mutex);
747 /* Do the actual free outside the server lock */
749 (* old_free_func) (old_data);
756 * Retrieves data previously set with dbus_server_set_data().
757 * The slot must still be allocated (must not have been freed).
759 * @param server the server
760 * @param slot the slot to get data from
761 * @returns the data, or #NULL if not found
764 dbus_server_get_data (DBusServer *server,
770 dbus_mutex_lock (server->mutex);
773 res = _dbus_data_slot_list_get (&slot_allocator,
778 dbus_mutex_unlock (server->mutex);