2 paths to configuration files
4 Copyright (C) 2010, 2011
5 The 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 const char *homedir
= NULL
;
55 /* value of $MC_HOME */
56 static const char *mc_home
= NULL
;
58 static gboolean config_dir_present
= FALSE
;
62 const char *old_filename
;
65 const char *new_filename
;
66 } mc_config_files_reference
[] =
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
},
81 /* User should move this file with applying some changes in file */
82 { "", &mc_config_str
, MC_FILEBIND_FILE
},
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
},
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
},
105 #ifdef MC_HOMEDIR_XDG
109 const char *filename
;
112 } mc_config_migrate_rules_fix
[] =
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
},
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
},
126 { &mc_cache_str
, MC_PANELS_FILE
, &mc_config_str
},
131 #endif /* MC_HOMEDIR_XDG */
133 /*** file scope functions *********************************************************************** */
134 /* --------------------------------------------------------------------------------------------- */
137 mc_config_mkdir (const char *directory_name
, GError
** error
)
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))
142 g_propagate_error (error
,
143 g_error_new (MC_ERROR
, 0, _("Cannot create %s directory"),
148 /* --------------------------------------------------------------------------------------------- */
151 mc_config_init_one_config_path (const char *path_base
, const char *subdir
, GError
** error
)
155 full_path
= g_build_filename (path_base
, subdir
, NULL
);
157 if (g_file_test (full_path
, G_FILE_TEST_EXISTS
))
159 if (g_file_test (full_path
, G_FILE_TEST_IS_DIR
))
161 config_dir_present
= TRUE
;
165 fprintf (stderr
, "%s %s\n", _("FATAL: not a directory:"), full_path
);
170 mc_config_mkdir (full_path
, error
);
171 if (error
!= NULL
&& *error
!= NULL
)
179 /* --------------------------------------------------------------------------------------------- */
182 mc_config_get_deprecated_path (void)
184 return g_build_filename (mc_config_get_home_dir (), MC_OLD_USERCONF_DIR
, NULL
);
187 /* --------------------------------------------------------------------------------------------- */
190 mc_config_copy (const char *old_name
, const char *new_name
, GError
** error
)
192 if (g_file_test (old_name
, G_FILE_TEST_IS_REGULAR
))
194 char *contents
= NULL
;
197 if (g_file_get_contents (old_name
, &contents
, &length
, error
))
198 g_file_set_contents (new_name
, contents
, length
, error
);
204 if (g_file_test (old_name
, G_FILE_TEST_IS_DIR
))
208 const char *dir_name
;
210 dir
= g_dir_open (old_name
, 0, error
);
214 if (g_mkdir_with_parents (new_name
, 0700) == -1)
217 g_propagate_error (error
,
218 g_error_new (MC_ERROR
, 0,
220 ("An error occured while migrating user settings: %s"),
221 unix_error_string (errno
)));
225 while ((dir_name
= g_dir_read_name (dir
)) != NULL
)
227 char *old_name2
, *new_name2
;
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
);
238 /* --------------------------------------------------------------------------------------------- */
242 mc_config_fix_migrated_rules (void)
246 for (rule_index
= 0; mc_config_migrate_rules_fix
[rule_index
].old_basedir
!= NULL
; rule_index
++)
251 g_build_filename (*mc_config_migrate_rules_fix
[rule_index
].old_basedir
,
252 mc_config_migrate_rules_fix
[rule_index
].filename
, NULL
);
254 if (g_file_test (old_name
, G_FILE_TEST_EXISTS
))
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
;
260 new_name
= g_build_filename (basedir
, filename
, NULL
);
261 rename (old_name
, new_name
);
267 #endif /* MC_HOMEDIR_XDG */
269 /* --------------------------------------------------------------------------------------------- */
270 /*** public functions ****************************************************************************/
271 /* --------------------------------------------------------------------------------------------- */
274 mc_config_init_config_paths (GError
** error
)
278 if (xdg_vars_initialized
)
281 /* init mc_home and homedir if not yet */
282 (void) mc_config_get_home_dir ();
284 #ifdef MC_HOMEDIR_XDG
287 dir
= g_build_filename (mc_home
, ".config", (char *) NULL
);
288 mc_config_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
291 dir
= g_build_filename (mc_home
, ".cache", (char *) NULL
);
292 mc_cache_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
295 dir
= g_build_filename (mc_home
, ".local", "share", (char *) NULL
);
296 mc_data_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
301 dir
= (char *) g_get_user_config_dir ();
302 if (dir
!= NULL
&& *dir
!= '\0')
303 mc_config_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
306 dir
= g_build_filename (homedir
, ".config", (char *) NULL
);
307 mc_config_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
311 dir
= (char *) g_get_user_cache_dir ();
312 if (dir
!= NULL
&& *dir
!= '\0')
313 mc_cache_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
316 dir
= g_build_filename (homedir
, ".cache", (char *) NULL
);
317 mc_cache_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
321 dir
= (char *) g_get_user_data_dir ();
322 if (dir
!= NULL
&& *dir
!= '\0')
323 mc_data_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
326 dir
= g_build_filename (homedir
, ".local", "share", (char *) NULL
);
327 mc_data_str
= mc_config_init_one_config_path (dir
, MC_USERCONF_DIR
, error
);
332 mc_config_fix_migrated_rules ();
333 #else /* MC_HOMEDIR_XDG */
334 char *defined_userconf_dir
;
336 defined_userconf_dir
= tilde_expand (MC_USERCONF_DIR
);
337 if (g_path_is_absolute (defined_userconf_dir
))
338 dir
= defined_userconf_dir
;
341 g_free (defined_userconf_dir
);
342 dir
= g_build_filename (mc_config_get_home_dir (), MC_USERCONF_DIR
, (char *) NULL
);
345 mc_data_str
= mc_cache_str
= mc_config_str
= mc_config_init_one_config_path (dir
, "", error
);
348 #endif /* MC_HOMEDIR_XDG */
350 xdg_vars_initialized
= TRUE
;
353 /* --------------------------------------------------------------------------------------------- */
356 mc_config_deinit_config_paths (void)
358 if (!xdg_vars_initialized
)
361 g_free (mc_config_str
);
362 #ifdef MC_HOMEDIR_XDG
363 g_free (mc_cache_str
);
364 g_free (mc_data_str
);
365 #endif /* MC_HOMEDIR_XDG */
367 g_free (mc_global
.share_data_dir
);
368 g_free (mc_global
.sysconfig_dir
);
370 xdg_vars_initialized
= FALSE
;
373 /* --------------------------------------------------------------------------------------------- */
376 mc_config_get_data_path (void)
378 if (!xdg_vars_initialized
)
379 mc_config_init_config_paths (NULL
);
381 return (const char *) mc_data_str
;
384 /* --------------------------------------------------------------------------------------------- */
387 mc_config_get_cache_path (void)
389 if (!xdg_vars_initialized
)
390 mc_config_init_config_paths (NULL
);
392 return (const char *) mc_cache_str
;
395 /* --------------------------------------------------------------------------------------------- */
398 mc_config_get_home_dir (void)
402 homedir
= g_getenv ("MC_HOME");
403 if (homedir
== NULL
|| *homedir
== '\0')
404 homedir
= g_getenv ("HOME");
407 if (homedir
== NULL
|| *homedir
== '\0')
408 homedir
= g_get_home_dir ();
413 /* --------------------------------------------------------------------------------------------- */
416 mc_config_get_path (void)
418 if (!xdg_vars_initialized
)
419 mc_config_init_config_paths (NULL
);
421 return (const char *) mc_config_str
;
424 /* --------------------------------------------------------------------------------------------- */
427 mc_config_migrate_from_old_place (GError
** error
)
432 old_dir
= mc_config_get_deprecated_path ();
434 g_free (mc_config_init_one_config_path (mc_config_str
, EDIT_DIR
, error
));
435 #ifdef MC_HOMEDIR_XDG
436 g_free (mc_config_init_one_config_path (mc_cache_str
, EDIT_DIR
, error
));
437 g_free (mc_config_init_one_config_path (mc_data_str
, EDIT_DIR
, error
));
438 #endif /* MC_HOMEDIR_XDG */
440 for (rule_index
= 0; mc_config_files_reference
[rule_index
].old_filename
!= NULL
; rule_index
++)
443 if (*mc_config_files_reference
[rule_index
].old_filename
== '\0')
447 g_build_filename (old_dir
, mc_config_files_reference
[rule_index
].old_filename
, NULL
);
449 if (g_file_test (old_name
, G_FILE_TEST_EXISTS
))
452 const char *basedir
= *mc_config_files_reference
[rule_index
].new_basedir
;
453 const char *filename
= mc_config_files_reference
[rule_index
].new_filename
;
455 new_name
= g_build_filename (basedir
, filename
, NULL
);
456 mc_config_copy (old_name
, new_name
, error
);
462 #ifdef MC_HOMEDIR_XDG
463 g_propagate_error (error
,
464 g_error_new (MC_ERROR
, 0,
466 ("Your old settings were migrated from %s\n"
467 "to Freedesktop recommended dirs.\n"
468 "To get more info, please visit\n"
469 "http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html"),
471 #else /* MC_HOMEDIR_XDG */
472 g_propagate_error (error
,
473 g_error_new (MC_ERROR
, 0,
475 ("Your old settings were migrated from %s\n"
476 "to %s\n"), old_dir
, mc_config_str
));
477 #endif /* MC_HOMEDIR_XDG */
482 /* --------------------------------------------------------------------------------------------- */
485 mc_config_deprecated_dir_present (void)
490 old_dir
= mc_config_get_deprecated_path ();
491 is_present
= g_file_test (old_dir
, G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
);
494 return is_present
&& !config_dir_present
;
497 /* --------------------------------------------------------------------------------------------- */
499 * Get full path to config file by short name.
501 * @param config_name short name
502 * @return full path to config file
506 mc_config_get_full_path (const char *config_name
)
510 if (config_name
== NULL
)
513 if (!xdg_vars_initialized
)
514 mc_config_init_config_paths (NULL
);
516 for (rule_index
= 0; mc_config_files_reference
[rule_index
].old_filename
!= NULL
; rule_index
++)
518 if (strcmp (config_name
, mc_config_files_reference
[rule_index
].new_filename
) == 0)
520 return g_build_filename (*mc_config_files_reference
[rule_index
].new_basedir
,
521 mc_config_files_reference
[rule_index
].new_filename
, NULL
);
527 /* --------------------------------------------------------------------------------------------- */
529 * Get full path to config file by short name.
531 * @param config_name short name
532 * @return object with full path to config file
536 mc_config_get_full_vpath (const char *config_name
)
538 vfs_path_t
*ret_vpath
;
541 str_path
= mc_config_get_full_path (config_name
);
543 ret_vpath
= vfs_path_from_str (str_path
);
548 /* --------------------------------------------------------------------------------------------- */