Merge lp:~3v1n0/libappindicator/incons-paths-on-snap into lp:libappindicator/16.10

[Marco Trevisan (Treviño)]

AppIndicator: fix icon and theme paths when running in $SNAP environment

Prepend $SNAP path to icons and theme paths when running in a sandboxed
environment, this allows to run app indicators without caring about the fact
they've been designed or compiled to run in a snap world or not.

See gtk2/gtk3 examples using this at https://github.com/3v1n0/indicators-examples-snaps

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:283
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/1/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1142/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1149/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/1/rebuild

review: Needs Fixing (continuous-integration)

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:284
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/2/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1143/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1150/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/2/rebuild

review: Needs Fixing (continuous-integration)

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:285
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/3/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1144/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1151/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/3/rebuild

review: Needs Fixing (continuous-integration)

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:286
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/4/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1150/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1157/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/4/rebuild

review: Needs Fixing (continuous-integration)

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:287
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/5/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1161/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1168/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/5/rebuild

review: Needs Fixing (continuous-integration)

[Andrea Azzarone (azzar1)]

LGTM.

review: Approve

[Marco Trevisan (Treviño) (3v1n0)]

Actually I've noticed that this is not correct when the developer uses an hardcoded path suc has /snap/$SNAP_NAME/current.

So it needs some tuning.

[lp:~3v1n0/libappindicator/incons-paths-on-snap]

288. By Marco Trevisan (Treviño) on 2016-11-29

app-indicator: get real path on snap when trying to transform it

So when pointing to /snap/<name>/current will be automatically translated
to /snap/<name>/<current_revision>/...

[Marco Trevisan (Treviño) (3v1n0)]

Done this part too...

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:288
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/6/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1207/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1214/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/6/rebuild

review: Needs Fixing (continuous-integration)

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:288
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/7/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1208/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1215
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/1000
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/1000/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=zesty/1000
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=zesty/1000/artifact/output/*zip*/output.zip
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/1000/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=zesty/1000/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/1000/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=zesty/1000
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=zesty/1000/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-libappindicator-ci/7/rebuild

review: Needs Fixing (continuous-integration)

[Andrea Azzarone (azzar1)]

+1

review: Approve

=== modified file 'configure.ac'
--- configure.ac	2013-01-29 17:50:13 +0000
+++ configure.ac	2016-11-29 17:27:34 +0000
@@ -121,7 +121,7 @@
       RUNTIME=mono
    fi
 
-   AC_PATH_PROG(CSC, gmcs, no)
+   AC_PATH_PROG(CSC, mono-csc, no)
    LIB_PREFIX=.so
    LIB_SUFFIX=
 fi
 
=== modified file 'debian/control'
--- debian/control	2013-12-19 14:37:54 +0000
+++ debian/control	2016-11-29 17:27:34 +0000
@@ -8,6 +8,7 @@
                python-all-dev,
                at-spi2-core,
                cli-common-dev (>= 0.5.7) [!arm64 !ppc64el],
+               gnome-common,
                gobject-introspection,
                intltool,
                gtk-doc-tools,
 
=== modified file 'debian/rules'
--- debian/rules	2013-12-19 14:37:54 +0000
+++ debian/rules	2016-11-29 17:27:34 +0000
@@ -15,8 +15,6 @@
 CONFIGURE_FLAGS_gtk2 = --with-gtk=2 --enable-gtk-doc
 CONFIGURE_FLAGS_gtk3 = --with-gtk=3 --enable-gtk-doc=no
 
-export CSC=/usr/bin/mono-csc
-
 export DPKG_GENSYMBOLS_CHECK_LEVEL = 4
 
 CFLAGS += -fPIC
 
=== modified file 'example/simple-client-vala.vala'
--- example/simple-client-vala.vala	2012-03-21 18:02:41 +0000
+++ example/simple-client-vala.vala	2016-11-29 17:27:34 +0000
@@ -104,7 +104,7 @@
 			print(@"Got scroll event! delta: $delta, direction: $direction\n");
 		});
 
