sup 0.0.1

data/Rakefile

@@ -0,0 +1,45 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/sup.rb'
+
+Hoe.new('sup', Redwood::VERSION) do |p|
+  p.rubyforge_name = 'sup'
+  p.author = "William Morgan"
+  p.summary = 'A console-based email client with the best features of GMail, mutt, and emacs. Features full text search, labels, tagged operations, multiple buffers, recent contacts, and more.'
+  p.description = p.paragraphs_of('README.txt', 2..4).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[2].gsub(/^\s+/, "")
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.email = "wmorgan-sup@masanjin.net"
+  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17']]
+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)
+
+SCREENSHOTS = FileList["www/ss?.png"]
+SCREENSHOTS_SMALL = []
+SCREENSHOTS.each do |fn|
+  fn =~ /ss(\d+)\.png/
+  sfn = "www/ss#{$1}-small.png"
+  file sfn => [fn] do |t|
+    sh "cat #{fn} | pngtopnm | pnmscale -xysize 320 240 | pnmtopng > #{sfn}"
+  end
+  SCREENSHOTS_SMALL << sfn
+end
+
+task :upload_webpage => WWW_FILES do |t|
+  sh "scp -C #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/sup/"
+end
+
+task :upload_webpage_images => (SCREENSHOTS + SCREENSHOTS_SMALL) do |t|
+  sh "scp -C #{t.prerequisites * ' '} wmorgan@rubyforge.org:/var/www/gforge-projects/sup/"
+end
+
+# vim: syntax=Ruby

data/bin/sup

