Merge lp:~ted/ubuntu-app-launch/triplet-app-name into lp:ubuntu-app-launch/14.04

[Ted Gould]

Add application list handling to the triplet function

This brings the triplet function here up to parity with the URL dispatcher one so that URL dispatcher can depend on this function.

[lp:~ted/ubuntu-app-launch/triplet-app-name]

117. By Ted Gould on 2014-01-29

Add documentation for application listing

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:116
http://jenkins.qa.ubuntu.com/job/upstart-app-launch-ci/219/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-trusty-amd64-ci/78
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-trusty-armhf-ci/78
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-trusty-i386-ci/79

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:117
http://jenkins.qa.ubuntu.com/job/upstart-app-launch-ci/220/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-trusty-amd64-ci/79
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-trusty-armhf-ci/79
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-trusty-i386-ci/80

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

review: Approve (continuous-integration)

[Charles Kerr (charlesk)]

So you're migrating the code from url-dispatcher to upstart-app-launch so that both can use the same implementation instead of reinventing the wheel? Nice job.

review: Approve

=== modified file 'libupstart-app-launch/upstart-app-launch.c'
--- libupstart-app-launch/upstart-app-launch.c	2014-01-14 20:52:13 +0000
+++ libupstart-app-launch/upstart-app-launch.c	2014-01-29 02:34:09 +0000
@@ -698,7 +698,7 @@
 }
 
 /* Try and get a manifest file and do a couple sanity checks on it */
-JsonParser *
+static JsonParser *
 get_manifest_file (const gchar * pkg)
 {
 	/* Get the directory from click */
@@ -753,20 +753,88 @@
 	return parser;
 }
 
+/* Types of search we can do for an app name */
+typedef enum _app_name_t app_name_t;
+enum _app_name_t {
+	APP_NAME_ONLY,
+	APP_NAME_FIRST,
+	APP_NAME_LAST
+};
+
+/* Figure out the app name if it's one of the keywords */
+static const gchar *
+manifest_app_name (JsonParser ** manifest, const gchar * pkg, const gchar * original_app)
+{
+	app_name_t app_type = APP_NAME_FIRST;
+
+	if (original_app == NULL) {
+		/* first */
+	} else if (g_strcmp0(original_app, "first-listed-app") == 0) {
+		/* first */
+	} else if (g_strcmp0(original_app, "last-listed-app") == 0) {
+		app_type = APP_NAME_LAST;
+	} else if (g_strcmp0(original_app, "only-listed-app") == 0) {
+		app_type = APP_NAME_ONLY;
+	} else {
+		return original_app;
+	}
+
+	if (*manifest == NULL) {
+		*manifest = get_manifest_file(pkg);
+	}
+
+	JsonNode * root_node = json_parser_get_root(*manifest);
+	JsonObject * root_obj = json_node_get_object(root_node);
+	JsonObject * hooks = json_object_get_object_member(root_obj, "hooks");
+
+	if (hooks == NULL) {
+		return NULL;
+	}
+
+	GList * apps = json_object_get_members(hooks);
+	if (apps == NULL) {
+		return NULL;
+	}
+
+	const gchar * retapp = NULL;
+
+	switch (app_type) {
+	case APP_NAME_ONLY:
+		if (g_list_length(apps) == 1) {
+			retapp = (const gchar *)apps->data;
+		}
+		break;
+	case APP_NAME_FIRST:
+		retapp = (const gchar *)apps->data;
+		break;
+	case APP_NAME_LAST:
+		retapp = (const gchar *)(g_list_last(apps)->data);
+		break;
+	default:
+		break;
+	}
+
+	g_list_free(apps);
+
+	return retapp;
+}
+
 /* Figure out the app version using the manifest */
