imap-backup 7.0.2 → 8.0.0

data/lib/imap/backup/cli/remote.rb

@@ -1,14 +1,106 @@
+require "imap/backup/logger"
+
 module Imap::Backup
   class CLI::Remote < Thor
     include Thor::Actions
     include CLI::Helpers
 
     desc "folders EMAIL", "List account folders"
+    config_option
+    format_option
+    quiet_option
+    verbose_option
     def folders(email)
-      connection = connection(email)
+      Imap::Backup::Logger.setup_logging options
+      names = names(email)
+      case options[:format]
+      when "json"
+        json_format_names names
+      else
+        list_names names
+      end
+    end
+
+    desc "namespaces EMAIL", "List account namespaces"
+    long_desc <<~DESC
+      Lists namespaces defined for an email account.
+
+      This command is useful in deciding the parameters for
+      the `imap-backup migrate` and `imap-backup mirror` commands.
+    DESC
+    config_option
+    format_option
+    quiet_option
+    verbose_option
+    def namespaces(email)
+      Imap::Backup::Logger.setup_logging options
+      config = load_config(**options)
+      connection = connection(config, email)
+      namespaces = connection.namespaces
+      case options[:format]
+      when "json"
+        json_format_namespaces namespaces
+      else
+        list_namespaces namespaces
+      end
+    end
+
+    no_commands do
+      def names(email)
+        config = load_config(**options)
+        connection = connection(config, email)
+
+        connection.folder_names
+      end
+
+      def json_format_names(names)
+        list = names.map do |name|
+          {name: name}
+        end
+        Kernel.puts list.to_json
+      end
+
+      def list_names(names)
+        names.each do |name|
+          Kernel.puts %("#{name}")
+        end
+      end
+
+      def json_format_namespaces(namespaces)
+        list = {
+          personal: namespace_info(namespaces.personal.first),
+          other: namespace_info(namespaces.other.first),
+          shared: namespace_info(namespaces.shared.first)
+        }
+        Kernel.puts list.to_json
+      end
+
+      def list_namespaces(namespaces)
+        Kernel.puts format(
+          "%-10<name>s %-10<prefix>s %<delim>s",
+          {name: "Name", prefix: "Prefix", delim: "Delimiter"}
+        )
+        list_namespace namespaces, :personal
+        list_namespace namespaces, :other
+        list_namespace namespaces, :shared
+      end
+
+      def list_namespace(namespaces, name)
+        info = namespace_info(namespaces.send(name).first, quote: true)
+        if info
+          Kernel.puts format("%-10<name>s %-10<prefix>s %<delim>s", name: name, **info)
+        else
+          Kernel.puts format("%-10<name>s (Not defined)", name: name)
+        end
+      end
+
+      def namespace_info(namespace, quote: false)
+        return nil if !namespace
 
-      connection.folder_names.each do |name|
-        Kernel.puts %("#{name}")
+        {
+          prefix: quote ? namespace.prefix.to_json : namespace.prefix,
+          delim: quote ? namespace.delim.to_json : namespace.delim
+        }
       end
     end
   end

data/lib/imap/backup/cli/restore.rb

@@ -4,33 +4,38 @@ module Imap::Backup
     include CLI::Helpers
 
     attr_reader :email
-    attr_reader :account_names
+    attr_reader :options
 
     def initialize(email = nil, options)
       super([])
       @email = email
-      @account_names = options[:accounts].split(",") if options.key?(:accounts)
+      @options = options
     end
 
     no_commands do
       def run
+        config = load_config(**options)
         case
-        when email && !account_names
-          connection = connection(email)
+        when email && !emails
+          connection = connection(config, email)
           connection.restore
-        when !email && !account_names
+        when !email && !emails
           Logger.logger.info "Calling restore without an EMAIL parameter is deprecated"
-          each_connection([], &:restore)
-        when email && account_names.any?
+          each_connection(config, [], &:restore)
+        when email && emails.any?
           raise "Pass either an email or the --accounts option, not both"