@@ -0,0 +1,229 @@
+#!/bin/env ruby
+
+require 'rubygems'
+require 'ncurses'
+require "sup"
+
+module Redwood
+
+$exception = nil
+
+global_keymap = Keymap.new do |k|
+  k.add :quit, "Quit Redwood", 'q'
+  k.add :help, "Show help", 'H', '?'
+  k.add :roll_buffers, "Switch to next buffer", 'b'
+  k.add :roll_buffers_backwards, "Switch to previous buffer", 'B'
+  k.add :kill_buffer, "Kill the current buffer", 'x'
+  k.add :list_buffers, "List all buffers", 'A'
+  k.add :list_contacts, "List contacts", 'C'
+  k.add :redraw, "Redraw screen", :ctrl_l
+  k.add :search, "Search messages", '/'
+  k.add :list_labels, "List labels", 'L'
+  k.add :poll, "Poll for new messages", 'P'
+  k.add :compose, "Compose new message", 'm'
+end
+
+def start_cursing
+  Ncurses.initscr
+  Ncurses.noecho
+  Ncurses.cbreak
+  Ncurses.stdscr.keypad 1
+  Ncurses.curs_set 0
+  Ncurses.start_color
+end
+
+def stop_cursing
+  Ncurses.curs_set 1
+  Ncurses.echo
+  Ncurses.endwin
+end
+module_function :start_cursing, :stop_cursing
+
+Redwood::SentManager.new Redwood::SENT_FN
+Redwood::ContactManager.new Redwood::CONTACT_FN
+Redwood::LabelManager.new Redwood::LABEL_FN
+Redwood::AccountManager.new $config[:accounts]
+Redwood::DraftManager.new Redwood::DRAFT_DIR
+Redwood::UpdateManager.new
+Redwood::PollManager.new
+
+Index.new.load
+log "loaded #{Index.size} messages from index"
+
+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
+  
+begin
+  log "starting curses"
+  start_cursing
+
+  log "initializing colormap"
+  Colormap.new do |c|
+    c.add :status_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLUE, Ncurses::A_BOLD
+    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 :labellist_old_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK
+    c.add :labellist_new_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK, 
+           Ncurses::A_BOLD
+    c.add :twiddle_color, Ncurses::COLOR_BLUE, Ncurses::COLOR_BLACK
+    c.add :label_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK
+    c.add :message_patina_color, Ncurses::COLOR_BLACK, Ncurses::COLOR_GREEN
+    c.add :mime_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
+    c.add :sig_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK
+    c.add :to_me_color, Ncurses::COLOR_GREEN, Ncurses::COLOR_BLACK
+    c.add :starred_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK,
+          Ncurses::A_BOLD
+    c.add :starred_patina_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_GREEN,
+          Ncurses::A_BOLD
+    c.add :snippet_color, Ncurses::COLOR_CYAN, Ncurses::COLOR_BLACK
+    c.add :option_color, Ncurses::COLOR_WHITE, Ncurses::COLOR_BLACK
+    c.add :tagged_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK,
+          Ncurses::A_BOLD
+    c.add :draft_notification_color, Ncurses::COLOR_RED, Ncurses::COLOR_BLACK,
+          Ncurses::A_BOLD
+  end
+
+  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
+
+  log "ready for (inter)action!"
+  Logger.make_buf
+
+  bm.draw_screen
+  imode.load_more_threads ibuf.content_height
+
+  until $exception
+    bm.draw_screen
+    c = Ncurses.nonblocking_getch
+    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
+        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 bm.focus_buf unless bm.focus_buf.mode.is_a? InboxMode
+        when :list_buffers
+          bm.spawn_unless_exists("Buffer List") { BufferListMode.new }
+        when :list_contacts
+          mode = ContactListMode.new 
+          bm.spawn "compose to contacts", mode
+        when :search
+          text = bm.ask :search, "query: "
+          next unless text && text !~ /^\s*$/
+          mode = SearchResultsMode.new text
+          short_text = 
+            if text.length < 20
+              text
+            else
+              text[0 ... 20] + "..."
+            end
+          bm.spawn "search: \"#{short_text}\"", mode
+          bm.draw_screen
+          mode.load_more_threads mode.buffer.content_height
+        when :list_labels
+          b = BufferManager.spawn_unless_exists("all labels") do
+            LabelListMode.new
+          end
+          b.mode.load_in_background
+        when :compose
+          mode = ComposeMode.new
+          bm.spawn "new message", mode
+          mode.edit
+        when :poll
+          b = BufferManager.spawn_unless_exists("load new messages") do
+            PollMode.new
+          end
+          b.mode.poll
+        when :nothing
+        when :redraw
+          bm.completely_redraw_screen
+        else
+          BufferManager.flash "Unknown key press '#{c.to_character}' for #{bm.focus_buf.mode.name}."
+        end
+      end
+    end
+  end
+  bm.kill_all_buffers
+  Redwood::LabelManager.save
+  Redwood::ContactManager.save
+rescue Exception => e
+  $exception ||= e
+ensure
+  stop_cursing
+end
+
+Index.save unless $exception # TODO: think about this
+
+if $exception 
+  if $exception.is_a? IndexError
+    $stderr.puts <<EOS
+An error occurred while loading a message from source "#{$exception.source}".
+Typically, this means that the source has been modified in some
+way which has rendered the messages invalid.
+
+You must rebuild the index for this source. Please run:
+  sup-import --rebuild #{$exception.source}
+to correct this error.
+EOS
+  raise $exception                             
+  else
+    $stderr.puts <<EOS
+-----------------------------------------------------------------
+I'm very sorry, but it seems that an error occurred in Redwood. 
+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
+address this problem. Thank you!
+
+Sincerely,
+William
+-----------------------------------------------------------------
+
+The problem was: #{$exception.message} (error type #{$exception.class.name})
+A backtrace follows:
+EOS
+    raise $exception
+  end
+end
+
+
+end
+

data/bin/sup-import

