README
¶
goftp
Golang FTP library with Walk support.
Features
- AUTH TLS support
- Walk
Sample
package main
import (
"crypto/sha256"
"crypto/tls"
"fmt"
"io"
"os"
"encoding/hex"
"gopkg.in/dutchcoders/goftp.v1"
)
func main() {
var err error
var ftp *goftp.FTP
// For debug messages: goftp.ConnectDbg("ftp.server.com:21")
if ftp, err = goftp.Connect("ftp.server.com:21"); err != nil {
panic(err)
}
defer ftp.Close()
fmt.Println("Successfully connected to", server)
// TLS client authentication
config := tls.Config{
InsecureSkipVerify: true,
ClientAuth: tls.RequestClientCert,
}
if err = ftp.AuthTLS(config); err != nil {
panic(err)
}
// Username / password authentication
if err = ftp.Login("username", "password"); err != nil {
panic(err)
}
if err = ftp.Cwd("/"); err != nil {
panic(err)
}
var curpath string
if curpath, err = ftp.Pwd(); err != nil {
panic(err)
}
fmt.Printf("Current path: %s", curpath)
// Get directory listing
var files []string
if files, err = ftp.List(""); err != nil {
panic(err)
}
fmt.Println("Directory listing:", files)
// Upload a file
var file *os.File
if file, err = os.Open("/tmp/test.txt"); err != nil {
panic(err)
}
if err := ftp.Stor("/test.txt", file); err != nil {
panic(err)
}
// Download each file into local memory, and calculate it's sha256 hash
err = ftp.Walk("/", func(path string, info os.FileMode, err error) error {
_, err = ftp.Retr(path, func(r io.Reader) error {
var hasher = sha256.New()
if _, err = io.Copy(hasher, r); err != nil {
return err
}
hash := fmt.Sprintf("%s %x", path, hex.EncodeToString(hasher.Sum(nil)))
fmt.Println(hash)
return err
})
return nil
})
}
Contributions
Contributions are welcome.
- Sourav Datta: for his work on the anonymous user login and multiline return status.
- Vincenzo La Spesa: for his work on resolving login issues with specific ftp servers
Creators
Remco Verhoef
Copyright and license
Code and documentation copyright 2011-2014 Remco Verhoef. Code released under the MIT license.
Documentation
¶
Overview ¶
Package goftp upload helper
Index ¶
- Constants
- Variables
- func StatusText(code string) string
- type FTP
- func (ftp *FTP) AuthTLS(config *tls.Config) error
- func (ftp *FTP) Close() error
- func (ftp *FTP) Cwd(path string) (err error)
- func (ftp *FTP) Dele(path string) (err error)
- func (ftp *FTP) List(path string) (files []string, err error)
- func (ftp *FTP) Login(username string, password string) (err error)
- func (ftp *FTP) Mkd(path string) error
- func (ftp *FTP) Noop() (err error)
- func (ftp *FTP) Pasv() (port int, err error)
- func (ftp *FTP) Pwd() (path string, err error)
- func (ftp *FTP) Quit() (err error)
- func (ftp *FTP) RawCmd(command string, args ...interface{}) (code int, line string)
- func (ftp *FTP) ReadAndDiscard() (int, error)
- func (ftp *FTP) Rename(from string, to string) (err error)
- func (ftp *FTP) Retr(path string, retrFn RetrFunc) (s string, err error)
- func (ftp *FTP) Rmd(path string) (err error)
- func (ftp *FTP) Size(path string) (size int, err error)
- func (ftp *FTP) Stat(path string) ([]string, error)
- func (ftp *FTP) Stor(path string, r io.Reader) (err error)
- func (ftp *FTP) Syst() (line string, err error)
- func (ftp *FTP) Type(t TypeCode) error
- func (ftp *FTP) Upload(localPath string) (err error)
- func (ftp *FTP) Walk(path string, walkFn WalkFunc) (err error)
- type RetrFunc
- type TypeCode
- type WalkFunc
Constants ¶
const ( // TypeASCII for ASCII TypeASCII = "A" // TypeEBCDIC for EBCDIC TypeEBCDIC = "E" // TypeImage for an Image TypeImage = "I" // TypeLocal for local byte size TypeLocal = "L" )
const ( StatusFileOK = "150" StatusOK = "200" StatusSystemStatus = "211" StatusDirectoryStatus = "212" StatusFileStatus = "213" StatusConnectionClosing = "221" StatusSystemType = "215" StatusClosingDataConnection = "226" StatusActionOK = "250" StatusPathCreated = "257" StatusActionPending = "350" )
FTP Status codes, defined in RFC 959
Variables ¶
var ( SystemTypeUnixL8 = "UNIX Type: L8" SystemTypeWindowsNT = "Windows_NT" )
System types from Syst
var RePwdPath = regexp.MustCompile(`\"(.*)\"`)
RePwdPath is the default expression for matching files in the current working directory
Functions ¶
func StatusText ¶
StatusText returns a text for the FTP status code. It returns the empty string if the code is unknown.
Types ¶
type FTP ¶
type FTP struct {
// contains filtered or unexported fields
}
FTP is a session for File Transfer Protocol
func ConnectDbg ¶
ConnectDbg to server at addr (format "host:port"). debug is ON
func (*FTP) Login ¶
Login to the server with provided username and password. Typical default may be ("anonymous","").
func (*FTP) Quit ¶
Quit sends quit to the server and close the connection. No need to Close after this.
func (*FTP) RawCmd ¶
RawCmd sends raw commands to the remote server. Returns response code as int and response as string.
func (*FTP) ReadAndDiscard ¶
ReadAndDiscard reads all the buffered bytes and returns the number of bytes that cleared from the buffer
func (*FTP) Retr ¶
Retr retrieves file from remote host at path, using retrFn to read from the remote file.
Source Files