imap-backup 4.0.2 → 4.0.3

data/lib/thunderbird/local_folder.rb

@@ -1,97 +1,65 @@
 require "thunderbird/profile"
-require "thunderbird/local_folder_placeholder"
+require "thunderbird/subdirectory"
 
+# A local folder is a file containing emails
 class Thunderbird::LocalFolder
-  attr_reader :folder_path
+  attr_reader :path
   attr_reader :profile
 
-  def initialize(profile, folder_path)
+  def initialize(profile, path)
     @profile = profile
-    @folder_path = folder_path
+    @path = path
   end
 
-  def local_folder_placeholder
-    if parent
-      path = File.join(parent.full_path, folder_path_elements[-1])
-      Thunderbird::LocalFolderPlaceholder.new(path)
-    end
-  end
+  def set_up
+    return if path_elements.empty?
 
-  def directory_is_directory?
-    File.directory?(full_path)
-  end
+    return true if !in_subdirectory?
 
-  def full_path
-    File.join(profile.local_folders_path, relative_path)
+    subdirectory.set_up
   end
 
-  def parent
-    if folder_path_elements.count > 0
-      self.class.new(profile, File.join(folder_path_elements[0..-2]))
+  def full_path
+    if in_subdirectory?
+      File.join(subdirectory.full_path, folder_name)
+    else
+      folder_name
     end
   end
 
-  def folder_path_elements
-    folder_path.split(File::SEPARATOR)
+  def exists?
+    File.exist?(full_path)
   end
 
-  def directory_exists?
-    File.exists?(full_path)
+  def msf_path
+    "#{path}.msf"
   end
 
-  def is_directory?
-    File.directory?(full_path)
+  def msf_exists?
+    File.exist?(msf_path)
   end
 
-  def subdirectories
-    folder_path_elements.map { |p| "#{p}.sbd" }
-  end
+  private
 
-  def relative_path
-    File.join(subdirectories)
+  def in_subdirectory?
+    path_elements.count > 1
   end
 
-  def set_up
-    ok = check
-    return if !ok
+  def subdirectory
+    return nil if !in_subdirectory?
 
-    ensure_initialized
+    Thunderbird::Subdirectory.new(profile, subdirectory_path)
   end
 
-  private
-
-  def ensure_initialized
-    return true if !parent
-
-    parent.ensure_initialized
-
-    local_folder_placeholder.ensure_initialized
+  def path_elements
+    path.split(File::SEPARATOR)
+  end
 
-    FileUtils.mkdir_p full_path
+  def subdirectory_path
+    File.join(path_elements[0..-2])
   end
 
-  def check
-    return true if !parent
-
-    parent_ok = parent.check
-
-    return if !parent_ok
-
-    case
-    when local_folder_placeholder.exists? && !directory_exists?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{local_folder_placeholder.path}' exists, but '#{full_path}' is missing"
-      false
-    when directory_exists? && !local_folder_placeholder.exists?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{full_path}' exists, but '#{local_folder_placeholder.path}' is missing"
-      false
-    when local_folder_placeholder.exists? && !local_folder_placeholder.is_regular?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{local_folder_placeholder.path}' exists, but it is not a regular file"
-      false
-    when directory_exists? && !is_directory?
-      Kernel.puts "Can't set up folder '#{folder_path}': '#{full_path}' exists, but it is not a directory"
-      false
-    else
-      true
-    end
+  def folder_name
+    path_elements[-1]
   end
 end

data/lib/thunderbird/profiles.rb

@@ -1,10 +1,11 @@
 require "thunderbird"
+require "thunderbird/install"
 require "thunderbird/profile"
 
 # http://kb.mozillazine.org/Profiles.ini_file
 class Thunderbird::Profiles
-  def default
-    title, entries = blocks.find { |_name, entries| entries[:Default] == "1" }
+  def profile_for_path(path)
+    title, entries = blocks.find { |_name, entries| entries[:Path] == path }
 
     Thunderbird::Profile.new(title, entries) if title
   end
@@ -12,11 +13,16 @@ class Thunderbird::Profiles
   def profile(name)
     title, entries = blocks.find { |_name, entries| entries[:Name] == name }
 
-    return nil if !title
-
     Thunderbird::Profile.new(title, entries) if title
   end
 
+  def installs
+    @installs ||= begin
+      pairs = blocks.filter { |name, _entries| name.start_with?("Install") }
+      pairs.map { |title, entries| Thunderbird::Install.new(title, entries) }
+    end
+  end
+
   private
 
   # Parse profiles.ini.
@@ -31,7 +37,11 @@ class Thunderbird::Profiles
 
         loop do
           line = f.gets
-          break if !line
+          if !line
+            blocks[title] = entries if title
+            break
+          end
+
           line.chomp!
 
           # Is this line the start of a new block
