imap-backup 6.0.0.rc2 → 6.0.0

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

@@ -0,0 +1,75 @@
+require "imap/backup/setup/helpers"
+
+module Imap::Backup
+  class Setup; end
+  class Setup::Account; end
+
+  class Setup::Account::Header
+    attr_reader :account
+    attr_reader :menu
+
+    def initialize(menu:, account:)
+      @menu = menu
+      @account = account
+    end
+
+    def run
+      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(', ')}#{multi_fetch_size}
+        server  #{space}#{account.server}#{connection_options}
+
+        Choose an action
+      HEADER
+    end
+
+    private
+
+    def folders
+      account.folders || []
+    end
+
+    def helpers
+      Setup::Helpers.new
+    end
+
+    def modified_flag
+      account.modified? ? "*" : ""
+    end
+
+    def multi_fetch_size
+      "\nmulti-fetch #{account.multi_fetch_size}" if account.multi_fetch_size > 1
+    end
+
+    def connection_options
+      return nil if !account.connection_options
+
+      escaped = JSON.generate(account.connection_options)
+      escaped.gsub!('"', '\"')
+      "\nconnection options  '#{escaped}'"
+    end
+
+    def space
+      account.connection_options ? " " * 12 : " " * 4
+    end
+
+    def masked_password
+      if (account.password == "") || account.password.nil?
+        "(unset)"
+      else
+        account.password.gsub(/./, "x")
+      end
+    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("\\", "\\\\\\\\")
+    end
+  end
+end

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

@@ -1,11 +1,19 @@
-require "imap/backup/setup/helpers"
+require "imap/backup/setup/account/header"
+require "imap/backup/setup/backup_path"
+require "imap/backup/setup/email"
 
 module Imap::Backup
   class Setup; end
 
-  Setup::Account = Struct.new(:config, :account, :highline) do
+  class Setup::Account
+    attr_reader :account
+    attr_reader :config
+    attr_reader :highline
+
     def initialize(config, account, highline)
-      super
+      @account = account
+      @config = config
+      @highline = highline
     end
 
     def run
@@ -37,54 +45,12 @@ module Imap::Backup
     end
 
     def header(menu)
-      modified = account.modified? ? "*" : ""
-
-      if account.multi_fetch_size > 1
-        multi_fetch_size = "\nmulti-fetch #{account.multi_fetch_size}"
-      end
-
-      if account.connection_options
-        escaped =
-          JSON.generate(account.connection_options)
-        connection_options =
-          "\nconnection options  '#{escaped}'"
-        space = " " * 12
-      else
-        connection_options = nil
-        space = " " * 4
-      end
-
-      menu.header = <<~HEADER.chomp
-        #{helpers.title_prefix} Account#{modified}
-
-        email   #{space}#{account.username}
-        password#{space}#{masked_password}
-        path    #{space}#{account.local_path}
-        folders #{space}#{folders.map { |f| f[:name] }.join(', ')}#{multi_fetch_size}
-        server  #{space}#{account.server}#{connection_options}
-
-        Choose an action
-      HEADER
+      Setup::Account::Header.new(menu: menu, account: account).run
     end
 
     def modify_email(menu)
       menu.choice("modify email") do
-        username = Setup::Asker.email(username)
-        Kernel.puts "username: #{username}"
-        other_accounts = config.accounts.reject { |a| a == account }
-        others = other_accounts.map { |a| a.username }
-        Kernel.puts "others: #{others.inspect}"
-        if others.include?(username)
-          Kernel.puts(
-            "There is already an account set up with that email address"
-          )
-        else
-          account.username = username
-          default = default_server(username)
-          if default && (account.server.nil? || (account.server == ""))
-            account.server = default
-          end
-        end
+        Setup::Email.new(account: account, config: config).run
       end
     end
 
@@ -96,25 +62,9 @@ module Imap::Backup
       end
     end
 
