sup 0.10.2 → 0.11

data/CONTRIBUTORS

@@ -2,40 +2,42 @@ William Morgan <wmorgan-sup at the masanjin dot nets>
 Rich Lane <rlane at the club.cc.cmu dot edus>
 Ismo Puustinen <ismo at the iki dot fis>
 Nicolas Pouillard <nicolas.pouillard at the gmail dot coms>
+Eric Sherman <hyperbolist at the gmail dot coms>
 Ben Walton <bwalton at the artsci.utoronto dot cas>
 Mike Stipicevic <stipim at the rpi dot edus>
 Marcus Williams <marcus-sup at the bar-coded dot nets>
 Lionel Ott <white.magic at the gmx dot des>
+Tero Tilus <tero at the tilus dot nets>
 Ingmar Vanhassel <ingmar at the exherbo dot orgs>
 Mark Alexander <marka at the pobox dot coms>
 Christopher Warrington <chrisw at the rice dot edus>
 Richard Brown <rbrown at the exherbo dot orgs>
-Anthony Martinez <pi+sup at the pihost dot uss>
 Marc Hartstein <marc.hartstein at the alum.vassar dot edus>
 Israel Herraiz <israel.herraiz at the gmail dot coms>
-Tero Tilus <tero at the tilus dot nets>
+Anthony Martinez <pi+sup at the pihost dot uss>
+Michael Stapelberg <michael at the stapelberg dot des>
 Bo Borgerson <gigabo at the gmail dot coms>
 William Erik Baxter <web at the superscript dot coms>
 Grant Hollingworth <grant at the antiflux dot orgs>
 Adeodato Simó <dato at the net.com.org dot ess>
-Edward Z. Yang <ezyang at the mit dot edus>
+Daniel Schoepe <daniel.schoepe at the googlemail dot coms>
 Steve Goldman <sgoldman at the tower-research dot coms>
-Michael Stapelberg <michael at the stapelberg dot des>
+Edward Z. Yang <ezyang at the MIT dot EDUs>
 Decklin Foster <decklin at the red-bean dot coms>
-Eric Sherman <hyperbolist at the gmail dot coms>
 Cameron Matheson <cam+sup at the cammunism dot orgs>
 Carl Worth <cworth at the cworth dot orgs>
-Alex Vandiver <alex at the chmrr dot nets>
-Jeff Balogh <its.jeff.balogh at the gmail dot coms>
 Andrew Pimlott <andrew at the pimlott dot nets>
+Alex Vandiver <alexmv at the mit dot edus>
+Jeff Balogh <its.jeff.balogh at the gmail dot coms>
 Peter Harkins <ph at the malaprop dot orgs>
 Kornilios Kourtis <kkourt at the cslab.ece.ntua dot grs>
+Michael Hamann <michael at the content-space dot des>
 Giorgio Lando <patroclo7 at the gmail dot coms>
 Benoît PIERRE <benoit.pierre at the gmail dot coms>
 Jonah <Jonah at the GoodCoffee dot cas>
 ian <ian at the lorf dot orgs>
 Steven Walter <swalter at the monarch.(none)>
-Jon M. Dugan <jdugan at the es dot nets>
+Alex Vandiver <alex at the chmrr dot nets>
 Stefan Lundström <lundst at the snabb.(none)>
-Michael Hamann <michael at the content-space dot des>
+Jon M. Dugan <jdugan at the es dot nets>
 Kirill Smelkov <kirr at the landau.phys.spbu dot rus>

data/History.txt

@@ -1,3 +1,17 @@
+== 0.11 / 2010-03-07
+* Remove deprecated Ferret backend.
+* Add deprecation notices to IMAP, IMAPS, and mbox+ssh sources.
+* 256 color support.
+* Backwards-compatible index format improvements.
+* Saved searches.
+* Improved support for custom keybindings.
+* Idle detection - poll totals accumulate and index flushes on idle.
+* Several textfield improvments.
+* New hooks: publish, mentions-attachments, keybindings,
+  index-mode-date-widget, gpg-args, and crypto-settings.
+* sup-cmd for easy programmatic access to a Sup index.
+* As always, many bugfixes and tweaks.
+
 == 0.10.2 / 2010-01-26
 * Update gem dependencies to pull in xapian-full and ncursesw instead of ferret
   and ncurses.

data/README.txt

@@ -12,8 +12,7 @@ email as an extension of your long-term memory, Sup is for you.
 Sup makes it easy to:
 - Handle massive amounts of email.
 
-- Mix email from different sources: mbox files (even across different
-  machines), Maildir directories, IMAP folders, and GMail accounts.
+- Mix email from different sources: mbox files and Maildirs.
 
 - Instantaneously search over your entire email collection. Search over
   body text, or use a query language to combine search predicates in any
