sup 0.0.7 → 0.0.8

data/History.txt

@@ -1,4 +1,17 @@
+== 0.0.8 / 2007-04-01
+
+* Maildir support!
+* New command: sup-config. Interactively walks you through everything
+  you need to get up and running.
+* Now proactive about notifying users of de-synced sources.
+* Renamed sup-import => sup-sync with a brand new, less illogical
+  interface.
+* Added a sup-dump, to enable backing up and rebuilding indices from
+  scratch (e.g. when Ferret upgrades break index formats).
+* More bugfixes. Will they ever end?
+
 == 0.0.7 / 2007-02-12
+
 * Split sup-import into two bits: sup-import and sup-add.
 * Command-line arguments now handled by trollop.
 * Better error handling for IMAP and svn+ssh.
@@ -11,6 +24,7 @@
 * Removed hoe dependency.
 
 == 0.0.6 / 2007-01-06
+
 * Very minor fix to support more types of IMAP authentication.
 
 == 0.0.5 / 2007-01-05
@@ -44,4 +58,3 @@
 
 * Initial release. Unix-centrism, support for mbox only, no i18n.
   Untested on anything other than 1.8.5. Other than that, works great!
-

data/Manifest.txt

@@ -6,8 +6,10 @@ README.txt
 Rakefile
 bin/sup
 bin/sup-add
-bin/sup-import
+bin/sup-config
+bin/sup-dump
 bin/sup-recover-sources
+bin/sup-sync
 doc/FAQ.txt
 doc/Philosophy.txt
 doc/TODO
@@ -23,6 +25,7 @@ lib/sup/index.rb
 lib/sup/keymap.rb
 lib/sup/label.rb
 lib/sup/logger.rb
+lib/sup/maildir.rb
 lib/sup/mbox.rb
 lib/sup/mbox/loader.rb
 lib/sup/mbox/ssh-file.rb

data/README.txt

@@ -11,9 +11,9 @@ with the speed and simplicity of a console interface.
 Sup makes it easy to:
 - Handle massive amounts of email.
 
-- Mix email from different sources: mbox files (even across
-  different machines), IMAP folders, POP accounts, and GMail
-  accounts.
+- Mix email from different sources: mbox files (even across different
+  machines), Maildir directories, IMAP folders, POP accounts, and
+  GMail accounts.
 
 - Instantaneously search over your entire email collection. Search
   over body text, or use a query language to combine search
@@ -40,7 +40,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 langauge. Search over message bodies, labels, from: and
+  Ferret 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
@@ -109,22 +109,28 @@ Current limitations which will be fixed:
 * ncurses
 * rmail
 * highline
+* trollop
+* net-ssh
 
 == INSTALL:
 
 * gem install sup -y
 
 == KNOWN BUGS IN OTHER PACKAGES:
+
 * If you get an error about frozen strings in RubyMail when importing
   certain messages with attachments, in rmail, change line 159 of
   multipart.rb to:
     chunk = chunk[0..start]
+  This is because RubyMail hasn't been updated since like Ruby 1.8.2.
+  Please bug Matt Lickey.
 * Occasionally Ferret produces something the Ruby GC doesn't like
   (particularly when importing messages from very large sources).
   No worries, just re-run sup-import. (This is unresolved atm.)
-* There are a couple other Ferret issues with outstanding patches but
-  they are pretty rare.
-
+* If you are using IMAP or Maildir and see this error:
+    /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
+  then you need to upgrade to Ruby 1.8.5. YAML in earlier versions
+  can't parse BigNums.
 
 == LICENSE:
 

data/Rakefile

@@ -12,11 +12,11 @@ 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.description = p.paragraphs_of('README.txt', 2..9).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.changes = p.paragraphs_of('History.txt', 0..0).join("\n\n")
   p.email = "wmorgan-sup@masanjin.net"
-  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17'], 'highline', 'net-ssh', 'trollop']
+  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17'], 'highline', 'net-ssh', ['trollop', '>= 1.5']]
 end
 
 rule 'ss?.png' => 'ss?-small.png' do |t|

data/bin/sup

@@ -83,6 +83,8 @@ begin
           Ncurses::A_BOLD
     c.add :starred_patina_color, Ncurses::COLOR_YELLOW, Ncurses::COLOR_GREEN,
           Ncurses::A_BOLD
+    c.add :alternate_starred_patina_color, Ncurses::COLOR_YELLOW,
+          Ncurses::COLOR_BLUE, 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,
@@ -98,16 +100,24 @@ begin
   imode = InboxMode.new
   ibuf = bm.spawn "inbox", imode
 
-  log "ready for (inter)action!"
+  log "ready for interaction!"
   Logger.make_buf
 
   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
       begin
         s.connect
       rescue SourceError => e
-        Redwood::log "Fatal error loading from #{s}: #{e.message}"
+        Redwood::log "fatal error loading from #{s}: #{e.message}"
       end
     end if s.respond_to? :connect
   end
@@ -197,12 +207,11 @@ rescue Exception => e
 ensure
   Redwood::finish
   stop_cursing
-  
-  # don't ask me why, but sometimes it's necessary to print something
-  # to stderr at this point or the exception doesn't get printed.
-  # doesn't get printed. WHY?
-
-  $stderr.puts " " 
+  if $exception
+    Redwood::log "oh crap, an exception"
+  else
+    Redwood::log "good night, sweet prince!"
+  end
 end
 
 Index.save unless $exception # TODO: think about this

data/bin/sup-add

@@ -6,22 +6,19 @@ require 'highline/import'
 require 'trollop'
 require "sup"
 
-Thread.abort_on_exception = true # make debugging possible
-
 $opts = Trollop::options do
   version "sup-add (sup #{Redwood::VERSION})"
   banner <<EOS
 Adds a source to the Sup source list.
 
 Usage:
-  sup-add [options] <source>+
+  sup-add [options] <source uri>+
 
-where <source>+ is one or more sources.
+where <source uri>+ is one or more source URIs.
 
 For mbox files on local disk, use the form:
+    mbox:<path to mbox file>, or
     mbox://<path to mbox file>
-or simply
-    <path to mbox file>
 
 For mbox files on remote machines, use the form:
     mbox+ssh://<machine name>/<path to mbox file>
@@ -32,6 +29,10 @@ For IMAP folders, use the form (note no username or password!):
     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>
+
 Options are:
 EOS
   opt :archive, "Automatically archive all new messages from these sources."
@@ -79,28 +80,33 @@ index = Redwood::Index.new
 index.load
 
 ARGV.each do |uri|
-  uri = "mbox://#{uri}" unless uri =~ %r!://!
   if !$opts[:force_new] && index.source_for(uri) 
     say "Already know about #{uri}; skipping."
     next
   end
+
+  parsed_uri = URI(uri)
+
   source = 
-    case uri
-    when %r!^mbox\+ssh://!
+    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, index.sources
-      Redwood::MBox::SSHLoader.new(uri, username, password, nil, !$opts[:unusual], $opts[:archive])
-    when %r!^imaps?://!
+      Redwood::MBox::SSHLoader.new uri, username, password, nil, !$opts[:unusual], $opts[:archive]
+    when "imap", "imaps"
       username, password = get_login_info uri, index.sources
-      Redwood::IMAP.new(uri, username, password, nil, !$opts[:unusual], $opts[:archive])
+      Redwood::IMAP.new uri, username, password, nil, !$opts[:unusual], $opts[:archive]
+    when "maildir"
+      Redwood::Maildir.new uri, nil, !$opts[:unusual], $opts[:archive]
+    when "mbox"
+      Redwood::MBox::Loader.new uri, nil, !$opts[:unusual], $opts[:archive]
     else
-      Redwood::MBox::Loader.new(uri, nil, !$opts[:unusual], $opts[:archive])
+      Trollop::die "Unknown source type #{parsed_uri.scheme.inspect}"      
     end
   say "Adding #{source}..."
   index.add_source source
 end
 
-say "Saving source list..."
 index.save
 Redwood::finish

data/bin/sup-config

@@ -0,0 +1,222 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'highline/import'
+require 'yaml'
+require 'trollop'
+require "sup"
+
+$opts = Trollop::options do
+  version "sup-config (sup #{Redwood::VERSION})"
+  banner <<EOS
+Interactive configuration tool for Sup. Won't destroy existing
+configuration.
+
+Usage:
+  sup-config
+
+Options:
+EOS
+end #' stupid ruby-mode
+
+def axe q, default=nil
+  ans = 
+  if default && !default.empty?
+    ask "#{q} (enter for \"#{default}\"): "
+  else
+    ask "#{q}: "
+  end
+  ans.empty? ? default : ans
+end
+
+def axe_yes q, default="n"
+  axe(q, default) =~ /^y|yes$/i
+end
+
+def build_cmd cmd
+  (ENV["RUBY_INVOCATION"] ? ENV["RUBY_INVOCATION"] + " " : "") + File.join(File.dirname($0), cmd)
+end
+
+def add_source
+  type = nil
+
+  say "Ok, adding a new source."
+  choose do |menu|
+    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
+
+  while true do
+    say "Now for the details."
+
+    components = 
+      case type
+      when :mbox
+        fn = axe "What's the full path to the mbox file?", ENV["MAIL"] #"srm
+        return if fn.nil? || fn.empty?
+        { :scheme => "mbox", :path => fn }
+      when :maildir
+        fn = axe "What's the full path to the maildir directory?", ENV["MAIL"] #"srm
+        return if fn.nil? || fn.empty?
+        { :scheme => "maildir", :path => fn }
+      when :mboxssh
+        srv = axe "What server is the mbox file located on?", $last_server 
+        return if srv.nil? || srv.empty?
+        $last_server = srv
+        fn = axe "What's the full path to the mbox file?", ENV["MAIL"] #"srm
+        return if fn.nil? || fn.empty?
+        fn = "/#{fn}" # lame
+        { :scheme => "mbox+ssh", :host => srv, :path => fn }
+      when :imap, :imaps
+        srv = axe "What is the IMAP server?", $last_server
+        return if srv.nil? || srv.empty?
+        $last_server = srv
+        fn = axe "What's the folder path?", "INBOX" #"srm 
+        return if fn.nil? || fn.empty?
+        fn = "/#{fn}" # lame
+        { :scheme => type.to_s, :host => srv, :path => fn }
+      end
+    
+    uri = 
+      begin
+        URI::Generic.build components
+      rescue URI::Error => e
+        say "Whoopsie! I couldn't build a URI from that: #{e.message}"
+        if axe_yes("Try again?") then next else return end
+      end
+
+    say "I'm going to add this source: #{uri}."
+    unless axe("Does that look right?", "y") =~ /^y|yes$/i
+      if axe_yes("Try again?") then next else return end
+    end
+
+    usual = axe_yes "Does this source ever receive new messages?", "y"
+    archive = usual ? axe_yes("Should those new messages be automatically archived?") : false
+    
+    cmd = build_cmd "sup-add"
+    cmd += " --unusual" unless usual
+    cmd += " --archive" if archive
+    cmd += " #{uri}"
+
+    puts "Ok, trying to run \"#{cmd}\"..."
+
+    system cmd
+    if $?.success?
+      say "Great! Added!"
+      break 
+    else
+      say "Rats, that failed. You may have to do it manually."
+      if axe_yes("Try again?") then next else return end
+    end
+  end
+end
+
+$terminal.wrap_at = :auto
+Redwood::start
+index = Redwood::Index.new
+index.load_sources
+
+say <<EOS
+Howdy neighbor! This here's sup-config, ready to help you jack in to
+the next generation of digital cyberspace: the text-based email
+program. Get ready to be the envy of everyone in your internets
+with your amazing keyboarding skills! Jump from email to email with
+nary a click of the mouse!
+
+Just answer these simple questions and you'll be on your way! Press
+enter at any point to accept the default answer.
+
+EOS
+#' stupid ruby-mode
+
+account = $config[:accounts][:default]
+
+name = axe "What's your name?", account[:name]
+email = axe "What's your email address?", account[:email] #'srm
+
+say "Ok, your header will look like this:"
+say "  From: #{name} <#{email}>"
+
+say "\nDo you have any alternate email addresses that also receive email?"
+say "If so, enter them now, separated by spaces."
+alts = axe("Alternate email addresses", account[:alternates].join(" ")).split(/\s+/)
+
+sigfn = axe "What file contains your signature?", account[:signature]
+editor = axe "What editor would you like to use?", $config[:editor]
+
+$config[:accounts][:default][:name] = name
+$config[:accounts][:default][:email] = email
+$config[:accounts][:default][:alternates] = alts
+$config[:accounts][:default][:signature] = sigfn
+$config[:editor] = editor
+
+Redwood::save_yaml_obj $config, Redwood::CONFIG_FN
+
+say "Ok, I've saved you up a nice lil' #{Redwood::CONFIG_FN}."
+
+done = false
+until done
+  say "\nNow, we'll tell Sup where to find all your email."
+  index.load_sources
+  say "Current sources:"
+  if index.sources.empty?
+    say "  No sources!"
+  else
+    index.sources.each { |s| puts "* #{s}" }
+  end
+
+  say "\n"
+  choose do |menu|
+    menu.prompt = "Your wish?"
+    menu.choice("Add a new source.") { add_source }
+    menu.choice("Done adding sources!") { done = true }
+  end
+end
+
+say <<EOS
+
+Ok. The final step is to import all your messages into the Sup index.
+Depending on how many messages are in the sources, this could take
+quite a while.
+
+IMPORTANT NOTE: this import will archive messages if the source is
+marked archival, and won't otherwise. It will preserve read/unread
+status as given by the source, and it will automatically add one label
+per source. All of this behavior can be controlled on per-source
+basis by running sup-sync manually.
+
+EOS
+#'
+if axe_yes "Run sup-sync to import all messages now?"
+  while true
+    cmd = build_cmd("sup-sync") + " --all-sources"
+    puts "Ok, trying to run \"#{cmd}\"..."
+    system cmd
+    if $?.success?
+      say "Great! It worked!"
+      break 
+    else
+      say "Rats, that failed. You may have to do it manually."
+      if axe_yes("Try again?") then next else break end
+    end
+  end
+end
+
+index.load
+
+say <<EOS
+
+Okee doke, you've got yourself an index of #{index.size} messages. Looks
+like you're ready to jack in to cyberspace there, cowboy.
+
+Just one last command:
+
+  sup
+
+Have fun!
+EOS