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