5 ## subclasses should implement:
8 class ThreadIndexMode < LineCursorMode
9 DATE_WIDTH = Time::TO_NICE_S_MAX_LEN
11 LOAD_MORE_THREAD_NUM = 20
13 HookManager.register "index-mode-size-widget", <<EOS
14 Generates the per-thread size widget for each thread.
16 thread: The message thread to be formatted.
19 HookManager.register "mark-as-spam", <<EOS
20 This hook is run when a thread is marked as spam
22 thread: The message thread being marked as spam.
25 register_keymap do |k|
26 k.add :load_threads, "Load #{LOAD_MORE_THREAD_NUM} more threads", 'M'
27 k.add_multi "Load all threads (! to confirm) :", '!' do |kk|
28 kk.add :load_all_threads, "Load all threads (may list a _lot_ of threads)", '!'
30 k.add :cancel_search, "Cancel current search", :ctrl_g
31 k.add :reload, "Refresh view", '@'
32 k.add :toggle_archived, "Toggle archived status", 'a'
33 k.add :toggle_starred, "Star or unstar all messages in thread", '*'
34 k.add :toggle_new, "Toggle new/read status of all messages in thread", 'N'
35 k.add :edit_labels, "Edit or add labels for a thread", 'l'
36 k.add :edit_message, "Edit message (drafts only)", 'e'
37 k.add :toggle_spam, "Mark/unmark thread as spam", 'S'
38 k.add :toggle_deleted, "Delete/undelete thread", 'd'
39 k.add :kill, "Kill thread (never to be seen in inbox again)", '&'
40 k.add :save, "Save changes now", '$'
41 k.add :jump_to_next_new, "Jump to next new thread", :tab
42 k.add :reply, "Reply to latest message in a thread", 'r'
43 k.add :reply_all, "Reply to all participants of the latest message in a thread", 'G'
44 k.add :forward, "Forward latest message in a thread", 'f'
45 k.add :toggle_tagged, "Tag/untag selected thread", 't'
46 k.add :toggle_tagged_all, "Tag/untag all threads", 'T'
47 k.add :tag_matching, "Tag matching threads", 'g'
48 k.add :apply_to_tagged, "Apply next command to all tagged threads", '+', '='
49 k.add :join_threads, "Force tagged threads to be joined into the same thread", '#'
50 k.add :undo, "Undo the previous action", 'u'
53 def initialize hidden_labels=[], load_thread_opts={}
55 @mutex = Mutex.new # covers the following variables:
58 @size_widget_width = nil
60 @tags = Tagger.new self
62 ## these guys, and @text and @lines, are not covered
64 @load_thread_opts = load_thread_opts
65 @hidden_labels = hidden_labels + LabelManager::HIDDEN_RESERVED_LABELS
66 @date_width = DATE_WIDTH
68 @interrupt_search = false
70 initialize_threads # defines @ts and @ts_mutex
71 update # defines @text and @lines
73 UpdateManager.register self
75 @save_thread_mutex = Mutex.new
77 @last_load_more_size = nil
78 to_load_more do |size|
79 next if @last_load_more_size == 0
80 load_threads :num => 1, :background => false
81 load_threads :num => (size - 1),
82 :when_done => lambda { |num| @last_load_more_size = num }
86 def unsaved?; dirty? end
87 def lines; @text.length; end
88 def [] i; @text[i]; end
89 def contains_thread? t; @threads.include?(t) end
94 BufferManager.draw_screen
95 load_threads :num => buffer.content_height
98 ## open up a thread view window
99 def select t=nil, when_done=nil
100 t ||= cursor_thread or return
102 Redwood::reporting_thread("load messages for thread-view-mode") do
104 message = "Loading #{num.pluralize 'message body'}..."
105 BufferManager.say(message) do |sid|
106 t.each_with_index do |(m, *o), i|
108 BufferManager.say "#{message} (#{i}/#{num})", sid if t.size > 1
112 mode = ThreadViewMode.new t, @hidden_labels, self
113 BufferManager.spawn t.subj, mode
114 BufferManager.draw_screen
115 mode.jump_to_first_open true
116 BufferManager.draw_screen # lame TODO: make this unnecessary
117 ## the first draw_screen is needed before topline and botline
118 ## are set, and the second to show the cursor having moved
120 update_text_for_line curpos
121 UpdateManager.relay self, :read, t.first
122 when_done.call if when_done
126 def multi_select threads
127 threads.each { |t| select t }
130 ## these two methods are called by thread-view-modes when the user
131 ## wants to view the previous/next thread without going back to
132 ## index-mode. we update the cursor as a convenience.
133 def launch_next_thread_after thread, &b
134 launch_another_thread thread, 1, &b
137 def launch_prev_thread_before thread, &b
138 launch_another_thread thread, -1, &b
141 def launch_another_thread thread, direction, &b
142 l = @lines[thread] or return
143 target_l = l + direction
144 t = @mutex.synchronize do
145 if target_l >= 0 && target_l < @threads.length
150 if t # there's a next thread
151 set_cursor_pos target_l # move out of mutex?
153 elsif b # no next thread. call the block anyways
158 def handle_single_message_labeled_update sender, m
159 ## no need to do anything different here; we don't differentiate
160 ## messages from their containing threads
161 handle_labeled_update sender, m
164 def handle_labeled_update sender, m
165 if(t = thread_containing(m))
166 l = @lines[t] or return
167 update_text_for_line l
168 elsif is_relevant?(m)
173 def handle_simple_update sender, m
174 t = thread_containing(m) or return
175 l = @lines[t] or return
176 update_text_for_line l
179 %w(read unread archived starred unstarred).each do |state|
180 define_method "handle_#{state}_update" do |*a|
181 handle_simple_update(*a)
186 def is_relevant? m; false; end
188 def handle_added_update sender, m
190 BufferManager.draw_screen
193 def handle_single_message_deleted_update sender, m
194 @ts_mutex.synchronize do
195 return unless @ts.contains? m
201 def handle_deleted_update sender, m
202 t = @ts_mutex.synchronize { @ts.thread_for m }
208 def handle_spammed_update sender, m
209 t = @ts_mutex.synchronize { @ts.thread_for m }
215 def handle_undeleted_update sender, m
224 @mutex.synchronize do
225 ## let's see you do THIS in python
226 @threads = @ts.threads.select { |t| !@hidden_threads[t] }.sort_by { |t| [t.date, t.first.id] }.reverse
227 @size_widgets = @threads.map { |t| size_widget_for_thread t }
228 @size_widget_width = @size_widgets.max_of { |w| w.display_length }
235 return unless(t = cursor_thread)
236 message, *crap = t.find { |m, *o| m.has_label? :draft }
238 mode = ResumeMode.new message
239 BufferManager.spawn "Edit message", mode
241 BufferManager.flash "Not a draft message!"
245 ## returns an undo lambda
246 def actually_toggle_starred t
248 if t.has_label? :starred # if ANY message has a star
249 t.remove_label :starred # remove from all
250 UpdateManager.relay self, :unstarred, t.first
252 t.first.add_label :starred
253 UpdateManager.relay self, :starred, t.first
257 t.first.add_label :starred # add only to first
258 UpdateManager.relay self, :starred, t.first
260 t.remove_label :starred
261 UpdateManager.relay self, :unstarred, t.first
268 t = cursor_thread or return
269 undo = actually_toggle_starred t
270 UndoManager.register "toggling thread starred status", undo
271 update_text_for_line curpos
275 def multi_toggle_starred threads
276 UndoManager.register "toggling #{threads.size.pluralize 'thread'} starred status",
277 threads.map { |t| actually_toggle_starred t }
281 ## returns an undo lambda
282 def actually_toggle_archived t
285 if t.has_label? :inbox
286 t.remove_label :inbox
287 UpdateManager.relay self, :archived, t.first
289 thread.apply_label :inbox
290 update_text_for_line pos
291 UpdateManager.relay self,:unarchived, thread.first
295 UpdateManager.relay self, :unarchived, t.first
297 thread.remove_label :inbox
298 update_text_for_line pos
299 UpdateManager.relay self, :unarchived, thread.first
304 ## returns an undo lambda
305 def actually_toggle_spammed t
307 if t.has_label? :spam
309 add_or_unhide t.first
310 UpdateManager.relay self, :unspammed, t.first
312 thread.apply_label :spam
313 self.hide_thread thread
314 UpdateManager.relay self,:spammed, thread.first
319 UpdateManager.relay self, :spammed, t.first
321 thread.remove_label :spam
322 add_or_unhide thread.first
323 UpdateManager.relay self,:unspammed, thread.first
328 ## returns an undo lambda
329 def actually_toggle_deleted t
330 if t.has_label? :deleted
331 t.remove_label :deleted
332 add_or_unhide t.first
333 UpdateManager.relay self, :undeleted, t.first
335 t.apply_label :deleted
337 UpdateManager.relay self, :deleted, t.first
340 t.apply_label :deleted
342 UpdateManager.relay self, :deleted, t.first
344 t.remove_label :deleted
345 add_or_unhide t.first
346 UpdateManager.relay self, :undeleted, t.first
352 t = cursor_thread or return
353 undo = actually_toggle_archived t
354 UndoManager.register "deleting/undeleting thread #{t.first.id}", undo, lambda { update_text_for_line curpos }
355 update_text_for_line curpos
358 def multi_toggle_archived threads
359 undos = threads.map { |t| actually_toggle_archived t }
360 UndoManager.register "deleting/undeleting #{threads.size.pluralize 'thread'}", undos, lambda { regen_text }
365 t = cursor_thread or return
366 t.toggle_label :unread
367 update_text_for_line curpos
371 def multi_toggle_new threads
372 threads.each { |t| t.toggle_label :unread }
376 def multi_toggle_tagged threads
377 @mutex.synchronize { @tags.drop_all_tags }
382 ## this command has no non-tagged form. as a convenience, allow this
383 ## command to be applied to tagged threads without hitting ';'.
384 @tags.apply_to_tagged :join_threads
387 def multi_join_threads threads
388 @ts.join_threads threads or return
389 @tags.drop_all_tags # otherwise we have tag pointers to invalid threads!
394 n = @mutex.synchronize do
395 ((curpos + 1) ... lines).find { |i| @threads[i].has_label? :unread } ||
396 (0 ... curpos).find { |i| @threads[i].has_label? :unread }
399 ## jump there if necessary
400 jump_to_line n unless n >= topline && n < botline
403 BufferManager.flash "No new messages"
408 t = cursor_thread or return
409 multi_toggle_spam [t]
410 HookManager.run("mark-as-spam", :thread => t)
413 ## both spam and deleted have the curious characteristic that you
414 ## always want to hide the thread after either applying or removing
415 ## that label. in all thread-index-views except for
416 ## label-search-results-mode, when you mark a message as spam or
417 ## deleted, you want it to disappear immediately; in LSRM, you only
418 ## see deleted or spam emails, and when you undelete or unspam them
419 ## you also want them to disappear immediately.
420 def multi_toggle_spam threads
421 undos = threads.map { |t| actually_toggle_spammed t }
422 UndoManager.register "marking/unmarking #{threads.size.pluralize 'thread'} as spam",
423 undos, lambda { regen_text }
428 t = cursor_thread or return
429 multi_toggle_deleted [t]
432 ## see comment for multi_toggle_spam
433 def multi_toggle_deleted threads
434 undos = threads.map { |t| actually_toggle_deleted t }
435 UndoManager.register "deleting/undeleting #{threads.size.pluralize 'thread'}",
436 undos, lambda { regen_text }
441 t = cursor_thread or return
445 ## m-m-m-m-MULTI-KILL
446 def multi_kill threads
447 UndoManager.register "killing #{threads.size.pluralize 'thread'}" do
449 t.remove_label :killed
450 add_or_unhide t.first
456 t.apply_label :killed
461 BufferManager.flash "#{threads.size.pluralize 'thread'} killed."
464 def save background=true
466 Redwood::reporting_thread("saving thread") { actually_save }
473 @save_thread_mutex.synchronize do
474 BufferManager.say("Saving contacts...") { ContactManager.instance.save }
475 dirty_threads = @mutex.synchronize { (@threads + @hidden_threads.keys).select { |t| t.dirty? } }
476 next if dirty_threads.empty?
478 BufferManager.say("Saving threads...") do |say_id|
479 dirty_threads.each_with_index do |t, i|
480 BufferManager.say "Saving modified thread #{i + 1} of #{dirty_threads.length}...", say_id
488 UpdateManager.unregister self
492 BufferManager.clear @mbid if @mbid
493 sleep 0.1 # TODO: necessary?
494 BufferManager.erase_flash
501 t = cursor_thread or return
502 @mutex.synchronize { @tags.toggle_tag_for t }
503 update_text_for_line curpos
507 def toggle_tagged_all
508 @mutex.synchronize { @threads.each { |t| @tags.toggle_tag_for t } }
513 query = BufferManager.ask :search, "tag threads matching (regex): "
514 return if query.nil? || query.empty?
517 rescue RegexpError => e
518 BufferManager.flash "error interpreting '#{query}': #{e.message}"
521 @mutex.synchronize { @threads.each { |t| @tags.tag t if thread_matches?(t, query) } }
525 def apply_to_tagged; @tags.apply_to_tagged; end
528 thread = cursor_thread or return
529 speciall = (@hidden_labels + LabelManager::RESERVED_LABELS).uniq
531 old_labels = thread.labels
534 keepl, modifyl = thread.labels.partition { |t| speciall.member? t }
536 user_labels = BufferManager.ask_for_labels :label, "Labels for thread: ", modifyl, @hidden_labels
537 return unless user_labels
539 thread.labels = Set.new(keepl) + user_labels
540 user_labels.each { |l| LabelManager << l }
541 update_text_for_line curpos
543 UndoManager.register "labeling thread" do
544 thread.labels = old_labels
545 update_text_for_line pos
546 UpdateManager.relay self, :labeled, thread.first
549 UpdateManager.relay self, :labeled, thread.first
552 def multi_edit_labels threads
553 user_labels = BufferManager.ask_for_labels :labels, "Add/remove labels (use -label to remove): ", [], @hidden_labels
554 return unless user_labels
556 user_labels.map! { |l| (l.to_s =~ /^-/)? [l.to_s.gsub(/^-?/, '').to_sym, true] : [l, false] }
557 hl = user_labels.select { |(l,_)| @hidden_labels.member? l }
559 BufferManager.flash "'#{hl}' is a reserved label!"
563 old_labels = threads.map { |t| t.labels.dup }
566 user_labels.each do |(l, to_remove)|
574 UpdateManager.relay self, :labeled, t.first
579 UndoManager.register "labeling #{threads.size.pluralize 'thread'}" do
580 threads.zip(old_labels).map do |t, old_labels|
581 t.labels = old_labels
582 UpdateManager.relay self, :labeled, t.first
588 def reply type_arg=nil
589 t = cursor_thread or return
591 return if m.nil? # probably won't happen
593 mode = ReplyMode.new m, type_arg
594 BufferManager.spawn "Reply to #{m.subj}", mode
597 def reply_all; reply :all; end
600 t = cursor_thread or return
602 return if m.nil? # probably won't happen
604 ForwardMode.spawn_nicely :message => m
607 def load_n_threads_background n=LOAD_MORE_THREAD_NUM, opts={}
608 return if @load_thread # todo: wrap in mutex
609 @load_thread = Redwood::reporting_thread("load threads for thread-index-mode") do
610 num = load_n_threads n, opts
611 opts[:when_done].call(num) if opts[:when_done]
616 ## TODO: figure out @ts_mutex in this method
617 def load_n_threads n=LOAD_MORE_THREAD_NUM, opts={}
618 @interrupt_search = false
619 @mbid = BufferManager.say "Searching for threads..."
622 ts_to_load = ts_to_load + @ts.size unless n == -1 # -1 means all threads
625 last_update = Time.now
626 @ts.load_n_threads(ts_to_load, opts) do |i|
627 if (Time.now - last_update) >= 0.25
628 BufferManager.say "Loaded #{i.pluralize 'thread'}...", @mbid
630 BufferManager.draw_screen
631 last_update = Time.now
633 break if @interrupt_search
635 @ts.threads.each { |th| th.labels.each { |l| LabelManager << l } }
638 BufferManager.clear @mbid
640 BufferManager.draw_screen
643 ignore_concurrent_calls :load_n_threads
649 "line #{curpos + 1} of #{l} #{dirty? ? '*modified*' : ''}"
654 @interrupt_search = true
658 load_threads :num => -1
661 def load_threads opts={}
663 n = ThreadIndexMode::LOAD_MORE_THREAD_NUM
668 myopts = @load_thread_opts.merge({ :when_done => (lambda do |num|
669 opts[:when_done].call(num) if opts[:when_done]
672 BufferManager.flash "Found #{num.pluralize 'thread'}."
674 BufferManager.flash "No matches."
678 if opts[:background] || opts[:background].nil?
679 load_n_threads_background n, myopts
681 load_n_threads n, myopts
684 ignore_concurrent_calls :load_threads
686 def resize rows, cols
694 @ts_mutex.synchronize do
695 if (is_relevant?(m) || @ts.is_relevant?(m)) && !@ts.contains?(m)
696 @ts.load_thread_for_message m, @load_thread_opts
699 @hidden_threads.delete @ts.thread_for(m)
705 def thread_containing m; @ts_mutex.synchronize { @ts.thread_for m } end
707 ## used to tag threads by query. this can be made a lot more sophisticated,
708 ## but for right now we'll do the obvious this.
709 def thread_matches? t, query
710 t.subj =~ query || t.snippet =~ query || t.participants.any? { |x| x.longname =~ query }
713 def size_widget_for_thread t
714 HookManager.run("index-mode-size-widget", :thread => t) || default_size_widget_for(t)
717 def cursor_thread; @mutex.synchronize { @threads[curpos] }; end
726 @mutex.synchronize do
727 i = @threads.index(t) or return
728 raise "already hidden" if @hidden_threads[t]
729 @hidden_threads[t] = true
731 @size_widgets.delete_at i
736 def update_text_for_line l
737 return unless l # not sure why this happens, but it does, occasionally
741 @mutex.synchronize do
742 @size_widgets[l] = size_widget_for_thread @threads[l]
744 ## if the widget size has increased, we need to redraw everyone
745 need_update = @size_widgets[l].size > @size_widget_width
751 @text[l] = text_for_thread_at l
752 buffer.mark_dirty if buffer
757 threads = @mutex.synchronize { @threads }
758 @text = threads.map_with_index { |t, i| text_for_thread_at i }
759 @lines = threads.map_with_index { |t, i| [t, i] }.to_h
760 buffer.mark_dirty if buffer
763 def authors; map { |m, *o| m.from if m }.compact.uniq; end
765 def author_names_and_newness_for_thread t, limit=nil
770 break if limit and authors.size >= limit
773 if AccountManager.is_account?(m.from)
775 elsif t.authors.size == 1
781 new[name] ||= m.has_label?(:unread)
785 authors.to_a.map { |a| [a, new[a]] }
789 def text_for_thread_at line
790 t, size_widget = @mutex.synchronize { [@threads[line], @size_widgets[line]] }
792 date = t.date.to_nice_s
794 starred = t.has_label? :starred
796 ## format the from column
798 ann = author_names_and_newness_for_thread t, AUTHOR_LIMIT
800 ann.each_with_index do |(name, newness), i|
801 break if cur_width >= from_width
802 last = i == ann.length - 1
805 if cur_width + name.display_length > from_width
806 name[0 ... (from_width - cur_width - 1)] + "."
807 elsif cur_width + name.display_length == from_width
808 name[0 ... (from_width - cur_width)]
811 name[0 ... (from_width - cur_width)]
813 name[0 ... (from_width - cur_width - 1)] + ","
817 cur_width += abbrev.display_length
819 if last && from_width > cur_width
820 abbrev += " " * (from_width - cur_width)
823 from << [(newness ? :index_new_color : (starred ? :index_starred_color : :index_old_color)), abbrev]
826 dp = t.direct_participants.any? { |p| AccountManager.is_account? p }
827 p = dp || t.participants.any? { |p| AccountManager.is_account? p }
830 if t.has_label?(:draft)
832 elsif t.has_label?(:unread)
840 snippet = t.snippet + (t.snippet.empty? ? "" : "...")
842 size_widget_text = sprintf "%#{ @size_widget_width}s", size_widget
845 [:tagged_color, @tags.tagged?(t) ? ">" : " "],
846 [:none, sprintf("%#{@date_width}s", date)],
847 (starred ? [:starred_color, "*"] : [:none, " "]),
851 [subj_color, size_widget_text],
852 [:to_me_color, t.labels.member?(:attachment) ? "@" : " "],
853 [:to_me_color, dp ? ">" : (p ? '+' : " ")],
855 (t.labels - @hidden_labels).map { |label| [:label_color, "#{label} "] } +
857 [subj_color, t.subj + (t.subj.empty? ? "" : " ")],
858 [:snippet_color, snippet],
862 def dirty?; @mutex.synchronize { (@hidden_threads.keys + @threads).any? { |t| t.dirty? } } end
866 def default_size_widget_for t
876 [(buffer.content_width.to_f * 0.2).to_i, MIN_FROM_WIDTH].max
879 def initialize_threads
880 @ts = ThreadSet.new Index.instance, $config[:thread_by_subject]
881 @ts_mutex = Mutex.new