lib/mcconfig/common.c

   1 /*
   2    Configure module for the Midnight Commander
   3
   4    Copyright (C) 1994, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
   5    2007, 2009, 2011
   6    The Free Software Foundation, Inc.
   7
   8    This file is part of the Midnight Commander.
   9
  10    The Midnight Commander is free software: you can redistribute it
  11    and/or modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation, either version 3 of the License,
  13    or (at your option) any later version.
  14
  15    The Midnight Commander is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24 #include <config.h>
  25
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30 #include <errno.h>              /* extern int errno */
  31
  32 #include "lib/global.h"
  33 #include "lib/vfs/vfs.h"        /* mc_stat */
  34 #include "lib/util.h"
  35 #include "lib/mcconfig.h"
  36
  37 /*** global variables **************************************************/
  38
  39 mc_config_t *mc_main_config;
  40 mc_config_t *mc_panels_config;
  41
  42 /*** file scope macro definitions **************************************/
  43
  44 /*** file scope type declarations **************************************/
  45
  46 /*** file scope variables **********************************************/
  47
  48 /*** file scope functions **********************************************/
  49 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  50
  51 static gboolean
  52 mc_config_new_or_override_file (mc_config_t * mc_config, const gchar * ini_path, GError ** error)
  53 {
  54     gchar *data, *written_data;
  55     gsize len, total_written;
  56     gboolean ret;
  57     int fd;
  58     ssize_t cur_written;
  59     vfs_path_t *ini_vpath;
  60
  61     ini_vpath = vfs_path_from_str (ini_path);
  62     data = g_key_file_to_data (mc_config->handle, &len, NULL);
  63     if (!exist_file (ini_path))
  64     {
  65         ret = g_file_set_contents (ini_path, data, len, error);
  66         g_free (data);
  67         vfs_path_free (ini_vpath);
  68         return ret;
  69     }
  70     mc_util_make_backup_if_possible (ini_path, "~");
  71
  72     fd = mc_open (ini_vpath, O_WRONLY | O_TRUNC, 0);
  73     if (fd == -1)
  74     {
  75         g_propagate_error (error, g_error_new (MC_ERROR, 0, "%s", unix_error_string (errno)));
  76         g_free (data);
  77         vfs_path_free (ini_vpath);
  78         return FALSE;
  79     }
  80
  81     for (written_data = data, total_written = len;
  82          (cur_written = mc_write (fd, (const void *) written_data, total_written)) > 0;
  83          written_data += cur_written, total_written -= cur_written);
  84     mc_close (fd);
  85     g_free (data);
  86
  87     if (cur_written == -1)
  88     {
  89         mc_util_restore_from_backup_if_possible (ini_path, "~");
  90         g_propagate_error (error, g_error_new (MC_ERROR, 0, "%s", unix_error_string (errno)));
  91         vfs_path_free (ini_vpath);
  92         return FALSE;
  93     }
  94
  95     mc_util_unlink_backup_if_possible (ini_path, "~");
  96     vfs_path_free (ini_vpath);
  97     return TRUE;
  98 }
  99
 100 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 101 /*** public functions **************************************************/
 102 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 103
 104 mc_config_t *
 105 mc_config_init (const gchar * ini_path)
 106 {
 107     mc_config_t *mc_config;
 108     struct stat st;
 109
 110     mc_config = g_try_malloc0 (sizeof (mc_config_t));
 111
 112     if (mc_config == NULL)
 113         return NULL;
 114
 115     mc_config->handle = g_key_file_new ();
 116     if (mc_config->handle == NULL)
 117     {
 118         g_free (mc_config);
 119         return NULL;
 120     }
 121     if (ini_path == NULL)
 122         return mc_config;
 123
 124     if (exist_file (ini_path))
 125     {
 126         vfs_path_t *vpath;
 127
 128         vpath = vfs_path_from_str (ini_path);
 129         if (mc_stat (vpath, &st) == 0 && st.st_size != 0)
 130         {
 131             /* file exists and not empty */
 132             g_key_file_load_from_file (mc_config->handle, ini_path, G_KEY_FILE_KEEP_COMMENTS, NULL);
 133         }
 134         vfs_path_free (vpath);
 135     }
 136
 137     mc_config->ini_path = g_strdup (ini_path);
 138     return mc_config;
 139 }
 140
 141 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 142
 143 void
 144 mc_config_deinit (mc_config_t * mc_config)
 145 {
 146     if (mc_config != NULL)
 147     {
 148         g_free (mc_config->ini_path);
 149         g_key_file_free (mc_config->handle);
 150         g_free (mc_config);
 151     }
 152 }
 153
 154 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 155
 156 gboolean
 157 mc_config_has_param (const mc_config_t * mc_config, const char *group, const gchar * param)
 158 {
 159     if (!mc_config || !group || !param)
 160         return FALSE;
 161
 162     return g_key_file_has_key (mc_config->handle, group, param, NULL);
 163 }
 164
 165 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 166
 167 gboolean
 168 mc_config_has_group (mc_config_t * mc_config, const char *group)
 169 {
 170     if (!mc_config || !group)
 171         return FALSE;
 172
 173     return g_key_file_has_group (mc_config->handle, group);
 174 }
 175
 176 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 177
 178 gboolean
 179 mc_config_del_key (mc_config_t * mc_config, const char *group, const gchar * param)
 180 {
 181     if (!mc_config || !group || !param)
 182         return FALSE;
 183 #if GLIB_CHECK_VERSION (2, 15, 0)
 184     return g_key_file_remove_key (mc_config->handle, group, param, NULL);
 185 #else
 186     g_key_file_remove_key (mc_config->handle, group, param, NULL);
 187     return TRUE;
 188 #endif
 189 }
 190
 191 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 192
 193 gboolean
 194 mc_config_del_group (mc_config_t * mc_config, const char *group)
 195 {
 196     if (!mc_config || !group)
 197         return FALSE;
 198
 199 #if GLIB_CHECK_VERSION (2, 15, 0)
 200     return g_key_file_remove_group (mc_config->handle, group, NULL);
 201 #else
 202     g_key_file_remove_group (mc_config->handle, group, NULL);
 203     return TRUE;
 204 #endif
 205 }
 206
 207 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 208
 209 gboolean
 210 mc_config_read_file (mc_config_t * mc_config, const gchar * ini_path, gboolean remove_empty)
 211 {
 212     mc_config_t *tmp_config;
 213     gchar **groups, **curr_grp;
 214     gchar **keys, **curr_key;
 215     gchar *value;
 216
 217     if (mc_config == NULL)
 218         return FALSE;
 219
 220     tmp_config = mc_config_init (ini_path);
 221     if (tmp_config == NULL)
 222         return FALSE;
 223
 224     groups = mc_config_get_groups (tmp_config, NULL);
 225
 226     if (groups == NULL)
 227     {
 228         mc_config_deinit (tmp_config);
 229         return FALSE;
 230     }
 231
 232     for (curr_grp = groups; *curr_grp != NULL; curr_grp++)
 233     {
 234         keys = mc_config_get_keys (tmp_config, *curr_grp, NULL);
 235         for (curr_key = keys; *curr_key != NULL; curr_key++)
 236         {
 237             value = g_key_file_get_value (tmp_config->handle, *curr_grp, *curr_key, NULL);
 238             if (value != NULL)
 239             {
 240                 if (*value == '\0' && remove_empty)
 241                     g_key_file_remove_key (mc_config->handle, *curr_grp, *curr_key, NULL);
 242                 else
 243                     g_key_file_set_value (mc_config->handle, *curr_grp, *curr_key, value);
 244                 g_free (value);
 245             }
 246             else if (remove_empty)
 247                 g_key_file_remove_key (mc_config->handle, *curr_grp, *curr_key, NULL);
 248         }
 249         g_strfreev (keys);
 250     }
 251     g_strfreev (groups);
 252     mc_config_deinit (tmp_config);
 253     return TRUE;
 254 }
 255
 256 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 257
 258 gboolean
 259 mc_config_save_file (mc_config_t * mc_config, GError ** error)
 260 {
 261     if (mc_config == NULL || mc_config->ini_path == NULL)
 262     {
 263         return FALSE;
 264     }
 265     return mc_config_new_or_override_file (mc_config, mc_config->ini_path, error);
 266 }
 267
 268 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 269
 270 gboolean
 271 mc_config_save_to_file (mc_config_t * mc_config, const gchar * ini_path, GError ** error)
 272 {
 273     if (mc_config == NULL)
 274     {
 275         return FALSE;
 276     }
 277     return mc_config_new_or_override_file (mc_config, ini_path, error);
 278
 279 }
 280
 281 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */