util

package
v1.22.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2024 License: MIT Imports: 36 Imported by: 688

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidArgument  = errors.New("invalid argument")
	ErrPermissionDenied = errors.New("permission denied")
	ErrAlreadyExist     = errors.New("resource already exists")
	ErrNotExist         = errors.New("resource does not exist")
)

Common Errors forming the base of our error system

Many Errors returned by Gitea can be tested against these errors using errors.Is.

View Source
var ErrNotEmpty = errors.New("not-empty")

ErrNotEmpty is an error reported when there is a non-empty reader

Functions

func AESGCMDecrypt added in v1.17.0

func AESGCMDecrypt(key, ciphertext []byte) ([]byte, error)

AESGCMDecrypt (from legacy package): decrypts ciphertext with the given key using AES in GCM mode. should be replaced.

func AESGCMEncrypt added in v1.17.0

func AESGCMEncrypt(key, plaintext []byte) ([]byte, error)

AESGCMEncrypt (from legacy package): encrypts plaintext with the given key using AES in GCM mode. should be replaced.

func ApplyUmask added in v1.17.4

func ApplyUmask(f string, newMode os.FileMode) error

func CommonSkip added in v1.17.4

func CommonSkip(name string) bool

CommonSkip will check a provided name to see if it represents file or directory that should not be watched

func ContrastColor added in v1.22.0

func ContrastColor(backgroundColor string) string

ContrastColor returns a black or white foreground color that the highest contrast ratio. In the future, the APCA contrast function, or CSS `contrast-color` will be better. https://github.com/color-js/color.js/blob/eb7b53f7a13bb716ec8b28c7a56f052cd599acd9/src/contrast/APCA.js#L42

func CopyFile added in v1.14.0

func CopyFile(src, dest string) error

CopyFile copies file from source to target path.

func CreatePublicKeyFingerprint added in v1.20.0

func CreatePublicKeyFingerprint(key crypto.PublicKey) ([]byte, error)

CreatePublicKeyFingerprint creates a fingerprint of the given key. The fingerprint is the sha256 sum of the PKIX structure of the key.

func CryptoRandomBytes added in v1.17.0

func CryptoRandomBytes(length int64) ([]byte, error)

CryptoRandomBytes generates `length` crypto bytes This differs from CryptoRandomString, as each byte in CryptoRandomString is generated by [0,61] range This function generates totally random bytes, each byte is generated by [0,255] range

func CryptoRandomInt added in v1.17.0

func CryptoRandomInt(limit int64) (int64, error)

CryptoRandomInt returns a crypto random integer between 0 and limit, inclusive

func CryptoRandomString added in v1.17.0

func CryptoRandomString(length int64) (string, error)

CryptoRandomString generates a crypto random alphanumerical string, each byte is generated by [0,61] range

func Debounce added in v1.20.0

func Debounce(d time.Duration) func(f func())

func FilePathJoinAbs added in v1.19.1

func FilePathJoinAbs(base string, sub ...string) string

FilePathJoinAbs joins the path elements into a single file path, each element is cleaned by filepath.Clean separately. All slashes/backslashes are converted to path separators before cleaning, the result only contains path separators. The first element must be an absolute path, caller should prepare the base path. It's caller's duty to make every element not bypass its own directly level, to avoid security issues. Like PathJoinRel, any redundant part (empty, relative dots, slashes) is removed.

{`/foo`, ``, `bar`} => `/foo/bar`
{`/foo`, `..`, `bar`} => `/foo/bar`

func FileURLToPath added in v1.15.0

func FileURLToPath(u *url.URL) (string, error)

FileURLToPath extracts the path information from a file://... url. It returns an error only if the URL is not a file URL.

func GenerateKeyPair added in v1.19.0

func GenerateKeyPair(bits int) (string, string, error)

GenerateKeyPair generates a public and private keypair

func GetRelativeLuminance added in v1.22.0

func GetRelativeLuminance(color string) float64

GetRelativeLuminance returns relative luminance for a SRGB color - https://en.wikipedia.org/wiki/Relative_luminance Keep this in sync with web_src/js/utils/color.js

