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 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>
33 #include "glib/glib-private.h"
36 /* ---------------------------------------------------------------------------------------------------- */
38 G_GNUC_UNUSED static void completion_debug (const gchar *format, ...);
40 /* Uncomment to get debug traces in /tmp/gdbus-completion-debug.txt (nice
41 * to not have it interfere with stdout/stderr)
44 G_GNUC_UNUSED static void
45 completion_debug (const gchar *format, ...)
49 static FILE *f = NULL;
51 va_start (var_args, format);
52 s = g_strdup_vprintf (format, var_args);
55 f = fopen ("/tmp/gdbus-completion-debug.txt", "a+");
57 fprintf (f, "%s\n", s);
62 completion_debug (const gchar *format, ...)
67 /* ---------------------------------------------------------------------------------------------------- */
71 remove_arg (gint num, gint *argc, gchar **argv[])
75 g_assert (num <= (*argc));
77 for (n = num; (*argv)[n] != NULL; n++)
78 (*argv)[n] = (*argv)[n+1];
80 (*argc) = (*argc) - 1;
84 usage (gint *argc, gchar **argv[], gboolean use_stdout)
90 o = g_option_context_new (_("COMMAND"));
91 g_option_context_set_help_enabled (o, FALSE);
92 /* Ignore parsing result */
93 g_option_context_parse (o, argc, argv, NULL);
94 program_name = g_path_get_basename ((*argv)[0]);
95 s = g_strdup_printf (_("Commands:\n"
96 " help Shows this information\n"
97 " introspect Introspect a remote object\n"
98 " monitor Monitor a remote object\n"
99 " call Invoke a method on a remote object\n"
100 " emit Emit a signal\n"
102 "Use \"%s COMMAND --help\" to get help on each command.\n"),
104 g_free (program_name);
105 g_option_context_set_description (o, s);
107 s = g_option_context_get_help (o, FALSE, NULL);
111 g_printerr ("%s", s);
113 g_option_context_free (o);
117 modify_argv0_for_command (gint *argc, gchar **argv[], const gchar *command)
123 * 1. get a g_set_prgname() ?; or
124 * 2. save old argv[0] and restore later
127 g_assert (g_strcmp0 ((*argv)[1], command) == 0);
128 remove_arg (1, argc, argv);
130 program_name = g_path_get_basename ((*argv)[0]);
131 s = g_strdup_printf ("%s %s", (*argv)[0], command);
133 g_free (program_name);
136 /* ---------------------------------------------------------------------------------------------------- */
139 print_methods (GDBusConnection *c,
145 const gchar *xml_data;
151 result = g_dbus_connection_call_sync (c,
154 "org.freedesktop.DBus.Introspectable",
157 G_VARIANT_TYPE ("(s)"),
158 G_DBUS_CALL_FLAGS_NONE,
164 g_printerr (_("Error: %s\n"), error->message);
165 g_error_free (error);
168 g_variant_get (result, "(&s)", &xml_data);
171 node = g_dbus_node_info_new_for_xml (xml_data, &error);
172 g_variant_unref (result);
175 g_printerr (_("Error parsing introspection XML: %s\n"), error->message);
176 g_error_free (error);
180 for (n = 0; node->interfaces != NULL && node->interfaces[n] != NULL; n++)
182 const GDBusInterfaceInfo *iface = node->interfaces[n];
183 for (m = 0; iface->methods != NULL && iface->methods[m] != NULL; m++)
185 const GDBusMethodInfo *method = iface->methods[m];
186 g_print ("%s.%s \n", iface->name, method->name);
189 g_dbus_node_info_unref (node);
196 print_paths (GDBusConnection *c,
202 const gchar *xml_data;
207 result = g_dbus_connection_call_sync (c,
210 "org.freedesktop.DBus.Introspectable",
213 G_VARIANT_TYPE ("(s)"),
214 G_DBUS_CALL_FLAGS_NONE,
220 g_printerr (_("Error: %s\n"), error->message);
221 g_error_free (error);
224 g_variant_get (result, "(&s)", &xml_data);
226 //g_printerr ("xml='%s'", xml_data);
229 node = g_dbus_node_info_new_for_xml (xml_data, &error);
230 g_variant_unref (result);
233 g_printerr (_("Error parsing introspection XML: %s\n"), error->message);
234 g_error_free (error);
238 //g_printerr ("bar '%s'\n", path);
240 if (node->interfaces != NULL)
241 g_print ("%s \n", path);
243 for (n = 0; node->nodes != NULL && node->nodes[n] != NULL; n++)
247 //g_printerr ("foo '%s'\n", node->nodes[n].path);
249 if (g_strcmp0 (path, "/") == 0)
250 s = g_strdup_printf ("/%s", node->nodes[n]->path);
252 s = g_strdup_printf ("%s/%s", path, node->nodes[n]->path);
254 print_paths (c, name, s);
258 g_dbus_node_info_unref (node);
265 print_names (GDBusConnection *c,
266 gboolean include_unique_names)
272 GHashTable *name_set;
276 name_set = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
279 result = g_dbus_connection_call_sync (c,
280 "org.freedesktop.DBus",
281 "/org/freedesktop/DBus",
282 "org.freedesktop.DBus",
285 G_VARIANT_TYPE ("(as)"),
286 G_DBUS_CALL_FLAGS_NONE,
292 g_printerr (_("Error: %s\n"), error->message);
293 g_error_free (error);
296 g_variant_get (result, "(as)", &iter);
297 while (g_variant_iter_loop (iter, "s", &str))
298 g_hash_table_insert (name_set, g_strdup (str), NULL);
299 g_variant_iter_free (iter);
300 g_variant_unref (result);
303 result = g_dbus_connection_call_sync (c,
304 "org.freedesktop.DBus",
305 "/org/freedesktop/DBus",
306 "org.freedesktop.DBus",
307 "ListActivatableNames",
309 G_VARIANT_TYPE ("(as)"),
310 G_DBUS_CALL_FLAGS_NONE,
316 g_printerr (_("Error: %s\n"), error->message);
317 g_error_free (error);
320 g_variant_get (result, "(as)", &iter);
321 while (g_variant_iter_loop (iter, "s", &str))
322 g_hash_table_insert (name_set, g_strdup (str), NULL);
323 g_variant_iter_free (iter);
324 g_variant_unref (result);
326 keys = g_hash_table_get_keys (name_set);
327 keys = g_list_sort (keys, (GCompareFunc) g_strcmp0);
328 for (l = keys; l != NULL; l = l->next)
330 const gchar *name = l->data;
331 if (!include_unique_names && g_str_has_prefix (name, ":"))
334 g_print ("%s \n", name);
339 g_hash_table_unref (name_set);
342 /* ---------------------------------------------------------------------------------------------------- */
344 static gboolean opt_connection_system = FALSE;
345 static gboolean opt_connection_session = FALSE;
346 static gboolean opt_connection_user = FALSE;
347 static gboolean opt_connection_machine = FALSE;
348 static gchar *opt_connection_address = NULL;
350 static const GOptionEntry connection_entries[] =
352 { "system", 'y', 0, G_OPTION_ARG_NONE, &opt_connection_system, N_("Connect to the system bus"), NULL},
353 { "session", 'e', 0, G_OPTION_ARG_NONE, &opt_connection_session, N_("Connect to the session bus"), NULL},
354 { "user", 'u', 0, G_OPTION_ARG_NONE, &opt_connection_user, N_("Connect to the system bus"), NULL},
355 { "machine", 'm', 0, G_OPTION_ARG_NONE, &opt_connection_machine, N_("Connect to the session bus"), NULL},
356 { "address", 'a', 0, G_OPTION_ARG_STRING, &opt_connection_address, N_("Connect to given D-Bus address"), NULL},
360 static GOptionGroup *
361 connection_get_group (void)
363 static GOptionGroup *g;
365 g = g_option_group_new ("connection",
366 N_("Connection Endpoint Options:"),
367 N_("Options specifying the connection endpoint"),
370 g_option_group_set_translation_domain (g, GETTEXT_PACKAGE);
371 g_option_group_add_entries (g, connection_entries);
376 static GDBusConnection *
377 connection_get_dbus_connection (GError **error)
384 count = !!opt_connection_system +
385 !!opt_connection_session +
386 !!opt_connection_address;
388 /* First, ensure we have exactly one connect */
394 _("No connection endpoint specified"));
402 _("Multiple connection endpoints specified"));
406 if (opt_connection_system)
408 c = g_bus_get_sync (G_BUS_TYPE_SYSTEM, NULL, error);
410 else if (opt_connection_session)
412 c = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, error);
414 else if (opt_connection_address != NULL)
416 c = g_dbus_connection_new_for_address_sync (opt_connection_address,
417 G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT,
418 NULL, /* GDBusAuthObserver */
419 NULL, /* GCancellable */
427 /* ---------------------------------------------------------------------------------------------------- */
430 call_helper_get_method_in_signature (GDBusConnection *c,
433 const gchar *interface_name,
434 const gchar *method_name,
439 GDBusNodeInfo *node_info;
440 const gchar *xml_data;
441 GDBusInterfaceInfo *interface_info;
442 GDBusMethodInfo *method_info;
449 result = g_dbus_connection_call_sync (c,
452 "org.freedesktop.DBus.Introspectable",
455 G_VARIANT_TYPE ("(s)"),
456 G_DBUS_CALL_FLAGS_NONE,
463 g_variant_get (result, "(&s)", &xml_data);
464 node_info = g_dbus_node_info_new_for_xml (xml_data, error);
465 if (node_info == NULL)
468 interface_info = g_dbus_node_info_lookup_interface (node_info, interface_name);
469 if (interface_info == NULL)
471 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
472 _("Warning: According to introspection data, interface '%s' does not exist\n"),
477 method_info = g_dbus_interface_info_lookup_method (interface_info, method_name);
478 if (method_info == NULL)
480 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
481 _("Warning: According to introspection data, method '%s' does not exist on interface '%s'\n"),
487 ret = g_ptr_array_new_with_free_func ((GDestroyNotify) g_variant_type_free);
488 for (n = 0; method_info->in_args != NULL && method_info->in_args[n] != NULL; n++)
490 g_ptr_array_add (ret, g_variant_type_new (method_info->in_args[n]->signature));
494 if (node_info != NULL)
495 g_dbus_node_info_unref (node_info);
497 g_variant_unref (result);
502 /* ---------------------------------------------------------------------------------------------------- */
505 _g_variant_parse_me_harder (GVariantType *type,
506 const gchar *given_str,
514 str = g_string_new ("\"");
515 for (n = 0; given_str[n] != '\0'; n++)
517 if (G_UNLIKELY (given_str[n] == '\"'))
518 g_string_append (str, "\\\"");
520 g_string_append_c (str, given_str[n]);
522 g_string_append_c (str, '"');
523 s = g_string_free (str, FALSE);
525 value = g_variant_parse (type,
535 /* ---------------------------------------------------------------------------------------------------- */
537 static gchar *opt_emit_dest = NULL;
538 static gchar *opt_emit_object_path = NULL;
539 static gchar *opt_emit_signal = NULL;
541 static const GOptionEntry emit_entries[] =
543 { "dest", 'd', 0, G_OPTION_ARG_STRING, &opt_emit_dest, N_("Optional destination for signal (unique name)"), NULL},
544 { "object-path", 'o', 0, G_OPTION_ARG_STRING, &opt_emit_object_path, N_("Object path to emit signal on"), NULL},
545 { "signal", 's', 0, G_OPTION_ARG_STRING, &opt_emit_signal, N_("Signal and interface name"), NULL},
550 handle_emit (gint *argc,
552 gboolean request_completion,
553 const gchar *completion_cur,
554 const gchar *completion_prev)
561 GVariant *parameters;
562 gchar *interface_name;
564 GVariantBuilder builder;
570 interface_name = NULL;
573 modify_argv0_for_command (argc, argv, "emit");
575 o = g_option_context_new (NULL);
576 g_option_context_set_help_enabled (o, FALSE);
577 g_option_context_set_summary (o, _("Emit a signal."));
578 g_option_context_add_main_entries (o, emit_entries, GETTEXT_PACKAGE);
579 g_option_context_add_group (o, connection_get_group ());
581 if (!g_option_context_parse (o, argc, argv, NULL))
583 if (!request_completion)
585 s = g_option_context_get_help (o, FALSE, NULL);
586 g_printerr ("%s", s);
593 c = connection_get_dbus_connection (&error);
596 if (request_completion)
598 if (g_strcmp0 (completion_prev, "--address") == 0)
606 g_print ("--system \n--session \n--address \n");
611 g_printerr (_("Error connecting: %s\n"), error->message);
612 g_error_free (error);
617 /* All done with completion now */
618 if (request_completion)
621 if (opt_emit_object_path == NULL)
623 g_printerr (_("Error: object path not specified.\n"));
626 if (!g_variant_is_object_path (opt_emit_object_path))
628 g_printerr (_("Error: %s is not a valid object path\n"), opt_emit_object_path);
632 if (opt_emit_signal == NULL)
634 g_printerr (_("Error: signal not specified.\n"));
638 s = strrchr (opt_emit_signal, '.');
641 g_printerr (_("Error: signal must be the fully-qualified name.\n"));
644 signal_name = g_strdup (s + 1);
645 interface_name = g_strndup (opt_emit_signal, s - opt_emit_signal);
647 if (!g_dbus_is_interface_name (interface_name))
649 g_printerr (_("Error: %s is not a valid interface name\n"), interface_name);
653 if (!g_dbus_is_member_name (signal_name))
655 g_printerr (_("Error: %s is not a valid member name\n"), signal_name);
659 if (opt_emit_dest != NULL && !g_dbus_is_unique_name (opt_emit_dest))
661 g_printerr (_("Error: %s is not a valid unique bus name.\n"), opt_emit_dest);
665 /* Read parameters */
666 g_variant_builder_init (&builder, G_VARIANT_TYPE_TUPLE);
667 for (n = 1; n < (guint) *argc; n++)
672 value = g_variant_parse (NULL,
681 context = g_variant_parse_error_print_context (error, (*argv)[n]);
682 g_error_free (error);
684 value = _g_variant_parse_me_harder (NULL, (*argv)[n], &error);
687 /* Use the original non-"parse-me-harder" error */
688 g_printerr (_("Error parsing parameter %d: %s\n"),
691 g_error_free (error);
693 g_variant_builder_clear (&builder);
698 g_variant_builder_add_value (&builder, value);
700 parameters = g_variant_builder_end (&builder);
702 if (parameters != NULL)
703 parameters = g_variant_ref_sink (parameters);
704 if (!g_dbus_connection_emit_signal (c,
706 opt_emit_object_path,
712 g_printerr (_("Error: %s\n"), error->message);
713 g_error_free (error);
717 if (!g_dbus_connection_flush_sync (c, NULL, &error))
719 g_printerr (_("Error flushing connection: %s\n"), error->message);
720 g_error_free (error);
729 if (parameters != NULL)
730 g_variant_unref (parameters);
731 g_free (interface_name);
732 g_free (signal_name);
733 g_option_context_free (o);
737 /* ---------------------------------------------------------------------------------------------------- */
739 static gchar *opt_call_dest = NULL;
740 static gchar *opt_call_object_path = NULL;
741 static gchar *opt_call_method = NULL;
742 static gint opt_call_timeout = -1;
744 static const GOptionEntry call_entries[] =
746 { "dest", 'd', 0, G_OPTION_ARG_STRING, &opt_call_dest, N_("Destination name to invoke method on"), NULL},
747 { "object-path", 'o', 0, G_OPTION_ARG_STRING, &opt_call_object_path, N_("Object path to invoke method on"), NULL},
748 { "method", 'm', 0, G_OPTION_ARG_STRING, &opt_call_method, N_("Method and interface name"), NULL},
749 { "timeout", 't', 0, G_OPTION_ARG_INT, &opt_call_timeout, N_("Timeout in seconds"), NULL},
754 handle_call (gint *argc,
756 gboolean request_completion,
757 const gchar *completion_cur,
758 const gchar *completion_prev)
765 GVariant *parameters;
766 gchar *interface_name;
769 GPtrArray *in_signature_types;
770 gboolean complete_names;
771 gboolean complete_paths;
772 gboolean complete_methods;
773 GVariantBuilder builder;
779 interface_name = NULL;
782 in_signature_types = NULL;
784 modify_argv0_for_command (argc, argv, "call");
786 o = g_option_context_new (NULL);
787 g_option_context_set_help_enabled (o, FALSE);
788 g_option_context_set_summary (o, _("Invoke a method on a remote object."));
789 g_option_context_add_main_entries (o, call_entries, GETTEXT_PACKAGE);
790 g_option_context_add_group (o, connection_get_group ());
792 complete_names = FALSE;
793 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--dest") == 0)
795 complete_names = TRUE;
796 remove_arg ((*argc) - 1, argc, argv);
799 complete_paths = FALSE;
800 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--object-path") == 0)
802 complete_paths = TRUE;
803 remove_arg ((*argc) - 1, argc, argv);
806 complete_methods = FALSE;
807 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--method") == 0)
809 complete_methods = TRUE;
810 remove_arg ((*argc) - 1, argc, argv);
813 if (!g_option_context_parse (o, argc, argv, NULL))
815 if (!request_completion)
817 s = g_option_context_get_help (o, FALSE, NULL);
818 g_printerr ("%s", s);
825 c = connection_get_dbus_connection (&error);
828 if (request_completion)
830 if (g_strcmp0 (completion_prev, "--address") == 0)
838 g_print ("--system \n--session \n--address \n");
843 g_printerr (_("Error connecting: %s\n"), error->message);
844 g_error_free (error);
849 /* validate and complete destination (bus name) */
850 if (g_dbus_connection_get_unique_name (c) != NULL)
852 /* this only makes sense on message bus connections */
855 print_names (c, FALSE);
858 if (opt_call_dest == NULL)
860 if (request_completion)
861 g_print ("--dest \n");
863 g_printerr (_("Error: Destination is not specified\n"));
866 if (request_completion && g_strcmp0 ("--dest", completion_prev) == 0)
868 print_names (c, g_str_has_prefix (opt_call_dest, ":"));
873 /* validate and complete object path */
876 print_paths (c, opt_call_dest, "/");
879 if (opt_call_object_path == NULL)
881 if (request_completion)
882 g_print ("--object-path \n");
884 g_printerr (_("Error: Object path is not specified\n"));
887 if (request_completion && g_strcmp0 ("--object-path", completion_prev) == 0)
890 s = g_strdup (opt_call_object_path);
891 p = strrchr (s, '/');
898 print_paths (c, opt_call_dest, s);
902 if (!request_completion && !g_variant_is_object_path (opt_call_object_path))
904 g_printerr (_("Error: %s is not a valid object path\n"), opt_call_object_path);
908 /* validate and complete method (interface + method name) */
909 if (complete_methods)
911 print_methods (c, opt_call_dest, opt_call_object_path);
914 if (opt_call_method == NULL)
916 if (request_completion)
917 g_print ("--method \n");
919 g_printerr (_("Error: Method name is not specified\n"));
922 if (request_completion && g_strcmp0 ("--method", completion_prev) == 0)
924 print_methods (c, opt_call_dest, opt_call_object_path);
927 s = strrchr (opt_call_method, '.');
928 if (!request_completion && s == NULL)
930 g_printerr (_("Error: Method name '%s' is invalid\n"), opt_call_method);
933 method_name = g_strdup (s + 1);
934 interface_name = g_strndup (opt_call_method, s - opt_call_method);
936 /* All done with completion now */
937 if (request_completion)
940 /* Introspect, for easy conversion - it's not fatal if we can't do this */
941 in_signature_types = call_helper_get_method_in_signature (c,
943 opt_call_object_path,
947 if (in_signature_types == NULL)
949 //g_printerr ("Error getting introspection data: %s\n", error->message);
950 g_error_free (error);
954 /* Read parameters */
955 g_variant_builder_init (&builder, G_VARIANT_TYPE_TUPLE);
956 for (n = 1; n < (guint) *argc; n++)
962 if (in_signature_types != NULL)
964 if (n - 1 >= in_signature_types->len)
966 /* Only warn for the first param */
967 if (n - 1 == in_signature_types->len)
969 g_printerr ("Warning: Introspection data indicates %d parameters but more was passed\n",
970 in_signature_types->len);
975 type = in_signature_types->pdata[n - 1];
980 value = g_variant_parse (type,
989 context = g_variant_parse_error_print_context (error, (*argv)[n]);
990 g_error_free (error);
992 value = _g_variant_parse_me_harder (type, (*argv)[n], &error);
997 s = g_variant_type_dup_string (type);
998 g_printerr (_("Error parsing parameter %d of type '%s': %s\n"),
1006 g_printerr (_("Error parsing parameter %d: %s\n"),
1010 g_error_free (error);
1011 g_variant_builder_clear (&builder);
1017 g_variant_builder_add_value (&builder, value);
1019 parameters = g_variant_builder_end (&builder);
1021 if (parameters != NULL)
1022 parameters = g_variant_ref_sink (parameters);
1023 result = g_dbus_connection_call_sync (c,
1025 opt_call_object_path,
1030 G_DBUS_CALL_FLAGS_NONE,
1031 opt_call_timeout > 0 ? opt_call_timeout * 1000 : opt_call_timeout,
1038 g_printerr (_("Error: %s\n"), error->message);
1039 g_error_free (error);
1041 if (in_signature_types != NULL)
1044 s = g_string_new (NULL);
1045 for (n = 0; n < in_signature_types->len; n++)
1047 GVariantType *type = in_signature_types->pdata[n];
1048 g_string_append_len (s,
1049 g_variant_type_peek_string (type),
1050 g_variant_type_get_string_length (type));
1052 g_printerr ("(According to introspection data, you need to pass '%s')\n", s->str);
1053 g_string_free (s, TRUE);
1058 s = g_variant_print (result, TRUE);
1059 g_print ("%s\n", s);
1065 if (in_signature_types != NULL)
1066 g_ptr_array_unref (in_signature_types);
1068 g_variant_unref (result);
1071 if (parameters != NULL)
1072 g_variant_unref (parameters);
1073 g_free (interface_name);
1074 g_free (method_name);
1075 g_option_context_free (o);
1079 /* ---------------------------------------------------------------------------------------------------- */
1081 static gchar *opt_introspect_dest = NULL;
1082 static gchar *opt_introspect_object_path = NULL;
1083 static gboolean opt_introspect_xml = FALSE;
1084 static gboolean opt_introspect_recurse = FALSE;
1085 static gboolean opt_introspect_only_properties = FALSE;
1088 dump_annotation (const GDBusAnnotationInfo *o,
1090 gboolean ignore_indent)
1093 g_print ("%*s@%s(\"%s\")\n",
1094 ignore_indent ? 0 : indent, "",
1097 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1098 dump_annotation (o->annotations[n], indent + 2, FALSE);
1102 dump_arg (const GDBusArgInfo *o,
1104 const gchar *direction,
1105 gboolean ignore_indent,
1106 gboolean include_newline)
1110 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1112 dump_annotation (o->annotations[n], indent, ignore_indent);
1113 ignore_indent = FALSE;
1116 g_print ("%*s%s%s %s%s",
1117 ignore_indent ? 0 : indent, "",
1121 include_newline ? ",\n" : "");
1125 count_args (GDBusArgInfo **args)
1131 while (args[n] != NULL)
1138 dump_method (const GDBusMethodInfo *o,
1144 guint total_num_args;
1146 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1147 dump_annotation (o->annotations[n], indent, FALSE);
1149 g_print ("%*s%s(", indent, "", o->name);
1150 name_len = strlen (o->name);
1151 total_num_args = count_args (o->in_args) + count_args (o->out_args);
1152 for (n = 0, m = 0; o->in_args != NULL && o->in_args[n] != NULL; n++, m++)
1154 gboolean ignore_indent = (m == 0);
1155 gboolean include_newline = (m != total_num_args - 1);
1157 dump_arg (o->in_args[n],
1158 indent + name_len + 1,
1163 for (n = 0; o->out_args != NULL && o->out_args[n] != NULL; n++, m++)
1165 gboolean ignore_indent = (m == 0);
1166 gboolean include_newline = (m != total_num_args - 1);
1167 dump_arg (o->out_args[n],
1168 indent + name_len + 1,
1177 dump_signal (const GDBusSignalInfo *o,
1182 guint total_num_args;
1184 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1185 dump_annotation (o->annotations[n], indent, FALSE);
1187 g_print ("%*s%s(", indent, "", o->name);
1188 name_len = strlen (o->name);
1189 total_num_args = count_args (o->args);
1190 for (n = 0; o->args != NULL && o->args[n] != NULL; n++)
1192 gboolean ignore_indent = (n == 0);
1193 gboolean include_newline = (n != total_num_args - 1);
1194 dump_arg (o->args[n],
1195 indent + name_len + 1,
1204 dump_property (const GDBusPropertyInfo *o,
1208 const gchar *access;
1211 if (o->flags == G_DBUS_PROPERTY_INFO_FLAGS_READABLE)
1212 access = "readonly";
1213 else if (o->flags == G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE)
1214 access = "writeonly";
1215 else if (o->flags == (G_DBUS_PROPERTY_INFO_FLAGS_READABLE | G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
1216 access = "readwrite";
1218 g_assert_not_reached ();
1220 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1221 dump_annotation (o->annotations[n], indent, FALSE);
1225 gchar *s = g_variant_print (value, FALSE);
1226 g_print ("%*s%s %s %s = %s;\n", indent, "", access, o->signature, o->name, s);
1231 g_print ("%*s%s %s %s;\n", indent, "", access, o->signature, o->name);
1236 dump_interface (GDBusConnection *c,
1238 const GDBusInterfaceInfo *o,
1240 const gchar *object_path)
1243 GHashTable *properties;
1245 properties = g_hash_table_new_full (g_str_hash,
1248 (GDestroyNotify) g_variant_unref);
1250 /* Try to get properties */
1251 if (c != NULL && name != NULL && object_path != NULL && o->properties != NULL)
1254 result = g_dbus_connection_call_sync (c,
1257 "org.freedesktop.DBus.Properties",
1259 g_variant_new ("(s)", o->name),
1261 G_DBUS_CALL_FLAGS_NONE,
1267 if (g_variant_is_of_type (result, G_VARIANT_TYPE ("(a{sv})")))
1271 g_variant_get (result,
1274 while ((item = g_variant_iter_next_value (iter)))
1278 g_variant_get (item,
1283 g_hash_table_insert (properties, key, g_variant_ref (value));
1286 g_variant_unref (result);
1291 for (n = 0; o->properties != NULL && o->properties[n] != NULL; n++)
1293 result = g_dbus_connection_call_sync (c,
1296 "org.freedesktop.DBus.Properties",
1298 g_variant_new ("(ss)", o->name, o->properties[n]->name),
1299 G_VARIANT_TYPE ("(v)"),
1300 G_DBUS_CALL_FLAGS_NONE,
1306 GVariant *property_value;
1307 g_variant_get (result,
1310 g_hash_table_insert (properties,
1311 g_strdup (o->properties[n]->name),
1312 g_variant_ref (property_value));
1313 g_variant_unref (result);
1319 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1320 dump_annotation (o->annotations[n], indent, FALSE);
1322 g_print ("%*sinterface %s {\n", indent, "", o->name);
1323 if (o->methods != NULL && !opt_introspect_only_properties)
1325 g_print ("%*s methods:\n", indent, "");
1326 for (n = 0; o->methods[n] != NULL; n++)
1327 dump_method (o->methods[n], indent + 4);
1329 if (o->signals != NULL && !opt_introspect_only_properties)
1331 g_print ("%*s signals:\n", indent, "");
1332 for (n = 0; o->signals[n] != NULL; n++)
1333 dump_signal (o->signals[n], indent + 4);
1335 if (o->properties != NULL)
1337 g_print ("%*s properties:\n", indent, "");
1338 for (n = 0; o->properties[n] != NULL; n++)
1340 dump_property (o->properties[n],
1342 g_hash_table_lookup (properties, (o->properties[n])->name));
1348 g_hash_table_unref (properties);
1352 introspect_do (GDBusConnection *c,
1353 const gchar *object_path,
1357 dump_node (GDBusConnection *c,
1359 const GDBusNodeInfo *o,
1361 const gchar *object_path,
1365 const gchar *object_path_to_print;
1367 object_path_to_print = object_path;
1368 if (o->path != NULL)
1369 object_path_to_print = o->path;
1371 for (n = 0; o->annotations != NULL && o->annotations[n] != NULL; n++)
1372 dump_annotation (o->annotations[n], indent, FALSE);
1374 g_print ("%*snode %s", indent, "", object_path_to_print != NULL ? object_path_to_print : "(not set)");
1375 if (o->interfaces != NULL || o->nodes != NULL)
1378 for (n = 0; o->interfaces != NULL && o->interfaces[n] != NULL; n++)
1380 if (opt_introspect_only_properties)
1382 if (o->interfaces[n]->properties != NULL && o->interfaces[n]->properties[0] != NULL)
1383 dump_interface (c, name, o->interfaces[n], indent + 2, object_path);
1387 dump_interface (c, name, o->interfaces[n], indent + 2, object_path);
1390 for (n = 0; o->nodes != NULL && o->nodes[n] != NULL; n++)
1395 if (g_variant_is_object_path (o->nodes[n]->path))
1397 child_path = g_strdup (o->nodes[n]->path);
1398 /* avoid infinite loops */
1399 if (g_str_has_prefix (child_path, object_path))
1401 introspect_do (c, child_path, indent + 2);
1405 g_print ("Skipping path %s that is not enclosed by parent %s\n",
1406 child_path, object_path);
1411 if (g_strcmp0 (object_path, "/") == 0)
1412 child_path = g_strdup_printf ("/%s", o->nodes[n]->path);
1414 child_path = g_strdup_printf ("%s/%s", object_path, o->nodes[n]->path);
1415 introspect_do (c, child_path, indent + 2);
1417 g_free (child_path);
1421 dump_node (NULL, NULL, o->nodes[n], indent + 2, NULL, recurse);
1433 static const GOptionEntry introspect_entries[] =
1435 { "dest", 'd', 0, G_OPTION_ARG_STRING, &opt_introspect_dest, N_("Destination name to introspect"), NULL},
1436 { "object-path", 'o', 0, G_OPTION_ARG_STRING, &opt_introspect_object_path, N_("Object path to introspect"), NULL},
1437 { "xml", 'x', 0, G_OPTION_ARG_NONE, &opt_introspect_xml, N_("Print XML"), NULL},
1438 { "recurse", 'r', 0, G_OPTION_ARG_NONE, &opt_introspect_recurse, N_("Introspect children"), NULL},
1439 { "only-properties", 'p', 0, G_OPTION_ARG_NONE, &opt_introspect_only_properties, N_("Only print properties"), NULL},
1444 introspect_do (GDBusConnection *c,
1445 const gchar *object_path,
1450 GDBusNodeInfo *node;
1452 const gchar *xml_data;
1459 result = g_dbus_connection_call_sync (c,
1460 opt_introspect_dest,
1462 "org.freedesktop.DBus.Introspectable",
1465 G_VARIANT_TYPE ("(s)"),
1466 G_DBUS_CALL_FLAGS_NONE,
1472 g_printerr (_("Error: %s\n"), error->message);
1473 g_error_free (error);
1476 g_variant_get (result, "(&s)", &xml_data);
1478 if (opt_introspect_xml)
1480 g_print ("%s", xml_data);
1485 node = g_dbus_node_info_new_for_xml (xml_data, &error);
1488 g_printerr (_("Error parsing introspection XML: %s\n"), error->message);
1489 g_error_free (error);
1493 dump_node (c, opt_introspect_dest, node, indent, object_path, opt_introspect_recurse);
1500 g_dbus_node_info_unref (node);
1502 g_variant_unref (result);
1507 handle_introspect (gint *argc,
1509 gboolean request_completion,
1510 const gchar *completion_cur,
1511 const gchar *completion_prev)
1518 gboolean complete_names;
1519 gboolean complete_paths;
1524 modify_argv0_for_command (argc, argv, "introspect");
1526 o = g_option_context_new (NULL);
1527 if (request_completion)
1528 g_option_context_set_ignore_unknown_options (o, TRUE);
1529 g_option_context_set_help_enabled (o, FALSE);
1530 g_option_context_set_summary (o, _("Introspect a remote object."));
1531 g_option_context_add_main_entries (o, introspect_entries, GETTEXT_PACKAGE);
1532 g_option_context_add_group (o, connection_get_group ());
1534 complete_names = FALSE;
1535 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--dest") == 0)
1537 complete_names = TRUE;
1538 remove_arg ((*argc) - 1, argc, argv);
1541 complete_paths = FALSE;
1542 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--object-path") == 0)
1544 complete_paths = TRUE;
1545 remove_arg ((*argc) - 1, argc, argv);
1548 if (!g_option_context_parse (o, argc, argv, NULL))
1550 if (!request_completion)
1552 s = g_option_context_get_help (o, FALSE, NULL);
1553 g_printerr ("%s", s);
1560 c = connection_get_dbus_connection (&error);
1563 if (request_completion)
1565 if (g_strcmp0 (completion_prev, "--address") == 0)
1573 g_print ("--system \n--session \n--address \n");
1578 g_printerr (_("Error connecting: %s\n"), error->message);
1579 g_error_free (error);
1584 if (g_dbus_connection_get_unique_name (c) != NULL)
1588 print_names (c, FALSE);
1591 /* this only makes sense on message bus connections */
1592 if (opt_introspect_dest == NULL)
1594 if (request_completion)
1595 g_print ("--dest \n");
1597 g_printerr (_("Error: Destination is not specified\n"));
1600 if (request_completion && g_strcmp0 ("--dest", completion_prev) == 0)
1602 print_names (c, g_str_has_prefix (opt_introspect_dest, ":"));
1608 print_paths (c, opt_introspect_dest, "/");
1611 if (opt_introspect_object_path == NULL)
1613 if (request_completion)
1614 g_print ("--object-path \n");
1616 g_printerr (_("Error: Object path is not specified\n"));
1619 if (request_completion && g_strcmp0 ("--object-path", completion_prev) == 0)
1622 s = g_strdup (opt_introspect_object_path);
1623 p = strrchr (s, '/');
1630 print_paths (c, opt_introspect_dest, s);
1634 if (!request_completion && !g_variant_is_object_path (opt_introspect_object_path))
1636 g_printerr (_("Error: %s is not a valid object path\n"), opt_introspect_object_path);
1640 if (request_completion && opt_introspect_object_path != NULL && !opt_introspect_recurse)
1642 g_print ("--recurse \n");
1645 if (request_completion && opt_introspect_object_path != NULL && !opt_introspect_only_properties)
1647 g_print ("--only-properties \n");
1650 /* All done with completion now */
1651 if (request_completion)
1654 if (!introspect_do (c, opt_introspect_object_path, 0))
1662 g_option_context_free (o);
1666 /* ---------------------------------------------------------------------------------------------------- */
1668 static gchar *opt_monitor_dest = NULL;
1669 static gchar *opt_monitor_object_path = NULL;
1671 static guint monitor_filter_id = 0;
1674 monitor_signal_cb (GDBusConnection *connection,
1675 const gchar *sender_name,
1676 const gchar *object_path,
1677 const gchar *interface_name,
1678 const gchar *signal_name,
1679 GVariant *parameters,
1683 s = g_variant_print (parameters, TRUE);
1684 g_print ("%s: %s.%s %s\n",
1693 monitor_on_name_appeared (GDBusConnection *connection,
1695 const gchar *name_owner,
1698 g_print ("The name %s is owned by %s\n", name, name_owner);
1699 g_assert (monitor_filter_id == 0);
1700 monitor_filter_id = g_dbus_connection_signal_subscribe (connection,
1702 NULL, /* any interface */
1703 NULL, /* any member */
1704 opt_monitor_object_path,
1706 G_DBUS_SIGNAL_FLAGS_NONE,
1708 NULL, /* user_data */
1709 NULL); /* user_data destroy notify */
1713 monitor_on_name_vanished (GDBusConnection *connection,
1717 g_print ("The name %s does not have an owner\n", name);
1719 if (monitor_filter_id != 0)
1721 g_dbus_connection_signal_unsubscribe (connection, monitor_filter_id);
1722 monitor_filter_id = 0;
1726 static const GOptionEntry monitor_entries[] =
1728 { "dest", 'd', 0, G_OPTION_ARG_STRING, &opt_monitor_dest, N_("Destination name to monitor"), NULL},
1729 { "object-path", 'o', 0, G_OPTION_ARG_STRING, &opt_monitor_object_path, N_("Object path to monitor"), NULL},
1734 handle_monitor (gint *argc,
1736 gboolean request_completion,
1737 const gchar *completion_cur,
1738 const gchar *completion_prev)
1745 gboolean complete_names;
1746 gboolean complete_paths;
1752 modify_argv0_for_command (argc, argv, "monitor");
1754 o = g_option_context_new (NULL);
1755 if (request_completion)
1756 g_option_context_set_ignore_unknown_options (o, TRUE);
1757 g_option_context_set_help_enabled (o, FALSE);
1758 g_option_context_set_summary (o, _("Monitor a remote object."));
1759 g_option_context_add_main_entries (o, monitor_entries, GETTEXT_PACKAGE);
1760 g_option_context_add_group (o, connection_get_group ());
1762 complete_names = FALSE;
1763 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--dest") == 0)
1765 complete_names = TRUE;
1766 remove_arg ((*argc) - 1, argc, argv);
1769 complete_paths = FALSE;
1770 if (request_completion && *argc > 1 && g_strcmp0 ((*argv)[(*argc)-1], "--object-path") == 0)
1772 complete_paths = TRUE;
1773 remove_arg ((*argc) - 1, argc, argv);
1776 if (!g_option_context_parse (o, argc, argv, NULL))
1778 if (!request_completion)
1780 s = g_option_context_get_help (o, FALSE, NULL);
1781 g_printerr ("%s", s);
1788 c = connection_get_dbus_connection (&error);
1791 if (request_completion)
1793 if (g_strcmp0 (completion_prev, "--address") == 0)
1801 g_print ("--system \n--session \n--address \n");
1806 g_printerr (_("Error connecting: %s\n"), error->message);
1807 g_error_free (error);
1812 if (g_dbus_connection_get_unique_name (c) != NULL)
1816 print_names (c, FALSE);
1819 /* this only makes sense on message bus connections */
1820 if (opt_monitor_dest == NULL)
1822 if (request_completion)
1823 g_print ("--dest \n");
1825 g_printerr (_("Error: Destination is not specified\n"));
1828 if (request_completion && g_strcmp0 ("--dest", completion_prev) == 0)
1830 print_names (c, g_str_has_prefix (opt_monitor_dest, ":"));
1836 print_paths (c, opt_monitor_dest, "/");
1839 if (opt_monitor_object_path == NULL)
1841 if (request_completion)
1843 g_print ("--object-path \n");
1846 /* it's fine to not have an object path */
1848 if (request_completion && g_strcmp0 ("--object-path", completion_prev) == 0)
1851 s = g_strdup (opt_monitor_object_path);
1852 p = strrchr (s, '/');
1859 print_paths (c, opt_monitor_dest, s);
1863 if (!request_completion && (opt_monitor_object_path != NULL && !g_variant_is_object_path (opt_monitor_object_path)))
1865 g_printerr (_("Error: %s is not a valid object path\n"), opt_monitor_object_path);
1869 /* All done with completion now */
1870 if (request_completion)
1873 if (opt_monitor_object_path != NULL)
1874 g_print ("Monitoring signals on object %s owned by %s\n", opt_monitor_object_path, opt_monitor_dest);
1876 g_print ("Monitoring signals from all objects owned by %s\n", opt_monitor_dest);
1878 loop = g_main_loop_new (NULL, FALSE);
1879 g_bus_watch_name_on_connection (c,
1881 G_BUS_NAME_WATCHER_FLAGS_AUTO_START,
1882 monitor_on_name_appeared,
1883 monitor_on_name_vanished,
1887 g_main_loop_run (loop);
1888 g_main_loop_unref (loop);
1895 g_option_context_free (o);
1899 /* ---------------------------------------------------------------------------------------------------- */
1902 pick_word_at (const gchar *s,
1904 gint *out_word_begins_at)
1911 if (out_word_begins_at != NULL)
1912 *out_word_begins_at = -1;
1916 if (g_ascii_isspace (s[cursor]) && ((cursor > 0 && g_ascii_isspace(s[cursor-1])) || cursor == 0))
1918 if (out_word_begins_at != NULL)
1919 *out_word_begins_at = cursor;
1920 return g_strdup ("");
1923 while (!g_ascii_isspace (s[cursor - 1]) && cursor > 0)
1928 while (!g_ascii_isspace (s[end]) && s[end] != '\0')
1931 if (out_word_begins_at != NULL)
1932 *out_word_begins_at = begin;
1934 return g_strndup (s + begin, end - begin);
1938 main (gint argc, gchar *argv[])
1941 const gchar *command;
1942 gboolean request_completion;
1943 gchar *completion_cur;
1944 gchar *completion_prev;
1949 setlocale (LC_ALL, "");
1950 textdomain (GETTEXT_PACKAGE);
1953 tmp = _glib_get_locale_dir ();
1954 bindtextdomain (GETTEXT_PACKAGE, tmp);
1957 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
1960 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
1961 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1965 completion_cur = NULL;
1966 completion_prev = NULL;
1970 usage (&argc, &argv, FALSE);
1974 request_completion = FALSE;
1976 //completion_debug ("---- argc=%d --------------------------------------------------------", argc);
1980 if (g_strcmp0 (command, "help") == 0)
1982 if (request_completion)
1988 usage (&argc, &argv, TRUE);
1993 else if (g_strcmp0 (command, "emit") == 0)
1995 if (handle_emit (&argc,
2003 else if (g_strcmp0 (command, "call") == 0)
2005 if (handle_call (&argc,
2013 else if (g_strcmp0 (command, "introspect") == 0)
2015 if (handle_introspect (&argc,
2023 else if (g_strcmp0 (command, "monitor") == 0)
2025 if (handle_monitor (&argc,
2033 else if (g_strcmp0 (command, "complete") == 0 && argc == 4 && !request_completion)
2035 const gchar *completion_line;
2036 gchar **completion_argv;
2037 gint completion_argc;
2038 gint completion_point;
2042 request_completion = TRUE;
2044 completion_line = argv[2];
2045 completion_point = strtol (argv[3], &endp, 10);
2046 if (endp == argv[3] || *endp != '\0')
2050 completion_debug ("completion_point=%d", completion_point);
2051 completion_debug ("----");
2052 completion_debug (" 0123456789012345678901234567890123456789012345678901234567890123456789");
2053 completion_debug ("'%s'", completion_line);
2054 completion_debug (" %*s^",
2055 completion_point, "");
2056 completion_debug ("----");
2059 if (!g_shell_parse_argv (completion_line,
2064 /* it's very possible the command line can't be parsed (for
2065 * example, missing quotes etc) - in that case, we just
2066 * don't autocomplete at all
2071 /* compute cur and prev */
2072 completion_prev = NULL;
2073 completion_cur = pick_word_at (completion_line, completion_point, &cur_begin);
2077 for (prev_end = cur_begin - 1; prev_end >= 0; prev_end--)
2079 if (!g_ascii_isspace (completion_line[prev_end]))
2081 completion_prev = pick_word_at (completion_line, prev_end, NULL);
2087 completion_debug (" cur='%s'", completion_cur);
2088 completion_debug ("prev='%s'", completion_prev);
2091 argc = completion_argc;
2092 argv = completion_argv;
2100 if (request_completion)
2102 g_print ("help \nemit \ncall \nintrospect \nmonitor \n");
2108 g_printerr ("Unknown command '%s'\n", command);
2109 usage (&argc, &argv, FALSE);
2115 g_free (completion_cur);
2116 g_free (completion_prev);