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
11 class Maildir < Source
12 SCAN_INTERVAL = 30 # seconds
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))
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 raise ArgumentError, "mbox URI must have a path component" unless uri.path
25 @labels = (labels || []).freeze
32 def file_path; @dir end
33 def self.suggest_labels_for path; [] end
34 def is_source_for? uri; super || (URI(Source.expand_filesystem_uri(uri)) == URI(self.uri)); end
38 return unless start_offset
40 start = @ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}." # couldn't find the most recent email
43 def each_raw_message_line id
45 with_file_for(id) do |f|
54 with_file_for(id) { |f| MBox::read_header f }
59 with_file_for(id) { |f| RMail::Parser.read f }
65 with_file_for(id) do |f|
66 until f.eof? || (l = f.gets) =~ /^$/
75 with_file_for(id) { |f| f.readlines.join }
78 def scan_mailbox opts={}
79 return unless @ids.empty? || opts[:rescan]
80 return if @last_scan && (Time.now - @last_scan) < SCAN_INTERVAL
82 Redwood::log "scanning maildir..."
83 cdir = File.join(@dir, 'cur')
84 ndir = File.join(@dir, 'new')
86 raise FatalSourceError, "#{cdir} not a directory" unless File.directory? cdir
87 raise FatalSourceError, "#{ndir} not a directory" unless File.directory? ndir
90 @ids, @ids_to_fns = [], {}
91 (Dir[File.join(cdir, "*")] + Dir[File.join(ndir, "*")]).map do |fn|
97 rescue SystemCallError, IOError => e
98 raise FatalSourceError, "Problem scanning Maildir directories: #{e.message}."
101 Redwood::log "done scanning maildir"
102 @last_scan = Time.now
104 synchronized :scan_mailbox
108 return unless start_offset
110 start = @ids.index(cur_offset || start_offset) or raise OutOfSyncSourceError, "Unknown message id #{cur_offset || start_offset}." # couldn't find the most recent email
112 start.upto(@ids.length - 1) do |i|
115 yield id, @labels + (seen?(id) ? [] : [:unread]) + (trashed?(id) ? [:deleted] : []) + (flagged?(id) ? [:starred] : [])
125 scan_mailbox :rescan => true
129 def pct_done; 100.0 * (@ids.index(cur_offset) || 0).to_f / (@ids.length - 1).to_f; end
131 def draft? msg; maildir_data(msg)[2].include? "D"; end
132 def flagged? msg; maildir_data(msg)[2].include? "F"; end
133 def passed? msg; maildir_data(msg)[2].include? "P"; end
134 def replied? msg; maildir_data(msg)[2].include? "R"; end
135 def seen? msg; maildir_data(msg)[2].include? "S"; end
136 def trashed? msg; maildir_data(msg)[2].include? "T"; end
138 def mark_draft msg; maildir_mark_file msg, "D" unless draft? msg; end
139 def mark_flagged msg; maildir_mark_file msg, "F" unless flagged? msg; end
140 def mark_passed msg; maildir_mark_file msg, "P" unless passed? msg; end
141 def mark_replied msg; maildir_mark_file msg, "R" unless replied? msg; end
142 def mark_seen msg; maildir_mark_file msg, "S" unless seen? msg; end
143 def mark_trashed msg; maildir_mark_file msg, "T" unless trashed? msg; end
148 # use 7 digits for the size. why 7? seems nice.
149 sprintf("%d%07d", File.mtime(fn), File.size(fn) % 10000000).to_i
153 fn = @ids_to_fns[id] or raise OutOfSyncSourceError, "No such id: #{id.inspect}."
155 File.open(fn) { |f| yield f }
156 rescue SystemCallError, IOError => e
157 raise FatalSourceError, "Problem reading file for id #{id.inspect}: #{fn.inspect}: #{e.message}."
162 fn = File.basename @ids_to_fns[msg]
163 fn =~ %r{^([^:,]+):([12]),([DFPRST]*)$}
164 [($1 || fn), ($2 || "2"), ($3 || "")]
167 ## not thread-safe on msg
168 def maildir_mark_file msg, flag
169 orig_path = @ids_to_fns[msg]
170 orig_base, orig_fn = File.split(orig_path)
171 new_base = orig_base.slice(0..-4) + 'cur'
172 tmp_base = orig_base.slice(0..-4) + 'tmp'
173 md_base, md_ver, md_flags = maildir_data msg
174 md_flags += flag; md_flags = md_flags.split(//).sort.join.squeeze
175 new_path = File.join new_base, "#{md_base}:#{md_ver},#{md_flags}"
176 tmp_path = File.join tmp_base, "#{md_base}:#{md_ver},#{md_flags}"
177 File.link orig_path, tmp_path
178 File.unlink orig_path
179 File.link tmp_path, new_path
181 @ids_to_fns[msg] = new_path