Merge lp:~ted/ubuntu-app-launch/libual-desktop-file into lp:ubuntu-app-launch/15.10

[Ted Gould]

Provide an API to find the desktop file and directory of an AppID

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:207
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~ted/ubuntu-app-launch/libual-desktop-file/+merge/267287/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/ubuntu-app-launch-ci/17/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-app-launch-wily-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-app-launch-wily-armhf-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-app-launch-wily-i386-ci/17

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-app-launch-ci/17/rebuild

review: Needs Fixing (continuous-integration)

[Renato Araujo Oliveira Filho (renatofilho)]

looks good to me.

review: Approve

=== modified file 'debian/libubuntu-app-launch2.symbols'
--- debian/libubuntu-app-launch2.symbols	2015-06-04 20:35:57 +0000
+++ debian/libubuntu-app-launch2.symbols	2015-08-12 02:52:44 +0000
@@ -1,5 +1,6 @@
 libubuntu-app-launch.so.2 libubuntu-app-launch2 #MINVER#
  ubuntu_app_launch_app_id_parse@Base 0.4
+ ubuntu_app_launch_application_info@Base 0replaceme
  ubuntu_app_launch_application_log_path@Base 0.4
  ubuntu_app_launch_get_primary_pid@Base 0.4
  ubuntu_app_launch_helper_set_exec@Base 0.5+15.10.20150604
 
=== modified file 'libubuntu-app-launch/app-info.c'
--- libubuntu-app-launch/app-info.c	2015-08-12 02:52:44 +0000
+++ libubuntu-app-launch/app-info.c	2015-08-12 02:52:44 +0000
@@ -24,8 +24,8 @@
 #include "app-info.h"
 
 /* Try and get a manifest and do a couple sanity checks on it */
-static JsonObject *
-get_manifest (const gchar * pkg)
+JsonObject *
+get_manifest (const gchar * pkg, gchar ** pkgpath)
 {
 	/* Get the directory from click */
 	GError * error = NULL;
@@ -55,6 +55,16 @@
 		g_object_unref(user);
 		return NULL;
 	}
+
+	if (pkgpath != NULL) {
+		*pkgpath = click_user_get_path(user, pkg, &error);
+		if (error != NULL) {
+			g_warning("Unable to get the Click package directory for %s: %s", pkg, error->message);
+			g_error_free(error);
+			g_object_unref(user);
+			return NULL;
+		}
+	}
 	g_object_unref(user);
 
 	if (!json_object_has_member(manifest, "version")) {
@@ -93,7 +103,7 @@
 	}
 
 	if (*manifest == NULL) {
-		*manifest = get_manifest(pkg);
+		*manifest = get_manifest(pkg, NULL);
 	}
 
 	JsonObject * hooks = json_object_get_object_member(*manifest, "hooks");
@@ -138,7 +148,7 @@
 		return original_ver;
 	} else  {
 		if (*manifest == NULL) {
-			*manifest = get_manifest(pkg);
+			*manifest = get_manifest(pkg, NULL);
 		}
 		g_return_val_if_fail(*manifest != NULL, NULL);
 
@@ -190,6 +200,53 @@
 	}
 }
 
+/* Look to see if the app id results in a desktop file, if so, fill in the params */
+static gboolean
+evaluate_dir (const gchar * dir, const gchar * desktop, gchar ** appdir, gchar ** appdesktop)
+{
+	char * fulldir = g_build_filename(dir, "applications", desktop, NULL);
+	gboolean found = FALSE;
+
+	if (g_file_test(fulldir, G_FILE_TEST_EXISTS)) {
+		if (appdir != NULL) {
+			*appdir = g_strdup(dir);
+		}
+
+		if (appdesktop != NULL) {
+			*appdesktop = g_strdup_printf("applications/%s", desktop);
+		}
+
+		found = TRUE;
+	}
+
+	g_free(fulldir);
+	return found;
+}
+
+/* Handle the legacy case where we look through the data directories */
+gboolean
+app_info_legacy (const gchar * appid, gchar ** appdir, gchar ** appdesktop)
+{
+	gchar * desktop = g_strdup_printf("%s.desktop", appid);
+
+	/* Special case the user's dir */
+	if (evaluate_dir(g_get_user_data_dir(), desktop, appdir, appdesktop)) {
+		g_free(desktop);
+		return TRUE;
+	}
+
+	const char * const * data_dirs = g_get_system_data_dirs();
+	int i;
+	for (i = 0; data_dirs[i] != NULL; i++) {
+		if (evaluate_dir(data_dirs[i], desktop, appdir, appdesktop)) {
+			g_free(desktop);
+			return TRUE;
+		}
+	}
+
+	return FALSE;
+}
+
 /* Handle the libertine case where we look in the container */
 gboolean
 app_info_libertine (const gchar * appid, gchar ** appdir, gchar ** appdesktop)
@@ -225,21 +282,73 @@
 		}
 	}
 
