notmuch show: Preserve thread-ordering and nesting without --entire-thread
[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 Make the keybindings help ('?') display the summary of each command's
12 documentation, not the function name.
13
14 Add a global keybinding table for notmuch, and then view-specific
15 tables that add to it.
16
17 Add a command to archive all threads in a search view.
18         
19 Add a '|' binding from the search view.
20
21 Add a binding to run a search from notmuch-show-mode.
22
23 When a thread has been entirely read, start out by closing all
24 messages except those that matched the search terms.
25
26 Add support for choosing from one of the user's configured email
27 addresses for the From line.
28
29 Make 'notmuch-show-pipe-message have a private history.
30
31 Add support for a delete keybinding that adds a "deleted" tag to the
32 current message/thread and make searches not return deleted messages
33 by default, (unless the user asks explicitly for deleted messags in
34 the search query).
35
36 Add support to "mute" a thread (add a "muted" tag and then don't
37 display threads in searches by default where any message of the thread
38 has the "muted" tag).
39
40 Portability
41 -----------
42 Fix configure script to test each compiler warning we want to use.
43
44 Completion
45 ----------
46 Fix bash completion to complete multiple search options (both --first
47 and *then* --max-threads), and also complete value for --sort=
48 (oldest-first or newest-first).
49
50 notmuch command-line tool
51 -------------------------
52 Teach "notmuch search" to return many different kinds of results. Some
53 ideas:
54
55         notmuch search --for threads    # Default if no --for is given
56         notmuch search --for messages
57         notmuch search --for tags
58         notmuch search --for addresses
59         notmuch search --for terms
60
61 Add a "--format" option to "notmuch search", (something printf-like
62 for selecting what gets printed).
63
64 Add a "--count-only" (or so?) option to "notmuch search" for returning
65 the count of search results.
66
67 Give "notmuch restore" some progress indicator. Until we get the
68 Xapian bugs fixed that are making this operation slow, we really need
69 to let the user know that things are still moving.
70
71 Add a "-f <filename>" option to select an alternate configuration
72 file.
73
74 Fix notmuch.c to call add_timestamp/get_timestamp with path names
75 relative to the database path. (Otherwise, moving the database to a
76 new directory will result in notmuch creating new timestamp documents
77 and leaving stale ones behind.)
78
79 Ensure that "notmuch new" is sane if its first, giant indexing session
80 gets interrupted, (that is, ensure that any results indexed so far are
81 flushed).
82
83 Fix notmuch.c to use a DIR prefix for directory timestamps, (the idea
84 being that it can then add other non-directory timestamps such as for
85 noting how far back in the past mail has been indexed, and whether it
86 needs to re-tag messages based on a theoretical "auto-tags"
87 configuration file).
88
89 Make "notmuch new" notice when a mail directory has gone more than a
90 month without receiving new mail and use that to trigger the printing
91 of the note that the user might want to mark the directory read-only.
92
93 Also make "notmuch new" optionally able to just mark those month-old
94 directories read-only on its own. (Could conflict with low-volume
95 lists such as announce lists if they are setup to deliver to their own
96 maildirs.)
97
98 Allow configuration for filename patterns that should be ignored when
99 indexing.
100
101 notmuch library
102 ---------------
103 Provide a sane syntax for date ranges. First, we don't want to require
104 both endpoints to be specified. For example it would be nice to be
105 able to say things like "since:2009-01-1" or "until:2009-01-1" and
106 have the other enpoint be implicit. Second we'de like to support
107 relative specifications of time such as "since:'2 months ago'". To do
108 any of this we're probably going to need to break down an write our
109 own parser for the query string rather than using Xapian's QueryParser
110 class.
111
112 Make failure to read a file (such as a permissions problem) a warning
113 rather than an error (should be similar to the existing warning for a
114 non-mail file).
115
116 Add support for files that are moved or deleted (which obviously need
117 to be handled differently).
118
119 Actually compile and install a libnotmuch shared library.
120
121 Fix to use the *last* Message-ID header if multiple such headers are
122 encountered, (I noticed this is one thing that kept me from seeing the
123 same message-ID values as sup).
124
125 Add support for the user to specify custom headers to be indexed.
126
127 Add support for configuring "virtual tags" which are a tuple of
128 (tag-name, search-specification). The database is responsible for
129 ensuring that the virtual tag is always consistent.
130
131 Think about optimizing chunked searches (max-threads > 0) to avoid
132 repeating work. That would be saving state from the previous chunk and
133 reusing it if the next search is the next chunk with the same search
134 string.
135
136 General
137 -------
138 Audit everything for dealing with out-of-memory (and drop xutil.c).
139
140 Write a test suite.
141
142 Achieve 100% test coverage with the test suite.
143
144 Investigate why the notmuch database is slightly larger than the sup
145 database for the same corpus of email.
146
147 Xapian
148 ------
149 Fix defect #250
150
151         replace_document should make minimal changes to database file
152         http://trac.xapian.org/ticket/250
153
154         It looks like it's going to be easy to fix. Here's the file to
155         change:
156
157                 xapian-core/backends/flint/flint_database.cc
158
159         And look for:
160
161           // FIXME - in the case where there is overlap between the new
162           // termlist and the old termlist, it would be better to compare the
163           // two lists, and make the minimum set of modifications required.
164           // This would lead to smaller changesets for replication, and
165           // probably be faster overall
166
167         So I think this might be as easy as just walking over two
168         sorted lists looking for differences.
169
170         Note that this is in the currently default "flint" backend,
171         but the Xapian folks are probably more interested in fixing
172         the in-development "chert" backend. So the patch to get
173         upstreamed there will probably also fix:
174
175                 xapian-core/backends/chert/chert_database.cc
176
177         (I'm hoping the fix will be the same---an identical comment
178         exists there.)
179
180         Also, if you want to experiment with the chert backend,
181         compile current Xapian source and run notmuch with
182         XAPIAN_PREFER_CHERT=1. I haven't tried that yet, but there are
183         claims that a chert database can be 40% smaller than an
184         equivalent flint database.
185
186 Report this bug:
187
188         "tag:foo and tag:bar and -tag:deleted" goes insane
189
190         This seems to be triggered by a Boolean operator next to a
191         token starting with a non-word character---suddenly all the
192         Boolean operators get treated as literal tokens)