sup 0.2 → 0.3

data/History.txt

@@ -1,3 +1,13 @@
+== 0.3 / 2007-10-29
+* In-buffer search (finally!)
+* Subscribe to/unsubscribe from mailing list commands.
+* IMAP speedups.
+* More hooks: set status bar, set terminal title bar, modify message headers
+  and bodies before editing, etc.
+* Optionally use chronic gem to allow for natural-language dates in searches.
+* Many, many bugfixes and minor improvements.
+* Tomorrow is Sup's first birthday!
+
 == 0.2 / 2007-10-29
 * Complete hook system for user-inserted code.
 * GPG signature verification and decryption.

data/bin/sup

@@ -7,6 +7,7 @@ require 'fileutils'
 require 'trollop'
 require "sup"
 
+$exceptions = []
 $opts = Trollop::options do
   version "sup v#{Redwood::VERSION}"
   banner <<EOS
@@ -19,6 +20,7 @@ Options are:
 EOS
   opt :list_hooks, "List all hooks and descriptions thereof, and quit."
   opt :no_threads, "Turn of threading. Helps with debugging. (Necessarily disables background polling for new messages.)"
+  opt :search, "Search for threads ", :type => String
 end
 
 if $opts[:list_hooks]
@@ -39,10 +41,11 @@ global_keymap = Keymap.new do |k|
   k.add :list_buffers, "List all buffers", 'B'
   k.add :list_contacts, "List contacts", 'C'
   k.add :redraw, "Redraw screen", :ctrl_l
-  k.add :search, "Search messages", '/'
+  k.add :search, "Search all messages", '\\', 'F'
   k.add :list_labels, "List labels", 'L'
   k.add :poll, "Poll for new messages", 'P'
-  k.add :compose, "Compose new message", 'm'
+  k.add :compose, "Compose new message", 'm', 'c'
+  k.add :nothing, "Do nothing", :ctrl_g
   k.add :recall_draft, "Edit most recent draft message", 'R'
 end
 
@@ -92,26 +95,26 @@ EOS
 end
 
 begin
-  extend CanSpawnComposeMode
   Redwood::start
   Index.load
 
   if(s = Index.source_for DraftManager.source_name)
     DraftManager.source = s
   else
+    Redwood::log "no draft source, auto-adding..."
     Index.add_source DraftManager.new_source
   end
 
   if(s = Index.source_for SentManager.source_name)
     SentManager.source = s
   else
+    Redwood::log "no sent mail source, auto-adding..."
     Index.add_source SentManager.new_source
   end
 
   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
@@ -154,9 +157,9 @@ begin
     c.add :reply_mode_selected_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_BLACK, Ncurses::A_BOLD
     c.add :reply_mode_unselected_color, Ncurses::COLOR_CYAN, Ncurses::COLOR_BLACK
     c.add :reply_mode_label_color, Ncurses::COLOR_CYAN, Ncurses::COLOR_BLACK
+    c.add :search_highlight_color, Ncurses::COLOR_BLACK, Ncurses::COLOR_YELLOW, Ncurses::A_BOLD, :highlight => :search_highlight_color
   end
 
-  log "initializing buffer manager"
   bm = BufferManager.new
 
   log "initializing mail index buffer"
@@ -168,24 +171,18 @@ begin
 
   bm.draw_screen
 
-  begin
-    Index.usual_sources.each { |s| s.check }
-  rescue SourceError
-    # do nothing! we'll report it at the next step
-  end
-  Redwood::report_broken_sources
-  
   Index.usual_sources.each do |s|
-    reporting_thread do
+    next unless s.respond_to? :connect
+    reporting_thread("call #connect on #{s}") do
       begin
         s.connect
       rescue SourceError => e
         Redwood::log "fatal error loading from #{s}: #{e.message}"
       end
-    end if s.respond_to? :connect
+    end
   end
-
-  imode.load_threads :num => ibuf.content_height, :when_done => lambda { reporting_thread { sleep 1; PollManager.poll } unless $opts[:no_threads] }
+  
+  imode.load_threads :num => ibuf.content_height, :when_done => lambda { reporting_thread("poll after loading inbox") { sleep 1; PollManager.poll } unless $opts[:no_threads] }
 
   unless $opts[:no_threads]
     PollManager.start
@@ -193,7 +190,11 @@ begin
     Index.start_lock_update_thread
   end
 
-  until $exception || SuicideManager.die?
+  if $opts[:search]
+    SearchResultsMode.spawn_from_query $opts[:search]
+  end
+
+  until $exceptions.nonempty? || SuicideManager.die?
     c = Ncurses.nonblocking_getch
     next unless c
     bm.erase_flash
