graval

type FTPDriver interface {
	// params  - username, password
	// returns - true if the provided details are valid
	Authenticate(string, string, string) (bool, error)

	// params  - a file path
	// returns - an int with the number of bytes in the file or -1 if the file
	//           doesn't exist
	Bytes(string) (int64, error)

	// params  - a file path
	// returns - a time indicating when the requested path was last modified
	//         - an error if the file doesn't exist or the user lacks
	//           permissions
	ModifiedTime(string) (time.Time, error)

	// params  - path
	// returns - true if the current user is permitted to change to the
	//           requested path
	ChangeDir(string) (bool, error)

	// params  - path
	// returns - a collection of items describing the contents of the requested
	//           path
	DirContents(string) ([]os.FileInfo, error)

	// params  - path
	// returns - true if the directory was deleted
	DeleteDir(string) (bool, error)

	// params  - path
	// returns - true if the file was deleted
	DeleteFile(string) (bool, error)

	// params  - from_path, to_path
	// returns - true if the file was renamed
	Rename(string, string) (bool, error)

	// params  - path
	// returns - true if the new directory was created
	MakeDir(string) (bool, error)

	// params  - path
	// returns - a Reader that will return file data to send to the client
	GetFile(string) (io.ReadCloser, error)

	// params  - desination path, an io.Reader containing the file data
	// returns - true if the data was successfully persisted
	PutFile(string, io.Reader) (bool, error)
}

type FTPDriverFactory interface {
	NewDriver() (FTPDriver, error)
}

type FTPLogger interface {
	Info(args ...interface{})
	Infof(format string, args ...interface{})
	Warn(args ...interface{})
	Warnf(format string, args ...interface{})
	Error(args ...interface{})
	Errorf(format string, args ...interface{})
	Debug(args ...interface{})
	Debugf(format string, args ...interface{})
}

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

type FTPServerOpts struct {
	// Server name will be used for welcome message
	ServerName string

	// The factory that will be used to create a new FTPDriver instance for
	// each client connection. This is a mandatory option.
	Factory FTPDriverFactory

	// The hostname that the FTP server should listen on. Optional, defaults to
	// "::", which means all hostnames on ipv4 and ipv6.
	Hostname string

	// The port that the FTP should listen on. Optional, defaults to 3000. In
	// a production environment you will probably want to change this to 21.
	Port uint16

	// The lower bound of port numbers that can be used for passive-mode data sockets
	// Defaults to 0, which allows the server to pick any free port
	PasvMinPort uint16

	// The upper bound of port numbers that can be used for passive-mode data sockets
	// Defaults to 0, which allows the server to pick any free port
	PasvMaxPort uint16

	// Use this option to override the IP address that will be advertised in response to the
	// PASV command. Most setups can ignore this, but it can be helpful in situations where
	// the FTP server is behind a NAT gateway or load balancer and the public IP used by
	// clients is different to the IP the server is directly listening on
	PasvAdvertisedIp string

	// The logger implementation
	Logger FTPLogger
}

type FtpLogLevel int