config

Documentation

Overview

Package config handles loading and validating the kcd daemon configuration. It has zero external imports except github.com/BurntSushi/toml.

Index

• func DefaultConfigPath() string
• func DefaultSocketPath() string
• func StatePath() string
• type BatteryConfig
  • func (c *BatteryConfig) Defaults()
• type Config
  • func Defaults() *Config
  • func Load(path string) (*Config, error)
  • func (c *Config) EnsureDeviceID(configPath string) error
  • func (c *Config) Save(path string) error
  • func (c *Config) Validate() error
• type MousepadConfig
  • func (c *MousepadConfig) Defaults()
• type NotificationConfig
• type NotificationPluginConfig
  • func (c *NotificationPluginConfig) Defaults()
• type PairingConfig
  • func (c *PairingConfig) Defaults()
• type PingConfig
  • func (c *PingConfig) Defaults()
• type PluginConfig
  • func (p *PluginConfig) Defaults()
• type SFTPConfig
  • func (c *SFTPConfig) Defaults()
• type SMSConfig
  • func (c *SMSConfig) Defaults()
• type ShareConfig
  • func (c *ShareConfig) Defaults()

Functions

func DefaultConfigPath

func DefaultConfigPath() string

DefaultConfigPath returns the default config file path.

func DefaultSocketPath

func DefaultSocketPath() string

DefaultSocketPath returns the default IPC socket path.

func StatePath

func StatePath() string

StatePath returns the path to the device state file.

Types

type BatteryConfig

type BatteryConfig struct {
	NotifyLow   bool   `toml:"notify_low"`
	NotifyFull  bool   `toml:"notify_full"`
	LowUrgency  string `toml:"low_urgency"`
	FullUrgency string `toml:"full_urgency"`
	LowMessage  string `toml:"low_message"`
	FullMessage string `toml:"full_message"`
}

func (*BatteryConfig) Defaults

func (c *BatteryConfig) Defaults()

type Config

type Config struct {
	DeviceID    string `toml:"device_id"`
	DeviceName  string `toml:"device_name"`
	DeviceType  string `toml:"device_type"` // "desktop", "laptop", "phone", "tablet"
	CertFile    string `toml:"cert_file"`
	KeyFile     string `toml:"key_file"`
	SocketPath  string `toml:"socket_path"`
	DownloadDir string `toml:"download_dir"`
	TCPPort     int    `toml:"tcp_port"`
	// EnableBroadcast was removed — broadcast starts automatically with `kcd pair` (listen mode)
	LogLevel string `toml:"log_level"` // "debug", "info", "warn", "error" (or "quiet")
	// AutoAcceptPairing was removed in favor of `kcd pair` (listen mode).
	// Old config values are silently ignored by the TOML parser.
	Plugins       PluginConfig             `toml:"plugins"`
	Commands      map[string]string        `toml:"commands"`
	Notifications NotificationConfig       `toml:"notifications"`
	Battery       BatteryConfig            `toml:"battery"`
	Notification  NotificationPluginConfig `toml:"notification_plugin"`
	Share         ShareConfig              `toml:"share"`
	SFTP          SFTPConfig               `toml:"sftp"`
	Ping          PingConfig               `toml:"ping"`
	Pairing       PairingConfig            `toml:"pairing"`
	Mousepad      MousepadConfig           `toml:"mousepad"`
	SMS           SMSConfig                `toml:"sms"`
	ConfigPath    string                   `toml:"-"` // populated at load time, never written to disk
}

Config holds all daemon configuration.

func Defaults

func Defaults() *Config

Defaults returns a Config populated with sensible defaults using XDG paths.

func Load

func Load(path string) (*Config, error)

Load reads a TOML config file and merges it with defaults.

func (*Config) EnsureDeviceID

func (c *Config) EnsureDeviceID(configPath string) error

EnsureDeviceID generates a UUIDv4-style device ID if one is not already set, and writes the updated config back to the given path.

