36e2299b27ec25261638157a9dd6f3837b85f6e0
[notmuch] / TODO
1 Fix the things that are causing the most pain to new users
2 ----------------------------------------------------------
3 1. A new import is tagging all messages as "inbox" -- total pain
4
5 2. Allow an easy way to get tags from directory names (if the user has them)
6
7 3. Fix Xapian defect #250 so tagging is fast.
8
9 Emacs interface (notmuch.el)
10 ----------------------------
11 Enhance '+' and '-' in the search view to operate on an entire region
12 if set.
13
14 Fix '*' to work by simply calling '+' or '-' on a region consisting of
15 the entire buffer.
16
17 Add a global keybinding table for notmuch, and then view-specific
18 tables that add to it.
19
20 Add a command to archive all threads in a search view.
21         
22 Add a '|' binding from the search view.
23
24 When a thread has been entirely read, start out by closing all
25 messages except those that matched the search terms.
26
27 Add support for choosing from one of the user's configured email
28 addresses for the From line.
29
30 Make 'notmuch-show-pipe-message have a private history.
31
32 Add support for a delete keybinding that adds a "deleted" tag to the
33 current message/thread and make searches not return deleted messages
34 by default, (unless the user asks explicitly for deleted messags in
35 the search query).
36
37 Add support to "mute" a thread (add a "muted" tag and then don't
38 display threads in searches by default where any message of the thread
39 has the "muted" tag).
40
41 Fix i-search to open up invisible citations as necessary.
42
43 Portability
44 -----------
45 Fix configure script to test each compiler warning we want to use.
46
47 Completion
48 ----------
49 Fix bash completion to complete multiple search options (both --first
50 and *then* --max-threads), and also complete value for --sort=
51 (oldest-first or newest-first).
52
53 notmuch command-line tool
54 -------------------------
55 Implement "notmuch search --exclude-threads=<search-terms>" to allow
56 for excluding muted threads, (and any other negative, thread-based
57 filtering that the user wants to do).
58
59 Fix "notmuch show" so that the UI doesn't fail to show a thread that
60 is visible in a search buffer, but happens to no longer match the
61 current search. (Perhaps add a --matching=<secondary-search-terms>
62 option (or similar) to "notmuch show".)
63
64 Teach "notmuch search" to return many different kinds of results. Some
65 ideas:
66
67         notmuch search --output=threads # Default if no --output is given
68         notmuch search --output=messages
69         notmuch search --output=tags
70         notmuch search --output=addresses
71         notmuch search --output=terms
72
73 Add a "--format" option to "notmuch search", (something printf-like
74 for selecting what gets printed).
75
76 Add a "--count-only" (or so?) option to "notmuch search" for returning
77 the count of search results.
78
79 Add documented syntax for searching all threads/messages.
80
81 Give "notmuch restore" some progress indicator. Until we get the
82 Xapian bugs fixed that are making this operation slow, we really need
83 to let the user know that things are still moving.
84
85 Fix "notmuch restore" to operate in a single pass much like "notmuch
86 dump" does, rather than doing N searches into the database, each
87 matching 1/N messages.
88
89 Add a "-f <filename>" option to select an alternate configuration
90 file.
91
92 Fix notmuch.c to call add_timestamp/get_timestamp with path names
93 relative to the database path. (Otherwise, moving the database to a
94 new directory will result in notmuch creating new timestamp documents
95 and leaving stale ones behind.)
96
97 Fix notmuch.c to use a DIR prefix for directory timestamps, (the idea
98 being that it can then add other non-directory timestamps such as for
99 noting how far back in the past mail has been indexed, and whether it
100 needs to re-tag messages based on a theoretical "auto-tags"
101 configuration file).
102
103 Make "notmuch new" notice when a mail directory has gone more than a
104 month without receiving new mail and use that to trigger the printing
105 of the note that the user might want to mark the directory read-only.
106
107 Also make "notmuch new" optionally able to just mark those month-old
108 directories read-only on its own. (Could conflict with low-volume
109 lists such as announce lists if they are setup to deliver to their own
110 maildirs.)
111
112 Allow configuration for filename patterns that should be ignored when
113 indexing.
114
115 notmuch library
116 ---------------
117 Index content from citations, please.
118
119 Provide a sane syntax for date ranges. First, we don't want to require
120 both endpoints to be specified. For example it would be nice to be
121 able to say things like "since:2009-01-1" or "until:2009-01-1" and
122 have the other endpoint be implicit. Second we'd like to support
123 relative specifications of time such as "since:'2 months ago'". To do
124 any of this we're probably going to need to break down an write our
125 own parser for the query string rather than using Xapian's QueryParser
126 class.
127
128 Make failure to read a file (such as a permissions problem) a warning
129 rather than an error (should be similar to the existing warning for a
130 non-mail file).
131
132 Add support for files that are moved or deleted (which obviously need
133 to be handled differently).
134
135 Actually compile and install a libnotmuch shared library.
136
137 Fix to use the *last* Message-ID header if multiple such headers are
138 encountered, (I noticed this is one thing that kept me from seeing the
139 same message-ID values as sup).
140
141 Add support for the user to specify custom headers to be indexed.
142
143 Add support for configuring "virtual tags" which are a tuple of
144 (tag-name, search-specification). The database is responsible for
145 ensuring that the virtual tag is always consistent.
146
147 Indicate to the user if two files with the same message ID have
148 content that is actually different in some interesting way. Perhaps
149 notmuch initially sees all changes as interesting, and quickly learns
150 from the user which changes are not interesting (such as the very
151 common mailing-list footer).
152
153 Fix notmuch_query_count_messages to share code with
154 notmuch_query_search_messages rather than duplicating code. (And
155 consider renaming it as well.)
156
157 Provide a mechanism for doing automatic address completion based on
158 notmuch searches. Here was one proposal made in IRC:
159
160         <cworth> I guess all it would really have to be would be a way
161                  to configure a series of searches to try in turn,
162                  (presenting ambiguities at a given single level, and
163                  advancing to the next level only if one level
164                  returned no matches).
165         <cworth> So then I might have a series that looks like this:
166         <cworth> notmuch search --output=address_from tag:address_book_alias
167         <cworth> notmuch search --output=address_to tag:sent
168         <cworth> notmuch search --output=address_from
169         <cworth> I think I might like that quite a bit.
170         <cworth> And then we have a story for an address book for
171                  non-emacs users.
172
173 Provide a ~me Xapian synonym for all of the user's configured email
174 addresses.
175
176 General
177 -------
178 Audit everything for dealing with out-of-memory (and drop xutil.c).
179
180 Write a test suite.
181
182 Achieve 100% test coverage with the test suite.
183
184 Investigate why the notmuch database is slightly larger than the sup
185 database for the same corpus of email.
186
187 Xapian
188 ------
189 Fix defect #250
190
191         replace_document should make minimal changes to database file
192         http://trac.xapian.org/ticket/250
193
194         It looks like it's going to be easy to fix. Here's the file to
195         change:
196
197                 xapian-core/backends/flint/flint_database.cc
198
199         And look for:
200
201           // FIXME - in the case where there is overlap between the new
202           // termlist and the old termlist, it would be better to compare the
203           // two lists, and make the minimum set of modifications required.
204           // This would lead to smaller changesets for replication, and
205           // probably be faster overall
206
207         So I think this might be as easy as just walking over two
208         sorted lists looking for differences.
209
210         Note that this is in the currently default "flint" backend,
211         but the Xapian folks are probably more interested in fixing
212         the in-development "chert" backend. So the patch to get
213         upstreamed there will probably also fix:
214
215                 xapian-core/backends/chert/chert_database.cc
216
217         (I'm hoping the fix will be the same---an identical comment
218         exists there.)
219
220         Also, if you want to experiment with the chert backend,
221         compile current Xapian source and run notmuch with
222         XAPIAN_PREFER_CHERT=1. I haven't tried that yet, but there are
223         claims that a chert database can be 40% smaller than an
224         equivalent flint database.
225
226 Report this bug:
227
228         "tag:foo and tag:bar and -tag:deleted" goes insane
229
230         This seems to be triggered by a Boolean operator next to a
231         token starting with a non-word character---suddenly all the
232         Boolean operators get treated as literal tokens)