+	if (appdir != NULL) {
+		*appdir = desktopdir;
+	} else {
+		g_free(desktopdir);
+	}
+
+	if (appdesktop != NULL) {
+		*appdesktop = g_build_filename("applications", desktopname, NULL);
+	}
+
+	g_free(desktopfile);
 	g_free(desktopname);
 	g_free(container);
 	g_free(app);
 
-	if (appdir != NULL) {
-		*appdir = desktopdir;
-	} else {
-		g_free(desktopdir);
-	}
+	return TRUE;
+}
+
+/* Get the information on where the desktop file is from libclick */
+gboolean
+app_info_click (const gchar * appid, gchar ** appdir, gchar ** appdesktop)
+{
+	gchar * package = NULL;
+	gchar * application = NULL;
+
+	if (!ubuntu_app_launch_app_id_parse(appid, &package, &application, NULL)) {
+		return FALSE;
+	}
+
+	JsonObject * manifest = get_manifest(package, appdir);
+	if (manifest == NULL) {
+		g_free(package);
+		g_free(application);
+		return FALSE;
+	}
+
+	g_free(package);
 
 	if (appdesktop != NULL) {
-		*appdesktop = desktopfile;
+		JsonObject * hooks = json_object_get_object_member(manifest, "hooks");
+		if (hooks == NULL) {
+			json_object_unref(manifest);
+			g_free(application);
+			return FALSE;
+		}
+
+		JsonObject * appobj = json_object_get_object_member(hooks, application);
+		g_free(application);
+
+		if (appobj == NULL) {
+			json_object_unref(manifest);
+			return FALSE;
+		}
+
+		const gchar * desktop = json_object_get_string_member(appobj, "desktop");
+		if (desktop == NULL) {
+			json_object_unref(manifest);
+			return FALSE;
+		}
+
+		*appdesktop = g_strdup(desktop);
 	} else {
-		g_free(desktopfile);
+		g_free(application);
 	}
 
+	json_object_unref(manifest);
+
 	return TRUE;
 }
+
 
=== modified file 'libubuntu-app-launch/app-info.h'
--- libubuntu-app-launch/app-info.h	2015-08-12 02:52:44 +0000
+++ libubuntu-app-launch/app-info.h	2015-08-12 02:52:44 +0000
@@ -21,7 +21,9 @@
 
 #include <glib.h>
 
+gboolean app_info_legacy (const gchar * appid, gchar ** appdir, gchar ** appdesktop);
 gboolean app_info_libertine (const gchar * appid, gchar ** appdir, gchar ** appdesktop);
+gboolean app_info_click (const gchar * appid, gchar ** appdir, gchar ** appdesktop);
 
 gchar * click_triplet_to_app_id (const gchar * pkg, const gchar * app, const gchar * ver);
 gchar * libertine_triplet_to_app_id (const gchar * pkg, const gchar * app, const gchar * ver);
 
