"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files
Go azure-blobazure-blob-storageazure-filesbackblaze-b2cloud-storagedropboxencryptionftpfuse-filesystemgogolanggoogle-cloud-storagegoogle-driveonedriveopenstack-swiftrclones3sftpsyncwebdav
drive: implement rclone backend rescue to rescue orphaned files
Nick Craig-Wood264c9fb2c00d
diff --git a/backend/drive/drive.go b/backend/drive/drive.goindex f39800af0..f49603437 100644--- a/backend/drive/drive.go+++ b/backend/drive/drive.go@@ -3559,7 +3559,8 @@ func (f *Fs) copyID(ctx context.Context, id, dest string) (err error) {return nil}-func (f *Fs) query(ctx context.Context, query string) (entries []*drive.File, err error) {+// Run the drive query calling fn on each entry found+func (f *Fs) queryFn(ctx context.Context, query string, fn func(*drive.File)) (err error) {list := f.svc.Files.List()if query != "" {list.Q(query)@@ -3578,10 +3579,7 @@ func (f *Fs) query(ctx context.Context, query string) (entries []*drive.File, erif f.rootFolderID == "appDataFolder" {list.Spaces("appDataFolder")}-fields := fmt.Sprintf("files(%s),nextPageToken,incompleteSearch", f.getFileFields(ctx))-- var results []*drive.Filefor {var files *drive.FileListerr = f.pacer.Call(func() (bool, error) {@@ -3589,20 +3587,66 @@ func (f *Fs) query(ctx context.Context, query string) (entries []*drive.File, erreturn f.shouldRetry(ctx, err)})if err != nil {- return nil, fmt.Errorf("failed to execute query: %w", err)+ return fmt.Errorf("failed to execute query: %w", err)}if files.IncompleteSearch {fs.Errorf(f, "search result INCOMPLETE")}- results = append(results, files.Files...)+ for _, item := range files.Files {+ fn(item)+ }if files.NextPageToken == "" {break}list.PageToken(files.NextPageToken)}+ return nil+}++// Run the drive query returning the entries found+func (f *Fs) query(ctx context.Context, query string) (entries []*drive.File, err error) {+ var results []*drive.File+ err = f.queryFn(ctx, query, func(item *drive.File) {+ results = append(results, item)+ })+ if err != nil {+ return nil, err+ }return results, nil}+// Rescue, list or delete orphaned files+func (f *Fs) rescue(ctx context.Context, dirID string, delete bool) (err error) {+ return f.queryFn(ctx, "'me' in owners and trashed=false", func(item *drive.File) {+ if len(item.Parents) != 0 {+ return+ }+ // Have found an orphaned entry+ if delete {+ fs.Infof(item.Name, "Deleting orphan %q into trash", item.Id)+ err = f.delete(ctx, item.Id, true)+ if err != nil {+ fs.Errorf(item.Name, "Failed to delete orphan %q: %v", item.Id, err)+ }+ } else if dirID == "" {+ operations.SyncPrintf("%q, %q\n", item.Name, item.Id)+ } else {+ fs.Infof(item.Name, "Rescuing orphan %q", item.Id)+ err = f.pacer.Call(func() (bool, error) {+ _, err = f.svc.Files.Update(item.Id, nil).+ AddParents(dirID).+ Fields(f.getFileFields(ctx)).+ SupportsAllDrives(true).+ Context(ctx).Do()+ return f.shouldRetry(ctx, err)+ })+ if err != nil {+ fs.Errorf(item.Name, "Failed to rescue orphan %q: %v", item.Id, err)+ }+ }+ })+}+var commandHelp = []fs.CommandHelp{{Name: "get",Short: "Get command for fetching the drive config parameters",@@ -3794,6 +3838,37 @@ The result is a JSON array of matches, for example:"webViewLink": "https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk\u0026resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC"}]`,+}, {+ Name: "rescue",+ Short: "Rescue or delete any orphaned files",+ Long: `This command rescues or deletes any orphaned files or directories.++Sometimes files can get orphaned in Google Drive. This means that they+are no longer in any folder in Google Drive.++This command finds those files and either rescues them to a directory+you specify or deletes them.++Usage:++This can be used in 3 ways.++First, list all orphaned files++ rclone backend rescue drive:++Second rescue all orphaned files to the directory indicated++ rclone backend rescue drive: "relative/path/to/rescue/directory"++e.g. To rescue all orphans to a directory called "Orphans" in the top level++ rclone backend rescue drive: Orphans++Third delete all orphaned files to the trash++ rclone backend rescue drive: -o delete+`,}}// Command the backend to run a named command@@ -3922,6 +3997,22 @@ func (f *Fs) Command(ctx context.Context, name string, arg []string, opt map[str} else {return nil, errors.New("need a query argument")}+ case "rescue":+ dirID := ""+ _, delete := opt["delete"]+ if len(arg) == 0 {+ // no arguments - list only+ } else if !delete && len(arg) == 1 {+ dir := arg[0]+ dirID, err = f.dirCache.FindDir(ctx, dir, true)+ if err != nil {+ return nil, fmt.Errorf("failed to find or create rescue directory %q: %w", dir, err)+ }+ fs.Infof(f, "Rescuing orphans into %q", dir)+ } else {+ return nil, errors.New("syntax error: need 0 or 1 args or -o delete")+ }+ return nil, f.rescue(ctx, dirID, delete)default:return nil, fs.ErrorCommandNotFound}