imap-backup 9.3.2 → 10.0.0

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

@@ -1,3 +1,5 @@
+require "imap/backup/account/backup_folders"
+require "imap/backup/account/serialized_folders"
 require "imap/backup/thunderbird/mailbox_exporter"
 
 module Imap::Backup
@@ -14,12 +16,15 @@ module Imap::Backup
     def ignore_history(email)
       Logger.setup_logging options
       config = load_config(**options)
-      connection = connection(config, email)
+      account = account(config, email)
 
-      connection.backup_folders.each do |folder|
+      backup_folders = Account::BackupFolders.new(
+        client: account.client, account: account
+      )
+      backup_folders.each do |folder|
         next if !folder.exist?
 
-        serializer = Serializer.new(connection.account.local_path, folder.name)
+        serializer = Serializer.new(account.local_path, folder.name)
         do_ignore_folder_history(folder, serializer)
       end
     end
@@ -52,7 +57,7 @@ module Imap::Backup
       profile_name = options[:profile]
 
       config = load_config(**options)
-      connection = connection(config, email)
+      account = account(config, email)
       profile = thunderbird_profile(profile_name)
 
       if !profile
@@ -61,7 +66,11 @@ module Imap::Backup
         raise "Default Thunderbird profile not found"
       end
 
-      connection.local_folders.each do |serializer, _folder|
+      serialized_folders = Account::SerializedFolders.new(account: account)
+
+      raise "No serialized folders were found for account '#{email}'" if serialized_folders.none?
+
+      serialized_folders.each do |serializer, _folder|
         Thunderbird::MailboxExporter.new(
           email, serializer, profile, force: force
         ).run

data/lib/imap/backup/cli.rb

@@ -49,15 +49,6 @@ module Imap::Backup
       true
     end
 
-    def self.accounts_option
-      method_option(
-        "accounts",
-        type: :string,
-        desc: "a comma-separated list of accounts (defaults to all configured accounts)",
-        aliases: ["-a"]
-      )
-    end
-
     desc "backup [OPTIONS]", "Run the backup"
     long_desc <<~DESC
       Downloads any emails not yet present locally.

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

@@ -7,15 +7,19 @@ module Imap::Backup
   class Client::Default
     extend Forwardable
     def_delegators :imap, *%i(
-      append authenticate create expunge login namespace
+      append authenticate create expunge namespace
       responses uid_fetch uid_search uid_store
     )
 
-    attr_reader :args
+    attr_reader :account
+    attr_reader :options
+    attr_reader :server
     attr_accessor :state
 
-    def initialize(*args)
-      @args = args
+    def initialize(server, account, options)
+      @account = account
+      @options = options
+      @server = server
       @state = nil
     end
 
@@ -28,6 +32,21 @@ module Imap::Backup
       mailbox_lists.map { |ml| extract_name(ml) }
     end
 
+    def login
+      Logger.logger.debug "Logging in: #{account.username}/#{masked_password}"
+      imap.login(account.username, account.password)
+      Logger.logger.debug "Login complete"
+    end
+
+    def reconnect
+      disconnect
+      login
+    end
+
+    def username
+      account.username
+    end
+
     # Track mailbox selection during delegation to Net::IMAP instance
 
     def disconnect
@@ -53,7 +72,7 @@ module Imap::Backup
     private
 
     def imap
-      @imap ||= Net::IMAP.new(*args)
+      @imap ||= Net::IMAP.new(server, options)
     end
 
     def extract_name(mailbox_list)
@@ -61,6 +80,10 @@ module Imap::Backup
       Net::IMAP.decode_utf7(utf7_encoded)
     end
 
+    def masked_password
+      account.password.gsub(/./, "x")
+    end
+
     # 6.3.8. LIST Command
     # An empty ("" string) mailbox name argument is a special request to
     # return the hierarchy delimiter and the root name of the name given

data/lib/imap/backup/configuration.rb

@@ -1,7 +1,10 @@
+require "fileutils"
 require "json"
 require "os"
 
 require "imap/backup/account"
+require "imap/backup/file_mode"
+require "imap/backup/serializer/permission_checker"
 
 module Imap::Backup
   class Configuration
@@ -66,7 +69,10 @@ module Imap::Backup
     def data
       @data ||=
         if File.exist?(pathname)
-          Utils.check_permissions(pathname, 0o600) if !windows?
+          permission_checker = Serializer::PermissionChecker.new(
+            filename: pathname, limit: 0o600
+          )
+          permission_checker.run if !windows?
           contents = File.read(pathname)
           JSON.parse(contents, symbolize_names: true)
         else
