sup 0.9.1 → 0.10

data/CONTRIBUTORS

@@ -10,28 +10,32 @@ 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>
+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>
 Steve Goldman <sgoldman at the tower-research dot coms>
+Michael Stapelberg <michael at the stapelberg dot des>
 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>
-Tero Tilus <tero at the tilus dot nets>
+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>
 Peter Harkins <ph at the malaprop dot orgs>
-Anthony Martinez <pi at the pihost dot uss>
-Carl Worth <cworth at the cworth dot orgs>
 Kornilios Kourtis <kkourt at the cslab.ece.ntua dot grs>
 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)>
-Michael Hamann <michael at the content-space dot des>
-Stefan Lundström <lundst at the snabb.(none)>
-William Erik Baxter <web at the superscript dot coms>
 Jon M. Dugan <jdugan at the es dot nets>
+Stefan Lundström <lundst at the snabb.(none)>
+Michael Hamann <michael at the content-space dot des>
 Kirill Smelkov <kirr at the landau.phys.spbu dot rus>

data/History.txt

@@ -1,3 +1,14 @@
+== 0.10 / 2010-01-22
+* Make Xapian backend the default, and add deprecation notice to Ferret indexes.
+* Now Ruby 1.9 compatible (Xapian backend only).
+* Changes are now saved automatically to the index. Pressing "$" now just
+  forces a flush of Xapian indexes, which can minimize quit time.
+* Fix problem with replying to Google Groups messages.
+* Allow toggling of line wrap. Useful for long URLs.
+* Multiple attachments can be added at once by specifying a wildcard.
+* New command to save all attachments at once.
+* As always, many bugfixes and tweaks.
+
 == 0.9.1 / 2009-12-10
 * Make textfield behave more like readline, including C-w
 * Add ask_for_to config option. You can set all ask_for_* options to false, and

data/ReleaseNotes

@@ -1,3 +1,13 @@
+Release 0.10:
+
+The Xapian backend is now the default. Convert your old, crash-prone Ferret
+index to Xapian by running sup-convert-ferret-index.
+
+Using a Ferret backend will produce a deprecation notice, and will not be
+supported in 0.11.
+
+Many thanks to Rich Lane.
+
 Release 0.9.1:
 
 This is mainly a bugfix release, with a couple minor new features rolled up.

data/bin/sup

@@ -1,24 +1,21 @@
 #!/usr/bin/env ruby
 
 require 'rubygems'
-require 'ncurses'
-require 'curses'
-require 'fileutils'
-require 'trollop'
-require "sup"
-
-BIN_VERSION = "0.9.1"
 
-unless Redwood::VERSION == BIN_VERSION
-  $stderr.puts <<EOS
+no_ncursesw = false
+begin
+  require 'ncursesw'
+rescue LoadError
+  require 'ncurses'
+  no_ncursesw = true
+end
 
-Error: version mismatch!
-The sup executable is at version #{BIN_VERSION.inspect}.
-The sup libraries are at version #{Redwood::VERSION.inspect}.
+require 'fileutils'
+require 'trollop'
+require "sup"; Redwood::check_library_version_against "0.10"
 
-Is your development environment conflicting with rubygems?
-EOS
-  exit(-1)
+if no_ncursesw
+  debug "No 'ncursesw' gem detected. Install it for wide character support."
 end
 
 $opts = Trollop::options do
@@ -37,6 +34,7 @@ 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]
@@ -79,6 +77,7 @@ global_keymap = Keymap.new do |k|
   k.add :search_unread, "Show all unread messages", 'U'
   k.add :list_labels, "List labels", 'L'
   k.add :poll, "Poll for new messages", 'P'
+  k.add :poll_unusual, "Poll for new messages from unusual sources", '{'
   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'
@@ -135,12 +134,40 @@ def stop_cursing
 end
 module_function :start_cursing, :stop_cursing
 
-Index.init
+Index.init $opts[:index]
 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.
