libpurple/xmlnode.c

/*
 * Purple - Internet Messaging Library
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here. Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This library 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 library 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 library; if not, see <https://www.gnu.org/licenses/>.
 */

/* A lot of this code at least resembles the code in libxode, but since
 * libxode uses memory pools that we simply have no need for, I decided to
 * write my own stuff.  Also, re-writing this lets me be as lightweight
 * as I want to be.  Thank you libxode for giving me a good starting point */

#include <glib/gi18n-lib.h>

#include "debug.h"

#include <libxml/parser.h>
#include <string.h>
#include <glib.h>

#include "purplemarkup.h"
#include "util.h"
#include "xmlnode.h"
#include "glibcompat.h"

#ifdef _WIN32
# define NEWLINE_S "\r\n"
#else
# define NEWLINE_S "\n"
#endif

static PurpleXmlNode*
new_node(const char *name, PurpleXmlNodeType type)
{
	PurpleXmlNode *node = g_new0(PurpleXmlNode, 1);

	node->name = g_strdup(name);
	node->type = type;

	return node;
}

PurpleXmlNode*
purple_xmlnode_new(const char *name)
{
	g_return_val_if_fail(name != NULL && *name != '\0', NULL);

	return new_node(name, PURPLE_XMLNODE_TYPE_TAG);
}

PurpleXmlNode *
purple_xmlnode_new_child(PurpleXmlNode *parent, const char *name)
{
	PurpleXmlNode *node;

	g_return_val_if_fail(parent != NULL, NULL);
	g_return_val_if_fail(name != NULL && *name != '\0', NULL);

	node = new_node(name, PURPLE_XMLNODE_TYPE_TAG);

	purple_xmlnode_insert_child(parent, node);

	return node;
}

void
purple_xmlnode_insert_child(PurpleXmlNode *parent, PurpleXmlNode *child)
{
	g_return_if_fail(parent != NULL);
	g_return_if_fail(child != NULL);

	child->parent = parent;

	if(parent->lastchild) {
		parent->lastchild->next = child;
	} else {
		parent->child = child;
	}

	parent->lastchild = child;
}

void
purple_xmlnode_insert_data(PurpleXmlNode *node, const char *data, gssize size)
{
	PurpleXmlNode *child;
	gsize real_size;

	g_return_if_fail(node != NULL);
	g_return_if_fail(data != NULL);
	g_return_if_fail(size != 0);

	real_size = size == -1 ? strlen(data) : (gsize)size;

	child = new_node(NULL, PURPLE_XMLNODE_TYPE_DATA);

	child->data = g_memdup2(data, real_size);
	child->data_sz = real_size;

	purple_xmlnode_insert_child(node, child);
}

void
purple_xmlnode_remove_attrib(PurpleXmlNode *node, const char *attr)
{
	PurpleXmlNode *attr_node, *sibling = NULL;

	g_return_if_fail(node != NULL);
	g_return_if_fail(attr != NULL);

	attr_node = node->child;
	while (attr_node) {
		if(attr_node->type == PURPLE_XMLNODE_TYPE_ATTRIB &&
				purple_strequal(attr_node->name, attr))
		{
			if (node->lastchild == attr_node) {
				node->lastchild = sibling;
			}
			if (sibling == NULL) {
				node->child = attr_node->next;
				purple_xmlnode_free(attr_node);
				attr_node = node->child;
			} else {
				sibling->next = attr_node->next;
				sibling = attr_node->next;
				purple_xmlnode_free(attr_node);
				attr_node = sibling;
			}
		} else {
			attr_node = attr_node->next;
		}
		sibling = attr_node;
	}
}

void
purple_xmlnode_remove_attrib_with_namespace(PurpleXmlNode *node, const char *attr, const char *xmlns)
{
	PurpleXmlNode *attr_node, *sibling = NULL;

	g_return_if_fail(node != NULL);
	g_return_if_fail(attr != NULL);

	for(attr_node = node->child; attr_node; attr_node = attr_node->next) {
		if(attr_node->type == PURPLE_XMLNODE_TYPE_ATTRIB &&
		   purple_strequal(attr,  attr_node->name) &&
		   purple_strequal(xmlns, attr_node->xmlns))
		{
			if(sibling == NULL) {
				node->child = attr_node->next;
			} else {
				sibling->next = attr_node->next;
			}
			if (node->lastchild == attr_node) {
				node->lastchild = sibling;
			}
			purple_xmlnode_free(attr_node);
			return;
		}
		sibling = attr_node;
	}
}

