coredns/plugin/rewrite/ttl.go

package rewrite

import (
	"context"
	"fmt"
	"regexp"
	"strconv"
	"strings"

	"github.com/coredns/coredns/plugin"
	"github.com/coredns/coredns/request"
	//"github.com/miekg/dns"
)

type exactTTLRule struct {
	NextAction    string
	From          string
	ResponseRules []ResponseRule
}

type prefixTTLRule struct {
	NextAction    string
	Prefix        string
	ResponseRules []ResponseRule
}

type suffixTTLRule struct {
	NextAction    string
	Suffix        string
	ResponseRules []ResponseRule
}

type substringTTLRule struct {
	NextAction    string
	Substring     string
	ResponseRules []ResponseRule
}

type regexTTLRule struct {
	NextAction    string
	Pattern       *regexp.Regexp
	ResponseRules []ResponseRule
}

// Rewrite rewrites the current request based upon exact match of the name
// in the question section of the request.
func (rule *exactTTLRule) Rewrite(ctx context.Context, state request.Request) Result {
	if rule.From == state.Name() {
		return RewriteDone
	}
	return RewriteIgnored
}

// Rewrite rewrites the current request when the name begins with the matching string.
func (rule *prefixTTLRule) Rewrite(ctx context.Context, state request.Request) Result {
	if strings.HasPrefix(state.Name(), rule.Prefix) {
		return RewriteDone
	}
	return RewriteIgnored
}

// Rewrite rewrites the current request when the name ends with the matching string.
func (rule *suffixTTLRule) Rewrite(ctx context.Context, state request.Request) Result {
	if strings.HasSuffix(state.Name(), rule.Suffix) {
		return RewriteDone
	}
	return RewriteIgnored
}

// Rewrite rewrites the current request based upon partial match of the
// name in the question section of the request.
func (rule *substringTTLRule) Rewrite(ctx context.Context, state request.Request) Result {
	if strings.Contains(state.Name(), rule.Substring) {
		return RewriteDone
	}
	return RewriteIgnored
}

// Rewrite rewrites the current request when the name in the question
// section of the request matches a regular expression.
func (rule *regexTTLRule) Rewrite(ctx context.Context, state request.Request) Result {
	regexGroups := rule.Pattern.FindStringSubmatch(state.Name())
	if len(regexGroups) == 0 {
		return RewriteIgnored
	}
	return RewriteDone
}

// newTTLRule creates a name matching rule based on exact, partial, or regex match
func newTTLRule(nextAction string, args ...string) (Rule, error) {
	if len(args) < 2 {
		return nil, fmt.Errorf("too few (%d) arguments for a ttl rule", len(args))
	}
	var s string
	if len(args) == 2 {
		s = args[1]
	}
	if len(args) == 3 {
		s = args[2]
	}
	ttl, valid := isValidTTL(s)
	if !valid {
		return nil, fmt.Errorf("invalid TTL '%s' for a ttl rule", s)
	}
	if len(args) == 3 {
		switch strings.ToLower(args[0]) {
		case ExactMatch:
			return &exactTTLRule{
				nextAction,
				plugin.Name(args[1]).Normalize(),
				[]ResponseRule{{
					Active: true,
					Type:   "ttl",
					TTL:    ttl,
				}},
			}, nil
		case PrefixMatch:
			return &prefixTTLRule{
				nextAction,
				plugin.Name(args[1]).Normalize(),
				[]ResponseRule{{
					Active: true,
					Type:   "ttl",
					TTL:    ttl,
				}},
			}, nil
		case SuffixMatch:
			return &suffixTTLRule{
				nextAction,
				plugin.Name(args[1]).Normalize(),
				[]ResponseRule{{
					Active: true,
					Type:   "ttl",
					TTL:    ttl,
				}},
			}, nil
		case SubstringMatch:
			return &substringTTLRule{
				nextAction,
				plugin.Name(args[1]).Normalize(),
				[]ResponseRule{{
					Active: true,
					Type:   "ttl",
					TTL:    ttl,
				}},
			}, nil
		case RegexMatch:
			regexPattern, err := regexp.Compile(args[1])
			if err != nil {
				return nil, fmt.Errorf("invalid regex pattern in a ttl rule: %s", args[1])
			}
			return &regexTTLRule{
				nextAction,
				regexPattern,
				[]ResponseRule{{
					Active: true,
					Type:   "ttl",
					TTL:    ttl,
				}},
			}, nil
		default:
			return nil, fmt.Errorf("ttl rule supports only exact, prefix, suffix, substring, and regex name matching")
		}
	}
	if len(args) > 3 {
		return nil, fmt.Errorf("many few arguments for a ttl rule")
	}
	return &exactTTLRule{
		nextAction,
		plugin.Name(args[0]).Normalize(),
		[]ResponseRule{{
			Active: true,
			Type:   "ttl",
			TTL:    ttl,
		}},
	}, nil
}

// Mode returns the processing nextAction
func (rule *exactTTLRule) Mode() string     { return rule.NextAction }
func (rule *prefixTTLRule) Mode() string    { return rule.NextAction }
func (rule *suffixTTLRule) Mode() string    { return rule.NextAction }
func (rule *substringTTLRule) Mode() string { return rule.NextAction }
func (rule *regexTTLRule) Mode() string     { return rule.NextAction }

// GetResponseRules returns rules to rewrite the response with. Currently not implemented.
func (rule *exactTTLRule) GetResponseRules() []ResponseRule {
	return rule.ResponseRules
}

// GetResponseRules returns rules to rewrite the response with. Currently not implemented.
func (rule *prefixTTLRule) GetResponseRules() []ResponseRule {
	return rule.ResponseRules
}

// GetResponseRules returns rules to rewrite the response with. Currently not implemented.
func (rule *suffixTTLRule) GetResponseRules() []ResponseRule {
	return rule.ResponseRules
}

// GetResponseRules returns rules to rewrite the response with. Currently not implemented.
func (rule *substringTTLRule) GetResponseRules() []ResponseRule {
	return rule.ResponseRules
}

// GetResponseRules returns rules to rewrite the response with.
func (rule *regexTTLRule) GetResponseRules() []ResponseRule {
	return rule.ResponseRules
}

// validTTL returns true if v is valid TTL value.
func isValidTTL(v string) (uint32, bool) {
	i, err := strconv.Atoi(v)
	if err != nil {
		return uint32(0), false
	}
	if i > 2147483647 {
		return uint32(0), false
	}
	if i < 0 {
		return uint32(0), false
	}
	return uint32(i), true
}