@@ -83,7 +89,7 @@ module Imap::Backup
     end
 
     def make_private(path)
-      FileUtils.chmod(0o700, path) if Utils.mode(path) != 0o700
+      FileUtils.chmod(0o700, path) if FileMode.new(filename: path).mode != 0o700
     end
 
     def windows?

data/lib/imap/backup/downloader.rb

@@ -24,7 +24,7 @@ module Imap::Backup
     end
 
     def run
-      debug "#{uids.count} new messages"
+      info("#{uids.count} new messages") if uids.any?
 
       uids.each_slice(multi_fetch_size).with_index do |block, i|
         multifetch_failed = download_block(block, i)
@@ -35,6 +35,9 @@ module Imap::Backup
       @multi_fetch_size = 1
       @uids = nil
       retry
+    rescue Net::IMAP::ByeResponseError
+      folder.client.reconnect
+      retry
     end
 
     private

data/lib/imap/backup/file_mode.rb

@@ -0,0 +1,16 @@
+module Imap::Backup
+  class FileMode
+    attr_reader :filename
+
+    def initialize(filename:)
+      @filename = filename
+    end
+
+    def mode
+      return nil if !File.exist?(filename)
+
+      stat = File.stat(filename)
+      stat.mode & 0o777
+    end
+  end
+end

data/lib/imap/backup/mirror.rb

@@ -94,8 +94,7 @@ module Imap::Backup
     end
 
     def destination_email
-      # TODO: is there a more elegant way to get the email?
-      folder.connection.account.username
+      folder.client.username
     end
   end
 end

data/lib/imap/backup/serializer/directory.rb

@@ -1,5 +1,7 @@
 require "os"
 
+require "imap/backup/serializer/folder_maker"
+
 module Imap::Backup
   class Serializer; end
 
@@ -16,13 +18,13 @@ module Imap::Backup
 
     def ensure_exists
       if !File.directory?(full_path)
-        Utils.make_folder(
-          path, relative, DIRECTORY_PERMISSIONS
-        )
+        Serializer::FolderMaker.new(
+          base: path, path: relative, permissions: DIRECTORY_PERMISSIONS
+        ).run
       end
 
       return if OS.windows?
-      return if Utils.mode(full_path) == DIRECTORY_PERMISSIONS
+      return if FileMode.new(filename: full_path).mode == DIRECTORY_PERMISSIONS
 
       FileUtils.chmod DIRECTORY_PERMISSIONS, full_path
     end

data/lib/imap/backup/serializer/folder_maker.rb

@@ -0,0 +1,33 @@
+require "fileutils"
+
+module Imap::Backup
+  class Serializer; end
+
+  class Serializer::FolderMaker
+    attr_reader :base
+    attr_reader :path
+    attr_reader :permissions
+
+    def initialize(base:, path:, permissions:)
+      @base = base
+      @path = path
+      @permissions = permissions
+    end
+
+    def run
+      parts = path.split("/")
+      return if parts.empty?
+
+      FileUtils.mkdir_p(full_path) if !File.exist?(full_path)
+      full = base
+      parts.each do |part|
+        full = File.join(full, part)
+        FileUtils.chmod permissions, full
+      end
+    end
+
+    def full_path
+      File.join(base, path)
+    end
+  end
+end

data/lib/imap/backup/serializer/permission_checker.rb

@@ -0,0 +1,26 @@
+module Imap::Backup
+  class Serializer::PermissionChecker
+    attr_reader :filename
+    attr_reader :limit
+
+    def initialize(filename:, limit:)
+      @filename = filename
+      @limit = limit
+    end
+
+    def run
+      actual = FileMode.new(filename: filename).mode
+      return nil if actual.nil?
+
+      mask = ~limit & 0o777
+      return if (actual & mask).zero?
+
+      message = format(
+        "Permissions on '%<filename>s' " \
+        "should be 0%<limit>o, not 0%<actual>o",
+        filename: filename, limit: limit, actual: actual
+      )
+      raise message
+    end
+  end
+end

data/lib/imap/backup/serializer.rb

@@ -36,7 +36,7 @@ module Imap::Backup
     # Returns true if there are existing, valid files
     # false otherwise (in which case any existing files are deleted)
     def validate!
-      return if @validated
+      return true if @validated
 
       optionally_migrate2to3
 

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

@@ -9,18 +9,12 @@ module Imap::Backup
     end
 
     def test
