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