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_multi "Load all threads (! to confirm) :", '!' do |kk|
20 kk.add :load_all_threads, "Load all threads (may list a _lot_ of threads)", '!'
22 k.add :cancel_search, "Cancel current search", :ctrl_g
23 k.add :reload, "Refresh view", '@'
24 k.add :toggle_archived, "Toggle archived status", 'a'
25 k.add :toggle_starred, "Star or unstar all messages in thread", '*'
26 k.add :toggle_new, "Toggle new/read status of all messages in thread", 'N'
27 k.add :edit_labels, "Edit or add labels for a thread", 'l'
28 k.add :edit_message, "Edit message (drafts only)", 'e'
29 k.add :toggle_spam, "Mark/unmark thread as spam", 'S'
30 k.add :toggle_deleted, "Delete/undelete thread", 'd'
31 k.add :kill, "Kill thread (never to be seen in inbox again)", '&'
32 k.add :save, "Save changes now", '$'
33 k.add :jump_to_next_new, "Jump to next new thread", :tab
34 k.add :reply, "Reply to latest message in a thread", 'r'
35 k.add :forward, "Forward latest message in a thread", 'f'
36 k.add :toggle_tagged, "Tag/untag selected thread", 't'
37 k.add :toggle_tagged_all, "Tag/untag all threads", 'T'
38 k.add :tag_matching, "Tag matching threads", 'g'
39 k.add :apply_to_tagged, "Apply next command to all tagged threads", ';'
40 k.add :join_threads, "Force tagged threads to be joined into the same thread", '#'
43 def initialize hidden_labels=[], load_thread_opts={}
45 @mutex = Mutex.new # covers the following variables:
48 @size_widget_width = nil
50 @tags = Tagger.new self
52 ## these guys, and @text and @lines, are not covered
54 @load_thread_opts = load_thread_opts
55 @hidden_labels = hidden_labels + LabelManager::HIDDEN_RESERVED_LABELS
56 @date_width = DATE_WIDTH
58 @interrupt_search = false
60 initialize_threads # defines @ts and @ts_mutex
61 update # defines @text and @lines
63 UpdateManager.register self
65 @last_load_more_size = nil
66 to_load_more do |size|
67 next if @last_load_more_size == 0
68 load_threads :num => 1, :background => false
69 load_threads :num => (size - 1),
70 :when_done => lambda { |num| @last_load_more_size = num }
74 def lines; @text.length; end
75 def [] i; @text[i]; end
76 def contains_thread? t; @threads.include?(t) end
80 BufferManager.draw_screen
81 load_threads :num => buffer.content_height
84 ## open up a thread view window
85 def select t=nil, when_done=nil
86 t ||= cursor_thread or return
88 Redwood::reporting_thread("load messages for thread-view-mode") do
90 message = "Loading #{num.pluralize 'message body'}..."
91 BufferManager.say(message) do |sid|
92 t.each_with_index do |(m, *o), i|
94 BufferManager.say "#{message} (#{i}/#{num})", sid if t.size > 1
98 mode = ThreadViewMode.new t, @hidden_labels, self
99 BufferManager.spawn t.subj, mode
100 BufferManager.draw_screen
101 mode.jump_to_first_open true
102 BufferManager.draw_screen # lame TODO: make this unnecessary
103 ## the first draw_screen is needed before topline and botline
104 ## are set, and the second to show the cursor having moved
106 update_text_for_line curpos
107 UpdateManager.relay self, :read, t.first
108 when_done.call if when_done
112 def multi_select threads
113 threads.each { |t| select t }
116 ## these two methods are called by thread-view-modes when the user
117 ## wants to view the previous/next thread without going back to
118 ## index-mode. we update the cursor as a convenience.
119 def launch_next_thread_after thread, &b
120 launch_another_thread thread, 1, &b
123 def launch_prev_thread_before thread, &b
124 launch_another_thread thread, -1, &b
127 def launch_another_thread thread, direction, &b
128 l = @lines[thread] or return
129 target_l = l + direction
130 t = @mutex.synchronize do
131 if target_l >= 0 && target_l < @threads.length
136 if t # there's a next thread
137 set_cursor_pos target_l # move out of mutex?
139 elsif b # no next thread. call the block anyways
144 def handle_single_message_labeled_update sender, m
145 ## no need to do anything different here; we don't differentiate
146 ## messages from their containing threads
147 handle_labeled_update sender, m
150 def handle_labeled_update sender, m
151 if(t = thread_containing(m))
152 l = @lines[t] or return
153 update_text_for_line l
154 elsif is_relevant?(m)
159 def handle_simple_update sender, m
160 t = thread_containing(m) or return
161 l = @lines[t] or return
162 update_text_for_line l
165 %w(read unread archived starred unstarred).each do |state|
166 define_method "handle_#{state}_update" do |*a|
167 handle_simple_update(*a)
172 def is_relevant? m; false; end
174 def handle_added_update sender, m
176 BufferManager.draw_screen
179 def handle_single_message_deleted_update sender, m
180 @ts_mutex.synchronize do
181 return unless @ts.contains? m
187 def handle_deleted_update sender, m
188 t = @ts_mutex.synchronize { @ts.thread_for m }
194 def handle_spammed_update sender, m
195 t = @ts_mutex.synchronize { @ts.thread_for m }
201 def handle_undeleted_update sender, m
206 @mutex.synchronize do
207 ## let's see you do THIS in python
208 @threads = @ts.threads.select { |t| !@hidden_threads[t] }.sort_by { |t| [t.date, t.first.id] }.reverse
209 @size_widgets = @threads.map { |t| size_widget_for_thread t }
210 @size_widget_width = @size_widgets.max_of { |w| w.length }
217 return unless(t = cursor_thread)
218 message, *crap = t.find { |m, *o| m.has_label? :draft }
220 mode = ResumeMode.new message
221 BufferManager.spawn "Edit message", mode
223 BufferManager.flash "Not a draft message!"
227 def actually_toggle_starred t
228 if t.has_label? :starred # if ANY message has a star
229 t.remove_label :starred # remove from all
230 UpdateManager.relay self, :unstarred, t.first
232 t.first.add_label :starred # add only to first
233 UpdateManager.relay self, :starred, t.first
238 t = cursor_thread or return
239 actually_toggle_starred t
240 update_text_for_line curpos
244 def multi_toggle_starred threads
245 threads.each { |t| actually_toggle_starred t }
249 def actually_toggle_archived t
250 if t.has_label? :inbox
251 t.remove_label :inbox
252 UpdateManager.relay self, :archived, t.first
255 UpdateManager.relay self, :unarchived, t.first
259 def actually_toggle_spammed t
260 if t.has_label? :spam
262 UpdateManager.relay self, :unspammed, t.first
265 UpdateManager.relay self, :spammed, t.first
269 def actually_toggle_deleted t
270 if t.has_label? :deleted
271 t.remove_label :deleted
272 UpdateManager.relay self, :undeleted, t.first
274 t.apply_label :deleted
275 UpdateManager.relay self, :deleted, t.first
280 t = cursor_thread or return
281 actually_toggle_archived t
282 update_text_for_line curpos
285 def multi_toggle_archived threads
286 threads.each { |t| actually_toggle_archived t }
291 t = cursor_thread or return
292 t.toggle_label :unread
293 update_text_for_line curpos
297 def multi_toggle_new threads
298 threads.each { |t| t.toggle_label :unread }
302 def multi_toggle_tagged threads
303 @mutex.synchronize { @tags.drop_all_tags }
308 ## this command has no non-tagged form. as a convenience, allow this
309 ## command to be applied to tagged threads without hitting ';'.
310 @tags.apply_to_tagged :join_threads
313 def multi_join_threads threads
314 @ts.join_threads threads or return
315 @tags.drop_all_tags # otherwise we have tag pointers to invalid threads!
320 n = @mutex.synchronize do
321 ((curpos + 1) ... lines).find { |i| @threads[i].has_label? :unread } ||
322 (0 ... curpos).find { |i| @threads[i].has_label? :unread }
325 ## jump there if necessary
326 jump_to_line n unless n >= topline && n < botline
329 BufferManager.flash "No new messages"
334 t = cursor_thread or return
335 multi_toggle_spam [t]
338 ## both spam and deleted have the curious characteristic that you
339 ## always want to hide the thread after either applying or removing
340 ## that label. in all thread-index-views except for
341 ## label-search-results-mode, when you mark a message as spam or
342 ## deleted, you want it to disappear immediately; in LSRM, you only
343 ## see deleted or spam emails, and when you undelete or unspam them
344 ## you also want them to disappear immediately.
345 def multi_toggle_spam threads
347 actually_toggle_spammed t
354 t = cursor_thread or return
355 multi_toggle_deleted [t]
358 ## see comment for multi_toggle_spam
359 def multi_toggle_deleted threads
361 actually_toggle_deleted t
368 t = cursor_thread or return
372 def multi_kill threads
374 t.apply_label :killed
378 BufferManager.flash "#{threads.size.pluralize 'Thread'} killed."
382 dirty_threads = @mutex.synchronize { (@threads + @hidden_threads.keys).select { |t| t.dirty? } }
383 return if dirty_threads.empty?
385 BufferManager.say("Saving threads...") do |say_id|
386 dirty_threads.each_with_index do |t, i|
387 BufferManager.say "Saving modified thread #{i + 1} of #{dirty_threads.length}...", say_id
394 UpdateManager.unregister self
398 BufferManager.clear @mbid if @mbid
399 sleep 0.1 # TODO: necessary?
400 BufferManager.erase_flash
407 t = cursor_thread or return
408 @mutex.synchronize { @tags.toggle_tag_for t }
409 update_text_for_line curpos
413 def toggle_tagged_all
414 @mutex.synchronize { @threads.each { |t| @tags.toggle_tag_for t } }
419 query = BufferManager.ask :search, "tag threads matching: "
420 return if query.nil? || query.empty?
422 @mutex.synchronize { @threads.each { |t| @tags.tag t if thread_matches?(t, query) } }
426 def apply_to_tagged; @tags.apply_to_tagged; end
429 thread = cursor_thread or return
430 speciall = (@hidden_labels + LabelManager::RESERVED_LABELS).uniq
431 keepl, modifyl = thread.labels.partition { |t| speciall.member? t }
433 user_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", modifyl, @hidden_labels
435 return unless user_labels
436 thread.labels = keepl + user_labels
437 user_labels.each { |l| LabelManager << l }
438 update_text_for_line curpos
439 UpdateManager.relay self, :labeled, thread.first
442 def multi_edit_labels threads
443 answer = BufferManager.ask :add_labels, "add labels: "
445 user_labels = answer.split(/\s+/).map { |l| l.intern }
447 hl = user_labels.select { |l| @hidden_labels.member? l }
449 threads.each { |t| user_labels.each { |l| t.apply_label l } }
450 user_labels.each { |l| LabelManager << l }
452 BufferManager.flash "'#{hl}' is a reserved label!"
458 t = cursor_thread or return
460 return if m.nil? # probably won't happen
462 mode = ReplyMode.new m
463 BufferManager.spawn "Reply to #{m.subj}", mode
467 t = cursor_thread or return
469 return if m.nil? # probably won't happen
471 ForwardMode.spawn_nicely :message => m
474 def load_n_threads_background n=LOAD_MORE_THREAD_NUM, opts={}
475 return if @load_thread # todo: wrap in mutex
476 @load_thread = Redwood::reporting_thread("load threads for thread-index-mode") do
477 num = load_n_threads n, opts
478 opts[:when_done].call(num) if opts[:when_done]
483 ## TODO: figure out @ts_mutex in this method
484 def load_n_threads n=LOAD_MORE_THREAD_NUM, opts={}
485 @interrupt_search = false
486 @mbid = BufferManager.say "Searching for threads..."
489 ts_to_load = ts_to_load + @ts.size unless n == -1 # -1 means all threads
492 last_update = Time.now
493 @ts.load_n_threads(ts_to_load, opts) do |i|
494 if (Time.now - last_update) >= 0.25
495 BufferManager.say "Loaded #{i.pluralize 'thread'}...", @mbid
497 BufferManager.draw_screen
498 last_update = Time.now
500 break if @interrupt_search
502 @ts.threads.each { |th| th.labels.each { |l| LabelManager << l } }
505 BufferManager.clear @mbid
507 BufferManager.draw_screen
510 ignore_concurrent_calls :load_n_threads
516 "line #{curpos + 1} of #{l} #{dirty? ? '*modified*' : ''}"
521 @interrupt_search = true
525 load_threads :num => -1
528 def load_threads opts={}
530 n = ThreadIndexMode::LOAD_MORE_THREAD_NUM
535 myopts = @load_thread_opts.merge({ :when_done => (lambda do |num|
536 opts[:when_done].call(num) if opts[:when_done]
539 BufferManager.flash "Found #{num.pluralize 'thread'}."
541 BufferManager.flash "No matches."
545 if opts[:background] || opts[:background].nil?
546 load_n_threads_background n, myopts
548 load_n_threads n, myopts
551 ignore_concurrent_calls :load_threads
553 def resize rows, cols
561 @ts_mutex.synchronize do
562 if (is_relevant?(m) || @ts.is_relevant?(m)) && !@ts.contains?(m)
563 @ts.load_thread_for_message m
566 @hidden_threads.delete @ts.thread_for(m)
572 def thread_containing m; @ts_mutex.synchronize { @ts.thread_for m } end
574 ## used to tag threads by query. this can be made a lot more sophisticated,
575 ## but for right now we'll do the obvious this.
576 def thread_matches? t, query
577 t.subj =~ query || t.snippet =~ query || t.participants.any? { |x| x.longname =~ query }
580 def size_widget_for_thread t
581 HookManager.run("index-mode-size-widget", :thread => t) || default_size_widget_for(t)
584 def cursor_thread; @mutex.synchronize { @threads[curpos] }; end
593 @mutex.synchronize do
594 i = @threads.index(t) or return
595 raise "already hidden" if @hidden_threads[t]
596 @hidden_threads[t] = true
598 @size_widgets.delete_at i
603 def update_text_for_line l
604 return unless l # not sure why this happens, but it does, occasionally
608 @mutex.synchronize do
609 @size_widgets[l] = size_widget_for_thread @threads[l]
611 ## if the widget size has increased, we need to redraw everyone
612 need_update = @size_widgets[l].size > @size_widget_width
618 @text[l] = text_for_thread_at l
619 buffer.mark_dirty if buffer
624 threads = @mutex.synchronize { @threads }
625 @text = threads.map_with_index { |t, i| text_for_thread_at i }
626 @lines = threads.map_with_index { |t, i| [t, i] }.to_h
627 buffer.mark_dirty if buffer
630 def authors; map { |m, *o| m.from if m }.compact.uniq; end
632 def author_names_and_newness_for_thread t
634 authors = t.map do |m, *o|
638 if AccountManager.is_account?(m.from)
640 elsif t.authors.size == 1
646 new[name] ||= m.has_label?(:unread)
650 authors.compact.uniq.map { |a| [a, new[a]] }
653 def text_for_thread_at line
654 t, size_widget = @mutex.synchronize { [@threads[line], @size_widgets[line]] }
656 date = t.date.to_nice_s
658 new = t.has_label?(:unread)
659 starred = t.has_label?(:starred)
661 ## format the from column
663 ann = author_names_and_newness_for_thread t
665 ann.each_with_index do |(name, newness), i|
666 break if cur_width >= from_width
667 last = i == ann.length - 1
670 if cur_width + name.length > from_width
671 name[0 ... (from_width - cur_width - 1)] + "."
672 elsif cur_width + name.length == from_width
673 name[0 ... (from_width - cur_width)]
676 name[0 ... (from_width - cur_width)]
678 name[0 ... (from_width - cur_width - 1)] + ","
682 cur_width += abbrev.length
684 if last && from_width > cur_width
685 abbrev += " " * (from_width - cur_width)
688 from << [(newness ? :index_new_color : (starred ? :index_starred_color : :index_old_color)), abbrev]
691 dp = t.direct_participants.any? { |p| AccountManager.is_account? p }
692 p = dp || t.participants.any? { |p| AccountManager.is_account? p }
703 snippet = t.snippet + (t.snippet.empty? ? "" : "...")
705 size_widget_text = sprintf "%#{ @size_widget_width}s", size_widget
708 [:tagged_color, @tags.tagged?(t) ? ">" : " "],
709 [:none, sprintf("%#{@date_width}s", date)],
710 (starred ? [:starred_color, "*"] : [:none, " "]),
714 [subj_color, size_widget_text],
715 [:to_me_color, dp ? " >" : (p ? ' +' : " ")],
716 [subj_color, t.subj + (t.subj.empty? ? "" : " ")],
718 (t.labels - @hidden_labels).map { |label| [:label_color, "+#{label} "] } +
719 [[:snippet_color, snippet]
724 def dirty?; @mutex.synchronize { (@hidden_threads.keys + @threads).any? { |t| t.dirty? } } end
728 def default_size_widget_for t
738 [(buffer.content_width.to_f * 0.2).to_i, MIN_FROM_WIDTH].max
741 def initialize_threads
742 @ts = ThreadSet.new Index.instance, $config[:thread_by_subject]
743 @ts_mutex = Mutex.new