sup 0.0.6 → 0.0.7

data/doc/FAQ.txt

@@ -1,27 +1,55 @@
 Sup FAQ
 -------
 Q: What does Sup stand for?
-A: It stands for "what's up?", which is more or less the question I'm
-   asking when I read my mail.
+A: It stands for "what's up?", which is more or less the question in
+   mind when I fire up my mail client.
 
 Q: If you love GMail so much, why not just use it?
-A: I hate using a mouse, and I hate ads, and I hate non-programmability
+A: I hate ads, I hate using a mouse, and I hate non-programmability
    and non-extensibility.
 
+   Also, GMail encourages top-posting in a variety of ways. THIS
+   CANNOT BE TOLERATED!
+
 Q: Why the console?
-A: There are many advantages to the console. As any Unix user knows, a
-   few keystrokes can accomplish the work of a hundred mouse clicks.
-   Also, you don't need web browser, and you get instantaneous response
-   and a simple interface.
 
-   That said, a good Ajax programmer could probably replicate GMail
-   pretty easily using Sup as the backend.
+A: Because a keystroke is with a hundred mouse clicks (as any Unix
+   user knows). Because you don't need web browser. Because you get
+   instantaneous response and a simple interface.
 
 Q: How does Sup deal with spam?
 A: You can manually mark messages as spam, which prevents them from
-   showing up in future searches, but that's all that Sup does. Spam
+   showing up in future searches, but that's as far as Sup goes. Spam
    filtering should be done by a dedicated tool like SpamAssassin.
 
+Q: How do I delete a message?
+A: Press the 'd' key.
+
+Q: But I want to delete it for real, not just add a 'deleted' flag in
+   the index. I want it gone from disk!
+A: Deleting a message is an old-fashioned concept. In the modern
+   world, disk space is cheap enough that you should never have to
+   delete a message. If it's spam, save it for future analysis.
+
+Q: C'mon, really now!
+A: Ok, at some point I plan to have a batch deletion tool that will
+   run through a source and delete all messages that have a 'spam' or
+   'deleted' tags (and, for mbox sources, will update the offsets of
+   all later messages). But that doesn't exist yet.
+
+Q: I got some error message about needing to run sup-import --rescan
+   when I tried to read a message. What's that about?
+A: If messages have been moved, deleted, or altered in a source, Sup
+   may have to rebuild its index for that source. For example, for
+   mbox files, even reading a message changes the offsets of every
+   file on disk. Rather than rescanning every time, Sup assumes
+   sources don't change except by having new messages added. If that
+   assumption is violated, you'll have to run sup-import --rescan.
+
+   The alternative is to rescan every source when Sup starts
+   up. Because Sup is designed to work with arbitrarily large mbox
+   files, this would not be a good idea.
+
 Q: What are all these "Redwood" references I see in the code?
 A: That was Sup's original name. (Think pine, elm. Although I am a
    Mutt user, I couldn't think of a good progression there.) But it was
@@ -31,9 +59,18 @@ A: That was Sup's original name. (Think pine, elm. Although I am a
    Maybe one day I'll do a huge search-and-replace on the code, but it
    doesn't seem that important at this point.
 
+Q: I want to move messages from one source to another. (E.g., my
+   primary inbox is an IMAP server with a quota, and I want to move
+   some of those messages to local mbox files.) How do I do that while
+   preserving message state?
+A: Move the messages from the source to the target using whatever tool
+   you'd like. Then (and this is the important part), sup-import
+   --rebuild both sources at once. If you do it one at a time, you may
+   lose message state. (Depending, actually, on which order you do it
+   in. But just do them both at once.)
+
 Q: How is Sup possible?
 A: Sup is only possible through the hard work of Dave Balmain, the
    author of ferret, which is the search engine behind Sup. Ferret is
    really a first-class piece of software, and it's due to the
    tremendous amount of time and effort he's put in to it.
-

data/doc/TODO

@@ -1,25 +1,58 @@
-fix bug: when returning from a shelling out, ncurses is crazy 
-batch deletion
+for 0.0.8
+---------
+create attachments
+forward attachments
+warnings: top-posting, missing attachment
 maildir
-on startup, multi-threadedly call #connect on all sources 
-support for message-content modules such as ruby-talk:XXXXX detection
+
+for 0.0.9
+---------
+select all, starred, to me, etc
+undo
 use Net::SMTP
-search for other messages from author in thread-view-mode
-forward attachments
-tab completion on labels, contacts
+gmail
+
+future
+------
+decode RFC 2047 ("encoded word") headers
+  - see: http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/101949, http://dev.rubyonrails.org/ticket/6807
+swappable keymappings
 within-buffer search
