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

1522 lines
45 KiB
C
Raw 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"
show/reply: Unify the code that extracts text parts Previously, show and reply had separate implementations of decoding and printing text parts. Now both use show's implementation, which was more complete. Show's implementation has been extended with an option to add reply quoting to the extracted part (this is implemented as a named flag to avoid naked booleans, even though it's the only flag it can take).
2012-03-27 23:59:50 +02:00
#include "gmime-filter-reply.h"
show: Associate an sprinter with each format This associates an sprinter constructor with each show format and uses this to construct the appropriate sprinter. Currently nothing is done with this sprinter, but the following patches will weave it through the layers of notmuch show.
2012-08-03 03:14:50 +02:00
#include "sprinter.h"
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
#include "zlib-extra.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
CLI/show: initial support for --duplicate for (raw output only) Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.
2022-07-01 23:45:43 +02:00
static const char *
_get_filename (notmuch_message_t *message, int index)
{
notmuch_filenames_t *filenames = notmuch_message_get_filenames (message);
int i = 1;
for (;
notmuch_filenames_valid (filenames);
notmuch_filenames_move_to_next (filenames), i++) {
if (i >= index)
return notmuch_filenames_get (filenames);
}
return 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
static const char *
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
_get_tags_as_string (const void *ctx, notmuch_message_t *message)
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_tags_t *tags;
int first = 1;
const char *tag;
char *result;
result = talloc_strdup (ctx, "");
if (result == NULL)
return NULL;
for (tags = notmuch_message_get_tags (message);
lib: Rename iterator functions to prepare for reverse iteration. We rename 'has_more' to 'valid' so that it can function whether iterating in a forward or reverse direction. We also rename 'advance' to 'move_to_next' to setup parallel naming with the proposed functions 'move_to_first', 'move_to_last', and 'move_to_previous'.
2010-03-09 18:22:29 +01:00
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: 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
tag = notmuch_tags_get (tags);
result = talloc_asprintf_append (result, "%s%s",
first ? "" : " ", tag);
first = 0;
}
return result;
}
/* Get a nice, single-line summary of message. */
static const char *
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
_get_one_line_summary (const void *ctx, notmuch_message_t *message)
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
{
const char *from;
time_t date;
const char *relative_date;
const char *tags;
from = notmuch_message_get_header (message, "from");
date = notmuch_message_get_date (message);
relative_date = notmuch_time_relative_date (ctx, date);
tags = _get_tags_as_string (ctx, message);
return talloc_asprintf (ctx, "%s (%s) (%s)",
from, relative_date, 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
static const char *
_get_disposition (GMimeObject *meta)
cli/show: abstract get content disposition Reduce duplication in follow-up work. As a side effect, handle error returns from g_mime_content_disposition_get_disposition() without segfaulting.
2017-02-26 19:33:47 +01:00
{
GMimeContentDisposition *disposition;
disposition = g_mime_object_get_content_disposition (meta);
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 (! disposition)
cli/show: abstract get content disposition Reduce duplication in follow-up work. As a side effect, handle error returns from g_mime_content_disposition_get_disposition() without segfaulting.
2017-02-26 19:33:47 +01:00
return NULL;
return g_mime_content_disposition_get_disposition (disposition);
}
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
static bool
_get_message_flag (notmuch_message_t *message, notmuch_message_flag_t flag)
{
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
notmuch_bool_t is_set;
notmuch_status_t status;
status = notmuch_message_get_flag_st (message, flag, &is_set);
if (print_status_message ("notmuch show", message, status))
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
INTERNAL_ERROR ("unexpected error getting message flag\n");
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
return is_set;
}
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
/* Emit a sequence of key/value pairs for the metadata of message.
* The caller should begin a map before calling this. */
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
static void
Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. All the structured output functions in notmuch-reply and notmuch-show are renamed to a generic name (as they do not contain any json-specific code anyway). This patch is a preparation to actually using the new S-Expression sprinter in notmuch-reply and notmuch-show.
2012-12-06 22:12:12 +01:00
format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
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 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
/* Any changes to the JSON or S-Expression format should be
* reflected in the file devel/schemata. */
show: More aggressively document the presence of devel/schemata Previously, the only mention of devel/schemata was a comment at the top of format_part_json, but the JSON output code is spread across several functions that are distributed across notmuch-show.c. Add references from the other three key JSON output functions.
2012-11-07 16:27:01 +01:00
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
void *local = talloc_new (NULL);
notmuch-show: add tags to json output The previous json patches forgot to add the notmuch tags to the json output. This is inconsistent to the text output so here they are. We just output a 'tags' field that sends notmuch tags as a json array. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-03-11 13:11:43 +01:00
notmuch_tags_t *tags;
notmuch-show: Add unix and relative dates to the JSON output Include a 'date_unix' and 'date_relative' field in the JSON output for each message. 'date_relative' can be used by a UI implementation, whereas 'date_unix' is useful when scripting.
2010-03-23 10:40:48 +01:00
time_t date;
const char *relative_date;
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "id");
sp->string (sp, notmuch_message_get_message_id (message));
sp->map_key (sp, "match");
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
sp->boolean (sp, _get_message_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "excluded");
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
sp->boolean (sp, _get_message_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "filename");
cli/show: list all filenames of a message in the formatted output Instead of just having the first filename for the message, list all duplicate filenames of the message as a list in the formatted outputs. This bumps the format version to 3.
2017-02-25 14:31:31 +01:00
if (notmuch_format_version >= 3) {
notmuch_filenames_t *filenames;
sp->begin_list (sp);
for (filenames = notmuch_message_get_filenames (message);
notmuch_filenames_valid (filenames);
notmuch_filenames_move_to_next (filenames)) {
sp->string (sp, notmuch_filenames_get (filenames));
}
notmuch_filenames_destroy (filenames);
sp->end (sp);
} else {
sp->string (sp, notmuch_message_get_filename (message));
}
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "timestamp");
notmuch-show: Add unix and relative dates to the JSON output Include a 'date_unix' and 'date_relative' field in the JSON output for each message. 'date_relative' can be used by a UI implementation, whereas 'date_unix' is useful when scripting.
2010-03-23 10:40:48 +01:00
date = notmuch_message_get_date (message);
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->integer (sp, date);
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
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "date_relative");
relative_date = notmuch_time_relative_date (local, date);
sp->string (sp, relative_date);
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
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "tags");
sp->begin_list (sp);
notmuch-show: add tags to json output The previous json patches forgot to add the notmuch tags to the json output. This is inconsistent to the text output so here they are. We just output a 'tags' field that sends notmuch tags as a json array. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2010-03-11 13:11:43 +01:00
for (tags = notmuch_message_get_tags (message);
notmuch_tags_valid (tags);
notmuch_tags_move_to_next (tags))
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->string (sp, notmuch_tags_get (tags));
sp->end (sp);
talloc_free (local);
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 show: Add a --format=mbox option We don't love the mbox format, but it's still sometimes the most practical way to share a collection of messages as a single file. Here we implement the "mboxrd" variant of the mbox file format. This variant applies reversible escaping by prefixing a '>' character to all lines in the email messages matching the regular expression: "^>*From " This allows the escaping to be reliably removed. A reader should remove a '>' from any line matching the regular expression: "^>>*From " More details on the mboxrd formats (and others as well) can be found here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
2010-06-09 04:45:54 +02:00
/* Extract just the email address from the contents of a From:
* header. */
static const char *
_extract_email_address (const void *ctx, const char *from)
{
InternetAddressList *addresses;
InternetAddress *address;
InternetAddressMailbox *mailbox;
const char *email = "MAILER-DAEMON";
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
addresses = internet_address_list_parse (NULL, from);
notmuch show: Add a --format=mbox option We don't love the mbox format, but it's still sometimes the most practical way to share a collection of messages as a single file. Here we implement the "mboxrd" variant of the mbox file format. This variant applies reversible escaping by prefixing a '>' character to all lines in the email messages matching the regular expression: "^>*From " This allows the escaping to be reliably removed. A reader should remove a '>' from any line matching the regular expression: "^>>*From " More details on the mboxrd formats (and others as well) can be found here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
2010-06-09 04:45:54 +02:00
/* Bail if there is no address here. */
if (addresses == NULL || internet_address_list_length (addresses) < 1)
goto DONE;
/* Otherwise, just use the first address. */
address = internet_address_list_get_address (addresses, 0);
/* The From header should never contain an address group rather
* than a mailbox. So bail if it does. */
if (! INTERNET_ADDRESS_IS_MAILBOX (address))
goto DONE;
mailbox = INTERNET_ADDRESS_MAILBOX (address);
email = internet_address_mailbox_get_addr (mailbox);
email = talloc_strdup (ctx, email);
DONE:
Release memory allocated by internet_address_list_parse_string() g_object_unref() releases the memory of the InternetAddressList object returned by internet_address_list_parse_string() -- when last (only) reference is released, internet_address_list_finalize() will do cleanup.
2011-12-10 11:18:54 +01:00
if (addresses)
g_object_unref (addresses);
notmuch show: Add a --format=mbox option We don't love the mbox format, but it's still sometimes the most practical way to share a collection of messages as a single file. Here we implement the "mboxrd" variant of the mbox file format. This variant applies reversible escaping by prefixing a '>' character to all lines in the email messages matching the regular expression: "^>*From " This allows the escaping to be reliably removed. A reader should remove a '>' from any line matching the regular expression: "^>>*From " More details on the mboxrd formats (and others as well) can be found here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
2010-06-09 04:45:54 +02:00
return email;
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 show: Add a --format=mbox option We don't love the mbox format, but it's still sometimes the most practical way to share a collection of messages as a single file. Here we implement the "mboxrd" variant of the mbox file format. This variant applies reversible escaping by prefixing a '>' character to all lines in the email messages matching the regular expression: "^>*From " This allows the escaping to be reliably removed. A reader should remove a '>' from any line matching the regular expression: "^>>*From " More details on the mboxrd formats (and others as well) can be found here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
2010-06-09 04:45:54 +02:00
/* Return 1 if 'line' is an mbox From_ line---that is, a line
* beginning with zero or more '>' characters followed by the
* characters 'F', 'r', 'o', 'm', and space.
*
* Any characters at all may appear after that in the line.
*/
static int
_is_from_line (const char *line)
{
const char *s = line;
if (line == NULL)
return 0;
while (*s == '>')
s++;
if (STRNCMP_LITERAL (s, "From ") == 0)
return 1;
else
return 0;
}
CLI: print extra headers in structured output This is based on a patch from Johan Parin [1], which is in turn responding to a bug report / feature requiest from Jan Malkhovski. The update to the structured output documented in schemata is intended to be upward compatible, so the format version stays the same [1]: id:20191116162723.18343-1-johan.parin@gmail.com [2]: id:87h8sdemnr.fsf@oxij.org
2022-01-01 13:01:36 +01:00
/* Output extra headers if configured with the `show.extra_headers'
* configuration option
*/
static void
format_extra_headers_sprinter (sprinter_t *sp, GMimeMessage *message)
{
GMimeHeaderList *header_list = g_mime_object_get_header_list (GMIME_OBJECT (message));
for (notmuch_config_values_t *extra_headers = notmuch_config_get_values (
sp->notmuch, NOTMUCH_CONFIG_EXTRA_HEADERS);
notmuch_config_values_valid (extra_headers);
notmuch_config_values_move_to_next (extra_headers)) {
GMimeHeader *header;
const char *header_name = notmuch_config_values_get (extra_headers);
header = g_mime_header_list_get_header (header_list, header_name);
if (header == NULL)
continue;
sp->map_key (sp, g_mime_header_get_name (header));
sp->string (sp, g_mime_header_get_value (header));
}
}
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
void
Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. All the structured output functions in notmuch-reply and notmuch-show are renamed to a generic name (as they do not contain any json-specific code anyway). This patch is a preparation to actually using the new S-Expression sprinter in notmuch-reply and notmuch-show.
2012-12-06 22:12:12 +01:00
format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
cli/show: emit payload subject instead of outside subject Correctly fix the two outstanding tests so that the protected (hidden) subject is properly reported. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:58 +02:00
bool reply, const _notmuch_message_crypto_t *msg_crypto)
Improve handling of message/rfc822 parts by adding a new header_message_part function to the formating structure. This new function takes a GMimeMessage as input, and outputs the formatted headers. This allows for message/rfc822 parts to be formatted on output in a similar way to full messages (see previous patch that overhauls the multipart test for more info).
2011-06-06 02:29:28 +02:00
{
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
/* Any changes to the JSON or S-Expression format should be
* reflected in the file devel/schemata. */
show: More aggressively document the presence of devel/schemata Previously, the only mention of devel/schemata was a comment at the top of format_part_json, but the JSON output code is spread across several functions that are distributed across notmuch-show.c. Add references from the other three key JSON output functions.
2012-11-07 16:27:01 +01:00
fix memory leaks in notmuch-show.c:format_headers_sprinter() Internet_address_list_to_string() and g_mime_message_get_date_as_string() return allocated string buffers and not const, so from what I can tell from taking a look at the sprinter-sexp.c’s sexp_string() function, the code leaks the recipients_string as well as the date string.
2017-03-16 17:53:47 +01:00
char *recipients_string;
show: include Reply-To header in json output Output the Reply-To header field if present in a message. I want to be able to see what the sender intended in my mail client, before hitting the reply key. Only json output is changed, like the recently added Bcc field.
2012-10-30 11:12:46 +01:00
const char *reply_to_string;
cli: replace use of g_mime_message_get_reply_to This function changes signature in gmime 3.0, so we provide two new functions, one for each signature.
2017-05-04 20:59:37 +02:00
void *local = talloc_new (sp);
Improve handling of message/rfc822 parts by adding a new header_message_part function to the formating structure. This new function takes a GMimeMessage as input, and outputs the formatted headers. This allows for message/rfc822 parts to be formatted on output in a similar way to full messages (see previous patch that overhauls the multipart test for more info).
2011-06-06 02:29:28 +02:00
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
sp->begin_map (sp);
sp->map_key (sp, "Subject");
cli/show: emit payload subject instead of outside subject Correctly fix the two outstanding tests so that the protected (hidden) subject is properly reported. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:58 +02:00
if (msg_crypto && msg_crypto->payload_subject) {
sp->string (sp, msg_crypto->payload_subject);
} else
sp->string (sp, g_mime_message_get_subject (message));
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
sp->map_key (sp, "From");
lib/cli: replace use of g_mime_message_get_sender This function changes semantics in gmime-3.0 so make a new function that provides the same functionality in both
2017-05-06 04:26:57 +02:00
sp->string (sp, g_mime_message_get_from_string (message));
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
cli: replace use of g_mime_message_get_recipients This function, and associated enum, have been renamed and generalized in gmime-3.0.
2017-05-06 13:41:14 +02:00
recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
if (recipients_string) {
sp->map_key (sp, "To");
sp->string (sp, recipients_string);
fix memory leaks in notmuch-show.c:format_headers_sprinter() Internet_address_list_to_string() and g_mime_message_get_date_as_string() return allocated string buffers and not const, so from what I can tell from taking a look at the sprinter-sexp.c’s sexp_string() function, the code leaks the recipients_string as well as the date string.
2017-03-16 17:53:47 +01:00
g_free (recipients_string);
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
}
cli: replace use of g_mime_message_get_recipients This function, and associated enum, have been renamed and generalized in gmime-3.0.
2017-05-06 13:41:14 +02:00
recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
if (recipients_string) {
sp->map_key (sp, "Cc");
sp->string (sp, recipients_string);
fix memory leaks in notmuch-show.c:format_headers_sprinter() Internet_address_list_to_string() and g_mime_message_get_date_as_string() return allocated string buffers and not const, so from what I can tell from taking a look at the sprinter-sexp.c’s sexp_string() function, the code leaks the recipients_string as well as the date string.
2017-03-16 17:53:47 +01:00
g_free (recipients_string);
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
}
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
cli: replace use of g_mime_message_get_recipients This function, and associated enum, have been renamed and generalized in gmime-3.0.
2017-05-06 13:41:14 +02:00
recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_BCC);
notmuch-show: include Bcc header in json output With this change, emacs users can use notmuch-message-headers variable to configure notmuch-show display Bcc header.
2012-09-10 08:35:30 +02:00
if (recipients_string) {
sp->map_key (sp, "Bcc");
sp->string (sp, recipients_string);
fix memory leaks in notmuch-show.c:format_headers_sprinter() Internet_address_list_to_string() and g_mime_message_get_date_as_string() return allocated string buffers and not const, so from what I can tell from taking a look at the sprinter-sexp.c’s sexp_string() function, the code leaks the recipients_string as well as the date string.
2017-03-16 17:53:47 +01:00
g_free (recipients_string);
notmuch-show: include Bcc header in json output With this change, emacs users can use notmuch-message-headers variable to configure notmuch-show display Bcc header.
2012-09-10 08:35:30 +02:00
}
cli: replace use of g_mime_message_get_reply_to This function changes signature in gmime 3.0, so we provide two new functions, one for each signature.
2017-05-04 20:59:37 +02:00
reply_to_string = g_mime_message_get_reply_to_string (local, message);
show: include Reply-To header in json output Output the Reply-To header field if present in a message. I want to be able to see what the sender intended in my mail client, before hitting the reply key. Only json output is changed, like the recently added Bcc field.
2012-10-30 11:12:46 +01:00
if (reply_to_string) {
sp->map_key (sp, "Reply-To");
sp->string (sp, reply_to_string);
}
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
if (reply) {
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
sp->map_key (sp, "In-reply-to");
sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
sp->map_key (sp, "References");
sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
} else {
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
sp->map_key (sp, "Date");
cli: replace use of g_mime_message_get_date_as_string This function goes away in gmime-3.0. Also, the memory management is apparently error prone, witness the memory leak in notmuch-reply.
2017-05-04 14:48:44 +02:00
sp->string (sp, g_mime_message_get_date_string (sp, message));
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
}
CLI: print extra headers in structured output This is based on a patch from Johan Parin [1], which is in turn responding to a bug report / feature requiest from Jan Malkhovski. The update to the structured output documented in schemata is intended to be upward compatible, so the format version stays the same [1]: id:20191116162723.18343-1-johan.parin@gmail.com [2]: id:87h8sdemnr.fsf@oxij.org
2022-01-01 13:01:36 +01:00
/* Output extra headers the user has configured, if any */
CLI: print extra headers only for non-replies If in the future we decide to output extra headers for replies, this should be controlled by a separate configuration option.
2022-01-19 02:26:45 +01:00
if (! reply)
format_extra_headers_sprinter (sp, message);
show: Convert format_headers_json to use sprinter This no longer requires a talloc context (not that it really did before since it didn't return anything), so we remove its context argument.
2012-08-03 03:14:53 +02:00
sp->end (sp);
cli: replace use of g_mime_message_get_reply_to This function changes signature in gmime 3.0, so we provide two new functions, one for each signature.
2017-05-04 20:59:37 +02:00
talloc_free (local);
Improve handling of message/rfc822 parts by adding a new header_message_part function to the formating structure. This new function takes a GMimeMessage as input, and outputs the formatted headers. This allows for message/rfc822 parts to be formatted on output in a similar way to full messages (see previous patch that overhauls the multipart test for more info).
2011-06-06 02:29:28 +02:00
}
notmuch show: Don't do text conversions for non-text parts This fixes the recently-added test case (in test/multipart) demonstrating corruption of binary parts that happen to contain CRLF pairs. We restore the original code from show_one_part_content to format_part_content_raw. Then, for good measure, we rename show_part_content to the more descriptive show_text_part_content and add an internal error if it is ever called with a non-text part.
2011-06-01 01:13:21 +02:00
/* Write a MIME text part out to the given stream.
show/reply: Unify the code that extracts text parts Previously, show and reply had separate implementations of decoding and printing text parts. Now both use show's implementation, which was more complete. Show's implementation has been extended with an option to add reply quoting to the extracted part (this is implemented as a named flag to avoid naked booleans, even though it's the only flag it can take).
2012-03-27 23:59:50 +02:00
*
* If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
* each output line.
notmuch show: Don't do text conversions for non-text parts This fixes the recently-added test case (in test/multipart) demonstrating corruption of binary parts that happen to contain CRLF pairs. We restore the original code from show_one_part_content to format_part_content_raw. Then, for good measure, we rename show_part_content to the more descriptive show_text_part_content and add an internal error if it is ever called with a non-text part.
2011-06-01 01:13:21 +02:00
*
* Both line-ending conversion (CRLF->LF) and charset conversion ( ->
* UTF-8) will be performed, so it is inappropriate to call this
* function with a non-text part. Doing so will trigger an internal
* error.
*/
show/reply: Unify the code that extracts text parts Previously, show and reply had separate implementations of decoding and printing text parts. Now both use show's implementation, which was more complete. Show's implementation has been extended with an option to add reply quoting to the extracted part (this is implemented as a named flag to avoid naked booleans, even though it's the only flag it can take).
2012-03-27 23:59:50 +02:00
void
show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
notmuch_show_text_part_flags flags)
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01:00
{
notmuch show: Don't do text conversions for non-text parts This fixes the recently-added test case (in test/multipart) demonstrating corruption of binary parts that happen to contain CRLF pairs. We restore the original code from show_one_part_content to format_part_content_raw. Then, for good measure, we rename show_part_content to the more descriptive show_text_part_content and add an internal error if it is ever called with a non-text part.
2011-06-01 01:13:21 +02:00
GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01:00
GMimeStream *stream_filter = NULL;
cli/show: unref crlf filter. Mimic the handling of the other filter g_objects. This cleans up a fair sized memory leak.
2017-03-18 18:46:42 +01:00
GMimeFilter *crlf_filter = NULL;
lib: detect mislabeled Windows-1252 parts Use GMime functionality to detect mislabeled messages and apply the correct (Windows) encoding instead.
2018-08-07 14:48:22 +02:00
GMimeFilter *windows_filter = NULL;
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01:00
GMimeDataWrapper *wrapper;
notmuch-show: Show message part using UTF-8. Pass the message through the charset filter so that we can view messages wrote in different charset encoding. Signed-off-by: Kan-Ru Chen <kanru@kanru.info>
2009-11-22 09:30:47 +01:00
const char *charset;
notmuch show: Don't do text conversions for non-text parts This fixes the recently-added test case (in test/multipart) demonstrating corruption of binary parts that happen to contain CRLF pairs. We restore the original code from show_one_part_content to format_part_content_raw. Then, for good measure, we rename show_part_content to the more descriptive show_text_part_content and add an internal error if it is ever called with a non-text part.
2011-06-01 01:13:21 +02:00
if (! g_mime_content_type_is_type (content_type, "text", "*"))
INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
g_mime_content_type_get_mime_type (content_type));
notmuch show: Don't do text conversions for non-text parts This fixes the recently-added test case (in test/multipart) demonstrating corruption of binary parts that happen to contain CRLF pairs. We restore the original code from show_one_part_content to format_part_content_raw. Then, for good measure, we rename show_part_content to the more descriptive show_text_part_content and add an internal error if it is ever called with a non-text part.
2011-06-01 01:13:21 +02:00
Reduce some excessive indentation. I prefer checking a condition and returning early rather than making large blocks of code within a function conditional.
2011-06-01 01:18:45 +02:00
if (stream_out == NULL)
return;
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01:00
lib: detect mislabeled Windows-1252 parts Use GMime functionality to detect mislabeled messages and apply the correct (Windows) encoding instead.
2018-08-07 14:48:22 +02:00
charset = g_mime_object_get_content_type_parameter (part, "charset");
charset = charset ? g_mime_charset_canon_name (charset) : NULL;
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
wrapper = g_mime_part_get_content (GMIME_PART (part));
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 (wrapper && charset && ! g_ascii_strncasecmp (charset, "iso-8859-", 9)) {
lib: detect mislabeled Windows-1252 parts Use GMime functionality to detect mislabeled messages and apply the correct (Windows) encoding instead.
2018-08-07 14:48:22 +02:00
GMimeStream *null_stream = NULL;
GMimeStream *null_stream_filter = NULL;
/* Check for mislabeled Windows encoding */
null_stream = g_mime_stream_null_new ();
null_stream_filter = g_mime_stream_filter_new (null_stream);
windows_filter = g_mime_filter_windows_new (charset);
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
g_mime_stream_filter_add (GMIME_STREAM_FILTER (null_stream_filter),
windows_filter);
lib: detect mislabeled Windows-1252 parts Use GMime functionality to detect mislabeled messages and apply the correct (Windows) encoding instead.
2018-08-07 14:48:22 +02:00
g_mime_data_wrapper_write_to_stream (wrapper, null_stream_filter);
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
charset = g_mime_filter_windows_real_charset (
lib: detect mislabeled Windows-1252 parts Use GMime functionality to detect mislabeled messages and apply the correct (Windows) encoding instead.
2018-08-07 14:48:22 +02:00
(GMimeFilterWindows *) windows_filter);
if (null_stream_filter)
g_object_unref (null_stream_filter);
if (null_stream)
g_object_unref (null_stream);
/* Keep a reference to windows_filter in order to prevent the
* charset string from deallocation. */
}
Reduce some excessive indentation. I prefer checking a condition and returning early rather than making large blocks of code within a function conditional.
2011-06-01 01:18:45 +02:00
stream_filter = g_mime_stream_filter_new (stream_out);
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
crlf_filter = g_mime_filter_dos2unix_new (false);
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
g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
crlf_filter);
cli/show: unref crlf filter. Mimic the handling of the other filter g_objects. This cleans up a fair sized memory leak.
2017-03-18 18:46:42 +01:00
g_object_unref (crlf_filter);
Reduce some excessive indentation. I prefer checking a condition and returning early rather than making large blocks of code within a function conditional.
2011-06-01 01:18:45 +02:00
if (charset) {
GMimeFilter *charset_filter;
charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
/* This result can be NULL for things like "unknown-8bit".
* Don't set a NULL filter as that makes GMime print
* annoying assertion-failure messages on stderr. */
notmuch: unref charset_filter to fix one memory leak In my test case added g_object_unref(charset_filter) reduces memory consumption over 90% when 'notmuch show --format=text "*"' is executed (~11000 messages, RES ~330M -> ~25M).
2011-12-13 19:18:48 +01:00
if (charset_filter) {
Reduce some excessive indentation. I prefer checking a condition and returning early rather than making large blocks of code within a function conditional.
2011-06-01 01:18:45 +02:00
g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
charset_filter);
notmuch: unref charset_filter to fix one memory leak In my test case added g_object_unref(charset_filter) reduces memory consumption over 90% when 'notmuch show --format=text "*"' is executed (~11000 messages, RES ~330M -> ~25M).
2011-12-13 19:18:48 +01:00
g_object_unref (charset_filter);
}
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01:00
}
show/reply: Unify the code that extracts text parts Previously, show and reply had separate implementations of decoding and printing text parts. Now both use show's implementation, which was more complete. Show's implementation has been extended with an option to add reply quoting to the extracted part (this is implemented as a named flag to avoid naked booleans, even though it's the only flag it can take).
2012-03-27 23:59:50 +02:00
if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
GMimeFilter *reply_filter;
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
reply_filter = g_mime_filter_reply_new (true);
show/reply: Unify the code that extracts text parts Previously, show and reply had separate implementations of decoding and printing text parts. Now both use show's implementation, which was more complete. Show's implementation has been extended with an option to add reply quoting to the extracted part (this is implemented as a named flag to avoid naked booleans, even though it's the only flag it can take).
2012-03-27 23:59:50 +02:00
if (reply_filter) {
g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
reply_filter);
g_object_unref (reply_filter);
}
}
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01:00
if (wrapper && stream_filter)
g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
if (stream_filter)
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
g_object_unref (stream_filter);
lib: detect mislabeled Windows-1252 parts Use GMime functionality to detect mislabeled messages and apply the correct (Windows) encoding instead.
2018-08-07 14:48:22 +02:00
if (windows_filter)
g_object_unref (windows_filter);
notmuch show: Don't hide text parts, even with disposition attachment. If it's text, (such as a patch), then I want to see it.
2009-11-21 01:09:36 +01: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
static const char *
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
signature_status_to_string (GMimeSignatureStatus status)
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
{
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
if (g_mime_signature_status_bad (status))
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
return "bad";
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
if (g_mime_signature_status_error (status))
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
return "error";
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
if (g_mime_signature_status_good (status))
return "good";
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
return "unknown";
}
Add signature verification of PGP/MIME-signed parts with --verify. This is primarily for notmuch-show, although the functionality is added to show-message. Once signatures are processed a new part_sigstatus formatter is emitted, and the entire multipart/signed part is replaced with the contents of the signed part. At the moment only a json part_sigstatus formatting function is available. Emacs support to follow. The original work for this patch was done by Daniel Kahn Gillmor <dkg@fifthhorseman.net> whose help with this functionality I greatly appreciate.
2011-05-26 03:01:17 +02:00
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
/* Print signature flags */
struct key_map_struct {
gmime-cleanup: use GMime 3.0 data types Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:43 +02:00
GMimeSignatureStatus bit;
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
const char *string;
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
};
static void
do_format_signature_errors (sprinter_t *sp, struct key_map_struct *key_map,
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
unsigned int array_map_len, GMimeSignatureStatus errors)
{
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
sp->map_key (sp, "errors");
sp->begin_map (sp);
for (unsigned int i = 0; i < array_map_len; i++) {
if (errors & key_map[i].bit) {
sp->map_key (sp, key_map[i].string);
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
sp->boolean (sp, true);
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
}
}
sp->end (sp);
}
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
static void
format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
{
gmime-cleanup: use GMime 3.0 data types Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:43 +02:00
GMimeSignatureStatus errors = g_mime_signature_get_status (signature);
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +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
if (! (errors & GMIME_SIGNATURE_STATUS_ERROR_MASK))
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
return;
struct key_map_struct key_map[] = {
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
{ GMIME_SIGNATURE_STATUS_KEY_REVOKED, "key-revoked" },
{ GMIME_SIGNATURE_STATUS_KEY_EXPIRED, "key-expired" },
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
{ GMIME_SIGNATURE_STATUS_SIG_EXPIRED, "sig-expired" },
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
{ GMIME_SIGNATURE_STATUS_KEY_MISSING, "key-missing" },
{ GMIME_SIGNATURE_STATUS_CRL_MISSING, "crl-missing" },
{ GMIME_SIGNATURE_STATUS_CRL_TOO_OLD, "crl-too-old" },
{ GMIME_SIGNATURE_STATUS_BAD_POLICY, "bad-policy" },
{ GMIME_SIGNATURE_STATUS_SYS_ERROR, "sys-error" },
{ GMIME_SIGNATURE_STATUS_TOFU_CONFLICT, "tofu-conflict" },
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +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
do_format_signature_errors (sp, key_map, ARRAY_SIZE (key_map), errors);
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
}
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
build: drop support for gmime-2.6 GMime 3.0 is over 2 years old now, and 2.6 has been deprecated in notmuch for about 1.5 years. Comments and documentation no longer need to refer to GMime 2.6, so clean them all up. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:33 +02:00
/* Signature status sprinter */
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
static void
cli/show: pass the siglist directly to the sigstatus sprinter This makes it easier to reuse format_part_sigstatus_sprinter() when we have other places that we want to display a signature status.
2019-04-20 19:51:39 +02:00
format_part_sigstatus_sprinter (sprinter_t *sp, GMimeSignatureList *siglist)
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
{
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
/* Any changes to the JSON or S-Expression format should be
* reflected in the file devel/schemata. */
show: More aggressively document the presence of devel/schemata Previously, the only mention of devel/schemata was a comment at the top of format_part_json, but the JSON output code is spread across several functions that are distributed across notmuch-show.c. Add references from the other three key JSON output functions.
2012-11-07 16:27:01 +01:00
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->begin_list (sp);
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01: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
if (! siglist) {
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->end (sp);
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
return;
}
int i;
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
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->begin_map (sp);
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
/* status */
GMimeSignatureStatus status = g_mime_signature_get_status (signature);
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->map_key (sp, "status");
sp->string (sp, signature_status_to_string (status));
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
if (g_mime_signature_status_good (status)) {
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
if (certificate) {
sp->map_key (sp, "fingerprint");
sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
}
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
/* these dates are seconds since the epoch; should we
* provide a more human-readable format string? */
time_t created = g_mime_signature_get_created (signature);
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
if (created != -1) {
sp->map_key (sp, "created");
sp->integer (sp, created);
}
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
time_t expires = g_mime_signature_get_expires (signature);
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
if (expires > 0) {
sp->map_key (sp, "expires");
sp->integer (sp, expires);
}
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
if (certificate) {
crypto: signature verification reports valid User IDs When i'm trying to understand a message signature, i care that i know who it came from (the "validity" of the identity associated with the key), *not* whether i'm willing to accept the keyholder's other identity assertions (the "trust" associated with the certificate). We've been reporting User ID information based on the "trust" associated with the certificate, because GMime didn't clearly expose the validity of the User IDs. This change relies on fixes made in GMime 3.0.3 and later which include https://github.com/jstedfast/gmime/pull/18.
2017-12-08 21:09:46 +01:00
const char *uid = g_mime_certificate_get_valid_userid (certificate);
if (uid) {
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->map_key (sp, "userid");
crypto: signature verification reports valid User IDs When i'm trying to understand a message signature, i care that i know who it came from (the "validity" of the identity associated with the key), *not* whether i'm willing to accept the keyholder's other identity assertions (the "trust" associated with the certificate). We've been reporting User ID information based on the "trust" associated with the certificate, because GMime didn't clearly expose the validity of the User IDs. This change relies on fixes made in GMime 3.0.3 and later which include https://github.com/jstedfast/gmime/pull/18.
2017-12-08 21:09:46 +01:00
sp->string (sp, uid);
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
}
cli/show: produce "email" element in sigstatus When the certificate that signs a message is known to be valid, GMime is capable of reporting on the e-mail address embedded in the certificate. We pass this information along to the caller of "notmuch show", as often only the e-mail address of the certificate has actually been checked/verified. Furthermore, signature verification should probably at some point compare the e-mail address of the caller against the sender address of the message itself. Having to parse what gmime thinks is a "userid" to extract an e-mail address seems clunky and unnecessary if gmime already thinks it knows what the e-mail address is. See id:878s41ax6t.fsf@fifthhorseman.net for more motivation and discussion. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2021-05-27 03:44:58 +02:00
const char *email = g_mime_certificate_get_valid_email (certificate);
if (email) {
sp->map_key (sp, "email");
sp->string (sp, email);
}
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
}
} else if (certificate) {
cli: make keyid from fingerprint in gmime 3.0 The "key_id" field seems to used for userid in gmime-3.0, while the keyid is dropped in the fingerprint field if the full fingerprint is not available.
2017-06-03 01:57:01 +02:00
const char *key_id = g_mime_certificate_get_fpr16 (certificate);
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
if (key_id) {
sp->map_key (sp, "keyid");
sp->string (sp, key_id);
}
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
}
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
if (notmuch_format_version <= 3) {
gmime-cleanup: use GMime 3.0 data types Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:43 +02:00
GMimeSignatureStatus errors = g_mime_signature_get_status (signature);
cli: generalize use of GMIME_SIGNATURE_{ERROR,STATUS} to gmime-3 The ERROR enum is merged into to the STATUS enum, and the set of flags is different.
2017-05-14 19:49:31 +02:00
if (g_mime_signature_status_error (errors)) {
cli: implement structured output version 4 Since the error field is unused by the emacs front end, no changes are needed other than bumping the format version number. As it is, this is a bit overengineered, but it will reduce duplication when we support gmime 3.0
2017-06-03 19:47:34 +02:00
sp->map_key (sp, "errors");
sp->integer (sp, errors);
}
} else {
format_signature_errors (sp, signature);
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
}
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->end (sp);
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
}
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
show: Convert format_part_sigstatus_json to use sprinter
2012-08-03 03:14:54 +02:00
sp->end (sp);
Add compatibility with gmime 2.6 There are lots of API changes in gmime 2.6 crypto handling. By adding preprocessor directives, it is however possible to add gmime 2.6 compatibility while preserving compatibility with gmime 2.4 too. This is mostly based on id:"8762i8hrb9.fsf@bookbinder.fernseed.info". This was tested against both gmime 2.6.4 and 2.4.31. With gmime 2.4.31, the crypto tests all work fine (as expected). With gmime 2.6.4, one crypto test is currently broken (signature verification with signer key unavailable), most likely because of a bug in gmime which will hopefully be fixed in a future version.
2012-01-20 10:39:24 +01:00
}
cli: conform to same conditional build style as elsewhere in notmuch-show Conform to the same style for #ifdef GMIME_ATLEAST_26 conditional builds as elsewhere. There are no functional changes.
2013-03-30 14:53:17 +01:00
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
static notmuch_status_t
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
int indent, const notmuch_show_params_t *params)
{
/* The disposition and content-type metadata are associated with
* the envelope for message parts */
CLI: replace some constructs with more uncrustify friendly ones In particular - use (bool) instead of !! - cuddle the opening parens of function calls - add parens in some ternery operators
2019-06-13 00:47:20 +02:00
GMimeObject *meta = node->envelope_part ? (
notmuch-show: run uncrustify This is the result of running: $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h In the top level source directory. I was using uncrustify 0.68.1+dfsg1-2. I do not know why these changes were not caught in 33382c2b5ba2537952a60ea378feff36961e4713 Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-07-03 06:31:19 +02:00
GMIME_OBJECT (node->envelope_part) ) : node->part;
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
GMimeContentType *content_type = g_mime_object_get_content_type (meta);
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
const bool leaf = GMIME_IS_PART (node->part);
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
GMimeStream *stream = params->out_stream;
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
const char *part_type;
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
int i;
if (node->envelope_file) {
notmuch_message_t *message = node->envelope_file;
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
part_type = "message";
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
part_type,
notmuch_message_get_message_id (message),
indent,
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
_get_message_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
_get_message_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
notmuch_message_get_filename (message));
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
} else {
cli/show: fix usage of g_mime_content_type_to_string It returns an "allocated string", which needs to be freed.
2017-03-18 18:33:50 +01:00
char *content_string;
cli/show: abstract get content disposition Reduce duplication in follow-up work. As a side effect, handle error returns from g_mime_content_disposition_get_disposition() without segfaulting.
2017-02-26 19:33:47 +01:00
const char *disposition = _get_disposition (meta);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
const char *cid = g_mime_object_get_content_id (meta);
CLI: replace some constructs with more uncrustify friendly ones In particular - use (bool) instead of !! - cuddle the opening parens of function calls - add parens in some ternery operators
2019-06-13 00:47:20 +02:00
const char *filename = leaf ? (
notmuch-show: run uncrustify This is the result of running: $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h In the top level source directory. I was using uncrustify 0.68.1+dfsg1-2. I do not know why these changes were not caught in 33382c2b5ba2537952a60ea378feff36961e4713 Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-07-03 06:31:19 +02:00
g_mime_part_get_filename (GMIME_PART (node->part)) ) : NULL;
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
if (disposition &&
cli/show: abstract get content disposition Reduce duplication in follow-up work. As a side effect, handle error returns from g_mime_content_disposition_get_disposition() without segfaulting.
2017-02-26 19:33:47 +01:00
strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
part_type = "attachment";
else
part_type = "part";
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
if (filename)
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, ", Filename: %s", filename);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
if (cid)
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, ", Content-id: %s", cid);
cli/show: fix usage of g_mime_content_type_to_string It returns an "allocated string", which needs to be freed.
2017-03-18 18:33:50 +01:00
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
content_string = g_mime_content_type_get_mime_type (content_type);
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
cli/show: fix usage of g_mime_content_type_to_string It returns an "allocated string", which needs to be freed.
2017-03-18 18:33:50 +01:00
g_free (content_string);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
}
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
if (GMIME_IS_MESSAGE (node->part)) {
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
GMimeMessage *message = GMIME_MESSAGE (node->part);
cli/show: fix some memory leaks in format_part_text Mimic Jeff Stedfast's changes to format_headers_sprinter, clean up use of internet_address_list_to_string and g_mime_message_get_date_as_string.
2017-03-18 18:07:45 +01:00
char *recipients_string;
char *date_string;
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "\fheader{\n");
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
if (node->envelope_file)
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
lib/cli: replace use of g_mime_message_get_sender This function changes semantics in gmime-3.0 so make a new function that provides the same functionality in both
2017-05-06 04:26:57 +02:00
g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_from_string (message));
cli: replace use of g_mime_message_get_recipients This function, and associated enum, have been renamed and generalized in gmime-3.0.
2017-05-06 13:41:14 +02:00
recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
if (recipients_string)
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "To: %s\n", recipients_string);
cli/show: fix some memory leaks in format_part_text Mimic Jeff Stedfast's changes to format_headers_sprinter, clean up use of internet_address_list_to_string and g_mime_message_get_date_as_string.
2017-03-18 18:07:45 +01:00
g_free (recipients_string);
cli: replace use of g_mime_message_get_recipients This function, and associated enum, have been renamed and generalized in gmime-3.0.
2017-05-06 13:41:14 +02:00
recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
if (recipients_string)
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
cli/show: fix some memory leaks in format_part_text Mimic Jeff Stedfast's changes to format_headers_sprinter, clean up use of internet_address_list_to_string and g_mime_message_get_date_as_string.
2017-03-18 18:07:45 +01:00
g_free (recipients_string);
cli: replace use of g_mime_message_get_date_as_string This function goes away in gmime-3.0. Also, the memory management is apparently error prone, witness the memory leak in notmuch-reply.
2017-05-04 14:48:44 +02:00
date_string = g_mime_message_get_date_string (node, message);
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "Date: %s\n", date_string);
g_mime_stream_printf (stream, "\fheader}\n");
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01: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
if (! params->output_body) {
cli: notmuch show support for --body=false with --format=text
2018-10-31 00:54:31 +01:00
g_mime_stream_printf (stream, "\f%s}\n", part_type);
return NOTMUCH_STATUS_SUCCESS;
}
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "\fbody{\n");
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
}
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
if (leaf) {
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
if (g_mime_content_type_is_type (content_type, "text", "*") &&
cli: notmuch show support for --include-html with --format=text
2018-10-31 00:54:32 +01:00
(params->include_html ||
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
! g_mime_content_type_is_type (content_type, "text", "html"))) {
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
show_text_part_content (node->part, stream, 0);
show: Simplify new text formatter code This makes the text formatter take advantage of the new code structure. The previously duplicated header logic is now unified, several things that we used to compute repeatedly across different callbacks are now computed once, and the code is simpler overall and 32% shorter. Unifying the header logic causes this to format some dates slightly differently, so the two affected test cases are updated.
2012-02-04 22:24:26 +01:00
} else {
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
char *content_string = g_mime_content_type_get_mime_type (content_type);
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
cli/show: fix usage of g_mime_content_type_to_string It returns an "allocated string", which needs to be freed.
2017-03-18 18:33:50 +01:00
g_free (content_string);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
}
}
for (i = 0; i < node->nchildren; i++)
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
if (GMIME_IS_MESSAGE (node->part))
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "\fbody}\n");
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_printf (stream, "\f%s}\n", part_type);
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
return NOTMUCH_STATUS_SUCCESS;
show: Convert text format to the new self-recursive style This is all code movement and a smidgen of glue. This moves the existing text formatter code into one self-recursive function, but doesn't change any of the logic. The next patch will actually take advantage of what the new structure has to offer. Note that this patch retains format_headers_message_part_text because it is also used by the raw format.
2012-02-04 22:24:25 +01:00
}
show: indicate charset for all omitted parts Write a "charset" field for all omitted parts for which it is applicable, not only text/html parts. Factor out the code to a separate function. It will be extended with more fields next.
2012-12-16 00:22:50 +01:00
static void
show: indicate length, encoding of omitted body content If a leaf part's body content is omitted, return the encoded length and transfer encoding in --format=json output. This information may be used by the consumer, e.g. to decide whether to download a large attachment over a slow link. Returning the _encoded_ content length is more efficient than returning the _decoded_ content length. Returning the transfer encoding allows the consumer to estimate the decoded content length.
2012-12-16 00:24:23 +01:00
format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
show: indicate charset for all omitted parts Write a "charset" field for all omitted parts for which it is applicable, not only text/html parts. Factor out the code to a separate function. It will be extended with more fields next.
2012-12-16 00:22:50 +01:00
{
const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
show: indicate length, encoding of omitted body content If a leaf part's body content is omitted, return the encoded length and transfer encoding in --format=json output. This information may be used by the consumer, e.g. to decide whether to download a large attachment over a slow link. Returning the _encoded_ content length is more efficient than returning the _decoded_ content length. Returning the transfer encoding allows the consumer to estimate the decoded content length.
2012-12-16 00:24:23 +01:00
const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
GMimeDataWrapper *wrapper = g_mime_part_get_content (part);
show: indicate length, encoding of omitted body content If a leaf part's body content is omitted, return the encoded length and transfer encoding in --format=json output. This information may be used by the consumer, e.g. to decide whether to download a large attachment over a slow link. Returning the _encoded_ content length is more efficient than returning the _decoded_ content length. Returning the transfer encoding allows the consumer to estimate the decoded content length.
2012-12-16 00:24:23 +01:00
GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
ssize_t content_length = g_mime_stream_length (stream);
show: indicate charset for all omitted parts Write a "charset" field for all omitted parts for which it is applicable, not only text/html parts. Factor out the code to a separate function. It will be extended with more fields next.
2012-12-16 00:22:50 +01:00
if (content_charset != NULL) {
sp->map_key (sp, "content-charset");
sp->string (sp, content_charset);
}
show: indicate length, encoding of omitted body content If a leaf part's body content is omitted, return the encoded length and transfer encoding in --format=json output. This information may be used by the consumer, e.g. to decide whether to download a large attachment over a slow link. Returning the _encoded_ content length is more efficient than returning the _decoded_ content length. Returning the transfer encoding allows the consumer to estimate the decoded content length.
2012-12-16 00:24:23 +01:00
if (cte != NULL) {
sp->map_key (sp, "content-transfer-encoding");
sp->string (sp, cte);
}
if (content_length >= 0) {
sp->map_key (sp, "content-length");
sp->integer (sp, content_length);
}
show: indicate charset for all omitted parts Write a "charset" field for all omitted parts for which it is applicable, not only text/html parts. Factor out the code to a separate function. It will be extended with more fields next.
2012-12-16 00:22:50 +01:00
}
reply: Add a JSON reply format. This new JSON format for replies includes headers generated for a reply message as well as the headers of the original message. Using this data, a client can intelligently create a reply. For example, the emacs client will be able to create replies with quoted HTML parts by parsing the HTML parts.
2012-03-18 17:32:36 +01:00
void
Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. All the structured output functions in notmuch-reply and notmuch-show are renamed to a generic name (as they do not contain any json-specific code anyway). This patch is a preparation to actually using the new S-Expression sprinter in notmuch-reply and notmuch-show.
2012-12-06 22:12:12 +01:00
format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
CLI/show: support --duplicate for structured output This introduces a new mandatory key for message structures, namely "duplicate". Per convention in devel/schemata this does _not_ increase the format version. This means that clients are responsible for checking that it exists, and not crashing if it does not. The main functional change is teaching mime_node_open to understand a 'duplicate' argument. Support for --duplicate in notmuch-reply would make sense, but we defer it to a later commit.
2022-07-01 23:45:44 +02:00
int duplicate,
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 output_body,
bool include_html)
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
{
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
/* Any changes to the JSON or S-Expression format should be
* reflected in the file devel/schemata. */
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
if (node->envelope_file) {
cli/show: emit payload subject instead of outside subject Correctly fix the two outstanding tests so that the protected (hidden) subject is properly reported. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:58 +02:00
const _notmuch_message_crypto_t *msg_crypto = NULL;
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->begin_map (sp);
Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. All the structured output functions in notmuch-reply and notmuch-show are renamed to a generic name (as they do not contain any json-specific code anyway). This patch is a preparation to actually using the new S-Expression sprinter in notmuch-reply and notmuch-show.
2012-12-06 22:12:12 +01:00
format_message_sprinter (sp, node->envelope_file);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
CLI/show: support --duplicate for structured output This introduces a new mandatory key for message structures, namely "duplicate". Per convention in devel/schemata this does _not_ increase the format version. This means that clients are responsible for checking that it exists, and not crashing if it does not. The main functional change is teaching mime_node_open to understand a 'duplicate' argument. Support for --duplicate in notmuch-reply would make sense, but we defer it to a later commit.
2022-07-01 23:45:44 +02:00
sp->map_key (sp, "duplicate");
sp->integer (sp, duplicate > 0 ? duplicate : 1);
cli: add --body=true|false option to notmuch-show.c This option allows the caller to suppress the output of the bodies of the messages. Currently this is only implemented for format=json. This is used by notmuch-pick.el (although not needed) because it gives a speed-up of at least a factor of a two (and in some cases a speed up of more than a factor of 8); moreover it reduces the memory usage in emacs hugely.
2012-07-24 20:23:27 +02:00
if (output_body) {
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->map_key (sp, "body");
sp->begin_list (sp);
CLI/show: support --duplicate for structured output This introduces a new mandatory key for message structures, namely "duplicate". Per convention in devel/schemata this does _not_ increase the format version. This means that clients are responsible for checking that it exists, and not crashing if it does not. The main functional change is teaching mime_node_open to understand a 'duplicate' argument. Support for --duplicate in notmuch-reply would make sense, but we defer it to a later commit.
2022-07-01 23:45:44 +02:00
format_part_sprinter (ctx, sp, mime_node_child (node, 0), -1, true, include_html);
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->end (sp);
cli: add --body=true|false option to notmuch-show.c This option allows the caller to suppress the output of the bodies of the messages. Currently this is only implemented for format=json. This is used by notmuch-pick.el (although not needed) because it gives a speed-up of at least a factor of a two (and in some cases a speed up of more than a factor of 8); moreover it reduces the memory usage in emacs hugely.
2012-07-24 20:23:27 +02:00
}
cli/show: emit new whole-message crypto status output This allows MUAs that don't want to think about per-mime-part cryptographic status to have a simple high-level overview of the message's cryptographic state. Sensibly structured encrypted and/or signed messages will work fine with this. The only requirement for the simplest encryption + signing is that the message have all of its encryption and signing protection (the "cryptographic envelope") in a contiguous set of MIME layers at the very outside of the message itself. This is because messages with some subparts signed or encrypted, but with other subparts with no cryptographic protection is very difficult to reason about, and even harder for the user to make sense of or work with. For further characterization of the Cryptographic Envelope and some of the usability tradeoffs, see here: https://dkg.fifthhorseman.net/blog/e-mail-cryptography.html#cryptographic-envelope
2019-05-25 20:04:06 +02:00
cli/show: emit payload subject instead of outside subject Correctly fix the two outstanding tests so that the protected (hidden) subject is properly reported. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:58 +02:00
msg_crypto = mime_node_get_message_crypto_status (node);
cli/show: emit new whole-message crypto status output This allows MUAs that don't want to think about per-mime-part cryptographic status to have a simple high-level overview of the message's cryptographic state. Sensibly structured encrypted and/or signed messages will work fine with this. The only requirement for the simplest encryption + signing is that the message have all of its encryption and signing protection (the "cryptographic envelope") in a contiguous set of MIME layers at the very outside of the message itself. This is because messages with some subparts signed or encrypted, but with other subparts with no cryptographic protection is very difficult to reason about, and even harder for the user to make sense of or work with. For further characterization of the Cryptographic Envelope and some of the usability tradeoffs, see here: https://dkg.fifthhorseman.net/blog/e-mail-cryptography.html#cryptographic-envelope
2019-05-25 20:04:06 +02:00
if (notmuch_format_version >= 4) {
sp->map_key (sp, "crypto");
sp->begin_map (sp);
if (msg_crypto->sig_list ||
msg_crypto->decryption_status != NOTMUCH_MESSAGE_DECRYPTED_NONE) {
if (msg_crypto->sig_list) {
sp->map_key (sp, "signed");
sp->begin_map (sp);
sp->map_key (sp, "status");
format_part_sigstatus_sprinter (sp, msg_crypto->sig_list);
if (msg_crypto->signature_encrypted) {
sp->map_key (sp, "encrypted");
sp->boolean (sp, msg_crypto->signature_encrypted);
}
cli/show: add information about which headers were protected The header-mask member of the per-message crypto object allows a clever UI frontend to mark whether a header was protected (or not). And if it was protected, it contains enough information to show useful detail to an interested user. For example, an MUA could offer a "show what this message's Subject looked like on the wire" feature in expert mode. As before, we only handle Subject for now, but we might be able to handle other headers in the future. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net> Amended by db: tweaked schemata notation.
2019-05-28 00:14:16 +02:00
if (msg_crypto->payload_subject) {
sp->map_key (sp, "headers");
sp->begin_list (sp);
sp->string (sp, "Subject");
sp->end (sp);
}
cli/show: emit new whole-message crypto status output This allows MUAs that don't want to think about per-mime-part cryptographic status to have a simple high-level overview of the message's cryptographic state. Sensibly structured encrypted and/or signed messages will work fine with this. The only requirement for the simplest encryption + signing is that the message have all of its encryption and signing protection (the "cryptographic envelope") in a contiguous set of MIME layers at the very outside of the message itself. This is because messages with some subparts signed or encrypted, but with other subparts with no cryptographic protection is very difficult to reason about, and even harder for the user to make sense of or work with. For further characterization of the Cryptographic Envelope and some of the usability tradeoffs, see here: https://dkg.fifthhorseman.net/blog/e-mail-cryptography.html#cryptographic-envelope
2019-05-25 20:04:06 +02:00
sp->end (sp);
}
if (msg_crypto->decryption_status != NOTMUCH_MESSAGE_DECRYPTED_NONE) {
sp->map_key (sp, "decrypted");
sp->begin_map (sp);
sp->map_key (sp, "status");
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
sp->string (sp, msg_crypto->decryption_status == NOTMUCH_MESSAGE_DECRYPTED_FULL ?
"full" : "partial");
cli/show: add information about which headers were protected The header-mask member of the per-message crypto object allows a clever UI frontend to mark whether a header was protected (or not). And if it was protected, it contains enough information to show useful detail to an interested user. For example, an MUA could offer a "show what this message's Subject looked like on the wire" feature in expert mode. As before, we only handle Subject for now, but we might be able to handle other headers in the future. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net> Amended by db: tweaked schemata notation.
2019-05-28 00:14:16 +02:00
if (msg_crypto->payload_subject) {
const char *subject = g_mime_message_get_subject GMIME_MESSAGE (node->part);
if (subject == NULL || strcmp (subject, msg_crypto->payload_subject)) {
/* protected subject differs from the external header */
sp->map_key (sp, "header-mask");
sp->begin_map (sp);
sp->map_key (sp, "Subject");
if (subject == NULL)
sp->null (sp);
else
sp->string (sp, subject);
sp->end (sp);
}
}
cli/show: emit new whole-message crypto status output This allows MUAs that don't want to think about per-mime-part cryptographic status to have a simple high-level overview of the message's cryptographic state. Sensibly structured encrypted and/or signed messages will work fine with this. The only requirement for the simplest encryption + signing is that the message have all of its encryption and signing protection (the "cryptographic envelope") in a contiguous set of MIME layers at the very outside of the message itself. This is because messages with some subparts signed or encrypted, but with other subparts with no cryptographic protection is very difficult to reason about, and even harder for the user to make sense of or work with. For further characterization of the Cryptographic Envelope and some of the usability tradeoffs, see here: https://dkg.fifthhorseman.net/blog/e-mail-cryptography.html#cryptographic-envelope
2019-05-25 20:04:06 +02:00
sp->end (sp);
}
}
sp->end (sp);
}
cli/show: emit headers after emitting body This paves the way for emitting protected headers after verification and decryption, because it means that the headers will only be emitted after the body has been parsed. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:54 +02:00
sp->map_key (sp, "headers");
cli/show: emit payload subject instead of outside subject Correctly fix the two outstanding tests so that the protected (hidden) subject is properly reported. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:58 +02:00
format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false, msg_crypto);
cli/show: emit headers after emitting body This paves the way for emitting protected headers after verification and decryption, because it means that the headers will only be emitted after the body has been parsed. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:54 +02:00
show: Convert envelope format_part_json to use sprinter
2012-08-03 03:14:56 +02:00
sp->end (sp);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
return;
}
/* The disposition and content-type metadata are associated with
* the envelope for message parts */
CLI: replace some constructs with more uncrustify friendly ones In particular - use (bool) instead of !! - cuddle the opening parens of function calls - add parens in some ternery operators
2019-06-13 00:47:20 +02:00
GMimeObject *meta = node->envelope_part ? (
notmuch-show: run uncrustify This is the result of running: $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h In the top level source directory. I was using uncrustify 0.68.1+dfsg1-2. I do not know why these changes were not caught in 33382c2b5ba2537952a60ea378feff36961e4713 Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-07-03 06:31:19 +02:00
GMIME_OBJECT (node->envelope_part) ) : node->part;
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
GMimeContentType *content_type = g_mime_object_get_content_type (meta);
cli/show: fix usage of g_mime_content_type_to_string It returns an "allocated string", which needs to be freed.
2017-03-18 18:33:50 +01:00
char *content_string;
cli/show: add content-disposition to structured output message parts Help the clients decide how to display parts. Test updates by Mark Walters <markwalters1009@gmail.com>. One more test fix by db
2017-02-26 19:33:48 +01:00
const char *disposition = _get_disposition (meta);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
const char *cid = g_mime_object_get_content_id (meta);
CLI: replace some constructs with more uncrustify friendly ones In particular - use (bool) instead of !! - cuddle the opening parens of function calls - add parens in some ternery operators
2019-06-13 00:47:20 +02:00
const char *filename = GMIME_IS_PART (node->part) ? (
g_mime_part_get_filename (GMIME_PART (node->part) ) ) : NULL;
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
int nclose = 0;
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
int i;
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->begin_map (sp);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "id");
sp->integer (sp, node->part_num);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
if (node->decrypt_attempted) {
sp->map_key (sp, "encstatus");
sp->begin_list (sp);
sp->begin_map (sp);
sp->map_key (sp, "status");
sp->string (sp, node->decrypt_success ? "good" : "bad");
sp->end (sp);
sp->end (sp);
}
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
if (node->verify_attempted) {
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "sigstatus");
cli/show: pass the siglist directly to the sigstatus sprinter This makes it easier to reuse format_part_sigstatus_sprinter() when we have other places that we want to display a signature status.
2019-04-20 19:51:39 +02:00
format_part_sigstatus_sprinter (sp, node->sig_list);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
}
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "content-type");
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
content_string = g_mime_content_type_get_mime_type (content_type);
cli/show: fix usage of g_mime_content_type_to_string It returns an "allocated string", which needs to be freed.
2017-03-18 18:33:50 +01:00
sp->string (sp, content_string);
g_free (content_string);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
cli/show: add content-disposition to structured output message parts Help the clients decide how to display parts. Test updates by Mark Walters <markwalters1009@gmail.com>. One more test fix by db
2017-02-26 19:33:48 +01:00
if (disposition) {
sp->map_key (sp, "content-disposition");
sp->string (sp, disposition);
}
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
if (cid) {
sp->map_key (sp, "content-id");
sp->string (sp, cid);
}
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
if (filename) {
sp->map_key (sp, "filename");
sp->string (sp, filename);
}
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
show: Further general simplifications of the JSON formatter
2012-02-20 01:26:30 +01:00
if (GMIME_IS_PART (node->part)) {
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
/* For non-HTML text parts, we include the content in the
* JSON. Since JSON must be Unicode, we handle charset
* decoding here and do not report a charset to the caller.
cli: add --include-html option to notmuch show For my client, the largest bottleneck for displaying large threads is exporting each html part individually since by default notmuch will not show the json parts. For large threads there can be quite a few parts and each must be exported and decoded one by one. Also, I then have to deal with all the crazy charsets which I can do through a library but is a pain. Therefore, this patch adds an --include-html option that causes the text/html parts to be included as part of the output of show. diff man/man1/notmuch-show.1
2013-07-02 02:19:42 +02:00
* For text/html parts, we do not include the content unless
* the --include-html option has been passed. If a html part
* is not included, it can be requested directly. This makes
* charset decoding the responsibility on the caller so we
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
* report the charset for text/html parts.
*/
show: indicate charset for all omitted parts Write a "charset" field for all omitted parts for which it is applicable, not only text/html parts. Factor out the code to a separate function. It will be extended with more fields next.
2012-12-16 00:22:50 +01:00
if (g_mime_content_type_is_type (content_type, "text", "*") &&
cli: add --include-html option to notmuch show For my client, the largest bottleneck for displaying large threads is exporting each html part individually since by default notmuch will not show the json parts. For large threads there can be quite a few parts and each must be exported and decoded one by one. Also, I then have to deal with all the crazy charsets which I can do through a library but is a pain. Therefore, this patch adds an --include-html option that causes the text/html parts to be included as part of the output of show. diff man/man1/notmuch-show.1
2013-07-02 02:19:42 +02:00
(include_html ||
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
! g_mime_content_type_is_type (content_type, "text", "html"))) {
show: Further general simplifications of the JSON formatter
2012-02-20 01:26:30 +01:00
GMimeStream *stream_memory = g_mime_stream_mem_new ();
GByteArray *part_content;
show/reply: Unify the code that extracts text parts Previously, show and reply had separate implementations of decoding and printing text parts. Now both use show's implementation, which was more complete. Show's implementation has been extended with an option to add reply quoting to the extracted part (this is implemented as a named flag to avoid naked booleans, even though it's the only flag it can take).
2012-03-27 23:59:50 +02:00
show_text_part_content (node->part, stream_memory, 0);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "content");
sp->string_len (sp, (char *) part_content->data, part_content->len);
show: Further general simplifications of the JSON formatter
2012-02-20 01:26:30 +01:00
g_object_unref (stream_memory);
show: indicate charset for all omitted parts Write a "charset" field for all omitted parts for which it is applicable, not only text/html parts. Factor out the code to a separate function. It will be extended with more fields next.
2012-12-16 00:22:50 +01:00
} else {
cli/show: If a leaf part has children, show them instead of omitting Until we did PKCS#7 unwrapping, no leaf MIME part could have a child. Now, we treat the unwrapped MIME part as the child of the PKCS#7 SignedData object. So in that case, we want to show it instead of deliberately omitting the content. This fixes the test of the protected subject in id:smime-onepart-signed@protected-headers.example. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2020-05-13 00:29:34 +02:00
/* if we have a child part despite being a standard
* (non-multipart) MIME part, that means there is
* something to unwrap, which we will present in
* content: */
if (node->nchildren) {
sp->map_key (sp, "content");
sp->begin_list (sp);
nclose = 1;
} else
format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
}
show: Further general simplifications of the JSON formatter
2012-02-20 01:26:30 +01:00
} else if (GMIME_IS_MULTIPART (node->part)) {
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "content");
sp->begin_list (sp);
nclose = 1;
show: Further general simplifications of the JSON formatter
2012-02-20 01:26:30 +01:00
} else if (GMIME_IS_MESSAGE (node->part)) {
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "content");
sp->begin_list (sp);
sp->begin_map (sp);
sp->map_key (sp, "headers");
cli/show: emit payload subject instead of outside subject Correctly fix the two outstanding tests so that the protected (hidden) subject is properly reported. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-27 00:15:58 +02:00
format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false, NULL);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
sp->map_key (sp, "body");
sp->begin_list (sp);
nclose = 3;
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
}
for (i = 0; i < node->nchildren; i++)
CLI/show: support --duplicate for structured output This introduces a new mandatory key for message structures, namely "duplicate". Per convention in devel/schemata this does _not_ increase the format version. This means that clients are responsible for checking that it exists, and not crashing if it does not. The main functional change is teaching mime_node_open to understand a 'duplicate' argument. Support for --duplicate in notmuch-reply would make sense, but we defer it to a later commit.
2022-07-01 23:45:44 +02:00
format_part_sprinter (ctx, sp, mime_node_child (node, i), -1, true, include_html);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
show: Convert non-envelope format_part_json to use sprinter
2012-08-03 03:14:55 +02:00
/* Close content structures */
for (i = 0; i < nclose; i++)
sp->end (sp);
/* Close part map */
sp->end (sp);
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
}
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
static notmuch_status_t
Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. All the structured output functions in notmuch-reply and notmuch-show are renamed to a generic name (as they do not contain any json-specific code anyway). This patch is a preparation to actually using the new S-Expression sprinter in notmuch-reply and notmuch-show.
2012-12-06 22:12:12 +01:00
format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
mime_node_t *node, unused (int indent),
const notmuch_show_params_t *params)
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
{
CLI/show: support --duplicate for structured output This introduces a new mandatory key for message structures, namely "duplicate". Per convention in devel/schemata this does _not_ increase the format version. This means that clients are responsible for checking that it exists, and not crashing if it does not. The main functional change is teaching mime_node_open to understand a 'duplicate' argument. Support for --duplicate in notmuch-reply would make sense, but we defer it to a later commit.
2022-07-01 23:45:44 +02:00
format_part_sprinter (ctx, sp, node, params->duplicate, params->output_body,
params->include_html);
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
return NOTMUCH_STATUS_SUCCESS;
show: Convert JSON format to the new self-recursive style As before, this is all code movement and a smidgen of glue. This moves the existing JSON formatter code into one self-recursive function, but doesn't change any of the logic to take advantage of the new structure. In general, "leafs" of the JSON structure are left in helper functions (most of them untouched), so that it's easy to see the overall structure of the format from the main recursive function.
2012-02-20 01:26:24 +01:00
}
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
/* Print a message in "mboxrd" format as documented, for example,
* here:
*
* http://qmail.org/qmail-manual-html/man5/mbox.html
*/
show: Convert mbox format to new self-recursive style Given the lack of recursion, this is pretty easy.
2012-03-06 19:48:41 +01:00
static notmuch_status_t
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
unused (int indent),
show: Convert mbox format to new self-recursive style Given the lack of recursion, this is pretty easy.
2012-03-06 19:48:41 +01:00
unused (const notmuch_show_params_t *params))
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
{
show: Convert mbox format to new self-recursive style Given the lack of recursion, this is pretty easy.
2012-03-06 19:48:41 +01:00
notmuch_message_t *message = node->envelope_file;
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
const char *filename;
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
gzFile file;
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
const char *from;
time_t date;
struct tm date_gmtime;
char date_asctime[26];
char *line = NULL;
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
ssize_t line_size;
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
ssize_t line_len;
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 (! message)
show: Convert mbox format to new self-recursive style Given the lack of recursion, this is pretty easy.
2012-03-06 19:48:41 +01:00
INTERNAL_ERROR ("format_part_mbox requires a root part");
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
filename = notmuch_message_get_filename (message);
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
file = gzopen (filename, "r");
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
if (file == NULL) {
fprintf (stderr, "Failed to open %s: %s\n",
filename, strerror (errno));
show: Convert mbox format to new self-recursive style Given the lack of recursion, this is pretty easy.
2012-03-06 19:48:41 +01:00
return NOTMUCH_STATUS_FILE_ERROR;
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
}
from = notmuch_message_get_header (message, "from");
from = _extract_email_address (ctx, from);
date = notmuch_message_get_date (message);
gmtime_r (&date, &date_gmtime);
asctime_r (&date_gmtime, date_asctime);
printf ("From %s %s", from, date_asctime);
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
while ((line_len = gz_getline (message, &line, &line_size, file)) != UTIL_EOF ) {
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
if (_is_from_line (line))
putchar ('>');
printf ("%s", line);
}
printf ("\n");
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
gzclose (file);
show: Convert mbox format to new self-recursive style Given the lack of recursion, this is pretty easy.
2012-03-06 19:48:41 +01:00
return NOTMUCH_STATUS_SUCCESS;
show: Move format_message_mbox with the other new-style formats Just code motion.
2012-03-06 19:48:40 +01:00
}
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
static notmuch_status_t
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
mime_node_t *node, unused (int indent),
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
const notmuch_show_params_t *params)
show: Move format_part_content_raw with the other new-style formats Just code motion.
2012-03-06 19:48:42 +01:00
{
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
if (node->envelope_file) {
/* Special case the entire message to avoid MIME parsing. */
const char *filename;
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
GMimeStream *stream = NULL;
ssize_t ssize;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
char buf[4096];
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
notmuch_status_t ret = NOTMUCH_STATUS_FILE_ERROR;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
CLI/show: initial support for --duplicate for (raw output only) Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.
2022-07-01 23:45:43 +02:00
filename = _get_filename (node->envelope_file, params->duplicate);
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
if (filename == NULL) {
fprintf (stderr, "Error: Cannot get message filename.\n");
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
goto DONE;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
}
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
stream = g_mime_stream_gzfile_open (filename);
if (stream == NULL) {
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
goto DONE;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
}
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
while (! g_mime_stream_eos (stream)) {
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
ssize = g_mime_stream_read (stream, buf, sizeof (buf));
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
if (ssize < 0) {
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
fprintf (stderr, "Error: Read failed from %s\n", filename);
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
goto DONE;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
}
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
if (ssize > 0 && fwrite (buf, ssize, 1, stdout) != 1) {
notmuch-show: use correct format specifier for ssize_t Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
2021-01-24 17:07:57 +01:00
fprintf (stderr, "Error: Write %zd chars to stdout failed\n", ssize);
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
goto DONE;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
}
}
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
ret = NOTMUCH_STATUS_SUCCESS;
/* XXX This DONE is just for the special case of a node in a single file */
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
DONE:
cli/notmuch-show: support gzipped files This drops "file" from mime_node_context and just uses a local variable. It also uses the new gzip aware utility routines recently added to util/gmime-extra.c. The use of gzopen / gzfile in addition is a bit icky, but the choice is between that, and providing yet another readline implimentation that understands GMime streams.
2019-03-24 04:32:44 +01:00
if (stream)
g_object_unref (stream);
return ret;
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
}
show: Move format_part_content_raw with the other new-style formats Just code motion.
2012-03-06 19:48:42 +01:00
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
show: Move format_part_content_raw with the other new-style formats Just code motion.
2012-03-06 19:48:42 +01:00
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
if (GMIME_IS_PART (node->part)) {
/* For leaf parts, we emit only the transfer-decoded
* body. */
GMimeDataWrapper *wrapper;
gmime-cleanup: use GMime 3.0 function names Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:44 +02:00
wrapper = g_mime_part_get_content (GMIME_PART (node->part));
show: Move format_part_content_raw with the other new-style formats Just code motion.
2012-03-06 19:48:42 +01:00
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
if (wrapper && stream_filter)
g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
} else {
/* Write out the whole part. For message parts (the root
* part and embedded message parts), this will be the
* message including its headers (but not the
* encapsulating part's headers). For multipart parts,
* this will include the headers. */
if (stream_filter)
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
g_mime_object_write_to_stream (node->part, NULL, stream_filter);
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
}
show: Move format_part_content_raw with the other new-style formats Just code motion.
2012-03-06 19:48:42 +01:00
if (stream_filter)
g_object_unref (stream_filter);
show: Convert raw format to the new self-recursive style, properly support interior parts This is fully compatible for root and leaf parts, but now has proper support for interior parts. This requires some design decisions that were guided by what I would want if I were to save a part. Specifically: - Leaf parts are printed without headers and with transfer decoding. This is what makes sense for saving attachments. (Furthermore, the transfer decoding is necessary since, without the headers, the caller would not be able to interpret non-transfer-decoded output.) - Message parts are printed with their message headers, but without enclosing part headers. This is what makes sense for saving a message as a whole (which is a message part) and for saving attached messages. This is symmetric for whole messages and for attached messages, though we special-case the whole message for performance reasons (and corner-case correctness reasons: given malformed input, GMime may not be able to reproduce it from the parsed representation). - Multipart parts are printed with their headers and all child parts. It's not clear what the best thing to do for multipart is, but this was the most natural to implement and can be justified because such parts can't be interpreted without their headers. As an added benefit, we can move the special-case code for part 0 into the raw formatter.
2012-03-06 19:48:43 +01:00
return NOTMUCH_STATUS_SUCCESS;
show: Move format_part_content_raw with the other new-style formats Just code motion.
2012-03-06 19:48:42 +01:00
}
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
static notmuch_status_t
pass entire format structure to various show_message functions Various show_message* functions require formatting functions, which were previously being passed individually as arguments. Since we will need to be needing to passing in more formatting function in the future (ie. for crypto support), we here modify things so that we just pass in the entire format structure. This will make things much simpler down the line as we need to pass in new format functions. We move the show_format structure into notmuch-client.c as notmuch_show_format. This also affects notmuch-reply.c, so we create a mostly-empty format_reply to pass the reply_part function to show_message_body.
2011-05-20 20:45:33 +02:00
show_message (void *ctx,
const notmuch_show_format_t *format,
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
sprinter_t *sp,
pass entire format structure to various show_message functions Various show_message* functions require formatting functions, which were previously being passed individually as arguments. Since we will need to be needing to passing in more formatting function in the future (ie. for crypto support), we here modify things so that we just pass in the entire format structure. This will make things much simpler down the line as we need to pass in new format functions. We move the show_format structure into notmuch-client.c as notmuch_show_format. This also affects notmuch-reply.c, so we create a mostly-empty format_reply to pass the reply_part function to show_message_body.
2011-05-20 20:45:33 +02:00
notmuch_message_t *message,
New part output handling as option to notmuch-show. Outputting of single MIME parts is moved to an option of notmuch show, instead of being handled in it's own sub-command. The recent rework of multipart mime allowed for this change but consolidating part handling into a single recursive function (show_message_part) that includes formatting. This allows for far simpler handling single output of a single part, including formatting.
2011-05-24 00:31:32 +02:00
int indent,
notmuch_show_params_t *params)
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
{
show: Remove support for old-style formatters in show_message show_message used to have a compatibility path for old-style formatters. This removes that.
2012-04-08 02:57:46 +02:00
void *local = talloc_new (ctx);
mime_node_t *root, *part;
notmuch_status_t status;
cli/show: reindex when we learned new session keys about a message If the number of session keys for a given message increased after running "notmuch show" then we just learned something new that might let us do automatic decryption. We should reindex this message using our newfound knowledge. Amended by db: add previously discussed #if block
2018-05-11 08:57:57 +02:00
unsigned int session_keys = 0;
notmuch_status_t session_key_count_error = NOTMUCH_STATUS_SUCCESS;
if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
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
session_key_count_error = notmuch_message_count_properties (message, "session-key",
&session_keys);
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
CLI/show: support --duplicate for structured output This introduces a new mandatory key for message structures, namely "duplicate". Per convention in devel/schemata this does _not_ increase the format version. This means that clients are responsible for checking that it exists, and not crashing if it does not. The main functional change is teaching mime_node_open to understand a 'duplicate' argument. Support for --duplicate in notmuch-reply would make sense, but we defer it to a later commit.
2022-07-01 23:45:44 +02:00
status = mime_node_open (local, message, params->duplicate, &(params->crypto), &root);
show: Remove support for old-style formatters in show_message show_message used to have a compatibility path for old-style formatters. This removes that.
2012-04-08 02:57:46 +02:00
if (status)
goto DONE;
part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
if (part)
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
status = format->part (local, sp, part, indent, params);
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
if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE && session_key_count_error ==
NOTMUCH_STATUS_SUCCESS) {
cli/show: reindex when we learned new session keys about a message If the number of session keys for a given message increased after running "notmuch show" then we just learned something new that might let us do automatic decryption. We should reindex this message using our newfound knowledge. Amended by db: add previously discussed #if block
2018-05-11 08:57:57 +02:00
unsigned int new_session_keys = 0;
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
if (notmuch_message_count_properties (message, "session-key", &new_session_keys) ==
NOTMUCH_STATUS_SUCCESS &&
cli/show: reindex when we learned new session keys about a message If the number of session keys for a given message increased after running "notmuch show" then we just learned something new that might let us do automatic decryption. We should reindex this message using our newfound knowledge. Amended by db: add previously discussed #if block
2018-05-11 08:57:57 +02:00
new_session_keys > session_keys) {
/* try a quiet re-indexing */
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
notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (
notmuch_message_get_database (message));
cli/show: reindex when we learned new session keys about a message If the number of session keys for a given message increased after running "notmuch show" then we just learned something new that might let us do automatic decryption. We should reindex this message using our newfound knowledge. Amended by db: add previously discussed #if block
2018-05-11 08:57:57 +02:00
if (indexopts) {
notmuch_indexopts_set_decrypt_policy (indexopts, NOTMUCH_DECRYPT_AUTO);
print_status_message ("Error re-indexing message with --decrypt=stash",
message, notmuch_message_reindex (message, indexopts));
}
}
}
notmuch-show: run uncrustify This is the result of running: $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h In the top level source directory. I was using uncrustify 0.68.1+dfsg1-2. I do not know why these changes were not caught in 33382c2b5ba2537952a60ea378feff36961e4713 Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-07-03 06:31:19 +02:00
DONE:
show: Remove support for old-style formatters in show_message show_message used to have a compatibility path for old-style formatters. This removes that.
2012-04-08 02:57:46 +02:00
talloc_free (local);
return status;
New part output handling as option to notmuch-show. Outputting of single MIME parts is moved to an option of notmuch show, instead of being handled in it's own sub-command. The recent rework of multipart mime allowed for this change but consolidating part handling into a single recursive function (show_message_part) that includes formatting. This allows for far simpler handling single output of a single part, including formatting.
2011-05-24 00:31:32 +02:00
}
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
static notmuch_status_t
pass entire format structure to various show_message functions Various show_message* functions require formatting functions, which were previously being passed individually as arguments. Since we will need to be needing to passing in more formatting function in the future (ie. for crypto support), we here modify things so that we just pass in the entire format structure. This will make things much simpler down the line as we need to pass in new format functions. We move the show_format structure into notmuch-client.c as notmuch_show_format. This also affects notmuch-reply.c, so we create a mostly-empty format_reply to pass the reply_part function to show_message_body.
2011-05-20 20:45:33 +02:00
show_messages (void *ctx,
const notmuch_show_format_t *format,
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
sprinter_t *sp,
pass entire format structure to various show_message functions Various show_message* functions require formatting functions, which were previously being passed individually as arguments. Since we will need to be needing to passing in more formatting function in the future (ie. for crypto support), we here modify things so that we just pass in the entire format structure. This will make things much simpler down the line as we need to pass in new format functions. We move the show_format structure into notmuch-client.c as notmuch_show_format. This also affects notmuch-reply.c, so we create a mostly-empty format_reply to pass the reply_part function to show_message_body.
2011-05-20 20:45:33 +02:00
notmuch_messages_t *messages,
int indent,
create notmuch_show_params_t structure for holding parameters passed to show functions. This simplifies the passing of arguments to the show functions. This will be very useful as we accumulate more parameters that will need to be passed. Currently only the entire_thread parameter is passed this way.
2011-05-21 00:01:52 +02:00
notmuch_show_params_t *params)
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
{
notmuch_message_t *message;
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 match;
bool excluded;
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
int next_indent;
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
show: Convert show_message to use sprinter Unlike the previous patches, this function is used for all formats. However, for formats other than the JSON format, the sprinter methods used by show_message are all no-ops, so this code continues to function correctly for all of the formats. Converting show_message eliminates show_null_message in the process, since this maps directly to an sprinter method.
2012-08-03 03:14:57 +02:00
sp->begin_list (sp);
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 show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
for (;
lib: Rename iterator functions to prepare for reverse iteration. We rename 'has_more' to 'valid' so that it can function whether iterating in a forward or reverse direction. We also rename 'advance' to 'move_to_next' to setup parallel naming with the proposed functions 'move_to_first', 'move_to_last', and 'move_to_previous'.
2010-03-09 18:22:29 +01:00
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)) {
show: Convert show_message to use sprinter Unlike the previous patches, this function is used for all formats. However, for formats other than the JSON format, the sprinter methods used by show_message are all no-ops, so this code continues to function correctly for all of the formats. Converting show_message eliminates show_null_message in the process, since this maps directly to an sprinter method.
2012-08-03 03:14:57 +02:00
sp->begin_list (sp);
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 show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
message = notmuch_messages_get (messages);
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
match = _get_message_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
excluded = _get_message_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
next_indent = indent;
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 ((match && (! excluded || ! params->omit_excluded)) || params->entire_thread) {
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
status = show_message (ctx, format, sp, message, indent, params);
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 (status && ! res)
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
res = status;
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
next_indent = indent + 1;
cli: Let json output "null" messages for non --entire-thread All formats except Json can output empty messages for non entire-thread, but in Json format we output "null" to keep the other elements (e.g. the replies to the omitted message) in the correct place.
2012-06-16 12:21:43 +02:00
} else {
show: Convert show_message to use sprinter Unlike the previous patches, this function is used for all formats. However, for formats other than the JSON format, the sprinter methods used by show_message are all no-ops, so this code continues to function correctly for all of the formats. Converting show_message eliminates show_null_message in the process, since this maps directly to an sprinter method.
2012-08-03 03:14:57 +02:00
sp->null (sp);
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
}
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
status = show_messages (ctx,
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
format, sp,
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
notmuch_message_get_replies (message),
next_indent,
params);
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 (status && ! res)
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
res = status;
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
notmuch_message_destroy (message);
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
show: Convert show_message to use sprinter Unlike the previous patches, this function is used for all formats. However, for formats other than the JSON format, the sprinter methods used by show_message are all no-ops, so this code continues to function correctly for all of the formats. Converting show_message eliminates show_null_message in the process, since this maps directly to an sprinter method.
2012-08-03 03:14:57 +02:00
sp->end (sp);
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +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
show: Convert show_message to use sprinter Unlike the previous patches, this function is used for all formats. However, for formats other than the JSON format, the sprinter methods used by show_message are all no-ops, so this code continues to function correctly for all of the formats. Converting show_message eliminates show_null_message in the process, since this maps directly to an sprinter method.
2012-08-03 03:14:57 +02:00
sp->end (sp);
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
return res;
notmuch show: Implement proper thread ordering/nesting of messages. We now properly analyze the in-reply-to headers to create a proper tree representing the actual thread and present the messages in this correct thread order. Also, there's a new "depth:" value added to the "message{" header so that clients can format the thread as desired, (such as by indenting replies).
2009-11-16 05:39:25 +01:00
}
rename do_show_raw to do_show_single, and create params.raw for raw message output We rename here in order to make do_show_single into a generic function for handling output of just a single message, or which format=raw is a special case. The raw case is handled by setting a new parameter, params.raw, which is used to tell do_show_single to output a single message as a raw file. This is mostly in preparation for much improved part handling to follow imminently.
2011-05-23 05:04:02 +02:00
/* Formatted output of single message */
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
static int
rename do_show_raw to do_show_single, and create params.raw for raw message output We rename here in order to make do_show_single into a generic function for handling output of just a single message, or which format=raw is a special case. The raw case is handled by setting a new parameter, params.raw, which is used to tell do_show_single to output a single message as a raw file. This is mostly in preparation for much improved part handling to follow imminently.
2011-05-23 05:04:02 +02:00
do_show_single (void *ctx,
notmuch_query_t *query,
const notmuch_show_format_t *format,
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
sprinter_t *sp,
rename do_show_raw to do_show_single, and create params.raw for raw message output We rename here in order to make do_show_single into a generic function for handling output of just a single message, or which format=raw is a special case. The raw case is handled by setting a new parameter, params.raw, which is used to tell do_show_single to output a single message as a raw file. This is mostly in preparation for much improved part handling to follow imminently.
2011-05-23 05:04:02 +02:00
notmuch_show_params_t *params)
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_messages_t *messages;
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
notmuch_message_t *message;
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: 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 int count;
notmuch show: limit display to only matching messages This patch changes the default behaviour of notmuch show to display only messages that match the search expression. However, --entire-thread option is provided to display all messages in threads that matched the search expression. It is deemed that will be more useful for human users on the command line. Scripts can be modified to include the --entire-thread option so that they can display all messages once more. Example: $ notmuch search subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b thread:23d99d0f364f93e90e15df8b42eddb5b July 31 [4/12] Johan Herland; [RFCv2 00/12] Foreign VCS helper program for CVS repositories (inbox unread) Note that in this thread 4 out of 12 messages matched. The default show behaviour is to show only those messages that match: $ notmuch show subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b | grep 'message{' | wc -l 4 With the --entire-thread option the output will contain all dozen messages: $ notmuch show --entire-thread subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b | grep 'message{' | wc -l 12 Signed-off-by: Bart Trojanowski <bart@jukie.net>
2009-11-28 03:49:39 +01:00
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 (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 show", query, status))
return 1;
if (count != 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: search term did not match precisely one message (matched %u messages).\n",
count);
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
return 1;
notmuch show: limit display to only matching messages This patch changes the default behaviour of notmuch show to display only messages that match the search expression. However, --entire-thread option is provided to display all messages in threads that matched the search expression. It is deemed that will be more useful for human users on the command line. Scripts can be modified to include the --entire-thread option so that they can display all messages once more. Example: $ notmuch search subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b thread:23d99d0f364f93e90e15df8b42eddb5b July 31 [4/12] Johan Herland; [RFCv2 00/12] Foreign VCS helper program for CVS repositories (inbox unread) Note that in this thread 4 out of 12 messages matched. The default show behaviour is to show only those messages that match: $ notmuch show subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b | grep 'message{' | wc -l 4 With the --entire-thread option the output will contain all dozen messages: $ notmuch show --entire-thread subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b | grep 'message{' | wc -l 12 Signed-off-by: Bart Trojanowski <bart@jukie.net>
2009-11-28 03:49:39 +01: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 (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 show", query, status))
return 1;
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
message = notmuch_messages_get (messages);
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
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
if (message == NULL) {
fprintf (stderr, "Error: Cannot find matching message.\n");
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
return 1;
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
}
New part output handling as option to notmuch-show. Outputting of single MIME parts is moved to an option of notmuch show, instead of being handled in it's own sub-command. The recent rework of multipart mime allowed for this change but consolidating part handling into a single recursive function (show_message_part) that includes formatting. This allows for far simpler handling single output of a single part, including formatting.
2011-05-24 00:31:32 +02:00
notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
return show_message (ctx, format, sp, message, 0, params)
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_STATUS_SUCCESS;
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
}
rename do_show_raw to do_show_single, and create params.raw for raw message output We rename here in order to make do_show_single into a generic function for handling output of just a single message, or which format=raw is a special case. The raw case is handled by setting a new parameter, params.raw, which is used to tell do_show_single to output a single message as a raw file. This is mostly in preparation for much improved part handling to follow imminently.
2011-05-23 05:04:02 +02:00
/* Formatted output of threads */
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
static int
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
do_show_threaded (void *ctx,
notmuch_query_t *query,
const notmuch_show_format_t *format,
sprinter_t *sp,
notmuch_show_params_t *params)
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
{
notmuch_threads_t *threads;
notmuch_thread_t *thread;
notmuch_messages_t *messages;
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
cli: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
int i;
if (params->offset < 0) {
unsigned count;
notmuch_status_t s = notmuch_query_count_threads (query, &count);
if (print_status_query ("notmuch show", query, s))
return 1;
params->offset += count;
if (params->offset < 0)
params->offset = 0;
}
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01: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
status = notmuch_query_search_threads (query, &threads);
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 show", query, status))
notmuch-show: detect NULL pointer returned from notmuch_query_search_threads We want to return an error status, not 0 or (worse) segfault.
2014-01-23 13:24:01 +01:00
return 1;
show: Convert do_show to use sprinter
2012-08-03 03:14:58 +02:00
sp->begin_list (sp);
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
cli: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
for (i = 0;
notmuch_threads_valid (threads) && (params->limit < 0 || i < params->offset + params->limit);
notmuch_threads_move_to_next (threads), i++) {
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
thread = notmuch_threads_get (threads);
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: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
if (i < params->offset) {
notmuch_thread_destroy (thread);
continue;
}
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
messages = notmuch_thread_get_toplevel_messages (thread);
notmuch show: Detect an internal error if a thread has no messages. This really should be impossible---if there are no messages, then what was the thread object created from? During recent debugging, it was useful to have this error detected and reported.
2009-11-18 02:53:54 +01:00
notmuch show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +01:00
if (messages == NULL)
INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
notmuch_thread_get_thread_id (thread));
notmuch show: limit display to only matching messages This patch changes the default behaviour of notmuch show to display only messages that match the search expression. However, --entire-thread option is provided to display all messages in threads that matched the search expression. It is deemed that will be more useful for human users on the command line. Scripts can be modified to include the --entire-thread option so that they can display all messages once more. Example: $ notmuch search subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b thread:23d99d0f364f93e90e15df8b42eddb5b July 31 [4/12] Johan Herland; [RFCv2 00/12] Foreign VCS helper program for CVS repositories (inbox unread) Note that in this thread 4 out of 12 messages matched. The default show behaviour is to show only those messages that match: $ notmuch show subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b | grep 'message{' | wc -l 4 With the --entire-thread option the output will contain all dozen messages: $ notmuch show --entire-thread subject:git AND thread:23d99d0f364f93e90e15df8b42eddb5b | grep 'message{' | wc -l 12 Signed-off-by: Bart Trojanowski <bart@jukie.net>
2009-11-28 03:49:39 +01:00
show: Feed the sprinter down to part formatters There are several levels of function calls between where we create the sprinter and the call to the part formatter in show_message. This feeds the sprinter through all of them and into the part formatters.
2012-08-03 03:14:52 +02:00
status = show_messages (ctx, format, sp, messages, 0, params);
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 (status && ! res)
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
res = status;
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 show: Preserve thread-ordering and nesting without --entire-thread When "notmuch show" was recently modified to not show an entire thread by default, it also lost all capability to properly order the messages in a thread and to print their proper depth. For example, the command: notmuch show thread:6d5e3e276461188c5778c9f219f63782 had dramatically different output than: notmuch show --entire-thread thread:6d5e3e276461188c5778c9f219f63782 even though both commands were selecting and displaying the same set of messages. The first command would diplay them "flat", (all with depth:0), and in strict date order; while the second command would display them "nested" (with depth based on threading), and in thread order. We now fix "notmuch show" without the --entire-thread option to also display nested and thread-ordered messages. If some messages in the thread are not included in the displayed results, then they are not counted when computing depth values.
2009-12-03 01:05:23 +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
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
}
show: Convert do_show to use sprinter
2012-08-03 03:14:58 +02:00
sp->end (sp);
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
show: Allow formatters to return errors Formatter errors are propagated to the exit status of notmuch show. This isn't used by the JSON or text formatters, but it will be useful for the raw format, which is pickier.
2012-03-06 19:48:39 +01:00
return res != NOTMUCH_STATUS_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
}
notmuch: Add a 'part' subcommand A new 'part' subcommand allows the user to extract a single part from a MIME message. Usage: notmuch part --part=<n> <search terms> The search terms must match only a single message (e.g. id:foo@bar.com). The part number specified refers to the part identifiers output by `notmuch show'. The content of the part is written the stdout with no formatting or identification marks. It is not JSON formatted.
2010-03-24 08:21:20 +01:00
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
static int
do_show_unthreaded (void *ctx,
notmuch_query_t *query,
const notmuch_show_format_t *format,
sprinter_t *sp,
notmuch_show_params_t *params)
{
notmuch_messages_t *messages;
notmuch_message_t *message;
notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
notmuch_bool_t excluded;
cli: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
int i;
if (params->offset < 0) {
unsigned count;
notmuch_status_t s = notmuch_query_count_messages (query, &count);
if (print_status_query ("notmuch show", query, s))
return 1;
params->offset += count;
if (params->offset < 0)
params->offset = 0;
}
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
status = notmuch_query_search_messages (query, &messages);
if (print_status_query ("notmuch show", query, status))
return 1;
sp->begin_list (sp);
cli: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
for (i = 0;
notmuch_messages_valid (messages) && (params->limit < 0 || i < params->offset + params->limit);
notmuch_messages_move_to_next (messages), i++) {
if (i < params->offset) {
continue;
}
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
sp->begin_list (sp);
sp->begin_list (sp);
message = notmuch_messages_get (messages);
notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, TRUE);
cli/show: replace deprecated notmuch_message_get_flag This can be seen as moving an abort out of the library, into the CLI where we can both print to stderr and shut the process down without ill effect.
2020-07-11 20:30:05 +02:00
excluded = _get_message_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
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
if (! excluded || ! params->omit_excluded) {
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
status = show_message (ctx, format, sp, message, 0, params);
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
if (status && ! res)
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
res = status;
} else {
sp->null (sp);
}
notmuch_message_destroy (message);
sp->end (sp);
sp->end (sp);
}
sp->end (sp);
return res;
}
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
enum {
NOTMUCH_FORMAT_NOT_SPECIFIED,
NOTMUCH_FORMAT_JSON,
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
NOTMUCH_FORMAT_SEXP,
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
NOTMUCH_FORMAT_TEXT,
NOTMUCH_FORMAT_MBOX,
NOTMUCH_FORMAT_RAW
};
cli/show: move formatter structs closer to where they're needed The formatter structs are only needed for the formatter array initialization. Move them closer to use. This also lets us drop some forward declarations. No functional changes.
2017-01-06 21:14:48 +01:00
static const notmuch_show_format_t format_json = {
.new_sprinter = sprinter_json_create,
.part = format_part_sprinter_entry,
};
static const notmuch_show_format_t format_sexp = {
.new_sprinter = sprinter_sexp_create,
.part = format_part_sprinter_entry,
};
static const notmuch_show_format_t format_text = {
.new_sprinter = sprinter_text_create,
.part = format_part_text,
};
static const notmuch_show_format_t format_mbox = {
.new_sprinter = sprinter_text_create,
.part = format_part_mbox,
};
static const notmuch_show_format_t format_raw = {
.new_sprinter = sprinter_text_create,
.part = format_part_raw,
};
cli/show: use a table for choosing the formatter Continue detangling format pointer and format selection variables. No functional changes.
2017-01-06 21:14:45 +01:00
static const notmuch_show_format_t *formatters[] = {
[NOTMUCH_FORMAT_JSON] = &format_json,
[NOTMUCH_FORMAT_SEXP] = &format_sexp,
[NOTMUCH_FORMAT_TEXT] = &format_text,
[NOTMUCH_FORMAT_MBOX] = &format_mbox,
[NOTMUCH_FORMAT_RAW] = &format_raw,
};
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02: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_show_command (notmuch_database_t *notmuch, int argc, char *argv[])
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
{
notmuch_query_t *query;
char *query_string;
cli: reach previously unreachable cleanup code in "notmuch show" The last lines of notmuch_show_command() function were unreachable. Fix it by using a variable for return value. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:23 +01:00
int opt_index, ret;
cli/show: use a table for choosing the formatter Continue detangling format pointer and format selection variables. No functional changes.
2017-01-06 21:14:45 +01:00
const notmuch_show_format_t *formatter;
show: Associate an sprinter with each format This associates an sprinter constructor with each show format and uses this to construct the appropriate sprinter. Currently nothing is done with this sprinter, but the following patches will weave it through the layers of notmuch show.
2012-08-03 03:14:50 +02:00
sprinter_t *sprinter;
cli: modify show and reply to use new crypto struct notmuch_show_params_t is modified to use the new notmuch_crypto_t, and notmuch-show and notmuch-reply are modified accordingly.
2012-05-26 20:45:42 +02:00
notmuch_show_params_t params = {
.part = -1,
CLI/show: initial support for --duplicate for (raw output only) Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.
2022-07-01 23:45:43 +02:00
.duplicate = 0,
cli: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
.offset = 0,
.limit = -1, /* unlimited */
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
.omit_excluded = true,
.output_body = true,
cli/show: use decryption policy "auto" by default. When showing a message, if the user doesn't specify --decrypt= at all, but a stashed session key is known to notmuch, notmuch should just go ahead and try to decrypt the message with the session key (without bothering the user for access to their asymmetric secret key). The user can disable this at the command line with --decrypt=false if they really don't want to look at the e-mail that they've asked notmuch to show them. and of course, "notmuch show --decrypt" still works for accessing the user's secret keys if necessary.
2017-12-08 07:23:55 +01:00
.crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
cli: modify show and reply to use new crypto struct notmuch_show_params_t is modified to use the new notmuch_crypto_t, and notmuch-show and notmuch-reply are modified accordingly.
2012-05-26 20:45:42 +02:00
};
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
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 exclude = true;
bool entire_thread_set = false;
bool single_message;
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
bool unthreaded = FALSE;
CLI/show: complete conversion to new configuration framework. In order to open the database in main() for this command, we may need to re-open it in the (possibly less common) case where crypto options require write access.
2021-02-06 23:50:20 +01:00
notmuch_status_t status;
CLI/show: accept --sort Add the command-line option --sort to the show command of the CLI notmuch interface, with the same possible values as the same option in notmuch search.
2021-07-02 22:44:20 +02:00
int sort = NOTMUCH_SORT_NEWEST_FIRST;
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
notmuch_opt_desc_t options[] = {
CLI/show: accept --sort Add the command-line option --sort to the show command of the CLI notmuch interface, with the same possible values as the same option in notmuch search.
2021-07-02 22:44:20 +02:00
{ .opt_keyword = &sort, .name = "sort", .keywords =
(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 = &format, .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 },
{ "text", NOTMUCH_FORMAT_TEXT },
{ "sexp", NOTMUCH_FORMAT_SEXP },
{ "mbox", NOTMUCH_FORMAT_MBOX },
{ "raw", NOTMUCH_FORMAT_RAW },
{ 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" },
{ .opt_bool = &exclude, .name = "exclude" },
cli: use the arg parser .present feature to handle show --entire-thread The --entire-thread default depends on other arguments, so we'll have to figure out if it was explicitly set by the user or not. The arg parser .present feature helps us clean up the code here.
2017-10-01 22:53:16 +02:00
{ .opt_bool = &params.entire_thread, .name = "entire-thread",
.present = &entire_thread_set },
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
{ .opt_bool = &unthreaded, .name = "unthreaded" },
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 = &params.part, .name = "part" },
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
{ .opt_keyword = (int *) (&params.crypto.decrypt), .name = "decrypt",
cli/show: make --decrypt take a keyword. We also expand tab completion for it, update the emacs bindings, and update T350, T357, and T450 to match. Make use of the bool-to-keyword backward-compatibility feature.
2017-12-19 17:40:54 +01:00
.keyword_no_arg_value = "true", .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 []){ { "false", NOTMUCH_DECRYPT_FALSE },
{ "auto", NOTMUCH_DECRYPT_AUTO },
{ "true", NOTMUCH_DECRYPT_NOSTASH },
{ "stash", NOTMUCH_DECRYPT_TRUE },
{ 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_bool = &params.crypto.verify, .name = "verify" },
{ .opt_bool = &params.output_body, .name = "body" },
{ .opt_bool = &params.include_html, .name = "include-html" },
CLI/show: initial support for --duplicate for (raw output only) Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.
2022-07-01 23:45:43 +02:00
{ .opt_int = &params.duplicate, .name = "duplicate" },
cli: add options --offset and --limit to notmuch show notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-10-18 21:41:58 +02:00
{ .opt_int = &params.limit, .name = "limit" },
{ .opt_int = &params.offset, .name = "offset" },
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 = notmuch_shared_options },
{ }
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
};
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
opt_index = parse_arguments (argc, argv, options, 1);
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
if (opt_index < 0)
return EXIT_FAILURE;
create notmuch_show_params_t structure for holding parameters passed to show functions. This simplifies the passing of arguments to the show functions. This will be very useful as we accumulate more parameters that will need to be passed. Currently only the entire_thread parameter is passed this way.
2011-05-21 00:01:52 +02:00
CLI: make variable n_requested_db_uuid file scope. It turns out that now that we pass an open database into the subcommands, it is easy to check any requested uuid against the database at the same time as we process the other shared arguments. This results in overall less boilerplate code, as well as making a CLI scope function and variable file scope in notmuch.c.
2021-08-24 17:17:10 +02:00
notmuch_process_shared_options (notmuch, argv[0]);
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
cli/show: make --decrypt take a keyword. We also expand tab completion for it, update the emacs bindings, and update T350, T357, and T450 to match. Make use of the bool-to-keyword backward-compatibility feature.
2017-12-19 17:40:54 +01:00
/* explicit decryption implies verification */
cli/show: enable --decrypt=stash Add fancy new feature, which makes "notmuch show" capable of actually indexing messages that it just decrypted. This enables a workflow where messages can come in in the background and be indexed using "--decrypt=auto". But when showing an encrypted message for the first time, it gets automatically indexed. This is something of a departure for "notmuch show" -- in particular, because it requires read/write access to the database. However, this might be a common use case -- people get mail delivered and indexed in the background, but only want access to their secret key to happen when they're directly interacting with notmuch itself. In such a scenario, they couldn't search newly-delivered, encrypted messages, but they could search for them once they've read them. Documentation of this new feature also uses a table form, similar to that found in the description of index.decrypt in notmuch-config(1). A notmuch UI that wants to facilitate this workflow while also offering an interactive search interface might instead make use of these additional commands while the user is at the console: Count received encrypted messages (if > 0, there are some things we haven't yet tried to index, and therefore can't yet search): notmuch count tag:encrypted and \ not property:index.decryption=success and \ not property:index.decryption=failure Reindex those messages: notmuch reindex --try-decrypt=true tag:encrypted and \ not property:index.decryption=success and \ not property:index.decryption=failure
2018-05-11 08:57:59 +02:00
if (params.crypto.decrypt == NOTMUCH_DECRYPT_NOSTASH ||
params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
cli/show: make --decrypt take a keyword. We also expand tab completion for it, update the emacs bindings, and update T350, T357, and T450 to match. Make use of the bool-to-keyword backward-compatibility feature.
2017-12-19 17:40:54 +01:00
params.crypto.verify = true;
cli: new crypto verify flag to handle verification Use this flag rather than depend on the existence of an initialized gpgctx, to determine whether we should verify a multipart/signed. We will be moving to create the ctx lazily, so we don't want to depend on it being previously initialized if it's not needed.
2012-05-26 20:45:45 +02:00
cli/show: detangle overloading of params.part for single message display The use of params.part has become rather convoluted in notmuch show. Add another variable for selecting single message display to make the code easier to read. No functional changes.
2017-01-06 21:14:42 +01:00
/* specifying a part implies single message display */
single_message = params.part >= 0;
CLI/show: initial support for --duplicate for (raw output only) Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.
2022-07-01 23:45:43 +02:00
/* specifying a duplicate also implies single message display */
single_message = single_message || (params.duplicate > 0);
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
/* if part was requested and format was not specified, use format=raw */
if (params.part >= 0)
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
format = NOTMUCH_FORMAT_RAW;
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
else
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
format = NOTMUCH_FORMAT_TEXT;
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
}
cli: change argument parsing convention for subcommands previously we deleted the subcommand name from argv before passing to the subcommand. In this version, the deletion is done in the actual subcommands. Although this causes some duplication of code, it allows us to be more flexible about how we parse command line arguments in the subcommand, including possibly using off-the-shelf routines like getopt_long that expect the name of the command in argv[0].
2011-10-21 14:19:17 +02:00
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
if (format == NOTMUCH_FORMAT_MBOX) {
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
if (params.part > 0) {
fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\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;
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
}
CLI/show: warn if crypto options are used with mbox format This limitation seems somewhat hard to fix, but at least try to warn users when combining crypto operations with mbox output format. Because the default is --decrypt=auto, the warning is omitted if --decrypt=auto is specified. While this is not great, it seems more wrong to always warn, or to change the default because of this.
2023-12-21 18:04:00 +01:00
if (params.crypto.decrypt != NOTMUCH_DECRYPT_FALSE
&& params.crypto.decrypt != NOTMUCH_DECRYPT_AUTO) {
fprintf (stderr, "Warning: mbox format does not support decryption (ignored)\n");
}
if (params.crypto.verify) {
fprintf (stderr,
"Warning: mbox format does not support signature verification (ignored)\n");
}
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
} else if (format == NOTMUCH_FORMAT_RAW) {
cli/show: detangle overloading of params.part for single message display The use of params.part has become rather convoluted in notmuch show. Add another variable for selecting single message display to make the code easier to read. No functional changes.
2017-01-06 21:14:42 +01:00
/* raw format only supports single message display */
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
single_message = true;
cli: convert "notmuch show" to use the new argument parser Use the new notmuch argument parser to handle arguments in "notmuch show". There are three minor functional changes: 1) Also set params.raw = TRUE when defaulting to raw format when part is requested but format is not specified. This was a bug, and --part=0 without --format=raw did not work previously. 2) Set params.decrypt = FALSE if crypto context creation fails. 3) Only use the parameters for the last --format if specified multiple times. Previously this could have resulted in a non-working mixture of parameters. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-02-06 20:57:22 +01:00
}
show: Support --format-version
2012-12-16 04:17:25 +01:00
notmuch_exit_if_unsupported_format ();
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
/* Default is entire-thread = false except for format=json and
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
* format=sexp. */
cli: use the arg parser .present feature to handle show --entire-thread The --entire-thread default depends on other arguments, so we'll have to figure out if it was explicitly set by the user or not. The arg parser .present feature helps us clean up the code here.
2017-10-01 22:53:16 +02:00
if (! entire_thread_set &&
(format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP))
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
params.entire_thread = true;
cli: make --entire-thread=false work for format=json. The --entire-thread option in notmuch-show.c defaults to true when format=json. Previously there was no way to turn this off. This patch makes it respect --entire-thread=false. To do this the patch moves the --entire-thread option to be a keyword option using the new command line parsing to allow the existing --entire-thread to keep working.
2012-06-16 12:21:44 +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
if (! params.output_body) {
cli: add --body=true|false option to notmuch-show.c This option allows the caller to suppress the output of the bodies of the messages. Currently this is only implemented for format=json. This is used by notmuch-pick.el (although not needed) because it gives a speed-up of at least a factor of a two (and in some cases a speed up of more than a factor of 8); moreover it reduces the memory usage in emacs hugely.
2012-07-24 20:23:27 +02:00
if (params.part > 0) {
fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\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
params.output_body = true;
cli: add --body=true|false option to notmuch-show.c This option allows the caller to suppress the output of the bodies of the messages. Currently this is only implemented for format=json. This is used by notmuch-pick.el (although not needed) because it gives a speed-up of at least a factor of a two (and in some cases a speed up of more than a factor of 8); moreover it reduces the memory usage in emacs hugely.
2012-07-24 20:23:27 +02:00
} else {
cli: notmuch show support for --body=false with --format=text
2018-10-31 00:54:31 +01:00
if (format != NOTMUCH_FORMAT_TEXT &&
format != NOTMUCH_FORMAT_JSON &&
format != NOTMUCH_FORMAT_SEXP)
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
fprintf (stderr,
cli: notmuch show support for --body=false with --format=text
2018-10-31 00:54:31 +01:00
"Warning: --body=false only implemented for format=text, format=json and format=sexp\n");
cli: add --body=true|false option to notmuch-show.c This option allows the caller to suppress the output of the bodies of the messages. Currently this is only implemented for format=json. This is used by notmuch-pick.el (although not needed) because it gives a speed-up of at least a factor of a two (and in some cases a speed up of more than a factor of 8); moreover it reduces the memory usage in emacs hugely.
2012-07-24 20:23:27 +02:00
}
}
cli: add --include-html option to notmuch show For my client, the largest bottleneck for displaying large threads is exporting each html part individually since by default notmuch will not show the json parts. For large threads there can be quite a few parts and each must be exported and decoded one by one. Also, I then have to deal with all the crazy charsets which I can do through a library but is a pain. Therefore, this patch adds an --include-html option that causes the text/html parts to be included as part of the output of show. diff man/man1/notmuch-show.1
2013-07-02 02:19:42 +02:00
if (params.include_html &&
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
(format != NOTMUCH_FORMAT_TEXT &&
cli: notmuch show support for --include-html with --format=text
2018-10-31 00:54:32 +01:00
format != NOTMUCH_FORMAT_JSON &&
format != NOTMUCH_FORMAT_SEXP)) {
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,
"Warning: --include-html only implemented for format=text, format=json and format=sexp\n");
cli: add --include-html option to notmuch show For my client, the largest bottleneck for displaying large threads is exporting each html part individually since by default notmuch will not show the json parts. For large threads there can be quite a few parts and each must be exported and decoded one by one. Also, I then have to deal with all the crazy charsets which I can do through a library but is a pain. Therefore, this patch adds an --include-html option that causes the text/html parts to be included as part of the output of show. diff man/man1/notmuch-show.1
2013-07-02 02:19:42 +02:00
}
CLI/show: complete conversion to new configuration framework. In order to open the database in main() for this command, we may need to re-open it in the (possibly less common) case where crypto options require write access.
2021-02-06 23:50:20 +01:00
if (params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE) {
status = notmuch_database_reopen (notmuch, NOTMUCH_DATABASE_MODE_READ_WRITE);
if (status) {
fprintf (stderr, "Error reopening database for READ_WRITE: %s\n",
notmuch_status_to_string (status));
return EXIT_FAILURE;
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
}
}
query_string = query_string_from_args (notmuch, argc - opt_index, argv + opt_index);
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
if (query_string == NULL) {
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;
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
}
if (*query_string == '\0') {
Rename "notmuch cat" to "notmuch show --format=raw" This is part of an effort to avoid proliferation of excessive top-level notmuch commands. Also, "raw" better captures the functionality here, (as opposed to "cat" which is a fairly oblique reference to a bad Unix abbreviation whose metaphor doesn't work here since "notmuch cat" operates only on a single message and hence cannot "con'cat'enate" anything).
2010-11-06 20:03:51 +01:00
fprintf (stderr, "Error: notmuch show 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;
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
}
CLI/{count, dump, reindex, reply, show}: enable sexp queries The change in each case is to call notmuch_query_create_with_syntax, relying on the already inherited shared options. As a bonus we get improved error handling from the new query creation API. The remaining subcommand is 'tag', which is a bit trickier.
2021-08-24 17:17:43 +02:00
status = notmuch_query_create_with_syntax (notmuch, query_string,
shared_option_query_syntax (),
&query);
if (print_status_database ("notmuch show", notmuch, status))
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;
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
CLI/show: accept --sort Add the command-line option --sort to the show command of the CLI notmuch interface, with the same possible values as the same option in notmuch search.
2021-07-02 22:44:20 +02:00
notmuch_query_set_sort (query, sort);
show: Associate an sprinter with each format This associates an sprinter constructor with each show format and uses this to construct the appropriate sprinter. Currently nothing is done with this sprinter, but the following patches will weave it through the layers of notmuch show.
2012-08-03 03:14:50 +02:00
/* Create structure printer. */
cli/show: rename format_sel to simply format Now that the format pointer is a temporary variable, and named formatter, shorten format_sel to format. No functional changes.
2017-01-06 21:14:46 +01:00
formatter = formatters[format];
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
sprinter = formatter->new_sprinter (notmuch, stdout);
show: Associate an sprinter with each format This associates an sprinter constructor with each show format and uses this to construct the appropriate sprinter. Currently nothing is done with this sprinter, but the following patches will weave it through the layers of notmuch show.
2012-08-03 03:14:50 +02:00
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
params.out_stream = g_mime_stream_stdout_new ();
cli: Make notmuch-show respect excludes. This adds the excludes to notmuch-show.c. We do not exclude when only a single message (or part) is requested. notmuch-show will output the exclude information when either text or json format is requested. As this changes the output from notmuch-show it breaks many tests (in a trivial and expected fashion).
2012-03-01 23:30:40 +01:00
/* If a single message is requested we do not use search_excludes. */
cli/show: detangle overloading of params.part for single message display The use of params.part has become rather convoluted in notmuch show. Add another variable for selecting single message display to make the code easier to read. No functional changes.
2017-01-06 21:14:42 +01:00
if (single_message) {
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
ret = do_show_single (notmuch, query, formatter, sprinter, &params);
cli/show: detangle overloading of params.part for single message display The use of params.part has become rather convoluted in notmuch show. Add another variable for selecting single message display to make the code easier to read. No functional changes.
2017-01-06 21:14:42 +01:00
} else {
cli: move show to the new --exclude= option naming scheme. This moves notmuch show to the --exclude=(true|false) naming scheme. When exclude=false show returns all threads that match including those that only match in an excluded message. The excluded messages are flagged. When exclude=true the behaviour depends on whether --entire-thread is set. If it is not set then show only returns the messages which match and are not excluded. If it is set then show returns all messages in the threads that match in a non-excluded message, flagging the excluded messages in these threads. The rationale is that it is awkward to use a thread with some missing messages.
2012-04-07 18:10:06 +02:00
/* We always apply set the exclude flag. The
* exclude=true|false option controls whether or not we return
* threads that only match in an excluded message */
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +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: move show to the new --exclude= option naming scheme. This moves notmuch show to the --exclude=(true|false) naming scheme. When exclude=false show returns all threads that match including those that only match in an excluded message. The excluded messages are flagged. When exclude=true the behaviour depends on whether --entire-thread is set. If it is not set then show only returns the messages which match and are not excluded. If it is set then show returns all messages in the threads that match in a non-excluded message, flagging the excluded messages in these threads. The rationale is that it is awkward to use a thread with some missing messages.
2012-04-07 18:10:06 +02:00
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
for (exclude_tags = notmuch_config_get_values (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/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
status = notmuch_query_add_tag_exclude (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 show", query, status);
ret = -1;
goto DONE;
}
}
cli: move show to the new --exclude= option naming scheme. This moves notmuch show to the --exclude=(true|false) naming scheme. When exclude=false show returns all threads that match including those that only match in an excluded message. The excluded messages are flagged. When exclude=true the behaviour depends on whether --entire-thread is set. If it is not set then show only returns the messages which match and are not excluded. If it is set then show returns all messages in the threads that match in a non-excluded message, flagging the excluded messages in these threads. The rationale is that it is awkward to use a thread with some missing messages.
2012-04-07 18:10:06 +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
if (exclude == false) {
notmuch_query_set_omit_excluded (query, false);
params.omit_excluded = false;
cli: Make notmuch-show respect excludes. This adds the excludes to notmuch-show.c. We do not exclude when only a single message (or part) is requested. notmuch-show will output the exclude information when either text or json format is requested. As this changes the output from notmuch-show it breaks many tests (in a trivial and expected fashion).
2012-03-01 23:30:40 +01:00
}
cli: move show to the new --exclude= option naming scheme. This moves notmuch show to the --exclude=(true|false) naming scheme. When exclude=false show returns all threads that match including those that only match in an excluded message. The excluded messages are flagged. When exclude=true the behaviour depends on whether --entire-thread is set. If it is not set then show only returns the messages which match and are not excluded. If it is set then show returns all messages in the threads that match in a non-excluded message, flagging the excluded messages in these threads. The rationale is that it is awkward to use a thread with some missing messages.
2012-04-07 18:10:06 +02:00
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
if (unthreaded)
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
ret = do_show_unthreaded (notmuch, query, formatter, sprinter, &params);
notmuch-show.c: add an option for messages to be returned unthreaded This adds a --unthreaded option to notmuch show to tell it to return the matching messages in an unthreaded order (so just by date). To make it easier for users, in particular for notmuch-tree.el, we output each message with the same "nesting" as if it were an entire thread in its own right. amended by db: s/status= /status = /
2020-02-27 18:16:47 +01:00
else
CLI/show: mostly switch show to new config framework This will need some cleanup when the transition completes, and we stop passing notmuch_config_t structs to the subcommands. Unlike the general case, we open the database in the subcommand, since we don't know whether it should be opened read/write until we parse the command line arguments. Add a test to make sure passing config file on the command line is not broken by these or future config related changes.
2020-08-08 16:16:53 +02:00
ret = do_show_threaded (notmuch, query, formatter, sprinter, &params);
cli: Make notmuch-show respect excludes. This adds the excludes to notmuch-show.c. We do not exclude when only a single message (or part) is requested. notmuch-show will output the exclude information when either text or json format is requested. As this changes the output from notmuch-show it breaks many tests (in a trivial and expected fashion).
2012-03-01 23:30:40 +01:00
}
notmuch-show: run uncrustify This is the result of running: $ uncrustify --replace --config devel/uncrustify.cfg *.c *.h In the top level source directory. I was using uncrustify 0.68.1+dfsg1-2. I do not know why these changes were not caught in 33382c2b5ba2537952a60ea378feff36961e4713 Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-07-03 06:31:19 +02:00
DONE:
cli/show: use single stream for printf / gmime object output This is again motivated by the need to transition away from GMimeStreamFile for output to stdout. format_part_mbox is left alone for now, as this cannot be mixed in with output using gmime object output.
2017-05-27 18:51:13 +02:00
g_mime_stream_flush (params.out_stream);
g_object_unref (params.out_stream);
crypto: rename notmuch_crypto_t to _notmuch_crypto_t The notmuch_crypto_t struct isn't used externally, and we have no plans to explicitly export it. Prefix its name (and associated functions) with _ to make that intent clear.
2017-10-10 07:49:02 +02:00
_notmuch_crypto_cleanup (&params.crypto);
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
notmuch_query_destroy (query);
Use notmuch_database_destroy instead of notmuch_database_close Adapt the notmuch binaries source to the notmuch_database_close split. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
2012-04-22 14:07:53 +02:00
notmuch_database_destroy (notmuch);
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +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;
Add 'cat' subcommand This command outputs a raw message matched by search term to the standard output. It allows MUAs to access the messages for piping, attachment manipulation, etc. by running notmuch cat rather then directly access the file. This will simplify the MUAs when they need to operate on a remote database. Edited-by: Carl Worth <cworth@cworth.org>: Remove trailing whitespace, add missing "test_done" to new test script to avoid "Unexpected exit" error.
2010-10-22 11:28:03 +02:00
}
Reference in a new issue Copy permalink