imap-backup 9.1.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9d95502af3aa99d3ad49581ff743c641d12f308a1326ba2aabc1dcc2ec5f4f
-  data.tar.gz: ddf93a5e5bcc90ef698607b53224f5082da7cd0a7f65b52e0bf892999bb96898
+  metadata.gz: 2817e61358b848f7dbef08e1a16562def8cd364e66d317e4dac56c1f5e62f958
+  data.tar.gz: ec0e2d2963e863b204b0529ca3746492703486e8f77a9e7c08bc301b203249de
 SHA512:
-  metadata.gz: 582736b8992988cb3d34c48022cf59044d92c8c9488a133afe49610f4abf8853a98c31eb6c61e677d47363252dcbf5a2b923646b2643dd059bd71923a06e652f
-  data.tar.gz: 11ba0236028272763b078aa0e9d84d636fcb98478a7d225c1c8406c771838d158fd218ba259697a2aac7ead306d9fe13eb89f2aec1712d7416ff7afca86beb4e
+  metadata.gz: 66871fce3faebbcbd87737fef230803b46f32025b28753fe4f83813e652ef14817fce302da0570000f0d0ecb582862589a84f535a94aa1fa7cc1578eaf30591c
+  data.tar.gz: 274cfc47767322e31eb1e7206c3d1d449b2098ba1a65073c80aa5010c06924abfc7a952aeace01436715a7f95599503d86bcecbbdf210f7c8b5529bf7bee4fdf

data/lib/imap/backup/cli.rb

@@ -54,8 +54,8 @@ module Imap::Backup
       aliases: ["-r"]
     )
     def backup
-      Imap::Backup::Logger.setup_logging options
-      Backup.new(options).run
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Backup.new(non_logging_options).run
     end
 
     desc "local SUBCOMMAND [OPTIONS]", "View local info"
@@ -111,8 +111,8 @@ module Imap::Backup
       aliases: ["-s"]
     )
     def migrate(source_email, destination_email)
-      Imap::Backup::Logger.setup_logging options
-      Migrate.new(source_email, destination_email, **options).run
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Migrate.new(source_email, destination_email, **non_logging_options).run
     end
 
     desc(
@@ -161,8 +161,8 @@ module Imap::Backup
       aliases: ["-s"]
     )
     def mirror(source_email, destination_email)
-      Imap::Backup::Logger.setup_logging options
-      Mirror.new(source_email, destination_email, **options).run
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Mirror.new(source_email, destination_email, **non_logging_options).run
     end
 
     desc "remote SUBCOMMAND [OPTIONS]", "View info about online accounts"
@@ -178,8 +178,8 @@ module Imap::Backup
     quiet_option
     verbose_option
     def restore(email = nil)
-      Imap::Backup::Logger.setup_logging options
-      Restore.new(email, options).run
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Restore.new(email, non_logging_options).run
     end
 
     desc "setup", "Configure imap-backup"
@@ -191,8 +191,8 @@ module Imap::Backup
     quiet_option
     verbose_option
     def setup
-      Imap::Backup::Logger.setup_logging options
-      Setup.new(options).run
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Setup.new(non_logging_options).run
     end
 
     desc "stats EMAIL [OPTIONS]", "Print stats for each account folder"
@@ -206,8 +206,8 @@ module Imap::Backup
     quiet_option
     verbose_option
     def stats(email)
-      Imap::Backup::Logger.setup_logging options
-      Stats.new(email, options).run
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Stats.new(email, non_logging_options).run
     end
 
     desc "utils SUBCOMMAND [OPTIONS]", "Various utilities"

data/lib/imap/backup/logger.rb

@@ -2,7 +2,7 @@ require "logger"
 require "singleton"
 
 require "imap/backup/configuration"
-require "imap/backup/sanitizer"
+require "text/sanitizer"
 
 module Imap::Backup
   class Logger
@@ -13,11 +13,14 @@ module Imap::Backup
     end
 
     def self.setup_logging(options = {})
+      copy = options.clone
+      quiet = copy.delete(:quiet)
+      verbose = copy.delete(:verbose)
       level =
         case
-        when options[:quiet]
+        when quiet
           ::Logger::Severity::UNKNOWN
-        when options[:verbose]
+        when verbose
           ::Logger::Severity::DEBUG
         else
           ::Logger::Severity::INFO
@@ -25,10 +28,12 @@ module Imap::Backup
       logger.level = level
       debug = level == ::Logger::Severity::DEBUG
       Net::IMAP.debug = debug
+
+      copy
     end
 
     def self.sanitize_stderr
-      sanitizer = Sanitizer.new($stdout)
+      sanitizer = Text::Sanitizer.new($stdout)
       previous_stderr = $stderr
       $stderr = sanitizer
       yield

data/lib/imap/backup/naming.rb

