util/wmmenugen_parse_wmconfig.c

   1 /*
   2  * wmmenugen - Window Maker PropList menu generator
   3  *
   4  * Wmconfig <http://www.arrishq.net/> parser functions
   5  *
   6  * Copyright (c) 2010. Tamas Tevesz <ice@extreme.hu>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25
  26 #include <ctype.h>
  27 #include <ftw.h>
  28 #if DEBUG
  29 #include <errno.h>
  30 #endif
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <unistd.h>
  35
  36 #include "wmmenugen.h"
  37
  38 typedef struct {
  39         char    *Name;
  40         char    *Exec;
  41         char    *Category;
  42         char    *Restart;
  43         int      Flags;
  44 } WMConfigMenuEntry;
  45
  46 static Bool wmc_to_wm(WMConfigMenuEntry **wmc, WMMenuEntry **wm);
  47 static void parse_wmconfig_line(char **label, char **key, char **value, const char *line);
  48 static void init_wmconfig_storage(WMConfigMenuEntry **wmc);
  49
  50
  51 void parse_wmconfig(const char *file, cb_add_menu_entry *addWMMenuEntryCallback)
  52 {
  53         FILE *fp;
  54         char buf[1024];
  55         char *p, *lastlabel, *label, *key, *value;
  56         WMConfigMenuEntry *wmc;
  57         WMMenuEntry *wm;
  58
  59         lastlabel = label = key = value = NULL;
  60
  61         fp = fopen(file, "r");
  62         if (!fp) {
  63 #if DEBUG
  64                 fprintf(stderr, "Error opening file %s: %s\n", file, strerror(errno));
  65 #endif
  66                 return;
  67         }
  68
  69         wmc = (WMConfigMenuEntry *)wmalloc(sizeof(WMConfigMenuEntry));
  70         wmc->Name = NULL;
  71         wmc->Exec = NULL;
  72         wmc->Category = NULL;
  73         wmc->Restart = NULL;
  74         wmc->Flags = 0;
  75
  76         wm = (WMMenuEntry *)wmalloc(sizeof(WMMenuEntry));
  77
  78         memset(buf, 0, sizeof(buf));
  79
  80         while (fgets(buf, sizeof(buf), fp)) {
  81
  82                 p = buf;
  83
  84                 /* skip whitespaces */
  85                 while (isspace(*p))
  86                         p++;
  87                 /* skip comments, empty lines */
  88                 if (*p == '\r' || *p == '\n' || *p == '#') {
  89                         memset(buf, 0, sizeof(buf));
  90                         continue;
  91                 }
  92                 /* trim crlf */
  93                 buf[strcspn(buf, "\r\n")] = '\0';
  94                 if (strlen(buf) == 0)
  95                         continue;
  96
  97                 parse_wmconfig_line(&label, &key, &value, p);
  98
  99                 if (label && strlen(label) == 0)
 100                         continue;
 101                 if (!lastlabel && label)
 102                         lastlabel = wstrdup(label);
 103
 104                 if (strcmp(lastlabel, label) != 0) {
 105                         if (wmc_to_wm(&wmc, &wm)) {
 106                                 (*addWMMenuEntryCallback)(wm);
 107                                 init_wmconfig_storage(&wmc);
 108                         }
 109
 110                         wfree(lastlabel);
 111                         lastlabel = wstrdup(label);
 112                 }
 113
 114                 if (key && value) {
 115                         if (strcmp(key, "name") == 0)
 116                                 wmc->Name = value;
 117                         else if (strcmp(key, "exec") == 0)
 118                                 wmc->Exec = value;
 119                         else if (strcmp(key, "group") == 0)
 120                                 wmc->Category = value;
 121                         else if (strcmp(key, "restart") == 0)
 122                                 wmc->Restart = value;
 123                         else if (strcmp(key, "terminal") == 0)
 124                                 wmc->Flags |= F_TERMINAL;
 125                 }
 126
 127         }
 128
 129         fclose(fp);
 130
 131         if (wmc_to_wm(&wmc, &wm)) {
 132                 (*addWMMenuEntryCallback)(wm);
 133                 init_wmconfig_storage(&wmc);
 134         }
 135 }
 136
 137 /* an example to illustrate validateFilename.
 138  * with wmconfig, no special handling is needed
 139  */
 140 Bool wmconfig_validate_file(const char *filename, const struct stat *st, int tflags, struct FTW *ftw)
 141 {
 142         (void)filename;
 143         (void)st;
 144         (void)tflags;
 145         (void)ftw;
 146
 147         return True;
 148 #if 0   /* not dead code, example */
 149
 150         /* or we could have gone intro extremes */
 151         char *base_name;
 152         Bool ret;
 153
 154         (void)tflags;
 155
 156         base_name = wstrdup(filename + ftw->base);
 157         ret = True;
 158
 159         if (!S_ISREG(st->st_mode) ||                            /* not a regular file */
 160             (st->st_uid != 0 && st->st_uid != getuid()) ||      /* bad guy injected this file */
 161             strpbrk(base_name, ".") ||                          /* wmconfig typically has no extension */
 162             st->st_size >= 128 * 131072 ||                      /* noone writes wmconfig files > 128K */
 163             st->st_size == 0 ||                                 /* nor empty ones */
 164             ftw->level > 16)                                    /* how did we get this deep? */
 165                 ret = False;
 166
 167         wfree(base_name);
 168
 169         return ret;
 170 #endif
 171 }
 172
 173 /* get a line allocating label, key and value as necessary */
 174 static void parse_wmconfig_line(char **label, char **key, char **value, const char *line)
 175 {
 176         const char *p;
 177         int kstart, kend;
 178
 179         p = line;
 180         *label = *key = *value = NULL;
 181         kstart = kend = 0;
 182
 183         /* skip whitespace */
 184         while (isspace(*(p + kstart)))
 185                 kstart++;
 186
 187         kend = kstart;
 188         /* find end of label */
 189         while (*(p + kend) && !isspace(*(p + kend)))
 190                 kend++;
 191
 192         /* label */
 193         *label = wstrndup(p + kstart, kend - kstart);
 194         kstart = kend + 1;
 195
 196         /* skip whitespace */
 197         while (isspace(*(p + kstart)))
 198                 kstart++;
 199
 200         kend = kstart;
 201         /* find end of key */
 202         while (*(p + kend) && !isspace(*(p + kend)))
 203                 kend++;
 204
 205         /* key */
 206         *key = wstrndup(p + kstart, kend - kstart);
 207         kstart = kend + 1;
 208
 209         /* skip until after " */
 210         while (*(p + kstart) && *(p + kstart) != '"')
 211                 kstart++;
 212         kstart++;
 213
 214         kend = kstart;
 215         /* skip until " */
 216         while (*(p + kend) && *(p + kend) != '"')
 217                 kend++;
 218
 219         /* value */
 220         *value = wstrndup(p + kstart, kend - kstart);
 221 }
 222
 223 /* normalize and convert one wmconfig-format entry to wm format */
 224 static Bool wmc_to_wm(WMConfigMenuEntry **wmc, WMMenuEntry **wm)
 225 {
 226         char *p;
 227         size_t slen;
 228
 229         /* only Exec is mandatory, and it's better exist in a known place */
 230         if (!((*wmc)->Exec &&
 231              *(*wmc)->Exec &&
 232              fileInPath((*wmc)->Exec)))
 233                 return False;
 234
 235         /* normalize Exec: wmconfig tends to stick an ampersand
 236          * at the end of everything, which we don't need */
 237         slen = strlen((*wmc)->Exec) - 1;
 238         p = (*wmc)->Exec;
 239         while (slen > 0 && (isspace(*(p + slen)) || *(p + slen) == '&'))
 240                 *(p + slen--) = '\0';
 241
 242         /* if there's no Name, use the first word of Exec; still better
 243          * than nothing. i realize it's highly arguable whether `xterm' from
 244          * `xterm -e "ssh dev push-to-prod"' is helpful or not, but since
 245          * the alternative is to completely lose the entry, i opt for this.
 246          * you could just fix the descriptor file to have a label <G> */
 247         if (!(*wmc)->Name) {
 248                 (*wmc)->Name = wstrdup((*wmc)->Exec);
 249                 p = strchr((*wmc)->Name, ' ');
 250                 if (p)
 251                         *p = '\0';
 252         }
 253
 254         /* if there's no Category, use "Applications"; apparently "no category"
 255          * can manifest both as no `group' descriptor at all, or a group
 256          * descriptor of "" */
 257         if (!(*wmc)->Category || !*(*wmc)->Category)
 258                 (*wmc)->Category = wstrdup("Applications");
 259
 260         /* the `restart' type is used for restart, restart other
 261          * wm and quit current wm too. separate these cases. */
 262         if ((*wmc)->Restart) {
 263                 if (strcmp((*wmc)->Restart, "restart") == 0)
 264                         (*wmc)->Flags |= F_RESTART_SELF;
 265                 else if (strcmp((*wmc)->Restart, "quit") == 0)
 266                         (*wmc)->Flags |= F_QUIT;
 267                 else
 268                         (*wmc)->Flags |= F_RESTART_OTHER;
 269         }
 270
 271         (*wm)->Name = (*wmc)->Name;
 272         (*wm)->CmdLine = (*wmc)->Exec;
 273         (*wm)->SubMenu = (*wmc)->Category;
 274         (*wm)->Flags = (*wmc)->Flags;
 275
 276         return True;
 277 }
 278
 279 static void init_wmconfig_storage(WMConfigMenuEntry **wmc)
 280 {
 281         if ((*wmc)->Category)
 282                 wfree((*wmc)->Category);
 283         (*wmc)->Category = NULL;
 284         if ((*wmc)->Name)
 285                 wfree((*wmc)->Name);
 286         (*wmc)->Name = NULL;
 287         if ((*wmc)->Restart)
 288                 wfree((*wmc)->Restart);
 289         (*wmc)->Restart = NULL;
 290         (*wmc)->Flags = 0;
 291 }