Add appstream-compose

This is a simple app that takes a prefix (default /usr) and a set of
app names. It looks for appdata, desktop and icon files with that
basename in $prefix/share/[appdata|applications|icons] and generates
appstream xml files + icons in (by default) $prefix/share/app-info.

3 files changed, 575 insertions, 1 deletions

diff --git a/client/Makefile.am b/client/Makefile.am
index dc04134..8777c11 100644
--- a/client/Makefile.am
+++ b/client/Makefile.am
@@ -21,6 +21,7 @@ AS_BUILDER_LIBS =					\
 	$(top_builddir)/libappstream-builder/libappstream-builder.la
 
 bin_PROGRAMS =						\
+	appstream-compose				\
 	appstream-util
 
 if HAVE_BUILDER
@@ -57,4 +58,16 @@ appstream_builder_CFLAGS =				\
 	$(WARNINGFLAGS_C)
 endif
 
+appstream_compose_SOURCES =				\
+	as-compose.c
+appstream_compose_LDADD =				\
+	$(AS_GLIB_LIBS)					\
+	$(GLIB_LIBS)					\
+	$(SOUP_LIBS)					\
+	$(LIBARCHIVE_LIBS)
+appstream_compose_LDFLAGS =				\
+	$(PIE_LDFLAGS)
+appstream_compose_CFLAGS =				\
+	$(WARNINGFLAGS_C)
+
 -include $(top_srcdir)/git.mk