-		Timeout.add_seconds(1, () => {
+		GLib.Timeout.add_seconds(1, () => {
 			percentage = (percentage + 1) % 100;
 			if (can_haz_label) {
 				ci.set_label(@"$(percentage+1)%", "");
 
=== modified file 'src/app-indicator.c'
--- src/app-indicator.c	2015-07-02 17:03:37 +0000
+++ src/app-indicator.c	2016-11-29 17:27:34 +0000
@@ -38,6 +38,8 @@
 
 #include <libindicator/indicator-desktop-shortcuts.h>
 
+#include <stdlib.h>
+
 #include "app-indicator.h"
 #include "app-indicator-enum-types.h"
 #include "application-service-marshal.h"
@@ -71,8 +73,11 @@
 	AppIndicatorCategory  category;
 	AppIndicatorStatus    status;
 	gchar                *icon_name;
+	gchar                *absolute_icon_name;
 	gchar                *attention_icon_name;
+	gchar                *absolute_attention_icon_name;
 	gchar                *icon_theme_path;
+	gchar                *absolute_icon_theme_path;
 	DbusmenuServer       *menuservice;
 	GtkWidget            *menu;
 	GtkWidget            *sec_activate_target;
@@ -190,6 +195,8 @@
 static void status_icon_menu_activate (GtkStatusIcon *status_icon, guint button, guint activate_time, gpointer user_data);
 static void unfallback (AppIndicator * self, GtkStatusIcon * status_icon);
 static gchar * append_panel_icon_suffix (const gchar * icon_name);
+static gchar * get_real_theme_path (AppIndicator * self);
+static gchar * append_snap_prefix (const gchar * path);
 static void theme_changed_cb (GtkIconTheme * theme, gpointer user_data);
 static void sec_activate_target_parent_changed(GtkWidget *menuitem, GtkWidget *old_parent, gpointer   user_data);
 static GVariant * bus_get_prop (GDBusConnection * connection, const gchar * sender, const gchar * path, const gchar * interface, const gchar * property, GError ** error, gpointer user_data);
@@ -389,7 +396,7 @@
                                                              "An additional place to look for icon names that may be installed by the application.",
                                                              NULL,
                                                              G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT));
-	
+
 	/**
 	 * AppIndicator:connected:
 	 * 
@@ -640,6 +647,7 @@
 app_indicator_init (AppIndicator *self)
 {
 	AppIndicatorPrivate * priv = APP_INDICATOR_GET_PRIVATE(self);
+	self->priv = priv;
 
 	priv->id = NULL;
 	priv->clean_id = NULL;
@@ -648,6 +656,7 @@
 	priv->icon_name = NULL;
 	priv->attention_icon_name = NULL;
 	priv->icon_theme_path = NULL;
+	priv->absolute_icon_theme_path = get_real_theme_path (self);
 	priv->menu = NULL;
 	priv->menuservice = NULL;
 	priv->ordering_index = 0;
@@ -676,8 +685,6 @@
 	                                     (GBusNameVanishedCallback) name_vanished_handler,
 	                                     self, NULL);
 
-	self->priv = priv;
-
 	/* Start getting the session bus */
 	g_object_ref(self); /* ref for the bus creation callback */
 	g_bus_get(G_BUS_TYPE_SESSION, NULL, bus_creation, self);
@@ -794,16 +801,31 @@
 		priv->icon_name = NULL;
 	}
 
+	if (priv->absolute_icon_name != NULL) {
+		g_free(priv->absolute_icon_name);
+		priv->absolute_icon_name = NULL;
+	}
+
 	if (priv->attention_icon_name != NULL) {
 		g_free(priv->attention_icon_name);
 		priv->attention_icon_name = NULL;
 	}
 
+	if (priv->absolute_attention_icon_name != NULL) {
+		g_free(priv->absolute_attention_icon_name);
+		priv->absolute_attention_icon_name = NULL;
+	}
+
 	if (priv->icon_theme_path != NULL) {
 		g_free(priv->icon_theme_path);
 		priv->icon_theme_path = NULL;
 	}
-	
+
+	if (priv->absolute_icon_theme_path != NULL) {
+		g_free(priv->absolute_icon_theme_path);
+		priv->absolute_icon_theme_path = NULL;
+	}
+
 	if (priv->title != NULL) {
 		g_free(priv->title);
 		priv->title = NULL;
@@ -1188,8 +1210,14 @@
 		enum_value = g_enum_get_value ((GEnumClass *) g_type_class_ref (APP_INDICATOR_TYPE_INDICATOR_STATUS), priv->status);
 		return g_variant_new_string(enum_value->value_nick ? enum_value->value_nick : "");
 	} else if (g_strcmp0(property, "IconName") == 0) {
+		if (priv->absolute_icon_name) {
+			return g_variant_new_string(priv->absolute_icon_name);
+		}
 		return g_variant_new_string(priv->icon_name ? priv->icon_name : "");
 	} else if (g_strcmp0(property, "AttentionIconName") == 0) {
+		if (priv->absolute_attention_icon_name) {
+			return g_variant_new_string(priv->absolute_attention_icon_name);
+		}
 		return g_variant_new_string(priv->attention_icon_name ? priv->attention_icon_name : "");
 	} else if (g_strcmp0(property, "Title") == 0) {
 		const gchar * output = NULL;
@@ -1205,6 +1233,9 @@
 		}
 		return g_variant_new_string(output);
 	} else if (g_strcmp0(property, "IconThemePath") == 0) {
+		if (priv->absolute_icon_theme_path) {
+			return g_variant_new_string(priv->absolute_icon_theme_path);
+		}
 		return g_variant_new_string(priv->icon_theme_path ? priv->icon_theme_path : "");
 	} else if (g_strcmp0(property, "Menu") == 0) {
 		if (priv->menuservice != NULL) {
@@ -1571,19 +1602,23 @@
 
 	/* add the icon_theme_path once if needed */
 	GtkIconTheme *icon_theme = gtk_icon_theme_get_default();
-	if (self->priv->icon_theme_path != NULL) {
+	const gchar *theme_path = self->priv->absolute_icon_theme_path ?
+	                            self->priv->absolute_icon_theme_path :
+	                            self->priv->icon_theme_path;
+
+	if (theme_path != NULL) {
 		gchar **path;
 		gint n_elements, i;
 		gboolean found=FALSE;
 		gtk_icon_theme_get_search_path(icon_theme, &path, &n_elements);
 		for (i=0; i< n_elements || path[i] == NULL; i++) {
-			if(g_strcmp0(path[i], self->priv->icon_theme_path) == 0) {
+			if(g_strcmp0(path[i], theme_path) == 0) {
 				found=TRUE;
 				break;
 			}
 		}
 		if(!found) {
-			gtk_icon_theme_append_search_path(icon_theme, self->priv->icon_theme_path);
+			gtk_icon_theme_append_search_path(icon_theme, theme_path);
 		}
 		g_strfreev (path);
 	}
@@ -1607,8 +1642,12 @@
 	};
 
 	if (icon_name != NULL) {
+		gchar *snapped_icon = append_snap_prefix(icon_name);
+
 		if (g_file_test(icon_name, G_FILE_TEST_EXISTS)) {
 			gtk_status_icon_set_from_file(icon, icon_name);
+		} else if (snapped_icon && g_file_test(snapped_icon, G_FILE_TEST_EXISTS)) {
+			gtk_status_icon_set_from_file(icon, snapped_icon);
 		} else {
 			gchar *longname = append_panel_icon_suffix(icon_name);
 
@@ -1620,6 +1659,8 @@
 
 			g_free(longname);
 		}
+
+		g_free(snapped_icon);
 	}
 
 	return;
@@ -1633,7 +1674,7 @@
 	GtkMenu * menu = app_indicator_get_menu(APP_INDICATOR(data));
 	if (menu == NULL)
 		return;
-	
+
 	gtk_menu_popup(menu,
 	               NULL, /* Parent Menu */
 	               NULL, /* Parent item */
@@ -1681,7 +1722,7 @@
            	long_name = g_strdup (icon_name);
         }
 
-	return long_name;	
+	return long_name;
 }
 
 static gboolean
@@ -1858,6 +1899,14 @@
 	if (g_strcmp0 (self->priv->attention_icon_name, icon_name) != 0) {
 		g_free (self->priv->attention_icon_name);
 		self->priv->attention_icon_name = g_strdup (icon_name);
+
+		g_free(self->priv->absolute_attention_icon_name);
+		self->priv->absolute_attention_icon_name = NULL;
+
+		if (icon_name && icon_name[0] == '/') {
+			self->priv->absolute_attention_icon_name = append_snap_prefix (icon_name);
+		}
+
 		changed = TRUE;
 	}
 
@@ -1933,6 +1982,14 @@
 		}
 
 		self->priv->icon_name = g_strdup(icon_name);
+
+		g_free(self->priv->absolute_icon_name);
+		self->priv->absolute_icon_name = NULL;
+
+		if (icon_name && icon_name[0] == '/') {
+			self->priv->absolute_icon_name = append_snap_prefix (icon_name);
+		}
+
 		changed = TRUE;
 	}
 
@@ -1994,6 +2051,54 @@
 	return;
 }
 
