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
45 HookManager.register "mime-decode", <<EOS
46 Executes when decoding a MIME attachment.
48 content_type: the content-type of the message
49 filename: the filename of the attachment as saved to disk
50 sibling_types: if this attachment is part of a multipart MIME attachment,
51 an array of content-types for all attachments. Otherwise,
54 The decoded text of the attachment, or nil if not decoded.
57 HookManager.register "mime-view", <<EOS
58 Executes when viewing a MIME attachment, i.e., launching a separate
61 content_type: the content-type of the attachment
62 filename: the filename of the attachment as saved to disk
64 True if the viewing was successful, false otherwise.
68 ## raw_content is the post-MIME-decode content. this is used for
69 ## saving the attachment to disk.
70 attr_reader :content_type, :filename, :lines, :raw_content
73 def initialize content_type, filename, encoded_content, sibling_types
74 @content_type = content_type
76 @quotable = false # changed to true if we can parse it through the
77 # mime-decode hook, or if it's plain text
79 if encoded_content.body
80 encoded_content.decode
82 "For some bizarre reason, RubyMail was unable to parse this attachment.\n"
88 Message.convert_from @raw_content, encoded_content.charset
90 HookManager.run "mime-decode", :content_type => content_type,
91 :filename => lambda { write_to_disk },
92 :sibling_types => sibling_types
97 @lines = text.gsub("\r\n", "\n").gsub(/\t/, " ").gsub(/\r/, "").split("\n")
103 def patina_color; :attachment_color end
106 "Attachment: #{filename} (#{lines.length} lines)"
108 "Attachment: #{filename} (#{content_type})"
112 ## an attachment is exapndable if we've managed to decode it into
113 ## something we can display inline. otherwise, it's viewable.
114 def inlineable?; false end
115 def expandable?; !viewable? end
116 def initial_state; :open end
117 def viewable?; @lines.nil? end
118 def view_default! path
119 system "/usr/bin/run-mailcap --action=view #{@content_type}:#{path} > /dev/null 2> /dev/null"
125 ret = HookManager.run "mime-view", :content_type => @content_type,
127 view_default! path unless ret
131 file = Tempfile.new(@filename || "sup-attachment")
132 file.print @raw_content
137 ## used when viewing the attachment as text
139 @lines || @raw_content
144 WRAP_LEN = 80 # wrap at this width
148 @lines = lines.map { |l| l.chomp.wrap WRAP_LEN }.flatten # wrap
150 ## trim off all empty lines except one
151 @lines.pop while @lines.length > 1 && @lines[-1] =~ /^\s*$/ && @lines[-2] =~ /^\s*$/
154 def inlineable?; true end
155 def quotable?; true end
156 def expandable?; false end
157 def viewable?; false end
167 def inlineable?; @lines.length == 1 end
168 def quotable?; true end
169 def expandable?; !inlineable? end
170 def viewable?; false end
172 def patina_color; :quote_patina_color end
173 def patina_text; "(#{lines.length} quoted lines)" end
174 def color; :quote_color end
183 def inlineable?; @lines.length == 1 end
184 def quotable?; false end
185 def expandable?; !inlineable? end
186 def viewable?; false end
188 def patina_color; :sig_patina_color end
189 def patina_text; "(#{lines.length}-line signature)" end
190 def color; :sig_color end
193 class EnclosedMessage
195 def initialize from, body
197 @lines = body.split "\n"
201 @from ? @from.longname : "unknown sender"
204 def inlineable?; false end
205 def quotable?; false end
206 def expandable?; true end
207 def initial_state; :open end
208 def viewable?; false end
210 def patina_color; :generic_notice_patina_color end
211 def patina_text; "Begin enclosed message from #{from} (#{@lines.length} lines)" end
213 def color; :quote_color end
217 attr_reader :lines, :status, :patina_text
219 def initialize status, description, lines=[]
221 @patina_text = description
227 when :valid: :cryptosig_valid_color
228 when :invalid: :cryptosig_invalid_color
229 else :cryptosig_unknown_color
232 def color; patina_color end
234 def inlineable?; false end
235 def quotable?; false end
236 def expandable?; !@lines.empty? end
237 def viewable?; false end