mirror of
https://github.com/octoleo/syncthing.git
synced 2024-11-09 23:00:58 +00:00
4b3f9b1af9
* lib/versioner: Add placeholder to provide the absolute file path to external commands This commit adds support for a new placeholder, %FILE_PATH_FULL%, to the command of the external versioner. The placeholder will be replaced by the absolute path of the file that should be deleted. * Revert "lib/versioner: Add placeholder to provide the absolute file path to external commands" This reverts commit fb48962b947358e90a76e87a7794adb6057de476. * lib/versioner: Replace all placeholders in external command (fixes #5849) Before this commit, only these placeholders were replaced that span a whole word, for example "%FOLDER_PATH%". Words that consisted of more than one placeholder or additional characters, for example "%FOLDER_PATH%/%FILE_PATH%", were left untouched. * fixup! lib/versioner: Replace all placeholders in external command (fixes #5849)
117 lines
2.8 KiB
Go
117 lines
2.8 KiB
Go
// 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 (
|
|
"errors"
|
|
"os"
|
|
"os/exec"
|
|
"runtime"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/syncthing/syncthing/lib/fs"
|
|
|
|
"github.com/kballard/go-shellquote"
|
|
)
|
|
|
|
func init() {
|
|
// Register the constructor for this type of versioner with the name "external"
|
|
Factories["external"] = NewExternal
|
|
}
|
|
|
|
type External struct {
|
|
command string
|
|
filesystem fs.Filesystem
|
|
}
|
|
|
|
func NewExternal(folderID string, filesystem fs.Filesystem, params map[string]string) Versioner {
|
|
command := params["command"]
|
|
|
|
if runtime.GOOS == "windows" {
|
|
command = strings.Replace(command, `\`, `\\`, -1)
|
|
}
|
|
|
|
s := External{
|
|
command: command,
|
|
filesystem: filesystem,
|
|
}
|
|
|
|
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 (v External) Archive(filePath string) error {
|
|
info, err := v.filesystem.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")
|
|
}
|
|
|
|
l.Debugln("archiving", filePath)
|
|
|
|
if v.command == "" {
|
|
return errors.New("Versioner: command is empty, please enter a valid command")
|
|
}
|
|
|
|
words, err := shellquote.Split(v.command)
|
|
if err != nil {
|
|
return errors.New("Versioner: command is invalid: " + err.Error())
|
|
}
|
|
|
|
context := map[string]string{
|
|
"%FOLDER_FILESYSTEM%": v.filesystem.Type().String(),
|
|
"%FOLDER_PATH%": v.filesystem.URI(),
|
|
"%FILE_PATH%": filePath,
|
|
}
|
|
|
|
for i, word := range words {
|
|
for key, val := range context {
|
|
word = strings.Replace(word, key, val, -1)
|
|
}
|
|
|
|
words[i] = word
|
|
}
|
|
|
|
cmd := exec.Command(words[0], words[1:]...)
|
|
env := os.Environ()
|
|
// filter STGUIAUTH and STGUIAPIKEY from environment variables
|
|
filteredEnv := []string{}
|
|
for _, x := range env {
|
|
if !strings.HasPrefix(x, "STGUIAUTH=") && !strings.HasPrefix(x, "STGUIAPIKEY=") {
|
|
filteredEnv = append(filteredEnv, x)
|
|
}
|
|
}
|
|
cmd.Env = filteredEnv
|
|
combinedOutput, err := cmd.CombinedOutput()
|
|
l.Debugln("external command output:", string(combinedOutput))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// return error if the file was not removed
|
|
if _, err = v.filesystem.Lstat(filePath); fs.IsNotExist(err) {
|
|
return nil
|
|
}
|
|
return errors.New("Versioner: file was not removed by external script")
|
|
}
|
|
|
|
func (v External) GetVersions() (map[string][]FileVersion, error) {
|
|
return nil, ErrRestorationNotSupported
|
|
}
|
|
|
|
func (v External) Restore(filePath string, versionTime time.Time) error {
|
|
return ErrRestorationNotSupported
|
|
}
|