utils

Documentation

Index

• Constants
• Variables
• func AddSalt(input string) string
• func CheckPassword(inputPassword string, realPassword string) bool
• func CompareVersion(v1 string, v2 string) bool
• func FileIsExist(path string) bool
• func FileSize(size int64) string
• func GenerateToken() string
• func HmacSha1Encode(input string, key string) string
• func InputString(str *string, hint string)
• func MakeErrJSON(httpStatusCode int, errCode int, msg interface{}) (int, interface{})
• func MakeSuccessJSON(data interface{}) (int, interface{})
• func SSHExecute(ip string, port string, user string, password string, command string) (string, error)
• func Sha1Encode(input string) string

Constants

const (
	// Config
	TITLE_CONF          = "title"
	FLAG_PREFIX_CONF    = "flag_prefix"
	FLAG_SUFFIX_CONF    = "flag_suffix"
	ANIMATE_ASTEROID    = "animate_asteroid"
	SHOW_OTHERS_GAMEBOX = "show_others_gamebox"

	BOOLEAN_TRUE  = "true"
	BOOLEAN_FALSE = "false"
)

const (
	// Config type
	STRING = iota
	BOOLEAN
)

Variables

var (
	VERSION    string
	COMMIT_SHA string
	BUILD_TIME string
)

These variable will be assigned in CI.

Functions

func AddSalt

func AddSalt(input string) string

AddSalt: Use the config salt as key to HmacSha1Encode.

func CheckPassword

func CheckPassword(inputPassword string, realPassword string) bool

CheckPassword: Add salt and check the password.

func CompareVersion

func CompareVersion(v1 string, v2 string) bool

CompareVersion used to compare the cardinal version.

func FileIsExist

func FileIsExist(path string) bool

FileIsExist check the file or folder existed.

func FileSize

func FileSize(size int64) string

FileSize returns the formatter text of the giving size.

func GenerateToken

func GenerateToken() string

GenerateToken: return UUID v4 string.

func HmacSha1Encode

func HmacSha1Encode(input string, key string) string

HmacSha1Encode: HMAC SHA1 encode

func InputString

func InputString(str *string, hint string)

InputString used in the install.go for the config file guide.

func MakeErrJSON

func MakeErrJSON(httpStatusCode int, errCode int, msg interface{}) (int, interface{})

MakeErrJSON makes the error response JSON for gin.

func MakeSuccessJSON

func MakeSuccessJSON(data interface{}) (int, interface{})

MakeSuccessJSON makes the successful response JSON for gin.

func SSHExecute

func SSHExecute(ip string, port string, user string, password string, command string) (string, error)

func Sha1Encode

func Sha1Encode(input string) string

Sha1Encode: Sha1 encode input string.