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 ## this is called by thread-view-modes when the user wants to view
117 ## the next thread without going to index-mode. we update the cursor
119 def launch_next_thread_after thread, &b
120 l = @lines[thread] or return
121 t = @mutex.synchronize do
122 if l < @threads.length - 1
123 set_cursor_pos l + 1 # move out of mutex?
131 def handle_single_message_labeled_update sender, m
132 ## no need to do anything different here; we don't differentiate
133 ## messages from their containing threads
134 handle_labeled_update sender, m
137 def handle_labeled_update sender, m
138 if(t = thread_containing(m))
139 l = @lines[t] or return
140 update_text_for_line l
141 elsif is_relevant?(m)
146 def handle_simple_update sender, m
147 t = thread_containing(m) or return
148 l = @lines[t] or return
149 update_text_for_line l
152 %w(read unread archived starred unstarred).each do |state|
153 define_method "handle_#{state}_update" do |*a|
154 handle_simple_update(*a)
159 def is_relevant? m; false; end
161 def handle_added_update sender, m
163 BufferManager.draw_screen
166 def handle_single_message_deleted_update sender, m
167 @ts_mutex.synchronize do
168 return unless @ts.contains? m
174 def handle_deleted_update sender, m
175 @ts_mutex.synchronize do
176 return unless @ts.contains? m
177 @ts.remove_thread_containing_id m.id
182 def handle_undeleted_update sender, m
187 @mutex.synchronize do
188 ## let's see you do THIS in python
189 @threads = @ts.threads.select { |t| !@hidden_threads[t] }.sort_by { |t| [t.date, t.first.id] }.reverse
190 @size_widgets = @threads.map { |t| size_widget_for_thread t }
191 @size_widget_width = @size_widgets.max_of { |w| w.length }
198 return unless(t = cursor_thread)
199 message, *crap = t.find { |m, *o| m.has_label? :draft }
201 mode = ResumeMode.new message
202 BufferManager.spawn "Edit message", mode
204 BufferManager.flash "Not a draft message!"
208 def actually_toggle_starred t
209 if t.has_label? :starred # if ANY message has a star
210 t.remove_label :starred # remove from all
211 UpdateManager.relay self, :unstarred, t.first
213 t.first.add_label :starred # add only to first
214 UpdateManager.relay self, :starred, t.first
219 t = cursor_thread or return
220 actually_toggle_starred t
221 update_text_for_line curpos
225 def multi_toggle_starred threads
226 threads.each { |t| actually_toggle_starred t }
230 def actually_toggle_archived t
231 if t.has_label? :inbox
232 t.remove_label :inbox
233 UpdateManager.relay self, :archived, t.first
236 UpdateManager.relay self, :unarchived, t.first
240 def actually_toggle_spammed t
241 if t.has_label? :spam
243 UpdateManager.relay self, :unspammed, t.first
246 UpdateManager.relay self, :spammed, t.first
250 def actually_toggle_deleted t
251 if t.has_label? :deleted
252 t.remove_label :deleted
253 UpdateManager.relay self, :undeleted, t.first
255 t.apply_label :deleted
256 UpdateManager.relay self, :deleted, t.first
261 t = cursor_thread or return
262 actually_toggle_archived t
263 update_text_for_line curpos
266 def multi_toggle_archived threads
267 threads.each { |t| actually_toggle_archived t }
272 t = cursor_thread or return
273 t.toggle_label :unread
274 update_text_for_line curpos
278 def multi_toggle_new threads
279 threads.each { |t| t.toggle_label :unread }
283 def multi_toggle_tagged threads
284 @mutex.synchronize { @tags.drop_all_tags }
289 ## this command has no non-tagged form. as a convenience, allow this
290 ## command to be applied to tagged threads without hitting ';'.
291 @tags.apply_to_tagged :join_threads
294 def multi_join_threads threads
295 @ts.join_threads threads or return
296 @tags.drop_all_tags # otherwise we have tag pointers to invalid threads!
301 n = @mutex.synchronize do
302 ((curpos + 1) ... lines).find { |i| @threads[i].has_label? :unread } ||
303 (0 ... curpos).find { |i| @threads[i].has_label? :unread }
306 ## jump there if necessary
307 jump_to_line n unless n >= topline && n < botline
310 BufferManager.flash "No new messages"
315 t = cursor_thread or return
316 multi_toggle_spam [t]
319 ## both spam and deleted have the curious characteristic that you
320 ## always want to hide the thread after either applying or removing
321 ## that label. in all thread-index-views except for
322 ## label-search-results-mode, when you mark a message as spam or
323 ## deleted, you want it to disappear immediately; in LSRM, you only
324 ## see deleted or spam emails, and when you undelete or unspam them
325 ## you also want them to disappear immediately.
326 def multi_toggle_spam threads
328 actually_toggle_spammed t
335 t = cursor_thread or return
336 multi_toggle_deleted [t]
339 ## see comment for multi_toggle_spam
340 def multi_toggle_deleted threads
342 actually_toggle_deleted t
349 t = cursor_thread or return
353 def multi_kill threads
355 t.apply_label :killed
359 BufferManager.flash "#{threads.size.pluralize 'Thread'} killed."
363 dirty_threads = @mutex.synchronize { (@threads + @hidden_threads.keys).select { |t| t.dirty? } }
364 return if dirty_threads.empty?
366 BufferManager.say("Saving threads...") do |say_id|
367 dirty_threads.each_with_index do |t, i|
368 BufferManager.say "Saving modified thread #{i + 1} of #{dirty_threads.length}...", say_id
375 UpdateManager.unregister self
379 BufferManager.clear @mbid if @mbid
380 sleep 0.1 # TODO: necessary?
381 BufferManager.erase_flash
388 t = cursor_thread or return
389 @mutex.synchronize { @tags.toggle_tag_for t }
390 update_text_for_line curpos
394 def toggle_tagged_all
395 @mutex.synchronize { @threads.each { |t| @tags.toggle_tag_for t } }
400 query = BufferManager.ask :search, "tag threads matching: "
401 return if query.nil? || query.empty?
403 @mutex.synchronize { @threads.each { |t| @tags.tag t if thread_matches?(t, query) } }
407 def apply_to_tagged; @tags.apply_to_tagged; end
410 thread = cursor_thread or return
411 speciall = (@hidden_labels + LabelManager::RESERVED_LABELS).uniq
412 keepl, modifyl = thread.labels.partition { |t| speciall.member? t }
414 user_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", modifyl, @hidden_labels
416 return unless user_labels
417 thread.labels = keepl + user_labels
418 user_labels.each { |l| LabelManager << l }
419 update_text_for_line curpos
420 UpdateManager.relay self, :labeled, thread.first
423 def multi_edit_labels threads
424 answer = BufferManager.ask :add_labels, "add labels: "
426 user_labels = answer.split(/\s+/).map { |l| l.intern }
428 hl = user_labels.select { |l| @hidden_labels.member? l }
430 threads.each { |t| user_labels.each { |l| t.apply_label l } }
431 user_labels.each { |l| LabelManager << l }
433 BufferManager.flash "'#{hl}' is a reserved label!"
439 t = cursor_thread or return
441 return if m.nil? # probably won't happen
443 mode = ReplyMode.new m
444 BufferManager.spawn "Reply to #{m.subj}", mode
448 t = cursor_thread or return
450 return if m.nil? # probably won't happen
452 ForwardMode.spawn_nicely :message => m
455 def load_n_threads_background n=LOAD_MORE_THREAD_NUM, opts={}
456 return if @load_thread # todo: wrap in mutex
457 @load_thread = Redwood::reporting_thread("load threads for thread-index-mode") do
458 num = load_n_threads n, opts
459 opts[:when_done].call(num) if opts[:when_done]
464 ## TODO: figure out @ts_mutex in this method
465 def load_n_threads n=LOAD_MORE_THREAD_NUM, opts={}
466 @interrupt_search = false
467 @mbid = BufferManager.say "Searching for threads..."
470 ts_to_load = ts_to_load + @ts.size unless n == -1 # -1 means all threads
473 last_update = Time.now
474 @ts.load_n_threads(ts_to_load, opts) do |i|
475 if (Time.now - last_update) >= 0.25
476 BufferManager.say "Loaded #{i.pluralize 'thread'} (use ^G to cancel)...", @mbid
478 BufferManager.draw_screen
479 last_update = Time.now
481 break if @interrupt_search
483 @ts.threads.each { |th| th.labels.each { |l| LabelManager << l } }
486 BufferManager.clear @mbid
488 BufferManager.draw_screen
491 ignore_concurrent_calls :load_n_threads
497 "line #{curpos + 1} of #{l} #{dirty? ? '*modified*' : ''}"
502 @interrupt_search = true
506 load_threads :num => -1
509 def load_threads opts={}
511 n = ThreadIndexMode::LOAD_MORE_THREAD_NUM
516 myopts = @load_thread_opts.merge({ :when_done => (lambda do |num|
517 opts[:when_done].call(num) if opts[:when_done]
519 cancelled = @interrupt_search?" (search cancelled by user)":""
522 BufferManager.flash "Found #{num.pluralize 'thread'}#{cancelled}."
524 BufferManager.flash "No matches."
528 if opts[:background] || opts[:background].nil?
529 load_n_threads_background n, myopts
531 load_n_threads n, myopts
534 ignore_concurrent_calls :load_threads
536 def resize rows, cols
544 @ts_mutex.synchronize do
545 if (is_relevant?(m) || @ts.is_relevant?(m)) && !@ts.contains?(m)
546 @ts.load_thread_for_message m
549 @hidden_threads.delete @ts.thread_for(m)
555 def thread_containing m; @ts_mutex.synchronize { @ts.thread_for m } end
557 ## used to tag threads by query. this can be made a lot more sophisticated,
558 ## but for right now we'll do the obvious this.
559 def thread_matches? t, query
560 t.subj =~ query || t.snippet =~ query || t.participants.any? { |x| x.longname =~ query }
563 def size_widget_for_thread t
564 HookManager.run("index-mode-size-widget", :thread => t) || default_size_widget_for(t)
567 def cursor_thread; @mutex.synchronize { @threads[curpos] }; end
576 @mutex.synchronize do
577 i = @threads.index(t) or return
578 raise "already hidden" if @hidden_threads[t]
579 @hidden_threads[t] = true
581 @size_widgets.delete_at i
586 def update_text_for_line l
587 return unless l # not sure why this happens, but it does, occasionally
591 @mutex.synchronize do
592 @size_widgets[l] = size_widget_for_thread @threads[l]
594 ## if the widget size has increased, we need to redraw everyone
595 need_update = @size_widgets[l].size > @size_widget_width
601 @text[l] = text_for_thread_at l
602 buffer.mark_dirty if buffer
607 threads = @mutex.synchronize { @threads }
608 @text = threads.map_with_index { |t, i| text_for_thread_at i }
609 @lines = threads.map_with_index { |t, i| [t, i] }.to_h
610 buffer.mark_dirty if buffer
613 def authors; map { |m, *o| m.from if m }.compact.uniq; end
615 def author_names_and_newness_for_thread t
617 authors = t.map do |m, *o|
621 if AccountManager.is_account?(m.from)
623 elsif t.authors.size == 1
629 new[name] ||= m.has_label?(:unread)
633 authors.compact.uniq.map { |a| [a, new[a]] }
636 def text_for_thread_at line
637 t, size_widget = @mutex.synchronize { [@threads[line], @size_widgets[line]] }
639 date = t.date.to_nice_s
641 new = t.has_label?(:unread)
642 starred = t.has_label?(:starred)
644 ## format the from column
646 ann = author_names_and_newness_for_thread t
648 ann.each_with_index do |(name, newness), i|
649 break if cur_width >= from_width
650 last = i == ann.length - 1
653 if cur_width + name.length > from_width
654 name[0 ... (from_width - cur_width - 1)] + "."
655 elsif cur_width + name.length == from_width
656 name[0 ... (from_width - cur_width)]
659 name[0 ... (from_width - cur_width)]
661 name[0 ... (from_width - cur_width - 1)] + ","
665 cur_width += abbrev.length
667 if last && from_width > cur_width
668 abbrev += " " * (from_width - cur_width)
671 from << [(newness ? :index_new_color : (starred ? :index_starred_color : :index_old_color)), abbrev]
674 dp = t.direct_participants.any? { |p| AccountManager.is_account? p }
675 p = dp || t.participants.any? { |p| AccountManager.is_account? p }
686 snippet = t.snippet + (t.snippet.empty? ? "" : "...")
688 size_widget_text = sprintf "%#{ @size_widget_width}s", size_widget
691 [:tagged_color, @tags.tagged?(t) ? ">" : " "],
692 [:none, sprintf("%#{@date_width}s", date)],
693 (starred ? [:starred_color, "*"] : [:none, " "]),
697 [subj_color, size_widget_text],
698 [:to_me_color, dp ? " >" : (p ? ' +' : " ")],
699 [subj_color, t.subj + (t.subj.empty? ? "" : " ")],
701 (t.labels - @hidden_labels).map { |label| [:label_color, "+#{label} "] } +
702 [[:snippet_color, snippet]
707 def dirty?; @mutex.synchronize { (@hidden_threads.keys + @threads).any? { |t| t.dirty? } } end
711 def default_size_widget_for t
721 [(buffer.content_width.to_f * 0.2).to_i, MIN_FROM_WIDTH].max
724 def initialize_threads
725 @ts = ThreadSet.new Index.instance, $config[:thread_by_subject]
726 @ts_mutex = Mutex.new