void
purple_xmlnode_set_attrib(PurpleXmlNode *node, const char *attr, const char *value)
{
	purple_xmlnode_remove_attrib(node, attr);
	purple_xmlnode_set_attrib_full(node, attr, NULL, NULL, value);
}

void
purple_xmlnode_set_attrib_full(PurpleXmlNode *node, const char *attr, const char *xmlns, const char *prefix, const char *value)
{
	PurpleXmlNode *attrib_node;

	g_return_if_fail(node != NULL);
	g_return_if_fail(attr != NULL);
	g_return_if_fail(value != NULL);

	purple_xmlnode_remove_attrib_with_namespace(node, attr, xmlns);
	attrib_node = new_node(attr, PURPLE_XMLNODE_TYPE_ATTRIB);

	attrib_node->data = g_strdup(value);
	attrib_node->xmlns = g_strdup(xmlns);
	attrib_node->prefix = g_strdup(prefix);

	purple_xmlnode_insert_child(node, attrib_node);
}


const char *
purple_xmlnode_get_attrib(const PurpleXmlNode *node, const char *attr)
{
	PurpleXmlNode *x;

	g_return_val_if_fail(node != NULL, NULL);
	g_return_val_if_fail(attr != NULL, NULL);

	for(x = node->child; x; x = x->next) {
		if(x->type == PURPLE_XMLNODE_TYPE_ATTRIB && purple_strequal(attr, x->name)) {
			return x->data;
		}
	}

	return NULL;
}

const char *
purple_xmlnode_get_attrib_with_namespace(const PurpleXmlNode *node, const char *attr, const char *xmlns)
{
	const PurpleXmlNode *x;

	g_return_val_if_fail(node != NULL, NULL);
	g_return_val_if_fail(attr != NULL, NULL);

	for(x = node->child; x; x = x->next) {
		if(x->type == PURPLE_XMLNODE_TYPE_ATTRIB &&
		   purple_strequal(attr,  x->name) &&
		   purple_strequal(xmlns, x->xmlns)) {
			return x->data;
		}
	}

	return NULL;
}


void purple_xmlnode_set_namespace(PurpleXmlNode *node, const char *xmlns)
{
	char *tmp;
	g_return_if_fail(node != NULL);

	tmp = node->xmlns;
	node->xmlns = g_strdup(xmlns);

	if (node->namespace_map) {
		g_hash_table_insert(node->namespace_map,
			g_strdup(""), g_strdup(xmlns));
	}

	g_free(tmp);
}

const char *purple_xmlnode_get_namespace(const PurpleXmlNode *node)
{
	g_return_val_if_fail(node != NULL, NULL);

	return node->xmlns;
}

const char *purple_xmlnode_get_default_namespace(const PurpleXmlNode *node)
{
	const PurpleXmlNode *current_node;
	const char *ns = NULL;

	g_return_val_if_fail(node != NULL, NULL);

	current_node = node;
	while (current_node) {
		/* If this node does *not* have a prefix, node->xmlns is the default
		 * namespace.  Otherwise, it's the prefix namespace.
		 */
		if (!current_node->prefix && current_node->xmlns) {
			return current_node->xmlns;
		} else if (current_node->namespace_map) {
			ns = g_hash_table_lookup(current_node->namespace_map, "");
			if (ns && *ns) {
				return ns;
			}
		}

		current_node = current_node->parent;
	}

	return ns;
}

void purple_xmlnode_set_prefix(PurpleXmlNode *node, const char *prefix)
{
	g_return_if_fail(node != NULL);

	g_set_str(&node->prefix, prefix);
}

const char *purple_xmlnode_get_prefix(const PurpleXmlNode *node)
{
	g_return_val_if_fail(node != NULL, NULL);
	return node->prefix;
}

