lib/mcconfig/paths.c

   1 /*
   2    paths to configuration files
   3
   4    Copyright (C) 2010 The Free Software Foundation, Inc.
   5
   6    Written by:
   7    Slava Zanko <slavazanko@gmail.com>, 2010.
   8
   9    This file is part of the Midnight Commander.
  10
  11    The Midnight Commander is free software; you can redistribute it
  12    and/or modify it under the terms of the GNU General Public License as
  13    published by the Free Software Foundation; either version 2 of the
  14    License, or (at your option) any later version.
  15
  16    The Midnight Commander is distributed in the hope that it will be
  17    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  18    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program; if not, write to the Free Software
  23    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  24    MA 02110-1301, USA.
  25  */
  26
  27 #include <config.h>
  28
  29 #include <stdio.h>
  30 #include <errno.h>
  31
  32 #include "lib/global.h"
  33 #include "lib/mcconfig.h"
  34 #include "lib/fileloc.h"
  35 #include "lib/vfs/mc-vfs/vfs.h"
  36
  37 /*** global variables ****************************************************************************/
  38
  39 /*** file scope macro definitions ****************************************************************/
  40
  41 /*** file scope type declarations ****************************************************************/
  42
  43 /*** file scope variables ************************************************************************/
  44
  45 static gboolean xdg_vars_initialized = FALSE;
  46 static char *xdg_config = NULL;
  47 static char *xdg_cache = NULL;
  48 static char *xdg_data = NULL;
  49
  50 static const char *homedir = NULL;
  51
  52 static gboolean config_dir_present = FALSE;
  53
  54 static const struct
  55 {
  56     const char *old_filename;
  57
  58     char **new_basedir;
  59     const char *new_filename;
  60 } mc_config_migrate_rules[] =
  61 {
  62     /* *INDENT-OFF* */
  63     /* config */
  64     { "ini",                                   &xdg_config, MC_CONFIG_FILE},
  65     { "filehighlight.ini",                     &xdg_config, MC_FHL_INI_FILE},
  66     { "hotlist",                               &xdg_config, MC_HOTLIST_FILE},
  67     { "mc.keymap",                             &xdg_config, GLOBAL_KEYMAP_FILE},
  68
  69     /* data */
  70     { "skins",                                 &xdg_data, MC_SKINS_SUBDIR},
  71     { "fish",                                  &xdg_data, FISH_PREFIX},
  72     { "bindings",                              &xdg_data, MC_FILEBIND_FILE},
  73     { "menu",                                  &xdg_data, MC_USERMENU_FILE},
  74     { "bashrc",                                &xdg_data, "bashrc"},
  75     { "inputrc",                               &xdg_data, "inputrc"},
  76     { "extfs.d",                               &xdg_data, MC_EXTFS_DIR},
  77     { "cedit" PATH_SEP_STR "Syntax",           &xdg_data, EDIT_SYNTAX_FILE},
  78     { "cedit" PATH_SEP_STR "menu",             &xdg_data, EDIT_HOME_MENU},
  79     { "cedit" PATH_SEP_STR "edit.indent.rc",   &xdg_data, EDIT_DIR PATH_SEP_STR "edit.indent.rc"},
  80     { "cedit" PATH_SEP_STR "edit.spell.rc",    &xdg_data, EDIT_DIR PATH_SEP_STR "edit.spell.rc"},
  81
  82     /* cache */
  83     { "history",                               &xdg_cache, MC_HISTORY_FILE},
  84     { "panels.ini",                            &xdg_cache, MC_PANELS_FILE},
  85     { "log",                                   &xdg_cache, "mc.log"},
  86     { "filepos",                               &xdg_cache, MC_FILEPOS_FILE},
  87     { "Tree",                                  &xdg_cache, MC_TREESTORE_FILE},
  88     { "cedit" PATH_SEP_STR "cooledit.clip",    &xdg_cache, EDIT_CLIP_FILE},
  89     { "cedit" PATH_SEP_STR "cooledit.temp",    &xdg_cache, EDIT_TEMP_FILE},
  90     { "cedit" PATH_SEP_STR "cooledit.block",   &xdg_cache, EDIT_BLOCK_FILE},
  91
  92     {NULL, NULL, NULL}
  93     /* *INDENT-ON* */
  94 };
  95
  96 /*** file scope functions *********************************************************************** */
  97 /* --------------------------------------------------------------------------------------------- */
  98
  99 static void
 100 mc_config_mkdir (const char *directory_name, GError ** error)
 101 {
 102     if ((!g_file_test (directory_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) &&
 103         (g_mkdir_with_parents (directory_name, 0700) != 0))
 104     {
 105         g_propagate_error (error,
 106                            g_error_new (MC_ERROR, 0, _("Cannot create %s directory"),
 107                                         directory_name));
 108     }
 109 }
 110
 111 /* --------------------------------------------------------------------------------------------- */
 112
 113 static char *
 114 mc_config_init_one_config_path (const char *path_base, const char *subdir, GError ** error)
 115 {
 116     char *full_path;
 117
 118     full_path = g_build_filename (path_base, subdir, NULL);
 119
 120     if (g_file_test (full_path, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
 121         config_dir_present = TRUE;
 122
 123     mc_config_mkdir (full_path, error);
 124     if (error != NULL && *error != NULL)
 125     {
 126         g_free (full_path);
 127         full_path = NULL;
 128     }
 129     return full_path;
 130 }
 131
 132 /* --------------------------------------------------------------------------------------------- */
 133
 134 static char *
 135 mc_config_get_deprecated_path (void)
 136 {
 137     return g_build_filename (mc_config_get_home_dir (), "." MC_USERCONF_DIR, NULL);
 138 }
 139
 140 /* --------------------------------------------------------------------------------------------- */
 141
 142 static void
 143 mc_config_copy (const char *old_name, const char *new_name, GError ** error)
 144 {
 145     if (error != NULL && *error != NULL)
 146         return;
 147
 148     if (g_file_test (old_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_REGULAR))
 149     {
 150         char *contents = NULL;
 151         size_t length;
 152
 153         if (g_file_get_contents (old_name, &contents, &length, error))
 154             g_file_set_contents (new_name, contents, length, error);
 155
 156         g_free (contents);
 157         return;
 158     }
 159
 160     if (g_file_test (old_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
 161     {
 162
 163         GDir *dir;
 164         const char *dir_name;
 165
 166         dir = g_dir_open (old_name, 0, error);
 167         if (dir == NULL)
 168             return;
 169
 170         if (!g_mkdir_with_parents (new_name, 0700))
 171         {
 172             g_dir_close (dir);
 173             g_propagate_error (error,
 174                                g_error_new (MC_ERROR, 0,
 175                                             _
 176                                             ("An error occured while migrating user settings: %s"),
 177                                             g_strerror (errno)));
 178             return;
 179         }
 180
 181         while ((dir_name = g_dir_read_name (dir)) != NULL)
 182         {
 183             char *old_name2, *new_name2;
 184             old_name2 = g_build_filename (old_name, dir_name, NULL);
 185             new_name2 = g_build_filename (new_name, dir_name, NULL);
 186             mc_config_copy (old_name2, new_name2, error);
 187             g_free (new_name2);
 188             g_free (old_name2);
 189         }
 190     }
 191
 192     if (rename (old_name, new_name) != 0)
 193     {
 194         g_propagate_error (error,
 195                            g_error_new (MC_ERROR, 0,
 196                                         _
 197                                         ("An error occured while migrating user settings: %s"),
 198                                         g_strerror (errno)));
 199     }
 200 }
 201
 202 /* --------------------------------------------------------------------------------------------- */
 203 /*** public functions ****************************************************************************/
 204 /* --------------------------------------------------------------------------------------------- */
 205
 206 void
 207 mc_config_init_config_paths (GError ** error)
 208 {
 209     char *u_config_dir = (char *) g_get_user_config_dir ();
 210     char *u_data_dir = (char *) g_get_user_data_dir ();
 211     char *u_cache_dir = (char *) g_get_user_cache_dir ();
 212
 213     if (xdg_vars_initialized)
 214         return;
 215
 216     u_config_dir = (u_config_dir == NULL)
 217         ? g_build_filename (mc_config_get_home_dir (), ".config", NULL) : g_strdup (u_config_dir);
 218
 219     u_cache_dir = (u_cache_dir == NULL)
 220         ? g_build_filename (mc_config_get_home_dir (), ".cache", NULL) : g_strdup (u_cache_dir);
 221
 222     u_data_dir = (u_data_dir == NULL)
 223         ? g_build_filename (mc_config_get_home_dir (), ".local", "share", NULL)
 224         : g_strdup (u_data_dir);
 225
 226     xdg_config = mc_config_init_one_config_path (u_config_dir, MC_USERCONF_DIR, error);
 227     xdg_cache = mc_config_init_one_config_path (u_cache_dir, MC_USERCONF_DIR, error);
 228     xdg_data = mc_config_init_one_config_path (u_data_dir, MC_USERCONF_DIR, error);
 229
 230     g_free (u_data_dir);
 231     g_free (u_cache_dir);
 232     g_free (u_config_dir);
 233     xdg_vars_initialized = TRUE;
 234 }
 235
 236 /* --------------------------------------------------------------------------------------------- */
 237
 238 void
 239 mc_config_deinit_config_paths (void)
 240 {
 241     if (!xdg_vars_initialized)
 242         return;
 243
 244     g_free (xdg_config);
 245     g_free (xdg_cache);
 246     g_free (xdg_data);
 247
 248     xdg_vars_initialized = FALSE;
 249 }
 250
 251 /* --------------------------------------------------------------------------------------------- */
 252
 253 const char *
 254 mc_config_get_data_path (void)
 255 {
 256     if (!xdg_vars_initialized)
 257         mc_config_init_config_paths (NULL);
 258
 259     return (const char *) xdg_data;
 260 }
 261
 262 /* --------------------------------------------------------------------------------------------- */
 263
 264 const char *
 265 mc_config_get_cache_path (void)
 266 {
 267     if (!xdg_vars_initialized)
 268         mc_config_init_config_paths (NULL);
 269
 270     return (const char *) xdg_cache;
 271 }
 272
 273 /* --------------------------------------------------------------------------------------------- */
 274
 275 const char *
 276 mc_config_get_home_dir (void)
 277 {
 278     if (homedir == NULL)
 279     {
 280         homedir = g_getenv ("HOME");
 281         if (homedir == NULL)
 282             homedir = g_get_home_dir ();
 283     }
 284     return homedir;
 285 }
 286
 287 /* --------------------------------------------------------------------------------------------- */
 288
 289 const char *
 290 mc_config_get_path (void)
 291 {
 292     if (!xdg_vars_initialized)
 293         mc_config_init_config_paths (NULL);
 294
 295     return (const char *) xdg_config;
 296 }
 297
 298 /* --------------------------------------------------------------------------------------------- */
 299
 300 void
 301 mc_config_migrate_from_old_place (GError ** error)
 302 {
 303     char *old_dir, *tmp_dir_name;
 304     size_t rule_index;
 305
 306     old_dir = mc_config_get_deprecated_path ();
 307
 308     tmp_dir_name = mc_config_init_one_config_path (xdg_config, EDIT_DIR, error);
 309     g_free (tmp_dir_name);
 310     tmp_dir_name = mc_config_init_one_config_path (xdg_cache, EDIT_DIR, error);
 311     g_free (tmp_dir_name);
 312     tmp_dir_name = mc_config_init_one_config_path (xdg_data, EDIT_DIR, error);
 313     g_free (tmp_dir_name);
 314
 315     for (rule_index = 0; mc_config_migrate_rules[rule_index].old_filename != NULL; rule_index++)
 316     {
 317         char *old_name, *new_name;
 318
 319         old_name =
 320             g_build_filename (old_dir, mc_config_migrate_rules[rule_index].old_filename, NULL);
 321
 322         if (!g_file_test (old_name, G_FILE_TEST_EXISTS))
 323         {
 324             g_free (old_name);
 325             continue;
 326         }
 327
 328         new_name = g_build_filename (*mc_config_migrate_rules[rule_index].new_basedir,
 329                                      mc_config_migrate_rules[rule_index].new_filename, NULL);
 330
 331         mc_config_copy (old_name, new_name, error);
 332
 333         g_free (new_name);
 334         g_free (old_name);
 335     }
 336     /*
 337        {
 338        char *old_dir2;
 339        old_dir2 = g_strconcat (old_dir, "~", NULL);
 340        rename (old_dir, old_dir2);
 341        g_free (old_dir2);
 342        }
 343      */
 344     g_propagate_error (error,
 345                        g_error_new (MC_ERROR, 0,
 346                                     _
 347                                     ("Your old settings were migrated from %s\n"
 348                                      "to Freedesktop recommended dirs.\n"
 349                                      "To get more info, please visit\n"
 350                                      "http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html"),
 351                                     old_dir));
 352
 353     g_free (old_dir);
 354 }
 355
 356 /* --------------------------------------------------------------------------------------------- */
 357
 358 gboolean
 359 mc_config_deprecated_dir_present (void)
 360 {
 361     char *old_dir = mc_config_get_deprecated_path ();
 362     gboolean is_present = g_file_test (old_dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
 363     g_free (old_dir);
 364     return is_present && !config_dir_present;
 365 }
 366
 367 /* --------------------------------------------------------------------------------------------- */