@@ -43,12 +53,10 @@ class Thunderbird::Profiles
             # Start a new block
             title = match[1]
             entries = {}
-          else
+          elsif line != ""
             # Collect entries until we get to the next title
-            if line != ""
-              key, value = line.split("=")
-              entries[key.to_sym] = value
-            end
+            key, value = line.split("=")
+            entries[key.to_sym] = value
           end
         end
       end

data/lib/thunderbird/subdirectory.rb

@@ -0,0 +1,96 @@
+require "thunderbird/subdirectory_placeholder"
+
+class Thunderbird::Subdirectory
+  # `path` is the UI path, it doesn't have the '.sbd' extensions
+  # that are present in the real, file system path
+  attr_reader :path
+  attr_reader :profile
+
+  def initialize(profile, path)
+    @profile = profile
+    @path = path
+  end
+
+  def set_up
+    raise "Cannot create a subdirectory without a path" if !sub_directory?
+
+    if sub_sub_directory?
+      parent_ok = parent.set_up
+      return false if !parent_ok
+    end
+
+    ok = check
+    return false if !ok
+
+    FileUtils.mkdir_p full_path
+    placeholder.touch
+
+    true
+  end
+
+  # subdirectory relative path is 'Foo.sbd/Bar.sbd/Baz.sbd'
+  def full_path
+    relative_path = File.join(subdirectories)
+    File.join(profile.local_folders_path, relative_path)
+  end
+
+  private
+
+  def sub_directory?
+    path_elements.any?
+  end
+
+  def sub_sub_directory?
+    path_elements.count > 1
+  end
+
+  def parent
+    return nil if !sub_sub_directory?
+
+    self.class.new(profile, File.join(path_elements[0..-2]))
+  end
+
+  # placeholder relative path is 'Foo.sbd/Bar.sbd/Baz'
+  def placeholder
+    @placeholder = begin
+      relative_path = File.join(subdirectories[0..-2], path_elements[-1])
+      path = File.join(profile.local_folders_path, relative_path)
+      Thunderbird::SubdirectoryPlaceholder.new(path)
+    end
+  end
+
+  def path_elements
+    path.split(File::SEPARATOR)
+  end
+
+  def exists?
+    File.exist?(full_path)
+  end
+
+  def directory?
+    File.directory?(full_path)
+  end
+
+  def subdirectories
+    path_elements.map { |p| "#{p}.sbd" }
+  end
+
+  def check
+    case
+    when placeholder.exists? && !exists?
+      Kernel.puts "Can't set up folder '#{folder_path}': '#{placeholder.path}' exists, but '#{full_path}' is missing"
+      false
+    when exists? && !placeholder.exists?
+      Kernel.puts "Can't set up folder '#{folder_path}': '#{full_path}' exists, but '#{placeholder.path}' is missing"
+      false
+    when placeholder.exists? && !placeholder.regular?
+      Kernel.puts "Can't set up folder '#{folder_path}': '#{placeholder.path}' exists, but it is not a regular file"
+      false
+    when exists? && !directory?
+      Kernel.puts "Can't set up folder '#{folder_path}': '#{full_path}' exists, but it is not a directory"
+      false
+    else
+      true
+    end
+  end
+end

data/lib/thunderbird/{local_folder_placeholder.rb → subdirectory_placeholder.rb}

@@ -1,6 +1,6 @@
 # Each subdirectory is "accompanied" by a blank
 # file of the same name (without the '.sbd' extension)
-class Thunderbird::LocalFolderPlaceholder
+class Thunderbird::SubdirectoryPlaceholder
   attr_reader :path
 
   def initialize(path)
@@ -8,14 +8,14 @@ class Thunderbird::LocalFolderPlaceholder
   end
 
   def exists?
-    File.exists?(path)
+    File.exist?(path)
   end
 
-  def is_regular?
+  def regular?
     File.file?(path)
   end
 
-  def ensure_initialized
+  def touch
     FileUtils.touch path
   end
 end

data/lib/thunderbird.rb

@@ -1,6 +1,14 @@
+require "os"
+
 class Thunderbird
   def data_path
-    # TODO: Handle other OSes
-    File.join(Dir.home, ".thunderbird")
+    case
+    when OS.linux?
+      File.join(Dir.home, ".thunderbird")
+    when OS.mac?
+      File.join(Dir.home, "Library", "Thunderbird")
+    when OS.windows?
+      File.join(ENV["APPDATA"].gsub("\\", "/"), "Thunderbird")
+    end
   end
 end

data/spec/features/restore_spec.rb

@@ -152,7 +152,7 @@ RSpec.describe "restore", type: :feature, docker: true do
     it "maintains encodings" do
       message =
         server_messages(folder).
-        first["RFC822"]
+        first["BODY[]"]
 
       expect(message).to eq(server_message)
     end