-gchar *
-manifest_version (const gchar * pkg, const gchar * original_ver)
+static const gchar *
+manifest_version (JsonParser ** manifest, const gchar * pkg, const gchar * original_ver)
 {
-	if (g_strcmp0(original_ver, "current-user-version") != 0) {
-		return g_strdup(original_ver);
+	if (original_ver != NULL && g_strcmp0(original_ver, "current-user-version") != 0) {
+		return original_ver;
 	} else  {
-		JsonParser * manifest = get_manifest_file(pkg);
-		g_return_val_if_fail(manifest != NULL, NULL);
-		JsonNode * node = json_parser_get_root(manifest);
+		if (*manifest == NULL) {
+			*manifest = get_manifest_file(pkg);
+		}
+		g_return_val_if_fail(*manifest != NULL, NULL);
+
+		JsonNode * node = json_parser_get_root(*manifest);
 		JsonObject * obj = json_node_get_object(node);
-		gchar * ret = g_strdup(json_object_get_string_member(obj, "version"));
-		g_object_unref(manifest);
-		return ret;
+
+		return g_strdup(json_object_get_string_member(obj, "version"));
 	}
 
 	return NULL;
@@ -775,8 +843,22 @@
 gchar *
 upstart_app_launch_triplet_to_app_id (const gchar * pkg, const gchar * app, const gchar * ver)
 {
-	gchar * version = NULL;
-	version = manifest_version(pkg, ver);
+	g_return_val_if_fail(pkg != NULL, NULL);
+
+	const gchar * version = NULL;
+	const gchar * application = NULL;
+	JsonParser * manifest = NULL;
+
+	version = manifest_version(&manifest, pkg, ver);
 	g_return_val_if_fail(version != NULL, NULL);
-	return g_strdup_printf("%s_%s_%s", pkg, app, version);
+
+	application = manifest_app_name(&manifest, pkg, app);
+	g_return_val_if_fail(application != NULL, NULL);
+
+	gchar * retval = g_strdup_printf("%s_%s_%s", pkg, application, version);
+
+	/* The parser may hold allocation for some of our strings used above */
+	g_clear_object(&manifest);
+
+	return retval;
 }

=== modified file 'libupstart-app-launch/upstart-app-launch.h'
--- libupstart-app-launch/upstart-app-launch.h	2014-01-13 15:16:24 +0000
+++ libupstart-app-launch/upstart-app-launch.h	2014-01-29 02:34:09 +0000
@@ -274,13 +274,21 @@
 /**
  * upstart_app_launch_triplet_to_app_id:
  * @pkg: Click package name
- * @app: Application name
- * @version: Specific version or "current-user-version"
- *
- * Constructs an appid from pkg, app, version triple.
+ * @app: (allow-none): Application name, see description
+ * @version: (allow-none): Specific version or wildcard, see description
+ *
+ * Constructs an appid from pkg, app, version triple.  Wildcards are allowed
+ * for the @app and @version parameters.
+ *
+ * For the @app parameter the wildcards * "first-listed-app", "last-listed-app"
+ * and "only-listed-app" can be used.  A NULL value will default to the
+ * first listed app.
+ *
+ * For the @version parameter only one wildcard is allowed, "current-user-version".
+ * If NULL is passed that is the default.
  *
  * Return Value: Either the properly constructed @appid or NULL if it failed 
- *     to find the version installed.
+ *     to construct it.
  */
 gchar *     upstart_app_launch_triplet_to_app_id        (const gchar *                     pkg,
                                                          const gchar *                     app,

=== added file 'tests/click-app-dir/.click/info/com.test.multiple.manifest'
--- tests/click-app-dir/.click/info/com.test.multiple.manifest	1970-01-01 00:00:00 +0000
+++ tests/click-app-dir/.click/info/com.test.multiple.manifest	2014-01-29 02:34:09 +0000
@@ -0,0 +1,20 @@
+{
+	"version": "1.2.3",
+	"hooks": {
+		"first": {
+			"desktop": "application.desktop"
+		},
+		"second": {
+			"desktop": "application.desktop"
+		},
+		"third": {
+			"desktop": "application.desktop"
+		},
+		"fourth": {
+			"desktop": "application.desktop"
+		},
+		"fifth": {
+			"desktop": "application.desktop"
+		}
+	}
+}

=== modified file 'tests/libual-test.cc'
--- tests/libual-test.cc	2014-01-14 18:03:03 +0000
+++ tests/libual-test.cc	2014-01-29 02:34:09 +0000
@@ -288,9 +288,29 @@
 TEST_F(LibUAL, ApplicationId)
 {
 	/* Test with current-user-version, should return the version in the manifest */
-	ASSERT_STREQ(upstart_app_launch_triplet_to_app_id("com.test.good", "application", "current-user-version"), "com.test.good_application_1.2.3");
+	EXPECT_STREQ("com.test.good_application_1.2.3", upstart_app_launch_triplet_to_app_id("com.test.good", "application", "current-user-version"));
+
 	/* Test with version specified, shouldn't even read the manifest */
-	ASSERT_STREQ(upstart_app_launch_triplet_to_app_id("com.test.good", "application", "1.2.4"), "com.test.good_application_1.2.4");
+	EXPECT_STREQ("com.test.good_application_1.2.4", upstart_app_launch_triplet_to_app_id("com.test.good", "application", "1.2.4"));
+
+	/* Test with out a version or app, should return the version in the manifest */
+	EXPECT_STREQ("com.test.good_application_1.2.3", upstart_app_launch_triplet_to_app_id("com.test.good", "first-listed-app", "current-user-version"));
+
+	/* Test with a version or but wildcard app, should return the version in the manifest */
+	EXPECT_STREQ("com.test.good_application_1.2.4", upstart_app_launch_triplet_to_app_id("com.test.good", "last-listed-app", "1.2.4"));
+
+	/* Make sure we can select the app from a list correctly */
+	EXPECT_STREQ("com.test.multiple_first_1.2.3", upstart_app_launch_triplet_to_app_id("com.test.multiple", "first-listed-app", NULL));
+	EXPECT_STREQ("com.test.multiple_first_1.2.3", upstart_app_launch_triplet_to_app_id("com.test.multiple", NULL, NULL));
+	EXPECT_STREQ("com.test.multiple_fifth_1.2.3", upstart_app_launch_triplet_to_app_id("com.test.multiple", "last-listed-app", NULL));
+	EXPECT_EQ(nullptr, upstart_app_launch_triplet_to_app_id("com.test.multiple", "only-listed-app", NULL));
+	EXPECT_STREQ("com.test.good_application_1.2.3", upstart_app_launch_triplet_to_app_id("com.test.good", "only-listed-app", NULL));
+
+	/* A bunch that should be NULL */
+	EXPECT_EQ(nullptr, upstart_app_launch_triplet_to_app_id("com.test.no-hooks", NULL, NULL));
+	EXPECT_EQ(nullptr, upstart_app_launch_triplet_to_app_id("com.test.no-json", NULL, NULL));
+	EXPECT_EQ(nullptr, upstart_app_launch_triplet_to_app_id("com.test.no-object", NULL, NULL));
+	EXPECT_EQ(nullptr, upstart_app_launch_triplet_to_app_id("com.test.no-version", NULL, NULL));
 }
 
 TEST_F(LibUAL, ApplicationList)