kgpz_web/providers/config.go

package providers

import (
	"encoding/json"
	"fmt"
	"os"
	"strings"

	"github.com/Theodor-Springmann-Stiftung/kgpz_web/helpers"
	"github.com/Theodor-Springmann-Stiftung/kgpz_web/helpers/logging"
	"github.com/kelseyhightower/envconfig"
)

// WARNING: this is not intended to be used in a multi-threaded environment
// Instatiate this once on startup before any goroutines are started
const (
	DEFAULT_DIR              = "cache"
	DEFAULT_GIT_CACHE_DIR    = "git"
	DEFAULT_GND_CACHE_DIR    = "gnd"
	DEFAULT_GEO_CACHE_DIR    = "geo"
	DEFAULT_SEARCH_CACHE_DIR = "search"
	DEFAULT_PICTURES_DIR     = "pictures"

	DEFAULT_PORT  = "8095"
	DEFAULT_ADDR  = "localhost"
	DEFAULT_HTTPS = false

	ENV_PREFIX = "KGPZ"
)

type ConfigProvider struct {
	Files []string
	*Config
}

type Config struct {
	// At least one of these should be set
	BaseDIR         string `json:"base_dir" envconfig:"BASE_DIR"`
	GitURL          string `json:"git_url" envconfig:"GIT_URL"`
	GitBranch       string `json:"git_branch" envconfig:"GIT_BRANCH"`
	GITPath         string `json:"git_path" envconfig:"GIT_PATH"`
	GNDPath         string `json:"gnd_path" envconfig:"GND_PATH"`
	GeoPath         string `json:"geo_path" envconfig:"GEO_PATH"`
	SearchPath      string `json:"search_path" envconfig:"SEARCH_PATH"`
	PicturesPath    string `json:"pictures_path" envconfig:"PICTURES_PATH"`
	WebHookEndpoint string `json:"webhook_endpoint" envconfig:"WEBHOOK_ENDPOINT"`
	WebHookSecret   string `json:"webhook_secret" envconfig:"WEBHOOK_SECRET"`
	Debug           bool   `json:"debug" envconfig:"DEBUG"`
	LogData         bool   `json:"log_data" envconfig:"LOG_DATA"`
	Environment     string `json:"environment" envconfig:"ENVIRONMENT"`
	NoIndex         bool   `json:"no_index" envconfig:"NO_INDEX"`

	Address string `json:"address" envconfig:"ADDRESS"`
	Port    string `json:"port" envconfig:"PORT"`
	Https   bool   `json:"https" envconfig:"HTTPS"`
}

func NewConfigProvider(files []string) *ConfigProvider {
	return &ConfigProvider{Files: files}
}

func (c *ConfigProvider) Read() error {
	c.Config = &Config{}
	for _, file := range c.Files {
		c.Config = readSettingsFile(c.Config, file)
	}
	c.Config = readSettingsEnv(c.Config)
	c.Config = readDefaults(c.Config)
	return nil
}

func (c *ConfigProvider) Validate() error {
	if strings.TrimSpace(c.Config.BaseDIR) == "" {
		return fmt.Errorf("Base directory path not set")
	}

	// Validate webhook configuration: if endpoint is set, secret must also be set
	if strings.TrimSpace(c.Config.WebHookEndpoint) != "" && strings.TrimSpace(c.Config.WebHookSecret) == "" {
		return fmt.Errorf("WebHookSecret must be configured when WebHookEndpoint is set")
	}

	return nil
}

func readSettingsFile(cfg *Config, path string) *Config {
	f, err := os.Open(path)
	if err != nil {
		logging.Error(err, "Error opening config file "+path)
		return cfg
	}
	defer f.Close()

	dec := json.NewDecoder(f)
	err = dec.Decode(cfg)
	helpers.Assert(err, "Error decoding config file")

	return cfg
}

func readSettingsEnv(cfg *Config) *Config {
	_ = envconfig.Process(ENV_PREFIX, cfg)
	return cfg
}

func readDefaults(cfg *Config) *Config {
	if strings.TrimSpace(cfg.BaseDIR) == "" {
		cfg.BaseDIR = DEFAULT_DIR
	}

	if strings.TrimSpace(cfg.GITPath) == "" {
		cfg.GITPath = DEFAULT_GIT_CACHE_DIR
	}

	if strings.TrimSpace(cfg.GNDPath) == "" {
		cfg.GNDPath = DEFAULT_GND_CACHE_DIR
	}

	if strings.TrimSpace(cfg.GeoPath) == "" {
		cfg.GeoPath = DEFAULT_GEO_CACHE_DIR
	}

	if strings.TrimSpace(cfg.Address) == "" {
		cfg.Address = DEFAULT_ADDR
	}

	if strings.TrimSpace(cfg.Port) == "" {
		cfg.Port = DEFAULT_PORT
	}

	if strings.TrimSpace(cfg.SearchPath) == "" {
		cfg.SearchPath = DEFAULT_SEARCH_CACHE_DIR
	}

	if strings.TrimSpace(cfg.PicturesPath) == "" {
		cfg.PicturesPath = DEFAULT_PICTURES_DIR
	}

	if strings.TrimSpace(cfg.Environment) == "" {
		if cfg.Debug {
			cfg.Environment = "development"
		} else {
			cfg.Environment = "production"
		}
	}

	return cfg
}

func (c *Config) String() string {
	json, err := json.Marshal(c)
	if err != nil {
		return "Config: Error marshalling to JSON"
	}
	return string(json)
}