## pathnames on disk.
class Maildir < Source
+ include SerializeLabelsNicely
SCAN_INTERVAL = 30 # seconds
+ MYHOSTNAME = Socket.gethostname
- def initialize uri, last_date=nil, usual=true, archived=false, id=nil
- super
+ ## remind me never to use inheritance again.
+ yaml_properties :uri, :cur_offset, :usual, :archived, :id, :labels, :mtimes
+ def initialize uri, last_date=nil, usual=true, archived=false, id=nil, labels=[], mtimes={}
+ super uri, last_date, usual, archived, id
+ uri = URI(Source.expand_filesystem_uri(uri))
- @dir = URI(uri).path
+ raise ArgumentError, "not a maildir URI" unless uri.scheme == "maildir"
+ raise ArgumentError, "maildir URI cannot have a host: #{uri.host}" if uri.host
+ raise ArgumentError, "maildir URI must have a path component" unless uri.path
+
+ @dir = uri.path
+ @labels = Set.new(labels || [])
@ids = []
@ids_to_fns = {}
@last_scan = nil
@mutex = Mutex.new
+ #the mtime from the subdirs in the maildir with the unix epoch as default.
+ #these are used to determine whether scanning the directory for new mail
+ #is a worthwhile effort
+ @mtimes = { 'cur' => Time.at(0), 'new' => Time.at(0) }.merge(mtimes || {})
+ @dir_ids = { 'cur' => [], 'new' => [] }
+ end
+
+ def file_path; @dir end
+ def self.suggest_labels_for path; [] end
+ def is_source_for? uri; super || (URI(Source.expand_filesystem_uri(uri)) == URI(self.uri)); end
+
+ def check
+ scan_mailbox
+ return unless start_offset
+
+ start = @ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}." # couldn't find the most recent email
+ end
+
+ def store_message date, from_email, &block
+ stored = false
+ new_fn = new_maildir_basefn + ':2,S'
+ Dir.chdir(@dir) do |d|
+ tmp_path = File.join(@dir, 'tmp', new_fn)
+ new_path = File.join(@dir, 'new', new_fn)
+ begin
+ sleep 2 if File.stat(tmp_path)
+
+ File.stat(tmp_path)
+ rescue Errno::ENOENT #this is what we want.
+ begin
+ File.open(tmp_path, 'w') do |f|
+ yield f #provide a writable interface for the caller
+ f.fsync
+ end
+
+ File.link tmp_path, new_path
+ stored = true
+ ensure
+ File.unlink tmp_path if File.exists? tmp_path
+ end
+ end #rescue Errno...
+ end #Dir.chdir
+
+ stored
+ end
+
+ def each_raw_message_line id
+ scan_mailbox
+ with_file_for(id) do |f|
+ until f.eof?
+ yield f.gets
+ end
+ end
end
def load_header id
scan_mailbox
- with_file_for(id) { |f| MBox::read_header f }
+ with_file_for(id) { |f| parse_raw_email_header f }
end
def load_message id
ret
end
- def raw_full_message id
+ def raw_message id
scan_mailbox
- with_file_for(id) { |f| f.readlines.join }
+ with_file_for(id) { |f| f.read }
end
- def scan_mailbox
+ def scan_mailbox opts={}
+ return unless @ids.empty? || opts[:rescan]
return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
- cdir = File.join(@dir, 'cur')
- ndir = File.join(@dir, 'new')
+ initial_poll = @ids.empty?
+ debug "scanning maildir #@dir..."
begin
- @ids, @ids_to_fns = @mutex.synchronize do
- ids, ids_to_fns = [], {}
- (Dir[File.join(cdir, "*")] + Dir[File.join(ndir, "*")]).map do |fn|
- id = make_id fn
- ids << id
- ids_to_fns[id] = fn
- end
- [ids.sort, ids_to_fns]
+ @mtimes.each_key do |d|
+ subdir = File.join(@dir, d)
+ raise FatalSourceError, "#{subdir} not a directory" unless File.directory? subdir
+
+ mtime = File.mtime subdir
+
+ #only scan the dir if the mtime is more recent (or we haven't polled
+ #since startup)
+ if @mtimes[d] < mtime || initial_poll
+ @mtimes[d] = mtime
+ @dir_ids[d] = []
+ Dir[File.join(subdir, '*')].map do |fn|
+ id = make_id fn
+ @dir_ids[d] << id
+ @ids_to_fns[id] = fn
+ end
+ else
+ debug "no poll on #{d}. mtime on indicates no new messages."
+ end
end
- rescue SystemCallError => e
- die "Problem scanning Maildir directories: #{e.message}."
+ @ids = @dir_ids.values.flatten.uniq.sort!
+ rescue SystemCallError, IOError => e
+ raise FatalSourceError, "Problem scanning Maildir directories: #{e.message}."
end
+ debug "done scanning maildir"
@last_scan = Time.now
end
+ synchronized :scan_mailbox
def each
scan_mailbox
- start = @ids.index(cur_offset || start_offset) or die "Unknown message id #{cur_offset || start_offset}.", :suggest_rebuild => true # couldn't find the most recent email
+ return unless start_offset
+
+ start = @ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}." # couldn't find the most recent email
start.upto(@ids.length - 1) do |i|
id = @ids[i]
self.cur_offset = id
- yield id, (@ids_to_fns[id] =~ /,.*R.*$/ ? [] : [:unread])
+ yield id, @labels + (seen?(id) ? [] : [:unread]) + (trashed?(id) ? [:deleted] : []) + (flagged?(id) ? [:starred] : [])
end
end
end
def end_offset
- scan_mailbox
- @ids.last
+ scan_mailbox :rescan => true
+ @ids.last + 1
end
def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
+ def draft? msg; maildir_data(msg)[2].include? "D"; end
+ def flagged? msg; maildir_data(msg)[2].include? "F"; end
+ def passed? msg; maildir_data(msg)[2].include? "P"; end
+ def replied? msg; maildir_data(msg)[2].include? "R"; end
+ def seen? msg; maildir_data(msg)[2].include? "S"; end
+ def trashed? msg; maildir_data(msg)[2].include? "T"; end
+
+ def mark_draft msg; maildir_mark_file msg, "D" unless draft? msg; end
+ def mark_flagged msg; maildir_mark_file msg, "F" unless flagged? msg; end
+ def mark_passed msg; maildir_mark_file msg, "P" unless passed? msg; end
+ def mark_replied msg; maildir_mark_file msg, "R" unless replied? msg; end
+ def mark_seen msg; maildir_mark_file msg, "S" unless seen? msg; end
+ def mark_trashed msg; maildir_mark_file msg, "T" unless trashed? msg; end
+
private
- def die message, opts={}
- message += " It is likely that messages have been deleted from this Maildir mailbox. Please run sup-sync --changed #{to_s} to correct this problem." if opts[:suggest_rebuild]
- self.broken_msg = message
- Redwood::log message
- BufferManager.flash "Error communicating with Maildir. See log for details." if BufferManager.instantiated?
- raise SourceError, message
- end
-
def make_id fn
+ #doing this means 1 syscall instead of 2 (File.mtime, File.size).
+ #makes a noticeable difference on nfs.
+ stat = File.stat(fn)
# use 7 digits for the size. why 7? seems nice.
- sprintf("%d%07d", File.mtime(fn), File.size(fn)).to_i
+ sprintf("%d%07d", stat.mtime, stat.size % 10000000).to_i
+ end
+
+ def new_maildir_basefn
+ Kernel::srand()
+ "#{Time.now.to_i.to_s}.#{$$}#{Kernel.rand(1000000)}.#{MYHOSTNAME}"
end
def with_file_for id
- fn = @ids_to_fns[id] or die "No such id: #{id.inspect}.", :suggest_rebuild => true
+ fn = @ids_to_fns[id] or raise OutOfSyncSourceError, "No such id: #{id.inspect}."
begin
File.open(fn) { |f| yield f }
- rescue SystemCallError => e
- die "Problem reading file for id #{id.inspect}: #{fn.inspect}: #{e.message}."
+ rescue SystemCallError, IOError => e
+ raise FatalSourceError, "Problem reading file for id #{id.inspect}: #{fn.inspect}: #{e.message}."
end
end
-end
-Redwood::register_yaml(Maildir, %w(uri cur_offset usual archived id))
+ def maildir_data msg
+ fn = File.basename @ids_to_fns[msg]
+ fn =~ %r{^([^:]+):([12]),([DFPRST]*)$}
+ [($1 || fn), ($2 || "2"), ($3 || "")]
+ end
+
+ ## not thread-safe on msg
+ def maildir_mark_file msg, flag
+ orig_path = @ids_to_fns[msg]
+ orig_base, orig_fn = File.split(orig_path)
+ new_base = orig_base.slice(0..-4) + 'cur'
+ tmp_base = orig_base.slice(0..-4) + 'tmp'
+ md_base, md_ver, md_flags = maildir_data msg
+ md_flags += flag; md_flags = md_flags.split(//).sort.join.squeeze
+ new_path = File.join new_base, "#{md_base}:#{md_ver},#{md_flags}"
+ tmp_path = File.join tmp_base, "#{md_base}:#{md_ver},#{md_flags}"
+ File.link orig_path, tmp_path
+ File.unlink orig_path
+ File.link tmp_path, new_path
+ File.unlink tmp_path
+ @ids_to_fns[msg] = new_path
+ end
+end
end
projects / sup / blobdiff