Update config.go

* fix: cli command to unlock the autorestic running value

* fix(unlock cmd): get user confirmation in case an instance is still running

* fix(cmd unlock): add force flag

.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: Main
 on:
   push:
     tags:
-      - "v*.*.*"
+      - 'v*.*.*'
 
 jobs:
   docker:
@@ -40,7 +40,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: "^1.20"
+          go-version: '^1.21'
       - name: Build
         run: go run build/build.go
       - name: Release

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.20-alpine as builder
+FROM golang:1.22-alpine as builder
 
 WORKDIR /app
 COPY go.* .
@@ -6,8 +6,8 @@ RUN go mod download
 COPY . .
 RUN go build
 
-FROM restic/restic:0.16.0
+FROM restic/restic:0.16.4
-RUN apk add --no-cache rclone bash curl
+RUN apk add --no-cache rclone bash curl docker-cli
 COPY --from=builder /app/autorestic /usr/bin/autorestic
 ENTRYPOINT []
 CMD [ "autorestic" ]

README.md

@@ -34,7 +34,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Backup locations to multiple backends
 - Snapshot policies and pruning
 - Fully encrypted
-- Pre/After hooks
+- Before/after backup hooks
 - Exclude pattern/files
 - Cron jobs for automatic backup
 - Backup & Restore docker volume

cmd/unlock.go

@@ -0,0 +1,79 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"os/exec"
+	"strings"
+
+	"github.com/cupcakearmy/autorestic/internal"
+	"github.com/cupcakearmy/autorestic/internal/colors"
+	"github.com/cupcakearmy/autorestic/internal/lock"
+	"github.com/spf13/cobra"
+)
+
+var unlockCmd = &cobra.Command{
+	Use:   "unlock",
+	Short: "Unlock autorestic only if you are sure that no other instance is running",
+	Long: `Unlock autorestic only if you are sure that no other instance is running.
+To check you can run "ps aux | grep autorestic".`,
+	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
+
+		force, _ := cmd.Flags().GetBool("force")
+
+		if !force && isAutoresticRunning() {
+			colors.Error.Print("Another autorestic instance is running. Are you sure you want to unlock? (yes/no): ")
+			var response string
+			fmt.Scanln(&response)
+			if strings.ToLower(response) != "yes" {
+				colors.Primary.Println("Unlocking aborted.")
+				return
+			}
+		}
+
+		err := lock.Unlock()
+		if err != nil {
+			colors.Error.Println("Could not unlock:", err)
+			return
+		}
+
+		colors.Success.Println("Unlock successful")
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(unlockCmd)
+	unlockCmd.Flags().Bool("force", false, "force unlock")
+}
+
+// isAutoresticRunning checks if autorestic is running
+// and returns true if it is.
+// It also prints the processes to stdout.
+func isAutoresticRunning() bool {
+	cmd := exec.Command("sh", "-c", "ps aux | grep autorestic")
+	var out bytes.Buffer
+	cmd.Stdout = &out
+	err := cmd.Run()
+	if err != nil {
+		return false
+	}
+
+	lines := strings.Split(out.String(), "\n")
+	autoresticProcesses := []string{}
+
+	for _, line := range lines {
+		if strings.Contains(line, "autorestic") && !strings.Contains(line, "grep autorestic") {
+			autoresticProcesses = append(autoresticProcesses, line)
+		}
+	}
+
+	if len(autoresticProcesses) > 0 {
+		colors.Faint.Println("Found autorestic processes:")
+		for _, proc := range autoresticProcesses {
+			colors.Faint.Println(proc)
+		}
+		return true
+	}
+	return false
+}

docs/pages/cli/forget.md

@@ -4,7 +4,7 @@
 autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune]
 ```
 
-This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget).
+This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/options/forget).
 
 The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
 

docs/pages/cli/unlock.md

@@ -0,0 +1,32 @@
+# Unlock
+
+In case autorestic throws the error message `an instance is already running. exiting`, but there is no instance running you can unlock the lock.
+
+To verify that there is no instance running you can use `ps aux | grep autorestic`.
+
+Example with no instance running:
+
+```bash
+> ps aux | grep autorestic
+root       39260  0.0  0.0   6976  2696 pts/11   S+   19:41   0:00 grep autorestic
+```
+
+Example with an instance running:
+
+```bash
+> ps aux | grep autorestic
+root       29465  0.0  0.0 1162068 7380 pts/7    Sl+  19:28   0:00 autorestic --ci backup -a
+root       39260  0.0  0.0   6976  2696 pts/11   S+   19:41   0:00 grep autorestic
+```
+
+**If an instance is running you should not unlock as it could lead to data loss!**
+
+```bash
+autorestic unlock
+```
+
+Use the `--force` to prevent the confirmation prompt if an instance is running.
+
+```bash
+autorestic unlock --force
+```

docs/pages/config.md

@@ -56,6 +56,8 @@ version: 2
 
 extras:
   hooks: &foo
+    prevalidate:
+      - echo "Wake up!"
     before:
       - echo "Hello"
     after:

docs/pages/index.md

@@ -13,7 +13,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Backup locations to multiple backends
 - Snapshot policies and pruning
 - Fully encrypted
-- Pre/After hooks
+- Before/after backup hooks
 - Exclude pattern/files
 - Cron jobs for automatic backup
 - Backup & Restore docker volumes

docs/pages/location/hooks.md

@@ -6,23 +6,28 @@ They consist of a list of commands that will be executed in the same directory a
 
 The following hooks groups are supported, none are required:
 
+- `prevalidate`
 - `before`
 - `after`
 - `failure`
 - `success`
 
+The difference between `prevalidate` and `before` hooks are that `prevalidate` is run before checking the backup location is valid, including checking that the `from` directories exist. This can be useful, for example, to mount the source filesystem that contains the directories listed in `from`.
+
 ```yml | .autorestic.yml
 locations:
   my-location:
     from: /data
     to: my-backend
     hooks:
