imap-backup 9.4.0.pre1 → 10.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 9.4.0.pre1
+  version: 10.0.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 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
@@ -300,9 +305,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key:

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

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

@@ -1,136 +0,0 @@
-require "imap/backup/client/apple_mail"
-require "imap/backup/client/default"
-require "imap/backup/account/connection/backup_folders"
-require "imap/backup/account/connection/client_factory"
-require "imap/backup/account/connection/folder_names"
-require "imap/backup/flag_refresher"
-require "imap/backup/local_only_message_deleter"
-require "imap/backup/serializer/directory"
-
-module Imap::Backup
-  class Account; end
-
-  class Account::Connection
-    attr_reader :account
-
-    def initialize(account)
-      @account = account
-      reset
-    end
-
-    def folder_names
-      @folder_names ||= Account::Connection::FolderNames.new(client: client, account: account).run
-    end
-
-    def backup_folders
-      @backup_folders ||=
-        Account::Connection::BackupFolders.new(client: client, account: account).run
-    end
-
-    def namespaces
-      client.namespace
-    end
-
-    def run_backup(refresh: false)
-      Logger.logger.info "Running backup of account: #{account.username}"
-      # start the connection so we get logging messages in the right order
-      client
-      ensure_account_folder
-      if account.mirror_mode
-        # Delete serialized folders that are not to be backed up
-        wanted = backup_folders.map(&:name)
-        local_folders do |serializer, _folder|
-          serializer.delete if !wanted.include?(serializer.folder)
-        end
-      end
-      each_folder do |folder, serializer|
-        begin
-          next if !folder.exist?
-        rescue Encoding::UndefinedConversionError
-          message = "Skipping backup for '#{folder.name}' " \
-                    "as it is not UTF-7 encoded correctly"
-          Logger.logger.info message
-          next
-        end
-
-        Logger.logger.debug "[#{folder.name}] running backup"
-        serializer.apply_uid_validity(folder.uid_validity)
-        begin
-          Downloader.new(
-            folder,
-            serializer,
-            multi_fetch_size: account.multi_fetch_size,
-            reset_seen_flags_after_fetch: account.reset_seen_flags_after_fetch
-          ).run
-          if account.mirror_mode
-            Logger.logger.info "Mirror mode - Deleting messages only present locally"
-            LocalOnlyMessageDeleter.new(folder, serializer).run
-          end
-          FlagRefresher.new(folder, serializer).run if account.mirror_mode || refresh
-        rescue Net::IMAP::ByeResponseError
-          reconnect
-          retry
-        end
-      end
-    end
-
-    def local_folders
-      return enum_for(:local_folders) if !block_given?
-
-      ensure_account_folder
-      glob = File.join(account.local_path, "**", "*.imap")
-      base = Pathname.new(account.local_path)
-      Pathname.glob(glob) do |path|
-        name = path.relative_path_from(base).to_s[0..-6]
-        serializer = Serializer.new(account.local_path, name)
-        folder = Account::Folder.new(self, name)
-        yield serializer, folder
-      end
-    end
-
-    def restore
-      local_folders do |serializer, folder|
-        Uploader.new(folder, serializer).run
-      end
-    end
-
-    def disconnect
-      client.disconnect if @client
-      reset
-    end
-
-    def reconnect
-      disconnect
-    end
-
-    def reset
-      @backup_folders = nil
-      @client = nil
-      @folder_names = nil
-    end
-
-    # TODO: make this private
-    def client
-      @client ||= Account::Connection::ClientFactory.new(account: account).run
-    end
-
-    private
-
-    def each_folder
-      backup_folders.each do |folder|
-        serializer = Serializer.new(account.local_path, folder.name)
-        yield folder, serializer
-      end
-    end
-
-    def ensure_account_folder
-      raise "The backup path for #{account.username} is not set" if !account.local_path
-
-      Utils.make_folder(
-        File.dirname(account.local_path),
-        File.basename(account.local_path),
-        Serializer::Directory::DIRECTORY_PERMISSIONS
-      )
-    end
-  end
-end

data/lib/imap/backup/utils.rb

@@ -1,40 +0,0 @@
-require "fileutils"
-
-module Imap::Backup
-  module Utils
-    def self.check_permissions(filename, limit)
-      actual = mode(filename)
-      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
-
-    def self.mode(filename)
-      return nil if !File.exist?(filename)
-
-      stat = File.stat(filename)
-      stat.mode & 0o777
-    end
-
-    def self.make_folder(base_path, path, permissions)
-      parts = path.split("/")
-      return if parts.empty?
-
-      full_path = File.join(base_path, path)
-      FileUtils.mkdir_p full_path
-      path = base_path
-      parts.each do |part|
-        path = File.join(path, part)
-        FileUtils.chmod permissions, path
-      end
-    end
-  end
-end