sup 0.0.7 → 0.0.8

data/lib/sup/mbox/ssh-loader.rb

@@ -3,12 +3,7 @@ require 'net/ssh'
 module Redwood
 module MBox
 
-## this is slightly complicated because SSHFile (and thus @f or
-## @loader) can throw a variety of exceptions, and we need to catch
-## those, reraise them as SourceErrors, and set ourselves as broken.
-
 class SSHLoader < Source
-  attr_reader_cloned :labels
   attr_accessor :username, :password
 
   def initialize uri, username=nil, password=nil, start_offset=nil, usual=true, archived=false, id=nil
@@ -32,7 +27,6 @@ class SSHLoader < Source
     ## heuristic: use the filename as a label, unless the file
     ## has a path that probably represents an inbox.
     @labels = [:unread]
-    @labels << :inbox unless archived?
     @labels << File.basename(filename).intern unless File.dirname(filename) =~ /\b(var|usr|spool)\b/
   end
 
@@ -41,7 +35,6 @@ class SSHLoader < Source
   def filename; @parsed_uri.path[1..-1] end
 
   def next
-    return if broken?
     safely do
       offset, labels = @loader.next
       self.cur_offset = @loader.cur_offset # superclass keeps @cur_offset which is used by yaml
@@ -62,11 +55,9 @@ class SSHLoader < Source
   def safely
     begin
       yield
-    rescue Net::SSH::Exception, SocketError, SSHFileError, SystemCallError => e
+    rescue Net::SSH::Exception, SocketError, SSHFileError, SystemCallError, IOError => e
       m = "error communicating with SSH server #{host} (#{e.class.name}): #{e.message}"
-      Redwood::log m
-      self.broken_msg = @loader.broken_msg = m
-      raise SourceError, m
+      raise FatalSourceError, m
     end
   end
 

data/lib/sup/message.rb

@@ -138,7 +138,6 @@ class Message
   end
   private :read_header
 
-  def broken?; @source.broken?; end
   def snippet; @snippet || chunks && @snippet; end
   def is_list_message?; !@list_address.nil?; end
   def is_draft?; DraftLoader === @source; end
@@ -148,8 +147,7 @@ class Message
   end
 
   def save index
-    return if broken?
-    index.update_message self if @dirty
+    index.sync_message self if @dirty
     @dirty = false
   end
 
@@ -177,8 +175,8 @@ class Message
   ## this is called when the message body needs to actually be loaded.
   def load_from_source!
     @chunks ||=
-      if @source.broken?
-        [Text.new(error_message(@source.broken_msg.split("\n")))]
+      if @source.has_errors?
+        [Text.new(error_message(@source.error.message.split("\n")))]
       else
         begin
           ## we need to re-read the header because it contains information
@@ -192,6 +190,9 @@ class Message
           read_header @source.load_header(@source_info)
           message_to_chunks @source.load_message(@source_info)
         rescue SourceError, SocketError, MessageFormatError => e
+          ## we need force_to_top here otherwise this window will cover
+          ## up the error message one
+          Redwood::report_broken_sources :force_to_top => true
           [Text.new(error_message(e.message))]
         end
       end
@@ -202,8 +203,13 @@ class Message
 #@snippet...
 
 ***********************************************************************
-* An error occurred while loading this message. It is possible that   *
-* the source has changed, or (in the case of remote sources) is down. *
+ An error occurred while loading this message. It is possible that
+ the source has changed, or (in the case of remote sources) is down.
+ You can check the log for errors, though hopefully an error window
+ should have popped up at some point.
+
+ The message location was:
+ #@source##@source_info
 ***********************************************************************
 
 The error message was:
@@ -259,7 +265,7 @@ private
     ret = [] <<
       case m.header.content_type
       when "text/plain", nil
-        m.body && body = m.decode or raise MessageFormatError, "for some bizarre reason, RubyMail was unable to parse this message."
+        m.body && body = m.decode or raise MessageFormatError, "For some bizarre reason, RubyMail was unable to parse this message."
         text_to_chunks body.normalize_whitespace.split("\n")
       when /^multipart\//
         nil

data/lib/sup/mode.rb

@@ -81,7 +81,7 @@ EOS
     begin
       File.open(fn, "w") { |f| yield f }
       BufferManager.flash "Successfully wrote #{fn}."
-    rescue SystemCallError => e
+    rescue SystemCallError, IOError => e
       BufferManager.flash "Error writing to file: #{e.message}"
     end
   end

data/lib/sup/modes/edit-message-mode.rb

@@ -158,7 +158,7 @@ EOS
     end
 
     f.puts
-    f.puts @body
+    f.puts @body.map { |l| l =~ /^From / ? ">#{l}" : l }
   end  
 end
 

data/lib/sup/modes/inbox-mode.rb

@@ -21,7 +21,10 @@ class InboxMode < ThreadIndexMode
   end
 
   def multi_archive threads
-    threads.each { |t| remove_label_and_hide_thread t, :inbox }
+    threads.each do |t|
+      t.remove_label :inbox
+      hide_thread t
+    end
     regen_text
   end
 

data/lib/sup/modes/line-cursor-mode.rb

@@ -61,7 +61,7 @@ protected
     return false unless @curpos < lines - 1
     if @curpos >= botline - 1
       page_down
-      set_cursor_pos [topline + 1, botline].min
+      set_cursor_pos topline
     else
       @curpos += 1
       unless buffer.dirty?
@@ -77,8 +77,9 @@ protected
   def cursor_up
     return false unless @curpos > @cursor_top
     if @curpos == topline
+      old_topline = topline
       page_up
-      set_cursor_pos [botline - 2, topline].max
+      set_cursor_pos [old_topline - 1, topline].max
     else
       @curpos -= 1
       unless buffer.dirty?

data/lib/sup/modes/reply-mode.rb

@@ -119,7 +119,7 @@ protected
   def reply_body_lines m
     lines = ["Excerpts from #{@m.from.name}'s message of #{@m.date}:"] + 
       m.basic_body_lines.map { |l| "> #{l}" }
-    lines.pop while lines.last !~ /[:alpha:]/
+    lines.pop while lines.last =~ /^\s*$/
     lines
   end
 

data/lib/sup/modes/thread-index-mode.rb

@@ -56,11 +56,7 @@ class ThreadIndexMode < LineCursorMode
 
   ## open up a thread view window
   def select t=nil
-    t ||= @threads[curpos]
-
-    ## this isn't working entirely. TODO:figure out why
-    # t = t.clone # required so that messages added later on don't completely
-                # screw everything up
+    t ||= @threads[curpos] or return
 
     ## TODO: don't regen text completely
     Redwood::reporting_thread do
@@ -74,6 +70,10 @@ class ThreadIndexMode < LineCursorMode
       BufferManager.draw_screen # lame TODO: make this unnecessary
       ## the first draw_screen is needed before topline and botline
       ## are set, and the second to show the cursor having moved
+
+      t.remove_label :unread
+      update_text_for_line curpos
+      UpdateManager.relay self, :read, t
     end
   end
 
@@ -275,7 +275,7 @@ class ThreadIndexMode < LineCursorMode
   def apply_to_tagged; @tags.apply_to_tagged; end
 
   def edit_labels
-    thread = @threads[curpos]
+    thread = @threads[curpos] or return
     speciall = (@hidden_labels + LabelManager::RESERVED_LABELS).uniq
     keepl, modifyl = thread.labels.partition { |t| speciall.member? t }
     label_string = modifyl.join(" ")

data/lib/sup/modes/thread-view-mode.rb

@@ -3,7 +3,7 @@ module Redwood
 class ThreadViewMode < LineCursorMode
   ## this holds all info we need to lay out a message
   class Layout
-    attr_accessor :top, :bot, :prev, :next, :depth, :width, :state, :color
+    attr_accessor :top, :bot, :prev, :next, :depth, :width, :state, :color, :star_color, :orig_new
   end
 
   DATE_FORMAT = "%B %e %Y %l:%M%P"
@@ -26,6 +26,7 @@ class ThreadViewMode < LineCursorMode
     k.add :edit_as_new, "Edit message as new", 'D'
     k.add :save_to_disk, "Save message/attachment to disk", 's'
     k.add :search, "Search for messages from particular people", 'S'
+    k.add :compose, "Compose message to person", 'm'
     k.add :archive_and_kill, "Archive thread and kill buffer", 'A'
   end
 
