merge v0.23.0-rc changes

core/field_email.go

@@ -0,0 +1,153 @@
+package core
+
+import (
+	"context"
+	"slices"
+	"strings"
+
+	validation "github.com/go-ozzo/ozzo-validation/v4"
+	"github.com/go-ozzo/ozzo-validation/v4/is"
+	"github.com/pocketbase/pocketbase/core/validators"
+	"github.com/spf13/cast"
+)
+
+func init() {
+	Fields[FieldTypeEmail] = func() Field {
+		return &EmailField{}
+	}
+}
+
+const FieldTypeEmail = "email"
+
+var _ Field = (*EmailField)(nil)
+
+// EmailField defines "email" type field for storing single email string address.
+type EmailField struct {
+	Id          string `form:"id" json:"id"`
+	Name        string `form:"name" json:"name"`
+	System      bool   `form:"system" json:"system"`
+	Hidden      bool   `form:"hidden" json:"hidden"`
+	Presentable bool   `form:"presentable" json:"presentable"`
+
+	// ---
+
+	// ExceptDomains will require the email domain to NOT be included in the listed ones.
+	//
+	// This validator can be set only if OnlyDomains is empty.
+	ExceptDomains []string `form:"exceptDomains" json:"exceptDomains"`
+
+	// OnlyDomains will require the email domain to be included in the listed ones.
+	//
+	// This validator can be set only if ExceptDomains is empty.
+	OnlyDomains []string `form:"onlyDomains" json:"onlyDomains"`
+
+	// Required will require the field value to be non-empty email string.
+	Required bool `form:"required" json:"required"`
+}
+
+// Type implements [Field.Type] interface method.
+func (f *EmailField) Type() string {
+	return FieldTypeEmail
+}
+
+// GetId implements [Field.GetId] interface method.
+func (f *EmailField) GetId() string {
+	return f.Id
+}
+
+// SetId implements [Field.SetId] interface method.
+func (f *EmailField) SetId(id string) {
+	f.Id = id
+}
+
+// GetName implements [Field.GetName] interface method.
+func (f *EmailField) GetName() string {
+	return f.Name
+}
+
+// SetName implements [Field.SetName] interface method.
+func (f *EmailField) SetName(name string) {
+	f.Name = name
+}
+
+// GetSystem implements [Field.GetSystem] interface method.
+func (f *EmailField) GetSystem() bool {
+	return f.System
+}
+
+// SetSystem implements [Field.SetSystem] interface method.
+func (f *EmailField) SetSystem(system bool) {
+	f.System = system
+}
+
+// GetHidden implements [Field.GetHidden] interface method.
+func (f *EmailField) GetHidden() bool {
+	return f.Hidden
+}
+
+// SetHidden implements [Field.SetHidden] interface method.
+func (f *EmailField) SetHidden(hidden bool) {
+	f.Hidden = hidden
+}
+
+// ColumnType implements [Field.ColumnType] interface method.
+func (f *EmailField) ColumnType(app App) string {
+	return "TEXT DEFAULT '' NOT NULL"
+}
+
+// PrepareValue implements [Field.PrepareValue] interface method.
+func (f *EmailField) PrepareValue(record *Record, raw any) (any, error) {
+	return cast.ToString(raw), nil
+}
+
+// ValidateValue implements [Field.ValidateValue] interface method.
+func (f *EmailField) ValidateValue(ctx context.Context, app App, record *Record) error {
+	val, ok := record.GetRaw(f.Name).(string)
+	if !ok {
+		return validators.ErrUnsupportedValueType
+	}
+
+	if f.Required {
+		if err := validation.Required.Validate(val); err != nil {
+			return err
+		}
+	}
+
+	if val == "" {
+		return nil // nothing to check
+	}
+
+	if err := is.EmailFormat.Validate(val); err != nil {
+		return err
+	}
+
+	domain := val[strings.LastIndex(val, "@")+1:]
+
+	// only domains check
+	if len(f.OnlyDomains) > 0 && !slices.Contains(f.OnlyDomains, domain) {
+		return validation.NewError("validation_email_domain_not_allowed", "Email domain is not allowed")
+	}
+
+	// except domains check
+	if len(f.ExceptDomains) > 0 && slices.Contains(f.ExceptDomains, domain) {
+		return validation.NewError("validation_email_domain_not_allowed", "Email domain is not allowed")
+	}
+
+	return nil
+}
+
+// ValidateSettings implements [Field.ValidateSettings] interface method.
+func (f *EmailField) ValidateSettings(ctx context.Context, app App, collection *Collection) error {
+	return validation.ValidateStruct(f,
+		validation.Field(&f.Id, validation.By(DefaultFieldIdValidationRule)),
+		validation.Field(&f.Name, validation.By(DefaultFieldNameValidationRule)),
+		validation.Field(
+			&f.ExceptDomains,
+			validation.When(len(f.OnlyDomains) > 0, validation.Empty).Else(validation.Each(is.Domain)),
+		),
+		validation.Field(
+			&f.OnlyDomains,
+			validation.When(len(f.ExceptDomains) > 0, validation.Empty).Else(validation.Each(is.Domain)),
+		),
+	)
+}