class ThreadViewMode < LineCursorMode
## this holds all info we need to lay out a message
- class Layout
- attr_accessor :top, :bot, :prev, :next, :depth, :width, :state
+ class MessageLayout
+ attr_accessor :top, :bot, :prev, :next, :depth, :width, :state, :color, :star_color, :orig_new
+ end
+
+ class ChunkLayout
+ attr_accessor :state
end
DATE_FORMAT = "%B %e %Y %l:%M%P"
INDENT_SPACES = 2 # how many spaces to indent child messages
+ HookManager.register "detailed-headers", <<EOS
+Add or remove headers from the detailed header display of a message.
+Variables:
+ message: The message whose headers are to be formatted.
+ headers: A hash of header (name, value) pairs, initialized to the default
+ headers.
+Return value:
+ None. The variable 'headers' should be modified in place.
+EOS
+
register_keymap do |k|
- k.add :toggle_detailed_header, "Toggle detailed header", 'd'
+ k.add :toggle_detailed_header, "Toggle detailed header", 'h'
k.add :show_header, "Show full message header", 'H'
- k.add :toggle_expanded, "Expand/collapse item", :enter
+ k.add :activate_chunk, "Expand/collapse or activate item", :enter
k.add :expand_all_messages, "Expand/collapse all messages", 'E'
- k.add :edit_message, "Edit message (drafts only)", 'e'
+ k.add :edit_draft, "Edit draft", 'e'
+ k.add :edit_labels, "Edit or add labels for a thread", 'l'
k.add :expand_all_quotes, "Expand/collapse all quotes in a message", 'o'
k.add :jump_to_next_open, "Jump to next open message", 'n'
k.add :jump_to_prev_open, "Jump to previous open message", 'p'
k.add :toggle_starred, "Star or unstar message", '*'
- k.add :collapse_non_new_messages, "Collapse all but new messages", 'N'
+ k.add :toggle_new, "Toggle new/read status of message", 'N'
+# k.add :collapse_non_new_messages, "Collapse all but unread messages", 'N'
k.add :reply, "Reply to a message", 'r'
k.add :forward, "Forward a message", 'f'
- k.add :alias, "Edit alias/nickname for a person", 'a'
- k.add :edit_as_new, "Edit message as new", 'd'
+ k.add :alias, "Edit alias/nickname for a person", 'i'
+ k.add :edit_as_new, "Edit message as new", 'D'
k.add :save_to_disk, "Save message/attachment to disk", 's'
k.add :search, "Search for messages from particular people", 'S'
+ k.add :compose, "Compose message to person", 'm'
+ k.add :archive_and_kill, "Archive thread and kill buffer", 'a'
+ k.add :delete_and_kill, "Delete thread and kill buffer", 'd'
+ k.add :subscribe_to_list, "Subscribe to/unsubscribe from mailing list", "("
+ k.add :unsubscribe_from_list, "Subscribe to/unsubscribe from mailing list", ")"
end
- ## there are a couple important instance variables we hold to lay
- ## out the thread and to provide line-based functionality. @layout
- ## is a map from Message and Chunk objects to Layout objects. (for
- ## chunks, we only use the state field right now.) @message_lines is
- ## a map from row #s to Message objects. @chunk_lines is a map from
- ## row #s to Chunk objects. @person_lines is a map from row #s to
- ## Person objects.
+ ## there are a couple important instance variables we hold to format
+ ## the thread and to provide line-based functionality. @layout is a
+ ## map from Messages to MessageLayouts, and @chunk_layout from
+ ## Chunks to ChunkLayouts. @message_lines is a map from row #s to
+ ## Message objects. @chunk_lines is a map from row #s to Chunk
+ ## objects. @person_lines is a map from row #s to Person objects.
def initialize thread, hidden_labels=[]
super()
@thread = thread
@hidden_labels = hidden_labels
- @layout = {}
+ @layout = SavingHash.new { MessageLayout.new }
+ @chunk_layout = SavingHash.new { ChunkLayout.new }
earliest, latest = nil, nil
latest_date = nil
+ altcolor = false
+
@thread.each do |m, d, p|
next unless m
earliest ||= m
- @layout[m] = Layout.new
@layout[m].state = initial_state_for m
+ @layout[m].color = altcolor ? :alternate_patina_color : :message_patina_color
+ @layout[m].star_color = altcolor ? :alternate_starred_patina_color : :starred_patina_color
+ @layout[m].orig_new = m.has_label? :read
+ altcolor = !altcolor
if latest_date.nil? || m.date > latest_date
latest_date = m.date
latest = m
@layout[latest].state = :open if @layout[latest].state == :closed
@layout[earliest].state = :detailed if earliest.has_label?(:unread) || @thread.size == 1
- BufferManager.say("Loading message bodies...") { regen_text }
+ @thread.remove_label :unread
+ regen_text
end
def draw_line ln, opts={}
BufferManager.spawn "Reply to #{m.subj}", mode
end
+ def subscribe_to_list
+ m = @message_lines[curpos] or return
+ if m.list_subscribe && m.list_subscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
+ ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [PersonManager.person_for($1)], :subj => $3
+ else
+ BufferManager.flash "Can't find List-Subscribe header for this message."
+ end
+ end
+
+ def unsubscribe_from_list
+ m = @message_lines[curpos] or return
+ if m.list_unsubscribe && m.list_unsubscribe =~ /<mailto:(.*?)\?(subject=(.*?))>/
+ ComposeMode.spawn_nicely :from => AccountManager.account_for(m.recipient_email), :to => [PersonManager.person_for($1)], :subj => $3
+ else
+ BufferManager.flash "Can't find List-Unsubscribe header for this message."
+ end
+ end
+
def forward
m = @message_lines[curpos] or return
- mode = ForwardMode.new m
- BufferManager.spawn "Forward of #{m.subj}", mode
- mode.edit
+ ForwardMode.spawn_nicely m
end
include CanAliasContacts
def alias
p = @person_lines[curpos] or return
alias_contact p
- regen_text
+ update
end
def search
p = @person_lines[curpos] or return
mode = PersonSearchResultsMode.new [p]
- BufferManager.spawn "search for #{p.name}", mode
+ BufferManager.spawn "Search for #{p.name}", mode
mode.load_threads :num => mode.buffer.content_height
end
+ def compose
+ p = @person_lines[curpos]
+ if p
+ ComposeMode.spawn_nicely :to => [p]
+ else
+ ComposeMode.spawn_nicely
+ end
+ end
+
+ def edit_labels
+ reserved_labels = @thread.labels.select { |l| LabelManager::RESERVED_LABELS.include? l }
+ new_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", @thread.labels
+
+ return unless new_labels
+ @thread.labels = (reserved_labels + new_labels).uniq
+ new_labels.each { |l| LabelManager << l }
+ update
+ UpdateManager.relay self, :label_thread, @thread
+ end
+
def toggle_starred
m = @message_lines[curpos] or return
- if m.has_label? :starred
- m.remove_label :starred
+ toggle_label m, :starred
+ end
+
+ def toggle_new
+ m = @message_lines[curpos] or return
+ toggle_label m, :unread
+ end
+
+ def toggle_label m, label
+ if m.has_label? label
+ m.remove_label label
else
- m.add_label :starred
+ m.add_label label
end
## TODO: don't recalculate EVERYTHING just to add a stupid little
## star to the display
update
- UpdateManager.relay :starred, m
+ UpdateManager.relay self, :label, m
end
- def toggle_expanded
+ ## called when someone presses enter when the cursor is highlighting
+ ## a chunk. for expandable chunks (including messages) we toggle
+ ## open/closed state; for viewable chunks (like attachments) we
+ ## view.
+ def activate_chunk
chunk = @chunk_lines[curpos] or return
- case chunk
- when Message, Message::Quote, Message::Signature
- l = @layout[chunk]
- l.state = (l.state != :closed ? :closed : :open)
- cursor_down if l.state == :closed
- when Message::Attachment
- view_attachment chunk
+ layout =
+ if chunk.is_a?(Message)
+ @layout[chunk]
+ elsif chunk.expandable?
+ @chunk_layout[chunk]
+ end
+ if layout
+ layout.state = (layout.state != :closed ? :closed : :open)
+ #cursor_down if layout.state == :closed # too annoying
+ update
+ elsif chunk.viewable?
+ view chunk
end
- update
end
def edit_as_new
m = @message_lines[curpos] or return
- mode = ComposeMode.new(:body => m.basic_body_lines, :to => m.to, :cc => m.cc, :subj => m.subj, :bcc => m.bcc)
+ mode = ComposeMode.new(:body => m.quotable_body_lines, :to => m.to, :cc => m.cc, :subj => m.subj, :bcc => m.bcc)
BufferManager.spawn "edit as new", mode
- mode.edit
+ mode.edit_message
end
def save_to_disk
chunk = @chunk_lines[curpos] or return
case chunk
- when Message::Attachment
- fn = BufferManager.ask :filename, "Save attachment to file: ", chunk.filename
- save_to_file(fn) { |f| f.print chunk } if fn
+ when Chunk::Attachment
+ fn = BufferManager.ask_for_filename :filename, "Save attachment to file: ", chunk.filename
+ save_to_file(fn) { |f| f.print chunk.raw_content } if fn
else
m = @message_lines[curpos]
- fn = BufferManager.ask :filename, "Save message to file: "
- save_to_file(fn) { |f| f.print m.raw_full_message } if fn
+ fn = BufferManager.ask_for_filename :filename, "Save message to file: "
+ return unless fn
+ save_to_file(fn) do |f|
+ m.each_raw_message_line { |l| f.print l }
+ end
end
end
- def edit_message
+ def edit_draft
m = @message_lines[curpos] or return
if m.is_draft?
mode = ResumeMode.new m
BufferManager.spawn "Edit message", mode
- mode.edit
+ BufferManager.kill_buffer self.buffer
+ mode.edit_message
else
BufferManager.flash "Not a draft message!"
end
end
+ def jump_to_first_open
+ m = @message_lines[0] or return
+ if @layout[m].state != :closed
+ jump_to_message m
+ else
+ jump_to_next_open
+ end
+ end
+
def jump_to_next_open
+ return continue_search_in_buffer if in_search? # hack: allow 'n' to apply to both operations
m = @message_lines[curpos] or return
while nextm = @layout[m].next
- break if @layout[nextm].state == :open
+ break if @layout[nextm].state != :closed
m = nextm
end
jump_to_message nextm if nextm
def expand_all_messages
@global_message_state ||= :closed
@global_message_state = (@global_message_state == :closed ? :open : :closed)
- @layout.each { |m, l| l.state = @global_message_state if m.is_a? Message }
+ @layout.each { |m, l| l.state = @global_message_state }
update
end
def collapse_non_new_messages
- @layout.each { |m, l| l.state = m.has_label?(:unread) ? :open : :closed }
+ @layout.each { |m, l| l.state = l.orig_new ? :open : :closed }
update
end
def expand_all_quotes
if(m = @message_lines[curpos])
- quotes = m.chunks.select { |c| c.is_a?(Message::Quote) || c.is_a?(Message::Signature) }
- numopen = quotes.inject(0) { |s, c| s + (@layout[c].state == :open ? 1 : 0) }
+ quotes = m.chunks.select { |c| (c.is_a?(Chunk::Quote) || c.is_a?(Chunk::Signature)) && c.lines.length > 1 }
+ numopen = quotes.inject(0) { |s, c| s + (@chunk_layout[c].state == :open ? 1 : 0) }
newstate = numopen > quotes.length / 2 ? :closed : :open
- quotes.each { |c| @layout[c].state = newstate }
+ quotes.each { |c| @chunk_layout[c].state = newstate }
update
end
end
- ## kinda slow for large threads. TODO: fasterify
def cleanup
- BufferManager.say "Marking messages as read..." do
- @thread.each do |m, d, p|
- if m && m.has_label?(:unread)
- m.remove_label :unread
- UpdateManager.relay :read, m
- end
- end
- end
- @layout = @text = nil
+ @layout = @chunk_layout = @text = nil # for good luck
+ end
+
+ def archive_and_kill
+ @thread.remove_label :inbox
+ UpdateManager.relay self, :archived, @thread
+ BufferManager.kill_buffer_safely buffer
end
-private
+ def delete_and_kill
+ @thread.apply_label :deleted
+ UpdateManager.relay self, :deleted, @thread
+ BufferManager.kill_buffer_safely buffer
+ end
+
+private
def initial_state_for m
if m.has_label?(:starred) || m.has_label?(:unread)
@text += chunk_to_lines m, nil, @text.length, depth, parent
next
end
+ l = @layout[m]
- ## we're occasionally called on @threads that have had messages
- ## added to them since initialization. luckily we regen_text on
- ## the entire thread every time the user does anything besides
- ## scrolling (basically), so we can just slap this on here.
- ##
- ## to pick nits, the niceness that i do in the constructor with
- ## 'latest' etc. (for automatically opening just the latest
- ## message if everything's been read) will not be valid, but
- ## that's just a nicety and hopefully this won't happen too
- ## often.
-
- l = (@layout[m] ||= Layout.new)
- l.state ||= initial_state_for m
+ ## is this still necessary?
+ next unless @layout[m].state # skip discarded drafts
## build the patina
- text = chunk_to_lines m, l.state, @text.length, depth, parent
+ text = chunk_to_lines m, l.state, @text.length, depth, parent, l.color, l.star_color
l.top = @text.length
l.bot = @text.length + text.length # updated below
@text += text
prevm = m
- if @layout[m].state != :closed
+ if l.state != :closed
m.chunks.each do |c|
- cl = (@layout[c] ||= Layout.new)
- cl.state ||= :closed
+ cl = @chunk_layout[c]
+
+ ## set the default state for chunks
+ cl.state ||=
+ if c.expandable? && c.respond_to?(:initial_state)
+ c.initial_state
+ else
+ :closed
+ end
+
text = chunk_to_lines c, cl.state, @text.length, depth
(0 ... text.length).each do |i|
@chunk_lines[@text.length + i] = c
end
end
- def message_patina_lines m, state, start, parent, prefix
- prefix_widget = [:message_patina_color, prefix]
- widget =
- case state
- when :closed
- [:message_patina_color, "+ "]
- when :open, :detailed
- [:message_patina_color, "- "]
- end
- imp_widget =
+ def message_patina_lines m, state, start, parent, prefix, color, star_color
+ prefix_widget = [color, prefix]
+
+ open_widget = [color, (state == :closed ? "+ " : "- ")]
+ new_widget = [color, (m.has_label?(:unread) ? "N" : " ")]
+ starred_widget =
if m.has_label?(:starred)
- [:starred_patina_color, "* "]
+ [star_color, "* "]
else
- [:message_patina_color, " "]
+ [color, " "]
end
case state
when :open
@person_lines[start] = m.from
- [[prefix_widget, widget, imp_widget,
- [:message_patina_color,
+ [[prefix_widget, open_widget, new_widget, starred_widget,
+ [color,
"#{m.from ? m.from.mediumname : '?'} to #{m.recipients.map { |l| l.shortname }.join(', ')} #{m.date.to_nice_s} (#{m.date.to_nice_distance_s})"]]]
when :closed
@person_lines[start] = m.from
- [[prefix_widget, widget, imp_widget,
- [:message_patina_color,
+ [[prefix_widget, open_widget, new_widget, starred_widget,
+ [color,
"#{m.from ? m.from.mediumname : '?'}, #{m.date.to_nice_s} (#{m.date.to_nice_distance_s}) #{m.snippet}"]]]
when :detailed
@person_lines[start] = m.from
- from = [[prefix_widget, widget, imp_widget, [:message_patina_color, "From: #{m.from ? format_person(m.from) : '?'}"]]]
+ from_line = [[prefix_widget, open_widget, new_widget, starred_widget,
+ [color, "From: #{m.from ? format_person(m.from) : '?'}"]]]
- rest = []
+ addressee_lines = []
unless m.to.empty?
- m.to.each_with_index { |p, i| @person_lines[start + rest.length + from.length + i] = p }
- rest += format_person_list " To: ", m.to
+ m.to.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
+ addressee_lines += format_person_list " To: ", m.to
end
unless m.cc.empty?
- m.cc.each_with_index { |p, i| @person_lines[start + rest.length + from.length + i] = p }
- rest += format_person_list " Cc: ", m.cc
+ m.cc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
+ addressee_lines += format_person_list " Cc: ", m.cc
end
unless m.bcc.empty?
- m.bcc.each_with_index { |p, i| @person_lines[start + rest.length + from.length + i] = p }
- rest += format_person_list " Bcc: ", m.bcc
+ m.bcc.each_with_index { |p, i| @person_lines[start + addressee_lines.length + from_line.length + i] = p }
+ addressee_lines += format_person_list " Bcc: ", m.bcc
+ end
+
+ headers = OrderedHash.new
+ headers["Date"] = "#{m.date.strftime DATE_FORMAT} (#{m.date.to_nice_distance_s})"
+ headers["Subject"] = m.subj
+
+ show_labels = @thread.labels - LabelManager::HIDDEN_RESERVED_LABELS
+ unless show_labels.empty?
+ headers["Labels"] = show_labels.map { |x| x.to_s }.sort.join(', ')
+ end
+ if parent
+ headers["In reply to"] = "#{parent.from.mediumname}'s message of #{parent.date.strftime DATE_FORMAT}"
end
- rest += [
- " Date: #{m.date.strftime DATE_FORMAT} (#{m.date.to_nice_distance_s})",
- " Subject: #{m.subj}",
- (parent ? " In reply to: #{parent.from.mediumname}'s message of #{parent.date.strftime DATE_FORMAT}" : nil),
- m.labels.empty? ? nil : " Labels: #{m.labels.join(', ')}",
- ].compact
+ HookManager.run "detailed-headers", :message => m, :headers => headers
- from + rest.map { |l| [[:message_patina_color, prefix + " " + l]] }
+ from_line + (addressee_lines + headers.map { |k, v| " #{k}: #{v}" }).map { |l| [[color, prefix + " " + l]] }
end
end
p.longname + (ContactManager.is_contact?(p) ? " (#{ContactManager.alias_for p})" : "")
end
- def chunk_to_lines chunk, state, start, depth, parent=nil
+ ## todo: check arguments on this overly complex function
+ def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil, star_color=nil
prefix = " " * INDENT_SPACES * depth
case chunk
when :fake_root
- [[[:message_patina_color, "#{prefix}<one or more unreceived messages>"]]]
+ [[[:missing_message_color, "#{prefix}<one or more unreceived messages>"]]]
when nil
- [[[:message_patina_color, "#{prefix}<an unreceived message>"]]]
+ [[[:missing_message_color, "#{prefix}<an unreceived message>"]]]
when Message
- message_patina_lines(chunk, state, start, parent, prefix) +
+ message_patina_lines(chunk, state, start, parent, prefix, color, star_color) +
(chunk.is_draft? ? [[[:draft_notification_color, prefix + " >>> This message is a draft. To edit, hit 'e'. <<<"]]] : [])
- when Message::Attachment
- [[[:mime_color, "#{prefix}+ MIME attachment #{chunk.content_type}#{chunk.desc ? ' (' + chunk.desc + ')': ''}"]]]
- when Message::Text
- t = chunk.lines
- if t.last =~ /^\s*$/ && t.length > 1
- t.pop while t[-2] =~ /^\s*$/ # pop until only one file empty line
- end
- t.map { |line| [[:none, "#{prefix}#{line}"]] }
- when Message::Quote
- case state
- when :closed
- [[[:quote_patina_color, "#{prefix}+ (#{chunk.lines.length} quoted lines)"]]]
- when :open
- t = chunk.lines
- [[[:quote_patina_color, "#{prefix}- (#{chunk.lines.length} quoted lines)"]]] +
- t.map { |line| [[:quote_color, "#{prefix}#{line}"]] }
- end
- when Message::Signature
- case state
- when :closed
- [[[:sig_patina_color, "#{prefix}+ (#{chunk.lines.length}-line signature)"]]]
- when :open
- t = chunk.lines
- [[[:sig_patina_color, "#{prefix}- (#{chunk.lines.length}-line signature)"]]] +
- t.map { |line| [[:sig_color, "#{prefix}#{line}"]] }
- end
+
else
- raise "unknown chunk type #{chunk.class.name}"
+ raise "Bad chunk: #{chunk.inspect}" unless chunk.respond_to?(:inlineable?) ## debugging
+ if chunk.inlineable?
+ chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
+ elsif chunk.expandable?
+ case state
+ when :closed
+ [[[chunk.patina_color, "#{prefix}+ #{chunk.patina_text}"]]]
+ when :open
+ [[[chunk.patina_color, "#{prefix}- #{chunk.patina_text}"]]] + chunk.lines.map { |line| [[chunk.color, "#{prefix}#{line}"]] }
+ end
+ else
+ [[[chunk.patina_color, "#{prefix}x #{chunk.patina_text}"]]]
+ end
end
end
- def view_attachment a
- BufferManager.flash "viewing #{a.content_type} attachment..."
- a.view!
+ def view chunk
+ BufferManager.flash "viewing #{chunk.content_type} attachment..."
+ success = chunk.view!
BufferManager.erase_flash
BufferManager.completely_redraw_screen
+ unless success
+ BufferManager.spawn "Attachment: #{chunk.filename}", TextMode.new(chunk.to_s)
+ BufferManager.flash "Couldn't execute view command, viewing as text."
+ end
end
-
end
end