common

Documentation

Overview

common is a package that summarizes the common processing of lssh package.

Index

• Constants
• func Contains(list interface{}, elem interface{}) bool
• func GetDefaultConfigPath() (path string)
• func GetFilesBase64(paths []string, iscompress int) (result string, err error)
• func GetFullPath(path string) (fullPath string)
• func GetIdFromName(file string, name string) (id uint32, err error)
• func GetMaxLength(list []string) (MaxLength int)
• func GetNameFromId(file string, id uint32) (name string, err error)
• func GetOrderNumber(value string, array []string) int
• func GetPassPhrase(msg string) (input string, err error)
• func GetUniqueSlice(data []string) (result []string)
• func IsDirPath(path string) (isDir bool)
• func IsExist(filename string) bool
• func MapMerge(m ...map[string]interface{}) map[string]interface{}
• func MapReduce(map1, map2 map[string]interface{}) map[string]interface{}
• func MapToStruct(mapVal map[string]interface{}, val interface{}) (ok bool)
• func NewSHA1Hash(n ...int) string
• func ParseArgs(options []cli.Flag, args []string) []string
• func ParseForwardPort(value string) (local, remote string, err error)
• func ParseHostPath(value string) (host []string, path string)
• func ParseNFSForwardPortPath(value string) (port, path string, err error)
• func RandomString(n int) string
• func StringCompression(mode int, data []byte) (result []byte, err error)
• func StructToMap(val interface{}) (mapVal map[string]interface{}, ok bool)
• func WalkDir(dir string) (files []string, err error)

Constants

const (
	ARCHIVE_NONE = iota
	ARCHIVE_GZIP
)

enum

Functions

func Contains

func Contains(list interface{}, elem interface{}) bool

func GetDefaultConfigPath

func GetDefaultConfigPath() (path string)

func GetFilesBase64

func GetFilesBase64(paths []string, iscompress int) (result string, err error)

GetFilesBase64 returns a base64 encoded string of file content of paths.

func GetFullPath

func GetFullPath(path string) (fullPath string)

GetFullPath returns a fullpath of path. Expands `~` to user directory ($HOME environment variable).

func GetIdFromName

func GetIdFromName(file string, name string) (id uint32, err error)

GetUserName return user name from /etc/passwd and uid.

func GetMaxLength

func GetMaxLength(list []string) (MaxLength int)

GetMaxLength returns a max length of list. Length is byte length.

func GetNameFromId

func GetNameFromId(file string, id uint32) (name string, err error)

GetUserName return user name from /etc/passwd and uid.

func GetOrderNumber

func GetOrderNumber(value string, array []string) int

Get order num in array

func GetPassPhrase

func GetPassPhrase(msg string) (input string, err error)

GetPassPhrase gets the passphrase from virtual terminal input and returns the result. Works only on UNIX-based OS.

func GetUniqueSlice

func GetUniqueSlice(data []string) (result []string)

GetUniqueSlice return slice, removes duplicate values ​​from data(slice).

func IsDirPath

func IsDirPath(path string) (isDir bool)

IsDirPath identifies is the directory from the PATH string.

func IsExist

func IsExist(filename string) bool

IsExist returns existence of file.

func MapMerge

func MapMerge(m ...map[string]interface{}) map[string]interface{}

MapMerge merges multiple Maps

func MapReduce

func MapReduce(map1, map2 map[string]interface{}) map[string]interface{}

MapReduce sets map1 value to map2 if map1 and map2 have same key, and value of map2 is zero value. Available interface type is string or []string or bool.

WARN: This function returns a map, but updates value of map2 argument too.

func MapToStruct

func MapToStruct(mapVal map[string]interface{}, val interface{}) (ok bool)

MapToStruct sets value of mapVal to public field of val struct. Raises panic if mapVal has keys of private field of val struct or field that val struct doesn't have.

WARN: ok value is not used. Always returns false.

func NewSHA1Hash

func NewSHA1Hash(n ...int) string

NewSHA1Hash generates a new SHA1 hash based on a random number of characters.

func ParseArgs

func ParseArgs(options []cli.Flag, args []string) []string

ParseArgs return os.Args parse short options (ex.) [-la] => [-l,-a] )

TODO(blacknon): Migrate to github.com/urfave/cli version 1.22.

func ParseForwardPort

func ParseForwardPort(value string) (local, remote string, err error)

ParseForwardPort return forward address and port from string.

ex.)

• `localhost:8000:localhost:18000` => local: "localhost:8000", remote: "localhost:18000"
• `8080:localhost:18080` => local: "localhost:8080", remote: "localhost:18080"
• `localhost:2222:12222` => local: "localhost:2222", remote: "localhost:12222"

func ParseHostPath

func ParseHostPath(value string) (host []string, path string)

ParseHostPath return host and path, from host:/path/to/dir/file.

func ParseNFSForwardPortPath

func ParseNFSForwardPortPath(value string) (port, path string, err error)

ParseNFSForwardPortPath

func RandomString

func RandomString(n int) string

RandomString generates a random string of n length

func StringCompression

func StringCompression(mode int, data []byte) (result []byte, err error)

StringCompression compresses bytes in the specified mode.

func StructToMap

func StructToMap(val interface{}) (mapVal map[string]interface{}, ok bool)

StructToMap returns a map that converted struct to map. Keys of map are set from public field of struct.

WARN: ok value is not used. Always returns false.

func WalkDir

func WalkDir(dir string) (files []string, err error)

WalkDir return file path list ([]string).