rgrove-larch 1.0.0 → 1.0.0.1

data/lib/larch/imap.rb

@@ -6,6 +6,10 @@ module Larch
 # required reading if you're doing anything with IMAP in Ruby:
 # http://sup.rubyforge.org
 class IMAP
+  include MonitorMixin
+
+  # Maximum number of messages to fetch at once.
+  MAX_FETCH_COUNT = 1024
 
   # Recoverable connection errors.
   RECOVERABLE_ERRORS = [
@@ -52,6 +56,8 @@ class IMAP
   #   times. Default is 3.
   #
   def initialize(uri, username, password, options = {})
+    super()
+
     raise ArgumentError, "not an IMAP URI: #{uri}" unless uri.is_a?(URI) || uri =~ REGEX_URI
     raise ArgumentError, "must provide a username and password" unless username && password
     raise ArgumentError, "options must be a Hash" unless options.is_a?(Hash)
@@ -66,7 +72,6 @@ class IMAP
     @last_id     = 0
     @last_scan   = nil
     @message_ids = nil
-    @mutex       = Mutex.new
 
     # Create private convenience methods (debug, info, warn, etc.) to make
     # logging easier.
@@ -89,18 +94,16 @@ class IMAP
     return false if has_message?(message)
 
     safely do
-      @mutex.synchronize do
-        begin
-          @imap.select(mailbox)
-        rescue Net::IMAP::NoResponseError => e
-          if @options[:create_mailbox]
-            info "creating mailbox: #{mailbox}"
-            @imap.create(mailbox)
-            retry
-          end
-
-          raise
+      begin
+        @imap.select(mailbox)
+      rescue Net::IMAP::NoResponseError => e
+        if @options[:create_mailbox]
+          info "creating mailbox: #{mailbox}"
+          @imap.create(mailbox)
+          retry
         end
+
+        raise
       end
 
       debug "appending message: #{message.id}"
@@ -122,20 +125,19 @@ class IMAP
   def disconnect
     return unless @imap
 
-    @imap.disconnect
-    @imap = nil
+    synchronize do
+      @imap.disconnect
+      @imap = nil
+    end
 
     info "disconnected"
   end
-  synchronized :disconnect
 
   # Iterates through Larch message ids in this mailbox, yielding each one to the
   # provided block.
   def each
-    ids = @mutex.synchronize do
-      unsync_scan_mailbox
-      @ids
-    end
+    scan_mailbox
+    ids = @ids
 
     ids.each_key {|id| yield id }
   end
@@ -204,51 +206,52 @@ class IMAP
 
   # Fetches message headers from the current mailbox.
   def scan_mailbox
-    return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
+    synchronize do
+      return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
 
-    last_id = safely do
-      begin
-        @imap.examine(mailbox)
-      rescue Net::IMAP::NoResponseError => e
-        return if @options[:create_mailbox]
-        raise FatalError, "unable to open mailbox: #{e.message}"
+      last_id = safely do
+        begin
+          @imap.examine(mailbox)
+        rescue Net::IMAP::NoResponseError => e
+          return if @options[:create_mailbox]
+          raise FatalError, "unable to open mailbox: #{e.message}"
+        end
+
+        @imap.responses['EXISTS'].last
       end
 
-      @imap.responses['EXISTS'].last
-    end
+      @last_scan = Time.now
+      return if last_id == @last_id
 
-    @last_scan = Time.now
-    return if last_id == @last_id
+      range    = (@last_id + 1)..last_id
+      @last_id = last_id
 
-    range    = (@last_id + 1)..last_id
-    @last_id = last_id
+      info "fetching message headers #{range}" <<
+          (@options[:fast_scan] ? ' (fast scan)' : '')
 
-    info "fetching message headers #{range}" <<
-        (@options[:fast_scan] ? ' (fast scan)' : '')
+      fields = if @options[:fast_scan]
+        ['UID', 'RFC822.SIZE', 'INTERNALDATE']
+      else
+        "(UID BODY.PEEK[HEADER.FIELDS (MESSAGE-ID)] RFC822.SIZE INTERNALDATE)"
+      end
 
-    fields = if @options[:fast_scan]
-      ['UID', 'RFC822.SIZE', 'INTERNALDATE']
-    else
-      "(UID BODY.PEEK[HEADER.FIELDS (MESSAGE-ID)] RFC822.SIZE INTERNALDATE)"
-    end
+      imap_fetch(range, fields).each do |data|
+        id = create_id(data)
 
-    imap_fetch(range, fields).each do |data|
-      id = create_id(data)
+        unless uid = data.attr['UID']
+          error "UID not in IMAP response for message: #{id}"
+          next
+        end
 
-      unless uid = data.attr['UID']
-        error "UID not in IMAP response for message: #{id}"
-        next
-      end
+        if @ids.has_key?(id) && Larch.log.level == :debug
+          envelope = imap_uid_fetch([uid], 'ENVELOPE').first.attr['ENVELOPE']
+          debug "duplicate message? #{id} (Subject: #{envelope.subject})"
+        end
 
-      if @ids.has_key?(id) && Larch.log.level == :debug
-        envelope = imap_uid_fetch([uid], 'ENVELOPE').first.attr['ENVELOPE']
-        debug "duplicate message? #{id} (Subject: #{envelope.subject})"
+        @ids[id] = uid
       end
-
-      @ids[id] = uid
     end
   end
-  synchronized :scan_mailbox
 
   # Gets the SSL status.
   def ssl?
@@ -284,7 +287,19 @@ class IMAP
   # Fetches the specified _fields_ for the specified message sequence id(s) from
   # the IMAP server.
   def imap_fetch(ids, fields)
-    data = safely { @imap.fetch(ids, fields) }
+    ids = ids.to_a
+
+    data = safely do
+      pos     = 0
+      results = []
+
+      while pos < ids.length
+        results += @imap.fetch(ids[pos, MAX_FETCH_COUNT], fields)
+        pos += MAX_FETCH_COUNT
+      end
+
+      results
+    end
 
     # If fields isn't an array, make it one.
     fields = REGEX_FIELDS.match(fields).captures unless fields.is_a?(Array)
@@ -309,7 +324,19 @@ class IMAP
   # Fetches the specified _fields_ for the specified UID(s) from the IMAP
   # server.
   def imap_uid_fetch(uids, fields)
-    data = safely { @imap.uid_fetch(uids, fields) }
+    uids = uids.to_a
+
+    data = safely do
+      pos     = 0
+      results = []
+
+      while pos < uids.length
+        results += @imap.uid_fetch(uids[pos, MAX_FETCH_COUNT], fields)
+        pos += MAX_FETCH_COUNT
+      end
+
+      results
+    end
 
     # If fields isn't an array, make it one.
     fields = REGEX_FIELDS.match(fields).captures unless fields.is_a?(Array)
@@ -337,15 +364,17 @@ class IMAP
   def safely
     retries = 0
 
-    begin
-      unsafe_connect unless @imap
-    rescue *RECOVERABLE_ERRORS => e
-      info "#{e.class.name}: #{e.message} (will retry)"
-      raise unless (retries += 1) <= @options[:max_retries]
-
-      @imap = nil
-      sleep 1 * retries
-      retry
+    synchronize do
+      begin
+        unsafe_connect unless @imap
+      rescue *RECOVERABLE_ERRORS => e
+        info "#{e.class.name}: #{e.message} (will retry)"
+        raise unless (retries += 1) <= @options[:max_retries]
+
+        @imap = nil
+        sleep 1 * retries
+        retry
+      end
     end
 
     retries = 0

data/lib/larch.rb

@@ -5,11 +5,10 @@ $:.uniq!
 require 'cgi'
 require 'digest/md5'
 require 'net/imap'
-require 'thread'
+require 'monitor'
 require 'time'
 require 'uri'
 
-require 'larch/util'
 require 'larch/errors'
 require 'larch/imap'
 require 'larch/logger'
@@ -23,9 +22,9 @@ module Larch
     def init(log_level = :info)
       @log = Logger.new(log_level)
 
-      @copied    = 0
-      @failed    = 0
-      @total     = 0
+      @copied = 0
+      @failed = 0
+      @total  = 0
     end
 
     # Copies messages from _source_ to _dest_ if they don't already exist in
@@ -37,9 +36,9 @@ module Larch
       msgq  = SizedQueue.new(8)
       mutex = Mutex.new
 
-      @copied    = 0
-      @failed    = 0
-      @total     = 0
+      @copied = 0
+      @failed = 0
+      @total  = 0
 
       @log.info "copying messages from #{source.uri} to #{dest.uri}"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rgrove-larch
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.0.1
 platform: ruby
 authors: 
 - Ryan Grove
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-25 00:00:00 -08:00
+date: 2009-03-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,6 @@ files:
 - lib/larch/errors.rb
 - lib/larch/imap.rb
 - lib/larch/logger.rb
-- lib/larch/util.rb
 - lib/larch/version.rb
 has_rdoc: false
 homepage: http://github.com/rgrove/larch/

data/lib/larch/util.rb

@@ -1,17 +0,0 @@
-class Module
-
-  # Java-style whole-method synchronization, shamelessly stolen from Sup:
-  # http://sup.rubyforge.org. Assumes the existence of a <tt>@mutex</tt>
-  # variable.
-  def synchronized(*methods)
-    methods.each do |method|
-      class_eval <<-EOF
-        alias unsync_#{method} #{method}
-        def #{method}(*a, &b)
-          @mutex.synchronize { unsync_#{method}(*a, &b) }
-        end
-      EOF
-    end
-  end
-
-end