debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-23 03:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/notmuch-search.c

927 lines
24 KiB
C
Raw Permalink Normal View History

notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
/* notmuch - Not much of an email program, (just index and search)
*
* Copyright © 2009 Carl Worth
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
Use https instead of http where possible Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-02 18:26:14 +02:00
* along with this program. If not, see https://www.gnu.org/licenses/ .
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
*
* Author: Carl Worth <cworth@cworth.org>
*/
#include "notmuch-client.h"
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
#include "sprinter.h"
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
#include "string-util.h"
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
typedef enum {
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
/* Search command */
cli: search: Convert --output to keyword-flag argument This converts "notmuch search" to use the recently introduced keyword-flag argument parser. At this point, it only makes the code slightly less readable but following commits that add new --output keywords will profit from this.
2014-10-31 22:53:57 +01:00
OUTPUT_SUMMARY = 1 << 0,
OUTPUT_THREADS = 1 << 1,
OUTPUT_MESSAGES = 1 << 2,
OUTPUT_FILES = 1 << 3,
OUTPUT_TAGS = 1 << 4,
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
/* Address command */
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
OUTPUT_SENDER = 1 << 5,
OUTPUT_RECIPIENTS = 1 << 6,
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
OUTPUT_COUNT = 1 << 7,
cli: add support for only printing the addresses in notmuch address The notmuch address output is much more useful for scripts with just the addresses printed. Support this using the --output=address option.
2017-11-02 19:44:59 +01:00
OUTPUT_ADDRESS = 1 << 8,
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
} output_t;
cli: add support for not deduplicating notmuch address results Make it possible to use notmuch address as part of a | sort | uniq -c pipe instead of forcing --output=count. This is useful for combining results from multiple notmuch address queries.
2015-09-03 21:39:59 +02:00
typedef enum {
DEDUP_NONE,
DEDUP_MAILBOX,
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
DEDUP_ADDRESS,
cli: add support for not deduplicating notmuch address results Make it possible to use notmuch address as part of a | sort | uniq -c pipe instead of forcing --output=count. This is useful for combining results from multiple notmuch address queries.
2015-09-03 21:39:59 +02:00
} dedup_t;
cli: search: Move more variables into search_context_t In order to share some command line options between search and address subcommands we need to add corresponding variables to the context structure. While we are at it, we also add notmuch_database_t to unify parameters of all do_search_* functions and to simplify subsequent commits. Otherwise, there are no functional changes.
2014-11-05 01:25:51 +01:00
typedef enum {
NOTMUCH_FORMAT_JSON,
NOTMUCH_FORMAT_TEXT,
NOTMUCH_FORMAT_TEXT0,
NOTMUCH_FORMAT_SEXP
} format_sel_t;
cli: search: Refactor passing of command line options Many functions that implement the search command need to access command line options. Instead of passing each option in a separate variable, put them in a structure and pass only this structure. This will become handy in the following commits.
2014-10-31 22:53:55 +01:00
typedef struct {
cli: search: Move more variables into search_context_t In order to share some command line options between search and address subcommands we need to add corresponding variables to the context structure. While we are at it, we also add notmuch_database_t to unify parameters of all do_search_* functions and to simplify subsequent commits. Otherwise, there are no functional changes.
2014-11-05 01:25:51 +01:00
notmuch_database_t *notmuch;
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
void *talloc_ctx;
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
int format_sel;
cli: search: Refactor passing of command line options Many functions that implement the search command need to access command line options. Instead of passing each option in a separate variable, put them in a structure and pass only this structure. This will become handy in the following commits.
2014-10-31 22:53:55 +01:00
sprinter_t *format;
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
int exclude;
cli: search: Refactor passing of command line options Many functions that implement the search command need to access command line options. Instead of passing each option in a separate variable, put them in a structure and pass only this structure. This will become handy in the following commits.
2014-10-31 22:53:55 +01:00
notmuch_query_t *query;
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
int sort;
int output;
cli: search: Refactor passing of command line options Many functions that implement the search command need to access command line options. Instead of passing each option in a separate variable, put them in a structure and pass only this structure. This will become handy in the following commits.
2014-10-31 22:53:55 +01:00
int offset;
int limit;
int dupe;
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
GHashTable *addresses;
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
int dedup;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
} search_context_t;
cli: search: Refactor passing of command line options Many functions that implement the search command need to access command line options. Instead of passing each option in a separate variable, put them in a structure and pass only this structure. This will become handy in the following commits.
2014-10-31 22:53:55 +01:00
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
typedef struct {
const char *name;
const char *addr;
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
int count;
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
} mailbox_t;
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
/* Return two stable query strings that identify exactly the matched
* and unmatched messages currently in thread. If there are no
* matched or unmatched messages, the returned buffers will be
* NULL. */
static int
get_thread_query (notmuch_thread_t *thread,
char **matched_out, char **unmatched_out)
{
notmuch_messages_t *messages;
char *escaped = NULL;
size_t escaped_len = 0;
*matched_out = *unmatched_out = NULL;
for (messages = notmuch_thread_get_messages (thread);
notmuch_messages_valid (messages);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_messages_move_to_next (messages)) {
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
notmuch_message_t *message = notmuch_messages_get (messages);
const char *mid = notmuch_message_get_message_id (message);
cli/search: replace deprecated notmuch_message_get_flag Our handling of errors is all or nothing here, but it's an improvement on the status quo, and it avoids rippling internal API changes.
2020-07-11 20:30:04 +02:00
notmuch_bool_t is_set;
char **buf;
if (notmuch_message_get_flag_st (message, NOTMUCH_MESSAGE_FLAG_MATCH, &is_set))
return -1;
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
/* Determine which query buffer to extend */
cli/search: replace deprecated notmuch_message_get_flag Our handling of errors is all or nothing here, but it's an improvement on the status quo, and it avoids rippling internal API changes.
2020-07-11 20:30:04 +02:00
buf = is_set ? matched_out : unmatched_out;
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
/* Add this message's id: query. Since "id" is an exclusive
* prefix, it is implicitly 'or'd together, so we only need to
* join queries with a space. */
if (make_boolean_term (thread, "id", mid, &escaped, &escaped_len) < 0)
return -1;
if (*buf)
*buf = talloc_asprintf_append_buffer (*buf, " %s", escaped);
else
*buf = talloc_strdup (thread, escaped);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
if (! *buf)
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
return -1;
}
talloc_free (escaped);
return 0;
}
notmuch search: Fix to handle failure of notmuch_query_search_threads. Now that notmuch_query_search_threads can return NULL, (for example, due to a Xapian exception), we need to handle that case (rather than just segfault). It's simple enough to just return a non-zero exit code.
2010-10-23 02:57:02 +02:00
static int
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
do_search_threads (search_context_t *ctx)
notmuch search: Return first 100 results as quickly as possible. This is one of those cases where total time is not the metric of interest. We increase the total time of the search, (by doing some redundant work for the initial threads). But more significantly, we give the user *some* results nearly instantaneously, (so that the user might see the result of interest without ever even waiting for the complete results to come in).
2009-11-18 04:11:05 +01:00
{
notmuch_thread_t *thread;
notmuch_threads_t *threads;
notmuch_tags_t *tags;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
sprinter_t *format = ctx->format;
notmuch search: Return first 100 results as quickly as possible. This is one of those cases where total time is not the metric of interest. We increase the total time of the search, (by doing some redundant work for the initial threads). But more significantly, we give the user *some* results nearly instantaneously, (so that the user might see the result of interest without ever even waiting for the complete results to come in).
2009-11-18 04:11:05 +01:00
time_t date;
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
int i;
cli: convert remainder of CLI to n_q_search_{messages,threads}_st I think it would be no real problem to cut and paste the gdb based error message test from count to the other clients modified here, but I'm not currently convinced it's worth the trouble since the code path being tested is almost the the same, and the tests are relatively heavyweight.
2015-09-06 15:15:47 +02:00
notmuch_status_t status;
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->offset < 0) {
cli: update to use new count API Essentially replace each call to notmuch_count_* with the corresponding _st call, followed by print_status_query.
2015-09-27 17:31:58 +02:00
unsigned count;
notmuch_status_t status;
lib: replace deprecated n_q_count_threads with status returning version This function was deprecated in notmuch 0.21. We re-use the name for a status returning version, and deprecate the _st name.
2017-02-26 22:21:35 +01:00
status = notmuch_query_count_threads (ctx->query, &count);
cli: update to use new count API Essentially replace each call to notmuch_count_* with the corresponding _st call, followed by print_status_query.
2015-09-27 17:31:58 +02:00
if (print_status_query ("notmuch search", ctx->query, status))
return 1;
ctx->offset += count;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->offset < 0)
ctx->offset = 0;
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
}
Add an "--format=(json|text)" command-line option to both notmuch-search and notmuch-show. In the case of notmuch-show, "--format=json" also implies "--entire-thread" as the thread structure is implicit in the emitted document tree. As a coincidence to the implementation, multipart message ID numbers are now incremented with each part printed. This changes the previous semantics, which were unclear and not necessary related to the actual ordering of the message parts.
2009-12-31 16:17:40 +01:00
lib: replace n_query_search_threads with status returning version This function was deprecated in notmuch 0.21. We finally remove the deprecated API, and rename the status returning version to the simpler name. The status returning is kept as a deprecated alias.
2017-02-26 22:21:31 +01:00
status = notmuch_query_search_threads (ctx->query, &threads);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
if (print_status_query ("notmuch search", ctx->query, status))
notmuch search: Fix to handle failure of notmuch_query_search_threads. Now that notmuch_query_search_threads can return NULL, (for example, due to a Xapian exception), we need to handle that case (rather than just segfault). It's simple enough to just return a non-zero exit code.
2010-10-23 02:57:02 +02:00
return 1;
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->begin_list (format);
json: Fix search result with no matches to be a valid json object. In the original json code, search matching nothing would return a valid, empty json array (that is, "[]"). I broke this in commit 6dcb7592e32ed5140ea0c0357ce78d6a37af6066 when adding support for --output=threads|messages|tags. This time, while fixing the bug also add a test to the test suite to help avoid future regressions.
2011-01-30 20:26:04 +01:00
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
for (i = 0;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
notmuch_threads_valid (threads) && (ctx->limit < 0 || i < ctx->offset + ctx->limit);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_threads_move_to_next (threads), i++) {
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
thread = notmuch_threads_get (threads);
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (i < ctx->offset) {
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
notmuch_thread_destroy (thread);
continue;
}
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->output == OUTPUT_THREADS) {
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->set_prefix (format, "thread");
format->string (format,
notmuch_thread_get_thread_id (thread));
format->separator (format);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
} else { /* output == OUTPUT_SUMMARY */
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
void *ctx_quote = talloc_new (thread);
const char *authors = notmuch_thread_get_authors (thread);
const char *subject = notmuch_thread_get_subject (thread);
const char *thread_id = notmuch_thread_get_thread_id (thread);
int matched = notmuch_thread_get_matched_messages (thread);
cli/search: print total number of files matched in summary output. The structured output formats already have all of the filenames. This is an easy bit of UI change to make the multiple files visible.
2017-06-04 14:32:32 +02:00
int files = notmuch_thread_get_total_files (thread);
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
int total = notmuch_thread_get_total_messages (thread);
const char *relative_date = NULL;
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
bool first_tag = true;
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->begin_map (format);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->sort == NOTMUCH_SORT_OLDEST_FIRST)
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
date = notmuch_thread_get_oldest_date (thread);
else
date = notmuch_thread_get_newest_date (thread);
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
relative_date = notmuch_time_relative_date (ctx_quote, date);
if (format->is_text_printer) {
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
/* Special case for the text formatter */
cli/search: print total number of files matched in summary output. The structured output formats already have all of the filenames. This is an easy bit of UI change to make the multiple files visible.
2017-06-04 14:32:32 +02:00
printf ("thread:%s %12s ",
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
thread_id,
cli/search: print total number of files matched in summary output. The structured output formats already have all of the filenames. This is an easy bit of UI change to make the multiple files visible.
2017-06-04 14:32:32 +02:00
relative_date);
if (total == files)
printf ("[%d/%d] %s; %s (",
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
matched,
total,
sanitize_string (ctx_quote, authors),
sanitize_string (ctx_quote, subject));
cli/search: print total number of files matched in summary output. The structured output formats already have all of the filenames. This is an easy bit of UI change to make the multiple files visible.
2017-06-04 14:32:32 +02:00
else
printf ("[%d/%d(%d)] %s; %s (",
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
matched,
total,
files,
sanitize_string (ctx_quote, authors),
sanitize_string (ctx_quote, subject));
cli/search: print total number of files matched in summary output. The structured output formats already have all of the filenames. This is an easy bit of UI change to make the multiple files visible.
2017-06-04 14:32:32 +02:00
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
} else { /* Structured Output */
format->map_key (format, "thread");
format->string (format, thread_id);
format->map_key (format, "timestamp");
format->integer (format, date);
format->map_key (format, "date_relative");
format->string (format, relative_date);
format->map_key (format, "matched");
format->integer (format, matched);
format->map_key (format, "total");
format->integer (format, total);
format->map_key (format, "authors");
format->string (format, authors);
format->map_key (format, "subject");
format->string (format, subject);
search: Add stable queries to thread search results These queries will match exactly the set of messages currently in the thread, even if more messages later arrive. Two queries are provided: one for matched messages and one for unmatched messages. This can be used to fix race conditions with tagging threads from search results. While tagging based on a thread: query can affect messages that arrived after the search, tagging based on stable queries affects only the messages the user was shown in the search UI. Since we want clients to be able to depend on the presence of these queries, this ushers in schema version 2.
2013-10-24 17:19:08 +02:00
if (notmuch_format_version >= 2) {
char *matched_query, *unmatched_query;
if (get_thread_query (thread, &matched_query,
&unmatched_query) < 0) {
fprintf (stderr, "Out of memory\n");
return 1;
}
format->map_key (format, "query");
format->begin_list (format);
if (matched_query)
format->string (format, matched_query);
else
format->null (format);
if (unmatched_query)
format->string (format, unmatched_query);
else
format->null (format);
format->end (format);
}
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
}
talloc_free (ctx_quote);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->map_key (format, "tags");
format->begin_list (format);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
for (tags = notmuch_thread_get_tags (thread);
notmuch_tags_valid (tags);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_tags_move_to_next (tags)) {
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
const char *tag = notmuch_tags_get (tags);
if (format->is_text_printer) {
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
/* Special case for the text formatter */
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
if (first_tag)
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
first_tag = false;
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
else
fputc (' ', stdout);
fputs (tag, stdout);
} else { /* Structured Output */
format->string (format, tag);
}
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
}
Add an "--format=(json|text)" command-line option to both notmuch-search and notmuch-show. In the case of notmuch-show, "--format=json" also implies "--entire-thread" as the thread structure is implicit in the emitted document tree. As a coincidence to the implementation, multipart message ID numbers are now incremented with each part printed. This changes the previous semantics, which were unclear and not necessary related to the actual ordering of the message parts.
2009-12-31 16:17:40 +01:00
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
if (format->is_text_printer)
printf (")");
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->end (format);
format->end (format);
format->separator (format);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
}
Add an "--format=(json|text)" command-line option to both notmuch-search and notmuch-show. In the case of notmuch-show, "--format=json" also implies "--entire-thread" as the thread structure is implicit in the emitted document tree. As a coincidence to the implementation, multipart message ID numbers are now incremented with each part printed. This changes the previous semantics, which were unclear and not necessary related to the actual ordering of the message parts.
2009-12-31 16:17:40 +01:00
notmuch search: Return first 100 results as quickly as possible. This is one of those cases where total time is not the metric of interest. We increase the total time of the search, (by doing some redundant work for the initial threads). But more significantly, we give the user *some* results nearly instantaneously, (so that the user might see the result of interest without ever even waiting for the complete results to come in).
2009-11-18 04:11:05 +01:00
notmuch_thread_destroy (thread);
}
Add an "--format=(json|text)" command-line option to both notmuch-search and notmuch-show. In the case of notmuch-show, "--format=json" also implies "--entire-thread" as the thread structure is implicit in the emitted document tree. As a coincidence to the implementation, multipart message ID numbers are now incremented with each part printed. This changes the previous semantics, which were unclear and not necessary related to the actual ordering of the message parts.
2009-12-31 16:17:40 +01:00
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->end (format);
Print nothing when search result is empty This change affects both text and json formats. Now, text format behaves as before commit 6dcb7592, but json format is changed. Earlier, the empty search returned '[]', now it returns ''. The emacs interface seems not to be affected by this change.
2010-11-01 17:15:40 +01:00
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
return 0;
}
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
static mailbox_t *
new_mailbox (void *ctx, const char *name, const char *addr)
cli: abstract new mailbox creation We'll be needing more mailbox creation soon, so abstract it away. While at it, check for allocation failures. No other functional changes.
2015-09-03 21:39:58 +02:00
{
mailbox_t *mailbox;
mailbox = talloc (ctx, mailbox_t);
if (! mailbox)
return NULL;
mailbox->name = talloc_strdup (mailbox, name);
mailbox->addr = talloc_strdup (mailbox, addr);
mailbox->count = 1;
return mailbox;
}
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
static int
mailbox_compare (const void *v1, const void *v2)
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
{
const mailbox_t *m1 = v1, *m2 = v2;
int ret;
ret = strcmp_null (m1->name, m2->name);
if (! ret)
ret = strcmp (m1->addr, m2->addr);
return ret;
}
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
/* Returns true iff name and addr is duplicate. If not, stores the
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
* name/addr pair in order to detect subsequent duplicates. */
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
static bool
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
is_duplicate (const search_context_t *ctx, const char *name, const char *addr)
{
char *key;
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
GList *list, *l;
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
mailbox_t *mailbox;
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
list = g_hash_table_lookup (ctx->addresses, addr);
if (list) {
mailbox_t find = {
.name = name,
.addr = addr,
};
l = g_list_find_custom (list, &find, mailbox_compare);
if (l) {
mailbox = l->data;
mailbox->count++;
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return true;
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
}
mailbox = new_mailbox (ctx->format, name, addr);
if (! mailbox)
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return false;
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
/*
* XXX: It would be more efficient to prepend to the list, but
* then we'd have to store the changed list head back to the
* hash table. This check is here just to avoid the compiler
* warning for unused result.
*/
if (list != g_list_append (list, mailbox))
INTERNAL_ERROR ("appending to list changed list head\n");
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return false;
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
}
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
key = talloc_strdup (ctx->format, addr);
if (! key)
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return false;
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
cli: abstract new mailbox creation We'll be needing more mailbox creation soon, so abstract it away. While at it, check for allocation failures. No other functional changes.
2015-09-03 21:39:58 +02:00
mailbox = new_mailbox (ctx->format, name, addr);
if (! mailbox)
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return false;
cli: abstract new mailbox creation We'll be needing more mailbox creation soon, so abstract it away. While at it, check for allocation failures. No other functional changes.
2015-09-03 21:39:58 +02:00
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
list = g_list_append (NULL, mailbox);
if (! list)
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return false;
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
g_hash_table_insert (ctx->addresses, key, list);
cli: g_hash_table_lookup_extended is overkill Switch to normal glib hash table lookup. The extended version is only required if the values may contain NULL.
2015-09-03 21:39:57 +02:00
cli: convert notmuch_bool_t to stdbool C99 stdbool turned 18 this year. There really is no reason to use our own, except in the library interface for backward compatibility. Convert the cli and test binaries to stdbool.
2017-10-07 10:44:04 +02:00
return false;
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
}
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
static void
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
print_mailbox (const search_context_t *ctx, const mailbox_t *mailbox)
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
{
const char *name = mailbox->name;
const char *addr = mailbox->addr;
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
int count = mailbox->count;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
sprinter_t *format = ctx->format;
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
InternetAddress *ia = internet_address_mailbox_new (name, addr);
char *name_addr;
/* name_addr has the name part quoted if necessary. Compare
* 'John Doe <john@doe.com>' vs. '"Doe, John" <john@doe.com>' */
gmime-cleanup: pass NULL arguments explicitly where GMime 3.0 expects it Several GMime 2.6 functions sprouted a change in the argument order in GMime 3.0. We had a compatibility layer here to be able to handle compiling against both GMime 2.6 and 3.0. Now that we're using 3.0 only, rip out the compatibility layer for those functions with changed argument lists, and explicitly use the 3.0 argument lists. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:45 +02:00
name_addr = internet_address_to_string (ia, NULL, false);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
if (format->is_text_printer) {
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
if (ctx->output & OUTPUT_COUNT) {
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
format->integer (format, count);
format->string (format, "\t");
}
cli: add support for only printing the addresses in notmuch address The notmuch address output is much more useful for scripts with just the addresses printed. Support this using the --output=address option.
2017-11-02 19:44:59 +01:00
if (ctx->output & OUTPUT_ADDRESS)
format->string (format, addr);
else
format->string (format, name_addr);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
format->separator (format);
} else {
format->begin_map (format);
format->map_key (format, "name");
format->string (format, name);
format->map_key (format, "address");
format->string (format, addr);
format->map_key (format, "name-addr");
format->string (format, name_addr);
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
if (ctx->output & OUTPUT_COUNT) {
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
format->map_key (format, "count");
format->integer (format, count);
}
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
format->end (format);
format->separator (format);
}
g_object_unref (ia);
g_free (name_addr);
}
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
/* Print or prepare for printing addresses from InternetAddressList. */
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
static void
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
process_address_list (const search_context_t *ctx,
InternetAddressList *list)
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
{
InternetAddress *address;
int i;
for (i = 0; i < internet_address_list_length (list); i++) {
address = internet_address_list_get_address (list, i);
if (INTERNET_ADDRESS_IS_GROUP (address)) {
InternetAddressGroup *group;
InternetAddressList *group_list;
group = INTERNET_ADDRESS_GROUP (address);
group_list = internet_address_group_get_members (group);
if (group_list == NULL)
continue;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
process_address_list (ctx, group_list);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
} else {
InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
mailbox_t mbx = {
.name = internet_address_get_name (address),
.addr = internet_address_mailbox_get_addr (mailbox),
};
cli: add support for not deduplicating notmuch address results Make it possible to use notmuch address as part of a | sort | uniq -c pipe instead of forcing --output=count. This is useful for combining results from multiple notmuch address queries.
2015-09-03 21:39:59 +02:00
/* OUTPUT_COUNT only works with deduplication */
if (ctx->dedup != DEDUP_NONE &&
is_duplicate (ctx, mbx.name, mbx.addr))
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
continue;
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
/* OUTPUT_COUNT and DEDUP_ADDRESS require a full pass. */
if (ctx->output & OUTPUT_COUNT || ctx->dedup == DEDUP_ADDRESS)
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
continue;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
print_mailbox (ctx, &mbx);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
}
}
}
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
/* Print or prepare for printing addresses from a message header. */
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
static void
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
process_address_header (const search_context_t *ctx, const char *value)
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
{
InternetAddressList *list;
if (value == NULL)
return;
gmime-cleanup: pass NULL arguments explicitly where GMime 3.0 expects it Several GMime 2.6 functions sprouted a change in the argument order in GMime 3.0. We had a compatibility layer here to be able to handle compiling against both GMime 2.6 and 3.0. Now that we're using 3.0 only, rip out the compatibility layer for those functions with changed argument lists, and explicitly use the 3.0 argument lists. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:45 +02:00
list = internet_address_list_parse (NULL, value);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
if (list == NULL)
return;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
process_address_list (ctx, list);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
g_object_unref (list);
}
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
/* Destructor for talloc-allocated GHashTable keys and values. */
static void
_talloc_free_for_g_hash (void *ptr)
{
talloc_free (ptr);
}
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
static void
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
_list_free_for_g_hash (void *ptr)
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
{
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
g_list_free_full (ptr, _talloc_free_for_g_hash);
}
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
/* Print the most common variant of a list of unique mailboxes, and
* conflate the counts. */
static void
print_popular (const search_context_t *ctx, GList *list)
{
GList *l;
mailbox_t *mailbox = NULL, *m;
int max = 0;
int total = 0;
for (l = list; l; l = l->next) {
m = l->data;
total += m->count;
if (m->count > max) {
mailbox = m;
max = m->count;
}
}
if (! mailbox)
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
INTERNAL_ERROR ("Empty list in address hash table\n");
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
/* The original count is no longer needed, so overwrite. */
mailbox->count = total;
print_mailbox (ctx, mailbox);
}
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
static void
print_list_value (void *mailbox, void *context)
{
print_mailbox (context, mailbox);
}
static void
print_hash_value (unused (void *key), void *list, void *context)
{
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
const search_context_t *ctx = context;
if (ctx->dedup == DEDUP_ADDRESS)
print_popular (ctx, list);
else
g_list_foreach (list, print_list_value, context);
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
}
cli: add support for notmuch search --duplicate=N with --output=messages Print the message IDs of all messages matching the search terms that have at least N files associated with them.
2014-11-01 10:31:06 +01:00
static int
_count_filenames (notmuch_message_t *message)
{
notmuch_filenames_t *filenames;
int i = 0;
filenames = notmuch_message_get_filenames (message);
while (notmuch_filenames_valid (filenames)) {
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_filenames_move_to_next (filenames);
i++;
cli: add support for notmuch search --duplicate=N with --output=messages Print the message IDs of all messages matching the search terms that have at least N files associated with them.
2014-11-01 10:31:06 +01:00
}
notmuch_filenames_destroy (filenames);
return i;
}
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
static int
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
do_search_messages (search_context_t *ctx)
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
{
notmuch_message_t *message;
notmuch_messages_t *messages;
search --output=files: Output all filenames for each matching message Messages in the database can have multiple files associated with a single message-id, but until now only one filename for each message has been reported by "notmuch search --output=files" Signed-off-by: Mark Anderson <ma.skies@gmail.com>
2011-06-25 01:26:55 +02:00
notmuch_filenames_t *filenames;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
sprinter_t *format = ctx->format;
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
int i;
cli: convert remainder of CLI to n_q_search_{messages,threads}_st I think it would be no real problem to cut and paste the gdb based error message test from count to the other clients modified here, but I'm not currently convinced it's worth the trouble since the code path being tested is almost the the same, and the tests are relatively heavyweight.
2015-09-06 15:15:47 +02:00
notmuch_status_t status;
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->offset < 0) {
cli: update to use new count API Essentially replace each call to notmuch_count_* with the corresponding _st call, followed by print_status_query.
2015-09-27 17:31:58 +02:00
unsigned count;
notmuch_status_t status;
lib: replace deprecated n_q_count_messages with status returning version This function was deprecated in notmuch 0.21. We re-use the name for a status returning version, and deprecate the _st name. One or two remaining uses of the (removed) non-status returning version fixed at the same time
2017-02-26 22:21:34 +01:00
status = notmuch_query_count_messages (ctx->query, &count);
cli: update to use new count API Essentially replace each call to notmuch_count_* with the corresponding _st call, followed by print_status_query.
2015-09-27 17:31:58 +02:00
if (print_status_query ("notmuch search", ctx->query, status))
return 1;
ctx->offset += count;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->offset < 0)
ctx->offset = 0;
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
}
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
lib: replace deprecated n_q_search_messages with status returning version This function was deprecated in notmuch 0.21. We re-use the name for a status returning version, and deprecate the _st name.
2017-02-26 22:21:32 +01:00
status = notmuch_query_search_messages (ctx->query, &messages);
cli: convert remainder of CLI to n_q_search_{messages,threads}_st I think it would be no real problem to cut and paste the gdb based error message test from count to the other clients modified here, but I'm not currently convinced it's worth the trouble since the code path being tested is almost the the same, and the tests are relatively heavyweight.
2015-09-06 15:15:47 +02:00
if (print_status_query ("notmuch search", ctx->query, status))
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
return 1;
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->begin_list (format);
json: Fix search result with no matches to be a valid json object. In the original json code, search matching nothing would return a valid, empty json array (that is, "[]"). I broke this in commit 6dcb7592e32ed5140ea0c0357ce78d6a37af6066 when adding support for --output=threads|messages|tags. This time, while fixing the bug also add a test to the test suite to help avoid future regressions.
2011-01-30 20:26:04 +01:00
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
for (i = 0;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
notmuch_messages_valid (messages) && (ctx->limit < 0 || i < ctx->offset + ctx->limit);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_messages_move_to_next (messages), i++) {
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (i < ctx->offset)
cli: add options --offset and --limit to notmuch search Add options --offset=[-]N and --limit=M to notmuch search to determine the first result and maximum number of results to display. Option --limit=M limits the maximum number of results to display to M. Option --offset=[-]N skips the first N results; with the leading '-' skip until the Nth result from the end. Note that --offset with a negative N for thread or summary output requires counting the number of matching threads in advance. Signed-off-by: Jani Nikula <jani@nikula.org>
2011-11-15 21:08:49 +01:00
continue;
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
message = notmuch_messages_get (messages);
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->output == OUTPUT_FILES) {
cli: add --duplicate=N option to notmuch search Effective with --output=files, output the Nth filename associated with each message matching the query (N is 1-based). If N is greater than the number of files associated with the message, don't print anything.
2013-08-17 14:11:26 +02:00
int j;
search --output=files: Output all filenames for each matching message Messages in the database can have multiple files associated with a single message-id, but until now only one filename for each message has been reported by "notmuch search --output=files" Signed-off-by: Mark Anderson <ma.skies@gmail.com>
2011-06-25 01:26:55 +02:00
filenames = notmuch_message_get_filenames (message);
cli: add --duplicate=N option to notmuch search Effective with --output=files, output the Nth filename associated with each message matching the query (N is 1-based). If N is greater than the number of files associated with the message, don't print anything.
2013-08-17 14:11:26 +02:00
for (j = 1;
search --output=files: Output all filenames for each matching message Messages in the database can have multiple files associated with a single message-id, but until now only one filename for each message has been reported by "notmuch search --output=files" Signed-off-by: Mark Anderson <ma.skies@gmail.com>
2011-06-25 01:26:55 +02:00
notmuch_filenames_valid (filenames);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_filenames_move_to_next (filenames), j++) {
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->dupe < 0 || ctx->dupe == j) {
cli: add --duplicate=N option to notmuch search Effective with --output=files, output the Nth filename associated with each message matching the query (N is 1-based). If N is greater than the number of files associated with the message, don't print anything.
2013-08-17 14:11:26 +02:00
format->string (format, notmuch_filenames_get (filenames));
format->separator (format);
}
search --output=files: Output all filenames for each matching message Messages in the database can have multiple files associated with a single message-id, but until now only one filename for each message has been reported by "notmuch search --output=files" Signed-off-by: Mark Anderson <ma.skies@gmail.com>
2011-06-25 01:26:55 +02:00
}
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_filenames_destroy ( filenames );
search --output=files: Output all filenames for each matching message Messages in the database can have multiple files associated with a single message-id, but until now only one filename for each message has been reported by "notmuch search --output=files" Signed-off-by: Mark Anderson <ma.skies@gmail.com>
2011-06-25 01:26:55 +02:00
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
} else if (ctx->output == OUTPUT_MESSAGES) {
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
/* special case 1 for speed */
if (ctx->dupe <= 1 || ctx->dupe <= _count_filenames (message)) {
format->set_prefix (format, "id");
format->string (format,
notmuch_message_get_message_id (message));
format->separator (format);
}
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
} else {
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->output & OUTPUT_SENDER) {
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
const char *addrs;
addrs = notmuch_message_get_header (message, "from");
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
process_address_header (ctx, addrs);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
}
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
if (ctx->output & OUTPUT_RECIPIENTS) {
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
const char *hdrs[] = { "to", "cc", "bcc" };
const char *addrs;
size_t j;
for (j = 0; j < ARRAY_SIZE (hdrs); j++) {
addrs = notmuch_message_get_header (message, hdrs[j]);
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
process_address_header (ctx, addrs);
cli: search: Add --output={sender,recipients} The new outputs allow printing senders, recipients or both of matching messages. To print both, the user can use --output=sender and --output=recipients simultaneously. Currently, the same address can appear multiple times in the output. The next commit will change this. For this reason, tests are introduced there. We use mailbox_t rather than InternetAddressMailbox because we will need to extend it in a following commit. This code is based on a patch from Jani Nikula.
2014-10-31 22:53:58 +01:00
}
}
notmuch search: Add a new "notmuch search --output=files" Yet another thing that will be extremely handy for scripts.
2010-10-28 20:33:55 +02:00
}
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
notmuch_message_destroy (message);
}
cli: add support for deduplicating based on case insensitive address Consider all variants of an email address as one, and print the most common variant.
2015-09-03 21:40:03 +02:00
if (ctx->addresses &&
(ctx->output & OUTPUT_COUNT || ctx->dedup == DEDUP_ADDRESS))
cli: address: Add --output=count This output prints how many times was each address encountered during search.
2014-11-05 01:25:58 +01:00
g_hash_table_foreach (ctx->addresses, print_hash_value, ctx);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
notmuch_messages_destroy (messages);
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->end (format);
Print nothing when search result is empty This change affects both text and json formats. Now, text format behaves as before commit 6dcb7592, but json format is changed. Earlier, the empty search returned '[]', now it returns ''. The emacs interface seems not to be affected by this change.
2010-11-01 17:15:40 +01:00
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
return 0;
}
static int
cli: search: Move more variables into search_context_t In order to share some command line options between search and address subcommands we need to add corresponding variables to the context structure. While we are at it, we also add notmuch_database_t to unify parameters of all do_search_* functions and to simplify subsequent commits. Otherwise, there are no functional changes.
2014-11-05 01:25:51 +01:00
do_search_tags (const search_context_t *ctx)
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
{
notmuch_messages_t *messages = NULL;
notmuch_tags_t *tags;
const char *tag;
cli: search: Rename options to context In the next commit the options structure will be extended by non-option variables. Therefore we need a more generic name. Just text replacement, no other changes.
2014-11-05 01:25:50 +01:00
sprinter_t *format = ctx->format;
notmuch_query_t *query = ctx->query;
cli: search: Move more variables into search_context_t In order to share some command line options between search and address subcommands we need to add corresponding variables to the context structure. While we are at it, we also add notmuch_database_t to unify parameters of all do_search_* functions and to simplify subsequent commits. Otherwise, there are no functional changes.
2014-11-05 01:25:51 +01:00
notmuch_database_t *notmuch = ctx->notmuch;
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
cli: omit excluded messages in results where appropriate. In all cases of notmuch count/search/show where the results returned cannot reflect the exclude flag return just the matched not-excluded results. If the caller wishes to have all the matched results (i.e., including the excluded ones) they should call with the --no-exclude option. The relevant cases are count: both threads and messages search: all cases except the summary view show: mbox format
2012-03-01 23:30:43 +01:00
/* should the following only special case if no excluded terms
* specified? */
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
/* Special-case query of "*" for better performance. */
if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
tags = notmuch_database_get_all_tags (notmuch);
} else {
cli: convert remainder of CLI to n_q_search_{messages,threads}_st I think it would be no real problem to cut and paste the gdb based error message test from count to the other clients modified here, but I'm not currently convinced it's worth the trouble since the code path being tested is almost the the same, and the tests are relatively heavyweight.
2015-09-06 15:15:47 +02:00
notmuch_status_t status;
lib: replace deprecated n_q_search_messages with status returning version This function was deprecated in notmuch 0.21. We re-use the name for a status returning version, and deprecate the _st name.
2017-02-26 22:21:32 +01:00
status = notmuch_query_search_messages (query, &messages);
cli: convert remainder of CLI to n_q_search_{messages,threads}_st I think it would be no real problem to cut and paste the gdb based error message test from count to the other clients modified here, but I'm not currently convinced it's worth the trouble since the code path being tested is almost the the same, and the tests are relatively heavyweight.
2015-09-06 15:15:47 +02:00
if (print_status_query ("notmuch search", query, status))
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
return 1;
tags = notmuch_messages_collect_tags (messages);
}
if (tags == NULL)
return 1;
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->begin_list (format);
json: Fix search result with no matches to be a valid json object. In the original json code, search matching nothing would return a valid, empty json array (that is, "[]"). I broke this in commit 6dcb7592e32ed5140ea0c0357ce78d6a37af6066 when adding support for --output=threads|messages|tags. This time, while fixing the bug also add a test to the test suite to help avoid future regressions.
2011-01-30 20:26:04 +01:00
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
for (;
notmuch_tags_valid (tags);
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
notmuch_tags_move_to_next (tags)) {
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
tag = notmuch_tags_get (tags);
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->string (format, tag);
format->separator (format);
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
}
notmuch_tags_destroy (tags);
if (messages)
notmuch_messages_destroy (messages);
notmuch search: Fix to handle failure of notmuch_query_search_threads. Now that notmuch_query_search_threads can return NULL, (for example, due to a Xapian exception), we need to handle that case (rather than just segfault). It's simple enough to just return a non-zero exit code.
2010-10-23 02:57:02 +02:00
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
format->end (format);
notmuch search: Fix missing final newline in "notmuch search --output=tags" As mentioned in the recent test commits, this also fixes the missing '[' and ']' characters in the --format=json variant of "notmuch search --output=tags" as well.
2010-11-24 02:58:00 +01:00
notmuch search: Fix to handle failure of notmuch_query_search_threads. Now that notmuch_query_search_threads can return NULL, (for example, due to a Xapian exception), we need to handle that case (rather than just segfault). It's simple enough to just return a non-zero exit code.
2010-10-23 02:57:02 +02:00
return 0;
notmuch search: Return first 100 results as quickly as possible. This is one of those cases where total time is not the metric of interest. We increase the total time of the search, (by doing some redundant work for the initial threads). But more significantly, we give the user *some* results nearly instantaneously, (so that the user might see the result of interest without ever even waiting for the complete results to come in).
2009-11-18 04:11:05 +01:00
}
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
static int
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
_notmuch_search_prepare (search_context_t *ctx, int argc, char *argv[])
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
{
char *query_str;
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
if (! ctx->talloc_ctx)
ctx->talloc_ctx = talloc_new (NULL);
notmuch search: Add --first and --max-threads options for incremental search. This time, things are actually tested. The current results aren't exactly the same as previous results since the incremental search doesn't necessarily see all the new messages that pertain to the thread. This means that some author names are missing. I plan to fix this by doing an additional database search for all messages in each thread. Of course, this will also be different than before since now the result will display *all* authors in the thread (rather than only those that matched the search) but that's probably what we really want to display anyway.
2009-11-13 05:47:12 +01:00
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
switch (ctx->format_sel) {
notmuch-search: convert to command-line-arguments The switch on format_sel is slightly clunky, but it doesn't seem worth special casing argument processing for function pointers, when I think the function pointer approach will be modified/abandoned.
2011-12-04 16:26:22 +01:00
case NOTMUCH_FORMAT_TEXT:
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
ctx->format = sprinter_text_create (ctx->talloc_ctx, stdout);
notmuch-search: convert to command-line-arguments The switch on format_sel is slightly clunky, but it doesn't seem worth special casing argument processing for function pointers, when I think the function pointer approach will be modified/abandoned.
2011-12-04 16:26:22 +01:00
break;
cli: add --format=text0 to notmuch search Add new format text0, which is otherwise the same as text, but use the null character as separator instead of the newline character. This is similar to find(1) -print0 option, and works together with the xargs(1) -0 option.
2012-12-16 23:05:11 +01:00
case NOTMUCH_FORMAT_TEXT0:
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
if (ctx->output == OUTPUT_SUMMARY) {
cli: add --format=text0 to notmuch search Add new format text0, which is otherwise the same as text, but use the null character as separator instead of the newline character. This is similar to find(1) -print0 option, and works together with the xargs(1) -0 option.
2012-12-16 23:05:11 +01:00
fprintf (stderr, "Error: --format=text0 is not compatible with --output=summary.\n");
cli: clean up exit status code returned by the cli commands Apart from the status codes for format mismatches, the non-zero exit status codes have been arbitrary. Make the cli consistently return either EXIT_SUCCESS or EXIT_FAILURE.
2014-01-10 22:28:53 +01:00
return EXIT_FAILURE;
cli: add --format=text0 to notmuch search Add new format text0, which is otherwise the same as text, but use the null character as separator instead of the newline character. This is similar to find(1) -print0 option, and works together with the xargs(1) -0 option.
2012-12-16 23:05:11 +01:00
}
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
ctx->format = sprinter_text0_create (ctx->talloc_ctx, stdout);
cli: add --format=text0 to notmuch search Add new format text0, which is otherwise the same as text, but use the null character as separator instead of the newline character. This is similar to find(1) -print0 option, and works together with the xargs(1) -0 option.
2012-12-16 23:05:11 +01:00
break;
notmuch-search: convert to command-line-arguments The switch on format_sel is slightly clunky, but it doesn't seem worth special casing argument processing for function pointers, when I think the function pointer approach will be modified/abandoned.
2011-12-04 16:26:22 +01:00
case NOTMUCH_FORMAT_JSON:
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
ctx->format = sprinter_json_create (ctx->talloc_ctx, stdout);
notmuch-search: convert to command-line-arguments The switch on format_sel is slightly clunky, but it doesn't seem worth special casing argument processing for function pointers, when I think the function pointer approach will be modified/abandoned.
2011-12-04 16:26:22 +01:00
break;
Use the S-Expression structured printer in notmuch-show, notmuch-reply and notmuch-search. This patch uses the new S-Expression printer in the notmuch CLI (show, search and reply). You can now use --format=sexp for any of them.
2012-12-06 22:12:13 +01:00
case NOTMUCH_FORMAT_SEXP:
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
ctx->format = sprinter_sexp_create (ctx->talloc_ctx, stdout);
Use the S-Expression structured printer in notmuch-show, notmuch-reply and notmuch-search. This patch uses the new S-Expression printer in the notmuch CLI (show, search and reply). You can now use --format=sexp for any of them.
2012-12-06 22:12:13 +01:00
break;
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
default:
/* this should never happen */
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
INTERNAL_ERROR ("no output format selected");
notmuch-search: convert to command-line-arguments The switch on format_sel is slightly clunky, but it doesn't seem worth special casing argument processing for function pointers, when I think the function pointer approach will be modified/abandoned.
2011-12-04 16:26:22 +01:00
}
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
search: Support --format-version
2012-12-16 04:17:24 +01:00
notmuch_exit_if_unsupported_format ();
cli: add global option "--uuid" The function notmuch_exit_if_unmatched_db_uuid is split from notmuch_process_shared_options because it needs an open notmuch database. There are two exceptional cases in uuid handling. 1) notmuch config and notmuch setup don't currently open the database, so it doesn't make sense to check the UUID. 2) notmuch compact opens the database inside the library, so we either need to open the database just to check uuid, or change the API.
2015-04-06 00:39:55 +02:00
notmuch_exit_if_unmatched_db_uuid (ctx->notmuch);
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
query_str = query_string_from_args (ctx->notmuch, argc, argv);
Unbreak several notmuch commands after the addition of configuration. All of the following commands: notmuch dump notmuch reply notmuch restore notmuch search notmuch show notmuch tag were calling notmuch_database_open with an argument of NULL. This was a legitimate call until the recent addition of configuration, after which it is expected that all commands will lookup the correct path in the configuration file. So fix all these commands to do that. Also, while touching all of these commands, we fix them to use the talloc context that is passed in rather than creating a local talloc context. We also switch from using goto for return values, to doing direct returns as soon as an error is detected, (which can be leak free thanks to talloc).
2009-11-12 05:29:30 +01:00
if (query_str == NULL) {
Typsos
2009-11-18 00:23:42 +01:00
fprintf (stderr, "Out of memory.\n");
cli: clean up exit status code returned by the cli commands Apart from the status codes for format mismatches, the non-zero exit status codes have been arbitrary. Make the cli consistently return either EXIT_SUCCESS or EXIT_FAILURE.
2014-01-10 22:28:53 +01:00
return EXIT_FAILURE;
Unbreak several notmuch commands after the addition of configuration. All of the following commands: notmuch dump notmuch reply notmuch restore notmuch search notmuch show notmuch tag were calling notmuch_database_open with an argument of NULL. This was a legitimate call until the recent addition of configuration, after which it is expected that all commands will lookup the correct path in the configuration file. So fix all these commands to do that. Also, while touching all of these commands, we fix them to use the talloc context that is passed in rather than creating a local talloc context. We also switch from using goto for return values, to doing direct returns as soon as an error is detected, (which can be leak free thanks to talloc).
2009-11-12 05:29:30 +01:00
}
notmuch search: Avoid infinite stream of exceptions from "notmuch search" That is, give a nice error message and exit if no search terms are provided. Thanks to Priit Laes <plaes@plaes.org> for reporting the error and providing an early version of the fix.
2009-11-18 12:29:30 +01:00
if (*query_str == '\0') {
fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
cli: clean up exit status code returned by the cli commands Apart from the status codes for format mismatches, the non-zero exit status codes have been arbitrary. Make the cli consistently return either EXIT_SUCCESS or EXIT_FAILURE.
2014-01-10 22:28:53 +01:00
return EXIT_FAILURE;
notmuch search: Avoid infinite stream of exceptions from "notmuch search" That is, give a nice error message and exit if no search terms are provided. Thanks to Priit Laes <plaes@plaes.org> for reporting the error and providing an early version of the fix.
2009-11-18 12:29:30 +01:00
}
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
ctx->query = notmuch_query_create (ctx->notmuch, query_str);
if (ctx->query == NULL) {
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
fprintf (stderr, "Out of memory\n");
cli: clean up exit status code returned by the cli commands Apart from the status codes for format mismatches, the non-zero exit status codes have been arbitrary. Make the cli consistently return either EXIT_SUCCESS or EXIT_FAILURE.
2014-01-10 22:28:53 +01:00
return EXIT_FAILURE;
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
}
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
notmuch_query_set_sort (ctx->query, ctx->sort);
notmuch search: Add support for a --reverse option to reverse sort order. Note that the difference between thread results in date order and thread results in reverse-date order is not simply a matter of reversing the final results. When sorting in date order, the threads are sorted by the oldest message in the thread. When sorting in reverse-date order, the threads are sorted by the newest message in the thread. This difference means that we might want an explicit option in the interface to reverse the order, (even though the default will be to display the inbox in date order and global searches in reverse-date order).
2009-11-13 07:35:16 +01:00
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
if (ctx->exclude == NOTMUCH_EXCLUDE_FLAG && ctx->output != OUTPUT_SUMMARY) {
cli: move search to the new --exclude= naming scheme. This commit replaces the --no-exclude option with a --exclude=(true|false|flag) option. The default is to omit the excluded messages. The flag option only makes sense if output=summary (as otherwise there is nowhere to print the flag). In summary output exclude=false and exclude=flag give almost identical output: they differ in that with the exclude=flag option the match count (i.e., the x in [x/n] in the output) is the number of matching non-excluded messages rather than the number of matching messages. Note this changes the default for output=summary when no --exclude= option is given: it used to default to flag and now defaults to true (i.e. omit excluded messages). This is neccesary to keep the cli output uncluttered and for speed reasons.
2012-04-07 18:10:05 +02:00
/* If we are not doing summary output there is nowhere to
* print the excluded flag so fall back on including the
* excluded messages. */
fprintf (stderr, "Warning: this output format cannot flag excluded messages.\n");
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
ctx->exclude = NOTMUCH_EXCLUDE_FALSE;
cli: move search to the new --exclude= naming scheme. This commit replaces the --no-exclude option with a --exclude=(true|false|flag) option. The default is to omit the excluded messages. The flag option only makes sense if output=summary (as otherwise there is nowhere to print the flag). In summary output exclude=false and exclude=flag give almost identical output: they differ in that with the exclude=flag option the match count (i.e., the x in [x/n] in the output) is the number of matching non-excluded messages rather than the number of matching messages. Note this changes the default for output=summary when no --exclude= option is given: it used to default to flag and now defaults to true (i.e. omit excluded messages). This is neccesary to keep the cli output uncluttered and for speed reasons.
2012-04-07 18:10:05 +02:00
}
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
if (ctx->exclude != NOTMUCH_EXCLUDE_FALSE) {
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
notmuch_config_values_t *exclude_tags;
lib: make notmuch_query_add_tag_exclude return a status value Since this is an ABI breaking change, but we already bumped the SONAME for the next release
2017-02-18 16:08:04 +01:00
notmuch_status_t status;
cli: add --no-exclude option to count and search. This option turns off the exclusion so all matching messages are returned. We do not need to add this to notmuch-show as that does not (yet) exclude.
2012-03-01 23:30:33 +01:00
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
for (exclude_tags = notmuch_config_get_values (ctx->notmuch, NOTMUCH_CONFIG_EXCLUDE_TAGS);
notmuch_config_values_valid (exclude_tags);
notmuch_config_values_move_to_next (exclude_tags)) {
lib: make notmuch_query_add_tag_exclude return a status value Since this is an ABI breaking change, but we already bumped the SONAME for the next release
2017-02-18 16:08:04 +01:00
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
status = notmuch_query_add_tag_exclude (ctx->query,
notmuch_config_values_get (exclude_tags));
lib: make notmuch_query_add_tag_exclude return a status value Since this is an ABI breaking change, but we already bumped the SONAME for the next release
2017-02-18 16:08:04 +01:00
if (status && status != NOTMUCH_STATUS_IGNORED) {
print_status_query ("notmuch search", ctx->query, status);
return EXIT_FAILURE;
}
}
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
notmuch_query_set_omit_excluded (ctx->query, ctx->exclude);
cli: add --no-exclude option to count and search. This option turns off the exclusion so all matching messages are returned. We do not need to add this to notmuch-show as that does not (yet) exclude.
2012-03-01 23:30:33 +01:00
}
search: Support automatic tag exclusions This adds a "search" section to the config file and an "auto_tag_exclusions" setting in that section. The search and count commands pass tag tags from the configuration to the library.
2012-01-15 01:17:34 +01:00
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
return 0;
}
static void
_notmuch_search_cleanup (search_context_t *ctx)
{
notmuch_query_destroy (ctx->query);
notmuch_database_destroy (ctx->notmuch);
talloc_free (ctx->format);
}
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
static search_context_t search_context = {
.format_sel = NOTMUCH_FORMAT_TEXT,
.exclude = NOTMUCH_EXCLUDE_TRUE,
.sort = NOTMUCH_SORT_NEWEST_FIRST,
.output = 0,
.offset = 0,
.limit = -1, /* unlimited */
.dupe = -1,
cli: add support for not deduplicating notmuch address results Make it possible to use notmuch address as part of a | sort | uniq -c pipe instead of forcing --output=count. This is useful for combining results from multiple notmuch address queries.
2015-09-03 21:39:59 +02:00
.dedup = DEDUP_MAILBOX,
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
};
static const notmuch_opt_desc_t common_options[] = {
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_keyword = &search_context.sort, .name = "sort", .keywords =
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
(notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
{ "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
{ 0, 0 } } },
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_keyword = &search_context.format_sel, .name = "format", .keywords =
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
(notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
{ "sexp", NOTMUCH_FORMAT_SEXP },
{ "text", NOTMUCH_FORMAT_TEXT },
{ "text0", NOTMUCH_FORMAT_TEXT0 },
{ 0, 0 } } },
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_int = &notmuch_format_version, .name = "format-version" },
{ }
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
};
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
int
CLI: drop notmuch_config_t from subcommand interface. At this point it is unused in all subcommands.
2021-02-27 15:07:45 +01:00
notmuch_search_command (notmuch_database_t *notmuch, int argc, char *argv[])
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
{
search_context_t *ctx = &search_context;
int opt_index, ret;
notmuch_opt_desc_t options[] = {
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_keyword = &ctx->output, .name = "output", .keywords =
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
(notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
{ "threads", OUTPUT_THREADS },
{ "messages", OUTPUT_MESSAGES },
{ "files", OUTPUT_FILES },
{ "tags", OUTPUT_TAGS },
{ 0, 0 } } },
{ .opt_keyword = &ctx->exclude, .name = "exclude", .keywords =
(notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
{ "false", NOTMUCH_EXCLUDE_FALSE },
{ "flag", NOTMUCH_EXCLUDE_FLAG },
{ "all", NOTMUCH_EXCLUDE_ALL },
{ 0, 0 } } },
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_int = &ctx->offset, .name = "offset" },
{ .opt_int = &ctx->limit, .name = "limit" },
{ .opt_int = &ctx->dupe, .name = "duplicate" },
{ .opt_inherit = common_options },
{ .opt_inherit = notmuch_shared_options },
{ }
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
};
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
ctx->notmuch = notmuch;
cli: search: Convert --output to keyword argument Now, when address related outputs are in a separate command, it makes no sense to combine multiple --output options in search command line. Using switch statement to handle different outputs is more readable than a series of if statements.
2014-11-05 01:25:56 +01:00
ctx->output = OUTPUT_SUMMARY;
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
opt_index = parse_arguments (argc, argv, options, 1);
if (opt_index < 0)
return EXIT_FAILURE;
cli: define shared options, use for --help and --version Unfortunately it seems trickier to support --config globally The non-trivial changes are in notmuch.c; most of the other changes consists of blindly inserting two lines into every subcommand.
2015-04-05 15:13:03 +02:00
notmuch_process_shared_options (argv[0]);
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
if (ctx->output != OUTPUT_FILES && ctx->output != OUTPUT_MESSAGES &&
ctx->dupe != -1) {
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory Line breaks were then adjusted manually to keep argc and argv together.
2021-03-13 13:45:34 +01:00
fprintf (stderr,
"Error: --duplicate=N is only supported with --output=files and --output=messages.\n");
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
return EXIT_FAILURE;
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
}
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
if (_notmuch_search_prepare (ctx, argc - opt_index, argv + opt_index))
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
return EXIT_FAILURE;
cli: search: Convert --output to keyword argument Now, when address related outputs are in a separate command, it makes no sense to combine multiple --output options in search command line. Using switch statement to handle different outputs is more readable than a series of if statements.
2014-11-05 01:25:56 +01:00
switch (ctx->output) {
case OUTPUT_SUMMARY:
case OUTPUT_THREADS:
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
ret = do_search_threads (ctx);
cli: search: Convert --output to keyword argument Now, when address related outputs are in a separate command, it makes no sense to combine multiple --output options in search command line. Using switch statement to handle different outputs is more readable than a series of if statements.
2014-11-05 01:25:56 +01:00
break;
case OUTPUT_MESSAGES:
case OUTPUT_FILES:
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
ret = do_search_messages (ctx);
cli: search: Convert --output to keyword argument Now, when address related outputs are in a separate command, it makes no sense to combine multiple --output options in search command line. Using switch statement to handle different outputs is more readable than a series of if statements.
2014-11-05 01:25:56 +01:00
break;
case OUTPUT_TAGS:
cli: search: Convert ctx. to ctx-> In the next commit, notmuch_search_command will be refactored to several smaller functions. In order to simplify the next commit to verbatim move of several lines to new functions with search_context_t* argument, we convert all references to this structure to pointer dereferences. To do so we rename the context variable and use the original name ctx as the pointer to the renamed structure.
2014-11-05 01:25:52 +01:00
ret = do_search_tags (ctx);
cli: search: Convert --output to keyword argument Now, when address related outputs are in a separate command, it makes no sense to combine multiple --output options in search command line. Using switch statement to handle different outputs is more readable than a series of if statements.
2014-11-05 01:25:56 +01:00
break;
default:
INTERNAL_ERROR ("Unexpected output");
notmuch search: Add a new --output=(summary|threads|messages|tags) option. This can be handy for scripts which need to extract just a thread ID from a search term, for example.
2010-10-28 20:19:53 +02:00
}
cli: search: Split notmuch_search_command to smaller functions In a subsequent commit, these functions will be used to share some functionality between search and address commands.
2014-11-05 01:25:53 +01:00
_notmuch_search_cleanup (ctx);
Use the structured formatters in notmuch-search.c. This patch switches from the current ad-hoc printer to the structured formatters in sprinter.h, sprinter-text.c and sprinter-json.c. The JSON tests are changed slightly in order to make them PASS for the new structured output formatter. The text tests pass without adaptation.
2012-07-23 12:39:46 +02:00
cli: clean up exit status code returned by the cli commands Apart from the status codes for format mismatches, the non-zero exit status codes have been arbitrary. Make the cli consistently return either EXIT_SUCCESS or EXIT_FAILURE.
2014-01-10 22:28:53 +01:00
return ret ? EXIT_FAILURE : EXIT_SUCCESS;
notmuch: Break notmuch.c up into several smaller files. Now that the client sources are alone here in their own directory, (with all the library sources down inside the lib directory), we can break the client up into multiple files without mixing the files up. The hope is that these smaller files will be easier to manage and maintain.
2009-11-10 21:03:05 +01:00
}
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
int
CLI: drop notmuch_config_t from subcommand interface. At this point it is unused in all subcommands.
2021-02-27 15:07:45 +01:00
notmuch_address_command (notmuch_database_t *notmuch, int argc, char *argv[])
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
{
search_context_t *ctx = &search_context;
int opt_index, ret;
notmuch_opt_desc_t options[] = {
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_flags = &ctx->output, .name = "output", .keywords =
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
(notmuch_keyword_t []){ { "sender", OUTPUT_SENDER },
{ "recipients", OUTPUT_RECIPIENTS },
{ "count", OUTPUT_COUNT },
{ "address", OUTPUT_ADDRESS },
{ 0, 0 } } },
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_keyword = &ctx->exclude, .name = "exclude", .keywords =
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
(notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
{ "false", NOTMUCH_EXCLUDE_FALSE },
{ 0, 0 } } },
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_keyword = &ctx->dedup, .name = "deduplicate", .keywords =
cli: run uncrustify This is the result of running $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h in the top level source directory
2019-06-13 12:31:01 +02:00
(notmuch_keyword_t []){ { "no", DEDUP_NONE },
{ "mailbox", DEDUP_MAILBOX },
{ "address", DEDUP_ADDRESS },
{ 0, 0 } } },
cli: use designated initializers for opt desc Several changes at once, just to not have to change the same lines several times over: - Use designated initializers to initialize opt desc arrays. - Only initialize the needed fields. - Remove arg_id (short options) as unused. - Replace opt_type and output_var with several type safe output variables, where the output variable being non-NULL determines the type. Introduce checks to ensure only one is set. The downside is some waste of const space per argument; this could be saved by retaining opt_type and using a union, but that's still pretty verbose. - Fix some variables due to the type safety. Mostly a good thing, but leads to some enums being changed to ints. This is pedantically correct, but somewhat annoying. We could also cast, but that defeats the purpose a bit. - Terminate the opt desc arrays using {}. The output variable type safety and the ability to add new fields for just some output types or arguments are the big wins. For example, if we wanted to add a variable to set when the argument is present, we could do so for just the arguments that need it. Beauty is in the eye of the beholder, but I think this looks nice when defining the arguments, and reduces some of the verbosity we have there.
2017-10-01 22:53:11 +02:00
{ .opt_inherit = common_options },
{ .opt_inherit = notmuch_shared_options },
{ }
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
};
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
ctx->notmuch = notmuch;
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
opt_index = parse_arguments (argc, argv, options, 1);
if (opt_index < 0)
return EXIT_FAILURE;
cli: define shared options, use for --help and --version Unfortunately it seems trickier to support --config globally The non-trivial changes are in notmuch.c; most of the other changes consists of blindly inserting two lines into every subcommand.
2015-04-05 15:13:03 +02:00
notmuch_process_shared_options (argv[0]);
cli: notmuch address option defaults update When no --output option were given, change default to display senders only. When only --count option is given, display senders (in contrary to not displaying anything). Document that --count with --sort=**order** is not supported option combination. Clean up some whitespace in the documentation. One test updated to have --output=count without sender nor recipient output option.
2014-11-07 19:31:50 +01:00
if (! (ctx->output & (OUTPUT_SENDER | OUTPUT_RECIPIENTS)))
ctx->output |= OUTPUT_SENDER;
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
cli: add support for not deduplicating notmuch address results Make it possible to use notmuch address as part of a | sort | uniq -c pipe instead of forcing --output=count. This is useful for combining results from multiple notmuch address queries.
2015-09-03 21:39:59 +02:00
if (ctx->output & OUTPUT_COUNT && ctx->dedup == DEDUP_NONE) {
fprintf (stderr, "--output=count is not applicable with --deduplicate=no\n");
return EXIT_FAILURE;
}
CLI/{search,address}: convert to new configuration framework Since we are already passing a search context around as a kind of parameter block, add a new talloc context to that to replace relying on 'config'. Convert notmuch-search and notmuch-address at the same time, because they share some code. Add a test to make sure we don't break passing configuration as a command line argument.
2020-08-08 16:16:52 +02:00
if (_notmuch_search_prepare (ctx, argc - opt_index, argv + opt_index))
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
return EXIT_FAILURE;
cli: change the data structure for notmuch address deduplication Currently we key the address hash table with the case sensitive "name <address>". Switch to case insensitive keying with just address, and store the case sensitive name and address in linked lists. This will be helpful in adding support for different deduplication schemes in the future. There will be a slight performance penalty for the current full case sensitive name + address deduplication, but this is simpler as a whole when other deduplication schemes are added, and I expect the schemes to be added to become more popular than the current default. Aparet from the possible performance penalty, the only user visible change should be the change in the output ordering for --output=count. The order is not guaranteed (and is based on hash table traversal) currently anyway, so this should be of no consequence.
2015-09-25 18:48:20 +02:00
ctx->addresses = g_hash_table_new_full (strcase_hash, strcase_equal,
_talloc_free_for_g_hash,
_list_free_for_g_hash);
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
cli: do not sort addresses on --output=count or --deduplicate=address The order of the results with --output=count and --deduplicate=address are unspecified as they're based on a hash table traversal. This being the case, optimize the query by explicitly requesting unsorted results. Clarify the documentation accordingly.
2015-09-03 21:40:05 +02:00
/* The order is not guaranteed if a full pass is required, so go
* for fastest. */
if (ctx->output & OUTPUT_COUNT || ctx->dedup == DEDUP_ADDRESS)
notmuch_query_set_sort (ctx->query, NOTMUCH_SORT_UNSORTED);
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
ret = do_search_messages (ctx);
cli: address: Do not output duplicate addresses This filters out duplicate addresses from address command output. It also also adds tests for the address command. The code here is an extended version of a patch from Jani Nikula.
2014-11-05 01:25:57 +01:00
g_hash_table_unref (ctx->addresses);
cli: Introduce "notmuch address" command This moves address-related functionality from search command to the new address command. The implementation shares almost all code and some command line options. Options --offset and --limit were intentionally not included in the address command, because they refer to messages numbers, which users do not see in the output. This could confuse users because, for example, they could see more addresses in the output that what was specified with --limit. This functionality can be correctly reimplemented for address subcommand later. Also useless values of --exclude flag were not included in the address command. This was inspired by a patch from Jani Nikula.
2014-11-05 01:25:55 +01:00
_notmuch_search_cleanup (ctx);
return ret ? EXIT_FAILURE : EXIT_SUCCESS;
}
Reference in a new issue Copy permalink