@@ -52,6 +53,8 @@ class ThreadViewMode < LineCursorMode
       @layout[m] = Layout.new
       @layout[m].state = initial_state_for m
       @layout[m].color = altcolor ? :alternate_patina_color : :message_patina_color
+      @layout[m].star_color = altcolor ? :alternate_starred_patina_color : :starred_patina_color
+      @layout[m].orig_new = m.has_label? :unread
       altcolor = !altcolor
       if latest_date.nil? || m.date > latest_date
         latest_date = m.date
@@ -111,10 +114,22 @@ class ThreadViewMode < LineCursorMode
   def search
     p = @person_lines[curpos] or return
     mode = PersonSearchResultsMode.new [p]
-    BufferManager.spawn "search for #{p.name}", mode
+    BufferManager.spawn "Search for #{p.name}", mode
     mode.load_threads :num => mode.buffer.content_height
   end    
 
+  def compose
+    p = @person_lines[curpos]
+    mode =
+      if p
+        ComposeMode.new :to => [p]
+      else
+        ComposeMode.new
+      end
+    BufferManager.spawn "Compose message", mode
+    mode.edit
+  end    
+
   def toggle_starred
     m = @message_lines[curpos] or return
     if m.has_label? :starred
@@ -231,7 +246,7 @@ class ThreadViewMode < LineCursorMode
   end
 
   def collapse_non_new_messages
-    @layout.each { |m, l| l.state = m.has_label?(:unread) ? :open : :closed }
+    @layout.each { |m, l| l.state = l.orig_new ? :open : :closed if m.is_a? Message }
     update
   end
 
@@ -246,9 +261,7 @@ class ThreadViewMode < LineCursorMode
   end
 
   def cleanup
-    @thread.remove_label :unread
-    UpdateManager.relay self, :read, @thread
-    @layout = @text = nil
+    @layout = @text = nil # for good luck
   end
 
   def archive_and_kill
@@ -290,7 +303,7 @@ private
       l = @layout[m] or next # TODO: figure out why this is nil sometimes
 
       ## build the patina
-      text = chunk_to_lines m, l.state, @text.length, depth, parent, @layout[m].color
+      text = chunk_to_lines m, l.state, @text.length, depth, parent, @layout[m].color, @layout[m].star_color
       
       l.top = @text.length
       l.bot = @text.length + text.length # updated below
@@ -327,7 +340,7 @@ private
     end
   end
 
-  def message_patina_lines m, state, start, parent, prefix, color
+  def message_patina_lines m, state, start, parent, prefix, color, star_color
     prefix_widget = [color, prefix]
     widget = 
       case state
@@ -338,7 +351,7 @@ private
       end
     imp_widget = 
       if m.has_label?(:starred)
-        [:starred_patina_color, "* "]
+        [star_color, "* "]
       else
         [color, "  "]
       end
@@ -398,7 +411,7 @@ private
     p.longname + (ContactManager.is_contact?(p) ? " (#{ContactManager.alias_for p})" : "")
   end
 
-  def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil
+  def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil, star_color=nil
     prefix = " " * INDENT_SPACES * depth
     case chunk
     when :fake_root
@@ -406,7 +419,7 @@ private
     when nil
       [[[:missing_message_color, "#{prefix}<an unreceived message>"]]]
     when Message
-      message_patina_lines(chunk, state, start, parent, prefix, color) +
+      message_patina_lines(chunk, state, start, parent, prefix, color, star_color) +
         (chunk.is_draft? ? [[[:draft_notification_color, prefix + " >>> This message is a draft. To edit, hit 'e'. <<<"]]] : [])
     when Message::Attachment
       [[[:mime_color, "#{prefix}+ MIME attachment #{chunk.content_type}#{chunk.desc ? ' (' + chunk.desc + ')': ''}"]]]

data/lib/sup/poll.rb

@@ -43,10 +43,17 @@ class PollManager
     @mutex.synchronize do
       Index.usual_sources.each do |source|
 #        yield "source #{source} is done? #{source.done?} (cur_offset #{source.cur_offset} >= #{source.end_offset})"
-        yield "Loading from #{source}... " unless source.done? || source.broken?
+        begin
+          yield "Loading from #{source}... " unless source.done? || source.has_errors?
+        rescue SourceError => e
+          Redwood::log "problem getting messages from #{source}: #{e.message}"
+          Redwood::report_broken_sources
+          next
+        end
+
         num = 0
         numi = 0