const char *purple_xmlnode_get_prefix_namespace(const PurpleXmlNode *node, const char *prefix)
{
	const PurpleXmlNode *current_node;

	g_return_val_if_fail(node != NULL, NULL);
	g_return_val_if_fail(prefix != NULL, purple_xmlnode_get_default_namespace(node));

	current_node = node;
	while (current_node) {
		if (current_node->prefix && g_str_equal(prefix, current_node->prefix) &&
				current_node->xmlns) {
			return current_node->xmlns;
		} else if (current_node->namespace_map) {
			const char *ns = g_hash_table_lookup(current_node->namespace_map, prefix);
			if (ns && *ns) {
				return ns;
			}
		}

		current_node = current_node->parent;
	}

	return NULL;
}

void purple_xmlnode_strip_prefixes(PurpleXmlNode *node)
{
	PurpleXmlNode *child;
	const char *prefix;

	g_return_if_fail(node != NULL);

	for (child = node->child; child; child = child->next) {
		if (child->type == PURPLE_XMLNODE_TYPE_TAG) {
			purple_xmlnode_strip_prefixes(child);
		}
	}

	prefix = purple_xmlnode_get_prefix(node);
	if (prefix) {
		const char *ns = purple_xmlnode_get_prefix_namespace(node, prefix);
		purple_xmlnode_set_namespace(node, ns);
		purple_xmlnode_set_prefix(node, NULL);
	} else {
		purple_xmlnode_set_namespace(node, purple_xmlnode_get_default_namespace(node));
	}
}

PurpleXmlNode *purple_xmlnode_get_parent(const PurpleXmlNode *child)
{
	g_return_val_if_fail(child != NULL, NULL);
	return child->parent;
}

void
purple_xmlnode_free(PurpleXmlNode *node)
{
	PurpleXmlNode *x, *y;

	g_return_if_fail(node != NULL);

	/* if we're part of a tree, remove ourselves from the tree first */
	if(NULL != node->parent) {
		if(node->parent->child == node) {
			node->parent->child = node->next;
			if (node->parent->lastchild == node) {
				node->parent->lastchild = node->next;
			}
		} else {
			PurpleXmlNode *prev = node->parent->child;
			while(prev && prev->next != node) {
				prev = prev->next;
			}
			if(prev) {
				prev->next = node->next;
				if (node->parent->lastchild == node) {
					node->parent->lastchild = prev;
				}
			}
		}
	}

	/* now free our children */
	x = node->child;
	while(x) {
		y = x->next;
		purple_xmlnode_free(x);
		x = y;
	}

	/* now dispose of ourselves */
	g_free(node->name);
	g_free(node->data);
	g_free(node->xmlns);
	g_free(node->prefix);

	g_clear_pointer(&node->namespace_map, g_hash_table_destroy);

	g_free(node);
}

PurpleXmlNode*
purple_xmlnode_get_child(const PurpleXmlNode *parent, const char *name)
{
	return purple_xmlnode_get_child_with_namespace(parent, name, NULL);
}

PurpleXmlNode *
purple_xmlnode_get_child_with_namespace(const PurpleXmlNode *parent, const char *name, const char *ns)
{
	PurpleXmlNode *x, *ret = NULL;
	char **names;
	char *parent_name, *child_name;

	g_return_val_if_fail(parent != NULL, NULL);
	g_return_val_if_fail(name != NULL, NULL);

	names = g_strsplit(name, "/", 2);
	parent_name = names[0];
	child_name = names[1];

	for(x = parent->child; x; x = x->next) {
		/* XXX: Is it correct to ignore the namespace for the match if none was specified? */
		const char *xmlns = NULL;
		if(ns) {
			xmlns = purple_xmlnode_get_namespace(x);
		}

		if(x->type == PURPLE_XMLNODE_TYPE_TAG && purple_strequal(parent_name, x->name)
				&& purple_strequal(ns, xmlns)) {
			ret = x;
			break;
		}
	}

	if(child_name && ret) {
		ret = purple_xmlnode_get_child(ret, child_name);
	}

	g_strfreev(names);
	return ret;
}

char *
purple_xmlnode_get_data(const PurpleXmlNode *node)
{
	GString *str = NULL;
	PurpleXmlNode *c;

	g_return_val_if_fail(node != NULL, NULL);

	for(c = node->child; c; c = c->next) {
		if(c->type == PURPLE_XMLNODE_TYPE_DATA) {
			if(!str) {
				str = g_string_new_len(c->data, c->data_sz);
			} else {
				str = g_string_append_len(str, c->data, c->data_sz);
			}
		}
	}

	if (str == NULL) {
		return NULL;
	}

	return g_string_free_and_steal(str);
}

