mirror of
https://github.com/octoleo/syncthing.git
synced 2024-11-14 01:04:14 +00:00
4e151d380c
* lib/versioner: Reduce surface area This is a refactor while I was anyway rooting around in the versioner. Instead of exporting every possible implementation and the factory and letting the caller do whatever, this now encapsulates all that and exposes a New() that takes a config.VersioningConfiguration. Given that and that we don't know (from the outside) how a versioner works or what state it keeps, we now just construct it once per folder and keep it around. Previously it was recreated for each restore request. * unparam * wip
50 lines
1.4 KiB
Go
50 lines
1.4 KiB
Go
// 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 implements common interfaces for file versioning and a
|
|
// simple default versioning scheme.
|
|
package versioner
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/syncthing/syncthing/lib/config"
|
|
"github.com/syncthing/syncthing/lib/fs"
|
|
)
|
|
|
|
type Versioner interface {
|
|
Archive(filePath string) error
|
|
GetVersions() (map[string][]FileVersion, error)
|
|
Restore(filePath string, versionTime time.Time) error
|
|
}
|
|
|
|
type FileVersion struct {
|
|
VersionTime time.Time `json:"versionTime"`
|
|
ModTime time.Time `json:"modTime"`
|
|
Size int64 `json:"size"`
|
|
}
|
|
|
|
type factory func(filesystem fs.Filesystem, params map[string]string) Versioner
|
|
|
|
var factories = make(map[string]factory)
|
|
|
|
var ErrRestorationNotSupported = fmt.Errorf("version restoration not supported with the current versioner")
|
|
|
|
const (
|
|
TimeFormat = "20060102-150405"
|
|
timeGlob = "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9][0-9][0-9]" // glob pattern matching TimeFormat
|
|
)
|
|
|
|
func New(fs fs.Filesystem, cfg config.VersioningConfiguration) (Versioner, error) {
|
|
fac, ok := factories[cfg.Type]
|
|
if !ok {
|
|
return nil, fmt.Errorf("requested versioning type %q does not exist", cfg.Type)
|
|
}
|
|
|
|
return fac(fs, cfg.Params), nil
|
|
}
|