9 ## TODO: remove synchronized method protector calls; use a Monitor instead
10 ## (ruby's reentrant mutex)
12 ## fucking imap fucking sucks. what the FUCK kind of committee of dunces
13 ## designed this shit.
15 ## imap talks about 'unique ids' for messages, to be used for
16 ## cross-session identification. great---just what sup needs! except it
17 ## turns out the uids can be invalidated every time the 'uidvalidity'
18 ## value changes on the server, and 'uidvalidity' can change without
19 ## restriction. it can change any time you log in. it can change EVERY
20 ## time you log in. of course the imap spec "strongly recommends" that it
21 ## never change, but there's nothing to stop people from just setting it
22 ## to the current timestamp, and in fact that's EXACTLY what the one imap
23 ## server i have at my disposal does. thus the so-called uids are
24 ## absolutely useless and imap provides no cross-session way of uniquely
25 ## identifying a message. but thanks for the "strong recommendation",
28 ## so right now i'm using the 'internal date' and the size of each
29 ## message to uniquely identify it, and i scan over the entire mailbox
30 ## each time i open it to map those things to message ids. that can be
31 ## slow for large mailboxes, and we'll just have to hope that there are
32 ## no collisions. ho ho! a perfectly reasonable solution!
34 ## and here's another thing. check out RFC2060 2.2.2 paragraph 5:
36 ## A client MUST be prepared to accept any server response at all
37 ## times. This includes server data that was not requested.
39 ## yeah. that totally makes a lot of sense. and once again, the idiocy of
40 ## the spec actually happens in practice. you'll request flags for one
41 ## message, and get it interspersed with a random bunch of flags for some
42 ## other messages, including a different set of flags for the same
43 ## message! totally ok by the imap spec. totally retarded by any other
46 ## fuck you, imap committee. you managed to design something nearly as
47 ## shitty as mbox but goddamn THIRTY YEARS LATER.
51 include SerializeLabelsNicely
52 SCAN_INTERVAL = 60 # seconds
54 ## upon these errors we'll try to rereconnect a few times
55 RECOVERABLE_ERRORS = [ Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError ]
57 attr_accessor :username, :password
58 yaml_properties :uri, :username, :password, :cur_offset, :usual,
59 :archived, :id, :labels
61 def initialize uri, username, password, last_idate=nil, usual=true, archived=false, id=nil, labels=[]
62 raise ArgumentError, "username and password must be specified" unless username && password
63 raise ArgumentError, "not an imap uri" unless uri =~ %r!imaps?://!
65 super uri, last_idate, usual, archived, id
67 @parsed_uri = URI(uri)
74 @labels = Set.new((labels || []) - LabelManager::RESERVED_LABELS)
79 def self.suggest_labels_for path
80 path =~ /([^\/]*inbox[^\/]*)/i ? [$1.downcase.intern] : []
83 def host; @parsed_uri.host; end
84 def port; @parsed_uri.port || (ssl? ? 993 : 143); end
86 x = @parsed_uri.path[1..-1]
87 (x.nil? || x.empty?) ? 'INBOX' : CGI.unescape(x)
89 def ssl?; @parsed_uri.scheme == 'imaps' end
91 def check; end # do nothing because anything we do will be too slow,
92 # and we'll catch the errors later.
94 ## is this necessary? TODO: remove maybe
95 def == o; o.is_a?(IMAP) && o.uri == self.uri && o.username == self.username; end
98 parse_raw_email_header StringIO.new(raw_header(id))
102 RMail::Parser.read raw_message(id)
105 def each_raw_message_line id
106 StringIO.new(raw_message(id)).each { |l| yield l }
110 unsynchronized_scan_mailbox
111 header, flags = get_imap_fields id, 'RFC822.HEADER'
112 header.gsub(/\r\n/, "\n")
114 synchronized :raw_header
116 def store_message date, from_email, &block
117 message = StringIO.new
119 message.string.gsub! /\n/, "\r\n"
121 safely { @imap.append mailbox, message.string, [:Seen], Time.now }
125 unsynchronized_scan_mailbox
126 get_imap_fields(id, 'RFC822').first.gsub(/\r\n/, "\n")
128 synchronized :raw_message
130 def mark_as_deleted ids
131 ids = [ids].flatten # accept single arguments
132 unsynchronized_scan_mailbox
133 imap_ids = ids.map { |i| @imap_state[i] && @imap_state[i][:id] }.compact
134 return if imap_ids.empty?
135 @imap.store imap_ids, "+FLAGS", [:Deleted]
137 synchronized :mark_as_deleted
141 unsynchronized_scan_mailbox true
144 synchronized :expunge
148 safely { } # do nothing!
150 synchronized :connect
152 def scan_mailbox force=false
153 return if !force && @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
155 @imap.examine mailbox
156 @imap.responses["EXISTS"].last
158 @last_scan = Time.now
161 return if last_id == @ids.length
163 range = (@ids.length + 1) .. last_id
164 debug "fetching IMAP headers #{range}"
165 fetch(range, ['RFC822.SIZE', 'INTERNALDATE', 'FLAGS']).each do |v|
168 @imap_state[id] = { :id => v.seqno, :flags => v.attr["FLAGS"] }
170 debug "done fetching IMAP headers"
172 synchronized :scan_mailbox
175 return unless start_offset
178 @mutex.synchronize do
179 unsynchronized_scan_mailbox
183 start = ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}."
185 start.upto(ids.length - 1) do |i|
187 state = @mutex.synchronize { @imap_state[id] } or next
189 labels = { :Flagged => :starred,
191 }.inject(@labels) do |cur, (imap, sup)|
192 cur + (state[:flags].include?(imap) ? [sup] : [])
195 labels += [:unread] unless state[:flags].include?(:Seen)
202 unsynchronized_scan_mailbox
205 synchronized :start_offset
208 unsynchronized_scan_mailbox
211 synchronized :end_offset
213 def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
217 def fetch ids, fields
218 results = safely { @imap.fetch ids, fields }
220 if ids.respond_to? :member?
221 results.find_all { |r| ids.member?(r.seqno) && fields.all? { |f| r.attr.member?(f) } }
223 results.find_all { |r| ids == r.seqno && fields.all? { |f| r.attr.member?(f) } }
226 if good_results.empty?
227 raise FatalSourceError, "no IMAP response for #{ids} containing all fields #{fields.join(', ')} (got #{results.size} results)"
228 elsif good_results.size < results.size
229 warn "Your IMAP server sucks. It sent #{results.size} results for a request for #{good_results.size} messages. What are you using, Binc?"
236 say "Connecting to IMAP server #{host}:#{port}..."
238 ## apparently imap.rb does a lot of threaded stuff internally and if
239 ## an exception occurs, it will catch it and re-raise it on the
240 ## calling thread. but i can't seem to catch that exception, so i've
241 ## resorted to initializing it in its own thread. surely there's a
246 #raise Net::IMAP::ByeResponseError, "simulated imap failure"
247 @imap = Net::IMAP.new host, port, ssl?
250 ## although RFC1730 claims that "If an AUTHENTICATE command fails
251 ## with a NO response, the client may try another", in practice
252 ## it seems like they can also send a BAD response.
254 raise Net::IMAP::NoResponseError unless @imap.capability().member? "AUTH=CRAM-MD5"
255 @imap.authenticate 'CRAM-MD5', @username, @password
256 rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
257 debug "CRAM-MD5 authentication failed: #{e.class}. Trying LOGIN auth..."
259 raise Net::IMAP::NoResponseError unless @imap.capability().member? "AUTH=LOGIN"
260 @imap.authenticate 'LOGIN', @username, @password
261 rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
262 debug "LOGIN authentication failed: #{e.class}. Trying plain-text LOGIN..."
263 @imap.login @username, @password
266 say "Successfully connected to #{@parsed_uri}."
267 rescue Exception => e
274 raise exception if exception
278 @say_id = BufferManager.say s, @say_id if BufferManager.instantiated?
283 BufferManager.clear @say_id if BufferManager.instantiated?
287 def make_id imap_stuff
288 # use 7 digits for the size. why 7? seems nice.
289 %w(RFC822.SIZE INTERNALDATE).each do |w|
290 raise FatalSourceError, "requested data not in IMAP response: #{w}" unless imap_stuff.attr[w]
293 msize, mdate = imap_stuff.attr['RFC822.SIZE'] % 10000000, Time.parse(imap_stuff.attr["INTERNALDATE"])
294 sprintf("%d%07d", mdate.to_i, msize).to_i
297 def get_imap_fields id, *fields
298 raise OutOfSyncSourceError, "Unknown message id #{id}" unless @imap_state[id]
300 imap_id = @imap_state[id][:id]
301 result = fetch(imap_id, (fields + ['RFC822.SIZE', 'INTERNALDATE']).uniq).first
302 got_id = make_id result
304 ## I've turned off the following sanity check because Microsoft
305 ## Exchange fails it. Exchange actually reports two different
306 ## INTERNALDATEs for the exact same message when queried at different
309 ## RFC2060 defines the semantics of INTERNALDATE for messages that
310 ## arrive via SMTP for via various IMAP commands, but states that
311 ## "All other cases are implementation defined.". Great, thanks guys,
312 ## yet another useless field.
314 ## Of course no OTHER imap server I've encountered returns DIFFERENT
315 ## values for the SAME message. But it's Microsoft; what do you
316 ## expect? If their programmers were any good they'd be working at
319 # raise OutOfSyncSourceError, "IMAP message mismatch: requested #{id}, got #{got_id}." unless got_id == id
321 fields.map { |f| result.attr[f] or raise FatalSourceError, "empty response from IMAP server: #{f}" }
324 ## execute a block, connected if unconnected, re-connected up to 3
325 ## times if a recoverable error occurs, and properly dying if an
326 ## unrecoverable error occurs.
331 unsafe_connect unless @imap
333 rescue *RECOVERABLE_ERRORS => e
334 if (retries += 1) <= 3
336 warn "got #{e.class.name}: #{e.message.inspect}"
342 rescue SocketError, Net::IMAP::Error, SystemCallError, IOError, OpenSSL::SSL::SSLError => e
343 raise FatalSourceError, "While communicating with IMAP server (type #{e.class.name}): #{e.message.inspect}"