sup 0.19.0

data/contrib/colorpicker.rb

@@ -0,0 +1,100 @@
+require 'rubygems'
+
+require 'ncursesw'
+
+Ncurses.initscr
+Ncurses.noecho
+Ncurses.cbreak
+Ncurses.start_color
+
+Ncurses.curs_set 0
+Ncurses.move 0, 0
+Ncurses.clear
+Ncurses.refresh
+cc = Ncurses.COLORS
+
+Ncurses::keypad(Ncurses::stdscr, 1)
+Ncurses::mousemask(Ncurses::ALL_MOUSE_EVENTS | Ncurses::REPORT_MOUSE_POSITION, [])
+
+fail "color count is #{cc}, expected 256" unless cc == 256
+
+1.upto(255) do |c|
+  Ncurses.init_pair(c, 0, c)
+end
+
+def cell y, x, c
+  @map[[y,x]] = c
+  Ncurses.attron(Ncurses.COLOR_PAIR(c))
+  Ncurses.mvaddstr(y, x, " ")
+  Ncurses.attroff(Ncurses.COLOR_PAIR(c))
+end
+
+def handle_click y, x
+  c = @map[[y,x]] or return
+  name = case c
+  when 0...16
+    c.to_s
+  when 16...232
+    'c' + (c-16).to_s(6).rjust(3,'0')
+  when 232...256
+    'g' + (c-232).to_s
+  end
+
+  Ncurses.mvaddstr 11, 0, "#{name}            "
+
+  Ncurses.attron(Ncurses.COLOR_PAIR(c))
+  10.times do |i|
+    20.times do |j|
+      y = 13 + i
+      x = j
+      Ncurses.mvaddstr(y, x, " ")
+    end
+  end
+  Ncurses.attroff(Ncurses.COLOR_PAIR(c))
+end
+
+@map = {}
+@fg = @bg = 0
+
+begin
+  16.times do |i|
+    cell 0, i, i
+  end
+
+  6.times do |i|
+    6.times do |j|
+      6.times do |k|
+        c = 16 + 6*6*i + 6*j + k
+        y = 2 + j
+        x = 7*i + k
+        cell y, x, c
+      end
+    end
+  end
+
+  16.times do |i|
+    c = 16 + 6*6*6 + i
+    cell 9, i, c
+  end
+
+  handle_click 0, 0
+  Ncurses.refresh
+
+  while (c = Ncurses.getch)
+    case c
+    when 113 #q
+      break
+    when Ncurses::KEY_MOUSE
+      mev = Ncurses::MEVENT.new
+      Ncurses.getmouse(mev)
+      case(mev.bstate)
+      when Ncurses::BUTTON1_CLICKED
+        handle_click mev.y, mev.x
+      end
+    end
+    Ncurses.refresh
+  end
+
+ensure
+  Ncurses.endwin
+end

data/contrib/completion/_sup.zsh