+      prevalidate:
+        - echo "Checks"
       before:
         - echo "One"
         - echo "Two"
         - echo "Three"
       after:
-        - echo "Byte"
+        - echo "Bye"
       failure:
         - echo "Something went wrong"
       success:
@@ -31,13 +36,15 @@ locations:
 
 ## Flowchart
 
-1. `before` hook
+1. `prevalidate` hook
-2. Run backup
+2. Check backup location
-3. `after` hook
+3. `before` hook
-4. - `success` hook if no errors were found
+4. Run backup
+5. `after` hook
+6. - `success` hook if no errors were found
    - `failure` hook if at least one error was encountered
 
-If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
+If either the `prevalidate` or `before` hook encounters errors then the backup and `after` hooks will be skipped and only the `failed` hooks will run.
 
 ## Environment variables
 

go.mod

@@ -1,6 +1,6 @@
 module github.com/cupcakearmy/autorestic
 
-go 1.20
+go 1.21
 
 require (
 	github.com/blang/semver/v4 v4.0.0

internal/backend.go

@@ -143,6 +143,7 @@ func (b Backend) Exec(args []string) error {
 		return err
 	}
 	options := ExecuteOptions{Envs: env}
+	args = append(args, combineBackendOptions("exec", b)...)
 	_, out, err := ExecuteResticCommand(options, args...)
 	if err != nil {
 		colors.Error.Println(out)

internal/bins/bins.go

@@ -6,7 +6,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net/http"
 	"os"
 	"path"
@@ -37,7 +36,7 @@ func dlJSON(url string) (GithubRelease, error) {
 		return parsed, err
 	}
 	defer resp.Body.Close()
-	body, err := ioutil.ReadAll(resp.Body)
+	body, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return parsed, err
 
@@ -73,9 +72,10 @@ func downloadAndInstallAsset(body GithubRelease, name string) error {
 			// Uncompress
 			bz := bzip2.NewReader(resp.Body)
 
-			// Save to tmp
+			// Save to tmp file in the same directory as the install directory
-			// Linux does not support overwriting the file that is currently being overwritten, but it can be deleted and a new one moved in its place.
+			// Linux does not support overwriting the file that is currently being running
-			tmp, err := ioutil.TempFile(os.TempDir(), "autorestic-")
+			// But it can be delete the old one and a new one moved in its place.
+			tmp, err := os.CreateTemp(INSTALL_PATH, "autorestic-")
 			if err != nil {
 				return err
 			}
@@ -89,23 +89,25 @@ func downloadAndInstallAsset(body GithubRelease, name string) error {
 
 			to := path.Join(INSTALL_PATH, name)
 			defer os.Remove(tmp.Name()) // Cleanup temporary file after thread exits
-			if err := os.Rename(tmp.Name(), to); err != nil {
+
-				colors.Error.Printf("os.Rename() failed (%v), retrying with io.Copy()\n", err.Error())
+			mode := os.FileMode(0755)
-				var src *os.File
+			if originalBin, err := os.Lstat(to); err == nil {
-				var dst *os.File
+				mode = originalBin.Mode()
-				if src, err = os.Open(tmp.Name()); err != nil {
+				err := os.Remove(to)
+				if err != nil {
 					return err
 				}
-				if dst, err = os.Create(to); err != nil {
+			}
+
+			err = os.Rename(tmp.Name(), to)
+			if err != nil {
 				return err
 			}
-				if _, err := io.Copy(dst, src); err != nil {
+
+			err = os.Chmod(to, mode)
+			if err != nil {
 				return err
 			}
-				if err := os.Chmod(to, 0755); err != nil {
-					return err
-				}
-			}
 
 			colors.Success.Printf("Successfully installed '%s' under %s\n", name, INSTALL_PATH)
 			return nil

internal/config.go

@@ -17,7 +17,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.7.10"
+const VERSION = "1.8.0"
 
 type OptionMap map[string][]interface{}
 type Options map[string]OptionMap
@@ -132,6 +132,7 @@ func (c *Config) Describe() {
 
 		tmp = ""
 		hooks := map[string][]string{
+			"PreValidate": l.Hooks.PreValidate,
 			"Before":      l.Hooks.Before,
 			"After":       l.Hooks.After,
 			"Failure":     l.Hooks.Failure,

internal/location.go

@@ -34,6 +34,7 @@ const (
 
 type Hooks struct {
 	Dir         string    `mapstructure:"dir"`
+	PreValidate HookArray `mapstructure:"prevalidate,omitempty"`
 	Before      HookArray `mapstructure:"before,omitempty"`
 	After       HookArray `mapstructure:"after,omitempty"`
 	Success     HookArray `mapstructure:"success,omitempty"`
@@ -184,12 +185,18 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		},
 	}
 
+	// Hooks before location validation
+	if err := l.ExecuteHooks(l.Hooks.PreValidate, options); err != nil {
+		errors = append(errors, err)
+		goto after
+	}
+
 	if err := l.validate(); err != nil {
 		errors = append(errors, err)
 		goto after
 	}
 
-	// Hooks
+	// Hooks after location validation
 	if err := l.ExecuteHooks(l.Hooks.Before, options); err != nil {
 		errors = append(errors, err)
 		goto after
@@ -289,12 +296,13 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		}
 	}
 
-	// After hooks
+	// After backup hooks
 	if err := l.ExecuteHooks(l.Hooks.After, options); err != nil {
 		errors = append(errors, err)
 	}
 
 after:
+	// Success/failure hooks
 	var commands []string
 	var isSuccess = len(errors) == 0
 	if isSuccess {