// Copyright (C) 2014 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 ( "fmt" "path/filepath" "regexp" "strings" "time" "github.com/pkg/errors" "github.com/syncthing/syncthing/lib/fs" "github.com/syncthing/syncthing/lib/osutil" ) var locationLocal *time.Location var errDirectory = fmt.Errorf("cannot restore on top of a directory") var errNotFound = fmt.Errorf("version not found") var errFileAlreadyExists = fmt.Errorf("file already exists") func init() { var err error locationLocal, err = time.LoadLocation("Local") if err != nil { panic(err.Error()) } } // Inserts ~tag just before the extension of the filename. func TagFilename(name, tag string) string { dir, file := filepath.Dir(name), filepath.Base(name) ext := filepath.Ext(file) withoutExt := file[:len(file)-len(ext)] return filepath.Join(dir, withoutExt+"~"+tag+ext) } var tagExp = regexp.MustCompile(`.*~([^~.]+)(?:\.[^.]+)?$`) // Returns the tag from a filename, whether at the end or middle. func ExtractTag(path string) string { match := tagExp.FindStringSubmatch(path) // match is []string{"whole match", "submatch"} when successful if len(match) != 2 { return "" } return match[1] } func UntagFilename(path string) (string, string) { ext := filepath.Ext(path) versionTag := ExtractTag(path) // Files tagged with old style tags cannot be untagged. if versionTag == "" { return "", "" } // Old style tag if strings.HasSuffix(ext, versionTag) { return strings.TrimSuffix(path, "~"+versionTag), versionTag } withoutExt := path[:len(path)-len(ext)-len(versionTag)-1] name := withoutExt + ext return name, versionTag } func retrieveVersions(fileSystem fs.Filesystem) (map[string][]FileVersion, error) { files := make(map[string][]FileVersion) err := fileSystem.Walk(".", func(path string, f fs.FileInfo, err error) error { // Skip root (which is ok to be a symlink) if path == "." { return nil } // Skip walking if we cannot walk... if err != nil { return err } // Ignore symlinks if f.IsSymlink() { return fs.SkipDir } // No records for directories if f.IsDir() { return nil } path = osutil.NormalizedFilename(path) name, tag := UntagFilename(path) // Something invalid, assume it's an untagged file if name == "" || tag == "" { versionTime := f.ModTime().Truncate(time.Second) files[path] = append(files[path], FileVersion{ VersionTime: versionTime, ModTime: versionTime, Size: f.Size(), }) return nil } versionTime, err := time.ParseInLocation(TimeFormat, tag, locationLocal) if err != nil { // Can't parse it, welp, continue return nil } if err == nil { files[name] = append(files[name], FileVersion{ VersionTime: versionTime.Truncate(time.Second), ModTime: f.ModTime().Truncate(time.Second), Size: f.Size(), }) } return nil }) if err != nil { return nil, err } return files, nil } type fileTagger func(string, string) string func archiveFile(srcFs, dstFs fs.Filesystem, filePath string, tagger fileTagger) error { filePath = osutil.NativeFilename(filePath) info, err := srcFs.Lstat(filePath) if fs.IsNotExist(err) { l.Debugln("not archiving nonexistent file", filePath) return nil } else if err != nil { return err } if info.IsSymlink() { panic("bug: attempting to version a symlink") } _, err = dstFs.Stat(".") if err != nil { if fs.IsNotExist(err) { l.Debugln("creating versions dir") err := dstFs.Mkdir(".", 0755) if err != nil { return err } _ = dstFs.Hide(".") } else { return err } } l.Debugln("archiving", filePath) file := filepath.Base(filePath) inFolderPath := filepath.Dir(filePath) err = dstFs.MkdirAll(inFolderPath, 0755) if err != nil && !fs.IsExist(err) { return err } ver := tagger(file, info.ModTime().Format(TimeFormat)) dst := filepath.Join(inFolderPath, ver) l.Debugln("moving to", dst) err = osutil.RenameOrCopy(srcFs, dstFs, filePath, dst) // Set the mtime to the time the file was deleted. This can be used by the // cleanout routine. If this fails things won't work optimally but there's // not much we can do about it so we ignore the error. _ = dstFs.Chtimes(dst, time.Now(), time.Now()) return err } func restoreFile(src, dst fs.Filesystem, filePath string, versionTime time.Time, tagger fileTagger) error { // If the something already exists where we are restoring to, archive existing file for versioning // remove if it's a symlink, or fail if it's a directory if info, err := dst.Lstat(filePath); err == nil { switch { case info.IsDir(): return errDirectory case info.IsSymlink(): // Remove existing symlinks (as we don't want to archive them) if err := dst.Remove(filePath); err != nil { return errors.Wrap(err, "removing existing symlink") } case info.IsRegular(): if err := archiveFile(dst, src, filePath, tagger); err != nil { return errors.Wrap(err, "archiving existing file") } default: panic("bug: unknown item type") } } else if !fs.IsNotExist(err) { return err } filePath = osutil.NativeFilename(filePath) tag := versionTime.In(locationLocal).Truncate(time.Second).Format(TimeFormat) taggedFilename := TagFilename(filePath, tag) oldTaggedFilename := filePath + tag untaggedFileName := filePath // Check that the thing we've been asked to restore is actually a file // and that it exists. sourceFile := "" for _, candidate := range []string{taggedFilename, oldTaggedFilename, untaggedFileName} { if info, err := src.Lstat(candidate); fs.IsNotExist(err) || !info.IsRegular() { continue } else if err != nil { // All other errors are fatal return err } else if candidate == untaggedFileName && !info.ModTime().Truncate(time.Second).Equal(versionTime) { // No error, and untagged file, but mtime does not match, skip continue } sourceFile = candidate break } if sourceFile == "" { return errNotFound } // Check that the target location of where we are supposed to restore does not exist. // This should have been taken care of by the first few lines of this function. if _, err := dst.Lstat(filePath); err == nil { return errFileAlreadyExists } else if !fs.IsNotExist(err) { return err } _ = dst.MkdirAll(filepath.Dir(filePath), 0755) return osutil.RenameOrCopy(src, dst, sourceFile, filePath) } func fsFromParams(folderFs fs.Filesystem, params map[string]string) (versionsFs fs.Filesystem) { if params["fsType"] == "" && params["fsPath"] == "" { versionsFs = fs.NewFilesystem(folderFs.Type(), filepath.Join(folderFs.URI(), ".stversions")) } else if params["fsType"] == "" { uri := params["fsPath"] // We only know how to deal with relative folders for basic filesystems, as that's the only one we know // how to check if it's absolute or relative. if folderFs.Type() == fs.FilesystemTypeBasic && !filepath.IsAbs(params["fsPath"]) { uri = filepath.Join(folderFs.URI(), params["fsPath"]) } versionsFs = fs.NewFilesystem(folderFs.Type(), uri) } else { var fsType fs.FilesystemType _ = fsType.UnmarshalText([]byte(params["fsType"])) versionsFs = fs.NewFilesystem(fsType, params["fsPath"]) } l.Debugln("%s (%s) folder using %s (%s) versioner dir", folderFs.URI(), folderFs.Type(), versionsFs.URI(), versionsFs.Type()) return }