lib/mcconfig/common.c

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