ROX-Filer/src/choices.c

   1 /*
   2  * $Id$
   3  *
   4  * ROX-Filer, filer for the ROX desktop project
   5  * Copyright (C) 2000, Thomas Leonard, <tal197@ecs.soton.ac.uk>.
   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 /* choices.c - code for handling loading and saving of user choices */
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <sys/stat.h>
  26 #include <sys/types.h>
  27 #include <sys/param.h>
  28 #include <fcntl.h>
  29 #include <unistd.h>
  30 #include <errno.h>
  31
  32 #include "choices.h"
  33
  34 static gboolean saving_disabled = TRUE;
  35 static gchar **dir_list = NULL;
  36
  37 /* Static prototypes */
  38 static gboolean exists(char *path);
  39
  40
  41 /****************************************************************
  42  *                      EXTERNAL INTERFACE                      *
  43  ****************************************************************/
  44
  45
  46 /* Reads in CHOICESPATH and constructs the directory list table.
  47  * You must call this before using any other choices_* functions.
  48  *
  49  * If CHOICESPATH does not exist then a suitable default is used.
  50  */
  51 void choices_init(void)
  52 {
  53         char    *choices;
  54
  55         g_return_if_fail(dir_list == NULL);
  56
  57         choices = getenv("CHOICESPATH");
  58
  59         if (choices)
  60         {
  61                 if (*choices != ':' && *choices != '\0')
  62                         saving_disabled = FALSE;
  63
  64                 while (*choices == ':')
  65                         choices++;
  66
  67                 if (*choices == '\0')
  68                 {
  69                         dir_list = g_new(char *, 1);
  70                         dir_list[0] = NULL;
  71                 }
  72                 else
  73                         dir_list = g_strsplit(choices, ":", 0);
  74         }
  75         else
  76         {
  77                 saving_disabled = FALSE;
  78
  79                 dir_list = g_new(gchar *, 4);
  80                 dir_list[0] = g_strconcat(getenv("HOME"), "/Choices", NULL);
  81                 dir_list[1] = g_strdup("/usr/local/Choices");
  82                 dir_list[2] = g_strdup("/usr/Choices");
  83                 dir_list[3] = NULL;
  84         }
  85
  86 #if 0
  87         {
  88                 gchar   **cdir = dir_list;
  89
  90                 while (*cdir)
  91                 {
  92                         g_print("[ choices dir '%s' ]\n", *cdir);
  93                         cdir++;
  94                 }
  95
  96                 g_print("[ saving is %s ]\n", saving_disabled ? "disabled"
  97                                                               : "enabled");
  98         }
  99 #endif
 100 }
 101
 102 /* Returns an array of the directories in CHOICESPATH which contain
 103  * a subdirectory called 'dir'.
 104  *
 105  * Lower-indexed results should override higher-indexed ones.
 106  *
 107  * Free the list using choices_free_list().
 108  */
 109 GPtrArray *choices_list_dirs(char *dir)
 110 {
 111         GPtrArray       *list;
 112         gchar           **cdir = dir_list;
 113
 114         g_return_val_if_fail(dir_list != NULL, NULL);
 115
 116         list = g_ptr_array_new();
 117
 118         while (*cdir)
 119         {
 120                 guchar  *path;
 121
 122                 path = g_strconcat(*cdir, "/", dir, NULL);
 123                 if (exists(path))
 124                         g_ptr_array_add(list, path);
 125                 else
 126                         g_free(path);
 127
 128                 cdir++;
 129         }
 130
 131         return list;
 132 }
 133
 134 void choices_free_list(GPtrArray *list)
 135 {
 136         int     i;
 137
 138         g_return_if_fail(list != NULL);
 139
 140         for (i = 0; i < list->len; i++)
 141                 g_free(g_ptr_array_index(list, i));
 142
 143         g_ptr_array_free(list, TRUE);
 144 }
 145
 146 /* Get the pathname of a choices file to load. Eg:
 147  *
 148  * choices_find_path_load("menus", "ROX-Filer")
 149  *                              -> "/usr/local/Choices/ROX-Filer/menus".
 150  *
 151  * The return values may be NULL - use built-in defaults - otherwise
 152  * g_free() the result.
 153  */
 154 guchar *choices_find_path_load(char *leaf, char *dir)
 155 {
 156         gchar           **cdir = dir_list;
 157
 158         g_return_val_if_fail(dir_list != NULL, NULL);
 159
 160         while (*cdir)
 161         {
 162                 gchar   *path;
 163
 164                 path = g_strconcat(*cdir, "/", dir, "/", leaf, NULL);
 165
 166                 if (exists(path))
 167                         return path;
 168
 169                 g_free(path);
 170
 171                 cdir++;
 172         }
 173
 174         return NULL;
 175 }
 176
 177 /* Returns the pathname of a file to save to, or NULL if saving is
 178  * disabled. If 'create' is TRUE then intermediate directories will
 179  * be created (set this to FALSE if you just want to find out where
 180  * a saved file would go without actually altering the filesystem).
 181  */
 182 guchar *choices_find_path_save(char *leaf, char *dir, gboolean create)
 183 {
 184         static gchar    *path = NULL;
 185
 186         g_return_val_if_fail(dir_list != NULL, NULL);
 187
 188         if (path)
 189         {
 190                 g_free(path);
 191                 path = NULL;
 192         }
 193
 194         if (saving_disabled)
 195                 return NULL;
 196
 197         if (create && !exists(dir_list[0]))
 198         {
 199                 if (mkdir(dir_list[0], 0777))
 200                         g_warning("mkdir(%s): %s\n", dir_list[0],
 201                                         g_strerror(errno));
 202         }
 203
 204         path = g_strconcat(dir_list[0], "/", dir, NULL);
 205         if (create && !exists(path))
 206         {
 207                 if (mkdir(path, 0777))
 208                         g_warning("mkdir(%s): %s\n", path, g_strerror(errno));
 209         }
 210
 211         path = g_strconcat(path, "/", leaf, NULL);
 212
 213         return path;
 214 }
 215
 216
 217 /****************************************************************
 218  *                      INTERNAL FUNCTIONS                      *
 219  ****************************************************************/
 220
 221
 222 /* Returns TRUE if the object exists, FALSE if it doesn't */
 223 static gboolean exists(char *path)
 224 {
 225         struct stat info;
 226
 227         return stat(path, &info) == 0;
 228 }