@@ -215,48 +216,26 @@ begin
       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
+        b, new = bm.spawn_unless_exists("Contact List") { ContactListMode.new }
+        b.mode.load_in_background if new
       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
+        query = BufferManager.ask :search, "search all messages: "
+        next unless query && query !~ /^\s*$/
+        SearchResultsMode.spawn_from_query query
       when :list_labels
         labels = LabelManager.listable_labels.map { |l| LabelManager.string_for l }
         user_label = bm.ask_with_completions :label, "Show threads with label (enter for listing): ", labels
-        user_label =
-          case user_label
-          when nil, /^\s*$/
-            bm.spawn_modal("Label list", LabelListMode.new) if user_label && user_label.empty?
+        unless user_label.nil?
+          if user_label.empty?
+            bm.spawn_unless_exists("Label list") { LabelListMode.new } if user_label && user_label.empty?
           else
-            LabelManager.label_for user_label
+            LabelSearchResultsMode.spawn_nicely user_label
           end
-        
-        case user_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([user_label])
-          end
-          b.mode.load_threads :num => b.content_height
         end
-
       when :compose
-        spawn_compose_mode
+        ComposeMode.spawn_nicely
       when :poll
-        reporting_thread { PollManager.poll }
+        reporting_thread("user-invoked poll") { PollManager.poll }
       when :recall_draft
         case Index.num_results_for :label => :draft
         when 0
@@ -268,23 +247,21 @@ begin
           BufferManager.spawn "Edit message", r
           r.edit_message
         else
-          b = BufferManager.spawn_unless_exists("All drafts") do
-            mode = LabelSearchResultsMode.new [:draft]
-          end
-          b.mode.load_threads :num => b.content_height
+          b, new = BufferManager.spawn_unless_exists("All drafts") { LabelSearchResultsMode.new [:draft] }
+          b.mode.load_threads :num => b.content_height if new
         end
       when :nothing
       when :redraw
         bm.completely_redraw_screen
       else
-        bm.flash "Unknown key press '#{c.to_character}' for #{bm.focus_buf.mode.name}."
+        bm.flash "Unknown keypress '#{c.to_character}' for #{bm.focus_buf.mode.name}."
       end
     end
 
     bm.draw_screen
   end
 rescue Exception => e
-  $exception ||= e
+  $exceptions << [e, "main"]
 ensure
   unless $opts[:no_threads]
     PollManager.stop if PollManager.instantiated?
@@ -300,8 +277,7 @@ ensure
     Redwood::log "I've been ordered to commit sepuku. I obey!"
   end
 
-  case $exception
-  when nil
+  if $exceptions.empty?
     Redwood::log "no fatal errors. good job, william."
     Index.save
   else
@@ -311,23 +287,29 @@ ensure
   Index.unlock
 end
 
-if $exception 
+unless $exceptions.empty?
+  File.open("sup-exception-log.txt", "w") do |f|
+    $exceptions.each do |e, name|
+      f.puts "--- #{e.class.name} from thread: #{name}"
+      f.puts e.message, e.backtrace
+    end
+  end
   $stderr.puts <<EOS
 ----------------------------------------------------------------
-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 sup-talk at rubyforge dot orgs so that I might address this
-problem. Thank you!
+I'm very sorry. It seems that an error occurred in Sup. Please
+accept my sincere apologies. If you don't mind, please send the
+contents of sup-exception-log.txt and a brief report of the
+circumstances 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})
-A backtrace follows:
 EOS
-  raise $exception
+  $exceptions.each do |e, name|
+    puts "--- #{e.class.name} from thread: #{name}"
+    puts e.message, e.backtrace
+  end
 end
 
 end

data/doc/NewUserGuide.txt

@@ -135,20 +135,24 @@ scrollable list of all the labels you've ever used, along with some
 special labels (Draft, Starred, Sent, Spam, etc.). Highlight a label
 and press enter to view all the messages with that label.
 
-What you just did was actually a specific search. For a general
-search, press "/". Now type in your query (again, Ctrl-G to cancel at
-any point.) You can just type in arbitrary text, which will be matched
-on a per-word basis against the bodies of all email in the index, or
-you can make use of the full Ferret query syntax:
+What you just did was actually a specific search. For a general search,
+press "\" (backslash---forward slash is used for in-buffer search,
+following console conventions). Now type in your query (again, Ctrl-G to
+cancel at any point.) You can just type in arbitrary text, which will be
+matched on a per-word basis against the bodies of all email in the
+index, or you can make use of the full Ferret query syntax:
 
 - Phrasal queries using double-quotes, e.g.: "three contiguous words"
 - Queries against a particular field using <field name>:<query>,
   e.g.: label:ruby-talk, or from:matz@ruby-lang.org. (Fields include:
   body, from, to, and subject.)
