parser/parse.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    parse.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 "parse.h"
  20 #include <glib.h>
  21 #include <string.h>
  22 #include <errno.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25 #include <unistd.h>
  26
  27 static gboolean xdg_start;
  28 static gchar   *xdg_config_home_path;
  29 static gchar   *xdg_data_home_path;
  30 static GSList  *xdg_config_dir_paths;
  31 static GSList  *xdg_data_dir_paths;
  32
  33 struct Callback {
  34     gchar *tag;
  35     ParseCallback func;
  36     gpointer data;
  37 };
  38
  39 struct _ObParseInst {
  40     GHashTable *callbacks;
  41 };
  42
  43 static void destfunc(struct Callback *c)
  44 {
  45     g_free(c->tag);
  46     g_free(c);
  47 }
  48
  49 ObParseInst* parse_startup(void)
  50 {
  51     ObParseInst *i = g_new(ObParseInst, 1);
  52     i->callbacks = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
  53                                          (GDestroyNotify)destfunc);
  54     return i;
  55 }
  56
  57 void parse_shutdown(ObParseInst *i)
  58 {
  59     if (i) {
  60         g_hash_table_destroy(i->callbacks);
  61         g_free(i);
  62     }
  63 }
  64
  65 void parse_register(ObParseInst *i, const gchar *tag,
  66                     ParseCallback func, gpointer data)
  67 {
  68     struct Callback *c;
  69
  70     if ((c = g_hash_table_lookup(i->callbacks, tag))) {
  71         g_error("Tag '%s' already registered", tag);
  72         return;
  73     }
  74
  75     c = g_new(struct Callback, 1);
  76     c->tag = g_strdup(tag);
  77     c->func = func;
  78     c->data = data;
  79     g_hash_table_insert(i->callbacks, c->tag, c);
  80 }
  81
  82 gboolean parse_load_rc(const gchar *file, xmlDocPtr *doc, xmlNodePtr *root)
  83 {
  84     GSList *it;
  85     gboolean r = FALSE;
  86
  87     if (file && parse_load(file, "openbox_config", doc, root))
  88         return TRUE;
  89
  90     for (it = xdg_config_dir_paths; !r && it; it = g_slist_next(it)) {
  91         gchar *path;
  92
  93         path = g_build_filename(it->data, "openbox", "rc.xml", NULL);
  94         r = parse_load(path, "openbox_config", doc, root);
  95         g_free(path);
  96     }
  97
  98     return r;
  99 }
 100
 101 gboolean parse_load_theme(const gchar *name, xmlDocPtr *doc, xmlNodePtr *root,
 102                           gchar **retpath)
 103 {
 104     GSList *it;
 105     gchar *path;
 106     gboolean r = FALSE;
 107     gchar *eng;
 108
 109     /* backward compatibility.. */
 110     path = g_build_filename(g_get_home_dir(), ".themes", name,
 111                             "openbox-3", "themerc.xml", NULL);
 112     if (parse_load(path, "openbox_theme", doc, root) &&
 113         parse_attr_string("engine", *root, &eng))
 114     {
 115         if (!strcmp(eng, "box")) {
 116             *retpath = g_path_get_dirname(path);
 117             r = TRUE;
 118         }
 119         g_free(eng);
 120     }
 121     g_free(path);
 122
 123     if (!r) {
 124         for (it = xdg_data_dir_paths; !r && it; it = g_slist_next(it)) {
 125             path = g_build_filename(it->data, "themes", name, "openbox-3",
 126                                     "themerc.xml", NULL);
 127             if (parse_load(path, "openbox_theme", doc, root) &&
 128                 parse_attr_string("engine", *root, &eng))
 129             {
 130                 if (!strcmp(eng, "box")) {
 131                     *retpath = g_path_get_dirname(path);
 132                     r = TRUE;
 133                 }
 134                 g_free(eng);
 135             }
 136             g_free(path);
 137         }
 138     }
 139     return r;
 140 }
 141
 142 gboolean parse_load_menu(const gchar *file, xmlDocPtr *doc, xmlNodePtr *root)
 143 {
 144     GSList *it;
 145     gchar *path;
 146     gboolean r = FALSE;
 147
 148     if (file[0] == '/') {
 149         r = parse_load(file, "openbox_menu", doc, root);
 150     } else {
 151         for (it = xdg_config_dir_paths; !r && it; it = g_slist_next(it)) {
 152             path = g_build_filename(it->data, "openbox", file, NULL);
 153             r = parse_load(path, "openbox_menu", doc, root);
 154             g_free(path);
 155         }
 156     }
 157     return r;
 158 }
 159
 160 gboolean parse_load(const gchar *path, const gchar *rootname,
 161                     xmlDocPtr *doc, xmlNodePtr *root)
 162 {
 163     struct stat s;
 164
 165     if (stat(path, &s) < 0)
 166         return FALSE;
 167
 168     /* XML_PARSE_BLANKS is needed apparently. When it loads a theme file,
 169        without this option, the tree is weird and has extra nodes in it. */
 170     if ((*doc = xmlReadFile(path, NULL,
 171                             XML_PARSE_NOBLANKS | XML_PARSE_RECOVER))) {
 172         *root = xmlDocGetRootElement(*doc);
 173         if (!*root) {
 174             xmlFreeDoc(*doc);
 175             *doc = NULL;
 176             g_message("%s is an empty document", path);
 177         } else {
 178             if (xmlStrcmp((*root)->name, (const xmlChar*)rootname)) {
 179                 xmlFreeDoc(*doc);
 180                 *doc = NULL;
 181                 g_message("XML Document %s is of wrong type. Root "
 182                           "node is not '%s'", path, rootname);
 183             }
 184         }
 185     }
 186     if (!*doc)
 187         return FALSE;
 188     return TRUE;
 189 }
 190
 191 gboolean parse_load_mem(gpointer data, guint len, const gchar *rootname,
 192                         xmlDocPtr *doc, xmlNodePtr *root)
 193 {
 194     if ((*doc = xmlParseMemory(data, len))) {
 195         *root = xmlDocGetRootElement(*doc);
 196         if (!*root) {
 197             xmlFreeDoc(*doc);
 198             *doc = NULL;
 199             g_message("Given memory is an empty document");
 200         } else {
 201             if (xmlStrcmp((*root)->name, (const xmlChar*)rootname)) {
 202                 xmlFreeDoc(*doc);
 203                 *doc = NULL;
 204                 g_message("XML Document in given memory is of wrong "
 205                           "type. Root node is not '%s'\n", rootname);
 206             }
 207         }
 208     }
 209     if (!*doc)
 210         return FALSE;
 211     return TRUE;
 212 }
 213
 214 void parse_close(xmlDocPtr doc)
 215 {
 216     xmlFreeDoc(doc);
 217 }
 218
 219 void parse_tree(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node)
 220 {
 221     while (node) {
 222         struct Callback *c = g_hash_table_lookup(i->callbacks, node->name);
 223
 224         if (c)
 225             c->func(i, doc, node, c->data);
 226
 227         node = node->next;
 228     }
 229 }
 230
 231 gchar *parse_string(xmlDocPtr doc, xmlNodePtr node)
 232 {
 233     xmlChar *c = xmlNodeListGetString(doc, node->children, TRUE);
 234     gchar *s;
 235     if (c) g_strstrip((char*)c);
 236     s = g_strdup(c ? (gchar*)c : "");
 237     xmlFree(c);
 238     return s;
 239 }
 240
 241 gint parse_int(xmlDocPtr doc, xmlNodePtr node)
 242 {
 243     xmlChar *c = xmlNodeListGetString(doc, node->children, TRUE);
 244     gint i;
 245     if (c) g_strstrip((char*)c);
 246     i = c ? atoi((gchar*)c) : 0;
 247     xmlFree(c);
 248     return i;
 249 }
 250
 251 gboolean parse_bool(xmlDocPtr doc, xmlNodePtr node)
 252 {
 253     xmlChar *c = xmlNodeListGetString(doc, node->children, TRUE);
 254     gboolean b = FALSE;
 255     if (c) g_strstrip((char*)c);
 256     if (c && !xmlStrcasecmp(c, (const xmlChar*) "true"))
 257         b = TRUE;
 258     else if (c && !xmlStrcasecmp(c, (const xmlChar*) "yes"))
 259         b = TRUE;
 260     else if (c && !xmlStrcasecmp(c, (const xmlChar*) "on"))
 261         b = TRUE;
 262     xmlFree(c);
 263     return b;
 264 }
 265
 266 gboolean parse_contains(const gchar *val, xmlDocPtr doc, xmlNodePtr node)
 267 {
 268     xmlChar *c = xmlNodeListGetString(doc, node->children, TRUE);
 269     gboolean r;
 270     if (c) g_strstrip((char*)c); /* strip leading/trailing whitespace */
 271     r = !xmlStrcasecmp(c, (const xmlChar*) val);
 272     xmlFree(c);
 273     return r;
 274 }
 275
 276 xmlNodePtr parse_find_node(const gchar *tag, xmlNodePtr node)
 277 {
 278     while (node) {
 279         if (!xmlStrcmp(node->name, (const xmlChar*) tag))
 280             return node;
 281         node = node->next;
 282     }
 283     return NULL;
 284 }
 285
 286 gboolean parse_attr_bool(const gchar *name, xmlNodePtr node, gboolean *value)
 287 {
 288     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 289     gboolean r = FALSE;
 290     if (c) {
 291         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 292         if (!xmlStrcasecmp(c, (const xmlChar*) "true"))
 293             *value = TRUE, r = TRUE;
 294         else if (!xmlStrcasecmp(c, (const xmlChar*) "yes"))
 295             *value = TRUE, r = TRUE;
 296         else if (!xmlStrcasecmp(c, (const xmlChar*) "on"))
 297             *value = TRUE, r = TRUE;
 298         else if (!xmlStrcasecmp(c, (const xmlChar*) "false"))
 299             *value = FALSE, r = TRUE;
 300         else if (!xmlStrcasecmp(c, (const xmlChar*) "no"))
 301             *value = FALSE, r = TRUE;
 302         else if (!xmlStrcasecmp(c, (const xmlChar*) "off"))
 303             *value = FALSE, r = TRUE;
 304     }
 305     xmlFree(c);
 306     return r;
 307 }
 308
 309 gboolean parse_attr_int(const gchar *name, xmlNodePtr node, gint *value)
 310 {
 311     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 312     gboolean r = FALSE;
 313     if (c) {
 314         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 315         *value = atoi((gchar*)c);
 316         r = TRUE;
 317     }
 318     xmlFree(c);
 319     return r;
 320 }
 321
 322 gboolean parse_attr_string(const gchar *name, xmlNodePtr node, gchar **value)
 323 {
 324     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 325     gboolean r = FALSE;
 326     if (c) {
 327         g_strstrip((char*)c); /* strip leading/trailing whitespace */
 328         *value = g_strdup((gchar*)c);
 329         r = TRUE;
 330     }
 331     xmlFree(c);
 332     return r;
 333 }
 334
 335 gboolean parse_attr_contains(const gchar *val, xmlNodePtr node,
 336                              const gchar *name)
 337 {
 338     xmlChar *c = xmlGetProp(node, (const xmlChar*) name);
 339     gboolean r = FALSE;
 340     if (c) {
 341         g_strstrip((char*)c);
 342         r = !xmlStrcasecmp(c, (const xmlChar*) val);
 343     }
 344     xmlFree(c);
 345     return r;
 346 }
 347
 348 static gint slist_path_cmp(const gchar *a, const gchar *b)
 349 {
 350     return strcmp(a, b);
 351 }
 352
 353 typedef GSList* (*GSListFunc) (gpointer list, gconstpointer data);
 354
 355 static GSList* slist_path_add(GSList *list, gpointer data, GSListFunc func)
 356 {
 357     g_assert(func);
 358
 359     if (!data)
 360         return list;
 361
 362     if (!g_slist_find_custom(list, data, (GCompareFunc) slist_path_cmp))
 363         list = func(list, data);
 364     else
 365         g_free(data);
 366
 367     return list;
 368 }
 369
 370 static GSList* split_paths(const gchar *paths)
 371 {
 372     GSList *list = NULL;
 373     gchar **spl, **it;
 374
 375     if (!paths)
 376         return NULL;
 377     spl = g_strsplit(paths, ":", -1);
 378     for (it = spl; *it; ++it)
 379         list = slist_path_add(list, *it, (GSListFunc) g_slist_append);
 380     g_free(spl);
 381     return list;
 382 }
 383
 384 void parse_paths_startup(void)
 385 {
 386     const gchar *path;
 387
 388     if (xdg_start)
 389         return;
 390     xdg_start = TRUE;
 391
 392     path = g_getenv("XDG_CONFIG_HOME");
 393     if (path && path[0] != '\0') /* not unset or empty */
 394         xdg_config_home_path = g_build_filename(path, NULL);
 395     else
 396         xdg_config_home_path = g_build_filename(g_get_home_dir(), ".config",
 397                                                 NULL);
 398
 399     path = g_getenv("XDG_DATA_HOME");
 400     if (path && path[0] != '\0') /* not unset or empty */
 401         xdg_data_home_path = g_build_filename(path, NULL);
 402     else
 403         xdg_data_home_path = g_build_filename(g_get_home_dir(), ".local",
 404                                               "share", NULL);
 405
 406     path = g_getenv("XDG_CONFIG_DIRS");
 407     if (path && path[0] != '\0') /* not unset or empty */
 408         xdg_config_dir_paths = split_paths(path);
 409     else {
 410         xdg_config_dir_paths = slist_path_add(xdg_config_dir_paths,
 411                                               g_strdup(CONFIGDIR),
 412                                               (GSListFunc) g_slist_append);
 413         xdg_config_dir_paths = slist_path_add(xdg_config_dir_paths,
 414                                               g_build_filename
 415                                               (G_DIR_SEPARATOR_S,
 416                                                "etc", "xdg", NULL),
 417                                               (GSListFunc) g_slist_append);
 418     }
 419     xdg_config_dir_paths = slist_path_add(xdg_config_dir_paths,
 420                                           g_strdup(xdg_config_home_path),
 421                                           (GSListFunc) g_slist_prepend);
 422
 423     path = g_getenv("XDG_DATA_DIRS");
 424     if (path && path[0] != '\0') /* not unset or empty */
 425         xdg_data_dir_paths = split_paths(path);
 426     else {
 427         xdg_data_dir_paths = slist_path_add(xdg_data_dir_paths,
 428                                             g_strdup(DATADIR),
 429                                             (GSListFunc) g_slist_append);
 430         xdg_data_dir_paths = slist_path_add(xdg_data_dir_paths,
 431                                             g_build_filename
 432                                             (G_DIR_SEPARATOR_S,
 433                                              "usr", "local", "share", NULL),
 434                                             (GSListFunc) g_slist_append);
 435         xdg_data_dir_paths = slist_path_add(xdg_data_dir_paths,
 436                                             g_build_filename
 437                                             (G_DIR_SEPARATOR_S,
 438                                              "usr", "share", NULL),
 439                                             (GSListFunc) g_slist_append);
 440     }
 441     xdg_data_dir_paths = slist_path_add(xdg_data_dir_paths,
 442                                         g_strdup(xdg_data_home_path),
 443                                         (GSListFunc) g_slist_prepend);
 444 }
 445
 446 void parse_paths_shutdown(void)
 447 {
 448     GSList *it;
 449
 450     if (!xdg_start)
 451         return;
 452     xdg_start = FALSE;
 453
 454     for (it = xdg_config_dir_paths; it; it = g_slist_next(it))
 455         g_free(it->data);
 456     g_slist_free(xdg_config_dir_paths);
 457     xdg_config_dir_paths = NULL;
 458     for (it = xdg_data_dir_paths; it; it = g_slist_next(it))
 459         g_free(it->data);
 460     g_slist_free(xdg_data_dir_paths);
 461     xdg_data_dir_paths = NULL;
 462     g_free(xdg_config_home_path);
 463     xdg_config_home_path = NULL;
 464     g_free(xdg_data_home_path);
 465     xdg_data_home_path = NULL;
 466 }
 467
 468 gchar *parse_expand_tilde(const gchar *f)
 469 {
 470     gchar *ret;
 471     GRegex *regex;
 472
 473     if (!f)
 474         return NULL;
 475
 476     regex = g_regex_new("(?:^|(?<=[ \\t]))~(?:(?=[/ \\t])|$)",
 477                         G_REGEX_MULTILINE | G_REGEX_RAW, 0, NULL);
 478     ret = g_regex_replace_literal(regex, f, -1, 0, g_get_home_dir(), 0, NULL);
 479     g_regex_unref(regex);
 480
 481     return ret;
 482 }
 483
 484 gboolean parse_mkdir(const gchar *path, gint mode)
 485 {
 486     gboolean ret = TRUE;
 487
 488     g_return_val_if_fail(path != NULL, FALSE);
 489     g_return_val_if_fail(path[0] != '\0', FALSE);
 490
 491     if (!g_file_test(path, G_FILE_TEST_IS_DIR))
 492         if (mkdir(path, mode) == -1)
 493             ret = FALSE;
 494
 495     return ret;
 496 }
 497
 498 gboolean parse_mkdir_path(const gchar *path, gint mode)
 499 {
 500     gboolean ret = TRUE;
 501
 502     g_return_val_if_fail(path != NULL, FALSE);
 503     g_return_val_if_fail(path[0] == '/', FALSE);
 504
 505     if (!g_file_test(path, G_FILE_TEST_IS_DIR)) {
 506         gchar *c, *e;
 507
 508         c = g_strdup(path);
 509         e = c;
 510         while ((e = strchr(e + 1, '/'))) {
 511             *e = '\0';
 512             if (!(ret = parse_mkdir(c, mode)))
 513                 goto parse_mkdir_path_end;
 514             *e = '/';
 515         }
 516         ret = parse_mkdir(c, mode);
 517
 518     parse_mkdir_path_end:
 519         g_free(c);
 520     }
 521
 522     return ret;
 523 }
 524
 525 const gchar* parse_xdg_config_home_path(void)
 526 {
 527     return xdg_config_home_path;
 528 }
 529
 530 const gchar* parse_xdg_data_home_path(void)
 531 {
 532     return xdg_data_home_path;
 533 }
 534
 535 GSList* parse_xdg_config_dir_paths(void)
 536 {
 537     return xdg_config_dir_paths;
 538 }
 539
 540 GSList* parse_xdg_data_dir_paths(void)
 541 {
 542     return xdg_data_dir_paths;
 543 }