@@ -39,7 +38,7 @@ Features:
   operability, regardless of how much amount of email you have.
 
 - Immediate full-text search of your entire email archive, using the
-  Ferret query language. Search over message bodies, labels, from: and
+  Xapian query language. Search over message bodies, labels, from: and
   to: fields, or any combination thereof.
 
 - Thread-centrism. Operations are performed at the thread, not the
@@ -73,13 +72,6 @@ Current limitations which will be fixed:
   source (read, move, delete, etc) with another client Sup will punish
   you with a lengthy reindexing process.
 
-- Support for mbox, Maildir, and IMAP only at this point. No support for
-  POP or mh.
-
-- IMAP support is very slow due mostly to Ruby's IMAP library.  You may
-  consider something like offlineimap to mirror your IMAP folders with
-  local Maildir ones.
-
 - Unix-centrism in MIME attachment handling and in sendmail invocation.
 
 == SYNOPSYS:
@@ -96,7 +88,7 @@ Current limitations which will be fixed:
 
 == REQUIREMENTS:
 
- - ferret >= 0.11.6
+ - xapian-full >= 1.1.3.2
  - ncurses >= 0.9.1
  - rmail >= 0.17
  - highline

data/ReleaseNotes

@@ -1,3 +1,19 @@
+Release 0.11:
+
+The deprecated Ferret index has been removed.
+
+Remote sources (IMAP, IMAPS, and mbox+ssh) have been deprecated and will be
+removed in 0.12. Tools like offlineimap, fetchmail, and rsync provide a much
+better user experience for these mail sources than Sup would ever be able to by
+itself.
+
+If your terminal supports it you can now use 256 colors in your colorscheme. Run
+the contrib/colorpicker.rb program to get the color names to put in colors.yaml.
+
+Saved searches are now supported. Hit '%' in search-results-mode to save the
+current search, and enter an empty search string to open the list of saved
+searches.
+
 Release 0.10:
 
 The Xapian backend is now the default. Convert your old, crash-prone Ferret

data/bin/sup

@@ -12,10 +12,15 @@ end
 
 require 'fileutils'
 require 'trollop'
-require "sup"; Redwood::check_library_version_against "0.10.2"
+require "sup"; Redwood::check_library_version_against "0.11"
+
+if ENV['SUP_PROFILE']
+  require 'ruby-prof'
+  RubyProf.start
+end
 
 if no_ncursesw
-  debug "No 'ncursesw' gem detected. Install it for wide character support."
+  info "No 'ncursesw' gem detected. Install it for wide character support."
 end
 
 $opts = Trollop::options do
@@ -34,7 +39,6 @@ EOS
   opt :search, "Search for this query upon startup", :type => String
   opt :compose, "Compose message to this recipient upon startup", :type => String
   opt :subject, "When composing, use this subject", :type => String, :short => "j"
-  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
 end
 
 Trollop::die :subject, "requires --compose" if $opts[:subject] && !$opts[:compose]
@@ -83,7 +87,15 @@ global_keymap = Keymap.new do |k|
   k.add :recall_draft, "Edit most recent draft message", 'R'
   k.add :show_inbox, "Show the Inbox buffer", 'I'
   k.add :show_console, "Show the Console buffer", '~'
+
+  ## Submap for less often used keybindings
+  k.add_multi "reload (c)olors, rerun (k)eybindings hook", 'O' do |kk|
+    kk.add :reload_colors, "Reload colors", 'c'
+    kk.add :run_keybindings_hook, "Rerun keybindings hook", 'k'
+  end
 end
+  
+Redwood::Keymap.run_hook global_keymap
 
 ## the following magic enables wide characters when used with a ruby
 ## ncurses.so that's been compiled against libncursesw. (note the w.) why
@@ -134,40 +146,33 @@ def stop_cursing
 end
 module_function :start_cursing, :stop_cursing
 
-Index.init $opts[:index]
+Index.init
 Index.lock_interactively or exit
 
-if Index.is_a_deprecated_ferret_index?
-  FERRET_DEPRECATION_WARNING_FN = File.join BASE_DIR, "you-have-been-warned-about-ferret-deprecation"
-  unless File.exist? FERRET_DEPRECATION_WARNING_FN
-    $stderr.puts <<EOS
-Warning! Your 30-day trial period for using Sup is almost over!
-
-To purchase the full version of Sup, please see http://sup.rubyforge.org/.
-
-Just kidding. BUT! You are using an old Ferret index. The Ferret backend is
-deprecated and support will be removed in the next version of Sup.
+begin
+  Redwood::start
+  Index.load
+  Index.start_sync_worker unless $opts[:no_threads]
 