-    def path_modification_validator(path)
-      same = config.accounts.find do |a|
-        a.username != account.username && a.local_path == path
-      end
-      if same
-        Kernel.puts "The path '#{path}' is used to backup " \
-          "the account '#{same.username}'"
-        false
-      else
-        true
-      end
-    end
-
     def modify_backup_path(menu)
       menu.choice("modify backup path") do
-        existing = account.local_path.clone
-        account.local_path = Setup::Asker.backup_path(
-          account.local_path, ->(path) { path_modification_validator(path) }
-        )
+        Setup::BackupPath.new(account: account, config: config).run
       end
     end
 
@@ -169,32 +119,5 @@ module Imap::Backup
         end
       end
     end
-
-    def folders
-      account.folders || []
-    end
-
-    def masked_password
-      if (account.password == "") || account.password.nil?
-        "(unset)"
-      else
-        account.password.gsub(/./, "x")
-      end
-    end
-
-    def default_server(username)
-      provider = Email::Provider.for_address(username)
-
-      if provider.is_a?(Email::Provider::Unknown)
-        Kernel.puts "Can't decide provider for email address '#{username}'"
-        return nil
-      end
-
-      provider.host
-    end
-
-    def helpers
-      Setup::Helpers.new
-    end
   end
 end

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

@@ -1,11 +1,13 @@
 module Imap::Backup
   class Setup; end
 
-  Setup::Asker = Struct.new(:highline) do
+  class Setup::Asker
     EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
 
+    attr_reader :highline
+
     def initialize(highline)
-      super
+      @highline = highline
     end
 
     def email(default = "")
@@ -30,15 +32,6 @@ module Imap::Backup
       password
     end
 
-    def backup_path(default, validator)
-      highline.ask("backup directory: ") do |q|
-        q.default  = default
-        q.readline = true
-        q.validate = validator
-        q.responses[:not_valid] = "Choose a different directory "
-      end
-    end
-
     def self.email(default = "")
       new(Setup.highline).email(default)
     end
@@ -46,9 +39,5 @@ module Imap::Backup
     def self.password
       new(Setup.highline).password
     end
-
-    def self.backup_path(default, validator)
-      new(Setup.highline).backup_path(default, validator)
-    end
   end
 end

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

@@ -0,0 +1,41 @@
+module Imap::Backup
+  class Setup; end
+
+  class Setup::BackupPath
+    attr_reader :account
+    attr_reader :config
+
+    def initialize(account:, config:)
+      @account = account
+      @config = config
+    end
+
+    def run
+      account.local_path = highline.ask("backup directory: ") do |q|
+        q.default  = account.local_path
+        q.readline = true
+        q.validate = ->(path) { path_modification_validator(path) }
+        q.responses[:not_valid] = "Choose a different directory "
+      end
+    end
+
+    private
+
+    def highline
+      Setup.highline
+    end
+
+    def path_modification_validator(path)
+      same = config.accounts.find do |a|
+        a.username != account.username && a.local_path == path
+      end
+      if same
+        Kernel.puts "The path '#{path}' is used to backup " \
+                    "the account '#{same.username}'"
+        false
+      else
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require "email/provider"
+
+module Imap::Backup
+  class Setup; end
+
+  class Setup::Email
+    attr_reader :account
+    attr_reader :config
+
+    def initialize(account:, config:)
+      @account = account
+      @config = config
+    end
+
+    def run
+      username = Setup::Asker.email(account.username)
+      other_accounts = config.accounts.reject { |a| a == account }
+      others = other_accounts.map(&:username)
+      if others.include?(username)
+        Kernel.puts(
+          "There is already an account set up with that email address"
+        )
+      else
+        account.username = username
+        if account.server.nil? || (account.server == "")
+          default = default_server(username)
+          account.server = default if default
+        end
+      end
+    end
+
+    private
+
+    def default_server(username)
+      provider = Email::Provider.for_address(username)
+
+      if provider.is_a?(Email::Provider::Unknown)
+        Kernel.puts "Can't decide provider for email address '#{username}'"
+        return nil
+      end
+
+      provider.host
+    end
+  end
+end

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

