sup 0.19.0

data/bin/sup-config

@@ -0,0 +1,243 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'highline/import'
+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
+
+No options.
+EOS
+end
+
+def axe q, default=nil
+  question = if default && !default.empty?
+               "#{q} (enter for \"#{default}\"): "
+             else
+               "#{q}: "
+             end
+  ans = ask question
+  ans.empty? ? default : ans.to_s
+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
+  require "sup/util/uri"
+
+  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("Get me out of here!") { return }
+  end
+
+  while true do
+    say "Ok, now for the details."
+
+    default_labels, components = case type
+    when :mbox
+      $last_fn ||= ENV["MAIL"]
+      fn = axe "What's the full path to the mbox file?", $last_fn
+      return if fn.nil? || fn.empty?
+
+      $last_fn = fn
+      [Redwood::MBox.suggest_labels_for(fn),
+       { :scheme => "mbox", :path => fn }]
+    when :maildir
+      $last_fn ||= ENV["MAIL"]
+      fn = axe "What's the full path to the maildir directory?", $last_fn
+      return if fn.nil? || fn.empty?
+
+      $last_fn = fn
+      [Redwood::Maildir.suggest_labels_for(fn),
+       { :scheme => "maildir", :path => fn }]
+    end
+
+    uri = begin
+      Redwood::Util::Uri.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 new messages be automatically archived? (I.e. not appear in your inbox, though still be accessible via search.)") : false
+
+    sync_back = (type == :maildir) ? axe_yes("Should the original Maildir messages be modified to reflect changes like read status, starred messages, etc.?", "y") : false
+
+    labels_str = axe("Enter any labels to be automatically added to all messages from this source, separated by spaces (or 'none')", default_labels.join(","))
+
+    labels = if labels_str =~ /^\s*none\s*$/i
+      nil
+    else
+      labels_str.split(/\s+/)
+    end
+
+    cmd = build_cmd "sup-add"
+    cmd += " --unusual" unless usual
+    cmd += " --archive" if archive
+    cmd += " --no-sync-back" unless sync_back
+    cmd += " --labels=#{labels.join(',')}" if labels && !labels.empty?
+    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.init
+Redwood::SourceManager.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.
+
+EOS
+
+account = $config[:accounts][:default]
+
+name = axe "What's your name?", account[:name]
+email = axe "What's your (primary) email address?", account[:email]
+
+say "Ok, your from 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]
+
+time_mode = axe "Would like to display time in 12h (type 12h) or in 24h (type 24h)?", $config[:time_mode]
+
+$config[:accounts][:default][:name] = name
+$config[:accounts][:default][:email] = email
+$config[:accounts][:default][:alternates] = alts
+$config[:accounts][:default][:signature] = sigfn
+$config[:editor] = editor
+$config[:time_mode] = time_mode
+
+done = false
+until done
+  say "\nNow, we'll tell Sup where to find all your email."
+  Redwood::SourceManager.load_sources
+  say "Current sources:"
+  if Redwood::SourceManager.sources.empty?
+    say "  No sources!"
+  else
+    Redwood::SourceManager.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 "\nSup needs to know where to store your sent messages."
+say "Only sources capable of storing mail will be listed.\n\n"
+
+Redwood::SourceManager.load_sources
+if Redwood::SourceManager.sources.empty?
+  say "\nUsing the default sup://sent, since you haven't configured other sources yet."
+  $config[:sent_source] = 'sup://sent'
+else
+  # this handles the event that source.yaml already contains the SentLoader
+  # source.
+  have_sup_sent = false
+
+  choose do |menu|
+    menu.prompt = "Store my sent mail in? "
+
+    menu.choice('Default (an mbox in ~/.sup, aka sup://sent)') { $config[:sent_source] = 'sup://sent'} unless have_sup_sent
+
+    valid_sents = Redwood::SourceManager.sources.each do |s|
+      have_sup_sent = true if s.to_s.eql?('sup://sent')
+      menu.choice(s.to_s) { $config[:sent_source] = s.to_s } if s.respond_to? :store_message
+    end
+  end
+end
+
+Redwood::save_yaml_obj $config, Redwood::CONFIG_FN, false, true
+
+say "Ok, I've saved you up a nice lil' #{Redwood::CONFIG_FN}."
+
+say <<EOS
+
+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.
+
+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:
+
+  #{build_cmd "sup"}
+
+Have fun!
+EOS

