]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
settings: Add XDG support helper functions
authorOlliver Schinagl <oliver@schinagl.nl>
Sat, 10 Jun 2023 13:39:56 +0000 (15:39 +0200)
committerFlole998 <Flole998@users.noreply.github.com>
Fri, 16 Jun 2023 11:11:41 +0000 (13:11 +0200)
The XDG spec goes beyond the '.config' directory structure, but also
helps with other directories, which may be locale dependent.

Sadly, the upstream source that does all the parsing, is not a library,
but only a binary or source code.

Lets store a copy of the source-code under vendor, to avoid duplicating
the exact same code internally.

Expose these functions as hts wrappers for the rest of the codebase to
use.

Signed-off-by: Olliver Schinagl <oliver@schinagl.nl>
src/settings.c
src/settings.h
vendor/xdg-user-dirs/xdg-user-dir-lookup.c [new file with mode: 0644]

index 3bc2afb2af3818dd940b789051bcc56c946792e4..da98a249a49021a87bb42d1b0a82615b532920e2 100644 (file)
@@ -35,6 +35,8 @@
 #include "tvheadend.h"
 #include "filebundle.h"
 
+#include "../vendor/xdg-user-dirs/xdg-user-dir-lookup.c"
+
 static char *settingspath = NULL;
 
 /**
@@ -442,3 +444,18 @@ hts_settings_exists ( const char *pathfmt, ... )
 
   return (stat(path, &st) == 0);
 }
+
+/*
+ * XDG user directory support
+ */
+char *
+hts_settings_get_xdg_dir_lookup (const char *name)
+{
+  return xdg_user_dir_lookup (name);
+}
+
+char *
+hts_settings_get_xdg_dir_with_fallback (const char *name, const char *fallback)
+{
+  return xdg_user_dir_lookup_with_fallback (name, fallback);
+}
index 4bdb0f69bd210218b51981071b19f30eb0ff4a2d..bf852462811c534e00493c399402d41b2b98be61 100644 (file)
@@ -48,4 +48,7 @@ int hts_settings_makedirs ( const char *path );
 
 int hts_settings_exists ( const char *pathfmt, ... );
 
