2003-04-24 Havoc Pennington <hp@redhat.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.h"
28 #include "dbus-server-debug-pipe.h"
29 #endif
30 #include "dbus-address.h"
31
32 /**
33  * @defgroup DBusServer DBusServer
34  * @ingroup  DBus
35  * @brief Server that listens for new connections.
36  *
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.
41  *
42  * @todo Thread safety hasn't been looked at for #DBusServer
43  * @todo Need notification to apps of disconnection, may matter for some transports
44  */
45
46 /**
47  * @defgroup DBusServerInternals DBusServer implementation details
48  * @ingroup  DBusInternals
49  * @brief Implementation details of DBusServer
50  *
51  * @{
52  */
53
54 /**
55  * Initializes the members of the DBusServer base class.
56  * Chained up to by subclass constructors.
57  *
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.
62  */
63 dbus_bool_t
64 _dbus_server_init_base (DBusServer             *server,
65                         const DBusServerVTable *vtable,
66                         const DBusString       *address)
67 {
68   server->vtable = vtable;
69   server->refcount = 1;
70
71   server->address = NULL;
72   server->watches = NULL;
73   server->timeouts = NULL;
74   
75   if (!_dbus_string_copy_data (address, &server->address))
76     goto failed;
77   
78   server->watches = _dbus_watch_list_new ();
79   if (server->watches == NULL)
80     goto failed;
81
82   server->timeouts = _dbus_timeout_list_new ();
83   if (server->timeouts == NULL)
84     goto failed;
85
86   _dbus_data_slot_list_init (&server->slot_list);
87
88   _dbus_verbose ("Initialized server on address %s\n", server->address);
89   
90   return TRUE;
91
92  failed:
93   if (server->watches)
94     {
95       _dbus_watch_list_free (server->watches);
96       server->watches = NULL;
97     }
98   if (server->timeouts)
99     {
100       _dbus_timeout_list_free (server->timeouts);
101       server->timeouts = NULL;
102     }
103   if (server->address)
104     {
105       dbus_free (server->address);
106       server->address = NULL;
107     }
108   
109   return FALSE;
110 }
111
112 /**
113  * Finalizes the members of the DBusServer base class.
114  * Chained up to by subclass finalizers.
115  *
116  * @param server the server.
117  */
118 void
119 _dbus_server_finalize_base (DBusServer *server)
120 {
121   /* calls out to application code... */
122   _dbus_data_slot_list_free (&server->slot_list);
123
124   dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
125
126   if (!server->disconnected)
127     dbus_server_disconnect (server);
128
129   _dbus_watch_list_free (server->watches);
130   _dbus_timeout_list_free (server->timeouts);
131
132   dbus_free (server->address);
133
134   dbus_free_string_array (server->auth_mechanisms);
135 }
136
137 /**
138  * Adds a watch for this server, chaining out to application-provided
139  * watch handlers.
140  *
141  * @param server the server.
142  * @param watch the watch to add.
143  */
144 dbus_bool_t
145 _dbus_server_add_watch (DBusServer *server,
146                         DBusWatch  *watch)
147 {
148   return _dbus_watch_list_add_watch (server->watches, watch);
149 }
150
151 /**
152  * Removes a watch previously added with _dbus_server_remove_watch().
153  *
154  * @param server the server.
155  * @param watch the watch to remove.
156  */
157 void
158 _dbus_server_remove_watch  (DBusServer *server,
159                             DBusWatch  *watch)
160 {
161   _dbus_watch_list_remove_watch (server->watches, watch);
162 }
163
164 /**
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.
168  *
169  * @param server the server.
170  * @param watch the watch to toggle.
171  * @param enabled whether to enable or disable
172  */
173 void
174 _dbus_server_toggle_watch (DBusServer  *server,
175                            DBusWatch   *watch,
176                            dbus_bool_t  enabled)
177 {
178   if (server->watches) /* null during finalize */
179     _dbus_watch_list_toggle_watch (server->watches,
180                                    watch, enabled);
181 }
182
183 /**
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.
188  *
189  * @param server the server.
190  * @param timeout the timeout to add.
191  */
192 dbus_bool_t
193 _dbus_server_add_timeout (DBusServer  *server,
194                           DBusTimeout *timeout)
195 {
196   return _dbus_timeout_list_add_timeout (server->timeouts, timeout);
197 }
198
199 /**
200  * Removes a timeout previously added with _dbus_server_add_timeout().
201  *
202  * @param server the server.
203  * @param timeout the timeout to remove.
204  */
205 void
206 _dbus_server_remove_timeout (DBusServer  *server,
207                              DBusTimeout *timeout)
208 {
209   _dbus_timeout_list_remove_timeout (server->timeouts, timeout);  
210 }
211
212 /**
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.
216  *
217  * @param server the server.
218  * @param timeout the timeout to toggle.
219  * @param enabled whether to enable or disable
220  */
221 void
222 _dbus_server_toggle_timeout (DBusServer  *server,
223                              DBusTimeout *timeout,
224                              dbus_bool_t  enabled)
225 {
226   if (server->timeouts) /* null during finalize */
227     _dbus_timeout_list_toggle_timeout (server->timeouts,
228                                        timeout, enabled);
229 }
230
231
232 /** @} */
233
234 /**
235  * @addtogroup DBusServer
236  *
237  * @{
238  */
239
240
241 /**
242  * @typedef DBusServer
243  *
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().
250  * 
251  */
252
253 /**
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.
260  *
261  * @todo error messages on bad address could really be better.
262  * DBusResultCode is a bit limiting here.
263  *
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.
267  * 
268  */
269 DBusServer*
270 dbus_server_listen (const char     *address,
271                     DBusError      *error)
272 {
273   DBusServer *server;
274   DBusAddressEntry **entries;
275   int len, i;
276   const char *address_problem_type;
277   const char *address_problem_field;
278   const char *address_problem_other;
279
280   _dbus_return_val_if_fail (address != NULL, NULL);
281   _dbus_return_val_if_error_is_set (error, NULL);
282   
283   if (!dbus_parse_address (address, &entries, &len, error))
284     return NULL;
285
286   server = NULL;
287   address_problem_type = NULL;
288   address_problem_field = NULL;
289   address_problem_other = NULL;
290   
291   for (i = 0; i < len; i++)
292     {
293       const char *method = dbus_address_entry_get_method (entries[i]);
294
295       if (strcmp (method, "unix") == 0)
296         {
297           const char *path = dbus_address_entry_get_value (entries[i], "path");
298           const char *tmpdir = dbus_address_entry_get_value (entries[i], "tmpdir");
299           
300           if (path == NULL && tmpdir == NULL)
301             {
302               address_problem_type = "unix";
303               address_problem_field = "path or tmpdir";
304               goto bad_address;
305             }
306
307           if (path && tmpdir)
308             {
309               address_problem_other = "cannot specify both \"path\" and \"tmpdir\" at the same time";
310               goto bad_address;
311             }
312
313           if (tmpdir != NULL)
314             {
315               DBusString full_path;
316               DBusString filename;
317               
318               if (!_dbus_string_init (&full_path))
319                 {
320                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
321                   goto out;
322                 }
323                   
324               if (!_dbus_string_init (&filename))
325                 {
326                   _dbus_string_free (&full_path);
327                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
328                   goto out;
329                 }
330               
331               if (!_dbus_string_append (&filename,
332                                         "dbus-") ||
333                   !_dbus_generate_random_ascii (&filename, 10) ||
334                   !_dbus_string_append (&full_path, tmpdir) ||
335                   !_dbus_concat_dir_and_file (&full_path, &filename))
336                 {
337                   _dbus_string_free (&full_path);
338                   _dbus_string_free (&filename);
339                   dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
340                   goto out;
341                 }
342               
343               /* FIXME - we will unconditionally unlink() the path.
344                * unlink() does not follow symlinks, but would like
345                * independent confirmation this is safe enough. See
346                * also _dbus_listen_unix_socket() and comments therein.
347                */
348               
349               server =
350                 _dbus_server_new_for_domain_socket (_dbus_string_get_const_data (&full_path),
351                                                     error);
352
353               _dbus_string_free (&full_path);
354               _dbus_string_free (&filename);
355             }
356           else
357             {
358               server = _dbus_server_new_for_domain_socket (path, error);
359             }
360         }
361       else if (strcmp (method, "tcp") == 0)
362         {
363           const char *host = dbus_address_entry_get_value (entries[i], "host");
364           const char *port = dbus_address_entry_get_value (entries[i], "port");
365           DBusString  str;
366           long lport;
367           dbus_bool_t sresult;
368           
369           if (port == NULL)
370             {
371               address_problem_type = "tcp";
372               address_problem_field = "port";
373               goto bad_address;
374             }
375
376           _dbus_string_init_const (&str, port);
377           sresult = _dbus_string_parse_int (&str, 0, &lport, NULL);
378           _dbus_string_free (&str);
379           
380           if (sresult == FALSE || lport <= 0 || lport > 65535)
381             {
382               address_problem_other = "Port is not an integer between 0 and 65535";
383               goto bad_address;
384             }
385           
386           server = _dbus_server_new_for_tcp_socket (host, lport, error);
387
388           if (server)
389             break;
390         }
391 #ifdef DBUS_BUILD_TESTS
392       else if (strcmp (method, "debug") == 0)
393         {
394           const char *name = dbus_address_entry_get_value (entries[i], "name");
395
396           if (name == NULL)
397             {
398               address_problem_type = "debug";
399               address_problem_field = "name";
400               goto bad_address;
401             }
402
403           server = _dbus_server_debug_new (name, error);
404         }
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  * If allocation fails, -1 is returned. Again, the allocated
670  * slot is global, i.e. all DBusServer objects will
671  * have a slot with the given integer ID reserved.
672  *
673  * @returns -1 on failure, otherwise the data slot ID
674  */
675 int
676 dbus_server_allocate_data_slot (void)
677 {
678   return _dbus_data_slot_allocator_alloc (&slot_allocator,
679                                           _DBUS_LOCK_NAME (server_slots));
680 }
681
682 /**
683  * Deallocates a global ID for server data slots.
684  * dbus_server_get_data() and dbus_server_set_data()
685  * may no longer be used with this slot.
686  * Existing data stored on existing DBusServer objects
687  * will be freed when the server is finalized,
688  * but may not be retrieved (and may only be replaced
689  * if someone else reallocates the slot).
690  *
691  * @param slot the slot to deallocate
692  */
693 void
694 dbus_server_free_data_slot (int slot)
695 {
696   _dbus_return_if_fail (slot >= 0);
697   
698   _dbus_data_slot_allocator_free (&slot_allocator, slot);
699 }
700
701 /**
702  * Stores a pointer on a DBusServer, along
703  * with an optional function to be used for freeing
704  * the data when the data is set again, or when
705  * the server is finalized. The slot number
706  * must have been allocated with dbus_server_allocate_data_slot().
707  *
708  * @param server the server
709  * @param slot the slot number
710  * @param data the data to store
711  * @param free_data_func finalizer function for the data
712  * @returns #TRUE if there was enough memory to store the data
713  */
714 dbus_bool_t
715 dbus_server_set_data (DBusServer       *server,
716                       int               slot,
717                       void             *data,
718                       DBusFreeFunction  free_data_func)
719 {
720   DBusFreeFunction old_free_func;
721   void *old_data;
722   dbus_bool_t retval;
723
724   _dbus_return_val_if_fail (server != NULL, FALSE);
725   
726 #if 0
727   dbus_mutex_lock (server->mutex);
728 #endif
729   
730   retval = _dbus_data_slot_list_set (&slot_allocator,
731                                      &server->slot_list,
732                                      slot, data, free_data_func,
733                                      &old_free_func, &old_data);
734
735 #if 0
736   dbus_mutex_unlock (server->mutex);
737 #endif
738   
739   if (retval)
740     {
741       /* Do the actual free outside the server lock */
742       if (old_free_func)
743         (* old_free_func) (old_data);
744     }
745
746   return retval;
747 }
748
749 /**
750  * Retrieves data previously set with dbus_server_set_data().
751  * The slot must still be allocated (must not have been freed).
752  *
753  * @param server the server
754  * @param slot the slot to get data from
755  * @returns the data, or #NULL if not found
756  */
757 void*
758 dbus_server_get_data (DBusServer   *server,
759                       int           slot)
760 {
761   void *res;
762
763   _dbus_return_val_if_fail (server != NULL, NULL);
764   
765 #if 0
766   dbus_mutex_lock (server->mutex);
767 #endif
768   
769   res = _dbus_data_slot_list_get (&slot_allocator,
770                                   &server->slot_list,
771                                   slot);
772
773 #if 0
774   dbus_mutex_unlock (server->mutex);
775 #endif
776   
777   return res;
778 }
779
780 /** @} */
781