sup 0.0.8 → 0.1

data/HACKING

@@ -4,47 +4,17 @@ Invoke it like this:
 
 ruby -I lib -w bin/sup
 
+You'll have to install all gems mentioned in the Rakefile (look for the line
+setting p.extra_deps). If you're on a Debian or Debian-based system (e.g.
+Ubuntu), you'll have to make sure you have a complete Ruby installation,
+especially libssl-ruby.
+
 Coding standards
 ----------------
 
 - Don't wrap code unless it really benefits from it. The days of
   80-column displays are long over. But do wrap comments and other
   text at whatever Emacs meta-Q does.
-- Use as few parentheses as possible.
+- I like poetry mode.
 - Use {} for one-liner blocks and do/end for multi-line blocks.
 
-How messages are updated in the index
--------------------------------------
-
-Ferret doesn't have any concept of updating; to change message state
-it must be deleted then re-added to the index.
-
-Thus there are a couple situations where we'll have a message to be
-"added", but it already exists in the index, and we need to decide
-which parts of which version to keep:
-
-1. The user has changed the state of the message, e.g. read it or
-   added a user label. In this case we want to use the state of the
-   version in memory, but keep everything else on disk.
-
-   This is the behavior of Index#update_message
-
-2. We've received a new copy of the message. Crucially, this can
-   happen for two different reasons:
-
-   a. The message was sent to a mailing list to which the user is
-      subscribed, and we're now getting that message back, possibly
-      with altered content (subject mangling, signature adding, etc.)
-
-   b. The user has moved the message between sources. E.g. if the
-      primary inbox has a quota, and other sources are on local,
-      quota-less disk, the user may regularly move messages from the
-      inbox to the sources on disk.
-
-   In both of these cases, the solution is to keep the state from the
-   index, but use the new message contents.
-
-   This is the behavior of Index#update_or_add_message, which can be
-   also be called for new message.
-
-

data/History.txt

@@ -1,3 +1,14 @@
+== 0.1 / 2007-07-17
+* MIME attachment creation.
+* i18n support: character set conversion and rfc2047 header decoding.
+* Better MIME handling.
+* Multiple account support.
+* Locking and concurrent Sup process detection and killation.
+* Thread autoloading when you scroll down.
+* Batch deletion of messages marked deleted or spam from message
+  sources via sup-sync-back tool (mbox only).
+* Millions of bugfixes.
+
 == 0.0.8 / 2007-04-01
 
 * Maildir support!

data/Manifest.txt

@@ -10,6 +10,7 @@ bin/sup-config
 bin/sup-dump
 bin/sup-recover-sources
 bin/sup-sync
+bin/sup-sync-back
 doc/FAQ.txt
 doc/Philosophy.txt
 doc/TODO
@@ -33,9 +34,11 @@ lib/sup/mbox/ssh-loader.rb
 lib/sup/message.rb
 lib/sup/mode.rb
 lib/sup/modes/buffer-list-mode.rb
+lib/sup/modes/completion-mode.rb
 lib/sup/modes/compose-mode.rb
 lib/sup/modes/contact-list-mode.rb
 lib/sup/modes/edit-message-mode.rb
+lib/sup/modes/file-browser-mode.rb
 lib/sup/modes/forward-mode.rb
 lib/sup/modes/help-mode.rb
 lib/sup/modes/inbox-mode.rb
@@ -54,8 +57,10 @@ lib/sup/modes/thread-index-mode.rb
 lib/sup/modes/thread-view-mode.rb
 lib/sup/person.rb
 lib/sup/poll.rb
+lib/sup/rfc2047.rb
 lib/sup/sent.rb
 lib/sup/source.rb
+lib/sup/suicide.rb
 lib/sup/tagger.rb
 lib/sup/textfield.rb
 lib/sup/thread.rb

data/README.txt

@@ -4,9 +4,10 @@ sup
 
 == DESCRIPTION:
 