-        add_new_messages_from source do |m, offset, entry|
+        add_messages_from source do |m, offset, entry|
           ## always preserve the labels on disk.
           m.labels = entry[:label].split(/\s+/).map { |x| x.intern } if entry
           yield "Found message at #{offset} with labels {#{m.labels * ', '}}"
@@ -69,47 +76,49 @@ class PollManager
   end
 
   ## this is the main mechanism for adding new messages to the
-  ## index. it's called both by sup-import and by PollMode.
+  ## index. it's called both by sup-sync and by PollMode.
   ##
-  ## for each new message in the source, this yields the message, the
-  ## source offset, and the index entry on disk (if any). it expects
-  ## the yield to return the message (possibly altered in some way),
-  ## and then adds it (if new) or updates it (if previously seen).
+  ## for each message in the source, starting from the source's
+  ## starting offset, this methods yields the message, the source
+  ## offset, and the index entry on disk (if any). it expects the
+  ## yield to return the message (possibly altered in some way), and
+  ## then adds it (if new) or updates it (if previously seen).
   ##
-  ## the labels of the yielded message are the source labels. it is
-  ## likely that callers will want to replace these with the index
-  ## labels, if they exist, so that state is not lost when e.g. a new
-  ## version of a message from a mailing list comes in.
-  def add_new_messages_from source
-    return if source.done? || source.broken?
-
-    source.each do |offset, labels|
-      if source.broken?
-        Redwood::log "error loading messages from #{source}: #{source.broken_msg}"
-        return
-      end
+  ## the labels of the yielded message are the default source
+  ## labels. it is likely that callers will want to replace these with
+  ## the index labels, if they exist, so that state is not lost when
+  ## e.g. a new version of a message from a mailing list comes in.
+  def add_messages_from source
+    begin
+      return if source.done? || source.has_errors?
       
-      labels.each { |l| LabelManager << l }
-
-      begin
-        m = Message.new :source => source, :source_info => offset, :labels => labels
-        if m.source_marked_read?
-          m.remove_label :unread
-          labels.delete :unread
+      source.each do |offset, labels|
+        if source.has_errors?
+          Redwood::log "error loading messages from #{source}: #{source.broken_msg}"
+          return
         end
+      
+        labels.each { |l| LabelManager << l }
+        labels += [:inbox] unless source.archived?
+
+        begin
+          m = Message.new :source => source, :source_info => offset, :labels => labels
+          if m.source_marked_read?
+            m.remove_label :unread
+            labels.delete :unread
+          end
 
-        docid, entry = Index.load_entry_for_id m.id
-        m = yield m, offset, entry
-        next unless m
-        if entry
-          Index.update_message m, docid, entry
-        else
-          Index.add_message m
-          UpdateManager.relay self, :add, m
+          docid, entry = Index.load_entry_for_id m.id
+          m = yield(m, offset, entry) or next
+          Index.sync_message m, docid, entry
+          UpdateManager.relay self, :add, m unless entry
+        rescue MessageFormatError => e
+          Redwood::log "ignoring erroneous message at #{source}##{offset}: #{e.message}"
         end
-      rescue MessageFormatError, SourceError => e
-        Redwood::log "ignoring erroneous message at #{source}##{offset}: #{e.message}"
       end
+    rescue SourceError => e
+      Redwood::log "problem getting messages from #{source}: #{e.message}"
+      Redwood::report_broken_sources
     end
   end
 end

data/lib/sup/sent.rb

@@ -12,7 +12,7 @@ class SentManager
 
   def self.source_name; "sup://sent"; end
   def self.source_id; 9998; end
-  def new_source; @source = SentLoader.new; end
+  def new_source; @source = Recoverable.new SentLoader.new; end
 
   def write_sent_message date, from_email
     need_blank = File.exists?(@fn) && !File.zero?(@fn)
@@ -22,8 +22,8 @@ class SentManager
       yield f
     end
     @source.each do |offset, labels|
-      m = Message.new :source => @source, :source_info => offset, :labels => labels
-      Index.add_message m
+      m = Message.new :source => @source, :source_info => offset, :labels => @source.labels
+      Index.sync_message m
       UpdateManager.relay self, :add, m
     end
   end

