utils

Documentation

Index

• Constants
• func Clamp(value, min, max int64) int64
• func ClampCookieAge(seconds *int64) int64
• func ClampU(value, min, max uint64) uint64
• func ConvertImageToNRGBA(srcImage image.Image) (*image.NRGBA, error)
• func DirSize(dirPath string) (int64, error)
• func EncodeImage(dstImage *image.NRGBA) (*bytes.Buffer, error)
• func ExtractPDF()
• func FileSize(filePath string) (int64, error)
• func HashStringSHA1(s string) string
• func IsValidPassword(password string) bool
• func IsValidSessionName(sessionName *string) bool
• func IsValidUsername(username string) bool
• func PathExists(pathTo string) bool
• func PeriodicTask(d time.Duration, f func())
• func ReadJSON(jsonFile string) ([]byte, error)
• func Similarity(a string, b string) float64
• func TransformImage(srcImage *image.NRGBA, width int, cropLandscape bool, ltr bool) *image.NRGBA
• func UniversalExtract(dst string, archivePath string) ([]string, int)
• type Argon2idHash
  • func DefaultArgon2idHash() *Argon2idHash
  • func NewArgon2idHash(time, saltLen, memory uint32, threads uint8, keyLen uint32) *Argon2idHash
  • func (a *Argon2idHash) Compare(hash, salt, password []byte) bool
  • func (a *Argon2idHash) GenerateHash(password, salt []byte) (*HashSalt, error)
• type HashSalt
• type OrderedMap
  • func NewOrderedMap() *OrderedMap
  • func (om *OrderedMap) Get(key string) (interface{}, bool)
  • func (om *OrderedMap) OrderedKeys() []string
  • func (om *OrderedMap) Set(key string, value interface{})

Constants

const DEFAULT_ASPECT_RATIO = 1.5

const DEFAULT_COVER_WIDTH_SHIFT = 0.025

const DEFAULT_THUMB_COVER_WIDTH = 512

const DEFAULT_THUMB_PAGE_WIDTH = 256

Functions

func Clamp

func Clamp(value, min, max int64) int64

Clamp clamps the given value to the given range.

func ClampCookieAge

func ClampCookieAge(seconds *int64) int64

ClampCookieAge returns a valid cookie age in seconds.

func ClampU

func ClampU(value, min, max uint64) uint64

ClampU clamps the given unsigned value to the given range.

func ConvertImageToNRGBA

func ConvertImageToNRGBA(srcImage image.Image) (*image.NRGBA, error)

func DirSize

func DirSize(dirPath string) (int64, error)

func EncodeImage

func EncodeImage(dstImage *image.NRGBA) (*bytes.Buffer, error)

EncodeImage encodes the given image to the format specified in the config.

func ExtractPDF

func ExtractPDF()

func FileSize

func FileSize(filePath string) (int64, error)

func HashStringSHA1

func HashStringSHA1(s string) string

func IsValidPassword

func IsValidPassword(password string) bool

IsValidPassword checks if the password is valid.

func IsValidSessionName

func IsValidSessionName(sessionName *string) bool

IsValidSessionName checks if the session name is valid.

func IsValidUsername

func IsValidUsername(username string) bool

IsValidUsername checks if the username is valid.

func PathExists

func PathExists(pathTo string) bool

PathExists checks if the given path exists.

func PeriodicTask

func PeriodicTask(d time.Duration, f func())

PeriodicTask loops the given function in separate thread between the given interval.

func ReadJSON

func ReadJSON(jsonFile string) ([]byte, error)

ReadJSON returns the given JSON file as bytes.

func Similarity

func Similarity(a string, b string) float64

Similarity calculates the similarity between two strings.

func TransformImage

func TransformImage(srcImage *image.NRGBA, width int, cropLandscape bool, ltr bool) *image.NRGBA

TransformImage resizes the given image to the specified width and returns it. If cover is true, the image will be tried to be cropped to the specified width as some covers include the back cover as well.

func UniversalExtract

func UniversalExtract(dst string, archivePath string) ([]string, int)

UniversalExtract extracts media files from zip, cbz, rar, cbr, tar (all its variants) archives. Plain directories without compression are also supported. For PDF files, use ExtractPDF.

Types

type Argon2idHash

type Argon2idHash struct {
	// contains filtered or unexported fields
}

Argon2idHash is a wrapper for the argon2id hashing algorithm. https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#password-hashing-algorithms

func DefaultArgon2idHash

func DefaultArgon2idHash() *Argon2idHash

DefaultArgon2idHash constructor function for Argon2idHash. https://tobtu.com/minimum-password-settings/

func NewArgon2idHash

func NewArgon2idHash(time, saltLen, memory uint32, threads uint8, keyLen uint32) *Argon2idHash

NewArgon2idHash constructor function for Argon2idHash.

func (*Argon2idHash) Compare

func (a *Argon2idHash) Compare(hash, salt, password []byte) bool

Compare generated hash with stored hash.

func (*Argon2idHash) GenerateHash

func (a *Argon2idHash) GenerateHash(password, salt []byte) (*HashSalt, error)

GenerateHash using the password and provided salt. If no salt value was provided, fallbacks to a random value of a given length.

type HashSalt

type HashSalt struct {
	Hash []byte
	Salt []byte
}

HashSalt is a wrapper for the hash and salt values.

type OrderedMap

type OrderedMap struct {
	Keys []string
	Map  map[string]interface{}
}

func NewOrderedMap

func NewOrderedMap() *OrderedMap

func (*OrderedMap) Get

func (om *OrderedMap) Get(key string) (interface{}, bool)

func (*OrderedMap) OrderedKeys

func (om *OrderedMap) OrderedKeys() []string

func (*OrderedMap) Set

func (om *OrderedMap) Set(key string, value interface{})