char *
purple_xmlnode_get_data_unescaped(const PurpleXmlNode *node)
{
	char *escaped = purple_xmlnode_get_data(node);

	char *unescaped = escaped ? purple_unescape_html(escaped) : NULL;

	g_free(escaped);

	return unescaped;
}

static void
purple_xmlnode_to_str_foreach_append_ns(const char *key, const char *value,
	GString *buf)
{
	if (*key) {
		g_string_append_printf(buf, " xmlns:%s='%s'", key, value);
	} else {
		g_string_append_printf(buf, " xmlns='%s'", value);
	}
}

static char *
purple_xmlnode_to_str_helper(const PurpleXmlNode *node, int *len, gboolean formatting, int depth)
{
	GString *text;
	const char *prefix;
	const PurpleXmlNode *c;
	char *node_name, *esc, *esc2, *tab = NULL;
	gboolean need_end = FALSE, pretty = formatting;

	g_return_val_if_fail(node != NULL, NULL);

	text = g_string_new("");

	if(pretty && depth) {
		tab = g_strnfill(depth, '\t');
		text = g_string_append(text, tab);
	}

	node_name = g_markup_escape_text(node->name, -1);
	prefix = purple_xmlnode_get_prefix(node);

	if (prefix) {
		g_string_append_printf(text, "<%s:%s", prefix, node_name);
	} else {
		g_string_append_printf(text, "<%s", node_name);
	}

	if (node->namespace_map) {
		g_hash_table_foreach(node->namespace_map,
			(GHFunc)purple_xmlnode_to_str_foreach_append_ns, text);
	} else {
		/* Figure out if this node has a different default namespace from parent */
		const char *xmlns = NULL;
		const char *parent_xmlns = NULL;
		if (!prefix) {
			xmlns = node->xmlns;
		}

		if (!xmlns) {
			xmlns = purple_xmlnode_get_default_namespace(node);
		}
		if (node->parent) {
			parent_xmlns = purple_xmlnode_get_default_namespace(node->parent);
		}
		if (!purple_strequal(xmlns, parent_xmlns)) {
			char *escaped_xmlns = g_markup_escape_text(xmlns, -1);
			g_string_append_printf(text, " xmlns='%s'", escaped_xmlns);
			g_free(escaped_xmlns);
		}
	}
	for(c = node->child; c; c = c->next) {
		if(c->type == PURPLE_XMLNODE_TYPE_ATTRIB) {
			const char *aprefix = purple_xmlnode_get_prefix(c);
			esc = g_markup_escape_text(c->name, -1);
			esc2 = g_markup_escape_text(c->data, -1);
			if (aprefix) {
				g_string_append_printf(text, " %s:%s='%s'", aprefix, esc, esc2);
			} else {
				g_string_append_printf(text, " %s='%s'", esc, esc2);
			}
			g_free(esc);
			g_free(esc2);
		} else if(c->type == PURPLE_XMLNODE_TYPE_TAG || c->type == PURPLE_XMLNODE_TYPE_DATA) {
			if(c->type == PURPLE_XMLNODE_TYPE_DATA) {
				pretty = FALSE;
			}
			need_end = TRUE;
		}
	}

	if(need_end) {
		g_string_append_printf(text, ">%s", pretty ? NEWLINE_S : "");

		for(c = node->child; c; c = c->next) {
			if(c->type == PURPLE_XMLNODE_TYPE_TAG) {
				int esc_len;
				esc = purple_xmlnode_to_str_helper(c, &esc_len, pretty, depth+1);
				text = g_string_append_len(text, esc, esc_len);
				g_free(esc);
			} else if(c->type == PURPLE_XMLNODE_TYPE_DATA && c->data_sz > 0) {
				esc = g_markup_escape_text(c->data, c->data_sz);
				text = g_string_append(text, esc);
				g_free(esc);
			}
		}

		if(tab && pretty) {
			text = g_string_append(text, tab);
		}
		if (prefix) {
			g_string_append_printf(text, "</%s:%s>%s", prefix, node_name, formatting ? NEWLINE_S : "");
		} else {
			g_string_append_printf(text, "</%s>%s", node_name, formatting ? NEWLINE_S : "");
		}
	} else {
		g_string_append_printf(text, "/>%s", formatting ? NEWLINE_S : "");
	}

	g_free(node_name);

	g_free(tab);

	if(len) {
		*len = text->len;
	}

	return g_string_free_and_steal(text);
}

