sup 0.0.8 → 0.1

data/lib/sup/contact.rb

@@ -12,7 +12,7 @@ class ContactManager
       IO.foreach(fn) do |l|
         l =~ /^(\S+): (.*)$/ or raise "can't parse #{fn} line #{l.inspect}"
         aalias, addr = $1, $2
-        p = Person.for addr
+        p = PersonManager.person_for addr, :definitive => true
         @p2a[p] = aalias
         @a2p[aalias] = p
       end

data/lib/sup/draft.rb

@@ -42,6 +42,7 @@ end
 
 class DraftLoader < Source
   attr_accessor :dir
+  yaml_properties :cur_offset
 
   def initialize cur_offset=0
     dir = Redwood::DRAFT_DIR
@@ -119,6 +120,4 @@ private
   end
 end
 
-Redwood::register_yaml(DraftLoader, %w(cur_offset))
-
 end

data/lib/sup/imap.rb

@@ -6,7 +6,7 @@ require 'rmail'
 
 ## fucking imap fucking sucks. what the FUCK kind of committee of
 ## dunces designed this shit.
-
+##
 ## imap talks about 'unique ids' for messages, to be used for
 ## cross-session identification. great---just what sup needs! except
 ## it turns out the uids can be invalidated every time the
@@ -19,13 +19,25 @@ require 'rmail'
 ## does. thus the so-called uids are absolutely useless and imap
 ## provides no cross-session way of uniquely identifying a
 ## message. but thanks for the "strong recommendation", guys!
-
+##
 ## so right now i'm using the 'internal date' and the size of each
 ## message to uniquely identify it, and i scan over the entire mailbox
 ## each time i open it to map those things to message ids. that can be
 ## slow for large mailboxes, and we'll just have to hope that there
 ## are no collisions. ho ho! a perfectly reasonable solution!
-
+##
+## and here's another thing. check out RFC2060 2.2.2 paragraph 5:
+##
+##   A client MUST be prepared to accept any server response at all times.
+##   This includes server data that was not requested.
+##
+## yeah. that totally makes a lot of sense. and once again, the idiocy
+## of the spec actually happens in practice. you'll request flags for
+## one message, and get it interspersed with a random bunch of flags
+## for some other messages, including a different set of flags for the
+## same message! totally ok by the imap spec. totally retarded by any
+## other metric.
+##
 ## fuck you, imap committee. you managed to design something nearly as
 ## shitty as mbox but goddamn THIRTY YEARS LATER.
 module Redwood
@@ -34,11 +46,13 @@ class IMAP < Source
   SCAN_INTERVAL = 60 # seconds
 
   ## upon these errors we'll try to rereconnect a few times
-  RECOVERABLE_ERRORS = [ Errno::EPIPE, Errno::ETIMEDOUT ]
+  RECOVERABLE_ERRORS = [ Errno::EPIPE, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError ]
 
   attr_accessor :username, :password
+  yaml_properties :uri, :username, :password, :cur_offset, :usual,
+                  :archived, :id, :labels
 
-  def initialize uri, username, password, last_idate=nil, usual=true, archived=false, id=nil
+  def initialize uri, username, password, last_idate=nil, usual=true, archived=false, id=nil, labels=[]
     raise ArgumentError, "username and password must be specified" unless username && password
     raise ArgumentError, "not an imap uri" unless uri =~ %r!imaps?://!
 
@@ -51,11 +65,19 @@ class IMAP < Source
     @imap_ids = {}
     @ids = []
     @last_scan = nil
-    @labels = [:unread]
-    @labels << mailbox.intern unless mailbox =~ /inbox/i
+    @labels = (labels || []).freeze
+    @say_id = nil
     @mutex = Mutex.new
   end
 
+  def self.suggest_labels_for path
+    if path =~ /inbox/i
+      [path.intern]
+    else
+      []
+    end
+  end
+
   def host; @parsed_uri.host; end
   def port; @parsed_uri.port || (ssl? ? 993 : 143); end
   def mailbox