data/bin/sup-dump

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'xapian'
+require 'trollop'
+require 'set'
+
+BASE_DIR = ENV["SUP_BASE"] || File.join(ENV["HOME"], ".sup")
+
+$opts = Trollop::options do
+  version "sup-dump"
+  banner <<EOS
+Dumps all message state from the sup index to standard out. You can
+later use sup-sync --restored --restore <filename> to recover the index.
+
+This tool is primarily useful in the event that a Sup upgrade breaks index
+format compatibility.
+
+Usage:
+  sup-dump > <filename>
+  sup-dump | bzip2 > <filename> # even better
+EOS
+end
+
+xapian = Xapian::Database.new File.join(BASE_DIR, 'xapian')
+version = xapian.get_metadata 'rescue-version'
+version = '0' if version.empty?
+
+case version
+when '0'
+  xapian.postlist('Kmail').each do |x|
+    begin
+      entry = Marshal.load(xapian.document(x.docid).data)
+      puts "#{entry[:message_id]} (#{entry[:labels].sort_by { |l| l.to_s } * ' '})"
+    rescue
+      $stderr.puts "failed to dump document #{x.docid}"
+    end
+  end
+else
+  abort "this sup-dump version doesn't understand your index"
+end

data/bin/sup-import-dump

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'uri'
+require 'rubygems'
+require 'trollop'
+require "sup"
+
+PROGRESS_UPDATE_INTERVAL = 15 # seconds
+
+class AbortExecution < SystemExit
+end
+
+opts = Trollop::options do
+  version "sup-import-dump (sup #{Redwood::VERSION})"
+  banner <<EOS
+Imports message state previously exported by sup-dump into the index.
+sup-import-dump operates on the index only, so the messages must have already
+been added using sup-sync. If you need to recreate the index, see sup-sync
+--restore <filename> instead.
+
+Messages not mentioned in the dump file will not be modified.
+
+Usage:
+  sup-import-dump [options] <dump file>
+
+Options:
+EOS
+  opt :verbose, "Print message ids as they're processed."
+  opt :ignore_missing, "Silently skip over messages that are not in the index."
+  opt :warn_missing, "Warn about messages that are not in the index, but continue."
+  opt :abort_missing, "Abort on encountering messages that are not in the index. (default)"
+  opt :atomic, "Use transaction to apply all changes atomically."
+  opt :dry_run, "Don't actually modify the index. Probably only useful with --verbose.", :short => "-n"
+  opt :version, "Show version information", :short => :none
+
+  conflicts :ignore_missing, :warn_missing, :abort_missing
+end
+Trollop::die "No dump file given" if ARGV.empty?
+Trollop::die "Extra arguments given" if ARGV.length > 1
+dump_name = ARGV.shift
+missing_action = [:ignore_missing, :warn_missing, :abort_missing].find { |x| opts[x] } || :abort_missing
+
+Redwood::start
+index = Redwood::Index.init
+
+index.lock_interactively or exit
+begin
+  num_read = 0
+  num_changed = 0
+  index.load
+  index.begin_transaction if opts[:atomic]
+
+  IO.foreach dump_name do |l|
+    l =~ /^(\S+) \((.*?)\)$/ or raise "Can't read dump line: #{l.inspect}"
+    mid, labels = $1, $2
+    num_read += 1
+
+    unless index.contains_id? mid
+      if missing_action == :abort_missing
+        $stderr.puts "Message #{mid} not found in index, aborting."
+        raise AbortExecution, 10
+      elsif missing_action == :warn_missing
+        $stderr.puts "Message #{mid} not found in index, skipping."
+      end
+
+      next
+    end
+
+    m = index.build_message mid
+    new_labels = labels.to_set_of_symbols
+
+    if m.labels == new_labels
+      puts "#{mid} unchanged" if opts[:verbose]
+      next
+    end
+
+    puts "Changing flags for #{mid} from '#{m.labels.to_a * ' '}' to '#{new_labels.to_a * ' '}'" if opts[:verbose]
+    num_changed += 1
+
+    next if opts[:dry_run]
+
+    m.labels = new_labels
+    index.update_message_state m
+  end
+
+  index.commit_transaction if opts[:atomic]
+  puts "Updated #{num_changed} of #{num_read} messages."
+rescue AbortExecution
+  index.cancel_transaction if opts[:atomic]
+  raise
+rescue Exception => e
+  index.cancel_transaction if opts[:atomic]
+  File.open("sup-exception-log.txt", "w") { |f| f.puts e.backtrace }
+  raise
+ensure
+  index.save_index unless opts[:atomic]
+  Redwood::finish
+  index.unlock
+end