char *
purple_xmlnode_to_str(const PurpleXmlNode *node, int *len)
{
	return purple_xmlnode_to_str_helper(node, len, FALSE, 0);
}

char *
purple_xmlnode_to_formatted_str(const PurpleXmlNode *node, int *len)
{
	char *xml, *xml_with_declaration;

	g_return_val_if_fail(node != NULL, NULL);

	xml = purple_xmlnode_to_str_helper(node, len, TRUE, 0);
	xml_with_declaration =
		g_strdup_printf("<?xml version='1.0' encoding='UTF-8' ?>" NEWLINE_S NEWLINE_S "%s", xml);
	g_free(xml);

	if (len) {
		*len += sizeof("<?xml version='1.0' encoding='UTF-8' ?>" NEWLINE_S NEWLINE_S) - 1;
	}

	return xml_with_declaration;
}

struct _xmlnode_parser_data {
	PurpleXmlNode *current;
	gboolean error;
};

static void
purple_xmlnode_parser_element_start_libxml(gpointer user_data,
                                           const xmlChar *element_name,
                                           const xmlChar *prefix,
                                           const xmlChar *xmlns,
                                           int nb_namespaces,
                                           const xmlChar **namespaces,
                                           int nb_attributes,
                                           G_GNUC_UNUSED int nb_defaulted,
                                           const xmlChar **attributes)
{
	struct _xmlnode_parser_data *xpd = user_data;
	PurpleXmlNode *node;
	int i, j;

	if(!element_name || xpd->error) {
		return;
	} else {
		if(xpd->current) {
			node = purple_xmlnode_new_child(xpd->current, (const char*) element_name);
		} else {
			node = purple_xmlnode_new((const char *) element_name);
		}

		purple_xmlnode_set_namespace(node, (const char *) xmlns);
		purple_xmlnode_set_prefix(node, (const char *)prefix);

		if (nb_namespaces != 0) {
			node->namespace_map = g_hash_table_new_full(
				g_str_hash, g_str_equal, g_free, g_free);

			for (i = 0, j = 0; i < nb_namespaces; i++, j += 2) {
				const char *key = (const char *)namespaces[j];
				const char *val = (const char *)namespaces[j + 1];
				g_hash_table_insert(node->namespace_map,
					g_strdup(key ? key : ""), g_strdup(val ? val : ""));
			}
		}

		for(i=0; i < nb_attributes * 5; i+=5) {
			const char *name = (const char *)attributes[i];
			const char *prefix = (const char *)attributes[i+1];
			char *txt;
			int attrib_len = attributes[i+4] - attributes[i+3];
			char *attrib = g_strndup((const char *)attributes[i+3], attrib_len);
			txt = attrib;
			attrib = purple_unescape_text(txt);
			g_free(txt);
			purple_xmlnode_set_attrib_full(node, name, NULL, prefix, attrib);
			g_free(attrib);
		}

		xpd->current = node;
	}
}

static void
purple_xmlnode_parser_element_end_libxml(gpointer user_data,
                                         const xmlChar *element_name,
                                         G_GNUC_UNUSED const xmlChar *prefix,
                                         G_GNUC_UNUSED const xmlChar *xmlns)
{
	struct _xmlnode_parser_data *xpd = user_data;

	if(!element_name || !xpd->current || xpd->error) {
		return;
	}

	if(xpd->current->parent) {
		if(!xmlStrcmp((xmlChar*) xpd->current->name, element_name)) {
			xpd->current = xpd->current->parent;
		}
	}
}

static void
purple_xmlnode_parser_element_text_libxml(void *user_data, const xmlChar *text, int text_len)
{
	struct _xmlnode_parser_data *xpd = user_data;

	if(!xpd->current || xpd->error) {
		return;
	}

	if(!text || !text_len) {
		return;
	}

	purple_xmlnode_insert_data(xpd->current, (const char*) text, text_len);
}