+
+You should convert to Xapian before that happens.
+
+The conversion process may take several hours. It is safe and interruptable.
+You can start it at any point by typing:
+
+  sup-convert-ferret-index
+
+Press enter to continue and be on your way. You won't see this message
+again, just a brief reminder at shutdown.
+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 }
@@ -289,6 +316,10 @@ begin
       ComposeMode.spawn_nicely
     when :poll
       reporting_thread("user-invoked poll") { PollManager.poll }
+    when :poll_unusual
+      if BufferManager.ask_yes_or_no "Really poll unusual sources?"
+        reporting_thread("user-invoked unusual poll") { PollManager.poll_unusual }
+      end
     when :recall_draft
       case Index.num_results_for :label => :draft
       when 0
@@ -329,6 +360,7 @@ ensure
 
   HookManager.run "shutdown"
 
+  Index.stop_sync_worker
   Redwood::finish
   stop_cursing
   Redwood::Logger.remove_all_sinks!
@@ -359,9 +391,9 @@ unless Redwood::exceptions.empty?
   $stderr.puts <<EOS
 ----------------------------------------------------------------
 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 #{BASE_DIR}/exception-log.txt and a brief report of the
-circumstances to sup-talk at rubyforge dot orgs so that I might
+accept my sincere apologies. Please submit the contents of
+#{BASE_DIR}/exception-log.txt and a brief report of the
+circumstances to http://masanjin.net/sup-bugs/ so that I might
 address this problem. Thank you!
 
 Sincerely,
@@ -374,4 +406,8 @@ 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"
+require "sup"; Redwood::check_library_version_against "0.10"
 
 $opts = Trollop::options do
   version "sup-add (sup #{Redwood::VERSION})"
@@ -39,6 +39,8 @@ EOS
   opt :unusual, "Do not automatically poll these sources for new messages."
   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?
@@ -56,13 +58,20 @@ def get_login_info uri, sources
 
   username, password = nil, nil
   unless accounts.empty? || $opts[:force_new]
-    say "Would you like to use the same account as for a previous source for #{uri}?"
-    choose do |menu|
-      accounts.each do |host, olduser, oldpw|
-        menu.choice("Use the account info for #{olduser}@#{host}") { username, password = olduser, oldpw }
+    if $opts[:force_account]
+      host, username, password = accounts.find { |h, u, p| $opts[:force_account] == "#{u}@#{h}" }
+      unless username && password
+        say "No previous account #{$opts[:force_account].inspect} found."
+      end
+    else
+      say "Would you like to use the same account as for a previous source for #{uri}?"
+      choose do |menu|
+        accounts.each do |host, olduser, oldpw|
+          menu.choice("Use the account info for #{olduser}@#{host}") { username, password = olduser, oldpw }
+        end
+        menu.choice("Use a new account") { }
+        menu.prompt = "Account selection? "
       end
-      menu.choice("Use a new account") { }
-      menu.prompt = "Account selection? "
     end
   end
 
@@ -77,7 +86,8 @@ end
 
 $terminal.wrap_at = :auto
 Redwood::start
-index = Redwood::Index.init
+index = Redwood::Index.init $opts[:index]
+index.load
 
 index.lock_interactively or exit
 

data/bin/sup-config

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'highline/import'
 require 'yaml'
 require 'trollop'
-require "sup"
+require "sup"; Redwood::check_library_version_against "0.10"
 
 $opts = Trollop::options do
   version "sup-config (sup #{Redwood::VERSION})"
@@ -15,7 +15,7 @@ configuration.
 Usage:
   sup-config
 
-Options:
+No options.
 EOS
 end
 

