2 * Copyright © 2010 Codethink Limited
3 * Copyright © 2011 Canonical Limited
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published
7 * by the Free Software Foundation; either version 2 of the licence or (at
8 * 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 * Authors: Ryan Lortie <desrt@desrt.ca>
23 #include "gactiongroupexporter.h"
25 #include "gdbusmethodinvocation.h"
26 #include "gremoteactiongroup.h"
27 #include "gdbusintrospection.h"
28 #include "gdbusconnection.h"
29 #include "gactiongroup.h"
30 #include "gdbuserror.h"
33 * SECTION:gactiongroupexporter
34 * @title: GActionGroup exporter
36 * @short_description: Export GActionGroups on D-Bus
37 * @see_also: #GActionGroup, #GDBusActionGroup
39 * These functions support exporting a #GActionGroup on D-Bus.
40 * The D-Bus interface that is used is a private implementation
43 * To access an exported #GActionGroup remotely, use
44 * g_dbus_action_group_get() to obtain a #GDBusActionGroup.
48 g_action_group_describe_action (GActionGroup *action_group,
51 const GVariantType *type;
52 GVariantBuilder builder;
56 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(bgav)"));
58 enabled = g_action_group_get_action_enabled (action_group, name);
59 g_variant_builder_add (&builder, "b", enabled);
61 if ((type = g_action_group_get_action_parameter_type (action_group, name)))
63 gchar *str = g_variant_type_dup_string (type);
64 g_variant_builder_add (&builder, "g", str);
68 g_variant_builder_add (&builder, "g", "");
70 g_variant_builder_open (&builder, G_VARIANT_TYPE ("av"));
71 if ((state = g_action_group_get_action_state (action_group, name)))
73 g_variant_builder_add (&builder, "v", state);
74 g_variant_unref (state);
76 g_variant_builder_close (&builder);
78 return g_variant_builder_end (&builder);
81 /* Using XML saves us dozens of relocations vs. using the introspection
82 * structure types. We only need to burn cycles and memory if we
83 * actually use the exporter -- not in every single app using GIO.
85 * It's also a lot easier to read. :)
87 * For documentation of this interface, see
88 * http://live.gnome.org/GTK+/GApplication-dbus-apis
90 const char org_gtk_Actions_xml[] =
92 " <interface name='org.gtk.Actions'>"
93 " <method name='List'>"
94 " <arg type='as' name='list' direction='out'/>"
96 " <method name='Describe'>"
97 " <arg type='s' name='action_name' direction='in'/>"
98 " <arg type='(bgav)' name='description' direction='out'/>"
100 " <method name='DescribeAll'>"
101 " <arg type='a{s(bgav)}' name='descriptions' direction='out'/>"
103 " <method name='Activate'>"
104 " <arg type='s' name='action_name' direction='in'/>"
105 " <arg type='av' name='parameter' direction='in'/>"
106 " <arg type='a{sv}' name='platform_data' direction='in'/>"
108 " <method name='SetState'>"
109 " <arg type='s' name='action_name' direction='in'/>"
110 " <arg type='v' name='value' direction='in'/>"
111 " <arg type='a{sv}' name='platform_data' direction='in'/>"
113 " <signal name='Changed'>"
114 " <arg type='as' name='removals'/>"
115 " <arg type='a{sb}' name='enable_changes'/>"
116 " <arg type='a{sv}' name='state_changes'/>"
117 " <arg type='a{s(bgav)}' name='additions'/>"
122 static GDBusInterfaceInfo *org_gtk_Actions;
126 GActionGroup *action_group;
127 GDBusConnection *connection;
128 GMainContext *context;
130 GHashTable *pending_changes;
131 GSource *pending_source;
132 } GActionGroupExporter;
134 #define ACTION_ADDED_EVENT (1u<<0)
135 #define ACTION_REMOVED_EVENT (1u<<1)
136 #define ACTION_STATE_CHANGED_EVENT (1u<<2)
137 #define ACTION_ENABLED_CHANGED_EVENT (1u<<3)
140 g_action_group_exporter_dispatch_events (gpointer user_data)
142 GActionGroupExporter *exporter = user_data;
143 GVariantBuilder removes;
144 GVariantBuilder enabled_changes;
145 GVariantBuilder state_changes;
146 GVariantBuilder adds;
151 g_variant_builder_init (&removes, G_VARIANT_TYPE_STRING_ARRAY);
152 g_variant_builder_init (&enabled_changes, G_VARIANT_TYPE ("a{sb}"));
153 g_variant_builder_init (&state_changes, G_VARIANT_TYPE ("a{sv}"));
154 g_variant_builder_init (&adds, G_VARIANT_TYPE ("a{s(bgav)}"));
156 g_hash_table_iter_init (&iter, exporter->pending_changes);
157 while (g_hash_table_iter_next (&iter, &key, &value))
159 guint events = GPOINTER_TO_INT (value);
160 const gchar *name = key;
162 /* Adds and removes are incompatible with enabled or state
163 * changes, but we must report at least one event.
165 g_assert (((events & (ACTION_ENABLED_CHANGED_EVENT | ACTION_STATE_CHANGED_EVENT)) == 0) !=
166 ((events & (ACTION_REMOVED_EVENT | ACTION_ADDED_EVENT)) == 0));
168 if (events & ACTION_REMOVED_EVENT)
169 g_variant_builder_add (&removes, "s", name);
171 if (events & ACTION_ENABLED_CHANGED_EVENT)
175 enabled = g_action_group_get_action_enabled (exporter->action_group, name);
176 g_variant_builder_add (&enabled_changes, "{sb}", name, enabled);
179 if (events & ACTION_STATE_CHANGED_EVENT)
183 state = g_action_group_get_action_state (exporter->action_group, name);
184 g_variant_builder_add (&state_changes, "{sv}", name, state);
185 g_variant_unref (state);
188 if (events & ACTION_ADDED_EVENT)
190 GVariant *description;
192 description = g_action_group_describe_action (exporter->action_group, name);
193 g_variant_builder_add (&adds, "{s@(bgav)}", name, description);
197 g_hash_table_remove_all (exporter->pending_changes);
199 g_dbus_connection_emit_signal (exporter->connection, NULL, exporter->object_path,
200 "org.gtk.Actions", "Changed",
201 g_variant_new ("(asa{sb}a{sv}a{s(bgav)})",
202 &removes, &enabled_changes,
203 &state_changes, &adds),
206 exporter->pending_source = NULL;
212 g_action_group_exporter_get_events (GActionGroupExporter *exporter,
215 return (gsize) g_hash_table_lookup (exporter->pending_changes, name);
219 g_action_group_exporter_set_events (GActionGroupExporter *exporter,
223 gboolean have_events;
227 g_hash_table_insert (exporter->pending_changes, g_strdup (name), GINT_TO_POINTER (events));
229 g_hash_table_remove (exporter->pending_changes, name);
231 have_events = g_hash_table_size (exporter->pending_changes) > 0;
232 is_queued = exporter->pending_source != NULL;
234 if (have_events && !is_queued)
238 source = g_idle_source_new ();
239 exporter->pending_source = source;
240 g_source_set_callback (source, g_action_group_exporter_dispatch_events, exporter, NULL);
241 g_source_attach (source, exporter->context);
242 g_source_unref (source);
245 if (!have_events && is_queued)
247 g_source_destroy (exporter->pending_source);
248 exporter->pending_source = NULL;
253 g_action_group_exporter_action_added (GActionGroup *action_group,
254 const gchar *action_name,
257 GActionGroupExporter *exporter = user_data;
260 event_mask = g_action_group_exporter_get_events (exporter, action_name);
262 /* The action is new, so we should not have any pending
263 * enabled-changed or state-changed signals for it.
265 g_assert (~event_mask & (ACTION_STATE_CHANGED_EVENT |
266 ACTION_ENABLED_CHANGED_EVENT));
268 event_mask |= ACTION_ADDED_EVENT;
270 g_action_group_exporter_set_events (exporter, action_name, event_mask);
274 g_action_group_exporter_action_removed (GActionGroup *action_group,
275 const gchar *action_name,
278 GActionGroupExporter *exporter = user_data;
281 event_mask = g_action_group_exporter_get_events (exporter, action_name);
283 /* If the add event for this is still queued then just cancel it since
286 * If the event was freshly added, there should not have been any
287 * enabled or state changed events.
289 if (event_mask & ACTION_ADDED_EVENT)
291 g_assert (~event_mask & ~(ACTION_STATE_CHANGED_EVENT | ACTION_ENABLED_CHANGED_EVENT));
292 event_mask &= ~ACTION_ADDED_EVENT;
295 /* Otherwise, queue a remove event. Drop any state or enabled changes
296 * that were queued before the remove. */
299 event_mask |= ACTION_REMOVED_EVENT;
300 event_mask &= ~(ACTION_STATE_CHANGED_EVENT | ACTION_ENABLED_CHANGED_EVENT);
303 g_action_group_exporter_set_events (exporter, action_name, event_mask);
307 g_action_group_exporter_action_state_changed (GActionGroup *action_group,
308 const gchar *action_name,
312 GActionGroupExporter *exporter = user_data;
315 event_mask = g_action_group_exporter_get_events (exporter, action_name);
317 /* If it was removed, it must have been added back. Otherwise, why
318 * are we hearing about changes?
320 g_assert (~event_mask & ACTION_REMOVED_EVENT ||
321 event_mask & ACTION_ADDED_EVENT);
323 /* If it is freshly added, don't also bother with the state change
324 * signal since the updated state will be sent as part of the pending
327 if (~event_mask & ACTION_ADDED_EVENT)
328 event_mask |= ACTION_STATE_CHANGED_EVENT;
330 g_action_group_exporter_set_events (exporter, action_name, event_mask);
334 g_action_group_exporter_action_enabled_changed (GActionGroup *action_group,
335 const gchar *action_name,
339 GActionGroupExporter *exporter = user_data;
342 event_mask = g_action_group_exporter_get_events (exporter, action_name);
344 /* Reasoning as above. */
345 g_assert (~event_mask & ACTION_REMOVED_EVENT ||
346 event_mask & ACTION_ADDED_EVENT);
348 if (~event_mask & ACTION_ADDED_EVENT)
349 event_mask |= ACTION_ENABLED_CHANGED_EVENT;
351 g_action_group_exporter_set_events (exporter, action_name, event_mask);
355 org_gtk_Actions_method_call (GDBusConnection *connection,
357 const gchar *object_path,
358 const gchar *interface_name,
359 const gchar *method_name,
360 GVariant *parameters,
361 GDBusMethodInvocation *invocation,
364 GActionGroupExporter *exporter = user_data;
365 GVariant *result = NULL;
367 if (g_str_equal (method_name, "List"))
371 list = g_action_group_list_actions (exporter->action_group);
372 result = g_variant_new ("(^as)", list);
376 else if (g_str_equal (method_name, "Describe"))
381 g_variant_get (parameters, "(&s)", &name);
383 if (!g_action_group_has_action (exporter->action_group, name))
385 g_dbus_method_invocation_return_error (invocation, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
386 "The named action ('%s') does not exist.", name);
390 desc = g_action_group_describe_action (exporter->action_group, name);
391 result = g_variant_new ("(@(bgav))", desc);
394 else if (g_str_equal (method_name, "DescribeAll"))
396 GVariantBuilder builder;
400 list = g_action_group_list_actions (exporter->action_group);
401 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{s(bgav)}"));
402 for (i = 0; list[i]; i++)
404 const gchar *name = list[i];
405 GVariant *description;
407 description = g_action_group_describe_action (exporter->action_group, name);
408 g_variant_builder_add (&builder, "{s@(bgav)}", name, description);
410 result = g_variant_new ("(a{s(bgav)})", &builder);
414 else if (g_str_equal (method_name, "Activate"))
416 GVariant *parameter = NULL;
417 GVariant *platform_data;
421 g_variant_get (parameters, "(&sav@a{sv})", &name, &iter, &platform_data);
422 g_variant_iter_next (iter, "v", ¶meter);
423 g_variant_iter_free (iter);
425 if (G_IS_REMOTE_ACTION_GROUP (exporter->action_group))
426 g_remote_action_group_activate_action_full (G_REMOTE_ACTION_GROUP (exporter->action_group),
427 name, parameter, platform_data);
429 g_action_group_activate_action (exporter->action_group, name, parameter);
432 g_variant_unref (parameter);
434 g_variant_unref (platform_data);
437 else if (g_str_equal (method_name, "SetState"))
439 GVariant *platform_data;
443 g_variant_get (parameters, "(&sv@a{sv})", &name, &state, &platform_data);
445 if (G_IS_REMOTE_ACTION_GROUP (exporter->action_group))
446 g_remote_action_group_change_action_state_full (G_REMOTE_ACTION_GROUP (exporter->action_group),
447 name, state, platform_data);
449 g_action_group_change_action_state (exporter->action_group, name, state);
451 g_variant_unref (platform_data);
452 g_variant_unref (state);
456 g_assert_not_reached ();
458 g_dbus_method_invocation_return_value (invocation, result);
462 g_action_group_exporter_free (gpointer user_data)
464 GActionGroupExporter *exporter = user_data;
466 g_signal_handlers_disconnect_by_func (exporter->action_group,
467 g_action_group_exporter_action_added, exporter);
468 g_signal_handlers_disconnect_by_func (exporter->action_group,
469 g_action_group_exporter_action_enabled_changed, exporter);
470 g_signal_handlers_disconnect_by_func (exporter->action_group,
471 g_action_group_exporter_action_state_changed, exporter);
472 g_signal_handlers_disconnect_by_func (exporter->action_group,
473 g_action_group_exporter_action_removed, exporter);
475 g_hash_table_unref (exporter->pending_changes);
476 if (exporter->pending_source)
477 g_source_destroy (exporter->pending_source);
479 g_main_context_unref (exporter->context);
480 g_object_unref (exporter->connection);
481 g_object_unref (exporter->action_group);
482 g_free (exporter->object_path);
484 g_slice_free (GActionGroupExporter, exporter);
488 * g_dbus_connection_export_action_group:
489 * @connection: a #GDBusConnection
490 * @object_path: a D-Bus object path
491 * @action_group: a #GActionGroup
492 * @error: a pointer to a %NULL #GError, or %NULL
494 * Exports @action_group on @connection at @object_path.
496 * The implemented D-Bus API should be considered private. It is
497 * subject to change in the future.
499 * A given object path can only have one action group exported on it.
500 * If this constraint is violated, the export will fail and 0 will be
501 * returned (with @error set accordingly).
503 * You can unexport the action group using
504 * g_dbus_connection_unexport_action_group() with the return value of
507 * The thread default main context is taken at the time of this call.
508 * All incoming action activations and state change requests are
509 * reported from this context. Any changes on the action group that
510 * cause it to emit signals must also come from this same context.
511 * Since incoming action activations and state change requests are
512 * rather likely to cause changes on the action group, this effectively
513 * limits a given action group to being exported from only one main
516 * Returns: the ID of the export (never zero), or 0 in case of failure
521 g_dbus_connection_export_action_group (GDBusConnection *connection,
522 const gchar *object_path,
523 GActionGroup *action_group,
526 const GDBusInterfaceVTable vtable = {
527 org_gtk_Actions_method_call
529 GActionGroupExporter *exporter;
532 if G_UNLIKELY (org_gtk_Actions == NULL)
534 GError *error = NULL;
537 info = g_dbus_node_info_new_for_xml (org_gtk_Actions_xml, &error);
538 if G_UNLIKELY (info == NULL)
539 g_error ("%s", error->message);
540 org_gtk_Actions = g_dbus_node_info_lookup_interface (info, "org.gtk.Actions");
541 g_assert (org_gtk_Actions != NULL);
542 g_dbus_interface_info_ref (org_gtk_Actions);
543 g_dbus_node_info_unref (info);
546 exporter = g_slice_new (GActionGroupExporter);
547 id = g_dbus_connection_register_object (connection, object_path, org_gtk_Actions, &vtable,
548 exporter, g_action_group_exporter_free, error);
552 g_slice_free (GActionGroupExporter, exporter);
556 exporter->context = g_main_context_ref_thread_default ();
557 exporter->pending_changes = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
558 exporter->pending_source = NULL;
559 exporter->action_group = g_object_ref (action_group);
560 exporter->connection = g_object_ref (connection);
561 exporter->object_path = g_strdup (object_path);
563 g_signal_connect (action_group, "action-added",
564 G_CALLBACK (g_action_group_exporter_action_added), exporter);
565 g_signal_connect (action_group, "action-removed",
566 G_CALLBACK (g_action_group_exporter_action_removed), exporter);
567 g_signal_connect (action_group, "action-state-changed",
568 G_CALLBACK (g_action_group_exporter_action_state_changed), exporter);
569 g_signal_connect (action_group, "action-enabled-changed",
570 G_CALLBACK (g_action_group_exporter_action_enabled_changed), exporter);
576 * g_dbus_connection_unexport_action_group:
577 * @connection: a #GDBusConnection
578 * @export_id: the ID from g_dbus_connection_export_action_group()
580 * Reverses the effect of a previous call to
581 * g_dbus_connection_export_action_group().
583 * It is an error to call this function with an ID that wasn't returned
584 * from g_dbus_connection_export_action_group() or to call it with the
585 * same ID more than once.
590 g_dbus_connection_unexport_action_group (GDBusConnection *connection,
593 g_dbus_connection_unregister_object (connection, export_id);