data/spec/features/support/email_server.rb

@@ -1,5 +1,5 @@
 module EmailServerHelpers
-  REQUESTED_ATTRIBUTES = %w(RFC822 FLAGS INTERNALDATE).freeze
+  REQUESTED_ATTRIBUTES = ["BODY[]"].freeze
   DEFAULT_EMAIL = "address@example.org".freeze
 
   def send_email(folder, options)
@@ -28,7 +28,7 @@ module EmailServerHelpers
   end
 
   def server_message_to_body(message)
-    message["RFC822"]
+    message["BODY[]"]
   end
 
   def server_fetch_email(folder, uid)

data/spec/unit/email/provider/apple_mail_spec.rb

@@ -0,0 +1,7 @@
+describe Email::Provider::AppleMail do
+  describe "#host" do
+    it "returns host" do
+      expect(subject.host).to eq("imap.mail.me.com")
+    end
+  end
+end

data/spec/unit/email/provider/default_spec.rb

@@ -0,0 +1,17 @@
+describe Email::Provider::Default do
+  describe "#host" do
+    it "is unset" do
+      expect(subject.host).to be_nil
+    end
+  end
+
+  describe "#options" do
+    it "returns options" do
+      expect(subject.options).to be_a(Hash)
+    end
+
+    it "forces TLSv1_2" do
+      expect(subject.options[:ssl][:ssl_version]).to eq(:TLSv1_2)
+    end
+  end
+end

data/spec/unit/email/provider/fastmail_spec.rb

@@ -0,0 +1,7 @@
+describe Email::Provider::Fastmail do
+  describe "#host" do
+    it "returns host" do
+      expect(subject.host).to eq("imap.fastmail.com")
+    end
+  end
+end

data/spec/unit/email/provider/gmail_spec.rb

@@ -0,0 +1,7 @@
+describe Email::Provider::GMail do
+  describe "#host" do
+    it "returns host" do
+      expect(subject.host).to eq("imap.gmail.com")
+    end
+  end
+end

data/spec/unit/email/provider_spec.rb

@@ -1,40 +1,27 @@
 describe Email::Provider do
-  subject { described_class.new(:gmail) }
-
   describe ".for_address" do
     context "with known providers" do
       [
-        ["gmail.com", :gmail],
-        ["fastmail.fm", :fastmail]
-      ].each do |domain, provider|
-        it "recognizes #{provider}" do
+        ["fastmail.com", "Fastmail .com", Email::Provider::Fastmail],
+        ["fastmail.fm", "Fastmail .fm", Email::Provider::Fastmail],
+        ["gmail.com", "GMail", Email::Provider::GMail],
+        ["icloud.com", "Apple Mail icloud.com", Email::Provider::AppleMail],
+        ["mac.com", "Apple Mail mac.com", Email::Provider::AppleMail],
+        ["me.com", "Apple Mail me.com", Email::Provider::AppleMail]
+      ].each do |domain, name, klass|
+        it "recognizes #{name} addresses" do
           address = "foo@#{domain}"
-          expect(described_class.for_address(address).provider).to eq(provider)
+          expect(described_class.for_address(address)).to be_a(klass)
         end
       end
     end
 
     context "with unknown providers" do
       it "returns a default provider" do
-        result = described_class.for_address("foo@unknown.com").provider
-        expect(result).to eq(:default)
-      end
-    end
-  end
-
-  describe "#options" do
-    it "returns options" do
-      expect(subject.options).to be_a(Hash)
-    end
+        result = described_class.for_address("foo@unknown.com")
 
-    it "forces TLSv1_2" do
-      expect(subject.options[:ssl][:ssl_version]).to eq(:TLSv1_2)
-    end
-  end
-
-  describe "#host" do
-    it "returns host" do
-      expect(subject.host).to eq("imap.gmail.com")
+        expect(result).to be_a(Email::Provider::Default)
+      end
     end
   end
 end

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -14,8 +14,10 @@ describe Imap::Backup::Account::Connection do
 
   subject { described_class.new(options) }
 
-  let(:imap) do
-    instance_double(Net::IMAP, authenticate: nil, login: nil, disconnect: nil)
+  let(:client) do
+    instance_double(
+      Imap::Backup::Client::Default, authenticate: nil, login: nil, disconnect: nil
+    )
   end
   let(:imap_folders) { [] }
   let(:options) do
@@ -45,15 +47,14 @@ describe Imap::Backup::Account::Connection do
   let(:new_uid_validity) { nil }
 
   before do
-    allow(Net::IMAP).to receive(:new) { imap }
-    allow(imap).to receive(:list).with("", "") { [root_info] }
-    allow(imap).to receive(:list).with(ROOT_NAME, "*") { imap_folders }
+    allow(Imap::Backup::Client::Default).to receive(:new) { client }
+    allow(client).to receive(:list) { imap_folders }
     allow(Imap::Backup::Utils).to receive(:make_folder)
   end
 
   shared_examples "connects to IMAP" do
     it "logs in to the imap server" do
-      expect(imap).to have_received(:login)
+      expect(client).to have_received(:login)
     end
   end
 
@@ -76,48 +77,34 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  describe "#imap" do
-    let(:result) { subject.imap }
+  describe "#client" do
+    let(:result) { subject.client }
 
     it "returns the IMAP connection" do
-      expect(result).to eq(imap)
+      expect(result).to eq(client)
     end
 
     it "uses the password" do
       result
 
-      expect(imap).to have_received(:login).with(USERNAME, PASSWORD)
-    end
-
-    context "with the GMail IMAP server" do
-      let(:server) { GMAIL_IMAP_SERVER }
-      let(:refresh_token) { true }
-      let(:result) { nil }
-
-      context "when the password is not our copy of a GMail refresh token" do
-        it "uses the password" do
-          subject.imap
-
-          expect(imap).to have_received(:login).with(USERNAME, PASSWORD)
-        end
-      end
+      expect(client).to have_received(:login).with(USERNAME, PASSWORD)
     end
 
     context "when the first login attempt fails" do
       before do
         outcomes = [-> { raise EOFError }, -> { true }]
-        allow(imap).to receive(:login) { outcomes.shift.call }
+        allow(client).to receive(:login) { outcomes.shift.call }
       end
 
       it "retries" do
-        subject.imap
+        subject.client
 
-        expect(imap).to have_received(:login).twice
+        expect(client).to have_received(:login).twice
       end
     end
 
     context "when run" do
-      before { subject.imap }
+      before { subject.client }
 
       include_examples "connects to IMAP"
     end
@@ -125,22 +112,12 @@ describe Imap::Backup::Account::Connection do
 
   describe "#folders" do
     let(:imap_folders) do
-      [instance_double(Net::IMAP::MailboxList, name: BACKUP_FOLDER)]
+      [BACKUP_FOLDER]
     end
 
     it "returns the list of folders" do
       expect(subject.folders).to eq([BACKUP_FOLDER])
     end
-
-    context "with non-ASCII folder names" do
-      let(:imap_folders) do
-        [instance_double(Net::IMAP::MailboxList, name: "Gel&APY-scht")]
-      end
-
-      it "converts them to UTF-8" do
-        expect(subject.folders).to eq(["Gelöscht"])
-      end
-    end
   end
 
   describe "#status" do
@@ -208,9 +185,7 @@ describe Imap::Backup::Account::Connection do
     end
 
     context "without supplied config_folders" do
-      let(:imap_folders) do
-        [instance_double(Net::IMAP::MailboxList, name: ROOT_NAME)]
-      end
+      let(:imap_folders) { [ROOT_NAME] }
 
       before do
         allow(Imap::Backup::Account::Folder).to receive(:new).
@@ -241,7 +216,7 @@ describe Imap::Backup::Account::Connection do
 
       context "when the imap server doesn't return folders" do
         let(:config_folders) { nil }
-        let(:imap_folders) { nil }
+        let(:imap_folders) { [] }
 
         it "fails" do
           expect do
@@ -389,10 +364,10 @@ describe Imap::Backup::Account::Connection do
 
   describe "#reconnect" do
     context "when the IMAP connection has been used" do
-      before { subject.imap }
+      before { subject.client }
 
       it "disconnects from the server" do
-        expect(imap).to receive(:disconnect)
+        expect(client).to receive(:disconnect)
 
         subject.reconnect
       end
@@ -400,26 +375,26 @@ describe Imap::Backup::Account::Connection do
 
     context "when the IMAP connection has not been used" do
       it "does not disconnect from the server" do
-        expect(imap).to_not receive(:disconnect)
+        expect(client).to_not receive(:disconnect)
 
         subject.reconnect
       end
     end
 
     it "causes reconnection on future access" do
-      expect(Net::IMAP).to receive(:new)
+      expect(Imap::Backup::Client::Default).to receive(:new)
 
       subject.reconnect
-      subject.imap
+      subject.client
     end
   end
 
   describe "#disconnect" do
     context "when the IMAP connection has been used" do
       it "disconnects from the server" do
-        subject.imap
+        subject.client
 
-        expect(imap).to receive(:disconnect)
+        expect(client).to receive(:disconnect)
 
         subject.disconnect
       end
@@ -427,7 +402,7 @@ describe Imap::Backup::Account::Connection do
 
     context "when the IMAP connection has not been used" do
       it "does not disconnect from the server" do
-        expect(imap).to_not receive(:disconnect)
+        expect(client).to_not receive(:disconnect)
 
         subject.disconnect
       end