lib/mcconfig/paths.c

   1 /*
   2    paths to configuration files
   3
   4    Copyright (C) 2010, 2011
   5    The Free Software Foundation, Inc.
   6
   7    Written by:
   8    Slava Zanko <slavazanko@gmail.com>, 2010.
   9
  10    This file is part of the Midnight Commander.
  11
  12    The Midnight Commander is free software: you can redistribute it
  13    and/or modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation, either version 3 of the License,
  15    or (at your option) any later version.
  16
  17    The Midnight Commander is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 #include <config.h>
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <errno.h>
  31
  32 #include "lib/global.h"
  33 #include "lib/fileloc.h"
  34 #include "lib/vfs/vfs.h"
  35 #include "lib/util.h"           /* unix_error_string() */
  36
  37 #include "lib/mcconfig.h"
  38
  39 /*** global variables ****************************************************************************/
  40
  41 /*** file scope macro definitions ****************************************************************/
  42
  43 #define MC_OLD_USERCONF_DIR ".mc"
  44
  45 /*** file scope type declarations ****************************************************************/
  46
  47 /*** file scope variables ************************************************************************/
  48
  49 static gboolean xdg_vars_initialized = FALSE;
  50 static char *mc_config_str = NULL;
  51 static char *mc_cache_str = NULL;
  52 static char *mc_data_str = NULL;
  53
  54 static const char *homedir = NULL;
  55 /* value of $MC_HOME */
  56 static const char *mc_home = NULL;
  57
  58 static gboolean config_dir_present = FALSE;
  59
  60 static const struct
  61 {
  62     const char *old_filename;
  63
  64     char **new_basedir;
  65     const char *new_filename;
  66 } mc_config_files_reference[] =
  67 {
  68     /* *INDENT-OFF* */
  69     /* config */
  70     { "ini",                                   &mc_config_str, MC_CONFIG_FILE},
  71     { "filehighlight.ini",                     &mc_config_str, MC_FHL_INI_FILE},
  72     { "hotlist",                               &mc_config_str, MC_HOTLIST_FILE},
  73     { "mc.keymap",                             &mc_config_str, GLOBAL_KEYMAP_FILE},
  74     { "menu",                                  &mc_config_str, MC_USERMENU_FILE},
  75     { "cedit" PATH_SEP_STR "Syntax",           &mc_config_str, EDIT_SYNTAX_FILE},
  76     { "cedit" PATH_SEP_STR "menu",             &mc_config_str, EDIT_HOME_MENU},
  77     { "cedit" PATH_SEP_STR "edit.indent.rc",   &mc_config_str, EDIT_DIR PATH_SEP_STR "edit.indent.rc"},
  78     { "cedit" PATH_SEP_STR "edit.spell.rc",    &mc_config_str, EDIT_DIR PATH_SEP_STR "edit.spell.rc"},
  79     { "panels.ini",                            &mc_config_str, MC_PANELS_FILE},
  80
  81     /* User should move this file with applying some changes in file */
  82     { "",                                      &mc_config_str, MC_FILEBIND_FILE},
  83
  84     /* data */
  85     { "skins",                                 &mc_data_str, MC_SKINS_SUBDIR},
  86     { "fish",                                  &mc_data_str, FISH_PREFIX},
  87     { "bashrc",                                &mc_data_str, "bashrc"},
  88     { "inputrc",                               &mc_data_str, "inputrc"},
  89     { "extfs.d",                               &mc_data_str, MC_EXTFS_DIR},
  90     { "history",                               &mc_data_str, MC_HISTORY_FILE},
  91     { "filepos",                               &mc_data_str, MC_FILEPOS_FILE},
  92     { "cedit" PATH_SEP_STR "cooledit.clip",    &mc_data_str, EDIT_CLIP_FILE},
  93     { "",                                      &mc_data_str, MC_MACRO_FILE},
  94
  95     /* cache */
  96     { "log",                                   &mc_cache_str, "mc.log"},
  97     { "Tree",                                  &mc_cache_str, MC_TREESTORE_FILE},
  98     { "cedit" PATH_SEP_STR "cooledit.temp",    &mc_cache_str, EDIT_TEMP_FILE},
  99     { "cedit" PATH_SEP_STR "cooledit.block",   &mc_cache_str, EDIT_BLOCK_FILE},
 100
 101     {NULL, NULL, NULL}
 102     /* *INDENT-ON* */
 103 };
 104
 105 #ifdef MC_HOMEDIR_XDG
 106 static const struct
 107 {
 108     char **old_basedir;
 109     const char *filename;
 110
 111     char **new_basedir;
 112 } mc_config_migrate_rules_fix[] =
 113 {
 114     /* *INDENT-OFF* */
 115     { &mc_data_str, MC_USERMENU_FILE,                       &mc_config_str},
 116     { &mc_data_str, EDIT_SYNTAX_FILE,                       &mc_config_str},
 117     { &mc_data_str, EDIT_HOME_MENU,                         &mc_config_str},
 118     { &mc_data_str, EDIT_DIR PATH_SEP_STR "edit.indent.rc", &mc_config_str},
 119     { &mc_data_str, EDIT_DIR PATH_SEP_STR "edit.spell.rc",  &mc_config_str},
 120     { &mc_data_str, MC_FILEBIND_FILE,                       &mc_config_str},
 121
 122     { &mc_cache_str, MC_HISTORY_FILE,                       &mc_data_str},
 123     { &mc_cache_str, MC_FILEPOS_FILE,                       &mc_data_str},
 124     { &mc_cache_str, EDIT_CLIP_FILE,                        &mc_data_str},
 125
 126     { &mc_cache_str, MC_PANELS_FILE,                        &mc_config_str},
 127
 128     {NULL, NULL, NULL}
 129     /* *INDENT-ON* */
 130 };
 131 #endif /* MC_HOMEDIR_XDG */
 132
 133 /*** file scope functions *********************************************************************** */
 134 /* --------------------------------------------------------------------------------------------- */
 135
 136 static void
 137 mc_config_mkdir (const char *directory_name, GError ** error)
 138 {
 139     if ((!g_file_test (directory_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) &&
 140         (g_mkdir_with_parents (directory_name, 0700) != 0))
 141     {
 142         g_propagate_error (error,
 143                            g_error_new (MC_ERROR, 0, _("Cannot create %s directory"),
 144                                         directory_name));
 145     }
 146 }
 147
 148 /* --------------------------------------------------------------------------------------------- */
 149
 150 static char *
 151 mc_config_init_one_config_path (const char *path_base, const char *subdir, GError ** error)
 152 {
 153     char *full_path;
 154
 155     full_path = g_build_filename (path_base, subdir, NULL);
 156
 157     if (g_file_test (full_path, G_FILE_TEST_EXISTS))
 158     {
 159         if (g_file_test (full_path, G_FILE_TEST_IS_DIR))
 160         {
 161             config_dir_present = TRUE;
 162         }
 163         else
 164         {
 165             fprintf (stderr, "%s %s\n", _("FATAL: not a directory:"), full_path);
 166             exit (EXIT_FAILURE);
 167         }
 168     }
 169
 170     mc_config_mkdir (full_path, error);
 171     if (error != NULL && *error != NULL)
 172     {
 173         g_free (full_path);
 174         full_path = NULL;
 175     }
 176     return full_path;
 177 }
 178
 179 /* --------------------------------------------------------------------------------------------- */
 180
 181 static char *
 182 mc_config_get_deprecated_path (void)
 183 {
 184     return g_build_filename (mc_config_get_home_dir (), MC_OLD_USERCONF_DIR, NULL);
 185 }
 186
 187 /* --------------------------------------------------------------------------------------------- */
 188
 189 static void
 190 mc_config_copy (const char *old_name, const char *new_name, GError ** error)
 191 {
 192     if (g_file_test (old_name, G_FILE_TEST_IS_REGULAR))
 193     {
 194         char *contents = NULL;
 195         size_t length;
 196
 197         if (g_file_get_contents (old_name, &contents, &length, error))
 198             g_file_set_contents (new_name, contents, length, error);
 199
 200         g_free (contents);
 201         return;
 202     }
 203
 204     if (g_file_test (old_name, G_FILE_TEST_IS_DIR))
 205     {
 206
 207         GDir *dir;
 208         const char *dir_name;
 209
 210         dir = g_dir_open (old_name, 0, error);
 211         if (dir == NULL)
 212             return;
 213
 214         if (g_mkdir_with_parents (new_name, 0700) == -1)
 215         {
 216             g_dir_close (dir);
 217             g_propagate_error (error,
 218                                g_error_new (MC_ERROR, 0,
 219                                             _
 220                                             ("An error occured while migrating user settings: %s"),
 221                                             unix_error_string (errno)));
 222             return;
 223         }
 224
 225         while ((dir_name = g_dir_read_name (dir)) != NULL)
 226         {
 227             char *old_name2, *new_name2;
 228
 229             old_name2 = g_build_filename (old_name, dir_name, NULL);
 230             new_name2 = g_build_filename (new_name, dir_name, NULL);
 231             mc_config_copy (old_name2, new_name2, error);
 232             g_free (new_name2);
 233             g_free (old_name2);
 234         }
 235     }
 236 }
 237
 238 /* --------------------------------------------------------------------------------------------- */
 239
 240 #if MC_HOMEDIR_XDG
 241 static void
 242 mc_config_fix_migrated_rules (void)
 243 {
 244     size_t rule_index;
 245
 246     for (rule_index = 0; mc_config_migrate_rules_fix[rule_index].old_basedir != NULL; rule_index++)
 247     {
 248         char *old_name;
 249
 250         old_name =
 251             g_build_filename (*mc_config_migrate_rules_fix[rule_index].old_basedir,
 252                               mc_config_migrate_rules_fix[rule_index].filename, NULL);
 253
 254         if (g_file_test (old_name, G_FILE_TEST_EXISTS))
 255         {
 256             char *new_name;
 257             const char *basedir = *mc_config_migrate_rules_fix[rule_index].new_basedir;
 258             const char *filename = mc_config_migrate_rules_fix[rule_index].filename;
 259
 260             new_name = g_build_filename (basedir, filename, NULL);
 261             rename (old_name, new_name);
 262             g_free (new_name);
 263         }
 264         g_free (old_name);
 265     }
 266 }
 267 #endif /* MC_HOMEDIR_XDG */
 268
 269 /* --------------------------------------------------------------------------------------------- */
 270
 271 static gboolean
 272 mc_config_deprecated_dir_present (void)
 273 {
 274     char *old_dir;
 275     gboolean is_present;
 276
 277     old_dir = mc_config_get_deprecated_path ();
 278     is_present = g_file_test (old_dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
 279     g_free (old_dir);
 280
 281     return is_present && !config_dir_present;
 282 }
 283
 284 /* --------------------------------------------------------------------------------------------- */
 285 /*** public functions ****************************************************************************/
 286 /* --------------------------------------------------------------------------------------------- */
 287
 288 void
 289 mc_config_init_config_paths (GError ** error)
 290 {
 291     char *dir;
 292
 293     if (xdg_vars_initialized)
 294         return;
 295
 296     /* init mc_home and homedir if not yet */
 297     (void) mc_config_get_home_dir ();
 298
 299 #ifdef MC_HOMEDIR_XDG
 300     if (mc_home != NULL)
 301     {
 302         dir = g_build_filename (mc_home, ".config", (char *) NULL);
 303         mc_config_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 304         g_free (dir);
 305
 306         dir = g_build_filename (mc_home, ".cache", (char *) NULL);
 307         mc_cache_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 308         g_free (dir);
 309
 310         dir = g_build_filename (mc_home, ".local", "share", (char *) NULL);
 311         mc_data_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 312         g_free (dir);
 313     }
 314     else
 315     {
 316         dir = (char *) g_get_user_config_dir ();
 317         if (dir != NULL && *dir != '\0')
 318             mc_config_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 319         else
 320         {
 321             dir = g_build_filename (homedir, ".config", (char *) NULL);
 322             mc_config_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 323             g_free (dir);
 324         }
 325
 326         dir = (char *) g_get_user_cache_dir ();
 327         if (dir != NULL && *dir != '\0')
 328             mc_cache_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 329         else
 330         {
 331             dir = g_build_filename (homedir, ".cache", (char *) NULL);
 332             mc_cache_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 333             g_free (dir);
 334         }
 335
 336         dir = (char *) g_get_user_data_dir ();
 337         if (dir != NULL && *dir != '\0')
 338             mc_data_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 339         else
 340         {
 341             dir = g_build_filename (homedir, ".local", "share", (char *) NULL);
 342             mc_data_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, error);
 343             g_free (dir);
 344         }
 345     }
 346
 347     mc_config_fix_migrated_rules ();
 348 #else /* MC_HOMEDIR_XDG */
 349     char *defined_userconf_dir;
 350
 351     defined_userconf_dir = tilde_expand (MC_USERCONF_DIR);
 352     if (g_path_is_absolute (defined_userconf_dir))
 353         dir = defined_userconf_dir;
 354     else
 355     {
 356         g_free (defined_userconf_dir);
 357         dir = g_build_filename (mc_config_get_home_dir (), MC_USERCONF_DIR, (char *) NULL);
 358     }
 359
 360     mc_data_str = mc_cache_str = mc_config_str = mc_config_init_one_config_path (dir, "", error);
 361
 362     g_free (dir);
 363 #endif /* MC_HOMEDIR_XDG */
 364
 365     xdg_vars_initialized = TRUE;
 366 }
 367
 368 /* --------------------------------------------------------------------------------------------- */
 369
 370 void
 371 mc_config_deinit_config_paths (void)
 372 {
 373     if (!xdg_vars_initialized)
 374         return;
 375
 376     g_free (mc_config_str);
 377 #ifdef MC_HOMEDIR_XDG
 378     g_free (mc_cache_str);
 379     g_free (mc_data_str);
 380 #endif /* MC_HOMEDIR_XDG */
 381
 382     g_free (mc_global.share_data_dir);
 383     g_free (mc_global.sysconfig_dir);
 384
 385     xdg_vars_initialized = FALSE;
 386 }
 387
 388 /* --------------------------------------------------------------------------------------------- */
 389
 390 const char *
 391 mc_config_get_data_path (void)
 392 {
 393     if (!xdg_vars_initialized)
 394         mc_config_init_config_paths (NULL);
 395
 396     return (const char *) mc_data_str;
 397 }
 398
 399 /* --------------------------------------------------------------------------------------------- */
 400
 401 const char *
 402 mc_config_get_cache_path (void)
 403 {
 404     if (!xdg_vars_initialized)
 405         mc_config_init_config_paths (NULL);
 406
 407     return (const char *) mc_cache_str;
 408 }
 409
 410 /* --------------------------------------------------------------------------------------------- */
 411
 412 const char *
 413 mc_config_get_home_dir (void)
 414 {
 415     if (homedir == NULL)
 416     {
 417         homedir = g_getenv ("MC_HOME");
 418         if (homedir == NULL || *homedir == '\0')
 419             homedir = g_getenv ("HOME");
 420         else
 421             mc_home = homedir;
 422         if (homedir == NULL || *homedir == '\0')
 423             homedir = g_get_home_dir ();
 424     }
 425     return homedir;
 426 }
 427
 428 /* --------------------------------------------------------------------------------------------- */
 429
 430 const char *
 431 mc_config_get_path (void)
 432 {
 433     if (!xdg_vars_initialized)
 434         mc_config_init_config_paths (NULL);
 435
 436     return (const char *) mc_config_str;
 437 }
 438
 439 /* --------------------------------------------------------------------------------------------- */
 440
 441 gboolean
 442 mc_config_migrate_from_old_place (GError ** error, char **msg)
 443 {
 444     char *old_dir;
 445     size_t rule_index;
 446
 447     if (!mc_config_deprecated_dir_present ())
 448         return FALSE;
 449
 450     old_dir = mc_config_get_deprecated_path ();
 451
 452     g_free (mc_config_init_one_config_path (mc_config_str, EDIT_DIR, error));
 453 #ifdef MC_HOMEDIR_XDG
 454     g_free (mc_config_init_one_config_path (mc_cache_str, EDIT_DIR, error));
 455     g_free (mc_config_init_one_config_path (mc_data_str, EDIT_DIR, error));
 456 #endif /* MC_HOMEDIR_XDG */
 457
 458     if (*error != NULL)
 459         return FALSE;
 460
 461     for (rule_index = 0; mc_config_files_reference[rule_index].old_filename != NULL; rule_index++)
 462     {
 463         char *old_name;
 464         if (*mc_config_files_reference[rule_index].old_filename == '\0')
 465             continue;
 466
 467         old_name =
 468             g_build_filename (old_dir, mc_config_files_reference[rule_index].old_filename, NULL);
 469
 470         if (g_file_test (old_name, G_FILE_TEST_EXISTS))
 471         {
 472             char *new_name;
 473             const char *basedir = *mc_config_files_reference[rule_index].new_basedir;
 474             const char *filename = mc_config_files_reference[rule_index].new_filename;
 475
 476             new_name = g_build_filename (basedir, filename, NULL);
 477             mc_config_copy (old_name, new_name, error);
 478             g_free (new_name);
 479         }
 480         g_free (old_name);
 481     }
 482
 483 #ifdef MC_HOMEDIR_XDG
 484     *msg = g_strdup_printf (_("Your old settings were migrated from %s\n"
 485                               "to Freedesktop recommended dirs.\n"
 486                               "To get more info, please visit\n"
 487                               "http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html"),
 488                             old_dir);
 489 #else /* MC_HOMEDIR_XDG */
 490     *msg = g_strdup_printf (_("Your old settings were migrated from %s\n"
 491                               "to %s\n"), old_dir, mc_config_str);
 492 #endif /* MC_HOMEDIR_XDG */
 493
 494     g_free (old_dir);
 495
 496     return TRUE;
 497 }
 498
 499 /* --------------------------------------------------------------------------------------------- */
 500 /**
 501  * Get full path to config file by short name.
 502  *
 503  * @param config_name short name
 504  * @return full path to config file
 505  */
 506
 507 char *
 508 mc_config_get_full_path (const char *config_name)
 509 {
 510     size_t rule_index;
 511
 512     if (config_name == NULL)
 513         return NULL;
 514
 515     if (!xdg_vars_initialized)
 516         mc_config_init_config_paths (NULL);
 517
 518     for (rule_index = 0; mc_config_files_reference[rule_index].old_filename != NULL; rule_index++)
 519     {
 520         if (strcmp (config_name, mc_config_files_reference[rule_index].new_filename) == 0)
 521         {
 522             return g_build_filename (*mc_config_files_reference[rule_index].new_basedir,
 523                                      mc_config_files_reference[rule_index].new_filename, NULL);
 524         }
 525     }
 526     return NULL;
 527 }
 528
 529 /* --------------------------------------------------------------------------------------------- */
 530 /**
 531  * Get full path to config file by short name.
 532  *
 533  * @param config_name short name
 534  * @return object with full path to config file
 535  */
 536
 537 vfs_path_t *
 538 mc_config_get_full_vpath (const char *config_name)
 539 {
 540     vfs_path_t *ret_vpath;
 541     char *str_path;
 542
 543     str_path = mc_config_get_full_path (config_name);
 544
 545     ret_vpath = vfs_path_from_str (str_path);
 546     g_free (str_path);
 547     return ret_vpath;
 548 }
 549
 550 /* --------------------------------------------------------------------------------------------- */