Merge pull request #270 from crazy-max/regexp-opt

Option to escape all regular expression metacharacters

Author: crazy-max

docs/config/server/ftp.md

@@ -17,6 +17,7 @@
         disableUTF8: false
         disableEPSV: false
         disableMLSD: false
+        escapeRegexpMeta: false
         tls: false
         insecureSkipVerify: false
         logTrace: false
@@ -182,6 +183,25 @@ properly. (default `false`)
 !!! abstract "Environment variables"
     * `FTPGRAB_SERVER_FTP_DISABLEMLSD`
 
+### `escapeRegexpMeta`
+
+Escapes all regular expression metacharacters in the source path. (default `false`)
+
+!!! warning
+    This setting is only useful for FTP servers that enforce global matching or
+    if you don't want to use regular expressions when listing files.
+    More info: https://github.com/crazy-max/ftpgrab/issues/49#issuecomment-489137115
+
+!!! example "Config file"
+    ```yaml
+    server:
+      ftp:
+        escapeRegexpMeta: false
+    ```
+
+!!! abstract "Environment variables"
+    * `FTPGRAB_SERVER_FTP_ESCAPEREGEXPMETA`
+
 ### `tls`
 
 Use implicit FTP over TLS. (default `false`)

internal/config/config_test.go

@@ -54,6 +54,7 @@ func TestLoadFile(t *testing.T) {
 						DisableUTF8:        utl.NewFalse(),
 						DisableEPSV:        utl.NewFalse(),
 						DisableMLSD:        utl.NewFalse(),
+						EscapeRegexpMeta:   utl.NewFalse(),
 						TLS:                utl.NewFalse(),
 						InsecureSkipVerify: utl.NewFalse(),
 						LogTrace:           utl.NewFalse(),
@@ -159,6 +160,7 @@ func TestLoadEnv(t *testing.T) {
 						DisableUTF8:        utl.NewFalse(),
 						DisableEPSV:        utl.NewFalse(),
 						DisableMLSD:        utl.NewFalse(),
+						EscapeRegexpMeta:   utl.NewFalse(),
 						TLS:                utl.NewFalse(),
 						InsecureSkipVerify: utl.NewFalse(),
 						LogTrace:           utl.NewFalse(),
@@ -315,6 +317,7 @@ func TestLoadMixed(t *testing.T) {
 						DisableUTF8:        utl.NewFalse(),
 						DisableEPSV:        utl.NewFalse(),
 						DisableMLSD:        utl.NewFalse(),
+						EscapeRegexpMeta:   utl.NewFalse(),
 						TLS:                utl.NewFalse(),
 						InsecureSkipVerify: utl.NewFalse(),
 						LogTrace:           utl.NewFalse(),

internal/config/server_ftp.go

@@ -19,6 +19,7 @@ type ServerFTP struct {
 	DisableUTF8        *bool          `yaml:"disableUTF8,omitempty" json:"disableUTF8,omitempty"`
 	DisableEPSV        *bool          `yaml:"disableEPSV,omitempty" json:"disableEPSV,omitempty"`
 	DisableMLSD        *bool          `yaml:"disableMLSD,omitempty" json:"disableMLSD,omitempty"`
+	EscapeRegexpMeta   *bool          `yaml:"escapeRegexpMeta,omitempty" json:"escapeRegexpMeta,omitempty"`
 	TLS                *bool          `yaml:"tls,omitempty" json:"tls,omitempty"`
 	InsecureSkipVerify *bool          `yaml:"insecureSkipVerify,omitempty" json:"insecureSkipVerify,omitempty"`
 	LogTrace           *bool          `yaml:"logTrace,omitempty" json:"logTrace,omitempty"`
@@ -39,6 +40,7 @@ func (s *ServerFTP) SetDefaults() {
 	s.DisableUTF8 = utl.NewFalse()
 	s.DisableEPSV = utl.NewFalse()
 	s.DisableMLSD = utl.NewFalse()
+	s.EscapeRegexpMeta = utl.NewFalse()
 	s.TLS = utl.NewFalse()
 	s.InsecureSkipVerify = utl.NewFalse()
 	s.LogTrace = utl.NewFalse()

internal/server/ftp/client.go

@@ -76,9 +76,13 @@ func (c *Client) Common() config.ServerCommon {
 }
 
 // ReadDir fetches the contents of a directory, returning a list of os.FileInfo's
-func (c *Client) ReadDir(path string) ([]os.FileInfo, error) {
+func (c *Client) ReadDir(dir string) ([]os.FileInfo, error) {
 	var files []*ftp.Entry
-	files, err := c.ftp.List(regexp.QuoteMeta(path))
+
+	if *c.cfg.EscapeRegexpMeta {
+		dir = regexp.QuoteMeta(dir)
+	}
+	files, err := c.ftp.List(dir)
 	if err != nil {
 		return nil, err
 	}