imap-backup 15.0.2 → 15.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de4f5bfc1260430435d380fd3fa6c315efad4ef503b0429bce041615d3ae2e10
-  data.tar.gz: 3c1541e30cb01d1ecd6da9372e79b8e8c71f119eee5a11770bef76b90e89e037
+  metadata.gz: 9a391a879278c1f286d5756ebfc3e77c39acda7e5ec9441776e30fb720251cee
+  data.tar.gz: bcd9c851be504e9c775a241a21e1ecc708baf4f05ff7fe42160e7468c10ca3f3
 SHA512:
-  metadata.gz: 25aa565a7860560958b59c5f88f67b470128405acc15fc67fe3683152d0ea9c63d8787287f006249a22b26a88d92425bed653254126ef92259ea85022b33efcb
-  data.tar.gz: 54d8df69cef34dcafd3ba97f63f202b0f00e2306f8e12c4ea7329dfae5028e42e9a4050630fae2d03131048aa3c70e90ee7bb8a49a1388084bd136ad3e0ce973
+  metadata.gz: 289206eb94864c60e82b35db46e9f5d7531f73692bd10c02d407e800c77aa00597a149cfc7d05f749abe8d8189745a4b9b5a184fd8df472ea13d646fe8065105
+  data.tar.gz: b38e2740e7862fc92175a684dfd93a3b176ed3b8e56ae2ee6438490577ab54002238ecdf4d6f1449d0c557ca5996eea1b81f6aabbb6aaaa47ad455796b431903

data/docs/performance.md

@@ -1,14 +1,12 @@
-# Performace
+# Performance
 
-The two performance-related settings are "Download strategy",
-which is a global setting,
-and "Multi-fetch size", which is an Account-level setting.
+The two performance-related settings are "Download strategy", which is a global setting, and "Multi-fetch size", which is an Account-level setting.
 
 As with all performance tweaks, there are trade-offs.
 
 # Overview
 
-The defaults, which suit most machines and plays nice with servers is:
+The defaults, which suit most machines and play nice with servers are:
 
 * Download strategy: "delay writing metadata",
 * Multi-fetch size: 1.
@@ -18,7 +16,7 @@ a small virtual server or Raspberry Pi
 to run your backups, you can change "Download strategy".
 
 If your email provider supports it,
-and you don't have tight memeory limits,
+and you don't have tight memory limits,
 increase "Multi-fetch size" for faster backups.
 
 # Delay download writes
@@ -45,7 +43,7 @@ By default, during backup, each message is downloaded one-by-one.
 Using this setting, you can download chunks of emails at a time,
 potentially speeding up the process.
 
-Using multi-fetch *will* mean that the backup process will use
+Using multi-fetch mean that the backup process *will* use
 more memory - equivalent to the size of the groups of messages
 that are downloaded.
 

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

@@ -18,27 +18,33 @@ module Imap::Backup
     # Runs the backup
     # @return [void]
     def run
-      Logger.logger.info "Running backup of account: #{account.username}"
+      Logger.logger.info "Running backup of account '#{account.username}'"
       # start the connection so we get logging messages in the right order
       account.client.login
 
-      Account::FolderEnsurer.new(account: account).run
-      Account::LocalOnlyFolderDeleter.new(account: account).run if account.mirror_mode
+      run_pre_backup_tasks
       backup_folders = Account::BackupFolders.new(
         client: account.client, account: account
-      )
+      ).to_a
       if backup_folders.none?
-        Logger.logger.warn "Account #{account.username}: No folders found to backup"
+        Logger.logger.warn "No folders found to backup for account '#{account.username}'"
         return
       end
+      Logger.logger.debug "Starting backup of #{backup_folders.count} folders"
       backup_folders.each do |folder|
         Account::FolderBackup.new(account: account, folder: folder, refresh: refresh).run
       end
+      Logger.logger.debug "Backup of account '#{account.username}' complete"
     end
 
     private
 
     attr_reader :account
     attr_reader :refresh
+
+    def run_pre_backup_tasks
+      Account::FolderEnsurer.new(account: account).run
+      Account::LocalOnlyFolderDeleter.new(account: account).run if account.mirror_mode
+    end
   end
 end

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

@@ -31,19 +31,15 @@ module Imap::Backup
 
     # @raise any error that occurs more than 10 times
     def exist?
-      previous_level = Imap::Backup::Logger.logger.level
-      previous_debug = Net::IMAP.debug
-      Imap::Backup::Logger.logger.level = ::Logger::Severity::UNKNOWN
-      Net::IMAP.debug = false
+      Logger.logger.debug "Checking whether folder '#{name}' exists"
       retry_on_error(errors: EXAMINE_RETRY_CLASSES) do
         examine
       end
+      Logger.logger.debug "Folder '#{name}' exists"
       true
     rescue FolderNotFound
+      Logger.logger.debug "Folder '#{name}' does not exist"
       false
-    ensure
-      Imap::Backup::Logger.logger.level = previous_level
-      Net::IMAP.debug = previous_debug
     end
 
     # Creates the folder on the server
@@ -69,8 +65,11 @@ module Imap::Backup
     # @raise any error that occurs more than 10 times
     # @return [Array<Integer>] the folders message UIDs
     def uids
+      Logger.logger.debug "Fetching UIDs for folder '#{name}'"
       examine
-      client.uid_search(["ALL"]).sort
+      result = client.uid_search(["ALL"]).sort
+      Logger.logger.debug "#{result.count} UIDs found for folder '#{name}'"
+      result
     rescue FolderNotFound
       []
     rescue NoMethodError

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

