3741f0efca6a6f14aaf817d31d922ac01eef4c27
[notmuch] / devel / 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 Emacs interface (notmuch.el)
6 ----------------------------
7 Add notmuch-bcc and notmuch-cc for setting default Bcc and Cc values,
8 (should affect the message-setup-hook).
9
10 Switch the notmuch-search view to use "notmuch search --format=json"
11 to fix large classes of bugs regarding poorly-escaped output and lame
12 regular expressions. (The most recently found, unfixed example is the
13 sender's name containing ';' which causes emacs to drop a search
14 result.) This may require removing the outer array from the current
15 "notmuch search --format=json" results.
16
17 Fix '*' to work by simply calling '+' or '-' on a region consisting of
18 the entire buffer, (this would avoid one race condition---while still
19 leaving other race conditions---but could also potentially make '*' a
20 very expensive operation).
21
22 Add a global keybinding table for notmuch, and then view-specific
23 tables that add to it.
24         
25 Add a '|' binding from the search view.
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 messages in
35 the search query).
36
37 Add keybindings for next/previous thread.
38
39 Add support to "mute" a thread (add a "muted" tag and then don't
40 display threads in searches by default where any message of the thread
41 has the "muted" tag).
42
43 Make '=' count from the end rather than from the beginning if more
44 than half-way through the buffer.
45
46 Fix to automatically wrap long headers (for RFC compliance) before
47 sending. This should probably just be fixed in message-mode itself,
48 (but perhaps we can have a notmuch-message-mode that layers this on
49 top).
50
51 Stop hiding the headers so much in the thread-view mode.
52
53 Allow opening a message in thread-view mode by clicking on either
54 line.
55
56 Automatically open a message when navigating to it with N or P.
57
58 Change 'a' command in thread-view mode to only archive open messages.
59
60 Add a binding to open all closed messages.
61
62 Change the 'a'rchive command in the thread view to only archive open
63 messages.
64
65 Completion
66 ----------
67 Fix bash completion to complete multiple search options (both --first
68 and *then* --max-threads), and also complete value for --sort=
69 (oldest-first or newest-first).
70
71 notmuch command-line tool
72 -------------------------
73 Add support to "notmuch search" and "notmuch show" to allow for
74 listing of duplicate messages, (distinct filenames with the same
75 Message-ID). I'm not sure what the option should be named. Perhaps
76 --with-duplicates ?
77
78 Add a -0 option to "notmuch search" so that one can safely deal with
79 any filename with:
80
81         notmuch search --output=files -0 <terms> | xargs -0 <command>
82
83 "notmuch setup" should use realpath() before replacing the
84 configuration file. The ensures that the final target file of any
85 intermediate symbolic links is what is actually replaced, (rather than
86 any symbolic link).
87
88 Replace "notmuch reply" with "notmuch compose --reply <search-terms>".
89 This would enable a plain "notmuch compose" to be used to construct an
90 initial message, (which would then have the properly configured name
91 and email address in the From: line. We could also then easily support
92 "notmuch compose --from <something>" to support getting at alternate
93 email addresses.
94
95 Implement "notmuch search --exclude-threads=<search-terms>" to allow
96 for excluding muted threads, (and any other negative, thread-based
97 filtering that the user wants to do).
98
99 Fix "notmuch show" so that the UI doesn't fail to show a thread that
100 is visible in a search buffer, but happens to no longer match the
101 current search. (Perhaps add a --matching=<secondary-search-terms>
102 option (or similar) to "notmuch show".) For now, this is being worked
103 around in the emacs interface by noticing that "notmuch show" returns
104 nothing and re-rerunning the command without the extra arguments.
105
106 Add a "--format" option to "notmuch search", (something printf-like
107 for selecting what gets printed).
108
109 Give "notmuch restore" some progress indicator.
110
111 Fix "notmuch restore" to operate in a single pass much like "notmuch
112 dump" does, rather than doing N searches into the database, each
113 matching 1/N messages.
114
115 Add a "-f <filename>" option to select an alternate configuration
116 file.
117
118 Allow configuration for filename patterns that should be ignored when
119 indexing.
120
121 Fix to avoid this ugly message:
122
123         (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed
124         Warning: Not indexing empty mime part.
125
126   This probably means adding a test case to generate that message,
127   filing an upstream bug against GMime, and then silencing the
128   notmuch-generated portion of the warning (so that once GMime is
129   fixed, this is all silent).
130
131 Simplify notmuch-reply to simply print the headers (we have the
132 original values) rather than calling GMime (which encodes) and adding
133 the confusing gmime-filter-headers.c code (which decodes).
134
135 Properly handle replying to multiple messages. Currently, the JSON
136 reply format only supports a single message, but the default reply
137 format accepts searches returning multiple messages. The expected
138 behavior of replying to multiple messages is not obvious, and there
139 are multiple ideas that might make sense. Some consensus needs to be
140 reached on this issue, and then both reply formats should be updated
141 to be consistent.
142
143 notmuch library
144 ---------------
145 Add support for custom flag<->tag mappings. In the notmuch
146 configuration file this could be
147
148         [maildir]
149         synchronize_flags = R:replied; D*:deleted; S:~unread;
150
151 In the library interface this could be implemented with an array of
152 structures to define the mapping (flag character, tag name,
153 inverse-sense bit (~ above), and tag-when-any-file-flagged
154 vs. tag-when-all-files-flagged (* above)).
155
156 Add an interface to accept a "key" and a byte stream, rather than a
157 filename.
158
159 Provide a sane syntax for date ranges. First, we don't want to require
160 both endpoints to be specified. For example it would be nice to be
161 able to say things like "since:2009-01-1" or "until:2009-01-1" and
162 have the other endpoint be implicit. Second we'd like to support
163 relative specifications of time such as "since:'2 months ago'". To do
164 any of this we're probably going to need to break down an write our
165 own parser for the query string rather than using Xapian's QueryParser
166 class.
167
168 Make failure to read a file (such as a permissions problem) a warning
169 rather than an error (should be similar to the existing warning for a
170 non-mail file).
171
172 Fix to use the *last* Message-ID header if multiple such headers are
173 encountered, (I noticed this is one thing that kept me from seeing the
174 same message-ID values as sup).
175
176 Add support for configuring "virtual tags" which are a tuple of
177 (tag-name, search-specification). The database is responsible for
178 ensuring that the virtual tag is always consistent.
179
180 Indicate to the user if two files with the same message ID have
181 content that is actually different in some interesting way. Perhaps
182 notmuch initially sees all changes as interesting, and quickly learns
183 from the user which changes are not interesting (such as the very
184 common mailing-list footer).
185
186 Fix notmuch_query_count_messages to share code with
187 notmuch_query_search_messages rather than duplicating code. (And
188 consider renaming it as well.)
189
190 Provide a mechanism for doing automatic address completion based on
191 notmuch searches. Here was one proposal made in IRC:
192
193         <cworth> I guess all it would really have to be would be a way
194                  to configure a series of searches to try in turn,
195                  (presenting ambiguities at a given single level, and
196                  advancing to the next level only if one level
197                  returned no matches).
198         <cworth> So then I might have a series that looks like this:
199         <cworth> notmuch search --output=address_from tag:address_book_alias
200         <cworth> notmuch search --output=address_to tag:sent
201         <cworth> notmuch search --output=address_from
202         <cworth> I think I might like that quite a bit.
203         <cworth> And then we have a story for an address book for
204                  non-emacs users.
205
206 Provide a ~me Xapian synonym for all of the user's configured email
207 addresses.
208
209 Add symbol hiding so that we don't risk leaking any private symbols
210 into the shared-library interface.
211
212 Audit all libnotmuch entry points to ensure that all Xapian calls are
213 wrapped in a try/catch block.
214
215 Fix the "count" functionality to be exact as Olly explained in IRC:
216
217         ojwb> cworth: if you set the check_at_least parameter to the
218         database size, get_matches_estimated() will be exact
219
220 Fix the threading of a message that has a References: header but no
221 In-Reply-To: header (see id:"87lixxnxpb.fsf@yoom.home.cworth.org").
222
223 Search syntax
224 -------------
225 Implement support for "tag:*" to expand to all tags.
226
227 Fix "notmuch search to:" to be less confusing. Many users expect this
228 to search for all messages with a To: header, but it instead searches
229 for all messages with the word "to". If we don't provide the first
230 behavior, perhaps we should exit on an error when a configured prefix
231 is provided with no value?
232
233 Support "*" in all cases and not just as a special case. That is, "* "
234 should also work, as well as "* and tag:inbox".
235
236 Implement a syntax for requesting set-theoertic operations on results
237 of multiple searches. For example, I would like to do:
238
239         "tag:inbox" SET-SUBTRACT "tag:muted"
240
241     as well as:
242
243         "tag:notmuch and <date-range>" SET-INTERSECT
244         "tag:notmuch and not (tag:merged or tag:postponed)"
245
246     See id:3wdpr282yz2.fsf@testarossa.amd.com for more details on the
247     use cases of the above.
248
249 Database changes
250 ----------------
251 Store a reference term for every message-id that appears in
252 References. We just started doing this for newly-added documents, but
253 at the next convenient database-schema upgrade, we should go back and
254 fix old messages to be consistent.
255
256 Start indexing the List-Id header, (and re-index this header for
257 existing messages at the next database upgrade).
258
259 Add support for the user to specify custom headers to be indexed (and
260 re-index these for existing messages at the next database upgrade).
261
262 Save filenames for files detected as "not an email file" in the
263 database. This would allow for two things: 1. Optimizing "notmuch new"
264 to not have to look at these files again (since they are potentially
265 large so the detection could be potentially slow). 2. A "notmuch
266 search" syntax could be added to allow the user to find these files,
267 (and perhaps delete them or move them away as appropriate).
268
269 Fix filesystem/notmuch-new race condition by not updating database
270 mtime for a directory if it is the same as the current mtime.
271
272 Test suite
273 ----------
274 Achieve 100% test coverage with the test suite.
275
276 General
277 -------
278 Audit everything for dealing with out-of-memory (and drop xutil.c).
279
280 Investigate why the notmuch database is slightly larger than the sup
281 database for the same corpus of email.
282
283 Makefile should print message teaching user about LD_LIBRARY_PATH (or
284 similar) if libdir is not set to a directory examined by ldconfig.