ddns-updater-qdm12-3/internal/params/json.go

package params

import (
	"bytes"
	"encoding/json"
	"errors"
	"fmt"
	"io/fs"
	"net/netip"
	"os"
	"strings"

	"github.com/qdm12/ddns-updater/internal/models"
	"github.com/qdm12/ddns-updater/internal/provider"
	"github.com/qdm12/ddns-updater/internal/provider/utils"
	"github.com/qdm12/ddns-updater/pkg/publicip/ipversion"
	"golang.org/x/net/publicsuffix"
)

type commonSettings struct {
	Provider string `json:"provider"`
	Domain   string `json:"domain"`
	// Host is kept for retro-compatibility and is replaced by Owner.
	Host string `json:"host,omitempty"`
	// Owner is kept for retro-compatibility and is determined from the
	// Domain field.
	Owner      string       `json:"owner,omitempty"`
	IPVersion  string       `json:"ip_version"`
	IPv6Suffix netip.Prefix `json:"ipv6_suffix,omitempty"`
	// Retro values for warnings
	ProviderIP *bool `json:"provider_ip,omitempty"`
}

// JSONProviders obtain the update settings from the JSON content,
// first trying from the environment variable CONFIG and then from
// the file config.json.
func (r *Reader) JSONProviders(filePath string) (
	providers []provider.Provider, warnings []string, err error,
) {
	providers, warnings, err = r.getProvidersFromEnv(filePath)
	if providers != nil || warnings != nil || err != nil {
		return providers, warnings, err
	}
	return r.getProvidersFromFile(filePath)
}

var errWriteConfigToFile = errors.New("cannot write configuration to file")

// getProvidersFromFile obtain the update settings from config.json.
func (r *Reader) getProvidersFromFile(filePath string) (
	providers []provider.Provider, warnings []string, err error,
) {
	r.logger.Info("reading JSON config from file " + filePath)
	bytes, err := r.readFile(filePath)
	if err != nil {
		if !errors.Is(err, os.ErrNotExist) {
			return nil, nil, err
		}

		r.logger.Info("file not found, creating an empty settings file")

		const filePerm = fs.FileMode(0o666)
		err = r.writeFile(filePath, []byte(`{}`), filePerm)
		if err != nil {
			err = fmt.Errorf("%w: %w", errWriteConfigToFile, err)
		}
		return nil, nil, err
	}
	r.logger.Debug("config read: " + string(bytes))

	return extractAllSettings(bytes)
}

// getProvidersFromEnv obtain the update settings from the environment variable CONFIG.
// If the settings are valid, they are written to the filePath.
func (r *Reader) getProvidersFromEnv(filePath string) (
	providers []provider.Provider, warnings []string, err error,
) {
	s := os.Getenv("CONFIG")
	if s == "" {
		return nil, nil, nil
	}
	r.logger.Info("reading JSON config from environment variable CONFIG")
	r.logger.Debug("config read: " + s)

	b := []byte(s)

	providers, warnings, err = extractAllSettings(b)
	if err != nil {
		return providers, warnings, fmt.Errorf("configuration given: %w", err)
	}

	buffer := bytes.NewBuffer(nil)
	err = json.Indent(buffer, b, "", "  ")
	if err != nil {
		return providers, warnings, fmt.Errorf("%w: %w", errWriteConfigToFile, err)
	}
	const filePerm = fs.FileMode(0o666)
	err = r.writeFile(filePath, buffer.Bytes(), filePerm)
	if err != nil {
		return providers, warnings, fmt.Errorf("%w: %w", errWriteConfigToFile, err)
	}

	return providers, warnings, nil
}

var (
	errUnmarshalCommon = errors.New("cannot unmarshal common settings")
	errUnmarshalRaw    = errors.New("cannot unmarshal raw configuration")
)

