/** * as_app_builder_search_translations: * @app: an #AsApp * @prefix: a prefix to search, e.g. "/usr" * @min_percentage: minimum percentage to add language * @flags: #AsAppBuilderFlags, e.g. %AS_APP_BUILDER_FLAG_USE_FALLBACKS * @cancellable: a #GCancellable or %NULL * @error: a #GError or %NULL * * Searches a prefix for languages, and using a heuristic adds <language> * tags to the specified application. * * If there are no #AsTranslation objects set on the #AsApp then all domains * are matched, which may include more languages than you intended to. * * @min_percentage sets the minimum percentage to add a language tag. * The usual value would be 25% and any language less complete than * this will not be added. * * The purpose of this functionality is to avoid blowing up the size * of the AppStream metadata with a lot of extra data detailing * languages with very few translated strings. * * Returns: %TRUE for success * * Since: 0.5.8 **/ gboolean as_app_builder_search_translations (AsApp *app, const gchar *prefix, guint min_percentage, AsAppBuilderFlags flags, GCancellable *cancellable, GError **error) { AsAppBuilderEntry *e; GList *l; g_autoptr(AsAppBuilderContext) ctx = NULL; ctx = as_app_builder_ctx_new (); ctx->translations = as_app_get_translations (app); /* search for QT .qm files */ if (!as_app_builder_search_translations_qt (ctx, prefix, flags, error)) return FALSE; /* search for gettext .mo files */ if (!as_app_builder_search_translations_gettext (ctx, prefix, flags, error)) return FALSE; /* search for Google .pak files */ if (!as_app_builder_search_translations_pak (ctx, prefix, flags, error)) return FALSE; /* calculate percentages */ for (l = ctx->data; l != NULL; l = l->next) { e = l->data; e->percentage = MIN (e->nstrings * 100 / ctx->max_nstrings, 100); } /* sort */ ctx->data = g_list_sort (ctx->data, as_app_builder_entry_sort_cb); /* add results */ for (l = ctx->data; l != NULL; l = l->next) { e = l->data; if (e->percentage < min_percentage) continue; as_app_add_language (app, (gint) e->percentage, e->locale); } 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 consistency. * * Returns: (transfer container) (element-type AsProblem): A list of problems, or %NULL * * Since: 0.1.4 **/ GPtrArray * as_app_validate (AsApp *app, guint32 flags, GError **error) { AsAppProblems problems; AsFormat *format; GError *error_local = NULL; GHashTable *urls; GList *l; const gchar *description; const gchar *key; const gchar *license; const gchar *name; const gchar *summary; const gchar *tmp; const gchar *update_contact; gboolean deprecated_failure = FALSE; gboolean require_appstream_spec_only = FALSE; gboolean require_contactdetails = FALSE; gboolean require_copyright = FALSE; gboolean require_description = FALSE; gboolean require_project_license = FALSE; gboolean require_sentence_case = FALSE; gboolean require_translations = FALSE; gboolean require_url = TRUE; gboolean require_content_license = TRUE; gboolean require_name = TRUE; gboolean require_translation = FALSE; gboolean require_content_rating = FALSE; gboolean require_name_shorter_than_summary = FALSE; gboolean validate_license = TRUE; gboolean ret; guint length_name_max = 60; guint length_name_min = 3; guint length_summary_max = 200; guint length_summary_min = 8; guint number_para_max = 10; guint number_para_min = 1; guint str_len; g_autoptr(GList) keys = NULL; g_autoptr(AsAppValidateHelper) helper = g_new0 (AsAppValidateHelper, 1); /* has to be set */ format = as_app_get_format_default (app); if (format == NULL) { g_set_error_literal (error, AS_APP_ERROR, AS_APP_ERROR_FAILED, "cannot validate without at least one format"); return NULL; } /* only for desktop and console apps */ if (as_app_get_kind (app) == AS_APP_KIND_DESKTOP || as_app_get_kind (app) == AS_APP_KIND_CONSOLE) { require_content_rating = TRUE; require_description = TRUE; } /* relax the requirements a bit */ if ((flags & AS_APP_VALIDATE_FLAG_RELAX) > 0) { length_name_max = 100; length_summary_max = 200; require_content_license = FALSE; validate_license = FALSE; require_url = FALSE; number_para_max = 20; number_para_min = 1; require_sentence_case = FALSE; require_content_rating = FALSE; switch (as_format_get_kind (format)) { case AS_FORMAT_KIND_METAINFO: case AS_FORMAT_KIND_APPDATA: require_name = FALSE; break; default: break; } } /* make the requirements more strict */ if ((flags & AS_APP_VALIDATE_FLAG_STRICT) > 0) { deprecated_failure = TRUE; require_copyright = TRUE; require_translations = TRUE; require_project_license = TRUE; require_content_license = TRUE; require_appstream_spec_only = TRUE; require_sentence_case = TRUE; require_name_shorter_than_summary = TRUE; require_contactdetails = TRUE; require_translation = TRUE; number_para_min = 2; number_para_max = 4; } /* addons don't need such a long description */ switch (as_format_get_kind (format)) { case AS_FORMAT_KIND_METAINFO: case AS_FORMAT_KIND_APPDATA: number_para_min = 1; break; default: break; } /* set up networking */ helper->app = app; 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; if (!as_app_validate_setup_networking (helper, error)) return NULL; /* invalid component type */ if (as_app_get_kind (app) == AS_APP_KIND_UNKNOWN) { ai_app_validate_add (helper, AS_PROBLEM_KIND_ATTRIBUTE_INVALID, "<component> has invalid type attribute"); } as_app_validate_check_id (helper, as_app_get_id (app)); /* metadata_license */ license = as_app_get_metadata_license (app); if (license != NULL) { if (require_content_license && !as_app_validate_is_content_license (license)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<metadata_license> is not valid [%s]", license); } else if (validate_license) { if (!as_app_validate_license (license, &error_local)) { g_prefix_error (&error_local, "<metadata_license> is not valid [%s]", license); ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "%s", error_local->message); g_clear_error (&error_local); } } } if (license == NULL) { switch (as_format_get_kind (format)) { case AS_FORMAT_KIND_APPDATA: case AS_FORMAT_KIND_METAINFO: ai_app_validate_add (helper, 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 && validate_license) { if (!as_app_validate_license (license, &error_local)) { g_prefix_error (&error_local, "<project_license> is not valid [%s]", license); ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "%s", error_local->message); g_clear_error (&error_local); } } if (require_project_license && license == NULL) { switch (as_format_get_kind (format)) { case AS_FORMAT_KIND_APPDATA: case AS_FORMAT_KIND_METAINFO: ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<project_license> is not present"); break; default: break; } } /* categories */ if (as_format_get_kind (format) == AS_FORMAT_KIND_APPSTREAM && as_app_get_kind (app) == AS_APP_KIND_DESKTOP) { GPtrArray *categories = as_app_get_categories (app); guint nr_toplevel_cats = 0; const gchar *cats[] = { "AudioVideo", "Development", "Education", "Game", "Graphics", "Network", "Office", "Science", "Settings", "System", "Utility", NULL }; for (guint i = 0; i < categories->len; i++) { const gchar *cat = g_ptr_array_index (categories, i); for (guint j = 0; cats[j] != NULL; j++) { if (g_strcmp0 (cats[j], cat) == 0) nr_toplevel_cats++; } } if (nr_toplevel_cats == 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<category> must include main categories " "from the desktop entry spec"); } else if (nr_toplevel_cats > 3) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "too many main <category> types: %u", nr_toplevel_cats); } } /* translation */ if (require_translation && as_format_get_kind (format) == AS_FORMAT_KIND_APPDATA && as_app_get_translations (app)->len == 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<translation> not specified"); } /* pkgname */ if (as_app_get_pkgname_default (app) != NULL && as_format_get_kind (format) == AS_FORMAT_KIND_METAINFO) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<pkgname> not allowed in metainfo"); } /* appdata */ if (as_format_get_kind (format) == AS_FORMAT_KIND_APPDATA && as_app_get_kind (app) == AS_APP_KIND_DESKTOP) { AsIcon *icon = as_app_get_icon_default (app); if (icon != NULL && as_icon_get_kind (icon) != AS_ICON_KIND_REMOTE) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<icon> not allowed in desktop appdata"); } } /* extends */ if (as_app_get_extends(app)->len == 0 && as_app_get_kind (app) == AS_APP_KIND_ADDON && as_format_get_kind (format) == AS_FORMAT_KIND_METAINFO) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<extends> is not present"); } /* update_contact */ update_contact = as_app_get_update_contact (app); if (g_strcmp0 (update_contact, "someone_who_cares@upstream_project.org") == 0) { ai_app_validate_add (helper, 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 (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<update_contact> is too short [%s]", update_contact); } if (require_contactdetails && update_contact == NULL) { switch (as_format_get_kind (format)) { case AS_FORMAT_KIND_APPDATA: case AS_FORMAT_KIND_METAINFO: ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<update_contact> is not present"); break; default: break; } } /* only found for files */ problems = as_app_get_problems (app); if (as_format_get_kind (format) == AS_FORMAT_KIND_APPDATA || as_format_get_kind (format) == AS_FORMAT_KIND_METAINFO) { if ((problems & AS_APP_PROBLEM_NO_XML_HEADER) > 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_MARKUP_INVALID, "<?xml> header not found"); } if (require_copyright && (problems & AS_APP_PROBLEM_NO_COPYRIGHT_INFO) > 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_VALUE_MISSING, "<!-- Copyright [year] [name] --> is not present"); } if (deprecated_failure && (problems & AS_APP_PROBLEM_UPDATECONTACT_FALLBACK) > 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<updatecontact> should be <update_contact>"); } } /* check invalid values */ if ((problems & AS_APP_PROBLEM_INVALID_PROJECT_GROUP) > 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<project_group> is not valid"); } /* only allow XML in the specification */ if (require_appstream_spec_only && (problems & AS_APP_PROBLEM_INVALID_XML_TAG) > 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "XML data contains unknown tag"); } /* only allow XML in the specification */ if (problems & AS_APP_PROBLEM_EXPECTED_CHILDREN) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "Expected children for tag"); } /* only allow XML in the specification */ if (problems & AS_APP_PROBLEM_INVALID_KEYWORDS) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<keyword> invalid contents"); } /* releases all have to have unique versions */ if (problems & AS_APP_PROBLEM_DUPLICATE_RELEASE) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<release> version was duplicated"); } if (problems & AS_APP_PROBLEM_DUPLICATE_SCREENSHOT) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<screenshot> content was duplicated"); } if (problems & AS_APP_PROBLEM_DUPLICATE_CONTENT_RATING) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<content_rating> was duplicated"); } /* check for things that have to exist */ if (as_app_get_id (app) == NULL) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<id> is not present"); } /* games require a content rating */ if (require_content_rating) { GPtrArray *ratings = as_app_get_content_ratings (app); if (ratings->len == 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<content_rating> required " "[use https://odrs.gnome.org/oars]"); } } /* 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 (helper, AS_PROBLEM_KIND_TAG_INVALID, "<url> type invalid [%s]", key); } tmp = g_hash_table_lookup (urls, key); if (tmp == NULL || tmp[0] == '\0') continue; if (!g_str_has_prefix (tmp, "http://") && !g_str_has_prefix (tmp, "https://")) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_INVALID, "<url> does not start with 'http://' [%s]", tmp); } } /* screenshots */ as_app_validate_screenshots (app, helper); /* icons */ as_app_validate_icons (app, helper); /* releases */ if (!as_app_validate_releases (app, helper, error)) return NULL; /* kudos */ if (!as_app_validate_kudos (app, helper, error)) return NULL; /* name */ name = as_app_get_name (app, "C"); if (name != NULL) { str_len = (guint) strlen (name); if (str_len < length_name_min) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<name> is too short [%s] minimum is %u chars", name, length_name_min); } if (str_len > length_name_max) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<name> is too long [%s] maximum is %u chars", name, length_name_max); } if (ai_app_validate_fullstop_ending (name)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<name> cannot end in '.' [%s]", name); } if (as_app_validate_has_hyperlink (name)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<name> cannot contain a hyperlink [%s]", name); } if (require_sentence_case && !as_app_validate_has_first_word_capital (helper, name)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<name> requires sentence case [%s]", name); } } else if (require_name) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<name> is not present"); } /* comment */ summary = as_app_get_comment (app, "C"); if (summary != NULL) { str_len = (guint) strlen (summary); if (str_len < length_summary_min) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<summary> is too short [%s] minimum is %u chars", summary, length_summary_min); } if (str_len > length_summary_max) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<summary> is too long [%s] maximum is %u chars", summary, length_summary_max); } if (require_sentence_case && ai_app_validate_fullstop_ending (summary)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<summary> cannot end in '.' [%s]", summary); } if (as_app_validate_has_hyperlink (summary)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<summary> cannot contain a hyperlink [%s]", summary); } if (require_sentence_case && !as_app_validate_has_first_word_capital (helper, summary)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<summary> requires sentence case [%s]", summary); } } else if (require_name) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<summary> is not present"); } if (require_name_shorter_than_summary && summary != NULL && name != NULL && strlen (summary) < strlen (name)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<summary> is shorter than <name>"); } description = as_app_get_description (app, "C"); if (description == NULL) { if (require_description) { ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<description> required"); } } else { ret = as_app_validate_description (description, helper, number_para_min, number_para_max, FALSE, &error_local); if (!ret) { ai_app_validate_add (helper, AS_PROBLEM_KIND_MARKUP_INVALID, "%s", 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 (helper, 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 (helper, 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 (helper, AS_PROBLEM_KIND_TRANSLATIONS_REQUIRED, "<description> has no translations"); } } /* developer_name */ name = as_app_get_developer_name (app, NULL); if (name != NULL) { str_len = (guint) strlen (name); if (str_len < length_name_min) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<developer_name> is too short [%s] minimum is %u chars", name, length_name_min); } if (str_len > length_name_max) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<developer_name> is too long [%s] maximum is %u chars", name, length_name_max); } if (as_app_validate_has_hyperlink (name)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<developer_name> cannot contain a hyperlink [%s]", name); } if (as_app_validate_has_email (name)) { ai_app_validate_add (helper, AS_PROBLEM_KIND_STYLE_INCORRECT, "<developer_name> cannot contain an email address [%s]", name); } } /* using deprecated names */ if (deprecated_failure && (problems & AS_APP_PROBLEM_DEPRECATED_LICENCE) > 0) { ai_app_validate_add (helper, AS_PROBLEM_KIND_ATTRIBUTE_INVALID, "<licence> is deprecated, use " "<metadata_license> instead"); } if ((problems & AS_APP_PROBLEM_MULTIPLE_ENTRIES) > 0) { ai_app_validate_add (helper, 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_format_get_kind (format)) { case AS_FORMAT_KIND_APPDATA: case AS_FORMAT_KIND_METAINFO: ai_app_validate_add (helper, AS_PROBLEM_KIND_TAG_MISSING, "<url> is not present"); break; default: break; } } return helper->probs; }