models

package

v1.1.1 Latest Latest Go to latest Published: Dec 5, 2025 License: MIT Imports: 8 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ONSdigital/dp-feedback-api

Links

Open Source Insights

Documentation ¶

Index ¶

func IsSiteDomainURL(urlString, siteDomain string) bool
func MongodbEscapeString(value string) string
func MysqlRealEscapeString(value string) string
func NormaliseURL(urlString string) string
func Sanitize(cfg *config.Sanitize, toSanitize string) string
type Feedback
- func (f *Feedback) Sanitize(cfg *config.Sanitize)
- func (f *Feedback) Validate(cfg *config.Config) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IsSiteDomainURL ¶ added in v0.5.1

func IsSiteDomainURL(urlString, siteDomain string) bool

IsSiteDomainURL is true when urlString is a URL and its host ends with `.`+siteDomain (when siteDomain is blank, or uses config.SiteDomain)

func MongodbEscapeString ¶

func MongodbEscapeString(value string) string

MongodbEscapeString escapes the control characters used by mongodb commands TODO at the moment we only check for '$' char. We may need a deeper discussion about this

func MysqlRealEscapeString ¶

func MysqlRealEscapeString(value string) string

MysqlRealEscapeString escapes the control characters used by sql commands

func NormaliseURL ¶ added in v0.5.1

func NormaliseURL(urlString string) string

NormaliseURL when a string is a URL without a scheme (e.g. `host.name/path`), add it (`https://`)

func Sanitize ¶

func Sanitize(cfg *config.Sanitize, toSanitize string) string

Sanitize sanitizes the input string to prevent html, mysql and nosql (mongodb only) injection attacks

Types ¶

type Feedback ¶

type Feedback struct {
	IsPageUseful      *bool  `json:"is_page_useful"         validate:"required"`
	IsGeneralFeedback *bool  `json:"is_general_feedback"    validate:"required"`
	OnsURL            string `json:"ons_url,omitempty"      validate:"omitempty,ons_url"`
	Feedback          string `json:"feedback,omitempty"`
	Name              string `json:"name,omitempty"`
	EmailAddress      string `json:"email_address,omitempty" validate:"omitempty,email"`
}

func (*Feedback) Sanitize ¶

func (f *Feedback) Sanitize(cfg *config.Sanitize)

Sanitize mutates all the strings in Feedback to prevent HTML, SQL and NoSQL injections, according to the provided config

func (*Feedback) Validate ¶

func (f *Feedback) Validate(cfg *config.Config) error

Validate checks that the Feedback struct complies with the validation tags

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL