sup 0.9.1 → 0.10

data/lib/sup.rb

@@ -37,7 +37,7 @@ class Module
 end
 
 module Redwood
-  VERSION = "0.9.1"
+  VERSION = "0.10"
 
   BASE_DIR   = ENV["SUP_BASE"] || File.join(ENV["HOME"], ".sup")
   CONFIG_FN  = File.join(BASE_DIR, "config.yaml")
@@ -54,7 +54,7 @@ module Redwood
   YAML_DOMAIN = "masanjin.net"
   YAML_DATE = "2006-10-01"
 
-  DEFAULT_INDEX = 'ferret'
+  DEFAULT_NEW_INDEX_TYPE = 'xapian'
 
   ## record exceptions thrown in threads nicely
   @exceptions = []
@@ -188,8 +188,38 @@ EOM
     end
   end
 
+  ## to be called by entry points in bin/, to ensure that
+  ## their versions match up against the library versions.
+  ##
+  ## this is a perennial source of bug reports from people
+  ## who both use git and have a gem version installed.
+  def check_library_version_against v
+    unless Redwood::VERSION == v
+      $stderr.puts <<EOS
+Error: version mismatch!
+The sup executable is at version #{v.inspect}.
+The sup libraries are at version #{Redwood::VERSION.inspect}.
+
+Your development environment may be picking up code from a
+rubygems installation of sup.
+
+If you're running from git with a commandline like
+
+  ruby -Ilib #{$0}
+
+try this instead:
+
+  RUBY_INVOCATION="ruby -Ilib" ruby -Ilib #{$0}
+
+You can also try `gem uninstall sup` and removing all Sup rubygems.
+
+EOS
+      abort
+    end
+  end
+
   module_function :save_yaml_obj, :load_yaml_obj, :start, :finish,
-                  :report_broken_sources
+                  :report_broken_sources, :check_library_version_against
 end
 
 ## set up default configuration file
@@ -229,7 +259,8 @@ else
     :confirm_top_posting => true,
     :discard_snippets_from_encrypted_messages => false,
     :default_attachment_save_dir => "",
-    :sent_source => "sup://sent"
+    :sent_source => "sup://sent",
+    :poll_interval => 300
   }
   begin
     FileUtils.mkdir_p Redwood::BASE_DIR

data/lib/sup/buffer.rb

@@ -1,6 +1,11 @@
 require 'etc'
 require 'thread'
-require 'ncurses'
+
+begin
+  require 'ncursesw'
+rescue LoadError
+  require 'ncurses'
+end
 
 if defined? Ncurses
 module Ncurses
@@ -470,7 +475,7 @@ EOS
     end
   end
 
-  def ask_for_filename domain, question, default=nil
+  def ask_for_filename domain, question, default=nil, allow_directory=false
     answer = ask domain, question, default do |s|
       if s =~ /(~([^\s\/]*))/ # twiddle directory expansion
         full = $1
@@ -495,7 +500,7 @@ EOS
       answer =
         if answer.empty?
           spawn_modal "file browser", FileBrowserMode.new
-        elsif File.directory?(answer)
+        elsif File.directory?(answer) && !allow_directory
           spawn_modal "file browser", FileBrowserMode.new(answer)
         else
           File.expand_path answer
@@ -530,7 +535,7 @@ EOS
   end
 
   def ask_for_contacts domain, question, default_contacts=[]
-    default = default_contacts.map { |s| s.to_s }.join(" ")
+    default = default_contacts.is_a?(String) ? default_contacts : default_contacts.map { |s| s.to_s }.join(", ")
     default += " " unless default.empty?
 
     recent = Index.load_contacts(AccountManager.user_emails, :num => 10).map { |c| [c.full_address, c.email] }
@@ -604,7 +609,7 @@ EOS
   def ask_getch question, accept=nil
     raise "impossible!" if @asking
 
