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