emacs/notmuch-show.el: Avoid passing unintended format strings to `message'
[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 Emacs interface (notmuch.el)
8 ----------------------------
9 Enhance '+' and '-' in the search view to operate on an entire region
10 if set.
11
12 Fix '*' to work by simply calling '+' or '-' on a region consisting of
13 the entire buffer.
14
15 Add a global keybinding table for notmuch, and then view-specific
16 tables that add to it.
17         
18 Add a '|' binding from the search view.
19
20 Add support for choosing from one of the user's configured email
21 addresses for the From line.
22
23 Make 'notmuch-show-pipe-message have a private history.
24
25 Add support for a delete keybinding that adds a "deleted" tag to the
26 current message/thread and make searches not return deleted messages
27 by default, (unless the user asks explicitly for deleted messags in
28 the search query).
29
30 Add support to "mute" a thread (add a "muted" tag and then don't
31 display threads in searches by default where any message of the thread
32 has the "muted" tag).
33
34 Fix i-search to open up invisible citations as necessary.
35
36 Make '=' count from the end rather than from the beginning if more
37 than half-way through the buffer.
38
39 Fix to automatically wrap long headers (for RFC compliance) before
40 sending. This should probably just be fixed in message-mode itself,
41 (but perhaps we can have a notmuch-message-mode that layers this on
42 top).
43
44 Implement Fcc and use it for all messages, (whether a new composition,
45 a reply, or a forward). This again may require a notmuch-message-mode
46 that extends message-mode.
47
48 Stop hiding the headers so much in the thread-view mode.
49
50 Allow opening a message in thread-view mode by clicking on either
51 line.
52
53 Automatically open a message when navigating to it with N or P.
54
55 Change 'a' command in thread-view mode to only archive open messages.
56
57 Add a binding to open all closed messages.
58
59 Emacs saved-search interface
60 ----------------------------
61 Here's a proposal Carl wrote (id:87einafy4u.fsf@yoom.home.cworth.org):
62
63   So what I'm imagining for the default notmuch view is something like
64   this:
65
66           Welcome to notmuch.
67
68               Notmuch search: _________________________________________
69
70           Saved searches:
71
72               55,342      All messages
73                   22      Inbox
74
75           Recent searches:
76
77                    1      from:"someone special" and tag:unread
78                   34      tag:notmuch and tag:todo
79
80           Click (or press Enter) on any search to see the results.
81           Right-click (or press Space) on any recent search to save it.
82
83   So the "saved searches" portion of the view is basically just what
84   notmuch-folder displays now. Above that there's an obvious place to
85   start a new search, (in a slightly more "web-browser-like" way than the
86   typical mini-buffer approach).
87
88   All recent searches appear in the list at the bottom automatically, and
89   there's the documented mechanism for saving a search, (giving it a name
90   and having it appear above).
91
92 Portability
93 -----------
94 Fix configure script to test each compiler warning we want to use.
95
96 Completion
97 ----------
98 Fix bash completion to complete multiple search options (both --first
99 and *then* --max-threads), and also complete value for --sort=
100 (oldest-first or newest-first).
101
102 notmuch command-line tool
103 -------------------------
104 Fix the --format=json option to not imply --entire-thread.
105
106 Implement "notmuch search --exclude-threads=<search-terms>" to allow
107 for excluding muted threads, (and any other negative, thread-based
108 filtering that the user wants to do).
109
110 Fix "notmuch show" so that the UI doesn't fail to show a thread that
111 is visible in a search buffer, but happens to no longer match the
112 current search. (Perhaps add a --matching=<secondary-search-terms>
113 option (or similar) to "notmuch show".) For now, this is being worked
114 around in the emacs interface by noticing that "notmuch show" returns
115 nothing and re-rerunning the command without the extra arguments.
116
117 Teach "notmuch search" to return many different kinds of results. Some
118 ideas:
119
120         notmuch search --output=threads # Default if no --output is given
121         notmuch search --output=messages
122         notmuch search --output=tags
123         notmuch search --output=addresses
124         notmuch search --output=terms
125
126 Add a "--format" option to "notmuch search", (something printf-like
127 for selecting what gets printed).
128
129 Add a "--count-only" (or so?) option to "notmuch search" for returning
130 the count of search results.
131
132 Give "notmuch restore" some progress indicator.
133
134 Fix "notmuch restore" to operate in a single pass much like "notmuch
135 dump" does, rather than doing N searches into the database, each
136 matching 1/N messages.
137
138 Add a "-f <filename>" option to select an alternate configuration
139 file.
140
141 Allow configuration for filename patterns that should be ignored when
142 indexing.
143
144 Replace the "notmuch part --part=id" command with "notmuch show
145 --part=id", (David Edmonson wants to rewrite some of "notmuch show" to
146 provide more MIME-structure information in its output first).
147
148 Replace the "notmuch search-tags" command with "notmuch search
149 --output=tags".
150
151 Fix to avoid this ugly message:
152
153         (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed
154         Warning: Not indexing empty mime part.
155
156   This probably means adding a test case to generate that message,
157   filing an upstream bug against GMime, and then silencing the
158   notmuch-generated portion of the warning (so that once GMime is
159   fixed, this is all silent).
160
161 Simplify notmuch-reply to simply print the headers (we have the
162 original values) rather than calling GMime (which encodes) and adding
163 the confusing gmime-filter-headers.c code (which decodes).
164
165 notmuch library
166 ---------------
167 Add an interface to accept a "key" and a byte stream, rather than a
168 filename.
169
170 Provide a sane syntax for date ranges. First, we don't want to require
171 both endpoints to be specified. For example it would be nice to be
172 able to say things like "since:2009-01-1" or "until:2009-01-1" and
173 have the other endpoint be implicit. Second we'd like to support
174 relative specifications of time such as "since:'2 months ago'". To do
175 any of this we're probably going to need to break down an write our
176 own parser for the query string rather than using Xapian's QueryParser
177 class.
178
179 Make failure to read a file (such as a permissions problem) a warning
180 rather than an error (should be similar to the existing warning for a
181 non-mail file).
182
183 Actually compile and install a libnotmuch shared library.
184
185 Fix to use the *last* Message-ID header if multiple such headers are
186 encountered, (I noticed this is one thing that kept me from seeing the
187 same message-ID values as sup).
188
189 Add support for configuring "virtual tags" which are a tuple of
190 (tag-name, search-specification). The database is responsible for
191 ensuring that the virtual tag is always consistent.
192
193 Indicate to the user if two files with the same message ID have
194 content that is actually different in some interesting way. Perhaps
195 notmuch initially sees all changes as interesting, and quickly learns
196 from the user which changes are not interesting (such as the very
197 common mailing-list footer).
198
199 Fix notmuch_query_count_messages to share code with
200 notmuch_query_search_messages rather than duplicating code. (And
201 consider renaming it as well.)
202
203 Provide a mechanism for doing automatic address completion based on
204 notmuch searches. Here was one proposal made in IRC:
205
206         <cworth> I guess all it would really have to be would be a way
207                  to configure a series of searches to try in turn,
208                  (presenting ambiguities at a given single level, and
209                  advancing to the next level only if one level
210                  returned no matches).
211         <cworth> So then I might have a series that looks like this:
212         <cworth> notmuch search --output=address_from tag:address_book_alias
213         <cworth> notmuch search --output=address_to tag:sent
214         <cworth> notmuch search --output=address_from
215         <cworth> I think I might like that quite a bit.
216         <cworth> And then we have a story for an address book for
217                  non-emacs users.
218
219 Provide a ~me Xapian synonym for all of the user's configured email
220 addresses.
221
222 Add symbol hiding so that we don't risk leaking any private symbols
223 into the shared-library interface.
224
225 Audit all libnotmuch entry points to ensure that all Xapian calls are
226 wrapped in a try/catch block.
227
228 Search syntax
229 -------------
230 Implement support for "tag:*" to expand to all tags.
231
232 Fix "notmuch search to:" to be less confusing. Many users expect this
233 to search for all messages with a To: header, but it instead searches
234 for all messages with the word "to". If we don't provide the first
235 behavior, perhaps we should exit on an error when a configured prefix
236 is provided with no value?
237
238 Support "*" in all cases and not just as a special case. That is, "* "
239 should also work, as well as "* and tag:inbox".
240
241 Implement a syntax for requesting set-theoertic operations on results
242 of multiple searches. For example, I would like to do:
243
244         "tag:inbox" SET-SUBTRACT "tag:muted"
245
246     as well as:
247
248         "tag:notmuch and <date-range>" SET-INTERSECT
249         "tag:notmuch and not (tag:merged or tag:postponed)"
250
251     See id:3wdpr282yz2.fsf@testarossa.amd.com for more details on the
252     use cases of the above.
253
254 Database changes
255 ----------------
256 Store a reference term for every message-id that appears in
257 References. We just started doing this for newly-added documents, but
258 at the next convenient database-schema upgrade, we should go back and
259 fix old messages to be consistent.
260
261 Start indexing the List-Id header, (and re-index this header for
262 existing messages at the next database upgrade).
263
264 Start indexing the message file's directory ana make it available for
265 search as "folder:" (and re-index this value for existing messages at
266 the next database upgrade).
267
268 Add support for the user to specify custom headers to be indexed (and
269 re-index these for existing messages at the next database upgrade).
270
271 Test suite
272 ----------
273 Start testing --format=json.
274
275 Achieve 100% test coverage with the test suite.
276
277 Modularize test suite (to be able to run individual tests).
278
279 Summarize test results at the end.
280
281 Fix the insane quoting nightmare of the test suite, (and once we do
282 that we can actually test the implicit-phrase search feature such as
283 "notmuch search 'body search (phrase)'"
284
285 Test "notmuch reply" choosing the correct email address from the
286 Received header when no configured email address appears in To or Cc.
287
288 General
289 -------
290 Audit everything for dealing with out-of-memory (and drop xutil.c).
291
292 Investigate why the notmuch database is slightly larger than the sup
293 database for the same corpus of email.