func extractAllSettings(jsonBytes []byte) (
	allProviders []provider.Provider, warnings []string, err error,
) {
	config := struct {
		CommonSettings []commonSettings `json:"settings"`
	}{}
	rawConfig := struct {
		Settings []json.RawMessage `json:"settings"`
	}{}
	err = json.Unmarshal(jsonBytes, &config)
	if err != nil {
		return nil, nil, fmt.Errorf("%w: %w", errUnmarshalCommon, err)
	}
	err = json.Unmarshal(jsonBytes, &rawConfig)
	if err != nil {
		return nil, nil, fmt.Errorf("%w: %w", errUnmarshalRaw, err)
	}
	// TODO(v3): remove retro compatibility with IPV6_PREFIX
	retroIPv6Suffix, err := getRetroIPv6Suffix()
	if err != nil {
		return nil, nil, fmt.Errorf("getting retro-compatible global IPV6 suffix: %w", err)
	}

	for i, common := range config.CommonSettings {
		newProvider, newWarnings, err := makeSettingsFromObject(common, rawConfig.Settings[i],
			retroIPv6Suffix)
		warnings = append(warnings, newWarnings...)
		if err != nil {
			return nil, warnings, err
		}
		allProviders = append(allProviders, newProvider...)
	}

	return allProviders, warnings, nil
}

var ErrProviderNoLongerSupported = errors.New("provider no longer supported")

func makeSettingsFromObject(common commonSettings, rawSettings json.RawMessage,
	retroGlobalIPv6Suffix netip.Prefix) (
	providers []provider.Provider, warnings []string, err error,
) {
	if common.Provider == "google" {
		return nil, nil, fmt.Errorf("%w: %s", ErrProviderNoLongerSupported, common.Provider)
	}

	if common.Owner == "" { // retro compatibility
		common.Owner = common.Host
	}

	var domain string
	var owners []string
	if common.Owner != "" { // retro compatibility
		owners = strings.Split(common.Owner, ",")
		domain = common.Domain // single domain only
		domains := make([]string, len(owners))
		for i, owner := range owners {
			domains[i] = utils.BuildURLQueryHostname(owner, common.Domain)
		}
		warnings = append(warnings,
			fmt.Sprintf("you can specify the owner %q directly in the domain field as %q",
				common.Owner, strings.Join(domains, ",")))
	} else { // extract owner(s) from domain(s)
		domain, owners, err = extractFromDomainField(common.Domain)
		if err != nil {
			return nil, nil, fmt.Errorf("extracting owners from domains: %w", err)
		}
	}

	if common.IPVersion == "" {
		common.IPVersion = ipversion.IP4or6.String()
	}
	ipVersion, err := ipversion.Parse(common.IPVersion)
	if err != nil {
		return nil, nil, err
	}

	ipv6Suffix := common.IPv6Suffix
	if !ipv6Suffix.IsValid() {
		ipv6Suffix = retroGlobalIPv6Suffix
	}

	if ipVersion == ipversion.IP4 && ipv6Suffix.IsValid() {
		warnings = append(warnings,
			fmt.Sprintf("IPv6 suffix specified as %s but IP version is %s",
				ipv6Suffix, ipVersion))
	}

	if common.ProviderIP != nil {
		warning := fmt.Sprintf("for domain %s and ip version %s: "+
			`the field "provider_ip" is deprecated and no longer used`,
			domain, ipVersion)
		warnings = append(warnings, warning)
	}

	providerName := models.Provider(common.Provider)
	providers = make([]provider.Provider, len(owners))
	for i, owner := range owners {
		owner = strings.TrimSpace(owner)
		providers[i], err = provider.New(providerName, rawSettings, domain,
			owner, ipVersion, ipv6Suffix)
		if err != nil {
			return nil, warnings, err
		}
	}
	return providers, warnings, nil
}

var ErrMultipleDomainsSpecified = errors.New("multiple domains specified")

func extractFromDomainField(domainField string) (domainRegistered string,
	owners []string, err error,
) {
	domains := strings.Split(domainField, ",")
	owners = make([]string, len(domains))
	for i, domain := range domains {
		newDomainRegistered, err := publicsuffix.EffectiveTLDPlusOne(domain)
		switch {
		case err != nil:
			return "", nil, fmt.Errorf("extracting effective TLD+1: %w", err)
		case domainRegistered == "":
			domainRegistered = newDomainRegistered
		case domainRegistered != newDomainRegistered:
			return "", nil, fmt.Errorf("%w: %q and %q",
				ErrMultipleDomainsSpecified, domainRegistered, newDomainRegistered)
		}
		if domain == domainRegistered {
			owners[i] = "@"
			continue
		}
		owners[i] = strings.TrimSuffix(domain, "."+domainRegistered)
	}
	return domainRegistered, owners, nil
}