Merge d332f4476b into 6e34196220

* 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

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,81 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"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{}
+	currentPid := fmt.Sprint(os.Getpid())
+
+	for _, line := range lines {
+		if strings.Contains(line, "autorestic") && !strings.Contains(line, "grep autorestic") && !strings.Contains(line, currentPid) {
+			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/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/cron.md

@@ -34,7 +34,7 @@ Then paste this at the bottom of the file and save it. Note that in this specifi
 
 ```bash
 # This is required, as it otherwise cannot find restic as a command.
-PATH="/usr/local/bin:/usr/bin:/bin"
+PATH="/usr/local/bin:$PATH"
 
 # Example running every 5 minutes
 */5 * * * * autorestic -c /path/to/my/.autorestic.yml --ci cron

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
 

internal/config.go

@@ -17,7 +17,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.7.11"
+const VERSION = "1.8.1"
 
 type OptionMap map[string][]interface{}
 type Options map[string]OptionMap
@@ -132,10 +132,11 @@ func (c *Config) Describe() {
 
 		tmp = ""
 		hooks := map[string][]string{
-			"Before":  l.Hooks.Before,
+			"PreValidate": l.Hooks.PreValidate,
-			"After":   l.Hooks.After,
+			"Before":      l.Hooks.Before,
-			"Failure": l.Hooks.Failure,
+			"After":       l.Hooks.After,
-			"Success": l.Hooks.Success,
+			"Failure":     l.Hooks.Failure,
+			"Success":     l.Hooks.Success,
 		}
 		for hook, commands := range hooks {
 			if len(commands) > 0 {

internal/location.go

@@ -33,11 +33,12 @@ const (
 )
 
 type Hooks struct {
-	Dir     string    `mapstructure:"dir"`
+	Dir         string    `mapstructure:"dir"`
-	Before  HookArray `mapstructure:"before,omitempty"`
+	PreValidate HookArray `mapstructure:"prevalidate,omitempty"`
-	After   HookArray `mapstructure:"after,omitempty"`
+	Before      HookArray `mapstructure:"before,omitempty"`
-	Success HookArray `mapstructure:"success,omitempty"`
+	After       HookArray `mapstructure:"after,omitempty"`
-	Failure HookArray `mapstructure:"failure,omitempty"`
+	Success     HookArray `mapstructure:"success,omitempty"`
+	Failure     HookArray `mapstructure:"failure,omitempty"`
 }
 
 type LocationCopy = map[string][]string
@@ -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 {