]> git.cworth.org Git - sup/blob - lib/sup/modes/thread-view-mode.rb
bugfix for expand new messages
[sup] / lib / sup / modes / thread-view-mode.rb
1 module Redwood
2
3 class ThreadViewMode < LineCursorMode
4   ## this holds all info we need to lay out a message
5   class Layout
6     attr_accessor :top, :bot, :prev, :next, :depth, :width, :state, :color, :orig_new
7   end
8
9   DATE_FORMAT = "%B %e %Y %l:%M%P"
10   INDENT_SPACES = 2 # how many spaces to indent child messages
11
12   register_keymap do |k|
13     k.add :toggle_detailed_header, "Toggle detailed header", 'd'
14     k.add :show_header, "Show full message header", 'H'
15     k.add :toggle_expanded, "Expand/collapse item", :enter
16     k.add :expand_all_messages, "Expand/collapse all messages", 'E'
17     k.add :edit_message, "Edit message (drafts only)", 'e'
18     k.add :expand_all_quotes, "Expand/collapse all quotes in a message", 'o'
19     k.add :jump_to_next_open, "Jump to next open message", 'n'
20     k.add :jump_to_prev_open, "Jump to previous open message", 'p'
21     k.add :toggle_starred, "Star or unstar message", '*'
22     k.add :collapse_non_new_messages, "Collapse all but new messages", 'N'
23     k.add :reply, "Reply to a message", 'r'
24     k.add :forward, "Forward a message", 'f'
25     k.add :alias, "Edit alias/nickname for a person", 'a'
26     k.add :edit_as_new, "Edit message as new", 'D'
27     k.add :save_to_disk, "Save message/attachment to disk", 's'
28     k.add :search, "Search for messages from particular people", 'S'
29     k.add :compose, "Compose message to person", 'm'
30     k.add :archive_and_kill, "Archive thread and kill buffer", 'A'
31   end
32
33   ## there are a couple important instance variables we hold to lay
34   ## out the thread and to provide line-based functionality. @layout
35   ## is a map from Message and Chunk objects to Layout objects. (for
36   ## chunks, we only use the state field right now.) @message_lines is
37   ## a map from row #s to Message objects. @chunk_lines is a map from
38   ## row #s to Chunk objects. @person_lines is a map from row #s to
39   ## Person objects.
40
41   def initialize thread, hidden_labels=[]
42     super()
43     @thread = thread
44     @hidden_labels = hidden_labels
45
46     @layout = {}
47     earliest, latest = nil, nil
48     latest_date = nil
49     altcolor = false
50     @thread.each do |m, d, p|
51       next unless m
52       earliest ||= m
53       @layout[m] = Layout.new
54       @layout[m].state = initial_state_for m
55       @layout[m].color = altcolor ? :alternate_patina_color : :message_patina_color
56       @layout[m].orig_new = m.has_label? :unread
57       altcolor = !altcolor
58       if latest_date.nil? || m.date > latest_date
59         latest_date = m.date
60         latest = m
61       end
62     end
63
64     @layout[latest].state = :open if @layout[latest].state == :closed
65     @layout[earliest].state = :detailed if earliest.has_label?(:unread) || @thread.size == 1
66
67     regen_text
68   end
69
70   def draw_line ln, opts={}
71     if ln == curpos
72       super ln, :highlight => true
73     else
74       super
75     end
76   end
77   def lines; @text.length; end
78   def [] i; @text[i]; end
79
80   def show_header
81     m = @message_lines[curpos] or return
82     BufferManager.spawn_unless_exists("Full header") do
83       TextMode.new m.raw_header
84     end
85   end
86
87   def toggle_detailed_header
88     m = @message_lines[curpos] or return
89     @layout[m].state = (@layout[m].state == :detailed ? :open : :detailed)
90     update
91   end
92
93   def reply
94     m = @message_lines[curpos] or return
95     mode = ReplyMode.new m
96     BufferManager.spawn "Reply to #{m.subj}", mode
97   end
98
99   def forward
100     m = @message_lines[curpos] or return
101     mode = ForwardMode.new m
102     BufferManager.spawn "Forward of #{m.subj}", mode
103     mode.edit
104   end
105
106   include CanAliasContacts
107   def alias
108     p = @person_lines[curpos] or return
109     alias_contact p
110     update
111   end
112
113   def search
114     p = @person_lines[curpos] or return
115     mode = PersonSearchResultsMode.new [p]
116     BufferManager.spawn "Search for #{p.name}", mode
117     mode.load_threads :num => mode.buffer.content_height
118   end    
119
120   def compose
121     p = @person_lines[curpos] or return
122     mode = ComposeMode.new :to => [p]
123     BufferManager.spawn "Message to #{p.name}", mode
124     mode.edit
125   end    
126
127   def toggle_starred
128     m = @message_lines[curpos] or return
129     if m.has_label? :starred
130       m.remove_label :starred
131     else
132       m.add_label :starred
133     end
134     ## TODO: don't recalculate EVERYTHING just to add a stupid little
135     ## star to the display
136     update
137     UpdateManager.relay self, :starred, m
138   end
139
140   def toggle_expanded
141     chunk = @chunk_lines[curpos] or return
142     case chunk
143     when Message, Message::Quote, Message::Signature
144       return if chunk.lines.length == 1 unless chunk.is_a? Message # too small to expand/close
145       l = @layout[chunk]
146       l.state = (l.state != :closed ? :closed : :open)
147       cursor_down if l.state == :closed
148     when Message::Attachment
149       view_attachment chunk
150     end
151     update
152   end
153
154   def edit_as_new
155     m = @message_lines[curpos] or return
156     mode = ComposeMode.new(:body => m.basic_body_lines, :to => m.to, :cc => m.cc, :subj => m.subj, :bcc => m.bcc)
157     BufferManager.spawn "edit as new", mode
158     mode.edit
159   end
160
161   def save_to_disk
162     chunk = @chunk_lines[curpos] or return
163     case chunk
164     when Message::Attachment
165       fn = BufferManager.ask :filename, "Save attachment to file: ", chunk.filename
166       save_to_file(fn) { |f| f.print chunk } if fn
167     else
168       m = @message_lines[curpos]
169       fn = BufferManager.ask :filename, "Save message to file: "
170       save_to_file(fn) { |f| f.print m.raw_full_message } if fn
171     end
172   end
173
174   def edit_message
175     m = @message_lines[curpos] or return
176     if m.is_draft?
177       mode = ResumeMode.new m
178       BufferManager.spawn "Edit message", mode
179       mode.edit
180     else
181       BufferManager.flash "Not a draft message!"
182     end
183   end
184
185   def jump_to_first_open
186     m = @message_lines[0] or return
187     if @layout[m].state != :closed
188       jump_to_message m
189     else
190       jump_to_next_open
191     end
192   end
193
194   def jump_to_next_open
195     m = @message_lines[curpos] or return
196     while nextm = @layout[m].next
197       break if @layout[nextm].state != :closed
198       m = nextm
199     end
200     jump_to_message nextm if nextm
201   end
202
203   def jump_to_prev_open
204     m = @message_lines[curpos] or return
205     ## jump to the top of the current message if we're in the body;
206     ## otherwise, to the previous message
207     
208     top = @layout[m].top
209     if curpos == top
210       while(prevm = @layout[m].prev)
211         break if @layout[prevm].state != :closed
212         m = prevm
213       end
214       jump_to_message prevm if prevm
215     else
216       jump_to_message m
217     end
218   end
219
220   def jump_to_message m
221     l = @layout[m]
222     left = l.depth * INDENT_SPACES
223     right = left + l.width
224
225     ## jump to the top line unless both top and bottom fit in the current view
226     jump_to_line l.top unless l.top >= topline && l.top <= botline && l.bot >= topline && l.bot <= botline
227
228     ## jump to the left columns unless both left and right fit in the current view
229     jump_to_col left unless left >= leftcol && left <= rightcol && right >= leftcol && right <= rightcol
230
231     ## either way, move the cursor to the first line
232     set_cursor_pos l.top
233   end
234
235   def expand_all_messages
236     @global_message_state ||= :closed
237     @global_message_state = (@global_message_state == :closed ? :open : :closed)
238     @layout.each { |m, l| l.state = @global_message_state if m.is_a? Message }
239     update
240   end
241
242   def collapse_non_new_messages
243     @layout.each { |m, l| l.state = l.orig_new ? :open : :closed if m.is_a? Message }
244     update
245   end
246
247   def expand_all_quotes
248     if(m = @message_lines[curpos])
249       quotes = m.chunks.select { |c| (c.is_a?(Message::Quote) || c.is_a?(Message::Signature)) && c.lines.length > 1 }
250       numopen = quotes.inject(0) { |s, c| s + (@layout[c].state == :open ? 1 : 0) }
251       newstate = numopen > quotes.length / 2 ? :closed : :open
252       quotes.each { |c| @layout[c].state = newstate }
253       update
254     end
255   end
256
257   def cleanup
258     @layout = @text = nil # for good luck
259   end
260
261   def archive_and_kill
262     @thread.remove_label :inbox
263     UpdateManager.relay self, :archived, @thread
264     BufferManager.kill_buffer_safely buffer
265   end
266
267 private 
268
269   def initial_state_for m
270     if m.has_label?(:starred) || m.has_label?(:unread)
271       :open
272     else
273       :closed
274     end
275   end
276
277   def update
278     regen_text
279     buffer.mark_dirty if buffer
280   end
281
282   ## here we generate the actual content lines. we accumulate
283   ## everything into @text, and we set @chunk_lines and
284   ## @message_lines, and we update @layout.
285   def regen_text
286     @text = []
287     @chunk_lines = []
288     @message_lines = []
289     @person_lines = []
290
291     prevm = nil
292     @thread.each do |m, depth, parent|
293       unless m.is_a? Message # handle nil and :fake_root
294         @text += chunk_to_lines m, nil, @text.length, depth, parent
295         next
296       end
297       l = @layout[m] or next # TODO: figure out why this is nil sometimes
298
299       ## build the patina
300       text = chunk_to_lines m, l.state, @text.length, depth, parent, @layout[m].color
301       
302       l.top = @text.length
303       l.bot = @text.length + text.length # updated below
304       l.prev = prevm
305       l.next = nil
306       l.depth = depth
307       # l.state we preserve
308       l.width = 0 # updated below
309       @layout[l.prev].next = m if l.prev
310
311       (0 ... text.length).each do |i|
312         @chunk_lines[@text.length + i] = m
313         @message_lines[@text.length + i] = m
314         lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.length }.sum
315       end
316
317       @text += text
318       prevm = m 
319       if @layout[m].state != :closed
320         m.chunks.each do |c|
321           cl = (@layout[c] ||= Layout.new)
322           cl.state ||= :closed
323           text = chunk_to_lines c, cl.state, @text.length, depth
324           (0 ... text.length).each do |i|
325             @chunk_lines[@text.length + i] = c
326             @message_lines[@text.length + i] = m
327             lw = text[i].flatten.select { |x| x.is_a? String }.map { |x| x.length }.sum - (depth * INDENT_SPACES)
328             l.width = lw if lw > l.width
329           end
330           @text += text
331         end
332         @layout[m].bot = @text.length
333       end
334     end
335   end
336
337   def message_patina_lines m, state, start, parent, prefix, color
338     prefix_widget = [color, prefix]
339     widget = 
340       case state
341       when :closed
342         [color, "+ "]
343       when :open, :detailed
344         [color, "- "]
345       end
346     imp_widget = 
347       if m.has_label?(:starred)
348         [:starred_patina_color, "* "]
349       else
350         [color, "  "]
351       end
352
353     case state
354     when :open
355       @person_lines[start] = m.from
356       [[prefix_widget, widget, imp_widget,
357         [color, 
358             "#{m.from ? m.from.mediumname : '?'} to #{m.recipients.map { |l| l.shortname }.join(', ')} #{m.date.to_nice_s} (#{m.date.to_nice_distance_s})"]]]
359
360     when :closed
361       @person_lines[start] = m.from
362       [[prefix_widget, widget, imp_widget,
363         [color, 
364         "#{m.from ? m.from.mediumname : '?'}, #{m.date.to_nice_s} (#{m.date.to_nice_distance_s})  #{m.snippet}"]]]
365
366     when :detailed
367       @person_lines[start] = m.from
368       from = [[prefix_widget, widget, imp_widget, [color, "From: #{m.from ? format_person(m.from) : '?'}"]]]
369
370       rest = []
371       unless m.to.empty?
372         m.to.each_with_index { |p, i| @person_lines[start + rest.length + from.length + i] = p }
373         rest += format_person_list "  To: ", m.to
374       end
375       unless m.cc.empty?
376         m.cc.each_with_index { |p, i| @person_lines[start + rest.length + from.length + i] = p }
377         rest += format_person_list "  Cc: ", m.cc
378       end
379       unless m.bcc.empty?
380         m.bcc.each_with_index { |p, i| @person_lines[start + rest.length + from.length + i] = p }
381         rest += format_person_list "  Bcc: ", m.bcc
382       end
383
384       rest += [
385         "  Date: #{m.date.strftime DATE_FORMAT} (#{m.date.to_nice_distance_s})",
386         "  Subject: #{m.subj}",
387         (parent ? "  In reply to: #{parent.from.mediumname}'s message of #{parent.date.strftime DATE_FORMAT}" : nil),
388         m.labels.empty? ? nil : "  Labels: #{m.labels.join(', ')}",
389       ].compact
390       
391       from + rest.map { |l| [[color, prefix + "  " + l]] }
392     end
393   end
394
395   def format_person_list prefix, people
396     ptext = people.map { |p| format_person p }
397     pad = " " * prefix.length
398     [prefix + ptext.first + (ptext.length > 1 ? "," : "")] + 
399       ptext[1 .. -1].map_with_index do |e, i|
400         pad + e + (i == ptext.length - 1 ? "" : ",")
401       end
402   end
403
404   def format_person p
405     p.longname + (ContactManager.is_contact?(p) ? " (#{ContactManager.alias_for p})" : "")
406   end
407
408   def chunk_to_lines chunk, state, start, depth, parent=nil, color=nil
409     prefix = " " * INDENT_SPACES * depth
410     case chunk
411     when :fake_root
412       [[[:missing_message_color, "#{prefix}<one or more unreceived messages>"]]]
413     when nil
414       [[[:missing_message_color, "#{prefix}<an unreceived message>"]]]
415     when Message
416       message_patina_lines(chunk, state, start, parent, prefix, color) +
417         (chunk.is_draft? ? [[[:draft_notification_color, prefix + " >>> This message is a draft. To edit, hit 'e'. <<<"]]] : [])
418     when Message::Attachment
419       [[[:mime_color, "#{prefix}+ MIME attachment #{chunk.content_type}#{chunk.desc ? ' (' + chunk.desc + ')': ''}"]]]
420     when Message::Text
421       t = chunk.lines
422       if t.last =~ /^\s*$/ && t.length > 1
423         t.pop while t[-2] =~ /^\s*$/ # pop until only one file empty line
424       end
425       t.map { |line| [[:none, "#{prefix}#{line}"]] }
426     when Message::Quote
427       return [[[:quote_color, "#{prefix}#{chunk.lines.first}"]]] if chunk.lines.length == 1
428       case state
429       when :closed
430         [[[:quote_patina_color, "#{prefix}+ (#{chunk.lines.length} quoted lines)"]]]
431       when :open
432         [[[:quote_patina_color, "#{prefix}- (#{chunk.lines.length} quoted lines)"]]] + chunk.lines.map { |line| [[:quote_color, "#{prefix}#{line}"]] }
433       end
434     when Message::Signature
435       return [[[:sig_patina_color, "#{prefix}#{chunk.lines.first}"]]] if chunk.lines.length == 1
436       case state
437       when :closed
438         [[[:sig_patina_color, "#{prefix}+ (#{chunk.lines.length}-line signature)"]]]
439       when :open
440         [[[:sig_patina_color, "#{prefix}- (#{chunk.lines.length}-line signature)"]]] + chunk.lines.map { |line| [[:sig_color, "#{prefix}#{line}"]] }
441       end
442     else
443       raise "unknown chunk type #{chunk.class.name}"
444     end
445   end
446
447   def view_attachment a
448     BufferManager.flash "viewing #{a.content_type} attachment..."
449     success = a.view!
450     BufferManager.erase_flash
451     BufferManager.completely_redraw_screen
452     BufferManager.flash "Couldn't execute view command." unless success
453   end
454
455 end
456
457 end