@@ -88,6 +110,7 @@ class IMAP < Source
   def raw_header id
     unsynchronized_scan_mailbox
     header, flags = get_imap_fields id, 'RFC822.HEADER', 'FLAGS'
+    ## very bad. this is very very bad. very bad bad bad.
     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
@@ -115,9 +138,9 @@ class IMAP < Source
 
     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|
+    range = (@ids.length + 1) .. last_id
+    Redwood::log "fetching IMAP headers #{range}"
+    fetch(range, ['RFC822.SIZE', 'INTERNALDATE']).each do |v|
       id = make_id v
       @ids << id
       @imap_ids[id] = v.seqno
@@ -137,7 +160,7 @@ class IMAP < Source
     start.upto(ids.length - 1) do |i|         
       id = ids[i]
       self.cur_offset = id
-      yield id, @labels.clone
+      yield id, @labels
     end
   end
 
@@ -157,6 +180,24 @@ class IMAP < Source
 
 private
 
+  def fetch ids, fields
+    results = safely { @imap.fetch ids, fields }
+    good_results = 
+      if ids.respond_to? :member?
+        results.find_all { |r| ids.member?(r.seqno) && fields.all? { |f| r.attr.member?(f) } }
+      else
+        results.find_all { |r| ids == r.seqno && fields.all? { |f| r.attr.member?(f) } }
+      end
+
+    if good_results.empty?
+      raise FatalSourceError, "no IMAP response for #{ids} containing all fields #{fields.join(', ')} (got #{results.size} results)"
+    elsif good_results.size < results.size
+      Redwood::log "Your IMAP server sucks. It sent #{results.size} results for a request for #{good_results.size} messages. What are you using, Binc?"
+    end
+
+    good_results
+  end
+
   def unsafe_connect
     say "Connecting to IMAP server #{host}:#{port}..."
 
@@ -209,6 +250,10 @@ private
 
   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
@@ -217,11 +262,11 @@ private
     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
+    result = fetch(imap_id, (fields + ['RFC822.SIZE', 'INTERNALDATE']).uniq).first
+    got_id = make_id result
     raise OutOfSyncSourceError, "IMAP message mismatch: requested #{id}, got #{got_id}." unless got_id == id
 
-    fields.map { |f| results.attr[f] }
+    fields.map { |f| result.attr[f] or raise FatalSourceError, "empty response from IMAP server: #{f}" }
   end
 
   ## execute a block, connected if unconnected, re-connected up to 3
@@ -233,20 +278,20 @@ private
       begin
         unsafe_connect unless @imap
         yield
-      rescue *RECOVERABLE_ERRORS
+      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 => e
-      raise FatalSourceError, "While communicating with IMAP server: #{e.message}"
+    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
 
 end
 
-Redwood::register_yaml(IMAP, %w(uri username password cur_offset usual archived id))
-
 end

data/lib/sup/index.rb

@@ -7,6 +7,14 @@ require 'ferret'
 module Redwood
 
 class Index
+  class LockError < StandardError
+    def initialize h
+      @h = h
+    end
+
+    def method_missing m; @h[m.to_s] end
+  end
+
   include Singleton
 
   attr_reader :index
@@ -16,14 +24,79 @@ class Index
     @sources_dirty = false
 
     wsa = Ferret::Analysis::WhiteSpaceAnalyzer.new false
-    sa = Ferret::Analysis::StandardAnalyzer.new Ferret::Analysis::FULL_ENGLISH_STOP_WORDS, true
+    sa = Ferret::Analysis::StandardAnalyzer.new [], true
     @analyzer = Ferret::Analysis::PerFieldAnalyzer.new wsa
     @analyzer[:body] = sa
-    @qparser ||= Ferret::QueryParser.new :default_field => :body, :analyzer => @analyzer
+    @analyzer[:subject] = sa
+    @qparser ||= Ferret::QueryParser.new :default_field => :body, :analyzer => @analyzer, :or_default => false
+    @lock = Lockfile.new lockfile, :retries => 0, :max_age => nil
 
     self.class.i_am_the_instance self
   end
 
