config.go

package emails

import (
	"net/mail"
	"net/url"

	"github.com/datumforge/datum/pkg/utils/sendgrid"
)

// Config for sending emails via SendGrid and managing marketing contacts
type Config struct {
	// SendGridAPIKey is the SendGrid API key to authenticate with the service
	SendGridAPIKey string `json:"sendGridApiKey" koanf:"sendGridApiKey"`
	// FromEmail is the default email to send from
	FromEmail string `json:"fromEmail" koanf:"fromEmail" default:"no-reply@datum.net"`
	// Testing is a bool flag to indicate we shouldn't be sending live emails, and instead should be writing out fixtures
	Testing bool `json:"testing" koanf:"testing" default:"true"`
	// Archive is only supported in testing mode and is what is tied through the mock to write out fixtures
	Archive string `json:"archive" koanf:"archive" `
	// DatumListID is the UUID SendGrid spits out when you create marketing lists
	DatumListID string `json:"datumListId" koanf:"datumListId"`
	// AdminEmail is an internal group email configured within datum for email testing and visibility
	AdminEmail string `json:"adminEmail" koanf:"adminEmail" default:"admins@datum.net"`
	// ConsoleURLConfig is the configuration for the URLs used in emails
	ConsoleURLConfig ConsoleURLConfig `json:"consoleUrl" koanf:"consoleUrl"`
	// MarketingURLConfig is the configuration for the URLs used in marketing emails
	MarketingURLConfig MarketingURLConfig `json:"marketingUrl" koanf:"marketingUrl"`
}

// ConsoleURLConfig for the datum registration
type ConsoleURLConfig struct {
	// ConsoleBase is the base URL used for URL links in emails
	ConsoleBase string `json:"consoleBase" koanf:"consoleBase" default:"https://console.datum.net"`
	// Verify is the path to the verify endpoint used in verification emails
	Verify string `json:"verify" koanf:"verify" default:"/verify"`
	// Invite is the path to the invite endpoint used in invite emails
	Invite string `json:"invite" koanf:"invite" default:"/invite"`
	// Reset is the path to the reset endpoint used in password reset emails
	Reset string `json:"reset" koanf:"reset" default:"/password-reset"`
}

// MarketingURLConfig for the datum marketing emails
type MarketingURLConfig struct {
	// MarketingBase is the base URL used for marketing links in emails
	MarketingBase string `json:"marketingBase" koanf:"marketingBase" default:"https://www.datum.net"`
	// SubscriberVerify is the path to the subscriber verify endpoint used in verification emails
	SubscriberVerify string `json:"subscriberVerify" koanf:"subscriberVerify" default:"/verify"`
	// DefaultSubscriptionOrg is the default organization name to subscribe to
	DefaultSubscriptionOrg string `json:"defaultSubscriptionOrg" koanf:"defaultSubscriptionOrg" default:"Datum"`
}

// SetSendGridAPIKey to provided key
func (m *EmailManager) SetSendGridAPIKey(key string) {
	m.conf.SendGridAPIKey = key
}

// GetSendGridAPIKey from the email manager config
func (m *EmailManager) GetSendGridAPIKey() string {
	return m.conf.SendGridAPIKey
}

// SetFromEmail to provided email
func (m *EmailManager) SetFromEmail(email string) {
	m.conf.FromEmail = email
}

// GetFromEmail from the email manager config
func (m *EmailManager) GetFromEmail() string {
	return m.conf.FromEmail
}

// SetAdminEmail to provided email
func (m *EmailManager) SetAdminEmail(email string) {
	m.conf.AdminEmail = email
}

// GetAdminEmail from the email manager config
func (m *EmailManager) GetAdminEmail() string {
	return m.conf.AdminEmail
}

// SetTesting to true/false to enable testing settings
func (m *EmailManager) SetTesting(testing bool) {
	m.conf.Testing = testing
}

// GetTesting from the email manager config
func (m *EmailManager) GetTesting() bool {
	return m.conf.Testing
}

