diff --git a/ftp/ftp.go b/ftp/ftp.go
index f73dd6ac1..66deadd94 100644
--- a/ftp/ftp.go
+++ b/ftp/ftp.go
@@ -1,4 +1,4 @@
-// Package fs is a generic file system interface for rclone object storage systems
+// Package ftp interfaces with FTP servers
package ftp
import (
@@ -13,8 +13,14 @@ import (
"github.com/jlaffaye/ftp"
"github.com/ncw/rclone/fs"
+ "github.com/pkg/errors"
)
+// This mutex is only used by ftpConnection. We create a new ftp
+// connection for each transfer, but we need to serialize it otherwise
+// Dial() and Login() might be mixed...
+var globalMux = sync.Mutex{}
+
// Register with Fs
func init() {
fs.Register(&fs.RegInfo{
@@ -36,28 +42,24 @@ func init() {
})
}
-type Url struct {
- Scheme string
- Host string
- Port int
- Path string
-}
-
+// Fs represents a remote FTP server
type Fs struct {
name string // name of this remote
root string // the path we are working on if any
features *fs.Features // optional features
c *ftp.ServerConn // the connection to the FTP server
- url Url
+ url URL
mu sync.Mutex
}
+// Object describes an FTP file
type Object struct {
fs *Fs
remote string
info *FileInfo
}
+// FileInfo is the metadata known about an FTP file
type FileInfo struct {
Name string
Size uint64
@@ -65,25 +67,47 @@ type FileInfo struct {
IsDir bool
}
-// Implements ReadCloser for FTP objects.
-type FtpReadCloser struct {
- remote string
- c *ftp.ServerConn
- fd io.ReadCloser
+// URL represents an FTP URL
+type URL struct {
+ Scheme string
+ Host string
+ Port int
+ Path string
}
-/////////////////
-// Url methods //
-/////////////////
-func (u *Url) ToDial() string {
+// ToDial converts the URL to Dial format
+func (u *URL) ToDial() string {
return fmt.Sprintf("%s:%d", u.Host, u.Port)
}
-func (u *Url) String() string {
+func (u *URL) String() string {
return fmt.Sprintf("ftp://%s:%d/%s", u.Host, u.Port, u.Path)
}
-func parseUrl(url string) Url {
+// ------------------------------------------------------------
+
+// Name of this fs
+func (f *Fs) Name() string {
+ return f.name
+}
+
+// Root of the remote (as passed into NewFs)
+func (f *Fs) Root() string {
+ return f.root
+}
+
+// String returns a description of the FS
+func (f *Fs) String() string {
+ return fmt.Sprintf("FTP Connection to %s", f.url.String())
+}
+
+// Features returns the optional features of this Fs
+func (f *Fs) Features() *fs.Features {
+ return f.features
+}
+
+// Parse a URL
+func parseURL(url string) URL {
// This is *similar* to the RFC 3986 regexp but it matches the
// port independently from the host
r, _ := regexp.Compile("^(([^:/?#]+):)?(//([^/?#:]*))?(:([0-9]+))?([^?#]*)(\\?([^#]*))?(#(.*))?")
@@ -94,118 +118,53 @@ func parseUrl(url string) Url {
data[0][5] = "21"
}
port, _ := strconv.Atoi(data[0][5])
- return Url{data[0][2], data[0][4], port, data[0][7]}
+ return URL{data[0][2], data[0][4], port, data[0][7]}
}
-////////////////
-// Fs Methods //
-////////////////
-
-func (f *Fs) Put(in io.Reader, src fs.ObjectInfo) (fs.Object, error) {
- fs.Debugf(f, "Trying to put file %s", src.Remote())
- o := &Object{
- fs: f,
- remote: src.Remote(),
- }
- err := o.Update(in, src)
- return o, err
-}
-
-func (f *Fs) Rmdir(dir string) error {
- // This is actually a recursive remove directory
- f.mu.Lock()
- files, _ := f.c.List(filepath.Join(f.root, dir))
- f.mu.Unlock()
- for i := range files {
- if files[i].Type == ftp.EntryTypeFolder {
- f.Rmdir(filepath.Join(dir, files[i].Name))
- }
- }
- f.mu.Lock()
- err := f.c.RemoveDir(filepath.Join(f.root, dir))
- f.mu.Unlock()
- return err
-}
-
-func (f *Fs) Name() string {
- return f.name
-}
-
-// Root of the remote (as passed into NewFs)
-func (f *Fs) Root() string {
- return f.root
-}
-
-func (f *Fs) String() string {
- return fmt.Sprintf("FTP Connection to %s", f.url.String())
-}
-
-// Features returns the optional features of this Fs
-func (f *Fs) Features() *fs.Features {
- return f.features
-}
-
-// Hash are not supported
-func (f *Fs) Hashes() fs.HashSet {
- return 0
-}
-
-// Modified Time not supported
-func (f *Fs) Precision() time.Duration {
- return fs.ModTimeNotSupported
-}
-
-func (f *Fs) mkdir(abspath string) error {
- _, err := f.GetInfo(abspath)
+// Open a new connection to the FTP server.
+func ftpConnection(name, root string) (*ftp.ServerConn, URL, error) {
+ url := fs.ConfigFileGet(name, "url")
+ user := fs.ConfigFileGet(name, "username")
+ pass := fs.ConfigFileGet(name, "password")
+ u := parseURL(url)
+ u.Path = filepath.Join(u.Path, root)
+ fs.Debugf(nil, "New ftp Connection with name %s and url %s (path %s)", name, u.String(), u.Path)
+ globalMux.Lock()
+ defer globalMux.Unlock()
+ c, err := ftp.DialTimeout(u.ToDial(), 30*time.Second)
if err != nil {
- fs.Debugf(f, "Trying to create directory %s", abspath)
- f.mu.Lock()
- err := f.c.MakeDir(abspath)
- f.mu.Unlock()
- if err != nil {
- return err
- }
+ fs.Errorf(nil, "Error while Dialing %s: %s", u.ToDial(), err)
+ return nil, u, err
}
- return err
+ err = c.Login(user, pass)
+ if err != nil {
+ fs.Errorf(nil, "Error while Logging in into %s: %s", u.ToDial(), err)
+ return nil, u, err
+ }
+ return c, u, nil
}
-func (f *Fs) Mkdir(dir string) error {
- // This actually works as mkdir -p
- fs.Debugf(f, "ENTER function 'Mkdir' on '%s/%s'", f.root, dir)
- defer fs.Debugf(f, "EXIT function 'Mkdir' on '%s/%s'", f.root, dir)
- abspath := filepath.Join(f.root, dir)
- tokens := strings.Split(abspath, "/")
- curdir := ""
- for i := range tokens {
- curdir += "/" + tokens[i]
- f.mkdir(curdir)
+// NewFs contstructs an Fs from the path, container:path
+func NewFs(name, root string) (fs.Fs, error) {
+ fs.Debugf(nil, "ENTER function 'NewFs' with name %s and root %s", name, root)
+ defer fs.Debugf(nil, "EXIT function 'NewFs'")
+ c, u, err := ftpConnection(name, root)
+ if err != nil {
+ return nil, err
}
- return nil
-}
-
-func (f *Fs) GetInfo(remote string) (*FileInfo, error) {
- fs.Debugf(f, "ENTER function 'GetInfo' on file %s", remote)
- defer fs.Debugf(f, "EXIT function 'GetInfo'")
- dir := filepath.Dir(remote)
- base := filepath.Base(remote)
-
- f.mu.Lock()
- files, _ := f.c.List(dir)
- f.mu.Unlock()
- for i := range files {
- if files[i].Name == base {
- info := &FileInfo{
- Name: remote,
- Size: files[i].Size,
- ModTime: files[i].Time,
- IsDir: files[i].Type == ftp.EntryTypeFolder,
- }
- return info, nil
- }
- }
- return nil, fs.ErrorObjectNotFound
+ f := &Fs{
+ name: name,
+ root: u.Path,
+ c: c,
+ url: u,
+ mu: sync.Mutex{},
+ }
+ f.features = (&fs.Features{}).Fill(f)
+ return f, err
}
+// NewObject finds the Object at remote. If it can't be found
+// it returns the error fs.ErrorObjectNotFound.
func (f *Fs) NewObject(remote string) (fs.Object, error) {
fs.Debugf(f, "ENTER function 'NewObject' called with remote %s", remote)
defer fs.Debugf(f, "EXIT function 'NewObject'")
@@ -277,6 +236,16 @@ func (f *Fs) list(out fs.ListOpts, dir string, curlevel int) {
}
}
+// List the objects and directories of the Fs starting from dir
+//
+// dir should be "" to start from the root, and should not
+// have trailing slashes.
+//
+// This should return ErrDirNotFound (using out.SetError())
+// if the directory isn't found.
+//
+// Fses must support recursion levels of fs.MaxLevel and 1.
+// They may return ErrorLevelNotSupported otherwise.
func (f *Fs) List(out fs.ListOpts, dir string) {
fs.Debugf(f, "ENTER function 'List' on directory '%s/%s'", f.root, dir)
defer fs.Debugf(f, "EXIT function 'List' for directory '%s/%s'", f.root, dir)
@@ -284,39 +253,237 @@ func (f *Fs) List(out fs.ListOpts, dir string) {
out.Finished()
}
-////////////////////
-// Object methods //
-////////////////////
+// Hashes are not supported
+func (f *Fs) Hashes() fs.HashSet {
+ return 0
+}
+// Precision shows Modified Time not supported
+func (f *Fs) Precision() time.Duration {
+ return fs.ModTimeNotSupported
+}
+
+// Put in to the remote path with the modTime given of the given size
+//
+// May create the object even if it returns an error - if so
+// will return the object and the error, otherwise will return
+// nil and the error
+func (f *Fs) Put(in io.Reader, src fs.ObjectInfo) (fs.Object, error) {
+ fs.Debugf(f, "Trying to put file %s", src.Remote())
+ o := &Object{
+ fs: f,
+ remote: src.Remote(),
+ }
+ err := o.Update(in, src)
+ return o, err
+}
+
+// getInfo reads the FileInfo for a path
+func (f *Fs) getInfo(remote string) (*FileInfo, error) {
+ fs.Debugf(f, "ENTER function 'getInfo' on file %s", remote)
+ defer fs.Debugf(f, "EXIT function 'getInfo'")
+ dir := filepath.Dir(remote)
+ base := filepath.Base(remote)
+
+ f.mu.Lock()
+ files, _ := f.c.List(dir)
+ f.mu.Unlock()
+ for i := range files {
+ if files[i].Name == base {
+ info := &FileInfo{
+ Name: remote,
+ Size: files[i].Size,
+ ModTime: files[i].Time,
+ IsDir: files[i].Type == ftp.EntryTypeFolder,
+ }
+ return info, nil
+ }
+ }
+ return nil, fs.ErrorObjectNotFound
+}
+
+func (f *Fs) mkdir(abspath string) error {
+ _, err := f.getInfo(abspath)
+ if err != nil {
+ fs.Debugf(f, "Trying to create directory %s", abspath)
+ f.mu.Lock()
+ err := f.c.MakeDir(abspath)
+ f.mu.Unlock()
+ if err != nil {
+ return err
+ }
+ }
+ return err
+}
+
+// Mkdir creates the container if it doesn't exist
+func (f *Fs) Mkdir(dir string) error {
+ // This actually works as mkdir -p
+ fs.Debugf(f, "ENTER function 'Mkdir' on '%s/%s'", f.root, dir)
+ defer fs.Debugf(f, "EXIT function 'Mkdir' on '%s/%s'", f.root, dir)
+ abspath := filepath.Join(f.root, dir)
+ tokens := strings.Split(abspath, "/")
+ curdir := ""
+ for i := range tokens {
+ curdir += "/" + tokens[i]
+ err := f.mkdir(curdir)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
+// Rmdir removes the directory (container, bucket) if empty
+//
+// Return an error if it doesn't exist or isn't empty
+func (f *Fs) Rmdir(dir string) error {
+ // This is actually a recursive remove directory
+ f.mu.Lock()
+ files, err := f.c.List(filepath.Join(f.root, dir))
+ f.mu.Unlock()
+ if err != nil {
+ return errors.Wrap(err, "rmdir")
+ }
+ for i := range files {
+ if files[i].Type == ftp.EntryTypeFolder {
+ err = f.Rmdir(filepath.Join(dir, files[i].Name))
+ if err != nil {
+ return errors.Wrap(err, "rmdir")
+ }
+ }
+ }
+ f.mu.Lock()
+ err = f.c.RemoveDir(filepath.Join(f.root, dir))
+ f.mu.Unlock()
+ return err
+}
+
+// ------------------------------------------------------------
+
+// Fs returns the parent Fs
+func (o *Object) Fs() fs.Info {
+ return o.fs
+}
+
+// String version of o
+func (o *Object) String() string {
+ if o == nil {
+ return "<nil>"
+ }
+ return o.remote
+}
+
+// Remote returns the remote path
+func (o *Object) Remote() string {
+ return o.remote
+}
+
+// Hash returns the hash of an object returning a lowercase hex string
func (o *Object) Hash(t fs.HashType) (string, error) {
return "", fs.ErrHashUnsupported
}
+// Size returns the size of an object in bytes
+func (o *Object) Size() int64 {
+ return int64(o.info.Size)
+}
+
+// ModTime returns the modification time of the object
+func (o *Object) ModTime() time.Time {
+ return o.info.ModTime
+}
+
+// SetModTime sets the modification time of the object
+func (o *Object) SetModTime(modTime time.Time) error {
+ return nil
+}
+
+// Storable returns a boolean as to whether this object is storable
+func (o *Object) Storable() bool {
+ return true
+}
+
+// ftpReadCloser implements io.ReadCloser for FTP objects.
+type ftpReadCloser struct {
+ io.ReadCloser
+ c *ftp.ServerConn
+}
+
+// Close the FTP reader
+func (f *ftpReadCloser) Close() error {
+ err := f.ReadCloser.Close()
+ err2 := f.c.Quit()
+ if err == nil {
+ err = err2
+ }
+ return err
+}
+
+// Open an object for read
func (o *Object) Open(options ...fs.OpenOption) (io.ReadCloser, error) {
path := filepath.Join(o.fs.root, o.remote)
fs.Debugf(o.fs, "ENTER function 'Open' on file '%s' in root '%s'", o.remote, o.fs.root)
defer fs.Debugf(o.fs, "EXIT function 'Open' %s", path)
c, _, err := ftpConnection(o.fs.name, o.fs.root)
if err != nil {
- return nil, err
+ return nil, errors.Wrap(err, "open")
}
fd, err := c.Retr(path)
if err != nil {
- return nil, err
+ return nil, errors.Wrap(err, "open")
}
- return FtpReadCloser{path, c, fd}, nil
+ return &ftpReadCloser{ReadCloser: fd, c: c}, nil
}
-func (o *Object) Remote() string {
- return o.remote
+// makeAllDir creates the parent directories for the object
+func (o *Object) makeAllDir() error {
+ tokens := strings.Split(filepath.Dir(o.remote), "/")
+ dir := ""
+ for i := range tokens {
+ dir += tokens[i] + "/"
+ err := o.fs.Mkdir(dir)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
}
+// Update the already existing object
+//
+// Copy the reader into the object updating modTime and size
+//
+// The new object may have been created if an error is returned
+func (o *Object) Update(in io.Reader, src fs.ObjectInfo) error {
+ // Create all upper directory first...
+ err := o.makeAllDir()
+ if err != nil {
+ return errors.Wrap(err, "update")
+ }
+ path := filepath.Join(o.fs.root, o.remote)
+ c, _, err := ftpConnection(o.fs.name, o.fs.root)
+ if err != nil {
+ return errors.Wrap(err, "update")
+ }
+ err = c.Stor(path, in)
+ if err != nil {
+ return errors.Wrap(err, "update")
+ }
+ o.info, err = o.fs.getInfo(path)
+ if err != nil {
+ return errors.Wrap(err, "update")
+ }
+ return nil
+}
+
+// Remove an object
func (o *Object) Remove() error {
path := filepath.Join(o.fs.root, o.remote)
fs.Debugf(o, "ENTER function 'Remove' for obejct at %s", path)
defer fs.Debugf(o, "EXIT function 'Remove' for obejct at %s", path)
// Check if it's a directory or a file
- info, _ := o.fs.GetInfo(path)
+ info, _ := o.fs.getInfo(path)
var err error
if info.IsDir {
err = o.fs.Rmdir(o.remote)
@@ -328,112 +495,6 @@ func (o *Object) Remove() error {
return err
}
-func (o *Object) SetModTime(modTime time.Time) error {
- return nil
-}
-
-func (o *Object) Fs() fs.Info {
- return o.fs
-}
-
-func (o *Object) ModTime() time.Time {
- return o.info.ModTime
-}
-
-func (o *Object) Size() int64 {
- return int64(o.info.Size)
-}
-
-func (o *Object) Storable() bool {
- return true
-}
-
-func (o *Object) String() string {
- return fmt.Sprintf("FTP file at %s/%s", o.fs.url.String(), o.remote)
-}
-
-func (o *Object) MakeAllDir() {
- tokens := strings.Split(filepath.Dir(o.remote), "/")
- dir := ""
- for i := range tokens {
- dir += tokens[i] + "/"
- o.fs.Mkdir(dir)
- }
-}
-func (o *Object) Update(in io.Reader, src fs.ObjectInfo) error {
- // Create all upper directory first...
- o.MakeAllDir()
- path := filepath.Join(o.fs.root, o.remote)
- c, _, _ := ftpConnection(o.fs.name, o.fs.root)
- err := c.Stor(path, in)
- o.info, _ = o.fs.GetInfo(path)
- return err
-}
-
-///////////////////////////
-// FtpReadCloser methods //
-///////////////////////////
-
-func (f FtpReadCloser) Read(p []byte) (int, error) {
- return f.fd.Read(p)
-}
-
-func (f FtpReadCloser) Close() error {
- err := f.fd.Close()
- defer f.c.Quit()
- if err != nil {
- return nil
- }
- return nil
-}
-
-// This mutex is only used by ftpConnection. We create a new ftp
-// connection for each transfer, but we need to serialize it otherwise
-// Dial() and Login() might be mixed...
-var globalMux = sync.Mutex{}
-
-func ftpConnection(name, root string) (*ftp.ServerConn, Url, error) {
- // Open a new connection to the FTP server.
- url := fs.ConfigFileGet(name, "url")
- user := fs.ConfigFileGet(name, "username")
- pass := fs.ConfigFileGet(name, "password")
- u := parseUrl(url)
- u.Path = filepath.Join(u.Path, root)
- fs.Debugf(nil, "New ftp Connection with name %s and url %s (path %s)", name, u.String(), u.Path)
- globalMux.Lock()
- defer globalMux.Unlock()
- c, err := ftp.DialTimeout(u.ToDial(), 30*time.Second)
- if err != nil {
- fs.Errorf(nil, "Error while Dialing %s: %s", u.ToDial(), err)
- return nil, u, err
- }
- err = c.Login(user, pass)
- if err != nil {
- fs.Errorf(nil, "Error while Logging in into %s: %s", u.ToDial(), err)
- return nil, u, err
- }
- return c, u, nil
-}
-
-// Register the FS
-func NewFs(name, root string) (fs.Fs, error) {
- fs.Debugf(nil, "ENTER function 'NewFs' with name %s and root %s", name, root)
- defer fs.Debugf(nil, "EXIT function 'NewFs'")
- c, u, err := ftpConnection(name, root)
- if err != nil {
- return nil, err
- }
- f := &Fs{
- name: name,
- root: u.Path,
- c: c,
- url: u,
- mu: sync.Mutex{},
- }
- f.features = (&fs.Features{}).Fill(f)
- return f, err
-}
-
// Check the interfaces are satisfied
var (
_ fs.Fs = &Fs{}
diff --git a/ftp/ftp_internal_test.go b/ftp/ftp_internal_test.go
index cea83a48e..0e28b3b9f 100644
--- a/ftp/ftp_internal_test.go
+++ b/ftp/ftp_internal_test.go
@@ -2,16 +2,16 @@ package ftp
import "testing"
-func TestParseUrlToDial(t *testing.T){
+func TestParseUrlToDial(t *testing.T) {
for _, test := range []struct {
- in string
+ in string
want string
}{
{"ftp://foo.bar", "foo.bar:21"},
{"http://foo.bar", "foo.bar:21"},
{"ftp:/foo.bar:123", "foo.bar:123"},
} {
- u := parseUrl(test.in)
+ u := parseURL(test.in)
got := u.ToDial()
if got != test.want {
t.Logf("%q: want %q got %q", test.in, test.want, got)
@@ -19,16 +19,16 @@ func TestParseUrlToDial(t *testing.T){
}
}
-func TestParseUrlPath(t *testing.T){
+func TestParseUrlPath(t *testing.T) {
for _, test := range []struct {
- in string
+ in string
want string
}{
{"ftp://foo.bar/", "/"},
{"ftp://foo.bar/debian", "/debian"},
{"ftp://foo.bar", "/"},
} {
- u := parseUrl(test.in)
+ u := parseURL(test.in)
if u.Path != test.want {
t.Logf("%q: want %q got %q", test.in, test.want, u.Path)
}