sup 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,7 @@
+== 0.0.4 / 2007-01-03
+ 
+* Bugfixes, primarily for threaded networking.
+
 == 0.0.3 / 2007-01-02
 
 * Major speed increase for index views (inbox, search results), which

data/Manifest.txt

@@ -9,6 +9,7 @@ bin/sup-recover-sources
 doc/FAQ.txt
 doc/Philosophy.txt
 doc/TODO
+doc/UserGuide.txt
 lib/sup.rb
 lib/sup/account.rb
 lib/sup/buffer.rb

data/Rakefile

@@ -12,7 +12,7 @@ Hoe.new('sup', Redwood::VERSION) do |p|
   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.email = "wmorgan-sup@masanjin.net"
-  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17'], 'highline']
+  p.extra_deps = [['ferret', '>= 0.10.13'], ['ncurses', '>= 0.9.1'], ['rmail', '>= 0.17'], 'highline', 'net-ssh']
 end
 
 rule 'ss?.png' => 'ss?-small.png' do |t|

data/bin/sup

@@ -100,9 +100,8 @@ begin
   Logger.make_buf
 
   bm.draw_screen
-  imode.load_more_threads ibuf.content_height
+  imode.load_more_threads :num => ibuf.content_height, :when_done => lambda {   reporting_thread { sleep 1; PollManager.poll } }
 
-  reporting_thread { sleep 5; PollManager.poll }
   PollManager.start_thread
 
   until $exception
@@ -141,7 +140,7 @@ begin
             log "built query from #{text.inspect}: #{qobj}"
             mode = SearchResultsMode.new qobj
             bm.spawn "search: \"#{short_text}\"", mode
-            mode.load_more_threads mode.buffer.content_height
+            mode.load_more_threads :num => mode.buffer.content_height
           rescue Ferret::QueryParser::QueryParseException => e
             bm.flash "Couldn't parse query."
           end
@@ -168,7 +167,7 @@ begin
             b = BufferManager.spawn_unless_exists(:draft) do
               mode = LabelSearchResultsMode.new [:draft]
             end
-            b.mode.load_more_threads b.content_height
+            b.mode.load_more_threads :num => b.content_height
           end
         when :nothing
         when :redraw

data/bin/sup-import

@@ -76,7 +76,7 @@ def get_login_info uri, sources
 
   username, password = nil, nil
   unless accounts.empty?
-    say "Would you like to use the same account as for a previous source?"
+    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 }
@@ -95,7 +95,6 @@ def get_login_info uri, sources
   [username, password]
 end
 
-
 educate_user if ARGV.member? '--help'
 
 archive = ARGV.delete "--archive"
@@ -180,7 +179,7 @@ begin
         end
 
         m.remove_label :unread if m.status == "RO" unless force_read
-        puts "# message at #{offset}, labels: #{labels * ', '}"
+        puts "# message at #{offset}, labels: #{labels * ', '}" unless rebuild
         if (rebuild || force_rebuild) && 
             (docid, entry = index.load_entry_for_id(m.id)) && entry
           if force_rebuild || entry[:source_info].to_i != offset

data/doc/UserGuide.txt

@@ -0,0 +1,54 @@
+Welcome to Sup! Here's how to actually use it.
+
+To get started, just run 'sup'. Assuming this is your first time,
+you'll be confronted with a mostly blank screen, and a little message
+at the bottom telling you that you have no messages. That's because
+Sup doesn't have any messages in its index. In order to add messages,
+Sup needs to have some "sources" from which to load messages.
+
+If you want to play around a little at this point, you can press 'b'
+to cycle between buffers and 'x' to kill a buffer. There's probably
+not too much interesting there, but there's a log buffer with some
+cryptic messages. You can also press '?' at any point to get a list of
+keyboard commands, but in the absense of any email, these will be
+pretty useless. When you're done, press 'q' to quit.
+
+Now let's add a source to Sup. Run sup-import with a URI pointing to
+an email source. The URI should be of the form:
+- mbox://path/to/a/filename, for an mbox file on disk. (You can also
+  just provide the filename).
+- imap://imap.server/folder or imaps://secure.imap.server/folder for
+  an IMAP server.
+- mbox+ssh://remote.machine/path/to/a/filename for a remote mbox file.
+
+Note: sup-import tries to be smart about setting the labels on
+      messages that it adds (including the special labels "unread" and
+      "inbox"). There are options that control this behavior, and it's
+      worth taking a look at the output of sup-import --help to make
+      sure that you don't end up with 1000 new messages that you've
+      actually already read.
+
+If sup-import requires a username and password for the source, it will
+prompt you for one. Either way, it will start loading messages from
+that source into the index. Depending on the size of the source, this
+may take some time. Don't worry! This is a one-time step, and all the
+computation done now makes operating on the index faster.
+
+Now, before we run 'sup' again, take a moment to edit your
+~/.sup/config.yaml file. Replace "Your Name Here" with your name,
+"your.email.here@domain.tld" with your email address, and fill in your
+.signature file if you choose. You can also set the default editor.
+
+Now run 'sup'. You should messages being loaded into your "inbox!"
+There are two things that are worth understanding at this point.
+First, Sup does not actually use folders. Instead, messages can have
+any number of labels applied to them. Rather than viewing a folder,
+you view the results of a search. So your inbox is simply the set of
+messages that have the 'inbox' label applied to them.
+
+Second, Sup groups together messages into threads. You rarely operate
+on an individual message in Sup.
+
+Press enter to view a thread. 
+
+To be continued...