@@ -12,13 +12,13 @@ module Imap::Backup
 
     def run
       if connection.nil?
-        Imap::Backup::Logger.logger.warn "Connection failed"
+        Logger.logger.warn "Connection failed"
         highline.ask "Press a key "
         return
       end
 
       if imap_folders.nil?
-        Imap::Backup::Logger.logger.warn "Unable to get folder list"
+        Logger.logger.warn "Unable to get folder list"
         highline.ask "Press a key "
         return
       end
@@ -90,7 +90,7 @@ module Imap::Backup
 
     def toggle_selection(folder_name)
       if selected?(folder_name)
-        new_list = account.folders.select { |f| f[:name] != folder_name }
+        new_list = account.folders.reject { |f| f[:name] == folder_name }
         account.folders = new_list
       else
         existing = account.folders || []

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

@@ -5,7 +5,7 @@ module Imap::Backup
 
   class Setup::Helpers
     def title_prefix
-      "imap-backup –"
+      "imap-backup -"
     end
 
     def version

data/lib/imap/backup/setup.rb

@@ -1,5 +1,6 @@
 require "highline"
 
+require "email/provider"
 require "imap/backup/account"
 require "imap/backup/setup/helpers"
 
@@ -36,7 +37,7 @@ module Imap::Backup
             config.save
             throw :done
           end
-          menu.choice("exit without saving changes")  { throw :done }
+          menu.choice("exit without saving changes") { throw :done }
         else
           menu.choice("quit") { throw :done }
         end
@@ -67,7 +68,7 @@ module Imap::Backup
       new_setting = !config.debug?
       menu.choice(menu_item) do
         config.debug = new_setting
-        Imap::Backup::Logger.setup_logging(config)
+        Logger.setup_logging(config)
       end
     end
 
@@ -76,13 +77,13 @@ module Imap::Backup
     end
 
     def default_account_config(username)
