3 ## subclasses should implement:
6 class ThreadIndexMode < LineCursorMode
7 DATE_WIDTH = Time::TO_NICE_S_MAX_LEN
9 LOAD_MORE_THREAD_NUM = 20
11 HookManager.register "index-mode-size-widget", <<EOS
12 Generates the per-thread size widget for each thread.
14 thread: The message thread to be formatted.
17 register_keymap do |k|
18 k.add :load_threads, "Load #{LOAD_MORE_THREAD_NUM} more threads", 'M'
19 k.add :reload, "Refresh view", '@'
20 k.add :toggle_archived, "Toggle archived status", 'a'
21 k.add :toggle_starred, "Star or unstar all messages in thread", '*'
22 k.add :toggle_new, "Toggle new/read status of all messages in thread", 'N'
23 k.add :edit_labels, "Edit or add labels for a thread", 'l'
24 k.add :edit_message, "Edit message (drafts only)", 'e'
25 k.add :toggle_spam, "Mark/unmark thread as spam", 'S'
26 k.add :toggle_deleted, "Delete/undelete thread", 'd'
27 k.add :kill, "Kill thread (never to be seen in inbox again)", '&'
28 k.add :save, "Save changes now", '$'
29 k.add :jump_to_next_new, "Jump to next new thread", :tab
30 k.add :reply, "Reply to latest message in a thread", 'r'
31 k.add :forward, "Forward latest message in a thread", 'f'
32 k.add :toggle_tagged, "Tag/untag selected thread", 't'
33 k.add :toggle_tagged_all, "Tag/untag all threads", 'T'
34 k.add :tag_matching, "Tag matching threads", 'g'
35 k.add :apply_to_tagged, "Apply next command to all tagged threads", ';'
36 k.add :join_threads, "Force tagged threads to be joined into the same thread", '#'
39 def initialize hidden_labels=[], load_thread_opts={}
41 @mutex = Mutex.new # covers the following variables:
44 @size_widget_width = nil
46 @tags = Tagger.new self
48 ## these guys, and @text and @lines, are not covered
50 @load_thread_opts = load_thread_opts
51 @hidden_labels = hidden_labels + LabelManager::HIDDEN_RESERVED_LABELS
52 @date_width = DATE_WIDTH
54 initialize_threads # defines @ts and @ts_mutex
55 update # defines @text and @lines
57 UpdateManager.register self
59 @last_load_more_size = nil
60 to_load_more do |size|
61 next if @last_load_more_size == 0
62 load_threads :num => 1, :background => false
63 load_threads :num => (size - 1),
64 :when_done => lambda { |num| @last_load_more_size = num }
68 def lines; @text.length; end
69 def [] i; @text[i]; end
70 def contains_thread? t; @threads.include?(t) end
74 BufferManager.draw_screen
75 load_threads :num => buffer.content_height
78 ## open up a thread view window
79 def select t=nil, when_done=nil
80 t ||= cursor_thread or return
82 Redwood::reporting_thread("load messages for thread-view-mode") do
84 message = "Loading #{num.pluralize 'message body'}..."
85 BufferManager.say(message) do |sid|
86 t.each_with_index do |(m, *o), i|
88 BufferManager.say "#{message} (#{i}/#{num})", sid if t.size > 1
92 mode = ThreadViewMode.new t, @hidden_labels, self
93 BufferManager.spawn t.subj, mode
94 BufferManager.draw_screen
95 mode.jump_to_first_open true
96 BufferManager.draw_screen # lame TODO: make this unnecessary
97 ## the first draw_screen is needed before topline and botline
98 ## are set, and the second to show the cursor having moved
100 update_text_for_line curpos
101 UpdateManager.relay self, :read, t.first
102 when_done.call if when_done
106 def multi_select threads
107 threads.each { |t| select t }
110 ## this is called by thread-view-modes when the user wants to view
111 ## the next thread without going to index-mode. we update the cursor
113 def launch_next_thread_after thread, &b
114 l = @lines[thread] or return
115 t = @mutex.synchronize do
116 if l < @threads.length - 1
117 set_cursor_pos l + 1 # move out of mutex?
125 def handle_single_message_labeled_update sender, m
126 ## no need to do anything different here; we don't differentiate
127 ## messages from their containing threads
128 handle_labeled_update sender, m
131 def handle_labeled_update sender, m
132 if(t = thread_containing(m))
133 l = @lines[t] or return
134 update_text_for_line l
135 elsif is_relevant?(m)
140 def handle_simple_update sender, m
141 t = thread_containing(m) or return
142 l = @lines[t] or return
143 update_text_for_line l
146 %w(read unread archived starred unstarred).each do |state|
147 define_method "handle_#{state}_update" do |*a|
148 handle_simple_update(*a)
153 def is_relevant? m; false; end
155 def handle_added_update sender, m
157 BufferManager.draw_screen
160 def handle_single_message_deleted_update sender, m
161 @ts_mutex.synchronize do
162 return unless @ts.contains? m
168 def handle_deleted_update sender, m
169 @ts_mutex.synchronize do
170 return unless @ts.contains? m
171 @ts.remove_thread_containing_id m.id
176 def handle_undeleted_update sender, m
181 @mutex.synchronize do
182 ## let's see you do THIS in python
183 @threads = @ts.threads.select { |t| !@hidden_threads[t] }.sort_by { |t| [t.date, t.first.id] }.reverse
184 @size_widgets = @threads.map { |t| size_widget_for_thread t }
185 @size_widget_width = @size_widgets.max_of { |w| w.length }
192 return unless(t = cursor_thread)
193 message, *crap = t.find { |m, *o| m.has_label? :draft }
195 mode = ResumeMode.new message
196 BufferManager.spawn "Edit message", mode
198 BufferManager.flash "Not a draft message!"
202 def actually_toggle_starred t
203 if t.has_label? :starred # if ANY message has a star
204 t.remove_label :starred # remove from all
205 UpdateManager.relay self, :unstarred, t.first
207 t.first.add_label :starred # add only to first
208 UpdateManager.relay self, :starred, t.first
213 t = cursor_thread or return
214 actually_toggle_starred t
215 update_text_for_line curpos
219 def multi_toggle_starred threads
220 threads.each { |t| actually_toggle_starred t }
224 def actually_toggle_archived t
225 if t.has_label? :inbox
226 t.remove_label :inbox
227 UpdateManager.relay self, :archived, t.first
230 UpdateManager.relay self, :unarchived, t.first
234 def actually_toggle_spammed t
235 if t.has_label? :spam
237 UpdateManager.relay self, :unspammed, t.first
240 UpdateManager.relay self, :spammed, t.first
244 def actually_toggle_deleted t
245 if t.has_label? :deleted
246 t.remove_label :deleted
247 UpdateManager.relay self, :undeleted, t.first
249 t.apply_label :deleted
250 UpdateManager.relay self, :deleted, t.first
255 t = cursor_thread or return
256 actually_toggle_archived t
257 update_text_for_line curpos
260 def multi_toggle_archived threads
261 threads.each { |t| actually_toggle_archived t }
266 t = cursor_thread or return
267 t.toggle_label :unread
268 update_text_for_line curpos
272 def multi_toggle_new threads
273 threads.each { |t| t.toggle_label :unread }
277 def multi_toggle_tagged threads
278 @mutex.synchronize { @tags.drop_all_tags }
283 ## this command has no non-tagged form. as a convenience, allow this
284 ## command to be applied to tagged threads without hitting ';'.
285 @tags.apply_to_tagged :join_threads
288 def multi_join_threads threads
289 @ts.join_threads threads or return
290 @tags.drop_all_tags # otherwise we have tag pointers to invalid threads!
295 n = @mutex.synchronize do
296 ((curpos + 1) ... lines).find { |i| @threads[i].has_label? :unread } ||
297 (0 ... curpos).find { |i| @threads[i].has_label? :unread }
300 ## jump there if necessary
301 jump_to_line n unless n >= topline && n < botline
304 BufferManager.flash "No new messages"
309 t = cursor_thread or return
310 multi_toggle_spam [t]
313 ## both spam and deleted have the curious characteristic that you
314 ## always want to hide the thread after either applying or removing
315 ## that label. in all thread-index-views except for
316 ## label-search-results-mode, when you mark a message as spam or
317 ## deleted, you want it to disappear immediately; in LSRM, you only
318 ## see deleted or spam emails, and when you undelete or unspam them
319 ## you also want them to disappear immediately.
320 def multi_toggle_spam threads
322 actually_toggle_spammed t
329 t = cursor_thread or return
330 multi_toggle_deleted [t]
333 ## see comment for multi_toggle_spam
334 def multi_toggle_deleted threads
336 actually_toggle_deleted t
343 t = cursor_thread or return
347 def multi_kill threads
349 t.apply_label :killed
353 BufferManager.flash "#{threads.size.pluralize 'Thread'} killed."
357 dirty_threads = @mutex.synchronize { (@threads + @hidden_threads.keys).select { |t| t.dirty? } }
358 return if dirty_threads.empty?
360 BufferManager.say("Saving threads...") do |say_id|
361 dirty_threads.each_with_index do |t, i|
362 BufferManager.say "Saving modified thread #{i + 1} of #{dirty_threads.length}...", say_id
369 UpdateManager.unregister self
373 BufferManager.clear @mbid if @mbid
374 sleep 0.1 # TODO: necessary?
375 BufferManager.erase_flash
382 t = cursor_thread or return
383 @mutex.synchronize { @tags.toggle_tag_for t }
384 update_text_for_line curpos
388 def toggle_tagged_all
389 @mutex.synchronize { @threads.each { |t| @tags.toggle_tag_for t } }
394 query = BufferManager.ask :search, "tag threads matching: "
395 return if query.nil? || query.empty?
397 @mutex.synchronize { @threads.each { |t| @tags.tag t if thread_matches?(t, query) } }
401 def apply_to_tagged; @tags.apply_to_tagged; end
404 thread = cursor_thread or return
405 speciall = (@hidden_labels + LabelManager::RESERVED_LABELS).uniq
406 keepl, modifyl = thread.labels.partition { |t| speciall.member? t }
408 user_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", modifyl, @hidden_labels
410 return unless user_labels
411 thread.labels = keepl + user_labels
412 user_labels.each { |l| LabelManager << l }
413 UpdateManager.relay self, :labeled, thread.first
416 def multi_edit_labels threads
417 answer = BufferManager.ask :add_labels, "add labels: "
419 user_labels = answer.split(/\s+/).map { |l| l.intern }
421 hl = user_labels.select { |l| @hidden_labels.member? l }
423 threads.each { |t| user_labels.each { |l| t.apply_label l } }
424 user_labels.each { |l| LabelManager << l }
426 BufferManager.flash "'#{hl}' is a reserved label!"
432 t = cursor_thread or return
434 return if m.nil? # probably won't happen
436 mode = ReplyMode.new m
437 BufferManager.spawn "Reply to #{m.subj}", mode
441 t = cursor_thread or return
443 return if m.nil? # probably won't happen
445 ForwardMode.spawn_nicely :message => m
448 def load_n_threads_background n=LOAD_MORE_THREAD_NUM, opts={}
449 return if @load_thread # todo: wrap in mutex
450 @load_thread = Redwood::reporting_thread("load threads for thread-index-mode") do
451 num = load_n_threads n, opts
452 opts[:when_done].call(num) if opts[:when_done]
457 ## TODO: figure out @ts_mutex in this method
458 def load_n_threads n=LOAD_MORE_THREAD_NUM, opts={}
459 @mbid = BufferManager.say "Searching for threads..."
461 last_update = Time.now
462 @ts.load_n_threads(@ts.size + n, opts) do |i|
463 if (Time.now - last_update) >= 0.25
464 BufferManager.say "Loaded #{i.pluralize 'thread'}...", @mbid
466 BufferManager.draw_screen
467 last_update = Time.now
470 @ts.threads.each { |th| th.labels.each { |l| LabelManager << l } }
473 BufferManager.clear @mbid
475 BufferManager.draw_screen
478 ignore_concurrent_calls :load_n_threads
484 "line #{curpos + 1} of #{l} #{dirty? ? '*modified*' : ''}"
488 def load_threads opts={}
489 n = opts[:num] || ThreadIndexMode::LOAD_MORE_THREAD_NUM
491 myopts = @load_thread_opts.merge({ :when_done => (lambda do |num|
492 opts[:when_done].call(num) if opts[:when_done]
494 BufferManager.flash "Found #{num.pluralize 'thread'}."
496 BufferManager.flash "No matches."
500 if opts[:background] || opts[:background].nil?
501 load_n_threads_background n, myopts
503 load_n_threads n, myopts
506 ignore_concurrent_calls :load_threads
508 def resize rows, cols
516 @ts_mutex.synchronize do
517 if (is_relevant?(m) || @ts.is_relevant?(m)) && !@ts.contains?(m)
518 @ts.load_thread_for_message m
521 @hidden_threads.delete @ts.thread_for(m)
527 def thread_containing m; @ts_mutex.synchronize { @ts.thread_for m } end
529 ## used to tag threads by query. this can be made a lot more sophisticated,
530 ## but for right now we'll do the obvious this.
531 def thread_matches? t, query
532 t.subj =~ query || t.snippet =~ query || t.participants.any? { |x| x.longname =~ query }
535 def size_widget_for_thread t
536 HookManager.run("index-mode-size-widget", :thread => t) || default_size_widget_for(t)
539 def cursor_thread; @mutex.synchronize { @threads[curpos] }; end
548 @mutex.synchronize do
549 i = @threads.index(t) or return
550 raise "already hidden" if @hidden_threads[t]
551 @hidden_threads[t] = true
553 @size_widgets.delete_at i
558 def update_text_for_line l
559 return unless l # not sure why this happens, but it does, occasionally
563 @mutex.synchronize do
564 @size_widgets[l] = size_widget_for_thread @threads[l]
566 ## if the widget size has increased, we need to redraw everyone
567 need_update = @size_widgets[l].size > @size_widget_width
573 @text[l] = text_for_thread_at l
574 buffer.mark_dirty if buffer
579 threads = @mutex.synchronize { @threads }
580 @text = threads.map_with_index { |t, i| text_for_thread_at i }
581 @lines = threads.map_with_index { |t, i| [t, i] }.to_h
582 buffer.mark_dirty if buffer
585 def authors; map { |m, *o| m.from if m }.compact.uniq; end
587 def author_names_and_newness_for_thread t
589 authors = t.map do |m, *o|
593 if AccountManager.is_account?(m.from)
595 elsif t.authors.size == 1
601 new[name] ||= m.has_label?(:unread)
605 authors.compact.uniq.map { |a| [a, new[a]] }
608 def text_for_thread_at line
609 t, size_widget = @mutex.synchronize { [@threads[line], @size_widgets[line]] }
611 date = t.date.to_nice_s
613 new = t.has_label?(:unread)
614 starred = t.has_label?(:starred)
616 ## format the from column
618 ann = author_names_and_newness_for_thread t
620 ann.each_with_index do |(name, newness), i|
621 break if cur_width >= from_width
622 last = i == ann.length - 1
625 if cur_width + name.length > from_width
626 name[0 ... (from_width - cur_width - 1)] + "."
627 elsif cur_width + name.length == from_width
628 name[0 ... (from_width - cur_width)]
631 name[0 ... (from_width - cur_width)]
633 name[0 ... (from_width - cur_width - 1)] + ","
637 cur_width += abbrev.length
639 if last && from_width > cur_width
640 abbrev += " " * (from_width - cur_width)
643 from << [(newness ? :index_new_color : (starred ? :index_starred_color : :index_old_color)), abbrev]
646 dp = t.direct_participants.any? { |p| AccountManager.is_account? p }
647 p = dp || t.participants.any? { |p| AccountManager.is_account? p }
658 snippet = t.snippet + (t.snippet.empty? ? "" : "...")
660 size_widget_text = sprintf "%#{ @size_widget_width}s", size_widget
663 [:tagged_color, @tags.tagged?(t) ? ">" : " "],
664 [:none, sprintf("%#{@date_width}s", date)],
665 (starred ? [:starred_color, "*"] : [:none, " "]),
669 [subj_color, size_widget_text],
670 [:to_me_color, dp ? " >" : (p ? ' +' : " ")],
671 [subj_color, t.subj + (t.subj.empty? ? "" : " ")],
673 (t.labels - @hidden_labels).map { |label| [:label_color, "+#{label} "] } +
674 [[:snippet_color, snippet]
679 def dirty?; @mutex.synchronize { (@hidden_threads.keys + @threads).any? { |t| t.dirty? } } end
683 def default_size_widget_for t
693 [(buffer.content_width.to_f * 0.2).to_i, MIN_FROM_WIDTH].max
696 def initialize_threads
697 @ts = ThreadSet.new Index.instance, $config[:thread_by_subject]
698 @ts_mutex = Mutex.new