@@ -0,0 +1,114 @@
+#compdef sup sup-add sup-config sup-dump sup-sync sup-tweak-labels sup-recover-sources
+# vim: set et sw=2 sts=2 ts=2 ft=zsh :
+
+# TODO: sources completion: maildir://some/dir, mbox://some/file, ...
+#       for sup-add, sup-sync, sup-tweak-labels
+
+(( ${+functions[_sup_cmd]} )) ||
+_sup_cmd()
+{
+  _arguments -s : \
+    "(--list-hooks -l)"{--list-hooks,-l}"[list all hooks and descriptions, and quit]" \
+    "(--no-threads -n)"{--no-threads,-n}"[turn off threading]" \
+    "(--no-initial-poll -o)"{--no-initial-poll,-o}"[Don't poll for new messages when starting]" \
+    "(--search -s)"{--search,-s}"[search for this query upon startup]:Query: " \
+    "(--compose -c)"{--compose,-c}"[compose message to this recipient upon startup]:Email: " \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_add_cmd]} )) ||
+_sup_add_cmd()
+{
+  _arguments -s : \
+    "(--archive -a)"{--archive,-a}"[automatically archive all new messages from this source]" \
+    "(--unusual -u)"{--unusual,-u}"[do not automatically poll for new messages from this source]" \
+    "(--labels -l)"{--labels,-l}"[set of labels to apply to all messages from this source]:Labels: " \
+    "(--force-new -f)"{--force-new,-f}"[create a new account for this source, even if one already exists]" \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_config_cmd]} )) ||
+_sup_config_cmd()
+{
+  _arguments -s : \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_dump_cmd]} )) ||
+_sup_dump_cmd()
+{
+  _arguments -s : \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_recover_sources_cmd]} )) ||
+_sup_recover_sources_cmd()
+{
+  _arguments -s : \
+    "--archive[automatically archive all new messages from this source]" \
+    "--scan-num[number of messages to scan per source]:" \
+    "--unusual[do not automatically poll for new messages from this source]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_sync_cmd]} )) ||
+_sup_sync_cmd()
+{
+  # XXX Add only when --restore is given: (--restored -r)
+  #     Add only when --changed or--all are given: (--start-at -s)
+  _arguments -s : \
+    "--new[operate on new messages only]" \
+    "(--changed -c)"{--changed,-c}"[scan over the entire source for messages that have been deleted, altered, or moved from another source]" \
+    "(--restored -r)"{--restored,-r}"[operate only on those messages included in a dump file as specified by --restore which have changed state]" \
+    "(--all -a)"{--all,-a}"[operate on all messages in the source, regardless of newness or changedness]" \
+    "(--start-at -s)"{--start-at,-s}"[start at a particular offset]:Offset: " \
+    "--asis[if the message is already in the index, preserve its state, otherwise, use default source state]" \
+    "--restore[restore message state from a dump file created with sup-dump]:File:_file" \
+    "--discard[discard any message state in the index and use the default source state]" \
+    "(--archive -x)"{--archive,-x}"[mark messages as archived when using the default source state]" \
+    "(--read -e)"{--read,-e}"[mark messages as read when using the default source state]" \
+    "--extra-labels[apply these labels when using the default source state]:Labels: " \
+    "(--verbose -v)"{--verbose,-v}"[print message ids as they're processed]" \
+    "(--optimize -o)"{--optimize,-o}"[as the final operation, optimize the index]" \
+    "--all-sources[scan over all sources]" \
+    "(--dry-run -n)"{--dry-run,-n}"[don't actually modify the index]" \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_sync_back_cmd]} )) ||
+_sup_sync_back_cmd()
+{
+  _arguments -s : \
+    "(--drop-deleted -d)"{--drop-deleted,-d}"[drop deleted messages]" \
+    "--move-deleted[move deleted messages to a local mbox file]:File:_file" \
+    "(--drop-spam -s)"{--drop-spam,-s}"[drop spam messages]" \
+    "--move-spam[move spam messages to a local mbox file]:File:_file" \
+    "--with-dotlockfile[specific dotlockfile location (mbox files only)]:File:_file" \
+    "--dont-use-dotlockfile[don't use dotlockfile to lock mbox files]" \
+    "(--verbose -v)"{--verbose,-v}"[print message ids as they're processed]" \
+    "(--dry-run -n)"{--dry-run,-n}"[don't actually modify the index]" \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+(( ${+functions[_sup_tweak_labels_cmd]} )) ||
+_sup_tweak_labels_cmd()
+{
+  _arguments -s : \
+    "(--add -a)"{--add,-a}"[which labels to add to every message from the specified sources]:Labels: " \
+    "(--remove -r)"{--remove,-r}"[which labels to remove from every message from the specified sources]:Labels: " \
+    "--all-sources[scan over all sources]" \
+    "(--verbose -v)"{--verbose,-v}"[print message ids as they're processed]" \
+    "(--dry-run -n)"{--dry-run,-n}"[don't actually modify the index]" \
+    "--version[show version information]" \
+    "(--help -h)"{--help,-h}"[show help]"
+}
+
+_call_function ret _${words[1]//-/_}_cmd
+return ret
+

data/devel/console.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+irb -I lib -r ./devel/start-console.rb

data/devel/count-loc.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+egrep ".rb$"  Manifest.txt | xargs cat | grep -v "^ *$"|grep -v "^ *#"|grep -v "^ *end *$"|wc -l

data/devel/load-index.rb

@@ -0,0 +1,9 @@
+require 'sup'
+
+puts "loading index..."
+@index = Redwood::Index.new
+@index.load
+@i = @index.index
+puts "loaded index of #{@i.size} messages"
+
+

data/devel/profile.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'ruby-prof'
+require "redwood"
+
+result = RubyProf.profile do
+  Redwood::ThreadSet.new(ARGV.map { |fn| Redwood::MBox::Scanner.new fn }).load_n_threads 100
+end
+
+printer = RubyProf::GraphHtmlPrinter.new(result)
+File.open("profile.html", "w") { |f| printer.print(f, 1) }
+puts "report in profile.html"
+

data/devel/start-console.rb

@@ -0,0 +1,5 @@
+require 'sup'
+include Redwood
+start
+Index.init
+Index.load

data/doc/FAQ.txt

@@ -0,0 +1,119 @@
+Sup FAQ
+-------
+
+Q: What is Sup?
+A: A console-based email client for people with a lot of email.
+
+Q: What does Sup stand for?
+A: "What's up?"
+
+Q: Sup looks like a text-based Gmail.
+A: First I stole their ideas. Then I improved them.
+
+Q: Why not just use Gmail?
+A: I hate ads, I hate using a mouse, and I hate non-programmability and
+   non-extensibility.
+
+   Also, Gmail doesn't let you use a monospace font, which is just
+   lame.
+
+   Also, Gmail encourages top-posting. THIS CANNOT BE TOLERATED!
+
+Q: Why the console?
+A: Because a keystroke is worth a hundred mouse clicks, as any Unix
+   user knows. Because you don't need a web browser. Because you get
+   an 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. Later, you can run a batch process to
+   remove such messages from your sources. 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: Why delete? Unless it's spam, you might as well just archive it.
+
+Q: C'mon, really now!
+A: Ok, 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: Currently, for mbox sources, there is a batch deletion tool that
+   will strip out all messages marked as spam or deleted.
+
+Q: How well does Sup play with other mail clients?
+A: Not well at all. If messages have been moved, deleted, or altered
+   due to some other client, Sup will have to rebuild its index for
+   that message source. For example, for mbox files, reading a single
+   unread 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 sync the index.
+
+Q: How do I back up my index?
+A: Since the contents of the messages are recoverable from their
+   sources using sup-sync, all you need to back up is the message
+   state. To do this, simply run:
+      sup-dump > <dumpfile>
+   This will save all message state in a big text file, which you
+   should probably compress.
+
+Q: How do I restore the message state I saved in my state dump?
+A: Run:
+     sup-sync [<source>+] --restored --restore <dumpfile>
+   where <dumpfile> was created as above.
+
+Q: Xapian crashed and I can't read my index. Luckily I made a state
+   dump. What should I do?
+Q: How do I rebuild the index completely?
+A: Run:
+     rm -rf ~/.sup/xapian    # omg wtf
+     sup-sync --all-sources --all --restore <dumpfile>
+   Voila! A brand new index.
+
+Q: I want to move messages from one source to another. (E.g., my
+   primary inbox is an mbox file, and I want to move some of those
+   messages to a Maildir.) 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. Mutt's a good one. :) Then run:
+     sup-sync --changed <source1> <source2>
+
+   Note that if you sup-sync only one source at a time, depending on
+   the order in which you do it, the messages may be treated as
+   missing and then deleted from the index, which means that their
+   states will be lost when you sync the other source. So do them both
+   in one go.
+
+Q: What are all these "Redwood" references I see in the code?
+A: That was Sup's original name. (Think pine, elm. Although I was a
+   Mutt user, I couldn't think of a good progression there.) But it was
+   taken by another project on RubyForge, and wasn't that original, and
+   was too long to type anyways.
+
+Common Problems
+---------------
+
+P: I get some error message from Rubymail about frozen strings when
+   importing messages with attachments.
+S: The current solution is to directly modify RubyMail. 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 Armstrong.
+
+P: I see this error:
+     /usr/local/lib/ruby/1.8/yaml.rb:133:in `transfer': allocator undefined for Bignum (TypeError)
+S: You need to upgrade to Ruby 1.8.5. YAML in earlier versions can't
+   parse BigNums, but Sup relies on that for Maildir.
+
+P: When I run Sup remotely and view an HTML attachment, an existing
+   Firefox on the *local* machine is redirected to the attachment
+   file, which it can't find (since it's on the remote machine). How do
+   I view HTML attachments in this environment?
+S: Put this in your ~/.mailcap on the machine you run Sup on:
+      text/html; /usr/bin/firefox -a sup %s; description=HTML Text; test=test -n "$DISPLAY";  nametemplate=%s.html
+
+   Please read
+   https://github.com/sup-heliotrope/sup/wiki/Viewing-Attachments for
+   some security concerns on opening attachments.

data/doc/Hooks.txt

@@ -0,0 +1,79 @@
+Sup's Hook System
+-----------------
+
+Sup can be easily customized via its hook system, which allows custom
+user code to be injected into Sup's execution path by "hooking" the
+code onto pre-defined events. When those events occur, the code is
+executed.
+
+To see which hooks are available, simply run sup -l. Each hook sits in
+a file in ~/.sup/hooks/. Hooks are written in Ruby, and require no
+class or method definitions, just the executable code itself.
+
+Information passes from Sup to the hook code via Ruby variables
+(actually method calls), and from the hook code back to Sup via a
+return value. The values of variables persists across calls to the
+same hook, but is NOT available to other hooks. To make the value of a
+variable available to other hooks, use the get and set methods.  Each
+hook description lists the variables and return value expected, if
+any.
+
+The following special functions are available to hooks:
+* say msg
+  Displays the string msg to the user at the bottom of the screen.
+* log msg
+  Adds the string msg to the log, which the user can access via the
+  buffer list.
+* ask_yes_or_no question
+  Prompts the user with the string question for a yes or no
+  response. Returns true if the user answered yes, false otherwise.
+* get key
+  Gets the cross-hook value associated with key (which is typically a
+  string). If there is no value for a given key, nil is returned.
+* set key value
+  Sets the cross-hook value associated with key to value. key is
+  typically a string, while value can be whatever type it needs to be,
+  including nil.
+
+Some example hooks:
+
+before-poll:
+  ## runs fetchmail before polling
+  if (@last_fetchmail_time || Time.now) < Time.now - 60
+    say "Running fetchmail..."
+    system "fetchmail >& /dev/null"
+    say "Done running fetchmail."
+  end
+  @last_fetchmail_time = Time.now
+
+
+mime-decode:
+  ## Please read:
+  https://github.com/sup-heliotrope/sup/wiki/Viewing-Attachments for
+  some security concerns on opening attachments.
+
+  ## turn text/html attachments into plain text, unless they are part
+  ## of a multipart/alternative pair
+  require 'shellwords'
+  unless sibling_types.member? "text/plain"
+    case content_type
+    when "text/html"
+      `/usr/bin/w3m -dump -T #{content_type} #{Shellwords.escape filename}`
+    end
+  end
+
+startup:
+  ## runs a background task
+  @bgtask_pid = fork
+  if @bgtask_pid
+    set 'bgtask_pid' @bgtask_pid
+    Process.detach(@bgtask_pid) # so we don't have to wait on it when we go to kill it
+  else
+    exec "background-task args 2&>1 >> /tmp/logfile"
+  end
+
+after-poll:
+  ## kills the background task after the first poll
+  @bgtask_pid = get 'bgtask_pid'
+  Process.kill("TERM", @bgtask_pid) unless @bgtask_pid == nil
+  set 'bgtask_pid' nil