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 <libxml/xinclude.h>
  23 #include <glib.h>
  24
  25 #ifdef HAVE_STDLIB_H
  26 #  include <stdlib.h>
  27 #endif
  28 #ifdef HAVE_SYS_STAT_H
  29 #  include <sys/stat.h>
  30 #endif
  31 #ifdef HAVE_SYS_TYPES_H
  32 #  include <sys/types.h>
  33 #endif
  34 #ifdef HAVE_UNISTD_H
  35 #  include <unistd.h>
  36 #endif
  37
  38 struct Callback {
  39     gchar *tag;
  40     ObtXmlCallback func;
  41     gpointer data;
  42 };
  43
  44 struct _ObtXmlInst {
  45     gint ref;
  46     ObtPaths *xdg_paths;
  47     GHashTable *callbacks;
  48     xmlDocPtr doc;
  49     xmlNodePtr root;
  50     gchar *path;
  51 };
  52
  53 static void destfunc(struct Callback *c)
  54 {
  55     g_free(c->tag);
  56     g_slice_free(struct Callback, c);
  57 }
  58
  59 ObtXmlInst* obt_xml_instance_new(void)
  60 {
  61     ObtXmlInst *i = g_slice_new(ObtXmlInst);
  62     i->ref = 1;
  63     i->xdg_paths = obt_paths_new();
  64     i->callbacks = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
  65                                          (GDestroyNotify)destfunc);
  66     i->doc = NULL;
  67     i->root = NULL;
  68     i->path = NULL;
  69     return i;
  70 }
  71
  72 void obt_xml_instance_ref(ObtXmlInst *i)
  73 {
  74     ++i->ref;
  75 }
  76
  77 void obt_xml_instance_unref(ObtXmlInst *i)
  78 {
  79     if (i && --i->ref == 0) {
  80         obt_paths_unref(i->xdg_paths);
  81         g_hash_table_destroy(i->callbacks);
  82         g_slice_free(ObtXmlInst, i);
  83     }
  84 }
  85
  86 xmlDocPtr obt_xml_doc(ObtXmlInst *i)
  87 {
  88     g_assert(i->doc); /* a doc is open? */
  89     return i->doc;
  90 }
  91
  92 xmlNodePtr obt_xml_root(ObtXmlInst *i)
  93 {
  94     g_assert(i->doc); /* a doc is open? */
  95     return i->root;
  96 }
  97
  98 void obt_xml_register(ObtXmlInst *i, const gchar *tag,
  99                       ObtXmlCallback func, gpointer data)
 100 {
 101     struct Callback *c;
 102
 103     if (g_hash_table_lookup(i->callbacks, tag)) {
 104         g_error("Tag '%s' already registered", tag);
 105         return;
 106     }
 107
 108     c = g_slice_new(struct Callback);
 109     c->tag = g_strdup(tag);
 110     c->func = func;
 111     c->data = data;
 112     g_hash_table_insert(i->callbacks, c->tag, c);
 113 }
 114
 115 void obt_xml_unregister(ObtXmlInst *i, const gchar *tag)
 116 {
 117     g_hash_table_remove(i->callbacks, tag);
 118 }
 119
 120 void obt_xml_new_file(ObtXmlInst *i,
 121                       const gchar *root_node)
 122 {
 123     xmlNodePtr old;
 124
 125     g_assert(i->doc == NULL); /* another doc isn't open already? */
 126
 127     i->doc = xmlNewDoc((xmlChar*)"1.0");
 128     i->root = xmlNewDocRawNode(i->doc, NULL, (xmlChar*)root_node, NULL);
 129     old = xmlDocSetRootElement(i->doc, i->root);
 130     if (old) xmlFreeNode(old);
 131 }
 132
 133 static gboolean load_file(ObtXmlInst *i,
 134                           const gchar *domain,
 135                           const gchar *filename,
 136                           const gchar *root_node,
 137                           GSList *paths)
 138 {
 139     GSList *it;
 140     gboolean r = FALSE;
 141
 142     g_assert(i->doc == NULL); /* another doc isn't open already? */
 143
 144     for (it = paths; !r && it; it = g_slist_next(it)) {
 145         gchar *path;
 146         struct stat s;
 147
 148         if (!domain && !filename) /* given a full path to the file */
 149             path = g_strdup(it->data);
 150         else
 151             path = g_build_filename(it->data, domain, filename, NULL);
 152
 153         if (stat(path, &s) >= 0) {
 154             /* XML_PARSE_BLANKS is needed apparently, or the tree can end up
 155                with extra nodes in it. */
 156             i->doc = xmlReadFile(path, NULL, (XML_PARSE_NOBLANKS |
 157                                               XML_PARSE_RECOVER));
 158             xmlXIncludeProcessFlags(i->doc, (XML_PARSE_NOBLANKS |
 159                                              XML_PARSE_RECOVER));
 160             if (i->doc) {
 161                 i->root = xmlDocGetRootElement(i->doc);
 162                 if (!i->root) {
 163                     xmlFreeDoc(i->doc);
 164                     i->doc = NULL;
 165                     g_message("%s is an empty XML document", path);
 166                 }
 167                 else if (xmlStrcmp(i->root->name,
 168                                    (const xmlChar*)root_node)) {
 169                     xmlFreeDoc(i->doc);
 170                     i->doc = NULL;
 171                     i->root = NULL;
 172                     g_message("XML document %s is of wrong type. Root "
 173                               "node is not '%s'", path, root_node);
 174                 }
 175                 else {
 176                     i->path = g_strdup(path);
 177                     r = TRUE; /* ok! */
 178                 }
 179             }
 180         }
 181
 182         g_free(path);
 183     }
 184
 185     return r;
 186 }
 187
 188 gboolean obt_xml_load_file(ObtXmlInst *i,
 189                            const gchar *path,
 190                            const gchar *root_node)
 191 {
 192     GSList *paths;
 193     gboolean r;
 194
 195     paths = g_slist_append(NULL, g_strdup(path));
 196
 197     r = load_file(i, NULL, NULL, 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_cache_file(ObtXmlInst *i,
 207                                  const gchar *domain,
 208                                  const gchar *filename,
 209                                  const gchar *root_node)
 210 {
 211     GSList *paths = NULL;
 212     gboolean r;
 213
 214     paths = g_slist_append(paths,
 215                            g_strdup(obt_paths_cache_home(i->xdg_paths)));
 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_config_file(ObtXmlInst *i,
 227                                   const gchar *domain,
 228                                   const gchar *filename,
 229                                   const gchar *root_node)
 230 {
 231     GSList *it, *paths = NULL;
 232     gboolean r;
 233
 234     for (it = obt_paths_config_dirs(i->xdg_paths); it; it = g_slist_next(it))
 235         paths = g_slist_append(paths, g_strdup(it->data));
 236
 237     r = load_file(i, domain, filename, root_node, paths);
 238
 239     while (paths) {
 240         g_free(paths->data);
 241         paths = g_slist_delete_link(paths, paths);
 242     }
 243     return r;
 244 }
 245
 246 gboolean obt_xml_load_data_file(ObtXmlInst *i,
 247                                 const gchar *domain,
 248                                 const gchar *filename,
 249                                 const gchar *root_node)
 250 {
 251     GSList *it, *paths = NULL;
 252     gboolean r;
 253
 254     for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
 255         paths = g_slist_append(paths, g_strdup(it->data));
 256
 257     r = load_file(i, domain, filename, root_node, paths);
 258
 259     while (paths) {
 260         g_free(paths->data);
 261         paths = g_slist_delete_link(paths, paths);
 262     }
 263     return r;
 264 }
 265
 266 gboolean obt_xml_load_theme_file(ObtXmlInst *i,
 267                                  const gchar *theme,
 268                                  const gchar *domain,
 269                                  const gchar *filename,
 270                                  const gchar *root_node)
 271 {
 272     GSList *it, *paths = NULL;
 273     gboolean r;
 274
 275     /* use ~/.themes for backwards compatibility */
 276     paths = g_slist_append
 277         (paths, g_build_filename(g_get_home_dir(), ".themes", theme, NULL));
 278
 279     for (it = obt_paths_data_dirs(i->xdg_paths); it; it = g_slist_next(it))
 280         paths = g_slist_append
 281             (paths, g_build_filename(it->data, "themes", theme, NULL));
 282
 283     r = load_file(i, domain, filename, root_node, paths);
 284
 285     while (paths) {
 286         g_free(paths->data);
 287         paths = g_slist_delete_link(paths, paths);
 288     }
 289     return r;
 290 }
 291
 292
 293 gboolean obt_xml_load_mem(ObtXmlInst *i,
 294                           gpointer data, guint len, const gchar *root_node)
 295 {
 296     gboolean r = FALSE;
 297
 298     g_assert(i->doc == NULL); /* another doc isn't open already? */
 299
 300     i->doc = xmlParseMemory(data, len);
 301     if (i) {
 302         i->root = xmlDocGetRootElement(i->doc);
 303         if (!i->root) {
 304             xmlFreeDoc(i->doc);
 305             i->doc = NULL;
 306             g_message("Given memory is an empty document");
 307         }
 308         else if (xmlStrcmp(i->root->name, (const xmlChar*)root_node)) {
 309             xmlFreeDoc(i->doc);
 310             i->doc = NULL;
 311             i->root = NULL;
 312             g_message("XML Document in given memory is of wrong "
 313                       "type. Root node is not '%s'\n", root_node);
 314         }
 315         else
 316             r = TRUE; /* ok ! */
 317     }
 318     return r;
 319 }
 320
 321 gboolean obt_xml_save_file(ObtXmlInst *inst,
 322                            const gchar *path,
 323                            gboolean pretty)
 324 {
 325     return xmlSaveFormatFile(path, inst->doc, pretty) != -1;
 326 }
 327
 328 gboolean obt_xml_save_cache_file(ObtXmlInst *inst,
 329                                  const gchar *domain,
 330                                  const gchar *filename,
 331                                  gboolean pretty)
 332 {
 333     gchar *dpath, *fpath;
 334     gboolean ok;
 335
 336     dpath = g_build_filename(obt_paths_cache_home(inst->xdg_paths),
 337                              domain, NULL);
 338     fpath = g_build_filename(dpath, filename, NULL);
 339
 340     ok = obt_paths_mkdir_path(dpath, 0700);
 341     ok = ok && obt_xml_save_file(inst, fpath, pretty);
 342
 343     g_free(fpath);
 344     g_free(dpath);
 345     return ok;
 346 }
 347
 348 void obt_xml_close(ObtXmlInst *i)
 349 {
 350     if (i && i->doc) {
 351         xmlFreeDoc(i->doc);
 352         g_free(i->path);
 353         i->doc = NULL;
 354         i->root = NULL;
 355         i->path = NULL;
 356     }
 357 }
 358
 359 void obt_xml_tree(ObtXmlInst *i, xmlNodePtr node)
 360 {
 361     g_assert(i->doc); /* a doc is open? */
 362
 363     while (node) {
 364         if (node->name) {
 365             struct Callback *c = g_hash_table_lookup(i->callbacks, node->name);
 366             if (c) c->func(node, c->data);
 367         }
 368         node = node->next;
 369     }
 370 }
 371
 372 void obt_xml_tree_from_root(ObtXmlInst *i)
 373 {
 374     obt_xml_tree(i, i->root->children);
 375 }
 376
 377 gchar *obt_xml_node_string(xmlNodePtr node)
 378 {
 379     xmlChar *c = xmlNodeGetContent(node);
 380     gchar *s;
 381     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 382     s = g_strdup(c ? (gchar*)c : "");
 383     xmlFree(c);
 384     return s;
 385 }
 386
 387 gint obt_xml_node_int(xmlNodePtr node)
 388 {
 389     xmlChar *c = xmlNodeGetContent(node);
 390     gint i;
 391     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 392     i = c ? atoi((gchar*)c) : 0;
 393     xmlFree(c);
 394     return i;
 395 }
 396
 397 gboolean obt_xml_node_bool(xmlNodePtr node)
 398 {
 399     xmlChar *c = xmlNodeGetContent(node);
 400     gboolean b = FALSE;
 401     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 402     if (c && !xmlStrcasecmp(c, (const xmlChar*) "true"))
 403         b = TRUE;
 404     else if (c && !xmlStrcasecmp(c, (const xmlChar*) "yes"))
 405         b = TRUE;
 406     else if (c && !xmlStrcasecmp(c, (const xmlChar*) "on"))
 407         b = TRUE;
 408     xmlFree(c);
 409     return b;
 410 }
 411
 412 gboolean obt_xml_node_contains(xmlNodePtr node, const gchar *val)
 413 {
 414     xmlChar *c = xmlNodeGetContent(node);
 415     gboolean r;
 416     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 417     r = !xmlStrcasecmp(c, (const xmlChar*) val);
 418     xmlFree(c);
 419     return r;
 420 }
 421
 422 xmlNodePtr obt_xml_find_sibling(xmlNodePtr node, const gchar *tag)
 423 {
 424     while (node) {
 425         if (!xmlStrcmp(node->name, (const xmlChar*) tag))
 426             return node;
 427         node = node->next;
 428     }
 429     return NULL;
 430 }
 431
 432 void obt_xml_node_set_string(xmlNodePtr node, const gchar *s)
 433 {
 434     xmlNodeSetContent(node, (const xmlChar*)s);
 435 }
 436
 437 void obt_xml_node_set_int(xmlNodePtr node, gint i)
 438 {
 439     gchar *s = g_strdup_printf("%d", i);
 440     obt_xml_node_set_string(node, s);
 441     g_free(s);
 442 }
 443
 444 void obt_xml_node_set_bool(xmlNodePtr node, gboolean b)
 445 {
 446     obt_xml_node_set_string(node, b ? "yes" : "no");
 447 }
 448
 449 gboolean obt_xml_attr_bool(xmlNodePtr node, const gchar *name,
 450                            gboolean *value)
 451 {
 452     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 453     gboolean r = FALSE;
 454     if (c) {
 455         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 456         if (!xmlStrcasecmp(c, (const xmlChar*) "true"))
 457             *value = TRUE, r = TRUE;
 458         else if (!xmlStrcasecmp(c, (const xmlChar*) "yes"))
 459             *value = TRUE, r = TRUE;
 460         else if (!xmlStrcasecmp(c, (const xmlChar*) "on"))
 461             *value = TRUE, r = TRUE;
 462         else if (!xmlStrcasecmp(c, (const xmlChar*) "false"))
 463             *value = FALSE, r = TRUE;
 464         else if (!xmlStrcasecmp(c, (const xmlChar*) "no"))
 465             *value = FALSE, r = TRUE;
 466         else if (!xmlStrcasecmp(c, (const xmlChar*) "off"))
 467             *value = FALSE, r = TRUE;
 468     }
 469     xmlFree(c);
 470     return r;
 471 }
 472
 473 gboolean obt_xml_attr_int(xmlNodePtr node, const gchar *name, gint *value)
 474 {
 475     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 476     gboolean r = FALSE;
 477     if (c) {
 478         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 479         *value = atoi((gchar*)c);
 480         r = TRUE;
 481     }
 482     xmlFree(c);
 483     return r;
 484 }
 485
 486 gboolean obt_xml_attr_string(xmlNodePtr node, const gchar *name,
 487                              gchar **value)
 488 {
 489     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 490     gboolean r = FALSE;
 491     if (c) {
 492         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 493         *value = g_strdup((gchar*)c);
 494         r = TRUE;
 495     }
 496     xmlFree(c);
 497     return r;
 498 }
 499
 500 gboolean obt_xml_attr_contains(xmlNodePtr node, const gchar *name,
 501                                const gchar *val)
 502 {
 503     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 504     gboolean r = FALSE;
 505     if (c) {
 506         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 507         r = !xmlStrcasecmp(c, (const xmlChar*) val);
 508     }
 509     xmlFree(c);
 510     return r;
 511 }
 512
 513 /*! Finds a sibling which matches a name and attributes.
 514   @first The first sibling in the list.
 515   @attrs NULL-terminated array of strings.  The first string is the name of
 516     the node.  The remaining values are key,value pairs for attributes the
 517     node should have.
 518 */
 519 static xmlNodePtr find_sibling(xmlNodePtr first, gchar **attrs)
 520 {
 521     xmlNodePtr c;
 522     gboolean ok;
 523
 524     ok = FALSE;
 525     c = obt_xml_find_sibling(first, attrs[0]);
 526     while (c && !ok) {
 527         gint i;
 528
 529         ok = TRUE;
 530         for (i = 1; attrs[i]; ++i) {
 531             gchar **eq = g_strsplit(attrs[i], "=", 2);
 532             if (eq[1] && !obt_xml_attr_contains(c, eq[0], eq[1]))
 533                 ok = FALSE;
 534             g_strfreev(eq);
 535         }
 536         if (!ok)
 537             c = obt_xml_find_sibling(c->next, attrs[0]);
 538     }
 539     return ok ? c : NULL;
 540 }
 541
 542 static xmlNodePtr create_child(xmlNodePtr parent, gchar *const*attrs,
 543                                const gchar *value)
 544 {
 545     xmlNodePtr c;
 546     gint i;
 547
 548     c = xmlNewTextChild(parent, NULL, (xmlChar*)attrs[0], (xmlChar*)value);
 549
 550     for (i = 1; attrs[i]; ++i) {
 551         gchar **eq = g_strsplit(attrs[i], "=", 2);
 552         if (eq[1])
 553             xmlNewProp(c, (xmlChar*)eq[0], (xmlChar*)eq[1]);
 554         g_strfreev(eq);
 555     }
 556     return c;
 557 }
 558
 559 xmlNodePtr obt_xml_path_get_node(xmlNodePtr subtree, const gchar *path,
 560                                  const gchar *default_value)
 561 {
 562     xmlNodePtr n, c;
 563     gchar **nodes;
 564     gchar **it, **next;
 565
 566     g_return_val_if_fail(subtree != NULL, NULL);
 567
 568     n = subtree;
 569
 570     nodes = g_strsplit(path, "/", 0);
 571     for (it = nodes; *it; it = next) {
 572         gchar **attrs;
 573
 574         attrs = g_strsplit(*it, ":", 0);
 575         next = it + 1;
 576
 577         /* match attributes */
 578         c = find_sibling(n->children, attrs);
 579
 580         if (!c) {
 581             if (*next)
 582                 c = create_child(n, attrs, NULL);
 583             else if (default_value)
 584                 c = create_child(n, attrs, default_value);
 585         }
 586         n = c;
 587
 588         g_strfreev(attrs);
 589     }
 590
 591     g_strfreev(nodes);
 592
 593     return n;
 594 }
 595
 596 GList* obt_xml_path_get_list(xmlNodePtr subtree, const gchar *path)
 597 {
 598     xmlNodePtr n, c;
 599     gchar **nodes;
 600     gchar **it, **next;
 601     GList *list;
 602
 603     g_return_val_if_fail(subtree != NULL, NULL);
 604
 605     n = subtree;
 606     list = NULL;
 607
 608     nodes = g_strsplit(path, "/", 0);
 609     if (nodes[0]) {
 610         gchar **attrs;
 611
 612         for (it = nodes, next = it + 1; *next; it = next) {
 613             attrs = g_strsplit(*it, ":", 0);
 614             next = it + 1;
 615
 616             /* match attributes */
 617             c = find_sibling(n->children, attrs);
 618             if (!c) c = create_child(n, attrs, NULL);
 619             n = c;
 620
 621             g_strfreev(attrs);
 622         }
 623
 624         attrs = g_strsplit(*next, ":", 0);
 625         c = n->children;
 626         while (c && (c = find_sibling(c, attrs))) {
 627             list = g_list_append(list, c);
 628             c = c->next;
 629         }
 630         g_strfreev(attrs);
 631     }
 632
 633     g_strfreev(nodes);
 634
 635     return list;
 636 }
 637
 638
 639 void obt_xml_path_delete_node(xmlNodePtr subtree, const gchar *path)
 640 {
 641     xmlNodePtr n;
 642
 643     n = obt_xml_path_get_node(subtree, path, NULL);
 644     xmlUnlinkNode(n);
 645     xmlFreeNode(n);
 646 }
 647
 648 gchar* obt_xml_path_string(xmlNodePtr subtree, const gchar *path,
 649                           const gchar *default_value)
 650 {
 651     xmlNodePtr n;
 652
 653     n = obt_xml_path_get_node(subtree, path, default_value);
 654     return n ? obt_xml_node_string(n) : NULL;
 655 }
 656
 657 int obt_xml_path_int(xmlNodePtr subtree, const gchar *path,
 658                      const gchar *default_value)
 659 {
 660     xmlNodePtr n;
 661
 662     n = obt_xml_path_get_node(subtree, path, default_value);
 663     return n ? obt_xml_node_int(n) : 0;
 664 }
 665
 666 gboolean obt_xml_path_bool(xmlNodePtr subtree, const gchar *path,
 667                            const gchar *default_value)
 668 {
 669     xmlNodePtr n;
 670
 671     n = obt_xml_path_get_node(subtree, path, default_value);
 672     return n ? obt_xml_node_bool(n) : FALSE;
 673 }
 674
 675 void obt_xml_path_set_string(xmlNodePtr subtree, const gchar *path,
 676                              const gchar *value)
 677 {
 678     xmlNodePtr n = obt_xml_path_get_node(subtree, path, "");
 679     obt_xml_node_set_string(n, value);
 680 }
 681
 682 void obt_xml_path_set_int(xmlNodePtr subtree, const gchar *path,
 683                           gint value)
 684 {
 685     xmlNodePtr n = obt_xml_path_get_node(subtree, path, "");
 686     obt_xml_node_set_int(n, value);
 687 }
 688
 689 void obt_xml_path_set_bool(xmlNodePtr subtree, const gchar *path,
 690                            gboolean value)
 691 {
 692     xmlNodePtr n = obt_xml_path_get_node(subtree, path, "");
 693     obt_xml_node_set_bool(n, value);
 694 }