func (*Config) Save

func (c *Config) Save(path string) error

Save writes the config to a TOML file, creating parent directories as needed.

func (*Config) Validate

func (c *Config) Validate() error

Validate checks required fields and returns an error if any are invalid.

type MousepadConfig

type MousepadConfig struct {
	Backend string `toml:"backend"`
}

func (*MousepadConfig) Defaults

func (c *MousepadConfig) Defaults()

type NotificationConfig

type NotificationConfig map[string]string

NotificationConfig controls per-app notification filtering.

type NotificationPluginConfig

type NotificationPluginConfig struct {
	Urgency          string `toml:"urgency"`
	FetchIcons       bool   `toml:"fetch_icons"`
	IconCacheDir     string `toml:"icon_cache_dir"`
	MaxBodyLength    int    `toml:"max_body_length"`
	ExpireMS         int    `toml:"expire_ms"`
	SkipNonClearable bool   `toml:"skip_non_clearable"`
}

func (*NotificationPluginConfig) Defaults

func (c *NotificationPluginConfig) Defaults()

type PairingConfig

type PairingConfig struct {
	TimeoutSecs int `toml:"timeout_secs"`
}

func (*PairingConfig) Defaults

func (c *PairingConfig) Defaults()

type PingConfig

type PingConfig struct {
	AppName        string `toml:"app_name"`
	Icon           string `toml:"icon"`
	DefaultMessage string `toml:"default_message"`
}

func (*PingConfig) Defaults

func (c *PingConfig) Defaults()

type PluginConfig

type PluginConfig struct {
	Battery        bool `toml:"battery"`
	Clipboard      bool `toml:"clipboard"`
	Notification   bool `toml:"notification"`
	Share          bool `toml:"share"`
	RunCommand     bool `toml:"runcommand"`
	MPRIS          bool `toml:"mpris"`
	Ping           bool `toml:"ping"`
	Telephony      bool `toml:"telephony"`
	Connectivity   bool `toml:"connectivity"`
	Mousepad       bool `toml:"mousepad"`
	SFTP           bool `toml:"sftp"`
	FindMyPhone    bool `toml:"findmyphone"`
	LockDevice     bool `toml:"lockdevice"`
	SystemVolume   bool `toml:"systemvolume"`
	PauseMusic     bool `toml:"pausemusic"`
	SMS            bool `toml:"sms"`
	Presenter      bool `toml:"presenter"`
	FindThisDevice bool `toml:"findthisdevice"`
}

func (*PluginConfig) Defaults

func (p *PluginConfig) Defaults()

type SFTPConfig

type SFTPConfig struct {
	MountDir               string   `toml:"mount_dir"`
	CredentialsTimeoutSecs int      `toml:"credentials_timeout_secs"`
	KeepaliveIntervalSecs  int      `toml:"keepalive_interval_secs"`
	KeepaliveCount         int      `toml:"keepalive_count"`
	AutoOpen               bool     `toml:"auto_open"`
	OpenCommand            string   `toml:"open_command"`
	ExtraSshfsOpts         []string `toml:"extra_sshfs_opts"`
}

func (*SFTPConfig) Defaults

func (c *SFTPConfig) Defaults()

type SMSConfig

type SMSConfig struct {
	// NotifyIncoming shows a desktop notification when an SMS is received.
	NotifyIncoming bool `toml:"notify_incoming"`
}

func (*SMSConfig) Defaults

func (c *SMSConfig) Defaults()

type ShareConfig

type ShareConfig struct {
	PortMin           int    `toml:"port_min"`
	PortMax           int    `toml:"port_max"`
	AcceptTimeoutSecs int    `toml:"accept_timeout_secs"`
	AutoOpen          bool   `toml:"auto_open"`
	OpenCommand       string `toml:"open_command"`
	Overwrite         bool   `toml:"overwrite"`
}

func (*ShareConfig) Defaults

func (c *ShareConfig) Defaults()