Merge branch 'file-attachment-fix' into next
[sup:mainline.git] / lib / sup / modes / edit-message-mode.rb
1 require 'tempfile'
2 require 'socket' # just for gethostname!
3 require 'pathname'
4 require 'rmail'
5
6 module Redwood
7
8 class SendmailCommandFailed < StandardError; end
9
10 class EditMessageMode < LineCursorMode
11   DECORATION_LINES = 1
12
13   FORCE_HEADERS = %w(From To Cc Bcc Subject)
14   MULTI_HEADERS = %w(To Cc Bcc)
15   NON_EDITABLE_HEADERS = %w(Message-Id Date)
16
17   HookManager.register "signature", <<EOS
18 Generates a message signature.
19 Variables:
20       header: an object that supports string-to-string hashtable-style access
21               to the raw headers for the message. E.g., header["From"],
22               header["To"], etc.
23   from_email: the email part of the From: line, or nil if empty
24 Return value:
25   A string (multi-line ok) containing the text of the signature, or nil to
26   use the default signature.
27 EOS
28
29   HookManager.register "before-edit", <<EOS
30 Modifies message body and headers before editing a new message. Variables
31 should be modified in place.
32 Variables:
33         header: a hash of headers. See 'signature' hook for documentation.
34         body: an array of lines of body text.
35 Return value:
36         none
37 EOS
38
39   attr_reader :status
40   attr_accessor :body, :header
41   bool_reader :edited
42
43   register_keymap do |k|
44     k.add :send_message, "Send message", 'y'
45     k.add :edit_message_or_field, "Edit selected field", 'e'
46     k.add :edit_to, "Edit To:", 't'
47     k.add :edit_cc, "Edit Cc:", 'c'
48     k.add :edit_subject, "Edit Subject", 's'
49     k.add :edit_message, "Edit message", :enter
50     k.add :save_as_draft, "Save as draft", 'P'
51     k.add :attach_file, "Attach a file", 'a'
52     k.add :delete_attachment, "Delete an attachment", 'd'
53     k.add :move_cursor_right, "Move selector to the right", :right, 'l'
54     k.add :move_cursor_left, "Move selector to the left", :left, 'h'
55   end
56
57   def initialize opts={}
58     @header = opts.delete(:header) || {} 
59     @header_lines = []
60
61     @body = opts.delete(:body) || []
62     @body += sig_lines if $config[:edit_signature] && !opts.delete(:have_signature)
63
64     if opts[:attachments]
65       @attachments = opts[:attachments].values
66       @attachment_names = opts[:attachments].keys
67     else
68       @attachments = []
69       @attachment_names = []
70     end
71
72     @message_id = "<#{Time.now.to_i}-sup-#{rand 10000}@#{Socket.gethostname}>"
73     @edited = false
74     @selectors = []
75     @selector_label_width = 0
76
77     @crypto_selector =
78       if CryptoManager.have_crypto?
79         HorizontalSelector.new "Crypto:", [:none] + CryptoManager::OUTGOING_MESSAGE_OPERATIONS.keys, ["None"] + CryptoManager::OUTGOING_MESSAGE_OPERATIONS.values
80       end
81     add_selector @crypto_selector if @crypto_selector
82     
83     HookManager.run "before-edit", :header => @header, :body => @body
84
85     super opts
86     regen_text
87   end
88
89   def lines; @text.length + (@selectors.empty? ? 0 : (@selectors.length + DECORATION_LINES)) end
90   
91   def [] i
92     if @selectors.empty?
93       @text[i]
94     elsif i < @selectors.length
95       @selectors[i].line @selector_label_width
96     elsif i == @selectors.length
97       ""
98     else
99       @text[i - @selectors.length - DECORATION_LINES]
100     end
101   end
102
103   ## hook for subclasses. i hate this style of programming.
104   def handle_new_text header, body; end
105
106   def edit_message_or_field
107     lines = DECORATION_LINES + @selectors.size
108     if lines > curpos
109       return
110     elsif (curpos - lines) >= @header_lines.length
111       edit_message
112     else
113       edit_field @header_lines[curpos - lines]
114     end
115   end
116
117   def edit_to; edit_field "To" end
118   def edit_cc; edit_field "Cc" end
119   def edit_subject; edit_field "Subject" end
120
121   def edit_message
122     @file = Tempfile.new "sup.#{self.class.name.gsub(/.*::/, '').camel_to_hyphy}"
123     @file.puts format_headers(@header - NON_EDITABLE_HEADERS).first
124     @file.puts
125     @file.puts @body
126     @file.close
127
128     editor = $config[:editor] || ENV['EDITOR'] || "/usr/bin/vi"
129
130     mtime = File.mtime @file.path
131     BufferManager.shell_out "#{editor} #{@file.path}"
132     @edited = true if File.mtime(@file.path) > mtime
133
134     return @edited unless @edited
135
136     header, @body = parse_file @file.path
137     @header = header - NON_EDITABLE_HEADERS
138     handle_new_text @header, @body
139     update
140
141     @edited
142   end
143
144   def killable?
145     !edited? || BufferManager.ask_yes_or_no("Discard message?")
146   end
147
148   def attach_file
149     fn = BufferManager.ask_for_filename :attachment, "File name (enter for browser): "
150     return unless fn
151     begin
152       @attachments << RMail::Message.make_file_attachment(fn)
153       @attachment_names << fn
154       update
155     rescue SystemCallError => e
156       BufferManager.flash "Can't read #{fn}: #{e.message}"
157     end
158   end
159
160   def delete_attachment
161     i = curpos - @attachment_lines_offset - DECORATION_LINES - 1
162     if i >= 0 && i < @attachments.size && BufferManager.ask_yes_or_no("Delete attachment #{@attachment_names[i]}?")
163       @attachments.delete_at i
164       @attachment_names.delete_at i
165       update
166     end
167   end
168
169 protected
170
171   def move_cursor_left
172     if curpos < @selectors.length
173       @selectors[curpos].roll_left
174       buffer.mark_dirty
175     else
176       col_left
177     end
178   end
179
180   def move_cursor_right
181     if curpos < @selectors.length
182       @selectors[curpos].roll_right
183       buffer.mark_dirty
184     else
185       col_right
186     end
187   end
188
189   def add_selector s
190     @selectors << s
191     @selector_label_width = [@selector_label_width, s.label.length].max
192   end
193
194   def update
195     regen_text
196     buffer.mark_dirty if buffer
197   end
198
199   def regen_text
200     header, @header_lines = format_headers(@header - NON_EDITABLE_HEADERS) + [""]
201     @text = header + [""] + @body
202     @text += sig_lines unless $config[:edit_signature]
203     
204     @attachment_lines_offset = 0
205
206     unless @attachments.empty?
207       @text += [""]
208       @attachment_lines_offset = @text.length
209       @text += (0 ... @attachments.size).map { |i| [[:attachment_color, "+ Attachment: #{@attachment_names[i]} (#{@attachments[i].body.size.to_human_size})"]] }
210     end
211   end
212
213   def parse_file fn
214     File.open(fn) do |f|
215       header = MBox::read_header f
216       body = f.readlines
217
218       header.delete_if { |k, v| NON_EDITABLE_HEADERS.member? k }
219       header.each { |k, v| header[k] = parse_header k, v }
220
221       [header, body]
222     end
223   end
224
225   def parse_header k, v
226     if MULTI_HEADERS.include?(k)
227       v.split_on_commas.map do |name|
228         (p = ContactManager.contact_for(name)) && p.full_address || name
229       end
230     else
231       v
232     end
233   end
234
235   def format_headers header
236     header_lines = []
237     headers = (FORCE_HEADERS + (header.keys - FORCE_HEADERS)).map do |h|
238       lines = make_lines "#{h}:", header[h]
239       lines.length.times { header_lines << h }
240       lines
241     end.flatten.compact
242     [headers, header_lines]
243   end
244
245   def make_lines header, things
246     case things
247     when nil, []
248       [header + " "]
249     when String
250       [header + " " + things]
251     else
252       if things.empty?
253         [header]
254       else
255         things.map_with_index do |name, i|
256           raise "an array: #{name.inspect} (things #{things.inspect})" if Array === name
257           if i == 0
258             header + " " + name
259           else
260             (" " * (header.length + 1)) + name
261           end + (i == things.length - 1 ? "" : ",")
262         end
263       end
264     end
265   end
266
267   def send_message
268     return false if !edited? && !BufferManager.ask_yes_or_no("Message unedited. Really send?")
269     return false if $config[:confirm_no_attachments] && mentions_attachments? && @attachments.size == 0 && !BufferManager.ask_yes_or_no("You haven't added any attachments. Really send?")#" stupid ruby-mode
270     return false if $config[:confirm_top_posting] && top_posting? && !BufferManager.ask_yes_or_no("You're top-posting. That makes you a bad person. Really send?") #" stupid ruby-mode
271
272     from_email = 
273       if @header["From"] =~ /<?(\S+@(\S+?))>?$/
274         $1
275       else
276         AccountManager.default_account.email
277       end
278
279     acct = AccountManager.account_for(from_email) || AccountManager.default_account
280     BufferManager.flash "Sending..."
281
282     begin
283       date = Time.now
284       m = build_message date
285       IO.popen(acct.sendmail, "w") { |p| p.puts m }
286       raise SendmailCommandFailed, "Couldn't execute #{acct.sendmail}" unless $? == 0
287       SentManager.write_sent_message(date, from_email) { |f| f.puts sanitize_body(m.to_s) }
288       BufferManager.kill_buffer buffer
289       BufferManager.flash "Message sent!"
290       true
291     rescue SystemCallError, SendmailCommandFailed, CryptoManager::Error => e
292       Redwood::log "Problem sending mail: #{e.message}"
293       BufferManager.flash "Problem sending mail: #{e.message}"
294       false
295     end
296   end
297
298   def save_as_draft
299     DraftManager.write_draft { |f| write_message f, false }
300     BufferManager.kill_buffer buffer
301     BufferManager.flash "Saved for later editing."
302   end
303
304   def build_message date
305     m = RMail::Message.new
306     m.header["Content-Type"] = "text/plain; charset=#{$encoding}"
307     m.body = @body.join
308     m.body = m.body
309     m.body += sig_lines.join("\n") unless $config[:edit_signature]
310
311     ## there are attachments, so wrap body in an attachment of its own
312     unless @attachments.empty?
313       body_m = m
314       body_m.header["Content-Disposition"] = "inline"
315       m = RMail::Message.new
316       
317       m.add_part body_m
318       @attachments.each { |a| m.add_part a }
319     end
320
321     ## do whatever crypto transformation is necessary
322     if @crypto_selector && @crypto_selector.val != :none
323       from_email = PersonManager.person_for(@header["From"]).email
324       to_email = (@header["To"] + @header["Cc"] + @header["Bcc"]).map { |p| PersonManager.person_for(p).email }
325
326       m = CryptoManager.send @crypto_selector.val, from_email, to_email, m
327     end
328
329     ## finally, set the top-level headers
330     @header.each do |k, v|
331       next if v.nil? || v.empty?
332       m.header[k] = 
333         case v
334         when String
335           v
336         when Array
337           v.join ", "
338         end
339     end
340     m.header["Date"] = date.rfc2822
341     m.header["Message-Id"] = @message_id
342     m.header["User-Agent"] = "Sup/#{Redwood::VERSION}"
343     m
344   end
345
346   ## TODO: remove this. redundant with write_full_message_to.
347   ##
348   ## this is going to change soon: draft messages (currently written
349   ## with full=false) will be output as yaml.
350   def write_message f, full=true, date=Time.now
351     raise ArgumentError, "no pre-defined date: header allowed" if @header["Date"]
352     f.puts format_headers(@header).first
353     f.puts <<EOS
354 Date: #{date.rfc2822}
355 Message-Id: #{@message_id}
356 EOS
357     if full
358       f.puts <<EOS
359 Mime-Version: 1.0
360 Content-Type: text/plain; charset=us-ascii
361 Content-Disposition: inline
362 User-Agent: Redwood/#{Redwood::VERSION}
363 EOS
364     end
365
366     f.puts
367     f.puts sanitize_body(@body.join)
368     f.puts sig_lines if full unless $config[:edit_signature]
369   end  
370
371 protected
372
373   def edit_field field
374     case field
375     when "Subject"
376       text = BufferManager.ask :subject, "Subject: ", @header[field]
377        if text
378          @header[field] = parse_header field, text
379          update
380          field
381        end
382     else
383       default =
384         case field
385         when *MULTI_HEADERS
386           @header[field].join(", ")
387         else
388           @header[field]
389         end
390
391       contacts = BufferManager.ask_for_contacts :people, "#{field}: ", default
392       if contacts
393         text = contacts.map { |s| s.longname }.join(", ")
394         @header[field] = parse_header field, text
395         update
396         field
397       end
398     end
399   end
400
401 private
402
403   def sanitize_body body
404     body.gsub(/^From /, ">From ")
405   end
406
407   def mentions_attachments?
408     @body.any? { |l| l =~ /^[^>]/ && l =~ /\battach(ment|ed|ing|)\b/i }
409   end
410
411   def top_posting?
412     @body.join =~ /(\S+)\s*Excerpts from.*\n(>.*\n)+\s*\Z/
413   end
414
415   def sig_lines
416     p = PersonManager.person_for(@header["From"])
417     from_email = p && p.email
418
419     ## first run the hook
420     hook_sig = HookManager.run "signature", :header => @header, :from_email => from_email
421     return ["", "-- "] + hook_sig.split("\n") if hook_sig
422
423     ## no hook, do default signature generation based on config.yaml
424     return [] unless from_email
425     sigfn = (AccountManager.account_for(from_email) || 
426              AccountManager.default_account).signature
427
428     if sigfn && File.exists?(sigfn)
429       ["", "-- "] + File.readlines(sigfn).map { |l| l.chomp }
430     else
431       []
432     end
433   end
434 end
435
436 end