src/posix/dirs.c

   1 /*****************************************************************************
   2  * dirs.c: XDG directories configuration
   3  *****************************************************************************
   4  * Copyright (C) 2001-2007 VLC authors and VideoLAN
   5  * Copyright © 2007-2009 Rémi Denis-Courmont
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29
  30 #include "../libvlc.h"
  31 #include "config/configuration.h"
  32
  33 #include <unistd.h>
  34 #include <pwd.h>
  35 #include <assert.h>
  36 #include <limits.h>
  37
  38 /**
  39  * Determines the architecture-dependent data directory
  40  *
  41  * @return a string (always succeeds).
  42  */
  43 VLC_WEAK char *config_GetLibDir(void)
  44 {
  45     return strdup(LIBDIR);
  46 }
  47
  48 char *config_GetSysPath(vlc_sysdir_t type, const char *filename)
  49 {
  50     static const char env_vars[][16] = {
  51         [VLC_PKG_DATA_DIR] = "VLC_DATA_PATH",
  52         [VLC_PKG_LIB_DIR] = "VLC_LIB_PATH",
  53         [VLC_PKG_LIBEXEC_DIR] = "VLC_LIB_PATH",
  54     };
  55
  56     if (type < ARRAY_SIZE(env_vars)) {
  57         const char *name = env_vars[type];
  58          if (*name != '\0') {
  59              const char *value = getenv(name);
  60              if (value != NULL) {
  61                  const char *fmt = (filename != NULL) ? "%s/%s" : "%s";
  62                  char *filepath;
  63
  64                  if (unlikely(asprintf(&filepath, fmt, value, filename) == -1))
  65                      filepath = NULL;
  66                  return filepath;
  67              }
  68          }
  69     }
  70
  71     char *libdir = config_GetLibDir();
  72     if (libdir == NULL)
  73         return NULL; /* OOM */
  74
  75     static const char *const dirs[] = {
  76         [VLC_PKG_DATA_DIR] = PKGDATADIR,
  77         [VLC_PKG_LIB_DIR] = PKGLIBDIR,
  78         [VLC_PKG_LIBEXEC_DIR] = PKGLIBEXECDIR,
  79         [VLC_SYSDATA_DIR] = SYSDATADIR,
  80         [VLC_LIB_DIR] = LIBDIR,
  81         [VLC_LIBEXEC_DIR] = LIBEXECDIR,
  82         [VLC_LOCALE_DIR] = LOCALEDIR,
  83     };
  84     assert(type < ARRAY_SIZE(dirs));
  85
  86     const char *dir_static = dirs[type];
  87     assert(*dir_static != '\0');
  88     /* Look for common static prefix. */
  89     size_t prefix_len = 0;
  90     while (prefix_len < strlen(LIBDIR)
  91         && LIBDIR[prefix_len] == dir_static[prefix_len])
  92         prefix_len++;
  93
  94     /* Check that suffix matches between static and dynamic libdir paths. */
  95     char *filepath = NULL;
  96     size_t suffix_len = strlen(LIBDIR) - prefix_len;
  97     size_t libdir_len = strlen(libdir);
  98
  99     if (suffix_len > libdir_len
 100      || memcmp(LIBDIR + prefix_len, libdir + (libdir_len - suffix_len),
 101                suffix_len)) {
 102         suffix_len = libdir_len;
 103         prefix_len = 0;
 104     }
 105
 106     /* Graft non-common static suffix to dynamically computed common prefix. */
 107     const char *fmt = (filename != NULL) ? "%.*s%s/%s" : "%.*s%s";
 108
 109     if (unlikely(asprintf(&filepath, fmt, (int)(libdir_len - suffix_len),
 110                           libdir, dir_static + prefix_len, filename) == -1))
 111         filepath = NULL;
 112
 113     free(libdir);
 114     return filepath;
 115 }
 116
 117 static char *config_GetHomeDir (void)
 118 {
 119     /* 1/ Try $HOME  */
 120     const char *home = getenv ("HOME");
 121     if (home != NULL)
 122         return strdup (home);
 123 #if defined(HAVE_GETPWUID_R)
 124     /* 2/ Try /etc/passwd */
 125     long max = sysconf (_SC_GETPW_R_SIZE_MAX);
 126     if (max != -1)
 127     {
 128         char buf[max];
 129         struct passwd pwbuf, *pw;
 130
 131         if (getpwuid_r (getuid (), &pwbuf, buf, sizeof (buf), &pw) == 0
 132           && pw != NULL)
 133             return strdup (pw->pw_dir);
 134     }
 135 #endif
 136     return NULL;
 137 }
 138
 139 static char *config_GetAppDir (const char *xdg_name, const char *xdg_default)
 140 {
 141     char *psz_dir;
 142     char var[sizeof ("XDG__HOME") + strlen (xdg_name)];
 143
 144     /* XDG Base Directory Specification - Version 0.6 */
 145     snprintf (var, sizeof (var), "XDG_%s_HOME", xdg_name);
 146
 147     const char *home = getenv (var);
 148     if (home != NULL)
 149     {
 150         if (asprintf (&psz_dir, "%s/vlc", home) == -1)
 151             psz_dir = NULL;
 152         return psz_dir;
 153     }
 154
 155     char *psz_home = config_GetHomeDir ();
 156     if( psz_home == NULL
 157      || asprintf( &psz_dir, "%s/%s/vlc", psz_home, xdg_default ) == -1 )
 158         psz_dir = NULL;
 159     free (psz_home);
 160     return psz_dir;
 161 }
 162
 163 static char *config_GetTypeDir (const char *xdg_name)
 164 {
 165     const size_t namelen = strlen (xdg_name);
 166     const char *home = getenv ("HOME");
 167     const char *dir = getenv ("XDG_CONFIG_HOME");
 168     const char *file = "user-dirs.dirs";
 169
 170     if (home == NULL)
 171         return NULL;
 172     if (dir == NULL)
 173     {
 174         dir = home;
 175         file = ".config/user-dirs.dirs";
 176     }
 177
 178     char *path;
 179     if (asprintf (&path, "%s/%s", dir, file) == -1)
 180         return NULL;
 181
 182     FILE *stream = fopen (path, "rte");
 183     free (path);
 184     path = NULL;
 185     if (stream != NULL)
 186     {
 187         char *linebuf = NULL;
 188         size_t linelen = 0;
 189
 190         while (getline (&linebuf, &linelen, stream) != -1)
 191         {
 192             char *ptr = linebuf;
 193             ptr += strspn (ptr, " \t"); /* Skip whites */
 194             if (strncmp (ptr, "XDG_", 4))
 195                 continue;
 196             ptr += 4; /* Skip XDG_ */
 197             if (strncmp (ptr, xdg_name, namelen))
 198                 continue;
 199             ptr += namelen; /* Skip XDG type name */
 200             if (strncmp (ptr, "_DIR", 4))
 201                 continue;
 202             ptr += 4; /* Skip _DIR */
 203             ptr += strspn (ptr, " \t"); /* Skip whites */
 204             if (*ptr != '=')
 205                 continue;
 206             ptr++; /* Skip equality sign */
 207             ptr += strspn (ptr, " \t"); /* Skip whites */
 208             if (*ptr != '"')
 209                 continue;
 210             ptr++; /* Skip quote */
 211             linelen -= ptr - linebuf;
 212
 213             char *out;
 214             if (strncmp (ptr, "$HOME", 5))
 215             {
 216                 path = malloc (linelen);
 217                 if (path == NULL)
 218                     continue;
 219                 out = path;
 220             }
 221             else
 222             {   /* Prefix with $HOME */
 223                 const size_t homelen = strlen (home);
 224                 ptr += 5;
 225                 path = malloc (homelen + linelen - 5);
 226                 if (path == NULL)
 227                     continue;
 228                 memcpy (path, home, homelen);
 229                 out = path + homelen;
 230             }
 231
 232             while (*ptr != '"')
 233             {
 234                 if (*ptr == '\\')
 235                     ptr++;
 236                 if (*ptr == '\0')
 237                 {
 238                     free (path);
 239                     path = NULL;
 240                     break;
 241                 }
 242                 *(out++) = *(ptr++);
 243             }
 244             if (path != NULL)
 245                 *out = '\0';
 246             break;
 247         }
 248         free (linebuf);
 249         fclose (stream);
 250     }
 251
 252     /* Default! */
 253     if (path == NULL)
 254     {
 255         if (strcmp (xdg_name, "DESKTOP") == 0)
 256         {
 257             if (asprintf (&path, "%s/Desktop", home) == -1)
 258                 return NULL;
 259         }
 260         else
 261             path = strdup (home);
 262     }
 263
 264     return path;
 265 }
 266
 267
 268 char *config_GetUserDir (vlc_userdir_t type)
 269 {
 270     switch (type)
 271     {
 272         case VLC_HOME_DIR:
 273             break;
 274         case VLC_CONFIG_DIR:
 275             return config_GetAppDir ("CONFIG", ".config");
 276         case VLC_USERDATA_DIR:
 277             return config_GetAppDir ("DATA", ".local/share");
 278         case VLC_CACHE_DIR:
 279             return config_GetAppDir ("CACHE", ".cache");
 280
 281         case VLC_DESKTOP_DIR:
 282             return config_GetTypeDir ("DESKTOP");
 283         case VLC_DOWNLOAD_DIR:
 284             return config_GetTypeDir ("DOWNLOAD");
 285         case VLC_TEMPLATES_DIR:
 286             return config_GetTypeDir ("TEMPLATES");
 287         case VLC_PUBLICSHARE_DIR:
 288             return config_GetTypeDir ("PUBLICSHARE");
 289         case VLC_DOCUMENTS_DIR:
 290             return config_GetTypeDir ("DOCUMENTS");
 291         case VLC_MUSIC_DIR:
 292             return config_GetTypeDir ("MUSIC");
 293         case VLC_PICTURES_DIR:
 294             return config_GetTypeDir ("PICTURES");
 295         case VLC_VIDEOS_DIR:
 296             return config_GetTypeDir ("VIDEOS");
 297     }
 298     return config_GetHomeDir ();
 299 }