2 * Copyright © 2011 Canonical Ltd.
4 * This library is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * 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 Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
19 * Author: Ryan Lortie <desrt@desrt.ca>
22 #include "gmenuexporter.h"
24 #include "gdbusmethodinvocation.h"
25 #include "gdbusintrospection.h"
26 #include "gdbusnamewatching.h"
27 #include "gdbuserror.h"
30 * SECTION:gmenuexporter
31 * @title: GMenuModel exporter
32 * @short_description: Export GMenuModels on D-Bus
33 * @see_also: #GMenuModel, #GDBusMenuModel
35 * These functions support exporting a #GMenuModel on D-Bus.
36 * The D-Bus interface that is used is a private implementation
39 * To access an exported #GMenuModel remotely, use
40 * g_dbus_menu_model_get() to obtain a #GDBusMenuModel.
43 /* {{{1 D-Bus Interface description */
45 /* For documentation of this interface, see
46 * http://live.gnome.org/GTK+/GApplication-dbus-apis
49 static GDBusInterfaceInfo *
50 org_gtk_Menus_get_interface (void)
52 static GDBusInterfaceInfo *interface_info;
54 if (interface_info == NULL)
59 info = g_dbus_node_info_new_for_xml ("<node>"
60 " <interface name='org.gtk.Menus'>"
61 " <method name='Start'>"
62 " <arg type='au' name='groups' direction='in'/>"
63 " <arg type='a(uuaa{sv})' name='content' direction='out'/>"
65 " <method name='End'>"
66 " <arg type='au' name='groups' direction='in'/>"
68 " <signal name='Changed'>"
69 " arg type='a(uuuuaa{sv})' name='changes'/>"
74 g_error ("%s\n", error->message);
75 interface_info = g_dbus_node_info_lookup_interface (info, "org.gtk.Menus");
76 g_assert (interface_info != NULL);
77 g_dbus_interface_info_ref (interface_info);
78 g_dbus_node_info_unref (info);
81 return interface_info;
84 /* {{{1 Forward declarations */
85 typedef struct _GMenuExporterMenu GMenuExporterMenu;
86 typedef struct _GMenuExporterLink GMenuExporterLink;
87 typedef struct _GMenuExporterGroup GMenuExporterGroup;
88 typedef struct _GMenuExporterRemote GMenuExporterRemote;
89 typedef struct _GMenuExporterWatch GMenuExporterWatch;
90 typedef struct _GMenuExporter GMenuExporter;
92 static gboolean g_menu_exporter_group_is_subscribed (GMenuExporterGroup *group);
93 static guint g_menu_exporter_group_get_id (GMenuExporterGroup *group);
94 static GMenuExporter * g_menu_exporter_group_get_exporter (GMenuExporterGroup *group);
95 static GMenuExporterMenu * g_menu_exporter_group_add_menu (GMenuExporterGroup *group,
97 static void g_menu_exporter_group_remove_menu (GMenuExporterGroup *group,
100 static GMenuExporterGroup * g_menu_exporter_create_group (GMenuExporter *exporter);
101 static GMenuExporterGroup * g_menu_exporter_lookup_group (GMenuExporter *exporter,
103 static void g_menu_exporter_report (GMenuExporter *exporter,
105 static void g_menu_exporter_remove_group (GMenuExporter *exporter,
108 /* {{{1 GMenuExporterLink, GMenuExporterMenu */
110 struct _GMenuExporterMenu
112 GMenuExporterGroup *group;
117 GSequence *item_links;
120 struct _GMenuExporterLink
123 GMenuExporterMenu *menu;
124 GMenuExporterLink *next;
128 g_menu_exporter_menu_free (GMenuExporterMenu *menu)
130 g_menu_exporter_group_remove_menu (menu->group, menu->id);
132 if (menu->handler_id != 0)
133 g_signal_handler_disconnect (menu->model, menu->handler_id);
135 if (menu->item_links != NULL)
136 g_sequence_free (menu->item_links);
138 g_object_unref (menu->model);
140 g_slice_free (GMenuExporterMenu, menu);
144 g_menu_exporter_link_free (gpointer data)
146 GMenuExporterLink *link = data;
150 GMenuExporterLink *tmp = link;
153 g_menu_exporter_menu_free (tmp->menu);
156 g_slice_free (GMenuExporterLink, tmp);
160 static GMenuExporterLink *
161 g_menu_exporter_menu_create_links (GMenuExporterMenu *menu,
164 GMenuExporterLink *list = NULL;
169 iter = g_menu_model_iterate_item_links (menu->model, position);
171 while (g_menu_link_iter_get_next (iter, &name, &model))
173 GMenuExporterGroup *group;
174 GMenuExporterLink *tmp;
176 /* keep sections in the same group, but create new groups
179 if (!g_str_equal (name, "section"))
180 group = g_menu_exporter_create_group (g_menu_exporter_group_get_exporter (menu->group));
184 tmp = g_slice_new (GMenuExporterLink);
185 tmp->name = g_strconcat (":", name, NULL);
186 tmp->menu = g_menu_exporter_group_add_menu (group, model);
190 g_object_unref (model);
193 g_object_unref (iter);
199 g_menu_exporter_menu_describe_item (GMenuExporterMenu *menu,
202 GMenuAttributeIter *attr_iter;
203 GVariantBuilder builder;
205 GMenuExporterLink *link;
209 g_variant_builder_init (&builder, G_VARIANT_TYPE_VARDICT);
211 attr_iter = g_menu_model_iterate_item_attributes (menu->model, position);
212 while (g_menu_attribute_iter_get_next (attr_iter, &name, &value))
214 g_variant_builder_add (&builder, "{sv}", name, value);
215 g_variant_unref (value);
217 g_object_unref (attr_iter);
219 iter = g_sequence_get_iter_at_pos (menu->item_links, position);
220 for (link = g_sequence_get (iter); link; link = link->next)
221 g_variant_builder_add (&builder, "{sv}", link->name,
222 g_variant_new ("(uu)", g_menu_exporter_group_get_id (link->menu->group), link->menu->id));
224 return g_variant_builder_end (&builder);
228 g_menu_exporter_menu_list (GMenuExporterMenu *menu)
230 GVariantBuilder builder;
233 g_variant_builder_init (&builder, G_VARIANT_TYPE ("aa{sv}"));
235 n = g_sequence_get_length (menu->item_links);
236 for (i = 0; i < n; i++)
237 g_variant_builder_add_value (&builder, g_menu_exporter_menu_describe_item (menu, i));
239 return g_variant_builder_end (&builder);
243 g_menu_exporter_menu_items_changed (GMenuModel *model,
249 GMenuExporterMenu *menu = user_data;
250 GSequenceIter *point;
253 g_assert (menu->model == model);
254 g_assert (menu->item_links != NULL);
255 g_assert (position + removed <= g_sequence_get_length (menu->item_links));
257 point = g_sequence_get_iter_at_pos (menu->item_links, position + removed);
258 g_sequence_remove_range (g_sequence_get_iter_at_pos (menu->item_links, position), point);
260 for (i = position; i < position + added; i++)
261 g_sequence_insert_before (point, g_menu_exporter_menu_create_links (menu, i));
263 if (g_menu_exporter_group_is_subscribed (menu->group))
265 GVariantBuilder builder;
267 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(uuuuaa{sv})"));
268 g_variant_builder_add (&builder, "u", g_menu_exporter_group_get_id (menu->group));
269 g_variant_builder_add (&builder, "u", menu->id);
270 g_variant_builder_add (&builder, "u", position);
271 g_variant_builder_add (&builder, "u", removed);
273 g_variant_builder_open (&builder, G_VARIANT_TYPE ("aa{sv}"));
274 for (i = position; i < position + added; i++)
275 g_variant_builder_add_value (&builder, g_menu_exporter_menu_describe_item (menu, i));
276 g_variant_builder_close (&builder);
278 g_menu_exporter_report (g_menu_exporter_group_get_exporter (menu->group), g_variant_builder_end (&builder));
283 g_menu_exporter_menu_prepare (GMenuExporterMenu *menu)
287 g_assert (menu->item_links == NULL);
289 if (g_menu_model_is_mutable (menu->model))
290 menu->handler_id = g_signal_connect (menu->model, "items-changed",
291 G_CALLBACK (g_menu_exporter_menu_items_changed), menu);
293 menu->item_links = g_sequence_new (g_menu_exporter_link_free);
295 n_items = g_menu_model_get_n_items (menu->model);
297 g_menu_exporter_menu_items_changed (menu->model, 0, 0, n_items, menu);
300 static GMenuExporterMenu *
301 g_menu_exporter_menu_new (GMenuExporterGroup *group,
305 GMenuExporterMenu *menu;
307 menu = g_slice_new0 (GMenuExporterMenu);
310 menu->model = g_object_ref (model);
315 /* {{{1 GMenuExporterGroup */
317 struct _GMenuExporterGroup
319 GMenuExporter *exporter;
330 g_menu_exporter_group_check_if_useless (GMenuExporterGroup *group)
332 if (g_hash_table_size (group->menus) == 0 && group->subscribed == 0)
334 g_menu_exporter_remove_group (group->exporter, group->id);
336 g_hash_table_unref (group->menus);
338 g_slice_free (GMenuExporterGroup, group);
343 g_menu_exporter_group_subscribe (GMenuExporterGroup *group,
344 GVariantBuilder *builder)
349 if (!group->prepared)
351 GMenuExporterMenu *menu;
353 /* set this first, so that any menus created during the
354 * preparation of the first menu also end up in the prepared
357 group->prepared = TRUE;
359 menu = g_hash_table_lookup (group->menus, 0);
361 /* If the group was created by a subscription and does not yet
362 * exist, it won't have a root menu...
364 * That menu will be prepared if it is ever added (due to
365 * group->prepared == TRUE).
368 g_menu_exporter_menu_prepare (menu);
373 g_hash_table_iter_init (&iter, group->menus);
374 while (g_hash_table_iter_next (&iter, &key, &val))
376 guint id = GPOINTER_TO_INT (key);
377 GMenuExporterMenu *menu = val;
379 if (g_sequence_get_length (menu->item_links))
381 g_variant_builder_open (builder, G_VARIANT_TYPE ("(uuaa{sv})"));
382 g_variant_builder_add (builder, "u", group->id);
383 g_variant_builder_add (builder, "u", id);
384 g_variant_builder_add_value (builder, g_menu_exporter_menu_list (menu));
385 g_variant_builder_close (builder);
391 g_menu_exporter_group_unsubscribe (GMenuExporterGroup *group,
394 g_assert (group->subscribed >= count);
396 group->subscribed -= count;
398 g_menu_exporter_group_check_if_useless (group);
401 static GMenuExporter *
402 g_menu_exporter_group_get_exporter (GMenuExporterGroup *group)
404 return group->exporter;
408 g_menu_exporter_group_is_subscribed (GMenuExporterGroup *group)
410 return group->subscribed > 0;
414 g_menu_exporter_group_get_id (GMenuExporterGroup *group)
420 g_menu_exporter_group_remove_menu (GMenuExporterGroup *group,
423 g_hash_table_remove (group->menus, GINT_TO_POINTER (id));
425 g_menu_exporter_group_check_if_useless (group);
428 static GMenuExporterMenu *
429 g_menu_exporter_group_add_menu (GMenuExporterGroup *group,
432 GMenuExporterMenu *menu;
435 id = group->next_menu_id++;
436 menu = g_menu_exporter_menu_new (group, id, model);
437 g_hash_table_insert (group->menus, GINT_TO_POINTER (id), menu);
440 g_menu_exporter_menu_prepare (menu);
445 static GMenuExporterGroup *
446 g_menu_exporter_group_new (GMenuExporter *exporter,
449 GMenuExporterGroup *group;
451 group = g_slice_new0 (GMenuExporterGroup);
452 group->menus = g_hash_table_new (NULL, NULL);
453 group->exporter = exporter;
459 /* {{{1 GMenuExporterRemote */
461 struct _GMenuExporterRemote
463 GMenuExporter *exporter;
469 g_menu_exporter_remote_subscribe (GMenuExporterRemote *remote,
471 GVariantBuilder *builder)
473 GMenuExporterGroup *group;
476 count = (gsize) g_hash_table_lookup (remote->watches, GINT_TO_POINTER (group_id));
477 g_hash_table_insert (remote->watches, GINT_TO_POINTER (group_id), GINT_TO_POINTER (count + 1));
479 /* Group will be created (as empty/unsubscribed if it does not exist) */
480 group = g_menu_exporter_lookup_group (remote->exporter, group_id);
481 g_menu_exporter_group_subscribe (group, builder);
485 g_menu_exporter_remote_unsubscribe (GMenuExporterRemote *remote,
488 GMenuExporterGroup *group;
491 count = (gsize) g_hash_table_lookup (remote->watches, GINT_TO_POINTER (group_id));
497 g_hash_table_insert (remote->watches, GINT_TO_POINTER (group_id), GINT_TO_POINTER (count - 1));
499 g_hash_table_remove (remote->watches, GINT_TO_POINTER (group_id));
501 group = g_menu_exporter_lookup_group (remote->exporter, group_id);
502 g_menu_exporter_group_unsubscribe (group, 1);
506 g_menu_exporter_remote_has_subscriptions (GMenuExporterRemote *remote)
508 return g_hash_table_size (remote->watches) != 0;
512 g_menu_exporter_remote_free (gpointer data)
514 GMenuExporterRemote *remote = data;
518 g_hash_table_iter_init (&iter, remote->watches);
519 while (g_hash_table_iter_next (&iter, &key, &val))
521 GMenuExporterGroup *group;
523 group = g_menu_exporter_lookup_group (remote->exporter, GPOINTER_TO_INT (key));
524 g_menu_exporter_group_unsubscribe (group, GPOINTER_TO_INT (val));
527 g_bus_unwatch_name (remote->watch_id);
528 g_hash_table_unref (remote->watches);
530 g_slice_free (GMenuExporterRemote, remote);
533 static GMenuExporterRemote *
534 g_menu_exporter_remote_new (GMenuExporter *exporter,
537 GMenuExporterRemote *remote;
539 remote = g_slice_new0 (GMenuExporterRemote);
540 remote->exporter = exporter;
541 remote->watches = g_hash_table_new (NULL, NULL);
542 remote->watch_id = watch_id;
547 /* {{{1 GMenuExporter */
549 struct _GMenuExporter
551 GDBusConnection *connection;
553 guint registration_id;
557 GMenuExporterMenu *root;
562 g_menu_exporter_name_vanished (GDBusConnection *connection,
566 GMenuExporter *exporter = user_data;
568 /* connection == NULL when we get called because the connection closed */
569 g_assert (exporter->connection == connection || connection == NULL);
571 g_hash_table_remove (exporter->remotes, name);
575 g_menu_exporter_subscribe (GMenuExporter *exporter,
579 GMenuExporterRemote *remote;
580 GVariantBuilder builder;
584 remote = g_hash_table_lookup (exporter->remotes, sender);
590 watch_id = g_bus_watch_name_on_connection (exporter->connection, sender, G_BUS_NAME_WATCHER_FLAGS_NONE,
591 NULL, g_menu_exporter_name_vanished, exporter, NULL);
592 remote = g_menu_exporter_remote_new (exporter, watch_id);
593 g_hash_table_insert (exporter->remotes, g_strdup (sender), remote);
596 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a(uuaa{sv}))"));
598 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a(uuaa{sv})"));
600 g_variant_iter_init (&iter, group_ids);
601 while (g_variant_iter_next (&iter, "u", &id))
602 g_menu_exporter_remote_subscribe (remote, id, &builder);
604 g_variant_builder_close (&builder);
606 return g_variant_builder_end (&builder);
610 g_menu_exporter_unsubscribe (GMenuExporter *exporter,
614 GMenuExporterRemote *remote;
618 remote = g_hash_table_lookup (exporter->remotes, sender);
623 g_variant_iter_init (&iter, group_ids);
624 while (g_variant_iter_next (&iter, "u", &id))
625 g_menu_exporter_remote_unsubscribe (remote, id);
627 if (!g_menu_exporter_remote_has_subscriptions (remote))
628 g_hash_table_remove (exporter->remotes, sender);
632 g_menu_exporter_report (GMenuExporter *exporter,
635 GVariantBuilder builder;
637 g_variant_builder_init (&builder, G_VARIANT_TYPE_TUPLE);
638 g_variant_builder_open (&builder, G_VARIANT_TYPE_ARRAY);
639 g_variant_builder_add_value (&builder, report);
640 g_variant_builder_close (&builder);
642 g_dbus_connection_emit_signal (exporter->connection,
644 exporter->object_path,
645 "org.gtk.Menus", "Changed",
646 g_variant_builder_end (&builder),
651 g_menu_exporter_remove_group (GMenuExporter *exporter,
654 g_hash_table_remove (exporter->groups, GINT_TO_POINTER (id));
657 static GMenuExporterGroup *
658 g_menu_exporter_lookup_group (GMenuExporter *exporter,
661 GMenuExporterGroup *group;
663 group = g_hash_table_lookup (exporter->groups, GINT_TO_POINTER (group_id));
667 group = g_menu_exporter_group_new (exporter, group_id);
668 g_hash_table_insert (exporter->groups, GINT_TO_POINTER (group_id), group);
674 static GMenuExporterGroup *
675 g_menu_exporter_create_group (GMenuExporter *exporter)
677 GMenuExporterGroup *group;
680 id = exporter->next_group_id++;
681 group = g_menu_exporter_group_new (exporter, id);
682 g_hash_table_insert (exporter->groups, GINT_TO_POINTER (id), group);
688 g_menu_exporter_free (gpointer user_data)
690 GMenuExporter *exporter = user_data;
692 g_menu_exporter_menu_free (exporter->root);
693 g_hash_table_unref (exporter->remotes);
694 g_hash_table_unref (exporter->groups);
695 g_object_unref (exporter->connection);
696 g_free (exporter->object_path);
698 g_slice_free (GMenuExporter, exporter);
702 g_menu_exporter_method_call (GDBusConnection *connection,
704 const gchar *object_path,
705 const gchar *interface_name,
706 const gchar *method_name,
707 GVariant *parameters,
708 GDBusMethodInvocation *invocation,
711 GMenuExporter *exporter = user_data;
714 group_ids = g_variant_get_child_value (parameters, 0);
716 if (g_str_equal (method_name, "Start"))
717 g_dbus_method_invocation_return_value (invocation, g_menu_exporter_subscribe (exporter, sender, group_ids));
719 else if (g_str_equal (method_name, "End"))
721 g_menu_exporter_unsubscribe (exporter, sender, group_ids);
722 g_dbus_method_invocation_return_value (invocation, NULL);
726 g_assert_not_reached ();
728 g_variant_unref (group_ids);
731 /* {{{1 Public API */
734 * g_dbus_connection_export_menu_model:
735 * @connection: a #GDBusConnection
736 * @object_path: a D-Bus object path
737 * @menu: a #GMenuModel
738 * @error: return location for an error, or %NULL
740 * Exports @menu on @connection at @object_path.
742 * The implemented D-Bus API should be considered private.
743 * It is subject to change in the future.
745 * An object path can only have one action group exported on it. If this
746 * constraint is violated, the export will fail and 0 will be
747 * returned (with @error set accordingly).
749 * You can unexport the menu model using
750 * g_dbus_connection_unexport_menu_model() with the return value of
753 * Returns: the ID of the export (never zero), or 0 in case of failure
758 g_dbus_connection_export_menu_model (GDBusConnection *connection,
759 const gchar *object_path,
763 const GDBusInterfaceVTable vtable = {
764 g_menu_exporter_method_call,
766 GMenuExporter *exporter;
769 exporter = g_slice_new0 (GMenuExporter);
771 id = g_dbus_connection_register_object (connection, object_path, org_gtk_Menus_get_interface (),
772 &vtable, exporter, g_menu_exporter_free, error);
776 g_slice_free (GMenuExporter, exporter);
780 exporter->connection = g_object_ref (connection);
781 exporter->object_path = g_strdup (object_path);
782 exporter->groups = g_hash_table_new (NULL, NULL);
783 exporter->remotes = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_menu_exporter_remote_free);
784 exporter->root = g_menu_exporter_group_add_menu (g_menu_exporter_create_group (exporter), menu);
790 * g_dbus_connection_unexport_menu_model:
791 * @connection: a #GDBusConnection
792 * @export_id: the ID from g_dbus_connection_export_menu_model()
794 * Reverses the effect of a previous call to
795 * g_dbus_connection_export_menu_model().
797 * It is an error to call this function with an ID that wasn't returned
798 * from g_dbus_connection_export_menu_model() or to call it with the
799 * same ID more than once.
804 g_dbus_connection_unexport_menu_model (GDBusConnection *connection,
807 g_dbus_connection_unregister_object (connection, export_id);
811 /* vim:set foldmethod=marker: */