data/lib/sup.rb

@@ -13,7 +13,7 @@ class Object
 end
 
 module Redwood
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
   BASE_DIR   = ENV["SUP_BASE"] || File.join(ENV["HOME"], ".sup")
   CONFIG_FN  = File.join(BASE_DIR, "config.yaml")

data/lib/sup/buffer.rb

@@ -136,6 +136,7 @@ class BufferManager
     @focus_buf = nil
     @dirty = true
     @minibuf_stack = []
+    @minibuf_mutex = Mutex.new
     @textfields = {}
     @flash = nil
     @shelled = false
@@ -366,12 +367,19 @@ class BufferManager
     end
   end
 
-  def minibuf_lines; [(@flash ? 1 : 0) + @minibuf_stack.compact.size, 1].max; end
+  def minibuf_lines
+    @minibuf_mutex.synchronize do
+      [(@flash ? 1 : 0) + @minibuf_stack.compact.size, 1].max
+    end
+  end
   
   def draw_minibuf opts={}
-    m = @minibuf_stack.compact
-    m << @flash if @flash
-    m << "" if m.empty?
+    m = nil
+    @minibuf_mutex.synchronize do
+      m = @minibuf_stack.compact
+      m << @flash if @flash
+      m << "" if m.empty?
+    end
 
     Ncurses.mutex.lock unless opts[:sync] == false
     Ncurses.attrset Colormap.color_for(:none)
@@ -383,9 +391,13 @@ class BufferManager
   end
 
   def say s, id=nil
-    new_id = id.nil?
-    id ||= @minibuf_stack.length
-    @minibuf_stack[id] = s
+    new_id = nil
+    @minibuf_mutex.synchronize do
+      new_id = id.nil?
+      id ||= @minibuf_stack.length
+      @minibuf_stack[id] = s
+    end
+
     if new_id
       draw_screen :refresh => true
     else
@@ -412,11 +424,13 @@ class BufferManager
   ## a little tricky because we can't just delete_at id because ids
   ## are relative (they're positions into the array).
   def clear id
-    @minibuf_stack[id] = nil
-    if id == @minibuf_stack.length - 1
-      id.downto(0) do |i|
-        break if @minibuf_stack[i]
-        @minibuf_stack.delete_at i
+    @minibuf_mutex.synchronize do
+      @minibuf_stack[id] = nil
+      if id == @minibuf_stack.length - 1
+        id.downto(0) do |i|
+          break if @minibuf_stack[i]
+          @minibuf_stack.delete_at i
+        end
       end
     end
 

data/lib/sup/imap.rb

@@ -48,7 +48,7 @@ class IMAP < Source
     @ids = []
     @labels = [:unread]
     @labels << :inbox unless archived?
-    @labels << mailbox.intern unless mailbox =~ /inbox/i || mailbox.nil?
+    @labels << mailbox.intern unless mailbox =~ /inbox/i
     @mutex = Mutex.new
   end
 
@@ -122,7 +122,10 @@ class IMAP < Source
 
   def host; @parsed_uri.host; end
   def port; @parsed_uri.port || (ssl? ? 993 : 143); end
-  def mailbox; @parsed_uri.path[1..-1] || 'INBOX'; end
+  def mailbox
+    x = @parsed_uri.path[1..-1]
+    x.nil? || x.empty? ? 'INBOX' : x
+  end
   def ssl?; @parsed_uri.scheme == 'imaps' end
 
   def load_header id
@@ -149,6 +152,7 @@ class IMAP < Source
   end
 
   def get_imap_field id, field
+    retries = 0
     f = nil
     imap_id = @imap_ids[id] or raise SourceError, "Unknown message id #{id}. It is likely that messages have been deleted from this IMAP mailbox."
     begin
@@ -157,6 +161,12 @@ class IMAP < Source
       raise SourceError, "IMAP message mismatch: requested #{id}, got #{got_id}. It is likely the IMAP mailbox has been modified." unless got_id == id
     rescue Net::IMAP::Error => e
       raise SourceError, e.message
