/**
* as_app_validate_screenshots:
**/
static void
as_app_validate_screenshots (AsApp *app, AsAppValidateHelper *helper)
{
AsScreenshot *ss;
GPtrArray *screenshots;
gboolean screenshot_has_default = FALSE;
guint number_screenshots_max = 5;
guint number_screenshots_min = 1;
guint i;
/* relax the requirements a bit */
if ((helper->flags & AS_APP_VALIDATE_FLAG_RELAX) > 0) {
number_screenshots_max = 10;
number_screenshots_min = 0;
}
/* metainfo doesn't require any screenshots */
if (as_app_get_source_kind (app) == AS_APP_SOURCE_KIND_METAINFO)
number_screenshots_min = 0;
/* only for AppData and AppStream */
if (as_app_get_source_kind (app) == AS_APP_SOURCE_KIND_DESKTOP)
return;
screenshots = as_app_get_screenshots (app);
if (screenshots->len < number_screenshots_min) {
ai_app_validate_add (helper->probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"Not enough <screenshot> tags");
}
if (screenshots->len > number_screenshots_max) {
ai_app_validate_add (helper->probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"Too many <screenshot> tags");
}
for (i = 0; i < screenshots->len; i++) {
ss = g_ptr_array_index (screenshots, i);
as_app_validate_screenshot (ss, helper);
if (as_screenshot_get_kind (ss) == AS_SCREENSHOT_KIND_DEFAULT) {
if (screenshot_has_default) {
ai_app_validate_add (helper->probs,
AS_PROBLEM_KIND_MARKUP_INVALID,
"<screenshot> has more than one default");
}
screenshot_has_default = TRUE;
continue;
}
}
if (screenshots->len > 0 && !screenshot_has_default) {
ai_app_validate_add (helper->probs,
AS_PROBLEM_KIND_MARKUP_INVALID,
"<screenshots> has no default <screenshot>");
}
}
/**
* as_app_validate_releases:
**/
static gboolean
as_app_validate_releases (AsApp *app, AsAppValidateHelper *helper, GError **error)
{
AsRelease *release;
GPtrArray *releases;
guint i;
/* only for AppData */
if (as_app_get_source_kind (app) != AS_APP_SOURCE_KIND_APPDATA)
return TRUE;
releases = as_app_get_releases (app);
if (releases->len > 10) {
ai_app_validate_add (helper->probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"Too many <release> tags");
}
for (i = 0; i < releases->len; i++) {
release = g_ptr_array_index (releases, i);
if (!as_app_validate_release (release, helper, error))
return FALSE;
}
return TRUE;
}
/**
* gs_appstream_refine_app:
*/
gboolean
gs_appstream_refine_app (GsPlugin *plugin,
GsApp *app,
AsApp *item,
GError **error)
{
AsRelease *rel;
GHashTable *urls;
GPtrArray *pkgnames;
GPtrArray *kudos;
const gchar *tmp;
guint i;
/* set the kind to be more precise */
if (gs_app_get_kind (app) == AS_APP_KIND_UNKNOWN ||
gs_app_get_kind (app) == AS_APP_KIND_GENERIC) {
gs_app_set_kind (app, as_app_get_kind (item));
}
/* is installed already */
if (gs_app_get_state (app) == AS_APP_STATE_UNKNOWN) {
switch (as_app_get_source_kind (item)) {
case AS_APP_SOURCE_KIND_APPDATA:
case AS_APP_SOURCE_KIND_DESKTOP:
gs_app_set_kind (app, AS_APP_KIND_DESKTOP);
gs_app_set_state (app, AS_APP_STATE_INSTALLED);
break;
case AS_APP_SOURCE_KIND_METAINFO:
gs_app_set_state (app, AS_APP_STATE_INSTALLED);
break;
case AS_APP_SOURCE_KIND_APPSTREAM:
gs_app_set_state (app, as_app_get_state (item));
break;
default:
break;
}
}
/* set management plugin automatically */
gs_refine_item_management_plugin (app, item);
/* set id */
if (as_app_get_id (item) != NULL && gs_app_get_id (app) == NULL)
gs_app_set_id (app, as_app_get_id (item));
/* set name */
tmp = as_app_get_name (item, NULL);
if (tmp != NULL) {
if (g_str_has_prefix (tmp, "(Nightly) ")) {
tmp += 10;
if (gs_app_get_metadata_item (app, "X-XdgApp-Tags") == NULL)
gs_app_set_metadata (app, "X-XdgApp-Tags", "nightly");
}
gs_app_set_name (app, GS_APP_QUALITY_HIGHEST, tmp);
}
/* set summary */
tmp = as_app_get_comment (item, NULL);
if (tmp != NULL) {
gs_app_set_summary (app, GS_APP_QUALITY_HIGHEST, tmp);
}
/* add urls */
urls = as_app_get_urls (item);
if (g_hash_table_size (urls) > 0 &&
gs_app_get_url (app, AS_URL_KIND_HOMEPAGE) == NULL) {
GList *l;
g_autoptr(GList) keys = NULL;
keys = g_hash_table_get_keys (urls);
for (l = keys; l != NULL; l = l->next) {
gs_app_set_url (app,
as_url_kind_from_string (l->data),
g_hash_table_lookup (urls, l->data));
}
}
/* set licence */
if (as_app_get_project_license (item) != NULL && gs_app_get_license (app) == NULL)
gs_app_set_license (app,
GS_APP_QUALITY_HIGHEST,
as_app_get_project_license (item));
/* set keywords */
if (as_app_get_keywords (item, NULL) != NULL &&
gs_app_get_keywords (app) == NULL) {
gs_app_set_keywords (app, as_app_get_keywords (item, NULL));
gs_app_add_kudo (app, GS_APP_KUDO_HAS_KEYWORDS);
}
/* set origin */
if (as_app_get_origin (item) != NULL &&
gs_app_get_origin (app) == NULL) {
gs_app_set_origin (app, as_app_get_origin (item));
}
/* set description */
tmp = as_app_get_description (item, NULL);
if (tmp != NULL) {
g_autofree gchar *from_xml = NULL;
from_xml = as_markup_convert_simple (tmp, error);
if (from_xml == NULL) {
g_prefix_error (error, "trying to parse '%s': ", tmp);
return FALSE;
}
gs_app_set_description (app, GS_APP_QUALITY_HIGHEST, from_xml);
}
/* set icon */
if (as_app_get_icon_default (item) != NULL && gs_app_get_pixbuf (app) == NULL)
gs_refine_item_pixbuf (plugin, app, item);
/* set categories */
if (as_app_get_categories (item) != NULL &&
gs_app_get_categories (app)->len == 0)
gs_app_set_categories (app, as_app_get_categories (item));
/* set project group */
if (as_app_get_project_group (item) != NULL &&
gs_app_get_project_group (app) == NULL)
gs_app_set_project_group (app, as_app_get_project_group (item));
/* this is a core application for the desktop and cannot be removed */
if (_as_app_has_compulsory_for_desktop (item, "GNOME") &&
gs_app_get_kind (app) == AS_APP_KIND_DESKTOP)
gs_app_add_quirk (app, AS_APP_QUIRK_COMPULSORY);
/* set id kind */
if (gs_app_get_kind (app) == AS_APP_KIND_UNKNOWN)
gs_app_set_kind (app, as_app_get_kind (item));
/* copy all the metadata */
gs_appstream_copy_metadata (app, item);
/* set package names */
pkgnames = as_app_get_pkgnames (item);
if (pkgnames->len > 0 && gs_app_get_sources(app)->len == 0)
gs_app_set_sources (app, pkgnames);
/* set addons */
gs_appstream_refine_add_addons (plugin, app, item);
/* set screenshots */
gs_appstream_refine_add_screenshots (app, item);
/* are the screenshots perfect */
if (gs_appstream_are_screenshots_perfect (item))
gs_app_add_kudo (app, GS_APP_KUDO_PERFECT_SCREENSHOTS);
/* was this application released recently */
if (gs_appstream_is_recent_release (item))
gs_app_add_kudo (app, GS_APP_KUDO_RECENT_RELEASE);
/* add kudos */
if (as_app_get_language (item, plugin->locale) > 50)
gs_app_add_kudo (app, GS_APP_KUDO_MY_LANGUAGE);
/* add new-style kudos */
kudos = as_app_get_kudos (item);
for (i = 0; i < kudos->len; i++) {
tmp = g_ptr_array_index (kudos, i);
switch (as_kudo_kind_from_string (tmp)) {
case AS_KUDO_KIND_SEARCH_PROVIDER:
gs_app_add_kudo (app, GS_APP_KUDO_SEARCH_PROVIDER);
break;
case AS_KUDO_KIND_USER_DOCS:
gs_app_add_kudo (app, GS_APP_KUDO_INSTALLS_USER_DOCS);
break;
case AS_KUDO_KIND_APP_MENU:
gs_app_add_kudo (app, GS_APP_KUDO_USES_APP_MENU);
break;
case AS_KUDO_KIND_MODERN_TOOLKIT:
gs_app_add_kudo (app, GS_APP_KUDO_MODERN_TOOLKIT);
break;
case AS_KUDO_KIND_NOTIFICATIONS:
gs_app_add_kudo (app, GS_APP_KUDO_USES_NOTIFICATIONS);
break;
case AS_KUDO_KIND_HIGH_CONTRAST:
gs_app_add_kudo (app, GS_APP_KUDO_HIGH_CONTRAST);
break;
case AS_KUDO_KIND_HI_DPI_ICON:
gs_app_add_kudo (app, GS_APP_KUDO_HI_DPI_ICON);
break;
default:
g_debug ("no idea how to handle kudo '%s'", tmp);
break;
}
}
/* is there any update information */
rel = as_app_get_release_default (item);
if (rel != NULL) {
tmp = as_release_get_description (rel, NULL);
if (tmp != NULL) {
g_autofree gchar *desc = NULL;
desc = as_markup_convert (tmp,
AS_MARKUP_CONVERT_FORMAT_MARKDOWN,
error);
if (desc == NULL)
return FALSE;
gs_app_set_update_details (app, desc);
}
gs_app_set_update_urgency (app, as_release_get_urgency (rel));
gs_app_set_update_version (app, as_release_get_version (rel));
}
return TRUE;
}
/**
* as_app_validate:
* @app: a #AsApp instance.
* @flags: the #AsAppValidateFlags to use, e.g. %AS_APP_VALIDATE_FLAG_NONE
* @error: A #GError or %NULL.
*
* Validates data in the instance for style and consitency.
*
* Returns: (transfer container) (element-type AsProblem): A list of problems, or %NULL
*
* Since: 0.1.4
**/
GPtrArray *
as_app_validate (AsApp *app, AsAppValidateFlags flags, GError **error)
{
AsAppProblems problems;
AsAppValidateHelper helper;
GError *error_local = NULL;
GHashTable *urls;
GList *l;
GPtrArray *probs = NULL;
const gchar *description;
const gchar *id_full;
const gchar *key;
const gchar *license;
const gchar *name;
const gchar *summary;
const gchar *tmp;
const gchar *update_contact;
gboolean deprectated_failure = FALSE;
gboolean require_contactdetails = TRUE;
gboolean require_copyright = FALSE;
gboolean require_project_license = FALSE;
gboolean require_translations = FALSE;
gboolean require_url = TRUE;
gboolean ret;
guint length_name_max = 30;
guint length_name_min = 3;
guint length_summary_max = 100;
guint length_summary_min = 8;
guint number_para_max = 4;
guint number_para_min = 2;
guint str_len;
_cleanup_list_free_ GList *keys = NULL;
/* relax the requirements a bit */
if ((flags & AS_APP_VALIDATE_FLAG_RELAX) > 0) {
length_name_max = 100;
length_summary_max = 200;
require_contactdetails = FALSE;
require_url = FALSE;
number_para_max = 10;
number_para_min = 1;
}
/* make the requirements more strict */
if ((flags & AS_APP_VALIDATE_FLAG_STRICT) > 0) {
deprectated_failure = TRUE;
require_copyright = TRUE;
require_translations = TRUE;
require_project_license = TRUE;
}
/* set up networking */
helper.probs = g_ptr_array_new_with_free_func ((GDestroyNotify) g_object_unref);
helper.screenshot_urls = g_ptr_array_new_with_free_func (g_free);
helper.flags = flags;
helper.previous_para_was_short = FALSE;
helper.para_chars_before_list = 0;
helper.number_paragraphs = 0;
ret = as_app_validate_setup_networking (&helper, error);
if (!ret)
goto out;
/* success, enough */
probs = helper.probs;
/* id */
ret = FALSE;
id_full = as_app_get_id_full (app);
switch (as_app_get_id_kind (app)) {
case AS_ID_KIND_DESKTOP:
if (g_str_has_suffix (id_full, ".desktop"))
ret = TRUE;
break;
case AS_ID_KIND_FONT:
if (g_str_has_suffix (id_full, ".ttf"))
ret = TRUE;
else if (g_str_has_suffix (id_full, ".otf"))
ret = TRUE;
break;
case AS_ID_KIND_INPUT_METHOD:
if (g_str_has_suffix (id_full, ".xml"))
ret = TRUE;
else if (g_str_has_suffix (id_full, ".db"))
ret = TRUE;
break;
case AS_ID_KIND_CODEC:
if (g_str_has_prefix (id_full, "gstreamer"))
ret = TRUE;
break;
case AS_ID_KIND_UNKNOWN:
ai_app_validate_add (probs,
AS_PROBLEM_KIND_ATTRIBUTE_INVALID,
"<id> has invalid type attribute");
break;
case AS_ID_KIND_ADDON:
/* anything goes */
ret = TRUE;
default:
break;
}
if (!ret) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_MARKUP_INVALID,
"<id> does not have correct extension for kind");
}
/* metadata_license */
license = as_app_get_metadata_license (app);
if (license != NULL) {
if (g_strcmp0 (license, "CC0-1.0") != 0 &&
g_strcmp0 (license, "CC-BY-3.0") != 0 &&
g_strcmp0 (license, "CC-BY-SA-3.0") != 0 &&
g_strcmp0 (license, "GFDL-1.3") != 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_INVALID,
"<metadata_license> is not valid");
}
}
if (license == NULL) {
switch (as_app_get_source_kind (app)) {
case AS_APP_SOURCE_KIND_APPDATA:
case AS_APP_SOURCE_KIND_METAINFO:
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_MISSING,
"<metadata_license> is not present");
break;
default:
break;
}
}
/* project_license */
license = as_app_get_project_license (app);
if (license != NULL) {
ret = as_app_validate_license (license, &error_local);
if (!ret) {
g_prefix_error (&error_local,
"<project_license> is not valid: ");
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_INVALID,
error_local->message);
g_clear_error (&error_local);
}
}
if (require_project_license && license == NULL) {
switch (as_app_get_source_kind (app)) {
case AS_APP_SOURCE_KIND_APPDATA:
case AS_APP_SOURCE_KIND_METAINFO:
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_MISSING,
"<project_license> is not present");
break;
default:
break;
}
}
/* updatecontact */
update_contact = as_app_get_update_contact (app);
if (g_strcmp0 (update_contact,
"someone_who_cares@upstream_project.org") == 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_INVALID,
"<update_contact> is still set to a dummy value");
}
if (update_contact != NULL && strlen (update_contact) < 6) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<update_contact> is too short");
}
if (require_contactdetails && update_contact == NULL) {
switch (as_app_get_source_kind (app)) {
case AS_APP_SOURCE_KIND_APPDATA:
case AS_APP_SOURCE_KIND_METAINFO:
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_MISSING,
"<updatecontact> is not present");
break;
default:
break;
}
}
/* only found for files */
problems = as_app_get_problems (app);
if (as_app_get_source_kind (app) == AS_APP_SOURCE_KIND_APPDATA ||
as_app_get_source_kind (app) == AS_APP_SOURCE_KIND_METAINFO) {
if ((problems & AS_APP_PROBLEM_NO_XML_HEADER) > 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_MARKUP_INVALID,
"<?xml> header not found");
}
if (require_copyright &&
(problems & AS_APP_PROBLEM_NO_COPYRIGHT_INFO) > 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_VALUE_MISSING,
"<!-- Copyright [year] [name] --> is not present");
}
}
/* check for things that have to exist */
if (as_app_get_id_full (app) == NULL) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_MISSING,
"<id> is not present");
}
/* url */
urls = as_app_get_urls (app);
keys = g_hash_table_get_keys (urls);
for (l = keys; l != NULL; l = l->next) {
key = l->data;
if (g_strcmp0 (key, "unknown") == 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_INVALID,
"<url> type invalid");
}
tmp = g_hash_table_lookup (urls, key);
if (!g_str_has_prefix (tmp, "http://") &&
!g_str_has_prefix (tmp, "https://")) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_INVALID,
"<url> does not start with 'http://'");
}
}
/* screenshots */
as_app_validate_screenshots (app, &helper);
/* releases */
ret = as_app_validate_releases (app, &helper, error);
if (!ret)
goto out;
/* name */
name = as_app_get_name (app, "C");
if (name != NULL) {
str_len = strlen (name);
if (str_len < length_name_min) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<name> is too short");
}
if (str_len > length_name_max) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<name> is too long");
}
if (ai_app_validate_fullstop_ending (name)) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<name> cannot end in '.'");
}
if (as_app_validate_has_hyperlink (name)) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<name> cannot contain a hyperlink");
}
}
/* comment */
summary = as_app_get_comment (app, "C");
if (summary != NULL) {
str_len = strlen (summary);
if (str_len < length_summary_min) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<summary> is too short");
}
if (str_len > length_summary_max) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<summary> is too long");
}
if (ai_app_validate_fullstop_ending (summary)) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<summary> cannot end in '.'");
}
if (as_app_validate_has_hyperlink (summary)) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<summary> cannot contain a hyperlink");
}
}
if (summary != NULL && name != NULL &&
strlen (summary) < strlen (name)) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<summary> is shorter than <name>");
}
description = as_app_get_description (app, "C");
if (description != NULL) {
ret = as_app_validate_description (description,
&helper,
number_para_min,
number_para_max,
&error_local);
if (!ret) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_MARKUP_INVALID,
error_local->message);
g_error_free (error_local);
}
}
if (require_translations) {
if (name != NULL &&
as_app_get_name_size (app) == 1 &&
(problems & AS_APP_PROBLEM_INTLTOOL_NAME) == 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED,
"<name> has no translations");
}
if (summary != NULL &&
as_app_get_comment_size (app) == 1 &&
(problems & AS_APP_PROBLEM_INTLTOOL_SUMMARY) == 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED,
"<summary> has no translations");
}
if (description != NULL &&
as_app_get_description_size (app) == 1 &&
(problems & AS_APP_PROBLEM_INTLTOOL_DESCRIPTION) == 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED,
"<description> has no translations");
}
}
/* using deprecated names */
if (deprectated_failure && (problems & AS_APP_PROBLEM_DEPRECATED_LICENCE) > 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_ATTRIBUTE_INVALID,
"<licence> is deprecated, use "
"<metadata_license> instead");
}
if ((problems & AS_APP_PROBLEM_MULTIPLE_ENTRIES) > 0) {
ai_app_validate_add (probs,
AS_PROBLEM_KIND_MARKUP_INVALID,
"<application> used more than once");
}
/* require homepage */
if (require_url && as_app_get_url_item (app, AS_URL_KIND_HOMEPAGE) == NULL) {
switch (as_app_get_source_kind (app)) {
case AS_APP_SOURCE_KIND_APPDATA:
case AS_APP_SOURCE_KIND_METAINFO:
ai_app_validate_add (probs,
AS_PROBLEM_KIND_TAG_MISSING,
"<url> is not present");
break;
default:
break;
}
}
out:
g_ptr_array_unref (helper.screenshot_urls);
if (helper.session != NULL)
g_object_unref (helper.session);
return probs;
}
