commons

Apr 23, 2024

Changes in this version

+ func Printf(format string, a ...any) (n int, err error)

+ func Println(a ...any) (n int, err error)

Apr 2, 2024

Changes in this version

+ const AesSaltLen

+ const PgpSalt

+ const SshEncryptedFileExtension

+ const SshRsaAesCtrHeader

+ const WinSCPAesCtrHeader

+ func DecodePrivateKey(privatekeyPath string) (*rsa.PrivateKey, error)

+ func DecodePublicKey(publickeyPath string) (*rsa.PublicKey, error)

+ func DecodePublicPrivateKey(keyPath string) (interface{}, error)

+ func DecryptAESCTR(data []byte, salt []byte, key []byte) ([]byte, error)

+ func DecryptAESCTRReaderWriter(reader io.Reader, writer io.Writer, salt []byte, key []byte) error

+ func DecryptFilePGP(source string, target string, key []byte) error

+ func DecryptFileSSH(source string, target string, privatekey *rsa.PrivateKey) error

+ func DecryptFileWinSCP(source string, target string, key []byte) error

+ func DecryptFilenamePGP(filename string) string

+ func DecryptFilenameSSH(filename string, privatekey *rsa.PrivateKey) (string, error)

+ func DecryptFilenameWinSCP(filename string, key []byte) (string, error)

+ func EncryptAESCTR(data []byte, salt []byte, key []byte) ([]byte, error)

+ func EncryptAESCTRReaderWriter(reader io.Reader, writer io.Writer, salt []byte, key []byte) error

+ func EncryptFilePGP(source string, target string, key []byte) error

+ func EncryptFileSSH(source string, target string, publickey *rsa.PublicKey) error

+ func EncryptFileWinSCP(source string, target string, key []byte) error

+ func EncryptFilenamePGP(filename string) string

+ func EncryptFilenameSSH(filename string, publickey *rsa.PublicKey) (string, error)

+ func EncryptFilenameWinSCP(filename string, key []byte) (string, error)

+ func GetDefaultIRODSConfigPath() string

+ func GetDefaultPrivateKeyPath() string

+ func GetDefaultPublicKeyPath() string

+ func IsCorrectFilename(filename []byte) bool

+ func PadPkcs7(data []byte, blocksize int) []byte

+ type EncryptionConfig struct

+ Mode EncryptionMode

+ Required bool

+ func GetEncryptionConfigFromMeta(filesystem *irodsclient_fs.FileSystem, targetPath string) *EncryptionConfig

type EncryptionManager

+ func (manager *EncryptionManager) SetKey(key []byte)

+ func (manager *EncryptionManager) SetPublicPrivateKey(keyPath string)

type EncryptionMode

+ const EncryptionModeSSH

Mar 29, 2024

Changes in this version

+ func IsDigitsOnly(s string) bool

Mar 26, 2024

Changes in this version

type Config

+ SSLCACertificatePath string

Mar 21, 2024

Changes in this version

+ const ParallelUploadMinSize

+ const RedirectToResourceMinSize

Feb 28, 2024

Changes in this version

+ const PgpEncryptedFileExtension

+ const WinSCPEncryptedFileExtension

+ func LoadAndOverwriteConfigFromEnv() error

+ type EncryptionManager struct

+ func NewEncryptionManager(mode EncryptionMode, encryptFilename bool, key []byte) *EncryptionManager

+ func (manager *EncryptionManager) DecryptFile(source string, target string) error

+ func (manager *EncryptionManager) DecryptFilename(filename string) (string, error)

+ func (manager *EncryptionManager) EncryptFile(source string, target string) error

+ func (manager *EncryptionManager) EncryptFilename(filename string) (string, error)

+ type EncryptionMode string

+ const EncryptionModePGP

+ const EncryptionModeUnknown

+ const EncryptionModeWinSCP

+ func DetectEncryptionMode(p string) (EncryptionMode, bool)