-Sup is a console-based email client that combines the best
-features of GMail, mutt, and emacs. Sup matches the power of GMail
-with the speed and simplicity of a console interface.
+Sup is a console-based email client for people with a lot of email.
+It supports tagging, very fast full-text search, automatic contact-
+list management, and more. If you're the type of person who treats
+email as an extension of your long-term memory, Sup is for you.
 
 Sup makes it easy to:
 - Handle massive amounts of email.
@@ -84,24 +85,15 @@ Current limitations which will be fixed:
 
 == SYNOPSYS:
 
-  1. sup-import <source>+
-  2. sup
-  3. edit ~/.sup/config.yaml for the (very few) settings sup has
-
-  Where <source> is a filename (for mbox files), an imap or imaps URI,
-  or a mbox+ssh URI (for remote mbox files). You will be prompted for
-  a username and password if required.
-
-  sup-import has several options which control whether you want
-  messages from particular mailboxes not to be added to the inbox, or
-  not to be marked as new, so run it with -h for help.
+  0. sup-config
+  1. sup
 
   Note that Sup never changes the contents of any mailboxes; it only
   indexes in to them. So it shouldn't ever corrupt your mail. The flip
   side is that if you change a mailbox (e.g. delete messages, or, in
   the case of mbox files, read an unread message) then Sup will be
   unable to load messages from that source and will ask you to run
-  sup-import --rebuild.
+  sup-sync --changed.
 
 == REQUIREMENTS:
 
@@ -109,28 +101,18 @@ Current limitations which will be fixed:
 * ncurses
 * rmail
 * highline
-* trollop
 * net-ssh
+* trollop >= 1.7
+* lockfile
+* mime-types
 
 == INSTALL:
 
 * gem install sup -y
 
-== KNOWN BUGS IN OTHER PACKAGES:
-
-* If you get an error about frozen strings in RubyMail when importing
-  certain messages with attachments, in rmail, change line 159 of
-  multipart.rb to:
-    chunk = chunk[0..start]
-  This is because RubyMail hasn't been updated since like Ruby 1.8.2.
-  Please bug Matt Lickey.
-* Occasionally Ferret produces something the Ruby GC doesn't like
-  (particularly when importing messages from very large sources).
-  No worries, just re-run sup-import. (This is unresolved atm.)
-* If you are using IMAP or Maildir and see this error:
-    /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
-  then you need to upgrade to Ruby 1.8.5. YAML in earlier versions
-  can't parse BigNums.
+== PROBLEMS:
+
+See FAQ.txt for some common problems and their solutions.
 
 == LICENSE:
 

data/Rakefile

@@ -2,7 +2,7 @@
 
 require 'rubygems'
 require 'hoe'
-require './lib/sup.rb'
+require 'sup'
 
 class Hoe
   def extra_deps; @extra_deps.reject { |x| Array(x).first == "hoe" } end
@@ -16,14 +16,14 @@ Hoe.new('sup', Redwood::VERSION) do |p|
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[2].gsub(/^\s+/, "")
   p.changes = p.paragraphs_of('History.txt', 0..0).join("\n\n")
   p.email = "wmorgan-sup@masanjin.net"
-  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17'], 'highline', 'net-ssh', ['trollop', '>= 1.5']]
+  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17'], 'highline', 'net-ssh', ['trollop', '>= 1.7'], 'lockfile', 'mime-types']
 end
 
 rule 'ss?.png' => 'ss?-small.png' do |t|
 end
 
 ## is there really no way to make a rule for this?
-WWW_FILES = %w(www/index.html README.txt doc/Philosophy.txt doc/FAQ.txt doc/UserGuide.txt)
+WWW_FILES = %w(www/index.html README.txt doc/Philosophy.txt doc/FAQ.txt doc/UserGuide.txt www/main.css)
 
 SCREENSHOTS = FileList["www/ss?.png"]
 SCREENSHOTS_SMALL = []

data/bin/sup

@@ -2,8 +2,23 @@
 
 require 'rubygems'
 require 'ncurses'
+require 'fileutils'
+require 'trollop'
 require "sup"
 