+    rescue Errno::EPIPE
+      if (retries += 1) <= 3
+        @imap = nil
+        connect
+        retry
+      end
     end
     raise SourceError, "null IMAP field '#{field}' for message with id #{id} imap id #{imap_id}" if f.nil?
 

data/lib/sup/mbox/loader.rb

@@ -37,6 +37,7 @@ class Loader < Source
       @f.seek offset
       l = @f.gets
       unless l =~ BREAK_RE
+        Redwood::log "#{to_s}: offset mismatch in mbox file offset #{offset.inspect}: #{l.inspect}"
         self.broken_msg = "offset mismatch in mbox file offset #{offset.inspect}: #{l.inspect}. Run 'sup-import --rebuild #{to_s}' to correct this." 
         raise SourceError, self.broken_msg
       end

data/lib/sup/mbox/ssh-file.rb

@@ -75,6 +75,15 @@ class Buffer
   def to_s; empty? ? "<empty>" : "[#{start}, #{endd})"; end # for debugging
 end
 
+## sharing a ssh connection to one machines between sources seems to
+## create lots of broken situations: commands returning bizarre (large
+## positive integer) return codes despite working; commands
+## occasionally not working, etc. i suspect this is because of the
+## fragile nature of the ssh syncshell. 
+##
+## at any rate, we now open up one ssh connection per file, which is
+## probably silly in the extreme case.
+
 ## the file-like interface to a remote file
 class SSHFile
   MAX_BUF_SIZE = 1024 * 1024 # bytes
@@ -82,9 +91,6 @@ class SSHFile
   REASONABLE_TRANSFER_SIZE = 1024 * 32
   SIZE_CHECK_INTERVAL = 60 * 1 # seconds
 
-  @@shells = {}
-  @@shells_mutex = Mutex.new
-
   def initialize host, fn, ssh_opts={}
     @buf = Buffer.new
     @host = host
@@ -94,8 +100,11 @@ class SSHFile
     @offset = 0
     @say_id = nil
     @broken_msg = nil
+    @shell = nil
+    @shell_mutex = Mutex.new
   end
 
+  def to_s; "mbox+ssh://#@host/#@fn"; end ## TODO: remove thisis EVILness
   def broken?; !@broken_msg.nil?; end
 
   ## TODO: share this code with imap
@@ -111,33 +120,20 @@ class SSHFile
 
   def connect
     raise SSHFileError, @broken_msg if broken?
-    return if @shell
-
-    key = [@host, @ssh_opts[:username]]
-    @shell = 
-      @@shells_mutex.synchronize do
-      if @@shells.member? key
-        returning(@@shells[key]) do |shell|
-          say "Checking for #@fn..."
-          begin
-            raise Errno::ENOENT, @fn unless shell.test("-e #@fn").status == 0
-          ensure
-            shutup
-          end
-        end
-      else
+
+    @shell_mutex.synchronize do
+      return if @shell
+
+      begin
         say "Opening SSH connection to #{@host}..."
-        begin
-          #raise SSHFileError, "simulated SSH file error"
-          session = Net::SSH.start @host, @ssh_opts
-          say "Starting SSH shell..."
-          shell = session.shell.sync
-          say "Checking for #@fn..."
-          raise Errno::ENOENT, @fn unless shell.test("-e #@fn").status == 0
-          @@shells[key] = shell
-        ensure
-          shutup
-        end
+        #raise SSHFileError, "simulated SSH file error"
+        session = Net::SSH.start @host, @ssh_opts
+        say "Starting SSH shell..."
+        @shell = session.shell.sync
+        say "Checking for #@fn..."
+        raise Errno::ENOENT, @fn unless @shell.test("-e #@fn").status == 0
+      ensure
+        shutup
       end
     end
   end
@@ -178,10 +174,16 @@ private
       # MBox::debug "sending command: #{cmd.inspect}"
       begin
         result = @shell.send_command cmd
-        raise SSHFileError, "Failure during remote command #{cmd.inspect}: #{result.stderr[0 .. 100]}" unless result.status == 0
+        raise SSHFileError, "Failure during remote command #{cmd.inspect}: #{(result.stderr || result.stdout || "")[0 .. 100]}" unless result.status == 0
       rescue Net::SSH::Exception # these happen occasionally for no apparent reason. gotta love that nondeterminism!
-        retry if (retries += 1) < 3
+        retry if (retries += 1) <= 3
         raise
+      rescue Errno::EPIPE
+        if (retries += 1) <= e
+          @shell = nil
+          connect
+          retry
+        end
       end
     rescue Net::SSH::Exception, SSHFileError, Errno::ENOENT => e
       @broken_msg = e.message

data/lib/sup/modes/contact-list-mode.rb

@@ -60,7 +60,7 @@ class ContactListMode < LineCursorMode
   def multi_search people
     mode = PersonSearchResultsMode.new people
     BufferManager.spawn "personal search results", mode
