obt/xml.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    obt/xml.c for the Openbox window manager
   4    Copyright (c) 2003-2007   Dana Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #include "obt/xml.h"
  20 #include "obt/paths.h"
  21
  22 #include <glib.h>
  23
  24 #ifdef HAVE_STDLIB_H
  25 #  include <stdlib.h>
  26 #endif
  27 #ifdef HAVE_SYS_STAT_H
  28 #  include <sys/stat.h>
  29 #endif
  30 #ifdef HAVE_SYS_TYPES_H
  31 #  include <sys/types.h>
  32 #endif
  33 #ifdef HAVE_UNISTD_H
  34 #  include <unistd.h>
  35 #endif
  36
  37 struct Callback {
  38     gchar *tag;
  39     ObtXmlCallback func;
  40     gpointer data;
  41 };
  42
  43 struct _ObtXmlInst {
  44     gint ref;
  45     ObtPaths *xdg_paths;
  46     GHashTable *callbacks;
  47     xmlDocPtr doc;
  48     xmlNodePtr root;
  49     gchar *path;
  50 };
  51
  52 static void destfunc(struct Callback *c)
  53 {
  54     g_free(c->tag);
  55     g_slice_free(struct Callback, c);
  56 }
  57
  58 ObtXmlInst* obt_xml_instance_new(void)
  59 {
  60     ObtXmlInst *i = g_slice_new(ObtXmlInst);
  61     i->ref = 1;
  62     i->xdg_paths = obt_paths_new();
  63     i->callbacks = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
  64                                          (GDestroyNotify)destfunc);
  65     i->doc = NULL;
  66     i->root = NULL;
  67     i->path = NULL;
  68     return i;
  69 }
  70
  71 void obt_xml_instance_ref(ObtXmlInst *i)
  72 {
  73     ++i->ref;
  74 }
  75
  76 void obt_xml_instance_unref(ObtXmlInst *i)
  77 {
  78     if (i && --i->ref == 0) {
  79         obt_paths_unref(i->xdg_paths);
  80         g_hash_table_destroy(i->callbacks);
  81         g_slice_free(ObtXmlInst, i);
  82     }
  83 }
  84
  85 xmlDocPtr obt_xml_doc(ObtXmlInst *i)
  86 {
  87     g_assert(i->doc); /* a doc is open? */
  88     return i->doc;
  89 }
  90
  91 xmlNodePtr obt_xml_root(ObtXmlInst *i)
  92 {
  93     g_assert(i->doc); /* a doc is open? */
  94     return i->root;
  95 }
  96
  97 void obt_xml_register(ObtXmlInst *i, const gchar *tag,
  98                       ObtXmlCallback func, gpointer data)
  99 {
 100     struct Callback *c;
 101
 102     if (g_hash_table_lookup(i->callbacks, tag)) {
 103         g_error("Tag '%s' already registered", tag);
 104         return;
 105     }
 106
 107     c = g_slice_new(struct Callback);
 108     c->tag = g_strdup(tag);
 109     c->func = func;
 110     c->data = data;
 111     g_hash_table_insert(i->callbacks, c->tag, c);
 112 }
 113
 114 static gboolean load_file(ObtXmlInst *i,
 115                           const gchar *domain,
 116                           const gchar *filename,
 117                           const gchar *root_node,
 118                           GSList *paths)
 119 {
 120     GSList *it;
 121     gboolean r = FALSE;
 122
 123     g_assert(i->doc == NULL); /* another doc isn't open already? */
 124
 125     for (it = paths; !r && it; it = g_slist_next(it)) {
 126         gchar *path;
 127         struct stat s;
 128
 129         if (!domain && !filename) /* given a full path to the file */
 130             path = g_strdup(it->data);
 131         else
 132             path = g_build_filename(it->data, domain, filename, NULL);
 133
 134         if (stat(path, &s) >= 0) {
 135             /* XML_PARSE_BLANKS is needed apparently, or the tree can end up
 136                with extra nodes in it. */
 137             i->doc = xmlReadFile(path, NULL, (XML_PARSE_NOBLANKS |
 138                                               XML_PARSE_RECOVER |
 139                                               XML_PARSE_XINCLUDE));
 140             if (i->doc) {
 141                 i->root = xmlDocGetRootElement(i->doc);
 142                 if (!i->root) {
 143                     xmlFreeDoc(i->doc);
 144                     i->doc = NULL;
 145                     g_message("%s is an empty XML document", path);
 146                 }
 147                 else if (xmlStrcmp(i->root->name,
 148                                    (const xmlChar*)root_node)) {
 149                     xmlFreeDoc(i->doc);
 150                     i->doc = NULL;
 151                     i->root = NULL;
 152                     g_message("XML document %s is of wrong type. Root "
 153                               "node is not '%s'", path, root_node);
 154                 }
 155                 else {
 156                     i->path = g_strdup(path);
 157                     r = TRUE; /* ok! */
 158                 }
 159             }
 160         }
 161
 162         g_free(path);
 163     }
 164
 165     return r;
 166 }
 167
 168 gboolean obt_xml_load_file(ObtXmlInst *i,
 169                            const gchar *path,
 170                            const gchar *root_node)
 171 {
 172     GSList *paths;
 173     gboolean r;
 174
 175     paths = g_slist_append(NULL, g_strdup(path));
 176
 177     r = load_file(i, NULL, NULL, root_node, paths);
 178
 179     while (paths) {
 180         g_free(paths->data);
 181         paths = g_slist_delete_link(paths, paths);
 182     }
 183     return r;
 184 }
 185
 186 gboolean obt_xml_load_config_file(ObtXmlInst *i,
 187                                   const gchar *domain,
 188                                   const gchar *filename,
 189                                   const gchar *root_node)
 190 {
 191     GSList *it, *paths = NULL;
 192     gboolean r;
 193
 194     for (it = obt_paths_config_dirs(i->xdg_paths); it; it = g_slist_next(it))
 195         paths = g_slist_append(paths, g_strdup(it->data));
 196
 197     r = load_file(i, domain, filename, root_node, paths);
 198
 199     while (paths) {
 200         g_free(paths->data);
 201         paths = g_slist_delete_link(paths, paths);
 202     }
 203     return r;
 204 }
 205
 206 gboolean obt_xml_load_data_file(ObtXmlInst *i,
 207                                 const gchar *domain,
 208                                 const gchar *filename,
 209                                 const gchar *root_node)
 210 {
 211     GSList *it, *paths = NULL;
 212     gboolean r;
 213
 214     for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
 215         paths = g_slist_append(paths, g_strdup(it->data));
 216
 217     r = load_file(i, domain, filename, root_node, paths);
 218
 219     while (paths) {
 220         g_free(paths->data);
 221         paths = g_slist_delete_link(paths, paths);
 222     }
 223     return r;
 224 }
 225
 226 gboolean obt_xml_load_theme_file(ObtXmlInst *i,
 227                                  const gchar *theme,
 228                                  const gchar *domain,
 229                                  const gchar *filename,
 230                                  const gchar *root_node)
 231 {
 232     GSList *it, *paths = NULL;
 233     gboolean r;
 234
 235     /* use ~/.themes for backwards compatibility */
 236     paths = g_slist_append
 237         (paths, g_build_filename(g_get_home_dir(), ".themes", theme, NULL));
 238
 239     for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
 240         paths = g_slist_append
 241             (paths, g_build_filename(it->data, "themes", theme, NULL));
 242
 243     r = load_file(i, domain, filename, root_node, paths);
 244
 245     while (paths) {
 246         g_free(paths->data);
 247         paths = g_slist_delete_link(paths, paths);
 248     }
 249     return r;
 250 }
 251
 252
 253 gboolean obt_xml_load_mem(ObtXmlInst *i,
 254                           gpointer data, guint len, const gchar *root_node)
 255 {
 256     gboolean r = FALSE;
 257
 258     g_assert(i->doc == NULL); /* another doc isn't open already? */
 259
 260     i->doc = xmlParseMemory(data, len);
 261     if (i) {
 262         i->root = xmlDocGetRootElement(i->doc);
 263         if (!i->root) {
 264             xmlFreeDoc(i->doc);
 265             i->doc = NULL;
 266             g_message("Given memory is an empty document");
 267         }
 268         else if (xmlStrcmp(i->root->name, (const xmlChar*)root_node)) {
 269             xmlFreeDoc(i->doc);
 270             i->doc = NULL;
 271             i->root = NULL;
 272             g_message("XML Document in given memory is of wrong "
 273                       "type. Root node is not '%s'\n", root_node);
 274         }
 275         else
 276             r = TRUE; /* ok ! */
 277     }
 278     return r;
 279 }
 280
 281 gboolean obt_xml_save_file(ObtXmlInst *inst,
 282                            const gchar *path,
 283                            gboolean pretty)
 284 {
 285     return xmlSaveFormatFile(path, inst->doc, pretty) != -1;
 286 }
 287
 288 void obt_xml_close(ObtXmlInst *i)
 289 {
 290     if (i && i->doc) {
 291         xmlFreeDoc(i->doc);
 292         g_free(i->path);
 293         i->doc = NULL;
 294         i->root = NULL;
 295         i->path = NULL;
 296     }
 297 }
 298
 299 void obt_xml_tree(ObtXmlInst *i, xmlNodePtr node)
 300 {
 301     g_assert(i->doc); /* a doc is open? */
 302
 303     while (node) {
 304         if (node->name) {
 305             struct Callback *c = g_hash_table_lookup(i->callbacks, node->name);
 306             if (c) c->func(node, c->data);
 307         }
 308         node = node->next;
 309     }
 310 }
 311
 312 void obt_xml_tree_from_root(ObtXmlInst *i)
 313 {
 314     obt_xml_tree(i, i->root->children);
 315 }
 316
 317 gchar *obt_xml_node_string(xmlNodePtr node)
 318 {
 319     xmlChar *c = xmlNodeGetContent(node);
 320     gchar *s;
 321     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 322     s = g_strdup(c ? (gchar*)c : "");
 323     xmlFree(c);
 324     return s;
 325 }
 326
 327 gint obt_xml_node_int(xmlNodePtr node)
 328 {
 329     xmlChar *c = xmlNodeGetContent(node);
 330     gint i;
 331     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 332     i = c ? atoi((gchar*)c) : 0;
 333     xmlFree(c);
 334     return i;
 335 }
 336
 337 gboolean obt_xml_node_bool(xmlNodePtr node)
 338 {
 339     xmlChar *c = xmlNodeGetContent(node);
 340     gboolean b = FALSE;
 341     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 342     if (c && !xmlStrcasecmp(c, (const xmlChar*) "true"))
 343         b = TRUE;
 344     else if (c && !xmlStrcasecmp(c, (const xmlChar*) "yes"))
 345         b = TRUE;
 346     else if (c && !xmlStrcasecmp(c, (const xmlChar*) "on"))
 347         b = TRUE;
 348     xmlFree(c);
 349     return b;
 350 }
 351
 352 gboolean obt_xml_node_contains(xmlNodePtr node, const gchar *val)
 353 {
 354     xmlChar *c = xmlNodeGetContent(node);
 355     gboolean r;
 356     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 357     r = !xmlStrcasecmp(c, (const xmlChar*) val);
 358     xmlFree(c);
 359     return r;
 360 }
 361
 362 xmlNodePtr obt_xml_find_node(xmlNodePtr node, const gchar *tag)
 363 {
 364     while (node) {
 365         if (!xmlStrcmp(node->name, (const xmlChar*) tag))
 366             return node;
 367         node = node->next;
 368     }
 369     return NULL;
 370 }
 371
 372 gboolean obt_xml_attr_bool(xmlNodePtr node, const gchar *name,
 373                            gboolean *value)
 374 {
 375     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 376     gboolean r = FALSE;
 377     if (c) {
 378         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 379         if (!xmlStrcasecmp(c, (const xmlChar*) "true"))
 380             *value = TRUE, r = TRUE;
 381         else if (!xmlStrcasecmp(c, (const xmlChar*) "yes"))
 382             *value = TRUE, r = TRUE;
 383         else if (!xmlStrcasecmp(c, (const xmlChar*) "on"))
 384             *value = TRUE, r = TRUE;
 385         else if (!xmlStrcasecmp(c, (const xmlChar*) "false"))
 386             *value = FALSE, r = TRUE;
 387         else if (!xmlStrcasecmp(c, (const xmlChar*) "no"))
 388             *value = FALSE, r = TRUE;
 389         else if (!xmlStrcasecmp(c, (const xmlChar*) "off"))
 390             *value = FALSE, r = TRUE;
 391     }
 392     xmlFree(c);
 393     return r;
 394 }
 395
 396 gboolean obt_xml_attr_int(xmlNodePtr node, const gchar *name, gint *value)
 397 {
 398     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 399     gboolean r = FALSE;
 400     if (c) {
 401         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 402         *value = atoi((gchar*)c);
 403         r = TRUE;
 404     }
 405     xmlFree(c);
 406     return r;
 407 }
 408
 409 gboolean obt_xml_attr_string(xmlNodePtr node, const gchar *name,
 410                              gchar **value)
 411 {
 412     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 413     gboolean r = FALSE;
 414     if (c) {
 415         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 416         *value = g_strdup((gchar*)c);
 417         r = TRUE;
 418     }
 419     xmlFree(c);
 420     return r;
 421 }
 422
 423 gboolean obt_xml_attr_contains(xmlNodePtr node, const gchar *name,
 424                                const gchar *val)
 425 {
 426     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 427     gboolean r = FALSE;
 428     if (c) {
 429         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 430         r = !xmlStrcasecmp(c, (const xmlChar*) val);
 431     }
 432     xmlFree(c);
 433     return r;
 434 }