mirror of
https://github.com/offen/docker-volume-backup.git
synced 2024-09-19 21:20:28 +02:00
279844ccfb
* Added abstract helper interface and implemented it for all storage backends * Moved storage client initializations also to helper classes * Fixed ssh init issue * Moved script parameter to helper struct to simplify script init. * Created sub modules. Enhanced abstract implementation. * Fixed config issue * Fixed declaration issues. Added config to interface. * Added StorageProviders to unify all backends. * Cleanup, optimizations, comments. * Applied discussed changes. See description. Moved modules to internal packages. Replaced StoragePool with slice. Moved conditional for init of storage backends back to script. * Fix docker build issue * Fixed accidentally removed local copy condition. * Delete .gitignore * Renaming/changes according to review Renamed Init functions and interface. Replaced config object with specific config values. Init func returns interface instead of struct. Removed custom import names where possible. * Fixed auto-complete error. * Combined copy instructions into one layer. * Added logging func for storages. * Introduced logging func for errors too. * Missed an error message * Moved config back to main. Optimized prune stats handling. * Move stats back to main package * Code doc stuff * Apply changes from #136 * Replace name field with function. * Changed receiver names from stg to b. * Renamed LogFuncDef to Log * Removed redundant package name. * Renamed storagePool to storages. * Simplified creation of new storage backend. * Added initialization for storage stats map. * Invert .dockerignore patterns. * Fix package typo
59 lines
1.7 KiB
Go
59 lines
1.7 KiB
Go
package storage
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
// Backend is an interface for defining functions which all storage providers support.
|
|
type Backend interface {
|
|
Copy(file string) error
|
|
Prune(deadline time.Time, pruningPrefix string) (*PruneStats, error)
|
|
Name() string
|
|
}
|
|
|
|
// StorageBackend is a generic type of storage. Everything here are common properties of all storage types.
|
|
type StorageBackend struct {
|
|
DestinationPath string
|
|
RetentionDays int
|
|
Log Log
|
|
}
|
|
|
|
type LogType string
|
|
|
|
const (
|
|
INFO LogType = "INFO"
|
|
WARNING LogType = "WARNING"
|
|
ERROR LogType = "ERROR"
|
|
)
|
|
|
|
type Log func(logType LogType, context string, msg string, params ...interface{}) error
|
|
|
|
// PruneStats is a wrapper struct for returning stats after pruning
|
|
type PruneStats struct {
|
|
Total uint
|
|
Pruned uint
|
|
}
|
|
|
|
// DoPrune holds general control flow that applies to any kind of storage.
|
|
// Callers can pass in a thunk that performs the actual deletion of files.
|
|
func (b *StorageBackend) DoPrune(context string, lenMatches, lenCandidates int, description string, doRemoveFiles func() error) error {
|
|
if lenMatches != 0 && lenMatches != lenCandidates {
|
|
if err := doRemoveFiles(); err != nil {
|
|
return err
|
|
}
|
|
b.Log(INFO, context,
|
|
"Pruned %d out of %d %s as their age exceeded the configured retention period of %d days.",
|
|
lenMatches,
|
|
lenCandidates,
|
|
description,
|
|
b.RetentionDays,
|
|
)
|
|
} else if lenMatches != 0 && lenMatches == lenCandidates {
|
|
b.Log(WARNING, context, "The current configuration would delete all %d existing %s.", lenMatches, description)
|
|
b.Log(WARNING, context, "Refusing to do so, please check your configuration.")
|
|
} else {
|
|
b.Log(INFO, context, "None of %d existing %s were pruned.", lenCandidates, description)
|
|
}
|
|
return nil
|
|
}
|