static void
purple_xmlnode_parser_error_libxml(void *user_data, const char *msg, ...)
{
	struct _xmlnode_parser_data *xpd = user_data;
	char errmsg[2048];
	va_list args;

	xpd->error = TRUE;

	va_start(args, msg);
	g_vsnprintf(errmsg, sizeof(errmsg), msg, args);
	va_end(args);

	purple_debug_error("xmlnode", "Error parsing xml file: %s", errmsg);
}

static void
purple_xmlnode_parser_structural_error_libxml(void *user_data, const xmlErrorPtr error)
{
	struct _xmlnode_parser_data *xpd = user_data;

	if (error && (error->level == XML_ERR_ERROR ||
	              error->level == XML_ERR_FATAL)) {
		xpd->error = TRUE;
		purple_debug_error("xmlnode", "XML parser error for PurpleXmlNode %p: "
		                   "Domain %i, code %i, level %i: %s",
		                   user_data, error->domain, error->code, error->level,
		                   error->message ? error->message : "(null)");
	} else if (error) {
		purple_debug_warning("xmlnode", "XML parser error for PurpleXmlNode %p: "
		                     "Domain %i, code %i, level %i: %s",
		                     user_data, error->domain, error->code, error->level,
		                     error->message ? error->message : "(null)");
	} else {
		purple_debug_warning("xmlnode", "XML parser error for PurpleXmlNode %p",
		                     user_data);
	}
}

static xmlSAXHandler purple_xmlnode_parser_libxml = {
	NULL, /* internalSubset */
	NULL, /* isStandalone */
	NULL, /* hasInternalSubset */
	NULL, /* hasExternalSubset */
	NULL, /* resolveEntity */
	NULL, /* getEntity */
	NULL, /* entityDecl */
	NULL, /* notationDecl */
	NULL, /* attributeDecl */
	NULL, /* elementDecl */
	NULL, /* unparsedEntityDecl */
	NULL, /* setDocumentLocator */
	NULL, /* startDocument */
	NULL, /* endDocument */
	NULL, /* startElement */
	NULL, /* endElement */
	NULL, /* reference */
	purple_xmlnode_parser_element_text_libxml, /* characters */
	NULL, /* ignorableWhitespace */
	NULL, /* processingInstruction */
	NULL, /* comment */
	NULL, /* warning */
	purple_xmlnode_parser_error_libxml, /* error */
	NULL, /* fatalError */
	NULL, /* getParameterEntity */
	NULL, /* cdataBlock */
	NULL, /* externalSubset */
	XML_SAX2_MAGIC, /* initialized */
	NULL, /* _private */
	purple_xmlnode_parser_element_start_libxml, /* startElementNs */
	purple_xmlnode_parser_element_end_libxml,   /* endElementNs   */
	(xmlStructuredErrorFunc)purple_xmlnode_parser_structural_error_libxml, /* serror */
};

PurpleXmlNode *
purple_xmlnode_from_str(const char *str, gssize size)
{
	struct _xmlnode_parser_data *xpd;
	PurpleXmlNode *ret;
	gsize real_size;

	g_return_val_if_fail(str != NULL, NULL);

	real_size = size < 0 ? strlen(str) : (gsize)size;
	xpd = g_new0(struct _xmlnode_parser_data, 1);

	if (xmlSAXUserParseMemory(&purple_xmlnode_parser_libxml, xpd, str, real_size) < 0) {
		while(xpd->current && xpd->current->parent) {
			xpd->current = xpd->current->parent;
		}
		g_clear_pointer(&xpd->current, purple_xmlnode_free);
	}
	ret = xpd->current;
	if (xpd->error) {
		ret = NULL;
		g_clear_pointer(&xpd->current, purple_xmlnode_free);
	}

	g_free(xpd);
	return ret;
}

