Backport all-categories-invalid to appstream

org.flatpak.Builder.json

@@ -396,6 +396,12 @@
                             "type": "archive",
                             "url": "https://github.com/ximion/appstream/archive/refs/tags/v1.0.1.tar.gz",
                             "sha256": "3a6877c887627aed515e9802f63ac7bd83fffab4c2cad33c809c692c4bd8da48"
+                        },
+                        {
+                            "type": "patch",
+                            "paths": [
+                                "patches/appstream-all-categories-invalid.patch"
+                            ]
                         }
                     ],
                     "modules": [

patches/appstream-all-categories-invalid.patch

@@ -0,0 +1,145 @@
+From b14319907e7ea3c9ff927c44a88c1bed254f6881 Mon Sep 17 00:00:00 2001
+From: Matthias Klumpp <[email protected]>
+Date: Thu, 4 Jan 2024 05:12:24 +0100
+Subject: [PATCH] validator: Improve error message if no valid categories were
+ found
+
+---
+ src/as-utils-private.h       |  2 ++
+ src/as-utils.c               | 50 ++++++++++++++++++++++++++++++++++++
+ src/as-validator-issue-tag.h |  6 +++++
+ src/as-validator.c           | 16 ++++++++++--
+ 4 files changed, 72 insertions(+), 2 deletions(-)
+
+diff --git a/src/as-utils-private.h b/src/as-utils-private.h
+index 82c2685b..424a79f1 100644
+--- a/src/as-utils-private.h
++++ b/src/as-utils-private.h
+@@ -120,6 +120,8 @@ void as_ref_string_assign_transfer (GRefString **rstr_ptr, GRefString *new_rstr)
+ AS_INTERNAL_VISIBLE
+ gboolean as_utils_extract_tarball (const gchar *filename, const gchar *target_dir, GError **error);
+
++gboolean as_utils_category_name_is_bad (const gchar *category_name);
++
+ gboolean as_utils_is_platform_triplet_arch (const gchar *arch);
+ gboolean as_utils_is_platform_triplet_oskernel (const gchar *os);
+ gboolean as_utils_is_platform_triplet_osenv (const gchar *env);
+diff --git a/src/as-utils.c b/src/as-utils.c
+index 6bf85926..e4a6d2c1 100644
+--- a/src/as-utils.c
++++ b/src/as-utils.c
+@@ -1316,6 +1316,56 @@ as_utils_is_category_name (const gchar *category_name)
+ 	return g_strstr_len (g_bytes_get_data (data, NULL), -1, key) != NULL;
+ }
+
++/**
++ * as_utils_category_name_is_bad:
++ * @category_name: a XDG category name, e.g. "ProjectManagement"
++ *
++ * We want to ignore certain low-quality categories like "GTK", "Qt"
++ * or "GUI" that convey no meaning to the user at all,
++ * as well as any custom-defined categories.
++ *
++ * This functiuon checks for those, adn should be used in
++ * conjunction with %as_utils_is_category_name.
++ *
++ * It is not invalid to use the categories in desktop-entry files,
++ * but they should not end up in AppStream catalog metadata, and
++ * should ideally not be used in MetaInfo files as well.
++ *
++ * Returns: %TRUE if the category should be ignored.
++ **/
++gboolean
++as_utils_category_name_is_bad (const gchar *category_name)
++{
++	if (as_str_equal0 (category_name, "GTK"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "Qt"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "KDE"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "GNOME"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "Motif"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "Java"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "GUI"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "Application"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "XFCE"))
++		return TRUE;
++	if (as_str_equal0 (category_name, "DDE"))
++		return TRUE;
++
++	/* we want to ignore custom categories */
++	if (g_str_has_prefix (category_name, "X-"))
++		return TRUE;
++	if (g_str_has_prefix (category_name, "x-"))
++		return TRUE;
++
++	return FALSE;
++}
++
+ /**
+  * as_utils_is_tld:
+  * @tld: a top-level domain without dot, e.g. "de", "org", "name"
+diff --git a/src/as-validator-issue-tag.h b/src/as-validator-issue-tag.h
+index 3c40c016..28c6a093 100644
+--- a/src/as-validator-issue-tag.h
++++ b/src/as-validator-issue-tag.h
+@@ -743,6 +743,12 @@ AsValidatorIssueTag as_validator_issue_tag_list[] =  {
+ 	  N_("The category name is not valid. Refer to the XDG Menu Specification for a list of valid category names."),
+ 	},
+
++	{ "all-categories-ignored",
++	  AS_ISSUE_SEVERITY_WARNING,
++	  N_("All categories for this component have been ignored, either because they were invalid or because they are of low quality "
++	     "(e.g. custom 'X-' prefixed or toolkit ones like 'GTK' or 'Qt'). Please fix your category names, or add more categories."),
++	},
++
+ 	{ "app-categories-missing",
+ 	  AS_ISSUE_SEVERITY_ERROR,
+ 	  N_("This component is in no valid categories, even though it should be. Please check its metainfo file and desktop-entry file."),
+diff --git a/src/as-validator.c b/src/as-validator.c
+index f09d191e..3424a6e4 100644
+--- a/src/as-validator.c
++++ b/src/as-validator.c
+@@ -3398,11 +3398,11 @@ as_validator_validate_component_node (AsValidator *validator, AsContext *ctx, xm
+
+ 	/* validate categories */
+ 	if (as_component_get_categories (cpt)->len > 0) {
+-		guint j;
+ 		GPtrArray *cat_array;
++		gboolean have_valid_category = FALSE;
+
+ 		cat_array = as_component_get_categories (cpt);
+-		for (j = 0; j < cat_array->len; j++) {
++		for (guint j = 0; j < cat_array->len; j++) {
+ 			const gchar *category_name = (const gchar *) g_ptr_array_index (cat_array,
+ 											j);
+
+@@ -3411,7 +3411,19 @@ as_validator_validate_component_node (AsValidator *validator, AsContext *ctx, xm
+ 							NULL,
+ 							"category-invalid",
+ 							category_name);
++				continue;
+ 			}
++
++			/* check if the category would be ignored during catalog composition */
++			if (as_utils_category_name_is_bad (category_name))
++				continue;
++
++			have_valid_category = TRUE;
++		}
++
++		if (!have_valid_category) {
++			/* the user clearly intended there to be categories, yet we ended up with no valid ones */
++			as_validator_add_issue (validator, NULL, "all-categories-ignored", NULL);
+ 		}
+ 	}
+
+-- 
+2.43.0
+