-      connection.client
+      account.client
       "Connection successful"
     rescue Net::IMAP::NoResponseError
       "No response"
     rescue StandardError => e
       "Unexpected error: #{e}"
     end
-
-    private
-
-    def connection
-      Account::Connection.new(account)
-    end
   end
 end

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

@@ -11,13 +11,12 @@ module Imap::Backup
     end
 
     def run
-      if connection.nil?
-        Logger.logger.warn "Connection failed"
+      if client.nil?
         highline.ask "Press a key "
         return
       end
 
-      if imap_folders.nil?
+      if folder_names.empty?
         Logger.logger.warn "Unable to get folder list"
         highline.ask "Press a key "
         return
@@ -50,7 +49,7 @@ module Imap::Backup
     end
 
     def add_folders(menu)
-      imap_folders.each do |folder|
+      folder_names.each do |folder|
         mark = selected?(folder) ? "+" : "-"
         menu.choice("#{mark} #{folder}") do
           toggle_selection folder
@@ -69,7 +68,7 @@ module Imap::Backup
       removed = []
       config_folders = []
       account.folders.each do |f|
-        found = imap_folders.find { |folder| folder == f[:name] }
+        found = folder_names.find { |folder| folder == f[:name] }
         if found
           config_folders << f
         else
@@ -98,14 +97,15 @@ module Imap::Backup
       end
     end
 
-    def connection
-      @connection ||= Account::Connection.new(account)
+    def client
+      @client ||= account.client
     rescue StandardError
+      Logger.logger.warn "Connection failed"
       nil
     end
 
-    def imap_folders
-      @imap_folders ||= connection.folder_names
+    def folder_names
+      @folder_names ||= client.list
     end
 
     def highline

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

@@ -18,8 +18,18 @@ module Imap::Backup
     end
 
     def run
+      if !profile_set_up
+        error "The Thunderbird profile '#{profile.title}' " \
+              "has not been set up. " \
+              "Please set it up before trying to export"
+        return false
+      end
+
       local_folder_ok = local_folder.set_up
-      return false if !local_folder_ok
+      if !local_folder_ok
+        error "Failed to set up local folder"
+        return false
+      end
 
       skip_for_msf = check_msf
       return false if skip_for_msf
@@ -27,6 +37,7 @@ module Imap::Backup
       skip_for_local_folder = check_local_folder
       return false if skip_for_local_folder
 
+      info "Exporting account '#{email}' to folder '#{local_folder.full_path}'"
       copy_messages
 
       true
@@ -34,15 +45,19 @@ module Imap::Backup
 
     private
 
+    def profile_set_up
+      File.exist?(profile.local_folders_path)
+    end
+
     def check_local_folder
       return false if !local_folder.exists?
 
       if force
-        Kernel.puts "Overwriting '#{local_folder.path}' as --force option was supplied"
+        info "Overwriting '#{local_folder.path}' as --force option was supplied"
         return false
       end
 
-      Kernel.puts "Skipping export of '#{serializer.folder}' as '#{local_folder.path}' exists"
+      warning "Skipping export of '#{serializer.folder}' as '#{local_folder.full_path}' exists"
       true
     end
 
@@ -50,12 +65,12 @@ module Imap::Backup
       return false if !local_folder.msf_exists?
 
       if force
-        Kernel.puts "Deleting '#{local_folder.msf_path}' as --force option was supplied"
+        info "Deleting '#{local_folder.msf_path}' as --force option was supplied"
         File.unlink local_folder.msf_path
         return false
       end
 
