Dan Anglin
42251f6df8
SUMMARY
This commit adds configuration support to enbas. The configuration is
stored as a JSON file in the user specified configuration directory.
When using enbas for the first time, the user will first need to
execute the new init command in order to generate the configuration.
Once this has been generated the user can edit the settings to
personalise their experience, login to their account and use enbas as
normal.
For now the configurable settings included in the configuration
are as follows:
- The path to the credentials file (by default this is set to a file in
the same directory as the configuration file).
- The path to the cache directory.
- The character limit used for line wrapping.
- The programs used for integrations such as paging, media viewing,
opening URLs, etc.
CHANGES
- added the new config type.
- added the new init executor for generating a new configuration file.
- removed the following top level flags in favour of the new
configration support.
- cache-dir
- pager
- image-viewer
- video-player
- max-terminal-width
- added a new error type for use when an unknown media attachment ID
is specified.
- updated the usage function for the executors to support a case
where a flagsets has no flags.
- update .golangci.yaml to disable some linters
108 lines
2.4 KiB
Go
108 lines
2.4 KiB
Go
// SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
|
|
//
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
package config
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"codeflow.dananglin.me.uk/apollo/enbas/internal/utilities"
|
|
)
|
|
|
|
const (
|
|
configFileName = "config.json"
|
|
)
|
|
|
|
type Config struct {
|
|
CredentialsFile string `json:"credentialsFile"`
|
|
CacheDirectory string `json:"cacheDirectory"`
|
|
LineWrapMaxWidth int `json:"lineWrapMaxWidth"`
|
|
HTTP HTTPConfig `json:"http"`
|
|
Integrations Integrations `json:"integrations"`
|
|
}
|
|
|
|
type HTTPConfig struct {
|
|
Timeout int `json:"timeout"`
|
|
MediaTimeout int `json:"mediaTimeout"`
|
|
}
|
|
|
|
type Integrations struct {
|
|
Browser string `json:"browser"`
|
|
Editor string `json:"editor"`
|
|
Pager string `json:"pager"`
|
|
ImageViewer string `json:"imageViewer"`
|
|
VideoPlayer string `json:"videoPlayer"`
|
|
}
|
|
|
|
func NewConfigFromFile(configDir string) (*Config, error) {
|
|
path := configFile(configDir)
|
|
|
|
file, err := os.Open(path)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to open %s: %w", path, err)
|
|
}
|
|
defer file.Close()
|
|
|
|
var config Config
|
|
|
|
if err := json.NewDecoder(file).Decode(&config); err != nil {
|
|
return nil, fmt.Errorf("unable to decode the JSON data: %w", err)
|
|
}
|
|
|
|
return &config, nil
|
|
}
|
|
|
|
func FileExists(configDir string) (bool, error) {
|
|
path := configFile(configDir)
|
|
|
|
return utilities.FileExists(path)
|
|
}
|
|
|
|
func SaveDefaultConfigToFile(configDir string) error {
|
|
path := configFile(configDir)
|
|
|
|
file, err := os.Create(path)
|
|
if err != nil {
|
|
return fmt.Errorf("unable to create the file at %s: %w", path, err)
|
|
}
|
|
defer file.Close()
|
|
|
|
config := defaultConfig(configDir)
|
|
encoder := json.NewEncoder(file)
|
|
encoder.SetIndent("", " ")
|
|
|
|
if err := encoder.Encode(config); err != nil {
|
|
return fmt.Errorf("unable to save the JSON data to the config file: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func configFile(configDir string) string {
|
|
return filepath.Join(utilities.CalculateConfigDir(configDir), configFileName)
|
|
}
|
|
|
|
func defaultConfig(configDir string) Config {
|
|
credentialsFilePath := defaultCredentialsConfigFile(configDir)
|
|
|
|
return Config{
|
|
CredentialsFile: credentialsFilePath,
|
|
CacheDirectory: "",
|
|
HTTP: HTTPConfig{
|
|
Timeout: 5,
|
|
MediaTimeout: 30,
|
|
},
|
|
LineWrapMaxWidth: 80,
|
|
Integrations: Integrations{
|
|
Browser: "",
|
|
Editor: "",
|
|
Pager: "",
|
|
ImageViewer: "",
|
|
VideoPlayer: "",
|
|
},
|
|
}
|
|
}
|