3 ## Here we define all the "chunks" that a message is parsed
4 ## into. Chunks are used by ThreadViewMode to render a message. Chunks
5 ## are used for both MIME stuff like attachments, for Sup's parsing of
6 ## the message body into text, quote, and signature regions, and for
7 ## notices like "this message was decrypted" or "this message contains
8 ## a valid signature"---basically, anything we want to differentiate
11 ## A chunk can be inlineable, expandable, or viewable. If it's
12 ## inlineable, #color and #lines are called and the output is treated
13 ## as part of the message text. This is how Text and one-line Quotes
14 ## and Signatures work.
16 ## If it's not inlineable but is expandable, #patina_color and
17 ## #patina_text are called to generate a "patina" (a one-line widget,
18 ## basically), and the user can press enter to toggle the display of
19 ## the chunk content, which is generated from #color and #lines as
20 ## above. This is how Quote, Signature, and most widgets
21 ## work. Exandable chunks can additionally define #initial_state to be
22 ## :open if they want to start expanded (default is to start collapsed).
24 ## If it's not expandable but is viewable, a patina is displayed using
25 ## #patina_color and #patina_text, but no toggling is allowed. Instead,
26 ## if #view! is defined, pressing enter on the widget calls view! and
27 ## (if that returns false) #to_s. Otherwise, enter does nothing. This
28 ## is how non-inlineable attachments work.
30 ## Independent of all that, a chunk can be quotable, in which case it's
31 ## included as quoted text during a reply. Text, Quotes, and mime-parsed
32 ## attachments are quotable; Signatures are not.
34 ## monkey-patch time: make temp files have the right extension
36 def make_tmpname basename, n
37 sprintf '%d-%d-%s', $$, n, basename
44 WRAP_LEN = 80 # wrap messages and text attachments at this width
47 HookManager.register "mime-decode", <<EOS
48 Decodes a MIME attachment into text form. The text will be displayed
49 directly in Sup. For attachments that you wish to use a separate program
50 to view (e.g. images), you should use the mime-view hook instead.
53 content_type: the content-type of the message
54 filename: the filename of the attachment as saved to disk
55 sibling_types: if this attachment is part of a multipart MIME attachment,
56 an array of content-types for all attachments. Otherwise,
59 The decoded text of the attachment, or nil if not decoded.
62 HookManager.register "mime-view", <<EOS
63 Views a non-text MIME attachment. This hook allows you to run
64 third-party programs for attachments that require such a thing (e.g.
65 images). To instead display a text version of the attachment directly in
66 Sup, use the mime-decode hook instead.
68 Note that by default (at least on systems that have a run-mailcap command),
69 Sup uses the default mailcap handler for the attachment's MIME type. If
70 you want a particular behavior to be global, you may wish to change your
74 content_type: the content-type of the attachment
75 filename: the filename of the attachment as saved to disk
77 True if the viewing was successful, false otherwise. If false, calling
78 /usr/bin/run-mailcap will be tried.
82 ## raw_content is the post-MIME-decode content. this is used for
83 ## saving the attachment to disk.
84 attr_reader :content_type, :filename, :lines, :raw_content
87 def initialize content_type, filename, encoded_content, sibling_types
88 @content_type = content_type
90 @quotable = false # changed to true if we can parse it through the
91 # mime-decode hook, or if it's plain text
93 if encoded_content.body
94 encoded_content.decode
96 "For some bizarre reason, RubyMail was unable to parse this attachment.\n"
101 when /^text\/plain\b/
102 Iconv.easy_decode $encoding, encoded_content.charset || $encoding, @raw_content
104 HookManager.run "mime-decode", :content_type => content_type,
105 :filename => lambda { write_to_disk },
106 :sibling_types => sibling_types
111 @lines = text.gsub("\r\n", "\n").gsub(/\t/, " ").gsub(/\r/, "").split("\n")
112 @lines = lines.map {|l| l.chomp.wrap WRAP_LEN}.flatten
118 def patina_color; :attachment_color end
121 "Attachment: #{filename} (#{lines.length} lines)"
123 "Attachment: #{filename} (#{content_type}; #{@raw_content.size.to_human_size})"
127 ## an attachment is exapndable if we've managed to decode it into
128 ## something we can display inline. otherwise, it's viewable.
129 def inlineable?; false end
130 def expandable?; !viewable? end
131 def initial_state; :open end
132 def viewable?; @lines.nil? end
133 def view_default! path
134 cmd = "/usr/bin/run-mailcap --action=view '#{@content_type}:#{path}' 2>/dev/null"
135 Redwood::log "running: #{cmd.inspect}"
142 ret = HookManager.run "mime-view", :content_type => @content_type,
144 ret || view_default!(path)
148 file = Tempfile.new(@filename || "sup-attachment")
149 file.print @raw_content
154 ## used when viewing the attachment as text
156 @lines || @raw_content
164 @lines = lines.map { |l| l.chomp.wrap WRAP_LEN }.flatten # wrap
166 ## trim off all empty lines except one
167 @lines.pop while @lines.length > 1 && @lines[-1] =~ /^\s*$/ && @lines[-2] =~ /^\s*$/
170 def inlineable?; true end
171 def quotable?; true end
172 def expandable?; false end
173 def viewable?; false end
183 def inlineable?; @lines.length == 1 end
184 def quotable?; true end
185 def expandable?; !inlineable? end
186 def viewable?; false end
188 def patina_color; :quote_patina_color end
189 def patina_text; "(#{lines.length} quoted lines)" end
190 def color; :quote_color end
199 def inlineable?; @lines.length == 1 end
200 def quotable?; false end
201 def expandable?; !inlineable? end
202 def viewable?; false end
204 def patina_color; :sig_patina_color end
205 def patina_text; "(#{lines.length}-line signature)" end
206 def color; :sig_color end
209 class EnclosedMessage
211 def initialize from, to, cc, date, subj
212 @from = from ? "unknown sender" : from.full_adress
213 @to = to ? "" : to.map { |p| p.full_address }.join(", ")
214 @cc = cc ? "" : cc.map { |p| p.full_address }.join(", ")
223 @lines = "\nFrom: #{from}\n"
224 @lines += "To: #{to}\n"
226 @lines += "Cc: #{cc}\n"
228 @lines += "Date: #{date}\n"
229 @lines += "Subject: #{subj}\n\n"
232 def inlineable?; false end
233 def quotable?; false end
234 def expandable?; true end
235 def initial_state; :closed end
236 def viewable?; false end
238 def patina_color; :generic_notice_patina_color end
239 def patina_text; "Begin enclosed message sent on #{@date}" end
241 def color; :quote_color end
245 attr_reader :lines, :status, :patina_text
247 def initialize status, description, lines=[]
249 @patina_text = description
255 when :valid: :cryptosig_valid_color
256 when :invalid: :cryptosig_invalid_color
257 else :cryptosig_unknown_color
260 def color; patina_color end
262 def inlineable?; false end
263 def quotable?; false end
264 def expandable?; !@lines.empty? end
265 def viewable?; false end