Locate config file

Signed-off-by: Bryan Frimin <bryan@getprobo.com>

Author: gearnode

CHANGELOG.md

@@ -29,6 +29,10 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - The CLI now works without a configuration file, falling back to sensible
   defaults (expire: 1day, formatter: plaintext, gzip: enabled).
+- Configuration file lookup now follows the XDG Base Directory Specification.
+  The CLI searches `$HOME/.config/privatebin/config.json`, then
+  `$XDG_CONFIG_HOME/privatebin/config.json`, the platform-native user config
+  directory, and finally `$XDG_CONFIG_DIRS` (defaults to `/etc/xdg`).
 - Remove duplicate error output in the main function.
 
 ### Security

cmd/privatebin/main.go

@@ -24,7 +24,6 @@ import (
 	"io"
 	"net/url"
 	"os"
-	"path"
 	"path/filepath"
 	"strings"
 
@@ -82,12 +81,12 @@ var (
 			}
 
 			if cfgPath == "" {
-				homeDir, err := os.UserHomeDir()
+				p, err := locateConfigFile()
 				if err != nil {
-					return fmt.Errorf("cannot get user home directory: %w", err)
+					return err
 				}
 
-				cfgPath = path.Join(homeDir, ".config", "privatebin", "config.json")
+				cfgPath = p
 			}
 
 			cfg, err := loadCfgFile(cfgPath)
@@ -225,18 +224,18 @@ var (
 					)
 				}
 
-			_ = json.NewEncoder(os.Stdout).Encode(
-				map[string]any{
-					"paste_id": result.PasteID,
-					"paste": map[string]string{
-						"attachment_name": result.Paste.AttachmentName,
-						"attachment":      base64.StdEncoding.EncodeToString(result.Paste.Attachment),
-						"data":            base64.StdEncoding.EncodeToString(result.Paste.Data),
+				_ = json.NewEncoder(os.Stdout).Encode(
+					map[string]any{
+						"paste_id": result.PasteID,
+						"paste": map[string]string{
+							"attachment_name": result.Paste.AttachmentName,
+							"attachment":      base64.StdEncoding.EncodeToString(result.Paste.Attachment),
+							"data":            base64.StdEncoding.EncodeToString(result.Paste.Data),
+						},
+						"comment_count": result.CommentCount,
+						"comments":      comments,
 					},
-					"comment_count": result.CommentCount,
-					"comments":      comments,
-				},
-			)
+				)
 			}
 			return nil
 		},
