8 ## fucking imap fucking sucks. what the FUCK kind of committee of dunces
11 ## imap talks about 'unique ids' for messages, to be used for
12 ## cross-session identification. great---just what sup needs! except it
13 ## turns out the uids can be invalidated every time the 'uidvalidity'
14 ## value changes on the server, and 'uidvalidity' can change without
15 ## restriction. it can change any time you log in. it can change EVERY
16 ## time you log in. of course the imap spec "strongly recommends" that it
17 ## never change, but there's nothing to stop people from just setting it
18 ## to the current timestamp, and in fact that's exactly what the one imap
19 ## server i have at my disposal does. thus the so-called uids are
20 ## absolutely useless and imap provides no cross-session way of uniquely
21 ## identifying a message. but thanks for the "strong recommendation",
24 ## so right now i'm using the 'internal date' and the size of each
25 ## message to uniquely identify it, and i scan over the entire mailbox
26 ## each time i open it to map those things to message ids. that can be
27 ## slow for large mailboxes, and we'll just have to hope that there are
28 ## no collisions. ho ho! a perfectly reasonable solution!
30 ## and here's another thing. check out RFC2060 2.2.2 paragraph 5:
32 ## A client MUST be prepared to accept any server response at all
33 ## times. This includes server data that was not requested.
35 ## yeah. that totally makes a lot of sense. and once again, the idiocy of
36 ## the spec actually happens in practice. you'll request flags for one
37 ## message, and get it interspersed with a random bunch of flags for some
38 ## other messages, including a different set of flags for the same
39 ## message! totally ok by the imap spec. totally retarded by any other
42 ## fuck you, imap committee. you managed to design something nearly as
43 ## shitty as mbox but goddamn THIRTY YEARS LATER.
47 SCAN_INTERVAL = 60 # seconds
49 ## upon these errors we'll try to rereconnect a few times
50 RECOVERABLE_ERRORS = [ Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError ]
52 attr_accessor :username, :password
53 yaml_properties :uri, :username, :password, :cur_offset, :usual,
54 :archived, :id, :labels
56 def initialize uri, username, password, last_idate=nil, usual=true, archived=false, id=nil, labels=[]
57 raise ArgumentError, "username and password must be specified" unless username && password
58 raise ArgumentError, "not an imap uri" unless uri =~ %r!imaps?://!
60 super uri, last_idate, usual, archived, id
62 @parsed_uri = URI(uri)
69 @labels = ((labels || []) - LabelManager::RESERVED_LABELS).uniq.freeze
74 def self.suggest_labels_for path
75 path =~ /([^\/]*inbox[^\/]*)/i ? [$1.downcase.intern] : []
78 def host; @parsed_uri.host; end
79 def port; @parsed_uri.port || (ssl? ? 993 : 143); end
81 x = @parsed_uri.path[1..-1]
82 (x.nil? || x.empty?) ? 'INBOX' : CGI.unescape(x)
84 def ssl?; @parsed_uri.scheme == 'imaps' end
86 def check; end # do nothing because anything we do will be too slow,
87 # and we'll catch the errors later.
89 ## is this necessary? TODO: remove maybe
90 def == o; o.is_a?(IMAP) && o.uri == self.uri && o.username == self.username; end
93 MBox::read_header StringIO.new(raw_header(id))
97 RMail::Parser.read raw_message(id)
100 def each_raw_message_line id
101 StringIO.new(raw_message(id)).each { |l| yield l }
105 unsynchronized_scan_mailbox
106 header, flags = get_imap_fields id, 'RFC822.HEADER'
107 header.gsub(/\r\n/, "\n")
109 synchronized :raw_header
112 unsynchronized_scan_mailbox
113 get_imap_fields(id, 'RFC822').first.gsub(/\r\n/, "\n")
115 synchronized :raw_message
119 safely { } # do nothing!
121 synchronized :connect
124 return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
126 @imap.examine mailbox
127 @imap.responses["EXISTS"].last
129 @last_scan = Time.now
131 return if last_id == @ids.length
133 range = (@ids.length + 1) .. last_id
134 Redwood::log "fetching IMAP headers #{range}"
135 fetch(range, ['RFC822.SIZE', 'INTERNALDATE', 'FLAGS']).each do |v|
138 @imap_state[id] = { :id => v.seqno, :flags => v.attr["FLAGS"] }
140 Redwood::log "done fetching IMAP headers"
142 synchronized :scan_mailbox
145 return unless start_offset
148 @mutex.synchronize do
149 unsynchronized_scan_mailbox
153 start = ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}."
155 start.upto(ids.length - 1) do |i|
157 state = @mutex.synchronize { @imap_state[id] } or next
159 labels = { :Flagged => :starred,
161 }.inject(@labels) do |cur, (imap, sup)|
162 cur + (state[:flags].include?(imap) ? [sup] : [])
165 labels += [:unread] unless state[:flags].include?(:Seen)
172 unsynchronized_scan_mailbox
175 synchronized :start_offset
178 unsynchronized_scan_mailbox
181 synchronized :end_offset
183 def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
187 def fetch ids, fields
188 results = safely { @imap.fetch ids, fields }
190 if ids.respond_to? :member?
191 results.find_all { |r| ids.member?(r.seqno) && fields.all? { |f| r.attr.member?(f) } }
193 results.find_all { |r| ids == r.seqno && fields.all? { |f| r.attr.member?(f) } }
196 if good_results.empty?
197 raise FatalSourceError, "no IMAP response for #{ids} containing all fields #{fields.join(', ')} (got #{results.size} results)"
198 elsif good_results.size < results.size
199 Redwood::log "Your IMAP server sucks. It sent #{results.size} results for a request for #{good_results.size} messages. What are you using, Binc?"
206 say "Connecting to IMAP server #{host}:#{port}..."
208 ## apparently imap.rb does a lot of threaded stuff internally and if
209 ## an exception occurs, it will catch it and re-raise it on the
210 ## calling thread. but i can't seem to catch that exception, so i've
211 ## resorted to initializing it in its own thread. surely there's a
216 #raise Net::IMAP::ByeResponseError, "simulated imap failure"
217 @imap = Net::IMAP.new host, port, ssl?
220 ## although RFC1730 claims that "If an AUTHENTICATE command fails
221 ## with a NO response, the client may try another", in practice
222 ## it seems like they can also send a BAD response.
224 raise Net::IMAP::NoResponseError unless @imap.capability().member? "AUTH=CRAM-MD5"
225 @imap.authenticate 'CRAM-MD5', @username, @password
226 rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
227 Redwood::log "CRAM-MD5 authentication failed: #{e.class}. Trying LOGIN auth..."
229 raise Net::IMAP::NoResponseError unless @imap.capability().member? "AUTH=LOGIN"
230 @imap.authenticate 'LOGIN', @username, @password
231 rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
232 Redwood::log "LOGIN authentication failed: #{e.class}. Trying plain-text LOGIN..."
233 @imap.login @username, @password
236 say "Successfully connected to #{@parsed_uri}."
237 rescue Exception => e
244 raise exception if exception
248 @say_id = BufferManager.say s, @say_id if BufferManager.instantiated?
253 BufferManager.clear @say_id if BufferManager.instantiated?
257 def make_id imap_stuff
258 # use 7 digits for the size. why 7? seems nice.
259 %w(RFC822.SIZE INTERNALDATE).each do |w|
260 raise FatalSourceError, "requested data not in IMAP response: #{w}" unless imap_stuff.attr[w]
263 msize, mdate = imap_stuff.attr['RFC822.SIZE'] % 10000000, Time.parse(imap_stuff.attr["INTERNALDATE"])
264 sprintf("%d%07d", mdate.to_i, msize).to_i
267 def get_imap_fields id, *fields
268 raise OutOfSyncSourceError, "Unknown message id #{id}" unless @imap_state[id]
270 imap_id = @imap_state[id][:id]
271 result = fetch(imap_id, (fields + ['RFC822.SIZE', 'INTERNALDATE']).uniq).first
272 got_id = make_id result
274 ## I've turned off the following sanity check because Microsoft
275 ## Exchange fails it. Exchange actually reports two different
276 ## INTERNALDATEs for the exact same message when queried at different
279 ## RFC2060 defines the semantics of INTERNALDATE for messages that
280 ## arrive via SMTP for via various IMAP commands, but states that
281 ## "All other cases are implementation defined.". Great, thanks guys,
282 ## yet another useless field.
284 ## Of course no OTHER imap server I've encountered returns DIFFERENT
285 ## values for the SAME message. But it's Microsoft; what do you
286 ## expect? If their programmers were any good they'd be working at
289 # raise OutOfSyncSourceError, "IMAP message mismatch: requested #{id}, got #{got_id}." unless got_id == id
291 fields.map { |f| result.attr[f] or raise FatalSourceError, "empty response from IMAP server: #{f}" }
294 ## execute a block, connected if unconnected, re-connected up to 3
295 ## times if a recoverable error occurs, and properly dying if an
296 ## unrecoverable error occurs.
301 unsafe_connect unless @imap
303 rescue *RECOVERABLE_ERRORS => e
304 if (retries += 1) <= 3
306 Redwood::log "got #{e.class.name}: #{e.message.inspect}"
312 rescue SocketError, Net::IMAP::Error, SystemCallError, IOError, OpenSSL::SSL::SSLError => e
313 raise FatalSourceError, "While communicating with IMAP server (type #{e.class.name}): #{e.message.inspect}"