@@ -0,0 +1,25 @@
+module Imap::Backup
+  class Naming
+    INVALID_FILENAME_CHARACTERS = ":%;".freeze
+    INVALID_FILENAME_CHARACTER_MATCH = /([#{INVALID_FILENAME_CHARACTERS}])/.freeze
+
+    # `*_path` functions treat `/` as an acceptable character
+    def self.to_local_path(name)
+      name.gsub(INVALID_FILENAME_CHARACTER_MATCH) do |character|
+        hex =
+          character.
+          codepoints[0].
+          to_s(16)
+        "%#{hex};"
+      end
+    end
+
+    def self.from_local_path(name)
+      name.gsub(/%(.*?);/) do
+        ::Regexp.last_match(1).
+          to_i(16).
+          chr("UTF-8")
+      end
+    end
+  end
+end

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

@@ -1,4 +1,6 @@
 module Imap::Backup
+  class Serializer; end
+
   class Serializer::Appender
     attr_reader :imap
     attr_reader :folder

data/lib/imap/backup/serializer.rb

@@ -1,6 +1,7 @@
 require "forwardable"
 
 require "email/mboxrd/message"
+require "imap/backup/naming"
 require "imap/backup/serializer/appender"
 require "imap/backup/serializer/imap"
 require "imap/backup/serializer/message"
@@ -72,7 +73,7 @@ module Imap::Backup
     def append(uid, message, flags)
       validate!
 
-      appender = Serializer::Appender.new(folder: folder, imap: imap, mbox: mbox)
+      appender = Serializer::Appender.new(folder: sanitized, imap: imap, mbox: mbox)
       appender.run(uid: uid, message: message, flags: flags)
     end
 
@@ -116,14 +117,16 @@ module Imap::Backup
     end
 
     def folder_path
-      self.class.folder_path_for(path: path, folder: folder)
+      self.class.folder_path_for(path: path, folder: sanitized)
     end
 
     private
 
     def rename(new_name)
       destination = self.class.folder_path_for(path: path, folder: new_name)
-      ensure_containing_directory(new_name)
+      relative = File.dirname(new_name)
+      directory = Serializer::Directory.new(path, relative)
+      directory.ensure_exists
       mbox.rename destination
       imap.rename destination
     end
@@ -136,7 +139,7 @@ module Imap::Backup
     def mbox
       @mbox ||=
         begin
-          ensure_containing_directory(folder)
+          ensure_containing_directory
           Serializer::Mbox.new(folder_path)
         end
     end
@@ -144,11 +147,15 @@ module Imap::Backup
     def imap
       @imap ||=
         begin
-          ensure_containing_directory(folder)
+          ensure_containing_directory
           Serializer::Imap.new(folder_path)
         end
     end
 
+    def sanitized
+      @sanitized ||= Naming.to_local_path(folder)
+    end
+
     def optionally_migrate2to3
       migrator = Version2Migrator.new(folder_path)
       return if !migrator.required?
@@ -162,8 +169,8 @@ module Imap::Backup
       migrator.run
     end
 
-    def ensure_containing_directory(folder)
-      relative = File.dirname(folder)
+    def ensure_containing_directory
+      relative = File.dirname(sanitized)
       directory = Serializer::Directory.new(path, relative)
       directory.ensure_exists
     end

data/lib/imap/backup/version.rb

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

data/lib/text/sanitizer.rb

@@ -0,0 +1,46 @@
+require "forwardable"
+
+module Text; end
+
+class Text::Sanitizer
+  extend Forwardable
+
+  attr_reader :output
+
+  delegate puts: :output
+  delegate write: :output
+
+  def initialize(output)
+    @output = output
+    @current = ""
+  end
+
+  def print(*args)
+    @current << args.join
+    loop do
+      line, newline, rest = @current.partition("\n")
+      break if newline != "\n"
+
+      clean = sanitize(line)
+      output.puts clean
+      @current = rest
+    end
+  end
+
+  def flush
+    return if @current == ""
+
+    clean = sanitize(@current)
+    output.puts clean
+  end
+
+  private
+
+  def sanitize(text)
+    # Hide password in Net::IMAP debug output
+    text.gsub(
+      /\A(C: RUBY\d+ LOGIN \S+) \S+/,
+      "\\1 [PASSWORD REDACTED]"
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -258,7 +258,7 @@ files:
 - lib/imap/backup/migrator.rb
 - lib/imap/backup/mirror.rb
 - lib/imap/backup/mirror/map.rb
-- lib/imap/backup/sanitizer.rb
+- lib/imap/backup/naming.rb
 - lib/imap/backup/serializer.rb
 - lib/imap/backup/serializer/appender.rb
 - lib/imap/backup/serializer/directory.rb
@@ -282,6 +282,7 @@ files:
 - lib/imap/backup/utils.rb
 - lib/imap/backup/version.rb
 - lib/retry_on_error.rb
+- lib/text/sanitizer.rb
 homepage: https://github.com/joeyates/imap-backup
 licenses:
 - MIT

data/lib/imap/backup/sanitizer.rb

@@ -1,46 +0,0 @@
-require "forwardable"
-
-module Imap::Backup
-  class Sanitizer
-    extend Forwardable
-
-    attr_reader :output
-
-    delegate puts: :output
-    delegate write: :output
-
-    def initialize(output)
-      @output = output
-      @current = ""
-    end
-
-    def print(*args)
-      @current << args.join
-      loop do
-        line, newline, rest = @current.partition("\n")
-        break if newline != "\n"
-
-        clean = sanitize(line)
-        output.puts clean
-        @current = rest
-      end
-    end
-
-    def flush
-      return if @current == ""
-
-      clean = sanitize(@current)
-      output.puts clean
-    end
-
-    private
-
-    def sanitize(text)
-      # Hide password in Net::IMAP debug output
-      text.gsub(
-        /\A(C: RUBY\d+ LOGIN \S+) \S+/,
-        "\\1 [PASSWORD REDACTED]"
-      )
-    end
-  end
-end