data/bin/sup-psych-ify-config-files

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "sup"
+require "fileutils"
+
+if RUBY_VERSION >= "2.1"
+  puts "YAML migration is deprecated by Ruby 2.1 and newer."
+  exit
+end
+
+Redwood.start
+
+fn = Redwood::SOURCE_FN
+FileUtils.cp fn, "#{fn}.syck_bak"
+
+Redwood::SourceManager.load_sources fn
+Redwood::SourceManager.save_sources fn, true
+
+Redwood.finish

data/bin/sup-recover-sources

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+
+$opts = {
+  :unusual => false,
+  :archive => false,
+  :scan_num => 10,
+}
+
+
+OPTIONPARSERSUCKS = "\n" + " " * 38
+OptionParser.new do |opts|
+  opts.banner = <<EOS
+Usage: sup-recover-sources [options] <source>+
+
+Rebuilds a lost sources.yaml file by reading messages from a list of
+sources and determining, for each source, the most prevalent
+'source_id' field of messages from that source in the index.
+
+The only non-deterministic component to this is that if the same
+message appears in multiple sources, those sources may be
+mis-diagnosed by this program.
+
+If the first N messages (--scan-num below) all have the same source_id
+in the index, the source will be added to sources.yaml. Otherwise, the
+distribution will be printed, and you will have to add it by hand.
+
+The offset pointer into the sources will be set to the end of the source,
+so you will have to run sup-import --rebuild for each new source after
+doing this.
+
+Options include:
+EOS
+
+  opts.on("--unusual", "Mark sources as 'unusual'. Only usual#{OPTIONPARSERSUCKS}sources will be polled by hand. Default:#{OPTIONPARSERSUCKS}#{$opts[:unusual]}.") { $opts[:unusual] = true }
+
+  opts.on("--archive", "Mark sources as 'archive'. New messages#{OPTIONPARSERSUCKS}from these sources will not appear in#{OPTIONPARSERSUCKS}the inbox. Default: #{$opts[:archive]}.") { $opts[:archive] = true }
+
+  opts.on("--scan-num N", Integer, "Number of messages to scan per source.#{OPTIONPARSERSUCKS}Default: #{$opts[:scan_num]}.") do |n|
+    $opts[:scan_num] = n
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse(ARGV)
+
+require "sup"
+Redwood::start
+puts "loading index..."
+index = Redwood::Index.init
+index.load
+puts "loaded index of #{index.size} messages"
+
+ARGV.each do |fn|
+  next if Redwood::SourceManager.source_for fn
+
+  ## TODO: merge this code with the same snippet in import
+  source = Redwood::MBox.new(fn, nil, !$opts[:unusual], $opts[:archive])
+
+  source_ids = Hash.new 0
+  count = 0
+  source.each do |offset, labels|
+    m = Redwood::Message.new :source => source, :source_info => offset
+    m.load_from_source!
+    source_id = Redwood::SourceManager.source_for_id m.id
+    next unless source_id
+    source_ids[source_id] += 1
+    count += 1
+    break if count == $opts[:scan_num]
+  end
+
+  if source_ids.size == 1
+    id = source_ids.keys.first.to_i
+    puts "assigned #{source} to #{source_ids.keys.first}"
+    source.id = id
+    Redwood::SourceManager.add_source source
+  else
+    puts ">> unable to determine #{source}: #{source_ids.inspect}"
+  end
+end
+
+index.save