@@ -323,15 +322,15 @@ var (
 
 			switch output {
 			case "":
-			_, _ = fmt.Fprintf(os.Stdout, "%s\n", result.PasteURL.String())
+				_, _ = fmt.Fprintf(os.Stdout, "%s\n", result.PasteURL.String())
 			case "json":
-			_ = json.NewEncoder(os.Stdout).Encode(
-				map[string]any{
-					"paste_id":     result.PasteID,
-					"paste_url":    result.PasteURL.String(),
-					"delete_token": result.DeleteToken,
-				},
-			)
+				_ = json.NewEncoder(os.Stdout).Encode(
+					map[string]any{
+						"paste_id":     result.PasteID,
+						"paste_url":    result.PasteURL.String(),
+						"delete_token": result.DeleteToken,
+					},
+				)
 			}
 
 			return nil
@@ -344,12 +343,12 @@ var (
 		SilenceUsage: true,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 			if cfgPath == "" {
-				homeDir, err := os.UserHomeDir()
+				p, err := locateConfigFile()
 				if err != nil {
-					return fmt.Errorf("cannot get user home directory: %w", err)
+					return err
 				}
 
-				cfgPath = path.Join(homeDir, ".config", "privatebin", "config.json")
+				cfgPath = p
 			}
 
 			return nil
@@ -396,9 +395,69 @@ var (
 	}
 )
 
+func configFileCandidates() ([]string, error) {
+	var candidates []string
+	seen := make(map[string]bool)
+
+	add := func(p string) {
+		if !seen[p] {
+			seen[p] = true
+			candidates = append(candidates, p)
+		}
+	}
+
+	// $HOME/.config: conventional location for CLI tools.
+	if home, err := os.UserHomeDir(); err == nil {
+		add(filepath.Join(home, ".config", "privatebin", "config.json"))
+	}
+
+	// XDG_CONFIG_HOME: user-specific config directory override.
+	if dir := os.Getenv("XDG_CONFIG_HOME"); dir != "" {
+		add(filepath.Join(dir, "privatebin", "config.json"))
+	}
+
+	// Platform-native user config directory.
+	if dir, err := os.UserConfigDir(); err == nil {
+		add(filepath.Join(dir, "privatebin", "config.json"))
+	}
+
+	// XDG_CONFIG_DIRS: system-wide config directories (default /etc/xdg).
+	xdgDirs := os.Getenv("XDG_CONFIG_DIRS")
+	if xdgDirs == "" {
+		xdgDirs = "/etc/xdg"
+	}
+	for _, dir := range filepath.SplitList(xdgDirs) {
+		if dir != "" {
+			add(filepath.Join(dir, "privatebin", "config.json"))
+		}
+	}
+
+	if len(candidates) == 0 {
+		return nil, fmt.Errorf("cannot determine configuration file location")
+	}
+
+	return candidates, nil
+}
+
+func locateConfigFile() (string, error) {
+	candidates, err := configFileCandidates()
+	if err != nil {
+		return "", err
+	}
+
+	for _, path := range candidates {
+		if _, err := os.Stat(path); err == nil {
+			return path, nil
+		}
+	}
+
+	// No existing file found; return the preferred default for creation.
+	return candidates[0], nil
+}
+
 func init() {
 	rootCmd.PersistentFlags().StringVarP(&output, "output", "o", "", "the command output format")
-	rootCmd.PersistentFlags().StringVarP(&cfgPath, "config", "c", "", "the config file (default is $HOME/.config/privatebin/config.json)")
+	rootCmd.PersistentFlags().StringVarP(&cfgPath, "config", "c", "", "the config file (default is ~/.config/privatebin/config.json)")
 	rootCmd.PersistentFlags().StringVarP(&binName, "bin", "b", "", "the name of the privatebin instance to use (default \"\")")
 	rootCmd.PersistentFlags().StringSliceVarP(&extraHeaderFields, "header", "H", []string{}, "extra HTTP header fields to include in the request sent")
 	rootCmd.PersistentFlags().StringVar(&proxy, "proxy", "", "proxy URL to use for requests (e.g. socks5://127.0.0.1:9050 for TOR)")

doc/privatebin-init.1.md

@@ -13,8 +13,9 @@ section: 1
 
 # DESCRIPTION
 Generate a configuration file with sensible defaults and write it to
-the default location at _~/.config/privatebin/config.json_. If the
-**-\-config** flag is set, the file is written to that path instead.
+the preferred default location at _~/.config/privatebin/config.json_.
+If the **-\-config** flag is set, the file is written to that path
+instead.
 
 The generated configuration contains a single bin entry pointing to the
 host specified by **-\-host** (defaulting to _https://privatebin.net_),

doc/privatebin.1.md

@@ -29,8 +29,11 @@ instances.
 : The privatebin instance name.
 
 **-c, -\-config** \<path\>
-: The path of the configuration file (default
-  "~/.config/privatebin/config.json").
+: The path of the configuration file. When not set, the CLI searches
+  _$HOME/.config/privatebin/config.json_, then
+  _$XDG\_CONFIG\_HOME/privatebin/config.json_, the platform-native user
+  configuration directory, and finally the directories listed in
+  **$XDG\_CONFIG\_DIRS** (see **privatebin.conf**(5) for details).
 
 **-H, -\-header** \<key=value\>
 : The extra HTTP header fields to include in the request sent.
@@ -67,6 +70,17 @@ Create a paste through a SOCKS5 proxy (e.g. TOR):
 
 # ENVIRONMENT
 
+**XDG\_CONFIG\_HOME**
+: User-specific configuration directory. When set, the CLI searches
+  this directory for _privatebin/config.json_ (after checking
+  _$HOME/.config_). See **privatebin.conf**(5) for the full search
+  order.
+
+**XDG\_CONFIG\_DIRS**
+: Colon-separated list of system-wide configuration directories.
+  Defaults to _/etc/xdg_ when not set. Each directory is searched for
+  _privatebin/config.json_.
+
 **HTTP_PROXY**, **HTTPS_PROXY**, **ALL_PROXY**
 : When no **-\-proxy** flag is provided and no **proxy** configuration
   value is set, the standard proxy environment variables are honored.

doc/privatebin.conf.5.md

@@ -147,11 +147,20 @@ Configuration using a SOCKS5 proxy (e.g. TOR):
 
 # FILES
 
-_~/.config/privatebin/config.json_
-: Default location of the privatebin configuration. The file has to be
-created manually as it is not installed with a standard installation.
-The configuration file is optional; when absent, the CLI uses sensible
-defaults (expire: 1day, formatter: plaintext, gzip: enabled).
+The CLI searches for the configuration file in the following locations,
+in order, and uses the first one found:
+
+1. _$HOME/.config/privatebin/config.json_
+2. _$XDG\_CONFIG\_HOME/privatebin/config.json_ (if **XDG\_CONFIG\_HOME** is set)
+3. The platform-native user configuration directory (as returned by
+   Go's **os.UserConfigDir**): _$HOME/.config_ on Linux,
+   _$HOME/Library/Application Support_ on macOS, _%AppData%_ on Windows
+4. Each directory in **$XDG\_CONFIG\_DIRS** (defaults to _/etc/xdg_)
+
+Duplicate paths are skipped. When no **-\-config** flag is provided and
+no file is found, the CLI falls back to sensible defaults (expire:
+1day, formatter: plaintext, gzip: enabled). The **privatebin init**
+command writes to the first candidate path by default.
 
 # AUTHORS