package main import ( "context" "encoding/json" "sort" "strings" "github.com/restic/restic/internal/errors" "github.com/restic/restic/internal/restic" "github.com/spf13/cobra" ) var cmdForget = &cobra.Command{ Use: "forget [flags] [snapshot ID] [...]", Short: "Remove snapshots from the repository", Long: ` The "forget" command removes snapshots according to a policy. Please note that this command really only deletes the snapshot object in the repository, which is a reference to data stored there. In order to remove this (now unreferenced) data after 'forget' was run successfully, see the 'prune' command. `, DisableAutoGenTag: true, RunE: func(cmd *cobra.Command, args []string) error { return runForget(forgetOptions, globalOptions, args) }, } // ForgetOptions collects all options for the forget command. type ForgetOptions struct { Last int Hourly int Daily int Weekly int Monthly int Yearly int Within restic.Duration KeepTags restic.TagLists Host string Tags restic.TagLists Paths []string Compact bool // Grouping GroupBy string DryRun bool Prune bool } var forgetOptions ForgetOptions func init() { cmdRoot.AddCommand(cmdForget) f := cmdForget.Flags() f.IntVarP(&forgetOptions.Last, "keep-last", "l", 0, "keep the last `n` snapshots") f.IntVarP(&forgetOptions.Hourly, "keep-hourly", "H", 0, "keep the last `n` hourly snapshots") f.IntVarP(&forgetOptions.Daily, "keep-daily", "d", 0, "keep the last `n` daily snapshots") f.IntVarP(&forgetOptions.Weekly, "keep-weekly", "w", 0, "keep the last `n` weekly snapshots") f.IntVarP(&forgetOptions.Monthly, "keep-monthly", "m", 0, "keep the last `n` monthly snapshots") f.IntVarP(&forgetOptions.Yearly, "keep-yearly", "y", 0, "keep the last `n` yearly snapshots") f.VarP(&forgetOptions.Within, "keep-within", "", "keep snapshots that were created within `duration` before the newest (e.g. 1y5m7d)") f.Var(&forgetOptions.KeepTags, "keep-tag", "keep snapshots with this `taglist` (can be specified multiple times)") // Sadly the commonly used shortcut `H` is already used. f.StringVar(&forgetOptions.Host, "host", "", "only consider snapshots with the given `host`") // Deprecated since 2017-03-07. f.StringVar(&forgetOptions.Host, "hostname", "", "only consider snapshots with the given `hostname` (deprecated)") f.Var(&forgetOptions.Tags, "tag", "only consider snapshots which include this `taglist` in the format `tag[,tag,...]` (can be specified multiple times)") f.StringArrayVar(&forgetOptions.Paths, "path", nil, "only consider snapshots which include this (absolute) `path` (can be specified multiple times)") f.BoolVarP(&forgetOptions.Compact, "compact", "c", false, "use compact format") f.StringVarP(&forgetOptions.GroupBy, "group-by", "g", "host,paths", "string for grouping snapshots by host,paths,tags") f.BoolVarP(&forgetOptions.DryRun, "dry-run", "n", false, "do not delete anything, just print what would be done") f.BoolVar(&forgetOptions.Prune, "prune", false, "automatically run the 'prune' command if snapshots have been removed") f.SortFlags = false } func runForget(opts ForgetOptions, gopts GlobalOptions, args []string) error { repo, err := OpenRepository(gopts) if err != nil { return err } lock, err := lockRepoExclusive(repo) defer unlockRepo(lock) if err != nil { return err } // group by hostname and dirs type key struct { Hostname string Paths []string Tags []string } snapshotGroups := make(map[string]restic.Snapshots) var GroupByTag bool var GroupByHost bool var GroupByPath bool var GroupOptionList []string GroupOptionList = strings.Split(opts.GroupBy, ",") for _, option := range GroupOptionList { switch option { case "host": GroupByHost = true case "paths": GroupByPath = true case "tags": GroupByTag = true case "": default: return errors.Fatal("unknown grouping option: '" + option + "'") } } removeSnapshots := 0 ctx, cancel := context.WithCancel(gopts.ctx) defer cancel() for sn := range FindFilteredSnapshots(ctx, repo, opts.Host, opts.Tags, opts.Paths, args) { if len(args) > 0 { // When explicit snapshots args are given, remove them immediately. if !opts.DryRun { h := restic.Handle{Type: restic.SnapshotFile, Name: sn.ID().String()} if err = repo.Backend().Remove(gopts.ctx, h); err != nil { return err } Verbosef("removed snapshot %v\n", sn.ID().Str()) removeSnapshots++ } else { Verbosef("would have removed snapshot %v\n", sn.ID().Str()) } } else { // Determining grouping-keys var tags []string var hostname string var paths []string if GroupByTag { tags = sn.Tags sort.StringSlice(tags).Sort() } if GroupByHost { hostname = sn.Hostname } if GroupByPath { paths = sn.Paths } sort.StringSlice(sn.Paths).Sort() var k []byte var err error k, err = json.Marshal(key{Tags: tags, Hostname: hostname, Paths: paths}) if err != nil { return err } snapshotGroups[string(k)] = append(snapshotGroups[string(k)], sn) } } policy := restic.ExpirePolicy{ Last: opts.Last, Hourly: opts.Hourly, Daily: opts.Daily, Weekly: opts.Weekly, Monthly: opts.Monthly, Yearly: opts.Yearly, Within: opts.Within, Tags: opts.KeepTags, } if policy.Empty() && len(args) == 0 { Verbosef("no policy was specified, no snapshots will be removed\n") } if !policy.Empty() { Verbosef("Applying Policy: %v\n", policy) for k, snapshotGroup := range snapshotGroups { var key key if json.Unmarshal([]byte(k), &key) != nil { return err } // Info Verbosef("snapshots") var infoStrings []string if GroupByTag { infoStrings = append(infoStrings, "tags ["+strings.Join(key.Tags, ", ")+"]") } if GroupByHost { infoStrings = append(infoStrings, "host ["+key.Hostname+"]") } if GroupByPath { infoStrings = append(infoStrings, "paths ["+strings.Join(key.Paths, ", ")+"]") } if infoStrings != nil { Verbosef(" for (" + strings.Join(infoStrings, ", ") + ")") } Verbosef(":\n\n") keep, remove := restic.ApplyPolicy(snapshotGroup, policy) if len(keep) != 0 && !gopts.Quiet { Printf("keep %d snapshots:\n", len(keep)) PrintSnapshots(globalOptions.stdout, keep, opts.Compact) Printf("\n") } if len(remove) != 0 && !gopts.Quiet { Printf("remove %d snapshots:\n", len(remove)) PrintSnapshots(globalOptions.stdout, remove, opts.Compact) Printf("\n") } removeSnapshots += len(remove) if !opts.DryRun { for _, sn := range remove { h := restic.Handle{Type: restic.SnapshotFile, Name: sn.ID().String()} err = repo.Backend().Remove(gopts.ctx, h) if err != nil { return err } } } } } if removeSnapshots > 0 && opts.Prune { Verbosef("%d snapshots have been removed, running prune\n", removeSnapshots) if !opts.DryRun { return pruneRepository(gopts, repo) } } return nil }