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