obt/link.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    obt/link.c for the Openbox window manager
   4    Copyright (c) 2009        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/link.h"
  20 #include "obt/ddparse.h"
  21 #include "obt/paths.h"
  22 #include <glib.h>
  23
  24 struct _ObtLink {
  25     guint ref;
  26
  27     ObtLinkType type;
  28     gchar *name; /*!< Specific name for the object (eg Firefox) */
  29     gboolean display; /*<! When false, do not display this link in menus or
  30                            launchers, etc */
  31     gboolean deleted; /*<! When true, the Link could exist but is deleted
  32                            for the current user */
  33     gchar *generic; /*!< Generic name for the object (eg Web Browser) */
  34     gchar *comment; /*!< Comment/description to display for the object */
  35     gchar *icon; /*!< Name/path for an icon for the object */
  36     guint env_required; /*!< The environments that must be present to use this
  37                           link. */
  38     guint env_restricted; /*!< The environments that must _not_ be present to
  39                             use this link. */
  40
  41     union _ObtLinkData {
  42         struct _ObtLinkApp {
  43             gchar *exec; /*!< Executable to run for the app */
  44             gchar *wdir; /*!< Working dir to run the app in */
  45             gboolean term; /*!< Run the app in a terminal or not */
  46             ObtLinkAppOpen open;
  47
  48             /* XXX gchar**? or something better, a mime struct.. maybe
  49                glib has something i can use. */
  50             gchar **mime; /*!< Mime types the app can open */
  51
  52             GQuark *categories; /*!< Array of quarks representing the
  53                                   application's categories */
  54             gulong  n_categories; /*!< Number of categories for the app */
  55
  56             ObtLinkAppStartup startup;
  57             gchar *startup_wmclass;
  58         } app;
  59         struct _ObtLinkLink {
  60             gchar *addr;
  61         } url;
  62         struct _ObtLinkDir {
  63         } dir;
  64     } d;
  65 };
  66
  67 ObtLink* obt_link_from_ddfile(const gchar *ddname, GSList *paths,
  68                               ObtPaths *p)
  69 {
  70     ObtLink *link;
  71     GHashTable *groups, *keys;
  72     ObtDDParseGroup *g;
  73     ObtDDParseValue *v;
  74
  75     /* parse the file, and get a hash table of the groups */
  76     groups = obt_ddparse_file(ddname, paths);
  77     if (!groups) return NULL; /* parsing failed */
  78     /* grab the Desktop Entry group */
  79     g = g_hash_table_lookup(groups, "Desktop Entry");
  80     g_assert(g != NULL);
  81     /* grab the keys that appeared in the Desktop Entry group */
  82     keys = obt_ddparse_group_keys(g);
  83
  84     /* build the ObtLink (we steal all strings from the parser) */
  85     link = g_slice_new0(ObtLink);
  86     link->ref = 1;
  87     link->display = TRUE;
  88
  89     v = g_hash_table_lookup(keys, "Type");
  90     g_assert(v);
  91     link->type = v->value.enumerable;
  92
  93     if ((v = g_hash_table_lookup(keys, "Hidden")))
  94         link->deleted = v->value.boolean;
  95
  96     if ((v = g_hash_table_lookup(keys, "NoDisplay")))
  97         link->display = !v->value.boolean;
  98
  99     if ((v = g_hash_table_lookup(keys, "GenericName")))
 100         link->generic = v->value.string, v->value.string = NULL;
 101
 102     if ((v = g_hash_table_lookup(keys, "Comment")))
 103         link->comment = v->value.string, v->value.string = NULL;
 104
 105     if ((v = g_hash_table_lookup(keys, "Icon")))
 106         link->icon = v->value.string, v->value.string = NULL;
 107
 108     if ((v = g_hash_table_lookup(keys, "OnlyShowIn")))
 109         link->env_required = v->value.environments;
 110     else
 111         link->env_required = 0;
 112
 113     if ((v = g_hash_table_lookup(keys, "NotShowIn")))
 114         link->env_restricted = v->value.environments;
 115     else
 116         link->env_restricted = 0;
 117
 118     /* type-specific keys */
 119
 120     if (link->type == OBT_LINK_TYPE_APPLICATION) {
 121         gchar *c;
 122         gboolean percent;
 123
 124         v = g_hash_table_lookup(keys, "Exec");
 125         g_assert(v);
 126         link->d.app.exec = v->value.string;
 127         v->value.string = NULL;
 128
 129         /* parse link->d.app.exec to determine link->d.app.open */
 130         percent = FALSE;
 131         for (c = link->d.app.exec; *c; ++c) {
 132             if (percent) {
 133                 switch (*c) {
 134                 case 'f': link->d.app.open = OBT_LINK_APP_SINGLE_LOCAL; break;
 135                 case 'F': link->d.app.open = OBT_LINK_APP_MULTI_LOCAL; break;
 136                 case 'u': link->d.app.open = OBT_LINK_APP_SINGLE_URL; break;
 137                 case 'U': link->d.app.open = OBT_LINK_APP_MULTI_URL; break;
 138                 default: percent = FALSE;
 139                 }
 140                 if (percent) break; /* found f/F/u/U */
 141             }
 142             else if (*c == '%') percent = TRUE;
 143         }
 144
 145         if ((v = g_hash_table_lookup(keys, "TryExec"))) {
 146             /* XXX spawn a thread to check TryExec? */
 147             link->display = link->display &&
 148                 obt_paths_try_exec(p, v->value.string);
 149         }
 150
 151         if ((v = g_hash_table_lookup(keys, "Path"))) {
 152             /* steal the string */
 153             link->d.app.wdir = v->value.string;
 154             v->value.string = NULL;
 155         }
 156
 157         if ((v = g_hash_table_lookup(keys, "Terminal")))
 158             link->d.app.term = v->value.boolean;
 159
 160         if ((v = g_hash_table_lookup(keys, "StartupNotify")))
 161             link->d.app.startup = v->value.boolean ?
 162                 OBT_LINK_APP_STARTUP_PROTOCOL_SUPPORT :
 163                 OBT_LINK_APP_STARTUP_NO_SUPPORT;
 164         else {
 165             link->d.app.startup = OBT_LINK_APP_STARTUP_LEGACY_SUPPORT;
 166             if ((v = g_hash_table_lookup(keys, "StartupWMClass"))) {
 167                 /* steal the string */
 168                 link->d.app.startup_wmclass = v->value.string;
 169                 v->value.string = NULL;
 170             }
 171         }
 172
 173         if ((v = g_hash_table_lookup(keys, "Categories"))) {
 174             gulong i;
 175             gchar *end;
 176
 177             link->d.app.categories = g_new(GQuark, v->value.strings.n);
 178             link->d.app.n_categories = v->value.strings.n;
 179
 180             for (i = 0; i < v->value.strings.n; ++i) {
 181                 link->d.app.categories[i] =
 182                     g_quark_from_string(v->value.strings.a[i]);
 183                 c = end = end+1; /* next */
 184             }
 185         }
 186
 187         /* XXX do something with mime types */
 188     }
 189     else if (link->type == OBT_LINK_TYPE_URL) {
 190         v = g_hash_table_lookup(keys, "URL");
 191         g_assert(v);
 192         link->d.url.addr = v->value.string;
 193         v->value.string = NULL;
 194     }
 195
 196     /* destroy the parsing info */
 197     g_hash_table_destroy(groups);
 198
 199     return link;
 200 }
 201
 202 void obt_link_ref(ObtLink *dd)
 203 {
 204     ++dd->ref;
 205 }
 206
 207 void obt_link_unref(ObtLink *dd)
 208 {
 209     if (--dd->ref < 1) {
 210         g_free(dd->name);
 211         g_free(dd->generic);
 212         g_free(dd->comment);
 213         g_free(dd->icon);
 214         if (dd->type == OBT_LINK_TYPE_APPLICATION) {
 215             g_free(dd->d.app.exec);
 216             g_free(dd->d.app.wdir);
 217             g_free(dd->d.app.categories);
 218             g_free(dd->d.app.startup_wmclass);
 219         }
 220         else if (dd->type == OBT_LINK_TYPE_URL)
 221             g_free(dd->d.url.addr);
 222         g_slice_free(ObtLink, dd);
 223     }
 224 }
 225
 226 const GQuark* obt_link_app_categories(ObtLink *e, gulong *n)
 227 {
 228     g_return_val_if_fail(e != NULL, NULL);
 229     g_return_val_if_fail(e->type == OBT_LINK_TYPE_APPLICATION, NULL);
 230     g_return_val_if_fail(n != NULL, NULL);
 231
 232     *n = e->d.app.n_categories;
 233     return e->d.app.categories;
 234 }