util

Documentation

Index

• Constants
• func EscapeXMLSpecialChars(in string) string
• func ExistFile(path string) bool
• func ExpandHomeDir(path string) (string, error)
• func GetBlockSizeForParallelTransfer(dataObjectLength int64) int64
• func GetCorrectIRODSPath(p string) string
• func GetEncoderRing(key string) []byte
• func GetIRODSDateTime(timestring string) (time.Time, error)
• func GetIRODSPathDepth(p string) int
• func GetIRODSPathDirname(p string) string
• func GetIRODSPathFileName(p string) string
• func GetIRODSZone(p string) (string, error)
• func GetNumTasksForParallelTransfer(dataObjectLength int64) int
• func GetParentIRODSDirs(p string) []string
• func GetPasswordPadded(newPassword string) string
• func GetRelativeIRODSPath(base string, target string) (string, error)
• func MakeIRODSPath(collectionPath string, dataobjectName string) string
• func MakeRandomString(size int) string
• func ObfuscateNewPassword(newPassword string, oldPassword string, signature string) string
• func ReadBytes(socket net.Conn, buffer []byte, size int) (int, error)
• func Scramble(toScramble string, key string, scramblePrefix string, blockChaining bool) string
• func ScrambleV2(newPassword string, oldPassword string, signature string) string
• func SplitIRODSPath(p string) (string, string)
• func WaitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool
• func WriteBytes(socket net.Conn, buffer []byte, size int) error

Constants

const (
	// TransferTaskMinLength is a minimum data length of a task for parallel data transfer
	TransferTaskMinLength int64 = 4 * 1024 * 1024 // 4MB
	// TransferTaskMaxNum is a maximum number of tasks for parallel data transfer
	TransferTaskMaxNum int = 4
	// TransferBlockSize is a block size of a task
	TransferBlockSize int64 = 1024 * 1024 // 1MB
)

Functions

func EscapeXMLSpecialChars

func EscapeXMLSpecialChars(in string) string

func ExistFile

func ExistFile(path string) bool

func ExpandHomeDir

func ExpandHomeDir(path string) (string, error)

func GetBlockSizeForParallelTransfer

func GetBlockSizeForParallelTransfer(dataObjectLength int64) int64

GetBlockSizeForParallelTransfer returns the block size

func GetCorrectIRODSPath

func GetCorrectIRODSPath(p string) string

GetCorrectIRODSPath corrects the path

func GetEncoderRing

func GetEncoderRing(key string) []byte

func GetIRODSDateTime

func GetIRODSDateTime(timestring string) (time.Time, error)

GetIRODSDateTime returns time struct from string IRODS time

func GetIRODSPathDepth

func GetIRODSPathDepth(p string) int

GetIRODSPathDepth returns depth of the path "/" returns 0 "abc" returns -1 "/abc" returns 0 "/a/b" returns 1 "/a/b/c" returns 2

func GetIRODSPathDirname

func GetIRODSPathDirname(p string) string

GetIRODSPathDirname returns the dir of the path

func GetIRODSPathFileName

func GetIRODSPathFileName(p string) string

GetIRODSPathFileName returns the filename of the path

func GetIRODSZone

func GetIRODSZone(p string) (string, error)

GetIRODSZone returns the zone of the path

func GetNumTasksForParallelTransfer

func GetNumTasksForParallelTransfer(dataObjectLength int64) int

GetNumTasksForParallelTransfer returns the number transfer tasks to be used

func GetParentIRODSDirs

func GetParentIRODSDirs(p string) []string

GetParentDirs returns all parent dirs

func GetPasswordPadded

func GetPasswordPadded(newPassword string) string

func GetRelativeIRODSPath

func GetRelativeIRODSPath(base string, target string) (string, error)

GetRelativePath returns relative path

func MakeIRODSPath

func MakeIRODSPath(collectionPath string, dataobjectName string) string

MakeIRODSPath makes the path from collection and data object

func MakeRandomString

func MakeRandomString(size int) string

MakeRandomString returns a random string

func ObfuscateNewPassword

func ObfuscateNewPassword(newPassword string, oldPassword string, signature string) string

ObfuscateNewPassword obfuscates new password for changing

func ReadBytes

func ReadBytes(socket net.Conn, buffer []byte, size int) (int, error)

ReadBytes reads data from socket in a particular size

func Scramble

func Scramble(toScramble string, key string, scramblePrefix string, blockChaining bool) string

func ScrambleV2

func ScrambleV2(newPassword string, oldPassword string, signature string) string

func SplitIRODSPath

func SplitIRODSPath(p string) (string, string)

SplitIRODSPath splits the path into dir and file

func WaitTimeout

func WaitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool

WaitTimeout waits for the waitgroup for the specified max timeout. Returns true if waiting timed out.

func WriteBytes

func WriteBytes(socket net.Conn, buffer []byte, size int) error

WriteBytes writes data to socket