+$opts = Trollop::options do
+  version "sup v#{Redwood::VERSION}"
+  banner <<EOS
+Sup is a curses-based email client.
+
+Usage:
+  sup [options]
+
+Options are:
+EOS
+  opt :no_threads, "Turn of threading. Helps with debugging. (Necessarily disables background polling for new messages.)"
+end
+
 Thread.abort_on_exception = true # make debugging possible
 
 module Redwood
@@ -31,31 +46,60 @@ def start_cursing
   Ncurses.stdscr.keypad 1
   Ncurses.curs_set 0
   Ncurses.start_color
+  $cursing = true
 end
 
 def stop_cursing
+  return unless $cursing
   Ncurses.curs_set 1
   Ncurses.echo
   Ncurses.endwin
 end
 module_function :start_cursing, :stop_cursing
 
-Redwood::start
-Index.new.load
+Index.new
+begin
+  Index.lock
+rescue Index::LockError => e
+  require 'highline'
 
-if(s = Index.source_for DraftManager.source_name)
-  DraftManager.source = s
-else
-  Index.add_source DraftManager.new_source
-end
+  h = HighLine.new
+  h.wrap_at = :auto
+  h.say Index.fancy_lock_error_message_for(e)
 
-if(s = Index.source_for SentManager.source_name)
-  SentManager.source = s
-else
-  Index.add_source SentManager.new_source
+  case h.ask("Should I ask that process to kill itself? ")
+  when /^\s*y\s*$/i
+    h.say "Ok, suggesting sepuku..."
+    FileUtils.touch Redwood::SUICIDE_FN
+    sleep SuicideManager::DELAY * 2
+    FileUtils.rm_f Redwood::SUICIDE_FN
+    h.say "Let's try that again."
+    retry
+  else
+    h.say <<EOS
+Ok, giving up. If the process crashed and left a stale lockfile, you
+can fix this by manually deleting #{Index.lockfile}.
+EOS
+    exit
+  end
 end
 
 begin
+  Redwood::start
+  Index.load
+
+  if(s = Index.source_for DraftManager.source_name)
+    DraftManager.source = s
+  else
+    Index.add_source DraftManager.new_source
+  end
+
+  if(s = Index.source_for SentManager.source_name)
+    SentManager.source = s
+  else
+    Index.add_source SentManager.new_source
+  end
+
   log "starting curses"
   start_cursing
 
@@ -65,6 +109,8 @@ begin
     c.add :index_old_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK
     c.add :index_new_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK, 
            Ncurses::A_BOLD
+    c.add :index_starred_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK, 
+           Ncurses::A_BOLD
     c.add :labellist_old_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK
     c.add :labellist_new_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK, 
            Ncurses::A_BOLD
@@ -73,7 +119,7 @@ begin
     c.add :message_patina_color, Ncurses::COLOR_BLACK, Ncurses::COLOR_GREEN
     c.add :alternate_patina_color, Ncurses::COLOR_BLACK, Ncurses::COLOR_BLUE
     c.add :missing_message_color, Ncurses::COLOR_BLACK, Ncurses::COLOR_RED
-    c.add :mime_color, Ncurses::COLOR_CYAN, Ncurses::COLOR_BLACK
+    c.add :attachment_color, Ncurses::COLOR_CYAN, Ncurses::COLOR_BLACK
     c.add :quote_patina_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK
     c.add :sig_patina_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK
     c.add :quote_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK
@@ -91,6 +137,8 @@ begin
           Ncurses::A_BOLD
     c.add :draft_notification_color, Ncurses::COLOR_RED, Ncurses::COLOR_BLACK,
           Ncurses::A_BOLD
+    c.add :completion_character_color, Ncurses::COLOR_WHITE,
+          Ncurses::COLOR_BLACK, Ncurses::A_BOLD
   end
 
   log "initializing buffer manager"
@@ -98,7 +146,7 @@ begin
 
   log "initializing mail index buffer"
   imode = InboxMode.new
-  ibuf = bm.spawn "inbox", imode
+  ibuf = bm.spawn "Inbox", imode
 
   log "ready for interaction!"
   Logger.make_buf
