Add XDG_BIN_HOME support

Author: adrg

base_dirs.go

@@ -11,6 +11,9 @@ const (
 	envStateHome  = "XDG_STATE_HOME"
 	envCacheHome  = "XDG_CACHE_HOME"
 	envRuntimeDir = "XDG_RUNTIME_DIR"
+
+	// Non-standard.
+	envBinHome = "XDG_BIN_HOME"
 )
 
 type baseDirectories struct {
@@ -22,7 +25,8 @@ type baseDirectories struct {
 	cacheHome  string
 	runtime    string
 
-	// Non-standard directories.
+	// Non-standard.
+	binHome      string
 	fonts        []string
 	applications []string
 }

paths_darwin.go

@@ -30,6 +30,8 @@ func initBaseDirs(home string) {
 	baseDirs.runtime = pathutil.EnvPath(envRuntimeDir, homeAppSupport)
 
 	// Initialize non-standard directories.
+	baseDirs.binHome = pathutil.EnvPath(envBinHome, filepath.Join(home, ".local", "bin"))
+
 	baseDirs.applications = []string{
 		"/Applications",
 	}

paths_plan9.go

@@ -26,6 +26,8 @@ func initBaseDirs(home string) {
 	baseDirs.runtime = pathutil.EnvPath(envRuntimeDir, "/tmp")
 
 	// Initialize non-standard directories.
+	baseDirs.binHome = pathutil.EnvPath(envBinHome, filepath.Join(home, "bin"))
+
 	baseDirs.applications = []string{
 		filepath.Join(home, "bin"),
 		"/bin",

paths_unix.go

@@ -27,6 +27,8 @@ func initBaseDirs(home string) {
 	baseDirs.runtime = pathutil.EnvPath(envRuntimeDir, filepath.Join("/run/user", strconv.Itoa(os.Getuid())))
 
 	// Initialize non-standard directories.
+	baseDirs.binHome = pathutil.EnvPath(envBinHome, filepath.Join(home, ".local", "bin"))
+
 	appDirs := []string{
 		filepath.Join(baseDirs.dataHome, "applications"),
 		filepath.Join(home, ".local/share/applications"),

paths_windows.go

@@ -25,10 +25,17 @@ func initBaseDirs(home string, kf *knownFolders) {
 	baseDirs.runtime = pathutil.EnvPath(envRuntimeDir, kf.localAppData)
 
 	// Initialize non-standard directories.
+	baseDirs.binHome = pathutil.EnvPath(envBinHome, kf.userProgramFiles)
+
 	baseDirs.applications = []string{
 		kf.programs,
 		kf.commonPrograms,
+		kf.programFiles,
+		kf.programFilesCommon,
+		kf.userProgramFiles,
+		kf.userProgramFilesCommon,
 	}
+
 	baseDirs.fonts = []string{
 		kf.fonts,
 		filepath.Join(kf.localAppData, "Microsoft", "Windows", "Fonts"),
@@ -47,24 +54,28 @@ func initUserDirs(home string, kf *knownFolders) {
 }
 
 type knownFolders struct {
-	systemDrive    string
-	systemRoot     string
-	programData    string
-	userProfile    string
-	userProfiles   string
-	roamingAppData string
-	localAppData   string
-	desktop        string
-	downloads      string
-	documents      string
-	music          string
-	pictures       string
-	videos         string
-	templates      string
-	public         string
-	fonts          string
-	programs       string
-	commonPrograms string
+	systemDrive            string
+	systemRoot             string
+	programData            string
+	userProfile            string
+	userProfiles           string
+	roamingAppData         string
+	localAppData           string
+	desktop                string
+	downloads              string
+	documents              string
+	music                  string
+	pictures               string
+	videos                 string
+	templates              string
+	public                 string
+	fonts                  string
+	programs               string
+	commonPrograms         string
+	programFiles           string
+	programFilesCommon     string
+	userProgramFiles       string
+	userProgramFilesCommon string
 }
 
 func initKnownFolders(home string) *knownFolders {
@@ -156,6 +167,30 @@ func initKnownFolders(home string) *knownFolders {
 		nil,
 		[]string{filepath.Join(kf.programData, "Microsoft", "Windows", "Start Menu", "Programs")},
 	)
+	kf.programFiles = pathutil.KnownFolder(
+		windows.FOLDERID_ProgramFiles,
+		[]string{"ProgramFiles"},
+		[]string{filepath.Join(kf.systemDrive, "Program Files")},
+	)
+	kf.programFilesCommon = pathutil.KnownFolder(
+		windows.FOLDERID_ProgramFilesCommon,
+		nil,
+		[]string{filepath.Join(kf.programFiles, "Common Files")},
+	)
+	kf.userProgramFiles = pathutil.KnownFolder(
+		windows.FOLDERID_UserProgramFiles,
+		nil,
+		[]string{
+			filepath.Join(kf.localAppData, "Programs"),
+		},
+	)
+	kf.userProgramFilesCommon = pathutil.KnownFolder(
+		windows.FOLDERID_UserProgramFilesCommon,
+		nil,
+		[]string{
+			filepath.Join(kf.userProgramFiles, "Common"),
+		},
+	)
 
 	return kf
 }

xdg.go

@@ -67,6 +67,12 @@ var (
 	// swapped out to disk.
 	RuntimeDir string
 
+	// BinHome defines the base directory relative to which user-specific
+	// binary files should be written. This directory is defined by
+	// the non-standard $XDG_BIN_HOME environment variable. If the variable is
+	// not set, a default equal to $HOME/.local/bin should be used.
+	BinHome string
+
 	// UserDirs defines the locations of well known user directories.
 	UserDirs UserDirectories
 
@@ -104,6 +110,7 @@ func Reload() {
 	RuntimeDir = baseDirs.runtime
 
 	// Set non-standard directories.
+	BinHome = baseDirs.binHome
 	FontDirs = baseDirs.fonts
 	ApplicationDirs = baseDirs.applications
 }