-    mode.load_more_threads mode.buffer.content_height
+    mode.load_more_threads :num => mode.buffer.content_height
   end
 
   def search

data/lib/sup/modes/inbox-mode.rb

@@ -28,19 +28,21 @@ class InboxMode < ThreadIndexMode
 
   def is_relevant? m; m.has_label? :inbox; end
 
-  def load_more_threads n=ThreadIndexMode::LOAD_MORE_THREAD_NUM
+  def load_more_threads opts={}
+    n = opts[:num] || ThreadIndexMode::LOAD_MORE_THREAD_NUM
     load_n_threads_background n, :label => :inbox,
                                  :load_killed => false,
                                  :load_spam => false,
-                                 :when_done => lambda { |num|
+                                 :when_done => (lambda do |num|
+      opts[:when_done].call if opts[:when_done]
       BufferManager.flash "Added #{num} threads."
-    }
+    end)
   end
 
   def reload
     drop_all_threads
     BufferManager.draw_screen
-    load_more_threads buffer.content_height
+    load_more_threads :num => buffer.content_height
   end
 end
 

data/lib/sup/modes/label-list-mode.rb

@@ -81,7 +81,7 @@ protected
       b = BufferManager.spawn_unless_exists(label) do
         mode = LabelSearchResultsMode.new [label]
       end
-      b.mode.load_more_threads b.content_height
+      b.mode.load_more_threads :num => b.content_height
     end
   end
 end

data/lib/sup/modes/label-search-results-mode.rb

@@ -12,11 +12,13 @@ class LabelSearchResultsMode < ThreadIndexMode
 
   def is_relevant? m; @labels.all? { |l| m.has_label? l }; end
 
-  def load_more_threads n=ThreadIndexMode::LOAD_MORE_THREAD_NUM
+  def load_more_threads opts={}
+    n = opts[:num] || ThreadIndexMode::LOAD_MORE_THREAD_NUM
     load_n_threads_background n, :labels => @labels,
                                  :load_killed => true,
                                  :load_spam => false,
                                  :when_done =>(lambda do |num|
+      opts[:when_done].call if opts[:when_done]
       if num > 0
         BufferManager.flash "Found #{num} threads"
       else

data/lib/sup/modes/person-search-results-mode.rb

@@ -12,11 +12,13 @@ class PersonSearchResultsMode < ThreadIndexMode
 
   def is_relevant? m; @people.any? { |p| m.from == p }; end
 
-  def load_more_threads n=ThreadIndexMode::LOAD_MORE_THREAD_NUM
+  def load_more_threads opts={}
+    n = opts[:num] || ThreadIndexMode::LOAD_MORE_THREAD_NUM
     load_n_threads_background n, :participants => @people,
                                  :load_killed => true,
                                  :load_spam => false,
                                  :when_done =>(lambda do |num|
+      opts[:when_done].call if opts[:when_done]
       if num > 0
         BufferManager.flash "Found #{num} threads"
       else

data/lib/sup/modes/search-results-mode.rb

@@ -13,11 +13,13 @@ class SearchResultsMode < ThreadIndexMode
   ## TODO: think about this
   def is_relevant? m; super; end
 
-  def load_more_threads n=ThreadIndexMode::LOAD_MORE_THREAD_NUM
+  def load_more_threads opts={}
+    n = opts[:num] || ThreadIndexMode::LOAD_MORE_THREAD_NUM
     load_n_threads_background n, :qobj => @qobj,
                                  :load_killed => true,
                                  :load_spam => false,
                                  :when_done =>(lambda do |num|
+      opts[:when_done].call if opts[:when_done]
       if num > 0
         BufferManager.flash "Found #{num} threads"
       else

data/lib/sup/modes/thread-index-mode.rb

@@ -72,6 +72,7 @@ class ThreadIndexMode < LineCursorMode
   def handle_add_update m
     if is_relevant?(m) || @ts.is_relevant?(m)
       @ts.load_thread_for_message m
+      @new_cache.delete @ts.thread_for(m) # force recalculation of newness
       update
     end
   end

data/lib/sup/source.rb

@@ -38,7 +38,7 @@ class Source
   end
 
   def broken?; !@broken_msg.nil?; end
-  def to_s; @uri; end
+  def to_s; @uri.to_s; end
   def seek_to! o; self.cur_offset = o; end
   def reset!
     return if broken?

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: sup
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-01-02 00:00:00 -08:00
+  version: 0.0.4
+date: 2007-01-03 00:00:00 -08:00
 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.
 require_paths: 
 - lib
@@ -39,6 +39,7 @@ files:
 - doc/FAQ.txt
 - doc/Philosophy.txt
 - doc/TODO
+- doc/UserGuide.txt
 - lib/sup.rb
 - lib/sup/account.rb
 - lib/sup/buffer.rb
@@ -136,3 +137,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: