X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=TODO;h=260ffe18b37c778fcb7b13325f78547e76257aaa;hp=b85d33102f17e5d0fe536696acd62e325181121a;hb=d2177d0b22a95989dee4f46a1b2cca68484a2ce3;hpb=369b44103d5fb5db6c3915dc45de83588395c1b9 diff --git a/TODO b/TODO index b85d3310..260ffe18 100644 --- a/TODO +++ b/TODO @@ -2,35 +2,26 @@ Fix the things that are causing the most pain to new users ---------------------------------------------------------- 1. A new import is tagging all messages as "inbox" -- total pain -2. Allow an easy way to get tags from directory names (if the user has them) - -3. Allow an easy way to remove excess tags, (date-based search) - -4. Make emacs fast for big search results (see "lazy searching" below) - -5. Fix Xapian defect #250 so tagging is fast. - Emacs interface (notmuch.el) ---------------------------- -Make the keybindings help ('?') display the summary of each command's -documentation, not the function name. - -Add a global keybinding table for notmuch, and then view-specific -tables that add to it. +Add notmuch-bcc and notmuch-cc for setting default Bcc and Cc values, +(should affect the message-setup-hook). -Add a command to archive all threads in a search view. +Switch the notmuch-search view to use "notmuch search --format=json" +to fix large classes of bugs regarding poorly-escaped output and lame +regular expressions. (The most recently found, unfixed example is the +sender's name containing ';' which causes emacs to drop a search +result.) This may require removing the outer array from the current +"notmuch search --format=json" results. -Lazy searching: call "notmuch search" with --first and --max to fill -just a screenful of results, and then fill in more as ther user pages -through the buffer. +Fix '*' to work by simply calling '+' or '-' on a region consisting of +the entire buffer. +Add a global keybinding table for notmuch, and then view-specific +tables that add to it. + Add a '|' binding from the search view. -Add a binding to run a search from notmuch-show-mode. - -When a thread has been entirely read, start out by closing all -messages except those that matched the search terms. - Add support for choosing from one of the user's configured email addresses for the From line. @@ -41,17 +32,33 @@ current message/thread and make searches not return deleted messages by default, (unless the user asks explicitly for deleted messags in the search query). +Add keybindings for next/previous thread. + Add support to "mute" a thread (add a "muted" tag and then don't display threads in searches by default where any message of the thread has the "muted" tag). -Portability ------------ -Fix configure script to test each compiler warning we want to use. +Make '=' count from the end rather than from the beginning if more +than half-way through the buffer. + +Fix to automatically wrap long headers (for RFC compliance) before +sending. This should probably just be fixed in message-mode itself, +(but perhaps we can have a notmuch-message-mode that layers this on +top). -Implement strndup locally (or call talloc_strndup instead). +Stop hiding the headers so much in the thread-view mode. -Implement getline locally, (look at gnulib). +Allow opening a message in thread-view mode by clicking on either +line. + +Automatically open a message when navigating to it with N or P. + +Change 'a' command in thread-view mode to only archive open messages. + +Add a binding to open all closed messages. + +Change the 'a'rchive command in the thread view to only archive open +messages. Completion ---------- @@ -61,123 +68,213 @@ and *then* --max-threads), and also complete value for --sort= notmuch command-line tool ------------------------- -Teach "notmuch search" to return many different kinds of results. Some -ideas: +Add support to "notmuch search" and "notmuch show" to allow for +listing of duplicate messages, (distinct filenames with the same +Message-ID). I'm not sure what the option should be named. Perhaps +--with-duplicates ? + +Add a -0 option to "notmuch search" so that one can safely deal with +any filename with: + + notmuch search --output=files -0 | xargs -0 + +"notmuch setup" should use realpath() before replacing the +configuration file. The ensures that the final target file of any +intermediate symbolic links is what is actually replaced, (rather than +any symbolic link). - notmuch search --for threads # Default if no --for is given - notmuch search --for messages - notmuch search --for tags - notmuch search --for addresses - notmuch search --for terms +Replace "notmuch reply" with "notmuch compose --reply ". +This would enable a plain "notmuch compose" to be used to construct an +initial message, (which would then have the properly configured name +and email address in the From: line. We could also then easily support +"notmuch compose --from " to support getting at alternate +email addresses. + +Fix the --format=json option to not imply --entire-thread. + +Implement "notmuch search --exclude-threads=" to allow +for excluding muted threads, (and any other negative, thread-based +filtering that the user wants to do). + +Fix "notmuch show" so that the UI doesn't fail to show a thread that +is visible in a search buffer, but happens to no longer match the +current search. (Perhaps add a --matching= +option (or similar) to "notmuch show".) For now, this is being worked +around in the emacs interface by noticing that "notmuch show" returns +nothing and re-rerunning the command without the extra arguments. Add a "--format" option to "notmuch search", (something printf-like for selecting what gets printed). -Add a "--count-only" (or so?) option to "notmuch search" for returning -the count of search results. +Give "notmuch restore" some progress indicator. -Give "notmuch restore" some progress indicator. Until we get the -Xapian bugs fixed that are making this operation slow, we really need -to let the user know that things are still moving. +Fix "notmuch restore" to operate in a single pass much like "notmuch +dump" does, rather than doing N searches into the database, each +matching 1/N messages. Add a "-f " option to select an alternate configuration file. -Fix notmuch.c to call add_timestamp/get_timestamp with path names -relative to the database path. (Otherwise, moving the database to a -new directory will result in notmuch creating new timestamp documents -and leaving stale ones behind.) +Allow configuration for filename patterns that should be ignored when +indexing. -Ensure that "notmuch new" is sane if its first, giant indexing session -gets interrupted, (that is, ensure that any results indexed so far are -flushed). +Replace the "notmuch part --part=id" command with "notmuch show +--part=id", (David Edmonson wants to rewrite some of "notmuch show" to +provide more MIME-structure information in its output first). -Fix notmuch.c to use a DIR prefix for directory timestamps, (the idea -being that it can then add other non-directory timestamps such as for -noting how far back in the past mail has been indexed, and whether it -needs to re-tag messages based on a theoretical "auto-tags" -configuration file). +Replace the "notmuch search-tags" command with "notmuch search +--output=tags". -Make "notmuch new" notice when a mail directory has gone more than a -month without receiving new mail and use that to trigger the printing -of the note that the user might want to mark the directory read-only. +Fix to avoid this ugly message: -Also make "notmuch new" optionally able to just mark those month-old -directories read-only on its own. (Could conflict with low-volume -lists such as announce lists if they are setup to deliver to their own -maildirs.) + (process:17197): gmime-CRITICAL **: g_mime_message_get_mime_part: assertion `GMIME_IS_MESSAGE (message)' failed + Warning: Not indexing empty mime part. + + This probably means adding a test case to generate that message, + filing an upstream bug against GMime, and then silencing the + notmuch-generated portion of the warning (so that once GMime is + fixed, this is all silent). + +Simplify notmuch-reply to simply print the headers (we have the +original values) rather than calling GMime (which encodes) and adding +the confusing gmime-filter-headers.c code (which decodes). notmuch library --------------- -Add support for files that are moved or deleted (which obviously need -to be handled differently). +Add support for custom flag<->tag mappings. In the notmuch +configuration file this could be + + [maildir] + synchronize_flags = R:replied; D*:deleted; S:~unread; -Actually compile and install a libnotmuch shared library. +In the library interface this could be implemented with an array of +structures to define the mapping (flag character, tag name, +inverse-sense bit (~ above), and tag-when-any-file-flagged +vs. tag-when-all-files-flagged (* above)). + +Add an interface to accept a "key" and a byte stream, rather than a +filename. + +Provide a sane syntax for date ranges. First, we don't want to require +both endpoints to be specified. For example it would be nice to be +able to say things like "since:2009-01-1" or "until:2009-01-1" and +have the other endpoint be implicit. Second we'd like to support +relative specifications of time such as "since:'2 months ago'". To do +any of this we're probably going to need to break down an write our +own parser for the query string rather than using Xapian's QueryParser +class. + +Make failure to read a file (such as a permissions problem) a warning +rather than an error (should be similar to the existing warning for a +non-mail file). Fix to use the *last* Message-ID header if multiple such headers are encountered, (I noticed this is one thing that kept me from seeing the same message-ID values as sup). -Add support for the user to specify custom headers to be indexed. - Add support for configuring "virtual tags" which are a tuple of (tag-name, search-specification). The database is responsible for ensuring that the virtual tag is always consistent. -General -------- -Audit everything for dealing with out-of-memory (and drop xutil.c). +Indicate to the user if two files with the same message ID have +content that is actually different in some interesting way. Perhaps +notmuch initially sees all changes as interesting, and quickly learns +from the user which changes are not interesting (such as the very +common mailing-list footer). -Write a test suite. +Fix notmuch_query_count_messages to share code with +notmuch_query_search_messages rather than duplicating code. (And +consider renaming it as well.) -Achieve 100% test coverage with the test suite. +Provide a mechanism for doing automatic address completion based on +notmuch searches. Here was one proposal made in IRC: -Investigate why the notmuch database is slightly larger than the sup -database for the same corpus of email. + I guess all it would really have to be would be a way + to configure a series of searches to try in turn, + (presenting ambiguities at a given single level, and + advancing to the next level only if one level + returned no matches). + So then I might have a series that looks like this: + notmuch search --output=address_from tag:address_book_alias + notmuch search --output=address_to tag:sent + notmuch search --output=address_from + I think I might like that quite a bit. + And then we have a story for an address book for + non-emacs users. + +Provide a ~me Xapian synonym for all of the user's configured email +addresses. + +Add symbol hiding so that we don't risk leaking any private symbols +into the shared-library interface. + +Audit all libnotmuch entry points to ensure that all Xapian calls are +wrapped in a try/catch block. -Xapian ------- -Fix defect #250 +Fix the "count" functionality to be exact as Olly explained in IRC: - replace_document should make minimal changes to database file - http://trac.xapian.org/ticket/250 + ojwb> cworth: if you set the check_at_least parameter to the + database size, get_matches_estimated() will be exact - It looks like it's going to be easy to fix. Here's the file to - change: +Fix the threading of a message that has a References: header but no +In-Reply-To: header (see id:"87lixxnxpb.fsf@yoom.home.cworth.org"). - xapian-core/backends/flint/flint_database.cc +Search syntax +------------- +Implement support for "tag:*" to expand to all tags. - And look for: +Fix "notmuch search to:" to be less confusing. Many users expect this +to search for all messages with a To: header, but it instead searches +for all messages with the word "to". If we don't provide the first +behavior, perhaps we should exit on an error when a configured prefix +is provided with no value? - // FIXME - in the case where there is overlap between the new - // termlist and the old termlist, it would be better to compare the - // two lists, and make the minimum set of modifications required. - // This would lead to smaller changesets for replication, and - // probably be faster overall +Support "*" in all cases and not just as a special case. That is, "* " +should also work, as well as "* and tag:inbox". - So I think this might be as easy as just walking over two - sorted lists looking for differences. +Implement a syntax for requesting set-theoertic operations on results +of multiple searches. For example, I would like to do: - Note that this is in the currently default "flint" backend, - but the Xapian folks are probably more interested in fixing - the in-development "chert" backend. So the patch to get - upstreamed there will probably also fix: + "tag:inbox" SET-SUBTRACT "tag:muted" - xapian-core/backends/chert/chert_database.cc + as well as: - (I'm hoping the fix will be the same---an identical comment - exists there.) + "tag:notmuch and " SET-INTERSECT + "tag:notmuch and not (tag:merged or tag:postponed)" - Also, if you want to experiment with the chert backend, - compile current Xapian source and run notmuch with - XAPIAN_PREFER_CHERT=1. I haven't tried that yet, but there are - claims that a chert database can be 40% smaller than an - equivalent flint database. + See id:3wdpr282yz2.fsf@testarossa.amd.com for more details on the + use cases of the above. -Report this bug: +Database changes +---------------- +Store a reference term for every message-id that appears in +References. We just started doing this for newly-added documents, but +at the next convenient database-schema upgrade, we should go back and +fix old messages to be consistent. - "tag:foo and tag:bar and -tag:deleted" goes insane +Start indexing the List-Id header, (and re-index this header for +existing messages at the next database upgrade). + +Add support for the user to specify custom headers to be indexed (and +re-index these for existing messages at the next database upgrade). + +Save filenames for files detected as "not an email file" in the +database. This would allow for two things: 1. Optimizing "notmuch new" +to not have to look at these files again (since they are potentially +large so the detection could be potentially slow). 2. A "notmuch +search" syntax could be added to allow the user to find these files, +(and perhaps delete them or move them away as appropriate). + +Test suite +---------- +Achieve 100% test coverage with the test suite. + +General +------- +Audit everything for dealing with out-of-memory (and drop xutil.c). + +Investigate why the notmuch database is slightly larger than the sup +database for the same corpus of email. - This seems to be triggered by a Boolean operator next to a - token starting with a non-word character---suddenly all the - Boolean operators get treated as literal tokens) +Makefile should print message teaching user about LD_LIBRARY_PATH (or +similar) if libdir is not set to a directory examined by ldconfig.