-    accept = accept.split(//).map { |x| x[0] } if accept
+    accept = accept.split(//).map { |x| x.ord } if accept
 
     status, title = get_status_and_title @focus_buf
     Ncurses.sync do
@@ -640,7 +645,7 @@ EOS
   ## returns true (y), false (n), or nil (ctrl-g / cancel)
   def ask_yes_or_no question
     case(r = ask_getch question, "ynYN")
-    when ?y, ?Y
+    when ?y.ord, ?Y.ord
       true
     when nil
       nil
@@ -755,6 +760,7 @@ EOS
   end
 
 private
+
   def default_status_bar buf
     " [#{buf.mode.name}] #{buf.title}   #{buf.mode.status}"
   end

data/lib/sup/colormap.rb

@@ -50,6 +50,7 @@ class Colormap
     :system_buf => { :fg => "blue", :bg => "default" },
     :regular_buf => { :fg => "white", :bg => "default" },
     :modified_buffer => { :fg => "yellow", :bg => "default", :attrs => ["bold"] },
+    :date => { :fg => "white", :bg => "default"},
   }
   
   def initialize

data/lib/sup/crypto.rb

@@ -15,15 +15,14 @@ class CryptoManager
     @mutex = Mutex.new
 
     bin = `which gpg`.chomp
-    @cmd =
-      case bin
-      when /\S/
-        debug "crypto: detected gpg binary in #{bin}"
-        "#{bin} --quiet --batch --no-verbose --logger-fd 1 --use-agent"
-      else
-        debug "crypto: no gpg binary detected"
-        nil
-      end
+    @cmd = case bin
+    when /\S/
+      debug "crypto: detected gpg binary in #{bin}"
+      "#{bin} --quiet --batch --no-verbose --logger-fd 1 --use-agent"
+    else
+      debug "crypto: no gpg binary detected"
+      nil
+    end
   end
 
   def have_crypto?; !@cmd.nil? end
@@ -33,15 +32,19 @@ class CryptoManager
     payload_fn.write format_payload(payload)
     payload_fn.close
 
-    output = run_gpg "--output - --armor --detach-sign --textmode --local-user '#{from}' #{payload_fn.path}"
+    sig_fn = Tempfile.new "redwood.signature"; sig_fn.close
 
-    raise Error, (output || "gpg command failed: #{cmd}") unless $?.success?
+    message = run_gpg "--output #{sig_fn.path} --yes --armor --detach-sign --textmode --local-user '#{from}' #{payload_fn.path}", :interactive => true
+    unless $?.success?
+      info "Error while running gpg: #{message}"
+      raise Error, "GPG command failed. See log for details."
+    end
 
     envelope = RMail::Message.new
     envelope.header["Content-Type"] = 'multipart/signed; protocol=application/pgp-signature; micalg=pgp-sha1'
 
     envelope.add_part payload
-    signature = RMail::Message.make_attachment output, "application/pgp-signature", nil, "signature.asc"
+    signature = RMail::Message.make_attachment IO.read(sig_fn.path), "application/pgp-signature", nil, "signature.asc"
     envelope.add_part signature
     envelope
   end
@@ -51,15 +54,20 @@ class CryptoManager
     payload_fn.write format_payload(payload)
     payload_fn.close
 
+    encrypted_fn = Tempfile.new "redwood.encrypted"; encrypted_fn.close
+
     recipient_opts = (to + [ from ] ).map { |r| "--recipient '<#{r}>'" }.join(" ")
     sign_opts = sign ? "--sign --local-user '#{from}'" : ""
-    gpg_output = run_gpg "--output - --armor --encrypt --textmode #{sign_opts} #{recipient_opts} #{payload_fn.path}"
-    raise Error, (gpg_output || "gpg command failed: #{cmd}") unless $?.success?
+    message = run_gpg "--output #{encrypted_fn.path} --yes --armor --encrypt --textmode #{sign_opts} #{recipient_opts} #{payload_fn.path}", :interactive => true
+    unless $?.success?
+      info "Error while running gpg: #{message}"
+      raise Error, "GPG command failed. See log for details."
+    end
 
     encrypted_payload = RMail::Message.new
     encrypted_payload.header["Content-Type"] = "application/octet-stream"
     encrypted_payload.header["Content-Disposition"] = 'inline; filename="msg.asc"'
-    encrypted_payload.body = gpg_output
+    encrypted_payload.body = IO.read(encrypted_fn.path)
 
     control = RMail::Message.new
     control.header["Content-Type"] = "application/pgp-encrypted"
@@ -111,46 +119,50 @@ class CryptoManager
     payload_fn.write payload.to_s
     payload_fn.close
 
-    output = run_gpg "--decrypt #{payload_fn.path}"
+    output_fn = Tempfile.new "redwood.output"
+    output_fn.close
 
-    if $?.success?
-      decrypted_payload, sig_lines = if output =~ /\A(.*?)((^gpg: .*$)+)\Z/m
-        [$1, $2]
-      else
-        [output, nil]
-      end
+    message = run_gpg "--output #{output_fn.path} --yes --decrypt #{payload_fn.path}", :interactive => true
 
-      sig = if sig_lines # encrypted & signed
-        if sig_lines =~ /^gpg: (Good signature from .*$)/
-          Chunk::CryptoNotice.new :valid, $1, sig_lines.split("\n")
-        else
-          Chunk::CryptoNotice.new :invalid, $1, sig_lines.split("\n")
-        end
-      end
+    unless $?.success?
+      info "Error while running gpg: #{message}"
+      return Chunk::CryptoNotice.new(:invalid, "This message could not be decrypted", message.split("\n"))
+    end
 
-      # This is gross. This decrypted payload could very well be a multipart
-      # element itself, as opposed to a simple payload. For example, a
-      # multipart/signed element, like those generated by Mutt when encrypting
-      # and signing a message (instead of just clearsigning the body).
-      # Supposedly, decrypted_payload being a multipart element ought to work
-      # out nicely because Message::multipart_encrypted_to_chunks() runs the
-      # decrypted message through message_to_chunks() again to get any
-      # children. However, it does not work as intended because these inner
-      # payloads need not carry a MIME-Version header, yet they are fed to
-      # RMail as a top-level message, for which the MIME-Version header is
-      # required. This causes for the part not to be detected as multipart,
-      # hence being shown as an attachment. If we detect this is happening,
-      # we force the decrypted payload to be interpreted as MIME.
-      msg = RMail::Parser.read(decrypted_payload)
-      if msg.header.content_type =~ %r{^multipart/} and not msg.multipart?
-        decrypted_payload = "MIME-Version: 1.0\n" + decrypted_payload
-        msg = RMail::Parser.read(decrypted_payload)
-      end
-      notice = Chunk::CryptoNotice.new :valid, "This message has been decrypted for display"
-      [notice, sig, msg]
-    else
-      Chunk::CryptoNotice.new :invalid, "This message could not be decrypted", output.split("\n")
+    output = IO.read output_fn.path
+    output.force_encoding Encoding::ASCII_8BIT if output.respond_to? :force_encoding
+
+    ## there's probably a better way to do this, but we're using the output to
+    ## look for a valid signature being present.
+
+    sig = case message
+    when /^gpg: (Good signature from .*$)/i
+      Chunk::CryptoNotice.new :valid, $1, message.split("\n")
+    when /^gpg: (Bad signature from .*$)/i
+      Chunk::CryptoNotice.new :invalid, $1, message.split("\n")
     end
+
+    # This is gross. This decrypted payload could very well be a multipart
+    # element itself, as opposed to a simple payload. For example, a
+    # multipart/signed element, like those generated by Mutt when encrypting
+    # and signing a message (instead of just clearsigning the body).
+    # Supposedly, decrypted_payload being a multipart element ought to work
+    # out nicely because Message::multipart_encrypted_to_chunks() runs the
+    # decrypted message through message_to_chunks() again to get any
+    # children. However, it does not work as intended because these inner
+    # payloads need not carry a MIME-Version header, yet they are fed to
+    # RMail as a top-level message, for which the MIME-Version header is
+    # required. This causes for the part not to be detected as multipart,
+    # hence being shown as an attachment. If we detect this is happening,
+    # we force the decrypted payload to be interpreted as MIME.
+    msg = RMail::Parser.read output
+    if msg.header.content_type =~ %r{^multipart/} && !msg.multipart?
+      output = "MIME-Version: 1.0\n" + output
+      output.force_encoding Encoding::ASCII_8BIT if output.respond_to? :force_encoding
+      msg = RMail::Parser.read output
+    end
+    notice = Chunk::CryptoNotice.new :valid, "This message has been decrypted for display"
+    [notice, sig, msg]
   end
 
 private
@@ -169,10 +181,19 @@ private
     payload.to_s.gsub(/(^|[^\r])\n/, "\\1\r\n").gsub(/^MIME-Version: .*\r\n/, "")
   end
 
-  def run_gpg args
-    cmd = "#{@cmd} #{args} 2> /dev/null"
-    output = `#{cmd}`
-    output
+  def run_gpg args, opts={}
+    cmd = "#{@cmd} #{args}"
+    if opts[:interactive] && BufferManager.instantiated?
+      output_fn = Tempfile.new "redwood.output"
+      output_fn.close
+      cmd += " > #{output_fn.path} 2> /dev/null"
+      debug "crypto: running: #{cmd}"
+      BufferManager.shell_out cmd
+      IO.read(output_fn.path) rescue "can't read output"
+    else
+      debug "crypto: running: #{cmd}"
+      `#{cmd} 2> /dev/null`
+    end
   end
 end
 end

data/lib/sup/ferret_index.rb

@@ -11,6 +11,8 @@ Variables:
   subs: The string being searched.
 EOS
 
+  def is_a_deprecated_ferret_index?; true end
+
   def initialize dir=BASE_DIR
     super
 
@@ -127,8 +129,11 @@ EOS
       :from => (m.from ? m.from.indexable_content : ""),
       :to => (m.to + m.cc + m.bcc).map { |x| x.indexable_content }.join(" "),
 
+      ## always overwrite :refs.
+      ## these might have changed due to manual thread joining.
+      :refs => (m.refs + m.replytos).uniq.join(" "),
+
       :subject => (entry[:subject] || wrap_subj(Message.normalize_subj(m.subj))),
-      :refs => (entry[:refs] || (m.refs + m.replytos).uniq.join(" ")),
     }
 
     @index_mutex.synchronize do

