path: root/e-util/e-xml-utils.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-xml-utils.c
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Chris Lahey <clahey@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */


#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "e-xml-utils.h"

#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <locale.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <math.h>

#include <parser.h>
#include <xmlmemory.h>

#include "gal/util/e-i18n.h"
#include "gal/util/e-util.h"

xmlNode *
e_xml_get_child_by_name (const xmlNode *parent, const xmlChar *child_name)
{
    xmlNode *child;

    g_return_val_if_fail (parent != NULL, NULL);
    g_return_val_if_fail (child_name != NULL, NULL);
    
    for (child = parent->xmlChildrenNode; child != NULL; child = child->next) {
        if (xmlStrcmp (child->name, child_name) == 0) {
            return child;
        }
    }
    return NULL;
}

/* Returns the first child with the name child_name and the "lang"
 * attribute that matches the current LC_MESSAGES, or else, the first
 * child with the name child_name and no "lang" attribute.
 */
xmlNode *
e_xml_get_child_by_name_by_lang (const xmlNode *parent,
                 const xmlChar *child_name,
                 const gchar *lang)
{
    xmlNode *child;
    /* This is the default version of the string. */
    xmlNode *C = NULL;

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

    if (lang == NULL) {
#ifdef HAVE_LC_MESSAGES
        lang = setlocale (LC_MESSAGES, NULL);
#else
        lang = setlocale (LC_CTYPE, NULL);
#endif
    }
    for (child = parent->xmlChildrenNode; child != NULL; child = child->next) {
        if (xmlStrcmp (child->name, child_name) == 0) {
            xmlChar *this_lang = xmlGetProp (child, "lang");
            if (this_lang == NULL) {
                C = child;
            } else if (xmlStrcmp(this_lang, "lang") == 0) {
                return child;
            }
        }
    }
    return C;
}

static xmlNode *
e_xml_get_child_by_name_by_lang_list_with_score (const xmlNode *parent,
                         const gchar *name,
                         GList *lang_list,
                         gint *best_lang_score)
{
    xmlNodePtr best_node = NULL, node;

    for (node = parent->xmlChildrenNode; node != NULL; node = node->next) {
        xmlChar *lang;

        if (node->name == NULL || strcmp (node->name, name) != 0) {
            continue;
        }
        lang = xmlGetProp (node, "xml:lang");
        if (lang != NULL) {
            GList *l;
            gint i;

            for (l = lang_list, i = 0;
                 l != NULL && i < *best_lang_score;
                 l = l->next, i++) {
                if (strcmp ((gchar *) l->data, lang) == 0) {
                    best_node = node;
                    *best_lang_score = i;
                }
            }
        } else {
            if (best_node == NULL) {
                best_node = node;
            }
        }
        xmlFree (lang);
        if (*best_lang_score == 0) {
            return best_node;
        } 
    }

    return best_node;
}

/*
 * e_xml_get_child_by_name_by_lang_list:
 *
 */
xmlNode *
e_xml_get_child_by_name_by_lang_list (const xmlNode *parent,
                      const gchar *name,
                      GList *lang_list)
{
    gint best_lang_score = INT_MAX;

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

    if (lang_list == NULL) {
        lang_list = gnome_i18n_get_language_list ("LC_MESSAGES");
    }
    return e_xml_get_child_by_name_by_lang_list_with_score
        (parent,name,
         lang_list,
         &best_lang_score);
}

/*
 * e_xml_get_child_by_name_no_lang
 *
 */
xmlNode *
e_xml_get_child_by_name_no_lang (const xmlNode *parent, const gchar *name)
{
    xmlNodePtr node;

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

    for (node = parent->xmlChildrenNode; node != NULL; node = node->next) {
        xmlChar *lang;

        if (node->name == NULL || strcmp (node->name, name) != 0) {
            continue;
        }
        lang = xmlGetProp (node, "xml:lang");
        if (lang == NULL) {
            return node;
        }
        xmlFree (lang);
    }

    return NULL;
}

gint
e_xml_get_integer_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_integer_prop_by_name_with_default (parent, prop_name, 0);
}

gint
e_xml_get_integer_prop_by_name_with_default (const xmlNode *parent,
                         const xmlChar *prop_name,
                         gint def)
{
    xmlChar *prop;
    gint ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        (void) sscanf (prop, "%d", &ret_val);
        xmlFree (prop);
    }
    return ret_val;
}