data/lib/sup/source.rb

@@ -1,6 +1,8 @@
 module Redwood
 
 class SourceError < StandardError; end
+class OutOfSyncSourceError < SourceError; end
+class FatalSourceError < SourceError; end
 
 class Source
   ## Implementing a new source is typically quite easy, because Sup
@@ -30,31 +32,31 @@ class Source
   ## - load_message offset
   ## - raw_header offset
   ## - raw_full_message offset
+  ## - check
   ## - next (or each, if you prefer)
   ##
   ## ... where "offset" really means unique id. (You can tell I
   ## started with mbox.)
   ##
-  ## You can throw SourceErrors from any of those, but we don't catch
-  ## anything else, so make sure you catch *all* errors and reraise
-  ## them as SourceErrors, and set broken_msg to something if the
-  ## source needs to be rescanned.
+  ## All exceptions relating to accessing the source must be caught
+  ## and rethrown as FatalSourceErrors or OutOfSyncSourceErrors.
+  ## OutOfSyncSourceErrors should be used for problems that a call to
+  ## sup-sync will fix (namely someone's been playing with the source
+  ## from another client); FatalSourceErrors can be used for anything
+  ## else (e.g. the imap server is down or the maildir is missing.)
   ##
-  ## Also, be sure to make the source thread-safe, since it WILL be
+  ## Finally, be sure the source is thread-safe, since it WILL be
   ## pummeled from multiple threads at once.
   ##
-  ## Two examples for you to look at, though sadly neither of them is
-  ## as simple as I'd like: mbox/loader.rb and imap.rb
+  ## Examples for you to look at: mbox/loader.rb, imap.rb, and
+  ## maildir.rb.
 
-
-
-  ## dirty? described whether cur_offset has changed, which means the
-  ## source info needs to be re-saved to sources.yaml.
+  ## let's begin!
   ##
-  ## broken? means no message can be loaded, e.g. IMAP server is
-  ## down, mbox file is corrupt and needs to be rescanned, etc.
+  ## dirty? means cur_offset has changed, so the source info needs to
+  ## be re-saved to sources.yaml.
   bool_reader :usual, :archived, :dirty
-  attr_reader :uri, :cur_offset, :broken_msg
+  attr_reader :uri, :cur_offset
   attr_accessor :id
 
   def initialize uri, initial_offset=nil, usual=true, archived=false, id=nil
@@ -64,41 +66,26 @@ class Source
     @archived = archived
     @id = id
     @dirty = false
-    @broken_msg = nil
   end
 
-  def broken?; !@broken_msg.nil?; end
   def to_s; @uri.to_s; end
   def seek_to! o; self.cur_offset = o; end
-  def reset!
-    return if broken?
-    begin
-      seek_to! start_offset
-    rescue SourceError
-    end
-  end
-  def == o; o.to_s == to_s; end
-  def done?;
-    return true if broken? 
-    begin
-      (self.cur_offset ||= start_offset) >= end_offset
-    rescue SourceError => e
-      true
-    end
-  end
+  def reset!; seek_to! start_offset; end
+  def == o; o.uri == uri; end
+  def done?; (self.cur_offset ||= start_offset) >= end_offset; end
   def is_source_for? uri; URI(self.uri) == URI(uri); end
 
+  ## check should throw a FatalSourceError or an OutOfSyncSourcError
+  ## if it can detect a problem. it is called when the sup starts up
+  ## to proactively notify the user of any source problems.
+  def check; end
+
   def each
-    return if broken?
-    begin
-      self.cur_offset ||= start_offset
-      until done? || broken? # just like life!
-        n, labels = self.next
-        raise "no message" unless n
-        yield n, labels
-      end
-    rescue SourceError => e
-      self.broken_msg = e.message
+    self.cur_offset ||= start_offset
+    until done?
+      n, labels = self.next
+      raise "no message" unless n
+      yield n, labels
     end
   end
 
@@ -108,11 +95,6 @@ protected
     @cur_offset = o
     @dirty = true
   end
-
-  def broken_msg= m
-    @broken_msg = m
-#    Redwood::log "#{to_s}: #{m}"
-  end
 end
 
 Redwood::register_yaml(Source, %w(uri cur_offset usual archived id))