dbus/dbus-server.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-server.c DBusServer object
   3  *
   4  * Copyright (C) 2002, 2003, 2004, 2005 Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   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 #include "dbus-server-socket.h"
  27 #include "dbus-string.h"
  28 #ifdef DBUS_BUILD_TESTS
  29 #include "dbus-server-debug-pipe.h"
  30 #endif
  31 #include "dbus-address.h"
  32 #include "dbus-protocol.h"
  33
  34 /**
  35  * @defgroup DBusServer DBusServer
  36  * @ingroup  DBus
  37  * @brief Server that listens for new connections.
  38  *
  39  * Types and functions related to DBusServer.
  40  * A DBusServer represents a server that other applications
  41  * can connect to. Each connection from another application
  42  * is represented by a DBusConnection.
  43  *
  44  * @todo Thread safety hasn't been looked at for #DBusServer
  45  * @todo Need notification to apps of disconnection, may matter for some transports
  46  */
  47
  48 /**
  49  * @defgroup DBusServerInternals DBusServer implementation details
  50  * @ingroup  DBusInternals
  51  * @brief Implementation details of DBusServer
  52  *
  53  * @{
  54  */
  55
  56 /* this is a little fragile since it assumes the address doesn't
  57  * already have a guid, but it shouldn't
  58  */
  59 static char*
  60 copy_address_with_guid_appended (const DBusString *address,
  61                                  const DBusString *guid_hex)
  62 {
  63   DBusString with_guid;
  64   char *retval;
  65
  66   if (!_dbus_string_init (&with_guid))
  67     return NULL;
  68
  69   if (!_dbus_string_copy (address, 0, &with_guid,
  70                           _dbus_string_get_length (&with_guid)) ||
  71       !_dbus_string_append (&with_guid, ",guid=") ||
  72       !_dbus_string_copy (guid_hex, 0,
  73                           &with_guid, _dbus_string_get_length (&with_guid)))
  74     {
  75       _dbus_string_free (&with_guid);
  76       return NULL;
  77     }
  78
  79   retval = NULL;
  80   _dbus_string_steal_data (&with_guid, &retval);
  81
  82   _dbus_string_free (&with_guid);
  83
  84   return retval; /* may be NULL if steal_data failed */
  85 }
  86
  87 /**
  88  * Initializes the members of the DBusServer base class.
  89  * Chained up to by subclass constructors.
  90  *
  91  * @param server the server.
  92  * @param vtable the vtable for the subclass.
  93  * @param address the server's address
  94  * @returns #TRUE on success.
  95  */
  96 dbus_bool_t
  97 _dbus_server_init_base (DBusServer             *server,
  98                         const DBusServerVTable *vtable,
  99                         const DBusString       *address)
 100 {
 101   server->vtable = vtable;
 102   server->refcount.value = 1;
 103
 104   server->address = NULL;
 105   server->watches = NULL;
 106   server->timeouts = NULL;
 107
 108   if (!_dbus_string_init (&server->guid_hex))
 109     return FALSE;
 110
 111   _dbus_generate_uuid (&server->guid);
 112
 113   if (!_dbus_uuid_encode (&server->guid, &server->guid_hex))
 114     goto failed;
 115
 116   server->address = copy_address_with_guid_appended (address,
 117                                                      &server->guid_hex);
 118   if (server->address == NULL)
 119     goto failed;
 120
 121   _dbus_mutex_new_at_location (&server->mutex);
 122   if (server->mutex == NULL)
 123     goto failed;
 124
 125   server->watches = _dbus_watch_list_new ();
 126   if (server->watches == NULL)
 127     goto failed;
 128
 129   server->timeouts = _dbus_timeout_list_new ();
 130   if (server->timeouts == NULL)
 131     goto failed;
 132
 133   _dbus_data_slot_list_init (&server->slot_list);
 134
 135   _dbus_verbose ("Initialized server on address %s\n", server->address);
 136
 137   return TRUE;
 138
 139  failed:
 140   _dbus_mutex_free_at_location (&server->mutex);
 141   server->mutex = NULL;
 142   if (server->watches)
 143     {
 144       _dbus_watch_list_free (server->watches);
 145       server->watches = NULL;
 146     }
 147   if (server->timeouts)
 148     {
 149       _dbus_timeout_list_free (server->timeouts);
 150       server->timeouts = NULL;
 151     }
 152   if (server->address)
 153     {
 154       dbus_free (server->address);
 155       server->address = NULL;
 156     }
 157   _dbus_string_free (&server->guid_hex);
 158
 159   return FALSE;
 160 }
 161
 162 /**
 163  * Finalizes the members of the DBusServer base class.
 164  * Chained up to by subclass finalizers.
 165  *
 166  * @param server the server.
 167  */
 168 void
 169 _dbus_server_finalize_base (DBusServer *server)
 170 {
 171   /* We don't have the lock, but nobody should be accessing
 172    * concurrently since they don't have a ref
 173    */
 174 #ifndef DBUS_DISABLE_CHECKS
 175   _dbus_assert (!server->have_server_lock);
 176 #endif
 177   _dbus_assert (server->disconnected);
 178
 179   /* calls out to application code... */
 180   _dbus_data_slot_list_free (&server->slot_list);
 181
 182   dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
 183
 184   _dbus_watch_list_free (server->watches);
 185   _dbus_timeout_list_free (server->timeouts);
 186
 187   _dbus_mutex_free_at_location (&server->mutex);
 188
 189   dbus_free (server->address);
 190
 191   dbus_free_string_array (server->auth_mechanisms);
 192
 193   _dbus_string_free (&server->guid_hex);
 194 }
 195
 196
 197 /** Function to be called in protected_change_watch() with refcount held */
 198 typedef dbus_bool_t (* DBusWatchAddFunction)     (DBusWatchList *list,
 199                                                   DBusWatch     *watch);
 200 /** Function to be called in protected_change_watch() with refcount held */
 201 typedef void        (* DBusWatchRemoveFunction)  (DBusWatchList *list,
 202                                                   DBusWatch     *watch);
 203 /** Function to be called in protected_change_watch() with refcount held */
 204 typedef void        (* DBusWatchToggleFunction)  (DBusWatchList *list,
 205                                                   DBusWatch     *watch,
 206                                                   dbus_bool_t    enabled);
 207
 208 static dbus_bool_t
 209 protected_change_watch (DBusServer             *server,
 210                         DBusWatch              *watch,
 211                         DBusWatchAddFunction    add_function,
 212                         DBusWatchRemoveFunction remove_function,
 213                         DBusWatchToggleFunction toggle_function,
 214                         dbus_bool_t             enabled)
 215 {
 216   DBusWatchList *watches;
 217   dbus_bool_t retval;
 218
 219   HAVE_LOCK_CHECK (server);
 220
 221   /* This isn't really safe or reasonable; a better pattern is the "do
 222    * everything, then drop lock and call out" one; but it has to be
 223    * propagated up through all callers
 224    */
 225
 226   watches = server->watches;
 227   if (watches)
 228     {
 229       server->watches = NULL;
 230       _dbus_server_ref_unlocked (server);
 231       SERVER_UNLOCK (server);
 232
 233       if (add_function)
 234         retval = (* add_function) (watches, watch);
 235       else if (remove_function)
 236         {
 237           retval = TRUE;
 238           (* remove_function) (watches, watch);
 239         }
 240       else
 241         {
 242           retval = TRUE;
 243           (* toggle_function) (watches, watch, enabled);
 244         }
 245
 246       SERVER_LOCK (server);
 247       server->watches = watches;
 248       _dbus_server_unref_unlocked (server);
 249
 250       return retval;
 251     }
 252   else
 253     return FALSE;
 254 }
 255
 256 /**
 257  * Adds a watch for this server, chaining out to application-provided
 258  * watch handlers.
 259  *
 260  * @param server the server.
 261  * @param watch the watch to add.
 262  */
 263 dbus_bool_t
 264 _dbus_server_add_watch (DBusServer *server,
 265                         DBusWatch  *watch)
 266 {
 267   HAVE_LOCK_CHECK (server);
 268   return protected_change_watch (server, watch,
 269                                  _dbus_watch_list_add_watch,
 270                                  NULL, NULL, FALSE);
 271 }
 272
 273 /**
 274  * Removes a watch previously added with _dbus_server_remove_watch().
 275  *
 276  * @param server the server.
 277  * @param watch the watch to remove.
 278  */
 279 void
 280 _dbus_server_remove_watch  (DBusServer *server,
 281                             DBusWatch  *watch)
 282 {
 283   HAVE_LOCK_CHECK (server);
 284   protected_change_watch (server, watch,
 285                           NULL,
 286                           _dbus_watch_list_remove_watch,
 287                           NULL, FALSE);
 288 }
 289
 290 /**
 291  * Toggles a watch and notifies app via server's
 292  * DBusWatchToggledFunction if available. It's an error to call this
 293  * function on a watch that was not previously added.
 294  *
 295  * @param server the server.
 296  * @param watch the watch to toggle.
 297  * @param enabled whether to enable or disable
 298  */
 299 void
 300 _dbus_server_toggle_watch (DBusServer  *server,
 301                            DBusWatch   *watch,
 302                            dbus_bool_t  enabled)
 303 {
 304   _dbus_assert (watch != NULL);
 305
 306   HAVE_LOCK_CHECK (server);
 307   protected_change_watch (server, watch,
 308                           NULL, NULL,
 309                           _dbus_watch_list_toggle_watch,
 310                           enabled);
 311 }
 312
 313 /** Function to be called in protected_change_timeout() with refcount held */
 314 typedef dbus_bool_t (* DBusTimeoutAddFunction)    (DBusTimeoutList *list,
 315                                                    DBusTimeout     *timeout);
 316 /** Function to be called in protected_change_timeout() with refcount held */
 317 typedef void        (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
 318                                                    DBusTimeout     *timeout);
 319 /** Function to be called in protected_change_timeout() with refcount held */
 320 typedef void        (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
 321                                                    DBusTimeout     *timeout,
 322                                                    dbus_bool_t      enabled);
 323
 324
 325 static dbus_bool_t
 326 protected_change_timeout (DBusServer               *server,
 327                           DBusTimeout              *timeout,
 328                           DBusTimeoutAddFunction    add_function,
 329                           DBusTimeoutRemoveFunction remove_function,
 330                           DBusTimeoutToggleFunction toggle_function,
 331                           dbus_bool_t               enabled)
 332 {
 333   DBusTimeoutList *timeouts;
 334   dbus_bool_t retval;
 335
 336   HAVE_LOCK_CHECK (server);
 337
 338   /* This isn't really safe or reasonable; a better pattern is the "do everything, then
 339    * drop lock and call out" one; but it has to be propagated up through all callers
 340    */
 341
 342   timeouts = server->timeouts;
 343   if (timeouts)
 344     {
 345       server->timeouts = NULL;
 346       _dbus_server_ref_unlocked (server);
 347       SERVER_UNLOCK (server);
 348
 349       if (add_function)
 350         retval = (* add_function) (timeouts, timeout);
 351       else if (remove_function)
 352         {
 353           retval = TRUE;
 354           (* remove_function) (timeouts, timeout);
 355         }
 356       else
 357         {
 358           retval = TRUE;
 359           (* toggle_function) (timeouts, timeout, enabled);
 360         }
 361
 362       SERVER_LOCK (server);
 363       server->timeouts = timeouts;
 364       _dbus_server_unref_unlocked (server);
 365
 366       return retval;
 367     }
 368   else
 369     return FALSE;
 370 }
 371
 372 /**
 373  * Adds a timeout for this server, chaining out to
 374  * application-provided timeout handlers. The timeout should be
 375  * repeatedly handled with dbus_timeout_handle() at its given interval
 376  * until it is removed.
 377  *
 378  * @param server the server.
 379  * @param timeout the timeout to add.
 380  */
 381 dbus_bool_t
 382 _dbus_server_add_timeout (DBusServer  *server,
 383                           DBusTimeout *timeout)
 384 {
 385   return protected_change_timeout (server, timeout,
 386                                    _dbus_timeout_list_add_timeout,
 387                                    NULL, NULL, FALSE);
 388 }
 389
 390 /**
 391  * Removes a timeout previously added with _dbus_server_add_timeout().
 392  *
 393  * @param server the server.
 394  * @param timeout the timeout to remove.
 395  */
 396 void
 397 _dbus_server_remove_timeout (DBusServer  *server,
 398                              DBusTimeout *timeout)
 399 {
 400   protected_change_timeout (server, timeout,
 401                             NULL,
 402                             _dbus_timeout_list_remove_timeout,
 403                             NULL, FALSE);
 404 }
 405
 406 /**
 407  * Toggles a timeout and notifies app via server's
 408  * DBusTimeoutToggledFunction if available. It's an error to call this
 409  * function on a timeout that was not previously added.
 410  *
 411  * @param server the server.
 412  * @param timeout the timeout to toggle.
 413  * @param enabled whether to enable or disable
 414  */
 415 void
 416 _dbus_server_toggle_timeout (DBusServer  *server,
 417                              DBusTimeout *timeout,
 418                              dbus_bool_t  enabled)
 419 {
 420   protected_change_timeout (server, timeout,
 421                             NULL, NULL,
 422                             _dbus_timeout_list_toggle_timeout,
 423                             enabled);
 424 }
 425
 426
 427 /**
 428  * Like dbus_server_ref() but does not acquire the lock (must already be held)
 429  *
 430  * @param server the server.
 431  */
 432 void
 433 _dbus_server_ref_unlocked (DBusServer *server)
 434 {
 435   _dbus_assert (server != NULL);
 436   _dbus_assert (server->refcount.value > 0);
 437
 438   HAVE_LOCK_CHECK (server);
 439
 440 #ifdef DBUS_HAVE_ATOMIC_INT
 441   _dbus_atomic_inc (&server->refcount);
 442 #else
 443   _dbus_assert (server->refcount.value > 0);
 444
 445   server->refcount.value += 1;
 446 #endif
 447 }
 448
 449 /**
 450  * Like dbus_server_unref() but does not acquire the lock (must already be held)
 451  *
 452  * @param server the server.
 453  */
 454 void
 455 _dbus_server_unref_unlocked (DBusServer *server)
 456 {
 457   dbus_bool_t last_unref;
 458
 459   /* Keep this in sync with dbus_server_unref */
 460
 461   _dbus_assert (server != NULL);
 462   _dbus_assert (server->refcount.value > 0);
 463
 464   HAVE_LOCK_CHECK (server);
 465
 466 #ifdef DBUS_HAVE_ATOMIC_INT
 467   last_unref = (_dbus_atomic_dec (&server->refcount) == 1);
 468 #else
 469   _dbus_assert (server->refcount.value > 0);
 470
 471   server->refcount.value -= 1;
 472   last_unref = (server->refcount.value == 0);
 473 #endif
 474
 475   if (last_unref)
 476     {
 477       _dbus_assert (server->disconnected);
 478
 479       SERVER_UNLOCK (server);
 480
 481       _dbus_assert (server->vtable->finalize != NULL);
 482
 483       (* server->vtable->finalize) (server);
 484     }
 485 }
 486
 487 /** @} */
 488
 489 /**
 490  * @addtogroup DBusServer
 491  *
 492  * @{
 493  */
 494
 495
 496 /**
 497  * @typedef DBusServer
 498  *
 499  * An opaque object representing a server that listens for
 500  * connections from other applications. Each time a connection
 501  * is made, a new DBusConnection is created and made available
 502  * via an application-provided DBusNewConnectionFunction.
 503  * The DBusNewConnectionFunction is provided with
 504  * dbus_server_set_new_connection_function().
 505  *
 506  */
 507
 508 static const struct {
 509   DBusServerListenResult (* func) (DBusAddressEntry *entry,
 510                                    DBusServer      **server_p,
 511                                    DBusError        *error);
 512 } listen_funcs[] = {
 513   { _dbus_server_listen_socket },
 514   { _dbus_server_listen_platform_specific }
 515 #ifdef DBUS_BUILD_TESTS
 516   , { _dbus_server_listen_debug_pipe }
 517 #endif
 518 };
 519
 520 /**
 521  * Listens for new connections on the given address.
 522  * If there are multiple address entries in the address,
 523  * tries each one and listens on the first one that
 524  * works.
 525  *
 526  * Returns #NULL and sets error if listening fails for any reason.
 527  * Otherwise returns a new #DBusServer.
 528  * dbus_server_set_new_connection_function() and
 529  * dbus_server_set_watch_functions() should be called
 530  * immediately to render the server fully functional.
 531  *
 532  * @param address the address of this server.
 533  * @param error location to store rationale for failure.
 534  * @returns a new DBusServer, or #NULL on failure.
 535  *
 536  */
 537 DBusServer*
 538 dbus_server_listen (const char     *address,
 539                     DBusError      *error)
 540 {
 541   DBusServer *server;
 542   DBusAddressEntry **entries;
 543   int len, i;
 544   DBusError first_connect_error;
 545   dbus_bool_t handled_once;
 546
 547   _dbus_return_val_if_fail (address != NULL, NULL);
 548   _dbus_return_val_if_error_is_set (error, NULL);
 549
 550   if (!dbus_parse_address (address, &entries, &len, error))
 551     return NULL;
 552
 553   server = NULL;
 554   dbus_error_init (&first_connect_error);
 555   handled_once = FALSE;
 556
 557   for (i = 0; i < len; i++)
 558     {
 559       int j;
 560
 561       for (j = 0; j < (int) _DBUS_N_ELEMENTS (listen_funcs); ++j)
 562         {
 563           DBusServerListenResult result;
 564           DBusError tmp_error;
 565
 566           dbus_error_init (&tmp_error);
 567           result = (* listen_funcs[j].func) (entries[i],
 568                                              &server,
 569                                              &tmp_error);
 570
 571           if (result == DBUS_SERVER_LISTEN_OK)
 572             {
 573               _dbus_assert (server != NULL);
 574               _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
 575               handled_once = TRUE;
 576               goto out;
 577             }
 578           else if (result == DBUS_SERVER_LISTEN_BAD_ADDRESS)
 579             {
 580               _dbus_assert (server == NULL);
 581               _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
 582               dbus_move_error (&tmp_error, error);
 583               handled_once = TRUE;
 584               goto out;
 585             }
 586           else if (result == DBUS_SERVER_LISTEN_NOT_HANDLED)
 587             {
 588               _dbus_assert (server == NULL);
 589               _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
 590
 591               /* keep trying addresses */
 592             }
 593           else if (result == DBUS_SERVER_LISTEN_DID_NOT_CONNECT)
 594             {
 595               _dbus_assert (server == NULL);
 596               _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
 597               if (!dbus_error_is_set (&first_connect_error))
 598                 dbus_move_error (&tmp_error, &first_connect_error);
 599               else
 600                 dbus_error_free (&tmp_error);
 601
 602               handled_once = TRUE;
 603
 604               /* keep trying addresses */
 605             }
 606         }
 607
 608       _dbus_assert (server == NULL);
 609       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 610     }
 611
 612  out:
 613
 614   if (!handled_once)
 615     {
 616       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 617       if (len > 0)
 618         dbus_set_error (error,
 619                        DBUS_ERROR_BAD_ADDRESS,
 620                        "Unknown address type '%s'",
 621                        dbus_address_entry_get_method (entries[0]));
 622       else
 623         dbus_set_error (error,
 624                         DBUS_ERROR_BAD_ADDRESS,
 625                         "Empty address '%s'",
 626                         address);
 627     }
 628
 629   dbus_address_entries_free (entries);
 630
 631   if (server == NULL)
 632     {
 633       _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error) ||
 634                    dbus_error_is_set (error));
 635
 636       if (error && dbus_error_is_set (error))
 637         {
 638           /* already set the error */
 639         }
 640       else
 641         {
 642           /* didn't set the error but either error should be
 643            * NULL or first_connect_error should be set.
 644            */
 645           _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error));
 646           dbus_move_error (&first_connect_error, error);
 647         }
 648
 649       _DBUS_ASSERT_ERROR_IS_CLEAR (&first_connect_error); /* be sure we freed it */
 650       _DBUS_ASSERT_ERROR_IS_SET (error);
 651
 652       return NULL;
 653     }
 654   else
 655     {
 656       _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 657       return server;
 658     }
 659 }
 660
 661 /**
 662  * Increments the reference count of a DBusServer.
 663  *
 664  * @param server the server.
 665  * @returns the server
 666  */
 667 DBusServer *
 668 dbus_server_ref (DBusServer *server)
 669 {
 670   _dbus_return_val_if_fail (server != NULL, NULL);
 671   _dbus_return_val_if_fail (server->refcount.value > 0, NULL);
 672
 673 #ifdef DBUS_HAVE_ATOMIC_INT
 674   _dbus_atomic_inc (&server->refcount);
 675 #else
 676   SERVER_LOCK (server);
 677   _dbus_assert (server->refcount.value > 0);
 678
 679   server->refcount.value += 1;
 680   SERVER_UNLOCK (server);
 681 #endif
 682
 683   return server;
 684 }
 685
 686 /**
 687  * Decrements the reference count of a DBusServer.  Finalizes the
 688  * server if the reference count reaches zero.
 689  *
 690  * The server must be disconnected before the refcount reaches zero.
 691  *
 692  * @param server the server.
 693  */
 694 void
 695 dbus_server_unref (DBusServer *server)
 696 {
 697   dbus_bool_t last_unref;
 698
 699   /* keep this in sync with unref_unlocked */
 700
 701   _dbus_return_if_fail (server != NULL);
 702   _dbus_return_if_fail (server->refcount.value > 0);
 703
 704 #ifdef DBUS_HAVE_ATOMIC_INT
 705   last_unref = (_dbus_atomic_dec (&server->refcount) == 1);
 706 #else
 707   SERVER_LOCK (server);
 708
 709   _dbus_assert (server->refcount.value > 0);
 710
 711   server->refcount.value -= 1;
 712   last_unref = (server->refcount.value == 0);
 713
 714   SERVER_UNLOCK (server);
 715 #endif
 716
 717   if (last_unref)
 718     {
 719       /* lock not held! */
 720       _dbus_assert (server->disconnected);
 721
 722       _dbus_assert (server->vtable->finalize != NULL);
 723
 724       (* server->vtable->finalize) (server);
 725     }
 726 }
 727
 728 /**
 729  * Releases the server's address and stops listening for
 730  * new clients. If called more than once, only the first
 731  * call has an effect. Does not modify the server's
 732  * reference count.
 733  *
 734  * @param server the server.
 735  */
 736 void
 737 dbus_server_disconnect (DBusServer *server)
 738 {
 739   _dbus_return_if_fail (server != NULL);
 740   _dbus_return_if_fail (server->refcount.value > 0);
 741
 742   SERVER_LOCK (server);
 743   _dbus_server_ref_unlocked (server);
 744
 745   _dbus_assert (server->vtable->disconnect != NULL);
 746
 747   if (!server->disconnected)
 748     {
 749       /* this has to be first so recursive calls to disconnect don't happen */
 750       server->disconnected = TRUE;
 751
 752       (* server->vtable->disconnect) (server);
 753     }
 754
 755   SERVER_UNLOCK (server);
 756   dbus_server_unref (server);
 757 }
 758
 759 /**
 760  * Returns #TRUE if the server is still listening for new connections.
 761  *
 762  * @param server the server.
 763  */
 764 dbus_bool_t
 765 dbus_server_get_is_connected (DBusServer *server)
 766 {
 767   dbus_bool_t retval;
 768
 769   _dbus_return_val_if_fail (server != NULL, FALSE);
 770
 771   SERVER_LOCK (server);
 772   retval = !server->disconnected;
 773   SERVER_UNLOCK (server);
 774
 775   return retval;
 776 }
 777
 778 /**
 779  * Returns the address of the server, as a newly-allocated
 780  * string which must be freed by the caller.
 781  *
 782  * @param server the server
 783  * @returns the address or #NULL if no memory
 784  */
 785 char*
 786 dbus_server_get_address (DBusServer *server)
 787 {
 788   char *retval;
 789
 790   _dbus_return_val_if_fail (server != NULL, NULL);
 791
 792   SERVER_LOCK (server);
 793   retval = _dbus_strdup (server->address);
 794   SERVER_UNLOCK (server);
 795
 796   return retval;
 797 }
 798
 799 /**
 800  * Sets a function to be used for handling new connections.  The given
 801  * function is passed each new connection as the connection is
 802  * created. If the new connection function increments the connection's
 803  * reference count, the connection will stay alive. Otherwise, the
 804  * connection will be unreferenced and closed. The new connection
 805  * function may also close the connection itself, which is considered
 806  * good form if the connection is not wanted.
 807  *
 808  * The connection here is private in the sense of
 809  * dbus_connection_open_private(), so if the new connection function
 810  * keeps a reference it must arrange for the connection to be closed.
 811  * i.e. libdbus does not own this connection once the new connection
 812  * function takes a reference.
 813  *
 814  * @param server the server.
 815  * @param function a function to handle new connections.
 816  * @param data data to pass to the new connection handler.
 817  * @param free_data_function function to free the data.
 818  */
 819 void
 820 dbus_server_set_new_connection_function (DBusServer                *server,
 821                                          DBusNewConnectionFunction  function,
 822                                          void                      *data,
 823                                          DBusFreeFunction           free_data_function)
 824 {
 825   DBusFreeFunction old_free_function;
 826   void *old_data;
 827
 828   _dbus_return_if_fail (server != NULL);
 829
 830   SERVER_LOCK (server);
 831   old_free_function = server->new_connection_free_data_function;
 832   old_data = server->new_connection_data;
 833
 834   server->new_connection_function = function;
 835   server->new_connection_data = data;
 836   server->new_connection_free_data_function = free_data_function;
 837   SERVER_UNLOCK (server);
 838
 839   if (old_free_function != NULL)
 840     (* old_free_function) (old_data);
 841 }
 842
 843 /**
 844  * Sets the watch functions for the connection. These functions are
 845  * responsible for making the application's main loop aware of file
 846  * descriptors that need to be monitored for events.
 847  *
 848  * This function behaves exactly like dbus_connection_set_watch_functions();
 849  * see the documentation for that routine.
 850  *
 851  * @param server the server.
 852  * @param add_function function to begin monitoring a new descriptor.
 853  * @param remove_function function to stop monitoring a descriptor.
 854  * @param toggled_function function to notify when the watch is enabled/disabled
 855  * @param data data to pass to add_function and remove_function.
 856  * @param free_data_function function to be called to free the data.
 857  * @returns #FALSE on failure (no memory)
 858  */
 859 dbus_bool_t
 860 dbus_server_set_watch_functions (DBusServer              *server,
 861                                  DBusAddWatchFunction     add_function,
 862                                  DBusRemoveWatchFunction  remove_function,
 863                                  DBusWatchToggledFunction toggled_function,
 864                                  void                    *data,
 865                                  DBusFreeFunction         free_data_function)
 866 {
 867   dbus_bool_t result;
 868   DBusWatchList *watches;
 869
 870   _dbus_return_val_if_fail (server != NULL, FALSE);
 871
 872   SERVER_LOCK (server);
 873   watches = server->watches;
 874   server->watches = NULL;
 875   if (watches)
 876     {
 877       SERVER_UNLOCK (server);
 878       result = _dbus_watch_list_set_functions (watches,
 879                                                add_function,
 880                                                remove_function,
 881                                                toggled_function,
 882                                                data,
 883                                                free_data_function);
 884       SERVER_LOCK (server);
 885     }
 886   else
 887     {
 888       _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
 889       result = FALSE;
 890     }
 891   server->watches = watches;
 892   SERVER_UNLOCK (server);
 893
 894   return result;
 895 }
 896
 897 /**
 898  * Sets the timeout functions for the connection. These functions are
 899  * responsible for making the application's main loop aware of timeouts.
 900  *
 901  * This function behaves exactly like dbus_connection_set_timeout_functions();
 902  * see the documentation for that routine.
 903  *
 904  * @param server the server.
 905  * @param add_function function to add a timeout.
 906  * @param remove_function function to remove a timeout.
 907  * @param toggled_function function to notify when the timeout is enabled/disabled
 908  * @param data data to pass to add_function and remove_function.
 909  * @param free_data_function function to be called to free the data.
 910  * @returns #FALSE on failure (no memory)
 911  */
 912 dbus_bool_t
 913 dbus_server_set_timeout_functions (DBusServer                *server,
 914                                    DBusAddTimeoutFunction     add_function,
 915                                    DBusRemoveTimeoutFunction  remove_function,
 916                                    DBusTimeoutToggledFunction toggled_function,
 917                                    void                      *data,
 918                                    DBusFreeFunction           free_data_function)
 919 {
 920   dbus_bool_t result;
 921   DBusTimeoutList *timeouts;
 922
 923   _dbus_return_val_if_fail (server != NULL, FALSE);
 924
 925   SERVER_LOCK (server);
 926   timeouts = server->timeouts;
 927   server->timeouts = NULL;
 928   if (timeouts)
 929     {
 930       SERVER_UNLOCK (server);
 931       result = _dbus_timeout_list_set_functions (timeouts,
 932                                                  add_function,
 933                                                  remove_function,
 934                                                  toggled_function,
 935                                                  data,
 936                                                  free_data_function);
 937       SERVER_LOCK (server);
 938     }
 939   else
 940     {
 941       _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
 942       result = FALSE;
 943     }
 944   server->timeouts = timeouts;
 945   SERVER_UNLOCK (server);
 946
 947   return result;
 948 }
 949
 950 /**
 951  * Sets the authentication mechanisms that this server offers
 952  * to clients, as a list of SASL mechanisms. This function
 953  * only affects connections created *after* it is called.
 954  * Pass #NULL instead of an array to use all available mechanisms.
 955  *
 956  * @param server the server
 957  * @param mechanisms #NULL-terminated array of mechanisms
 958  * @returns #FALSE if no memory
 959  */
 960 dbus_bool_t
 961 dbus_server_set_auth_mechanisms (DBusServer  *server,
 962                                  const char **mechanisms)
 963 {
 964   char **copy;
 965
 966   _dbus_return_val_if_fail (server != NULL, FALSE);
 967
 968   SERVER_LOCK (server);
 969
 970   if (mechanisms != NULL)
 971     {
 972       copy = _dbus_dup_string_array (mechanisms);
 973       if (copy == NULL)
 974         return FALSE;
 975     }
 976   else
 977     copy = NULL;
 978
 979   dbus_free_string_array (server->auth_mechanisms);
 980   server->auth_mechanisms = copy;
 981
 982   SERVER_UNLOCK (server);
 983
 984   return TRUE;
 985 }
 986
 987
 988 static DBusDataSlotAllocator slot_allocator;
 989 _DBUS_DEFINE_GLOBAL_LOCK (server_slots);
 990
 991 /**
 992  * Allocates an integer ID to be used for storing application-specific
 993  * data on any DBusServer. The allocated ID may then be used
 994  * with dbus_server_set_data() and dbus_server_get_data().
 995  * The slot must be initialized with -1. If a nonnegative
 996  * slot is passed in, the refcount is incremented on that
 997  * slot, rather than creating a new slot.
 998  *
 999  * The allocated slot is global, i.e. all DBusServer objects will have
1000  * a slot with the given integer ID reserved.
1001  *
1002  * @param slot_p address of global variable storing the slot ID
1003  * @returns #FALSE on no memory
1004  */
1005 dbus_bool_t
1006 dbus_server_allocate_data_slot (dbus_int32_t *slot_p)
1007 {
1008   return _dbus_data_slot_allocator_alloc (&slot_allocator,
1009                                           (DBusMutex **)&_DBUS_LOCK_NAME (server_slots),
1010                                           slot_p);
1011 }
1012
1013 /**
1014  * Deallocates a global ID for server data slots.
1015  * dbus_server_get_data() and dbus_server_set_data()
1016  * may no longer be used with this slot.
1017  * Existing data stored on existing DBusServer objects
1018  * will be freed when the server is finalized,
1019  * but may not be retrieved (and may only be replaced
1020  * if someone else reallocates the slot).
1021  *
1022  * @param slot_p address of the slot to deallocate
1023  */
1024 void
1025 dbus_server_free_data_slot (dbus_int32_t *slot_p)
1026 {
1027   _dbus_return_if_fail (*slot_p >= 0);
1028
1029   _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
1030 }
1031
1032 /**
1033  * Stores a pointer on a DBusServer, along
1034  * with an optional function to be used for freeing
1035  * the data when the data is set again, or when
1036  * the server is finalized. The slot number
1037  * must have been allocated with dbus_server_allocate_data_slot().
1038  *
1039  * @param server the server
1040  * @param slot the slot number
1041  * @param data the data to store
1042  * @param free_data_func finalizer function for the data
1043  * @returns #TRUE if there was enough memory to store the data
1044  */
1045 dbus_bool_t
1046 dbus_server_set_data (DBusServer       *server,
1047                       int               slot,
1048                       void             *data,
1049                       DBusFreeFunction  free_data_func)
1050 {
1051   DBusFreeFunction old_free_func;
1052   void *old_data;
1053   dbus_bool_t retval;
1054
1055   _dbus_return_val_if_fail (server != NULL, FALSE);
1056
1057   SERVER_LOCK (server);
1058
1059   retval = _dbus_data_slot_list_set (&slot_allocator,
1060                                      &server->slot_list,
1061                                      slot, data, free_data_func,
1062                                      &old_free_func, &old_data);
1063
1064
1065   SERVER_UNLOCK (server);
1066
1067   if (retval)
1068     {
1069       /* Do the actual free outside the server lock */
1070       if (old_free_func)
1071         (* old_free_func) (old_data);
1072     }
1073
1074   return retval;
1075 }
1076
1077 /**
1078  * Retrieves data previously set with dbus_server_set_data().
1079  * The slot must still be allocated (must not have been freed).
1080  *
1081  * @param server the server
1082  * @param slot the slot to get data from
1083  * @returns the data, or #NULL if not found
1084  */
1085 void*
1086 dbus_server_get_data (DBusServer   *server,
1087                       int           slot)
1088 {
1089   void *res;
1090
1091   _dbus_return_val_if_fail (server != NULL, NULL);
1092
1093   SERVER_LOCK (server);
1094
1095   res = _dbus_data_slot_list_get (&slot_allocator,
1096                                   &server->slot_list,
1097                                   slot);
1098
1099   SERVER_UNLOCK (server);
1100
1101   return res;
1102 }
1103
1104 /** @} */
1105
1106 #ifdef DBUS_BUILD_TESTS
1107 #include "dbus-test.h"
1108
1109 dbus_bool_t
1110 _dbus_server_test (void)
1111 {
1112   const char *valid_addresses[] = {
1113     "tcp:port=1234",
1114     "unix:path=./boogie",
1115     "tcp:host=localhost,port=1234",
1116     "tcp:host=localhost,port=1234;tcp:port=5678",
1117     "tcp:port=1234;unix:path=./boogie",
1118   };
1119
1120   DBusServer *server;
1121   int i;
1122
1123   for (i = 0; i < _DBUS_N_ELEMENTS (valid_addresses); i++)
1124     {
1125       DBusError error;
1126
1127       /* FIXME um, how are the two tests here different? */
1128
1129       dbus_error_init (&error);
1130       server = dbus_server_listen (valid_addresses[i], &error);
1131       if (server == NULL)
1132         {
1133           _dbus_warn ("server listen error: %s: %s\n", error.name, error.message);
1134           dbus_error_free (&error);
1135           _dbus_assert_not_reached ("Failed to listen for valid address.");
1136         }
1137
1138       dbus_server_disconnect (server);
1139       dbus_server_unref (server);
1140
1141       /* Try disconnecting before unreffing */
1142       server = dbus_server_listen (valid_addresses[i], &error);
1143       if (server == NULL)
1144         {
1145           _dbus_warn ("server listen error: %s: %s\n", error.name, error.message);
1146           dbus_error_free (&error);
1147           _dbus_assert_not_reached ("Failed to listen for valid address.");
1148         }
1149
1150       dbus_server_disconnect (server);
1151       dbus_server_unref (server);
1152     }
1153
1154   return TRUE;
1155 }
1156
1157 #endif /* DBUS_BUILD_TESTS */