cacert-boardvoting/internal/forms/forms.go

/*
Copyright 2022 CAcert Inc.
SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package forms

import (
	"fmt"
	"strings"

	"git.cacert.org/cacert-boardvoting/internal/models"
	"git.cacert.org/cacert-boardvoting/internal/validator"
)

const (
	minimumTitleLength   = 3
	maximumTitleLength   = 200
	minimumContentLength = 3
	maximumContentLength = 8000

	minimumJustificationLen = 3

	threeDays  = 3
	oneWeek    = 7
	twoWeeks   = 14
	threeWeeks = 28
)

type EditMotionForm struct {
	Title               string           `form:"title"`
	Content             string           `form:"content"`
	Type                *models.VoteType `form:"type"`
	Due                 int              `form:"due"`
	validator.Validator `form:"-"`
}

func (f *EditMotionForm) Validate() {
	f.CheckField(
		validator.NotBlank(f.Title),
		"title",
		"This field cannot be blank",
	)
	f.CheckField(
		validator.MinChars(f.Title, minimumTitleLength),
		"title",
		fmt.Sprintf("This field must be at least %d characters long", minimumTitleLength),
	)
	f.CheckField(
		validator.MaxChars(f.Title, maximumTitleLength),
		"title",
		fmt.Sprintf("This field must be at most %d characters long", maximumTitleLength),
	)
	f.CheckField(
		validator.NotBlank(f.Content),
		"content",
		"This field cannot be blank",
	)
	f.CheckField(
		validator.MinChars(f.Content, minimumContentLength),
		"content",
		fmt.Sprintf("This field must be at least %d characters long", minimumContentLength),
	)
	f.CheckField(
		validator.MaxChars(f.Content, maximumContentLength),
		"content",
		fmt.Sprintf("This field must be at most %d characters long", maximumContentLength),
	)

	f.CheckField(validator.PermittedInt(
		f.Due, threeDays, oneWeek, twoWeeks, threeWeeks), "due", "invalid duration choice",
	)
}

func (f *EditMotionForm) Normalize() {
	f.Title = strings.TrimSpace(f.Title)
	f.Content = strings.TrimSpace(f.Content)
}

type DirectVoteForm struct {
	Choice *models.VoteChoice
}

type ProxyVoteForm struct {
	VoterID             int64              `form:"voter"`
	Choice              *models.VoteChoice `form:"choice"`
	Justification       string             `form:"justification"`
	Voters              []*models.User     `form:"-"`
	validator.Validator `form:"-"`
}

func (f *ProxyVoteForm) Validate() {
	f.CheckField(validator.NotBlank(f.Justification), "justification", "This field cannot be blank")
	f.CheckField(
		validator.MinChars(
			f.Justification,
			minimumJustificationLen,
		),
		"justification",
		fmt.Sprintf("This field must be at least %d characters long", minimumJustificationLen),
	)
	f.CheckField(validator.NotNil(f.Choice), "choice", "A choice has to be made")
}

func (f *ProxyVoteForm) Normalize() {
	f.Justification = strings.TrimSpace(f.Justification)
}