+ func GetEncryptionMode(mode string) EncryptionMode

+ type ListFormat string

+ const ListFormatLong

+ const ListFormatNormal

+ const ListFormatVeryLong

+ type ListSortOrder string

+ const ListSortOrderExt

+ const ListSortOrderName

+ const ListSortOrderNone

+ const ListSortOrderSize

+ const ListSortOrderTime

+ func GetListSortOrder(order string) ListSortOrder

Feb 23, 2024

Changes in this version

+ func AesDecrypt(key string, data []byte) ([]byte, error)

+ func AesEncrypt(key string, data []byte) ([]byte, error)

+ func DecryptFilenameWithPassword(filename string, password string) (string, error)

+ func EncryptFilenameWithPassword(filename string, password string) (string, error)

+ func PgpDecryptFileWithPassword(source string, target string, password string) error

+ func PgpEncryptFileWithPassword(source string, target string, password string) error

Feb 15, 2024

Changes in this version

+ const BundleTaskNameRemoveFilesAndMakeDirs

+ func FirstDelimeterIndex(p string) int

+ func GetBundleFilename(hash string) string

+ func GetParentIRODSDirs(p string) []string

+ func GetProgressWriter(displayPath bool) progress.Writer

+ func GetSessionID() int

+ func GetShortPathMessage(name string, messageLen int) string

+ func IsBundleFilename(p string) bool

+ func LastDelimeterIndex(p string) int

+ func MarkPathMap(pathMap map[string]bool, p string)

type Bundle

+ func (bundle *Bundle) AddDir(localPath string) error

+ func (bundle *Bundle) GetBundleFilename() (string, error)

Oct 26, 2023

Changes in this version

+ func SetSessionID(id int)

Oct 20, 2023

Changes in this version

type Bundle

+ func (bundle *Bundle) GetEntries() []*BundleEntry

+ type BundleEntry struct

+ Dir bool

+ IRODSPath string

+ LocalPath string

+ Size int64

type BundleTransferManager

+ func (manager *BundleTransferManager) GetBundles() []*Bundle

+ func (manager *BundleTransferManager) GetFilesystem() *irodsclient_fs.FileSystem

+ func (manager *BundleTransferManager) GetInputPathMap() map[string]bool

Oct 16, 2023

Changes in this version

+ func GetDir(p string) string

Jul 26, 2023

Changes in this version

+ const TransferTreadNumDefault

+ func CheckSafeStagingDir(stagingPath string) error

+ func GetUsername() string

+ func LoadConfigFromEnv() error

+ func LoadConfigFromFile(configPath string) error

+ func SetDefaultConfigIfEmpty()

+ func SyncAccount() error

Jul 7, 2023

Changes in this version

+ func ReinputFields() (bool, error)

May 24, 2023

Changes in this version

+ func MakeDateTimeFromString(str string) (time.Time, error)

Mar 13, 2023

Changes in this version

+ const Day

+ const GigaBytes

+ const Hour

+ const KiloBytes

+ const MaxParallelJobThreadNumDefault

+ const MegaBytes

+ const Minute

+ const TcpBufferSizeDefault

+ const TcpBufferSizeStringDefault

+ const TeraBytes

+ func GetIRODSFSClientAdvanced(account *irodsclient_types.IRODSAccount, maxConnection int, tcpBufferSize int) (*irodsclient_fs.FileSystem, error)

+ func ParseSize(size string) (int64, error)

+ func ParseTime(t string) (int, error)

Mar 11, 2023

Changes in this version

+ func CheckNewRelease() (*selfupdate.Release, error)

+ func SelfUpgrade() error

Mar 8, 2023

Changes in this version

+ func GetVersionParts(version string) (int, int, int)

+ func IsNewerVersion(ver1 []int, ver2 []int) bool

+ func SelfUpdate() error

Mar 2, 2023

