common

Documentation

Index

• Constants
• Variables
• func CheckPort(port string) string
• func CreateRedirect(redirecter Redirecter) gin.HandlerFunc
• func CreateRedirectString(target string) gin.HandlerFunc
• func DefaultErrorRedirect(logger log.Logger, errorMsg string) string
• func FilterErrorMsg(logger log.Logger, errorMsg string) string
• func FilterExtractHtml(html string, extractSize uint64) string
• func GetBaseUrl(levelToErase uint8, c *gin.Context) string
• func GetCurrentUrl(c *gin.Context) string
• func GetPagination(defaultPageSize uint64, c *gin.Context) (uint64, uint64, uint64, string)
• func InitPagination(data gin.H, filter string, pageNumber uint64, end uint64, total uint64)
• func LogOriginalError(logger log.Logger, err error)
• func MapToValueSlice[K comparable, V any](objects map[K]V) []V
• func WriteError(urlBuilder *strings.Builder, logger log.Logger, errorMsg string)
• type DataAdder
• type LocalesManager
• type Redirecter
• type Set
  • func MakeSet[V comparable](values []V) Set[V]
  • func (s Set[V]) Add(value V)
  • func (s Set[V]) Contains(value V) bool
  • func (s Set[V]) Remove(value V)
  • func (s Set[V]) Slice() []V
• type Stack
  • func NewStack[T any]() *Stack[T]
  • func (s *Stack[T]) Empty() bool
  • func (s *Stack[T]) Peek() T
  • func (s *Stack[T]) Pop() T
  • func (s *Stack[T]) Push(e T)
• type TemplateRedirecter

Constants

const (
	RedirectName = "Redirect"
	BaseUrlName  = "BaseUrl"

	UserIdName     = "Id" // current connected user id
	ViewedUserName = "ViewedUser"

	AllowedToCreateName = "AllowedToCreate"
	AllowedToUpdateName = "AllowedToUpdate"
	AllowedToDeleteName = "AllowedToDelete"
)

const (
	ErrorKey = "error"

	QueryError     = "?" + errorKeyEq
	AddQueryError  = "&" + errorKeyEq
	PathQueryError = "/" + QueryError
)

const (
	ErrorBadRoleNameKey          = "ErrorBadRoleName"
	ErrorBaseVersionKey          = "BaseVersionOutdated"
	ErrorEmptyCommentKey         = "EmptyComment"
	ErrorEmptyLoginKey           = "EmptyLogin"
	ErrorEmptyPasswordKey        = "EmptyPassword"
	ErrorExistingLoginKey        = "ExistingLogin"
	ErrorNotAuthorizedKey        = "ErrorNotAuthorized"
	ErrorTechnicalKey            = "ErrorTechnicalProblem"
	ErrorUpdateKey               = "ErrorUpdate"
	ErrorWeakPasswordKey         = "WeakPassword"
	ErrorWrongConfirmPasswordKey = "WrongConfirmPassword"
	ErrorWrongLangKey            = "WrongLang"
	ErrorWrongLoginKey           = "WrongLogin"
)

error displayed to user

const ReportingPlaceName = "reporting_place"

const WrongLangKey = "WrongLang"

Variables

var (
	ErrBadRoleName   = errors.New(ErrorBadRoleNameKey)
	ErrBaseVersion   = errors.New(ErrorBaseVersionKey)
	ErrEmptyComment  = errors.New(ErrorEmptyCommentKey)
	ErrEmptyLogin    = errors.New(ErrorEmptyLoginKey)
	ErrEmptyPassword = errors.New(ErrorEmptyPasswordKey)
	ErrExistingLogin = errors.New(ErrorExistingLoginKey)
	ErrNotAuthorized = errors.New(ErrorNotAuthorizedKey)
	ErrTechnical     = errors.New(ErrorTechnicalKey)
	ErrUpdate        = errors.New(ErrorUpdateKey)
	ErrWeakPassword  = errors.New(ErrorWeakPasswordKey)
	ErrWrongConfirm  = errors.New(ErrorWrongConfirmPasswordKey)
	ErrWrongLogin    = errors.New(ErrorWrongLoginKey)
)

Functions

func CheckPort

func CheckPort(port string) string

func CreateRedirect

func CreateRedirect(redirecter Redirecter) gin.HandlerFunc

func CreateRedirectString

func CreateRedirectString(target string) gin.HandlerFunc

func DefaultErrorRedirect

func DefaultErrorRedirect(logger log.Logger, errorMsg string) string

func FilterErrorMsg

func FilterErrorMsg(logger log.Logger, errorMsg string) string

func FilterExtractHtml

func FilterExtractHtml(html string, extractSize uint64) string

html must be well formed

func GetBaseUrl

func GetBaseUrl(levelToErase uint8, c *gin.Context) string

func GetCurrentUrl

func GetCurrentUrl(c *gin.Context) string

func GetPagination

func GetPagination(defaultPageSize uint64, c *gin.Context) (uint64, uint64, uint64, string)

func InitPagination

func InitPagination(data gin.H, filter string, pageNumber uint64, end uint64, total uint64)

func LogOriginalError

func LogOriginalError(logger log.Logger, err error)

func MapToValueSlice

func MapToValueSlice[K comparable, V any](objects map[K]V) []V

func WriteError

func WriteError(urlBuilder *strings.Builder, logger log.Logger, errorMsg string)

Types

type DataAdder

type DataAdder func(gin.H, *gin.Context)

type LocalesManager

type LocalesManager interface {
	GetDefaultLang() string
	GetAllLang() []string
	GetMultipleLang() bool
	GetLang(*gin.Context) string
	CheckLang(string, *gin.Context) string
	SetLangCookie(string, *gin.Context) string
}

type Redirecter

type Redirecter func(*gin.Context) string

type Set

type Set[V comparable] map[V]empty

func MakeSet

func MakeSet[V comparable](values []V) Set[V]

func (Set[V]) Add

func (s Set[V]) Add(value V)

func (Set[V]) Contains

func (s Set[V]) Contains(value V) bool

func (Set[V]) Remove

func (s Set[V]) Remove(value V)

func (Set[V]) Slice

func (s Set[V]) Slice() []V

type Stack

type Stack[T any] struct {
	// contains filtered or unexported fields
}

func NewStack

func NewStack[T any]() *Stack[T]

func (*Stack[T]) Empty

func (s *Stack[T]) Empty() bool

func (*Stack[T]) Peek

func (s *Stack[T]) Peek() T

func (*Stack[T]) Pop

func (s *Stack[T]) Pop() T

func (*Stack[T]) Push

func (s *Stack[T]) Push(e T)

type TemplateRedirecter

type TemplateRedirecter func(gin.H, *gin.Context) (string, string)