diff --git a/client/as-compose.c b/client/as-compose.c
new file mode 100644
index 0000000..2dd08ca
--- /dev/null
+++ b/client/as-compose.c
@@ -0,0 +1,561 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2014-2015 Richard Hughes <richard@hughsie.com>
+ * Copyright (C) 2016 Alexander Larsson <alexl@redhat.com>
+ *
+ * Licensed under the GNU General Public License Version 2
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+
+#include <appstream-glib.h>
+#include <glib.h>
+#include <glib/gi18n.h>
+#include <stdlib.h>
+#include <locale.h>
+#include <errno.h>
+
+/**
+ * as_util_app_log:
+ **/
+G_GNUC_PRINTF (2, 3)
+static void
+as_compose_app_log (AsApp *app, const gchar *fmt, ...)
+{
+	const gchar *id;
+	guint i;
+	va_list args;
+	g_autofree gchar *tmp = NULL;
+
+	va_start (args, fmt);
+	tmp = g_strdup_vprintf (fmt, args);
+	va_end (args);
+
+	/* print status */
+	id = as_app_get_id (app);
+	g_print ("%s: ", id);
+	for (i = strlen (id) + 2; i < 35; i++)
+		g_print (" ");
+	g_print ("%s\n", tmp);
+}
+
+
+static GdkPixbuf *
+load_icon (AsApp *app,
+	   const gchar *filename,
+	   const gchar *logfn,
+	   guint icon_size,
+	   guint min_icon_size,
+	   GError **error)
+{
+	GdkPixbuf *pixbuf = NULL;
+	guint pixbuf_height;
+	guint pixbuf_width;
+	guint tmp_height;
+	guint tmp_width;
+	g_autoptr(GdkPixbuf) pixbuf_src = NULL;
+	g_autoptr(GdkPixbuf) pixbuf_tmp = NULL;
+
+	/* open file in native size */
+	if (g_str_has_suffix (filename, ".svg")) {
+		pixbuf_src = gdk_pixbuf_new_from_file_at_scale (filename,
+								icon_size,
+								icon_size,
+								TRUE, error);
+	} else {
+		pixbuf_src = gdk_pixbuf_new_from_file (filename, error);
+	}
+	if (pixbuf_src == NULL)
+		return NULL;
+
+	/* check size */
+	if (gdk_pixbuf_get_width (pixbuf_src) < (gint) min_icon_size &&
+	    gdk_pixbuf_get_height (pixbuf_src) < (gint) min_icon_size) {
+		g_set_error (error,
+			     AS_APP_ERROR,
+			     AS_APP_ERROR_FAILED,
+			     "icon %s was too small %ix%i",
+			     logfn,
+			     gdk_pixbuf_get_width (pixbuf_src),
+			     gdk_pixbuf_get_height (pixbuf_src));
+		return NULL;
+	}
+
+	/* does the icon not have an alpha channel */
+	if (!gdk_pixbuf_get_has_alpha (pixbuf_src)) {
+		as_compose_app_log (app, 
+				    "icon %s does not have an alpha channel",
+				    logfn);
+	}
+
+	/* don't do anything to an icon with the perfect size */
+	pixbuf_width = gdk_pixbuf_get_width (pixbuf_src);
+	pixbuf_height = gdk_pixbuf_get_height (pixbuf_src);
+	if (pixbuf_width == icon_size && pixbuf_height == icon_size)
+		return g_object_ref (pixbuf_src);
+
+	/* never scale up, just pad */
+	if (pixbuf_width < icon_size && pixbuf_height < icon_size) {
+		g_autofree gchar *size_str = NULL;
+		size_str = g_strdup_printf ("%ix%i",
+					    pixbuf_width,
+					    pixbuf_height);
+		as_compose_app_log (app, "icon %s padded to %ix%i as size %s",
+				    logfn, icon_size, icon_size, size_str);
+		pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, TRUE, 8,
+					 icon_size, icon_size);
+		gdk_pixbuf_fill (pixbuf, 0x00000000);
+		gdk_pixbuf_copy_area (pixbuf_src,
+				      0, 0, /* of src */
+				      pixbuf_width, pixbuf_height,
+				      pixbuf,
+				      (icon_size - pixbuf_width) / 2,
+				      (icon_size - pixbuf_height) / 2);
+		return pixbuf;
+	}
+
+	/* is the aspect ratio perfectly square */
+	if (pixbuf_width == pixbuf_height) {
+		pixbuf = gdk_pixbuf_scale_simple (pixbuf_src,
+						  icon_size, icon_size,
+						  GDK_INTERP_HYPER);
+		/* TODO: private: as_pixbuf_sharpen (pixbuf, 1, -0.5); */
+		return pixbuf;
+	}
+
+	/* create new square pixbuf with alpha padding */
+	pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, TRUE, 8,
+				 icon_size, icon_size);
+	gdk_pixbuf_fill (pixbuf, 0x00000000);
+	if (pixbuf_width > pixbuf_height) {
+		tmp_width = icon_size;
+		tmp_height = icon_size * pixbuf_height / pixbuf_width;
+	} else {
+		tmp_width = icon_size * pixbuf_width / pixbuf_height;
+		tmp_height = icon_size;
+	}
+	pixbuf_tmp = gdk_pixbuf_scale_simple (pixbuf_src, tmp_width, tmp_height,
+					      GDK_INTERP_HYPER);
+	/* TODO: private: as_pixbuf_sharpen (pixbuf_tmp, 1, -0.5); */
+	gdk_pixbuf_copy_area (pixbuf_tmp,
+			      0, 0, /* of src */
+			      tmp_width, tmp_height,
+			      pixbuf,
+			      (icon_size - tmp_width) / 2,
+			      (icon_size - tmp_height) / 2);
+	return pixbuf;
+}
+
+static gboolean
+add_icons (AsApp *app,
+	   const gchar *icons_dir,
+	   guint min_icon_size,
+	   const gchar *prefix,
+	   const gchar *key,
+	   GError **error)
+{
+	g_autofree gchar *fn_hidpi = NULL;
+	g_autofree gchar *fn = NULL;
+	g_autofree gchar *name_hidpi = NULL;
+	g_autofree gchar *name = NULL;
+	g_autofree gchar *icon_path = NULL;
+	g_autofree gchar *icon_subdir = NULL;
+	g_autofree gchar *icon_path_hidpi = NULL;
+	g_autofree gchar *icon_subdir_hidpi = NULL;
+	g_autoptr(AsIcon) icon_hidpi = NULL;
+	g_autoptr(AsIcon) icon = NULL;
+	g_autoptr(GdkPixbuf) pixbuf_hidpi = NULL;
+	g_autoptr(GdkPixbuf) pixbuf = NULL;
+
+	/* find 64x64 icon */
+	fn = as_utils_find_icon_filename_full (prefix, key,
+					       AS_UTILS_FIND_ICON_NONE,
+					       error);
+	if (fn == NULL) {
+		g_prefix_error (error, "Failed to find icon: ");
+		return FALSE;
+	}
+
+	/* load the icon */
+	pixbuf = load_icon (app, fn, fn + strlen (prefix),
+			    64, min_icon_size, error);
+	if (pixbuf == NULL) {
+		g_prefix_error (error, "Failed to load icon: ");
+		return FALSE;
+	}
+
+	/* save in target directory */
+	name = g_strdup_printf ("%ix%i/%s.png",
+				64, 64,
+				as_app_get_id_filename (AS_APP (app)));
+
+	icon = as_icon_new ();
+	as_icon_set_pixbuf (icon, pixbuf);
+	as_icon_set_name (icon, name);
+	as_icon_set_kind (icon, AS_ICON_KIND_CACHED);
+	as_icon_set_prefix (icon, as_app_get_icon_path (AS_APP (app)));
+	as_app_add_icon (AS_APP (app), icon);
+
+	icon_path = g_build_filename (icons_dir, name, NULL);
+
+	icon_subdir = g_path_get_dirname (icon_path);	
+	if (g_mkdir_with_parents (icon_subdir, 0755)) {
+		int errsv = errno;
+		g_print ("%s: %s\n", _("Error icon output dir"), strerror (errsv));
+		return EXIT_FAILURE;
+	}
+	
+	g_print ("saving %s\n", icon_path);
+	if (!gdk_pixbuf_save (pixbuf, icon_path, "png", error, NULL))
+		return FALSE;
+	
+	/* try to get a HiDPI icon */
+	fn_hidpi = as_utils_find_icon_filename_full (prefix, key,
+						     AS_UTILS_FIND_ICON_HI_DPI,
+						     NULL);
+	if (fn_hidpi == NULL)
+		return TRUE;
+
+	/* load the HiDPI icon */
+	pixbuf_hidpi = load_icon (app, fn_hidpi,
+				  fn_hidpi + strlen (prefix),
+				  128, 128, NULL);
+	if (pixbuf_hidpi == NULL)
+		return TRUE;
+	if (gdk_pixbuf_get_width (pixbuf_hidpi) <= gdk_pixbuf_get_width (pixbuf) ||
+	    gdk_pixbuf_get_height (pixbuf_hidpi) <= gdk_pixbuf_get_height (pixbuf))
+		return TRUE;
+	as_app_add_kudo_kind (AS_APP (app), AS_KUDO_KIND_HI_DPI_ICON);
+
+	/* save icon */
+	name_hidpi = g_strdup_printf ("%ix%i/%s.png",
+				      128, 128,
+				      as_app_get_id_filename (AS_APP (app)));
+	icon_hidpi = as_icon_new ();
+	as_icon_set_pixbuf (icon_hidpi, pixbuf_hidpi);
+	as_icon_set_name (icon_hidpi, name_hidpi);
+	as_icon_set_kind (icon_hidpi, AS_ICON_KIND_CACHED);
+	as_icon_set_prefix (icon_hidpi, as_app_get_icon_path (AS_APP (app)));
+	as_app_add_icon (AS_APP (app), icon_hidpi);
+
+	icon_path_hidpi = g_build_filename (icons_dir, name_hidpi, NULL);
+	icon_subdir_hidpi = g_path_get_dirname (icon_path_hidpi);	
+	if (g_mkdir_with_parents (icon_subdir_hidpi, 0755)) {
+		int errsv = errno;
+		g_print ("%s: %s\n", _("Error icon output dir"), strerror (errsv));
+		return EXIT_FAILURE;
+	}
+	
+	g_print ("saving %s\n", icon_path_hidpi);
+	if (!gdk_pixbuf_save (pixbuf_hidpi, icon_path_hidpi, "png", error, NULL))
+		return FALSE;
+	return TRUE;
+}
+
+static AsApp *
+load_desktop (const gchar *prefix,
+	      const gchar *icons_dir,
+	      guint        min_icon_size,
+	      const gchar *app_name,
+	      const gchar *appdata_id,
+	      GError **error)
+{
+	g_autofree char *desktop_basename = NULL;
+	g_autofree char *desktop_path = NULL;
+	g_autoptr(AsApp) app = NULL;
+	AsIcon *icon;
+
+	if (appdata_id != NULL)
+		desktop_basename = g_strdup (appdata_id);
+	else
+		desktop_basename = g_strconcat (app_name, ".desktop", NULL);
+	
+	desktop_path = g_build_filename (prefix, "share/applications", desktop_basename, NULL);
+
+	app = as_app_new ();
+
+	if (!as_app_parse_file (app, desktop_path,
+				AS_APP_PARSE_FLAG_USE_HEURISTICS |
+				AS_APP_PARSE_FLAG_ALLOW_VETO,
+				error))
+		return NULL;
+
+	if (as_app_get_id_kind (app) == AS_ID_KIND_UNKNOWN) {
+		g_set_error (error,
+			     AS_APP_ERROR,
+			     AS_APP_ERROR_FAILED,
+			     "%s has no recognised type",
+			     as_app_get_id (AS_APP (app)));
+		return NULL;
+	}
+
+	icon = as_app_get_icon_default (AS_APP (app));
+	if (icon != NULL) {
+		g_autofree gchar *key = NULL;
+		key = g_strdup (as_icon_get_name (icon));
+		if (as_icon_get_kind (icon) == AS_ICON_KIND_STOCK) {
+			as_compose_app_log (app,
+					    "using stock icon %s", key);
+		} else {
+			g_autoptr(GError) error_local = NULL;
+			gboolean ret;
+
+			g_ptr_array_set_size (as_app_get_icons (AS_APP (app)), 0);
+			ret = add_icons (app,
+					 icons_dir, min_icon_size,
+					 prefix,
+					 key,
+					 &error_local);
+			if (!ret) {
+				as_app_add_veto (AS_APP (app), "%s",
+						 error_local->message);
+			}
+		}
+	}
+
+	
+	return g_steal_pointer (&app);
+}
+
+static AsApp *
+load_appdata (const gchar *prefix, const gchar *app_name, GError **error)
+{
+	g_autofree char *appdata_basename = g_strconcat (app_name, ".appdata.xml", NULL);
+	g_autofree char *appdata_path = g_build_filename (prefix, "share/appdata", appdata_basename, NULL);
+	g_autoptr(AsApp) app = NULL;
+	g_autoptr(GPtrArray) problems = NULL;
+	AsProblemKind problem_kind;
+	AsProblem *problem;
+	const gchar *tmp;
+	guint i;
+
+	g_debug ("Looking for %s\n", appdata_path);
+
+	app = as_app_new ();
+
+	if (!as_app_parse_file (app, appdata_path,
+				AS_APP_PARSE_FLAG_NONE,
+				error))
+		return NULL;
+
+	if (as_app_get_id_kind (app) == AS_ID_KIND_UNKNOWN) {
+		g_set_error (error,
+			     AS_APP_ERROR,
+			     AS_APP_ERROR_FAILED,
+			     "%s has no recognised type",
+			     as_app_get_id (AS_APP (app)));
+		return NULL;
+	}
+
+	problems = as_app_validate (app,
+				    AS_APP_VALIDATE_FLAG_NO_NETWORK |
+				    AS_APP_VALIDATE_FLAG_RELAX,
+				    error);
+	if (problems == NULL)
+		return NULL;
+	for (i = 0; i < problems->len; i++) {
+		problem = g_ptr_array_index (problems, i);
+		problem_kind = as_problem_get_kind (problem);
+		as_compose_app_log (app,
+				    "AppData problem: %s : %s",
+				    as_problem_kind_to_string (problem_kind),
+				    as_problem_get_message (problem));
+	}
+
+	/* check license */
+	tmp = as_app_get_metadata_license (app);
+	if (tmp == NULL) {
+		g_set_error (error,
+			     AS_APP_ERROR,
+			     AS_APP_ERROR_FAILED,
+			     "AppData %s has no licence",
+			     appdata_path);
+		return NULL;
+	}
+	if (!as_utils_is_spdx_license (tmp)) {
+		g_set_error (error,
+			     AS_APP_ERROR,
+			     AS_APP_ERROR_FAILED,
+			     "AppData %s license '%s' invalid",
+			     appdata_path, tmp);
+		return NULL;
+	}
+	
+
+	/* check project group */
+	tmp = as_app_get_project_group (app);
+	if (tmp != NULL) {
+		if (!as_utils_is_environment_id (tmp)) {
+			as_compose_app_log (app,
+					    "AppData project group invalid, "
+					    "so ignoring: %s", tmp);
+			as_app_set_project_group (AS_APP (app), NULL);
+		}
+	}
+
+	return g_steal_pointer (&app);
+}
+
+/**
+ * main:
+ **/
+int
+main (int argc, char **argv)
+{
+	g_autoptr(GOptionContext) option_context = NULL;
+	gboolean ret;
+	gboolean verbose = FALSE;
+	g_autoptr(GError) error = NULL;
+	g_autofree gchar *basename = NULL;
+	g_autofree gchar *icons_dir = NULL;
+	g_autofree gchar *origin = NULL;
+	g_autofree gchar *xml_basename = NULL;
+	g_autofree gchar *output_dir = NULL;
+	g_autofree gchar *prefix = NULL;
+	g_autoptr(AsStore) store = NULL;
+	g_autoptr(GFile) xml_dir = NULL;
+	g_autoptr(GFile) xml_file = NULL;
+	gint min_icon_size = 32;
+	gdouble api_version = 0.0f;
+	guint i;
+	const GOptionEntry options[] = {
+		{ "verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose,
+			/* TRANSLATORS: command line option */
+			_("Show extra debugging information"), NULL },
+		{ "prefix", '\0', 0, G_OPTION_ARG_FILENAME, &prefix,
+			/* TRANSLATORS: command line option */
+			_("Set the temporary directory"), "DIR" },
+		{ "output-dir", '\0', 0, G_OPTION_ARG_FILENAME, &output_dir,
+			/* TRANSLATORS: command line option */
+			_("Set the output directory"), "DIR" },
+		{ "icons-dir", '\0', 0, G_OPTION_ARG_FILENAME, &icons_dir,
+			/* TRANSLATORS: command line option */
+			_("Set the icons directory"), "DIR" },
+		{ "origin", '\0', 0, G_OPTION_ARG_STRING, &origin,
+			/* TRANSLATORS: command line option */
+			_("Set the origin name"), "NAME" },
+		{ "min-icon-size", '\0', 0, G_OPTION_ARG_INT, &min_icon_size,
+			/* TRANSLATORS: command line option */
+			_("Set the minimum icon size in pixels"), "ICON_SIZE" },
+		{ "basename", '\0', 0, G_OPTION_ARG_STRING, &basename,
+			/* TRANSLATORS: command line option */
+			_("Set the basenames of the output files"), "NAME" },
+		{ "api-version", '\0', 0, G_OPTION_ARG_DOUBLE, &api_version,
+			/* TRANSLATORS: command line option */
+			_("Set the AppStream version"), "API_VERSION" },
+		{ NULL}
+	};
+
+	setlocale (LC_ALL, "");
+	bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
+	bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
+	textdomain (GETTEXT_PACKAGE);
+	option_context = g_option_context_new (" - APP-IDS");
+
+	g_option_context_add_main_entries (option_context, options, NULL);
+	ret = g_option_context_parse (option_context, &argc, &argv, &error);
+	if (!ret) {
+		/* TRANSLATORS: error message */
+		g_print ("%s: %s\n", _("Failed to parse arguments"), error->message);
+		return EXIT_FAILURE;
+	}
+
+	if (verbose)
+		g_setenv ("G_MESSAGES_DEBUG", "all", TRUE);
+
+	/* set defaults */
+	if (api_version < 0.01)
+		api_version = 0.8;
+	if (prefix == NULL)
+		prefix = g_strdup ("/usr");
+	if (output_dir == NULL)
+		output_dir = g_build_filename (prefix, "share/app-info/xmls", NULL);
+	if (icons_dir == NULL)
+		icons_dir = g_build_filename (prefix, "share/app-info/icons", origin, NULL);
+	if (basename == NULL)
+		basename = g_strdup (origin);
+	if (origin == NULL) {
+		g_print ("WARNING: Metadata origin not set, using 'example'\n");
+		origin = g_strdup ("example");
+	}
+
+
+	if (argc == 1) {
+		g_autofree gchar *tmp = NULL;
+		tmp = g_option_context_get_help (option_context, TRUE, NULL);
+		g_print ("%s", tmp);
+		return  EXIT_FAILURE;
+	}
+
+	store = as_store_new ();
+	as_store_set_api_version (store, 0.8);
+	as_store_set_origin (store, origin);
+	
+	for (i = 1; i < (guint) argc; i++) {
+		const char *app_name = argv[i];
+		g_autoptr(AsApp) app = NULL;
+		g_autoptr(AsApp) desktop_app = NULL;
+
+		g_print ("processing %s\n", app_name);
+
+		app = load_appdata (prefix, app_name, &error);
+		if (app == NULL) {
+			g_print ("%s: %s\n", _("Error loading appdata"), error->message);
+			return EXIT_FAILURE;
+		}
+
+		desktop_app = load_desktop (prefix, icons_dir, min_icon_size,
+					    app_name, as_app_get_id (app), &error);
+		if (desktop_app == NULL) {
+			g_print ("%s: %s\n", _("Error loading desktop file"), error->message);
+			return EXIT_FAILURE;
+		}
+
+		/* copy all metadata */
+		as_app_subsume_full (app, desktop_app,
+				     AS_APP_SUBSUME_FLAG_NO_OVERWRITE);
+
+		as_store_add_app (store, app);
+	}
+
+	if (g_mkdir_with_parents (output_dir, 0755)) {
+		int errsv = errno;
+		g_print ("%s: %s\n", _("Error creating output dir"), strerror (errsv));
+		return EXIT_FAILURE;
+	}
+	
+	xml_dir = g_file_new_for_path (output_dir);
+	xml_basename = g_strconcat (basename, ".xml.gz", NULL);
+	xml_file = g_file_get_child (xml_dir, xml_basename);
+	g_print ("saving to %s\n", g_file_get_path (xml_file));
+	if (!as_store_to_file (store,
+			       xml_file,
+			       AS_NODE_TO_XML_FLAG_FORMAT_MULTILINE |
+			       AS_NODE_TO_XML_FLAG_FORMAT_INDENT |
+			       AS_NODE_TO_XML_FLAG_ADD_HEADER,
+			       NULL, &error)) {
+			g_print ("%s: %s\n", _("Error saving appstream"), error->message);
+			return EXIT_FAILURE;
+	}
+
+	
+	/* success */
+	/* TRANSLATORS: information message */
+	g_print ("%s\n", _("Done!"));
+
+	return EXIT_SUCCESS;
+}
diff --git a/libappstream-glib/as-utils.c b/libappstream-glib/as-utils.c
index 45a5b5f..92213db 100644
--- a/libappstream-glib/as-utils.c
+++ b/libappstream-glib/as-utils.c
@@ -1178,7 +1178,7 @@ as_utils_find_icon_filename_full (const gchar *destdir,
 	prefix = g_strdup_printf ("%s/usr", destdir);
 	if (!g_file_test (prefix, G_FILE_TEST_EXISTS)) {
 		g_free (prefix);
-		prefix = g_strdup_printf ("%s/files", destdir);
+		prefix = g_strdup (destdir);
 	}
 	if (!g_file_test (prefix, G_FILE_TEST_EXISTS)) {
 		g_set_error (error,