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
;
56 static gboolean config_dir_present
= FALSE
;
60 const char *old_filename
;
63 const char *new_filename
;
64 } mc_config_files_reference
[] =
68 { "ini", &mc_config_str
, MC_CONFIG_FILE
},
69 { "filehighlight.ini", &mc_config_str
, MC_FHL_INI_FILE
},
70 { "hotlist", &mc_config_str
, MC_HOTLIST_FILE
},
71 { "mc.keymap", &mc_config_str
, GLOBAL_KEYMAP_FILE
},
72 { "menu", &mc_config_str
, MC_USERMENU_FILE
},
73 { "cedit" PATH_SEP_STR
"Syntax", &mc_config_str
, EDIT_SYNTAX_FILE
},
74 { "cedit" PATH_SEP_STR
"menu", &mc_config_str
, EDIT_HOME_MENU
},
75 { "cedit" PATH_SEP_STR
"edit.indent.rc", &mc_config_str
, EDIT_DIR PATH_SEP_STR
"edit.indent.rc"},
76 { "cedit" PATH_SEP_STR
"edit.spell.rc", &mc_config_str
, EDIT_DIR PATH_SEP_STR
"edit.spell.rc"},
77 { "panels.ini", &mc_config_str
, MC_PANELS_FILE
},
79 /* User should move this file with applying some changes in file */
80 { "", &mc_config_str
, MC_FILEBIND_FILE
},
83 { "skins", &mc_data_str
, MC_SKINS_SUBDIR
},
84 { "fish", &mc_data_str
, FISH_PREFIX
},
85 { "bashrc", &mc_data_str
, "bashrc"},
86 { "inputrc", &mc_data_str
, "inputrc"},
87 { "extfs.d", &mc_data_str
, MC_EXTFS_DIR
},
88 { "history", &mc_data_str
, MC_HISTORY_FILE
},
89 { "filepos", &mc_data_str
, MC_FILEPOS_FILE
},
90 { "cedit" PATH_SEP_STR
"cooledit.clip", &mc_data_str
, EDIT_CLIP_FILE
},
91 { "", &mc_data_str
, MC_MACRO_FILE
},
94 { "log", &mc_cache_str
, "mc.log"},
95 { "Tree", &mc_cache_str
, MC_TREESTORE_FILE
},
96 { "cedit" PATH_SEP_STR
"cooledit.temp", &mc_cache_str
, EDIT_TEMP_FILE
},
97 { "cedit" PATH_SEP_STR
"cooledit.block", &mc_cache_str
, EDIT_BLOCK_FILE
},
103 #ifdef MC_HOMEDIR_XDG
107 const char *filename
;
110 } mc_config_migrate_rules_fix
[] =
113 { &mc_data_str
, MC_USERMENU_FILE
, &mc_config_str
},
114 { &mc_data_str
, EDIT_SYNTAX_FILE
, &mc_config_str
},
115 { &mc_data_str
, EDIT_HOME_MENU
, &mc_config_str
},
116 { &mc_data_str
, EDIT_DIR PATH_SEP_STR
"edit.indent.rc", &mc_config_str
},
117 { &mc_data_str
, EDIT_DIR PATH_SEP_STR
"edit.spell.rc", &mc_config_str
},
118 { &mc_data_str
, MC_FILEBIND_FILE
, &mc_config_str
},
120 { &mc_cache_str
, MC_HISTORY_FILE
, &mc_data_str
},
121 { &mc_cache_str
, MC_FILEPOS_FILE
, &mc_data_str
},
122 { &mc_cache_str
, EDIT_CLIP_FILE
, &mc_data_str
},
124 { &mc_cache_str
, MC_PANELS_FILE
, &mc_config_str
},
129 #endif /* MC_HOMEDIR_XDG */
131 /*** file scope functions *********************************************************************** */
132 /* --------------------------------------------------------------------------------------------- */
135 mc_config_mkdir (const char *directory_name
, GError
** error
)
137 if ((!g_file_test (directory_name
, G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
)) &&
138 (g_mkdir_with_parents (directory_name
, 0700) != 0))
140 g_propagate_error (error
,
141 g_error_new (MC_ERROR
, 0, _("Cannot create %s directory"),
146 /* --------------------------------------------------------------------------------------------- */
149 mc_config_init_one_config_path (const char *path_base
, const char *subdir
, GError
** error
)
153 full_path
= g_build_filename (path_base
, subdir
, NULL
);
155 if (g_file_test (full_path
, G_FILE_TEST_EXISTS
))
157 if (g_file_test (full_path
, G_FILE_TEST_IS_DIR
))
159 config_dir_present
= TRUE
;
163 fprintf (stderr
, "%s %s\n", _("FATAL: not a directory:"), full_path
);
168 mc_config_mkdir (full_path
, error
);
169 if (error
!= NULL
&& *error
!= NULL
)
177 /* --------------------------------------------------------------------------------------------- */
180 mc_config_get_deprecated_path (void)
182 return g_build_filename (mc_config_get_home_dir (), MC_OLD_USERCONF_DIR
, NULL
);
185 /* --------------------------------------------------------------------------------------------- */
188 mc_config_copy (const char *old_name
, const char *new_name
, GError
** error
)
190 if (g_file_test (old_name
, G_FILE_TEST_IS_REGULAR
))
192 char *contents
= NULL
;
195 if (g_file_get_contents (old_name
, &contents
, &length
, error
))
196 g_file_set_contents (new_name
, contents
, length
, error
);
202 if (g_file_test (old_name
, G_FILE_TEST_IS_DIR
))
206 const char *dir_name
;
208 dir
= g_dir_open (old_name
, 0, error
);
212 if (g_mkdir_with_parents (new_name
, 0700) == -1)
215 g_propagate_error (error
,
216 g_error_new (MC_ERROR
, 0,
218 ("An error occured while migrating user settings: %s"),
219 unix_error_string (errno
)));
223 while ((dir_name
= g_dir_read_name (dir
)) != NULL
)
225 char *old_name2
, *new_name2
;
227 old_name2
= g_build_filename (old_name
, dir_name
, NULL
);
228 new_name2
= g_build_filename (new_name
, dir_name
, NULL
);
229 mc_config_copy (old_name2
, new_name2
, error
);
236 /* --------------------------------------------------------------------------------------------- */
240 mc_config_fix_migrated_rules (void)
244 for (rule_index
= 0; mc_config_migrate_rules_fix
[rule_index
].old_basedir
!= NULL
; rule_index
++)
249 g_build_filename (*mc_config_migrate_rules_fix
[rule_index
].old_basedir
,
250 mc_config_migrate_rules_fix
[rule_index
].filename
, NULL
);
252 if (g_file_test (old_name
, G_FILE_TEST_EXISTS
))
255 const char *basedir
= *mc_config_migrate_rules_fix
[rule_index
].new_basedir
;
256 const char *filename
= mc_config_migrate_rules_fix
[rule_index
].filename
;
258 new_name
= g_build_filename (basedir
, filename
, NULL
);
259 rename (old_name
, new_name
);
265 #endif /* MC_HOMEDIR_XDG */
267 /* --------------------------------------------------------------------------------------------- */
268 /*** public functions ****************************************************************************/
269 /* --------------------------------------------------------------------------------------------- */
272 mc_config_init_config_paths (GError
** error
)
274 const char *mc_datadir
;
276 #ifdef MC_HOMEDIR_XDG
277 char *u_config_dir
= (char *) g_get_user_config_dir ();
278 char *u_data_dir
= (char *) g_get_user_data_dir ();
279 char *u_cache_dir
= (char *) g_get_user_cache_dir ();
281 if (xdg_vars_initialized
)
284 u_config_dir
= (u_config_dir
== NULL
)
285 ? g_build_filename (mc_config_get_home_dir (), ".config", NULL
) : g_strdup (u_config_dir
);
287 u_cache_dir
= (u_cache_dir
== NULL
)
288 ? g_build_filename (mc_config_get_home_dir (), ".cache", NULL
) : g_strdup (u_cache_dir
);
290 u_data_dir
= (u_data_dir
== NULL
)
291 ? g_build_filename (mc_config_get_home_dir (), ".local", "share", NULL
)
292 : g_strdup (u_data_dir
);
294 mc_config_str
= mc_config_init_one_config_path (u_config_dir
, MC_USERCONF_DIR
, error
);
295 mc_cache_str
= mc_config_init_one_config_path (u_cache_dir
, MC_USERCONF_DIR
, error
);
296 mc_data_str
= mc_config_init_one_config_path (u_data_dir
, MC_USERCONF_DIR
, error
);
299 g_free (u_cache_dir
);
300 g_free (u_config_dir
);
302 mc_config_fix_migrated_rules ();
303 #else /* MC_HOMEDIR_XDG */
304 char *defined_userconf_dir
;
307 defined_userconf_dir
= tilde_expand (MC_USERCONF_DIR
);
308 if (!g_path_is_absolute (defined_userconf_dir
))
310 u_config_dir
= g_build_filename (mc_config_get_home_dir (), MC_USERCONF_DIR
, NULL
);
311 g_free (defined_userconf_dir
);
314 u_config_dir
= defined_userconf_dir
;
316 mc_data_str
= mc_cache_str
= mc_config_str
=
317 mc_config_init_one_config_path (u_config_dir
, "", error
);
319 g_free (u_config_dir
);
320 #endif /* MC_HOMEDIR_XDG */
322 /* This is the directory, where MC was installed, on Unix this is DATADIR */
323 /* and can be overriden by the MC_DATADIR environment variable */
324 mc_datadir
= g_getenv ("MC_DATADIR");
325 if (mc_datadir
!= NULL
)
326 mc_global
.sysconfig_dir
= g_strdup (mc_datadir
);
328 mc_global
.sysconfig_dir
= g_strdup (SYSCONFDIR
);
330 mc_global
.share_data_dir
= g_strdup (DATADIR
);
332 xdg_vars_initialized
= TRUE
;
335 /* --------------------------------------------------------------------------------------------- */
338 mc_config_deinit_config_paths (void)
340 if (!xdg_vars_initialized
)
343 g_free (mc_config_str
);
344 #ifdef MC_HOMEDIR_XDG
345 g_free (mc_cache_str
);
346 g_free (mc_data_str
);
347 #endif /* MC_HOMEDIR_XDG */
349 g_free (mc_global
.share_data_dir
);
350 g_free (mc_global
.sysconfig_dir
);
352 xdg_vars_initialized
= FALSE
;
355 /* --------------------------------------------------------------------------------------------- */
358 mc_config_get_data_path (void)
360 if (!xdg_vars_initialized
)
361 mc_config_init_config_paths (NULL
);
363 return (const char *) mc_data_str
;
366 /* --------------------------------------------------------------------------------------------- */
369 mc_config_get_cache_path (void)
371 if (!xdg_vars_initialized
)
372 mc_config_init_config_paths (NULL
);
374 return (const char *) mc_cache_str
;
377 /* --------------------------------------------------------------------------------------------- */
380 mc_config_get_home_dir (void)
384 homedir
= g_getenv ("HOME");
386 homedir
= g_get_home_dir ();
391 /* --------------------------------------------------------------------------------------------- */
394 mc_config_get_path (void)
396 if (!xdg_vars_initialized
)
397 mc_config_init_config_paths (NULL
);
399 return (const char *) mc_config_str
;
402 /* --------------------------------------------------------------------------------------------- */
405 mc_config_migrate_from_old_place (GError
** error
)
410 old_dir
= mc_config_get_deprecated_path ();
412 g_free (mc_config_init_one_config_path (mc_config_str
, EDIT_DIR
, error
));
413 #ifdef MC_HOMEDIR_XDG
414 g_free (mc_config_init_one_config_path (mc_cache_str
, EDIT_DIR
, error
));
415 g_free (mc_config_init_one_config_path (mc_data_str
, EDIT_DIR
, error
));
416 #endif /* MC_HOMEDIR_XDG */
418 for (rule_index
= 0; mc_config_files_reference
[rule_index
].old_filename
!= NULL
; rule_index
++)
421 if (*mc_config_files_reference
[rule_index
].old_filename
== '\0')
425 g_build_filename (old_dir
, mc_config_files_reference
[rule_index
].old_filename
, NULL
);
427 if (g_file_test (old_name
, G_FILE_TEST_EXISTS
))
430 const char *basedir
= *mc_config_files_reference
[rule_index
].new_basedir
;
431 const char *filename
= mc_config_files_reference
[rule_index
].new_filename
;
433 new_name
= g_build_filename (basedir
, filename
, NULL
);
434 mc_config_copy (old_name
, new_name
, error
);
440 #ifdef MC_HOMEDIR_XDG
441 g_propagate_error (error
,
442 g_error_new (MC_ERROR
, 0,
444 ("Your old settings were migrated from %s\n"
445 "to Freedesktop recommended dirs.\n"
446 "To get more info, please visit\n"
447 "http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html"),
449 #else /* MC_HOMEDIR_XDG */
450 g_propagate_error (error
,
451 g_error_new (MC_ERROR
, 0,
453 ("Your old settings were migrated from %s\n"
454 "to %s\n"), old_dir
, mc_config_str
));
455 #endif /* MC_HOMEDIR_XDG */
460 /* --------------------------------------------------------------------------------------------- */
463 mc_config_deprecated_dir_present (void)
468 old_dir
= mc_config_get_deprecated_path ();
469 is_present
= g_file_test (old_dir
, G_FILE_TEST_EXISTS
| G_FILE_TEST_IS_DIR
);
472 return is_present
&& !config_dir_present
;
475 /* --------------------------------------------------------------------------------------------- */
477 * Get full path to config file by short name.
479 * @param config_name short name
480 * @return full path to config file
484 mc_config_get_full_path (const char *config_name
)
488 if (config_name
== NULL
)
491 if (!xdg_vars_initialized
)
492 mc_config_init_config_paths (NULL
);
494 for (rule_index
= 0; mc_config_files_reference
[rule_index
].old_filename
!= NULL
; rule_index
++)
496 if (strcmp (config_name
, mc_config_files_reference
[rule_index
].new_filename
) == 0)
498 return g_build_filename (*mc_config_files_reference
[rule_index
].new_basedir
,
499 mc_config_files_reference
[rule_index
].new_filename
, NULL
);
505 /* --------------------------------------------------------------------------------------------- */
507 * Get full path to config file by short name.
509 * @param config_name short name
510 * @return object with full path to config file
514 mc_config_get_full_vpath (const char *config_name
)
516 vfs_path_t
*ret_vpath
;
519 str_path
= mc_config_get_full_path (config_name
);
521 ret_vpath
= vfs_path_from_str(str_path
);
526 /* --------------------------------------------------------------------------------------------- */