-        when account_names.any?
+        when emails.any?
           Logger.logger.info(
             "Calling restore with the --account option is deprected, " \
             "please pass a single EMAIL argument"
           )
-          each_connection(account_names, &:restore)
+          each_connection(config, emails, &:restore)
         end
       end
+
+      def emails
+        @emails ||= options[:accounts].split(",") if options.key?(:accounts)
+      end
     end
   end
 end

data/lib/imap/backup/cli/setup.rb

@@ -1,14 +1,19 @@
 module Imap::Backup
   class CLI::Setup < Thor
     include Thor::Actions
+    include CLI::Helpers
 
-    def initialize
+    attr_reader :options
+
+    def initialize(options)
       super([])
+      @options = options
     end
 
     no_commands do
       def run
-        Setup.new.run
+        config = load_config(**options, require_exists: false)
+        Setup.new(config: config).run
       end
     end
   end

data/lib/imap/backup/cli/stats.rb

@@ -14,7 +14,7 @@ module Imap::Backup
     attr_reader :email
     attr_reader :options
 
-    def initialize(email, options = {})
+    def initialize(email, options)
       super([])
       @email = email
       @options = options
@@ -31,7 +31,8 @@ module Imap::Backup
       end
 
       def stats
-        connection = connection(email)
+        config = load_config(**options)
+        connection = connection(config, email)
 
         connection.backup_folders.map do |folder|
           next if !folder.exist?

data/lib/imap/backup/cli/utils.rb

@@ -8,11 +8,13 @@ module Imap::Backup
     FAKE_EMAIL = "fake@email.com".freeze
 
     desc "ignore-history EMAIL", "Skip downloading emails up to today for all configured folders"
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     def ignore_history(email)
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      connection = connection(email)
+      Imap::Backup::Logger.setup_logging options
+      config = load_config(**options)
+      connection = connection(config, email)
 
       connection.backup_folders.each do |folder|
         next if !folder.exist?
@@ -25,12 +27,13 @@ module Imap::Backup
     desc(
       "export-to-thunderbird EMAIL [OPTIONS]",
       <<~DOC
-        [Experimental] Copy backed up emails to Thunderbird.
+        Copy backed up emails to Thunderbird.
         A folder called 'imap-backup/EMAIL' is created under 'Local Folders'.
       DOC
     )
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     method_option(
       "force",
       type: :boolean,
@@ -44,12 +47,12 @@ module Imap::Backup
       aliases: ["-p"]
     )
     def export_to_thunderbird(email)
-      opts = symbolized(options)
-      Imap::Backup::Logger.setup_logging opts
-      force = opts.key?(:force) ? opts[:force] : false
-      profile_name = opts[:profile]
+      Imap::Backup::Logger.setup_logging options
+      force = options.key?(:force) ? options[:force] : false
+      profile_name = options[:profile]
 
-      connection = connection(email)
+      config = load_config(**options)
+      connection = connection(config, email)
       profile = thunderbird_profile(profile_name)
 
       if !profile

data/lib/imap/backup/cli.rb

@@ -16,7 +16,6 @@ module Imap::Backup
     autoload :Restore, "imap/backup/cli/restore"
     autoload :Setup, "imap/backup/cli/setup"
     autoload :Stats, "imap/backup/cli/stats"
-    autoload :Status, "imap/backup/cli/status"
     autoload :Utils, "imap/backup/cli/utils"
 
     include Helpers
