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-pipe.h"
29 #include "dbus-address.h"
32 * @defgroup DBusServer DBusServer
34 * @brief Server that listens for new connections.
36 * Types and functions related to DBusServer.
37 * A DBusServer represents a server that other applications
38 * can connect to. Each connection from another application
39 * is represented by a DBusConnection.
41 * @todo Thread safety hasn't been looked at for #DBusServer
42 * @todo Need notification to apps of disconnection, may matter for some transports
46 * @defgroup DBusServerInternals DBusServer implementation details
47 * @ingroup DBusInternals
48 * @brief Implementation details of DBusServer
54 * Initializes the members of the DBusServer base class.
55 * Chained up to by subclass constructors.
57 * @param server the server.
58 * @param vtable the vtable for the subclass.
59 * @param address the server's address
60 * @returns #TRUE on success.
63 _dbus_server_init_base (DBusServer *server,
64 const DBusServerVTable *vtable,
65 const DBusString *address)
67 server->vtable = vtable;
70 server->address = NULL;
71 server->watches = NULL;
72 server->timeouts = NULL;
74 if (!_dbus_string_copy_data (address, &server->address))
77 server->watches = _dbus_watch_list_new ();
78 if (server->watches == NULL)
81 server->timeouts = _dbus_timeout_list_new ();
82 if (server->timeouts == NULL)
85 _dbus_data_slot_list_init (&server->slot_list);
87 _dbus_verbose ("Initialized server on address %s\n", server->address);
94 _dbus_watch_list_free (server->watches);
95 server->watches = NULL;
99 _dbus_timeout_list_free (server->timeouts);
100 server->timeouts = NULL;
104 dbus_free (server->address);
105 server->address = NULL;
112 * Finalizes the members of the DBusServer base class.
113 * Chained up to by subclass finalizers.
115 * @param server the server.
118 _dbus_server_finalize_base (DBusServer *server)
120 /* calls out to application code... */
121 _dbus_data_slot_list_free (&server->slot_list);
123 dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
125 if (!server->disconnected)
126 dbus_server_disconnect (server);
128 _dbus_watch_list_free (server->watches);
129 _dbus_timeout_list_free (server->timeouts);
131 dbus_free (server->address);
133 dbus_free_string_array (server->auth_mechanisms);
137 * Adds a watch for this server, chaining out to application-provided
140 * @param server the server.
141 * @param watch the watch to add.
144 _dbus_server_add_watch (DBusServer *server,
147 return _dbus_watch_list_add_watch (server->watches, watch);
151 * Removes a watch previously added with _dbus_server_remove_watch().
153 * @param server the server.
154 * @param watch the watch to remove.
157 _dbus_server_remove_watch (DBusServer *server,
160 _dbus_watch_list_remove_watch (server->watches, watch);
164 * Toggles a watch and notifies app via server's
165 * DBusWatchToggledFunction if available. It's an error to call this
166 * function on a watch that was not previously added.
168 * @param server the server.
169 * @param watch the watch to toggle.
170 * @param enabled whether to enable or disable
173 _dbus_server_toggle_watch (DBusServer *server,
177 if (server->watches) /* null during finalize */
178 _dbus_watch_list_toggle_watch (server->watches,
183 * Adds a timeout for this server, chaining out to
184 * application-provided timeout handlers. The timeout should be
185 * repeatedly handled with dbus_timeout_handle() at its given interval
186 * until it is removed.
188 * @param server the server.
189 * @param timeout the timeout to add.
192 _dbus_server_add_timeout (DBusServer *server,
193 DBusTimeout *timeout)
195 return _dbus_timeout_list_add_timeout (server->timeouts, timeout);
199 * Removes a timeout previously added with _dbus_server_add_timeout().
201 * @param server the server.
202 * @param timeout the timeout to remove.
205 _dbus_server_remove_timeout (DBusServer *server,
206 DBusTimeout *timeout)
208 _dbus_timeout_list_remove_timeout (server->timeouts, timeout);
212 * Toggles a timeout and notifies app via server's
213 * DBusTimeoutToggledFunction if available. It's an error to call this
214 * function on a timeout that was not previously added.
216 * @param server the server.
217 * @param timeout the timeout to toggle.
218 * @param enabled whether to enable or disable
221 _dbus_server_toggle_timeout (DBusServer *server,
222 DBusTimeout *timeout,
225 if (server->timeouts) /* null during finalize */
226 _dbus_timeout_list_toggle_timeout (server->timeouts,
234 * @addtogroup DBusServer
241 * @typedef DBusServer
243 * An opaque object representing a server that listens for
244 * connections from other applications. Each time a connection
245 * is made, a new DBusConnection is created and made available
246 * via an application-provided DBusNewConnectionFunction.
247 * The DBusNewConnectionFunction is provided with
248 * dbus_server_set_new_connection_function().
253 * Listens for new connections on the given address.
254 * Returns #NULL if listening fails for any reason.
255 * Otherwise returns a new #DBusServer.
256 * dbus_server_set_new_connection_function() and
257 * dbus_server_set_watch_functions() should be called
258 * immediately to render the server fully functional.
260 * @todo error messages on bad address could really be better.
261 * DBusResultCode is a bit limiting here.
263 * @param address the address of this server.
264 * @param error location to store rationale for failure.
265 * @returns a new DBusServer, or #NULL on failure.
269 dbus_server_listen (const char *address,
273 DBusAddressEntry **entries;
275 const char *address_problem_type;
276 const char *address_problem_field;
277 const char *address_problem_other;
279 _dbus_return_val_if_fail (address != NULL, NULL);
280 _dbus_return_val_if_error_is_set (error, NULL);
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-pipe") == 0)
393 const char *name = dbus_address_entry_get_value (entries[i], "name");
397 address_problem_type = "debug-pipe";
398 address_problem_field = "name";
402 server = _dbus_server_debug_pipe_new (name, error);
407 address_problem_other = "Unknown address type (examples of valid types are \"unix\" and \"tcp\")";
417 dbus_address_entries_free (entries);
421 dbus_address_entries_free (entries);
422 if (address_problem_type != NULL)
423 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
424 "Server address of type %s was missing argument %s",
425 address_problem_type, address_problem_field);
427 dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
428 "Could not parse server address: %s",
429 address_problem_other);
435 * Increments the reference count of a DBusServer.
437 * @param server the server.
440 dbus_server_ref (DBusServer *server)
442 _dbus_return_if_fail (server != NULL);
444 server->refcount += 1;
448 * Decrements the reference count of a DBusServer. Finalizes the
449 * server if the reference count reaches zero. The server connection
450 * will be closed as with dbus_server_disconnect() when the server is
453 * @param server the server.
456 dbus_server_unref (DBusServer *server)
458 _dbus_return_if_fail (server != NULL);
460 _dbus_assert (server->refcount > 0);
462 server->refcount -= 1;
463 if (server->refcount == 0)
465 _dbus_assert (server->vtable->finalize != NULL);
467 (* server->vtable->finalize) (server);
472 * Releases the server's address and stops listening for
473 * new clients. If called more than once, only the first
474 * call has an effect. Does not modify the server's
477 * @param server the server.
480 dbus_server_disconnect (DBusServer *server)
482 _dbus_return_if_fail (server != NULL);
484 _dbus_assert (server->vtable->disconnect != NULL);
486 if (server->disconnected)
489 (* server->vtable->disconnect) (server);
490 server->disconnected = TRUE;
494 * Returns #TRUE if the server is still listening for new connections.
496 * @param server the server.
499 dbus_server_get_is_connected (DBusServer *server)
501 _dbus_return_val_if_fail (server != NULL, FALSE);
503 return !server->disconnected;
507 * Returns the address of the server, as a newly-allocated
508 * string which must be freed by the caller.
510 * @param server the server
511 * @returns the address or #NULL if no memory
514 dbus_server_get_address (DBusServer *server)
516 _dbus_return_val_if_fail (server != NULL, NULL);
518 return _dbus_strdup (server->address);
522 * Sets a function to be used for handling new connections. The given
523 * function is passed each new connection as the connection is
524 * created. If the new connection function increments the connection's
525 * reference count, the connection will stay alive. Otherwise, the
526 * connection will be unreferenced and closed.
528 * @param server the server.
529 * @param function a function to handle new connections.
530 * @param data data to pass to the new connection handler.
531 * @param free_data_function function to free the data.
534 dbus_server_set_new_connection_function (DBusServer *server,
535 DBusNewConnectionFunction function,
537 DBusFreeFunction free_data_function)
539 _dbus_return_if_fail (server != NULL);
541 if (server->new_connection_free_data_function != NULL)
542 (* server->new_connection_free_data_function) (server->new_connection_data);
544 server->new_connection_function = function;
545 server->new_connection_data = data;
546 server->new_connection_free_data_function = free_data_function;
550 * Sets the watch functions for the connection. These functions are
551 * responsible for making the application's main loop aware of file
552 * descriptors that need to be monitored for events.
554 * This function behaves exactly like dbus_connection_set_watch_functions();
555 * see the documentation for that routine.
557 * @param server the server.
558 * @param add_function function to begin monitoring a new descriptor.
559 * @param remove_function function to stop monitoring a descriptor.
560 * @param toggled_function function to notify when the watch is enabled/disabled
561 * @param data data to pass to add_function and remove_function.
562 * @param free_data_function function to be called to free the data.
563 * @returns #FALSE on failure (no memory)
566 dbus_server_set_watch_functions (DBusServer *server,
567 DBusAddWatchFunction add_function,
568 DBusRemoveWatchFunction remove_function,
569 DBusWatchToggledFunction toggled_function,
571 DBusFreeFunction free_data_function)
573 _dbus_return_val_if_fail (server != NULL, FALSE);
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 _dbus_return_val_if_fail (server != NULL, FALSE);
608 return _dbus_timeout_list_set_functions (server->timeouts,
609 add_function, remove_function,
611 data, free_data_function);
615 * Sets the authentication mechanisms that this server offers
616 * to clients, as a list of SASL mechanisms. This function
617 * only affects connections created *after* it is called.
618 * Pass #NULL instead of an array to use all available mechanisms.
620 * @param server the server
621 * @param mechanisms #NULL-terminated array of mechanisms
622 * @returns #FALSE if no memory
625 dbus_server_set_auth_mechanisms (DBusServer *server,
626 const char **mechanisms)
630 _dbus_return_val_if_fail (server != NULL, FALSE);
632 if (mechanisms != NULL)
634 copy = _dbus_dup_string_array (mechanisms);
641 dbus_free_string_array (server->auth_mechanisms);
642 server->auth_mechanisms = copy;
648 static DBusDataSlotAllocator slot_allocator;
649 _DBUS_DEFINE_GLOBAL_LOCK (server_slots);
652 * Allocates an integer ID to be used for storing application-specific
653 * data on any DBusServer. The allocated ID may then be used
654 * with dbus_server_set_data() and dbus_server_get_data().
655 * If allocation fails, -1 is returned. Again, the allocated
656 * slot is global, i.e. all DBusServer objects will
657 * have a slot with the given integer ID reserved.
659 * @returns -1 on failure, otherwise the data slot ID
662 dbus_server_allocate_data_slot (void)
664 return _dbus_data_slot_allocator_alloc (&slot_allocator,
665 _DBUS_LOCK_NAME (server_slots));
669 * Deallocates a global ID for server data slots.
670 * dbus_server_get_data() and dbus_server_set_data()
671 * may no longer be used with this slot.
672 * Existing data stored on existing DBusServer objects
673 * will be freed when the server is finalized,
674 * but may not be retrieved (and may only be replaced
675 * if someone else reallocates the slot).
677 * @param slot the slot to deallocate
680 dbus_server_free_data_slot (int slot)
682 _dbus_return_if_fail (slot >= 0);
684 _dbus_data_slot_allocator_free (&slot_allocator, slot);
688 * Stores a pointer on a DBusServer, along
689 * with an optional function to be used for freeing
690 * the data when the data is set again, or when
691 * the server is finalized. The slot number
692 * must have been allocated with dbus_server_allocate_data_slot().
694 * @param server the server
695 * @param slot the slot number
696 * @param data the data to store
697 * @param free_data_func finalizer function for the data
698 * @returns #TRUE if there was enough memory to store the data
701 dbus_server_set_data (DBusServer *server,
704 DBusFreeFunction free_data_func)
706 DBusFreeFunction old_free_func;
710 _dbus_return_val_if_fail (server != NULL, FALSE);
713 dbus_mutex_lock (server->mutex);
716 retval = _dbus_data_slot_list_set (&slot_allocator,
718 slot, data, free_data_func,
719 &old_free_func, &old_data);
722 dbus_mutex_unlock (server->mutex);
727 /* Do the actual free outside the server lock */
729 (* old_free_func) (old_data);
736 * Retrieves data previously set with dbus_server_set_data().
737 * The slot must still be allocated (must not have been freed).
739 * @param server the server
740 * @param slot the slot to get data from
741 * @returns the data, or #NULL if not found
744 dbus_server_get_data (DBusServer *server,
749 _dbus_return_val_if_fail (server != NULL, NULL);
752 dbus_mutex_lock (server->mutex);
755 res = _dbus_data_slot_list_get (&slot_allocator,
760 dbus_mutex_unlock (server->mutex);