overdue

.rclone_repo/vfs/rc.go

@@ -0,0 +1,171 @@
+package vfs
+
+import (
+	"strconv"
+	"strings"
+
+	"github.com/ncw/rclone/fs"
+	"github.com/ncw/rclone/fs/rc"
+	"github.com/pkg/errors"
+)
+
+// Add remote control for the VFS
+func (vfs *VFS) addRC() {
+	rc.Add(rc.Call{
+		Path: "vfs/forget",
+		Fn: func(in rc.Params) (out rc.Params, err error) {
+			root, err := vfs.Root()
+			if err != nil {
+				return nil, err
+			}
+
+			forgotten := []string{}
+			if len(in) == 0 {
+				root.ForgetAll()
+			} else {
+				for k, v := range in {
+					path, ok := v.(string)
+					if !ok {
+						return out, errors.Errorf("value must be string %q=%v", k, v)
+					}
+					path = strings.Trim(path, "/")
+					if strings.HasPrefix(k, "file") {
+						root.ForgetPath(path, fs.EntryObject)
+					} else if strings.HasPrefix(k, "dir") {
+						root.ForgetPath(path, fs.EntryDirectory)
+					} else {
+						return out, errors.Errorf("unknown key %q", k)
+					}
+					forgotten = append(forgotten, path)
+				}
+			}
+			out = rc.Params{
+				"forgotten": forgotten,
+			}
+			return out, nil
+		},
+		Title: "Forget files or directories in the directory cache.",
+		Help: `
+This forgets the paths in the directory cache causing them to be
+re-read from the remote when needed.
+
+If no paths are passed in then it will forget all the paths in the
+directory cache.
+
+    rclone rc vfs/forget
+
+Otherwise pass files or dirs in as file=path or dir=path.  Any
+parameter key starting with file will forget that file and any
+starting with dir will forget that dir, eg
+
+    rclone rc vfs/forget file=hello file2=goodbye dir=home/junk
+
+`,
+	})
+	rc.Add(rc.Call{
+		Path: "vfs/refresh",
+		Fn: func(in rc.Params) (out rc.Params, err error) {
+			root, err := vfs.Root()
+			if err != nil {
+				return nil, err
+			}
+			getDir := func(path string) (*Dir, error) {
+				path = strings.Trim(path, "/")
+				segments := strings.Split(path, "/")
+				var node Node = root
+				for _, s := range segments {
+					if dir, ok := node.(*Dir); ok {
+						node, err = dir.stat(s)
+						if err != nil {
+							return nil, err
+						}
+					}
+				}
+				if dir, ok := node.(*Dir); ok {
+					return dir, nil
+				}
+				return nil, EINVAL
+			}
+
+			recursive := false
+			{
+				const k = "recursive"
+
+				if v, ok := in[k]; ok {
+					s, ok := v.(string)
+					if !ok {
+						return out, errors.Errorf("value must be string %q=%v", k, v)
+					}
+					recursive, err = strconv.ParseBool(s)
+					if err != nil {
+						return out, errors.Errorf("invalid value %q=%v", k, v)
+					}
+					delete(in, k)
+				}
+			}
+
+			result := map[string]string{}
+			if len(in) == 0 {
+				if recursive {
+					err = root.readDirTree()
+				} else {
+					err = root.readDir()
+				}
+				if err != nil {
+					result[""] = err.Error()
+				} else {
+					result[""] = "OK"
+				}
+			} else {
+				for k, v := range in {
+					path, ok := v.(string)
+					if !ok {
+						return out, errors.Errorf("value must be string %q=%v", k, v)
+					}
+					if strings.HasPrefix(k, "dir") {
+						dir, err := getDir(path)
+						if err != nil {
+							result[path] = err.Error()
+						} else {
+							if recursive {
+								err = dir.readDirTree()
+							} else {
+								err = dir.readDir()
+							}
+							if err != nil {
+								result[path] = err.Error()
+							} else {
+								result[path] = "OK"
+							}
+
+						}
+					} else {
+						return out, errors.Errorf("unknown key %q", k)
+					}
+				}
+			}
+			out = rc.Params{
+				"result": result,
+			}
+			return out, nil
+		},
+		Title: "Refresh the directory cache.",
+		Help: `
+This reads the directories for the specified paths and freshens the
+directory cache.
+
+If no paths are passed in then it will refresh the root directory.
+
+    rclone rc vfs/refresh
+
+Otherwise pass directories in as dir=path. Any parameter key
+starting with dir will refresh that directory, eg
+
+    rclone rc vfs/refresh dir=home/junk dir2=data/misc
+
+If the parameter recursive=true is given the whole directory tree
+will get refreshed. This refresh will use --fast-list if enabled.
+
+`,
+	})
+}