@@ -45,8 +44,9 @@ module Imap::Backup
       The setup tool can be used to choose a specific list of folders to back up.
     DESC
     accounts_option
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     method_option(
       "refresh",
       type: :boolean,
@@ -54,20 +54,8 @@ module Imap::Backup
       aliases: ["-r"]
     )
     def backup
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      Backup.new(symbolized(options)).run
-    end
-
-    desc "folders [OPTIONS]", "This command is deprecated, use `imap-backup remote folders ACCOUNT`"
-    long_desc <<~DESC
-      Lists all folders of all configured accounts.
-      This command is deprecated.
-      Instead, use a combination of `imap-backup local accounts` to get the list of accounts,
-      and `imap-backup remote folders ACCOUNT` to get the folder list.
-    DESC
-    accounts_option
-    def folders
-      Folders.new(symbolized(options)).run
+      Imap::Backup::Logger.setup_logging options
+      Backup.new(options).run
     end
 
     desc "local SUBCOMMAND [OPTIONS]", "View local info"
@@ -75,7 +63,6 @@ module Imap::Backup
 
     desc(
       "migrate SOURCE_EMAIL DESTINATION_EMAIL [OPTIONS]",
-      "[Experimental] " \
       "Uploads backed-up emails from account SOURCE_EMAIL to account DESTINATION_EMAIL"
     )
     long_desc <<~DESC