void
e_xml_set_integer_prop_by_name (xmlNode *parent,
                const xmlChar *prop_name,
                gint value)
{
    gchar *valuestr;

    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    valuestr = g_strdup_printf ("%d", value);
    xmlSetProp (parent, prop_name, valuestr);
    g_free (valuestr);
}

guint
e_xml_get_uint_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_uint_prop_by_name_with_default (parent, prop_name, 0);
}

guint
e_xml_get_uint_prop_by_name_with_default (const xmlNode *parent,
                      const xmlChar *prop_name,
                      guint def)
{
    xmlChar *prop;
    guint ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        (void) sscanf (prop, "%u", &ret_val);
        xmlFree (prop);
    }
    return ret_val;
}

void
e_xml_set_uint_prop_by_name (xmlNode *parent,
                 const xmlChar *prop_name,
                 guint value)
{
    gchar *valuestr;

    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    valuestr = g_strdup_printf ("%u", value);
    xmlSetProp (parent, prop_name, valuestr);
    g_free (valuestr);
}

gboolean
e_xml_get_bool_prop_by_name (const xmlNode *parent,
                 const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_bool_prop_by_name_with_default (parent,
                             prop_name,
                             FALSE);
}

gboolean
e_xml_get_bool_prop_by_name_with_default(const xmlNode *parent,
                     const xmlChar *prop_name,
                     gboolean def)
{
    xmlChar *prop;
    gboolean ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        if (g_strcasecmp (prop, "true") == 0) {
            ret_val = TRUE;
        } else if (g_strcasecmp (prop, "false") == 0) {
            ret_val = FALSE;
        }
        xmlFree(prop);
    }
    return ret_val;
}

void
e_xml_set_bool_prop_by_name (xmlNode *parent, const xmlChar *prop_name, gboolean value)
{
    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    if (value) {
        xmlSetProp (parent, prop_name, "true");
    } else {
        xmlSetProp (parent, prop_name, "false");
    }
}

gdouble
e_xml_get_double_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_double_prop_by_name_with_default (parent, prop_name, 0.0);
}

gdouble
e_xml_get_double_prop_by_name_with_default (const xmlNode *parent, const xmlChar *prop_name, gdouble def)
{
    xmlChar *prop;
    gdouble ret_val = def;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        ret_val = e_flexible_strtod (prop, NULL);
        xmlFree (prop);
    }
    return ret_val;
}

void
e_xml_set_double_prop_by_name(xmlNode *parent, const xmlChar *prop_name, gdouble value)
{
    char buffer[E_ASCII_DTOSTR_BUF_SIZE];
    char *format;

    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    if (fabs (value) < 1e9 && fabs (value) > 1e-5) {
        format = g_strdup_printf ("%%.%df", DBL_DIG);
    } else {
        format = g_strdup_printf ("%%.%dg", DBL_DIG);
    }
    e_ascii_dtostr (buffer, sizeof (buffer), format, value);
    g_free (format);

    xmlSetProp (parent, prop_name, buffer);
}

gchar *
e_xml_get_string_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    return e_xml_get_string_prop_by_name_with_default (parent, prop_name, NULL);
}

gchar *
e_xml_get_string_prop_by_name_with_default (const xmlNode *parent, const xmlChar *prop_name, const gchar *def)
{
    xmlChar *prop;
    gchar *ret_val;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        ret_val = g_strdup (prop);
        xmlFree (prop);
    } else {
        ret_val = g_strdup (def);
    }
    return ret_val;
}

void
e_xml_set_string_prop_by_name (xmlNode *parent, const xmlChar *prop_name, const gchar *value)
{
    g_return_if_fail (parent != NULL);
    g_return_if_fail (prop_name != NULL);

    if (value != NULL) {
        xmlSetProp (parent, prop_name, value);
    }
}

gchar *
e_xml_get_translated_string_prop_by_name (const xmlNode *parent, const xmlChar *prop_name)
{
    xmlChar *prop;
    gchar *ret_val = NULL;
    gchar *combined_name;

    g_return_val_if_fail (parent != NULL, 0);
    g_return_val_if_fail (prop_name != NULL, 0);

    prop = xmlGetProp ((xmlNode *) parent, prop_name);
    if (prop != NULL) {
        ret_val = g_strdup (prop);
        xmlFree (prop);
        return ret_val;
    }

    combined_name = g_strdup_printf("_%s", prop_name);
    prop = xmlGetProp ((xmlNode *) parent, combined_name);
    if (prop != NULL) {
        ret_val = g_strdup (gettext(prop));
        xmlFree (prop);
    }
    g_free(combined_name);

    return ret_val;
}


