123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 |
- // Copyright (C) 2015 The Syncthing Authors.
- //
- // This Source Code Form is subject to the terms of the Mozilla Public
- // License, v. 2.0. If a copy of the MPL was not distributed with this file,
- // You can obtain one at https://mozilla.org/MPL/2.0/.
- package versioner
- import (
- "context"
- "fmt"
- "strconv"
- "time"
- "github.com/syncthing/syncthing/lib/config"
- "github.com/syncthing/syncthing/lib/fs"
- )
- func init() {
- // Register the constructor for this type of versioner
- factories["trashcan"] = newTrashcan
- }
- type trashcan struct {
- folderFs fs.Filesystem
- versionsFs fs.Filesystem
- cleanoutDays int
- copyRangeMethod fs.CopyRangeMethod
- }
- func newTrashcan(cfg config.FolderConfiguration) Versioner {
- cleanoutDays, _ := strconv.Atoi(cfg.Versioning.Params["cleanoutDays"])
- // On error we default to 0, "do not clean out the trash can"
- s := &trashcan{
- folderFs: cfg.Filesystem(nil),
- versionsFs: versionerFsFromFolderCfg(cfg),
- cleanoutDays: cleanoutDays,
- copyRangeMethod: cfg.CopyRangeMethod,
- }
- l.Debugf("instantiated %#v", s)
- return s
- }
- // Archive moves the named file away to a version archive. If this function
- // returns nil, the named file does not exist any more (has been archived).
- func (t *trashcan) Archive(filePath string) error {
- return archiveFile(t.copyRangeMethod, t.folderFs, t.versionsFs, filePath, func(name, tag string) string {
- return name
- })
- }
- func (t *trashcan) String() string {
- return fmt.Sprintf("trashcan@%p", t)
- }
- func (t *trashcan) Clean(ctx context.Context) error {
- if t.cleanoutDays <= 0 {
- return nil
- }
- if _, err := t.versionsFs.Lstat("."); fs.IsNotExist(err) {
- return nil
- }
- cutoff := time.Now().Add(time.Duration(-24*t.cleanoutDays) * time.Hour)
- dirTracker := make(emptyDirTracker)
- walkFn := func(path string, info fs.FileInfo, err error) error {
- if err != nil {
- return err
- }
- select {
- case <-ctx.Done():
- return ctx.Err()
- default:
- }
- if info.IsDir() && !info.IsSymlink() {
- dirTracker.addDir(path)
- return nil
- }
- if info.ModTime().Before(cutoff) {
- // The file is too old; remove it.
- err = t.versionsFs.Remove(path)
- } else {
- // Keep this file, and remember it so we don't unnecessarily try
- // to remove this directory.
- dirTracker.addFile(path)
- }
- return err
- }
- if err := t.versionsFs.Walk(".", walkFn); err != nil {
- return err
- }
- dirTracker.deleteEmptyDirs(t.versionsFs)
- return nil
- }
- func (t *trashcan) GetVersions() (map[string][]FileVersion, error) {
- return retrieveVersions(t.versionsFs)
- }
- func (t *trashcan) Restore(filepath string, versionTime time.Time) error {
- // If we have an untagged file A and want to restore it on top of existing file A, we can't first archive the
- // existing A as we'd overwrite the old A version, therefore when we archive existing file, we archive it with a
- // tag but when the restoration is finished, we rename it (untag it). This is only important if when restoring A,
- // there already exists a file at the same location
- // If we restore a deleted file, there won't be a conflict and archiving won't happen thus there won't be anything
- // in the archive to rename afterwards. Log whether the file exists prior to restoring.
- _, dstPathErr := t.folderFs.Lstat(filepath)
- taggedName := ""
- tagger := func(name, tag string) string {
- // We also abuse the fact that tagger gets called twice, once for tagging the restoration version, which
- // should just return the plain name, and second time by archive which archives existing file in the folder.
- // We can't use TagFilename here, as restoreFile would discover that as a valid version and restore that instead.
- if taggedName != "" {
- return taggedName
- }
- taggedName = fs.TempName(name)
- return name
- }
- if err := restoreFile(t.copyRangeMethod, t.versionsFs, t.folderFs, filepath, versionTime, tagger); taggedName == "" {
- return err
- }
- // If a deleted file was restored, even though the RenameOrCopy method is robust, check if the file exists and
- // skip the renaming function if this is the case.
- if fs.IsNotExist(dstPathErr) {
- if _, err := t.folderFs.Lstat(filepath); err != nil {
- return err
- }
- return nil
- }
- return t.versionsFs.Rename(taggedName, filepath)
- }
|