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 :show_message, "Show full message (raw form)", 'V'
31 k.add :activate_chunk, "Expand/collapse or activate item", :enter
32 k.add :expand_all_messages, "Expand/collapse all messages", 'E'
33 k.add :edit_draft, "Edit draft", 'e'
34 k.add :send_draft, "Send draft", 'y'
35 k.add :edit_labels, "Edit or add labels for a thread", 'l'
36 k.add :expand_all_quotes, "Expand/collapse all quotes in a message", 'o'
37 k.add :jump_to_next_open, "Jump to next open message", 'n'
38 k.add :jump_to_prev_open, "Jump to previous open message", 'p'
39 k.add :align_current_message, "Align current message in buffer", 'z'
40 k.add :toggle_starred, "Star or unstar message", '*'
41 k.add :toggle_new, "Toggle unread/read status of message", 'N'
42 # k.add :collapse_non_new_messages, "Collapse all but unread messages", 'N'
43 k.add :reply, "Reply to a message", 'r'
44 k.add :forward, "Forward a message or attachment", 'f'
45 k.add :alias, "Edit alias/nickname for a person", 'i'
46 k.add :edit_as_new, "Edit message as new", 'D'
47 k.add :save_to_disk, "Save message/attachment to disk", 's'
48 k.add :search, "Search for messages from particular people", 'S'
49 k.add :compose, "Compose message to person", 'm'
50 k.add :subscribe_to_list, "Subscribe to/unsubscribe from mailing list", "("
51 k.add :unsubscribe_from_list, "Subscribe to/unsubscribe from mailing list", ")"
52 k.add :pipe_message, "Pipe message or attachment to a shell command", '|'
54 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read:", '.' do |kk|
55 kk.add :archive_and_kill, "Archive this thread and kill buffer", 'a'
56 kk.add :delete_and_kill, "Delete this thread and kill buffer", 'd'
57 kk.add :spam_and_kill, "Mark this thread as spam and kill buffer", 's'
58 kk.add :unread_and_kill, "Mark this thread as unread and kill buffer", 'N'
61 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read/do (n)othing:", ',' do |kk|
62 kk.add :archive_and_next, "Archive this thread, kill buffer, and view next", 'a'
63 kk.add :delete_and_next, "Delete this thread, kill buffer, and view next", 'd'
64 kk.add :spam_and_next, "Mark this thread as spam, kill buffer, and view next", 's'
65 kk.add :unread_and_next, "Mark this thread as unread, kill buffer, and view next", 'N'
66 kk.add :do_nothing_and_next, "Kill buffer, and view next", 'n'
69 k.add_multi "(a)rchive/(d)elete/mark as (s)pam/mark as u(N)read/do (n)othing:", ']' do |kk|
70 kk.add :archive_and_prev, "Archive this thread, kill buffer, and view previous", 'a'
71 kk.add :delete_and_prev, "Delete this thread, kill buffer, and view previous", 'd'
72 kk.add :spam_and_prev, "Mark this thread as spam, kill buffer, and view previous", 's'
73 kk.add :unread_and_prev, "Mark this thread as unread, kill buffer, and view previous", 'N'
74 kk.add :do_nothing_and_prev, "Kill buffer, and view previous", 'n'
78 ## there are a couple important instance variables we hold to format
79 ## the thread and to provide line-based functionality. @layout is a
80 ## map from Messages to MessageLayouts, and @chunk_layout from
81 ## Chunks to ChunkLayouts. @message_lines is a map from row #s to
82 ## Message objects. @chunk_lines is a map from row #s to Chunk
83 ## objects. @person_lines is a map from row #s to Person objects.
85 def initialize thread, hidden_labels=[], index_mode=nil
88 @hidden_labels = hidden_labels
90 ## used for dispatch-and-next
91 @index_mode = index_mode
94 @layout = SavingHash.new { MessageLayout.new }
95 @chunk_layout = SavingHash.new { ChunkLayout.new }
96 earliest, latest = nil, nil
100 @thread.each do |m, d, p|
103 @layout[m].state = initial_state_for m
104 @layout[m].color = altcolor ? :alternate_patina_color : :message_patina_color
105 @layout[m].star_color = altcolor ? :alternate_starred_patina_color : :starred_patina_color
106 @layout[m].orig_new = m.has_label? :read
108 if latest_date.nil? || m.date > latest_date
114 @layout[latest].state = :open if @layout[latest].state == :closed
115 @layout[earliest].state = :detailed if earliest.has_label?(:unread) || @thread.size == 1
117 @thread.remove_label :unread
121 def draw_line ln, opts={}
123 super ln, :highlight => true
128 def lines; @text.length; end
129 def [] i; @text[i]; end
132 m = @message_lines[curpos] or return
133 BufferManager.spawn_unless_exists("Full header for #{m.id}") do
134 TextMode.new m.raw_header
139 m = @message_lines[curpos] or return
140 BufferManager.spawn_unless_exists("Raw message for #{m.id}") do
141 TextMode.new m.raw_message
145 def toggle_detailed_header
146 m = @message_lines[curpos] or return
147 @layout[m].state = (@layout[m].state == :detailed ? :open : :detailed)
152 m = @message_lines[curpos] or return
153 mode = ReplyMode.new m
154 BufferManager.spawn "Reply to #{m.subj}", mode
157 def subscribe_to_list
158 m = @message_lines[curpos] or return
159 if m.list_subscribe && m.list_subscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
160 ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [Person.from_address($1)], :subj => $3
162 BufferManager.flash "Can't find List-Subscribe header for this message."
166 def unsubscribe_from_list
167 m = @message_lines[curpos] or return
168 if m.list_unsubscribe && m.list_unsubscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
169 ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [Person.from_address($1)], :subj => $3
171 BufferManager.flash "Can't find List-Unsubscribe header for this message."
176 if(chunk = @chunk_lines[curpos]) && chunk.is_a?(Chunk::Attachment)
177 ForwardMode.spawn_nicely :attachments => [chunk]
178 elsif(m = @message_lines[curpos])
179 ForwardMode.spawn_nicely :message => m
183 include CanAliasContacts
185 p = @person_lines[curpos] or return
191 p = @person_lines[curpos] or return
192 mode = PersonSearchResultsMode.new [p]
193 BufferManager.spawn "Search for #{p.name}", mode
194 mode.load_threads :num => mode.buffer.content_height
198 p = @person_lines[curpos]
200 ComposeMode.spawn_nicely :to_default => p
202 ComposeMode.spawn_nicely
207 reserved_labels = @thread.labels.select { |l| LabelManager::RESERVED_LABELS.include? l }
208 new_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", @thread.labels
210 return unless new_labels
211 @thread.labels = (reserved_labels + new_labels).uniq
212 new_labels.each { |l| LabelManager << l }
214 UpdateManager.relay self, :labeled, @thread.first
218 m = @message_lines[curpos] or return
219 toggle_label m, :starred
223 m = @message_lines[curpos] or return
224 toggle_label m, :unread
227 def toggle_label m, label
228 if m.has_label? label
233 ## TODO: don't recalculate EVERYTHING just to add a stupid little
234 ## star to the display
236 UpdateManager.relay self, :single_message_labeled, m
239 ## called when someone presses enter when the cursor is highlighting
240 ## a chunk. for expandable chunks (including messages) we toggle
241 ## open/closed state; for viewable chunks (like attachments) we
244 chunk = @chunk_lines[curpos] or return
245 if chunk.is_a? Chunk::Text
246 ## if the cursor is over a text region, expand/collapse the
248 chunk = @message_lines[curpos]
250 layout = if chunk.is_a?(Message)
252 elsif chunk.expandable?
256 layout.state = (layout.state != :closed ? :closed : :open)
257 #cursor_down if layout.state == :closed # too annoying
259 elsif chunk.viewable?
262 if chunk.is_a?(Message)
263 jump_to_message chunk
264 jump_to_next_open if layout.state == :closed
269 m = @message_lines[curpos] or return
270 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)
271 BufferManager.spawn "edit as new", mode
276 chunk = @chunk_lines[curpos] or return
278 when Chunk::Attachment
279 default_dir = File.join(($config[:default_attachment_save_dir] || "."), chunk.filename)
280 fn = BufferManager.ask_for_filename :filename, "Save attachment to file: ", default_dir
281 save_to_file(fn) { |f| f.print chunk.raw_content } if fn
283 m = @message_lines[curpos]
284 fn = BufferManager.ask_for_filename :filename, "Save message to file: "
286 save_to_file(fn) do |f|
287 m.each_raw_message_line { |l| f.print l }
293 m = @message_lines[curpos] or return
295 mode = ResumeMode.new m
296 BufferManager.spawn "Edit message", mode
297 BufferManager.kill_buffer self.buffer
300 BufferManager.flash "Not a draft message!"
305 m = @message_lines[curpos] or return
307 mode = ResumeMode.new m
308 BufferManager.spawn "Send message", mode
309 BufferManager.kill_buffer self.buffer
312 BufferManager.flash "Not a draft message!"
316 def jump_to_first_open loose_alignment=false
317 m = @message_lines[0] or return
318 if @layout[m].state != :closed
319 jump_to_message m, loose_alignment
321 jump_to_next_open loose_alignment
325 def jump_to_next_open loose_alignment=false
326 return continue_search_in_buffer if in_search? # hack: allow 'n' to apply to both operations
327 m = (curpos ... @message_lines.length).argfind { |i| @message_lines[i] }
329 while nextm = @layout[m].next
330 break if @layout[nextm].state != :closed
333 jump_to_message nextm, loose_alignment if nextm
336 def align_current_message
337 m = @message_lines[curpos] or return
341 def jump_to_prev_open loose_alignment=false
342 m = (0 .. curpos).to_a.reverse.argfind { |i| @message_lines[i] } # bah, .to_a
344 ## jump to the top of the current message if we're in the body;
345 ## otherwise, to the previous message
349 while(prevm = @layout[m].prev)
350 break if @layout[prevm].state != :closed
353 jump_to_message prevm, loose_alignment if prevm
355 jump_to_message m, loose_alignment
359 IDEAL_TOP_CONTEXT = 3 # try and give 3 rows of top context
360 IDEAL_LEFT_CONTEXT = 4 # try and give 4 columns of left context
361 def jump_to_message m, loose_alignment=false
363 left = l.depth * INDENT_SPACES
364 right = left + l.width
366 ## jump to the top line
368 jump_to_line [l.top - IDEAL_TOP_CONTEXT, 0].max # give 3 lines of top context
373 ## jump to the left column
376 -IDEAL_LEFT_CONTEXT + (l.width - buffer.content_width + IDEAL_LEFT_CONTEXT + 1).clamp(0, IDEAL_LEFT_CONTEXT)
381 jump_to_col [ideal_left, 0].max
383 ## either way, move the cursor to the first line
387 def expand_all_messages
388 @global_message_state ||= :closed
389 @global_message_state = (@global_message_state == :closed ? :open : :closed)
390 @layout.each { |m, l| l.state = @global_message_state }
394 def collapse_non_new_messages
395 @layout.each { |m, l| l.state = l.orig_new ? :open : :closed }
399 def expand_all_quotes
400 if(m = @message_lines[curpos])
401 quotes = m.chunks.select { |c| (c.is_a?(Chunk::Quote) || c.is_a?(Chunk::Signature)) && c.lines.length > 1 }
402 numopen = quotes.inject(0) { |s, c| s + (@chunk_layout[c].state == :open ? 1 : 0) }
403 newstate = numopen > quotes.length / 2 ? :closed : :open
404 quotes.each { |c| @chunk_layout[c].state = newstate }
410 @layout = @chunk_layout = @text = nil # for good luck
413 def archive_and_kill; archive_and_then :kill end
414 def spam_and_kill; spam_and_then :kill end
415 def delete_and_kill; delete_and_then :kill end
416 def unread_and_kill; unread_and_then :kill end
418 def archive_and_next; archive_and_then :next end
419 def spam_and_next; spam_and_then :next end
420 def delete_and_next; delete_and_then :next end
421 def unread_and_next; unread_and_then :next end
422 def do_nothing_and_next; do_nothing_and_then :next end
424 def archive_and_prev; archive_and_then :prev end
425 def spam_and_prev; spam_and_then :prev end
426 def delete_and_prev; delete_and_then :prev end
427 def unread_and_prev; unread_and_then :prev end
428 def do_nothing_and_prev; do_nothing_and_then :prev end
430 def archive_and_then op
432 @thread.remove_label :inbox
433 UpdateManager.relay self, :archived, @thread.first
439 @thread.apply_label :spam
440 UpdateManager.relay self, :spammed, @thread.first
444 def delete_and_then op
446 @thread.apply_label :deleted
447 UpdateManager.relay self, :deleted, @thread.first
451 def unread_and_then op
453 @thread.apply_label :unread
454 UpdateManager.relay self, :unread, @thread.first
458 def do_nothing_and_then op
467 yield if block_given?
468 BufferManager.kill_buffer_safely buffer
473 @index_mode.launch_next_thread_after @thread, &l
475 @index_mode.launch_prev_thread_before @thread, &l
479 raise ArgumentError, "unknown thread dispatch operation #{op.inspect}"
485 chunk = @chunk_lines[curpos]
486 chunk = nil unless chunk.is_a?(Chunk::Attachment)
487 message = @message_lines[curpos] unless chunk
489 return unless chunk || message
491 command = BufferManager.ask(:shell, "pipe command: ")
492 return if command.nil? || command.empty?
494 output = pipe_to_process(command) do |stream|
496 stream.print chunk.raw_content
498 message.each_raw_message_line { |l| stream.print l }
503 BufferManager.spawn "Output of '#{command}'", TextMode.new(output)
505 BufferManager.flash "'#{command}' done!"
511 def initial_state_for m
512 if m.has_label?(:starred) || m.has_label?(:unread)
521 buffer.mark_dirty if buffer
524 ## here we generate the actual content lines. we accumulate
525 ## everything into @text, and we set @chunk_lines and
526 ## @message_lines, and we update @layout.
534 @thread.each do |m, depth, parent|
535 unless m.is_a? Message # handle nil and :fake_root
536 @text += chunk_to_lines m, nil, @text.length, depth, parent
541 ## is this still necessary?
542 next unless @layout[m].state # skip discarded drafts
545 text = chunk_to_lines m, l.state, @text.length, depth, parent, l.color, l.star_color
548 l.bot = @text.length + text.length # updated below
552 # l.state we preserve
553 l.width = 0 # updated below
554 @layout[l.prev].next = m if l.prev
556 (0 ... text.length).each do |i|
557 @chunk_lines[@text.length + i] = m
558 @message_lines[@text.length + i] = m
559 lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.display_length }.sum
564 if l.state != :closed
566 cl = @chunk_layout[c]
568 ## set the default state for chunks
570 if c.expandable? && c.respond_to?(:initial_state)
576 text = chunk_to_lines c, cl.state, @text.length, depth
577 (0 ... text.length).each do |i|
578 @chunk_lines[@text.length + i] = c
579 @message_lines[@text.length + i] = m
580 lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.display_length }.sum - (depth * INDENT_SPACES)
581 l.width = lw if lw > l.width
585 @layout[m].bot = @text.length
590 def message_patina_lines m, state, start, parent, prefix, color, star_color
591 prefix_widget = [color, prefix]
593 open_widget = [color, (state == :closed ? "+ " : "- ")]
594 new_widget = [color, (m.has_label?(:unread) ? "N" : " ")]
595 starred_widget = if m.has_label?(:starred)
600 attach_widget = [color, (m.has_label?(:attachment) ? "@" : " ")]
604 @person_lines[start] = m.from
605 [[prefix_widget, open_widget, new_widget, attach_widget, starred_widget,
607 "#{m.from ? m.from.mediumname : '?'} to #{m.recipients.map { |l| l.shortname }.join(', ')} #{m.date.to_nice_s} (#{m.date.to_nice_distance_s})"]]]
610 @person_lines[start] = m.from
611 [[prefix_widget, open_widget, new_widget, attach_widget, starred_widget,
613 "#{m.from ? m.from.mediumname : '?'}, #{m.date.to_nice_s} (#{m.date.to_nice_distance_s}) #{m.snippet}"]]]
616 @person_lines[start] = m.from
617 from_line = [[prefix_widget, open_widget, new_widget, attach_widget, starred_widget,
618 [color, "From: #{m.from ? format_person(m.from) : '?'}"]]]
622 m.to.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
623 addressee_lines += format_person_list " To: ", m.to
626 m.cc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
627 addressee_lines += format_person_list " Cc: ", m.cc
630 m.bcc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
631 addressee_lines += format_person_list " Bcc: ", m.bcc
634 headers = OrderedHash.new
635 headers["Date"] = "#{m.date.strftime DATE_FORMAT} (#{m.date.to_nice_distance_s})"
636 headers["Subject"] = m.subj
638 show_labels = @thread.labels - LabelManager::HIDDEN_RESERVED_LABELS
639 unless show_labels.empty?
640 headers["Labels"] = show_labels.map { |x| x.to_s }.sort.join(', ')
643 headers["In reply to"] = "#{parent.from.mediumname}'s message of #{parent.date.strftime DATE_FORMAT}"
646 HookManager.run "detailed-headers", :message => m, :headers => headers
648 from_line + (addressee_lines + headers.map { |k, v| " #{k}: #{v}" }).map { |l| [[color, prefix + " " + l]] }
652 def format_person_list prefix, people
653 ptext = people.map { |p| format_person p }
654 pad = " " * prefix.display_length
655 [prefix + ptext.first + (ptext.length > 1 ? "," : "")] +
656 ptext[1 .. -1].map_with_index do |e, i|
657 pad + e + (i == ptext.length - 1 ? "" : ",")
662 p.longname + (ContactManager.is_aliased_contact?(p) ? " (#{ContactManager.alias_for p})" : "")
665 ## todo: check arguments on this overly complex function
666 def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil, star_color=nil
667 prefix = " " * INDENT_SPACES * depth
670 [[[:missing_message_color, "#{prefix}<one or more unreceived messages>"]]]
672 [[[:missing_message_color, "#{prefix}<an unreceived message>"]]]
674 message_patina_lines(chunk, state, start, parent, prefix, color, star_color) +
675 (chunk.is_draft? ? [[[:draft_notification_color, prefix + " >>> This message is a draft. Hit 'e' to edit, 'y' to send. <<<"]]] : [])
678 raise "Bad chunk: #{chunk.inspect}" unless chunk.respond_to?(:inlineable?) ## debugging
680 chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
681 elsif chunk.expandable?
684 [[[chunk.patina_color, "#{prefix}+ #{chunk.patina_text}"]]]
686 [[[chunk.patina_color, "#{prefix}- #{chunk.patina_text}"]]] + chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
689 [[[chunk.patina_color, "#{prefix}x #{chunk.patina_text}"]]]
695 BufferManager.flash "viewing #{chunk.content_type} attachment..."
696 success = chunk.view!
697 BufferManager.erase_flash
698 BufferManager.completely_redraw_screen
700 BufferManager.spawn "Attachment: #{chunk.filename}", TextMode.new(chunk.to_s, chunk.filename)
701 BufferManager.flash "Couldn't execute view command, viewing as text."