require 'net/imap'
require 'stringio'
require 'time'
+require 'rmail'
## fucking imap fucking sucks. what the FUCK kind of committee of
## dunces designed this shit.
## slow for large mailboxes, and we'll just have to hope that there
## are no collisions. ho ho! a perfectly reasonable solution!
-## fuck you, imap committee. you managed to design something as shitty
-## as mbox but goddamn THIRTY YEARS LATER.
-
+## fuck you, imap committee. you managed to design something nearly as
+## shitty as mbox but goddamn THIRTY YEARS LATER.
module Redwood
class IMAP < Source
SCAN_INTERVAL = 60 # seconds
- attr_reader_cloned :labels
+ ## upon these errors we'll try to rereconnect a few times
+ RECOVERABLE_ERRORS = [ Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError ]
+
attr_accessor :username, :password
def initialize uri, username, password, last_idate=nil, usual=true, archived=false, id=nil
@ids = []
@last_scan = nil
@labels = [:unread]
- @labels << :inbox unless archived?
@labels << mailbox.intern unless mailbox =~ /inbox/i
@mutex = Mutex.new
end
end
def ssl?; @parsed_uri.scheme == 'imaps' end
+ def check
+ ids =
+ @mutex.synchronize do
+ unsynchronized_scan_mailbox
+ @ids
+ end
+
+ start = ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}."
+ end
+
+ ## is this necessary? TODO: remove maybe
+ def == o; o.is_a?(IMAP) && o.uri == self.uri && o.username == self.username; end
+
def load_header id
MBox::read_header StringIO.new(raw_header(id))
end
end
def raw_header id
- @mutex.synchronize do
- connect
- header, flags = get_imap_fields id, 'RFC822.HEADER', 'FLAGS'
- header = "Status: RO\n" + header if flags.include? :Seen # fake an mbox-style read header
- header.gsub(/\r\n/, "\n")
- end
+ unsynchronized_scan_mailbox
+ header, flags = get_imap_fields id, 'RFC822.HEADER', 'FLAGS'
+ header = header + "Status: RO\n" if flags.include? :Seen # fake an mbox-style read header # TODO: improve source-marked-as-read reporting system
+ header.gsub(/\r\n/, "\n")
end
+ synchronized :raw_header
def raw_full_message id
- @mutex.synchronize do
- connect
- get_imap_fields(id, 'RFC822').first.gsub(/\r\n/, "\n")
- end
+ unsynchronized_scan_mailbox
+ get_imap_fields(id, 'RFC822').first.gsub(/\r\n/, "\n")
end
+ synchronized :raw_full_message
def connect
- return if broken? || @imap
+ return if @imap
+ safely { } # do nothing!
+ end
+ synchronized :connect
+
+ def scan_mailbox
+ return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
+ last_id = safely do
+ @imap.examine mailbox
+ @imap.responses["EXISTS"].last
+ end
+ @last_scan = Time.now
+
+ return if last_id == @ids.length
+
+ range = (@ids.length + 1) .. last_id
+ Redwood::log "fetching IMAP headers #{range}"
+ values = safely { @imap.fetch range, ['RFC822.SIZE', 'INTERNALDATE'] }
+ relevant_values = values.find_all { |v| range.include? v.seqno }
+
+ if relevant_values.size != values.size
+ Redwood::log "You IMAP server is buggy: it returned #{values.size} headers for a request for #{range.size}. What are you using, Binc?"
+ end
+
+ relevant_values.each do |v|
+ id = make_id v
+ @ids << id
+ @imap_ids[id] = v.seqno
+ end
+ end
+ synchronized :scan_mailbox
+
+ def each
+ ids =
+ @mutex.synchronize do
+ unsynchronized_scan_mailbox
+ @ids
+ end
+
+ start = ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}."
+
+ start.upto(ids.length - 1) do |i|
+ id = ids[i]
+ self.cur_offset = id
+ yield id, @labels.clone
+ end
+ end
+
+ def start_offset
+ unsynchronized_scan_mailbox
+ @ids.first
+ end
+ synchronized :start_offset
+
+ def end_offset
+ unsynchronized_scan_mailbox
+ @ids.last
+ end
+ synchronized :end_offset
+ def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
+
+private
+
+ def unsafe_connect
say "Connecting to IMAP server #{host}:#{port}..."
## apparently imap.rb does a lot of threaded stuff internally and
## calling thread. but i can't seem to catch that exception, so
## i've resorted to initializing it in its own thread. surely
## there's a better way.
-
exception = nil
- Redwood::reporting_thread do
+ ::Thread.new do
begin
#raise Net::IMAP::ByeResponseError, "simulated imap failure"
@imap = Net::IMAP.new host, port, ssl?
@imap.login @username, @password
end
end
- scan_mailbox
- say "Successfully connected to #{@parsed_uri}." unless broken?
- rescue SocketError, Net::IMAP::Error, SourceError => e
+ say "Successfully connected to #{@parsed_uri}."
+ rescue Exception => e
exception = e
ensure
shutup
end
end.join
- die_from exception, :while => "connecting" if exception
- end
-
- def each
- @mutex.synchronize { connect }
-
- start = @ids.index(cur_offset || start_offset) or die_from "Unknown message id #{cur_offset || start_offset}.", :suggest_rebuild => true # couldn't find the most recent email
-
- start.upto(@ids.length - 1) do |i|
- id = @ids[i]
- self.cur_offset = id
- yield id, labels
- end
- end
-
- def start_offset
- @mutex.synchronize { connect }
- @ids.first
- end
-
- def end_offset
- @mutex.synchronize do
- connect
- scan_mailbox
- end
- @ids.last
+ raise exception if exception
end
- def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
-
-private
-
def say s
@say_id = BufferManager.say s, @say_id if BufferManager.instantiated?
Redwood::log s
@say_id = nil
end
- def scan_mailbox
- return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
-
- last_id = safely do
- @imap.examine mailbox
- @imap.responses["EXISTS"].last
- end
-
- @last_scan = Time.now
- return if last_id == @ids.length
- Redwood::log "fetching IMAP headers #{(@ids.length + 1) .. last_id}"
- values = safely { @imap.fetch((@ids.length + 1) .. last_id, ['RFC822.SIZE', 'INTERNALDATE']) }
- values.each do |v|
- id = make_id v
- @ids << id
- @imap_ids[id] = v.seqno
- end
- end
-
- def die_from e, opts={}
- @imap = nil
-
- message =
- case e
- when Exception
- "Error while #{opts[:while]}: #{e.message.chomp} (#{e.class.name})."
- when String
- e
- end
-
- message += " It is likely that messages have been deleted from this IMAP mailbox. Please run sup-import --rebuild #{to_s} to correct this problem." if opts[:suggest_rebuild]
-
- self.broken_msg = message
- Redwood::log message
- BufferManager.flash "Error communicating with IMAP server. See log for details." if BufferManager.instantiated?
- raise SourceError, message
- end
-
- ## build a fake unique id
def make_id imap_stuff
# use 7 digits for the size. why 7? seems nice.
+ %w(RFC822.SIZE INTERNALDATE).each do |w|
+ raise FatalSourceError, "requested data not in IMAP response: #{w}" unless imap_stuff.attr[w]
+ end
+
msize, mdate = imap_stuff.attr['RFC822.SIZE'] % 10000000, Time.parse(imap_stuff.attr["INTERNALDATE"])
sprintf("%d%07d", mdate.to_i, msize).to_i
end
def get_imap_fields id, *fields
- raise SourceError, broken_msg if broken?
- imap_id = @imap_ids[id] or die_from "Unknown message id #{id}.", :suggest_rebuild => true
+ imap_id = @imap_ids[id] or raise OutOfSyncSourceError, "Unknown message id #{id}"
retried = false
results = safely { @imap.fetch imap_id, (fields + ['RFC822.SIZE', 'INTERNALDATE']).uniq }.first
got_id = make_id results
- die_from "IMAP message mismatch: requested #{id}, got #{got_id}.", :suggest_rebuild => true unless got_id == id
+ raise OutOfSyncSourceError, "IMAP message mismatch: requested #{id}, got #{got_id}." unless got_id == id
- fields.map { |f| results.attr[f] }
+ fields.map { |f| results.attr[f] or raise FatalSourceError, "empty response from IMAP server: #{f}" }
end
+ ## execute a block, connected if unconnected, re-connected up to 3
+ ## times if a recoverable error occurs, and properly dying if an
+ ## unrecoverable error occurs.
def safely
+ retries = 0
begin
- yield
- rescue Net, SocketError, Net::IMAP::Error => e
- die_from e, :while => "communicating with IMAP server"
- rescue Errno::EPIPE
- unless retried
- retried = true
- @imap = nil
- connect
- retry
- else
- die_from e, :while => "communicating with IMAP server"
+ begin
+ unsafe_connect unless @imap
+ yield
+ rescue *RECOVERABLE_ERRORS => e
+ if (retries += 1) <= 3
+ @imap = nil
+ Redwood::log "got #{e.class.name}: #{e.message.inspect}"
+ sleep 2
+ retry
+ end
+ raise
end
+ rescue SocketError, Net::IMAP::Error, SystemCallError, IOError, OpenSSL::SSL::SSLError => e
+ raise FatalSourceError, "While communicating with IMAP server (type #{e.class.name}): #{e.message.inspect}"
end
end
projects / sup / blobdiff