/* Replacement for xmlSaveFile */

static void xmlNodeDump (xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur, int level, int format);


static void
xmlAttrDump (xmlBufferPtr buf, xmlDocPtr doc, xmlAttrPtr cur)
{
    xmlChar *value;
    
    if (cur == NULL) {
#ifdef DEBUG_TREE
        fprintf(stderr, "xmlAttrDump : property == NULL\n");
#endif
        return;
    }
    
    xmlBufferWriteChar (buf, " ");
    if ((cur->ns != NULL) && (cur->ns->prefix != NULL)) {
        xmlBufferWriteCHAR (buf, cur->ns->prefix);
        xmlBufferWriteChar (buf, ":");
    }
    
    xmlBufferWriteCHAR (buf, cur->name);
    value = xmlNodeListGetString (doc, cur->val, 0);
    if (value) {
        xmlBufferWriteChar (buf, "=");
        xmlBufferWriteQuotedString (buf, value);
        xmlFree (value);
    } else  {
        xmlBufferWriteChar (buf, "=\"\"");
    }
}

static void
xmlAttrListDump (xmlBufferPtr buf, xmlDocPtr doc, xmlAttrPtr cur)
{
    if (cur == NULL) {
#ifdef DEBUG_TREE
        fprintf(stderr, "xmlAttrListDump : property == NULL\n");
#endif
        return;
    }
    
    while (cur != NULL) {
        xmlAttrDump (buf, doc, cur);
        cur = cur->next;
    }
}

static void
xmlNodeListDump (xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur, int level, int format)
{
    int i;
    
    if (cur == NULL) {
#ifdef DEBUG_TREE
        fprintf(stderr, "xmlNodeListDump : node == NULL\n");
#endif
        return;
    }
    
    while (cur != NULL) {
        if ((format) && (xmlIndentTreeOutput) &&
            (cur->type == XML_ELEMENT_NODE))
            for (i = 0; i < level; i++)
                xmlBufferWriteChar (buf, "  ");
        xmlNodeDump (buf, doc, cur, level, format);
        if (format) {
            xmlBufferWriteChar (buf, "\n");
        }
        cur = cur->next;
    }
}

