sup 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.0.2 / 2006-12-10
+
+* IMAP support
+* Better handling of broken sources. (Everything won't just die.)
+* You will need to rebuild both your index, and sources.yaml.
+  Sorry!
+
 == 0.0.1 / 2006-11-28
 
 * Initial release. Unix-centrism, support for mbox only, no i18n.

data/Manifest.txt

@@ -49,4 +49,6 @@ lib/sup/buffer.rb
 lib/sup/sent.rb
 lib/sup/tagger.rb
 lib/sup/colormap.rb
+lib/sup/source.rb
+lib/sup/imap.rb
 lib/sup.rb

data/README.txt

@@ -31,16 +31,15 @@ Features:
   message level. Entire threads are manipulated and viewed (with
   redundancies removed) at a time.
 
-- Labels over folders. Drop that tired old metaphor and you'll see how
-  much easier it is to organize email.
+- Labels instead of folders. Drop that tired old metaphor and you'll
+  see how much easier it is to organize email.
 
 - GMail-style thread management.  Archive a thread, and it will
   disappear from your inbox until someone replies. Kill a thread, and
   it will never come back to your inbox. (But it will still show up in
   searches, of course.)
 
-- Console based, so instantaneous response to interaction. No mouse
-  clicking required!
+- Console based interface. No mouse clicking required!
 
 - Programmability. It's in Ruby. The code is good. It's easy to
   extend.
@@ -48,39 +47,45 @@ Features:
 - Multiple buffer support. Why be limited to viewing one thread at a
   time?
 
-- Automatic context-sensitive help.
-
-- Message tagging and multi-message tagged operations.
-
-- Mutt-style MIME attachment viewing.
+- Tons of other little features, like automatic context-sensitive
+  help, multi-message operations, MIME attachment viewing, recent
+  contact list generation, etc.
 
 Current limitations which will be fixed:
 
-- Support for mbox ONLY at this point. No support for POP, IMAP, and
-  GMail accounts.
+- Support for mbox and IMAP only at this point. No support for POP, mh,
+  or GMail mailstores.
 
 - No internationalization support. No wide characters, no subject
   demangling. 
 
-- No GMail-style filters.
+- Unix-centrism in MIME attachment handling and in sendmail
+  invocation.
 
-- Unix-centrism in MIME attachment handling.
+- Several obvious missing features, like undo, filters / saved
+  searches, message annotations, etc.
 
 == SYNOPSYS:
 
-  1. sup-import <mbox filename>+
+  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), or an imap or imaps
+  url. In the case of imap, don't put the username and password in
+  the URI (which is a terrible, terrible idea). You will be prompted
+  for them.
+
   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.
 
-  Note that Sup *never* changes the contents of any mailboxes. So it
-  shouldn't ever corrupt your mail. The flip side is that if you
-  change a mailbox (e.g. delete or read messages) then Sup may crash,
+  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 may crash,
   and will tell you to run sup-import --rebuild to recalculate the
-  offsets within the mailbox have changed.
+  offsets within the mailbox.
 
 == REQUIREMENTS:
 
@@ -93,10 +98,9 @@ Current limitations which will be fixed:
 * gem install sup -y
 * Then, in rmail, change line 159 of multipart.rb to:
     chunk = chunk[0..start]
