Pool sizes redefined and cleanup
[platform/upstream/dbus.git] / dbus / dbus-bus.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-bus.c  Convenience functions for communicating with the bus.
3  *
4  * Copyright (C) 2003  CodeFactory AB
5  * Copyright (C) 2003  Red Hat, Inc.
6  *
7  * Licensed under the Academic Free License version 2.1
8  * 
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  * 
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22  *
23  */
24
25 #include <config.h>
26 #include "dbus-bus.h"
27 #include "dbus-protocol.h"
28 #include "dbus-internals.h"
29 #include "dbus-message.h"
30 #include "dbus-marshal-validate.h"
31 #include "dbus-threads-internal.h"
32 #include "dbus-connection-internal.h"
33 #include "dbus-string.h"
34 #include "dbus-transport-kdbus.h"
35 #include <stdlib.h>
36
37 /**
38  * @defgroup DBusBus Message bus APIs
39  * @ingroup DBus
40  * @brief Functions for communicating with the message bus
41  *
42  * dbus_bus_get() allows all modules and libraries in a given
43  * process to share the same connection to the bus daemon by storing
44  * the connection globally.
45  *
46  * All other functions in this module are just convenience functions;
47  * most of them invoke methods on the bus daemon, by sending method
48  * call messages to #DBUS_SERVICE_DBUS. These convenience functions
49  * often make blocking method calls. If you don't want to block,
50  * you can send the method call messages manually in the same way
51  * you would any other method call message.
52  *
53  * This module is the only one in libdbus that's specific to
54  * communicating with the message bus daemon. The rest of the API can
55  * also be used for connecting to another application directly.
56  * 
57  * @todo right now the default address of the system bus is hardcoded,
58  * so if you change it in the global config file suddenly you have to
59  * set DBUS_SYSTEM_BUS_ADDRESS env variable.  Might be nice if the
60  * client lib somehow read the config file, or if the bus on startup
61  * somehow wrote out its address to a well-known spot, but might also
62  * not be worth it.
63  */
64
65 /**
66  * @defgroup DBusBusInternals Message bus APIs internals
67  * @ingroup DBusInternals
68  * @brief Internals of functions for communicating with the message bus
69  *
70  * @{
71  */
72
73 /**
74  * Block of message-bus-related data we attach to each
75  * #DBusConnection used with these convenience functions.
76  *
77  */
78 typedef struct
79 {
80   DBusConnection *connection; /**< Connection we're associated with */
81   char *unique_name; /**< Unique name of this connection */
82
83   unsigned int is_well_known : 1; /**< Is one of the well-known connections in our global array */
84 } BusData;
85
86 /** The slot we have reserved to store BusData.
87  */
88 static dbus_int32_t bus_data_slot = -1;
89
90 /** Number of bus types */
91 #define N_BUS_TYPES 3
92
93 static DBusConnection *bus_connections[N_BUS_TYPES];
94 static char *bus_connection_addresses[N_BUS_TYPES] = { NULL, NULL, NULL };
95
96 static DBusBusType activation_bus_type = DBUS_BUS_STARTER;
97
98 static dbus_bool_t initialized = FALSE;
99
100 static void
101 addresses_shutdown_func (void *data)
102 {
103   int i;
104
105   i = 0;
106   while (i < N_BUS_TYPES)
107     {
108       if (bus_connections[i] != NULL)
109         _dbus_warn_check_failed ("dbus_shutdown() called but connections were still live. This probably means the application did not drop all its references to bus connections.\n");
110       
111       dbus_free (bus_connection_addresses[i]);
112       bus_connection_addresses[i] = NULL;
113       ++i;
114     }
115
116   activation_bus_type = DBUS_BUS_STARTER;
117
118   initialized = FALSE;
119 }
120
121 static dbus_bool_t
122 get_from_env (char           **connection_p,
123               const char      *env_var)
124 {
125   const char *s;
126   
127   _dbus_assert (*connection_p == NULL);
128   
129   s = _dbus_getenv (env_var);
130   if (s == NULL || *s == '\0')
131     return TRUE; /* successfully didn't use the env var */
132   else
133     {
134       *connection_p = _dbus_strdup (s);
135       return *connection_p != NULL;
136     }
137 }
138
139 static dbus_bool_t
140 init_session_address (void)
141 {
142   dbus_bool_t retval;
143  
144   retval = FALSE;
145
146   /* First, look in the environment.  This is the normal case on 
147    * freedesktop.org/Unix systems. */
148   get_from_env (&bus_connection_addresses[DBUS_BUS_SESSION],
149                      "DBUS_SESSION_BUS_ADDRESS");
150   if (bus_connection_addresses[DBUS_BUS_SESSION] == NULL)
151     {
152       dbus_bool_t supported;
153       DBusString addr;
154       DBusError error = DBUS_ERROR_INIT;
155
156       if (!_dbus_string_init (&addr))
157         return FALSE;
158
159       supported = FALSE;
160       /* So it's not in the environment - let's try a platform-specific method.
161        * On MacOS, this involves asking launchd.  On Windows (not specified yet)
162        * we might do a COM lookup.
163        * Ignore errors - if we failed, fall back to autolaunch. */
164       retval = _dbus_lookup_session_address (&supported, &addr, &error);
165       if (supported && retval)
166         {
167           retval =_dbus_string_steal_data (&addr, &bus_connection_addresses[DBUS_BUS_SESSION]);
168         }
169       else if (supported && !retval)
170         {
171           if (dbus_error_is_set(&error))
172             _dbus_warn ("Dynamic session lookup supported but failed: %s\n", error.message);
173           else
174             _dbus_warn ("Dynamic session lookup supported but failed silently\n");
175         }
176       _dbus_string_free (&addr);
177     }
178   else
179     retval = TRUE;
180
181   if (!retval)
182     return FALSE;
183
184   /* We have a hard-coded (but compile-time-configurable) fallback address for
185    * the session bus. */
186   if (bus_connection_addresses[DBUS_BUS_SESSION] == NULL)
187     bus_connection_addresses[DBUS_BUS_SESSION] =
188       _dbus_strdup (DBUS_SESSION_BUS_CONNECT_ADDRESS);
189
190   if (bus_connection_addresses[DBUS_BUS_SESSION] == NULL)
191     return FALSE;
192
193   return TRUE;
194 }
195
196 static dbus_bool_t
197 init_connections_unlocked (void)
198 {
199   if (!initialized)
200     {
201       const char *s;
202       int i;
203
204       i = 0;
205       while (i < N_BUS_TYPES)
206         {
207           bus_connections[i] = NULL;
208           ++i;
209         }
210
211       /* Don't init these twice, we may run this code twice if
212        * init_connections_unlocked() fails midway through.
213        * In practice, each block below should contain only one
214        * "return FALSE" or running through twice may not
215        * work right.
216        */
217       
218        if (bus_connection_addresses[DBUS_BUS_SYSTEM] == NULL)
219          {
220            _dbus_verbose ("Filling in system bus address...\n");
221            
222            if (!get_from_env (&bus_connection_addresses[DBUS_BUS_SYSTEM],
223                               "DBUS_SYSTEM_BUS_ADDRESS"))
224              return FALSE;
225          }
226
227                   
228        if (bus_connection_addresses[DBUS_BUS_SYSTEM] == NULL)
229          {
230            /* Use default system bus address if none set in environment */
231            bus_connection_addresses[DBUS_BUS_SYSTEM] =
232              _dbus_strdup (DBUS_SYSTEM_BUS_DEFAULT_ADDRESS);
233
234            if (bus_connection_addresses[DBUS_BUS_SYSTEM] == NULL)
235              return FALSE;
236            
237            _dbus_verbose ("  used default system bus \"%s\"\n",
238                           bus_connection_addresses[DBUS_BUS_SYSTEM]);
239          }
240        else
241          _dbus_verbose ("  used env var system bus \"%s\"\n",
242                         bus_connection_addresses[DBUS_BUS_SYSTEM]);
243           
244       if (bus_connection_addresses[DBUS_BUS_SESSION] == NULL)
245         {
246           _dbus_verbose ("Filling in session bus address...\n");
247           
248           if (!init_session_address ())
249             return FALSE;
250
251           _dbus_verbose ("  \"%s\"\n", bus_connection_addresses[DBUS_BUS_SESSION] ?
252                          bus_connection_addresses[DBUS_BUS_SESSION] : "none set");
253         }
254
255       if (bus_connection_addresses[DBUS_BUS_STARTER] == NULL)
256         {
257           _dbus_verbose ("Filling in activation bus address...\n");
258           
259           if (!get_from_env (&bus_connection_addresses[DBUS_BUS_STARTER],
260                              "DBUS_STARTER_ADDRESS"))
261             return FALSE;
262           
263           _dbus_verbose ("  \"%s\"\n", bus_connection_addresses[DBUS_BUS_STARTER] ?
264                          bus_connection_addresses[DBUS_BUS_STARTER] : "none set");
265         }
266
267
268       if (bus_connection_addresses[DBUS_BUS_STARTER] != NULL)
269         {
270           s = _dbus_getenv ("DBUS_STARTER_BUS_TYPE");
271               
272           if (s != NULL)
273             {
274               _dbus_verbose ("Bus activation type was set to \"%s\"\n", s);
275                   
276               if (strcmp (s, "system") == 0)
277                 activation_bus_type = DBUS_BUS_SYSTEM;
278               else if (strcmp (s, "session") == 0)
279                 activation_bus_type = DBUS_BUS_SESSION;
280             }
281         }
282       else
283         {
284           /* Default to the session bus instead if available */
285           if (bus_connection_addresses[DBUS_BUS_SESSION] != NULL)
286             {
287               bus_connection_addresses[DBUS_BUS_STARTER] =
288                 _dbus_strdup (bus_connection_addresses[DBUS_BUS_SESSION]);
289               if (bus_connection_addresses[DBUS_BUS_STARTER] == NULL)
290                 return FALSE;
291             }
292         }
293       
294       /* If we return FALSE we have to be sure that restarting
295        * the above code will work right
296        */
297       
298       if (!_dbus_setenv ("DBUS_ACTIVATION_ADDRESS", NULL))
299         return FALSE;
300
301       if (!_dbus_setenv ("DBUS_ACTIVATION_BUS_TYPE", NULL))
302         return FALSE;
303       
304       if (!_dbus_register_shutdown_func (addresses_shutdown_func,
305                                          NULL))
306         return FALSE;
307       
308       initialized = TRUE;
309     }
310
311   return initialized;
312 }
313
314 static void
315 bus_data_free (void *data)
316 {
317   BusData *bd = data;
318   
319   if (bd->is_well_known)
320     {
321       int i;
322
323       if (!_DBUS_LOCK (bus))
324         _dbus_assert_not_reached ("global locks should have been initialized "
325             "when we attached bus data");
326
327       /* We may be stored in more than one slot */
328       /* This should now be impossible - these slots are supposed to
329        * be cleared on disconnect, so should not need to be cleared on
330        * finalize
331        */
332       i = 0;
333       while (i < N_BUS_TYPES)
334         {
335           if (bus_connections[i] == bd->connection)
336             bus_connections[i] = NULL;
337           
338           ++i;
339         }
340       _DBUS_UNLOCK (bus);
341     }
342   
343   dbus_free (bd->unique_name);
344   dbus_free (bd);
345
346   dbus_connection_free_data_slot (&bus_data_slot);
347 }
348
349 static BusData*
350 ensure_bus_data (DBusConnection *connection)
351 {
352   BusData *bd;
353
354   if (!dbus_connection_allocate_data_slot (&bus_data_slot))
355     return NULL;
356
357   bd = dbus_connection_get_data (connection, bus_data_slot);
358   if (bd == NULL)
359     {      
360       bd = dbus_new0 (BusData, 1);
361       if (bd == NULL)
362         {
363           dbus_connection_free_data_slot (&bus_data_slot);
364           return NULL;
365         }
366
367       bd->connection = connection;
368       
369       if (!dbus_connection_set_data (connection, bus_data_slot, bd,
370                                      bus_data_free))
371         {
372           dbus_free (bd);
373           dbus_connection_free_data_slot (&bus_data_slot);
374           return NULL;
375         }
376
377       /* Data slot refcount now held by the BusData */
378     }
379   else
380     {
381       dbus_connection_free_data_slot (&bus_data_slot);
382     }
383
384   return bd;
385 }
386
387 /**
388  * Internal function that checks to see if this
389  * is a shared connection owned by the bus and if it is unref it.
390  *
391  * @param connection a connection that has been disconnected.
392  */
393 void
394 _dbus_bus_notify_shared_connection_disconnected_unlocked (DBusConnection *connection)
395 {
396   int i;
397
398   if (!_DBUS_LOCK (bus))
399     {
400       /* If it was in bus_connections, we would have initialized global locks
401        * when we added it. So, it can't be. */
402       return;
403     }
404
405   /* We are expecting to have the connection saved in only one of these
406    * slots, but someone could in a pathological case set system and session
407    * bus to the same bus or something. Or set one of them to the starter
408    * bus without setting the starter bus type in the env variable.
409    * So we don't break the loop as soon as we find a match.
410    */
411   for (i = 0; i < N_BUS_TYPES; ++i)
412     {
413       if (bus_connections[i] == connection)
414         {
415           bus_connections[i] = NULL;
416         }
417     }
418
419   _DBUS_UNLOCK (bus);
420 }
421
422 static DBusConnection *
423 internal_bus_get (DBusBusType  type,
424                   dbus_bool_t  private,
425                   DBusError   *error)
426 {
427   const char *address;
428   DBusConnection *connection;
429   BusData *bd;
430   DBusBusType address_type;
431
432   _dbus_return_val_if_fail (type >= 0 && type < N_BUS_TYPES, NULL);
433   _dbus_return_val_if_error_is_set (error, NULL);
434
435   connection = NULL;
436
437   if (!_DBUS_LOCK (bus))
438     {
439       _DBUS_SET_OOM (error);
440       /* do not "goto out", that would try to unlock */
441       return NULL;
442     }
443
444   if (!init_connections_unlocked ())
445     {
446       _DBUS_SET_OOM (error);
447       goto out;
448     }
449
450   /* We want to use the activation address even if the
451    * activating bus is the session or system bus,
452    * per the spec.
453    */
454   address_type = type;
455   
456   /* Use the real type of the activation bus for getting its
457    * connection, but only if the real type's address is available. (If
458    * the activating bus isn't a well-known bus then
459    * activation_bus_type == DBUS_BUS_STARTER)
460    */
461   if (type == DBUS_BUS_STARTER &&
462       bus_connection_addresses[activation_bus_type] != NULL)
463     type = activation_bus_type;
464   
465   if (!private && bus_connections[type] != NULL)
466     {
467       connection = bus_connections[type];
468       dbus_connection_ref (connection);
469       goto out;
470     }
471
472   address = bus_connection_addresses[address_type];
473   if (address == NULL)
474     {
475       dbus_set_error (error, DBUS_ERROR_FAILED,
476                       "Unable to determine the address of the message bus (try 'man dbus-launch' and 'man dbus-daemon' for help)");
477       goto out;
478     }
479
480   if (private)
481     connection = dbus_connection_open_private (address, error);
482   else
483     connection = dbus_connection_open (address, error);
484   
485   if (!connection)
486     {
487       goto out;
488     }
489
490   _dbus_verbose (" !!! dbus_connection_open finished successfully   !!!! \n");  //todo RP to be removed
491
492   if (!dbus_bus_register (connection, error))
493     {
494       _dbus_connection_close_possibly_shared (connection);
495       dbus_connection_unref (connection);
496       connection = NULL;
497       goto out;
498     }
499
500   if (!private)
501     {
502       /* store a weak ref to the connection (dbus-connection.c is
503        * supposed to have a strong ref that it drops on disconnect,
504        * since this is a shared connection)
505        */
506       bus_connections[type] = connection;
507     }
508
509   /* By default we're bound to the lifecycle of
510    * the message bus.
511    */
512   dbus_connection_set_exit_on_disconnect (connection,
513                                           TRUE);
514
515   if (!_DBUS_LOCK (bus_datas))
516     _dbus_assert_not_reached ("global locks were initialized already");
517
518   bd = ensure_bus_data (connection);
519   _dbus_assert (bd != NULL); /* it should have been created on
520                                 register, so OOM not possible */
521   bd->is_well_known = TRUE;
522   _DBUS_UNLOCK (bus_datas);
523
524 out:
525   /* Return a reference to the caller, or NULL with error set. */
526   if (connection == NULL)
527     _DBUS_ASSERT_ERROR_IS_SET (error);
528
529   _DBUS_UNLOCK (bus);
530   return connection;
531 }
532
533
534 /** @} */ /* end of implementation details docs */
535
536 /**
537  * @addtogroup DBusBus
538  * @{
539  */
540
541 /**
542  * Connects to a bus daemon and registers the client with it.  If a
543  * connection to the bus already exists, then that connection is
544  * returned.  The caller of this function owns a reference to the bus.
545  *
546  * The caller may NOT call dbus_connection_close() on this connection;
547  * see dbus_connection_open() and dbus_connection_close() for details
548  * on that.
549  *
550  * If this function obtains a new connection object never before
551  * returned from dbus_bus_get(), it will call
552  * dbus_connection_set_exit_on_disconnect(), so the application
553  * will exit if the connection closes. You can undo this
554  * by calling dbus_connection_set_exit_on_disconnect() yourself
555  * after you get the connection.
556  *
557  * dbus_bus_get() calls dbus_bus_register() for you.
558  * 
559  * If returning a newly-created connection, this function will block
560  * until authentication and bus registration are complete.
561  * 
562  * @param type bus type
563  * @param error address where an error can be returned.
564  * @returns a #DBusConnection with new ref
565  */
566 DBusConnection *
567 dbus_bus_get (DBusBusType  type,
568               DBusError   *error)
569 {
570   return internal_bus_get (type, FALSE, error);
571 }
572
573 /**
574  * Connects to a bus daemon and registers the client with it as with
575  * dbus_bus_register().  Unlike dbus_bus_get(), always creates a new
576  * connection. This connection will not be saved or recycled by
577  * libdbus. Caller owns a reference to the bus and must either close
578  * it or know it to be closed prior to releasing this reference.
579  *
580  * See dbus_connection_open_private() for more details on when to
581  * close and unref this connection.
582  *
583  * This function calls
584  * dbus_connection_set_exit_on_disconnect() on the new connection, so the application
585  * will exit if the connection closes. You can undo this
586  * by calling dbus_connection_set_exit_on_disconnect() yourself
587  * after you get the connection.
588  *
589  * dbus_bus_get_private() calls dbus_bus_register() for you.
590  *
591  * This function will block until authentication and bus registration
592  * are complete.
593  *
594  * @param type bus type
595  * @param error address where an error can be returned.
596  * @returns a DBusConnection with new ref
597  */
598 DBusConnection *
599 dbus_bus_get_private (DBusBusType  type,
600                       DBusError   *error)
601 {
602   return internal_bus_get (type, TRUE, error);
603 }
604
605 /**
606  * Registers a connection with the bus. This must be the first
607  * thing an application does when connecting to the message bus.
608  * If registration succeeds, the unique name will be set,
609  * and can be obtained using dbus_bus_get_unique_name().
610  *
611  * This function will block until registration is complete.
612  *
613  * If the connection has already registered with the bus
614  * (determined by checking whether dbus_bus_get_unique_name()
615  * returns a non-#NULL value), then this function does nothing.
616  *
617  * If you use dbus_bus_get() or dbus_bus_get_private() this
618  * function will be called for you.
619  * 
620  * @note Just use dbus_bus_get() or dbus_bus_get_private() instead of
621  * dbus_bus_register() and save yourself some pain. Using
622  * dbus_bus_register() manually is only useful if you have your
623  * own custom message bus not found in #DBusBusType.
624  *
625  * If you open a bus connection with dbus_connection_open() or
626  * dbus_connection_open_private() you will have to dbus_bus_register()
627  * yourself, or make the appropriate registration method calls
628  * yourself. If you send the method calls yourself, call
629  * dbus_bus_set_unique_name() with the unique bus name you get from
630  * the bus.
631  *
632  * For shared connections (created with dbus_connection_open()) in a
633  * multithreaded application, you can't really make the registration
634  * calls yourself, because you don't know whether some other thread is
635  * also registering, and the bus will kick you off if you send two
636  * registration messages.
637  *
638  * If you use dbus_bus_register() however, there is a lock that
639  * keeps both apps from registering at the same time.
640  *
641  * The rule in a multithreaded app, then, is that dbus_bus_register()
642  * must be used to register, or you need to have your own locks that
643  * all threads in the app will respect.
644  *
645  * In a single-threaded application you can register by hand instead
646  * of using dbus_bus_register(), as long as you check
647  * dbus_bus_get_unique_name() to see if a unique name has already been
648  * stored by another thread before you send the registration messages.
649  * 
650  * @param connection the connection
651  * @param error place to store errors
652  * @returns #TRUE on success
653  */
654 dbus_bool_t
655 dbus_bus_register (DBusConnection *connection,
656                    DBusError      *error)
657 {
658   DBusMessage *message, *reply;
659   char *name = NULL;
660   BusData *bd;
661   dbus_bool_t retval;
662
663   _dbus_return_val_if_fail (connection != NULL, FALSE);
664   _dbus_return_val_if_error_is_set (error, FALSE);
665
666   retval = FALSE;
667   message = NULL;
668   reply = NULL;
669
670   if (!_DBUS_LOCK (bus_datas))
671     {
672       _DBUS_SET_OOM (error);
673       /* do not "goto out", that would try to unlock */
674       return FALSE;
675     }
676
677   bd = ensure_bus_data (connection);
678   if (bd == NULL)
679     {
680       _DBUS_SET_OOM (error);
681       goto out;
682     }
683
684   if (bd->unique_name != NULL)
685     {
686       _dbus_verbose ("Ignoring attempt to register the same DBusConnection %s with the message bus a second time.\n",
687                      bd->unique_name);
688       /* Success! */
689       retval = TRUE;
690       goto out;
691     }
692   if(dbus_transport_is_kdbus(connection))
693   {
694           name = malloc(18);
695           if(!bus_register_kdbus(name, connection, error))
696                   goto out;
697
698           if(!bus_register_policy_kdbus(name, connection, error))
699                 goto out;
700
701           dbus_connection_set_is_authenticated(connection);
702   }
703   else
704   {
705           message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
706                                                                                           DBUS_PATH_DBUS,
707                                                                                           DBUS_INTERFACE_DBUS,
708                                                                                           "Hello");
709           if (!message)
710                 {
711                   _DBUS_SET_OOM (error);
712                   goto out;
713                 }
714
715           reply = dbus_connection_send_with_reply_and_block (connection, message, -1, error);
716
717           if (reply == NULL)
718                 goto out;
719           else if (dbus_set_error_from_message (error, reply))
720                 goto out;
721           else if (!dbus_message_get_args (reply, error,
722                                                                            DBUS_TYPE_STRING, &name,
723                                                                            DBUS_TYPE_INVALID))
724                 goto out;
725   }
726
727   bd->unique_name = _dbus_strdup (name);
728   if (bd->unique_name == NULL)
729     {
730       _DBUS_SET_OOM (error);
731       goto out;
732     }
733   //_dbus_verbose("-- Our uniqe name is: %s\n", bd->unique_name);
734   retval = TRUE;
735   
736  out:
737   _DBUS_UNLOCK (bus_datas);
738
739   if (message)
740     dbus_message_unref (message);
741   else if (name)
742           free(name);
743
744   if (reply)
745     dbus_message_unref (reply);
746
747   if (!retval)
748     _DBUS_ASSERT_ERROR_IS_SET (error);
749
750   return retval;
751 }
752
753
754 /**
755  * Sets the unique name of the connection, as assigned by the message
756  * bus.  Can only be used if you registered with the bus manually
757  * (i.e. if you did not call dbus_bus_register()). Can only be called
758  * once per connection.  After the unique name is set, you can get it
759  * with dbus_bus_get_unique_name().
760  *
761  * The only reason to use this function is to re-implement the
762  * equivalent of dbus_bus_register() yourself. One (probably unusual)
763  * reason to do that might be to do the bus registration call
764  * asynchronously instead of synchronously.
765  *
766  * @note Just use dbus_bus_get() or dbus_bus_get_private(), or worst
767  * case dbus_bus_register(), instead of messing with this
768  * function. There's really no point creating pain for yourself by
769  * doing things manually.
770  *
771  * It's hard to use this function safely on shared connections
772  * (created by dbus_connection_open()) in a multithreaded application,
773  * because only one registration attempt can be sent to the bus. If
774  * two threads are both sending the registration message, there is no
775  * mechanism in libdbus itself to avoid sending it twice.
776  *
777  * Thus, you need a way to coordinate which thread sends the
778  * registration attempt; which also means you know which thread
779  * will call dbus_bus_set_unique_name(). If you don't know
780  * about all threads in the app (for example, if some libraries
781  * you're using might start libdbus-using threads), then you
782  * need to avoid using this function on shared connections.
783  *
784  * @param connection the connection
785  * @param unique_name the unique name
786  * @returns #FALSE if not enough memory
787  */
788 dbus_bool_t
789 dbus_bus_set_unique_name (DBusConnection *connection,
790                           const char     *unique_name)
791 {
792   BusData *bd;
793   dbus_bool_t success = FALSE;
794
795   _dbus_return_val_if_fail (connection != NULL, FALSE);
796   _dbus_return_val_if_fail (unique_name != NULL, FALSE);
797
798   if (!_DBUS_LOCK (bus_datas))
799     {
800       /* do not "goto out", that would try to unlock */
801       return FALSE;
802     }
803
804   bd = ensure_bus_data (connection);
805   if (bd == NULL)
806     goto out;
807
808   _dbus_assert (bd->unique_name == NULL);
809   
810   bd->unique_name = _dbus_strdup (unique_name);
811   success = bd->unique_name != NULL;
812
813 out:
814   _DBUS_UNLOCK (bus_datas);
815   
816   return success;
817 }
818
819 /**
820  * Gets the unique name of the connection as assigned by the message
821  * bus. Only possible after the connection has been registered with
822  * the message bus. All connections returned by dbus_bus_get() or
823  * dbus_bus_get_private() have been successfully registered.
824  *
825  * The name remains valid until the connection is freed, and
826  * should not be freed by the caller.
827  *
828  * Other than dbus_bus_get(), there are two ways to set the unique
829  * name; one is dbus_bus_register(), the other is
830  * dbus_bus_set_unique_name().  You are responsible for calling
831  * dbus_bus_set_unique_name() if you register by hand instead of using
832  * dbus_bus_register().
833  * 
834  * @param connection the connection
835  * @returns the unique name or #NULL on error
836  */
837 const char*
838 dbus_bus_get_unique_name (DBusConnection *connection)
839 {
840   BusData *bd;
841   const char *unique_name = NULL;
842
843   _dbus_return_val_if_fail (connection != NULL, NULL);
844
845   if (!_DBUS_LOCK (bus_datas))
846     {
847       /* We'd have initialized locks when we gave it its unique name, if it
848        * had one. Don't "goto out", that would try to unlock. */
849       return NULL;
850     }
851
852   bd = ensure_bus_data (connection);
853   if (bd == NULL)
854     goto out;
855
856   unique_name = bd->unique_name;
857
858 out:
859   _DBUS_UNLOCK (bus_datas);
860
861   return unique_name;
862 }
863
864 /**
865  * Asks the bus to return the UID the named connection authenticated
866  * as, if any.  Only works on UNIX; only works for connections on the
867  * same machine as the bus. If you are not on the same machine as the
868  * bus, then calling this is probably a bad idea, since the UID will
869  * mean little to your application.
870  *
871  * For the system message bus you're guaranteed to be on the same
872  * machine since it only listens on a UNIX domain socket (at least,
873  * as shipped by default).
874  *
875  * This function only works for connections that authenticated as
876  * a UNIX user, right now that includes all bus connections, but
877  * it's very possible to have connections with no associated UID.
878  * So check for errors and do something sensible if they happen.
879  * 
880  * This function will always return an error on Windows.
881  * 
882  * @param connection the connection
883  * @param name a name owned by the connection
884  * @param error location to store the error
885  * @returns the unix user id, or ((unsigned)-1) if error is set
886  */ 
887 unsigned long
888 dbus_bus_get_unix_user (DBusConnection *connection,
889                         const char     *name,
890                         DBusError      *error)
891 {
892   DBusMessage *message, *reply;
893   dbus_uint32_t uid;
894
895   _dbus_return_val_if_fail (connection != NULL, DBUS_UID_UNSET);
896   _dbus_return_val_if_fail (name != NULL, DBUS_UID_UNSET);
897   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), DBUS_UID_UNSET);
898   _dbus_return_val_if_error_is_set (error, DBUS_UID_UNSET);
899   
900   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
901                                           DBUS_PATH_DBUS,
902                                           DBUS_INTERFACE_DBUS,
903                                           "GetConnectionUnixUser");
904
905   if (message == NULL)
906     {
907       _DBUS_SET_OOM (error);
908       return DBUS_UID_UNSET;
909     }
910  
911   if (!dbus_message_append_args (message,
912                                  DBUS_TYPE_STRING, &name,
913                                  DBUS_TYPE_INVALID))
914     {
915       dbus_message_unref (message);
916       _DBUS_SET_OOM (error);
917       return DBUS_UID_UNSET;
918     }
919   
920   reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
921                                                      error);
922   
923   dbus_message_unref (message);
924   
925   if (reply == NULL)
926     {
927       _DBUS_ASSERT_ERROR_IS_SET (error);
928       return DBUS_UID_UNSET;
929     }  
930
931   if (dbus_set_error_from_message (error, reply))
932     {
933       _DBUS_ASSERT_ERROR_IS_SET (error);
934       dbus_message_unref (reply);
935       return DBUS_UID_UNSET;
936     }
937   
938   if (!dbus_message_get_args (reply, error,
939                               DBUS_TYPE_UINT32, &uid,
940                               DBUS_TYPE_INVALID))
941     {
942       _DBUS_ASSERT_ERROR_IS_SET (error);
943       dbus_message_unref (reply);
944       return DBUS_UID_UNSET;
945     }
946
947   dbus_message_unref (reply);
948   
949   return (unsigned long) uid;
950 }
951
952 /**
953  * Asks the bus to return its globally unique ID, as described in the
954  * D-Bus specification. For the session bus, this is useful as a way
955  * to uniquely identify each user session. For the system bus,
956  * probably the bus ID is not useful; instead, use the machine ID
957  * since it's accessible without necessarily connecting to the bus and
958  * may be persistent beyond a single bus instance (across reboots for
959  * example). See dbus_get_local_machine_id().
960  *
961  * In addition to an ID for each bus and an ID for each machine, there is
962  * an ID for each address that the bus is listening on; that can
963  * be retrieved with dbus_connection_get_server_id(), though it is
964  * probably not very useful.
965  * 
966  * @param connection the connection
967  * @param error location to store the error
968  * @returns the bus ID or #NULL if error is set
969  */ 
970 char*
971 dbus_bus_get_id (DBusConnection *connection,
972                  DBusError      *error)
973 {
974   DBusMessage *message, *reply;
975   char *id;
976   const char *v_STRING;
977
978   _dbus_return_val_if_fail (connection != NULL, NULL);
979   _dbus_return_val_if_error_is_set (error, NULL);
980   
981   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
982                                           DBUS_PATH_DBUS,
983                                           DBUS_INTERFACE_DBUS,
984                                           "GetId");
985   
986   if (message == NULL)
987     {
988       _DBUS_SET_OOM (error);
989       return NULL;
990     }
991   
992   reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
993                                                      error);
994   
995   dbus_message_unref (message);
996   
997   if (reply == NULL)
998     {
999       _DBUS_ASSERT_ERROR_IS_SET (error);
1000       return NULL;
1001     }  
1002
1003   if (dbus_set_error_from_message (error, reply))
1004     {
1005       _DBUS_ASSERT_ERROR_IS_SET (error);
1006       dbus_message_unref (reply);
1007       return NULL;
1008     }
1009
1010   v_STRING = NULL;
1011   if (!dbus_message_get_args (reply, error,
1012                               DBUS_TYPE_STRING, &v_STRING,
1013                               DBUS_TYPE_INVALID))
1014     {
1015       _DBUS_ASSERT_ERROR_IS_SET (error);
1016       dbus_message_unref (reply);
1017       return NULL;
1018     }
1019
1020   id = _dbus_strdup (v_STRING); /* may be NULL */
1021   
1022   dbus_message_unref (reply);
1023
1024   if (id == NULL)
1025     _DBUS_SET_OOM (error);
1026
1027   /* FIXME it might be nice to cache the ID locally */
1028   
1029   return id;
1030 }
1031
1032 /**
1033  * Asks the bus to assign the given name to this connection by invoking
1034  * the RequestName method on the bus. This method is fully documented
1035  * in the D-Bus specification. For quick reference, the flags and
1036  * result codes are discussed here, but the specification is the
1037  * canonical version of this information.
1038  *
1039  * First you should know that for each bus name, the bus stores
1040  * a queue of connections that would like to own it. Only
1041  * one owns it at a time - called the primary owner. If the primary
1042  * owner releases the name or disconnects, then the next owner in the
1043  * queue atomically takes over.
1044  *
1045  * So for example if you have an application org.freedesktop.TextEditor
1046  * and multiple instances of it can be run, you can have all of them
1047  * sitting in the queue. The first one to start up will receive messages
1048  * sent to org.freedesktop.TextEditor, but if that one exits another
1049  * will become the primary owner and receive messages.
1050  *
1051  * The queue means you don't need to manually watch for the current owner to
1052  * disappear and then request the name again.
1053  *
1054  * When requesting a name, you can specify several flags.
1055  * 
1056  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT and #DBUS_NAME_FLAG_DO_NOT_QUEUE
1057  * are properties stored by the bus for this connection with respect to
1058  * each requested bus name. These properties are stored even if the
1059  * connection is queued and does not become the primary owner.
1060  * You can update these flags by calling RequestName again (even if
1061  * you already own the name).
1062  *
1063  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT means that another requestor of the
1064  * name can take it away from you by specifying #DBUS_NAME_FLAG_REPLACE_EXISTING.
1065  *
1066  * #DBUS_NAME_FLAG_DO_NOT_QUEUE means that if you aren't the primary owner,
1067  * you don't want to be queued up - you only care about being the
1068  * primary owner.
1069  *
1070  * Unlike the other two flags, #DBUS_NAME_FLAG_REPLACE_EXISTING is a property
1071  * of the individual RequestName call, i.e. the bus does not persistently
1072  * associate it with the connection-name pair. If a RequestName call includes
1073  * the #DBUS_NAME_FLAG_REPLACE_EXISTING flag, and the current primary
1074  * owner has #DBUS_NAME_FLAG_ALLOW_REPLACEMENT set, then the current primary
1075  * owner will be kicked off.
1076  *
1077  * If no flags are given, an application will receive the requested
1078  * name only if the name is currently unowned; and it will NOT give
1079  * up the name if another application asks to take it over using
1080  * #DBUS_NAME_FLAG_REPLACE_EXISTING.
1081  *
1082  * This function returns a result code. The possible result codes
1083  * are as follows.
1084  * 
1085  * #DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER means that the name had no
1086  * existing owner, and the caller is now the primary owner; or that
1087  * the name had an owner, and the caller specified
1088  * #DBUS_NAME_FLAG_REPLACE_EXISTING, and the current owner
1089  * specified #DBUS_NAME_FLAG_ALLOW_REPLACEMENT.
1090  *
1091  * #DBUS_REQUEST_NAME_REPLY_IN_QUEUE happens only if the caller does NOT
1092  * specify #DBUS_NAME_FLAG_DO_NOT_QUEUE and either the current owner
1093  * did NOT specify #DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the caller did NOT
1094  * specify #DBUS_NAME_FLAG_REPLACE_EXISTING. In this case the caller ends up 
1095  * in a queue to own the name after the current owner gives it up.
1096  *
1097  * #DBUS_REQUEST_NAME_REPLY_EXISTS happens if the name has an owner
1098  * already and the caller specifies #DBUS_NAME_FLAG_DO_NOT_QUEUE
1099  * and either the current owner has NOT specified 
1100  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the caller did NOT specify 
1101  * #DBUS_NAME_FLAG_REPLACE_EXISTING.
1102  *
1103  * #DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER happens if an application
1104  * requests a name it already owns. (Re-requesting a name is useful if
1105  * you want to change the #DBUS_NAME_FLAG_ALLOW_REPLACEMENT or
1106  * #DBUS_NAME_FLAG_DO_NOT_QUEUE settings.)
1107  *
1108  * When a service represents an application, say "text editor," then
1109  * it should specify #DBUS_NAME_FLAG_ALLOW_REPLACEMENT if it wants
1110  * the last editor started to be the user's editor vs. the first one
1111  * started.  Then any editor that can be the user's editor should
1112  * specify #DBUS_NAME_FLAG_REPLACE_EXISTING to either take over
1113  * (last-started-wins) or be queued up (first-started-wins) according
1114  * to whether #DBUS_NAME_FLAG_ALLOW_REPLACEMENT was given.
1115  *
1116  * Conventionally, single-instance applications often offer a command
1117  * line option called --replace which means to replace the current
1118  * instance.  To implement this, always set
1119  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT when you request your
1120  * application's bus name.  When you lose ownership of your bus name,
1121  * you need to exit.  Look for the signal "NameLost" from
1122  * #DBUS_SERVICE_DBUS and #DBUS_INTERFACE_DBUS (the signal's first
1123  * argument is the bus name that was lost).  If starting up without
1124  * --replace, do not specify #DBUS_NAME_FLAG_REPLACE_EXISTING, and
1125  * exit if you fail to become the bus name owner. If --replace is
1126  * given, ask to replace the old owner.
1127  *
1128  * @param connection the connection
1129  * @param name the name to request
1130  * @param flags flags
1131  * @param error location to store the error
1132  * @returns a result code, -1 if error is set
1133  */ 
1134 int
1135 dbus_bus_request_name (DBusConnection *connection,
1136                        const char     *name,
1137                        unsigned int    flags,
1138                        DBusError      *error)
1139 {
1140         dbus_uint32_t result;
1141
1142         _dbus_return_val_if_fail (connection != NULL, 0);
1143         _dbus_return_val_if_fail (name != NULL, 0);
1144         _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), 0);
1145         _dbus_return_val_if_error_is_set (error, 0);
1146
1147         if(!dbus_transport_is_kdbus(connection))
1148         {
1149                 DBusMessage *message, *reply;
1150
1151                 message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1152                                                                                           DBUS_PATH_DBUS,
1153                                                                                           DBUS_INTERFACE_DBUS,
1154                                                                                           "RequestName");
1155                 if (message == NULL)
1156                 {
1157                   _DBUS_SET_OOM (error);
1158                   return -1;
1159                 }
1160
1161                 if (!dbus_message_append_args (message,
1162                                          DBUS_TYPE_STRING, &name,
1163                                          DBUS_TYPE_UINT32, &flags,
1164                                          DBUS_TYPE_INVALID))
1165                 {
1166                   dbus_message_unref (message);
1167                   _DBUS_SET_OOM (error);
1168                   return -1;
1169                 }
1170
1171                 reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
1172                                                                                                                  error);
1173
1174                 dbus_message_unref (message);
1175
1176                 if (reply == NULL)
1177                 {
1178                   _DBUS_ASSERT_ERROR_IS_SET (error);
1179                   return -1;
1180                 }
1181
1182                 if (dbus_set_error_from_message (error, reply))
1183                 {
1184                   _DBUS_ASSERT_ERROR_IS_SET (error);
1185                   dbus_message_unref (reply);
1186                   return -1;
1187                 }
1188
1189                 if (!dbus_message_get_args (reply, error,
1190                                                                   DBUS_TYPE_UINT32, &result,
1191                                                                   DBUS_TYPE_INVALID))
1192                 {
1193                   _DBUS_ASSERT_ERROR_IS_SET (error);
1194                   dbus_message_unref (reply);
1195                   return -1;
1196                 }
1197
1198                 dbus_message_unref (reply);
1199         }
1200         else
1201         {
1202                 if(!bus_register_policy_kdbus(name, connection, error))
1203                         return -1;
1204
1205                 result = bus_request_name_kdbus(connection, name, flags, error);
1206         }
1207   
1208         return result;
1209 }
1210
1211
1212 /**
1213  * Asks the bus to unassign the given name from this connection by
1214  * invoking the ReleaseName method on the bus. The "ReleaseName"
1215  * method is canonically documented in the D-Bus specification.
1216  *
1217  * Possible results are: #DBUS_RELEASE_NAME_REPLY_RELEASED
1218  * which means you owned the name or were in the queue to own it,
1219  * and and now you don't own it and aren't in the queue.
1220  * #DBUS_RELEASE_NAME_REPLY_NOT_OWNER which means someone else
1221  * owns the name so you can't release it.
1222  * #DBUS_RELEASE_NAME_REPLY_NON_EXISTENT
1223  * which means nobody owned the name.
1224  * 
1225  * @param connection the connection
1226  * @param name the name to remove 
1227  * @param error location to store the error
1228  * @returns a result code, -1 if error is set
1229  */ 
1230 int
1231 dbus_bus_release_name (DBusConnection *connection,
1232                        const char     *name,
1233                        DBusError      *error)
1234 {
1235   DBusMessage *message, *reply;
1236   dbus_uint32_t result;
1237
1238   _dbus_return_val_if_fail (connection != NULL, 0);
1239   _dbus_return_val_if_fail (name != NULL, 0);
1240   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), 0);
1241   _dbus_return_val_if_error_is_set (error, 0);
1242
1243   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1244                                           DBUS_PATH_DBUS,
1245                                           DBUS_INTERFACE_DBUS,
1246                                           "ReleaseName");
1247
1248   if (message == NULL)
1249     {
1250       _DBUS_SET_OOM (error);
1251       return -1;
1252     }
1253
1254   if (!dbus_message_append_args (message,
1255                                  DBUS_TYPE_STRING, &name,
1256                                  DBUS_TYPE_INVALID))
1257     {
1258       dbus_message_unref (message);
1259       _DBUS_SET_OOM (error);
1260       return -1;
1261     }
1262
1263   reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
1264                                                      error);
1265
1266   dbus_message_unref (message);
1267
1268   if (reply == NULL)
1269     {
1270       _DBUS_ASSERT_ERROR_IS_SET (error);
1271       return -1;
1272     }
1273
1274   if (dbus_set_error_from_message (error, reply))
1275     {
1276       _DBUS_ASSERT_ERROR_IS_SET (error);
1277       dbus_message_unref (reply);
1278       return -1;
1279     }
1280
1281   if (!dbus_message_get_args (reply, error,
1282                               DBUS_TYPE_UINT32, &result,
1283                               DBUS_TYPE_INVALID))
1284     {
1285       _DBUS_ASSERT_ERROR_IS_SET (error);
1286       dbus_message_unref (reply);
1287       return -1;
1288     }
1289
1290   dbus_message_unref (reply);
1291
1292   return result;
1293 }
1294
1295 /**
1296  * Asks the bus whether a certain name has an owner.
1297  *
1298  * Using this can easily result in a race condition,
1299  * since an owner can appear or disappear after you
1300  * call this.
1301  *
1302  * If you want to request a name, just request it;
1303  * if you want to avoid replacing a current owner,
1304  * don't specify #DBUS_NAME_FLAG_REPLACE_EXISTING and
1305  * you will get an error if there's already an owner.
1306  * 
1307  * @param connection the connection
1308  * @param name the name
1309  * @param error location to store any errors
1310  * @returns #TRUE if the name exists, #FALSE if not or on error
1311  */
1312 dbus_bool_t
1313 dbus_bus_name_has_owner (DBusConnection *connection,
1314                          const char     *name,
1315                          DBusError      *error)
1316 {
1317   DBusMessage *message, *reply;
1318   dbus_bool_t exists;
1319
1320   _dbus_return_val_if_fail (connection != NULL, FALSE);
1321   _dbus_return_val_if_fail (name != NULL, FALSE);
1322   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), FALSE);
1323   _dbus_return_val_if_error_is_set (error, FALSE);
1324   
1325   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1326                                           DBUS_PATH_DBUS,
1327                                           DBUS_INTERFACE_DBUS,
1328                                           "NameHasOwner");
1329   if (message == NULL)
1330     {
1331       _DBUS_SET_OOM (error);
1332       return FALSE;
1333     }
1334   
1335   if (!dbus_message_append_args (message,
1336                                  DBUS_TYPE_STRING, &name,
1337                                  DBUS_TYPE_INVALID))
1338     {
1339       dbus_message_unref (message);
1340       _DBUS_SET_OOM (error);
1341       return FALSE;
1342     }
1343   
1344   reply = dbus_connection_send_with_reply_and_block (connection, message, -1, error);
1345   dbus_message_unref (message);
1346
1347   if (reply == NULL)
1348     {
1349       _DBUS_ASSERT_ERROR_IS_SET (error);
1350       return FALSE;
1351     }
1352
1353   if (!dbus_message_get_args (reply, error,
1354                               DBUS_TYPE_BOOLEAN, &exists,
1355                               DBUS_TYPE_INVALID))
1356     {
1357       _DBUS_ASSERT_ERROR_IS_SET (error);
1358       dbus_message_unref (reply);
1359       return FALSE;
1360     }
1361   
1362   dbus_message_unref (reply);
1363   return exists;
1364 }
1365
1366 /**
1367  * Starts a service that will request ownership of the given name.
1368  * The returned result will be one of be one of
1369  * #DBUS_START_REPLY_SUCCESS or #DBUS_START_REPLY_ALREADY_RUNNING if
1370  * successful.  Pass #NULL if you don't care about the result.
1371  * 
1372  * The flags parameter is for future expansion, currently you should
1373  * specify 0.
1374  *
1375  * It's often easier to avoid explicitly starting services, and
1376  * just send a method call to the service's bus name instead.
1377  * Method calls start a service to handle them by default
1378  * unless you call dbus_message_set_auto_start() to disable this
1379  * behavior.
1380  * 
1381  * @param connection the connection
1382  * @param name the name we want the new service to request
1383  * @param flags the flags (should always be 0 for now)
1384  * @param result a place to store the result or #NULL
1385  * @param error location to store any errors
1386  * @returns #TRUE if the activation succeeded, #FALSE if not
1387  */
1388 dbus_bool_t
1389 dbus_bus_start_service_by_name (DBusConnection *connection,
1390                                 const char     *name,
1391                                 dbus_uint32_t   flags,
1392                                 dbus_uint32_t  *result,
1393                                 DBusError      *error)
1394 {
1395   DBusMessage *msg;
1396   DBusMessage *reply;
1397
1398   _dbus_return_val_if_fail (connection != NULL, FALSE);
1399   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), FALSE);
1400   
1401   msg = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1402                                       DBUS_PATH_DBUS,
1403                                       DBUS_INTERFACE_DBUS,
1404                                       "StartServiceByName");
1405
1406   if (!dbus_message_append_args (msg, DBUS_TYPE_STRING, &name,
1407                                  DBUS_TYPE_UINT32, &flags, DBUS_TYPE_INVALID))
1408     {
1409       dbus_message_unref (msg);
1410       _DBUS_SET_OOM (error);
1411       return FALSE;
1412     }
1413
1414   reply = dbus_connection_send_with_reply_and_block (connection, msg,
1415                                                      -1, error);
1416   dbus_message_unref (msg);
1417
1418   if (reply == NULL)
1419     {
1420       _DBUS_ASSERT_ERROR_IS_SET (error);
1421       return FALSE;
1422     }
1423
1424   if (dbus_set_error_from_message (error, reply))
1425     {
1426       _DBUS_ASSERT_ERROR_IS_SET (error);
1427       dbus_message_unref (reply);
1428       return FALSE;
1429     }
1430
1431   if (result != NULL &&
1432       !dbus_message_get_args (reply, error, DBUS_TYPE_UINT32,
1433                               result, DBUS_TYPE_INVALID))
1434     {
1435       _DBUS_ASSERT_ERROR_IS_SET (error);
1436       dbus_message_unref (reply);
1437       return FALSE;
1438     }
1439   
1440   dbus_message_unref (reply);
1441   return TRUE;
1442 }
1443
1444 static void
1445 send_no_return_values (DBusConnection *connection,
1446                        DBusMessage    *msg,
1447                        DBusError      *error)
1448 {
1449   if (error)
1450     {
1451       /* Block to check success codepath */
1452       DBusMessage *reply;
1453       
1454       reply = dbus_connection_send_with_reply_and_block (connection, msg,
1455                                                          -1, error);
1456       
1457       if (reply == NULL)
1458         _DBUS_ASSERT_ERROR_IS_SET (error);
1459       else
1460         dbus_message_unref (reply);
1461     }
1462   else
1463     {
1464       /* Silently-fail nonblocking codepath */
1465       dbus_message_set_no_reply (msg, TRUE);
1466       dbus_connection_send (connection, msg, NULL);
1467     }
1468 }
1469
1470 /**
1471  * Adds a match rule to match messages going through the message bus.
1472  * The "rule" argument is the string form of a match rule.
1473  *
1474  * If you pass #NULL for the error, this function will not
1475  * block; the match thus won't be added until you flush the
1476  * connection, and if there's an error adding the match
1477  * you won't find out about it. This is generally acceptable, since the
1478  * possible errors (including a lack of resources in the bus, the connection
1479  * having exceeded its quota of active match rules, or the match rule being
1480  * unparseable) are generally unrecoverable.
1481  *
1482  * If you pass non-#NULL for the error this function will
1483  * block until it gets a reply. This may be useful when using match rule keys
1484  * introduced in recent versions of D-Bus, like 'arg0namespace', to allow the
1485  * application to fall back to less efficient match rules supported by older
1486  * versions of the daemon if the running version is not new enough; or when
1487  * using user-supplied rules rather than rules hard-coded at compile time.
1488  *
1489  * Normal API conventions would have the function return
1490  * a boolean value indicating whether the error was set,
1491  * but that would require blocking always to determine
1492  * the return value.
1493  *
1494  * The AddMatch method is fully documented in the D-Bus 
1495  * specification. For quick reference, the format of the 
1496  * match rules is discussed here, but the specification 
1497  * is the canonical version of this information.
1498  *
1499  * Rules are specified as a string of comma separated 
1500  * key/value pairs. An example is 
1501  * "type='signal',sender='org.freedesktop.DBus',
1502  * interface='org.freedesktop.DBus',member='Foo',
1503  * path='/bar/foo',destination=':452345.34'"
1504  *
1505  * Possible keys you can match on are type, sender, 
1506  * interface, member, path, destination and numbered
1507  * keys to match message args (keys are 'arg0', 'arg1', etc.).
1508  * Omitting a key from the rule indicates 
1509  * a wildcard match.  For instance omitting
1510  * the member from a match rule but adding a sender would
1511  * let all messages from that sender through regardless of
1512  * the member.
1513  *
1514  * Matches are inclusive not exclusive so as long as one 
1515  * rule matches the message will get through.  It is important
1516  * to note this because every time a message is received the 
1517  * application will be paged into memory to process it.  This
1518  * can cause performance problems such as draining batteries
1519  * on embedded platforms.
1520  *
1521  * If you match message args ('arg0', 'arg1', and so forth)
1522  * only string arguments will match. That is, arg0='5' means
1523  * match the string "5" not the integer 5.
1524  *
1525  * Currently there is no way to match against non-string arguments.
1526  *
1527  * A specialised form of wildcard matching on arguments is
1528  * supported for path-like namespaces.  If your argument match has
1529  * a 'path' suffix (eg: "arg0path='/some/path/'") then it is
1530  * considered a match if the argument exactly matches the given
1531  * string or if one of them ends in a '/' and is a prefix of the
1532  * other.
1533  *
1534  * Matching on interface is tricky because method call
1535  * messages only optionally specify the interface.
1536  * If a message omits the interface, then it will NOT match
1537  * if the rule specifies an interface name. This means match
1538  * rules on method calls should not usually give an interface.
1539  *
1540  * However, signal messages are required to include the interface
1541  * so when matching signals usually you should specify the interface
1542  * in the match rule.
1543  * 
1544  * For security reasons, you can match arguments only up to
1545  * #DBUS_MAXIMUM_MATCH_RULE_ARG_NUMBER.
1546  *
1547  * Match rules have a maximum length of #DBUS_MAXIMUM_MATCH_RULE_LENGTH
1548  * bytes.
1549  *
1550  * Both of these maximums are much higher than you're likely to need,
1551  * they only exist because the D-Bus bus daemon has fixed limits on
1552  * all resource usage.
1553  *
1554  * @param connection connection to the message bus
1555  * @param rule textual form of match rule
1556  * @param error location to store any errors
1557  */
1558 void
1559 dbus_bus_add_match (DBusConnection *connection,
1560                     const char     *rule,
1561                     DBusError      *error)
1562 {
1563         _dbus_return_if_fail (rule != NULL);
1564
1565         if(!dbus_transport_is_kdbus(connection))
1566         {
1567                 DBusMessage *msg;
1568
1569                 msg = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1570                                       DBUS_PATH_DBUS,
1571                                       DBUS_INTERFACE_DBUS,
1572                                       "AddMatch");
1573
1574           if (msg == NULL)
1575                 {
1576                   _DBUS_SET_OOM (error);
1577                   return;
1578                 }
1579
1580           if (!dbus_message_append_args (msg, DBUS_TYPE_STRING, &rule,
1581                                                                          DBUS_TYPE_INVALID))
1582                 {
1583                   dbus_message_unref (msg);
1584                   _DBUS_SET_OOM (error);
1585                   return;
1586                 }
1587
1588           send_no_return_values (connection, msg, error);
1589
1590           dbus_message_unref (msg);
1591         }
1592         else
1593                 dbus_bus_add_match_kdbus(connection, rule, error);
1594 }
1595
1596 /**
1597  * Removes a previously-added match rule "by value" (the most
1598  * recently-added identical rule gets removed).  The "rule" argument
1599  * is the string form of a match rule.
1600  *
1601  * The bus compares match rules semantically, not textually, so
1602  * whitespace and ordering don't have to be identical to
1603  * the rule you passed to dbus_bus_add_match().
1604  * 
1605  * If you pass #NULL for the error, this function will not
1606  * block; otherwise it will. See detailed explanation in
1607  * docs for dbus_bus_add_match().
1608  * 
1609  * @param connection connection to the message bus
1610  * @param rule textual form of match rule
1611  * @param error location to store any errors
1612  */
1613 void
1614 dbus_bus_remove_match (DBusConnection *connection,
1615                        const char     *rule,
1616                        DBusError      *error)
1617 {
1618         if(!dbus_transport_is_kdbus(connection))
1619         {
1620                 DBusMessage *msg;
1621
1622           _dbus_return_if_fail (rule != NULL);
1623
1624           msg = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1625                                                                                   DBUS_PATH_DBUS,
1626                                                                                   DBUS_INTERFACE_DBUS,
1627                                                                                   "RemoveMatch");
1628
1629           if (!dbus_message_append_args (msg, DBUS_TYPE_STRING, &rule,
1630                                                                          DBUS_TYPE_INVALID))
1631                 {
1632                   dbus_message_unref (msg);
1633                   _DBUS_SET_OOM (error);
1634                   return;
1635                 }
1636
1637           send_no_return_values (connection, msg, error);
1638
1639           dbus_message_unref (msg);
1640         }
1641         else
1642                 dbus_bus_remove_match_kdbus(connection, rule, error);
1643 }
1644
1645 /** @} */