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/util.h"
  31 #include "lib/mcconfig.h"
  32
  33 /*** global variables **************************************************/
  34
  35 mc_config_t *mc_main_config;
  36 mc_config_t *mc_panels_config;
  37
  38 /*** file scope macro definitions **************************************/
  39
  40 /*** file scope type declarations **************************************/
  41
  42 /*** file scope variables **********************************************/
  43
  44 /*** file scope functions **********************************************/
  45 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  46
  47 static gboolean
  48 mc_config_new_or_override_file (mc_config_t * mc_config, const gchar * ini_path, GError ** error)
  49 {
  50     gchar *data, *written_data;
  51     gsize len, total_written;
  52     gboolean ret;
  53     int fd;
  54     ssize_t cur_written;
  55
  56     data = g_key_file_to_data (mc_config->handle, &len, NULL);
  57     if (!exist_file (ini_path))
  58     {
  59         ret = g_file_set_contents (ini_path, data, len, error);
  60         g_free (data);
  61         return ret;
  62     }
  63     mc_util_make_backup_if_possible (ini_path, "~");
  64
  65     fd = mc_open (ini_path, O_WRONLY | O_TRUNC | O_SYNC, 0);
  66     if (fd == -1)
  67     {
  68         g_propagate_error (error,
  69                            g_error_new (mc_main_error_quark (), 0, "%s",
  70                                         unix_error_string (errno)));
  71         g_free (data);
  72         return FALSE;
  73     }
  74
  75     for (written_data = data, total_written = len;
  76          (cur_written = mc_write (fd, (const void *) written_data, total_written)) > 0;
  77          written_data += cur_written, total_written -= cur_written);
  78     mc_close (fd);
  79     g_free (data);
  80
  81     if (cur_written == -1)
  82     {
  83         mc_util_restore_from_backup_if_possible (ini_path, "~");
  84         g_propagate_error (error,
  85                            g_error_new (mc_main_error_quark (), 0, "%s",
  86                                         unix_error_string (errno)));
  87         return FALSE;
  88     }
  89
  90     mc_util_unlink_backup_if_possible (ini_path, "~");
  91     return TRUE;
  92 }
  93
  94 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  95 /*** public functions **************************************************/
  96 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  97
  98 mc_config_t *
  99 mc_config_init (const gchar * ini_path)
 100 {
 101     mc_config_t *mc_config;
 102     struct stat st;
 103
 104     mc_config = g_try_malloc0 (sizeof (mc_config_t));
 105
 106     if (mc_config == NULL)
 107         return NULL;
 108
 109     mc_config->handle = g_key_file_new ();
 110     if (mc_config->handle == NULL)
 111     {
 112         g_free (mc_config);
 113         return NULL;
 114     }
 115     if (ini_path == NULL)
 116         return mc_config;
 117
 118     if (exist_file (ini_path) && mc_stat (ini_path, &st) == 0 && st.st_size != 0)
 119     {
 120         /* file exists and not empty */
 121         g_key_file_load_from_file (mc_config->handle, ini_path, G_KEY_FILE_KEEP_COMMENTS, NULL);
 122     }
 123
 124     mc_config->ini_path = g_strdup (ini_path);
 125     return mc_config;
 126 }
 127
 128 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 129
 130 void
 131 mc_config_deinit (mc_config_t * mc_config)
 132 {
 133     if (mc_config != NULL)
 134     {
 135         g_free (mc_config->ini_path);
 136         g_key_file_free (mc_config->handle);
 137         g_free (mc_config);
 138     }
 139 }
 140
 141 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 142
 143 gboolean
 144 mc_config_has_param (mc_config_t * mc_config, const char *group, const gchar * param)
 145 {
 146     if (!mc_config || !group || !param)
 147         return FALSE;
 148
 149     return g_key_file_has_key (mc_config->handle, group, param, NULL);
 150 }
 151
 152 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 153
 154 gboolean
 155 mc_config_has_group (mc_config_t * mc_config, const char *group)
 156 {
 157     if (!mc_config || !group)
 158         return FALSE;
 159
 160     return g_key_file_has_group (mc_config->handle, group);
 161 }
 162
 163 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 164
 165 gboolean
 166 mc_config_del_key (mc_config_t * mc_config, const char *group, const gchar * param)
 167 {
 168     if (!mc_config || !group || !param)
 169         return FALSE;
 170 #if GLIB_CHECK_VERSION (2, 15, 0)
 171     return g_key_file_remove_key (mc_config->handle, group, param, NULL);
 172 #else
 173     g_key_file_remove_key (mc_config->handle, group, param, NULL);
 174     return TRUE;
 175 #endif
 176 }
 177
 178 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 179
 180 gboolean
 181 mc_config_del_group (mc_config_t * mc_config, const char *group)
 182 {
 183     if (!mc_config || !group)
 184         return FALSE;
 185
 186 #if GLIB_CHECK_VERSION (2, 15, 0)
 187     return g_key_file_remove_group (mc_config->handle, group, NULL);
 188 #else
 189     g_key_file_remove_group (mc_config->handle, group, NULL);
 190     return TRUE;
 191 #endif
 192 }
 193
 194 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 195
 196 gboolean
 197 mc_config_read_file (mc_config_t * mc_config, const gchar * ini_path)
 198 {
 199     mc_config_t *tmp_config;
 200     gchar **groups, **curr_grp;
 201     gchar **keys, **curr_key;
 202     gchar *value;
 203
 204     if (mc_config == NULL)
 205     {
 206         return FALSE;
 207     }
 208
 209     tmp_config = mc_config_init (ini_path);
 210     if (tmp_config == NULL)
 211         return FALSE;
 212
 213     groups = mc_config_get_groups (tmp_config, NULL);
 214
 215     if (groups == NULL)
 216     {
 217         mc_config_deinit (tmp_config);
 218         return FALSE;
 219     }
 220
 221     for (curr_grp = groups; *curr_grp != NULL; curr_grp++)
 222     {
 223         keys = mc_config_get_keys (tmp_config, *curr_grp, NULL);
 224         for (curr_key = keys; *curr_key != NULL; curr_key++)
 225         {
 226             value = g_key_file_get_value (tmp_config->handle, *curr_grp, *curr_key, NULL);
 227             if (value == NULL)
 228                 continue;
 229
 230             g_key_file_set_value (mc_config->handle, *curr_grp, *curr_key, value);
 231             g_free (value);
 232         }
 233         g_strfreev (keys);
 234     }
 235     g_strfreev (groups);
 236     mc_config_deinit (tmp_config);
 237     return TRUE;
 238 }
 239
 240 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 241
 242 gboolean
 243 mc_config_save_file (mc_config_t * mc_config, GError ** error)
 244 {
 245     if (mc_config == NULL || mc_config->ini_path == NULL)
 246     {
 247         return FALSE;
 248     }
 249     return mc_config_new_or_override_file (mc_config, mc_config->ini_path, error);
 250 }
 251
 252 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
 253
 254 gboolean
 255 mc_config_save_to_file (mc_config_t * mc_config, const gchar * ini_path, GError ** error)
 256 {
 257     if (mc_config == NULL)
 258     {
 259         return FALSE;
 260     }
 261     return mc_config_new_or_override_file (mc_config, ini_path, error);
 262
 263 }
 264
 265 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */