larch 1.0.2 → 1.1.0dev20091006

data/lib/larch.rb

@@ -4,10 +4,16 @@ $:.uniq!
 
 require 'cgi'
 require 'digest/md5'
+require 'fileutils'
 require 'net/imap'
 require 'time'
 require 'uri'
+require 'yaml'
 
+require 'sequel'
+require 'sequel/extensions/migration'
+
+require 'larch/config'
 require 'larch/errors'
 require 'larch/imap'
 require 'larch/imap/mailbox'
@@ -17,16 +23,21 @@ require 'larch/version'
 module Larch
 
   class << self
-    attr_reader :log, :exclude
+    attr_reader :config, :db, :log, :exclude
 
     EXCLUDE_COMMENT = /#.*$/
     EXCLUDE_REGEX   = /^\s*\/(.*)\/\s*/
     GLOB_PATTERNS   = {'*' => '.*', '?' => '.'}
+    LIB_DIR         = File.join(File.dirname(File.expand_path(__FILE__)), 'larch')
+
+    def init(config)
+      raise ArgumentError, "config must be a Larch::Config instance" unless config.is_a?(Config)
 
-    def init(log_level = :info, exclude = [], exclude_file = nil)
-      @log = Logger.new(log_level)
+      @config = config
+      @log    = Logger.new(@config[:verbosity])
+      @db     = open_db(@config[:database])
 
-      @exclude = exclude.map do |e|
+      @exclude = @config[:exclude].map do |e|
         if e =~ EXCLUDE_REGEX
           Regexp.new($1, Regexp::IGNORECASE)
         else
@@ -34,7 +45,9 @@ module Larch
         end
       end
 
-      load_exclude_file(exclude_file) if exclude_file
+      load_exclude_file(@config[:exclude_file]) if @config[:exclude_file]
+
+      Net::IMAP.debug = true if @log.level == :insane
 
       # Stats
       @copied = 0
@@ -59,7 +72,7 @@ module Larch
         mailbox_to = imap_to.mailbox(mailbox_from.name, mailbox_from.delim)
         mailbox_to.subscribe if mailbox_from.subscribed?
 
-        copy_messages(imap_from, mailbox_from, imap_to, mailbox_to)
+        copy_messages(mailbox_from, mailbox_to)
       end
 
     rescue => e
@@ -69,8 +82,8 @@ module Larch
       summary
     end
 
-    # Copies the messages in a single IMAP folder (non-recursively) from the
-    # source to the destination.
+    # Copies the messages in a single IMAP folder and all its subfolders
+    # (recursively) from the source to the destination.
     def copy_folder(imap_from, imap_to)
       raise ArgumentError, "imap_from must be a Larch::IMAP instance" unless imap_from.is_a?(IMAP)
       raise ArgumentError, "imap_to must be a Larch::IMAP instance" unless imap_to.is_a?(IMAP)
@@ -79,13 +92,10 @@ module Larch
       @failed = 0
       @total  = 0
 
-      from_name = imap_from.uri_mailbox || 'INBOX'
-      to_name   = imap_to.uri_mailbox || 'INBOX'
-
-      return if excluded?(from_name) || excluded?(to_name)
+      mailbox_from = imap_from.mailbox(imap_from.uri_mailbox || 'INBOX')
+      mailbox_to   = imap_to.mailbox(imap_to.uri_mailbox || 'INBOX')
 
-      copy_messages(imap_from, imap_from.mailbox(from_name), imap_to,
-          imap_to.mailbox(to_name))
+      copy_mailbox(mailbox_from, mailbox_to)
 
       imap_from.disconnect
       imap_to.disconnect
@@ -97,32 +107,85 @@ module Larch
       summary
     end
 
+    # Opens a connection to the Larch message database, creating it if
+    # necessary.
+    def open_db(database)
+      filename  = File.expand_path(database)
+      directory = File.dirname(filename)
+
+      unless File.exist?(directory)
+        FileUtils.mkdir_p(directory)
+        File.chmod(0700, directory)
+      end
+
+      begin
+        db = Sequel.connect("sqlite://#{filename}")
+        db.test_connection
+      rescue => e
+        @log.fatal "unable to open message database: #{e}"
+        abort
+      end
+
+      # Ensure that the database schema is up to date.
+      migration_dir = File.join(LIB_DIR, 'db', 'migrate')
+
+      unless Sequel::Migrator.get_current_migration_version(db) ==
+          Sequel::Migrator.latest_migration_version(migration_dir)
+        begin
+          Sequel::Migrator.apply(db, migration_dir)
+        rescue => e
+          @log.fatal "unable to migrate message database: #{e}"
+          abort
+        end
+      end
+
+      require 'larch/db/message'
+      require 'larch/db/mailbox'
+      require 'larch/db/account'
+
+      db
+    end
+
     def summary
       @log.info "#{@copied} message(s) copied, #{@failed} failed, #{@total - @copied - @failed} untouched out of #{@total} total"
     end
 
     private
 
-    def copy_messages(imap_from, mailbox_from, imap_to, mailbox_to)
-      raise ArgumentError, "imap_from must be a Larch::IMAP instance" unless imap_from.is_a?(IMAP)
-      raise ArgumentError, "mailbox_from must be a Larch::IMAP::Mailbox instance" unless mailbox_from.is_a?(IMAP::Mailbox)
-      raise ArgumentError, "imap_to must be a Larch::IMAP instance" unless imap_to.is_a?(IMAP)
-      raise ArgumentError, "mailbox_to must be a Larch::IMAP::Mailbox instance" unless mailbox_to.is_a?(IMAP::Mailbox)
+    def copy_mailbox(mailbox_from, mailbox_to)
+      raise ArgumentError, "mailbox_from must be a Larch::IMAP::Mailbox instance" unless mailbox_from.is_a?(Larch::IMAP::Mailbox)
+      raise ArgumentError, "mailbox_to must be a Larch::IMAP::Mailbox instance" unless mailbox_to.is_a?(Larch::IMAP::Mailbox)
 
       return if excluded?(mailbox_from.name) || excluded?(mailbox_to.name)
 
-      @log.info "copying messages from #{imap_from.host}/#{mailbox_from.name} to #{imap_to.host}/#{mailbox_to.name}"
+      mailbox_to.subscribe if mailbox_from.subscribed?
+      copy_messages(mailbox_from, mailbox_to)
+
+      mailbox_from.each_mailbox do |child_from|
+        next if excluded?(child_from.name)
+        child_to = mailbox_to.imap.mailbox(child_from.name, child_from.delim)
+        copy_mailbox(child_from, child_to)
+      end
+    end
 
-      imap_from.connect
-      imap_to.connect
+    def copy_messages(mailbox_from, mailbox_to)
+      raise ArgumentError, "mailbox_from must be a Larch::IMAP::Mailbox instance" unless mailbox_from.is_a?(Larch::IMAP::Mailbox)
+      raise ArgumentError, "mailbox_to must be a Larch::IMAP::Mailbox instance" unless mailbox_to.is_a?(Larch::IMAP::Mailbox)
+
+      return if excluded?(mailbox_from.name) || excluded?(mailbox_to.name)
+
+      imap_from = mailbox_from.imap
+      imap_to   = mailbox_to.imap
+
+      @log.info "copying messages from #{imap_from.host}/#{mailbox_from.name} to #{imap_to.host}/#{mailbox_to.name}"
 
       @total += mailbox_from.length
 
-      mailbox_from.each do |id|
-        next if mailbox_to.has_message?(id)
+      mailbox_from.each_guid do |guid|
+        next if mailbox_to.has_guid?(guid)
 
         begin
-          msg = mailbox_from.peek(id)
+          next unless msg = mailbox_from.peek(guid)
 
           if msg.envelope.from
             env_from = msg.envelope.from.first
@@ -137,7 +200,6 @@ module Larch
           @copied += 1
 
         rescue Larch::IMAP::Error => e
-          # TODO: Keep failed message envelopes in a buffer for later output?
           @failed += 1
           @log.error e.message
           next

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: larch
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.1.0dev20091006
 platform: ruby
 authors: 
 - Ryan Grove
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-05 00:00:00 -07:00
+date: 2009-10-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.5
+    version: 
 - !ruby/object:Gem::Dependency 
   name: trollop
   type: :runtime
@@ -45,13 +65,18 @@ files:
 - LICENSE
 - README.rdoc
 - bin/larch
-- lib/larch.rb
+- lib/larch/config.rb
+- lib/larch/db/account.rb
+- lib/larch/db/mailbox.rb
+- lib/larch/db/message.rb
+- lib/larch/db/migrate/001_create_schema.rb
 - lib/larch/errors.rb
-- lib/larch/imap.rb
 - lib/larch/imap/mailbox.rb
+- lib/larch/imap.rb
 - lib/larch/logger.rb
 - lib/larch/version.rb
-has_rdoc: false
+- lib/larch.rb
+has_rdoc: true
 homepage: http://github.com/rgrove/larch/
 licenses: []
 
@@ -68,14 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
   version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Larch syncs messages from one IMAP server to another. Awesomely.