@@ -122,99 +170,129 @@ begin
     end if s.respond_to? :connect
   end
 
-  imode.load_threads :num => ibuf.content_height, :when_done => lambda { reporting_thread { sleep 1; PollManager.poll } }
+  imode.load_threads :num => ibuf.content_height, :when_done => lambda { reporting_thread { sleep 1; PollManager.poll } unless $opts[:no_threads] }
 
-  PollManager.start_thread
+  unless $opts[:no_threads]
+    PollManager.start
+    SuicideManager.start
+    Index.start_lock_update_thread
+  end
 
-  until $exception
-    bm.draw_screen
+  until $exception || SuicideManager.die?
     c = Ncurses.nonblocking_getch
+    next unless c
     bm.erase_flash
 
-    if c == Ncurses::KEY_RESIZE
-      bm.handle_resize
-    elsif c
-      unless bm.handle_input(c)
-        x = global_keymap.action_for c
-        case x
-        when :quit
-          break if bm.kill_all_buffers_safely
-        when :help
-          curmode = bm.focus_buf.mode
-          bm.spawn_unless_exists("<help for #{curmode.name}>") { HelpMode.new curmode, global_keymap }
-        when :roll_buffers
-          bm.roll_buffers
-        when :roll_buffers_backwards
-          bm.roll_buffers_backwards
-        when :kill_buffer
-          bm.kill_buffer_safely bm.focus_buf
-        when :list_buffers
-          bm.spawn_unless_exists("Buffer List") { BufferListMode.new }
-        when :list_contacts
-          b = bm.spawn_unless_exists("Contact List") { ContactListMode.new }
-          b.mode.load_in_background
-        when :search
-          text = bm.ask :search, "query: "
-          next unless text && text !~ /^\s*$/
-
-          begin
-            qobj = Index.parse_user_query_string text
-            short_text = text.length < 20 ? text : text[0 ... 20] + "..."
-            log "built query from #{text.inspect}: #{qobj}"
-            mode = SearchResultsMode.new qobj
-            bm.spawn "search: \"#{short_text}\"", mode
-            mode.load_threads :num => mode.buffer.content_height
-          rescue Ferret::QueryParser::QueryParseException => e
-            bm.flash "Couldn't parse query."
-          end
-        when :list_labels
-          b = bm.spawn_unless_exists("Label List") { LabelListMode.new }
-          b.mode.load_in_background
-        when :compose
-          mode = ComposeMode.new
-          bm.spawn "New Message", mode
-          mode.edit
-        when :poll
-          bm.raise_to_front PollManager.buffer
-          reporting_thread { PollManager.poll }
-        when :recall_draft
-          case Index.num_results_for :label => :draft
-          when 0
-            bm.flash "No draft messages."
-          when 1
-            m = nil
-            Index.each_id_by_date(:label => :draft) { |mid, builder| m = builder.call }
-            r = ResumeMode.new(m)
-            BufferManager.spawn "Edit message", r
-            r.edit
-          else
-            b = BufferManager.spawn_unless_exists(:draft) do
-              mode = LabelSearchResultsMode.new [:draft]
-            end
-            b.mode.load_threads :num => b.content_height
+    unless bm.handle_input(c)
+      x = global_keymap.action_for c
+      case x
+      when :quit
+        break if bm.kill_all_buffers_safely
+      when :help
+        curmode = bm.focus_buf.mode
+        bm.spawn_unless_exists("<help for #{curmode.name}>") { HelpMode.new curmode, global_keymap }
+      when :roll_buffers
+        bm.roll_buffers
+      when :roll_buffers_backwards
+        bm.roll_buffers_backwards
+      when :kill_buffer
+        bm.kill_buffer_safely bm.focus_buf
+      when :list_buffers
+        bm.spawn_unless_exists("Buffer List") { BufferListMode.new }
+      when :list_contacts
+        b = bm.spawn_unless_exists("Contact List") { ContactListMode.new }
+        b.mode.load_in_background
+      when :search
+        text = bm.ask :search, "query: "
+        next unless text && text !~ /^\s*$/
+
+        begin
+          qobj = Index.parse_user_query_string text
+          short_text = text.length < 20 ? text : text[0 ... 20] + "..."
+          log "built query from #{text.inspect}: #{qobj}"
+          mode = SearchResultsMode.new qobj
+          bm.spawn "search: \"#{short_text}\"", mode
+          mode.load_threads :num => mode.buffer.content_height
+        rescue Ferret::QueryParser::QueryParseException => e
+          bm.flash "Couldn't parse query."
+        end
+      when :list_labels
+        labels = LabelManager.listable_label_strings
+        user_label = bm.ask_with_completions :label, "Show threads with label (enter for listing): ", labels
+        user_label = bm.spawn_modal("Label list", LabelListMode.new) if user_label && user_label.empty?
+        
+        label = LabelManager.label_for user_label if user_label
+        case label
+        when nil
+        when :inbox
+          BufferManager.raise_to_front InboxMode.instance.buffer
+        else
+          b = BufferManager.spawn_unless_exists("All threads with label '#{user_label}'") do
+            mode = LabelSearchResultsMode.new([label])
           end
