git.cworth.org Git - sup/blob - lib/sup/maildir.rb

   1 require 'rmail'
   2 require 'uri'
   3
   4 module Redwood
   5
   6 ## Maildir doesn't provide an ordered unique id, which is what Sup
   7 ## requires to be really useful. So we must maintain, in memory, a
   8 ## mapping between Sup "ids" (timestamps, essentially) and the
   9 ## pathnames on disk.
  10
  11 class Maildir < Source
  12   SCAN_INTERVAL = 30 # seconds
  13
  14   ## remind me never to use inheritance again.
  15   yaml_properties :uri, :cur_offset, :usual, :archived, :id, :labels
  16   def initialize uri, last_date=nil, usual=true, archived=false, id=nil, labels=[]
  17     super uri, last_date, usual, archived, id
  18     uri = URI(Source.expand_filesystem_uri(uri))
  19
  20     raise ArgumentError, "not a maildir URI" unless uri.scheme == "maildir"
  21     raise ArgumentError, "maildir URI cannot have a host: #{uri.host}" if uri.host
  22
  23     @dir = uri.path
  24     @labels = (labels || []).freeze
  25     @ids = []
  26     @ids_to_fns = {}
  27     @last_scan = nil
  28     @mutex = Mutex.new
  29   end
  30
  31   def file_path; @dir end
  32   def self.suggest_labels_for path; [] end
  33   def is_source_for? uri; super || (URI(Source.expand_filesystem_uri(uri)) == URI(self.uri)); end
  34
  35   def check
  36     scan_mailbox
  37     return unless start_offset
  38
  39     start = @ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}." # couldn't find the most recent email
  40   end
  41
  42   def load_header id
  43     scan_mailbox
  44     with_file_for(id) { |f| MBox::read_header f }
  45   end
  46
  47   def load_message id
  48     scan_mailbox
  49     with_file_for(id) { |f| RMail::Parser.read f }
  50   end
  51
  52   def raw_header id
  53     scan_mailbox
  54     ret = ""
  55     with_file_for(id) do |f|
  56       until f.eof? || (l = f.gets) =~ /^$/
  57         ret += l
  58       end
  59     end
  60     ret
  61   end
  62
  63   def raw_full_message id
  64     scan_mailbox
  65     with_file_for(id) { |f| f.readlines.join }
  66   end
  67
  68   def scan_mailbox
  69     return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
  70
  71     cdir = File.join(@dir, 'cur')
  72     ndir = File.join(@dir, 'new')
  73
  74     raise FatalSourceError, "#{cdir} not a directory" unless File.directory? cdir
  75     raise FatalSourceError, "#{ndir} not a directory" unless File.directory? ndir
  76
  77     begin
  78       @ids, @ids_to_fns = @mutex.synchronize do
  79         ids, ids_to_fns = [], {}
  80         (Dir[File.join(cdir, "*")] + Dir[File.join(ndir, "*")]).map do |fn|
  81           id = make_id fn
  82           ids << id
  83           ids_to_fns[id] = fn
  84         end
  85         [ids.sort, ids_to_fns]
  86       end
  87     rescue SystemCallError, IOError => e
  88       raise FatalSourceError, "Problem scanning Maildir directories: #{e.message}."
  89     end
  90
  91     @last_scan = Time.now
  92   end
  93
  94   def each
  95     scan_mailbox
  96     return unless start_offset
  97
  98     start = @ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}." # couldn't find the most recent email
  99
 100     start.upto(@ids.length - 1) do |i|
 101       id = @ids[i]
 102       self.cur_offset = id
 103       yield id, @labels + (seen?(id) ? [] : [:unread]) + (trashed?(id) ? [:deleted] : [])
 104     end
 105   end
 106
 107   def start_offset
 108     scan_mailbox
 109     @ids.first
 110   end
 111
 112   def end_offset
 113     scan_mailbox
 114     @ids.last
 115   end
 116
 117   def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
 118
 119   def draft? msg; maildir_data(msg)[2].include? "D"; end
 120   def flagged? msg; maildir_data(msg)[2].include? "F"; end
 121   def passed? msg; maildir_data(msg)[2].include? "P"; end
 122   def replied? msg; maildir_data(msg)[2].include? "R"; end
 123   def seen? msg; maildir_data(msg)[2].include? "S"; end
 124   def trashed? msg; maildir_data(msg)[2].include? "T"; end
 125
 126   def mark_draft msg; maildir_mark_file msg, "D" unless draft? msg; end
 127   def mark_flagged msg; maildir_mark_file msg, "F" unless flagged? msg; end
 128   def mark_passed msg; maildir_mark_file msg, "P" unless passed? msg; end
 129   def mark_replied msg; maildir_mark_file msg, "R" unless replied? msg; end
 130   def mark_seen msg; maildir_mark_file msg, "S" unless seen? msg; end
 131   def mark_trashed msg; maildir_mark_file msg, "T" unless trashed? msg; end
 132
 133 private
 134
 135   def make_id fn
 136     # use 7 digits for the size. why 7? seems nice.
 137     sprintf("%d%07d", File.mtime(fn), File.size(fn)).to_i
 138   end
 139
 140   def with_file_for id
 141     fn = @ids_to_fns[id] or raise OutOfSyncSourceError, "No such id: #{id.inspect}."
 142     begin
 143       File.open(fn) { |f| yield f }
 144     rescue SystemCallError, IOError => e
 145       raise FatalSourceError, "Problem reading file for id #{id.inspect}: #{fn.inspect}: #{e.message}."
 146     end
 147   end
 148
 149   def maildir_data msg
 150     fn = File.basename @ids_to_fns[msg]
 151     fn =~ %r{^([^:,]+):([12]),([DFPRST]*)$}
 152     [($1 || fn), ($2 || "2"), ($3 || "")]
 153   end
 154
 155   ## not thread-safe on msg
 156   def maildir_mark_file msg, flag
 157     orig_path = @ids_to_fns[msg]
 158     orig_base, orig_fn = File.split(orig_path)
 159     new_base = orig_base.slice(0..-4) + 'cur'
 160     tmp_base = orig_base.slice(0..-4) + 'tmp'
 161     md_base, md_ver, md_flags = maildir_data msg
 162     md_flags += flag; md_flags = md_flags.split(//).sort.join.squeeze
 163     new_path = File.join new_base, "#{md_base}:#{md_ver},#{md_flags}"
 164     tmp_path = File.join tmp_base, "#{md_base}:#{md_ver},#{md_flags}"
 165     File.link orig_path, tmp_path
 166     File.unlink orig_path
 167     File.link tmp_path, new_path
 168     File.unlink tmp_path
 169     @ids_to_fns[msg] = new_path
 170   end
 171 end
 172
 173 end