lib/mcconfig/paths.c

lib/mcconfig/paths.c
Manual pages: mc • mcdiff • mcedit • mcview
/* */
This source file includes following definitions.
mc_config_mkdir
mc_config_init_one_config_path
mc_config_init_config_paths
mc_config_deinit_config_paths
mc_config_get_data_path
mc_config_get_cache_path
mc_config_get_home_dir
mc_config_get_path
mc_config_get_full_path
mc_config_get_full_vpath
   1 /*
   2    paths to configuration files
   3 
   4    Copyright (C) 2010-2025
   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 <https://www.gnu.org/licenses/>.
  24  */
  25 
  26 #include <config.h>
  27 
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 
  31 #include "lib/global.h"
  32 #include "lib/fileloc.h"
  33 #include "lib/vfs/vfs.h"
  34 #include "lib/util.h"  // unix_error_string()
  35 
  36 #include "lib/mcconfig.h"
  37 
  38 /*** global variables ****************************************************************************/
  39 
  40 /*** file scope macro definitions ****************************************************************/
  41 
  42 /*** file scope type declarations ****************************************************************/
  43 
  44 /*** forward declarations (file scope functions) *************************************************/
  45 
  46 /*** file scope variables ************************************************************************/
  47 
  48 static gboolean xdg_vars_initialized = FALSE;
  49 static char *mc_config_str = NULL;
  50 static char *mc_cache_str = NULL;
  51 static char *mc_data_str = NULL;
  52 
  53 static gboolean config_dir_present = FALSE;
  54 
  55 static const struct
  56 {
  57     char **basedir;
  58     const char *filename;
  59 } mc_config_files_reference[] = {
  60     // config
  61     { &mc_config_str, MC_CONFIG_FILE },
  62     { &mc_config_str, MC_FHL_INI_FILE },
  63     { &mc_config_str, MC_HOTLIST_FILE },
  64     { &mc_config_str, GLOBAL_KEYMAP_FILE },
  65     { &mc_config_str, MC_USERMENU_FILE },
  66     { &mc_config_str, EDIT_HOME_MENU },
  67     { &mc_config_str, MC_PANELS_FILE },
  68 
  69     // User should move this file with applying some changes in file
  70     { &mc_config_str, MC_EXT_FILE },
  71     { &mc_config_str, MC_EXT_OLD_FILE },
  72 
  73     // data
  74     { &mc_data_str, MC_SKINS_DIR },
  75     { &mc_data_str, VFS_SHELL_PREFIX },
  76     { &mc_data_str, MC_ASHRC_FILE },
  77     { &mc_data_str, MC_KSHRC_FILE },
  78     { &mc_data_str, MC_MKSHRC_FILE },
  79     { &mc_data_str, MC_BASHRC_FILE },
  80     { &mc_data_str, MC_INPUTRC_FILE },
  81     { &mc_data_str, MC_ZSHRC_FILE },
  82     { &mc_data_str, MC_EXTFS_DIR },
  83     { &mc_data_str, MC_HISTORY_FILE },
  84     { &mc_data_str, MC_FILEPOS_FILE },
  85     { &mc_data_str, EDIT_SYNTAX_FILE },
  86     { &mc_data_str, EDIT_HOME_CLIP_FILE },
  87     { &mc_data_str, MC_MACRO_FILE },
  88 
  89     // cache
  90     { &mc_cache_str, "mc.log" },
  91     { &mc_cache_str, MC_TREESTORE_FILE },
  92     { &mc_cache_str, EDIT_HOME_TEMP_FILE },
  93     { &mc_cache_str, EDIT_HOME_BLOCK_FILE },
  94 
  95     {
  96         NULL,
  97         NULL,
  98     },
  99 };
 100 
 101 /* --------------------------------------------------------------------------------------------- */
 102 /*** file scope functions *********************************************************************** */
 103 /* --------------------------------------------------------------------------------------------- */
 104 
 105 static void
 106 mc_config_mkdir (const char *directory_name, GError **mcerror)
     /*   */
 107 {
 108     mc_return_if_error (mcerror);
 109 
 110     if (!(g_file_test (directory_name, G_FILE_TEST_EXISTS)
 111           && g_file_test (directory_name, G_FILE_TEST_IS_DIR))
 112         && g_mkdir_with_parents (directory_name, 0700) != 0)
 113         mc_propagate_error (mcerror, 0, _ ("Cannot create %s directory"), directory_name);
 114 }
 115 
 116 /* --------------------------------------------------------------------------------------------- */
 117 
 118 static char *
 119 mc_config_init_one_config_path (const char *path_base, const char *subdir, GError **mcerror)
     /*   */
 120 {
 121     char *full_path;
 122 
 123     mc_return_val_if_error (mcerror, FALSE);
 124 
 125     full_path = g_build_filename (path_base, subdir, (char *) NULL);
 126 
 127     if (g_file_test (full_path, G_FILE_TEST_EXISTS))
 128     {
 129         if (g_file_test (full_path, G_FILE_TEST_IS_DIR))
 130             config_dir_present = TRUE;
 131         else
 132         {
 133             fprintf (stderr, "%s %s\n", _ ("FATAL: not a directory:"), full_path);
 134             exit (EXIT_FAILURE);
 135         }
 136     }
 137 
 138     mc_config_mkdir (full_path, mcerror);
 139     if (mcerror != NULL && *mcerror != NULL)
 140         MC_PTR_FREE (full_path);
 141 
 142     return full_path;
 143 }
 144 
 145 /* --------------------------------------------------------------------------------------------- */
 146 /*** public functions ****************************************************************************/
 147 /* --------------------------------------------------------------------------------------------- */
 148 
 149 void
 150 mc_config_init_config_paths (GError **mcerror)
     /*   */
 151 {
 152     const char *profile_root;
 153     char *dir;
 154 
 155     mc_return_if_error (mcerror);
 156 
 157     if (xdg_vars_initialized)
 158         return;
 159 
 160     profile_root = mc_get_profile_root ();
 161 
 162     if (strcmp (profile_root, mc_config_get_home_dir ()) != 0)
 163     {
 164         /*
 165          * The user overrode the default profile root.
 166          *
 167          * In this case we can't use GLib's g_get_user_{config,cache,data}_dir()
 168          * as these functions use the user's home dir as the root.
 169          */
 170 
 171         dir = g_build_filename (profile_root, ".config", (char *) NULL);
 172         mc_config_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, mcerror);
 173         g_free (dir);
 174 
 175         dir = g_build_filename (profile_root, ".cache", (char *) NULL);
 176         mc_cache_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, mcerror);
 177         g_free (dir);
 178 
 179         dir = g_build_filename (profile_root, ".local", "share", (char *) NULL);
 180         mc_data_str = mc_config_init_one_config_path (dir, MC_USERCONF_DIR, mcerror);
 181         g_free (dir);
 182     }
 183     else
 184     {
 185         mc_config_str =
 186             mc_config_init_one_config_path (g_get_user_config_dir (), MC_USERCONF_DIR, mcerror);
 187         mc_cache_str =
 188             mc_config_init_one_config_path (g_get_user_cache_dir (), MC_USERCONF_DIR, mcerror);
 189         mc_data_str =
 190             mc_config_init_one_config_path (g_get_user_data_dir (), MC_USERCONF_DIR, mcerror);
 191     }
 192 
 193     xdg_vars_initialized = TRUE;
 194 }
 195 
 196 /* --------------------------------------------------------------------------------------------- */
 197 
 198 void
 199 mc_config_deinit_config_paths (void)
     /*   */
 200 {
 201     if (!xdg_vars_initialized)
 202         return;
 203 
 204     g_free (mc_config_str);
 205     g_free (mc_cache_str);
 206     g_free (mc_data_str);
 207 
 208     g_free (mc_global.share_data_dir);
 209     g_free (mc_global.sysconfig_dir);
 210 
 211     xdg_vars_initialized = FALSE;
 212 }
 213 
 214 /* --------------------------------------------------------------------------------------------- */
 215 
 216 const char *
 217 mc_config_get_data_path (void)
     /*   */
 218 {
 219     if (!xdg_vars_initialized)
 220         mc_config_init_config_paths (NULL);
 221 
 222     return (const char *) mc_data_str;
 223 }
 224 
 225 /* --------------------------------------------------------------------------------------------- */
 226 
 227 const char *
 228 mc_config_get_cache_path (void)
     /*   */
 229 {
 230     if (!xdg_vars_initialized)
 231         mc_config_init_config_paths (NULL);
 232 
 233     return (const char *) mc_cache_str;
 234 }
 235 
 236 /* --------------------------------------------------------------------------------------------- */
 237 
 238 const char *
 239 mc_config_get_home_dir (void)
     /*   */
 240 {
 241     static const char *homedir = NULL;
 242 
 243     if (homedir == NULL)
 244     {
 245         /* Prior to GLib 2.36, g_get_home_dir() ignores $HOME, which is why
 246          * we read it ourselves. As that function's documentation explains,
 247          * using $HOME is good for compatibility with other programs and
 248          * for running from test frameworks. */
 249         homedir = g_getenv ("HOME");
 250         if (homedir == NULL || *homedir == '\0')
 251             homedir = g_get_home_dir ();
 252     }
 253 
 254     return homedir;
 255 }
 256 
 257 /* --------------------------------------------------------------------------------------------- */
 258 
 259 const char *
 260 mc_config_get_path (void)
     /*   */
 261 {
 262     if (!xdg_vars_initialized)
 263         mc_config_init_config_paths (NULL);
 264 
 265     return (const char *) mc_config_str;
 266 }
 267 
 268 /* --------------------------------------------------------------------------------------------- */
 269 /**
 270  * Get full path to config file by short name.
 271  *
 272  * @param config_name short name
 273  * @return full path to config file
 274  */
 275 
 276 char *
 277 mc_config_get_full_path (const char *config_name)
     /*   */
 278 {
 279     size_t rule_index;
 280 
 281     if (config_name == NULL)
 282         return NULL;
 283 
 284     if (!xdg_vars_initialized)
 285         mc_config_init_config_paths (NULL);
 286 
 287     for (rule_index = 0; mc_config_files_reference[rule_index].filename != NULL; rule_index++)
 288         if (strcmp (config_name, mc_config_files_reference[rule_index].filename) == 0)
 289             return g_build_filename (*mc_config_files_reference[rule_index].basedir,
 290                                      mc_config_files_reference[rule_index].filename, (char *) NULL);
 291 
 292     return NULL;
 293 }
 294 
 295 /* --------------------------------------------------------------------------------------------- */
 296 /**
 297  * Get full path to config file by short name.
 298  *
 299  * @param config_name short name
 300  * @return object with full path to config file
 301  */
 302 
 303 vfs_path_t *
 304 mc_config_get_full_vpath (const char *config_name)
     /*   */
 305 {
 306     vfs_path_t *ret_vpath;
 307     char *str_path;
 308 
 309     str_path = mc_config_get_full_path (config_name);
 310 
 311     ret_vpath = vfs_path_from_str (str_path);
 312     g_free (str_path);
 313 
 314     return ret_vpath;
 315 }
 316 
 317 /* --------------------------------------------------------------------------------------------- */
/* */
root/lib/mcconfig/paths.c

DEFINITIONS