+  def lockfile; File.join @dir, "lock" end
+
+  def lock
+    Redwood::log "locking #{lockfile}..."
+    begin
+      @lock.lock
+    rescue Lockfile::MaxTriesLockError
+      raise LockError, @lock.lockinfo_on_disk
+    end
+  end
+
+  def start_lock_update_thread
+    @lock_update_thread = Redwood::reporting_thread do
+      while true
+        sleep 30
+        @lock.touch_yourself
+      end
+    end
+  end
+
+  def stop_lock_update_thread
+    @lock_update_thread.kill if @lock_update_thread
+    @lock_update_thread = nil
+  end
+
+  def fancy_lock_error_message_for e
+    secs = Time.now - e.mtime
+    mins = secs.to_i / 60
+    time =
+      if mins == 0
+        "#{secs.to_i} seconds"
+      else
+        "#{mins} minutes"
+      end
+
+    <<EOS
+Error: the sup index is locked by another process! User '#{e.user}' on
+host '#{e.host}' is running #{e.pname} with pid #{e.pid}. The process was alive
+as of #{time} ago.
+EOS
+  end
+
+  def lock_or_die
+    begin
+      lock
+    rescue LockError => e
+      $stderr.puts fancy_lock_error_message_for(e)
+      $stderr.puts <<EOS
+
+You can wait for the process to finish, or, if it crashed and left a
+stale lock file behind, you can manually delete #{@lock.path}.
+EOS
+      exit
+    end
+  end
+
+  def unlock
+    if @lock && @lock.locked?
+      Redwood::log "unlocking #{lockfile}..."
+      @lock.unlock
+    end
+  end
+
   def load
     load_sources
     load_index
@@ -116,7 +189,7 @@ class Index
   end
 
   def save_index fn=File.join(@dir, "ferret")
-    # don't have to do anything,  apparently
+    # don't have to do anything, apparently
   end
 
   def contains_id? id
@@ -143,25 +216,25 @@ class Index
 
   def num_results_for opts={}
     return 0 if @index.size == 0 # otherwise ferret barfs ###TODO: remove this once my ferret patch is accepted
+
     q = build_query opts
-    index.search(q).total_hits
+    index.search(q, :limit => 1).total_hits
   end
 
   ## yield all messages in the thread containing 'm' by repeatedly
-  ## querying the index. uields pairs of message ids and
+  ## querying the index. yields pairs of message ids and
   ## message-building lambdas, so that building an unwanted message
   ## can be skipped in the block if desired.
   ##
   ## stops loading any thread if a message with a :killed flag is found.
-
   SAME_SUBJECT_DATE_LIMIT = 7
   def each_message_in_thread_for m, opts={}
+    Redwood::log "Building thread for #{m.id}: #{m.subj}"
     messages = {}
     searched = {}
     num_queries = 0
 
-    ## todo: make subject querying configurable
-    if true # do subject queries
+    if $config[:thread_by_subject] # do subject queries
       date_min = m.date - (SAME_SUBJECT_DATE_LIMIT * 12 * 3600)
       date_max = m.date + (SAME_SUBJECT_DATE_LIMIT * 12 * 3600)
 
@@ -196,14 +269,15 @@ class Index
         break if opts[:limit] && messages.size >= opts[:limit]
         break if @index[docid][:label].split(/\s+/).include? "killed" unless opts[:load_killed]
         mid = @index[docid][:message_id]
-        unless messages.member? mid
+        unless messages.member?(mid)
+          Redwood::log "got #{mid} as a child of #{id}"
           messages[mid] ||= lambda { build_message docid }
           refs = @index[docid][:refs].split(" ")
           pending += refs
         end
       end
     end
-    Redwood::log "ran #{num_queries} queries to build thread of #{messages.size} messages for #{m.id}" if num_queries > 0
+    Redwood::log "ran #{num_queries} queries to build thread of #{messages.size + 1} messages for #{m.id}" if num_queries > 0
     messages.each { |mid, builder| yield mid, builder }
   end
 
@@ -261,11 +335,9 @@ class Index
       t = @index[docid][:to]
 
       if AccountManager.is_account_email? f
