mugit/internal/config/config.go(view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
package config
import (
"errors"
"fmt"
"os"
"path/filepath"
"time"
"gopkg.in/yaml.v2"
)
var ErrConfigNotFound = errors.New("no config file found")
type ServerConfig struct {
Host string `yaml:"host"`
Port int `yaml:"port"`
}
type MetaConfig struct {
Title string `yaml:"title"`
Description string `yaml:"description"`
Host string `yaml:"host"`
}
type RepoConfig struct {
Dir string `yaml:"dir"`
Readmes []string `yaml:"readmes"`
Masters []string `yaml:"masters"`
}
type SSHConfig struct {
Enable bool `yaml:"enable"`
Port int `yaml:"port"`
HostKey string `yaml:"host_key"`
Keys []string `yaml:"keys"`
}
type MirrorConfig struct {
Enable bool `yaml:"enable"`
Interval string `yaml:"interval"`
GithubToken string `yaml:"github_token"`
}
type Config struct {
Server ServerConfig `yaml:"server"`
Meta MetaConfig `yaml:"meta"`
Repo RepoConfig `yaml:"repo"`
SSH SSHConfig `yaml:"ssh"`
Mirror MirrorConfig `yaml:"mirror"`
}
// Load loads configuration with the following priority:
// 1. User provided fpath (if provided and exists)
// 2. /var/lib/mugit/config.yaml
// 3. $XDG_CONFIG_HOME/mugit/config.yaml or $HOME/.config/mugit/config.yaml
func Load(fpath string) (*Config, error) {
// 4. /etc/mugit/config.yaml
configPath, err := findConfigFile(fpath)
if err != nil {
return nil, err
}
configBytes, err := os.ReadFile(configPath)
if err != nil {
return nil, err
}
var config Config
if cerr := yaml.Unmarshal(configBytes, &config); cerr != nil {
return nil, fmt.Errorf("parsing config: %w", cerr)
}
if config.Repo.Dir, err = filepath.Abs(config.Repo.Dir); err != nil {
return nil, err
}
config.ensureDefaults()
if verr := config.validate(); verr != nil {
return nil, verr
}
return &config, nil
}
func (c *Config) ensureDefaults() {
// ports
if c.Server.Port == 0 {
c.Server.Port = 8080
}
if c.SSH.Port == 0 {
c.SSH.Port = 2222
}
// meta
if c.Meta.Title == "" {
c.Meta.Title = "my cgit"
}
// repos
if len(c.Repo.Masters) == 0 {
c.Repo.Masters = []string{"master", "main"}
}
if len(c.Repo.Readmes) == 0 {
c.Repo.Readmes = []string{
"README.md", "readme.md",
"README.html", "readme.html",
"README.txt", "readme.txt",
"readme",
}
}
// mirroring
if c.Mirror.Interval == "" {
c.Mirror.Interval = "8h"
}
}
func (c Config) validate() error {
var errs []error
// server
if err := validatePort(c.Server.Port, "server.port"); err != nil {
errs = append(errs, err)
}
// meta
if c.Meta.Host == "" {
errs = append(errs, errors.New("meta.host is required"))
}
// repo
if err := validateDirExists(c.Repo.Dir, "repo.dir"); err != nil {
errs = append(errs, err)
}
if len(c.Repo.Readmes) == 0 {
errs = append(errs, errors.New("repo.readmes must have at least one value"))
}
if len(c.Repo.Masters) == 0 {
errs = append(errs, errors.New("repo.masters must have at least one value"))
}
// ssh
if c.SSH.Enable {
if err := validatePort(c.SSH.Port, "ssh.port"); err != nil {
errs = append(errs, err)
}
if c.SSH.Port == c.Server.Port {
errs = append(errs, fmt.Errorf("ssh.port must differ from server.port (both are %d)", c.Server.Port))
}
if err := validateFileExists(c.SSH.HostKey, "ssh.host_key"); err != nil {
errs = append(errs, err)
}
if len(c.SSH.Keys) == 0 {
errs = append(errs, errors.New("ssh.keys must have at least one value when ssh is enabled"))
}
}
// mirror
if c.Mirror.Enable {
if c.Mirror.Interval == "" {
errs = append(errs, errors.New("mirror.interval is required when mirror is enabled"))
} else if _, err := time.ParseDuration(c.Mirror.Interval); err != nil {
errs = append(errs, fmt.Errorf("mirror.interval: invalid duration format: %w", err))
}
}
return errors.Join(errs...)
}
func findConfigFile(userPath string) (string, error) {
if userPath != "" {
if _, err := os.Stat(userPath); err == nil {
return userPath, nil
}
}
path := "/var/lib/mugit/config.yaml"
if _, err := os.Stat(path); err == nil {
return path, nil
}
if configDir, err := os.UserConfigDir(); err == nil {
p := filepath.Join(configDir, "mugit", "config.yaml")
if _, err := os.Stat(p); err == nil {
return p, nil
}
}
path = "/etc/mugit/config.yaml"
if _, err := os.Stat(path); err == nil {
return path, nil
}
return "", ErrConfigNotFound
}
func validatePort(port int, fieldName string) error {
if port < 1 || port > 65535 {
return fmt.Errorf("%s must be between 1 and 65535, got %d", fieldName, port)
}
return nil
}
func validateDirExists(path string, fieldName string) error {
if path == "" {
return fmt.Errorf("%s is required", fieldName)
}
info, err := os.Stat(path)
if err != nil {
if os.IsNotExist(err) {
return fmt.Errorf("%s: directory does not exist: %s", fieldName, path)
}
return fmt.Errorf("%s: cannot access directory: %w", fieldName, err)
}
if !info.IsDir() {
return fmt.Errorf("%s: path exists but is not a directory: %s", fieldName, path)
}
return nil
}
func validateFileExists(path string, fieldName string) error {
if path == "" {
return fmt.Errorf("%s is required", fieldName)
}
info, err := os.Stat(path)
if err != nil {
if os.IsNotExist(err) {
return fmt.Errorf("%s: file does not exist: %s", fieldName, path)
}
return fmt.Errorf("%s: cannot access file: %w", fieldName, err)
}
if info.IsDir() {
return fmt.Errorf("%s: path is a directory, not a file: %s", fieldName, path)
}
return nil
}
|