git.cworth.org Git - sup/blob - lib/sup/imap.rb

   1 require 'uri'
   2 require 'net/imap'
   3 require 'stringio'
   4 require 'time'
   5 require 'rmail'
   6
   7 ## fucking imap fucking sucks. what the FUCK kind of committee of
   8 ## dunces designed this shit.
   9 ##
  10 ## imap talks about 'unique ids' for messages, to be used for
  11 ## cross-session identification. great---just what sup needs! except
  12 ## it turns out the uids can be invalidated every time the
  13 ## 'uidvalidity' value changes on the server, and 'uidvalidity' can
  14 ## change without restriction. it can change any time you log in. it
  15 ## can change EVERY time you log in. of course the imap spec "strongly
  16 ## recommends" that it never change, but there's nothing to stop
  17 ## people from just setting it to the current timestamp, and in fact
  18 ## that's exactly what the one imap server i have at my disposal
  19 ## does. thus the so-called uids are absolutely useless and imap
  20 ## provides no cross-session way of uniquely identifying a
  21 ## message. but thanks for the "strong recommendation", guys!
  22 ##
  23 ## so right now i'm using the 'internal date' and the size of each
  24 ## message to uniquely identify it, and i scan over the entire mailbox
  25 ## each time i open it to map those things to message ids. that can be
  26 ## slow for large mailboxes, and we'll just have to hope that there
  27 ## are no collisions. ho ho! a perfectly reasonable solution!
  28 ##
  29 ## and here's another thing. check out RFC2060 2.2.2 paragraph 5:
  30 ##
  31 ##   A client MUST be prepared to accept any server response at all times.
  32 ##   This includes server data that was not requested.
  33 ##
  34 ## yeah. that totally makes a lot of sense. and once again, the idiocy
  35 ## of the spec actually happens in practice. you'll request flags for
  36 ## one message, and get it interspersed with a random bunch of flags
  37 ## for some other messages, including a different set of flags for the
  38 ## same message! totally ok by the imap spec. totally retarded by any
  39 ## other metric.
  40 ##
  41 ## fuck you, imap committee. you managed to design something nearly as
  42 ## shitty as mbox but goddamn THIRTY YEARS LATER.
  43 module Redwood
  44
  45 class IMAP < Source
  46   SCAN_INTERVAL = 60 # seconds
  47
  48   ## upon these errors we'll try to rereconnect a few times
  49   RECOVERABLE_ERRORS = [ Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError ]
  50
  51   attr_accessor :username, :password
  52   yaml_properties :uri, :username, :password, :cur_offset, :usual,
  53                   :archived, :id, :labels
  54
  55   def initialize uri, username, password, last_idate=nil, usual=true, archived=false, id=nil, labels=[]
  56     raise ArgumentError, "username and password must be specified" unless username && password
  57     raise ArgumentError, "not an imap uri" unless uri =~ %r!imaps?://!
  58
  59     super uri, last_idate, usual, archived, id
  60
  61     @parsed_uri = URI(uri)
  62     @username = username
  63     @password = password
  64     @imap = nil
  65     @imap_ids = {}
  66     @ids = []
  67     @last_scan = nil
  68     @labels = (labels || []).freeze
  69     @say_id = nil
  70     @mutex = Mutex.new
  71   end
  72
  73   def self.suggest_labels_for path
  74     if path =~ /inbox/i
  75       [path.intern]
  76     else
  77       []
  78     end
  79   end
  80
  81   def host; @parsed_uri.host; end
  82   def port; @parsed_uri.port || (ssl? ? 993 : 143); end
  83   def mailbox
  84     x = @parsed_uri.path[1..-1]
  85     x.nil? || x.empty? ? 'INBOX' : x
  86   end
  87   def ssl?; @parsed_uri.scheme == 'imaps' end
  88
  89   def check
  90     return unless start_offset
  91
  92     ids =
  93       @mutex.synchronize do
  94         unsynchronized_scan_mailbox
  95         @ids
  96       end
  97
  98     start = ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}."
  99   end
 100
 101   ## is this necessary? TODO: remove maybe
 102   def == o; o.is_a?(IMAP) && o.uri == self.uri && o.username == self.username; end
 103
 104   def load_header id
 105     MBox::read_header StringIO.new(raw_header(id))
 106   end
 107
 108   def load_message id
 109     RMail::Parser.read raw_message(id)
 110   end
 111
 112   def raw_header id
 113     unsynchronized_scan_mailbox
 114     header, flags = get_imap_fields id, 'RFC822.HEADER', 'FLAGS'
 115     ## very bad. this is very very bad. very bad bad bad.
 116     header = header + "Status: RO\n" if flags.include? :Seen # fake an mbox-style read header # TODO: improve source-marked-as-read reporting system
 117     header.gsub(/\r\n/, "\n")
 118   end
 119   synchronized :raw_header
 120
 121   def raw_message id
 122     unsynchronized_scan_mailbox
 123     get_imap_fields(id, 'RFC822').first.gsub(/\r\n/, "\n")
 124   end
 125   synchronized :raw_message
 126
 127   def connect
 128     return if @imap
 129     safely { } # do nothing!
 130   end
 131   synchronized :connect
 132
 133   def scan_mailbox
 134     return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
 135     last_id = safely do
 136       @imap.examine mailbox
 137       @imap.responses["EXISTS"].last
 138     end
 139     @last_scan = Time.now
 140
 141     return if last_id == @ids.length
 142
 143     range = (@ids.length + 1) .. last_id
 144     Redwood::log "fetching IMAP headers #{range}"
 145     fetch(range, ['RFC822.SIZE', 'INTERNALDATE']).each do |v|
 146       id = make_id v
 147       @ids << id
 148       @imap_ids[id] = v.seqno
 149     end
 150   end
 151   synchronized :scan_mailbox
 152
 153   def each
 154     return unless start_offset
 155
 156     ids =
 157       @mutex.synchronize do
 158         unsynchronized_scan_mailbox
 159         @ids
 160       end
 161
 162     start = ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}."
 163
 164     start.upto(ids.length - 1) do |i|
 165       id = ids[i]
 166       self.cur_offset = id
 167       yield id, @labels
 168     end
 169   end
 170
 171   def start_offset
 172     unsynchronized_scan_mailbox
 173     @ids.first
 174   end
 175   synchronized :start_offset
 176
 177   def end_offset
 178     unsynchronized_scan_mailbox
 179     @ids.last
 180   end
 181   synchronized :end_offset
 182
 183   def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
 184
 185 private
 186
 187   def fetch ids, fields
 188     results = safely { @imap.fetch ids, fields }
 189     good_results =
 190       if ids.respond_to? :member?
 191         results.find_all { |r| ids.member?(r.seqno) && fields.all? { |f| r.attr.member?(f) } }
 192       else
 193         results.find_all { |r| ids == r.seqno && fields.all? { |f| r.attr.member?(f) } }
 194       end
 195
 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?"
 200     end
 201
 202     good_results
 203   end
 204
 205   def unsafe_connect
 206     say "Connecting to IMAP server #{host}:#{port}..."
 207
 208     ## apparently imap.rb does a lot of threaded stuff internally and
 209     ## if 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
 211     ## i've resorted to initializing it in its own thread. surely
 212     ## there's a better way.
 213     exception = nil
 214     ::Thread.new do
 215       begin
 216         #raise Net::IMAP::ByeResponseError, "simulated imap failure"
 217         @imap = Net::IMAP.new host, port, ssl?
 218         say "Logging in..."
 219
 220         ## although RFC1730 claims that "If an AUTHENTICATE command
 221         ## fails with a NO response, the client may try another", in
 222         ## practice it seems like they can also send a BAD response.
 223         begin
 224           @imap.authenticate 'CRAM-MD5', @username, @password
 225         rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
 226           Redwood::log "CRAM-MD5 authentication failed: #{e.class}. Trying LOGIN auth..."
 227           begin
 228             @imap.authenticate 'LOGIN', @username, @password
 229           rescue Net::IMAP::BadResponseError, Net::IMAP::NoResponseError => e
 230             Redwood::log "LOGIN authentication failed: #{e.class}. Trying plain-text LOGIN..."
 231             @imap.login @username, @password
 232           end
 233         end
 234         say "Successfully connected to #{@parsed_uri}."
 235       rescue Exception => e
 236         exception = e
 237       ensure
 238         shutup
 239       end
 240     end.join
 241
 242     raise exception if exception
 243   end
 244
 245   def say s
 246     @say_id = BufferManager.say s, @say_id if BufferManager.instantiated?
 247     Redwood::log s
 248   end
 249
 250   def shutup
 251     BufferManager.clear @say_id if BufferManager.instantiated?
 252     @say_id = nil
 253   end
 254
 255   def make_id imap_stuff
 256     # use 7 digits for the size. why 7? seems nice.
 257     %w(RFC822.SIZE INTERNALDATE).each do |w|
 258       raise FatalSourceError, "requested data not in IMAP response: #{w}" unless imap_stuff.attr[w]
 259     end
 260
 261     msize, mdate = imap_stuff.attr['RFC822.SIZE'] % 10000000, Time.parse(imap_stuff.attr["INTERNALDATE"])
 262     sprintf("%d%07d", mdate.to_i, msize).to_i
 263   end
 264
 265   def get_imap_fields id, *fields
 266     imap_id = @imap_ids[id] or raise OutOfSyncSourceError, "Unknown message id #{id}"
 267
 268     retried = false
 269     result = fetch(imap_id, (fields + ['RFC822.SIZE', 'INTERNALDATE']).uniq).first
 270     got_id = make_id result
 271     raise OutOfSyncSourceError, "IMAP message mismatch: requested #{id}, got #{got_id}." unless got_id == id
 272
 273     fields.map { |f| result.attr[f] or raise FatalSourceError, "empty response from IMAP server: #{f}" }
 274   end
 275
 276   ## execute a block, connected if unconnected, re-connected up to 3
 277   ## times if a recoverable error occurs, and properly dying if an
 278   ## unrecoverable error occurs.
 279   def safely
 280     retries = 0
 281     begin
 282       begin
 283         unsafe_connect unless @imap
 284         yield
 285       rescue *RECOVERABLE_ERRORS => e
 286         if (retries += 1) <= 3
 287           @imap = nil
 288           Redwood::log "got #{e.class.name}: #{e.message.inspect}"
 289           sleep 2
 290           retry
 291         end
 292         raise
 293       end
 294     rescue SocketError, Net::IMAP::Error, SystemCallError, IOError, OpenSSL::SSL::SSLError => e
 295       raise FatalSourceError, "While communicating with IMAP server (type #{e.class.name}): #{e.message.inspect}"
 296     end
 297   end
 298
 299 end
 300
 301 end