-        when :nothing
-        when :redraw
-          bm.completely_redraw_screen
+          b.mode.load_threads :num => b.content_height
+        end
+
+      when :compose
+        mode = ComposeMode.new
+        bm.spawn "New Message", mode
+        mode.edit
+      when :poll
+        #          bm.raise_to_front PollManager.buffer
+        reporting_thread { PollManager.poll }
+      when :recall_draft
+        case Index.num_results_for :label => :draft
+        when 0
+          bm.flash "No draft messages."
+        when 1
+          m = nil
+          Index.each_id_by_date(:label => :draft) { |mid, builder| m = builder.call }
+          r = ResumeMode.new(m)
+          BufferManager.spawn "Edit message", r
+          r.edit
         else
-          bm.flash "Unknown key press '#{c.to_character}' for #{bm.focus_buf.mode.name}."
+          b = BufferManager.spawn_unless_exists("All drafts") do
+            mode = LabelSearchResultsMode.new [:draft]
+          end
+          b.mode.load_threads :num => b.content_height
         end
+      when :nothing
+      when :redraw
+        bm.completely_redraw_screen
+      else
+        bm.flash "Unknown key press '#{c.to_character}' for #{bm.focus_buf.mode.name}."
       end
     end
+
+    bm.draw_screen
   end
 rescue Exception => e
   $exception ||= e
 ensure
+  unless $opts[:no_threads]
+    PollManager.stop if PollManager.instantiated?
+    SuicideManager.stop if PollManager.instantiated?
+    Index.stop_lock_update_thread
+  end
+
   Redwood::finish
   stop_cursing
-  if $exception
-    Redwood::log "oh crap, an exception"
+  Redwood::log "stopped cursing"
+
+  if SuicideManager.instantiated? && SuicideManager.die?
+    Redwood::log "I've been ordered to commit sepuku. I obey!"
+  end
+
+  case $exception
+  when nil
+    Redwood::log "no fatal errors. good job, william."
+    Index.save
   else
-    Redwood::log "good night, sweet prince!"
+    Redwood::log "oh crap, an exception"
   end
-end
 
-Index.save unless $exception # TODO: think about this
+  Index.unlock
+end
 
 if $exception 
   $stderr.puts <<EOS
@@ -222,14 +300,14 @@ if $exception
 I'm very sorry, but it seems that an error occurred in Sup. 
 Please accept my sincere apologies. If you don't mind, please
 send the backtrace below and a brief report of the circumstances
-to wmorgan-sup at masanjin dot nets so that I might address this
+to sup-talk at rubyforge dot orgs so that I might address this
 problem. Thank you!
 
 Sincerely,
 William
 ----------------------------------------------------------------
 
-The problem was: #{$exception.message} (error type #{$exception.class.name})
+The problem was: '#{$exception.message}' (error type #{$exception.class.name})
 A backtrace follows:
 EOS
   raise $exception