-You should convert to Xapian before that happens.
+  if Redwood::SourceManager.sources.any? { |x| x.is_a? Redwood::MBox::SSHLoader }
+    $stderr.puts <<EOS
+mbox+ssh sources are deprecated and will be removed in the next release.
+Running rsync in your before-poll hook is a good alternative.
 
-The conversion process may take several hours. It is safe and interruptable.
-You can start it at any point by typing:
+Press enter to continue.
+EOS
+    $stdin.gets
+  end
 
-  sup-convert-ferret-index
+  if Redwood::SourceManager.sources.any? { |x| x.is_a? Redwood::IMAP }
+    $stderr.puts <<EOS
+IMAP sources are deprecated and will be removed in the next release.
+Running offlineimap or fetchmail in your before-poll hook is a good alternative.
 
-Press enter to continue and be on your way. You won't see this message
-again, just a brief reminder at shutdown.
+Press enter to continue.
 EOS
-
     $stdin.gets
-    FileUtils.touch FERRET_DEPRECATION_WARNING_FN
   end
-end
-
-begin
-  Redwood::start
-  Index.load
-  Index.start_sync_worker unless $opts[:no_threads]
 
   $die = false
   trap("TERM") { |x| $die = true }
@@ -234,6 +239,7 @@ begin
 
   unless $opts[:no_threads]
     PollManager.start
+    IdleManager.start
     Index.start_lock_update_thread
   end
 
@@ -258,6 +264,8 @@ begin
       next
     end
 
+    IdleManager.ping
+
     if c == 410
       ## this is ncurses's way of telling us it's detected a refresh.
       ## since we have our own sigwinch handler, we don't do anything.
@@ -266,15 +274,16 @@ begin
 
     bm.erase_flash
 
-    action = begin
-      if bm.handle_input c
+    action =
+      begin
+        if bm.handle_input c
+          :nothing
+        else
+          bm.resolve_input_with_keymap c, global_keymap
+        end
+      rescue InputSequenceAborted
         :nothing
-      else
-        bm.resolve_input_with_keymap c, global_keymap
       end
-    rescue InputSequenceAborted
-      :nothing
-    end
     case action
     when :quit_now
       break if bm.kill_all_buffers_safely
@@ -297,9 +306,14 @@ begin
       b, new = bm.spawn_unless_exists("Contact List") { ContactListMode.new }
       b.mode.load_in_background if new
     when :search
-      query = BufferManager.ask :search, "search all messages: "
-      next unless query && query !~ /^\s*$/
-      SearchResultsMode.spawn_from_query query
+      query = BufferManager.ask :search, "Search all messages (enter for saved searches): "
+      unless query.nil?
+        if query.empty?
+          bm.spawn_unless_exists("Saved searches") { SearchListMode.new }
+        else
+          SearchResultsMode.spawn_from_query query
+        end
+      end
     when :search_unread
       SearchResultsMode.spawn_from_query "is:unread"
     when :list_labels
@@ -339,6 +353,15 @@ begin
     when :show_console
       b, new = bm.spawn_unless_exists("Console", :system => true) { ConsoleMode.new }
       b.mode.run
+    when :reload_colors
+      Colormap.reset
+      Colormap.populate_colormap
+      bm.completely_redraw_screen
+      bm.flash "reloaded colors"
+    when :run_keybindings_hook
+      HookManager.clear_one 'keybindings'
+      Keymap.run_hook global_keymap
+      bm.flash "keybindings hook run"
     when :nothing, InputSequenceAborted
     when :redraw
       bm.completely_redraw_screen
@@ -355,6 +378,7 @@ rescue Exception => e
 ensure
   unless $opts[:no_threads]
     PollManager.stop if PollManager.instantiated?
+    IdleManager.stop if IdleManager.instantiated?
     Index.stop_lock_update_thread
   end
 
@@ -379,6 +403,11 @@ ensure
   end
 
   Index.unlock
+
+  if (fn = ENV['SUP_PROFILE'])
+    result = RubyProf.stop
+    File.open(fn, 'w') { |io| RubyProf::CallTreePrinter.new(result).print(io) }
+  end
 end
 
 unless Redwood::exceptions.empty?
@@ -406,8 +435,4 @@ EOS
   end
 end
 
-if Index.is_a_deprecated_ferret_index?
-  puts "Reminder: to update your Ferret index to Xapian, run sup-convert-ferret-index."
-end
-
 end

data/bin/sup-add

@@ -4,7 +4,7 @@ require 'uri'
 require 'rubygems'
 require 'highline/import'
 require 'trollop'
-require "sup"; Redwood::check_library_version_against "0.10.2"
+require "sup"; Redwood::check_library_version_against "0.11"
 
 $opts = Trollop::options do
   version "sup-add (sup #{Redwood::VERSION})"
@@ -20,15 +20,6 @@ For mbox files on local disk, use the form:
     mbox:<path to mbox file>, or
     mbox://<path to mbox file>
 