-- Force non-occurrence by -, e.g. -body:"hot soup"
+- Force non-occurrence by -, e.g. -body:"hot soup".
+- If you have the chronic gem installed, date queries like
+  "before:today", "on:today", "after:yesterday", "after:(2 days ago)"
+  (parentheses required for multi-word descriptions).
 
 You can combine those all together. For example:
-     label:ruby-talk subject:\[ANN\] -rails
+     label:ruby-talk subject:\[ANN\] -rails on:today
 
 Play around with the search, and see the Ferret documentation for
 details on more sophisticated queries (date ranges, "within n words",

data/doc/TODO

@@ -1,43 +1,37 @@
-for 0.2
--------
-
-x bugfix: contacts.txt isn't parsed correctly when there are spaces in
-   aliases
-x bugfix: @ signs in names make sendmail die silently
-x bugfix: sent.mbox and >From
-x bugfix: tokenized email addresses (amazon.com, etc)
-x bugfix: trailing spaces in buffermanager.ask
-x bugfix: need to URL-unescape maildir folders
-x bugfix: downcasing tab completion
-x warnings: top-posting, missing attachment
-x hookability
-
-for 0.3
+for 0.4
 -------
 _ mark thread as unread should remember the unread messages and mark
-   only them as unread, just like gmail
+  only them as unread, just like gmail
 _ mark thread as unread should have a version within thread-view-mode
-   which then also closes the buffer
+  which then also closes the buffer
 _ bugfix: time zone parsing broken?
-_ mailing list auto-subscribe/unsubscribe
 _ forwards optionally include attachments
 _ attach messages
 _ flesh out gpg integration: sign & encrypt outgoing
-_ mbox: don't keep filehandles open, and protect all reads with dotlockfile
+_ mbox: don't keep filehandles open, and protect all reads with
+  dotlockfile
+_ imap: share connection to the same server.
 _ bugfix: screwing with the headers when editing causes a crash
 _ need a better way to force an address to a particular name,
-   for things like evite addresses
+  for things like evite addresses
 _ pressing A in thread-view-mode should jump to next message
 _ imap "add all folders on this server" option in sup-add
 _ for new message flashes, add new message counts until keypress
 _ bugfix: missing sources should be handled better
 _ search results: highlight relevant snippets and open to relevant
-   portion of thread
+  portion of thread
 _ have "notes" (treated as emails to oneself, never sent) as
-   first-class objects.
+  first-class objects.
 
 future
 ------
+_ ldbd support
+_ don't use a people.txt; store email addresses directly in the index. too many
+  problems with email addresses that occur with multiple names.
+_ infix match instead of prefix match for tab completion (maybe!)
+_ fix killed threads contributing to unread message count problem (prob. need
+  to maintain all killed message ids and our own unread message count for
+  inbox).
 _ emlx support (some os x thing)
 _ tab completion for mid-text cursors
 _ bugfix: not horizontal scrolling for ncurses text field entry
@@ -83,6 +77,24 @@ x gmail support: obsoleted by imap
 
 done
 ----
+x multi-thread dump upon crash
+x hook manager caches values of any proc "variables"
+x bugfix: remove delay on startup if a usual imap source exists
+x bugfix: broken source handling still needs to be improved
+x speed up querying
+x bugfix: sources sometimes aren't added by sup-add
+x more widgets: terminal title, statusbar
+x mailing list auto-subscribe/unsubscribe
+x bugfix: contacts.txt isn't parsed correctly when there are spaces in
+   aliases
+x bugfix: @ signs in names make sendmail die silently
+x bugfix: sent.mbox and >From
+x bugfix: tokenized email addresses (amazon.com, etc)
+x bugfix: trailing spaces in buffermanager.ask
+x bugfix: need to URL-unescape maildir folders
+x bugfix: downcasing tab completion
+x warnings: top-posting, missing attachment
+x hookability
 x bugfix: deadlock (on rubyforge) (? still valid ?)
 x bugfix: ferret corrupt index problem at index.c:901. see http://ferret.davebalmain.com/trac/ticket/279
 x tab completion for to: and cc: in compose-mode

data/lib/sup.rb

@@ -32,7 +32,7 @@ class Module
 end
 
 module Redwood
-  VERSION = "0.2"
+  VERSION = "0.3"
 
   BASE_DIR   = ENV["SUP_BASE"] || File.join(ENV["HOME"], ".sup")
   CONFIG_FN  = File.join(BASE_DIR, "config.yaml")
@@ -60,8 +60,7 @@ module Redwood
     end
 
 ## record exceptions thrown in threads nicely
-  $exception = nil
-  def reporting_thread
+  def reporting_thread name
     if $opts[:no_threads]
       yield
     else
@@ -69,11 +68,8 @@ module Redwood
         begin
           yield
         rescue Exception => e
-          File.open("sup-exception-log.txt", "w") do |f|
-            f.puts "--- #{e.class.name} at #{Time.now}"
-            f.puts e.message, e.backtrace
-          end
-          $exception ||= e
+          $exceptions ||= []
+          $exceptions << [e, name]
           raise
         end
       end
@@ -124,12 +120,16 @@ module Redwood
   end
 
   ## not really a good place for this, so I'll just dump it here.
+  ##
+  ## a source error is either a FatalSourceError or an OutOfSyncSourceError.
+  ## the superclass SourceError is just a generic.
   def report_broken_sources opts={}
     return unless BufferManager.instantiated?
 
-    broken_sources = Index.usual_sources.select { |s| s.error.is_a? FatalSourceError }
+    broken_sources = Index.sources.select { |s| s.error.is_a? FatalSourceError }
     unless broken_sources.empty?
-      BufferManager.spawn "Broken source notification", TextMode.new(<<EOM), opts
+      BufferManager.spawn_unless_exists("Broken source notification for #{broken_sources.join(',')}", opts) do
+        TextMode.new(<<EOM)
 Source error notification
 -------------------------
 
@@ -140,11 +140,13 @@ be viewed, and new messages will not be detected.
 #{broken_sources.map { |s| "Source: " + s.to_s + "\n Error: " + s.error.message.wrap(70).join("\n        ")}.join("\n\n")}
 EOM
 #' stupid ruby-mode
+      end
     end
 
-    desynced_sources = Index.usual_sources.select { |s| s.error.is_a? OutOfSyncSourceError }
+    desynced_sources = Index.sources.select { |s| s.error.is_a? OutOfSyncSourceError }
     unless desynced_sources.empty?
-      BufferManager.spawn "Out-of-sync source notification", TextMode.new(<<EOM), opts
+      BufferManager.spawn_unless_exists("Out-of-sync source notification for #{broken_sources.join(',')}", opts) do
+        TextMode.new(<<EOM)
 Out-of-sync source notification
 -------------------------------
 
@@ -162,6 +164,7 @@ and new messages will not be detected. Luckily, this is easy to correct!
   end}
 EOM
 #' stupid ruby-mode