static void
xmlNodeDump (xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur, int level, int format)
{
    int i;
    xmlNodePtr tmp;
    
    if (cur == NULL) {
#ifdef DEBUG_TREE
        fprintf(stderr, "xmlNodeDump : node == NULL\n");
#endif
        return;
    }
    
    if (cur->type == XML_TEXT_NODE) {
        if (cur->content != NULL) {
            xmlChar *buffer;
            
#ifndef XML_USE_BUFFER_CONTENT
            buffer = xmlEncodeEntitiesReentrant (doc, cur->content);
#else
            buffer = xmlEncodeEntitiesReentrant (doc, xmlBufferContent (cur->content));
#endif
            if (buffer != NULL) {
                xmlBufferWriteCHAR (buf, buffer);
                xmlFree (buffer);
            }
        }
        return;
    }
    
    if (cur->type == XML_PI_NODE) {
        if (cur->content != NULL) {
            xmlBufferWriteChar (buf, "<?");
            xmlBufferWriteCHAR (buf, cur->name);
            if (cur->content != NULL) {
                xmlBufferWriteChar (buf, " ");
#ifndef XML_USE_BUFFER_CONTENT
                xmlBufferWriteCHAR (buf, cur->content);
#else
                xmlBufferWriteCHAR (buf, xmlBufferContent (cur->content));
#endif
            }
            xmlBufferWriteChar (buf, "?>");
        }
        return;
    }
    
    if (cur->type == XML_COMMENT_NODE) {
        if (cur->content != NULL) {
            xmlBufferWriteChar (buf, "<!--");
#ifndef XML_USE_BUFFER_CONTENT
            xmlBufferWriteCHAR (buf, cur->content);
#else
            xmlBufferWriteCHAR (buf, xmlBufferContent (cur->content));
#endif
            xmlBufferWriteChar (buf, "-->");
        }
        return;
    }
    
    if (cur->type == XML_ENTITY_REF_NODE) {
        xmlBufferWriteChar (buf, "&");
        xmlBufferWriteCHAR (buf, cur->name);
        xmlBufferWriteChar (buf, ";");
        return;
    }
    
    if (cur->type == XML_CDATA_SECTION_NODE) {
        xmlBufferWriteChar (buf, "<![CDATA[");
        if (cur->content != NULL)
#ifndef XML_USE_BUFFER_CONTENT
            xmlBufferWriteCHAR (buf, cur->content);
#else
        xmlBufferWriteCHAR (buf, xmlBufferContent(cur->content));
#endif
        xmlBufferWriteChar (buf, "]]>");
        return;
    }
    
    if (format == 1) {
        tmp = cur->childs;
        while (tmp != NULL) {
            if ((tmp->type == XML_TEXT_NODE) || 
                (tmp->type == XML_ENTITY_REF_NODE)) {
                format = 0;
                break;
            }
            tmp = tmp->next;
        }
    }
    
    xmlBufferWriteChar (buf, "<");
    if ((cur->ns != NULL) && (cur->ns->prefix != NULL)) {
        xmlBufferWriteCHAR (buf, cur->ns->prefix);
        xmlBufferWriteChar (buf, ":");
    }
    
    xmlBufferWriteCHAR (buf, cur->name);
    
    if (cur->properties != NULL)
        xmlAttrListDump (buf, doc, cur->properties);
    
    if ((cur->content == NULL) && (cur->childs == NULL) &&
        (!xmlSaveNoEmptyTags)) {
        xmlBufferWriteChar (buf, "/>");
        return;
    }
    
    xmlBufferWriteChar (buf, ">");
    if (cur->content != NULL) {
        xmlChar *buffer;
        
#ifndef XML_USE_BUFFER_CONTENT
        buffer = xmlEncodeEntitiesReentrant (doc, cur->content);
#else
        buffer = xmlEncodeEntitiesReentrant (doc, xmlBufferContent (cur->content));
#endif
        if (buffer != NULL) {
            xmlBufferWriteCHAR (buf, buffer);
            xmlFree (buffer);
        }
    }
    
    if (cur->childs != NULL) {
        if (format)
            xmlBufferWriteChar (buf, "\n");
        
        xmlNodeListDump (buf, doc, cur->childs, (level >= 0 ? level + 1 : -1), format);
        if ((xmlIndentTreeOutput) && (format))
            for (i = 0; i < level; i++)
                xmlBufferWriteChar (buf, "  ");
    }
    
    xmlBufferWriteChar (buf, "</");
    if ((cur->ns != NULL) && (cur->ns->prefix != NULL)) {
        xmlBufferWriteCHAR (buf, cur->ns->prefix);
        xmlBufferWriteChar (buf, ":");
    }
    
    xmlBufferWriteCHAR (buf, cur->name);
    xmlBufferWriteChar (buf, ">");
}

static void
xmlDocContentDump (xmlBufferPtr buf, xmlDocPtr cur)
{
    xmlBufferWriteChar (buf, "<?xml version=");
    
    if (cur->version != NULL)
        xmlBufferWriteQuotedString (buf, cur->version);
    else
        xmlBufferWriteChar (buf, "\"1.0\"");
    
    if ((cur->encoding != NULL) &&
        (strcasecmp (cur->encoding, "UTF-8") != 0)) {
        xmlBufferWriteChar (buf, " encoding=");
        xmlBufferWriteQuotedString (buf, cur->encoding);
    }
    
    switch (cur->standalone) {
        case 1:
        xmlBufferWriteChar (buf, " standalone=\"yes\"");
        break;
    }
    
    xmlBufferWriteChar (buf, "?>\n");
    if (cur->root != NULL) {
        xmlNodePtr child = cur->root;
        
        while (child != NULL) {
            xmlNodeDump (buf, cur, child, 0, 1);
            xmlBufferWriteChar (buf, "\n");
            child = child->next;
        }
    }
}

int
e_xml_save_file (const char *filename, xmlDocPtr doc)
{
    size_t n, written = 0;
    xmlBufferPtr buf;
    int errnosave;
    ssize_t w;
    int fd;
    
    fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
    if (fd == -1)
        return -1;
    
    if (!(buf = xmlBufferCreate ())) {
        close (fd);
        unlink (filename);
        errno = ENOMEM;
        return -1;
    }
    
    xmlDocContentDump (buf, doc);
    
    n = buf->use;
    do {
        do {
            w = write (fd, buf->content + written, n - written);
        } while (w == -1 && errno == EINTR);
        
        if (w > 0)
            written += w;
    } while (w != -1 && written < n);
    
    xmlBufferFree (buf);
    
    if (written < n || fsync (fd) == -1) {
        errnosave = errno;
        close (fd);
        unlink (filename);
        errno = errnosave;
        return -1;
    }
    
    close (fd);
    
    return 0;
}