From 9627530cdaeb8d0ad9984f55f6fb0804740a1343 Mon Sep 17 00:00:00 2001 From: Lars Uebernickel Date: Fri, 24 May 2013 18:17:45 -0400 Subject: IndicatorNg: update indicator file format The old file format had some shortcomings: (1) It was impossible to efficiently reuse a menu for different profiles, because the profile name was implicit in the object path. The only way to do this was to export the same menu twice. Now, object paths have to be set explicitly in the indicator file. (2) The well-known dbus name of a service and the name of its service file were similar but slightly different (com.canonical.indicator.test vs com.canonical.test.indicator), which caused some confusion on when to use which. Now, the file name *is* the bus name, and the `BusName` key has been dropped. The new file format is documented in README. --- README | 35 +++++++++++++ libindicator/indicator-ng.c | 62 +++++++++++++++++++----- tests/com.canonical.indicator.no-such-service | 3 ++ tests/com.canonical.indicator.test | 6 +++ tests/com.canonical.test.indicator | 4 -- tests/com.canonical.test.nosuchservice.indicator | 4 -- tests/test-indicator-ng.c | 10 ++-- tools/indicator-loader.c | 5 +- 8 files changed, 102 insertions(+), 27 deletions(-) create mode 100644 tests/com.canonical.indicator.no-such-service create mode 100644 tests/com.canonical.indicator.test delete mode 100644 tests/com.canonical.test.indicator delete mode 100644 tests/com.canonical.test.nosuchservice.indicator diff --git a/README b/README index e69de29..1ea62ef 100644 --- a/README +++ b/README @@ -0,0 +1,35 @@ +The indicator service file format +================================= + +Unity's panel finds out about indicator by looking at indicator service +files in `/usr/share/unity/indicators`. These files have to have the same +name as the well-known D-Bus name that the corresponding service owns. + +An indicator file is a normal key file (like desktop files). It must have +an `[Indicator Service]` section, that contains the service's name +(`Name`) and optionally the object path at which its action group is found +(`ObjectPath`). For example: + + [Indicator Service] + Name=indicator-example + ObjectPath=/com/canonical/indicator/example + +An indicator can only export one action group, but a menu for each profile +("desktop", "greeter", "phone") supports. There must be a section for each +of those profiles, containing the object path on which the menu is +exported: + + [desktop] + ObjectPath=/com/canonical/indicator/example/desktop + + [greeter] + ObjectPath=/com/canonical/indicator/example/desktop + + [phone] + ObjectPath=/com/canonical/indicator/example/phone + +Object paths can be reused for different profiles (the greeter uses the +same menu as the desktop in the above example). + +There are no fallbacks. If a profile is not mentioned in the service file, +the indicator will not show up for that profile. diff --git a/libindicator/indicator-ng.c b/libindicator/indicator-ng.c index 0bd3981..fbf1e97 100644 --- a/libindicator/indicator-ng.c +++ b/libindicator/indicator-ng.c @@ -29,6 +29,7 @@ struct _IndicatorNg gchar *service_file; gchar *name; gchar *object_path; + gchar *menu_object_path; gchar *bus_name; gchar *profile; gchar *header_action; @@ -152,6 +153,7 @@ indicator_ng_finalize (GObject *object) g_free (self->service_file); g_free (self->name); g_free (self->object_path); + g_free (self->menu_object_path); g_free (self->bus_name); g_free (self->accessible_desc); g_free (self->header_action); @@ -362,11 +364,13 @@ indicator_ng_service_appeared (GDBusConnection *connection, gpointer user_data) { IndicatorNg *self = user_data; - gchar *menu_object_path; g_assert (!self->actions); g_assert (!self->menu); + /* watch is not established when menu_object_path == NULL */ + g_assert (self->menu_object_path); + self->session_bus = g_object_ref (connection); self->actions = G_ACTION_GROUP (g_dbus_action_group_get (connection, name_owner, self->object_path)); @@ -375,15 +379,12 @@ indicator_ng_service_appeared (GDBusConnection *connection, g_signal_connect_swapped (self->actions, "action-removed", G_CALLBACK (indicator_ng_update_entry), self); g_signal_connect_swapped (self->actions, "action-state-changed", G_CALLBACK (indicator_ng_update_entry), self); - menu_object_path = g_strconcat (self->object_path, "/", self->profile, NULL); - self->menu = G_MENU_MODEL (g_dbus_menu_model_get (connection, name_owner, menu_object_path)); + self->menu = G_MENU_MODEL (g_dbus_menu_model_get (connection, name_owner, self->menu_object_path)); g_signal_connect (self->menu, "items-changed", G_CALLBACK (indicator_ng_menu_changed), self); if (g_menu_model_get_n_items (self->menu)) indicator_ng_menu_changed (self->menu, 0, 0, 1, self); indicator_ng_update_entry (self); - - g_free (menu_object_path); } static void @@ -459,6 +460,38 @@ indicator_ng_service_vanished (GDBusConnection *connection, } } +static gboolean +indicator_ng_load_from_keyfile (IndicatorNg *self, + GKeyFile *keyfile, + GError **error) +{ + g_assert (self->name == NULL); + g_assert (self->object_path == NULL); + g_assert (self->menu_object_path == NULL); + + self->name = g_key_file_get_string (keyfile, "Indicator Service", "Name", error); + if (self->name == NULL) + return FALSE; + + self->object_path = g_key_file_get_string (keyfile, "Indicator Service", "ObjectPath", error); + if (self->object_path == NULL) + return FALSE; + + /* + * Don't throw an error when the profile doesn't exist. Non-existant + * profiles are silently ignored by not showing an indicator at all. + */ + if (g_key_file_has_group (keyfile, self->profile)) + { + /* however, if the profile exists, it must have "ObjectPath" */ + self->menu_object_path = g_key_file_get_string (keyfile, self->profile, "ObjectPath", error); + if (self->menu_object_path == NULL) + return FALSE; + } + + return TRUE; +} + static gboolean indicator_ng_initable_init (GInitable *initable, GCancellable *cancellable, @@ -466,16 +499,19 @@ indicator_ng_initable_init (GInitable *initable, { IndicatorNg *self = INDICATOR_NG (initable); GKeyFile *keyfile; + gboolean success; + + self->bus_name = g_path_get_basename (self->service_file); keyfile = g_key_file_new (); - if (g_key_file_load_from_file (keyfile, self->service_file, G_KEY_FILE_NONE, error)) + if (g_key_file_load_from_file (keyfile, self->service_file, G_KEY_FILE_NONE, error) && + indicator_ng_load_from_keyfile (self, keyfile, error)) { - if ((self->name = g_key_file_get_string (keyfile, "Indicator Service", "Name", error)) && - (self->bus_name = g_key_file_get_string (keyfile, "Indicator Service", "BusName", error)) && - (self->object_path = g_key_file_get_string (keyfile, "Indicator Service", "ObjectPath", error))) - { - self->entry.name_hint = self->name; + self->entry.name_hint = self->name; + /* only watch the service when it supports the proile we're interested in */ + if (self->menu_object_path) + { self->name_watch_id = g_bus_watch_name (G_BUS_TYPE_SESSION, self->bus_name, G_BUS_NAME_WATCHER_FLAGS_AUTO_START, @@ -483,10 +519,12 @@ indicator_ng_initable_init (GInitable *initable, indicator_ng_service_vanished, self, NULL); } + + success = TRUE; } g_key_file_free (keyfile); - return self->name_watch_id > 0; + return success; } static void diff --git a/tests/com.canonical.indicator.no-such-service b/tests/com.canonical.indicator.no-such-service new file mode 100644 index 0000000..54cc4fd --- /dev/null +++ b/tests/com.canonical.indicator.no-such-service @@ -0,0 +1,3 @@ +[Indicator Service] +Name=indicator-test +ObjectPath=/com/canonical/indicator/test diff --git a/tests/com.canonical.indicator.test b/tests/com.canonical.indicator.test new file mode 100644 index 0000000..0c7122f --- /dev/null +++ b/tests/com.canonical.indicator.test @@ -0,0 +1,6 @@ +[Indicator Service] +Name=indicator-test +ObjectPath=/com/canonical/indicator/test + +[desktop] +ObjectPath=/com/canonical/indicator/test/desktop diff --git a/tests/com.canonical.test.indicator b/tests/com.canonical.test.indicator deleted file mode 100644 index dad4c94..0000000 --- a/tests/com.canonical.test.indicator +++ /dev/null @@ -1,4 +0,0 @@ -[Indicator Service] -Name=indicator-test -BusName=com.canonical.indicator.test -ObjectPath=/com/canonical/indicator/test diff --git a/tests/com.canonical.test.nosuchservice.indicator b/tests/com.canonical.test.nosuchservice.indicator deleted file mode 100644 index 8464749..0000000 --- a/tests/com.canonical.test.nosuchservice.indicator +++ /dev/null @@ -1,4 +0,0 @@ -[Indicator Service] -Name=indicator-test -BusName=com.canonical.indicator.test.nosuchservice -ObjectPath=/com/canonical/indicator/test diff --git a/tests/test-indicator-ng.c b/tests/test-indicator-ng.c index 150cc37..7b677d3 100644 --- a/tests/test-indicator-ng.c +++ b/tests/test-indicator-ng.c @@ -50,11 +50,11 @@ test_instantiation (void) GError *error = NULL; GMainLoop *loop; - indicator = indicator_ng_new (SRCDIR "/com.canonical.test.nosuchservice.indicator", &error); + indicator = indicator_ng_new (SRCDIR "/com.canonical.indicator.no-such-service", &error); g_assert (indicator); g_assert (error == NULL); - g_assert_cmpstr (indicator_ng_get_service_file (indicator), ==, SRCDIR "/com.canonical.test.nosuchservice.indicator"); + g_assert_cmpstr (indicator_ng_get_service_file (indicator), ==, SRCDIR "/com.canonical.indicator.no-such-service"); g_assert_cmpstr (indicator_ng_get_profile (indicator), ==, "desktop"); { @@ -65,7 +65,7 @@ test_instantiation (void) "profile", &profile, NULL); - g_assert_cmpstr (service_file, ==, SRCDIR "/com.canonical.test.nosuchservice.indicator"); + g_assert_cmpstr (service_file, ==, SRCDIR "/com.canonical.indicator.no-such-service"); g_assert_cmpstr (profile, ==, "desktop"); g_free (service_file); @@ -89,7 +89,7 @@ test_instantiation_with_profile (void) IndicatorNg *indicator; GError *error = NULL; - indicator = indicator_ng_new_for_profile (SRCDIR "/com.canonical.test.indicator", "greeter", &error); + indicator = indicator_ng_new_for_profile (SRCDIR "/com.canonical.indicator.test", "greeter", &error); g_assert (indicator); g_assert (error == NULL); @@ -107,7 +107,7 @@ test_menu (void) GList *entries; IndicatorObjectEntry *entry; - indicator = indicator_ng_new (SRCDIR "/com.canonical.test.indicator", &error); + indicator = indicator_ng_new (SRCDIR "/com.canonical.indicator.test", &error); g_assert (indicator); g_assert (error == NULL); diff --git a/tools/indicator-loader.c b/tools/indicator-loader.c index 5659dea..2ec9913 100644 --- a/tools/indicator-loader.c +++ b/tools/indicator-loader.c @@ -150,7 +150,7 @@ load_module (const gchar * name, GtkWidget * menu) io = indicator_object_new_from_file(name); } #if GTK_MAJOR_VERSION == 3 - else if (g_str_has_suffix(name, ".indicator")) { + else { GError *error = NULL; io = INDICATOR_OBJECT (indicator_ng_new_for_profile (name, profile, &error)); @@ -162,9 +162,10 @@ load_module (const gchar * name, GtkWidget * menu) title = g_strdup_printf ("%s %s", profile, name); } -#endif +#else else return FALSE; +#endif /* Connect to it's signals */ g_signal_connect(G_OBJECT(io), INDICATOR_OBJECT_SIGNAL_ENTRY_ADDED, G_CALLBACK(entry_added), menu); -- cgit v1.2.3