util/wmmenugen_parse_xdg.c

   1 /*
   2  * wmmenugen - Window Maker PropList menu generator
   3  *
   4  * Desktop Entry Specification 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 /*
  24  * http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-1.1.html
  25  * http://standards.freedesktop.org/menu-spec/menu-spec-1.1.html
  26  *
  27  * We will only deal with Type == "Application" entries in [Desktop Entry]
  28  * groups. Since there is no passing of file name arguments or anything of
  29  * the sort to applications from the menu, execname is determined as follows:
  30  * - If `TryExec' is present, use that;
  31  * - else use `Exec' with any switches stripped
  32  *
  33  * Only the (first, though there should not be more than one) `Main Category'
  34  * is used to place the entry in a submenu.
  35  *
  36  * Basic validation of the .desktop file is done.
  37  */
  38
  39 #include <sys/types.h>
  40 #include <sys/stat.h>
  41
  42 #include <ctype.h>
  43 #include <ftw.h>
  44 #if DEBUG
  45 #include <errno.h>
  46 #endif
  47 #include <stdio.h>
  48 #include <stdlib.h>
  49 #include <string.h>
  50
  51 #include "wmmenugen.h"
  52
  53 /* LocaleString match levels */
  54 enum {
  55         MATCH_DEFAULT,
  56         MATCH_LANG,
  57         MATCH_LANG_MODIFIER,
  58         MATCH_LANG_COUNTRY,
  59         MATCH_LANG_COUNTRY_MODIFIER
  60 };
  61
  62 typedef struct {
  63         char    *Name;          /* Name */                              /* localestring */
  64         int      MatchLevel;    /* LocaleString match type */           /* int */
  65         char    *TryExec;       /* TryExec */                           /* string */
  66         char    *Exec;          /* Exec */                              /* string */
  67         char    *Path;          /* Path */                              /* string */
  68         int      Flags;         /* Flags */
  69         char    *Category;      /* Categories (first item only) */      /* string */
  70 } XDGMenuEntry;
  71
  72 static void  getKey(char **target, const char *line);
  73 static void  getStringValue(char **target, const char *line);
  74 static void  getLocalizedStringValue(char **target, const char *line, int *match_level);
  75 static int   getBooleanValue(const char *line);
  76 static void  getMenuHierarchyFor(char **xdgmenuspec);
  77 static int   compare_matchlevel(int *current_level, const char *found_locale);
  78 static Bool  xdg_to_wm(XDGMenuEntry **xdg, WMMenuEntry **wmentry);
  79 static void init_xdg_storage(XDGMenuEntry **xdg);
  80 static void init_wm_storage(WMMenuEntry **wm);
  81
  82 void parse_xdg(const char *file, void (*addWMMenuEntryCallback)(WMMenuEntry *aEntry))
  83 {
  84         FILE *fp;
  85         char buf[1024];
  86         char *p, *tmp, *key;
  87         WMMenuEntry *wm;
  88         XDGMenuEntry *xdg;
  89         int InGroup;
  90
  91         fp = fopen(file, "r");
  92         if (!fp) {
  93 #if DEBUG
  94                 fprintf(stderr, "Error opening file %s: %s\n", file, strerror(errno));
  95 #endif
  96                 return;
  97         }
  98
  99         xdg = (XDGMenuEntry *)wmalloc(sizeof(XDGMenuEntry));
 100         wm = (WMMenuEntry *)wmalloc(sizeof(WMMenuEntry));
 101         InGroup = 0;
 102         memset(buf, 0, sizeof(buf));
 103
 104         while (fgets(buf, sizeof(buf), fp)) {
 105
 106                 p = buf;
 107
 108                 /* skip whitespaces */
 109                 while (isspace(*p))
 110                         p++;
 111                 /* skip comments, empty lines */
 112                 if (*p == '\r' || *p == '\n' || *p == '#') {
 113                         memset(buf, 0, sizeof(buf));
 114                         continue;
 115                 }
 116                 /* trim crlf */
 117                 buf[strcspn(buf, "\r\n")] = '\0';
 118                 if (strlen(buf) == 0)
 119                         continue;
 120
 121                 if (strcmp(p, "[Desktop Entry]") == 0) {
 122                         /* if currently processing a group, we've just hit the
 123                          * end of its definition, try processing it
 124                          */
 125                         if (InGroup && xdg_to_wm(&xdg, &wm)) {
 126                                 (*addWMMenuEntryCallback)(wm);
 127                         }
 128                         init_xdg_storage(&xdg);
 129                         init_wm_storage(&wm);
 130                         InGroup = 1;
 131                         /* start processing group */
 132                         memset(buf, 0, sizeof(buf));
 133                         continue;
 134                 }
 135
 136                 if (!InGroup) {
 137                         memset(buf, 0, sizeof(buf));
 138                         continue;
 139                 }
 140
 141                 getKey(&key, p);
 142                 if (key == NULL) { /* not `key' = `value' */
 143                         memset(buf, 0, sizeof(buf));
 144                         continue;
 145                 }
 146
 147                 if (strcmp(key, "Type") == 0) {
 148                         getStringValue(&tmp, p);
 149                         if (strcmp(tmp, "Application") != 0)
 150                                 InGroup = 0;    /* if not application, skip current group */
 151                         wfree(tmp);
 152                         tmp = NULL;
 153                 } else if (strcmp(key, "Name") == 0) {
 154                         getLocalizedStringValue(&xdg->Name, p, &xdg->MatchLevel);
 155                 } else if (strcmp(key, "NoDisplay") == 0) {
 156                         if (getBooleanValue(p)) /* if nodisplay, skip current group */
 157                                 InGroup = 0;
 158                 } else if (strcmp(key, "Hidden") == 0) {
 159                         if (getBooleanValue(p))
 160                                 InGroup = 0;    /* if hidden, skip current group */
 161                 } else if (strcmp(key, "TryExec") == 0) {
 162                         getStringValue(&xdg->TryExec, p);
 163                 } else if (strcmp(key, "Exec") == 0) {
 164                         getStringValue(&xdg->Exec, p);
 165                 } else if (strcmp(key, "Path") == 0) {
 166                         getStringValue(&xdg->Path, p);
 167                 } else if (strcmp(key, "Terminal") == 0) {
 168                         if (getBooleanValue(p))
 169                                 xdg->Flags |= F_TERMINAL;
 170                 } else if (strcmp(key, "Categories") == 0) {
 171                         getStringValue(&xdg->Category, p);
 172                         getMenuHierarchyFor(&xdg->Category);
 173                 }
 174
 175                 wfree(key);
 176                 key = NULL;
 177         }
 178
 179         fclose(fp);
 180
 181         /* at the end of the file, might as well try to menuize what we have
 182          * unless there was no group at all or it was marked as hidden
 183          */
 184         if (InGroup && xdg_to_wm(&xdg, &wm))
 185                 (*addWMMenuEntryCallback)(wm);
 186
 187 }
 188
 189
 190 /* coerce an xdg entry type into a wm entry type
 191  */
 192 static Bool xdg_to_wm(XDGMenuEntry **xdg, WMMenuEntry **wm)
 193 {
 194         char *p;
 195
 196         /* Exec or TryExec is mandatory */
 197         if (!((*xdg)->Exec || (*xdg)->TryExec))
 198                 return False;
 199
 200         /* if there's no Name, use the first word of Exec or TryExec
 201          */
 202         if ((*xdg)->Name) {
 203                 (*wm)->Name = (*xdg)->Name;
 204         } else  {
 205                 if ((*xdg)->Exec)
 206                         (*wm)->Name = wstrdup((*xdg)->Exec);
 207                 else /* (*xdg)->TryExec */
 208                         (*wm)->Name = wstrdup((*xdg)->TryExec);
 209
 210                 p = strchr((*wm)->Name, ' ');
 211                 if (p)
 212                         *p = '\0';
 213         }
 214
 215         if ((*xdg)->Exec)
 216                 (*wm)->CmdLine = (*xdg)->Exec;
 217         else                                    /* (*xdg)->TryExec */
 218                 (*wm)->CmdLine = (*xdg)->TryExec;
 219
 220         (*wm)->SubMenu = (*xdg)->Category;
 221         (*wm)->Flags = (*xdg)->Flags;
 222
 223         return True;
 224 }
 225
 226 /* (re-)initialize a XDGMenuEntry storage
 227  */
 228 static void init_xdg_storage(XDGMenuEntry **xdg)
 229 {
 230
 231         if ((*xdg)->Name)
 232                 wfree((*xdg)->Name);
 233         if ((*xdg)->TryExec)
 234                 wfree((*xdg)->TryExec);
 235         if ((*xdg)->Exec)
 236                 wfree((*xdg)->Exec);
 237         if ((*xdg)->Category)
 238                 wfree((*xdg)->Category);
 239         if ((*xdg)->Path)
 240                 wfree((*xdg)->Path);
 241
 242         (*xdg)->Name = NULL;
 243         (*xdg)->TryExec = NULL;
 244         (*xdg)->Exec = NULL;
 245         (*xdg)->Category = NULL;
 246         (*xdg)->Path = NULL;
 247         (*xdg)->Flags = 0;
 248         (*xdg)->MatchLevel = -1;
 249 }
 250
 251 /* (re-)initialize a WMMenuEntry storage
 252  */
 253 static void init_wm_storage(WMMenuEntry **wm)
 254 {
 255         (*wm)->Name = NULL;
 256         (*wm)->CmdLine = NULL;
 257         (*wm)->Flags = 0;
 258 }
 259
 260 /* get a key from line. allocates target, which must be wfreed later */
 261 static void getKey(char **target, const char *line)
 262 {
 263         const char *p;
 264         int kstart, kend;
 265
 266         p = line;
 267
 268         if (strchr(p, '=') == NULL) {           /* not `key' = `value' */
 269                 *target = NULL;
 270                 return;
 271         }
 272
 273         kstart = 0;
 274
 275         /* skip whitespace */
 276         while (isspace(*(p + kstart)))
 277                 kstart++;
 278
 279         /* skip up until first whitespace or '[' (localestring) or '=' */
 280         kend = kstart + 1;
 281         while (*(p + kend) && !isspace(*(p + kend)) && *(p + kend) != '=' && *(p + kend) != '[')
 282                 kend++;
 283
 284         *target = wstrndup(p + kstart, kend - kstart);
 285 }
 286
 287 /* get a string value from line. allocates target, which must be wfreed later. */
 288 static void getStringValue(char **target, const char *line)
 289 {
 290         const char *p;
 291         int kstart;
 292
 293         p = line;
 294         kstart = 0;
 295
 296         /* skip until after '=' */
 297         while (*(p + kstart) && *(p + kstart) != '=')
 298                 kstart++;
 299         kstart++;
 300
 301         /* skip whitespace */
 302         while (*(p + kstart) && isspace(*(p + kstart)))
 303                 kstart++;
 304
 305         *target = wstrdup(p + kstart);
 306 }
 307
 308 /* get a localized string value from line. allocates target, which must be wfreed later.
 309  * matching is dependent on the current value of target as well as on the
 310  * level the current value is matched on. guts matching algorithm is in
 311  * compare_matchlevel().
 312  */
 313 static void getLocalizedStringValue(char **target, const char *line, int *match_level)
 314 {
 315         const char *p;
 316         char *locale;
 317         int kstart;
 318         int sqbstart, sqbend;
 319
 320         p = line;
 321         kstart = 0;
 322         sqbstart = 0;
 323         sqbend = 0;
 324         locale = NULL;
 325
 326         /* skip until after '=', mark if '[' and ']' is found */
 327         while (*(p + kstart) && *(p + kstart) != '=') {
 328                 switch (*(p + kstart)) {
 329                         case '[': sqbstart = kstart + 1;break;
 330                         case ']': sqbend = kstart;      break;
 331                         default :                       break;
 332                 }
 333                 kstart++;
 334         }
 335         kstart++;
 336
 337         /* skip whitespace */
 338         while (isspace(*(p + kstart)))
 339                 kstart++;
 340
 341         if (sqbstart > 0 && sqbend > sqbstart)
 342                 locale = wstrndup(p + sqbstart, sqbend - sqbstart);
 343
 344         /* if there is no value yet and this is the default key, return */
 345         if (!*target && !locale) {
 346                 *match_level = MATCH_DEFAULT;
 347                 *target = wstrdup(p + kstart);
 348                 return;
 349         }
 350
 351         if (compare_matchlevel(match_level, locale)) {
 352                 wfree(locale);
 353                 *target = wstrdup(p + kstart);
 354                 return;
 355         }
 356
 357         return;
 358 }
 359
 360 /* get a boolean value from line */
 361 static Bool getBooleanValue(const char *line)
 362 {
 363         char *p;
 364         int ret;
 365
 366         getStringValue(&p, line);
 367         ret = strcmp(p, "true") == 0 ? True : False;
 368         wfree(p);
 369
 370         return ret;
 371 }
 372
 373 /* perform locale matching by implementing the algorithm specified in
 374  * xdg desktop entry specification, section "localized values for keys".
 375  */
 376 static Bool compare_matchlevel(int *current_level, const char *found_locale)
 377 {
 378         /* current key locale */
 379         char *key_lang, *key_ctry, *key_enc, *key_mod;
 380
 381         parse_locale(found_locale, &key_lang, &key_ctry, &key_enc, &key_mod);
 382
 383         if (env_lang && key_lang &&             /* Shortcut: if key and env languages don't match, */
 384             strcmp(env_lang, key_lang) != 0)    /* don't even bother. This takes care of the great */
 385                 return False;                   /* majority of the cases without having to go through */
 386                                                 /* the more theoretical parts of the spec'd algo. */
 387
 388         if (!env_mod && key_mod)        /* If LC_MESSAGES does not have a MODIFIER field, */
 389                 return False;           /* then no key with a modifier will be matched. */
 390
 391         if (!env_ctry && key_ctry)      /* Similarly, if LC_MESSAGES does not have a COUNTRY field, */
 392                 return False;           /* then no key with a country specified will be matched. */
 393
 394         /* LC_MESSAGES value: lang_COUNTRY@MODIFIER */
 395         if (env_lang && env_ctry && env_mod) {          /* lang_COUNTRY@MODIFIER */
 396                 if (key_lang && key_ctry && key_mod &&
 397                     strcmp(env_lang, key_lang) == 0 &&
 398                     strcmp(env_ctry, key_ctry) == 0 &&
 399                     strcmp(env_mod,  key_mod) == 0) {
 400                         *current_level = MATCH_LANG_COUNTRY_MODIFIER;
 401                         return True;
 402                 } else if (key_lang && key_ctry &&      /* lang_COUNTRY */
 403                     strcmp(env_lang, key_lang) == 0 &&
 404                     strcmp(env_ctry, key_ctry) == 0 &&
 405                     *current_level < MATCH_LANG_COUNTRY) {
 406                         *current_level = MATCH_LANG_COUNTRY;
 407                         return True;
 408                 } else if (key_lang && key_mod &&       /* lang@MODIFIER */
 409                     strcmp(env_lang, key_lang) == 0 &&
 410                     strcmp(env_mod,  key_mod) == 0 &&
 411                     *current_level < MATCH_LANG_MODIFIER) {
 412                         *current_level = MATCH_LANG_MODIFIER;
 413                         return True;
 414                 } else if (key_lang &&                  /* lang */
 415                     strcmp(env_lang, key_lang) == 0 &&
 416                     *current_level < MATCH_LANG) {
 417                         *current_level = MATCH_LANG;
 418                         return True;
 419                 } else {
 420                         return False;
 421                 }
 422         }
 423
 424         /* LC_MESSAGES value: lang_COUNTRY */
 425         if (env_lang && env_ctry) {                     /* lang_COUNTRY */
 426                 if (key_lang && key_ctry &&
 427                     strcmp(env_lang, key_lang) == 0 &&
 428                     strcmp(env_ctry, key_ctry) == 0 &&
 429                     *current_level < MATCH_LANG_COUNTRY) {
 430                         *current_level = MATCH_LANG_COUNTRY;
 431                         return True;
 432                 } else if (key_lang &&                  /* lang */
 433                     strcmp(env_lang, key_lang) == 0 &&
 434                     *current_level < MATCH_LANG) {
 435                         *current_level = MATCH_LANG;
 436                         return True;
 437                 } else {
 438                         return False;
 439                 }
 440         }
 441
 442         /* LC_MESSAGES value: lang@MODIFIER */
 443         if (env_lang && env_mod) {                      /* lang@MODIFIER */
 444                 if (key_lang && key_mod &&
 445                     strcmp(env_lang, key_lang) == 0 &&
 446                     strcmp(env_mod,  key_mod) == 0 &&
 447                     *current_level < MATCH_LANG_MODIFIER) {
 448                         *current_level = MATCH_LANG_MODIFIER;
 449                         return True;
 450                 } else if (key_lang &&                  /* lang */
 451                     strcmp(env_lang, key_lang) == 0 &&
 452                     *current_level < MATCH_LANG) {
 453                         *current_level = MATCH_LANG;
 454                         return True;
 455                 } else {
 456                         return False;
 457                 }
 458         }
 459
 460         /* LC_MESSAGES value: lang */
 461         if (env_lang) {                                 /* lang */
 462                 if (key_lang &&
 463                     strcmp(env_lang, key_lang) == 0 &&
 464                     *current_level < MATCH_LANG) {
 465                         *current_level = MATCH_LANG;
 466                         return True;
 467                 } else {
 468                         return False;
 469                 }
 470         }
 471
 472         /* MATCH_DEFAULT is handled in getLocalizedStringValue */
 473
 474         return False;
 475 }
 476
 477 /* get the (first) xdg main category from a list of categories
 478  */
 479 static void  getMenuHierarchyFor(char **xdgmenuspec)
 480 {
 481         char *category, *p;
 482         char buf[1024];
 483
 484         if (!*xdgmenuspec || !**xdgmenuspec)
 485                 return;
 486
 487         category = wstrdup(*xdgmenuspec);
 488         wfree(*xdgmenuspec);
 489         memset(buf, 0, sizeof(buf));
 490
 491         p = strtok(category, ";");
 492         while (p) {             /* get a known category */
 493                 if (strcmp(p, "AudioVideo") == 0) {
 494                         snprintf(buf, sizeof(buf), "%s", _("Audio & Video"));
 495                         break;
 496                 } else if (strcmp(p, "Audio") == 0) {
 497                         snprintf(buf, sizeof(buf), "%s", _("Audio"));
 498                         break;
 499                 } else if (strcmp(p, "Video") == 0) {
 500                         snprintf(buf, sizeof(buf), "%s", _("Video"));
 501                         break;
 502                 } else if (strcmp(p, "Development") == 0) {
 503                         snprintf(buf, sizeof(buf), "%s", _("Development"));
 504                         break;
 505                 } else if (strcmp(p, "Education") == 0) {
 506                         snprintf(buf, sizeof(buf), "%s", _("Education"));
 507                         break;
 508                 } else if (strcmp(p, "Game") == 0) {
 509                         snprintf(buf, sizeof(buf), "%s", _("Game"));
 510                         break;
 511                 } else if (strcmp(p, "Graphics") == 0) {
 512                         snprintf(buf, sizeof(buf), "%s", _("Graphics"));
 513                         break;
 514                 } else if (strcmp(p, "Network") == 0) {
 515                         snprintf(buf, sizeof(buf), "%s", _("Network"));
 516                         break;
 517                 } else if (strcmp(p, "Office") == 0) {
 518                         snprintf(buf, sizeof(buf), "%s", _("Office"));
 519                         break;
 520                 } else if (strcmp(p, "Settings") == 0) {
 521                         snprintf(buf, sizeof(buf), "%s", _("Settings"));
 522                         break;
 523                 } else if (strcmp(p, "System") == 0) {
 524                         snprintf(buf, sizeof(buf), "%s", _("System"));
 525                         break;
 526                 } else if (strcmp(p, "Utility") == 0) {
 527                         snprintf(buf, sizeof(buf), "%s", _("Utility"));
 528                         break;
 529                 }
 530                 p = strtok(NULL, ";");
 531         }
 532
 533
 534         if (!*buf)              /* come up with something if nothing found */
 535                 snprintf(buf, sizeof(buf), "%s", _("Applications"));
 536
 537         *xdgmenuspec = wstrdup(buf);
 538 }