util

Documentation

Index

• func CheckAllowlist(r *library.Repo, allowlist []string) bool
• func EscapeValue(value string) string
• func FormParameter(c *gin.Context, parameter string) string
• func HandleError(c *gin.Context, status int, err error)
• func MaxInt(a, b int) int
• func MinInt(a, b int) int
• func PathParameter(c *gin.Context, parameter string) string
• func QueryParameter(c *gin.Context, parameter, value string) string
• func SplitFullName(value string) (string, string)
• func Unique(stringSlice []string) []string

Functions

func CheckAllowlist

func CheckAllowlist(r *library.Repo, allowlist []string) bool

CheckAllowlist is a helper function to ensure only repos in the allowlist are specified.

a single entry of '*' allows any repo to be enabled.

func EscapeValue

func EscapeValue(value string) string

EscapeValue safely escapes any string by removing any new lines and HTML escaping it.

func FormParameter

func FormParameter(c *gin.Context, parameter string) string

FormParameter safely captures a form parameter from the context by removing any new lines and HTML escaping the value.

func HandleError

func HandleError(c *gin.Context, status int, err error)

HandleError appends the error to the handler chain for logging and outputs it.

func MaxInt

func MaxInt(a, b int) int

MaxInt is a helper function to clamp the integer which prevents it from being higher then the provided value.

Currently, Go only supports float64 via math. ( max | min ).

func MinInt

func MinInt(a, b int) int

MinInt is a helper function to clamp the integer which prevents it from being lower then the provided value.

Currently, Go only supports float64 via math. ( max | min ).

func PathParameter

func PathParameter(c *gin.Context, parameter string) string

PathParameter safely captures a path parameter from the context by removing any new lines and HTML escaping the value.

func QueryParameter

func QueryParameter(c *gin.Context, parameter, value string) string

QueryParameter safely captures a query parameter from the context by removing any new lines and HTML escaping the value.

func SplitFullName

func SplitFullName(value string) (string, string)

SplitFullName safely splits the repo.FullName field into an org and name.

func Unique

func Unique(stringSlice []string) []string

Unique is a helper function that takes a slice and validates that there are no duplicate entries.