lib/mcconfig/paths.c

   1 /*
   2    paths to configuration files
   3
   4    Copyright (C) 2010-2017
   5    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 gboolean config_dir_present = FALSE;
  55
  56 static const struct
  57 {
  58     const char *old_filename;
  59
  60     char **new_basedir;
  61     const char *new_filename;
  62 } mc_config_files_reference[] =
  63 {
  64     /* *INDENT-OFF* */
  65     /* config */
  66     { "ini",                                   &mc_config_str, MC_CONFIG_FILE},
  67     { "filehighlight.ini",                     &mc_config_str, MC_FHL_INI_FILE},
  68     { "mc.keymap",                             &mc_config_str, GLOBAL_KEYMAP_FILE},
  69     { "menu",                                  &mc_config_str, MC_USERMENU_FILE},
  70     { "cedit" PATH_SEP_STR "Syntax",           &mc_config_str, EDIT_SYNTAX_FILE},
  71     { "cedit" PATH_SEP_STR "menu",             &mc_config_str, EDIT_HOME_MENU},
  72     { "cedit" PATH_SEP_STR "edit.indent.rc",   &mc_config_str, EDIT_DIR PATH_SEP_STR "edit.indent.rc"},
  73     { "cedit" PATH_SEP_STR "edit.spell.rc",    &mc_config_str, EDIT_DIR PATH_SEP_STR "edit.spell.rc"},
  74     { "panels.ini",                            &mc_config_str, MC_PANELS_FILE},
  75
  76     /* User should move this file with applying some changes in file */
  77     { "",                                      &mc_config_str, MC_FILEBIND_FILE},
  78
  79     /* data */
  80     { "skins",                                 &mc_data_str, MC_SKINS_SUBDIR},
  81     { "fish",                                  &mc_data_str, FISH_PREFIX},
  82     { "ashrc",                                 &mc_data_str, "ashrc"},
  83     { "bashrc",                                &mc_data_str, "bashrc"},
  84     { "inputrc",                               &mc_data_str, "inputrc"},
  85     { "extfs.d",                               &mc_data_str, MC_EXTFS_DIR},
  86     { "history",                               &mc_data_str, MC_HISTORY_FILE},
  87     { "filepos",                               &mc_data_str, MC_FILEPOS_FILE},
  88     { "hotlist",                               &mc_data_str, MC_HOTLIST_FILE},
  89     { "cedit" PATH_SEP_STR "cooledit.clip",    &mc_data_str, EDIT_CLIP_FILE},
  90     { "",                                      &mc_data_str, MC_MACRO_FILE},
  91
  92     /* cache */
  93     { "log",                                   &mc_cache_str, "mc.log"},
  94     { "Tree",                                  &mc_cache_str, MC_TREESTORE_FILE},
  95     { "cedit" PATH_SEP_STR "cooledit.temp",    &mc_cache_str, EDIT_TEMP_FILE},
  96     { "cedit" PATH_SEP_STR "cooledit.block",   &mc_cache_str, EDIT_BLOCK_FILE},
  97
  98     {NULL, NULL, NULL}
  99     /* *INDENT-ON* */
 100 };
 101
 102 #if MC_HOMEDIR_XDG
 103 static const struct
 104 {
 105     char **old_basedir;
 106     const char *filename;
 107
 108     char **new_basedir;
 109 } mc_config_migrate_rules_fix[] =
 110 {
 111     /* *INDENT-OFF* */
 112     { &mc_config_str, MC_HOTLIST_FILE,                      &mc_data_str},
 113
 114     { &mc_data_str, MC_USERMENU_FILE,                       &mc_config_str},
 115     { &mc_data_str, EDIT_SYNTAX_FILE,                       &mc_config_str},
 116     { &mc_data_str, EDIT_HOME_MENU,                         &mc_config_str},
 117     { &mc_data_str, EDIT_DIR PATH_SEP_STR "edit.indent.rc", &mc_config_str},
 118     { &mc_data_str, EDIT_DIR PATH_SEP_STR "edit.spell.rc",  &mc_config_str},
 119     { &mc_data_str, MC_FILEBIND_FILE,                       &mc_config_str},
 120
 121     { &mc_cache_str, MC_HISTORY_FILE,                       &mc_data_str},
 122     { &mc_cache_str, MC_FILEPOS_FILE,                       &mc_data_str},
 123     { &mc_cache_str, EDIT_CLIP_FILE,                        &mc_data_str},
 124
 125     { &mc_cache_str, MC_PANELS_FILE,                        &mc_config_str},
 126
 127     {NULL, NULL, NULL}
 128     /* *INDENT-ON* */
 129 };
 130 #endif /* MC_HOMEDIR_XDG */
 131
 132 /*** file scope functions *********************************************************************** */
 133 /* --------------------------------------------------------------------------------------------- */
 134
 135 static void
 136 mc_config_mkdir (const char *directory_name, GError ** mcerror)
 137 {
 138     mc_return_if_error (mcerror);
 139
 140     if ((!g_file_test (directory_name, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) &&
 141         (g_mkdir_with_parents (directory_name, 0700) != 0))
 142         mc_propagate_error (mcerror, 0, _("Cannot create %s directory"), directory_name);
 143 }
 144
 145 /* --------------------------------------------------------------------------------------------- */
 146
 147 static char *
 148 mc_config_init_one_config_path (const char *path_base, const char *subdir, GError ** mcerror)
 149 {
 150     char *full_path;
 151
 152     mc_return_val_if_error (mcerror, FALSE);
 153
 154     full_path = g_build_filename (path_base, subdir, (char *) NULL);
 155     if (g_file_test (full_path, G_FILE_TEST_EXISTS))
 156     {
 157         if (g_file_test (full_path, G_FILE_TEST_IS_DIR))
 158         {
 159             config_dir_present = TRUE;
 160         }
 161         else
 162         {
 163             fprintf (stderr, "%s %s\n", _("FATAL: not a directory:"), full_path);
 164             exit (EXIT_FAILURE);
 165         }
 166     }
 167
 168     mc_config_mkdir (full_path, mcerror);
 169     if (mcerror != NULL && *mcerror != NULL)
 170         MC_PTR_FREE (full_path);
 171
 172     return full_path;
 173 }
 174
 175 /* --------------------------------------------------------------------------------------------- */
 176
 177 static char *
 178 mc_config_get_deprecated_path (void)
 179 {
 180     return g_build_filename (mc_config_get_home_dir (), MC_OLD_USERCONF_DIR, (char *) NULL);
 181 }
 182
 183 /* --------------------------------------------------------------------------------------------- */
 184
 185 static void
 186 mc_config_copy (const char *old_name, const char *new_name, GError ** mcerror)
 187 {
 188     mc_return_if_error (mcerror);
 189
 190     if (g_file_test (old_name, G_FILE_TEST_IS_REGULAR))
 191     {
 192         char *contents = NULL;
 193         size_t length;
 194
 195         if (g_file_get_contents (old_name, &contents, &length, mcerror))
 196             g_file_set_contents (new_name, contents, length, mcerror);
 197
 198         g_free (contents);
 199         return;
 200     }
 201
 202     if (g_file_test (old_name, G_FILE_TEST_IS_DIR))
 203     {
 204
 205         GDir *dir;
 206         const char *dir_name;
 207
 208         dir = g_dir_open (old_name, 0, mcerror);
 209         if (dir == NULL)
 210             return;
 211
 212         if (g_mkdir_with_parents (new_name, 0700) == -1)
 213         {
 214             g_dir_close (dir);
 215             mc_propagate_error (mcerror, 0,
 216                                 _("An error occurred while migrating user settings: %s"),
 217                                 unix_error_string (errno));
 218             return;
 219         }
 220
 221         while ((dir_name = g_dir_read_name (dir)) != NULL)
 222         {
 223             char *old_name2, *new_name2;
 224
 225             old_name2 = g_build_filename (old_name, dir_name, (char *) NULL);
 226             new_name2 = g_build_filename (new_name, dir_name, (char *) NULL);
 227             mc_config_copy (old_name2, new_name2, mcerror);
 228             g_free (new_name2);
 229             g_free (old_name2);
 230         }
 231     }
 232 }
 233
 234 /* --------------------------------------------------------------------------------------------- */
 235
 236 #if MC_HOMEDIR_XDG
 237 static void
 238 mc_config_fix_migrated_rules (void)
 239 {
 240     size_t rule_index;
 241
 242     for (rule_index = 0; mc_config_migrate_rules_fix[rule_index].old_basedir != NULL; rule_index++)
 243     {
 244         char *old_name;
 245
 246         old_name =
 247             g_build_filename (*mc_config_migrate_rules_fix[rule_index].old_basedir,
 248                               mc_config_migrate_rules_fix[rule_index].filename, (char *) NULL);
 249
 250         if (g_file_test (old_name, G_FILE_TEST_EXISTS))
 251         {
 252             char *new_name;
 253             const char *basedir = *mc_config_migrate_rules_fix[rule_index].new_basedir;
 254             const char *filename = mc_config_migrate_rules_fix[rule_index].filename;
 255
 256             new_name = g_build_filename (basedir, filename, (char *) NULL);
 257             rename (old_name, new_name);
 258             g_free (new_name);
 259         }
 260         g_free (old_name);
 261     }
 262 }
 263 #endif /* MC_HOMEDIR_XDG */
 264
 265 /* --------------------------------------------------------------------------------------------- */
 266
 267 static gboolean
 268 mc_config_deprecated_dir_present (void)
 269 {
 270     char *old_dir;
 271     gboolean is_present;
 272
 273     old_dir = mc_config_get_deprecated_path ();
 274     is_present = g_file_test (old_dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
 275     g_free (old_dir);
 276
 277     return is_present && !config_dir_present;
 278 }
 279
 280 /* --------------------------------------------------------------------------------------------- */
 281 /*** public functions ****************************************************************************/
 282 /* --------------------------------------------------------------------------------------------- */
 283
 284 void
 285 mc_config_init_config_paths (GError ** mcerror)
 286 {
 287     const char *profile_root;
 288     char *dir;
 289 #if MC_HOMEDIR_XDG == 0
 290     char *defined_userconf_dir;
 291 #endif
 292
 293     mc_return_if_error (mcerror);
 294
 295     if (xdg_vars_initialized)
 296         return;
 297
 298     profile_root = mc_get_profile_root ();
 299
 300 #if MC_HOMEDIR_XDG
 301     if (strcmp (profile_root, mc_config_get_home_dir ()) != 0)
 302     {
 303         /*
 304          * The user overrode the default profile root.
 305          *
 306          * In this case we can't use GLib's g_get_user_{config,cache,data}_dir()
 307          * as these functions use the user's home dir as the root.
 308          */
 309
 310         dir = g_build_filename (profile_root, ".config", (char *) NULL);
 311         mc_config_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, mcerror);
 312         g_free (dir);
 313
 314         dir = g_build_filename (profile_root, ".cache", (char *) NULL);
 315         mc_cache_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, mcerror);
 316         g_free (dir);
 317
 318         dir = g_build_filename (profile_root, ".local", "share", (char *) NULL);
 319         mc_data_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, mcerror);
 320         g_free (dir);
 321     }
 322     else
 323     {
 324         mc_config_str =
 325             mc_config_init_one_config_path (g_get_user_config_dir (), MC_USERCONF_DIR, mcerror);
 326         mc_cache_str =
 327             mc_config_init_one_config_path (g_get_user_cache_dir (), MC_USERCONF_DIR, mcerror);
 328         mc_data_str =
 329             mc_config_init_one_config_path (g_get_user_data_dir (), MC_USERCONF_DIR, mcerror);
 330     }
 331
 332     mc_config_fix_migrated_rules ();
 333 #else /* MC_HOMEDIR_XDG */
 334     defined_userconf_dir = tilde_expand (MC_USERCONF_DIR);
 335     if (g_path_is_absolute (defined_userconf_dir))
 336         dir = defined_userconf_dir;
 337     else
 338     {
 339         g_free (defined_userconf_dir);
 340         dir = g_build_filename (profile_root, MC_USERCONF_DIR, (char *) NULL);
 341     }
 342
 343     mc_data_str = mc_cache_str = mc_config_str = mc_config_init_one_config_path (dir, "", mcerror);
 344
 345     g_free (dir);
 346 #endif /* MC_HOMEDIR_XDG */
 347
 348     xdg_vars_initialized = TRUE;
 349 }
 350
 351 /* --------------------------------------------------------------------------------------------- */
 352
 353 void
 354 mc_config_deinit_config_paths (void)
 355 {
 356     if (!xdg_vars_initialized)
 357         return;
 358
 359     g_free (mc_config_str);
 360 #if MC_HOMEDIR_XDG
 361     g_free (mc_cache_str);
 362     g_free (mc_data_str);
 363 #endif /* MC_HOMEDIR_XDG */
 364
 365     g_free (mc_global.share_data_dir);
 366     g_free (mc_global.sysconfig_dir);
 367
 368     xdg_vars_initialized = FALSE;
 369 }
 370
 371 /* --------------------------------------------------------------------------------------------- */
 372
 373 const char *
 374 mc_config_get_data_path (void)
 375 {
 376     if (!xdg_vars_initialized)
 377         mc_config_init_config_paths (NULL);
 378
 379     return (const char *) mc_data_str;
 380 }
 381
 382 /* --------------------------------------------------------------------------------------------- */
 383
 384 const char *
 385 mc_config_get_cache_path (void)
 386 {
 387     if (!xdg_vars_initialized)
 388         mc_config_init_config_paths (NULL);
 389
 390     return (const char *) mc_cache_str;
 391 }
 392
 393 /* --------------------------------------------------------------------------------------------- */
 394
 395 const char *
 396 mc_config_get_home_dir (void)
 397 {
 398     static const char *homedir = NULL;
 399
 400     if (homedir == NULL)
 401     {
 402         /* Prior to GLib 2.36, g_get_home_dir() ignores $HOME, which is why
 403          * we read it ourselves. As that function's documentation explains,
 404          * using $HOME is good for compatibility with other programs and
 405          * for running from test frameworks. */
 406         homedir = g_getenv ("HOME");
 407         if (homedir == NULL || *homedir == '\0')
 408             homedir = g_get_home_dir ();
 409     }
 410     return homedir;
 411 }
 412
 413 /* --------------------------------------------------------------------------------------------- */
 414
 415 const char *
 416 mc_config_get_path (void)
 417 {
 418     if (!xdg_vars_initialized)
 419         mc_config_init_config_paths (NULL);
 420
 421     return (const char *) mc_config_str;
 422 }
 423
 424 /* --------------------------------------------------------------------------------------------- */
 425
 426 gboolean
 427 mc_config_migrate_from_old_place (GError ** mcerror, char **msg)
 428 {
 429     char *old_dir;
 430     size_t rule_index;
 431
 432     mc_return_val_if_error (mcerror, FALSE);
 433
 434     if (!mc_config_deprecated_dir_present ())
 435         return FALSE;
 436
 437     old_dir = mc_config_get_deprecated_path ();
 438
 439     g_free (mc_config_init_one_config_path (mc_config_str, EDIT_DIR, mcerror));
 440 #if MC_HOMEDIR_XDG
 441     g_free (mc_config_init_one_config_path (mc_cache_str, EDIT_DIR, mcerror));
 442     g_free (mc_config_init_one_config_path (mc_data_str, EDIT_DIR, mcerror));
 443 #endif /* MC_HOMEDIR_XDG */
 444
 445     mc_return_val_if_error (mcerror, FALSE);
 446
 447     for (rule_index = 0; mc_config_files_reference[rule_index].old_filename != NULL; rule_index++)
 448     {
 449         char *old_name;
 450         if (*mc_config_files_reference[rule_index].old_filename == '\0')
 451             continue;
 452
 453         old_name =
 454             g_build_filename (old_dir, mc_config_files_reference[rule_index].old_filename,
 455                               (char *) NULL);
 456
 457         if (g_file_test (old_name, G_FILE_TEST_EXISTS))
 458         {
 459             char *new_name;
 460             const char *basedir = *mc_config_files_reference[rule_index].new_basedir;
 461             const char *filename = mc_config_files_reference[rule_index].new_filename;
 462
 463             new_name = g_build_filename (basedir, filename, (char *) NULL);
 464             mc_config_copy (old_name, new_name, mcerror);
 465             g_free (new_name);
 466         }
 467         g_free (old_name);
 468     }
 469
 470 #if MC_HOMEDIR_XDG
 471     *msg = g_strdup_printf (_("Your old settings were migrated from %s\n"
 472                               "to Freedesktop recommended dirs.\n"
 473                               "To get more info, please visit\n"
 474                               "http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html"),
 475                             old_dir);
 476 #else /* MC_HOMEDIR_XDG */
 477     *msg = g_strdup_printf (_("Your old settings were migrated from %s\n"
 478                               "to %s\n"), old_dir, mc_config_str);
 479 #endif /* MC_HOMEDIR_XDG */
 480
 481     g_free (old_dir);
 482
 483     return TRUE;
 484 }
 485
 486 /* --------------------------------------------------------------------------------------------- */
 487 /**
 488  * Get full path to config file by short name.
 489  *
 490  * @param config_name short name
 491  * @return full path to config file
 492  */
 493
 494 char *
 495 mc_config_get_full_path (const char *config_name)
 496 {
 497     size_t rule_index;
 498
 499     if (config_name == NULL)
 500         return NULL;
 501
 502     if (!xdg_vars_initialized)
 503         mc_config_init_config_paths (NULL);
 504
 505     for (rule_index = 0; mc_config_files_reference[rule_index].old_filename != NULL; rule_index++)
 506     {
 507         if (strcmp (config_name, mc_config_files_reference[rule_index].new_filename) == 0)
 508         {
 509             return g_build_filename (*mc_config_files_reference[rule_index].new_basedir,
 510                                      mc_config_files_reference[rule_index].new_filename,
 511                                      (char *) NULL);
 512         }
 513     }
 514     return NULL;
 515 }
 516
 517 /* --------------------------------------------------------------------------------------------- */
 518 /**
 519  * Get full path to config file by short name.
 520  *
 521  * @param config_name short name
 522  * @return object with full path to config file
 523  */
 524
 525 vfs_path_t *
 526 mc_config_get_full_vpath (const char *config_name)
 527 {
 528     vfs_path_t *ret_vpath;
 529     char *str_path;
 530
 531     str_path = mc_config_get_full_path (config_name);
 532
 533     ret_vpath = vfs_path_from_str (str_path);
 534     g_free (str_path);
 535     return ret_vpath;
 536 }
 537
 538 /* --------------------------------------------------------------------------------------------- */