Skip to content

armgit / posta

Public Imported from GitHub
0

Self-hosted email delivery platform that enables applications to send emails via HTTP APIs while handling SMTP delivery, templates, storage, security, and analytics. Fully self-hostable alternative to services like SendGrid or Mailgun.

6.8 KB
Raw Blame
// Copyright (c) 2026 Jonas Kaninda.
//
// This file is part of Posta.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: AGPL-3.0-or-later

package models

import (
	"database/sql/driver"
	"encoding/json"
	"fmt"
)

// FieldType is the kind of answer a form field accepts.
type FieldType string

const (
	FieldText        FieldType = "text"
	FieldTextarea    FieldType = "textarea"
	FieldEmail       FieldType = "email"
	FieldPhone       FieldType = "phone"
	FieldNumber      FieldType = "number"
	FieldURL         FieldType = "url"
	FieldDate        FieldType = "date"
	FieldTime        FieldType = "time"
	FieldSelect      FieldType = "select"
	FieldMultiSelect FieldType = "multiselect"
	FieldCheckbox    FieldType = "checkbox"
	FieldScale       FieldType = "scale"
	FieldRating      FieldType = "rating"
	FieldHidden      FieldType = "hidden"
	// FieldSection is not a question: it starts a new page of the form. The
	// questions after it, up to the next section, are that page.
	FieldSection FieldType = "section"
)

// GotoSubmit is a branch target that ends the form: the respondent submits
// from the page they are on.
const GotoSubmit = "submit"

// FieldRole marks the field that carries one of a message's summary values,
// replacing the key-name guessing of messages.Extract.
type FieldRole string

const (
	RoleNone        FieldRole = ""
	RoleSenderEmail FieldRole = "sender_email"
	RoleSenderName  FieldRole = "sender_name"
	RoleSenderPhone FieldRole = "sender_phone"
	RoleSubject     FieldRole = "subject"
	RoleBody        FieldRole = "body"
)

// FieldDisplay chooses how a choice field is drawn. It never changes what is
// accepted.
type FieldDisplay string

const (
	DisplayDefault    FieldDisplay = ""
	DisplayRadio      FieldDisplay = "radio"      // select
	DisplayDropdown   FieldDisplay = "dropdown"   // select
	DisplayCheckboxes FieldDisplay = "checkboxes" // multiselect
	DisplayList       FieldDisplay = "list"       // multiselect
)

// UnknownFieldsPolicy decides what happens to submitted keys the schema does
// not declare.
type UnknownFieldsPolicy string

const (
	UnknownFieldsKeep   UnknownFieldsPolicy = "keep"
	UnknownFieldsDrop   UnknownFieldsPolicy = "drop"
	UnknownFieldsReject UnknownFieldsPolicy = "reject"
)

type FieldOption struct {
	Value string `json:"value"`
	Label string `json:"label,omitempty"`
	// Goto, on a single-choice question, is where choosing this option leads
	// after its page: a later section's key, or GotoSubmit. Empty follows
	// the page's own next.
	Goto string `json:"goto,omitempty"`
}

// FieldDef declares one question of a form. A key, once saved, can be
// archived but not renamed or removed, so old submissions keep their meaning.
type FieldDef struct {
	Key      string    `json:"key"`
	Label    string    `json:"label"`
	Type     FieldType `json:"type"`
	Required bool      `json:"required,omitempty"`
	Role     FieldRole `json:"role,omitempty"`
	PII      bool      `json:"pii,omitempty"`

	MinLen  *int     `json:"min_len,omitempty"`
	MaxLen  *int     `json:"max_len,omitempty"`
	Min     *float64 `json:"min,omitempty"` // number; scale low end
	Max     *float64 `json:"max,omitempty"` // number; scale high end; rating stars
	Pattern string   `json:"pattern,omitempty"`

	Options  []FieldOption `json:"options,omitempty"`
	Display  FieldDisplay  `json:"display,omitempty"`
	MinLabel string        `json:"min_label,omitempty"` // scale
	MaxLabel string        `json:"max_label,omitempty"` // scale

	Placeholder string `json:"placeholder,omitempty"`
	Help        string `json:"help,omitempty"`
	Archived    bool   `json:"archived,omitempty"`

	// Next, on a section, is where its page leads when no answer branches: a
	// later section's key, or GotoSubmit. Empty continues to the next page.
	Next string `json:"next,omitempty"`
}

// IsSection reports whether the entry starts a page rather than asking a
// question.
func (f *FieldDef) IsSection() bool { return f.Type == FieldSection }

// FieldDefs is a form's schema, stored as jsonb. Nil means the form has no
// schema and accepts any fields, as before schemas existed.
type FieldDefs []FieldDef

func (d FieldDefs) Value() (driver.Value, error) {
	if d == nil {
		return nil, nil
	}
	return json.Marshal(d)
}

func (d *FieldDefs) Scan(value any) error {
	raw, err := jsonBytes(value)
	if err != nil || raw == nil {
		*d = nil
		return err
	}
	return json.Unmarshal(raw, d)
}

// Active returns the fields that are not archived, in order.
func (d FieldDefs) Active() FieldDefs {
	out := make(FieldDefs, 0, len(d))
	for _, f := range d {
		if !f.Archived {
			out = append(out, f)
		}
	}
	return out
}

// Questions returns the entries that ask something, archived ones included,
// leaving out sections.
func (d FieldDefs) Questions() FieldDefs {
	out := make(FieldDefs, 0, len(d))
	for _, f := range d {
		if !f.IsSection() {
			out = append(out, f)
		}
	}
	return out
}

// SubmissionData is a submission's typed answers keyed by field key, stored
// as jsonb. Numbers, booleans and multi-select arrays keep their JSON type.
type SubmissionData map[string]any

func (d SubmissionData) Value() (driver.Value, error) {
	if d == nil {
		return nil, nil
	}
	return json.Marshal(d)
}

func (d *SubmissionData) Scan(value any) error {
	raw, err := jsonBytes(value)
	if err != nil || raw == nil {
		*d = nil
		return err
	}
	return json.Unmarshal(raw, d)
}

// FormAppearance is a form's saved look, used by its hosted page and as the
// widget's default. Attributes on an embed take precedence.
type FormAppearance struct {
	Accent         string `json:"accent,omitempty"`           // #RRGGBB
	Theme          string `json:"theme,omitempty"`            // light, dark or auto
	HeaderImageURL string `json:"header_image_url,omitempty"` // https only
}

func (a FormAppearance) Value() (driver.Value, error) {
	if a == (FormAppearance{}) {
		return nil, nil
	}
	return json.Marshal(a)
}

func (a *FormAppearance) Scan(value any) error {
	raw, err := jsonBytes(value)
	if err != nil || raw == nil {
		*a = FormAppearance{}
		return err
	}
	return json.Unmarshal(raw, a)
}

func jsonBytes(value any) ([]byte, error) {
	switch v := value.(type) {
	case nil:
		return nil, nil
	case []byte:
		return v, nil
	case string:
		return []byte(v), nil
	default:
		return nil, fmt.Errorf("unsupported JSON column value %T", value)
	}
}