-      Kernel.puts(
+      warning(
         "Skipping export of '#{serializer.folder}' " \
         "as '#{local_folder.msf_path}' exists"
       )
@@ -66,8 +81,8 @@ module Imap::Backup
       File.open(local_folder.full_path, "w") do |f|
         serializer.messages.each do |message|
           timestamp = Time.now.strftime("%a %b %d %H:%M:%S %Y")
-          thunderbird_fom_line = "From - #{timestamp}"
-          output = "#{thunderbird_fom_line}\n#{message.body}\n"
+          thunderbird_from_line = "From - #{timestamp}"
+          output = "#{thunderbird_from_line}\n#{message.body}\n"
           f.write output
         end
       end
@@ -80,5 +95,17 @@ module Imap::Backup
         Thunderbird::LocalFolder.new(profile, prefixed_folder_path)
       end
     end
+
+    def error(message)
+      Logger.logger.error("[Thunderbird::MailboxExporter] #{message}")
+    end
+
+    def info(message)
+      Logger.logger.info("[Thunderbird::MailboxExporter] #{message}")
+    end
+
+    def warning(message)
+      Logger.logger.warn("[Thunderbird::MailboxExporter] #{message}")
+    end
   end
 end

data/lib/imap/backup/uploader.rb

@@ -64,7 +64,7 @@ module Imap::Backup
       Logger.logger.debug(
         "Backup '#{serializer.folder}' renamed and restored to '#{new_name}'"
       )
-      @folder = Account::Folder.new(folder.connection, new_name)
+      @folder = Account::Folder.new(folder.client, new_name)
       folder.create
       @serializer = Serializer.new(serializer.path, new_name)
       serializer.force_uid_validity(@folder.uid_validity)

data/lib/imap/backup/version.rb

@@ -1,9 +1,9 @@
 module Imap; end
 
 module Imap::Backup
-  MAJOR    = 9
-  MINOR    = 3
-  REVISION = 2
+  MAJOR    = 10
+  MINOR    = 0
+  REVISION = 0
   PRE      = nil
   VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")
 end

data/lib/imap/backup.rb

@@ -1,7 +1,5 @@
 module Imap; end
 
-require "imap/backup/utils"
-require "imap/backup/account/connection"
 require "imap/backup/account/folder"
 require "imap/backup/configuration"
 require "imap/backup/downloader"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 9.3.2
+  version: 10.0.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-08 00:00:00.000000000 Z
+date: 2023-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -232,11 +232,14 @@ files:
 - lib/email/provider/unknown.rb
 - lib/imap/backup.rb
 - lib/imap/backup/account.rb
-- lib/imap/backup/account/connection.rb
-- lib/imap/backup/account/connection/backup_folders.rb
-- lib/imap/backup/account/connection/client_factory.rb
-- lib/imap/backup/account/connection/folder_names.rb
+- lib/imap/backup/account/backup.rb
+- lib/imap/backup/account/backup_folders.rb
+- lib/imap/backup/account/client_factory.rb
 - lib/imap/backup/account/folder.rb
+- lib/imap/backup/account/folder_ensurer.rb
+- lib/imap/backup/account/local_only_folder_deleter.rb
+- lib/imap/backup/account/restore.rb
+- lib/imap/backup/account/serialized_folders.rb
 - lib/imap/backup/cli.rb
 - lib/imap/backup/cli/backup.rb
 - lib/imap/backup/cli/folder_enumerator.rb
@@ -253,6 +256,7 @@ files:
 - lib/imap/backup/client/default.rb
 - lib/imap/backup/configuration.rb
 - lib/imap/backup/downloader.rb
+- lib/imap/backup/file_mode.rb
 - lib/imap/backup/flag_refresher.rb
 - lib/imap/backup/local_only_message_deleter.rb
 - lib/imap/backup/logger.rb
@@ -263,10 +267,12 @@ files:
 - lib/imap/backup/serializer.rb
 - lib/imap/backup/serializer/appender.rb
 - lib/imap/backup/serializer/directory.rb
+- lib/imap/backup/serializer/folder_maker.rb
 - lib/imap/backup/serializer/imap.rb
 - lib/imap/backup/serializer/mbox.rb
 - lib/imap/backup/serializer/message.rb
 - lib/imap/backup/serializer/message_enumerator.rb
+- lib/imap/backup/serializer/permission_checker.rb
 - lib/imap/backup/serializer/unused_name_finder.rb
 - lib/imap/backup/serializer/version2_migrator.rb
 - lib/imap/backup/setup.rb
@@ -280,7 +286,6 @@ files:
 - lib/imap/backup/setup/helpers.rb
 - lib/imap/backup/thunderbird/mailbox_exporter.rb
 - lib/imap/backup/uploader.rb
-- lib/imap/backup/utils.rb
 - lib/imap/backup/version.rb
 - lib/retry_on_error.rb
 - lib/text/sanitizer.rb

data/lib/imap/backup/account/connection/folder_names.rb

@@ -1,26 +0,0 @@
-module Imap::Backup
-  class Account; end
-  class Account::Connection; end
-
-  class Account::Connection::FolderNames
-    attr_reader :account
-    attr_reader :client
-
-    def initialize(client:, account:)
-      @client = client
-      @account = account
-    end
-
-    def run
-      folder_names = client.list
-
-      if folder_names.empty?
-        message = "Unable to get folder list for account #{account.username}"
-        Logger.logger.info message
-        raise message
-      end
-
-      folder_names
-    end
-  end
-end