-      ::Imap::Backup::Account.new(
+      Imap::Backup::Account.new(
         username: username,
         password: "",
         local_path: File.join(config.path, username.tr("@", "_")),
         folders: []
       ).tap do |a|
-        server = Email::Provider.for_address(username)
+        server = ::Email::Provider.for_address(username)
         a.server = server.host if server.host
       end
     end

data/lib/imap/backup/thunderbird/mailbox_exporter.rb

@@ -21,28 +21,51 @@ module Imap::Backup
       local_folder_ok = local_folder.set_up
       return false if !local_folder_ok
 
-      if local_folder.msf_exists?
-        if force
-          Kernel.puts "Deleting '#{local_folder.msf_path}' as --force option was supplied"
-          File.unlink local_folder.msf_path
-        else
-          Kernel.puts "Skipping export of '#{serializer.folder}' as '#{local_folder.msf_path}' exists"
-          return false
-        end
+      skip_for_msf = check_msf
+      return false if skip_for_msf
+
+      skip_for_local_folder = check_local_folder
+      return false if skip_for_local_folder
+
+      copy_messages
+
+      true
+    end
+
+    private
+
+    def check_local_folder
+      return false if !local_folder.exists?
+
+      if force
+        Kernel.puts "Overwriting '#{local_folder.path}' as --force option was supplied"
+        return false
       end
 
-      if local_folder.exists?
-        if force
-          Kernel.puts "Overwriting '#{local_folder.path}' as --force option was supplied"
-        else
-          Kernel.puts "Skipping export of '#{serializer.folder}' as '#{local_folder.path}' exists"
-          return false
-        end
+      Kernel.puts "Skipping export of '#{serializer.folder}' as '#{local_folder.path}' exists"
+      true
+    end
+
+    def check_msf
+      return false if !local_folder.msf_exists?
+
+      if force
+        Kernel.puts "Deleting '#{local_folder.msf_path}' as --force option was supplied"
+        File.unlink local_folder.msf_path
+        return false
       end
 
+      Kernel.puts(
+        "Skipping export of '#{serializer.folder}' " \
+        "as '#{local_folder.msf_path}' exists"
+      )
+      true
+    end
+
+    def copy_messages
       File.open(local_folder.full_path, "w") do |f|
         enumerator = Serializer::MboxEnumerator.new(serializer.mbox_pathname)
-        enumerator.each.with_index do |raw, i|
+        enumerator.each do |raw|
           clean = Email::Mboxrd::Message.clean_serialized(raw)
           timestamp = Time.now.strftime("%a %b %d %H:%M:%S %Y")
           thunderbird_fom_line = "From - #{timestamp}"
@@ -50,12 +73,8 @@ module Imap::Backup
           f.write output
         end
       end
-
-      true
     end
 
-    private
-
     def local_folder
       @local_folder ||= begin
         top_level_folders = [EXPORT_PREFIX, email]

data/lib/imap/backup/uploader.rb

@@ -9,27 +9,65 @@ module Imap::Backup
     end
 
     def run
-      count = missing_uids.count
+      if folder.uids.any?
+        rename_serialized_folder
+      else
+        folder.create
+        serializer.force_uid_validity(folder.uid_validity)
+      end
+
       return if count.zero?
 
-      Imap::Backup::Logger.logger.debug "[#{folder.name}] #{count} to restore"
+      Logger.logger.debug "[#{folder.name}] #{count} to restore"
       serializer.each_message(missing_uids).with_index do |(uid, message), i|
-        next if message.nil?
+        upload_message uid, message, i + 1
+      end
+    end
+
+    private
+
+    def upload_message(uid, message, index)
+      return if message.nil?
 
-        log_prefix = "[#{folder.name}] uid: #{uid} (#{i + 1}/#{count}) -"
-        Imap::Backup::Logger.logger.debug(
-          "#{log_prefix} #{message.supplied_body.size} bytes"
-        )
+      log_prefix = "[#{folder.name}] uid: #{uid} (#{index}/#{count}) -"
+      Logger.logger.debug(
+        "#{log_prefix} #{message.supplied_body.size} bytes"
+      )
 
+      begin
         new_uid = folder.append(message)
         serializer.update_uid(uid, new_uid)
+      rescue StandardError => e
+        Logger.logger.warn "#{log_prefix} append error: #{e}"
       end
     end
 
-    private
+    def count
+      @count ||= missing_uids.count
+    end
 
     def missing_uids
       serializer.uids - folder.uids
     end
+
+    def rename_serialized_folder
+      Logger.logger.debug(
+        "There's already a '#{folder.name}' folder with emails"
+      )
+
+      # Rename the local folder to a unique name
+      new_name = serializer.apply_uid_validity(folder.uid_validity)
+
+      return if !new_name
+
+      # Restore the renamed folder
+      Logger.logger.debug(
+        "Backup '#{serializer.folder}' renamed and restored to '#{new_name}'"
+      )
+      @folder = Account::Folder.new(folder.connection, new_name)
+      folder.create
+      @serializer = Serializer.new(serializer.path, new_name)
+      serializer.force_uid_validity(@folder.uid_validity)
+    end
   end
 end

data/lib/imap/backup/utils.rb

@@ -11,7 +11,7 @@ module Imap::Backup
 
       message = format(
         "Permissions on '%<filename>s' " \
-          "should be 0%<limit>o, not 0%<actual>o",
+        "should be 0%<limit>o, not 0%<actual>o",
         filename: filename, limit: limit, actual: actual
       )
       raise message

data/lib/imap/backup/version.rb

@@ -4,6 +4,6 @@ module Imap::Backup
   MAJOR    = 6
   MINOR    = 0
   REVISION = 0
-  PRE      = "rc2".freeze
+  PRE      = nil
   VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")
 end

data/lib/imap/backup.rb

@@ -14,7 +14,6 @@ require "imap/backup/setup/asker"
 require "imap/backup/setup/connection_tester"
 require "imap/backup/setup/folder_chooser"
 require "imap/backup/version"
-require "email/provider"
 
 module Imap::Backup
   class ConfigurationNotFound < StandardError; end