2003-06-22 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / dbus / dbus-server.c
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-server.c DBusServer object
3  *
4  * Copyright (C) 2002, 2003 Red Hat Inc.
5  *
6  * Licensed under the Academic Free License version 1.2
7  * 
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.
12  *
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.
17  * 
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
21  *
22  */ 
23
24 #include "dbus-server.h"
25 #include "dbus-server-unix.h"
26 #ifdef DBUS_BUILD_TESTS
27 #include "dbus-server-debug-pipe.h"
28 #endif
29 #include "dbus-address.h"
30
31 /**
32  * @defgroup DBusServer DBusServer
33  * @ingroup  DBus
34  * @brief Server that listens for new connections.
35  *
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.
40  *
41  * @todo Thread safety hasn't been looked at for #DBusServer
42  * @todo Need notification to apps of disconnection, may matter for some transports
43  */
44
45 /**
46  * @defgroup DBusServerInternals DBusServer implementation details
47  * @ingroup  DBusInternals
48  * @brief Implementation details of DBusServer
49  *
50  * @{
51  */
52
53 /**
54  * Initializes the members of the DBusServer base class.
55  * Chained up to by subclass constructors.
56  *
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.
61  */
62 dbus_bool_t
63 _dbus_server_init_base (DBusServer             *server,
64                         const DBusServerVTable *vtable,
65                         const DBusString       *address)
66 {
67   server->vtable = vtable;
68   server->refcount = 1;
69
70   server->address = NULL;
71   server->watches = NULL;
72   server->timeouts = NULL;
73   
74   if (!_dbus_string_copy_data (address, &server->address))
75     goto failed;
76   
77   server->watches = _dbus_watch_list_new ();
78   if (server->watches == NULL)
79     goto failed;
80
81   server->timeouts = _dbus_timeout_list_new ();
82   if (server->timeouts == NULL)
83     goto failed;
84
85   _dbus_data_slot_list_init (&server->slot_list);
86
87   _dbus_verbose ("Initialized server on address %s\n", server->address);
88   
89   return TRUE;
90
91  failed:
92   if (server->watches)
93     {
94       _dbus_watch_list_free (server->watches);
95       server->watches = NULL;
96     }
97   if (server->timeouts)
98     {
99       _dbus_timeout_list_free (server->timeouts);
100       server->timeouts = NULL;
101     }
102   if (server->address)
103     {
104       dbus_free (server->address);
105       server->address = NULL;
106     }
107   
108   return FALSE;
109 }
110
111 /**
112  * Finalizes the members of the DBusServer base class.
113  * Chained up to by subclass finalizers.
114  *
115  * @param server the server.
116  */
117 void
118 _dbus_server_finalize_base (DBusServer *server)
119 {
120   /* calls out to application code... */
121   _dbus_data_slot_list_free (&server->slot_list);
122
123   dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
124
125   if (!server->disconnected)
126     dbus_server_disconnect (server);
127
128   _dbus_watch_list_free (server->watches);
129   _dbus_timeout_list_free (server->timeouts);
130
131   dbus_free (server->address);
132
133   dbus_free_string_array (server->auth_mechanisms);
134 }
135
136 /**
137  * Adds a watch for this server, chaining out to application-provided
138  * watch handlers.
139  *
140  * @param server the server.
141  * @param watch the watch to add.
142  */
143 dbus_bool_t
144 _dbus_server_add_watch (DBusServer *server,
145                         DBusWatch  *watch)
146 {
147   return _dbus_watch_list_add_watch (server->watches, watch);
148 }
149
150 /**
151  * Removes a watch previously added with _dbus_server_remove_watch().
152  *
153  * @param server the server.
154  * @param watch the watch to remove.
155  */
156 void
157 _dbus_server_remove_watch  (DBusServer *server,
158                             DBusWatch  *watch)
159 {
160   _dbus_watch_list_remove_watch (server->watches, watch);
161 }
162
163 /**
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.
167  *
168  * @param server the server.
169  * @param watch the watch to toggle.
170  * @param enabled whether to enable or disable
171  */
172 void
173 _dbus_server_toggle_watch (DBusServer  *server,
174                            DBusWatch   *watch,
175                            dbus_bool_t  enabled)
176 {
177   if (server->watches) /* null during finalize */
178     _dbus_watch_list_toggle_watch (server->watches,
179                                    watch, enabled);
180 }
181
182 /**
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.
187  *
188  * @param server the server.
189  * @param timeout the timeout to add.
190  */
191 dbus_bool_t
192 _dbus_server_add_timeout (DBusServer  *server,
193                           DBusTimeout *timeout)
194 {
195   return _dbus_timeout_list_add_timeout (server->timeouts, timeout);
196 }
197
198 /**
199  * Removes a timeout previously added with _dbus_server_add_timeout().
200  *
201  * @param server the server.
202  * @param timeout the timeout to remove.
203  */
204 void
205 _dbus_server_remove_timeout (DBusServer  *server,
206                              DBusTimeout *timeout)
207 {
208   _dbus_timeout_list_remove_timeout (server->timeouts, timeout);  
209 }
210
211 /**
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.
215  *
216  * @param server the server.
217  * @param timeout the timeout to toggle.
218  * @param enabled whether to enable or disable
219  */
220 void
221 _dbus_server_toggle_timeout (DBusServer  *server,
222                              DBusTimeout *timeout,
223                              dbus_bool_t  enabled)
224 {
225   if (server->timeouts) /* null during finalize */
226     _dbus_timeout_list_toggle_timeout (server->timeouts,
227                                        timeout, enabled);
228 }
229
230
231 /** @} */
232
233 /**
234  * @addtogroup DBusServer
235  *
236  * @{
237  */
238
239
240 /**
241  * @typedef DBusServer
242  *
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().
249  * 
250  */
251
252 /**
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.
259  *
260  * @todo error messages on bad address could really be better.
261  * DBusResultCode is a bit limiting here.
262  *
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.
266  * 
267  */
268 DBusServer*
269 dbus_server_listen (const char     *address,
270                     DBusError      *error)
271 {
272   DBusServer *server;
273   DBusAddressEntry **entries;
274   int len, i;
275   const char *address_problem_type;
276   const char *address_problem_field;
277   const char *address_problem_other;
278
279   _dbus_return_val_if_fail (address != NULL, NULL);
280   _dbus_return_val_if_error_is_set (error, NULL);
281   
282   if (!dbus_parse_address (address, &entries, &len, error))
283     return NULL;
284
285   server = NULL;
286   address_problem_type = NULL;
287   address_problem_field = NULL;
288   address_problem_other = NULL;
289   
290   for (i = 0; i < len; i++)
291     {
292       const char *method = dbus_address_entry_get_method (entries[i]);
293
294       if (strcmp (method, "unix") == 0)
295         {
296           const char *path = dbus_address_entry_get_value (entries[i], "path");
297           const char *tmpdir = dbus_address_entry_get_value (entries[i], "tmpdir");
298           const char *abstract = dbus_address_entry_get_value (entries[i], "abstract");
299           
300           if (path == NULL && tmpdir == NULL && abstract == NULL)
301             {
302               address_problem_type = "unix";
303               address_problem_field = "path or tmpdir or abstract";
304               goto bad_address;
305             }
306
307           if ((path && tmpdir) ||
308               (path && abstract) ||
309               (tmpdir && abstract))
310             {
311               address_problem_other = "cannot specify two of \"path\" and \"tmpdir\" and \"abstract\" at the same time";
312               goto bad_address;
313             }
314
315           if (tmpdir != NULL)
316             {
317               DBusString full_path;
318               DBusString filename;
319               
320               if (!_dbus_string_init (&full_path))
321                 {
322                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
323                   goto out;
324                 }
325                   
326               if (!_dbus_string_init (&filename))
327                 {
328                   _dbus_string_free (&full_path);
329                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
330                   goto out;
331                 }
332               
333               if (!_dbus_string_append (&filename,
334                                         "dbus-") ||
335                   !_dbus_generate_random_ascii (&filename, 10) ||
336                   !_dbus_string_append (&full_path, tmpdir) ||
337                   !_dbus_concat_dir_and_file (&full_path, &filename))
338                 {
339                   _dbus_string_free (&full_path);
340                   _dbus_string_free (&filename);
341                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
342                   goto out;
343                 }
344               
345               /* FIXME - we will unconditionally unlink() the path if
346                * we don't support abstract namespace.  unlink() does
347                * not follow symlinks, but would like independent
348                * confirmation this is safe enough. See also
349                * _dbus_listen_unix_socket() and comments therein.
350                */
351
352               /* Always use abstract namespace if possible with tmpdir */
353               
354               server =
355                 _dbus_server_new_for_domain_socket (_dbus_string_get_const_data (&full_path),
356 #ifdef HAVE_ABSTRACT_SOCKETS
357                                                     TRUE,
358 #else
359                                                     FALSE,
360 #endif
361                                                     error);
362
363               _dbus_string_free (&full_path);
364               _dbus_string_free (&filename);
365             }
366           else
367             {
368               if (path)
369                 server = _dbus_server_new_for_domain_socket (path, FALSE, error);
370               else
371                 server = _dbus_server_new_for_domain_socket (abstract, TRUE, error);
372             }
373         }
374       else if (strcmp (method, "tcp") == 0)
375         {
376           const char *host = dbus_address_entry_get_value (entries[i], "host");
377           const char *port = dbus_address_entry_get_value (entries[i], "port");
378           DBusString  str;
379           long lport;
380           dbus_bool_t sresult;
381           
382           if (port == NULL)
383             {
384               address_problem_type = "tcp";
385               address_problem_field = "port";
386               goto bad_address;
387             }
388
389           _dbus_string_init_const (&str, port);
390           sresult = _dbus_string_parse_int (&str, 0, &lport, NULL);
391           _dbus_string_free (&str);
392           
393           if (sresult == FALSE || lport <= 0 || lport > 65535)
394             {
395               address_problem_other = "Port is not an integer between 0 and 65535";
396               goto bad_address;
397             }
398           
399           server = _dbus_server_new_for_tcp_socket (host, lport, error);
400
401           if (server)
402             break;
403         }
404 #ifdef DBUS_BUILD_TESTS
405       else if (strcmp (method, "debug-pipe") == 0)
406         {
407           const char *name = dbus_address_entry_get_value (entries[i], "name");
408
409           if (name == NULL)
410             {
411               address_problem_type = "debug-pipe";
412               address_problem_field = "name";
413               goto bad_address;
414             }
415
416           server = _dbus_server_debug_pipe_new (name, error);
417         }
418 #endif
419       else
420         {
421           address_problem_other = "Unknown address type (examples of valid types are \"unix\" and \"tcp\")";
422           goto bad_address;
423         }
424       
425       if (server)
426         break;
427     }
428
429  out:
430   
431   dbus_address_entries_free (entries);
432   return server;
433
434  bad_address:
435   dbus_address_entries_free (entries);
436   if (address_problem_type != NULL)
437     dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
438                     "Server address of type %s was missing argument %s",
439                     address_problem_type, address_problem_field);
440   else
441     dbus_set_error (error, DBUS_ERROR_BAD_ADDRESS,
442                     "Could not parse server address: %s",
443                     address_problem_other);
444
445   return NULL;
446 }
447
448 /**
449  * Increments the reference count of a DBusServer.
450  *
451  * @param server the server.
452  */
453 void
454 dbus_server_ref (DBusServer *server)
455 {
456   _dbus_return_if_fail (server != NULL);
457   
458   server->refcount += 1;
459 }
460
461 /**
462  * Decrements the reference count of a DBusServer.  Finalizes the
463  * server if the reference count reaches zero. The server connection
464  * will be closed as with dbus_server_disconnect() when the server is
465  * finalized.
466  *
467  * @param server the server.
468  */
469 void
470 dbus_server_unref (DBusServer *server)
471 {
472   _dbus_return_if_fail (server != NULL);
473
474   _dbus_assert (server->refcount > 0);
475
476   server->refcount -= 1;
477   if (server->refcount == 0)
478     {
479       _dbus_assert (server->vtable->finalize != NULL);
480       
481       (* server->vtable->finalize) (server);
482     }
483 }
484
485 /**
486  * Releases the server's address and stops listening for
487  * new clients. If called more than once, only the first
488  * call has an effect. Does not modify the server's
489  * reference count.
490  * 
491  * @param server the server.
492  */
493 void
494 dbus_server_disconnect (DBusServer *server)
495 {
496   _dbus_return_if_fail (server != NULL);
497   
498   _dbus_assert (server->vtable->disconnect != NULL);
499
500   if (server->disconnected)
501     return;
502   
503   (* server->vtable->disconnect) (server);
504   server->disconnected = TRUE;
505 }
506
507 /**
508  * Returns #TRUE if the server is still listening for new connections.
509  *
510  * @param server the server.
511  */
512 dbus_bool_t
513 dbus_server_get_is_connected (DBusServer *server)
514 {
515   _dbus_return_val_if_fail (server != NULL, FALSE);
516   
517   return !server->disconnected;
518 }
519
520 /**
521  * Returns the address of the server, as a newly-allocated
522  * string which must be freed by the caller.
523  *
524  * @param server the server
525  * @returns the address or #NULL if no memory
526  */
527 char*
528 dbus_server_get_address (DBusServer *server)
529 {
530   _dbus_return_val_if_fail (server != NULL, NULL);
531   
532   return _dbus_strdup (server->address);
533 }
534
535 /**
536  * Sets a function to be used for handling new connections.  The given
537  * function is passed each new connection as the connection is
538  * created. If the new connection function increments the connection's
539  * reference count, the connection will stay alive. Otherwise, the
540  * connection will be unreferenced and closed.
541  *
542  * @param server the server.
543  * @param function a function to handle new connections.
544  * @param data data to pass to the new connection handler.
545  * @param free_data_function function to free the data.
546  */
547 void
548 dbus_server_set_new_connection_function (DBusServer                *server,
549                                          DBusNewConnectionFunction  function,
550                                          void                      *data,
551                                          DBusFreeFunction           free_data_function)
552 {
553   _dbus_return_if_fail (server != NULL);
554   
555   if (server->new_connection_free_data_function != NULL)
556     (* server->new_connection_free_data_function) (server->new_connection_data);
557   
558   server->new_connection_function = function;
559   server->new_connection_data = data;
560   server->new_connection_free_data_function = free_data_function;
561 }
562
563 /**
564  * Sets the watch functions for the connection. These functions are
565  * responsible for making the application's main loop aware of file
566  * descriptors that need to be monitored for events.
567  *
568  * This function behaves exactly like dbus_connection_set_watch_functions();
569  * see the documentation for that routine.
570  *
571  * @param server the server.
572  * @param add_function function to begin monitoring a new descriptor.
573  * @param remove_function function to stop monitoring a descriptor.
574  * @param toggled_function function to notify when the watch is enabled/disabled
575  * @param data data to pass to add_function and remove_function.
576  * @param free_data_function function to be called to free the data.
577  * @returns #FALSE on failure (no memory)
578  */
579 dbus_bool_t
580 dbus_server_set_watch_functions (DBusServer              *server,
581                                  DBusAddWatchFunction     add_function,
582                                  DBusRemoveWatchFunction  remove_function,
583                                  DBusWatchToggledFunction toggled_function,
584                                  void                    *data,
585                                  DBusFreeFunction         free_data_function)
586 {
587   _dbus_return_val_if_fail (server != NULL, FALSE);
588   
589   return _dbus_watch_list_set_functions (server->watches,
590                                          add_function,
591                                          remove_function,
592                                          toggled_function,
593                                          data,
594                                          free_data_function);
595 }
596
597 /**
598  * Sets the timeout functions for the connection. These functions are
599  * responsible for making the application's main loop aware of timeouts.
600  *
601  * This function behaves exactly like dbus_connection_set_timeout_functions();
602  * see the documentation for that routine.
603  *
604  * @param server the server.
605  * @param add_function function to add a timeout.
606  * @param remove_function function to remove a timeout.
607  * @param toggled_function function to notify when the timeout is enabled/disabled
608  * @param data data to pass to add_function and remove_function.
609  * @param free_data_function function to be called to free the data.
610  * @returns #FALSE on failure (no memory)
611  */
612 dbus_bool_t
613 dbus_server_set_timeout_functions (DBusServer                *server,
614                                    DBusAddTimeoutFunction     add_function,
615                                    DBusRemoveTimeoutFunction  remove_function,
616                                    DBusTimeoutToggledFunction toggled_function,
617                                    void                      *data,
618                                    DBusFreeFunction           free_data_function)
619 {
620   _dbus_return_val_if_fail (server != NULL, FALSE);
621   
622   return _dbus_timeout_list_set_functions (server->timeouts,
623                                            add_function, remove_function,
624                                            toggled_function,
625                                            data, free_data_function); 
626 }
627
628 /**
629  * Sets the authentication mechanisms that this server offers
630  * to clients, as a list of SASL mechanisms. This function
631  * only affects connections created *after* it is called.
632  * Pass #NULL instead of an array to use all available mechanisms.
633  *
634  * @param server the server
635  * @param mechanisms #NULL-terminated array of mechanisms
636  * @returns #FALSE if no memory
637  */
638 dbus_bool_t
639 dbus_server_set_auth_mechanisms (DBusServer  *server,
640                                  const char **mechanisms)
641 {
642   char **copy;
643
644   _dbus_return_val_if_fail (server != NULL, FALSE);
645   
646   if (mechanisms != NULL)
647     {
648       copy = _dbus_dup_string_array (mechanisms);
649       if (copy == NULL)
650         return FALSE;
651     }
652   else
653     copy = NULL;
654
655   dbus_free_string_array (server->auth_mechanisms);
656   server->auth_mechanisms = copy;
657
658   return TRUE;
659 }
660
661
662 static DBusDataSlotAllocator slot_allocator;
663 _DBUS_DEFINE_GLOBAL_LOCK (server_slots);
664
665 /**
666  * Allocates an integer ID to be used for storing application-specific
667  * data on any DBusServer. The allocated ID may then be used
668  * with dbus_server_set_data() and dbus_server_get_data().
669  * The slot must be initialized with -1. If a nonnegative
670  * slot is passed in, the refcount is incremented on that
671  * slot, rather than creating a new slot.
672  *  
673  * The allocated slot is global, i.e. all DBusServer objects will have
674  * a slot with the given integer ID reserved.
675  *
676  * @param slot_p address of global variable storing the slot ID
677  * @returns #FALSE on no memory
678  */
679 dbus_bool_t
680 dbus_server_allocate_data_slot (dbus_int32_t *slot_p)
681 {
682   return _dbus_data_slot_allocator_alloc (&slot_allocator,
683                                           _DBUS_LOCK_NAME (server_slots),
684                                           slot_p);
685 }
686
687 /**
688  * Deallocates a global ID for server data slots.
689  * dbus_server_get_data() and dbus_server_set_data()
690  * may no longer be used with this slot.
691  * Existing data stored on existing DBusServer objects
692  * will be freed when the server is finalized,
693  * but may not be retrieved (and may only be replaced
694  * if someone else reallocates the slot).
695  *
696  * @param slot_p address of the slot to deallocate
697  */
698 void
699 dbus_server_free_data_slot (dbus_int32_t *slot_p)
700 {
701   _dbus_return_if_fail (*slot_p >= 0);
702   
703   _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
704 }
705
706 /**
707  * Stores a pointer on a DBusServer, along
708  * with an optional function to be used for freeing
709  * the data when the data is set again, or when
710  * the server is finalized. The slot number
711  * must have been allocated with dbus_server_allocate_data_slot().
712  *
713  * @param server the server
714  * @param slot the slot number
715  * @param data the data to store
716  * @param free_data_func finalizer function for the data
717  * @returns #TRUE if there was enough memory to store the data
718  */
719 dbus_bool_t
720 dbus_server_set_data (DBusServer       *server,
721                       int               slot,
722                       void             *data,
723                       DBusFreeFunction  free_data_func)
724 {
725   DBusFreeFunction old_free_func;
726   void *old_data;
727   dbus_bool_t retval;
728
729   _dbus_return_val_if_fail (server != NULL, FALSE);
730   
731 #if 0
732   dbus_mutex_lock (server->mutex);
733 #endif
734   
735   retval = _dbus_data_slot_list_set (&slot_allocator,
736                                      &server->slot_list,
737                                      slot, data, free_data_func,
738                                      &old_free_func, &old_data);
739
740 #if 0
741   dbus_mutex_unlock (server->mutex);
742 #endif
743   
744   if (retval)
745     {
746       /* Do the actual free outside the server lock */
747       if (old_free_func)
748         (* old_free_func) (old_data);
749     }
750
751   return retval;
752 }
753
754 /**
755  * Retrieves data previously set with dbus_server_set_data().
756  * The slot must still be allocated (must not have been freed).
757  *
758  * @param server the server
759  * @param slot the slot to get data from
760  * @returns the data, or #NULL if not found
761  */
762 void*
763 dbus_server_get_data (DBusServer   *server,
764                       int           slot)
765 {
766   void *res;
767
768   _dbus_return_val_if_fail (server != NULL, NULL);
769   
770 #if 0
771   dbus_mutex_lock (server->mutex);
772 #endif
773   
774   res = _dbus_data_slot_list_get (&slot_allocator,
775                                   &server->slot_list,
776                                   slot);
777
778 #if 0
779   dbus_mutex_unlock (server->mutex);
780 #endif
781   
782   return res;
783 }
784
785 /** @} */
786