=== modified file 'libubuntu-app-launch/desktop-exec.c'
--- libubuntu-app-launch/desktop-exec.c	2015-08-12 02:52:44 +0000
+++ libubuntu-app-launch/desktop-exec.c	2015-08-12 02:52:44 +0000
@@ -80,28 +80,34 @@
 keyfile_for_libertine (const gchar * appid, gchar ** outcontainer)
 {
 	gchar * desktopfile = NULL;
+	gchar * desktopdir = NULL;
 
-	if (!app_info_libertine(appid, NULL, &desktopfile)) {
+	if (!app_info_libertine(appid, &desktopdir, &desktopfile)) {
 		return NULL;
 	}
 
+	gchar * desktopfull = g_build_filename(desktopdir, desktopfile, NULL);
+	g_debug("Desktop full: %s", desktopfull);
+	g_free(desktopdir);
+	g_free(desktopfile);
+
 	/* We now think we have a valid 'desktopfile' path */
 	GKeyFile * keyfile = g_key_file_new();
-	gboolean loaded = g_key_file_load_from_file(keyfile, desktopfile, G_KEY_FILE_NONE, NULL);
+	gboolean loaded = g_key_file_load_from_file(keyfile, desktopfull, G_KEY_FILE_NONE, NULL);
 
 	if (!loaded) {
-		g_free(desktopfile);
-		g_key_file_free(keyfile);
-		return NULL;
-	}
-
-	if (!verify_keyfile(keyfile, desktopfile)) {
-		g_free(desktopfile);
-		g_key_file_free(keyfile);
-		return NULL;
-	}
-
-	g_free(desktopfile);
+		g_free(desktopfull);
+		g_key_file_free(keyfile);
+		return NULL;
+	}
+
+	if (!verify_keyfile(keyfile, desktopfull)) {
+		g_free(desktopfull);
+		g_key_file_free(keyfile);
+		return NULL;
+	}
+
+	g_free(desktopfull);
 
 	if (outcontainer != NULL) {
 		ubuntu_app_launch_app_id_parse(appid, outcontainer, NULL, NULL);
 
=== modified file 'libubuntu-app-launch/ubuntu-app-launch.c'
--- libubuntu-app-launch/ubuntu-app-launch.c	2015-08-12 02:52:44 +0000
+++ libubuntu-app-launch/ubuntu-app-launch.c	2015-08-12 02:52:44 +0000
@@ -748,6 +748,18 @@
 	return path;
 }
 
+gboolean
+ubuntu_app_launch_application_info (const gchar * appid, gchar ** appdir, gchar ** appdesktop)
+{
+	if (is_click(appid)) {
+		return app_info_click(appid, appdir, appdesktop);
+	} else if (is_libertine(appid)) {
+		return app_info_libertine(appid, appdir, appdesktop);
+	} else {
+		return app_info_legacy(appid, appdir, appdesktop);
+	}
+}
+
 static GDBusConnection *
 gdbus_upstart_ref (void) {
 	static GDBusConnection * gdbus_upstart = NULL;
 
=== modified file 'libubuntu-app-launch/ubuntu-app-launch.h'
--- libubuntu-app-launch/ubuntu-app-launch.h	2015-06-04 20:22:27 +0000
+++ libubuntu-app-launch/ubuntu-app-launch.h	2015-08-12 02:52:44 +0000
@@ -142,6 +142,22 @@
 gchar *    ubuntu_app_launch_application_log_path     (const gchar *                     appid);
 
 /**
+ * ubuntu_app_launch_application_info:
+ * @appid: ID of the application
+ * @appdir: (allow-none) (transfer full): Directory for the application
+ * @appdesktop: (allow-none) (transfer full): Relative path to desktop file
+ *
+ * Finds a location for information on an application and the relative
+ * directory that it was found in. So this should be used to find icons
+ * relating to that desktop file.
+ *
+ * Return value: Path to a log file or NULL if unavailable
+ */
+gboolean   ubuntu_app_launch_application_info         (const gchar *                     appid,
+                                                       gchar **                          appdir,
+                                                       gchar **                          appdesktop);
+
+/**
  * ubuntu_app_launch_observer_add_app_starting:
  * @observer: (scope notified): Callback when an application is about to start
  * @user_data: (closure) (allow-none): Data to pass to the observer
 
=== modified file 'tests/libual-test.cc'
--- tests/libual-test.cc	2015-08-12 02:52:44 +0000
+++ tests/libual-test.cc	2015-08-12 02:52:44 +0000
@@ -1627,3 +1627,45 @@
 
 	ASSERT_TRUE(dbus_test_dbus_mock_object_clear_method_calls(mock, obj, NULL));
 }
+
+TEST_F(LibUAL, AppInfo)
+{
+	g_setenv("TEST_CLICK_DB", "click-db-dir", TRUE);
+	g_setenv("TEST_CLICK_USER", "test-user", TRUE);
+
+	char * dir = nullptr;
+	char * file = nullptr;
+
+	/* Basics */
+	EXPECT_TRUE(ubuntu_app_launch_application_info("com.test.good_application_1.2.3", nullptr, nullptr));
+	EXPECT_FALSE(ubuntu_app_launch_application_info("com.test.bad_not-app_1.3.3.7", nullptr, nullptr));
+	EXPECT_FALSE(ubuntu_app_launch_application_info(nullptr, nullptr, nullptr));
+
+	/* Ensure false doesn't set the values */
+	EXPECT_FALSE(ubuntu_app_launch_application_info("com.test.bad_not-app_1.3.3.7", &dir, &file));
+	EXPECT_EQ(nullptr, dir);
+	EXPECT_EQ(nullptr, file);
+	g_clear_pointer(&dir, g_free);
+	g_clear_pointer(&file, g_free);
+
+	/* Correct values from a click */
+	EXPECT_TRUE(ubuntu_app_launch_application_info("com.test.good_application_1.2.3", &dir, &file));
+	EXPECT_STREQ(CMAKE_SOURCE_DIR "/click-root-dir/.click/users/test-user/com.test.good", dir);
+	EXPECT_STREQ("application.desktop", file);
+	g_clear_pointer(&dir, g_free);
+	g_clear_pointer(&file, g_free);
+
+	/* Correct values from a legacy */
+	EXPECT_TRUE(ubuntu_app_launch_application_info("bar", &dir, &file));
+	EXPECT_STREQ(CMAKE_SOURCE_DIR, dir);
+	EXPECT_STREQ("applications/bar.desktop", file);
+	g_clear_pointer(&dir, g_free);
+	g_clear_pointer(&file, g_free);
+
+	/* Correct values for libertine */
+	EXPECT_TRUE(ubuntu_app_launch_application_info("container-name_test_0.0", &dir, &file));
+	EXPECT_STREQ(CMAKE_SOURCE_DIR "/libertine-data/libertine-container/container-name/rootfs/usr/share", dir);
+	EXPECT_STREQ("applications/test.desktop", file);
+	g_clear_pointer(&dir, g_free);
+	g_clear_pointer(&file, g_free);
+}