@@ -22,11 +22,11 @@ module Imap::Backup
     # @raise [RuntimeError] if the configured download strategy is incorrect
     # @return [void]
     def run
+      Logger.logger.debug "Running backup for folder '#{folder.name}'"
+
       folder_ok = folder_ok?
       return if !folder_ok
 
-      Logger.logger.debug "[#{folder.name}] running backup"
-
       serializer.apply_uid_validity(folder.uid_validity)
 
       serializer.transaction do
@@ -36,6 +36,7 @@ module Imap::Backup
       # After the transaction the serializer will have any appended messages
       # so we can check differences between the server and the local backup
       LocalOnlyMessageDeleter.new(folder, raw_serializer).run if account.mirror_mode
+      Logger.logger.debug "Backup for folder '#{folder.name}' complete"
     end
 
     private
@@ -46,10 +47,13 @@ module Imap::Backup
 
     def folder_ok?
       begin
-        return false if !folder.exist?
+        if !folder.exist?
+          Logger.logger.info "Skipping backup for folder '#{folder.name}' as it does not exist"
+          return false
+        end
       rescue Encoding::UndefinedConversionError
         message = "Skipping backup for '#{folder.name}' " \
-                  "as it is not UTF-7 encoded correctly"
+                  "as it's name is not UTF-7 encoded correctly"
         Logger.logger.info message
         return false
       end

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

@@ -24,6 +24,7 @@ module Imap::Backup
     #   @return [void]
     no_commands do
       def run
+        Logger.logger.debug "Loading configuration"
         config = load_config(**options)
         exit_code = nil
         accounts = requested_accounts(config)
@@ -31,6 +32,7 @@ module Imap::Backup
           Logger.logger.warn "No matching accounts found to backup"
           return
         end
+        Logger.logger.debug "Starting backup of #{accounts.count} accounts"
         accounts.each do |account|
           backup = Account::Backup.new(account: account, refresh: refresh)
           backup.run
@@ -43,6 +45,7 @@ module Imap::Backup
           Logger.logger.error message
           next
         end
+        Logger.logger.debug "Backup complete"
         exit(exit_code) if exit_code
       end
     end

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

@@ -88,7 +88,7 @@ module Imap::Backup
       "password-environment-variable",
       type: :string,
       desc: "an environment variable that is set to your password",
-      aliases: ["-e"]
+      aliases: ["-w"]
     )
     method_option(
       "password-file",
@@ -137,7 +137,7 @@ module Imap::Backup
       "mirror",
       type: :boolean,
       desc: "if this option is given, " \
-            "emails that are removed from the server " \
+            "existing backed-up emails that are no longer on the server " \
             "will be removed from the local backup.",
       aliases: ["-m"]
     )

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

@@ -27,6 +27,7 @@ module Imap::Backup
     # @return [Array<String>] the account folders
     def list
       root = provider_root
+      Logger.logger.debug "Listing all account folders"
       mailbox_lists = imap.list(root, "*")
 
       return [] if mailbox_lists.nil?
@@ -105,7 +106,9 @@ module Imap::Backup
     # in the reference.
     def provider_root
       @provider_root ||= begin
+        Logger.logger.debug "Fetching provider root"
         root_info = imap.list("", "")[0]
+        Logger.logger.debug "Provider root is '#{root_info.name}'"
         root_info.name
       end
     end

data/lib/imap/backup/downloader.rb

@@ -19,7 +19,19 @@ module Imap::Backup
     # Runs the downloader
     # @return [void]
     def run
-      info("#{uids.count} new messages") if uids.any?
+      debug("#{serializer_uids.count} already messages already downloaded")
+      debug("#{folder_uids.count} messages on server")
+      local_only_count = (serializer_uids - folder_uids).count
+      if local_only_count.positive?
+        debug("#{local_only_count} downloaded messages no longer on server")
+      end
+
+      if uids.none?
+        debug("no new messages on server — skipping")
+        return
+      end
+
+      info("#{uids.count} new messages")
 
       uids.each_slice(multi_fetch_size).with_index do |block, i|
         multifetch_failed = download_block(block, i)
@@ -62,8 +74,8 @@ module Imap::Backup
         end
       if uids_and_bodies.nil?
         if multi_fetch_size > 1
-          uids = block.join(", ")
-          debug("Multi fetch failed for UIDs #{uids}, switching to single fetches")
+          uid_list = block.join(", ")
+          debug("Multi fetch failed for UIDs #{uid_list}, switching to single fetches")
           return true
         else
           debug("Fetch failed for UID #{block[0]} - skipping")
@@ -96,8 +108,16 @@ module Imap::Backup
       error(e)
     end
 
+    def folder_uids
+      @folder_uids ||= folder.uids
+    end
+
+    def serializer_uids
+      @serializer_uids ||= serializer.uids
+    end
+
     def uids
-      @uids ||= folder.uids - serializer.uids
+      @uids ||= folder_uids - serializer_uids
     end
 
     def debug(message)

data/lib/imap/backup/version.rb

@@ -4,9 +4,9 @@ module Imap::Backup
   # @private
   MAJOR    = 15
   # @private
-  MINOR    = 0
+  MINOR    = 1
   # @private
-  REVISION = 2
+  REVISION = 3
   # @private
   PRE      = nil
   # The application version

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 15.0.2
+  version: 15.1.3
 platform: ruby
 authors:
 - Joe Yates
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -219,7 +218,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,8 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files: []