lib/mcconfig/common.c

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