ROX-Filer/src/appinfo.c

   1 /*
   2  * $Id$
   3  *
   4  * ROX-Filer, filer for the ROX desktop project
   5  * Copyright (C) 2001, the ROX-Filer team.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with
  18  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 /* appinfo.c - loading, caching and querying the AppInfo.xml files */
  23
  24 /* Any valid application directory may contain a file called AppInfo.xml.
  25  * The format is:
  26  *
  27  * <?xml version="1.0"?>
  28  * <AppInfo>
  29  *   <Summary>Tooltip text</Summary>
  30  *   <About>
  31  *     <Purpose>...</Purpose>
  32  *     <Version>...</Version>
  33  *     <Authors>...</Authors>
  34  *     <License>...</License>
  35  *     <Homepage>...</Homepage>
  36  *     ...
  37  *   </About>
  38  *   <AppMenu>
  39  *     <Item label="..." option="..."/>
  40  *     ...
  41  *   </AppMenu>
  42  * </AppInfo>
  43  */
  44
  45 #include "config.h"
  46
  47 #include <string.h>
  48
  49 #include "global.h"
  50
  51 #include "appinfo.h"
  52 #include "fscache.h"
  53 #include "dir.h"
  54 #include "type.h"
  55 #include "support.h"
  56
  57 static GFSCache *appinfo_cache = NULL;
  58
  59 /* Static prototypes */
  60 static AppInfo *load(char *pathname, gpointer data);
  61 static void ref(AppInfo *dir, gpointer data);
  62 static void unref(AppInfo *dir, gpointer data);
  63 static int getref(AppInfo *dir, gpointer data);
  64
  65 /* Stores the tree for one application's AppInfo file */
  66 struct _AppInfo {
  67         int     ref;
  68         xmlDocPtr doc;          /* Parsed AppInfo file */
  69 };
  70
  71 /****************************************************************
  72  *                      EXTERNAL INTERFACE                      *
  73  ****************************************************************/
  74
  75 void appinfo_init(void)
  76 {
  77         appinfo_cache = g_fscache_new((GFSLoadFunc) load,
  78                                       (GFSRefFunc) ref,
  79                                       (GFSRefFunc) unref,
  80                                       (GFSGetRefFunc) getref,
  81                                       NULL, NULL);
  82 }
  83
  84 /* Load the AppInfo file for this application.
  85  *
  86  * Returns a pointer to the AppInfo structure, or NULL if this isn't
  87  * an application with a valid AppInfo file.
  88  *
  89  * appinfo_unref() the result.
  90  */
  91 AppInfo *appinfo_get(guchar *app_dir, DirItem *item)
  92 {
  93         AppInfo *ai;
  94         guchar  *tmp;
  95
  96         /* Is it even an application directory? */
  97         if (item->base_type != TYPE_DIRECTORY ||
  98                         !(item->flags & ITEM_FLAG_APPDIR))
  99                 return NULL;    /* Not an application */
 100
 101         tmp = g_strconcat(app_dir, "/" APPINFO_FILENAME, NULL);
 102         ai = g_fscache_lookup(appinfo_cache, tmp);
 103         g_free(tmp);
 104
 105         if (!ai)
 106         {
 107                 /* Temp: look for the old AppMenu file */
 108                 tmp = g_strconcat(app_dir, "/AppMenu", NULL);
 109                 ai = g_fscache_lookup(appinfo_cache, tmp);
 110                 g_free(tmp);
 111         }
 112
 113         return ai;
 114 }
 115
 116 void appinfo_unref(AppInfo *info)
 117 {
 118         g_return_if_fail(info != NULL);
 119
 120         g_fscache_data_unref(appinfo_cache, info);
 121 }
 122
 123 /* Look for this section in the AppInfo document.
 124  * It may be any direct child node, or the root node itself (this is for
 125  * backwards compat with AppMenu; it may go soon).
 126  *
 127  * Returns an _xmlNode or NULL if there isn't one.
 128  */
 129 xmlNode *appinfo_get_section(AppInfo *ai, guchar *name)
 130 {
 131         xmlNode *node;
 132
 133         g_return_val_if_fail(ai != NULL, NULL);
 134         g_return_val_if_fail(name != NULL, NULL);
 135
 136         node = xmlDocGetRootElement(ai->doc);
 137         g_return_val_if_fail(node != NULL, NULL);
 138
 139         if (strcmp(node->name, name) == 0)
 140                 return node;
 141
 142         return get_subnode(node, NULL, name);
 143 }
 144
 145 /****************************************************************
 146  *                      INTERNAL FUNCTIONS                      *
 147  ****************************************************************/
 148
 149 /* The pathname is the full path of the AppInfo file.
 150  * If we get here, assume that this really is an application.
 151  */
 152 static AppInfo *load(char *pathname, gpointer data)
 153 {
 154         xmlDocPtr doc;
 155         AppInfo *appinfo = NULL;
 156
 157         doc = xmlParseFile(pathname);
 158         if (!doc)
 159                 return NULL;    /* Bad XML */
 160
 161         appinfo = g_new(AppInfo, 1);
 162         appinfo->ref = 1;
 163         appinfo->doc = doc;
 164
 165         return appinfo;
 166 }
 167
 168 static void ref(AppInfo *ai, gpointer data)
 169 {
 170         if (ai)
 171                 ai->ref++;
 172 }
 173
 174 static void unref(AppInfo *ai, gpointer data)
 175 {
 176         if (ai && --ai->ref == 0)
 177         {
 178                 xmlFreeDoc(ai->doc);
 179                 g_free(ai);
 180         }
 181 }
 182
 183 static int getref(AppInfo *ai, gpointer data)
 184 {
 185         return ai ? ai->ref : 0;
 186 }