+bugfix: when returning from a shelling out, ncurses is crazy 
+bugfix: miscellaneous weirdnesses in buffer line editing
+wide character support
+i18n support
+batch deletion
+support for message-content modules such as ruby-talk:XXXXX detection
+tab completion on labels, contacts
 contact selector in edit-message-mode
-undo
 maybe: filters
 maybe: rangefilter on the initial inbox to only consider the most recent 1000 messages
-select all, starred, to me, etc
-editing of arbitrary messages
 annotations on messages
-gmail
 pop
-move sup-import argument handling to getopt
 be able to mark individual messages as spam in thread-view-mode
+toggle wrapping
+maybe: de-archived messages auto-added to inbox
 
+done
+----
+x make 'A' archive in thread-view-mode
+x remove stupid percent_done source methods (still useful; made it optional)
+x don't quit while writing thread index state to disk or with unsaved drafts/messages
+x bugfix: deleted threads are showing up (i don't see this any more)
+x bugfix: changing IMAP ids
+x bugfix: STILL new messages, drafts sometimes not showing up in inbox
+x bugfix: killed threads
+x bugfix: resuming a draft asks before discard
+x add a flag to sup-import to force the creation of a new source (see http://rubyforge.org/forum/forum.php?thread_id=10973&forum_id=10340)
+x use trollop to handle sup-devel args
+x clean up import code and share between poll.rb and sup-import
+x on startup, multi-threadedly call #connect on all sources 
+x bugfix: first time viewing a message only gets the first to:; subsequent views get them all (wtf)
+x search for other messages from author in thread-view-mode
+x resuming of arbitrary messages
+x alias authors in thread-view-mode
+x fix up contact list mode: should display while loading, and when you add an alias, should move everything else to the right
 x fix bug: envelope-to thing still not working
 x fix snippet repetitions with small snippets
 x fix next and previous in thread-view-mode with <unreceived messages>

data/doc/UserGuide.txt

@@ -1,6 +1,6 @@
-Welcome to Sup! Here's how to actually use it.
+Welcome to Sup! Here's how to get started.
 
-First, try running 'sup'. Assuming this is your first time, you'll be
+First, try running 'sup'. Since this is your first time, you'll be
 confronted with a mostly blank screen, and a notice at the bottom that
 you have no new messages. That's because Sup doesn't have any messages
 in its index yet, and has no idea where to look for them anyways.
@@ -10,55 +10,67 @@ 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
-mostly useless. When you're bored, press 'q' to quit.
-
-We need to add some messages to Sup. In order for Sup to know about a
-message, it must be in the index. In order for Sup to load a message
-into the index, it must know about the "source" in which it
-resides. Sup stores all information necessary for search, and all
-state we have about a message, in the index, but doesn't duplicate the
-actual contents of the message itself. So when you search for messages
-or view your inbox, Sup just talks to the index (stored locally on
-disk), but when you view a message, Sup must request it from the
-source.
-
-So let's tell Sup about some sources. Run 'sup-import' with a URI
-pointing to an email source. The URI should be of the form:
+mostly useless. When you get bored, press 'q' to quit.
+
+I mentioned that Sup's index was empty. The index is where Sup stores
+all message state (e.g. read or unread, any message labels), and all
+information necessary for searching and for threading messages. Sup
+only knows about messages in its index, so we've got to add some to
+it.
+
+We add messages to the index by telling Sup about the source where the
+messages reside. Sources are things like imap folders, mbox folders,
+maildir directories, and gmail accounts (in the future). Sup doesn't
+duplicate the actual message content in the index. So when you search
+for messages or view your inbox, Sup talks only to the index (stored
+locally on disk). When you view a thread, Sup requests the full
+content of all the messages from the source.
+
+So let's add some sources to Sup's source list. Run 'sup-add' 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 folder. (Leave the folder blank for INBOX.)
 - mbox+ssh://remote.machine/path/to/a/filename for a remote mbox file.
 
-Before you actually import messages, you need to decide whether you
-want them to be archived or not. An archived message will not show up
-in your inbox. (Your inbox in Sup is, by definition, the set of all
-all non-archived messages). If you specify --force-archive, messages
-imported at *this* time will be archived, but new messages will go to
-your inbox. If you specify --archive, messages imported at *any* time
-will be automatically archived. (This is useful for sources that
-contain high-traffic mailing lists that you don't want "polluting"
-your inbox.)
-
-Typically you'll want to specify --archive for every source you import
-except your actual inbox. You can also force all messages to be marked
-as read; run sup-import --help for details. The default is to preserve
-the read/unread status from the source.
-
-Now run sup-import to add the source. If it requires a username and
-password for the source, it will prompt you. Either way, it will add
-the sources to Sup, and immediately start loading messages from them
-into the index. Depending on the size of the source, this may take a
+Before you add the source, you need make two decisions. The first is
+whether you want Sup to regularly poll this source for new
+messages. By default it will, but if this is a source that will never
+have new messages, you can specify --unusual. Sup polls only "usual"
+sources.
+
+The second is whether you want messages from the source to be
+automatically archived. An archived message will not show up in your
+inbox, but will be found when you search. (Your inbox in Sup is, by
+definition, the set of all all non-archived messages). Specify
+--archive to automatically archive all messages from the source. This
+is useful for sources that contain, for example, high-traffic mailing
+lists that you don't want "polluting" your inbox.
+
+If Sup requires account information, e.g. for IMAP servers and remote
+mbox files, sup-add will ask for it.
+
+Now that you've added the source, let's import all the current
+messages from it, by running sup-import with the source URI. You can
+specify --archive to automatically archive all messages in this
+import; typically you'll want to specify this for every source you
+import except your actual inbox. You can also specify --read to mark
+all imported messages as read; the default is to preserve the
+read/unread status from the source.
+
+sup-import will now load all the messages from the source into the
+index. Depending on the size of the source, this may take a
 while. Don't panic! It's a one-time process.
 
-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.
+We're almost ready. But 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.
 
-We're finally ready to run 'sup'. You should see the most recent
-loaded messages appear in your inbox. Congratulations, you've got Sup
-working!
+Ok, now run 'sup'. You should see the most recent unarchived messages
+appear in your inbox. Congratulations, you've got Sup working!
 
 If you're coming from the world of traditional email, there are a
 couple differences you should be aware of at this point. First, Sup

data/lib/sup.rb

@@ -13,13 +13,13 @@ class Object
 end
 
 module Redwood
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 
   BASE_DIR   = ENV["SUP_BASE"] || File.join(ENV["HOME"], ".sup")
   CONFIG_FN  = File.join(BASE_DIR, "config.yaml")
   SOURCE_FN  = File.join(BASE_DIR, "sources.yaml")
   LABEL_FN   = File.join(BASE_DIR, "labels.txt")
-  PERSON_FN   = File.join(BASE_DIR, "people.txt")
+  PERSON_FN  = File.join(BASE_DIR, "people.txt")
   CONTACT_FN = File.join(BASE_DIR, "contacts.txt")
   DRAFT_DIR  = File.join(BASE_DIR, "drafts")
   SENT_FN    = File.join(BASE_DIR, "sent.mbox")
@@ -34,6 +34,10 @@ module Redwood
       begin
         yield
       rescue Exception => e
+        File.open("sup-exception-log.txt", "w") do |f|
+          f.puts "--- #{e.class.name} at #{Time.now}"
+          f.puts e.message, e.backtrace
+        end
         $exception ||= e
         raise
       end

data/lib/sup/buffer.rb

@@ -14,7 +14,7 @@ module Ncurses
   end
 
   def mutex; @mutex ||= Mutex.new; end
-  def sync &b; mutex.synchronize &b; end
+  def sync &b; mutex.synchronize(&b); end
 
   ## aaahhh, user input. who would have though that such a simple
   ## idea would be SO FUCKING COMPLICATED?! because apparently
@@ -139,7 +139,7 @@ class BufferManager
     @minibuf_mutex = Mutex.new
     @textfields = {}
     @flash = nil
-    @shelled = false
+    @shelled = @asking = false
 
     self.class.i_am_the_instance self
   end
@@ -271,6 +271,21 @@ class BufferManager
     b
   end
 
+  def kill_all_buffers_safely
+    until @buffers.empty?
+      ## inbox mode always claims it's unkillable. we'll ignore it.
+      return false unless @buffers.first.mode.is_a?(InboxMode) || @buffers.first.mode.killable?
+      kill_buffer @buffers.first
+    end
+    true
+  end
+
+  def kill_buffer_safely buf
+    return false unless buf.mode.killable?
+    kill_buffer buf
+    true
+  end
+
   def kill_all_buffers
     kill_buffer @buffers.first until @buffers.empty?
   end
@@ -359,9 +374,9 @@ class BufferManager
     ret
   end
 
+  ## returns true (y), false (n), or nil (ctrl-g / cancel)
   def ask_yes_or_no question
-    r = ask_getch(question, "ynYN")
-    case r
+    case(r = ask_getch question, "ynYN")
     when ?y, ?Y
       true
     when nil
@@ -399,6 +414,7 @@ class BufferManager
 
   def say s, id=nil
     new_id = nil
+
     @minibuf_mutex.synchronize do
       new_id = id.nil?
       id ||= @minibuf_stack.length

data/lib/sup/contact.rb

@@ -5,33 +5,43 @@ class ContactManager
 
   def initialize fn
     @fn = fn
-    @people = {}
+    @p2a = {} # person to alias map
+    @a2p = {} # alias to person map
 
     if File.exists? fn
       IO.foreach(fn) do |l|
         l =~ /^(\S+): (.*)$/ or raise "can't parse #{fn} line #{l.inspect}"
         aalias, addr = $1, $2
-        @people[aalias] = Person.for addr
+        p = Person.for addr
+        @p2a[p] = aalias
+        @a2p[aalias] = p
       end
     end
 
     self.class.i_am_the_instance self
   end
 
-  def contacts; @people; end
+  def contacts; @p2a.keys; end
   def set_contact person, aalias
-    oldentry = @people.find { |a, p| p == person }
-    @people.delete oldentry.first if oldentry
-    @people[aalias] = person
+    if(pold = @a2p[aalias]) && (pold != person)
+      drop_contact pold
+    end
+    @p2a[person] = aalias
+    @a2p[aalias] = person
   end
-  def drop_contact person; @people.delete person; end
-  def delete t; @people.delete t; end
-  def resolve aalias; @people[aalias]; end
-
+  def drop_contact person
+    if(aalias = @p2a[person])
+      @p2a.delete person
+      @a2p.delete aalias
+    end
+  end    
+  def person_with aalias; @a2p[aalias]; end
+  def alias_for person; @p2a[person]; end
+  def is_contact? person; @p2a.member? person; end
   def save
     File.open(@fn, "w") do |f|
-      @people.keys.sort.each do |aalias|
-        f.puts "#{aalias}: #{@people[aalias].full_address}"
+      @p2a.each do |p, a|
+        f.puts "#{a}: #{p.full_address}"
       end
     end
   end

data/lib/sup/draft.rb

@@ -10,7 +10,7 @@ class DraftManager
     self.class.i_am_the_instance self
   end
 
-  def self.source_name; "drafts://"; end
+  def self.source_name; "sup://drafts"; end
   def self.source_id; 9999; end
   def new_source; @source = DraftLoader.new; end
 
@@ -19,11 +19,15 @@ class DraftManager
     fn = @source.fn_for_offset offset
     File.open(fn, "w") { |f| yield f }
 
-    @source.each do |offset, labels|
-      m = Message.new :source => @source, :source_info => offset, :labels => labels
+    my_message = nil
+    @source.each do |thisoffset, theselabels|
+      m = Message.new :source => @source, :source_info => thisoffset, :labels => theselabels
       Index.add_message m
-      UpdateManager.relay :add, m
+      UpdateManager.relay self, :add, m
+      my_message = m if thisoffset == offset
     end
+
+    my_message
   end
 
   def discard mid
@@ -32,7 +36,7 @@ class DraftManager
     raise ArgumentError, "not a draft: source id #{entry[:source_id].inspect}, should be #{DraftManager.source_id.inspect} for #{mid.inspect} / docno #{docid}" unless entry[:source_id].to_i == DraftManager.source_id
     Index.drop_entry docid
     File.delete @source.fn_for_offset(entry[:source_info])
-    UpdateManager.relay :delete, mid
+    UpdateManager.relay self, :delete, mid
   end
 end
 
@@ -48,9 +52,16 @@ class DraftLoader < Source
 
   def id; DraftManager.source_id; end
   def to_s; DraftManager.source_name; end
+  def uri; DraftManager.source_name; end
 
   def each
-    Dir.entries(@dir).select { |x| x =~ /^\d+$/ }.sort_by { |x| x.to_i }.each { |id| yield [id, [:draft]] }
+    ids = get_ids
+    ids.each do |id|
+      if id >= cur_offset
+        self.cur_offset = id + 1
+        yield [id, [:draft, :inbox]]
+      end
+    end
   end
 
   def gen_offset
@@ -96,7 +107,16 @@ class DraftLoader < Source
   end
 
   def start_offset; 0; end
-  def end_offset; Dir.new(@dir).entries.sort.last.to_i; end
+  def end_offset
+    ids = get_ids
+    ids.empty? ? 0 : (ids.last + 1)
+  end
+
+private
+
+  def get_ids
+    Dir.entries(@dir).select { |x| x =~ /^\d+$/ }.map { |x| x.to_i }.sort
+  end
 end
 
 Redwood::register_yaml(DraftLoader, %w(cur_offset))