data/lib/sup/index.rb

@@ -6,7 +6,7 @@ begin
   require 'chronic'
   $have_chronic = true
 rescue LoadError => e
-  debug "optional 'chronic' library not found; date-time query restrictions disabled"
+  debug "No 'chronic' gem detected. Install it for date/time query restrictions."
   $have_chronic = false
 end
 
@@ -23,11 +23,15 @@ class BaseIndex
     def method_missing m; @h[m.to_s] end
   end
 
+  def is_a_deprecated_ferret_index?; false end
+
   include Singleton
 
   def initialize dir=BASE_DIR
     @dir = dir
     @lock = Lockfile.new lockfile, :retries => 0, :max_age => nil
+    @sync_worker = nil
+    @sync_queue = Queue.new
   end
 
   def lockfile; File.join @dir, "lock" end
@@ -172,15 +176,65 @@ class BaseIndex
   def parse_query s
     unimplemented
   end
+
+  def save_thread t
+    t.each_dirty_message do |m|
+      if @sync_worker
+        @sync_queue << m
+      else
+        update_message_state m
+      end
+      m.clear_dirty
+    end
+  end
+
+  def start_sync_worker
+    @sync_worker = Redwood::reporting_thread('index sync') { run_sync_worker }
+  end
+
+  def stop_sync_worker
+    return unless worker = @sync_worker
+    @sync_worker = nil
+    @sync_queue << :die
+    worker.join
+  end
+
+  def run_sync_worker
+    while m = @sync_queue.deq
+      return if m == :die
+      update_message_state m
+      # Necessary to keep Xapian calls from lagging the UI too much.
+      sleep 0.03
+    end
+  end
 end
 