-        t.split(" ").each { |e| #Redwood::log "adding #{e} because there's a message to him from account email #{f}"; 
-          contacts[Person.for(e)] = true }
+        t.split(" ").each { |e| contacts[PersonManager.person_for(e)] = true }
       else
-        #Redwood::log "adding from #{f} because there's a message from him to #{t}"
-        contacts[Person.for(f)] = true
+        contacts[PersonManager.person_for(f)] = true
       end
     end
 
@@ -278,6 +350,13 @@ class Index
     @sources_dirty = false
   end
 
+  def has_any_from_source_with_label? source, label
+    q = Ferret::Search::BooleanQuery.new
+    q.add_query Ferret::Search::TermQuery.new("source_id", source.id.to_s), :must
+    q.add_query Ferret::Search::TermQuery.new("label", label.to_s), :must
+    index.search(q, :limit => 1).total_hits > 0
+  end
+
 protected
 
   def parse_user_query_string str; @qparser.parse str; end
@@ -306,9 +385,9 @@ protected
       bakfn = fn + ".bak"
       if File.exists? fn
         File.chmod 0600, fn
-        FileUtils.mv fn, bakfn, :force => true unless File.exists?(bakfn) && File.size(bakfn) > File.size(fn)
+        FileUtils.mv fn, bakfn, :force => true unless File.exists?(bakfn) && File.size(fn) == 0
       end
-      Redwood::save_yaml_obj @sources.values, fn
+      Redwood::save_yaml_obj @sources.values.sort_by { |s| s.id.to_i }, fn, true
       File.chmod 0600, fn
     end
     @sources_dirty = false

data/lib/sup/keymap.rb

@@ -81,7 +81,7 @@ class Keymap
       next if valid_keys.empty?
       [valid_keys.map { |k| keysym_to_string k }.join(", "), help]
     end.compact
-    llen = lines.map { |a, b| a.length }.max
+    llen = lines.max_of { |a, b| a.length }
     lines.map { |a, b| sprintf " %#{llen}s : %s", a, b }.join("\n")
   end
 end

data/lib/sup/label.rb

@@ -8,10 +8,10 @@ class LabelManager
   RESERVED_LABELS = [ :starred, :spam, :draft, :unread, :killed, :sent, :deleted ]
 
   ## labels which it nonetheless makes sense to search for by
-  LISTABLE_LABELS = [ :starred, :spam, :draft, :sent, :killed, :deleted ]
+  LISTABLE_RESERVED_LABELS = [ :starred, :spam, :draft, :sent, :killed, :deleted ]
 
   ## labels that will never be displayed to the user
-  HIDDEN_LABELS = [ :starred, :unread ]
+  HIDDEN_RESERVED_LABELS = [ :starred, :unread ]
 
   def initialize fn
     @fn = fn
@@ -22,15 +22,41 @@ class LabelManager
         []
       end
     @labels = {}
+    @modified = false
     labels.each { |t| @labels[t] = true }
 
     self.class.i_am_the_instance self
   end
 
-  def user_labels; @labels.keys; end
-  def << t; @labels[t] = true unless @labels.member?(t) || RESERVED_LABELS.member?(t); end
-  def delete t; @labels.delete t; end
+  ## all listable (user-defined and system listable) labels, ordered
+  ## nicely and converted to pretty strings. use #label_for to recover
+  ## the original label.
+  def listable_label_strings
+    LISTABLE_RESERVED_LABELS.sort_by { |l| l.to_s }.map { |l| l.to_s.ucfirst } +
+      @labels.keys.map { |l| l.to_s }.sort
+  end
+
+  ## reverse the label->string mapping, for convenience!
+  def label_for string
+    string.downcase.intern
+  end
+  
+  def << t
+    t = t.intern unless t.is_a? Symbol
+    unless @labels.member?(t) || RESERVED_LABELS.member?(t)
+      @labels[t] = true
+      @modified = true
+    end
+  end
+
+  def delete t
+    if @labels.delete t
+      @modified = true
+    end
+  end
+
   def save
+    return unless @modified
     File.open(@fn, "w") { |f| f.puts @labels.keys }
   end
 end