4 class ThreadViewMode < LineCursorMode
5 ## this holds all info we need to lay out a message
7 attr_accessor :top, :bot, :prev, :next, :depth, :width, :state, :color, :star_color, :orig_new
14 DATE_FORMAT = "%B %e %Y %l:%M%P"
15 INDENT_SPACES = 2 # how many spaces to indent child messages
17 HookManager.register "detailed-headers", <<EOS
18 Add or remove headers from the detailed header display of a message.
20 message: The message whose headers are to be formatted.
21 headers: A hash of header (name, value) pairs, initialized to the default
24 None. The variable 'headers' should be modified in place.
27 register_keymap do |k|
28 k.add :toggle_detailed_header, "Toggle detailed header", 'h'
29 k.add :show_header, "Show full message header", 'H'
30 k.add :activate_chunk, "Expand/collapse or activate item", :enter
31 k.add :expand_all_messages, "Expand/collapse all messages", 'E'
32 k.add :edit_draft, "Edit draft", 'e'
33 k.add :edit_labels, "Edit or add labels for a thread", 'l'
34 k.add :expand_all_quotes, "Expand/collapse all quotes in a message", 'o'
35 k.add :jump_to_next_open, "Jump to next open message", 'n'
36 k.add :jump_to_prev_open, "Jump to previous open message", 'p'
37 k.add :align_current_message, "Align current message in buffer", 'z'
38 k.add :toggle_starred, "Star or unstar message", '*'
39 k.add :toggle_new, "Toggle unread/read status of message", 'N'
40 # k.add :collapse_non_new_messages, "Collapse all but unread messages", 'N'
41 k.add :reply, "Reply to a message", 'r'
42 k.add :forward, "Forward a message or attachment", 'f'
43 k.add :alias, "Edit alias/nickname for a person", 'i'
44 k.add :edit_as_new, "Edit message as new", 'D'
45 k.add :save_to_disk, "Save message/attachment to disk", 's'
46 k.add :search, "Search for messages from particular people", 'S'
47 k.add :compose, "Compose message to person", 'm'
48 k.add :subscribe_to_list, "Subscribe to/unsubscribe from mailing list", "("
49 k.add :unsubscribe_from_list, "Subscribe to/unsubscribe from mailing list", ")"
50 k.add :pipe_message, "Pipe message or attachment to a shell command", '|'
52 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read:", '.' do |kk|
53 kk.add :archive_and_kill, "Archive this thread and kill buffer", 'a'
54 kk.add :delete_and_kill, "Delete this thread and kill buffer", 'd'
55 kk.add :spam_and_kill, "Mark this thread as spam and kill buffer", 's'
56 kk.add :unread_and_kill, "Mark this thread as unread and kill buffer", 'N'
59 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read/do (n)othing:", ',' do |kk|
60 kk.add :archive_and_next, "Archive this thread, kill buffer, and view next", 'a'
61 kk.add :delete_and_next, "Delete this thread, kill buffer, and view next", 'd'
62 kk.add :spam_and_next, "Mark this thread as spam, kill buffer, and view next", 's'
63 kk.add :unread_and_next, "Mark this thread as unread, kill buffer, and view next", 'N'
64 kk.add :do_nothing_and_next, "Kill buffer, and view next", 'n'
68 ## there are a couple important instance variables we hold to format
69 ## the thread and to provide line-based functionality. @layout is a
70 ## map from Messages to MessageLayouts, and @chunk_layout from
71 ## Chunks to ChunkLayouts. @message_lines is a map from row #s to
72 ## Message objects. @chunk_lines is a map from row #s to Chunk
73 ## objects. @person_lines is a map from row #s to Person objects.
75 def initialize thread, hidden_labels=[], index_mode=nil
78 @hidden_labels = hidden_labels
80 ## used for dispatch-and-next
81 @index_mode = index_mode
84 @layout = SavingHash.new { MessageLayout.new }
85 @chunk_layout = SavingHash.new { ChunkLayout.new }
86 earliest, latest = nil, nil
90 @thread.each do |m, d, p|
93 @layout[m].state = initial_state_for m
94 @layout[m].color = altcolor ? :alternate_patina_color : :message_patina_color
95 @layout[m].star_color = altcolor ? :alternate_starred_patina_color : :starred_patina_color
96 @layout[m].orig_new = m.has_label? :read
98 if latest_date.nil? || m.date > latest_date
104 @layout[latest].state = :open if @layout[latest].state == :closed
105 @layout[earliest].state = :detailed if earliest.has_label?(:unread) || @thread.size == 1
107 @thread.remove_label :unread
111 def draw_line ln, opts={}
113 super ln, :highlight => true
118 def lines; @text.length; end
119 def [] i; @text[i]; end
122 m = @message_lines[curpos] or return
123 BufferManager.spawn_unless_exists("Full header for #{m.id}") do
124 TextMode.new m.raw_header
128 def toggle_detailed_header
129 m = @message_lines[curpos] or return
130 @layout[m].state = (@layout[m].state == :detailed ? :open : :detailed)
135 m = @message_lines[curpos] or return
136 mode = ReplyMode.new m
137 BufferManager.spawn "Reply to #{m.subj}", mode
140 def subscribe_to_list
141 m = @message_lines[curpos] or return
142 if m.list_subscribe && m.list_subscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
143 ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [PersonManager.person_for($1)], :subj => $3
145 BufferManager.flash "Can't find List-Subscribe header for this message."
149 def unsubscribe_from_list
150 m = @message_lines[curpos] or return
151 if m.list_unsubscribe && m.list_unsubscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
152 ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [PersonManager.person_for($1)], :subj => $3
154 BufferManager.flash "Can't find List-Unsubscribe header for this message."
159 if(chunk = @chunk_lines[curpos]) && chunk.is_a?(Chunk::Attachment)
160 ForwardMode.spawn_nicely :attachments => [chunk]
161 elsif(m = @message_lines[curpos])
162 ForwardMode.spawn_nicely :message => m
166 include CanAliasContacts
168 p = @person_lines[curpos] or return
174 p = @person_lines[curpos] or return
175 mode = PersonSearchResultsMode.new [p]
176 BufferManager.spawn "Search for #{p.name}", mode
177 mode.load_threads :num => mode.buffer.content_height
181 p = @person_lines[curpos]
183 ComposeMode.spawn_nicely :to => [p]
185 ComposeMode.spawn_nicely
190 reserved_labels = @thread.labels.select { |l| LabelManager::RESERVED_LABELS.include? l }
191 new_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", @thread.labels
193 return unless new_labels
194 @thread.labels = (reserved_labels + new_labels).uniq
195 new_labels.each { |l| LabelManager << l }
197 UpdateManager.relay self, :labeled, @thread.first
201 m = @message_lines[curpos] or return
202 toggle_label m, :starred
206 m = @message_lines[curpos] or return
207 toggle_label m, :unread
210 def toggle_label m, label
211 if m.has_label? label
216 ## TODO: don't recalculate EVERYTHING just to add a stupid little
217 ## star to the display
219 UpdateManager.relay self, :single_message_labeled, m
222 ## called when someone presses enter when the cursor is highlighting
223 ## a chunk. for expandable chunks (including messages) we toggle
224 ## open/closed state; for viewable chunks (like attachments) we
227 chunk = @chunk_lines[curpos] or return
229 if chunk.is_a?(Message)
231 elsif chunk.expandable?
235 layout.state = (layout.state != :closed ? :closed : :open)
236 #cursor_down if layout.state == :closed # too annoying
238 elsif chunk.viewable?
244 m = @message_lines[curpos] or return
245 mode = ComposeMode.new(:body => m.quotable_body_lines, :to => m.to, :cc => m.cc, :subj => m.subj, :bcc => m.bcc)
246 BufferManager.spawn "edit as new", mode
251 chunk = @chunk_lines[curpos] or return
253 when Chunk::Attachment
254 fn = BufferManager.ask_for_filename :filename, "Save attachment to file: ", chunk.filename
255 save_to_file(fn) { |f| f.print chunk.raw_content } if fn
257 m = @message_lines[curpos]
258 fn = BufferManager.ask_for_filename :filename, "Save message to file: "
260 save_to_file(fn) do |f|
261 m.each_raw_message_line { |l| f.print l }
267 m = @message_lines[curpos] or return
269 mode = ResumeMode.new m
270 BufferManager.spawn "Edit message", mode
271 BufferManager.kill_buffer self.buffer
274 BufferManager.flash "Not a draft message!"
278 def jump_to_first_open loose_alignment=false
279 m = @message_lines[0] or return
280 if @layout[m].state != :closed
281 jump_to_message m, loose_alignment
283 jump_to_next_open loose_alignment
287 def jump_to_next_open loose_alignment=false
288 return continue_search_in_buffer if in_search? # hack: allow 'n' to apply to both operations
289 m = (curpos ... @message_lines.length).argfind { |i| @message_lines[i] }
291 while nextm = @layout[m].next
292 break if @layout[nextm].state != :closed
295 jump_to_message nextm, loose_alignment if nextm
298 def align_current_message
299 m = @message_lines[curpos] or return
303 def jump_to_prev_open loose_alignment=false
304 m = (0 .. curpos).to_a.reverse.argfind { |i| @message_lines[i] } # bah, .to_a
306 ## jump to the top of the current message if we're in the body;
307 ## otherwise, to the previous message
311 while(prevm = @layout[m].prev)
312 break if @layout[prevm].state != :closed
315 jump_to_message prevm, loose_alignment if prevm
317 jump_to_message m, loose_alignment
321 IDEAL_TOP_CONTEXT = 3 # try and give 3 rows of top context
322 IDEAL_LEFT_CONTEXT = 4 # try and give 4 columns of left context
323 def jump_to_message m, loose_alignment=false
325 left = l.depth * INDENT_SPACES
326 right = left + l.width
328 ## jump to the top line
330 jump_to_line [l.top - IDEAL_TOP_CONTEXT, 0].max # give 3 lines of top context
335 ## jump to the left column
338 -IDEAL_LEFT_CONTEXT + (l.width - buffer.content_width + IDEAL_LEFT_CONTEXT + 1).clamp(0, IDEAL_LEFT_CONTEXT)
343 jump_to_col [ideal_left, 0].max
345 ## either way, move the cursor to the first line
349 def expand_all_messages
350 @global_message_state ||= :closed
351 @global_message_state = (@global_message_state == :closed ? :open : :closed)
352 @layout.each { |m, l| l.state = @global_message_state }
356 def collapse_non_new_messages
357 @layout.each { |m, l| l.state = l.orig_new ? :open : :closed }
361 def expand_all_quotes
362 if(m = @message_lines[curpos])
363 quotes = m.chunks.select { |c| (c.is_a?(Chunk::Quote) || c.is_a?(Chunk::Signature)) && c.lines.length > 1 }
364 numopen = quotes.inject(0) { |s, c| s + (@chunk_layout[c].state == :open ? 1 : 0) }
365 newstate = numopen > quotes.length / 2 ? :closed : :open
366 quotes.each { |c| @chunk_layout[c].state = newstate }
372 @layout = @chunk_layout = @text = nil # for good luck
375 def archive_and_kill; archive_and_then :kill end
376 def spam_and_kill; spam_and_then :kill end
377 def delete_and_kill; delete_and_then :kill end
378 def unread_and_kill; unread_and_then :kill end
380 def archive_and_next; archive_and_then :next end
381 def spam_and_next; spam_and_then :next end
382 def delete_and_next; delete_and_then :next end
383 def unread_and_next; unread_and_then :next end
384 def do_nothing_and_next; do_nothing_and_then :next end
386 def archive_and_then op
388 @thread.remove_label :inbox
389 UpdateManager.relay self, :archived, @thread.first
395 @thread.apply_label :spam
396 UpdateManager.relay self, :spammed, @thread.first
400 def delete_and_then op
402 @thread.apply_label :deleted
403 UpdateManager.relay self, :deleted, @thread.first
407 def unread_and_then op
409 @thread.apply_label :unread
410 UpdateManager.relay self, :unread, @thread.first
414 def do_nothing_and_then op
424 @index_mode.launch_next_thread_after(@thread) do
425 @thread.save Index if block_given? && yield
426 BufferManager.kill_buffer_safely buffer
429 @thread.save Index if yield
430 BufferManager.kill_buffer_safely buffer
432 raise ArgumentError, "unknown thread dispatch operation #{op.inspect}"
438 chunk = @chunk_lines[curpos]
439 chunk = nil unless chunk.is_a?(Chunk::Attachment)
440 message = @message_lines[curpos] unless chunk
442 return unless chunk || message
444 command = BufferManager.ask(:shell, "pipe command: ")
445 return if command.nil? || command.empty?
447 output = pipe_to_process(command) do |stream|
449 stream.print chunk.raw_content
451 message.each_raw_message_line { |l| stream.print l }
456 BufferManager.spawn "Output of '#{command}'", TextMode.new(output)
458 BufferManager.flash "'#{command}' done!"
464 def initial_state_for m
465 if m.has_label?(:starred) || m.has_label?(:unread)
474 buffer.mark_dirty if buffer
477 ## here we generate the actual content lines. we accumulate
478 ## everything into @text, and we set @chunk_lines and
479 ## @message_lines, and we update @layout.
487 @thread.each do |m, depth, parent|
488 unless m.is_a? Message # handle nil and :fake_root
489 @text += chunk_to_lines m, nil, @text.length, depth, parent
494 ## is this still necessary?
495 next unless @layout[m].state # skip discarded drafts
498 text = chunk_to_lines m, l.state, @text.length, depth, parent, l.color, l.star_color
501 l.bot = @text.length + text.length # updated below
505 # l.state we preserve
506 l.width = 0 # updated below
507 @layout[l.prev].next = m if l.prev
509 (0 ... text.length).each do |i|
510 @chunk_lines[@text.length + i] = m
511 @message_lines[@text.length + i] = m
512 lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.length }.sum
517 if l.state != :closed
519 cl = @chunk_layout[c]
521 ## set the default state for chunks
523 if c.expandable? && c.respond_to?(:initial_state)
529 text = chunk_to_lines c, cl.state, @text.length, depth
530 (0 ... text.length).each do |i|
531 @chunk_lines[@text.length + i] = c
532 @message_lines[@text.length + i] = m
533 lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.length }.sum - (depth * INDENT_SPACES)
534 l.width = lw if lw > l.width
538 @layout[m].bot = @text.length
543 def message_patina_lines m, state, start, parent, prefix, color, star_color
544 prefix_widget = [color, prefix]
546 open_widget = [color, (state == :closed ? "+ " : "- ")]
547 new_widget = [color, (m.has_label?(:unread) ? "N" : " ")]
549 if m.has_label?(:starred)
557 @person_lines[start] = m.from
558 [[prefix_widget, open_widget, new_widget, starred_widget,
560 "#{m.from ? m.from.mediumname : '?'} to #{m.recipients.map { |l| l.shortname }.join(', ')} #{m.date.to_nice_s} (#{m.date.to_nice_distance_s})"]]]
563 @person_lines[start] = m.from
564 [[prefix_widget, open_widget, new_widget, starred_widget,
566 "#{m.from ? m.from.mediumname : '?'}, #{m.date.to_nice_s} (#{m.date.to_nice_distance_s}) #{m.snippet}"]]]
569 @person_lines[start] = m.from
570 from_line = [[prefix_widget, open_widget, new_widget, starred_widget,
571 [color, "From: #{m.from ? format_person(m.from) : '?'}"]]]
575 m.to.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
576 addressee_lines += format_person_list " To: ", m.to
579 m.cc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
580 addressee_lines += format_person_list " Cc: ", m.cc
583 m.bcc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
584 addressee_lines += format_person_list " Bcc: ", m.bcc
587 headers = OrderedHash.new
588 headers["Date"] = "#{m.date.strftime DATE_FORMAT} (#{m.date.to_nice_distance_s})"
589 headers["Subject"] = m.subj
591 show_labels = @thread.labels - LabelManager::HIDDEN_RESERVED_LABELS
592 unless show_labels.empty?
593 headers["Labels"] = show_labels.map { |x| x.to_s }.sort.join(', ')
596 headers["In reply to"] = "#{parent.from.mediumname}'s message of #{parent.date.strftime DATE_FORMAT}"
599 HookManager.run "detailed-headers", :message => m, :headers => headers
601 from_line + (addressee_lines + headers.map { |k, v| " #{k}: #{v}" }).map { |l| [[color, prefix + " " + l]] }
605 def format_person_list prefix, people
606 ptext = people.map { |p| format_person p }
607 pad = " " * prefix.length
608 [prefix + ptext.first + (ptext.length > 1 ? "," : "")] +
609 ptext[1 .. -1].map_with_index do |e, i|
610 pad + e + (i == ptext.length - 1 ? "" : ",")
615 p.longname + (ContactManager.is_aliased_contact?(p) ? " (#{ContactManager.alias_for p})" : "")
618 ## todo: check arguments on this overly complex function
619 def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil, star_color=nil
620 prefix = " " * INDENT_SPACES * depth
623 [[[:missing_message_color, "#{prefix}<one or more unreceived messages>"]]]
625 [[[:missing_message_color, "#{prefix}<an unreceived message>"]]]
627 message_patina_lines(chunk, state, start, parent, prefix, color, star_color) +
628 (chunk.is_draft? ? [[[:draft_notification_color, prefix + " >>> This message is a draft. To edit, hit 'e'. <<<"]]] : [])
631 raise "Bad chunk: #{chunk.inspect}" unless chunk.respond_to?(:inlineable?) ## debugging
633 chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
634 elsif chunk.expandable?
637 [[[chunk.patina_color, "#{prefix}+ #{chunk.patina_text}"]]]
639 [[[chunk.patina_color, "#{prefix}- #{chunk.patina_text}"]]] + chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
642 [[[chunk.patina_color, "#{prefix}x #{chunk.patina_text}"]]]
648 BufferManager.flash "viewing #{chunk.content_type} attachment..."
649 success = chunk.view!
650 BufferManager.erase_flash
651 BufferManager.completely_redraw_screen
653 BufferManager.spawn "Attachment: #{chunk.filename}", TextMode.new(chunk.to_s, chunk.filename)
654 BufferManager.flash "Couldn't execute view command, viewing as text."