@@ -0,0 +1,162 @@
+#!/bin/env ruby
+
+require "sup"
+
+class Float
+  def to_s; sprintf '%.2f', self; end
+end
+
+class Numeric
+  def to_time_s
+    i = to_i
+    sprintf "%d:%02d:%02d", i / 3600, (i / 60) % 60, i % 60
+  end
+end
+
+def time
+  startt = Time.now
+  yield
+  Time.now - startt
+end
+
+def educate_user
+  $stderr.puts <<EOS
+Loads messages into the Sup index, adding sources as needed to the
+source list.
+
+Usage:
+  sup-import [options] <source>*
+where <source>* is zero or more source descriptions (e.g., mbox
+filenames on disk). 
+
+If the sources listed are not already in the Sup source list,
+they will be added to it, as parameterized by the following options:
+  --archive: messages from these sources will not appear in the inbox
+  --unusual: these sources will not be polled when the flag --the-usual
+             is called
+
+Regardless of whether the sources are new or not, they will be polled,
+and any new messages will be added to the index, as parameterized by
+the following options:
+  --force-archive: regardless of the source "archive" flag, any new
+                   messages found will not appear in the inbox.
+  --force-read:    any messages found will not be marked as new.
+
+The following options can also be specified:
+  --the-usual:     import new messages from all usual sources
+  --rebuild:       rebuild the index for the specified sources rather than
+                   just adding new messages. Useful if the sources
+                   have changed in any way *other* than new messages
+                   being added.
+  --force-rebuild: force a rebuild of all messages in the inbox, not just
+                   ones that have changed. You probably won't need this
+                   unless William changes the index format.
+  --optimize:      optimize the index after adding any new messages.
+  --help:          don't do anything, just show this message.
+EOS
+#' stupid ruby-mode
+  exit
+end
+
+educate_user if ARGV.member? '--help'
+
+archive = ARGV.delete "--archive"
+unusual = ARGV.delete "--unusual"
+force_archive = ARGV.delete "--force-archive"
+force_read = ARGV.delete "--force-read"
+the_usual = ARGV.delete "--the-usual"
+rebuild = ARGV.delete "--rebuild"
+force_rebuild = ARGV.delete "--force-rebuild"
+optimize = ARGV.delete "--optimize"
+
+if(o = ARGV.find { |x| x =~ /^--/ })
+  $stderr.puts "error: unknown option #{o}"
+  educate_user
+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|
+  source = index.source_for fn
+  unless source
+    source = Redwood::MBox::Loader.new(fn, 0, !unusual, !!archive)
+    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
+
+found = {}
+start = Time.now
+begin
+  sources.each do |source|
+    next if source.done?
+    puts "loading from #{source}... "
+    num = 0
+    start_offset = nil
+    source.each do |offset, labels|
+      start_offset ||= offset
+      labels -= [:inbox] if force_archive
+      labels -= [:unread] if force_read
+      begin
+        m = Redwood::Message.new source, offset, 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
+        if (rebuild || force_rebuild) && 
+            (docid, entry = index.load_entry_for_id(m.id)) && entry
+          if force_rebuild || entry[:source_info].to_i != offset
+            puts "replacing message #{m.id} labels #{entry[:label].inspect} (offset #{entry[:source_info]} => #{offset})"
+            m.labels = entry[:label].split.map { |l| l.intern }
+            num += 1 if index.update_message m, source, offset
+          end
+        else
+          num += 1 if index.add_message m
+        end
+      rescue Redwood::MessageFormatError => e
+        $stderr.puts "ignoring erroneous message at #{source}##{offset}: #{e.message}"
+      end
+      if num % 1000 == 0 && num > 0
+        elapsed = Time.now - start
+        pctdone = (offset.to_f - start_offset) / (source.total.to_f - start_offset)
+        remaining = (source.total.to_f - offset.to_f) * (elapsed.to_f / (offset.to_f - start_offset))
+        puts "## #{num} (#{(pctdone * 100.0)}% done) read; #{elapsed.to_time_s} elapsed; est. #{remaining.to_time_s} remaining"
+      end
+    end
+    puts "loaded #{num} messages" unless num == 0
+  end
+ensure
+  index.save
+end
+
+if rebuild || force_rebuild
+  puts "deleting missing messages from the index..."
+  numdel = 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|
+      mid = index.index[docid][:message_id]
+      next if found[mid]
+      puts "deleting #{mid}"
+      index.index.delete docid
+      numdel += 1
+    end
+  end
+  puts "deleted #{numdel} messages"
+end
+
+if optimize
+  puts "optimizing index..."
+  optt = time { index.index.optimize }
+  puts "optimized index of size #{index.size} in #{optt}s."
+end

data/doc/FAQ.txt

@@ -0,0 +1,38 @@
+Sup FAQ
+-------
+
+Q: How is Sup even possible?
+A: Sup is only possible through the hard work of Dave Balmain, the
+   author of ferret.
+
+   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.
+
+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.
+   - Instantaneous interaction.
+   - A few keystrokes are worth 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.
+
+Q: How does Sup deal with spam?
+A: You can manually mark messages as spam, which prevents them from
+   showing up in future searches, but that's all that Sup does. Spam
+   filtering should be done by a dedicated tool like SpamAssassin.
+
+Q: What are all these "Redwood" references I see in the code?
+A: That was Sup's original name. (Think pine, elm. Although I am a
+   Mutt user, I couldn't think of a good progression there.) But it was
+   taken by another project on RubyForge, and wasn't that original,
+   and was too long to type anyways.
+
+   Maybe one day I'll do a huge search-and-replace on the code, but it
+   doesn't seem that important at this point.
+