+static const gchar *
+get_snap_prefix ()
+{
+	const gchar *snap = g_getenv ("SNAP");
+	return (snap && *snap != '\0') ? snap : NULL;
+}
+
+static gchar *
+append_snap_prefix (const gchar *path)
+{
+	gchar real_path[PATH_MAX];
+	const gchar *snap = get_snap_prefix ();
+
+	if (snap != NULL && path != NULL) {
+		if (realpath (path, real_path) != NULL) {
+			path = real_path;
+		}
+
+		if (g_str_has_prefix (path, "/tmp/")) {
+			g_warning ("Using '/tmp' paths in SNAP environment will lead to unreadable resources");
+			return NULL;
+		}
+
+		if (g_str_has_prefix (path, snap)) {
+			return g_strdup (path);
+		}
+
+		return g_build_path (G_DIR_SEPARATOR_S, snap, path, NULL);
+	}
+
+	return NULL;
+}
+
+static gchar *
+get_real_theme_path (AppIndicator * self)
+{
+	const gchar *theme_path = self->priv->icon_theme_path;
+	gchar *snapped_path = append_snap_prefix (theme_path);
+
+	if (snapped_path != NULL) {
+		return snapped_path;
+	} else if (get_snap_prefix ()) {
+		return g_build_path (G_DIR_SEPARATOR_S, g_get_user_data_dir (), "icons", NULL);
+	}
+
+	return NULL;
+}
+
 /**
  * app_indicator_set_icon_theme_path:
  * @self: The #AppIndicator object to use
@@ -2012,9 +2117,15 @@
 
 		self->priv->icon_theme_path = g_strdup(icon_theme_path);
 
+		g_free (self->priv->absolute_icon_theme_path);
+		self->priv->absolute_icon_theme_path = get_real_theme_path (self);
+
 		g_signal_emit (self, signals[NEW_ICON_THEME_PATH], 0, self->priv->icon_theme_path, TRUE);
 
 		if (self->priv->dbus_registration != 0 && self->priv->connection != NULL) {
+			const gchar *theme_path = self->priv->absolute_icon_theme_path ?
+										self->priv->absolute_icon_theme_path :
+										self->priv->icon_theme_path;
 			GError * error = NULL;
 
 			g_dbus_connection_emit_signal(self->priv->connection,
@@ -2022,7 +2133,7 @@
 										  self->priv->path,
 										  NOTIFICATION_ITEM_DBUS_IFACE,
 										  "NewIconThemePath",
-										  g_variant_new("(s)", self->priv->icon_theme_path),
+										  g_variant_new("(s)", theme_path ? theme_path : ""),
 										  &error);
 
 			if (error != NULL) {