Changes in this version

+ func CleanUpOldIRODSBundles(fs *irodsclient_fs.FileSystem, irodsTempDirPath string, removeDir bool, ...)

+ func CleanUpOldLocalBundles(localTempDirPath string, force bool)

+ func GetBundleFileName(managerID string, bundleIndex int64) string

+ func GetBundleFileNameParts(name string) (bool, string, string)

+ func IsStagingDirInTargetPath(stagingPath string) bool

Mar 1, 2023

Changes in this version

+ func GetCommonRootLocalDirPathForSync(paths []string) (string, error)

Mar 1, 2023

Changes in this version

+ const UploadTreadNumDefault

+ const UploadTreadNumMax

Feb 28, 2023

Changes in this version

+ func InputMissingFieldsFromStdin() error

+ func RunWithRetry(retry int, retryInterval int) error

+ type ConfigTypeIn struct

+ Host string

+ Password string

+ Port int

+ Username string

+ Zone string

+ func NewConfigTypeInFromYAML(yamlBytes []byte) (*ConfigTypeIn, error)

+ func (config *ConfigTypeIn) ToYAML() ([]byte, error)

Feb 15, 2023

Changes in this version

+ func GetDefaultStagingDir(fs *irodsclient_fs.FileSystem, targetPath string) (string, error)

+ func GetDefaultStagingDirInTargetPath(targetPath string) string

+ func GetResourceServers(fs *irodsclient_fs.FileSystem, targetDir string) ([]string, error)

+ func GetTrashHomeDir() string

+ func ValidateStagingDir(fs *irodsclient_fs.FileSystem, targetPath string, stagingPath string) (bool, error)

type BundleTransferManager

+ func (manager *BundleTransferManager) CleanUpBundles()

Feb 14, 2023

Changes in this version

+ const BundleTaskNameExtract

+ const BundleTaskNameRemove

+ const BundleTaskNameTar

+ const BundleTaskNameUpload

+ const MaxBundleFileNumDefault

+ const MaxBundleFileSizeDefault

+ const MaxThreadNumDefault

+ const MinBundleFileNumDefault

+ func ClearIRODSDirCache(filesystem *irodsclient_fs.FileSystem, irodsPath string)

+ func ExistsIRODSDir(filesystem *irodsclient_fs.FileSystem, irodsPath string) bool

+ func ExistsIRODSFile(filesystem *irodsclient_fs.FileSystem, irodsPath string) bool

+ func ExistsIRODSPath(filesystem *irodsclient_fs.FileSystem, irodsPath string) bool

+ func GetDefaultBundleTransferLogPath(id string) string

+ func ListIRODSDir(filesystem *irodsclient_fs.FileSystem, irodsPath string) ([]*irodsclient_fs.Entry, error)

+ func MakeTargetIRODSFilePath(filesystem *irodsclient_fs.FileSystem, source string, target string) string

+ func MakeTargetLocalFilePath(source string, target string) string

+ func StatIRODSPath(filesystem *irodsclient_fs.FileSystem, irodsPath string) (*irodsclient_fs.Entry, error)

+ type BundleFile struct

+ Hash string

+ IRODSPath string

+ LastModifiedTime time.Time

+ LocalPath string

+ Size int64

+ type BundleTransferLog struct

+ func NewBundleTransferLog(id string, logFilePath string, localInputPaths []string, ...) *BundleTransferLog

+ func NewBundleTransferLogFromLog(logFilePath string) (*BundleTransferLog, error)

+ func (bundleTransferLog *BundleTransferLog) IsCompleted(localPath string) bool

+ func (bundleTransferLog *BundleTransferLog) MakeBundleTransferLogDir() error

+ func (bundleTransferLog *BundleTransferLog) MonitorCtrlC()

+ func (bundleTransferLog *BundleTransferLog) PrintJobID()

+ func (bundleTransferLog *BundleTransferLog) Write(task *FileTransferTask) error