+      end
     end
   end
 
@@ -198,6 +201,7 @@ else
     :edit_signature => false,
     :ask_for_cc => true,
     :ask_for_bcc => false,
+    :ask_for_subject => true,
     :confirm_no_attachments => true,
     :confirm_top_posting => true,
   }
@@ -217,6 +221,20 @@ require "sup/hook"
 ## time.
 Redwood::HookManager.new Redwood::HOOK_DIR
 
+## everything we need to get logging working
+require "sup/buffer"
+require "sup/keymap"
+require "sup/mode"
+require "sup/modes/scroll-mode"
+require "sup/modes/text-mode"
+require "sup/modes/log-mode"
+require "sup/logger"
+module Redwood
+  def log s; Logger.log s; end
+  module_function :log
+end
+
+## now everything else (which can feel free to call Redwood::log at load time)
 require "sup/update"
 require "sup/suicide"
 require "sup/message-chunks"
@@ -230,9 +248,6 @@ require "sup/account"
 require "sup/thread"
 require "sup/index"
 require "sup/textfield"
-require "sup/buffer"
-require "sup/keymap"
-require "sup/mode"
 require "sup/colormap"
 require "sup/label"
 require "sup/contact"
@@ -240,8 +255,6 @@ require "sup/tagger"
 require "sup/draft"
 require "sup/poll"
 require "sup/crypto"
-require "sup/modes/scroll-mode"
-require "sup/modes/text-mode"
 require "sup/modes/line-cursor-mode"
 require "sup/modes/help-mode"
 require "sup/modes/edit-message-mode"
@@ -258,18 +271,11 @@ require "sup/modes/search-results-mode"
 require "sup/modes/person-search-results-mode"
 require "sup/modes/inbox-mode"
 require "sup/modes/buffer-list-mode"
-require "sup/modes/log-mode"
 require "sup/modes/poll-mode"
 require "sup/modes/file-browser-mode"
 require "sup/modes/completion-mode"
-require "sup/logger"
 require "sup/sent"
 
-module Redwood
-  def log s; Logger.log s; end
-  module_function :log
-end
-
 $:.each do |base|
   d = File.join base, "sup/share/modes/"
   Redwood::Mode.load_all_modes d if File.directory? d