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 HookManager.register "mark-as-spam", <<EOS
18 This hook is run when a thread is marked as spam
20 thread: The message thread being marked as spam.
23 register_keymap do |k|
24 k.add :load_threads, "Load #{LOAD_MORE_THREAD_NUM} more threads", 'M'
25 k.add_multi "Load all threads (! to confirm) :", '!' do |kk|
26 kk.add :load_all_threads, "Load all threads (may list a _lot_ of threads)", '!'
28 k.add :cancel_search, "Cancel current search", :ctrl_g
29 k.add :reload, "Refresh view", '@'
30 k.add :toggle_archived, "Toggle archived status", 'a'
31 k.add :toggle_starred, "Star or unstar all messages in thread", '*'
32 k.add :toggle_new, "Toggle new/read status of all messages in thread", 'N'
33 k.add :edit_labels, "Edit or add labels for a thread", 'l'
34 k.add :edit_message, "Edit message (drafts only)", 'e'
35 k.add :toggle_spam, "Mark/unmark thread as spam", 'S'
36 k.add :toggle_deleted, "Delete/undelete thread", 'd'
37 k.add :kill, "Kill thread (never to be seen in inbox again)", '&'
38 k.add :save, "Save changes now", '$'
39 k.add :jump_to_next_new, "Jump to next new thread", :tab
40 k.add :reply, "Reply to latest message in a thread", 'r'
41 k.add :forward, "Forward latest message in a thread", 'f'
42 k.add :toggle_tagged, "Tag/untag selected thread", 't'
43 k.add :toggle_tagged_all, "Tag/untag all threads", 'T'
44 k.add :tag_matching, "Tag matching threads", 'g'
45 k.add :apply_to_tagged, "Apply next command to all tagged threads", '+', '='
46 k.add :join_threads, "Force tagged threads to be joined into the same thread", '#'
49 def initialize hidden_labels=[], load_thread_opts={}
51 @mutex = Mutex.new # covers the following variables:
54 @size_widget_width = nil
56 @tags = Tagger.new self
58 ## these guys, and @text and @lines, are not covered
60 @load_thread_opts = load_thread_opts
61 @hidden_labels = hidden_labels + LabelManager::HIDDEN_RESERVED_LABELS
62 @date_width = DATE_WIDTH
64 @interrupt_search = false
66 initialize_threads # defines @ts and @ts_mutex
67 update # defines @text and @lines
69 UpdateManager.register self
71 @save_thread_mutex = Mutex.new
73 @last_load_more_size = nil
74 to_load_more do |size|
75 next if @last_load_more_size == 0
76 load_threads :num => 1, :background => false
77 load_threads :num => (size - 1),
78 :when_done => lambda { |num| @last_load_more_size = num }
82 def unsaved?; dirty? end
83 def lines; @text.length; end
84 def [] i; @text[i]; end
85 def contains_thread? t; @threads.include?(t) end
89 BufferManager.draw_screen
90 load_threads :num => buffer.content_height
93 ## open up a thread view window
94 def select t=nil, when_done=nil
95 t ||= cursor_thread or return
97 Redwood::reporting_thread("load messages for thread-view-mode") do
99 message = "Loading #{num.pluralize 'message body'}..."
100 BufferManager.say(message) do |sid|
101 t.each_with_index do |(m, *o), i|
103 BufferManager.say "#{message} (#{i}/#{num})", sid if t.size > 1
107 mode = ThreadViewMode.new t, @hidden_labels, self
108 BufferManager.spawn t.subj, mode
109 BufferManager.draw_screen
110 mode.jump_to_first_open true
111 BufferManager.draw_screen # lame TODO: make this unnecessary
112 ## the first draw_screen is needed before topline and botline
113 ## are set, and the second to show the cursor having moved
115 update_text_for_line curpos
116 UpdateManager.relay self, :read, t.first
117 when_done.call if when_done
121 def multi_select threads
122 threads.each { |t| select t }
125 ## these two methods are called by thread-view-modes when the user
126 ## wants to view the previous/next thread without going back to
127 ## index-mode. we update the cursor as a convenience.
128 def launch_next_thread_after thread, &b
129 launch_another_thread thread, 1, &b
132 def launch_prev_thread_before thread, &b
133 launch_another_thread thread, -1, &b
136 def launch_another_thread thread, direction, &b
137 l = @lines[thread] or return
138 target_l = l + direction
139 t = @mutex.synchronize do
140 if target_l >= 0 && target_l < @threads.length
145 if t # there's a next thread
146 set_cursor_pos target_l # move out of mutex?
148 elsif b # no next thread. call the block anyways
153 def handle_single_message_labeled_update sender, m
154 ## no need to do anything different here; we don't differentiate
155 ## messages from their containing threads
156 handle_labeled_update sender, m
159 def handle_labeled_update sender, m
160 if(t = thread_containing(m))
161 l = @lines[t] or return
162 update_text_for_line l
163 elsif is_relevant?(m)
168 def handle_simple_update sender, m
169 t = thread_containing(m) or return
170 l = @lines[t] or return
171 update_text_for_line l
174 %w(read unread archived starred unstarred).each do |state|
175 define_method "handle_#{state}_update" do |*a|
176 handle_simple_update(*a)
181 def is_relevant? m; false; end
183 def handle_added_update sender, m
185 BufferManager.draw_screen
188 def handle_single_message_deleted_update sender, m
189 @ts_mutex.synchronize do
190 return unless @ts.contains? m
196 def handle_deleted_update sender, m
197 t = @ts_mutex.synchronize { @ts.thread_for m }
203 def handle_spammed_update sender, m
204 t = @ts_mutex.synchronize { @ts.thread_for m }
210 def handle_undeleted_update sender, m
215 @mutex.synchronize do
216 ## let's see you do THIS in python
217 @threads = @ts.threads.select { |t| !@hidden_threads[t] }.sort_by { |t| [t.date, t.first.id] }.reverse
218 @size_widgets = @threads.map { |t| size_widget_for_thread t }
219 @size_widget_width = @size_widgets.max_of { |w| w.display_length }
226 return unless(t = cursor_thread)
227 message, *crap = t.find { |m, *o| m.has_label? :draft }
229 mode = ResumeMode.new message
230 BufferManager.spawn "Edit message", mode
232 BufferManager.flash "Not a draft message!"
236 def actually_toggle_starred t
237 if t.has_label? :starred # if ANY message has a star
238 t.remove_label :starred # remove from all
239 UpdateManager.relay self, :unstarred, t.first
241 t.first.add_label :starred # add only to first
242 UpdateManager.relay self, :starred, t.first
247 t = cursor_thread or return
248 actually_toggle_starred t
249 update_text_for_line curpos
253 def multi_toggle_starred threads
254 threads.each { |t| actually_toggle_starred t }
258 def actually_toggle_archived t
259 if t.has_label? :inbox
260 t.remove_label :inbox
261 UpdateManager.relay self, :archived, t.first
264 UpdateManager.relay self, :unarchived, t.first
268 def actually_toggle_spammed t
269 if t.has_label? :spam
271 UpdateManager.relay self, :unspammed, t.first
274 UpdateManager.relay self, :spammed, t.first
278 def actually_toggle_deleted t
279 if t.has_label? :deleted
280 t.remove_label :deleted
281 UpdateManager.relay self, :undeleted, t.first
283 t.apply_label :deleted
284 UpdateManager.relay self, :deleted, t.first
289 t = cursor_thread or return
290 actually_toggle_archived t
291 update_text_for_line curpos
294 def multi_toggle_archived threads
295 threads.each { |t| actually_toggle_archived t }
300 t = cursor_thread or return
301 t.toggle_label :unread
302 update_text_for_line curpos
306 def multi_toggle_new threads
307 threads.each { |t| t.toggle_label :unread }
311 def multi_toggle_tagged threads
312 @mutex.synchronize { @tags.drop_all_tags }
317 ## this command has no non-tagged form. as a convenience, allow this
318 ## command to be applied to tagged threads without hitting ';'.
319 @tags.apply_to_tagged :join_threads
322 def multi_join_threads threads
323 @ts.join_threads threads or return
324 @tags.drop_all_tags # otherwise we have tag pointers to invalid threads!
329 n = @mutex.synchronize do
330 ((curpos + 1) ... lines).find { |i| @threads[i].has_label? :unread } ||
331 (0 ... curpos).find { |i| @threads[i].has_label? :unread }
334 ## jump there if necessary
335 jump_to_line n unless n >= topline && n < botline
338 BufferManager.flash "No new messages"
343 t = cursor_thread or return
344 multi_toggle_spam [t]
345 HookManager.run("mark-as-spam", :thread => t)
348 ## both spam and deleted have the curious characteristic that you
349 ## always want to hide the thread after either applying or removing
350 ## that label. in all thread-index-views except for
351 ## label-search-results-mode, when you mark a message as spam or
352 ## deleted, you want it to disappear immediately; in LSRM, you only
353 ## see deleted or spam emails, and when you undelete or unspam them
354 ## you also want them to disappear immediately.
355 def multi_toggle_spam threads
357 actually_toggle_spammed t
364 t = cursor_thread or return
365 multi_toggle_deleted [t]
368 ## see comment for multi_toggle_spam
369 def multi_toggle_deleted threads
371 actually_toggle_deleted t
378 t = cursor_thread or return
382 def multi_kill threads
384 t.apply_label :killed
388 BufferManager.flash "#{threads.size.pluralize 'Thread'} killed."
391 def save background=true
393 Redwood::reporting_thread("saving thread") { actually_save }
400 @save_thread_mutex.synchronize do
401 BufferManager.say("Saving contacts...") { ContactManager.instance.save }
402 dirty_threads = @mutex.synchronize { (@threads + @hidden_threads.keys).select { |t| t.dirty? } }
403 next if dirty_threads.empty?
405 BufferManager.say("Saving threads...") do |say_id|
406 dirty_threads.each_with_index do |t, i|
407 BufferManager.say "Saving modified thread #{i + 1} of #{dirty_threads.length}...", say_id
415 UpdateManager.unregister self
419 BufferManager.clear @mbid if @mbid
420 sleep 0.1 # TODO: necessary?
421 BufferManager.erase_flash
428 t = cursor_thread or return
429 @mutex.synchronize { @tags.toggle_tag_for t }
430 update_text_for_line curpos
434 def toggle_tagged_all
435 @mutex.synchronize { @threads.each { |t| @tags.toggle_tag_for t } }
440 query = BufferManager.ask :search, "tag threads matching (regex): "
441 return if query.nil? || query.empty?
444 rescue RegexpError => e
445 BufferManager.flash "error interpreting '#{query}': #{e.message}"
448 @mutex.synchronize { @threads.each { |t| @tags.tag t if thread_matches?(t, query) } }
452 def apply_to_tagged; @tags.apply_to_tagged; end
455 thread = cursor_thread or return
456 speciall = (@hidden_labels + LabelManager::RESERVED_LABELS).uniq
457 keepl, modifyl = thread.labels.partition { |t| speciall.member? t }
459 user_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", modifyl, @hidden_labels
461 return unless user_labels
462 thread.labels = keepl + user_labels
463 user_labels.each { |l| LabelManager << l }
464 update_text_for_line curpos
465 UpdateManager.relay self, :labeled, thread.first
468 def multi_edit_labels threads
469 user_labels = BufferManager.ask_for_labels :labels, "Add/remove labels (use -label to remove): ", [], @hidden_labels
470 return unless user_labels
472 user_labels.map! { |l| (l.to_s =~ /^-/)? [l.to_s.gsub(/^-?/, '').to_sym, true] : [l, false] }
473 hl = user_labels.select { |(l,_)| @hidden_labels.member? l }
476 user_labels.each do |(l, to_remove)|
484 user_labels.each { |(l,_)| LabelManager << l }
486 BufferManager.flash "'#{hl}' is a reserved label!"
492 t = cursor_thread or return
494 return if m.nil? # probably won't happen
496 mode = ReplyMode.new m
497 BufferManager.spawn "Reply to #{m.subj}", mode
501 t = cursor_thread or return
503 return if m.nil? # probably won't happen
505 ForwardMode.spawn_nicely :message => m
508 def load_n_threads_background n=LOAD_MORE_THREAD_NUM, opts={}
509 return if @load_thread # todo: wrap in mutex
510 @load_thread = Redwood::reporting_thread("load threads for thread-index-mode") do
511 num = load_n_threads n, opts
512 opts[:when_done].call(num) if opts[:when_done]
517 ## TODO: figure out @ts_mutex in this method
518 def load_n_threads n=LOAD_MORE_THREAD_NUM, opts={}
519 @interrupt_search = false
520 @mbid = BufferManager.say "Searching for threads..."
523 ts_to_load = ts_to_load + @ts.size unless n == -1 # -1 means all threads
526 last_update = Time.now
527 @ts.load_n_threads(ts_to_load, opts) do |i|
528 if (Time.now - last_update) >= 0.25
529 BufferManager.say "Loaded #{i.pluralize 'thread'}...", @mbid
531 BufferManager.draw_screen
532 last_update = Time.now
534 break if @interrupt_search
536 @ts.threads.each { |th| th.labels.each { |l| LabelManager << l } }
539 BufferManager.clear @mbid
541 BufferManager.draw_screen
544 ignore_concurrent_calls :load_n_threads
550 "line #{curpos + 1} of #{l} #{dirty? ? '*modified*' : ''}"
555 @interrupt_search = true
559 load_threads :num => -1
562 def load_threads opts={}
564 n = ThreadIndexMode::LOAD_MORE_THREAD_NUM
569 myopts = @load_thread_opts.merge({ :when_done => (lambda do |num|
570 opts[:when_done].call(num) if opts[:when_done]
573 BufferManager.flash "Found #{num.pluralize 'thread'}."
575 BufferManager.flash "No matches."
579 if opts[:background] || opts[:background].nil?
580 load_n_threads_background n, myopts
582 load_n_threads n, myopts
585 ignore_concurrent_calls :load_threads
587 def resize rows, cols
595 @ts_mutex.synchronize do
596 if (is_relevant?(m) || @ts.is_relevant?(m)) && !@ts.contains?(m)
597 @ts.load_thread_for_message m, @load_thread_opts
600 @hidden_threads.delete @ts.thread_for(m)
606 def thread_containing m; @ts_mutex.synchronize { @ts.thread_for m } end
608 ## used to tag threads by query. this can be made a lot more sophisticated,
609 ## but for right now we'll do the obvious this.
610 def thread_matches? t, query
611 t.subj =~ query || t.snippet =~ query || t.participants.any? { |x| x.longname =~ query }
614 def size_widget_for_thread t
615 HookManager.run("index-mode-size-widget", :thread => t) || default_size_widget_for(t)
618 def cursor_thread; @mutex.synchronize { @threads[curpos] }; end
627 @mutex.synchronize do
628 i = @threads.index(t) or return
629 raise "already hidden" if @hidden_threads[t]
630 @hidden_threads[t] = true
632 @size_widgets.delete_at i
637 def update_text_for_line l
638 return unless l # not sure why this happens, but it does, occasionally
642 @mutex.synchronize do
643 @size_widgets[l] = size_widget_for_thread @threads[l]
645 ## if the widget size has increased, we need to redraw everyone
646 need_update = @size_widgets[l].size > @size_widget_width
652 @text[l] = text_for_thread_at l
653 buffer.mark_dirty if buffer
658 threads = @mutex.synchronize { @threads }
659 @text = threads.map_with_index { |t, i| text_for_thread_at i }
660 @lines = threads.map_with_index { |t, i| [t, i] }.to_h
661 buffer.mark_dirty if buffer
664 def authors; map { |m, *o| m.from if m }.compact.uniq; end
666 def author_names_and_newness_for_thread t
668 authors = t.map do |m, *o|
672 if AccountManager.is_account?(m.from)
674 elsif t.authors.size == 1
680 new[name] ||= m.has_label?(:unread)
684 authors.compact.uniq.map { |a| [a, new[a]] }
687 def text_for_thread_at line
688 t, size_widget = @mutex.synchronize { [@threads[line], @size_widgets[line]] }
690 date = t.date.to_nice_s
692 starred = t.has_label?(:starred)
694 ## format the from column
696 ann = author_names_and_newness_for_thread t
698 ann.each_with_index do |(name, newness), i|
699 break if cur_width >= from_width
700 last = i == ann.length - 1
703 if cur_width + name.display_length > from_width
704 name[0 ... (from_width - cur_width - 1)] + "."
705 elsif cur_width + name.display_length == from_width
706 name[0 ... (from_width - cur_width)]
709 name[0 ... (from_width - cur_width)]
711 name[0 ... (from_width - cur_width - 1)] + ","
715 cur_width += abbrev.display_length
717 if last && from_width > cur_width
718 abbrev += " " * (from_width - cur_width)
721 from << [(newness ? :index_new_color : (starred ? :index_starred_color : :index_old_color)), abbrev]
724 dp = t.direct_participants.any? { |p| AccountManager.is_account? p }
725 p = dp || t.participants.any? { |p| AccountManager.is_account? p }
728 if t.has_label?(:draft)
730 elsif t.has_label?(:unread)
738 snippet = t.snippet + (t.snippet.empty? ? "" : "...")
740 size_widget_text = sprintf "%#{ @size_widget_width}s", size_widget
743 [:tagged_color, @tags.tagged?(t) ? ">" : " "],
744 [:none, sprintf("%#{@date_width}s", date)],
745 (starred ? [:starred_color, "*"] : [:none, " "]),
749 [subj_color, size_widget_text],
750 [:to_me_color, t.labels.member?(:attachment) ? "@" : " "],
751 [:to_me_color, dp ? ">" : (p ? '+' : " ")],
752 [subj_color, t.subj + (t.subj.empty? ? "" : " ")],
754 (t.labels - @hidden_labels).map { |label| [:label_color, "+#{label} "] } +
755 [[:snippet_color, snippet]
759 def dirty?; @mutex.synchronize { (@hidden_threads.keys + @threads).any? { |t| t.dirty? } } end
763 def default_size_widget_for t
773 [(buffer.content_width.to_f * 0.2).to_i, MIN_FROM_WIDTH].max
776 def initialize_threads
777 @ts = ThreadSet.new Index.instance, $config[:thread_by_subject]
778 @ts_mutex = Mutex.new