2 * Copyright © 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
22 #include "gapplicationimpl.h"
24 #include "gactiongroup.h"
25 #include "gactiongroupexporter.h"
26 #include "gremoteactiongroup.h"
27 #include "gdbusactiongroup.h"
28 #include "gapplication.h"
30 #include "gdbusconnection.h"
31 #include "gdbusintrospection.h"
32 #include "gdbuserror.h"
33 #include "gmenuexporter.h"
38 #include "gapplicationcommandline.h"
39 #include "gdbusmethodinvocation.h"
41 G_GNUC_INTERNAL gboolean
42 g_dbus_action_group_sync (GDBusActionGroup *group,
43 GCancellable *cancellable,
47 /* DBus Interface definition {{{1 */
48 static const gchar org_gtk_Application_xml[] =
50 " <interface name='org.gtk.Application'>"
51 " <method name='Activate'>"
52 " <arg type='a{sv}' name='platform-data' direction='in'/>"
54 " <method name='Open'>"
55 " <arg type='as' name='uris' direction='in'/>"
56 " <arg type='s' name='hint' direction='in'/>"
57 " <arg type='a{sv}' name='platform-data' direction='in'/>"
59 " <method name='CommandLine'>"
60 " <arg type='o' name='path' direction='in'/>"
61 " <arg type='aay' name='arguments' direction='in'/>"
62 " <arg type='a{sv}' name='platform-data' direction='in'/>"
63 " <arg type='i' name='exit-status' direction='out'/>"
65 " <property name='AppMenu' type='ao' access='read'/>"
66 " <property name='MenuBar' type='ao' access='read'/>"
70 static GDBusInterfaceInfo *org_gtk_Application;
72 static const gchar org_gtk_private_CommandLine_xml[] =
74 " <interface name='org.gtk.private.CommandLine'>"
75 " <method name='Print'>"
76 " <arg type='s' name='message' direction='in'/>"
78 " <method name='PrintError'>"
79 " <arg type='s' name='message' direction='in'/>"
84 static GDBusInterfaceInfo *org_gtk_private_CommandLine;
86 /* GApplication implementation {{{1 */
87 struct _GApplicationImpl
89 GDBusConnection *session_bus;
90 const gchar *bus_name;
102 gboolean properties_live;
108 static GApplicationCommandLine *
109 g_dbus_command_line_new (GDBusMethodInvocation *invocation);
113 g_application_impl_method_call (GDBusConnection *connection,
115 const gchar *object_path,
116 const gchar *interface_name,
117 const gchar *method_name,
118 GVariant *parameters,
119 GDBusMethodInvocation *invocation,
122 GApplicationImpl *impl = user_data;
123 GApplicationClass *class;
125 class = G_APPLICATION_GET_CLASS (impl->app);
127 if (strcmp (method_name, "Activate") == 0)
129 GVariant *platform_data;
131 g_variant_get (parameters, "(@a{sv})", &platform_data);
132 class->before_emit (impl->app, platform_data);
133 g_signal_emit_by_name (impl->app, "activate");
134 class->after_emit (impl->app, platform_data);
135 g_variant_unref (platform_data);
137 g_dbus_method_invocation_return_value (invocation, NULL);
140 else if (strcmp (method_name, "Open") == 0)
142 GVariant *platform_data;
148 g_variant_get (parameters, "(@ass@a{sv})",
149 &array, &hint, &platform_data);
151 n = g_variant_n_children (array);
152 files = g_new (GFile *, n + 1);
154 for (i = 0; i < n; i++)
158 g_variant_get_child (array, i, "&s", &uri);
159 files[i] = g_file_new_for_uri (uri);
161 g_variant_unref (array);
164 class->before_emit (impl->app, platform_data);
165 g_signal_emit_by_name (impl->app, "open", files, n, hint);
166 class->after_emit (impl->app, platform_data);
168 g_variant_unref (platform_data);
170 for (i = 0; i < n; i++)
171 g_object_unref (files[i]);
174 g_dbus_method_invocation_return_value (invocation, NULL);
177 else if (strcmp (method_name, "CommandLine") == 0)
179 GApplicationCommandLine *cmdline;
180 GVariant *platform_data;
183 cmdline = g_dbus_command_line_new (invocation);
184 platform_data = g_variant_get_child_value (parameters, 2);
185 class->before_emit (impl->app, platform_data);
186 g_signal_emit_by_name (impl->app, "command-line", cmdline, &status);
187 g_application_command_line_set_exit_status (cmdline, status);
188 class->after_emit (impl->app, platform_data);
189 g_variant_unref (platform_data);
190 g_object_unref (cmdline);
193 g_assert_not_reached ();
197 g_application_impl_get_property (GDBusConnection *connection,
199 const gchar *object_path,
200 const gchar *interface_name,
201 const gchar *property_name,
205 GApplicationImpl *impl = user_data;
206 GVariantBuilder builder;
208 /* We use this boolean to detect if the properties have ever been
209 * queried before. If they have not been queried, then there is no
210 * point emitting change signals since nobody is watching anyway.
212 impl->properties_live = TRUE;
214 g_variant_builder_init (&builder, G_VARIANT_TYPE_OBJECT_PATH_ARRAY);
216 if (g_str_equal (property_name, "AppMenu"))
218 if (impl->app_menu_path != NULL)
219 g_variant_builder_add (&builder, "o", impl->app_menu_path);
222 else if (g_str_equal (property_name, "MenuBar"))
224 if (impl->menubar_path != NULL)
225 g_variant_builder_add (&builder, "o", impl->menubar_path);
229 g_assert_not_reached ();
231 return g_variant_builder_end (&builder);
235 application_path_from_appid (const gchar *appid)
237 gchar *appid_path, *iter;
239 appid_path = g_strconcat ("/", appid, NULL);
240 for (iter = appid_path; *iter; iter++)
253 g_application_impl_publish_menu (GApplicationImpl *impl,
261 /* unexport any existing menu */
264 g_dbus_connection_unexport_menu_model (impl->session_bus, *id);
270 /* export the new menu, if there is one */
273 /* try getting the preferred name */
274 *path = g_strconcat (impl->object_path, "/menus/", type, NULL);
275 *id = g_dbus_connection_export_menu_model (impl->session_bus, *path, model, NULL);
277 /* keep trying until we get a working name... */
278 for (i = 0; *id == 0; i++)
281 *path = g_strdup_printf ("%s/menus/%s%d", impl->object_path, type, i);
282 *id = g_dbus_connection_export_menu_model (impl->session_bus, *path, model, NULL);
286 /* notify for changes, if needed */
287 if (impl->properties_live)
289 GVariantBuilder builder;
291 g_variant_builder_init (&builder, G_VARIANT_TYPE_VARDICT);
292 g_variant_builder_add (&builder, "{sv}", type, g_variant_new_objv ((const gchar **) path, *path != NULL));
293 g_dbus_connection_emit_signal (impl->session_bus, NULL, impl->object_path,
294 "org.freedesktop.DBus.Properties", "PropertiesChanged",
295 g_variant_new ("(sa{sv}as)", "org.gtk.Actions", &builder, NULL), NULL);
300 g_application_impl_app_menu_changed (GObject *source,
304 GApplicationImpl *impl = user_data;
306 g_assert (source == impl->app);
308 g_application_impl_publish_menu (impl, "AppMenu", g_application_get_app_menu (impl->app),
309 &impl->app_menu_id, &impl->app_menu_path);
313 g_application_impl_menubar_changed (GObject *source,
317 GApplicationImpl *impl = user_data;
319 g_assert (source == impl->app);
321 g_application_impl_publish_menu (impl, "MenuBar", g_application_get_menubar (impl->app),
322 &impl->menubar_id, &impl->menubar_path);
325 /* Attempt to become the primary instance.
327 * Returns %TRUE if everything went OK, regardless of if we became the
328 * primary instance or not. %FALSE is reserved for when something went
329 * seriously wrong (and @error will be set too, in that case).
331 * After a %TRUE return, impl->primary will be TRUE if we were
335 g_application_impl_attempt_primary (GApplicationImpl *impl,
336 GCancellable *cancellable,
339 const static GDBusInterfaceVTable vtable = {
340 g_application_impl_method_call,
341 g_application_impl_get_property
346 if (org_gtk_Application == NULL)
348 GError *error = NULL;
351 info = g_dbus_node_info_new_for_xml (org_gtk_Application_xml, &error);
352 if G_UNLIKELY (info == NULL)
353 g_error ("%s", error->message);
354 org_gtk_Application = g_dbus_node_info_lookup_interface (info, "org.gtk.Application");
355 g_assert (org_gtk_Application != NULL);
356 g_dbus_interface_info_ref (org_gtk_Application);
357 g_dbus_node_info_unref (info);
360 /* We could possibly have been D-Bus activated as a result of incoming
361 * requests on either the application or actiongroup interfaces.
362 * Because of how GDBus dispatches messages, we need to ensure that
363 * both of those things are registered before we attempt to request
366 * The action group need not be populated yet, as long as it happens
367 * before we return to the mainloop. The reason for that is because
368 * GDBus does the check to make sure the object exists from the worker
369 * thread but doesn't actually dispatch the action invocation until we
370 * hit the mainloop in this thread. There is also no danger of
371 * receiving 'activate' or 'open' signals until after 'startup' runs,
372 * for the same reason.
374 impl->object_id = g_dbus_connection_register_object (impl->session_bus, impl->object_path,
375 org_gtk_Application, &vtable, impl, NULL, error);
377 if (impl->object_id == 0)
380 impl->actions_id = g_dbus_connection_export_action_group (impl->session_bus, impl->object_path, impl->app, error);
382 if (impl->actions_id == 0)
385 /* DBUS_NAME_FLAG_DO_NOT_QUEUE: 0x4 */
386 reply = g_dbus_connection_call_sync (impl->session_bus, "org.freedesktop.DBus", "/org/freedesktop/DBus",
387 "org.freedesktop.DBus", "RequestName",
388 g_variant_new ("(su)", impl->bus_name, 0x4), G_VARIANT_TYPE ("(u)"),
389 0, -1, cancellable, error);
394 g_variant_get (reply, "(u)", &rval);
395 g_variant_unref (reply);
397 /* DBUS_REQUEST_NAME_REPLY_EXISTS: 3 */
398 impl->primary = (rval != 3);
402 g_signal_connect (impl->app, "notify::app-menu", G_CALLBACK (g_application_impl_app_menu_changed), impl);
403 g_signal_connect (impl->app, "notify::menubar", G_CALLBACK (g_application_impl_menubar_changed), impl);
404 g_application_impl_app_menu_changed (impl->app, NULL, impl);
405 g_application_impl_menubar_changed (impl->app, NULL, impl);
411 /* Stop doing the things that the primary instance does.
413 * This should be called if attempting to become the primary instance
414 * failed (in order to clean up any partial success) and should also
415 * be called when freeing the GApplication.
417 * It is safe to call this multiple times.
420 g_application_impl_stop_primary (GApplicationImpl *impl)
424 g_dbus_connection_unregister_object (impl->session_bus, impl->object_id);
428 if (impl->actions_id)
430 g_dbus_connection_unexport_action_group (impl->session_bus, impl->actions_id);
431 impl->actions_id = 0;
436 g_signal_handlers_disconnect_by_func (impl->app, g_application_impl_app_menu_changed, impl);
437 g_signal_handlers_disconnect_by_func (impl->app, g_application_impl_menubar_changed, impl);
439 g_dbus_connection_call (impl->session_bus, "org.freedesktop.DBus",
440 "/org/freedesktop/DBus", "org.freedesktop.DBus",
441 "ReleaseName", g_variant_new ("(s)", impl->bus_name),
442 NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
443 impl->primary = FALSE;
446 if (impl->app_menu_id)
448 g_dbus_connection_unexport_menu_model (impl->session_bus, impl->app_menu_id);
449 g_free (impl->app_menu_path);
450 impl->app_menu_path = NULL;
451 impl->app_menu_id = 0;
454 if (impl->menubar_id)
456 g_dbus_connection_unexport_menu_model (impl->session_bus, impl->menubar_id);
457 g_free (impl->menubar_path);
458 impl->menubar_path = NULL;
459 impl->menubar_id = 0;
464 g_application_impl_destroy (GApplicationImpl *impl)
466 g_application_impl_stop_primary (impl);
468 if (impl->session_bus)
469 g_object_unref (impl->session_bus);
471 g_free (impl->object_path);
473 g_slice_free (GApplicationImpl, impl);
477 g_application_impl_register (GApplication *application,
479 GApplicationFlags flags,
480 GRemoteActionGroup **remote_actions,
481 GCancellable *cancellable,
484 GDBusActionGroup *actions;
485 GApplicationImpl *impl;
487 impl = g_slice_new0 (GApplicationImpl);
489 impl->app = application;
490 impl->bus_name = appid;
492 impl->session_bus = g_bus_get_sync (G_BUS_TYPE_SESSION, cancellable, NULL);
494 if (impl->session_bus == NULL)
496 /* If we can't connect to the session bus, proceed as a normal
497 * non-unique application.
499 *remote_actions = NULL;
503 impl->object_path = application_path_from_appid (appid);
505 /* Only try to be the primary instance if
506 * G_APPLICATION_IS_LAUNCHER was not specified.
508 if (~flags & G_APPLICATION_IS_LAUNCHER)
510 if (!g_application_impl_attempt_primary (impl, cancellable, error))
512 g_application_impl_destroy (impl);
519 /* We didn't make it. Drop our service-side stuff. */
520 g_application_impl_stop_primary (impl);
522 if (flags & G_APPLICATION_IS_SERVICE)
524 g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_FAILED,
525 "Unable to acquire bus name `%s'", appid);
526 g_application_impl_destroy (impl);
532 /* We are non-primary. Try to get the primary's list of actions.
533 * This also serves as a mechanism to ensure that the primary exists
534 * (ie: DBus service files installed correctly, etc).
536 actions = g_dbus_action_group_get (impl->session_bus, impl->bus_name, impl->object_path);
537 if (!g_dbus_action_group_sync (actions, cancellable, error))
539 /* The primary appears not to exist. Fail the registration. */
540 g_application_impl_destroy (impl);
541 g_object_unref (actions);
546 *remote_actions = G_REMOTE_ACTION_GROUP (actions);
552 g_application_impl_activate (GApplicationImpl *impl,
553 GVariant *platform_data)
555 g_dbus_connection_call (impl->session_bus,
558 "org.gtk.Application",
560 g_variant_new ("(@a{sv})", platform_data),
561 NULL, 0, -1, NULL, NULL, NULL);
565 g_application_impl_open (GApplicationImpl *impl,
569 GVariant *platform_data)
571 GVariantBuilder builder;
574 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(assa{sv})"));
575 g_variant_builder_open (&builder, G_VARIANT_TYPE_STRING_ARRAY);
576 for (i = 0; i < n_files; i++)
578 gchar *uri = g_file_get_uri (files[i]);
579 g_variant_builder_add (&builder, "s", uri);
582 g_variant_builder_close (&builder);
583 g_variant_builder_add (&builder, "s", hint);
584 g_variant_builder_add_value (&builder, platform_data);
586 g_dbus_connection_call (impl->session_bus,
589 "org.gtk.Application",
591 g_variant_builder_end (&builder),
592 NULL, 0, -1, NULL, NULL, NULL);
596 g_application_impl_cmdline_method_call (GDBusConnection *connection,
598 const gchar *object_path,
599 const gchar *interface_name,
600 const gchar *method_name,
601 GVariant *parameters,
602 GDBusMethodInvocation *invocation,
605 const gchar *message;
607 g_variant_get_child (parameters, 0, "&s", &message);
609 if (strcmp (method_name, "Print") == 0)
610 g_print ("%s", message);
611 else if (strcmp (method_name, "PrintError") == 0)
612 g_printerr ("%s", message);
614 g_assert_not_reached ();
616 g_dbus_method_invocation_return_value (invocation, NULL);
626 g_application_impl_cmdline_done (GObject *source,
627 GAsyncResult *result,
630 CommandLineData *data = user_data;
631 GError *error = NULL;
634 reply = g_dbus_connection_call_finish (G_DBUS_CONNECTION (source),
639 g_variant_get (reply, "(i)", &data->status);
640 g_variant_unref (reply);
645 g_printerr ("%s\n", error->message);
646 g_error_free (error);
650 g_main_loop_quit (data->loop);
654 g_application_impl_command_line (GApplicationImpl *impl,
656 GVariant *platform_data)
658 const static GDBusInterfaceVTable vtable = {
659 g_application_impl_cmdline_method_call
661 const gchar *object_path = "/org/gtk/Application/CommandLine";
662 GMainContext *context;
663 CommandLineData data;
666 context = g_main_context_new ();
667 data.loop = g_main_loop_new (context, FALSE);
668 g_main_context_push_thread_default (context);
670 if (org_gtk_private_CommandLine == NULL)
672 GError *error = NULL;
675 info = g_dbus_node_info_new_for_xml (org_gtk_private_CommandLine_xml, &error);
676 if G_UNLIKELY (info == NULL)
677 g_error ("%s", error->message);
678 org_gtk_private_CommandLine = g_dbus_node_info_lookup_interface (info, "org.gtk.private.CommandLine");
679 g_assert (org_gtk_private_CommandLine != NULL);
680 g_dbus_interface_info_ref (org_gtk_private_CommandLine);
681 g_dbus_node_info_unref (info);
684 object_id = g_dbus_connection_register_object (impl->session_bus, object_path,
685 org_gtk_private_CommandLine,
686 &vtable, &data, NULL, NULL);
687 /* In theory we should try other paths... */
688 g_assert (object_id != 0);
690 g_dbus_connection_call (impl->session_bus,
693 "org.gtk.Application",
695 g_variant_new ("(o^aay@a{sv})", object_path,
696 arguments, platform_data),
697 G_VARIANT_TYPE ("(i)"), 0, G_MAXINT, NULL,
698 g_application_impl_cmdline_done, &data);
700 g_main_loop_run (data.loop);
702 g_main_context_pop_thread_default (context);
703 g_main_context_unref (context);
704 g_main_loop_unref (data.loop);
710 g_application_impl_flush (GApplicationImpl *impl)
712 if (impl->session_bus)
713 g_dbus_connection_flush_sync (impl->session_bus, NULL, NULL);
717 /* GDBusCommandLine implementation {{{1 */
719 typedef GApplicationCommandLineClass GDBusCommandLineClass;
720 static GType g_dbus_command_line_get_type (void);
723 GApplicationCommandLine parent_instance;
724 GDBusMethodInvocation *invocation;
726 GDBusConnection *connection;
727 const gchar *bus_name;
728 const gchar *object_path;
732 G_DEFINE_TYPE (GDBusCommandLine,
734 G_TYPE_APPLICATION_COMMAND_LINE)
737 g_dbus_command_line_print_literal (GApplicationCommandLine *cmdline,
738 const gchar *message)
740 GDBusCommandLine *gdbcl = (GDBusCommandLine *) cmdline;
742 g_dbus_connection_call (gdbcl->connection,
745 "org.gtk.private.CommandLine", "Print",
746 g_variant_new ("(s)", message),
747 NULL, 0, -1, NULL, NULL, NULL);
751 g_dbus_command_line_printerr_literal (GApplicationCommandLine *cmdline,
752 const gchar *message)
754 GDBusCommandLine *gdbcl = (GDBusCommandLine *) cmdline;
756 g_dbus_connection_call (gdbcl->connection,
759 "org.gtk.private.CommandLine", "PrintError",
760 g_variant_new ("(s)", message),
761 NULL, 0, -1, NULL, NULL, NULL);
765 g_dbus_command_line_finalize (GObject *object)
767 GApplicationCommandLine *cmdline = G_APPLICATION_COMMAND_LINE (object);
768 GDBusCommandLine *gdbcl = (GDBusCommandLine *) object;
771 status = g_application_command_line_get_exit_status (cmdline);
773 g_dbus_method_invocation_return_value (gdbcl->invocation,
774 g_variant_new ("(i)", status));
775 g_object_unref (gdbcl->invocation);
777 G_OBJECT_CLASS (g_dbus_command_line_parent_class)
782 g_dbus_command_line_init (GDBusCommandLine *gdbcl)
787 g_dbus_command_line_class_init (GApplicationCommandLineClass *class)
789 GObjectClass *object_class = G_OBJECT_CLASS (class);
791 object_class->finalize = g_dbus_command_line_finalize;
792 class->printerr_literal = g_dbus_command_line_printerr_literal;
793 class->print_literal = g_dbus_command_line_print_literal;
796 static GApplicationCommandLine *
797 g_dbus_command_line_new (GDBusMethodInvocation *invocation)
799 GDBusCommandLine *gdbcl;
802 args = g_dbus_method_invocation_get_parameters (invocation);
804 gdbcl = g_object_new (g_dbus_command_line_get_type (),
805 "arguments", g_variant_get_child_value (args, 1),
806 "platform-data", g_variant_get_child_value (args, 2),
808 gdbcl->connection = g_dbus_method_invocation_get_connection (invocation);
809 gdbcl->bus_name = g_dbus_method_invocation_get_sender (invocation);
810 g_variant_get_child (args, 0, "&o", &gdbcl->object_path);
811 gdbcl->invocation = g_object_ref (invocation);
813 return G_APPLICATION_COMMAND_LINE (gdbcl);
818 /* vim:set foldmethod=marker: */