+ func (bundleTransferLog *BundleTransferLog) WriteHeader() error

+ type BundleTransferLogHeader struct

+ CreatedTime time.Time

+ ID string

+ IRODSTargetPath string

+ LocalInputPaths []string

+ func NewBundleTransferLogHeaderFromJSON(jsonBytes []byte) (*BundleTransferLogHeader, error)

+ func (logHeader *BundleTransferLogHeader) ToJSON() ([]byte, error)

type BundleTransferManager

+ func (manager *BundleTransferManager) DoneScheduling()

+ func (manager *BundleTransferManager) Schedule(source string, size int64, lastModTime time.Time) error

+ func (manager *BundleTransferManager) SetBundleRootPath(bundleRootPath string)

+ func (manager *BundleTransferManager) Start()

+ func (manager *BundleTransferManager) Wait() error

+ type FileTransferTask struct

+ Completed bool

+ Hash string

+ IRODSPath string

+ LastModifiedTime time.Time

+ LocalPath string

+ Size int64

+ func NewFileTransferTask(localPath string, irodsPath string, lastModified time.Time, size int64, ...) (*FileTransferTask, error)

+ func NewFileTransferTaskFromJSON(jsonBytes []byte) (*FileTransferTask, error)

+ func (task *FileTransferTask) ToJSON() ([]byte, error)

+ type ParallelJob struct

+ func (job *ParallelJob) GetManager() *ParallelJobManager

+ func (job *ParallelJob) Progress(processed int64, total int64, errored bool)

+ type ParallelJobManager struct

+ func NewParallelJobManager(fs *irodsclient_fs.FileSystem, maxThreads int, showProgress bool) *ParallelJobManager

+ func (manager *ParallelJobManager) DoneScheduling()

+ func (manager *ParallelJobManager) GetFilesystem() *irodsclient_fs.FileSystem

+ func (manager *ParallelJobManager) Schedule(name string, task ParallelJobTask, threadsRequired int, ...) error

+ func (manager *ParallelJobManager) Start()

+ func (manager *ParallelJobManager) Wait() error

+ type ParallelJobTask func(job *ParallelJob) error

Jan 24, 2023

Changes in this version

type Config

+ NoReplication bool

+ Ticket string

+ func GetConfig() *Config

Jan 19, 2023

Changes in this version

+ const AuthenticationSchemeDefault

+ const ClientServerPolicyDefault

+ const EncryptionAlgorithmDefault

+ const EncryptionKeySizeDefault

+ const HashRoundsDefault

+ const PortDefault

+ const SaltSizeDefault

type Config

+ AuthenticationScheme string

+ ClientServerNegotiation string

+ ClientServerPolicy string

+ ClientUsername string

+ EncryptionAlgorithm string

+ EncryptionKeySize int

+ EncryptionNumHashRounds int

+ EncryptionSaltSize int

+ SSLCACertificateFile string

+ func GetDefaultConfig() *Config

Nov 22, 2022

Changes in this version

+ const ClientProgramName

+ const MaxBundleFileNum

+ const MaxBundleFileSize

+ const MaxThreadNum

+ func EnsureTargetIRODSFilePath(filesystem *irodsclient_fs.FileSystem, source string, target string) string

+ func EnsureTargetLocalFilePath(source string, target string) string

+ func ExistFile(path string) bool

+ func ExpandHomeDir(path string) (string, error)

+ func GetAccount() *irodsclient_types.IRODSAccount

+ func GetBasename(path string) string

+ func GetCWD() string

+ func GetClientVersion() string

+ func GetCommonRootLocalDirPath(paths []string) (string, error)

+ func GetEnvironmentManager() *irodsclient_icommands.ICommandsEnvironmentManager

+ func GetFileExtension(path string) string

+ func GetHomeDir() string

