1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Author: David Zeuthen <davidz@redhat.com>
29 #include "gdbusutils.h"
30 #include "gdbusaddress.h"
31 #include "gdbuserror.h"
32 #include "gioenumtypes.h"
33 #include "gnetworkaddress.h"
34 #include "gsocketclient.h"
35 #include "giostream.h"
36 #include "gasyncresult.h"
38 #include "glib-private.h"
39 #include "gdbusprivate.h"
40 #include "giomodule-priv.h"
41 #include "gdbusdaemon.h"
47 #include <sys/types.h>
48 #include <gio/gunixsocketaddress.h>
60 * SECTION:gdbusaddress
61 * @title: D-Bus Addresses
62 * @short_description: D-Bus connection endpoints
65 * Routines for working with D-Bus addresses. A D-Bus address is a string
66 * like `unix:tmpdir=/tmp/my-app-name`. The exact format of addresses
67 * is explained in detail in the
68 * [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
71 static gchar
*get_session_address_platform_specific (GError
**error
);
72 static gchar
*get_session_address_dbus_launch (GError
**error
);
74 /* ---------------------------------------------------------------------------------------------------- */
80 * Checks if @string is a
81 * [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
83 * This doesn't check if @string is actually supported by #GDBusServer
84 * or #GDBusConnection - use g_dbus_is_supported_address() to do more
87 * Returns: %TRUE if @string is a valid D-Bus address, %FALSE otherwise.
92 g_dbus_is_address (const gchar
*string
)
100 g_return_val_if_fail (string
!= NULL
, FALSE
);
102 a
= g_strsplit (string
, ";", 0);
106 for (n
= 0; a
[n
] != NULL
; n
++)
108 if (!_g_dbus_address_parse_entry (a
[n
],
123 is_valid_unix (const gchar
*address_entry
,
124 GHashTable
*key_value_pairs
,
132 const gchar
*abstract
;
140 keys
= g_hash_table_get_keys (key_value_pairs
);
141 for (l
= keys
; l
!= NULL
; l
= l
->next
)
143 const gchar
*key
= l
->data
;
144 if (g_strcmp0 (key
, "path") == 0)
145 path
= g_hash_table_lookup (key_value_pairs
, key
);
146 else if (g_strcmp0 (key
, "tmpdir") == 0)
147 tmpdir
= g_hash_table_lookup (key_value_pairs
, key
);
148 else if (g_strcmp0 (key
, "abstract") == 0)
149 abstract
= g_hash_table_lookup (key_value_pairs
, key
);
154 G_IO_ERROR_INVALID_ARGUMENT
,
155 _("Unsupported key “%s” in address entry “%s”"),
164 if (tmpdir
!= NULL
|| abstract
!= NULL
)
167 else if (tmpdir
!= NULL
)
169 if (path
!= NULL
|| abstract
!= NULL
)
172 else if (abstract
!= NULL
)
174 if (path
!= NULL
|| tmpdir
!= NULL
)
181 G_IO_ERROR_INVALID_ARGUMENT
,
182 _("Address “%s” is invalid (need exactly one of path, tmpdir or abstract keys)"),
194 G_IO_ERROR_INVALID_ARGUMENT
,
195 _("Meaningless key/value pair combination in address entry “%s”"),
205 is_valid_nonce_tcp (const gchar
*address_entry
,
206 GHashTable
*key_value_pairs
,
215 const gchar
*nonce_file
;
226 keys
= g_hash_table_get_keys (key_value_pairs
);
227 for (l
= keys
; l
!= NULL
; l
= l
->next
)
229 const gchar
*key
= l
->data
;
230 if (g_strcmp0 (key
, "host") == 0)
231 host
= g_hash_table_lookup (key_value_pairs
, key
);
232 else if (g_strcmp0 (key
, "port") == 0)
233 port
= g_hash_table_lookup (key_value_pairs
, key
);
234 else if (g_strcmp0 (key
, "family") == 0)
235 family
= g_hash_table_lookup (key_value_pairs
, key
);
236 else if (g_strcmp0 (key
, "noncefile") == 0)
237 nonce_file
= g_hash_table_lookup (key_value_pairs
, key
);
242 G_IO_ERROR_INVALID_ARGUMENT
,
243 _("Unsupported key “%s” in address entry “%s”"),
252 port_num
= strtol (port
, &endp
, 10);
253 if ((*port
== '\0' || *endp
!= '\0') || port_num
< 0 || port_num
>= 65536)
257 G_IO_ERROR_INVALID_ARGUMENT
,
258 _("Error in address “%s” — the port attribute is malformed"),
264 if (family
!= NULL
&& !(g_strcmp0 (family
, "ipv4") == 0 || g_strcmp0 (family
, "ipv6") == 0))
268 G_IO_ERROR_INVALID_ARGUMENT
,
269 _("Error in address “%s” — the family attribute is malformed"),
276 /* TODO: validate host */
279 nonce_file
= nonce_file
; /* To avoid -Wunused-but-set-variable */
290 is_valid_tcp (const gchar
*address_entry
,
291 GHashTable
*key_value_pairs
,
309 keys
= g_hash_table_get_keys (key_value_pairs
);
310 for (l
= keys
; l
!= NULL
; l
= l
->next
)
312 const gchar
*key
= l
->data
;
313 if (g_strcmp0 (key
, "host") == 0)
314 host
= g_hash_table_lookup (key_value_pairs
, key
);
315 else if (g_strcmp0 (key
, "port") == 0)
316 port
= g_hash_table_lookup (key_value_pairs
, key
);
317 else if (g_strcmp0 (key
, "family") == 0)
318 family
= g_hash_table_lookup (key_value_pairs
, key
);
323 G_IO_ERROR_INVALID_ARGUMENT
,
324 _("Unsupported key “%s” in address entry “%s”"),
333 port_num
= strtol (port
, &endp
, 10);
334 if ((*port
== '\0' || *endp
!= '\0') || port_num
< 0 || port_num
>= 65536)
338 G_IO_ERROR_INVALID_ARGUMENT
,
339 _("Error in address “%s” — the port attribute is malformed"),
345 if (family
!= NULL
&& !(g_strcmp0 (family
, "ipv4") == 0 || g_strcmp0 (family
, "ipv6") == 0))
349 G_IO_ERROR_INVALID_ARGUMENT
,
350 _("Error in address “%s” — the family attribute is malformed"),
357 /* TODO: validate host */
369 * g_dbus_is_supported_address:
371 * @error: Return location for error or %NULL.
373 * Like g_dbus_is_address() but also checks if the library supports the
374 * transports in @string and that key/value pairs for each transport
375 * are valid. See the specification of the
376 * [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
378 * Returns: %TRUE if @string is a valid D-Bus address that is
379 * supported by this library, %FALSE if @error is set.
384 g_dbus_is_supported_address (const gchar
*string
,
393 g_return_val_if_fail (string
!= NULL
, FALSE
);
394 g_return_val_if_fail (error
== NULL
|| *error
== NULL
, FALSE
);
396 a
= g_strsplit (string
, ";", 0);
397 for (n
= 0; a
[n
] != NULL
; n
++)
399 gchar
*transport_name
;
400 GHashTable
*key_value_pairs
;
403 if (!_g_dbus_address_parse_entry (a
[n
],
410 if (g_strcmp0 (transport_name
, "unix") == 0)
411 supported
= is_valid_unix (a
[n
], key_value_pairs
, error
);
412 else if (g_strcmp0 (transport_name
, "tcp") == 0)
413 supported
= is_valid_tcp (a
[n
], key_value_pairs
, error
);
414 else if (g_strcmp0 (transport_name
, "nonce-tcp") == 0)
415 supported
= is_valid_nonce_tcp (a
[n
], key_value_pairs
, error
);
416 else if (g_strcmp0 (a
[n
], "autolaunch:") == 0)
419 g_free (transport_name
);
420 g_hash_table_unref (key_value_pairs
);
431 g_assert (ret
|| (!ret
&& (error
== NULL
|| *error
!= NULL
)));
437 _g_dbus_address_parse_entry (const gchar
*address_entry
,
438 gchar
**out_transport_name
,
439 GHashTable
**out_key_value_pairs
,
443 GHashTable
*key_value_pairs
;
444 gchar
*transport_name
;
451 transport_name
= NULL
;
452 key_value_pairs
= NULL
;
454 s
= strchr (address_entry
, ':');
459 G_IO_ERROR_INVALID_ARGUMENT
,
460 _("Address element “%s” does not contain a colon (:)"),
465 transport_name
= g_strndup (address_entry
, s
- address_entry
);
466 key_value_pairs
= g_hash_table_new_full (g_str_hash
, g_str_equal
, g_free
, g_free
);
468 kv_pairs
= g_strsplit (s
+ 1, ",", 0);
469 for (n
= 0; kv_pairs
!= NULL
&& kv_pairs
[n
] != NULL
; n
++)
471 const gchar
*kv_pair
= kv_pairs
[n
];
475 s
= strchr (kv_pair
, '=');
480 G_IO_ERROR_INVALID_ARGUMENT
,
481 _("Key/Value pair %d, “%s”, in address element “%s” does not contain an equal sign"),
488 key
= g_uri_unescape_segment (kv_pair
, s
, NULL
);
489 value
= g_uri_unescape_segment (s
+ 1, kv_pair
+ strlen (kv_pair
), NULL
);
490 if (key
== NULL
|| value
== NULL
)
494 G_IO_ERROR_INVALID_ARGUMENT
,
495 _("Error unescaping key or value in Key/Value pair %d, “%s”, in address element “%s”"),
503 g_hash_table_insert (key_value_pairs
, key
, value
);
509 g_strfreev (kv_pairs
);
512 if (out_transport_name
!= NULL
)
513 *out_transport_name
= transport_name
;
515 g_free (transport_name
);
516 if (out_key_value_pairs
!= NULL
)
517 *out_key_value_pairs
= key_value_pairs
;
518 else if (key_value_pairs
!= NULL
)
519 g_hash_table_unref (key_value_pairs
);
523 g_free (transport_name
);
524 if (key_value_pairs
!= NULL
)
525 g_hash_table_unref (key_value_pairs
);
530 /* ---------------------------------------------------------------------------------------------------- */
533 g_dbus_address_try_connect_one (const gchar
*address_entry
,
535 GCancellable
*cancellable
,
538 /* TODO: Declare an extension point called GDBusTransport (or similar)
539 * and move code below to extensions implementing said extension
540 * point. That way we can implement a D-Bus transport over X11 without
541 * making libgio link to libX11...
544 g_dbus_address_connect (const gchar
*address_entry
,
545 const gchar
*transport_name
,
546 GHashTable
*key_value_pairs
,
547 GCancellable
*cancellable
,
551 GSocketConnectable
*connectable
;
552 const gchar
*nonce_file
;
562 else if (g_strcmp0 (transport_name
, "unix") == 0)
565 const gchar
*abstract
;
566 path
= g_hash_table_lookup (key_value_pairs
, "path");
567 abstract
= g_hash_table_lookup (key_value_pairs
, "abstract");
568 if ((path
== NULL
&& abstract
== NULL
) || (path
!= NULL
&& abstract
!= NULL
))
572 G_IO_ERROR_INVALID_ARGUMENT
,
573 _("Error in address “%s” — the unix transport requires exactly one of the "
574 "keys “path” or “abstract” to be set"),
577 else if (path
!= NULL
)
579 connectable
= G_SOCKET_CONNECTABLE (g_unix_socket_address_new (path
));
581 else if (abstract
!= NULL
)
583 connectable
= G_SOCKET_CONNECTABLE (g_unix_socket_address_new_with_type (abstract
,
585 G_UNIX_SOCKET_ADDRESS_ABSTRACT
));
589 g_assert_not_reached ();
593 else if (g_strcmp0 (transport_name
, "tcp") == 0 || g_strcmp0 (transport_name
, "nonce-tcp") == 0)
601 is_nonce
= (g_strcmp0 (transport_name
, "nonce-tcp") == 0);
603 host
= g_hash_table_lookup (key_value_pairs
, "host");
608 G_IO_ERROR_INVALID_ARGUMENT
,
609 _("Error in address “%s” — the host attribute is missing or malformed"),
614 s
= g_hash_table_lookup (key_value_pairs
, "port");
617 port
= strtol (s
, &endp
, 10);
618 if ((*s
== '\0' || *endp
!= '\0') || port
< 0 || port
>= 65536)
622 G_IO_ERROR_INVALID_ARGUMENT
,
623 _("Error in address “%s” — the port attribute is missing or malformed"),
631 nonce_file
= g_hash_table_lookup (key_value_pairs
, "noncefile");
632 if (nonce_file
== NULL
)
636 G_IO_ERROR_INVALID_ARGUMENT
,
637 _("Error in address “%s” — the noncefile attribute is missing or malformed"),
643 /* TODO: deal with family key/value-pair */
644 connectable
= g_network_address_new (host
, port
);
646 else if (g_strcmp0 (address_entry
, "autolaunch:") == 0)
648 gchar
*autolaunch_address
;
649 autolaunch_address
= get_session_address_dbus_launch (error
);
650 if (autolaunch_address
!= NULL
)
652 ret
= g_dbus_address_try_connect_one (autolaunch_address
, NULL
, cancellable
, error
);
653 g_free (autolaunch_address
);
658 g_prefix_error (error
, _("Error auto-launching: "));
665 G_IO_ERROR_INVALID_ARGUMENT
,
666 _("Unknown or unsupported transport “%s” for address “%s”"),
671 if (connectable
!= NULL
)
673 GSocketClient
*client
;
674 GSocketConnection
*connection
;
676 g_assert (ret
== NULL
);
677 client
= g_socket_client_new ();
678 connection
= g_socket_client_connect (client
,
682 g_object_unref (connectable
);
683 g_object_unref (client
);
684 if (connection
== NULL
)
687 ret
= G_IO_STREAM (connection
);
689 if (nonce_file
!= NULL
)
691 gchar nonce_contents
[16 + 1];
692 size_t num_bytes_read
;
696 /* be careful to read only 16 bytes - we also check that the file is only 16 bytes long */
697 f
= fopen (nonce_file
, "rb");
703 G_IO_ERROR_INVALID_ARGUMENT
,
704 _("Error opening nonce file “%s”: %s"),
707 g_object_unref (ret
);
711 num_bytes_read
= fread (nonce_contents
,
716 if (num_bytes_read
!= 16)
718 if (num_bytes_read
== 0)
722 G_IO_ERROR_INVALID_ARGUMENT
,
723 _("Error reading from nonce file “%s”: %s"),
731 G_IO_ERROR_INVALID_ARGUMENT
,
732 _("Error reading from nonce file “%s”, expected 16 bytes, got %d"),
734 (gint
) num_bytes_read
);
736 g_object_unref (ret
);
743 if (!g_output_stream_write_all (g_io_stream_get_output_stream (ret
),
750 g_prefix_error (error
, _("Error writing contents of nonce file “%s” to stream:"), nonce_file
);
751 g_object_unref (ret
);
764 g_dbus_address_try_connect_one (const gchar
*address_entry
,
766 GCancellable
*cancellable
,
770 GHashTable
*key_value_pairs
;
771 gchar
*transport_name
;
775 transport_name
= NULL
;
776 key_value_pairs
= NULL
;
778 if (!_g_dbus_address_parse_entry (address_entry
,
784 ret
= g_dbus_address_connect (address_entry
,
792 guid
= g_hash_table_lookup (key_value_pairs
, "guid");
793 if (guid
!= NULL
&& out_guid
!= NULL
)
794 *out_guid
= g_strdup (guid
);
797 g_free (transport_name
);
798 if (key_value_pairs
!= NULL
)
799 g_hash_table_unref (key_value_pairs
);
804 /* ---------------------------------------------------------------------------------------------------- */
812 get_stream_data_free (GetStreamData
*data
)
814 g_free (data
->address
);
820 get_stream_thread_func (GTask
*task
,
821 gpointer source_object
,
823 GCancellable
*cancellable
)
825 GetStreamData
*data
= task_data
;
827 GError
*error
= NULL
;
829 stream
= g_dbus_address_get_stream_sync (data
->address
,
834 g_task_return_pointer (task
, stream
, g_object_unref
);
836 g_task_return_error (task
, error
);
840 * g_dbus_address_get_stream:
841 * @address: A valid D-Bus address.
842 * @cancellable: (nullable): A #GCancellable or %NULL.
843 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
844 * @user_data: Data to pass to @callback.
846 * Asynchronously connects to an endpoint specified by @address and
847 * sets up the connection so it is in a state to run the client-side
848 * of the D-Bus authentication conversation. @address must be in the
849 * [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
851 * When the operation is finished, @callback will be invoked. You can
852 * then call g_dbus_address_get_stream_finish() to get the result of
855 * This is an asynchronous failable function. See
856 * g_dbus_address_get_stream_sync() for the synchronous version.
861 g_dbus_address_get_stream (const gchar
*address
,
862 GCancellable
*cancellable
,
863 GAsyncReadyCallback callback
,
869 g_return_if_fail (address
!= NULL
);
871 data
= g_new0 (GetStreamData
, 1);
872 data
->address
= g_strdup (address
);
874 task
= g_task_new (NULL
, cancellable
, callback
, user_data
);
875 g_task_set_source_tag (task
, g_dbus_address_get_stream
);
876 g_task_set_task_data (task
, data
, (GDestroyNotify
) get_stream_data_free
);
877 g_task_run_in_thread (task
, get_stream_thread_func
);
878 g_object_unref (task
);
882 * g_dbus_address_get_stream_finish:
883 * @res: A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream().
884 * @out_guid: (optional) (out): %NULL or return location to store the GUID extracted from @address, if any.
885 * @error: Return location for error or %NULL.
887 * Finishes an operation started with g_dbus_address_get_stream().
889 * Returns: (transfer full): A #GIOStream or %NULL if @error is set.
894 g_dbus_address_get_stream_finish (GAsyncResult
*res
,
902 g_return_val_if_fail (g_task_is_valid (res
, NULL
), NULL
);
903 g_return_val_if_fail (error
== NULL
|| *error
== NULL
, NULL
);
906 ret
= g_task_propagate_pointer (task
, error
);
908 if (ret
!= NULL
&& out_guid
!= NULL
)
910 data
= g_task_get_task_data (task
);
911 *out_guid
= data
->guid
;
919 * g_dbus_address_get_stream_sync:
920 * @address: A valid D-Bus address.
921 * @out_guid: (optional) (out): %NULL or return location to store the GUID extracted from @address, if any.
922 * @cancellable: (nullable): A #GCancellable or %NULL.
923 * @error: Return location for error or %NULL.
925 * Synchronously connects to an endpoint specified by @address and
926 * sets up the connection so it is in a state to run the client-side
927 * of the D-Bus authentication conversation. @address must be in the
928 * [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
930 * This is a synchronous failable function. See
931 * g_dbus_address_get_stream() for the asynchronous version.
933 * Returns: (transfer full): A #GIOStream or %NULL if @error is set.
938 g_dbus_address_get_stream_sync (const gchar
*address
,
940 GCancellable
*cancellable
,
948 g_return_val_if_fail (address
!= NULL
, NULL
);
949 g_return_val_if_fail (error
== NULL
|| *error
== NULL
, NULL
);
954 addr_array
= g_strsplit (address
, ";", 0);
955 if (addr_array
!= NULL
&& addr_array
[0] == NULL
)
957 last_error
= g_error_new_literal (G_IO_ERROR
,
958 G_IO_ERROR_INVALID_ARGUMENT
,
959 _("The given address is empty"));
963 for (n
= 0; addr_array
!= NULL
&& addr_array
[n
] != NULL
; n
++)
965 const gchar
*addr
= addr_array
[n
];
969 ret
= g_dbus_address_try_connect_one (addr
,
979 g_assert (this_error
!= NULL
);
980 if (last_error
!= NULL
)
981 g_error_free (last_error
);
982 last_error
= this_error
;
989 if (last_error
!= NULL
)
990 g_error_free (last_error
);
994 g_assert (last_error
!= NULL
);
995 g_propagate_error (error
, last_error
);
998 g_strfreev (addr_array
);
1002 /* ---------------------------------------------------------------------------------------------------- */
1005 * Return the address of XDG_RUNTIME_DIR/bus if it exists, belongs to
1006 * us, and is a socket, and we are on Unix.
1009 get_session_address_xdg (void)
1017 bus
= g_build_filename (g_get_user_runtime_dir (), "bus", NULL
);
1019 /* if ENOENT, EPERM, etc., quietly don't use it */
1020 if (g_stat (bus
, &buf
) < 0)
1023 /* if it isn't ours, we have incorrectly inherited someone else's
1024 * XDG_RUNTIME_DIR; silently don't use it
1026 if (buf
.st_uid
!= geteuid ())
1029 /* if it isn't a socket, silently don't use it */
1030 if ((buf
.st_mode
& S_IFMT
) != S_IFSOCK
)
1033 tmp
= g_dbus_address_escape_value (bus
);
1034 ret
= g_strconcat ("unix:path=", tmp
, NULL
);
1045 /* ---------------------------------------------------------------------------------------------------- */
1049 get_session_address_dbus_launch (GError
**error
)
1053 gchar
*command_line
;
1054 gchar
*launch_stdout
;
1055 gchar
*launch_stderr
;
1057 gchar
*old_dbus_verbose
;
1058 gboolean restore_dbus_verbose
;
1062 command_line
= NULL
;
1063 launch_stdout
= NULL
;
1064 launch_stderr
= NULL
;
1065 restore_dbus_verbose
= FALSE
;
1066 old_dbus_verbose
= NULL
;
1068 /* Don't run binaries as root if we're setuid. */
1069 if (GLIB_PRIVATE_CALL (g_check_setuid
) ())
1071 g_set_error (error
, G_IO_ERROR
, G_IO_ERROR_FAILED
,
1072 _("Cannot spawn a message bus when setuid"));
1076 machine_id
= _g_dbus_get_machine_id (error
);
1077 if (machine_id
== NULL
)
1079 g_prefix_error (error
, _("Cannot spawn a message bus without a machine-id: "));
1083 if (g_getenv ("DISPLAY") == NULL
)
1085 g_set_error (error
, G_IO_ERROR
, G_IO_ERROR_FAILED
,
1086 _("Cannot autolaunch D-Bus without X11 $DISPLAY"));
1090 /* We're using private libdbus facilities here. When everything
1091 * (X11, Mac OS X, Windows) is spec'ed out correctly (not even the
1092 * X11 property is correctly documented right now) we should
1093 * consider using the spec instead of dbus-launch.
1095 * --autolaunch=MACHINEID
1096 * This option implies that dbus-launch should scan for a previ‐
1097 * ously-started session and reuse the values found there. If no
1098 * session is found, it will start a new session. The --exit-with-
1099 * session option is implied if --autolaunch is given. This option
1100 * is for the exclusive use of libdbus, you do not want to use it
1101 * manually. It may change in the future.
1104 /* TODO: maybe provide a variable for where to look for the dbus-launch binary? */
1105 command_line
= g_strdup_printf ("dbus-launch --autolaunch=%s --binary-syntax --close-stderr", machine_id
);
1107 if (G_UNLIKELY (_g_dbus_debug_address ()))
1109 _g_dbus_debug_print_lock ();
1110 g_print ("GDBus-debug:Address: Running '%s' to get bus address (possibly autolaunching)\n", command_line
);
1111 old_dbus_verbose
= g_strdup (g_getenv ("DBUS_VERBOSE"));
1112 restore_dbus_verbose
= TRUE
;
1113 g_setenv ("DBUS_VERBOSE", "1", TRUE
);
1114 _g_dbus_debug_print_unlock ();
1117 if (!g_spawn_command_line_sync (command_line
,
1126 if (!g_spawn_check_exit_status (exit_status
, error
))
1128 g_prefix_error (error
, _("Error spawning command line “%s”: "), command_line
);
1132 /* From the dbus-launch(1) man page:
1134 * --binary-syntax Write to stdout a nul-terminated bus address,
1135 * then the bus PID as a binary integer of size sizeof(pid_t),
1136 * then the bus X window ID as a binary integer of size
1137 * sizeof(long). Integers are in the machine's byte order, not
1138 * network byte order or any other canonical byte order.
1140 ret
= g_strdup (launch_stdout
);
1143 if (G_UNLIKELY (_g_dbus_debug_address ()))
1146 _g_dbus_debug_print_lock ();
1147 g_print ("GDBus-debug:Address: dbus-launch output:");
1148 if (launch_stdout
!= NULL
)
1150 s
= _g_dbus_hexdump (launch_stdout
, strlen (launch_stdout
) + 1 + sizeof (pid_t
) + sizeof (long), 2);
1151 g_print ("\n%s", s
);
1156 g_print (" (none)\n");
1158 g_print ("GDBus-debug:Address: dbus-launch stderr output:");
1159 if (launch_stderr
!= NULL
)
1160 g_print ("\n%s", launch_stderr
);
1162 g_print (" (none)\n");
1163 _g_dbus_debug_print_unlock ();
1166 g_free (machine_id
);
1167 g_free (command_line
);
1168 g_free (launch_stdout
);
1169 g_free (launch_stderr
);
1170 if (G_UNLIKELY (restore_dbus_verbose
))
1172 if (old_dbus_verbose
!= NULL
)
1173 g_setenv ("DBUS_VERBOSE", old_dbus_verbose
, TRUE
);
1175 g_unsetenv ("DBUS_VERBOSE");
1177 g_free (old_dbus_verbose
);
1181 /* end of G_OS_UNIX case */
1182 #elif defined(G_OS_WIN32)
1184 #define DBUS_DAEMON_ADDRESS_INFO "DBusDaemonAddressInfo"
1185 #define DBUS_DAEMON_MUTEX "DBusDaemonMutex"
1186 #define UNIQUE_DBUS_INIT_MUTEX "UniqueDBusInitMutex"
1187 #define DBUS_AUTOLAUNCH_MUTEX "DBusAutolaunchMutex"
1190 release_mutex (HANDLE mutex
)
1192 ReleaseMutex (mutex
);
1193 CloseHandle (mutex
);
1197 acquire_mutex (const char *mutexname
)
1202 mutex
= CreateMutexA (NULL
, FALSE
, mutexname
);
1206 res
= WaitForSingleObject (mutex
, INFINITE
);
1209 case WAIT_ABANDONED
:
1210 release_mutex (mutex
);
1221 is_mutex_owned (const char *mutexname
)
1224 gboolean res
= FALSE
;
1226 mutex
= CreateMutexA (NULL
, FALSE
, mutexname
);
1227 if (WaitForSingleObject (mutex
, 10) == WAIT_TIMEOUT
)
1230 ReleaseMutex (mutex
);
1231 CloseHandle (mutex
);
1237 read_shm (const char *shm_name
)
1246 for (i
= 0; i
< 20; i
++)
1248 shared_mem
= OpenFileMappingA (FILE_MAP_READ
, FALSE
, shm_name
);
1249 if (shared_mem
!= 0)
1254 if (shared_mem
!= 0)
1256 shared_data
= MapViewOfFile (shared_mem
, FILE_MAP_READ
, 0, 0, 0);
1257 if (shared_data
!= NULL
)
1259 res
= g_strdup (shared_data
);
1260 UnmapViewOfFile (shared_data
);
1262 CloseHandle (shared_mem
);
1269 set_shm (const char *shm_name
, const char *value
)
1274 shared_mem
= CreateFileMappingA (INVALID_HANDLE_VALUE
, NULL
, PAGE_READWRITE
,
1275 0, strlen (value
) + 1, shm_name
);
1276 if (shared_mem
== 0)
1279 shared_data
= MapViewOfFile (shared_mem
, FILE_MAP_WRITE
, 0, 0, 0 );
1280 if (shared_data
== NULL
)
1283 strcpy (shared_data
, value
);
1285 UnmapViewOfFile (shared_data
);
1290 /* These keep state between publish_session_bus and unpublish_session_bus */
1291 static HANDLE published_daemon_mutex
;
1292 static HANDLE published_shared_mem
;
1295 publish_session_bus (const char *address
)
1299 init_mutex
= acquire_mutex (UNIQUE_DBUS_INIT_MUTEX
);
1301 published_daemon_mutex
= CreateMutexA (NULL
, FALSE
, DBUS_DAEMON_MUTEX
);
1302 if (WaitForSingleObject (published_daemon_mutex
, 10 ) != WAIT_OBJECT_0
)
1304 release_mutex (init_mutex
);
1305 CloseHandle (published_daemon_mutex
);
1306 published_daemon_mutex
= NULL
;
1310 published_shared_mem
= set_shm (DBUS_DAEMON_ADDRESS_INFO
, address
);
1311 if (!published_shared_mem
)
1313 release_mutex (init_mutex
);
1314 CloseHandle (published_daemon_mutex
);
1315 published_daemon_mutex
= NULL
;
1319 release_mutex (init_mutex
);
1324 unpublish_session_bus (void)
1328 init_mutex
= acquire_mutex (UNIQUE_DBUS_INIT_MUTEX
);
1330 CloseHandle (published_shared_mem
);
1331 published_shared_mem
= NULL
;
1333 release_mutex (published_daemon_mutex
);
1334 published_daemon_mutex
= NULL
;
1336 release_mutex (init_mutex
);
1340 wait_console_window (void)
1342 FILE *console
= fopen ("CONOUT$", "w");
1344 SetConsoleTitleW (L
"gdbus-daemon output. Type any character to close this window.");
1345 fprintf (console
, _("(Type any character to close this window)\n"));
1351 open_console_window (void)
1353 if (((HANDLE
) _get_osfhandle (fileno (stdout
)) == INVALID_HANDLE_VALUE
||
1354 (HANDLE
) _get_osfhandle (fileno (stderr
)) == INVALID_HANDLE_VALUE
) && AllocConsole ())
1356 if ((HANDLE
) _get_osfhandle (fileno (stdout
)) == INVALID_HANDLE_VALUE
)
1357 freopen ("CONOUT$", "w", stdout
);
1359 if ((HANDLE
) _get_osfhandle (fileno (stderr
)) == INVALID_HANDLE_VALUE
)
1360 freopen ("CONOUT$", "w", stderr
);
1362 SetConsoleTitleW (L
"gdbus-daemon debug output.");
1364 atexit (wait_console_window
);
1369 idle_timeout_cb (GDBusDaemon
*daemon
, gpointer user_data
)
1371 GMainLoop
*loop
= user_data
;
1372 g_main_loop_quit (loop
);
1375 /* Satisfies STARTF_FORCEONFEEDBACK */
1377 turn_off_the_starting_cursor (void)
1382 PostQuitMessage (0);
1384 while ((bRet
= GetMessage (&msg
, 0, 0, 0)) != 0)
1389 TranslateMessage (&msg
);
1390 DispatchMessage (&msg
);
1394 __declspec(dllexport
) void CALLBACK
g_win32_run_session_bus (HWND hwnd
, HINSTANCE hinst
, char *cmdline
, int nCmdShow
);
1396 __declspec(dllexport
) void CALLBACK
1397 g_win32_run_session_bus (HWND hwnd
, HINSTANCE hinst
, char *cmdline
, int nCmdShow
)
1399 GDBusDaemon
*daemon
;
1401 const char *address
;
1402 GError
*error
= NULL
;
1404 turn_off_the_starting_cursor ();
1406 if (g_getenv ("GDBUS_DAEMON_DEBUG") != NULL
)
1407 open_console_window ();
1409 loop
= g_main_loop_new (NULL
, FALSE
);
1411 address
= "nonce-tcp:";
1412 daemon
= _g_dbus_daemon_new (address
, NULL
, &error
);
1415 g_printerr ("Can't init bus: %s\n", error
->message
);
1416 g_error_free (error
);
1420 g_signal_connect (daemon
, "idle-timeout", G_CALLBACK (idle_timeout_cb
), loop
);
1422 if (publish_session_bus (_g_dbus_daemon_get_address (daemon
)))
1424 g_main_loop_run (loop
);
1426 unpublish_session_bus ();
1429 g_main_loop_unref (loop
);
1430 g_object_unref (daemon
);
1434 get_session_address_dbus_launch (GError
**error
)
1436 HANDLE autolaunch_mutex
, init_mutex
;
1437 char *address
= NULL
;
1438 wchar_t gio_path
[MAX_PATH
+1+200];
1440 autolaunch_mutex
= acquire_mutex (DBUS_AUTOLAUNCH_MUTEX
);
1442 init_mutex
= acquire_mutex (UNIQUE_DBUS_INIT_MUTEX
);
1444 if (is_mutex_owned (DBUS_DAEMON_MUTEX
))
1445 address
= read_shm (DBUS_DAEMON_ADDRESS_INFO
);
1447 release_mutex (init_mutex
);
1449 if (address
== NULL
)
1451 gio_path
[MAX_PATH
] = 0;
1452 if (GetModuleFileNameW (_g_io_win32_get_module (), gio_path
, MAX_PATH
))
1454 PROCESS_INFORMATION pi
= { 0 };
1455 STARTUPINFOW si
= { 0 };
1457 wchar_t gio_path_short
[MAX_PATH
];
1458 wchar_t rundll_path
[MAX_PATH
*2];
1459 wchar_t args
[MAX_PATH
*4];
1461 GetShortPathNameW (gio_path
, gio_path_short
, MAX_PATH
);
1463 GetWindowsDirectoryW (rundll_path
, MAX_PATH
);
1464 wcscat (rundll_path
, L
"\\rundll32.exe");
1465 if (GetFileAttributesW (rundll_path
) == INVALID_FILE_ATTRIBUTES
)
1467 GetSystemDirectoryW (rundll_path
, MAX_PATH
);
1468 wcscat (rundll_path
, L
"\\rundll32.exe");
1471 wcscpy (args
, L
"\"");
1472 wcscat (args
, rundll_path
);
1473 wcscat (args
, L
"\" ");
1474 wcscat (args
, gio_path_short
);
1475 #if defined(_WIN64) || defined(_M_X64) || defined(_M_AMD64)
1476 wcscat (args
, L
",g_win32_run_session_bus");
1477 #elif defined (_MSC_VER)
1478 wcscat (args
, L
",_g_win32_run_session_bus@16");
1480 wcscat (args
, L
",g_win32_run_session_bus@16");
1483 res
= CreateProcessW (rundll_path
, args
,
1485 NORMAL_PRIORITY_CLASS
| CREATE_NO_WINDOW
| DETACHED_PROCESS
,
1486 0, NULL
/* TODO: Should be root */,
1489 address
= read_shm (DBUS_DAEMON_ADDRESS_INFO
);
1493 release_mutex (autolaunch_mutex
);
1495 if (address
== NULL
)
1499 _("Session dbus not running, and autolaunch failed"));
1503 #else /* neither G_OS_UNIX nor G_OS_WIN32 */
1505 get_session_address_dbus_launch (GError
**error
)
1510 _("Cannot determine session bus address (not implemented for this OS)"));
1513 #endif /* neither G_OS_UNIX nor G_OS_WIN32 */
1515 /* ---------------------------------------------------------------------------------------------------- */
1518 get_session_address_platform_specific (GError
**error
)
1522 /* Use XDG_RUNTIME_DIR/bus if it exists and is suitable. This is appropriate
1523 * for systems using the "a session is a user-session" model described in
1524 * <http://lists.freedesktop.org/archives/dbus/2015-January/016522.html>,
1525 * and implemented in dbus >= 1.9.14 and sd-bus.
1527 * On systems following the more traditional "a session is a login-session"
1528 * model, this will fail and we'll fall through to X11 autolaunching
1529 * (dbus-launch) below.
1531 ret
= get_session_address_xdg ();
1536 /* TODO (#694472): try launchd on OS X, like
1537 * _dbus_lookup_session_address_launchd() does, since
1538 * 'dbus-launch --autolaunch' probably won't work there
1541 /* As a last resort, try the "autolaunch:" transport. On Unix this means
1542 * X11 autolaunching; on Windows this means a different autolaunching
1543 * mechanism based on shared memory.
1545 return get_session_address_dbus_launch (error
);
1548 /* ---------------------------------------------------------------------------------------------------- */
1551 * g_dbus_address_get_for_bus_sync:
1552 * @bus_type: a #GBusType
1553 * @cancellable: (nullable): a #GCancellable or %NULL
1554 * @error: return location for error or %NULL
1556 * Synchronously looks up the D-Bus address for the well-known message
1557 * bus instance specified by @bus_type. This may involve using various
1558 * platform specific mechanisms.
1560 * The returned address will be in the
1561 * [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses).
1563 * Returns: a valid D-Bus address string for @bus_type or %NULL if
1569 g_dbus_address_get_for_bus_sync (GBusType bus_type
,
1570 GCancellable
*cancellable
,
1573 gchar
*ret
, *s
= NULL
;
1574 const gchar
*starter_bus
;
1575 GError
*local_error
;
1577 g_return_val_if_fail (error
== NULL
|| *error
== NULL
, NULL
);
1582 if (G_UNLIKELY (_g_dbus_debug_address ()))
1585 _g_dbus_debug_print_lock ();
1586 s
= _g_dbus_enum_to_string (G_TYPE_BUS_TYPE
, bus_type
);
1587 g_print ("GDBus-debug:Address: In g_dbus_address_get_for_bus_sync() for bus type '%s'\n",
1590 for (n
= 0; n
< 3; n
++)
1596 case 0: k
= "DBUS_SESSION_BUS_ADDRESS"; break;
1597 case 1: k
= "DBUS_SYSTEM_BUS_ADDRESS"; break;
1598 case 2: k
= "DBUS_STARTER_BUS_TYPE"; break;
1599 default: g_assert_not_reached ();
1602 g_print ("GDBus-debug:Address: env var %s", k
);
1604 g_print ("='%s'\n", v
);
1606 g_print (" is not set\n");
1608 _g_dbus_debug_print_unlock ();
1613 case G_BUS_TYPE_SYSTEM
:
1614 ret
= g_strdup (g_getenv ("DBUS_SYSTEM_BUS_ADDRESS"));
1617 ret
= g_strdup ("unix:path=/var/run/dbus/system_bus_socket");
1621 case G_BUS_TYPE_SESSION
:
1622 ret
= g_strdup (g_getenv ("DBUS_SESSION_BUS_ADDRESS"));
1625 ret
= get_session_address_platform_specific (&local_error
);
1629 case G_BUS_TYPE_STARTER
:
1630 starter_bus
= g_getenv ("DBUS_STARTER_BUS_TYPE");
1631 if (g_strcmp0 (starter_bus
, "session") == 0)
1633 ret
= g_dbus_address_get_for_bus_sync (G_BUS_TYPE_SESSION
, cancellable
, &local_error
);
1636 else if (g_strcmp0 (starter_bus
, "system") == 0)
1638 ret
= g_dbus_address_get_for_bus_sync (G_BUS_TYPE_SYSTEM
, cancellable
, &local_error
);
1643 if (starter_bus
!= NULL
)
1645 g_set_error (&local_error
,
1648 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
1649 " — unknown value “%s”"),
1654 g_set_error_literal (&local_error
,
1657 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
1658 "variable is not set"));
1664 g_set_error (&local_error
,
1667 _("Unknown bus type %d"),
1673 if (G_UNLIKELY (_g_dbus_debug_address ()))
1675 _g_dbus_debug_print_lock ();
1676 s
= _g_dbus_enum_to_string (G_TYPE_BUS_TYPE
, bus_type
);
1679 g_print ("GDBus-debug:Address: Returning address '%s' for bus type '%s'\n",
1684 g_print ("GDBus-debug:Address: Cannot look-up address bus type '%s': %s\n",
1685 s
, local_error
? local_error
->message
: "");
1688 _g_dbus_debug_print_unlock ();
1691 if (local_error
!= NULL
)
1692 g_propagate_error (error
, local_error
);
1698 * g_dbus_address_escape_value:
1699 * @string: an unescaped string to be included in a D-Bus address
1700 * as the value in a key-value pair
1702 * Escape @string so it can appear in a D-Bus address as the value
1703 * part of a key-value pair.
1705 * For instance, if @string is "/run/bus-for-:0",
1706 * this function would return "/run/bus-for-%3A0",
1707 * which could be used in a D-Bus address like
1708 * "unix:nonce-tcp:host=127.0.0.1,port=42,noncefile=/run/bus-for-%3A0".
1710 * Returns: (transfer full): a copy of @string with all
1711 * non-optionally-escaped bytes escaped
1716 g_dbus_address_escape_value (const gchar
*string
)
1721 g_return_val_if_fail (string
!= NULL
, NULL
);
1723 /* There will often not be anything needing escaping at all. */
1724 s
= g_string_sized_new (strlen (string
));
1726 /* D-Bus address escaping is mostly the same as URI escaping... */
1727 g_string_append_uri_escaped (s
, string
, "\\/", FALSE
);
1729 /* ... but '~' is an unreserved character in URIs, but a
1730 * non-optionally-escaped character in D-Bus addresses. */
1731 for (i
= 0; i
< s
->len
; i
++)
1733 if (G_UNLIKELY (s
->str
[i
] == '~'))
1736 g_string_insert (s
, i
+ 1, "7E");
1741 return g_string_free (s
, FALSE
);