-index_name = ENV['SUP_INDEX'] || $config[:index] || DEFAULT_INDEX
-case index_name
-  when "xapian"; require "sup/xapian_index"
-  when "ferret"; require "sup/ferret_index"
-  else fail "unknown index type #{index_name.inspect}"
+## just to make the backtraces even more insane, here we engage in yet more
+## method_missing metaprogramming so that Index.init(index_type_name) will
+## magically make Index act like the correct Index class.
+class Index
+  def self.init type=nil
+    ## determine the index type from the many possible ways of setting it
+    type = (type == "auto" ? nil : type) ||
+      ENV['SUP_INDEX'] ||
+      $config[:index] ||
+      (File.exist?(File.join(BASE_DIR, "xapian")) && "xapian") || ## PRIORITIZE THIS
+      (File.exist?(File.join(BASE_DIR, "ferret")) && "ferret") || ## deprioritize this
+      DEFAULT_NEW_INDEX_TYPE
+    begin
+      require "sup/#{type}_index"
+      @klass = Redwood.const_get "#{type.capitalize}Index"
+      @obj = @klass.init
+    rescue LoadError, NameError => e
+      raise "unknown index type #{type.inspect}: #{e.message}"
+    end
+    debug "using #{type} index"
+    @obj
+  end
+
+  def self.instance; @obj end
+  def self.method_missing m, *a, &b; @obj.send(m, *a, &b) end
+  def self.const_missing x; @obj.class.const_get(x) end
 end
-Index = Redwood.const_get "#{index_name.capitalize}Index"
-debug "using index #{Index.name}"
 
 end

data/lib/sup/logger.rb

@@ -14,13 +14,14 @@ class Logger
 
   def initialize level=nil
     level ||= ENV["SUP_LOG_LEVEL"] || "info"
-    @level = LEVELS.index(level) or raise ArgumentError, "invalid log level #{level.inspect}: should be one of #{LEVELS * ', '}"
+    self.level = level
     @mutex = Mutex.new
     @buf = StringIO.new
     @sinks = []
   end
 
   def level; LEVELS[@level] end
+  def level=(level); @level = LEVELS.index(level) || raise(ArgumentError, "invalid log level #{level.inspect}: should be one of #{LEVELS * ', '}"); end
 
   def add_sink s, copy_current=true
     @mutex.synchronize do