ROX-Filer/src/xml.c

   1 /*
   2  * $Id$
   3  *
   4  * ROX-Filer, filer for the ROX desktop project
   5  * Copyright (C) 2002, the ROX-Filer team.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with
  18  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 /* xml.c - A GObject wrapper for libxml documents */
  23
  24 #include "config.h"
  25
  26 #include <string.h>
  27
  28 #include <libxml/parser.h>
  29
  30 #include "global.h"
  31
  32 #include "i18n.h"
  33 #include "xml.h"
  34
  35 static gpointer parent_class = NULL;
  36
  37 /* Static prototypes */
  38 static xmlNode *best_lang(xmlNode *first);
  39 static void xml_wrapper_finialize(GObject *object);
  40 static void xml_wrapper_class_init(gpointer gclass, gpointer data);
  41 static void xml_wrapper_init(GTypeInstance *object, gpointer gclass);
  42 static GType xml_wrapper_get_type(void);
  43
  44 /****************************************************************
  45  *                      EXTERNAL INTERFACE                      *
  46  ****************************************************************/
  47
  48 XMLwrapper *xml_new(const char *pathname)
  49 {
  50         xmlDocPtr doc = NULL;
  51         XMLwrapper *xml_data;
  52
  53         if (pathname)
  54         {
  55                 doc = xmlParseFile(pathname);
  56                 if (!doc)
  57                         return NULL;    /* Bad XML */
  58         }
  59
  60         xml_data = g_object_new(xml_wrapper_get_type(), NULL);
  61         xml_data->doc = doc;
  62
  63         return xml_data;
  64 }
  65
  66 /* Return the first child of the root node with this name */
  67 xmlNode *xml_get_section(XMLwrapper *xml, const gchar *ns, const gchar *name)
  68 {
  69         g_return_val_if_fail(xml != NULL, NULL);
  70         g_return_val_if_fail(xml->doc != NULL, NULL);
  71
  72         return get_subnode(xmlDocGetRootElement(xml->doc), ns, name);
  73 }
  74
  75 /* Return the (first) child of this node with the given name.
  76  * NULL if not found.
  77  * If there are several consecutive nodes with the same name but different
  78  * xml:lang attributes, then the one matching the current locale is used,
  79  * or the first one if none match.
  80  */
  81 xmlNode *get_subnode(xmlNode *node, const char *namespaceURI, const char *name)
  82 {
  83         for (node = node->xmlChildrenNode; node; node = node->next)
  84         {
  85                 if (node->type != XML_ELEMENT_NODE)
  86                         continue;
  87
  88                 if (strcmp(node->name, name))
  89                         continue;
  90
  91                 if (node->ns == NULL || namespaceURI == NULL)
  92                 {
  93                         if (node->ns == NULL && namespaceURI == NULL)
  94                                 return best_lang(node);
  95                         continue;
  96                 }
  97
  98                 if (strcmp(node->ns->href, namespaceURI) == 0)
  99                         return best_lang(node);
 100         }
 101
 102         return NULL;
 103 }
 104
 105 /****************************************************************
 106  *                      INTERNAL FUNCTIONS                      *
 107  ****************************************************************/
 108
 109 /* Taking this node and each directly following node with the same name,
 110  * return the one which matches the current LANG.
 111  * Return the node itself if nothing matches.
 112  */
 113 static xmlNode *best_lang(xmlNode *first)
 114 {
 115         xmlNode *node = first;
 116         const char *target_lang = current_lang ? current_lang : "en";
 117
 118         g_return_val_if_fail(first != NULL, NULL);
 119
 120         for (node = first->next; node; node = node->next)
 121         {
 122                 char *lang;
 123
 124                 if (node->type != XML_ELEMENT_NODE)
 125                         continue;
 126
 127                 /* Check names match... */
 128                 if (strcmp(node->name, first->name))
 129                         return first;
 130
 131                 /* Check namespaces match... */
 132                 if ((node->ns == NULL) != (first->ns == NULL))
 133                         return first;
 134
 135                 if (node->ns && first->ns)
 136                         if (strcmp(node->ns->href, first->ns->href))
 137                                 return first;
 138
 139                 lang = xmlNodeGetLang(node);
 140
 141                 if (!lang)
 142                         continue;
 143                 if (strcmp(lang, target_lang) == 0)
 144                 {
 145                         g_free(lang);
 146                         return node;
 147                 }
 148                 g_free(lang);
 149         }
 150
 151         return first;
 152 }
 153
 154 static void xml_wrapper_finialize(GObject *object)
 155 {
 156         XMLwrapper *xml = (XMLwrapper *) object;
 157
 158         if (xml->doc)
 159         {
 160                 xmlFreeDoc(xml->doc);
 161                 xml->doc = NULL;
 162         }
 163
 164         G_OBJECT_CLASS(parent_class)->finalize(object);
 165 }
 166
 167 static void xml_wrapper_class_init(gpointer gclass, gpointer data)
 168 {
 169         GObjectClass *object = (GObjectClass *) gclass;
 170
 171         parent_class = g_type_class_peek_parent(gclass);
 172
 173         object->finalize = xml_wrapper_finialize;
 174 }
 175
 176 static void xml_wrapper_init(GTypeInstance *object, gpointer gclass)
 177 {
 178         XMLwrapper *wrapper = (XMLwrapper *) object;
 179
 180         wrapper->doc = NULL;
 181 }
 182
 183 static GType xml_wrapper_get_type(void)
 184 {
 185         static GType type = 0;
 186
 187         if (!type)
 188         {
 189                 static const GTypeInfo info =
 190                 {
 191                         sizeof (XMLwrapperClass),
 192                         NULL,                   /* base_init */
 193                         NULL,                   /* base_finalise */
 194                         xml_wrapper_class_init,
 195                         NULL,                   /* class_finalise */
 196                         NULL,                   /* class_data */
 197                         sizeof(XMLwrapper),
 198                         0,                      /* n_preallocs */
 199                         xml_wrapper_init
 200                 };
 201
 202                 type = g_type_register_static(G_TYPE_OBJECT, "XMLwrapper",
 203                                               &info, 0);
 204         }
 205
 206         return type;
 207 }
 208