/**
* as_content_rating_node_parse:
* @content_rating: a #AsContentRating instance.
* @node: a #GNode.
* @ctx: a #AsNodeContext.
* @error: A #GError or %NULL.
*
* Populates the object from a DOM node.
*
* Returns: %TRUE for success
*
* Since: 0.5.12
**/
gboolean
as_content_rating_node_parse (AsContentRating *content_rating, GNode *node,
AsNodeContext *ctx, GError **error)
{
AsContentRatingPrivate *priv = GET_PRIVATE (content_rating);
GNode *c;
const gchar *tmp;
g_autoptr(GHashTable) captions = NULL;
/* get ID */
tmp = as_node_get_attribute (node, "type");
if (tmp != NULL)
as_content_rating_set_kind (content_rating, tmp);
/* get keys */
for (c = node->children; c != NULL; c = c->next) {
AsContentRatingKey *key;
g_autoptr(AsImage) image = NULL;
if (as_node_get_tag (c) != AS_TAG_CONTENT_ATTRIBUTE)
continue;
key = g_slice_new0 (AsContentRatingKey);
as_ref_string_assign (&key->id, as_node_get_attribute (c, "id"));
key->value = as_content_rating_value_from_string (as_node_get_data (c));
g_ptr_array_add (priv->keys, key);
}
return TRUE;
}
/**
* as_icon_node_parse:
* @icon: a #AsIcon instance.
* @node: a #GNode.
* @error: A #GError or %NULL.
*
* Populates the object from a DOM node.
*
* Returns: %TRUE for success
*
* Since: 0.3.1
**/
gboolean
as_icon_node_parse (AsIcon *icon, GNode *node, GError **error)
{
AsIconPrivate *priv = GET_PRIVATE (icon);
const gchar *tmp;
gint size;
gboolean prepend_size = TRUE;
tmp = as_node_get_attribute (node, "type");
as_icon_set_kind (icon, as_icon_kind_from_string (tmp));
switch (priv->kind) {
case AS_ICON_KIND_EMBEDDED:
if (!as_icon_node_parse_embedded (icon, node, error))
return FALSE;
break;
default:
/* store the name without any prefix */
tmp = as_node_get_data (node);
if (g_strstr_len (tmp, -1, "/") == NULL) {
as_icon_set_name (icon, tmp, -1);
} else {
_cleanup_free_ gchar *basename = NULL;
basename = g_path_get_basename (tmp);
as_icon_set_name (icon, basename, -1);
}
/* width is optional, assume 64px if missing */
size = as_node_get_attribute_as_int (node, "width");
if (size == G_MAXINT) {
size = 64;
prepend_size = FALSE;
}
priv->width = size;
/* height is optional, assume 64px if missing */
size = as_node_get_attribute_as_int (node, "height");
if (size == G_MAXINT) {
size = 64;
prepend_size = FALSE;
}
priv->height = size;
/* only use the size if the metadata has width and height */
if (prepend_size) {
g_free (priv->prefix_private);
priv->prefix_private = g_strdup_printf ("%s/%ix%i",
priv->prefix,
priv->width,
priv->height);
}
break;
}
return TRUE;
}
static gboolean
as_icon_node_parse_embedded (AsIcon *icon, GNode *n, GError **error)
{
AsIconPrivate *priv = GET_PRIVATE (icon);
GNode *c;
gsize size;
g_autofree guchar *data = NULL;
g_autoptr(GdkPixbuf) pixbuf = NULL;
g_autoptr(GInputStream) stream = NULL;
/* get the icon name */
c = as_node_find (n, "name");
if (c == NULL) {
g_set_error_literal (error,
AS_ICON_ERROR,
AS_ICON_ERROR_FAILED,
"embedded icons needs <name>");
return FALSE;
}
g_free (priv->name);
priv->name = as_node_take_data (c);
/* parse the Base64 data */
c = as_node_find (n, "filecontent");
if (c == NULL) {
g_set_error_literal (error,
AS_ICON_ERROR,
AS_ICON_ERROR_FAILED,
"embedded icons needs <filecontent>");
return FALSE;
}
data = g_base64_decode (as_node_get_data (c), &size);
stream = g_memory_input_stream_new_from_data (data, (gssize) size, NULL);
if (stream == NULL) {
g_set_error_literal (error,
AS_ICON_ERROR,
AS_ICON_ERROR_FAILED,
"failed to load embedded data");
return FALSE;
}
/* load the image */
pixbuf = gdk_pixbuf_new_from_stream (stream, NULL, error);
if (pixbuf == NULL)
return FALSE;
as_icon_set_pixbuf (icon, pixbuf);
/* save the raw data */
if (priv->data != NULL)
g_bytes_unref (priv->data);
priv->data = g_bytes_new (data, size);
return TRUE;
}
/**
* as_node_get_localized:
* @node: a #AsNode
* @key: the key to use, e.g. "copyright"
*
* Extracts localized values from the DOM tree
*
* Return value: (transfer full): A hash table with the locale (e.g. en_GB) as the key
*
* Since: 0.1.0
**/
GHashTable *
as_node_get_localized (const AsNode *node, const gchar *key)
{
AsNodeData *data;
const gchar *xml_lang;
const gchar *data_unlocalized;
const gchar *data_localized;
GHashTable *hash = NULL;
AsNode *tmp;
/* does it exist? */
tmp = as_node_get_child_node (node, key, NULL, NULL);
if (tmp == NULL)
return NULL;
data_unlocalized = as_node_get_data (tmp);
/* find a node called name */
hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
for (tmp = node->children; tmp != NULL; tmp = tmp->next) {
data = tmp->data;
if (data == NULL)
continue;
if (data->cdata == NULL)
continue;
if (g_strcmp0 (as_tag_data_get_name (data), key) != 0)
continue;
xml_lang = as_node_attr_lookup (data, "xml:lang");
if (g_strcmp0 (xml_lang, "x-test") == 0)
continue;
/* avoid storing identical strings */
data_localized = data->cdata;
if (xml_lang != NULL && g_strcmp0 (data_unlocalized, data_localized) == 0)
continue;
g_hash_table_insert (hash,
g_strdup (xml_lang != NULL ? xml_lang : "C"),
(gpointer) data_localized);
}
return hash;
}
/**
* as_image_node_parse:
* @image: a #AsImage instance.
* @node: a #GNode.
* @ctx: a #AsNodeContext.
* @error: A #GError or %NULL.
*
* Populates the object from a DOM node.
*
* Returns: %TRUE for success
*
* Since: 0.1.0
**/
gboolean
as_image_node_parse (AsImage *image, GNode *node,
AsNodeContext *ctx, GError **error)
{
AsImagePrivate *priv = GET_PRIVATE (image);
const gchar *tmp;
guint size;
size = as_node_get_attribute_as_uint (node, "width");
if (size != G_MAXUINT)
as_image_set_width (image, size);
size = as_node_get_attribute_as_uint (node, "height");
if (size != G_MAXUINT)
as_image_set_height (image, size);
tmp = as_node_get_attribute (node, "type");
if (tmp == NULL)
as_image_set_kind (image, AS_IMAGE_KIND_SOURCE);
else
as_image_set_kind (image, as_image_kind_from_string (tmp));
as_ref_string_assign (&priv->url, as_node_get_data (node));
as_ref_string_assign (&priv->locale, as_node_get_attribute (node, "xml:lang"));
return TRUE;
}
static gboolean
as_app_validate_description (const gchar *xml,
AsAppValidateHelper *helper,
guint number_para_min,
guint number_para_max,
gboolean allow_short_para,
GError **error)
{
GNode *l;
GNode *l2;
g_autoptr(AsNode) node = NULL;
/* parse xml */
node = as_node_from_xml (xml, AS_NODE_FROM_XML_FLAG_NONE, error);
if (node == NULL)
return FALSE;
helper->number_paragraphs = 0;
helper->previous_para_was_short = FALSE;
for (l = node->children; l != NULL; l = l->next) {
if (g_strcmp0 (as_node_get_name (l), "p") == 0) {
if (as_node_get_attribute (l, "xml:lang") != NULL)
continue;
as_app_validate_description_para (as_node_get_data (l),
helper);
} else if (g_strcmp0 (as_node_get_name (l), "ul") == 0 ||
g_strcmp0 (as_node_get_name (l), "ol") == 0) {
as_app_validate_description_list (as_node_get_data (l),
allow_short_para,
helper);
for (l2 = l->children; l2 != NULL; l2 = l2->next) {
if (g_strcmp0 (as_node_get_name (l2), "li") == 0) {
if (as_node_get_attribute (l2, "xml:lang") != NULL)
continue;
as_app_validate_description_li (as_node_get_data (l2),
helper);
} else {
/* only <li> supported */
g_set_error (error,
AS_APP_ERROR,
AS_APP_ERROR_FAILED,
"invalid markup: <%s> follows <%s>",
as_node_get_name (l2),
as_node_get_name (l));
return FALSE;
}
}
} else {
/* only <p>, <ol> and <ul> supported */
g_set_error (error,
AS_APP_ERROR,
AS_APP_ERROR_FAILED,
"invalid markup: tag <%s> invalid here",
as_node_get_name (l));
return FALSE;
}
}
/* previous paragraph wasn't long enough */
if (helper->previous_para_was_short) {
ai_app_validate_add (helper,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"<p> is too short [%s]",
helper->previous_para_was_short_str);
}
if (helper->number_paragraphs < number_para_min) {
ai_app_validate_add (helper,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"Not enough <p> tags for a good description [%u/%u]",
helper->number_paragraphs,
number_para_min);
}
if (helper->number_paragraphs > number_para_max) {
ai_app_validate_add (helper,
AS_PROBLEM_KIND_STYLE_INCORRECT,
"Too many <p> tags for a good description [%u/%u]",
helper->number_paragraphs,
number_para_max);
}
return TRUE;
}
/**
* cra_plugin_process_filename:
*/
static gboolean
cra_plugin_process_filename (CraPlugin *plugin,
CraPackage *pkg,
const gchar *filename,
GList **apps,
const gchar *tmpdir,
GError **error)
{
GNode *root = NULL;
GString *valid_xml;
const gchar *tmp;
const GNode *n;
gboolean found_header = FALSE;
gboolean ret;
guint i;
_cleanup_free_ gchar *basename = NULL;
_cleanup_free_ gchar *data = NULL;
_cleanup_free_ gchar *filename_tmp;
_cleanup_object_unref_ CraApp *app = NULL;
_cleanup_strv_free_ gchar **languages = NULL;
_cleanup_strv_free_ gchar **lines = NULL;
/* open file */
filename_tmp = g_build_filename (tmpdir, filename, NULL);
ret = g_file_get_contents (filename_tmp, &data, NULL, error);
if (!ret)
goto out;
/* some components start with a comment (invalid XML) and some
* don't even have '<?xml' -- try to fix up best we can */
valid_xml = g_string_new ("");
lines = g_strsplit (data, "\n", -1);
for (i = 0; lines[i] != NULL; i++) {
if (g_str_has_prefix (lines[i], "<?xml") ||
g_str_has_prefix (lines[i], "<component>"))
found_header = TRUE;
if (found_header)
g_string_append_printf (valid_xml, "%s\n", lines[i]);
}
/* parse contents */
root = as_node_from_xml (valid_xml->str, -1,
AS_NODE_FROM_XML_FLAG_NONE,
error);
if (!ret)
goto out;
/* create new app */
basename = g_path_get_basename (filename);
app = cra_app_new (pkg, basename);
as_app_set_id_kind (AS_APP (app), AS_ID_KIND_INPUT_METHOD);
as_app_add_category (AS_APP (app), "Addons", -1);
as_app_add_category (AS_APP (app), "InputSources", -1);
as_app_set_icon (AS_APP (app), "system-run-symbolic", -1);
as_app_set_icon_kind (AS_APP (app), AS_ICON_KIND_STOCK);
cra_app_set_requires_appdata (app, TRUE);
/* read the component header which all input methods have */
n = as_node_find (root, "component/description");
if (n != NULL) {
as_app_set_name (AS_APP (app), "C", as_node_get_data (n), -1);
as_app_set_comment (AS_APP (app), "C", as_node_get_data (n), -1);
}
n = as_node_find (root, "component/homepage");
if (n != NULL) {
as_app_add_url (AS_APP (app),
AS_URL_KIND_HOMEPAGE,
as_node_get_data (n), -1);
}
/* do we have a engine section we can use? */
n = as_node_find (root, "component/engines/engine/longname");
if (n != NULL)
as_app_set_name (AS_APP (app), "C", as_node_get_data (n), -1);
n = as_node_find (root, "component/engines/engine/description");
if (n != NULL)
as_app_set_comment (AS_APP (app), "C", as_node_get_data (n), -1);
n = as_node_find (root, "component/engines/engine/symbol");
if (n != NULL) {
tmp = as_node_get_data (n);
if (tmp != NULL && tmp[0] != '\0') {
as_app_add_metadata (AS_APP (app),
"X-IBus-Symbol",
tmp, -1);
}
}
n = as_node_find (root, "component/engines/engine/language");
if (n != NULL) {
tmp = as_node_get_data (n);
if (tmp != NULL) {
languages = g_strsplit (tmp, ",", -1);
for (i = 0; languages[i] != NULL; i++) {
if (g_strcmp0 (languages[i], "other") == 0)
continue;
as_app_add_language (AS_APP (app),
100, languages[i], -1);
}
}
}
/* add */
cra_plugin_add_app (apps, app);
out:
if (root != NULL)
as_node_unref (root);
return ret;
}
/**
* as_screenshot_node_parse:
* @screenshot: a #AsScreenshot instance.
* @node: a #GNode.
* @ctx: a #AsNodeContext.
* @error: A #GError or %NULL.
*
* Populates the object from a DOM node.
*
* Returns: %TRUE for success
*
* Since: 0.1.0
**/
gboolean
as_screenshot_node_parse (AsScreenshot *screenshot, GNode *node,
AsNodeContext *ctx, GError **error)
{
AsScreenshotPrivate *priv = GET_PRIVATE (screenshot);
GList *l;
GNode *c;
const gchar *tmp;
guint size;
gint priority;
g_autoptr(GHashTable) captions = NULL;
tmp = as_node_get_attribute (node, "type");
if (tmp != NULL) {
as_screenshot_set_kind (screenshot,
as_screenshot_kind_from_string (tmp));
}
priority = as_node_get_attribute_as_int (node, "priority");
if (priority != G_MAXINT)
as_screenshot_set_priority (screenshot, priority);
/* add captions */
captions = as_node_get_localized (node, "caption");
if (captions != NULL) {
g_autoptr(GList) keys = NULL;
keys = g_hash_table_get_keys (captions);
for (l = keys; l != NULL; l = l->next) {
tmp = l->data;
as_screenshot_set_caption (screenshot,
tmp,
g_hash_table_lookup (captions, tmp));
}
}
/* AppData files does not have <image> tags */
tmp = as_node_get_data (node);
if (tmp != NULL) {
AsImage *image;
image = as_image_new ();
as_image_set_kind (image, AS_IMAGE_KIND_SOURCE);
size = as_node_get_attribute_as_uint (node, "width");
if (size != G_MAXINT)
as_image_set_width (image, size);
size = as_node_get_attribute_as_uint (node, "height");
if (size != G_MAXINT)
as_image_set_height (image, size);
as_image_set_url (image, tmp);
g_ptr_array_add (priv->images, image);
}
/* add images */
for (c = node->children; c != NULL; c = c->next) {
g_autoptr(AsImage) image = NULL;
if (as_node_get_tag (c) != AS_TAG_IMAGE)
continue;
image = as_image_new ();
if (!as_image_node_parse (image, c, ctx, error))
return FALSE;
g_ptr_array_add (priv->images, g_object_ref (image));
}
return TRUE;
}
/**
* as_icon_node_parse:
* @icon: a #AsIcon instance.
* @node: a #GNode.
* @ctx: a #AsNodeContext.
* @error: A #GError or %NULL.
*
* Populates the object from a DOM node.
*
* Returns: %TRUE for success
*
* Since: 0.3.1
**/
gboolean
as_icon_node_parse (AsIcon *icon, GNode *node,
AsNodeContext *ctx, GError **error)
{
AsIconPrivate *priv = GET_PRIVATE (icon);
const gchar *tmp;
guint size;
gboolean prepend_size = TRUE;
tmp = as_node_get_attribute (node, "type");
as_icon_set_kind (icon, as_icon_kind_from_string (tmp));
switch (priv->kind) {
case AS_ICON_KIND_EMBEDDED:
if (!as_icon_node_parse_embedded (icon, node, error))
return FALSE;
break;
default:
/* preserve the URL for remote icons */
tmp = as_node_get_data (node);
if (tmp == NULL) {
g_set_error (error,
AS_ICON_ERROR,
AS_ICON_ERROR_FAILED,
"no data for icon of type %s",
as_icon_kind_to_string (priv->kind));
return FALSE;
}
if (priv->kind == AS_ICON_KIND_REMOTE)
as_icon_set_url (icon, tmp);
else if (priv->kind == AS_ICON_KIND_LOCAL)
as_icon_set_filename (icon, tmp);
/* store the name without any prefix */
if (g_strstr_len (tmp, -1, "/") == NULL) {
as_icon_set_name (icon, tmp);
} else {
g_autofree gchar *basename = NULL;
basename = g_path_get_basename (tmp);
as_icon_set_name (icon, basename);
}
/* width is optional, assume 64px if missing */
size = as_node_get_attribute_as_uint (node, "width");
if (size == G_MAXUINT) {
size = 64;
prepend_size = FALSE;
}
priv->width = size;
/* height is optional, assume 64px if missing */
size = as_node_get_attribute_as_uint (node, "height");
if (size == G_MAXUINT) {
size = 64;
prepend_size = FALSE;
}
priv->height = size;
/* only use the size if the metadata has width and height */
if (prepend_size) {
g_free (priv->prefix_private);
priv->prefix_private = g_strdup_printf ("%s/%ux%u",
priv->prefix,
priv->width,
priv->height);
}
break;
}
return TRUE;
}
/**
* as_markup_convert_full:
* @markup: the text to copy.
* @format: the #AsMarkupConvertFormat, e.g. %AS_MARKUP_CONVERT_FORMAT_MARKDOWN
* @flags: the #AsMarkupConvertFlag, e.g. %AS_MARKUP_CONVERT_FLAG_IGNORE_ERRORS
* @error: A #GError or %NULL
*
* Converts an XML description into a printable form.
*
* Returns: (transfer full): a newly allocated %NULL terminated string
*
* Since: 0.3.5
**/
gchar *
as_markup_convert_full (const gchar *markup,
AsMarkupConvertFormat format,
AsMarkupConvertFlag flags,
GError **error)
{
GNode *tmp;
GNode *tmp_c;
const gchar *tag;
const gchar *tag_c;
g_autoptr(AsNode) root = NULL;
g_autoptr(GError) error_local = NULL;
g_autoptr(GString) str = NULL;
/* is this actually markup */
if (g_strstr_len (markup, -1, "<") == NULL)
return g_strdup (markup);
/* load */
root = as_node_from_xml (markup, AS_NODE_FROM_XML_FLAG_NONE, &error_local);
if (root == NULL) {
/* truncate to the last tag and try again */
if (flags & AS_MARKUP_CONVERT_FLAG_IGNORE_ERRORS) {
gchar *found;
g_autofree gchar *markup_new = NULL;
markup_new = g_strdup (markup);
found = g_strrstr (markup_new, "<");
g_assert (found != NULL);
*found = '\0';
return as_markup_convert_full (markup_new, format, flags, error);
}
/* just return error */
g_propagate_error (error, error_local);
error_local = NULL;
return NULL;
}
/* format */
str = g_string_new ("");
for (tmp = root->children; tmp != NULL; tmp = tmp->next) {
tag = as_node_get_name (tmp);
if (g_strcmp0 (tag, "unknown") == 0)
continue;
if (g_strcmp0 (tag, "p") == 0) {
as_markup_render_para (str, format, as_node_get_data (tmp));
continue;
}
/* loop on the children */
if (g_strcmp0 (tag, "ul") == 0 ||
g_strcmp0 (tag, "ol") == 0) {
as_markup_render_ul_start (str, format);
for (tmp_c = tmp->children; tmp_c != NULL; tmp_c = tmp_c->next) {
tag_c = as_node_get_name (tmp_c);
if (g_strcmp0 (tag_c, "unknown") == 0)
continue;
if (g_strcmp0 (tag_c, "li") == 0) {
as_markup_render_li (str, format,
as_node_get_data (tmp_c));
continue;
}
/* just abort the list */
if (flags & AS_MARKUP_CONVERT_FLAG_IGNORE_ERRORS)
break;
/* only <li> is valid in lists */
g_set_error (error,
AS_NODE_ERROR,
AS_NODE_ERROR_FAILED,
"Tag %s in %s invalid",
tag_c, tag);
return NULL;
}
as_markup_render_ul_end (str, format);
continue;
}
/* just try again */
if (flags & AS_MARKUP_CONVERT_FLAG_IGNORE_ERRORS)
continue;
/* only <p>, <ul> and <ol> is valid here */
g_set_error (error,
AS_NODE_ERROR,
AS_NODE_ERROR_FAILED,
"Unknown tag '%s'", tag);
return NULL;
}
/* success */
switch (format) {
case AS_MARKUP_CONVERT_FORMAT_SIMPLE:
case AS_MARKUP_CONVERT_FORMAT_MARKDOWN:
if (str->len > 0)
g_string_truncate (str, str->len - 1);
break;
default:
break;
}
return g_strdup (str->str);
}
/**
* as_review_node_parse:
* @review: a #AsReview instance.
* @node: a #GNode.
* @ctx: a #AsNodeContext.
* @error: A #GError or %NULL.
*
* Populates the object from a DOM node.
*
* Returns: %TRUE for success
*
* Since: 0.6.1
**/
gboolean
as_review_node_parse (AsReview *review, GNode *node,
AsNodeContext *ctx, GError **error)
{
AsReviewPrivate *priv = GET_PRIVATE (review);
AsNode *c;
const gchar *tmp;
gint itmp;
itmp = as_node_get_attribute_as_int (node, "rating");
if (itmp != G_MAXINT)
as_review_set_rating (review, itmp);
tmp = as_node_get_attribute (node, "date");
if (tmp != NULL) {
g_autoptr(GDateTime) dt = as_utils_iso8601_to_datetime (tmp);
if (dt != NULL)
as_review_set_date (review, dt);
}
tmp = as_node_get_attribute (node, "id");
if (tmp != NULL)
as_review_set_id (review, tmp);
for (c = node->children; c != NULL; c = c->next) {
if (as_node_get_tag (c) == AS_TAG_SUMMARY) {
as_review_set_summary (review, as_node_get_data (c));
continue;
}
if (as_node_get_tag (c) == AS_TAG_PRIORITY) {
gint64 prio = g_ascii_strtoll (as_node_get_data (c),
NULL, 10);
as_review_set_priority (review, (gint) prio);
continue;
}
if (as_node_get_tag (c) == AS_TAG_DESCRIPTION) {
g_autoptr(GString) xml = NULL;
xml = as_node_to_xml (c->children, AS_NODE_TO_XML_FLAG_INCLUDE_SIBLINGS);
as_review_set_description (review, xml->str);
continue;
}
if (as_node_get_tag (c) == AS_TAG_VERSION) {
as_review_set_version (review, as_node_get_data (c));
continue;
}
if (as_node_get_tag (c) == AS_TAG_REVIEWER_ID) {
as_review_set_reviewer_id (review, as_node_get_data (c));
continue;
}
if (as_node_get_tag (c) == AS_TAG_REVIEWER_NAME) {
as_review_set_reviewer_name (review, as_node_get_data (c));
continue;
}
if (as_node_get_tag (c) == AS_TAG_LANG) {
as_review_set_locale (review, as_node_get_data (c));
continue;
}
if (as_node_get_tag (c) == AS_TAG_METADATA) {
AsNode *c2;
for (c2 = c->children; c2 != NULL; c2 = c2->next) {
AsRefString *key;
AsRefString *value;
if (as_node_get_tag (c2) != AS_TAG_VALUE)
continue;
key = as_node_get_attribute (c2, "key");
value = as_node_get_data (c2);
if (value == NULL) {
g_hash_table_insert (priv->metadata,
as_ref_string_ref (key),
as_ref_string_new_static (""));
} else {
g_hash_table_insert (priv->metadata,
as_ref_string_ref (key),
as_ref_string_ref (value));
}
}
continue;
}
}
return TRUE;
}