func HexToRBGColor added in v1.20.0

func HexToRBGColor(colorString string) (float64, float64, float64)

HexToRBGColor parses color as RGB values in 0..255 range from the hex color string (with or without #)

func HomeDir added in v1.17.0

func HomeDir() (home string, err error)

HomeDir returns path of '~'(in Linux) on Windows, it returns error when the variable does not exist.

func IfZero added in v1.22.0

func IfZero[T comparable](v, def T) T

IfZero returns "def" if "v" is a zero value, otherwise "v"

func Iif added in v1.22.0

func Iif[T any](condition bool, trueVal, falseVal T) T

Iif is an "inline-if", it returns "trueVal" if "condition" is true, otherwise "falseVal"

func IsDir added in v1.14.0

func IsDir(dir string) (bool, error)

IsDir returns true if given path is a directory, or returns false when it's a file or does not exist.

func IsEmptyReader added in v1.18.4

func IsEmptyReader(r io.Reader) (err error)

IsEmptyReader reads a reader and ensures it is empty

func IsEmptyString added in v1.7.0

func IsEmptyString(s string) bool

IsEmptyString checks if the provided string is empty

func IsExist added in v1.14.0

func IsExist(path string) (bool, error)

IsExist checks whether a file or directory exists. It returns false when the file or directory does not exist.

func IsFile added in v1.14.0

func IsFile(filePath string) (bool, error)

IsFile returns true if given path is a file, or returns false when it's a directory or does not exist.

func IsReadmeFileExtension added in v1.19.0

func IsReadmeFileExtension(name string, ext ...string) (int, bool)

IsReadmeFileExtension reports whether name looks like a README file based on its name. It will look through the provided extensions and check if the file matches one of the extensions and provide the index in the extension list. If the filename is `readme.` with an unmatched extension it will match with the index equaling the length of the provided extension list. Note that the '.' should be provided in ext, e.g ".md"

func IsReadmeFileName added in v1.19.0

func IsReadmeFileName(name string) bool

IsReadmeFileName reports whether name looks like a README file based on its name.

func KeysOfMap added in v1.21.9

func KeysOfMap[K comparable, V any](m map[K]V) []K

TODO: Replace with "maps.Keys" once available, current it only in golang.org/x/exp/maps but not in standard library

func NewAlreadyExistErrorf added in v1.19.0

func NewAlreadyExistErrorf(message string, args ...any) error

NewAlreadyExistErrorf returns an error that formats as the given text but unwraps as an ErrAlreadyExist

func NewInvalidArgumentErrorf added in v1.19.0

func NewInvalidArgumentErrorf(message string, args ...any) error

NewInvalidArgumentErrorf returns an error that formats as the given text but unwraps as an ErrInvalidArgument

func NewNotExistErrorf added in v1.19.0

func NewNotExistErrorf(message string, args ...any) error

NewNotExistErrorf returns an error that formats as the given text but unwraps as an ErrNotExist

func NewPermissionDeniedErrorf added in v1.19.0

func NewPermissionDeniedErrorf(message string, args ...any) error

NewPermissionDeniedErrorf returns an error that formats as the given text but unwraps as an ErrPermissionDenied

func NewSilentWrapErrorf added in v1.19.0

func NewSilentWrapErrorf(unwrap error, message string, args ...any) error

NewSilentWrapErrorf returns an error that formats as the given text but unwraps as the provided error

func NormalizeEOL added in v1.11.0

func NormalizeEOL(input []byte) []byte

NormalizeEOL will convert Windows (CRLF) and Mac (CR) EOLs to UNIX (LF)

func OptionalBoolParse added in v1.16.0

func OptionalBoolParse(s string) optional.Option[bool]

OptionalBoolParse get the corresponding optional.Option[bool] of a string using strconv.ParseBool

func PackData added in v1.19.0

func PackData(data ...any) ([]byte, error)

PackData uses gob to encode the given data in sequence

func PaginateSlice added in v1.14.0

func PaginateSlice(list any, page, pageSize int) any

PaginateSlice cut a slice as per pagination options if page = 0 it do not paginate

func PathEscapeSegments added in v1.8.0

func PathEscapeSegments(path string) string

PathEscapeSegments escapes segments of a path while not escaping forward slash

func PathJoinRel added in v1.19.1

func PathJoinRel(elem ...string) string

PathJoinRel joins the path elements into a single path, each element is cleaned by path.Clean separately. It only returns the following values (like path.Join), any redundant part (empty, relative dots, slashes) is removed. It's caller's duty to make every element not bypass its own directly level, to avoid security issues.

empty => ``
`` => ``
`..` => `.`
`dir` => `dir`
`/dir/` => `dir`
`foo\..\bar` => `foo\..\bar`
{`foo`, ``, `bar`} => `foo/bar`
{`foo`, `..`, `bar`} => `foo/bar`

func PathJoinRelX added in v1.19.1

func PathJoinRelX(elem ...string) string

PathJoinRelX joins the path elements into a single path like PathJoinRel, and covert all backslashes to slashes. (X means "extended", also means the combination of `\` and `/`). It's caller's duty to make every element not bypass its own directly level, to avoid security issues. It returns similar results as PathJoinRel except:

`foo\..\bar` => `bar`  (because it's processed as `foo/../bar`)

All backslashes are handled as slashes, the result only contains slashes.

func ReadAtMost added in v1.15.6

func ReadAtMost(r io.Reader, buf []byte) (n int, err error)

ReadAtMost reads at most len(buf) bytes from r into buf. It returns the number of bytes copied. n is only less than len(buf) if r provides fewer bytes. If EOF or ErrUnexpectedEOF occurs while reading, err will be nil.

func ReadWithLimit added in v1.20.0

func ReadWithLimit(r io.Reader, n int) (buf []byte, err error)

ReadWithLimit reads at most "limit" bytes from r into buf. If EOF or ErrUnexpectedEOF occurs while reading, err will be nil.

func Remove added in v1.13.0

func Remove(name string) error

Remove removes the named file or (empty) directory with at most 5 attempts.

func RemoveAll added in v1.2.0

func RemoveAll(name string) error

RemoveAll removes the named file or (empty) directory with at most 5 attempts.

func Rename added in v1.14.5

func Rename(oldpath, newpath string) error

Rename renames (moves) oldpath to newpath with at most 5 attempts.

func ReserveLineBreakForTextarea added in v1.22.0

func ReserveLineBreakForTextarea(input string) string

func SanitizeCredentialURLs added in v1.17.0

func SanitizeCredentialURLs(s string) string

SanitizeCredentialURLs remove all credentials in URLs (starting with "scheme://") for the input string: "https://user:pass@domain.com" => "https://sanitized-credential@domain.com"

func SanitizeErrorCredentialURLs added in v1.17.0

func SanitizeErrorCredentialURLs(err error) error

SanitizeErrorCredentialURLs wraps the error and make sure the returned error message doesn't contain sensitive credentials in URLs

func SanitizeURL added in v1.21.0

func SanitizeURL(s string) (string, error)

func SecToTime added in v1.17.0

func SecToTime(durationVal any) string

SecToTime converts an amount of seconds to a human-readable string. E.g. 66s -> 1 minute 6 seconds 52410s -> 14 hours 33 minutes 563418 -> 6 days 12 hours 1563418 -> 2 weeks 4 days 3937125s -> 1 month 2 weeks 45677465s -> 1 year 6 months

func ShellEscape added in v1.13.0

func ShellEscape(toEscape string) string

ShellEscape will escape the provided string. We can't just use go-shellquote here because our preferences for escaping differ from those in that we want:

* If the string doesn't require any escaping just leave it as it is. * If the string requires any escaping prefer double quote escaping * If we have ! or newlines then we need to use single quote escaping

func SliceContainsString added in v1.19.0

func SliceContainsString(slice []string, target string, insensitive ...bool) bool

SliceContainsString sequential searches if string exists in slice.

func SliceRemoveAll added in v1.19.0

func SliceRemoveAll[T comparable](slice []T, target T) []T

SliceRemoveAll removes all the target elements from the slice.

func SliceSortedEqual added in v1.19.0

func SliceSortedEqual[T comparable](s1, s2 []T) bool

SliceSortedEqual returns true if the two slices will be equal when they get sorted. It doesn't require that the slices have been sorted, and it doesn't sort them either.

func Sorted added in v1.22.0

func Sorted[S ~[]E, E cmp.Ordered](values S) S

Sorted returns the sorted slice Note: The parameter is sorted inline.

func SplitStringAtByteN added in v1.15.0

func SplitStringAtByteN(input string, n int) (left, right string)

SplitStringAtByteN splits a string at byte n accounting for rune boundaries. (Combining characters are not accounted for.)

func SplitTrimSpace added in v1.20.0

func SplitTrimSpace(input, sep string) []string

SplitTrimSpace splits the string at given separator and trims leading and trailing space

func StatDir added in v1.14.0

func StatDir(rootPath string, includeDir ...bool) ([]string, error)

StatDir gathers information of given directory by depth-first. It returns slice of file list and includes subdirectories if enabled; it returns error and nil slice when error occurs in underlying functions, or given path is not a directory or does not exist.

Slice does not include given path itself. If subdirectories is enabled, they will have suffix '/'.

func ToFloat64 added in v1.20.0

func ToFloat64(number any) (float64, error)

ToFloat64 transform a given int into float64.

func ToInt64 added in v1.20.0

func ToInt64(number any) (int64, error)

ToInt64 transform a given int into int64.

func ToPointer added in v1.21.0

func ToPointer[T any](val T) *T

ToPointer returns the pointer of a copy of any given value

func ToSnakeCase added in v1.17.0

func ToSnakeCase(input string) string

ToSnakeCase convert the input string to snake_case format.

Some samples.

"FirstName"  => "first_name"
"HTTPServer" => "http_server"
"NoHTTPS"    => "no_https"
"GO_PATH"    => "go_path"
"GO PATH"    => "go_path"      // space is converted to underscore.
"GO-PATH"    => "go_path"      // hyphen is converted to underscore.

func ToTitleCase added in v1.17.0

func ToTitleCase(s string) string

ToTitleCase returns s with all english words capitalized

func ToTitleCaseNoLower added in v1.17.4

func ToTitleCaseNoLower(s string) string

ToTitleCaseNoLower returns s with all english words capitalized without lower-casing

func ToUpperASCII added in v1.17.0

func ToUpperASCII(s string) string

ToUpperASCII returns s with all ASCII letters mapped to their upper case.

func URLJoin added in v1.4.3

func URLJoin(base string, elems ...string) string

URLJoin joins url components, like path.Join, but preserving contents

func UnpackData added in v1.19.0

func UnpackData(buf []byte, data ...any) error

UnpackData uses gob to decode the given data in sequence

func UnsafeBytesToString added in v1.21.3

func UnsafeBytesToString(b []byte) string

UnsafeBytesToString uses Go's unsafe package to convert a byte slice to a string. TODO: replace all "goldmark/util.BytesToReadOnlyString" with this official approach

func UnsafeStringToBytes added in v1.21.3

func UnsafeStringToBytes(s string) []byte

func UseLightText added in v1.22.0

func UseLightText(backgroundColor string) bool

func ValuesOfMap added in v1.22.0

func ValuesOfMap[K comparable, V any](m map[K]V) []V

TODO: Replace with "maps.Values" once available, current it only in golang.org/x/exp/maps but not in standard library

Types

type SilentWrap added in v1.17.4

type SilentWrap struct {
	Message string
	Err     error
}

SilentWrap provides a simple wrapper for a wrapped error where the wrapped error message plays no part in the error message Especially useful for "untyped" errors created with "errors.New(…)" that can be classified as 'invalid argument', 'permission denied', 'exists already', or 'does not exist'

func (SilentWrap) Error added in v1.17.4

func (w SilentWrap) Error() string

Error returns the message

func (SilentWrap) Unwrap added in v1.17.4

func (w SilentWrap) Unwrap() error

Unwrap returns the underlying error

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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