mirror of
https://github.com/restic/restic.git
synced 2026-05-09 03:55:24 +00:00
Martin Castillo
2269ec82e1
Since restic unlock _removes_ locks, a user might wonder whether this works in append-only mode, which prevents deletion of data. This change explicitly mentions in the man page that the deletion of locks is an allowed exception.
71 lines
1.7 KiB
Go
71 lines
1.7 KiB
Go
package main
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/restic/restic/internal/global"
|
|
"github.com/restic/restic/internal/repository"
|
|
"github.com/restic/restic/internal/ui"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
func newUnlockCommand(globalOptions *global.Options) *cobra.Command {
|
|
var opts UnlockOptions
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "unlock",
|
|
Short: "Remove locks other processes created",
|
|
Long: `
|
|
The "unlock" command removes stale locks that have been created by other restic processes.
|
|
|
|
Removing locks works even with repositories served in append-only mode from restic's rest-server.
|
|
|
|
EXIT STATUS
|
|
===========
|
|
|
|
Exit status is 0 if the command was successful.
|
|
Exit status is 1 if there was any error.
|
|
`,
|
|
GroupID: cmdGroupDefault,
|
|
DisableAutoGenTag: true,
|
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
|
return runUnlock(cmd.Context(), opts, *globalOptions, globalOptions.Term)
|
|
},
|
|
}
|
|
opts.AddFlags(cmd.Flags())
|
|
return cmd
|
|
}
|
|
|
|
// UnlockOptions collects all options for the unlock command.
|
|
type UnlockOptions struct {
|
|
RemoveAll bool
|
|
}
|
|
|
|
func (opts *UnlockOptions) AddFlags(f *pflag.FlagSet) {
|
|
f.BoolVar(&opts.RemoveAll, "remove-all", false, "remove all locks, even non-stale ones")
|
|
}
|
|
|
|
func runUnlock(ctx context.Context, opts UnlockOptions, gopts global.Options, term ui.Terminal) error {
|
|
printer := ui.NewProgressPrinter(gopts.JSON, gopts.Verbosity, term)
|
|
repo, err := global.OpenRepository(ctx, gopts, printer)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
fn := repository.RemoveStaleLocks
|
|
if opts.RemoveAll {
|
|
fn = repository.RemoveAllLocks
|
|
}
|
|
|
|
processed, err := fn(ctx, repo)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if processed > 0 {
|
|
printer.P("successfully removed %d locks", processed)
|
|
}
|
|
return nil
|
|
}
|