package backup import ( "context" "github.com/pkg/errors" "github.com/spf13/cobra" "github.com/spf13/pflag" "github.com/alcionai/corso/src/cli/config" "github.com/alcionai/corso/src/cli/options" . "github.com/alcionai/corso/src/cli/print" "github.com/alcionai/corso/src/cli/utils" "github.com/alcionai/corso/src/internal/kopia" "github.com/alcionai/corso/src/internal/model" "github.com/alcionai/corso/src/pkg/backup" "github.com/alcionai/corso/src/pkg/backup/details" "github.com/alcionai/corso/src/pkg/control" "github.com/alcionai/corso/src/pkg/repository" "github.com/alcionai/corso/src/pkg/selectors" ) // ------------------------------------------------------------------------------------------------ // setup and globals // ------------------------------------------------------------------------------------------------ // exchange bucket info from flags var ( backupID string exchangeAll bool exchangeData []string user []string contact []string contactFolder []string contactName string email []string emailFolder []string emailReceivedAfter string emailReceivedBefore string emailSender string emailSubject string event []string eventCalendar []string eventOrganizer string eventRecurs string eventStartsAfter string eventStartsBefore string eventSubject string ) const ( dataContacts = "contacts" dataEmail = "email" dataEvents = "events" ) const ( exchangeServiceCommand = "exchange" exchangeServiceCommandCreateUseSuffix = " --user | '" + utils.Wildcard + "'" exchangeServiceCommandDeleteUseSuffix = " --backup " exchangeServiceCommandDetailsUseSuffix = " --backup " ) const ( exchangeServiceCommandCreateExamples = `# Backup all Exchange data for Alice corso backup create exchange --user alice@example.com # Backup only Exchange contacts for Alice and Bob corso backup create exchange --user alice@example.com,bob@example.com --data contacts # Backup all Exchange data for all M365 users corso backup create exchange --user '*'` exchangeServiceCommandDeleteExamples = `# Delete Exchange backup with ID 1234abcd-12ab-cd34-56de-1234abcd corso backup delete exchange --backup 1234abcd-12ab-cd34-56de-1234abcd` exchangeServiceCommandDetailsExamples = `# Explore Alice's items in backup 1234abcd-12ab-cd34-56de-1234abcd corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd --user alice@example.com # Explore Alice's emails with subject containing "Hello world" in folder "Inbox" from a specific backup corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ --user alice@example.com --email-subject "Hello world" --email-folder Inbox # Explore Bobs's events occurring after start of 2022 from a specific backup corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ --user bob@example.com --event-starts-after 2022-01-01T00:00:00 # Explore Alice's contacts with name containing Andy from a specific backup corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ --user alice@example.com --contact-name Andy` ) // called by backup.go to map parent subcommands to provider-specific handling. func addExchangeCommands(parent *cobra.Command) *cobra.Command { var ( c *cobra.Command fs *pflag.FlagSet ) switch parent.Use { case createCommand: c, fs = utils.AddCommand(parent, exchangeCreateCmd()) c.Use = c.Use + exchangeServiceCommandCreateUseSuffix c.Example = exchangeServiceCommandCreateExamples // Flags addition ordering should follow the order we want them to appear in help and docs: // More generic (ex: --all) and more frequently used flags take precedence. fs.BoolVar(&exchangeAll, "all", false, "Backup all Exchange data for all users") fs.StringSliceVar( &user, "user", nil, "Backup Exchange data by user ID; accepts '"+utils.Wildcard+"' to select all users") fs.StringSliceVar( &exchangeData, "data", nil, "Select one or more types of data to backup: "+dataEmail+", "+dataContacts+", or "+dataEvents) options.AddOperationFlags(c) case listCommand: c, _ = utils.AddCommand(parent, exchangeListCmd()) case detailsCommand: c, fs = utils.AddCommand(parent, exchangeDetailsCmd()) c.Use = c.Use + exchangeServiceCommandDetailsUseSuffix c.Example = exchangeServiceCommandDetailsExamples // Flags addition ordering should follow the order we want them to appear in help and docs: // More generic (ex: --all) and more frequently used flags take precedence. fs.StringVar(&backupID, "backup", "", "ID of the backup to explore. (required)") cobra.CheckErr(c.MarkFlagRequired("backup")) fs.StringSliceVar( &user, "user", nil, "Select backup details by user ID; accepts '"+utils.Wildcard+"' to select all users.") // email flags fs.StringSliceVar( &email, "email", nil, "Select backup details for emails by email ID; accepts '"+utils.Wildcard+"' to select all emails.") fs.StringSliceVar( &emailFolder, "email-folder", nil, "Select backup details for emails within a folder; accepts '"+utils.Wildcard+"' to select all email folders.") fs.StringVar( &emailSubject, "email-subject", "", "Select backup details for emails with a subject containing this value.") fs.StringVar( &emailSender, "email-sender", "", "Select backup details for emails from a specific sender.") fs.StringVar( &emailReceivedAfter, "email-received-after", "", "Select backup details for emails received after this datetime.") fs.StringVar( &emailReceivedBefore, "email-received-before", "", "Select backup details for emails received before this datetime.") // event flags fs.StringSliceVar( &event, "event", nil, "Select backup details for events by event ID; accepts '"+utils.Wildcard+"' to select all events.") fs.StringSliceVar( &eventCalendar, "event-calendar", nil, "Select backup details for events under a calendar; accepts '"+utils.Wildcard+"' to select all events.") fs.StringVar( &eventSubject, "event-subject", "", "Select backup details for events with a subject containing this value.") fs.StringVar( &eventOrganizer, "event-organizer", "", "Select backup details for events from a specific organizer.") fs.StringVar( &eventRecurs, "event-recurs", "", "Select backup details for recurring events. Use `--event-recurs false` to select non-recurring events.") fs.StringVar( &eventStartsAfter, "event-starts-after", "", "Select backup details for events starting after this datetime.") fs.StringVar( &eventStartsBefore, "event-starts-before", "", "Select backup details for events starting before this datetime.") // contact flags fs.StringSliceVar( &contact, "contact", nil, "Select backup details for contacts by contact ID; accepts '"+utils.Wildcard+"' to select all contacts.") fs.StringSliceVar( &contactFolder, "contact-folder", nil, "Select backup details for contacts within a folder; accepts '"+utils.Wildcard+"' to select all contact folders.") fs.StringVar( &contactName, "contact-name", "", "Select backup details for contacts whose contact name contains this value.") case deleteCommand: c, fs = utils.AddCommand(parent, exchangeDeleteCmd()) c.Use = c.Use + exchangeServiceCommandDeleteUseSuffix c.Example = exchangeServiceCommandDeleteExamples fs.StringVar(&backupID, "backup", "", "ID of the backup to delete. (required)") cobra.CheckErr(c.MarkFlagRequired("backup")) } return c } // ------------------------------------------------------------------------------------------------ // backup create // ------------------------------------------------------------------------------------------------ // `corso backup create exchange [...]` func exchangeCreateCmd() *cobra.Command { return &cobra.Command{ Use: exchangeServiceCommand, Short: "Backup M365 Exchange service data", RunE: createExchangeCmd, Args: cobra.NoArgs, } } // processes an exchange service backup. func createExchangeCmd(cmd *cobra.Command, args []string) error { ctx := cmd.Context() if utils.HasNoFlagsAndShownHelp(cmd) { return nil } if err := validateExchangeBackupCreateFlags(exchangeAll, user, exchangeData); err != nil { return err } s, acct, err := config.GetStorageAndAccount(ctx, true, nil) if err != nil { return Only(ctx, err) } r, err := repository.Connect(ctx, acct, s, control.Options{}) if err != nil { return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider)) } defer utils.CloseRepo(ctx, r) sel := exchangeBackupCreateSelectors(exchangeAll, user, exchangeData) bo, err := r.NewBackup(ctx, sel) if err != nil { return Only(ctx, errors.Wrap(err, "Failed to initialize Exchange backup")) } err = bo.Run(ctx) if err != nil { return Only(ctx, errors.Wrap(err, "Failed to run Exchange backup")) } bu, err := r.Backup(ctx, bo.Results.BackupID) if err != nil { return Only(ctx, errors.Wrap(err, "Unable to retrieve backup results from storage")) } bu.Print(ctx) return nil } func exchangeBackupCreateSelectors(all bool, users, data []string) selectors.Selector { sel := selectors.NewExchangeBackup() if all { sel.Include(sel.Users(selectors.Any())) return sel.Selector } if len(data) == 0 { sel.Include(sel.ContactFolders(user, selectors.Any())) sel.Include(sel.MailFolders(user, selectors.Any())) sel.Include(sel.EventCalendars(user, selectors.Any())) } for _, d := range data { switch d { case dataContacts: sel.Include(sel.ContactFolders(users, selectors.Any())) case dataEmail: sel.Include(sel.MailFolders(users, selectors.Any())) case dataEvents: sel.Include(sel.EventCalendars(users, selectors.Any())) } } return sel.Selector } func validateExchangeBackupCreateFlags(all bool, users, data []string) error { if len(users) == 0 && !all { return errors.New("requires one or more --user ids, the wildcard --user *, or the --all flag") } if len(data) > 0 && all { return errors.New("--all does a backup on all data, and cannot be reduced with --data") } for _, d := range data { if d != dataContacts && d != dataEmail && d != dataEvents { return errors.New( d + " is an unrecognized data type; must be one of " + dataContacts + ", " + dataEmail + ", or " + dataEvents) } } return nil } // ------------------------------------------------------------------------------------------------ // backup list // ------------------------------------------------------------------------------------------------ // `corso backup list exchange [...]` func exchangeListCmd() *cobra.Command { return &cobra.Command{ Use: exchangeServiceCommand, Short: "List the history of M365 Exchange service backups", RunE: listExchangeCmd, Args: cobra.NoArgs, } } // lists the history of backup operations func listExchangeCmd(cmd *cobra.Command, args []string) error { ctx := cmd.Context() s, acct, err := config.GetStorageAndAccount(ctx, true, nil) if err != nil { return Only(ctx, err) } r, err := repository.Connect(ctx, acct, s, options.Control()) if err != nil { return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider)) } defer utils.CloseRepo(ctx, r) bs, err := r.Backups(ctx) if err != nil { return Only(ctx, errors.Wrap(err, "Failed to list backups in the repository")) } backup.PrintAll(ctx, bs) return nil } // ------------------------------------------------------------------------------------------------ // backup details // ------------------------------------------------------------------------------------------------ // `corso backup details exchange [...]` func exchangeDetailsCmd() *cobra.Command { return &cobra.Command{ Use: exchangeServiceCommand, Short: "Shows the details of a M365 Exchange service backup", RunE: detailsExchangeCmd, Args: cobra.NoArgs, } } // lists the history of backup operations func detailsExchangeCmd(cmd *cobra.Command, args []string) error { ctx := cmd.Context() if utils.HasNoFlagsAndShownHelp(cmd) { return nil } if err := utils.ValidateExchangeRestoreFlags(backupID); err != nil { return err } s, acct, err := config.GetStorageAndAccount(ctx, true, nil) if err != nil { return Only(ctx, err) } r, err := repository.Connect(ctx, acct, s, options.Control()) if err != nil { return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider)) } defer utils.CloseRepo(ctx, r) opts := utils.ExchangeOpts{ Contacts: contact, ContactFolders: contactFolder, Emails: email, EmailFolders: emailFolder, Events: event, EventCalendars: eventCalendar, Users: user, ContactName: contactName, EmailReceivedAfter: emailReceivedAfter, EmailReceivedBefore: emailReceivedBefore, EmailSender: emailSender, EmailSubject: emailSubject, EventOrganizer: eventOrganizer, EventRecurs: eventRecurs, EventStartsAfter: eventStartsAfter, EventStartsBefore: eventStartsBefore, EventSubject: eventSubject, } ds, err := runDetailsExchangeCmd(ctx, r, backupID, opts) if err != nil { return Only(ctx, err) } if len(ds.Entries) == 0 { Info(ctx, selectors.ErrorNoMatchingItems) return nil } ds.PrintEntries(ctx) return nil } // runDetailsExchangeCmd actually performs the lookup in backup details. Assumes // len(backupID) > 0. func runDetailsExchangeCmd( ctx context.Context, r repository.BackupGetter, backupID string, opts utils.ExchangeOpts, ) (*details.Details, error) { d, _, err := r.BackupDetails(ctx, backupID) if err != nil { if errors.Is(err, kopia.ErrNotFound) { return nil, errors.Errorf("no backup exists with the id %s", backupID) } return nil, errors.Wrap(err, "Failed to get backup details in the repository") } sel := selectors.NewExchangeRestore() utils.IncludeExchangeRestoreDataSelectors(sel, opts) utils.FilterExchangeRestoreInfoSelectors(sel, opts) // if no selector flags were specified, get all data in the service. if len(sel.Scopes()) == 0 { sel.Include(sel.Users(selectors.Any())) } return sel.Reduce(ctx, d), nil } // ------------------------------------------------------------------------------------------------ // backup delete // ------------------------------------------------------------------------------------------------ // `corso backup delete exchange [...]` func exchangeDeleteCmd() *cobra.Command { return &cobra.Command{ Use: exchangeServiceCommand, Short: "Delete backed-up M365 Exchange service data", RunE: deleteExchangeCmd, Args: cobra.NoArgs, } } // deletes an exchange service backup. func deleteExchangeCmd(cmd *cobra.Command, args []string) error { ctx := cmd.Context() if utils.HasNoFlagsAndShownHelp(cmd) { return nil } s, acct, err := config.GetStorageAndAccount(ctx, true, nil) if err != nil { return Only(ctx, err) } r, err := repository.Connect(ctx, acct, s, options.Control()) if err != nil { return Only(ctx, errors.Wrapf(err, "Failed to connect to the %s repository", s.Provider)) } defer utils.CloseRepo(ctx, r) if err := r.DeleteBackup(ctx, model.StableID(backupID)); err != nil { return Only(ctx, errors.Wrapf(err, "Deleting backup %s", backupID)) } return nil }