2 paths to configuration files
4 Copyright (C) 2010-2016
5 Free Software Foundation, Inc.
8 Slava Zanko <slavazanko@gmail.com>, 2010.
10 This file is part of the Midnight Commander.
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.
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.
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/>.
32 #include "lib/global.h"
33 #include "lib/fileloc.h"
34 #include "lib/vfs/vfs.h"
35 #include "lib/util.h" /* unix_error_string() */
37 #include "lib/mcconfig.h"
39 /*** global variables ****************************************************************************/
41 /*** file scope macro definitions ****************************************************************/
43 #define MC_OLD_USERCONF_DIR ".mc"
45 /*** file scope type declarations ****************************************************************/
47 /*** file scope variables ************************************************************************/
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
;
54 static gboolean config_dir_present
= FALSE
;
58 const char *old_filename
;
61 const char *new_filename
;
62 } mc_config_files_reference
[] =
66 { "ini", &mc_config_str
, MC_CONFIG_FILE
},
67 { "filehighlight.ini", &mc_config_str
, MC_FHL_INI_FILE
},
68 { "hotlist", &mc_config_str
, MC_HOTLIST_FILE
},
69 { "mc.keymap", &mc_config_str
, GLOBAL_KEYMAP_FILE
},
70 { "menu", &mc_config_str
, MC_USERMENU_FILE
},
71 { "cedit" PATH_SEP_STR
"Syntax", &mc_config_str
, EDIT_SYNTAX_FILE
},
72 { "cedit" PATH_SEP_STR
"menu", &mc_config_str
, EDIT_HOME_MENU
},
73 { "cedit" PATH_SEP_STR
"edit.indent.rc", &mc_config_str
, EDIT_DIR PATH_SEP_STR
"edit.indent.rc"},
74 { "cedit" PATH_SEP_STR
"edit.spell.rc", &mc_config_str
, EDIT_DIR PATH_SEP_STR
"edit.spell.rc"},
75 { "panels.ini", &mc_config_str
, MC_PANELS_FILE
},
77 /* User should move this file with applying some changes in file */
78 { "", &mc_config_str
, MC_FILEBIND_FILE
},
81 { "skins", &mc_data_str
, MC_SKINS_SUBDIR
},
82 { "fish", &mc_data_str
, FISH_PREFIX
},
83 { "ashrc", &mc_data_str
, "ashrc"},
84 { "bashrc", &mc_data_str
, "bashrc"},
85 { "inputrc", &mc_data_str
, "inputrc"},
86 { "extfs.d", &mc_data_str
, MC_EXTFS_DIR
},
87 { "history", &mc_data_str
, MC_HISTORY_FILE
},
88 { "filepos", &mc_data_str
, MC_FILEPOS_FILE
},
89 { "cedit" PATH_SEP_STR
"cooledit.clip", &mc_data_str
, EDIT_CLIP_FILE
},
90 { "", &mc_data_str
, MC_MACRO_FILE
},
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
},
106 const char *filename
;
109 } mc_config_migrate_rules_fix
[] =
112 { &mc_data_str
, MC_USERMENU_FILE
, &mc_config_str
},
113 { &mc_data_str
, EDIT_SYNTAX_FILE
, &mc_config_str
},
114 { &mc_data_str
, EDIT_HOME_MENU
, &mc_config_str
},
115 { &mc_data_str
, EDIT_DIR PATH_SEP_STR
"edit.indent.rc", &mc_config_str
},
116 { &mc_data_str
, EDIT_DIR PATH_SEP_STR
"edit.spell.rc", &mc_config_str
},
117 { &mc_data_str
, MC_FILEBIND_FILE
, &mc_config_str
},
119 { &mc_cache_str
, MC_HISTORY_FILE
, &mc_data_str
},
120 { &mc_cache_str
, MC_FILEPOS_FILE
, &mc_data_str
},
121 { &mc_cache_str
, EDIT_CLIP_FILE
, &mc_data_str
},
123 { &mc_cache_str
, MC_PANELS_FILE
, &mc_config_str
},
128 #endif /* MC_HOMEDIR_XDG */
130 /*** file scope functions *********************************************************************** */
131 /* --------------------------------------------------------------------------------------------- */
134 mc_config_mkdir (const char *directory_name
, GError
** mcerror
)
136 mc_return_if_error (mcerror
);
138 if ((!g_file_test (directory_name
, G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) &&
139 (g_mkdir_with_parents (directory_name
, 0700) != 0))
140 mc_propagate_error (mcerror
, 0, _("Cannot create %s directory"), directory_name
);
143 /* --------------------------------------------------------------------------------------------- */
146 mc_config_init_one_config_path (const char *path_base
, const char *subdir
, GError
** mcerror
)
150 mc_return_val_if_error (mcerror
, FALSE
);
152 full_path
= g_build_filename (path_base
, subdir
, (char *) NULL
);
153 if (g_file_test (full_path
, G_FILE_TEST_EXISTS
))
155 if (g_file_test (full_path
, G_FILE_TEST_IS_DIR
))
157 config_dir_present
= TRUE
;
161 fprintf (stderr
, "%s %s\n", _("FATAL: not a directory:"), full_path
);
166 mc_config_mkdir (full_path
, mcerror
);
167 if (mcerror
!= NULL
&& *mcerror
!= NULL
)
168 MC_PTR_FREE (full_path
);
173 /* --------------------------------------------------------------------------------------------- */
176 mc_config_get_deprecated_path (void)
178 return g_build_filename (mc_config_get_home_dir (), MC_OLD_USERCONF_DIR
, (char *) NULL
);
181 /* --------------------------------------------------------------------------------------------- */
184 mc_config_copy (const char *old_name
, const char *new_name
, GError
** mcerror
)
186 mc_return_if_error (mcerror
);
188 if (g_file_test (old_name
, G_FILE_TEST_IS_REGULAR
))
190 char *contents
= NULL
;
193 if (g_file_get_contents (old_name
, &contents
, &length
, mcerror
))
194 g_file_set_contents (new_name
, contents
, length
, mcerror
);
200 if (g_file_test (old_name
, G_FILE_TEST_IS_DIR
))
204 const char *dir_name
;
206 dir
= g_dir_open (old_name
, 0, mcerror
);
210 if (g_mkdir_with_parents (new_name
, 0700) == -1)
213 mc_propagate_error (mcerror
, 0,
214 _("An error occurred while migrating user settings: %s"),
215 unix_error_string (errno
));
219 while ((dir_name
= g_dir_read_name (dir
)) != NULL
)
221 char *old_name2
, *new_name2
;
223 old_name2
= g_build_filename (old_name
, dir_name
, (char *) NULL
);
224 new_name2
= g_build_filename (new_name
, dir_name
, (char *) NULL
);
225 mc_config_copy (old_name2
, new_name2
, mcerror
);
232 /* --------------------------------------------------------------------------------------------- */
236 mc_config_fix_migrated_rules (void)
240 for (rule_index
= 0; mc_config_migrate_rules_fix
[rule_index
].old_basedir
!= NULL
; rule_index
++)
245 g_build_filename (*mc_config_migrate_rules_fix
[rule_index
].old_basedir
,
246 mc_config_migrate_rules_fix
[rule_index
].filename
, (char *) NULL
);
248 if (g_file_test (old_name
, G_FILE_TEST_EXISTS
))
251 const char *basedir
= *mc_config_migrate_rules_fix
[rule_index
].new_basedir
;
252 const char *filename
= mc_config_migrate_rules_fix
[rule_index
].filename
;
254 new_name
= g_build_filename (basedir
, filename
, (char *) NULL
);
255 rename (old_name
, new_name
);
261 #endif /* MC_HOMEDIR_XDG */
263 /* --------------------------------------------------------------------------------------------- */
266 mc_config_deprecated_dir_present (void)
271 old_dir
= mc_config_get_deprecated_path ();
272 is_present
= g_file_test (old_dir
, G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
);
275 return is_present
&& !config_dir_present
;
278 /* --------------------------------------------------------------------------------------------- */
279 /*** public functions ****************************************************************************/
280 /* --------------------------------------------------------------------------------------------- */
283 mc_config_init_config_paths (GError
** mcerror
)
285 const char *profile_root
;
287 #if MC_HOMEDIR_XDG == 0
288 char *defined_userconf_dir
;
291 mc_return_if_error (mcerror
);
293 if (xdg_vars_initialized
)
296 profile_root
= mc_get_profile_root ();
299 if (strcmp (profile_root
, mc_config_get_home_dir ()) != 0)
302 * The user overrode the default profile root.
304 * In this case we can't use GLib's g_get_user_{config,cache,data}_dir()
305 * as these functions use the user's home dir as the root.
308 dir
= g_build_filename (profile_root
, ".config", (char *) NULL
);
309 mc_config_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, mcerror
);
312 dir
= g_build_filename (profile_root
, ".cache", (char *) NULL
);
313 mc_cache_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, mcerror
);
316 dir
= g_build_filename (profile_root
, ".local", "share", (char *) NULL
);
317 mc_data_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, mcerror
);
323 mc_config_init_one_config_path (g_get_user_config_dir (), MC_USERCONF_DIR
, mcerror
);
325 mc_config_init_one_config_path (g_get_user_cache_dir (), MC_USERCONF_DIR
, mcerror
);
327 mc_config_init_one_config_path (g_get_user_data_dir (), MC_USERCONF_DIR
, mcerror
);
330 mc_config_fix_migrated_rules ();
331 #else /* MC_HOMEDIR_XDG */
332 defined_userconf_dir
= tilde_expand (MC_USERCONF_DIR
);
333 if (g_path_is_absolute (defined_userconf_dir
))
334 dir
= defined_userconf_dir
;
337 g_free (defined_userconf_dir
);
338 dir
= g_build_filename (profile_root
, MC_USERCONF_DIR
, (char *) NULL
);
341 mc_data_str
= mc_cache_str
= mc_config_str
= mc_config_init_one_config_path (dir
, "", mcerror
);
344 #endif /* MC_HOMEDIR_XDG */
346 xdg_vars_initialized
= TRUE
;
349 /* --------------------------------------------------------------------------------------------- */
352 mc_config_deinit_config_paths (void)
354 if (!xdg_vars_initialized
)
357 g_free (mc_config_str
);
359 g_free (mc_cache_str
);
360 g_free (mc_data_str
);
361 #endif /* MC_HOMEDIR_XDG */
363 g_free (mc_global
.share_data_dir
);
364 g_free (mc_global
.sysconfig_dir
);
366 xdg_vars_initialized
= FALSE
;
369 /* --------------------------------------------------------------------------------------------- */
372 mc_config_get_data_path (void)
374 if (!xdg_vars_initialized
)
375 mc_config_init_config_paths (NULL
);
377 return (const char *) mc_data_str
;
380 /* --------------------------------------------------------------------------------------------- */
383 mc_config_get_cache_path (void)
385 if (!xdg_vars_initialized
)
386 mc_config_init_config_paths (NULL
);
388 return (const char *) mc_cache_str
;
391 /* --------------------------------------------------------------------------------------------- */
394 mc_config_get_home_dir (void)
396 static const char *homedir
= NULL
;
400 /* Prior to GLib 2.36, g_get_home_dir() ignores $HOME, which is why
401 * we read it ourselves. As that function's documentation explains,
402 * using $HOME is good for compatibility with other programs and
403 * for running from test frameworks. */
404 homedir
= g_getenv ("HOME");
405 if (homedir
== NULL
|| *homedir
== '\0')
406 homedir
= g_get_home_dir ();
411 /* --------------------------------------------------------------------------------------------- */
414 mc_config_get_path (void)
416 if (!xdg_vars_initialized
)
417 mc_config_init_config_paths (NULL
);
419 return (const char *) mc_config_str
;
422 /* --------------------------------------------------------------------------------------------- */
425 mc_config_migrate_from_old_place (GError
** mcerror
, char **msg
)
430 mc_return_val_if_error (mcerror
, FALSE
);
432 if (!mc_config_deprecated_dir_present ())
435 old_dir
= mc_config_get_deprecated_path ();
437 g_free (mc_config_init_one_config_path (mc_config_str
, EDIT_DIR
, mcerror
));
439 g_free (mc_config_init_one_config_path (mc_cache_str
, EDIT_DIR
, mcerror
));
440 g_free (mc_config_init_one_config_path (mc_data_str
, EDIT_DIR
, mcerror
));
441 #endif /* MC_HOMEDIR_XDG */
443 mc_return_val_if_error (mcerror
, FALSE
);
445 for (rule_index
= 0; mc_config_files_reference
[rule_index
].old_filename
!= NULL
; rule_index
++)
448 if (*mc_config_files_reference
[rule_index
].old_filename
== '\0')
452 g_build_filename (old_dir
, mc_config_files_reference
[rule_index
].old_filename
,
455 if (g_file_test (old_name
, G_FILE_TEST_EXISTS
))
458 const char *basedir
= *mc_config_files_reference
[rule_index
].new_basedir
;
459 const char *filename
= mc_config_files_reference
[rule_index
].new_filename
;
461 new_name
= g_build_filename (basedir
, filename
, (char *) NULL
);
462 mc_config_copy (old_name
, new_name
, mcerror
);
469 *msg
= g_strdup_printf (_("Your old settings were migrated from %s\n"
470 "to Freedesktop recommended dirs.\n"
471 "To get more info, please visit\n"
472 "http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html"),
474 #else /* MC_HOMEDIR_XDG */
475 *msg
= g_strdup_printf (_("Your old settings were migrated from %s\n"
476 "to %s\n"), old_dir
, mc_config_str
);
477 #endif /* MC_HOMEDIR_XDG */
484 /* --------------------------------------------------------------------------------------------- */
486 * Get full path to config file by short name.
488 * @param config_name short name
489 * @return full path to config file
493 mc_config_get_full_path (const char *config_name
)
497 if (config_name
== NULL
)
500 if (!xdg_vars_initialized
)
501 mc_config_init_config_paths (NULL
);
503 for (rule_index
= 0; mc_config_files_reference
[rule_index
].old_filename
!= NULL
; rule_index
++)
505 if (strcmp (config_name
, mc_config_files_reference
[rule_index
].new_filename
) == 0)
507 return g_build_filename (*mc_config_files_reference
[rule_index
].new_basedir
,
508 mc_config_files_reference
[rule_index
].new_filename
,
515 /* --------------------------------------------------------------------------------------------- */
517 * Get full path to config file by short name.
519 * @param config_name short name
520 * @return object with full path to config file
524 mc_config_get_full_vpath (const char *config_name
)
526 vfs_path_t
*ret_vpath
;
529 str_path
= mc_config_get_full_path (config_name
);
531 ret_vpath
= vfs_path_from_str (str_path
);
536 /* --------------------------------------------------------------------------------------------- */