data/bin/sup-convert-ferret-index

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'trollop'
+require "sup"; Redwood::check_library_version_against "0.10"
+
+STATE_BACKUP_FN = "/tmp/sup-state.txt"
+SOURCE_BACKUP_FN = "sources.yaml-before-xapian-upgrade"
+BIN_DIR = File.dirname __FILE__
+
+$opts = Trollop::options do
+  version "sup-convert-ferret-index (sup #{Redwood::VERSION})"
+  banner <<EOS
+Convert an Sup Ferret index to a Xapian index.
+
+This will be a very slow process, but it will be lossless.
+
+If you interrupt it, nothing bad will happen. However, you will have to
+restart it from scratch.
+
+Usage:
+  sup-convert-ferret-index
+
+Options:
+EOS
+  opt :verbose, "Be verbose", :short => "-v"
+  opt :dry_run, "Don't actually do anything, just print out what would happen.", :short => "-n"
+  opt :force, "Force overwrite of an old Xapian index"
+  opt :version, "Show version information", :short => :none
+end
+
+def build_cmd cmd
+  (ENV["RUBY_INVOCATION"] ? ENV["RUBY_INVOCATION"] + " " : "") + File.join(BIN_DIR, cmd)
+end
+
+def run cmd
+  puts cmd
+  unless $opts[:dry_run]
+    startt = Time.now
+    system cmd or abort
+    printf "(completed in %.1fs)\n", (Time.now - startt)
+  end
+  puts
+end
+
+begin
+  require 'xapian'
+rescue LoadError
+  Trollop::die "you don't have the xapian gem installed, so this script won't do much for you--`gem install xapian` (or xapian-full) first"
+end
+
+Redwood::start
+index = Redwood::Index.init
+Trollop::die "you appear to already have a Xapian index--delete #{File.join(Redwood::BASE_DIR, "xapian")} or use --force if you really want to do this" unless Redwood::Index.is_a_deprecated_ferret_index? || $opts[:force]
+
+puts "## Step one: back up all message state to #{STATE_BACKUP_FN}"
+run "#{build_cmd 'sup-dump'} --index ferret > #{STATE_BACKUP_FN}"
+puts "## message state saved to #{STATE_BACKUP_FN}"
+
+source_backup_fn = File.join Redwood::BASE_DIR, SOURCE_BACKUP_FN
+puts "## Step two: back up sources.yaml file to #{source_backup_fn}"
+run "cp #{Redwood::SOURCE_FN} #{source_backup_fn}"
+
+puts "## Step three: build the Xapian index"
+run "#{build_cmd 'sup-sync'} --all --all-sources --index xapian --restore #{STATE_BACKUP_FN} #{$opts[:verbose] ? '--verbose' : ''}"
+puts "## xapian index successfully built!"
+
+puts <<EOS
+
+Congratulations, your index has been upgraded to the Xapian backend.
+From now on, running sup should detect this index automatically.
+
+If you want to revert to the Ferret index:
+1. overwrite #{Redwood::SOURCE_FN} with #{source_backup_fn}
+2. use sup --index ferret, OR delete your #{Redwood::BASE_DIR}/xapian directory"
+Note that the Ferret index will not be supported as of the next Sup release, so
+you probably shouldn't do this.
+
+If you are happy with Xapian and want to reclaim precious hard drive space:
+1. rm #{source_backup_fn}
+2. rm -r #{Redwood::BASE_DIR}/ferret
+
+Happy supping!
+EOS

data/bin/sup-dump

@@ -2,7 +2,7 @@
 
 require 'rubygems'
 require 'trollop'
-require "sup"
+require "sup"; Redwood::check_library_version_against "0.10"
 
 $opts = Trollop::options do
   version "sup-dump (sup #{Redwood::VERSION})"
@@ -17,11 +17,12 @@ Usage:
   sup-dump > <filename>
   sup-dump | bzip2 > <filename> # even better
 
-No options.
+Options:
 EOS
+  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
 end
 
-index = Redwood::Index.init
+index = Redwood::Index.init $opts[:index]
 Redwood::SourceManager.init
 index.load
 

data/bin/sup-sync

@@ -3,7 +3,7 @@
 require 'uri'
 require 'rubygems'
 require 'trollop'
-require "sup"
+require "sup"; Redwood::check_library_version_against "0.10"
 
 PROGRESS_UPDATE_INTERVAL = 15 # seconds
 
@@ -76,6 +76,7 @@ text <<EOS
 
 Other options:
 EOS
+  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
   opt :verbose, "Print message ids as they're processed."
   opt :optimize, "As the final operation, optimize the index."
   opt :all_sources, "Scan over all sources.", :short => :none
@@ -95,7 +96,7 @@ target = [:new, :changed, :all, :restored].find { |x| opts[x] } || :new
 op = [:asis, :restore, :discard].find { |x| opts[x] } || :asis
 
 Redwood::start
-index = Redwood::Index.init
+index = Redwood::Index.init opts[:index]
 
 restored_state = if opts[:restore]
   dump = {}
@@ -226,7 +227,7 @@ begin
         elapsed = last_info_time - start_time
         pctdone = source.respond_to?(:pct_done) ? source.pct_done : 100.0 * (source.cur_offset.to_f - source.start_offset).to_f / (source.end_offset - source.start_offset).to_f
         remaining = (100.0 - pctdone) * (elapsed.to_f / pctdone)
-        printf "## read %dm (about %.0f%%) @ %.1fm/s. %s elapsed, about %s remaining\n", num_scanned, pctdone, num_scanned / elapsed, elapsed.to_time_s, remaining.to_time_s
+        printf "## read %dm (~%.0f%%) @ %.1fm/s. %s elapsed, ~%s remaining, offset #{source.cur_offset}\n", num_scanned, pctdone, num_scanned / elapsed, elapsed.to_time_s, remaining.to_time_s
       end
     end
 

data/bin/sup-sync-back

@@ -5,7 +5,7 @@ require 'uri'
 require 'tempfile'
 require 'trollop'
 require 'enumerator'
-require "sup"
+require "sup"; Redwood::check_library_version_against "0.10"
 
 ## save a message 'm' to an open file pointer 'fp'
 def save m, fp
@@ -47,6 +47,7 @@ EOS
   opt :with_dotlockfile, "Specific dotlockfile location (mbox files only).", :default => "/usr/bin/dotlockfile", :short => :none
   opt :dont_use_dotlockfile, "Don't use dotlockfile to lock mbox files. Dangerous if other processes modify them concurrently.", :default => false, :short => :none
 
+  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
   opt :verbose, "Print message ids as they're processed."
   opt :dry_run, "Don't actually modify the index. Probably only useful with --verbose.", :short => "-n"
   opt :version, "Show version information", :short => :none
@@ -65,7 +66,7 @@ EOS
 end
 
 Redwood::start
-index = Redwood::Index.init
+index = Redwood::Index.init opts[:index]
 index.lock_interactively or exit
 
 deleted_fp, spam_fp = nil

data/bin/sup-tweak-labels

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'trollop'
 require 'enumerator'
-require "sup"
+require "sup"; Redwood::check_library_version_against "0.10"
 
 class Float
   def to_s; sprintf '%.2f', self; end
@@ -46,6 +46,7 @@ EOS
 
 Other options:
 EOS
+  opt :index, "Use this index type ('auto' for autodetect)", :default => "auto"
   opt :verbose, "Print message ids as they're processed."
   opt :very_verbose, "Print message names and subjects as they're processed."
   opt :all_sources, "Scan over all sources.", :short => :none
@@ -58,10 +59,9 @@ add_labels = opts[:add].to_set_of_symbols ","
 remove_labels = opts[:remove].to_set_of_symbols ","
 
 Trollop::die "nothing to do: no labels to add or remove" if add_labels.empty? && remove_labels.empty?
-Trollop::die "no sources specified" if ARGV.empty?
 
 Redwood::start
-index = Redwood::Index.init
+index = Redwood::Index.init opts[:index]
 index.lock_interactively or exit
 begin
   index.load