- fixed dbus_bus_request_name
[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
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[18];
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           if(!bus_register_kdbus(name, connection, error))
695                   goto out;
696
697           if(!bus_register_policy_kdbus(name, connection, error))
698                 goto out;
699
700           dbus_connection_set_is_authenticated(connection);
701   }
702   else
703   {
704           message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
705                                                                                           DBUS_PATH_DBUS,
706                                                                                           DBUS_INTERFACE_DBUS,
707                                                                                           "Hello");
708
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
742   if (reply)
743     dbus_message_unref (reply);
744
745   if (!retval)
746     _DBUS_ASSERT_ERROR_IS_SET (error);
747
748   return retval;
749 }
750
751
752 /**
753  * Sets the unique name of the connection, as assigned by the message
754  * bus.  Can only be used if you registered with the bus manually
755  * (i.e. if you did not call dbus_bus_register()). Can only be called
756  * once per connection.  After the unique name is set, you can get it
757  * with dbus_bus_get_unique_name().
758  *
759  * The only reason to use this function is to re-implement the
760  * equivalent of dbus_bus_register() yourself. One (probably unusual)
761  * reason to do that might be to do the bus registration call
762  * asynchronously instead of synchronously.
763  *
764  * @note Just use dbus_bus_get() or dbus_bus_get_private(), or worst
765  * case dbus_bus_register(), instead of messing with this
766  * function. There's really no point creating pain for yourself by
767  * doing things manually.
768  *
769  * It's hard to use this function safely on shared connections
770  * (created by dbus_connection_open()) in a multithreaded application,
771  * because only one registration attempt can be sent to the bus. If
772  * two threads are both sending the registration message, there is no
773  * mechanism in libdbus itself to avoid sending it twice.
774  *
775  * Thus, you need a way to coordinate which thread sends the
776  * registration attempt; which also means you know which thread
777  * will call dbus_bus_set_unique_name(). If you don't know
778  * about all threads in the app (for example, if some libraries
779  * you're using might start libdbus-using threads), then you
780  * need to avoid using this function on shared connections.
781  *
782  * @param connection the connection
783  * @param unique_name the unique name
784  * @returns #FALSE if not enough memory
785  */
786 dbus_bool_t
787 dbus_bus_set_unique_name (DBusConnection *connection,
788                           const char     *unique_name)
789 {
790   BusData *bd;
791   dbus_bool_t success = FALSE;
792
793   _dbus_return_val_if_fail (connection != NULL, FALSE);
794   _dbus_return_val_if_fail (unique_name != NULL, FALSE);
795
796   if (!_DBUS_LOCK (bus_datas))
797     {
798       /* do not "goto out", that would try to unlock */
799       return FALSE;
800     }
801
802   bd = ensure_bus_data (connection);
803   if (bd == NULL)
804     goto out;
805
806   _dbus_assert (bd->unique_name == NULL);
807   
808   bd->unique_name = _dbus_strdup (unique_name);
809   success = bd->unique_name != NULL;
810
811 out:
812   _DBUS_UNLOCK (bus_datas);
813   
814   return success;
815 }
816
817 /**
818  * Gets the unique name of the connection as assigned by the message
819  * bus. Only possible after the connection has been registered with
820  * the message bus. All connections returned by dbus_bus_get() or
821  * dbus_bus_get_private() have been successfully registered.
822  *
823  * The name remains valid until the connection is freed, and
824  * should not be freed by the caller.
825  *
826  * Other than dbus_bus_get(), there are two ways to set the unique
827  * name; one is dbus_bus_register(), the other is
828  * dbus_bus_set_unique_name().  You are responsible for calling
829  * dbus_bus_set_unique_name() if you register by hand instead of using
830  * dbus_bus_register().
831  * 
832  * @param connection the connection
833  * @returns the unique name or #NULL on error
834  */
835 const char*
836 dbus_bus_get_unique_name (DBusConnection *connection)
837 {
838   BusData *bd;
839   const char *unique_name = NULL;
840
841   _dbus_return_val_if_fail (connection != NULL, NULL);
842
843   if (!_DBUS_LOCK (bus_datas))
844     {
845       /* We'd have initialized locks when we gave it its unique name, if it
846        * had one. Don't "goto out", that would try to unlock. */
847       return NULL;
848     }
849
850   bd = ensure_bus_data (connection);
851   if (bd == NULL)
852     goto out;
853
854   unique_name = bd->unique_name;
855
856 out:
857   _DBUS_UNLOCK (bus_datas);
858
859   return unique_name;
860 }
861
862 /**
863  * Asks the bus to return the UID the named connection authenticated
864  * as, if any.  Only works on UNIX; only works for connections on the
865  * same machine as the bus. If you are not on the same machine as the
866  * bus, then calling this is probably a bad idea, since the UID will
867  * mean little to your application.
868  *
869  * For the system message bus you're guaranteed to be on the same
870  * machine since it only listens on a UNIX domain socket (at least,
871  * as shipped by default).
872  *
873  * This function only works for connections that authenticated as
874  * a UNIX user, right now that includes all bus connections, but
875  * it's very possible to have connections with no associated UID.
876  * So check for errors and do something sensible if they happen.
877  * 
878  * This function will always return an error on Windows.
879  * 
880  * @param connection the connection
881  * @param name a name owned by the connection
882  * @param error location to store the error
883  * @returns the unix user id, or ((unsigned)-1) if error is set
884  */ 
885 unsigned long
886 dbus_bus_get_unix_user (DBusConnection *connection,
887                         const char     *name,
888                         DBusError      *error)
889 {
890   DBusMessage *message, *reply;
891   dbus_uint32_t uid;
892
893   _dbus_return_val_if_fail (connection != NULL, DBUS_UID_UNSET);
894   _dbus_return_val_if_fail (name != NULL, DBUS_UID_UNSET);
895   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), DBUS_UID_UNSET);
896   _dbus_return_val_if_error_is_set (error, DBUS_UID_UNSET);
897   
898   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
899                                           DBUS_PATH_DBUS,
900                                           DBUS_INTERFACE_DBUS,
901                                           "GetConnectionUnixUser");
902
903   if (message == NULL)
904     {
905       _DBUS_SET_OOM (error);
906       return DBUS_UID_UNSET;
907     }
908  
909   if (!dbus_message_append_args (message,
910                                  DBUS_TYPE_STRING, &name,
911                                  DBUS_TYPE_INVALID))
912     {
913       dbus_message_unref (message);
914       _DBUS_SET_OOM (error);
915       return DBUS_UID_UNSET;
916     }
917   
918   reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
919                                                      error);
920   
921   dbus_message_unref (message);
922   
923   if (reply == NULL)
924     {
925       _DBUS_ASSERT_ERROR_IS_SET (error);
926       return DBUS_UID_UNSET;
927     }  
928
929   if (dbus_set_error_from_message (error, reply))
930     {
931       _DBUS_ASSERT_ERROR_IS_SET (error);
932       dbus_message_unref (reply);
933       return DBUS_UID_UNSET;
934     }
935   
936   if (!dbus_message_get_args (reply, error,
937                               DBUS_TYPE_UINT32, &uid,
938                               DBUS_TYPE_INVALID))
939     {
940       _DBUS_ASSERT_ERROR_IS_SET (error);
941       dbus_message_unref (reply);
942       return DBUS_UID_UNSET;
943     }
944
945   dbus_message_unref (reply);
946   
947   return (unsigned long) uid;
948 }
949
950 /**
951  * Asks the bus to return its globally unique ID, as described in the
952  * D-Bus specification. For the session bus, this is useful as a way
953  * to uniquely identify each user session. For the system bus,
954  * probably the bus ID is not useful; instead, use the machine ID
955  * since it's accessible without necessarily connecting to the bus and
956  * may be persistent beyond a single bus instance (across reboots for
957  * example). See dbus_get_local_machine_id().
958  *
959  * In addition to an ID for each bus and an ID for each machine, there is
960  * an ID for each address that the bus is listening on; that can
961  * be retrieved with dbus_connection_get_server_id(), though it is
962  * probably not very useful.
963  * 
964  * @param connection the connection
965  * @param error location to store the error
966  * @returns the bus ID or #NULL if error is set
967  */ 
968 char*
969 dbus_bus_get_id (DBusConnection *connection,
970                  DBusError      *error)
971 {
972   DBusMessage *message, *reply;
973   char *id;
974   const char *v_STRING;
975
976   _dbus_return_val_if_fail (connection != NULL, NULL);
977   _dbus_return_val_if_error_is_set (error, NULL);
978   
979   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
980                                           DBUS_PATH_DBUS,
981                                           DBUS_INTERFACE_DBUS,
982                                           "GetId");
983   
984   if (message == NULL)
985     {
986       _DBUS_SET_OOM (error);
987       return NULL;
988     }
989   
990   reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
991                                                      error);
992   
993   dbus_message_unref (message);
994   
995   if (reply == NULL)
996     {
997       _DBUS_ASSERT_ERROR_IS_SET (error);
998       return NULL;
999     }  
1000
1001   if (dbus_set_error_from_message (error, reply))
1002     {
1003       _DBUS_ASSERT_ERROR_IS_SET (error);
1004       dbus_message_unref (reply);
1005       return NULL;
1006     }
1007
1008   v_STRING = NULL;
1009   if (!dbus_message_get_args (reply, error,
1010                               DBUS_TYPE_STRING, &v_STRING,
1011                               DBUS_TYPE_INVALID))
1012     {
1013       _DBUS_ASSERT_ERROR_IS_SET (error);
1014       dbus_message_unref (reply);
1015       return NULL;
1016     }
1017
1018   id = _dbus_strdup (v_STRING); /* may be NULL */
1019   
1020   dbus_message_unref (reply);
1021
1022   if (id == NULL)
1023     _DBUS_SET_OOM (error);
1024
1025   /* FIXME it might be nice to cache the ID locally */
1026   
1027   return id;
1028 }
1029
1030 /**
1031  * Asks the bus to assign the given name to this connection by invoking
1032  * the RequestName method on the bus. This method is fully documented
1033  * in the D-Bus specification. For quick reference, the flags and
1034  * result codes are discussed here, but the specification is the
1035  * canonical version of this information.
1036  *
1037  * First you should know that for each bus name, the bus stores
1038  * a queue of connections that would like to own it. Only
1039  * one owns it at a time - called the primary owner. If the primary
1040  * owner releases the name or disconnects, then the next owner in the
1041  * queue atomically takes over.
1042  *
1043  * So for example if you have an application org.freedesktop.TextEditor
1044  * and multiple instances of it can be run, you can have all of them
1045  * sitting in the queue. The first one to start up will receive messages
1046  * sent to org.freedesktop.TextEditor, but if that one exits another
1047  * will become the primary owner and receive messages.
1048  *
1049  * The queue means you don't need to manually watch for the current owner to
1050  * disappear and then request the name again.
1051  *
1052  * When requesting a name, you can specify several flags.
1053  * 
1054  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT and #DBUS_NAME_FLAG_DO_NOT_QUEUE
1055  * are properties stored by the bus for this connection with respect to
1056  * each requested bus name. These properties are stored even if the
1057  * connection is queued and does not become the primary owner.
1058  * You can update these flags by calling RequestName again (even if
1059  * you already own the name).
1060  *
1061  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT means that another requestor of the
1062  * name can take it away from you by specifying #DBUS_NAME_FLAG_REPLACE_EXISTING.
1063  *
1064  * #DBUS_NAME_FLAG_DO_NOT_QUEUE means that if you aren't the primary owner,
1065  * you don't want to be queued up - you only care about being the
1066  * primary owner.
1067  *
1068  * Unlike the other two flags, #DBUS_NAME_FLAG_REPLACE_EXISTING is a property
1069  * of the individual RequestName call, i.e. the bus does not persistently
1070  * associate it with the connection-name pair. If a RequestName call includes
1071  * the #DBUS_NAME_FLAG_REPLACE_EXISTING flag, and the current primary
1072  * owner has #DBUS_NAME_FLAG_ALLOW_REPLACEMENT set, then the current primary
1073  * owner will be kicked off.
1074  *
1075  * If no flags are given, an application will receive the requested
1076  * name only if the name is currently unowned; and it will NOT give
1077  * up the name if another application asks to take it over using
1078  * #DBUS_NAME_FLAG_REPLACE_EXISTING.
1079  *
1080  * This function returns a result code. The possible result codes
1081  * are as follows.
1082  * 
1083  * #DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER means that the name had no
1084  * existing owner, and the caller is now the primary owner; or that
1085  * the name had an owner, and the caller specified
1086  * #DBUS_NAME_FLAG_REPLACE_EXISTING, and the current owner
1087  * specified #DBUS_NAME_FLAG_ALLOW_REPLACEMENT.
1088  *
1089  * #DBUS_REQUEST_NAME_REPLY_IN_QUEUE happens only if the caller does NOT
1090  * specify #DBUS_NAME_FLAG_DO_NOT_QUEUE and either the current owner
1091  * did NOT specify #DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the caller did NOT
1092  * specify #DBUS_NAME_FLAG_REPLACE_EXISTING. In this case the caller ends up 
1093  * in a queue to own the name after the current owner gives it up.
1094  *
1095  * #DBUS_REQUEST_NAME_REPLY_EXISTS happens if the name has an owner
1096  * already and the caller specifies #DBUS_NAME_FLAG_DO_NOT_QUEUE
1097  * and either the current owner has NOT specified 
1098  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT or the caller did NOT specify 
1099  * #DBUS_NAME_FLAG_REPLACE_EXISTING.
1100  *
1101  * #DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER happens if an application
1102  * requests a name it already owns. (Re-requesting a name is useful if
1103  * you want to change the #DBUS_NAME_FLAG_ALLOW_REPLACEMENT or
1104  * #DBUS_NAME_FLAG_DO_NOT_QUEUE settings.)
1105  *
1106  * When a service represents an application, say "text editor," then
1107  * it should specify #DBUS_NAME_FLAG_ALLOW_REPLACEMENT if it wants
1108  * the last editor started to be the user's editor vs. the first one
1109  * started.  Then any editor that can be the user's editor should
1110  * specify #DBUS_NAME_FLAG_REPLACE_EXISTING to either take over
1111  * (last-started-wins) or be queued up (first-started-wins) according
1112  * to whether #DBUS_NAME_FLAG_ALLOW_REPLACEMENT was given.
1113  *
1114  * Conventionally, single-instance applications often offer a command
1115  * line option called --replace which means to replace the current
1116  * instance.  To implement this, always set
1117  * #DBUS_NAME_FLAG_ALLOW_REPLACEMENT when you request your
1118  * application's bus name.  When you lose ownership of your bus name,
1119  * you need to exit.  Look for the signal "NameLost" from
1120  * #DBUS_SERVICE_DBUS and #DBUS_INTERFACE_DBUS (the signal's first
1121  * argument is the bus name that was lost).  If starting up without
1122  * --replace, do not specify #DBUS_NAME_FLAG_REPLACE_EXISTING, and
1123  * exit if you fail to become the bus name owner. If --replace is
1124  * given, ask to replace the old owner.
1125  *
1126  * @param connection the connection
1127  * @param name the name to request
1128  * @param flags flags
1129  * @param error location to store the error
1130  * @returns a result code, -1 if error is set
1131  */ 
1132 int
1133 dbus_bus_request_name (DBusConnection *connection,
1134                        const char     *name,
1135                        unsigned int    flags,
1136                        DBusError      *error)
1137 {
1138         dbus_uint32_t result;
1139
1140         _dbus_return_val_if_fail (connection != NULL, 0);
1141         _dbus_return_val_if_fail (name != NULL, 0);
1142         _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), 0);
1143         _dbus_return_val_if_error_is_set (error, 0);
1144
1145         if(!dbus_transport_is_kdbus(connection))
1146         {
1147                 DBusMessage *message, *reply;
1148
1149                 message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1150                                                                                           DBUS_PATH_DBUS,
1151                                                                                           DBUS_INTERFACE_DBUS,
1152                                                                                           "RequestName");
1153                 if (message == NULL)
1154                 {
1155                   _DBUS_SET_OOM (error);
1156                   return -1;
1157                 }
1158
1159                 if (!dbus_message_append_args (message,
1160                                          DBUS_TYPE_STRING, &name,
1161                                          DBUS_TYPE_UINT32, &flags,
1162                                          DBUS_TYPE_INVALID))
1163                 {
1164                   dbus_message_unref (message);
1165                   _DBUS_SET_OOM (error);
1166                   return -1;
1167                 }
1168
1169                 reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
1170                                                                                                                  error);
1171
1172                 dbus_message_unref (message);
1173
1174                 if (reply == NULL)
1175                 {
1176                   _DBUS_ASSERT_ERROR_IS_SET (error);
1177                   return -1;
1178                 }
1179
1180                 if (dbus_set_error_from_message (error, reply))
1181                 {
1182                   _DBUS_ASSERT_ERROR_IS_SET (error);
1183                   dbus_message_unref (reply);
1184                   return -1;
1185                 }
1186
1187                 if (!dbus_message_get_args (reply, error,
1188                                                                   DBUS_TYPE_UINT32, &result,
1189                                                                   DBUS_TYPE_INVALID))
1190                 {
1191                   _DBUS_ASSERT_ERROR_IS_SET (error);
1192                   dbus_message_unref (reply);
1193                   return -1;
1194                 }
1195
1196                 dbus_message_unref (reply);
1197         }
1198         else
1199         {
1200                 if(!bus_register_policy_kdbus(name, connection, error))
1201                         return -1;
1202
1203                 result = bus_request_name_kdbus(connection, name, flags, error);
1204         }
1205   
1206         return result;
1207 }
1208
1209
1210 /**
1211  * Asks the bus to unassign the given name from this connection by
1212  * invoking the ReleaseName method on the bus. The "ReleaseName"
1213  * method is canonically documented in the D-Bus specification.
1214  *
1215  * Possible results are: #DBUS_RELEASE_NAME_REPLY_RELEASED
1216  * which means you owned the name or were in the queue to own it,
1217  * and and now you don't own it and aren't in the queue.
1218  * #DBUS_RELEASE_NAME_REPLY_NOT_OWNER which means someone else
1219  * owns the name so you can't release it.
1220  * #DBUS_RELEASE_NAME_REPLY_NON_EXISTENT
1221  * which means nobody owned the name.
1222  * 
1223  * @param connection the connection
1224  * @param name the name to remove 
1225  * @param error location to store the error
1226  * @returns a result code, -1 if error is set
1227  */ 
1228 int
1229 dbus_bus_release_name (DBusConnection *connection,
1230                        const char     *name,
1231                        DBusError      *error)
1232 {
1233   DBusMessage *message, *reply;
1234   dbus_uint32_t result;
1235
1236   _dbus_return_val_if_fail (connection != NULL, 0);
1237   _dbus_return_val_if_fail (name != NULL, 0);
1238   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), 0);
1239   _dbus_return_val_if_error_is_set (error, 0);
1240
1241   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1242                                           DBUS_PATH_DBUS,
1243                                           DBUS_INTERFACE_DBUS,
1244                                           "ReleaseName");
1245
1246   if (message == NULL)
1247     {
1248       _DBUS_SET_OOM (error);
1249       return -1;
1250     }
1251
1252   if (!dbus_message_append_args (message,
1253                                  DBUS_TYPE_STRING, &name,
1254                                  DBUS_TYPE_INVALID))
1255     {
1256       dbus_message_unref (message);
1257       _DBUS_SET_OOM (error);
1258       return -1;
1259     }
1260
1261   reply = dbus_connection_send_with_reply_and_block (connection, message, -1,
1262                                                      error);
1263
1264   dbus_message_unref (message);
1265
1266   if (reply == NULL)
1267     {
1268       _DBUS_ASSERT_ERROR_IS_SET (error);
1269       return -1;
1270     }
1271
1272   if (dbus_set_error_from_message (error, reply))
1273     {
1274       _DBUS_ASSERT_ERROR_IS_SET (error);
1275       dbus_message_unref (reply);
1276       return -1;
1277     }
1278
1279   if (!dbus_message_get_args (reply, error,
1280                               DBUS_TYPE_UINT32, &result,
1281                               DBUS_TYPE_INVALID))
1282     {
1283       _DBUS_ASSERT_ERROR_IS_SET (error);
1284       dbus_message_unref (reply);
1285       return -1;
1286     }
1287
1288   dbus_message_unref (reply);
1289
1290   return result;
1291 }
1292
1293 /**
1294  * Asks the bus whether a certain name has an owner.
1295  *
1296  * Using this can easily result in a race condition,
1297  * since an owner can appear or disappear after you
1298  * call this.
1299  *
1300  * If you want to request a name, just request it;
1301  * if you want to avoid replacing a current owner,
1302  * don't specify #DBUS_NAME_FLAG_REPLACE_EXISTING and
1303  * you will get an error if there's already an owner.
1304  * 
1305  * @param connection the connection
1306  * @param name the name
1307  * @param error location to store any errors
1308  * @returns #TRUE if the name exists, #FALSE if not or on error
1309  */
1310 dbus_bool_t
1311 dbus_bus_name_has_owner (DBusConnection *connection,
1312                          const char     *name,
1313                          DBusError      *error)
1314 {
1315   DBusMessage *message, *reply;
1316   dbus_bool_t exists;
1317
1318   _dbus_return_val_if_fail (connection != NULL, FALSE);
1319   _dbus_return_val_if_fail (name != NULL, FALSE);
1320   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), FALSE);
1321   _dbus_return_val_if_error_is_set (error, FALSE);
1322   
1323   message = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1324                                           DBUS_PATH_DBUS,
1325                                           DBUS_INTERFACE_DBUS,
1326                                           "NameHasOwner");
1327   if (message == NULL)
1328     {
1329       _DBUS_SET_OOM (error);
1330       return FALSE;
1331     }
1332   
1333   if (!dbus_message_append_args (message,
1334                                  DBUS_TYPE_STRING, &name,
1335                                  DBUS_TYPE_INVALID))
1336     {
1337       dbus_message_unref (message);
1338       _DBUS_SET_OOM (error);
1339       return FALSE;
1340     }
1341   
1342   reply = dbus_connection_send_with_reply_and_block (connection, message, -1, error);
1343   dbus_message_unref (message);
1344
1345   if (reply == NULL)
1346     {
1347       _DBUS_ASSERT_ERROR_IS_SET (error);
1348       return FALSE;
1349     }
1350
1351   if (!dbus_message_get_args (reply, error,
1352                               DBUS_TYPE_BOOLEAN, &exists,
1353                               DBUS_TYPE_INVALID))
1354     {
1355       _DBUS_ASSERT_ERROR_IS_SET (error);
1356       dbus_message_unref (reply);
1357       return FALSE;
1358     }
1359   
1360   dbus_message_unref (reply);
1361   return exists;
1362 }
1363
1364 /**
1365  * Starts a service that will request ownership of the given name.
1366  * The returned result will be one of be one of
1367  * #DBUS_START_REPLY_SUCCESS or #DBUS_START_REPLY_ALREADY_RUNNING if
1368  * successful.  Pass #NULL if you don't care about the result.
1369  * 
1370  * The flags parameter is for future expansion, currently you should
1371  * specify 0.
1372  *
1373  * It's often easier to avoid explicitly starting services, and
1374  * just send a method call to the service's bus name instead.
1375  * Method calls start a service to handle them by default
1376  * unless you call dbus_message_set_auto_start() to disable this
1377  * behavior.
1378  * 
1379  * @param connection the connection
1380  * @param name the name we want the new service to request
1381  * @param flags the flags (should always be 0 for now)
1382  * @param result a place to store the result or #NULL
1383  * @param error location to store any errors
1384  * @returns #TRUE if the activation succeeded, #FALSE if not
1385  */
1386 dbus_bool_t
1387 dbus_bus_start_service_by_name (DBusConnection *connection,
1388                                 const char     *name,
1389                                 dbus_uint32_t   flags,
1390                                 dbus_uint32_t  *result,
1391                                 DBusError      *error)
1392 {
1393   DBusMessage *msg;
1394   DBusMessage *reply;
1395
1396   _dbus_return_val_if_fail (connection != NULL, FALSE);
1397   _dbus_return_val_if_fail (_dbus_check_is_valid_bus_name (name), FALSE);
1398   
1399   msg = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1400                                       DBUS_PATH_DBUS,
1401                                       DBUS_INTERFACE_DBUS,
1402                                       "StartServiceByName");
1403
1404   if (!dbus_message_append_args (msg, DBUS_TYPE_STRING, &name,
1405                                  DBUS_TYPE_UINT32, &flags, DBUS_TYPE_INVALID))
1406     {
1407       dbus_message_unref (msg);
1408       _DBUS_SET_OOM (error);
1409       return FALSE;
1410     }
1411
1412   reply = dbus_connection_send_with_reply_and_block (connection, msg,
1413                                                      -1, error);
1414   dbus_message_unref (msg);
1415
1416   if (reply == NULL)
1417     {
1418       _DBUS_ASSERT_ERROR_IS_SET (error);
1419       return FALSE;
1420     }
1421
1422   if (dbus_set_error_from_message (error, reply))
1423     {
1424       _DBUS_ASSERT_ERROR_IS_SET (error);
1425       dbus_message_unref (reply);
1426       return FALSE;
1427     }
1428
1429   if (result != NULL &&
1430       !dbus_message_get_args (reply, error, DBUS_TYPE_UINT32,
1431                               result, DBUS_TYPE_INVALID))
1432     {
1433       _DBUS_ASSERT_ERROR_IS_SET (error);
1434       dbus_message_unref (reply);
1435       return FALSE;
1436     }
1437   
1438   dbus_message_unref (reply);
1439   return TRUE;
1440 }
1441
1442 static void
1443 send_no_return_values (DBusConnection *connection,
1444                        DBusMessage    *msg,
1445                        DBusError      *error)
1446 {
1447   if (error)
1448     {
1449       /* Block to check success codepath */
1450       DBusMessage *reply;
1451       
1452       reply = dbus_connection_send_with_reply_and_block (connection, msg,
1453                                                          -1, error);
1454       
1455       if (reply == NULL)
1456         _DBUS_ASSERT_ERROR_IS_SET (error);
1457       else
1458         dbus_message_unref (reply);
1459     }
1460   else
1461     {
1462       /* Silently-fail nonblocking codepath */
1463       dbus_message_set_no_reply (msg, TRUE);
1464       dbus_connection_send (connection, msg, NULL);
1465     }
1466 }
1467
1468 /**
1469  * Adds a match rule to match messages going through the message bus.
1470  * The "rule" argument is the string form of a match rule.
1471  *
1472  * If you pass #NULL for the error, this function will not
1473  * block; the match thus won't be added until you flush the
1474  * connection, and if there's an error adding the match
1475  * you won't find out about it. This is generally acceptable, since the
1476  * possible errors (including a lack of resources in the bus, the connection
1477  * having exceeded its quota of active match rules, or the match rule being
1478  * unparseable) are generally unrecoverable.
1479  *
1480  * If you pass non-#NULL for the error this function will
1481  * block until it gets a reply. This may be useful when using match rule keys
1482  * introduced in recent versions of D-Bus, like 'arg0namespace', to allow the
1483  * application to fall back to less efficient match rules supported by older
1484  * versions of the daemon if the running version is not new enough; or when
1485  * using user-supplied rules rather than rules hard-coded at compile time.
1486  *
1487  * Normal API conventions would have the function return
1488  * a boolean value indicating whether the error was set,
1489  * but that would require blocking always to determine
1490  * the return value.
1491  *
1492  * The AddMatch method is fully documented in the D-Bus 
1493  * specification. For quick reference, the format of the 
1494  * match rules is discussed here, but the specification 
1495  * is the canonical version of this information.
1496  *
1497  * Rules are specified as a string of comma separated 
1498  * key/value pairs. An example is 
1499  * "type='signal',sender='org.freedesktop.DBus',
1500  * interface='org.freedesktop.DBus',member='Foo',
1501  * path='/bar/foo',destination=':452345.34'"
1502  *
1503  * Possible keys you can match on are type, sender, 
1504  * interface, member, path, destination and numbered
1505  * keys to match message args (keys are 'arg0', 'arg1', etc.).
1506  * Omitting a key from the rule indicates 
1507  * a wildcard match.  For instance omitting
1508  * the member from a match rule but adding a sender would
1509  * let all messages from that sender through regardless of
1510  * the member.
1511  *
1512  * Matches are inclusive not exclusive so as long as one 
1513  * rule matches the message will get through.  It is important
1514  * to note this because every time a message is received the 
1515  * application will be paged into memory to process it.  This
1516  * can cause performance problems such as draining batteries
1517  * on embedded platforms.
1518  *
1519  * If you match message args ('arg0', 'arg1', and so forth)
1520  * only string arguments will match. That is, arg0='5' means
1521  * match the string "5" not the integer 5.
1522  *
1523  * Currently there is no way to match against non-string arguments.
1524  *
1525  * A specialised form of wildcard matching on arguments is
1526  * supported for path-like namespaces.  If your argument match has
1527  * a 'path' suffix (eg: "arg0path='/some/path/'") then it is
1528  * considered a match if the argument exactly matches the given
1529  * string or if one of them ends in a '/' and is a prefix of the
1530  * other.
1531  *
1532  * Matching on interface is tricky because method call
1533  * messages only optionally specify the interface.
1534  * If a message omits the interface, then it will NOT match
1535  * if the rule specifies an interface name. This means match
1536  * rules on method calls should not usually give an interface.
1537  *
1538  * However, signal messages are required to include the interface
1539  * so when matching signals usually you should specify the interface
1540  * in the match rule.
1541  * 
1542  * For security reasons, you can match arguments only up to
1543  * #DBUS_MAXIMUM_MATCH_RULE_ARG_NUMBER.
1544  *
1545  * Match rules have a maximum length of #DBUS_MAXIMUM_MATCH_RULE_LENGTH
1546  * bytes.
1547  *
1548  * Both of these maximums are much higher than you're likely to need,
1549  * they only exist because the D-Bus bus daemon has fixed limits on
1550  * all resource usage.
1551  *
1552  * @param connection connection to the message bus
1553  * @param rule textual form of match rule
1554  * @param error location to store any errors
1555  */
1556 void
1557 dbus_bus_add_match (DBusConnection *connection,
1558                     const char     *rule,
1559                     DBusError      *error)
1560 {
1561         _dbus_return_if_fail (rule != NULL);
1562
1563         if(!dbus_transport_is_kdbus(connection))
1564         {
1565                 DBusMessage *msg;
1566
1567                 msg = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1568                                       DBUS_PATH_DBUS,
1569                                       DBUS_INTERFACE_DBUS,
1570                                       "AddMatch");
1571
1572           if (msg == NULL)
1573                 {
1574                   _DBUS_SET_OOM (error);
1575                   return;
1576                 }
1577
1578           if (!dbus_message_append_args (msg, DBUS_TYPE_STRING, &rule,
1579                                                                          DBUS_TYPE_INVALID))
1580                 {
1581                   dbus_message_unref (msg);
1582                   _DBUS_SET_OOM (error);
1583                   return;
1584                 }
1585
1586           send_no_return_values (connection, msg, error);
1587
1588           dbus_message_unref (msg);
1589         }
1590         else
1591                 dbus_bus_add_match_kdbus(connection, rule, error);
1592 }
1593
1594 /**
1595  * Removes a previously-added match rule "by value" (the most
1596  * recently-added identical rule gets removed).  The "rule" argument
1597  * is the string form of a match rule.
1598  *
1599  * The bus compares match rules semantically, not textually, so
1600  * whitespace and ordering don't have to be identical to
1601  * the rule you passed to dbus_bus_add_match().
1602  * 
1603  * If you pass #NULL for the error, this function will not
1604  * block; otherwise it will. See detailed explanation in
1605  * docs for dbus_bus_add_match().
1606  * 
1607  * @param connection connection to the message bus
1608  * @param rule textual form of match rule
1609  * @param error location to store any errors
1610  */
1611 void
1612 dbus_bus_remove_match (DBusConnection *connection,
1613                        const char     *rule,
1614                        DBusError      *error)
1615 {
1616   DBusMessage *msg;
1617
1618   _dbus_return_if_fail (rule != NULL);
1619   
1620   msg = dbus_message_new_method_call (DBUS_SERVICE_DBUS,
1621                                       DBUS_PATH_DBUS,
1622                                       DBUS_INTERFACE_DBUS,
1623                                       "RemoveMatch");
1624
1625   if (!dbus_message_append_args (msg, DBUS_TYPE_STRING, &rule,
1626                                  DBUS_TYPE_INVALID))
1627     {
1628       dbus_message_unref (msg);
1629       _DBUS_SET_OOM (error);
1630       return;
1631     }
1632
1633   send_no_return_values (connection, msg, error);
1634
1635   dbus_message_unref (msg);
1636 }
1637
1638 /** @} */