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 HookManager.register "bounce-command", <<EOS
28 Determines the command used to bounce a message.
30 from: The From header of the message being bounced
31 (eg: likely _not_ your address).
32 to: The addresses you asked the message to be bounced to as an array.
34 A string representing the command to pipe the mail into. This
35 should include the entire command except for the destination addresses,
36 which will be appended by sup.
39 register_keymap do |k|
40 k.add :toggle_detailed_header, "Toggle detailed header", 'h'
41 k.add :show_header, "Show full message header", 'H'
42 k.add :show_message, "Show full message (raw form)", 'V'
43 k.add :activate_chunk, "Expand/collapse or activate item", :enter
44 k.add :expand_all_messages, "Expand/collapse all messages", 'E'
45 k.add :edit_draft, "Edit draft", 'e'
46 k.add :send_draft, "Send draft", 'y'
47 k.add :edit_labels, "Edit or add labels for a thread", 'l'
48 k.add :expand_all_quotes, "Expand/collapse all quotes in a message", 'o'
49 k.add :jump_to_next_open, "Jump to next open message", 'n'
50 k.add :jump_to_prev_open, "Jump to previous open message", 'p'
51 k.add :align_current_message, "Align current message in buffer", 'z'
52 k.add :toggle_starred, "Star or unstar message", '*'
53 k.add :toggle_new, "Toggle unread/read status of message", 'N'
54 # k.add :collapse_non_new_messages, "Collapse all but unread messages", 'N'
55 k.add :reply, "Reply to a message", 'r'
56 k.add :reply_all, "Reply to all participants of this message", 'G'
57 k.add :forward, "Forward a message or attachment", 'f'
58 k.add :bounce, "Bounce message to other recipient(s)", '!'
59 k.add :alias, "Edit alias/nickname for a person", 'i'
60 k.add :edit_as_new, "Edit message as new", 'D'
61 k.add :save_to_disk, "Save message/attachment to disk", 's'
62 k.add :search, "Search for messages from particular people", 'S'
63 k.add :compose, "Compose message to person", 'm'
64 k.add :subscribe_to_list, "Subscribe to/unsubscribe from mailing list", "("
65 k.add :unsubscribe_from_list, "Subscribe to/unsubscribe from mailing list", ")"
66 k.add :pipe_message, "Pipe message or attachment to a shell command", '|'
68 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read:", '.' do |kk|
69 kk.add :archive_and_kill, "Archive this thread and kill buffer", 'a'
70 kk.add :delete_and_kill, "Delete this thread and kill buffer", 'd'
71 kk.add :spam_and_kill, "Mark this thread as spam and kill buffer", 's'
72 kk.add :unread_and_kill, "Mark this thread as unread and kill buffer", 'N'
75 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read/do (n)othing:", ',' do |kk|
76 kk.add :archive_and_next, "Archive this thread, kill buffer, and view next", 'a'
77 kk.add :delete_and_next, "Delete this thread, kill buffer, and view next", 'd'
78 kk.add :spam_and_next, "Mark this thread as spam, kill buffer, and view next", 's'
79 kk.add :unread_and_next, "Mark this thread as unread, kill buffer, and view next", 'N'
80 kk.add :do_nothing_and_next, "Kill buffer, and view next", 'n'
83 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read/do (n)othing:", ']' do |kk|
84 kk.add :archive_and_prev, "Archive this thread, kill buffer, and view previous", 'a'
85 kk.add :delete_and_prev, "Delete this thread, kill buffer, and view previous", 'd'
86 kk.add :spam_and_prev, "Mark this thread as spam, kill buffer, and view previous", 's'
87 kk.add :unread_and_prev, "Mark this thread as unread, kill buffer, and view previous", 'N'
88 kk.add :do_nothing_and_prev, "Kill buffer, and view previous", 'n'
92 ## there are a couple important instance variables we hold to format
93 ## the thread and to provide line-based functionality. @layout is a
94 ## map from Messages to MessageLayouts, and @chunk_layout from
95 ## Chunks to ChunkLayouts. @message_lines is a map from row #s to
96 ## Message objects. @chunk_lines is a map from row #s to Chunk
97 ## objects. @person_lines is a map from row #s to Person objects.
99 def initialize thread, hidden_labels=[], index_mode=nil
102 @hidden_labels = hidden_labels
104 ## used for dispatch-and-next
105 @index_mode = index_mode
108 @layout = SavingHash.new { MessageLayout.new }
109 @chunk_layout = SavingHash.new { ChunkLayout.new }
110 earliest, latest = nil, nil
114 @thread.each do |m, d, p|
117 @layout[m].state = initial_state_for m
118 @layout[m].color = altcolor ? :alternate_patina_color : :message_patina_color
119 @layout[m].star_color = altcolor ? :alternate_starred_patina_color : :starred_patina_color
120 @layout[m].orig_new = m.has_label? :read
122 if latest_date.nil? || m.date > latest_date
128 @layout[latest].state = :open if @layout[latest].state == :closed
129 @layout[earliest].state = :detailed if earliest.has_label?(:unread) || @thread.size == 1
131 @thread.remove_label :unread
135 def draw_line ln, opts={}
137 super ln, :highlight => true
142 def lines; @text.length; end
143 def [] i; @text[i]; end
146 m = @message_lines[curpos] or return
147 BufferManager.spawn_unless_exists("Full header for #{m.id}") do
148 TextMode.new m.raw_header
153 m = @message_lines[curpos] or return
154 BufferManager.spawn_unless_exists("Raw message for #{m.id}") do
155 TextMode.new m.raw_message
159 def toggle_detailed_header
160 m = @message_lines[curpos] or return
161 @layout[m].state = (@layout[m].state == :detailed ? :open : :detailed)
165 def reply type_arg=nil
166 m = @message_lines[curpos] or return
167 mode = ReplyMode.new m, type_arg
168 BufferManager.spawn "Reply to #{m.subj}", mode
171 def reply_all; reply :all; end
173 def subscribe_to_list
174 m = @message_lines[curpos] or return
175 if m.list_subscribe && m.list_subscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
176 ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [Person.from_address($1)], :subj => $3
178 BufferManager.flash "Can't find List-Subscribe header for this message."
182 def unsubscribe_from_list
183 m = @message_lines[curpos] or return
184 if m.list_unsubscribe && m.list_unsubscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
185 ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [Person.from_address($1)], :subj => $3
187 BufferManager.flash "Can't find List-Unsubscribe header for this message."
192 if(chunk = @chunk_lines[curpos]) && chunk.is_a?(Chunk::Attachment)
193 ForwardMode.spawn_nicely :attachments => [chunk]
194 elsif(m = @message_lines[curpos])
195 ForwardMode.spawn_nicely :message => m
200 m = @message_lines[curpos] or return
201 to = BufferManager.ask_for_contacts(:people, "Bounce To: ") or return
203 defcmd = AccountManager.default_account.sendmail.sub(/\s(\-(ti|it|t))\b/) do |match|
210 cmd = case (hookcmd = HookManager.run "bounce-command", :from => m.from, :to => to)
211 when nil, /^$/ then defcmd
213 end + ' ' + to.map { |t| t.email }.join(' ')
215 bt = to.size > 1 ? "#{to.size} recipients" : to.to_s
217 if BufferManager.ask_yes_or_no "Really bounce to #{bt}?"
218 debug "bounce command: #{cmd}"
220 IO.popen(cmd, 'w') do |sm|
221 sm.puts m.raw_message
223 raise SendmailCommandFailed, "Couldn't execute #{cmd}" unless $? == 0
224 rescue SystemCallError, SendmailCommandFailed => e
225 warn "problem sending mail: #{e.message}"
226 BufferManager.flash "Problem sending mail: #{e.message}"
231 include CanAliasContacts
233 p = @person_lines[curpos] or return
239 p = @person_lines[curpos] or return
240 mode = PersonSearchResultsMode.new [p]
241 BufferManager.spawn "Search for #{p.name}", mode
242 mode.load_threads :num => mode.buffer.content_height
246 p = @person_lines[curpos]
248 ComposeMode.spawn_nicely :to_default => p
250 ComposeMode.spawn_nicely
255 reserved_labels = @thread.labels.select { |l| LabelManager::RESERVED_LABELS.include? l }
256 new_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", @thread.labels
258 return unless new_labels
259 @thread.labels = Set.new(reserved_labels) + new_labels
260 new_labels.each { |l| LabelManager << l }
262 UpdateManager.relay self, :labeled, @thread.first
266 m = @message_lines[curpos] or return
267 toggle_label m, :starred
271 m = @message_lines[curpos] or return
272 toggle_label m, :unread
275 def toggle_label m, label
276 if m.has_label? label
281 ## TODO: don't recalculate EVERYTHING just to add a stupid little
282 ## star to the display
284 UpdateManager.relay self, :single_message_labeled, m
287 ## called when someone presses enter when the cursor is highlighting
288 ## a chunk. for expandable chunks (including messages) we toggle
289 ## open/closed state; for viewable chunks (like attachments) we
292 chunk = @chunk_lines[curpos] or return
293 if chunk.is_a? Chunk::Text
294 ## if the cursor is over a text region, expand/collapse the
296 chunk = @message_lines[curpos]
298 layout = if chunk.is_a?(Message)
300 elsif chunk.expandable?
304 layout.state = (layout.state != :closed ? :closed : :open)
305 #cursor_down if layout.state == :closed # too annoying
307 elsif chunk.viewable?
310 if chunk.is_a?(Message)
311 jump_to_message chunk
312 jump_to_next_open if layout.state == :closed
317 m = @message_lines[curpos] or return
318 mode = ComposeMode.new(:body => m.quotable_body_lines, :to => m.to, :cc => m.cc, :subj => m.subj, :bcc => m.bcc, :refs => m.refs, :replytos => m.replytos)
319 BufferManager.spawn "edit as new", mode
324 chunk = @chunk_lines[curpos] or return
326 when Chunk::Attachment
327 default_dir = File.join(($config[:default_attachment_save_dir] || "."), chunk.filename)
328 fn = BufferManager.ask_for_filename :filename, "Save attachment to file: ", default_dir
329 save_to_file(fn) { |f| f.print chunk.raw_content } if fn
331 m = @message_lines[curpos]
332 fn = BufferManager.ask_for_filename :filename, "Save message to file: "
334 save_to_file(fn) do |f|
335 m.each_raw_message_line { |l| f.print l }
341 m = @message_lines[curpos] or return
343 mode = ResumeMode.new m
344 BufferManager.spawn "Edit message", mode
345 BufferManager.kill_buffer self.buffer
348 BufferManager.flash "Not a draft message!"
353 m = @message_lines[curpos] or return
355 mode = ResumeMode.new m
356 BufferManager.spawn "Send message", mode
357 BufferManager.kill_buffer self.buffer
360 BufferManager.flash "Not a draft message!"
364 def jump_to_first_open loose_alignment=false
365 m = @message_lines[0] or return
366 if @layout[m].state != :closed
367 jump_to_message m, loose_alignment
369 jump_to_next_open loose_alignment
373 def jump_to_next_open loose_alignment=false
374 return continue_search_in_buffer if in_search? # hack: allow 'n' to apply to both operations
375 m = (curpos ... @message_lines.length).argfind { |i| @message_lines[i] }
377 while nextm = @layout[m].next
378 break if @layout[nextm].state != :closed
381 jump_to_message nextm, loose_alignment if nextm
384 def align_current_message
385 m = @message_lines[curpos] or return
389 def jump_to_prev_open loose_alignment=false
390 m = (0 .. curpos).to_a.reverse.argfind { |i| @message_lines[i] } # bah, .to_a
392 ## jump to the top of the current message if we're in the body;
393 ## otherwise, to the previous message
397 while(prevm = @layout[m].prev)
398 break if @layout[prevm].state != :closed
401 jump_to_message prevm, loose_alignment if prevm
403 jump_to_message m, loose_alignment
407 IDEAL_TOP_CONTEXT = 3 # try and give 3 rows of top context
408 IDEAL_LEFT_CONTEXT = 4 # try and give 4 columns of left context
409 def jump_to_message m, loose_alignment=false
411 left = l.depth * INDENT_SPACES
412 right = left + l.width
414 ## jump to the top line
416 jump_to_line [l.top - IDEAL_TOP_CONTEXT, 0].max # give 3 lines of top context
421 ## jump to the left column
424 -IDEAL_LEFT_CONTEXT + (l.width - buffer.content_width + IDEAL_LEFT_CONTEXT + 1).clamp(0, IDEAL_LEFT_CONTEXT)
429 jump_to_col [ideal_left, 0].max
431 ## either way, move the cursor to the first line
435 def expand_all_messages
436 @global_message_state ||= :closed
437 @global_message_state = (@global_message_state == :closed ? :open : :closed)
438 @layout.each { |m, l| l.state = @global_message_state }
442 def collapse_non_new_messages
443 @layout.each { |m, l| l.state = l.orig_new ? :open : :closed }
447 def expand_all_quotes
448 if(m = @message_lines[curpos])
449 quotes = m.chunks.select { |c| (c.is_a?(Chunk::Quote) || c.is_a?(Chunk::Signature)) && c.lines.length > 1 }
450 numopen = quotes.inject(0) { |s, c| s + (@chunk_layout[c].state == :open ? 1 : 0) }
451 newstate = numopen > quotes.length / 2 ? :closed : :open
452 quotes.each { |c| @chunk_layout[c].state = newstate }
458 @layout = @chunk_layout = @text = nil # for good luck
461 def archive_and_kill; archive_and_then :kill end
462 def spam_and_kill; spam_and_then :kill end
463 def delete_and_kill; delete_and_then :kill end
464 def unread_and_kill; unread_and_then :kill end
466 def archive_and_next; archive_and_then :next end
467 def spam_and_next; spam_and_then :next end
468 def delete_and_next; delete_and_then :next end
469 def unread_and_next; unread_and_then :next end
470 def do_nothing_and_next; do_nothing_and_then :next end
472 def archive_and_prev; archive_and_then :prev end
473 def spam_and_prev; spam_and_then :prev end
474 def delete_and_prev; delete_and_then :prev end
475 def unread_and_prev; unread_and_then :prev end
476 def do_nothing_and_prev; do_nothing_and_then :prev end
478 def archive_and_then op
480 @thread.remove_label :inbox
481 UpdateManager.relay self, :archived, @thread.first
487 @thread.apply_label :spam
488 UpdateManager.relay self, :spammed, @thread.first
492 def delete_and_then op
494 @thread.apply_label :deleted
495 UpdateManager.relay self, :deleted, @thread.first
499 def unread_and_then op
501 @thread.apply_label :unread
502 UpdateManager.relay self, :unread, @thread.first
506 def do_nothing_and_then op
515 yield if block_given?
516 BufferManager.kill_buffer_safely buffer
521 @index_mode.launch_next_thread_after @thread, &l
523 @index_mode.launch_prev_thread_before @thread, &l
527 raise ArgumentError, "unknown thread dispatch operation #{op.inspect}"
533 chunk = @chunk_lines[curpos]
534 chunk = nil unless chunk.is_a?(Chunk::Attachment)
535 message = @message_lines[curpos] unless chunk
537 return unless chunk || message
539 command = BufferManager.ask(:shell, "pipe command: ")
540 return if command.nil? || command.empty?
542 output = pipe_to_process(command) do |stream|
544 stream.print chunk.raw_content
546 message.each_raw_message_line { |l| stream.print l }
551 BufferManager.spawn "Output of '#{command}'", TextMode.new(output)
553 BufferManager.flash "'#{command}' done!"
559 def initial_state_for m
560 if m.has_label?(:starred) || m.has_label?(:unread)
569 buffer.mark_dirty if buffer
572 ## here we generate the actual content lines. we accumulate
573 ## everything into @text, and we set @chunk_lines and
574 ## @message_lines, and we update @layout.
582 @thread.each do |m, depth, parent|
583 unless m.is_a? Message # handle nil and :fake_root
584 @text += chunk_to_lines m, nil, @text.length, depth, parent
589 ## is this still necessary?
590 next unless @layout[m].state # skip discarded drafts
593 text = chunk_to_lines m, l.state, @text.length, depth, parent, l.color, l.star_color
596 l.bot = @text.length + text.length # updated below
600 # l.state we preserve
601 l.width = 0 # updated below
602 @layout[l.prev].next = m if l.prev
604 (0 ... text.length).each do |i|
605 @chunk_lines[@text.length + i] = m
606 @message_lines[@text.length + i] = m
607 lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.display_length }.sum
612 if l.state != :closed
614 cl = @chunk_layout[c]
616 ## set the default state for chunks
618 if c.expandable? && c.respond_to?(:initial_state)
624 text = chunk_to_lines c, cl.state, @text.length, depth
625 (0 ... text.length).each do |i|
626 @chunk_lines[@text.length + i] = c
627 @message_lines[@text.length + i] = m
628 lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.display_length }.sum - (depth * INDENT_SPACES)
629 l.width = lw if lw > l.width
633 @layout[m].bot = @text.length
638 def message_patina_lines m, state, start, parent, prefix, color, star_color
639 prefix_widget = [color, prefix]
641 open_widget = [color, (state == :closed ? "+ " : "- ")]
642 new_widget = [color, (m.has_label?(:unread) ? "N" : " ")]
643 starred_widget = if m.has_label?(:starred)
648 attach_widget = [color, (m.has_label?(:attachment) ? "@" : " ")]
652 @person_lines[start] = m.from
653 [[prefix_widget, open_widget, new_widget, attach_widget, starred_widget,
655 "#{m.from ? m.from.mediumname : '?'} to #{m.recipients.map { |l| l.shortname }.join(', ')} #{m.date.to_nice_s} (#{m.date.to_nice_distance_s})"]]]
658 @person_lines[start] = m.from
659 [[prefix_widget, open_widget, new_widget, attach_widget, starred_widget,
661 "#{m.from ? m.from.mediumname : '?'}, #{m.date.to_nice_s} (#{m.date.to_nice_distance_s}) #{m.snippet}"]]]
664 @person_lines[start] = m.from
665 from_line = [[prefix_widget, open_widget, new_widget, attach_widget, starred_widget,
666 [color, "From: #{m.from ? format_person(m.from) : '?'}"]]]
670 m.to.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
671 addressee_lines += format_person_list " To: ", m.to
674 m.cc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
675 addressee_lines += format_person_list " Cc: ", m.cc
678 m.bcc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
679 addressee_lines += format_person_list " Bcc: ", m.bcc
682 headers = OrderedHash.new
683 headers["Date"] = "#{m.date.strftime DATE_FORMAT} (#{m.date.to_nice_distance_s})"
684 headers["Subject"] = m.subj
686 show_labels = @thread.labels - LabelManager::HIDDEN_RESERVED_LABELS
687 unless show_labels.empty?
688 headers["Labels"] = show_labels.map { |x| x.to_s }.sort.join(', ')
691 headers["In reply to"] = "#{parent.from.mediumname}'s message of #{parent.date.strftime DATE_FORMAT}"
694 HookManager.run "detailed-headers", :message => m, :headers => headers
696 from_line + (addressee_lines + headers.map { |k, v| " #{k}: #{v}" }).map { |l| [[color, prefix + " " + l]] }
700 def format_person_list prefix, people
701 ptext = people.map { |p| format_person p }
702 pad = " " * prefix.display_length
703 [prefix + ptext.first + (ptext.length > 1 ? "," : "")] +
704 ptext[1 .. -1].map_with_index do |e, i|
705 pad + e + (i == ptext.length - 1 ? "" : ",")
710 p.longname + (ContactManager.is_aliased_contact?(p) ? " (#{ContactManager.alias_for p})" : "")
713 ## todo: check arguments on this overly complex function
714 def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil, star_color=nil
715 prefix = " " * INDENT_SPACES * depth
718 [[[:missing_message_color, "#{prefix}<one or more unreceived messages>"]]]
720 [[[:missing_message_color, "#{prefix}<an unreceived message>"]]]
722 message_patina_lines(chunk, state, start, parent, prefix, color, star_color) +
723 (chunk.is_draft? ? [[[:draft_notification_color, prefix + " >>> This message is a draft. Hit 'e' to edit, 'y' to send. <<<"]]] : [])
726 raise "Bad chunk: #{chunk.inspect}" unless chunk.respond_to?(:inlineable?) ## debugging
728 chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
729 elsif chunk.expandable?
732 [[[chunk.patina_color, "#{prefix}+ #{chunk.patina_text}"]]]
734 [[[chunk.patina_color, "#{prefix}- #{chunk.patina_text}"]]] + chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
737 [[[chunk.patina_color, "#{prefix}x #{chunk.patina_text}"]]]
743 BufferManager.flash "viewing #{chunk.content_type} attachment..."
744 success = chunk.view!
745 BufferManager.erase_flash
746 BufferManager.completely_redraw_screen
748 BufferManager.spawn "Attachment: #{chunk.filename}", TextMode.new(chunk.to_s, chunk.filename)
749 BufferManager.flash "Couldn't execute view command, viewing as text."