gluetun/internal/configuration/sources/env/reader.go

package env

import (
	"github.com/qdm12/gluetun/internal/configuration/settings"
	"github.com/qdm12/gosettings/sources/env"
)

type Source struct {
	warner Warner
}

type Warner interface {
	Warn(s string)
}

func New(warner Warner) *Source {
	return &Source{
		warner: warner,
	}
}

func (s *Source) String() string { return "environment variables" }

func (s *Source) Read() (settings settings.Settings, err error) {
	settings.VPN, err = s.readVPN()
	if err != nil {
		return settings, err
	}

	settings.Firewall, err = s.readFirewall()
	if err != nil {
		return settings, err
	}

	settings.System, err = s.readSystem()
	if err != nil {
		return settings, err
	}

	settings.Health, err = s.ReadHealth()
	if err != nil {
		return settings, err
	}

	settings.HTTPProxy, err = s.readHTTPProxy()
	if err != nil {
		return settings, err
	}

	settings.Log, err = readLog()
	if err != nil {
		return settings, err
	}

	settings.PublicIP, err = s.readPublicIP()
	if err != nil {
		return settings, err
	}

	settings.Updater, err = readUpdater()
	if err != nil {
		return settings, err
	}

	settings.Version, err = readVersion()
	if err != nil {
		return settings, err
	}

	settings.Shadowsocks, err = s.readShadowsocks()
	if err != nil {
		return settings, err
	}

	settings.DNS, err = s.readDNS()
	if err != nil {
		return settings, err
	}

	settings.ControlServer, err = s.readControlServer()
	if err != nil {
		return settings, err
	}

	settings.Pprof, err = readPprof()
	if err != nil {
		return settings, err
	}

	return settings, nil
}

func (s *Source) onRetroActive(oldKey, newKey string) {
	s.warner.Warn(
		"You are using the old environment variable " + oldKey +
			", please consider changing it to " + newKey)
}

// getEnvWithRetro returns the first environment variable
// key and corresponding non empty value from the environment
// variable keys given. It first goes through the retroKeys
// and end on returning the value corresponding to the currentKey.
// Note retroKeys should be in order from oldest to most
// recent retro-compatibility key.
func (s *Source) getEnvWithRetro(currentKey string,
	retroKeys ...string) (key, value string) {
	// We check retro-compatibility keys first since
	// the current key might be set in the Dockerfile.
	for _, key = range retroKeys {
		value = env.Get(key)
		if value != "" {
			s.onRetroActive(key, currentKey)
			return key, value
		}
	}

	return currentKey, env.Get(currentKey)
}