@@ -96,8 +83,9 @@ module Imap::Backup
       use the `--reset` option. In this case, all existing emails are
       deleted before uploading the migrated emails.
     DESC
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     method_option(
       "destination-prefix",
       type: :string,
@@ -117,8 +105,8 @@ module Imap::Backup
       aliases: ["-s"]
     )
     def migrate(source_email, destination_email)
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      Migrate.new(source_email, destination_email, **symbolized(options)).run
+      Imap::Backup::Logger.setup_logging options
+      Migrate.new(source_email, destination_email, **options).run
     end
 
     desc(
@@ -141,8 +129,9 @@ module Imap::Backup
       This file has a '.mirror' extension. This file contains a mapping of
       the known UIDs on the source account to those on the destination account.
     DESC
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     method_option(
       "destination-prefix",
       type: :string,
@@ -156,8 +145,8 @@ module Imap::Backup
       aliases: ["-s"]
     )
     def mirror(source_email, destination_email)
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      Mirror.new(source_email, destination_email, **symbolized(options)).run
+      Imap::Backup::Logger.setup_logging options
+      Mirror.new(source_email, destination_email, **options).run
     end
 
     desc "remote SUBCOMMAND [OPTIONS]", "View info about online accounts"
@@ -169,11 +158,12 @@ module Imap::Backup
       their original server.
     DESC
     accounts_option
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     def restore(email = nil)
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      Restore.new(email, symbolized(options)).run
+      Imap::Backup::Logger.setup_logging options
+      Restore.new(email, options).run
     end
 
     desc "setup", "Configure imap-backup"
@@ -181,11 +171,12 @@ module Imap::Backup
       A menu-driven command-line application used to configure imap-backup.
       Configure email accounts to back up.
     DESC
-    verbose_option
+    config_option
     quiet_option
+    verbose_option
     def setup
-      Imap::Backup::Logger.setup_logging symbolized(options)
-      Setup.new.run
+      Imap::Backup::Logger.setup_logging options
+      Setup.new(options).run
     end
 
     desc "stats EMAIL [OPTIONS]", "Print stats for each account folder"
@@ -194,24 +185,13 @@ module Imap::Backup
       are downloaded (exist on server and locally) "both" and those which
       are only present in the backup (as they have been deleted on the server) "local".
     DESC
-    method_option(
-      "format",
-      type: :string,
-      desc: "the output type, text (plain text) or json",
-      aliases: ["-f"]
-    )
+    config_option
+    format_option
+    quiet_option
+    verbose_option
     def stats(email)
-      Stats.new(email, symbolized(options)).run
-    end
-
-    desc "status", "This command is deprecated, use `imap-backup stats ACCOUNT`"
-    long_desc <<~DESC
-      For each configured account and folder, lists the number of emails yet to be downloaded.
-      This command is deprecated.
-    DESC
-    accounts_option
-    def status
-      Status.new(symbolized(options)).run
+      Imap::Backup::Logger.setup_logging options
+      Stats.new(email, options).run
     end
 
     desc "utils SUBCOMMAND [OPTIONS]", "Various utilities"

data/lib/imap/backup/client/default.rb

@@ -7,7 +7,7 @@ module Imap::Backup
   class Client::Default
     extend Forwardable
     def_delegators :imap, *%i(
-      append authenticate create expunge login
+      append authenticate create expunge login namespace
       responses uid_fetch uid_search uid_store
     )
 

data/lib/imap/backup/configuration.rb

@@ -14,12 +14,12 @@ module Imap::Backup
       File.join(CONFIGURATION_DIRECTORY, "config.json")
     end
 
-    def self.exist?(pathname = default_pathname)
-      File.exist?(pathname)
+    def self.exist?(path: nil)
+      File.exist?(path || default_pathname)
     end
 
-    def initialize(pathname = self.class.default_pathname)
-      @pathname = pathname
+    def initialize(path: nil)
+      @pathname = path || self.class.default_pathname
     end
 
     def path

data/lib/imap/backup/downloader.rb

@@ -51,7 +51,7 @@ module Imap::Backup
           if changed.any?
             ids = changed.join(", ")
             debug "Removing '\Seen' flag for the following messages: #{ids}"
-            folder.unset_flags(changed, [:Seen])
+            folder.remove_flags(changed, [:Seen])
           end
           uids_and_bodies
         else

data/lib/imap/backup/mirror.rb

@@ -56,7 +56,7 @@ module Imap::Backup
         next if !source_uid
 
         message = serializer.get(source_uid)
-        folder.apply_flags([destination_uid], message.flags) if flags.sort != message.flags.sort
+        folder.set_flags([destination_uid], message.flags) if flags.sort != message.flags.sort
       end
     end
 

data/lib/imap/backup/setup/account/header.rb

@@ -14,14 +14,22 @@ module Imap::Backup
     end
 
     def run
+      rows = [
+        email,
+        password,
+        server,
+        connection_options,
+        mode,
+        path,
+        folders,
+        multi_fetch,
+        reset_seen_flags_after_fetch
+      ].compact
+
       menu.header = <<~HEADER.chomp
         #{helpers.title_prefix} Account#{modified_flag}
 
-        email   #{space}#{account.username}
-        password#{space}#{masked_password}
-        path    #{space}#{local_path}
-        folders #{space}#{folders.map { |f| f[:name] }.join(', ')}#{mirror_mode}#{multi_fetch_size}
-        server  #{space}#{account.server}#{connection_options}#{reset_seen_flags_after_fetch}
+        #{format_rows(rows)}
 
         Choose an action
       HEADER
@@ -29,28 +37,70 @@ module Imap::Backup
 
     private
 
-    def folders
-      account.folders || []
+    def modified_flag
+      account.modified? ? "*" : ""
     end
 
-    def mirror_mode
-      if account.mirror_mode
-        "\nmode    #{space}mirror emails"
-      else
-        "\nmode    #{space}keep all emails"
-      end
+    def email
+      ["email", account.username]
     end
 
-    def helpers
-      Setup::Helpers.new
+    def password
+      masked_password =
+        if (account.password == "") || account.password.nil?
+          "(unset)"
+        else
+          account.password.gsub(/./, "x")
+        end
+      ["password", masked_password]
     end
 
-    def modified_flag
-      account.modified? ? "*" : ""
+    def path
+      # In order to handle backslashes, as Highline effectively
+      # does an eval (!) on its templates, we need to doubly
+      # escape them
+      local_path = account.local_path.gsub("\\", "\\\\\\\\")
+      ["path", local_path]
     end
 
-    def multi_fetch_size
-      "\nmulti-fetch #{account.multi_fetch_size}" if account.multi_fetch_size > 1
+    def folders
+      label =
+        if account.folder_blacklist
+          "exclude"
+        else
+          "include"
+        end
+      items = account.folders || []
+      list =
+        case
+        when items.any?
+          items.map { |f| f[:name] }.join(", ")
+        when !account.folder_blacklist
+          "(all folders)"
+        else
+          "(all folders) <- you have opted to not backup any folders!"
+        end
+      [label, list]
+    end
+
+    def mode
+      value =
+        if account.mirror_mode
+          "mirror emails"
+        else
+          "keep all emails"
+        end
+      ["mode", value]
+    end
+
+    def multi_fetch
+      return nil if account.multi_fetch_size == 1
+
+      ["multi-fetch", account.multi_fetch_size]
+    end
+
+    def server
+      ["server", account.server]
     end
 
     def connection_options
@@ -58,32 +108,33 @@ module Imap::Backup
 
       escaped = JSON.generate(account.connection_options)
       escaped.gsub!('"', '\"')
-      "\nconnection options  '#{escaped}'"
+      ["connection options", "'#{escaped}'"]
     end
 
     def reset_seen_flags_after_fetch
       return nil if !account.reset_seen_flags_after_fetch
 
-      "\nchanges to unread flags will be reset during download"
+      ["changes to unread flags will be reset during download"]
     end
 
-    def space
-      account.connection_options ? " " * 12 : " " * 4
-    end
-
-    def masked_password
-      if (account.password == "") || account.password.nil?
-        "(unset)"
-      else
-        account.password.gsub(/./, "x")
+    def format_rows(rows)
+      largest_label, _value = rows.max_by do |(label, value)|
+        if value
+          label.length
+        else
+          0
+        end
       end
+      rows.map do |(label, value)|
+        format(
+          "%-#{largest_label.length}<label>s %<value>s",
+          {label: label, value: value}
+        )
+      end.join("\n")
     end
 
-    def local_path
-      # In order to handle backslashes, as Highline effectively
-      # does an eval (!) on its templates, we need to doubly
-      # escape them
-      account.local_path.gsub("\\", "\\\\\\\\")
+    def helpers
+      Setup::Helpers.new
     end
   end
 end

data/lib/imap/backup/setup/account.rb

@@ -36,14 +36,15 @@ module Imap::Backup
         header menu
         modify_email menu
         modify_password menu
+        modify_server menu
+        modify_connection_options menu
+        test_connection menu
+        toggle_mirror_mode menu
         modify_backup_path menu
+        toggle_folder_blacklist menu
         choose_folders menu
-        toggle_mirror_mode menu
         modify_multi_fetch_size menu
-        modify_server menu
-        modify_connection_options menu
         toggle_reset_seen_flags_after_fetch menu
-        test_connection menu
         delete_account menu
         menu.choice("(q) return to main menu") { throw :done }
         menu.hidden("quit") { throw :done }
@@ -74,8 +75,17 @@ module Imap::Backup
       end
     end
 
+    def toggle_folder_blacklist(menu)
+      menu_item = "toggle folder inclusion mode (whitelist/blacklist)"
+      new_value = account.folder_blacklist ? nil : true
+      menu.choice(menu_item) do
+        account.folder_blacklist = new_value
+      end
+    end
+
     def choose_folders(menu)
-      menu.choice("choose backup folders") do
+      action = account.folder_blacklist ? "exclude from backups" : "include in backups"
+      menu.choice("choose folders to #{action}") do
         Setup::FolderChooser.new(account).run
       end
     end
@@ -105,15 +115,7 @@ module Imap::Backup
 
     def modify_connection_options(menu)
       menu.choice("modify connection options") do
-        default =
-          if account.connection_options
-            account.connection_options.to_json
-          else
-            ""
-          end
-        connection_options = highline.ask("connections options (as JSON): ") do |q|
-          q.default = default
-        end
+        connection_options = highline.ask("connections options (as JSON): ")
         if !connection_options.nil?
           begin
             account.connection_options = connection_options