// SetArchive location of email fixtures
func (m *EmailManager) SetArchive(archive string) {
	m.conf.Archive = archive
}

// GetArchive from the email manager config
func (m *EmailManager) GetArchive() string {
	return m.conf.Archive
}

// SetDatumListID to provided uuid
func (m *EmailManager) SetDatumListID(id string) {
	m.conf.DatumListID = id
}

// GetDatumListID from the email manager config
func (m *EmailManager) GetDatumListID() string {
	return m.conf.DatumListID
}

// parseEmail takes an email string as input and parses it into a `sendgrid.Contact`
// struct. It uses the `mail.ParseAddress` function from the `net/mail` package to parse the email
// address and name from the string. If the parsing is successful, it creates a `sendgrid.Contact`
// struct with the parsed email address and name (if available). If the parsing fails, it returns an
// error
func parseEmail(email string) (contact sendgrid.Contact, err error) {
	if email == "" {
		return contact, ErrEmailUnparsable
	}

	var addr *mail.Address

	if addr, err = mail.ParseAddress(email); err != nil {
		return contact, ErrEmailUnparsable
	}

	contact = sendgrid.Contact{
		Email: addr.Address,
	}
	contact.ParseName(addr.Name)

	return contact, nil
}

func (c ConsoleURLConfig) Validate() error {
	if c.ConsoleBase == "" {
		return newInvalidEmailConfigError("base URL")
	}

	if c.Invite == "" {
		return newInvalidEmailConfigError("invite path")
	}

	if c.Verify == "" {
		return newInvalidEmailConfigError("verify path")
	}

	if c.Reset == "" {
		return newInvalidEmailConfigError("reset path")
	}

	return nil
}

func (c MarketingURLConfig) Validate() error {
	if c.MarketingBase == "" {
		return newInvalidEmailConfigError("base URL")
	}

	if c.SubscriberVerify == "" {
		return newInvalidEmailConfigError("verify path")
	}

	if c.DefaultSubscriptionOrg == "" {
		return newInvalidEmailConfigError("default subscription org")
	}

	return nil
}

// InviteURL Construct an invite URL from the token.
func (m *EmailManager) InviteURL(token string) (string, error) {
	if token == "" {
		return "", newMissingRequiredFieldError("token")
	}

	base, err := url.Parse(m.ConsoleBase)
	if err != nil {
		return "", err
	}

	url := base.ResolveReference(&url.URL{Path: m.Invite, RawQuery: url.Values{"token": []string{token}}.Encode()})

	return url.String(), nil
}

// VerifyURL constructs a verify URL from the token.
func (m *EmailManager) VerifyURL(token string) (string, error) {
	if token == "" {
		return "", newMissingRequiredFieldError("token")
	}

	base, err := url.Parse(m.ConsoleBase)
	if err != nil {
		return "", err
	}

	url := base.ResolveReference(&url.URL{Path: m.Verify, RawQuery: url.Values{"token": []string{token}}.Encode()})

	return url.String(), nil
}

// ResetURL constructs a reset URL from the token.
func (m *EmailManager) ResetURL(token string) (string, error) {
	if token == "" {
		return "", newMissingRequiredFieldError("token")
	}

	base, err := url.Parse(m.ConsoleBase)
	if err != nil {
		return "", err
	}

	url := base.ResolveReference(&url.URL{Path: m.Reset, RawQuery: url.Values{"token": []string{token}}.Encode()})

	return url.String(), nil
}

// SubscriberVerifyURL constructs a verify URL from the token.
func (m *EmailManager) SubscriberVerifyURL(token string) (string, error) {
	if token == "" {
		return "", newMissingRequiredFieldError("token")
	}

	base, err := url.Parse(m.MarketingBase)
	if err != nil {
		return "", err
	}

	url := base.ResolveReference(&url.URL{Path: m.SubscriberVerify, RawQuery: url.Values{"token": []string{token}}.Encode()})

	return url.String(), nil
}