-#endif /* HTSSETTINGS_H__ */ 
+char *hts_settings_get_xdg_dir_lookup (const char *name);
+char *hts_settings_get_xdg_dir_with_fallback (const char *name, const char *fallback);
+
+#endif /* HTSSETTINGS_H__ */
diff --git a/vendor/xdg-user-dirs/xdg-user-dir-lookup.c b/vendor/xdg-user-dirs/xdg-user-dir-lookup.c
new file mode 100644 (file)
index 0000000..676af46
--- /dev/null
@@ -0,0 +1,233 @@
+/*
+  This file is not licenced under the GPL like the rest of the code.
+  Its is under the MIT license, to encourage reuse by cut-and-paste.
+
+  Copyright (c) 2007 Red Hat, Inc.
+
+  Permission is hereby granted, free of charge, to any person
+  obtaining a copy of this software and associated documentation files
+  (the "Software"), to deal in the Software without restriction,
+  including without limitation the rights to use, copy, modify, merge,
+  publish, distribute, sublicense, and/or sell copies of the Software,
+  and to permit persons to whom the Software is furnished to do so,
+  subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+/**
+ * xdg_user_dir_lookup_with_fallback:
+ * @type: a string specifying the type of directory
+ * @fallback: value to use if the directory isn't specified by the user
+ * @returns: a newly allocated absolute pathname
+ *
+ * Looks up a XDG user directory of the specified type.
+ * Example of types are "DESKTOP" and "DOWNLOAD".
+ *
+ * In case the user hasn't specified any directory for the specified
+ * type the value returned is @fallback.
+ *
+ * The return value is newly allocated and must be freed with
+ * free(). The return value is never NULL if @fallback != NULL, unless
+ * out of memory.
+ **/
+static char *
+xdg_user_dir_lookup_with_fallback (const char *type, const char *fallback)
+{
+  FILE *file;
+  char *home_dir, *config_home, *config_file;
+  char buffer[512];
+  char *user_dir;
+  char *p, *d;
+  int len;
+  int relative;
+
+  home_dir = getenv ("HOME");
+
+  if (home_dir == NULL)
+    goto error;
+
+  config_home = getenv ("XDG_CONFIG_HOME");
+  if (config_home == NULL || config_home[0] == 0)
+    {
+      config_file = (char*) malloc (strlen (home_dir) + strlen ("/.config/user-dirs.dirs") + 1);
+      if (config_file == NULL)
+        goto error;
+
+      strcpy (config_file, home_dir);
+      strcat (config_file, "/.config/user-dirs.dirs");
+    }
+  else
+    {
+      config_file = (char*) malloc (strlen (config_home) + strlen ("/user-dirs.dirs") + 1);
+      if (config_file == NULL)
+        goto error;
+
+      strcpy (config_file, config_home);
+      strcat (config_file, "/user-dirs.dirs");
+    }
+
+  file = fopen (config_file, "r");
+  free (config_file);
+  if (file == NULL)
+    goto error;
+
+  user_dir = NULL;
+  while (fgets (buffer, sizeof (buffer), file))
+    {
+      /* Remove newline at end */
+      len = strlen (buffer);
+      if (len > 0 && buffer[len-1] == '\n')
+        buffer[len-1] = 0;
+
+      p = buffer;
+      while (*p == ' ' || *p == '\t')
+        p++;
+
+      if (strncmp (p, "XDG_", 4) != 0)
+        continue;
+      p += 4;
+      if (strncmp (p, type, strlen (type)) != 0)
+        continue;
+      p += strlen (type);
+      if (strncmp (p, "_DIR", 4) != 0)
+        continue;
+      p += 4;
+
+      while (*p == ' ' || *p == '\t')
+        p++;
+
+      if (*p != '=')
+        continue;
+      p++;
+
+      while (*p == ' ' || *p == '\t')
+        p++;
+
+      if (*p != '"')
+        continue;
+      p++;
+
+      relative = 0;
+      if (strncmp (p, "$HOME/", 6) == 0)
+        {
+          p += 6;
+          relative = 1;
+        }
+      else if (*p != '/')
+        continue;
+
+      free (user_dir);
+      if (relative)
+        {
+          user_dir = (char*) malloc (strlen (home_dir) + 1 + strlen (p) + 1);
+          if (user_dir == NULL)
+            goto error2;
+
+          strcpy (user_dir, home_dir);
+          strcat (user_dir, "/");
+        }
+      else
+        {
+          user_dir = (char*) malloc (strlen (p) + 1);
+          if (user_dir == NULL)
+            goto error2;
+
+          *user_dir = 0;
+        }
+
+      d = user_dir + strlen (user_dir);
+      while (*p && *p != '"')
+        {
+          if ((*p == '\\') && (*(p+1) != 0))
+            p++;
+          *d++ = *p++;
+        }
+      *d = 0;
+    }
+error2:
+  fclose (file);
+
+  if (user_dir)
+    return user_dir;
+
+ error:
+  if (fallback)
+    return strdup (fallback);
+  return NULL;
+}
+
+/**
+ * xdg_user_dir_lookup:
+ * @type: a string specifying the type of directory
+ * @returns: a newly allocated absolute pathname
+ *
+ * Looks up a XDG user directory of the specified type.
+ * Example of types are "DESKTOP" and "DOWNLOAD".
+ *
+ * The return value is always != NULL (unless out of memory),
+ * and if a directory
+ * for the type is not specified by the user the default
+ * is the home directory. Except for DESKTOP which defaults
+ * to ~/Desktop.
+ *
+ * The return value is newly allocated and must be freed with
+ * free().
+ **/
+static char *
+xdg_user_dir_lookup (const char *type)
+{
+  char *dir, *home_dir, *user_dir;
+
+  dir = xdg_user_dir_lookup_with_fallback (type, NULL);
+  if (dir != NULL)
+    return dir;
+
+  home_dir = getenv ("HOME");
+
+  if (home_dir == NULL)
+    return strdup ("/tmp");
+
+  /* Special case desktop for historical compatibility */
+  if (strcmp (type, "DESKTOP") == 0)
+    {
+      user_dir = (char*) malloc (strlen (home_dir) + strlen ("/Desktop") + 1);
+      if (user_dir == NULL)
+        return NULL;
+
+      strcpy (user_dir, home_dir);
+      strcat (user_dir, "/Desktop");
+      return user_dir;
+    }
+
+  return strdup (home_dir);
+}
+
+#ifdef STANDALONE_XDG_USER_DIR_LOOKUP
+int
+main (int argc, char *argv[])
+{
+  if (argc != 2)
+    {
+      fprintf (stderr, "Usage %s <dir-type>\n", argv[0]);
+      exit (1);
+    }
+
+  printf ("%s\n", xdg_user_dir_lookup (argv[1]));
+  return 0;
+}
+#endif