PurpleXmlNode *
purple_xmlnode_from_file(const char *dir, const char *filename,
                         G_GNUC_UNUSED const char *description,
                         const char *process)
{
	gchar *filename_full;
	GError *error = NULL;
	gchar *contents = NULL;
	gsize length;
	PurpleXmlNode *node = NULL;

	g_return_val_if_fail(dir != NULL, NULL);

	purple_debug_misc(process, "Reading file %s from directory %s",
					filename, dir);

	filename_full = g_build_filename(dir, filename, NULL);

	if (!g_file_test(filename_full, G_FILE_TEST_EXISTS)) {
		purple_debug_info(process, "File %s does not exist (this is not "
						"necessarily an error)", filename_full);
		g_free(filename_full);
		return NULL;
	}

	if (!g_file_get_contents(filename_full, &contents, &length, &error)) {
		purple_debug_error(process, "Error reading file %s: %s",
						 filename_full, error->message);
		g_error_free(error);
	}

	if ((contents != NULL) && (length > 0)) {
		node = purple_xmlnode_from_str(contents, length);

		/* If we were unable to parse the file then save its contents to a backup file */
		if (node == NULL) {
			gchar *filename_temp, *filename_temp_full;

			filename_temp = g_strdup_printf("%s~", filename);
			filename_temp_full = g_build_filename(dir, filename_temp, NULL);

			purple_debug_error("util", "Error parsing file %s.  Renaming old "
							 "file to %s", filename_full, filename_temp);
			g_file_set_contents(filename_temp_full, contents, length, NULL);

			g_free(filename_temp_full);
			g_free(filename_temp);
		}

		g_free(contents);
	}

	/* If we could not parse the file then show the user an error message */
	if (node == NULL) {
		g_warning("failed to read %s", filename);
	}

	g_free(filename_full);

	return node;
}

static void
purple_xmlnode_copy_foreach_ns(gpointer key, gpointer value, gpointer user_data)
{
	GHashTable *ret = (GHashTable *)user_data;
	g_hash_table_insert(ret, g_strdup(key), g_strdup(value));
}

PurpleXmlNode *
purple_xmlnode_copy(const PurpleXmlNode *src)
{
	PurpleXmlNode *ret;
	PurpleXmlNode *child;
	PurpleXmlNode *sibling = NULL;

	g_return_val_if_fail(src != NULL, NULL);

	ret = new_node(src->name, src->type);
	ret->xmlns = g_strdup(src->xmlns);
	if (src->data) {
		if (src->data_sz) {
			ret->data = g_memdup2(src->data, src->data_sz);
			ret->data_sz = src->data_sz;
		} else {
			ret->data = g_strdup(src->data);
		}
	}
	ret->prefix = g_strdup(src->prefix);
	if (src->namespace_map) {
		ret->namespace_map = g_hash_table_new_full(g_str_hash, g_str_equal,
		                                           g_free, g_free);
		g_hash_table_foreach(src->namespace_map, purple_xmlnode_copy_foreach_ns, ret->namespace_map);
	}

	for (child = src->child; child; child = child->next) {
		if (sibling) {
			sibling->next = purple_xmlnode_copy(child);
			sibling = sibling->next;
		} else {
			ret->child = sibling = purple_xmlnode_copy(child);
		}
		sibling->parent = ret;
	}

	ret->lastchild = sibling;

	return ret;
}

PurpleXmlNode *
purple_xmlnode_get_next_twin(PurpleXmlNode *node)
{
	PurpleXmlNode *sibling;
	const char *ns = purple_xmlnode_get_namespace(node);

	g_return_val_if_fail(node != NULL, NULL);
	g_return_val_if_fail(node->type == PURPLE_XMLNODE_TYPE_TAG, NULL);

	for(sibling = node->next; sibling; sibling = sibling->next) {
		/* XXX: Is it correct to ignore the namespace for the match if none was specified? */
		const char *xmlns = NULL;
		if(ns) {
			xmlns = purple_xmlnode_get_namespace(sibling);
		}

		if(sibling->type == PURPLE_XMLNODE_TYPE_TAG && purple_strequal(node->name, sibling->name) &&
				purple_strequal(ns, xmlns)) {
			return sibling;
		}
	}

	return NULL;
}

GType
purple_xmlnode_get_type(void)
{
	static GType type = 0;

	if (type == 0) {
		type = g_boxed_type_register_static("PurpleXmlNode",
				(GBoxedCopyFunc)purple_xmlnode_copy,
				(GBoxedFreeFunc)purple_xmlnode_free);
	}

	return type;
}