+ func GetIRODSConnection(account *irodsclient_types.IRODSAccount) (*irodsclient_conn.IRODSConnection, error)

+ func GetIRODSFSClient(account *irodsclient_types.IRODSAccount) (*irodsclient_fs.FileSystem, error)

+ func GetParentLocalDirs(p string) []string

+ func GetVersionJSON() (string, error)

+ func GetZone() string

+ func HashLocalFile(sourcePath string, hashAlg hash.Hash) (string, error)

+ func HashLocalFileMD5(sourcePath string) (string, error)

+ func HashStrings(strs []string, hashAlg hash.Hash) (string, error)

+ func HashStringsMD5(strs []string) (string, error)

+ func InputMissingFields() (bool, error)

+ func InputYN(msg string) bool

+ func MakeDateTimeString(t time.Time) string

+ func MakeIRODSPath(cwd string, homedir string, zone string, irodsPath string) string

+ func MakeLocalPath(localPath string) string

+ func PrintAccount() error

+ func PrintEnvironment() error

+ func PrintHelp(command *cobra.Command) error

+ func ProcessCommonFlags(command *cobra.Command) (bool, error)

+ func SetCWD(cwd string)

+ func SetCommonFlags(command *cobra.Command)

+ func Tar(baseDir string, sources []string, target string, callback TrackerCallBack) error

+ func TestConnect(account *irodsclient_types.IRODSAccount) error

+ type Bundle struct

+ func NewBundle(tempDirPath string) *Bundle

+ func (bundle *Bundle) AddFile(path string, size int64)

+ func (bundle *Bundle) Seal(name string) error

+ type BundleTransferManager struct

+ func NewBundleTransferManager(maxBundleFileNum int, maxBundleFileSize int64, tempDirPath string) *BundleTransferManager

+ func (manager *BundleTransferManager) Go(filesystem *irodsclient_fs.FileSystem, tempPath string, targetPath string, ...) error

+ func (manager *BundleTransferManager) ScheduleBundleUpload(source string, size int64) error

+ type Config struct

+ CurrentWorkingDir string

+ DefaultResource string

+ Host string

+ LogLevel int

+ Password string

+ Port int

+ Username string

+ Zone string

+ func NewConfigFromENV() (*Config, error)

+ func NewConfigFromYAML(yamlBytes []byte) (*Config, error)

+ type ParallelTransferJob struct

+ func NewParallelTransferJob(task func(), threads int) *ParallelTransferJob

+ type ParallelTransferManager struct

+ func NewParallelTransferManager(maxThreads int) *ParallelTransferManager

+ func (manager *ParallelTransferManager) Go(showProgress bool) error

+ func (manager *ParallelTransferManager) ScheduleCopy(filesystem *irodsclient_fs.FileSystem, source string, target string) error

+ func (manager *ParallelTransferManager) ScheduleCopyIfDifferent(filesystem *irodsclient_fs.FileSystem, source string, target string) error

+ func (manager *ParallelTransferManager) ScheduleDownload(filesystem *irodsclient_fs.FileSystem, source string, target string) error

+ func (manager *ParallelTransferManager) ScheduleDownloadIfDifferent(filesystem *irodsclient_fs.FileSystem, source string, target string) error

+ func (manager *ParallelTransferManager) ScheduleUpload(filesystem *irodsclient_fs.FileSystem, source string, target string) error

+ func (manager *ParallelTransferManager) ScheduleUploadIfDifferent(filesystem *irodsclient_fs.FileSystem, source string, target string) error

+ type ProgressTrackerCallback func(name string, processed int64, total int64, done bool)

+ type TarEntry struct

+ func NewTarEntry(source string, target string) *TarEntry

+ type TrackerCallBack func(processed int64, total int64)

+ type VersionInfo struct

+ BuildDate string

+ ClientVersion string

+ Compiler string

+ GitCommit string

+ GoVersion string

+ Platform string

+ func GetVersion() VersionInfo