Commit 0a70455095a19a4c18497e6786ca6139c1cc2892 | zig

author	Ian Johnson <ian@ianjohnson.dev> 2024-08-19 23:11:32-04:00
committer	Andrew Kelley <andrew@ziglang.org> 2024-08-19 23:30:14-07:00
log	0a70455095a19a4c18497e6786ca6139c1cc2892
tree	e3b5ca0499e459ac413a2e4152dcae5ad6a9b833
parent	dffc8c44f9a01aa05ea364ffdc71509d15bc2601

Fix handling of empty XDG environment variables

Closes #21132

According to the XDG Base Directory specification
(https://specifications.freedesktop.org/basedir-spec/latest/#variables),
empty values for these environment variables should be treated the same
as if they are unset. Specifically, for the instances changed in this
commit,

> $XDG_DATA_HOME defines the base directory relative to which
> user-specific data files should be stored. If $XDG_DATA_HOME is either
> not set **or empty**, a default equal to $HOME/.local/share should be
> used.

and

> $XDG_CACHE_HOME defines the base directory relative to which
> user-specific non-essential data files should be stored. If
> $XDG_CACHE_HOME is either not set **or empty**, a default equal to
> $HOME/.cache should be used.

(emphasis mine)

In addition to the case mentioned in the linked issue, all other uses of
XDG environment variables were corrected.

3 files changed, 13 insertions(+), 6 deletions(-)

lib
- std
  - debug
    Dwarf.zig
  - fs
    get_app_data_dir.zig
src
- introspect.zig

lib/std/debug/Dwarf.zig+5-3

 @@ -2275,9 +2275,11 @@ pub const ElfModule = struct {
                             break :dir std.fs.openDirAbsolute(path, .{}) catch break :blk;
                         }
                         if (std.posix.getenv("XDG_CACHE_HOME")) |cache_path| {
-                            const path = std.fs.path.join(gpa, &[_][]const u8{ cache_path, "debuginfod_client" }) catch break :blk;
+                            if (cache_path.len > 0) {
-                            defer gpa.free(path);
+                                const path = std.fs.path.join(gpa, &[_][]const u8{ cache_path, "debuginfod_client" }) catch break :blk;
-                            break :dir std.fs.openDirAbsolute(path, .{}) catch break :blk;
+                                defer gpa.free(path);
+                                break :dir std.fs.openDirAbsolute(path, .{}) catch break :blk;
+                            }
                         }
                         if (std.posix.getenv("HOME")) |home_path| {
                             const path = std.fs.path.join(gpa, &[_][]const u8{ home_path, ".cache", "debuginfod_client" }) catch break :blk;

lib/std/fs/get_app_data_dir.zig+3-1

 @@ -32,7 +32,9 @@ pub fn getAppDataDir(allocator: mem.Allocator, appname: []const u8) GetAppDataDi
         },
         .linux, .freebsd, .netbsd, .dragonfly, .openbsd, .solaris, .illumos => {
             if (posix.getenv("XDG_DATA_HOME")) |xdg| {
-                return fs.path.join(allocator, &[_][]const u8{ xdg, appname });
+                if (xdg.len > 0) {
+                    return fs.path.join(allocator, &[_][]const u8{ xdg, appname });
+                }
             }
             const home_dir = posix.getenv("HOME") orelse {

src/introspect.zig+5-2

 @@ -90,8 +90,11 @@ pub fn resolveGlobalCacheDir(allocator: mem.Allocator) ![]u8 {
     if (builtin.os.tag != .windows) {
         if (std.zig.EnvVar.XDG_CACHE_HOME.getPosix()) |cache_root| {
-            return fs.path.join(allocator, &[_][]const u8{ cache_root, appname });
+            if (cache_root.len > 0) {
-        } else if (std.zig.EnvVar.HOME.getPosix()) |home| {
+                return fs.path.join(allocator, &[_][]const u8{ cache_root, appname });
+            }
+        }
+        if (std.zig.EnvVar.HOME.getPosix()) |home| {
             return fs.path.join(allocator, &[_][]const u8{ home, ".cache", appname });
         }
     }