-For mbox files on remote machines, use the form:
-    mbox+ssh://<machine name>/<path to mbox file>
-
-For IMAP folders, use the form (note no username or password!):
-    imap://<machine name>/          # unsecure, "INBOX" folder  
-    imap://<machine name>/<folder>  # unsecure, arbitrary
-    imaps://<machine name>/         # secure, "INBOX" folder
-    imaps://<machine name>/<folder> # secure, arbitrary folder 
-
 For Maildir folders, use the form:
     maildir:<path to Maildir directory>; or
     maildir://<path to Maildir directory>
@@ -40,7 +31,6 @@ EOS
   opt :labels, "A comma-separated set of labels to apply to all messages from this source", :type => String
   opt :force_new, "Create a new account for this source, even if one already exists."
   opt :force_account, "Reuse previously defined account user@hostname.", :type => String
-  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
 end
 
 Trollop::die "require one or more sources" if ARGV.empty?
@@ -86,7 +76,7 @@ end
 
 $terminal.wrap_at = :auto
 Redwood::start
-index = Redwood::Index.init $opts[:index]
+index = Redwood::Index.init
 index.load
 
 index.lock_interactively or exit
@@ -106,14 +96,6 @@ begin
 
     source = 
       case parsed_uri.scheme
-      when "mbox+ssh"
-        say "For SSH connections, if you will use public key authentication, you may leave the username and password blank."
-        say ""
-        username, password = get_login_info uri, Redwood::SourceManager.sources
-        Redwood::MBox::SSHLoader.new uri, username, password, nil, !$opts[:unusual], $opts[:archive], nil, labels
-      when "imap", "imaps"
-        username, password = get_login_info uri, Redwood::SourceManager.sources
-        Redwood::IMAP.new uri, username, password, nil, !$opts[:unusual], $opts[:archive], nil, labels
       when "maildir"
         Redwood::Maildir.new uri, nil, !$opts[:unusual], $opts[:archive], nil, labels
       when "mbox"

data/bin/sup-config

@@ -44,9 +44,6 @@ def add_source
     menu.prompt = "What type of mail source is it? "
     menu.choice("mbox file") { type = :mbox }
     menu.choice("maildir directory") { type = :maildir }
-    menu.choice("remote mbox file (accessible via ssh)") { type = :mboxssh }
-    menu.choice("IMAP server (secure)") { type = :imaps }
-    menu.choice("IMAP server (unsecure)") { type = :imap }
     menu.choice("Get me out of here!") { return }
   end
 
@@ -70,37 +67,6 @@ def add_source
       $last_fn = fn
       [Redwood::Maildir.suggest_labels_for(fn),
        { :scheme => "maildir", :path => fn }]
-    when :mboxssh
-      $last_server ||= "localhost"
-      srv = axe "What machine is the mbox file located on?", $last_server
-      return if srv.nil? || srv.empty?
-      $last_server = srv
-
-      fn = axe "What's the path to the mbox file?", $last_fn
-      return if fn.nil? || fn.empty?
-      $last_fn = fn
-      fn = "/#{fn}" # lame
-      [Redwood::MBox::SSHLoader.suggest_labels_for(fn),
-       { :scheme => "mbox+ssh", :host => srv, :path => fn }]
-    when :imap, :imaps
-      $last_server ||= "localhost"
-      srv = axe "What is the IMAP server (host, or host:port notation)?", $last_server
-      return if srv.nil? || srv.empty?
-      $last_server = srv
-
-      $last_folder ||= "INBOX"
-      fn = axe "What's the folder path?", $last_folder
-      return if fn.nil? || fn.empty?
-      $last_folder = fn
-
-      fn = "/#{fn}"
-      if srv =~ /^(\S+):(\d+)$/
-        host, port = $1, $2.to_i
-      else
-        host, port = srv, nil
-      end
-      [Redwood::IMAP.suggest_labels_for(fn),
-       { :scheme => type.to_s, :host => host, :port => port, :path => fn }]
     end
 
     uri = begin

data/bin/sup-dump

@@ -2,7 +2,7 @@
 
 require 'rubygems'
 require 'trollop'
-require "sup"; Redwood::check_library_version_against "0.10.2"
+require "sup"; Redwood::check_library_version_against "0.11"
 
 $opts = Trollop::options do
   version "sup-dump (sup #{Redwood::VERSION})"
@@ -16,13 +16,10 @@ the index format. This happened, for example, at Ferret version 0.11.
 Usage:
   sup-dump > <filename>
   sup-dump | bzip2 > <filename> # even better
-
-Options:
 EOS
-  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
 end
 
-index = Redwood::Index.init $opts[:index]
+index = Redwood::Index.init
 Redwood::SourceManager.init
 index.load