dnscontrol/providers/dnsmadeeasy/dnsMadeEasyProvider.go

package dnsmadeeasy

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

	"github.com/StackExchange/dnscontrol/v3/models"
	"github.com/StackExchange/dnscontrol/v3/pkg/diff"
	"github.com/StackExchange/dnscontrol/v3/pkg/diff2"
	"github.com/StackExchange/dnscontrol/v3/pkg/txtutil"
	"github.com/StackExchange/dnscontrol/v3/providers"
)

var features = providers.DocumentationNotes{
	providers.CanGetZones:            providers.Can(),
	providers.CanUseAlias:            providers.Can(),
	providers.CanUseCAA:              providers.Can(),
	providers.CanUseDS:               providers.Cannot(),
	providers.CanUseDSForChildren:    providers.Cannot(),
	providers.CanUsePTR:              providers.Can(),
	providers.CanUseSRV:              providers.Can(),
	providers.CanUseSSHFP:            providers.Cannot(),
	providers.CanUseTLSA:             providers.Cannot(),
	providers.DocCreateDomains:       providers.Can(),
	providers.DocDualHost:            providers.Can("System NS records cannot be edited. Custom apex NS records can be added/changed/deleted."),
	providers.DocOfficiallySupported: providers.Cannot(),
}

func init() {
	fns := providers.DspFuncs{
		Initializer:   New,
		RecordAuditor: AuditRecords,
	}

	providers.RegisterDomainServiceProviderType("DNSMADEEASY", fns, features)
}

// New creates a new API handle.
func New(settings map[string]string, _ json.RawMessage) (providers.DNSServiceProvider, error) {
	if settings["api_key"] == "" {
		return nil, fmt.Errorf("missing DNSMADEEASY api_key")
	}

	if settings["secret_key"] == "" {
		return nil, fmt.Errorf("missing DNSMADEEASY secret_key")
	}

	sandbox := false
	if settings["sandbox"] != "" {
		sandbox = true
	}

	debug := false
	if os.Getenv("DNSMADEEASY_DEBUG_HTTP") == "1" {
		debug = true
	}

	api := newProvider(settings["api_key"], settings["secret_key"], sandbox, debug)

	return api, nil
}

// GetDomainCorrections returns the corrections for a domain.
func (api *dnsMadeEasyProvider) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
	dc, err := dc.Copy()
	if err != nil {
		return nil, err
	}

	err = dc.Punycode()
	if err != nil {
		return nil, err
	}

	for _, rec := range dc.Records {
		if rec.Type == "ALIAS" {
			// ALIAS is called ANAME on DNS Made Easy
			rec.Type = "ANAME"
		} else if rec.Type == "NS" {
			// NS records have fixed TTL on DNS Made Easy and it cannot be changed
			rec.TTL = fixedNameServerRecordTTL
		}
	}

	domainName := dc.Name

	domain, err := api.findDomain(domainName)
	if err != nil {
		return nil, err
	}

	// Get existing records
	existingRecords, err := api.GetZoneRecords(domainName)
	if err != nil {
		return nil, err
	}

	// Normalize
	models.PostProcessRecords(existingRecords)
	txtutil.SplitSingleLongTxt(dc.Records) // Autosplit long TXT records

	var corrections []*models.Correction
	if !diff2.EnableDiff2 || true { // Remove "|| true" when diff2 version arrives

		differ := diff.New(dc)
		_, create, del, modify, err := differ.IncrementalDiff(existingRecords)
		if err != nil {
			return nil, err
		}

		var deleteRecordIds []int
		deleteDescription := []string{"Batch deletion of records:"}
		for _, m := range del {
			originalRecordID := m.Existing.Original.(*recordResponseDataEntry).ID
			deleteRecordIds = append(deleteRecordIds, originalRecordID)
			deleteDescription = append(deleteDescription, m.String())
		}

		if len(deleteRecordIds) > 0 {
			corr := &models.Correction{
				Msg: strings.Join(deleteDescription, "\n\t"),
				F: func() error {
					return api.deleteRecords(domain.ID, deleteRecordIds)
				},
			}
			corrections = append(corrections, corr)
		}

		var createRecords []recordRequestData
		createDescription := []string{"Batch creation of records:"}
		for _, m := range create {
			record := fromRecordConfig(m.Desired)
			createRecords = append(createRecords, *record)
			createDescription = append(createDescription, m.String())
		}

		if len(createRecords) > 0 {
			corr := &models.Correction{
				Msg: strings.Join(createDescription, "\n\t"),
				F: func() error {
					return api.createRecords(domain.ID, createRecords)
				},
			}
			corrections = append(corrections, corr)
		}

		var modifyRecords []recordRequestData
		modifyDescription := []string{"Batch modification of records:"}
		for _, m := range modify {
			originalRecord := m.Existing.Original.(*recordResponseDataEntry)

			record := fromRecordConfig(m.Desired)
			record.ID = originalRecord.ID
			record.GtdLocation = originalRecord.GtdLocation

			modifyRecords = append(modifyRecords, *record)
			modifyDescription = append(modifyDescription, m.String())
		}

		if len(modifyRecords) > 0 {
			corr := &models.Correction{
				Msg: strings.Join(modifyDescription, "\n\t"),
				F: func() error {
					return api.updateRecords(domain.ID, modifyRecords)
				},
			}
			corrections = append(corrections, corr)
		}

		return corrections, nil
	}

	// Insert Future diff2 version here.

	return corrections, nil
}

// EnsureDomainExists returns an error if domain doesn't exist.
func (api *dnsMadeEasyProvider) EnsureDomainExists(domainName string) error {
	exists, err := api.domainExists(domainName)
	if err != nil {
		return err
	}

	// domain already exists
	if exists {
		return nil
	}

	return api.createDomain(domainName)
}

// GetNameservers returns the nameservers for a domain.
func (api *dnsMadeEasyProvider) GetNameservers(domain string) ([]*models.Nameserver, error) {
	nameServers, err := api.fetchDomainNameServers(domain)
	if err != nil {
		return nil, err
	}

	return models.ToNameservers(nameServers)
}

// GetZoneRecords gets the records of a zone and returns them in RecordConfig format.
func (api *dnsMadeEasyProvider) GetZoneRecords(domain string) (models.Records, error) {
	records, err := api.fetchDomainRecords(domain)
	if err != nil {
		return nil, err
	}

	nameServers, err := api.fetchDomainNameServers(domain)
	if err != nil {
		return nil, err
	}

	existingRecords := make([]*models.RecordConfig, 0, len(records))
	for i := range records {
		// Ignore HTTPRED and SPF records
		if records[i].Type == "HTTPRED" || records[i].Type == "SPF" {
			continue
		}
		existingRecords = append(existingRecords, toRecordConfig(domain, &records[i]))
	}

	for i := range nameServers {
		existingRecords = append(existingRecords, systemNameServerToRecordConfig(domain, nameServers[i]))
	}

	return existingRecords, nil
}

// ListZones lists the zones on this account.
func (api *dnsMadeEasyProvider) ListZones() ([]string, error) {
	if err := api.loadDomains(); err != nil {
		return nil, err
	}

	var zones []string
	for i := range api.domains {
		zones = append(zones, i)
	}

	return zones, nil
}