-  (Sorry. it's an unsupported package.) You might be able to get away
+  (Sorry; it's an unsupported package.) You might be able to get away
   without doing this but if you get frozen string exceptions when
-  reading in multipart email messages, this is what you need to
-  change.
+  reading in multipart messages, this is what you need to change.
 
 == LICENSE:
 

data/bin/sup

@@ -1,4 +1,4 @@
-#!/bin/env ruby
+#!/usr/bin/env ruby
 
 require 'rubygems'
 require 'ncurses'
@@ -7,6 +7,17 @@ require "sup"
 module Redwood
 
 $exception = nil
+def reporting_thread
+  ::Thread.new do
+    begin
+      yield
+    rescue Exception => e
+      $exception ||= e
+      raise
+    end
+  end
+end
+module_function :reporting_thread
 
 global_keymap = Keymap.new do |k|
   k.add :quit, "Quit Redwood", 'q'
@@ -99,15 +110,6 @@ begin
   log "initializing buffer manager"
   bm = BufferManager.new
 
-  if Index.usual_sources.any? { |s| !s.done? }
-    log "polling for new mail"
-    pmode = PollMode.new
-    pbuf = bm.spawn "load new messages", pmode
-    pmode.poll
-#    sleep 1
-#    bm.kill_buffer pbuf
-  end
-
   log "initializing mail index buffer"
   imode = InboxMode.new
   ibuf = bm.spawn "inbox", imode
@@ -118,6 +120,8 @@ begin
   bm.draw_screen
   imode.load_more_threads ibuf.content_height
 
+  reporting_thread { sleep 3; PollManager.poll }
+
   until $exception
     bm.draw_screen
     c = Ncurses.nonblocking_getch
@@ -139,7 +143,7 @@ begin
         when :roll_buffers_backwards
           bm.roll_buffers_backwards
         when :kill_buffer
-          bm.kill_buffer bm.focus_buf unless bm.focus_buf.mode.is_a? InboxMode
+          bm.kill_buffer bm.focus_buf if bm.focus_buf.mode.killable?
         when :list_buffers
           bm.spawn_unless_exists("Buffer List") { BufferListMode.new }
         when :list_contacts
@@ -168,10 +172,8 @@ begin
           bm.spawn "new message", mode
           mode.edit
         when :poll
-          b = BufferManager.spawn_unless_exists("load new messages") do
-            PollMode.new
-          end
-          b.mode.poll
+          BufferManager.raise_to_front PollManager.buffer
+          PollManager.poll
         when :nothing
         when :redraw
           bm.completely_redraw_screen
@@ -193,21 +195,25 @@ end
 Index.save unless $exception # TODO: think about this
 
 if $exception 
-  if $exception.is_a? IndexError
+  case $exception
+  when IndexError
     $stderr.puts <<EOS
-An error occurred while loading a message from source "#{$exception.source}".
+An error occurred while parsing a message from source:
+   #{$exception.source}.
 Typically, this means that the source has been modified in some
-way which has rendered the messages invalid.
+way which has rendered the messages invalid. For example, if it's
+an mbox file, you may have read or deleted messages using another
+mail client.
 
 You must rebuild the index for this source. Please run:
   sup-import --rebuild #{$exception.source}
 to correct this error.
 EOS
-  raise $exception                             
+#' stupid ruby-mode
   else
     $stderr.puts <<EOS
------------------------------------------------------------------
-I'm very sorry, but it seems that an error occurred in Redwood. 
+----------------------------------------------------------------
+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 user wmorgan-sup at site masanjin dot net so that I might
@@ -215,15 +221,13 @@ address this problem. Thank you!
 
 Sincerely,
 William
------------------------------------------------------------------
+----------------------------------------------------------------
 
 The problem was: #{$exception.message} (error type #{$exception.class.name})
 A backtrace follows:
 EOS
-    raise $exception
   end
+  raise $exception
 end
 
-
 end
-

data/bin/sup-import

@@ -1,4 +1,4 @@
-#!/bin/env ruby
+#!/usr/bin/env ruby
 
 require "sup"
 
@@ -27,7 +27,7 @@ source list.
 Usage:
   sup-import [options] <source>*
 where <source>* is zero or more source descriptions (e.g., mbox
-filenames on disk). 
+filenames on disk, or imap/imaps URIs). 
 
 If the sources listed are not already in the Sup source list,
 they will be added to it, as parameterized by the following options:
@@ -54,7 +54,6 @@ The following options can also be specified:
   --optimize:      optimize the index after adding any new messages.
   --help:          don't do anything, just show this message.
 EOS
-#' stupid ruby-mode
   exit
 end
 
@@ -68,6 +67,12 @@ the_usual = ARGV.delete "--the-usual"
 rebuild = ARGV.delete "--rebuild"
 force_rebuild = ARGV.delete "--force-rebuild"
 optimize = ARGV.delete "--optimize"
+start_at = # ok really need to use optparse or something now
+  if(i = ARGV.index("--start-at"))
+    raise "start-at requires a numeric argument: #{ARGV[i + 1].inspect}" unless ARGV.length > (i + 1) && ARGV[i + 1] =~ /\d/
+    ARGV.delete_at i
+    ARGV.delete_at(i).to_i # whoa!
+  end
 
 if(o = ARGV.find { |x| x =~ /^--/ })
   $stderr.puts "error: unknown option #{o}"
@@ -77,24 +82,45 @@ end
 puts "loading index..."
 index = Redwood::Index.new
 index.load
-pre_nm = index.size
 puts "loaded index of #{index.size} messages"
 
 sources = ARGV.map do |fn|
+  fn = "mbox://#{fn}" unless fn =~ %r!://!
   source = index.source_for fn
   unless source
-    source = Redwood::MBox::Loader.new(fn, 0, !unusual, !!archive)
+    source = 
+      case fn
+      when %r!^imaps?://!
+        print "Username for #{fn}: "
+        username = $stdin.gets.chomp
+        print "Password for #{fn} (warning: cleartext): "
+        password = $stdin.gets.chomp
+        Redwood::IMAP.new(fn, username, password, nil, !unusual, !!archive)
+      else
+        Redwood::MBox::Loader.new(fn, nil, !unusual, !!archive)
+      end
     index.add_source source
   end
   source
 end
+
 sources = (sources + index.usual_sources).uniq if the_usual
-sources.each { |s| s.reset! } if rebuild || force_rebuild
+if rebuild || force_rebuild
+  if start_at
+    sources.each { |s| s.seek_to! start_at }
+  else
+    sources.each { |s| s.reset! }
+  end
+end
 
 found = {}
 start = Time.now
 begin
   sources.each do |source|
+    if source.broken?
+      puts "error loading messages from #{source}: #{source.broken_msg}"
+      next
+    end
     next if source.done?
     puts "loading from #{source}... "
     num = 0
@@ -104,15 +130,15 @@ begin
       labels -= [:inbox] if force_archive
       labels -= [:unread] if force_read
       begin
-        m = Redwood::Message.new source, offset, labels
+        m = Redwood::Message.new :source => source, :source_info => offset, :labels => labels
         if found[m.id]
           puts "skipping duplicate message #{m.id}"
           next
         else
           found[m.id] = true
         end
-
-        m.remove_label :unread if m.mbox_status == "RO" unless force_read
+        m.remove_label :unread if m.status == "RO" unless force_read
+        puts "# message at #{offset}, labels: #{labels * ', '}" unless rebuild || force_rebuild
         if (rebuild || force_rebuild) && 
             (docid, entry = index.load_entry_for_id(m.id)) && entry
           if force_rebuild || entry[:source_info].to_i != offset
@@ -123,7 +149,7 @@ begin
         else
           num += 1 if index.add_message m
         end
-      rescue Redwood::MessageFormatError => e
+      rescue Redwood::MessageFormatError, Redwood::SourceError => e
         $stderr.puts "ignoring erroneous message at #{source}##{offset}: #{e.message}"
       end
       if num % 1000 == 0 && num > 0
@@ -141,18 +167,22 @@ end
 
 if rebuild || force_rebuild
   puts "deleting missing messages from the index..."
-  numdel = 0
+  numdel = num = 0
   sources.each do |source|
     raise "no source id for #{source}" unless source.id
-    index.index.search_each("source_id:#{source.id}", :limit => :all) do |docid, score|
+    q = "+source_id:#{source.id}"
+    q += " +source_info: >= #{start_at}" if start_at
+    #p q
+    num += index.index.search_each(q, :limit => :all) do |docid, score|
       mid = index.index[docid][:message_id]
       next if found[mid]
       puts "deleting #{mid}"
       index.index.delete docid
       numdel += 1
     end
+    #p num
   end
-  puts "deleted #{numdel} messages"
+  puts "deleted #{numdel} / #{num} messages"
 end
 
 if optimize

data/doc/FAQ.txt

@@ -1,5 +1,7 @@
 Sup FAQ
 -------
+Q: What does Sup stand for?
+A: "What's up?".
 
 Q: How is Sup even possible?
 A: Sup is only possible through the hard work of Dave Balmain, the
@@ -7,17 +9,17 @@ A: Sup is only possible through the hard work of Dave Balmain, the
 
    I started using Ferret when it was still slightly buggy, and it
    seemed like every week Dave released a bugfix or a speed
-   improvement that directly affected sup.  Ferret has become a
-   first-class piece of software, and it's almost entirely due to him.
-   It amazes me just how much time and effort he has put into it.
+   improvement that directly affected sup. Ferret has become a
+   first-class piece of software, and it's due to the tremendous
+   amount of time and effort he's put in to it.
 
 Q: Why the console?
 A: As the millions (ok, hundreds) of mutt users will tell you, there are
    many advantages to the console:
-   - You don't need a bulky web browser.
-   - You can ssh and check your mail on another machine.
+   - You don't need web browser.
    - Instantaneous interaction.
-   - A few keystrokes are worth a hundred mouse clicks.
+   - A few keystrokes can accomplish the work of a hundred mouse
+     clicks.
 
 Q: If you love GMail so much, why not just use it?
 A: I hate using a mouse, and I hate ads, and I hate non-programmability.

data/doc/Philosophy.txt

@@ -1,6 +1,6 @@
-Must an email client have a philosophy? I think so. For many people,
-it is our primary means of communication. Something so important
-should warrant a little thought.
+Should an email client have a philosophy? I think so. For many people,
+email is our primary means of communication. Something so important
+ought to warrant a little thought.
 
 So here's Sup's philosophy.
 
@@ -8,10 +8,10 @@ Using "traditional" email clients today is increasingly problematic.
 Anyone who's on a high-traffic mailing list knows this.  My ruby-talk
 folder is 350 megs and Mutt sits there for 60 seconds while it opens
 it. Keeping up with the all the new traffic is painful, even with
-Mutt's excellent threading features, just because there's so much of
-it. A single thread can span several pages.  And Mutt is probably the
-best email client out there in terms of threading and mailing list
-support.
+Mutt's excellent threading features, simply because there's so much of
+it---a single thread can span several pages, and God help you if you
+lag behind. And Mutt is probably the best email client out there in
+terms of threading and mailing list support.
 
 The principle problem with traditional clients is that they place a
 high mental cost on the user for each incoming email, by forcing them
@@ -29,15 +29,16 @@ to answer.
 As a long-time Mutt user, when I watched people use GMail, I saw them
 use email differently from how I had ever used it. I saw that making
 certain operations quantitatively easier (namely, search) resulted in
-a qualitative difference in usage (and for the better!). I saw that
-thread-centrism had many advantages over message-centrism.
+a qualitative difference in usage. And I saw that thread-centrism had
+many advantages over message-centrism, especially when volume was high.
 
 So, in many ways, I believe GMail has taken the right approach to
 handle both of the factors above, and much of the inspiration for Sup
-was based on using GMail. Of course, I don't ultimately like using
-GMail, which is why I created Sup in the first place.
+was based on GMail. Ultimately, GMail wasn't right for me, which is
+why the idea for Sup was born.
 
-Sup is based on the following principles, which I learned from GMail:
+Sup is based on the following principles, which I more or less stole
+directly from GMail:
 
 - An immediately accessible and fast search capability over the
   entire email archive eliminates most of the need for folders,
@@ -50,10 +51,8 @@ Sup is based on the following principles, which I learned from GMail:
   and its content deserve the same treatment in the vast majority
   of cases.
 
-Sup is also based on many ideas from mutt (and Emacs and vi!), having
-to do with the fantastic productivity of a console- and key-based
-application, and the usefulness of multiple buffers, etc., and the
-necessity of handling multiple email accounts, but these features form
-less of the philosophy and more of the general usefulness of Sup.
-
+Sup is also based on many ideas from mutt and Emacs and vi, having to
+do with the fantastic productivity of a console- and keyboard-based
+application, the usefulness of multiple buffers, the necessity of
+handling multiple email accounts, etc.