* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program. If not, see http://www.gnu.org/licenses/ .
+ * along with this program. If not, see https://www.gnu.org/licenses/ .
*
* Author: Carl Worth <cworth@cworth.org>
*/
};
static notmuch_status_t
-format_part_json_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,
- int indent, const notmuch_show_params_t *params);
+format_part_sprinter_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,
+ int indent, const notmuch_show_params_t *params);
static const notmuch_show_format_t format_json = {
.new_sprinter = sprinter_json_create,
- .message_set_start = "[",
- .part = format_part_json_entry,
- .message_set_sep = ", ",
- .message_set_end = "]",
- .null_message = "null"
+ .part = format_part_sprinter_entry,
+};
+
+static const notmuch_show_format_t format_sexp = {
+ .new_sprinter = sprinter_sexp_create,
+ .part = format_part_sprinter_entry,
};
static notmuch_status_t
from, relative_date, tags);
}
+/* Emit a sequence of key/value pairs for the metadata of message.
+ * The caller should begin a map before calling this. */
static void
-format_message_json (const void *ctx, notmuch_message_t *message)
+format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
{
+ /* Any changes to the JSON or S-Expression format should be
+ * reflected in the file devel/schemata. */
+
+ void *local = talloc_new (NULL);
notmuch_tags_t *tags;
- int first = 1;
- void *ctx_quote = talloc_new (ctx);
time_t date;
const char *relative_date;
+ sp->map_key (sp, "id");
+ sp->string (sp, notmuch_message_get_message_id (message));
+
+ sp->map_key (sp, "match");
+ sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
+
+ sp->map_key (sp, "excluded");
+ sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
+
+ sp->map_key (sp, "filename");
+ sp->string (sp, notmuch_message_get_filename (message));
+
+ sp->map_key (sp, "timestamp");
date = notmuch_message_get_date (message);
- relative_date = notmuch_time_relative_date (ctx, date);
+ sp->integer (sp, date);
- printf ("\"id\": %s, \"match\": %s, \"excluded\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
- json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
- notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
- notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? "true" : "false",
- json_quote_str (ctx_quote, notmuch_message_get_filename (message)),
- date, relative_date);
+ sp->map_key (sp, "date_relative");
+ relative_date = notmuch_time_relative_date (local, date);
+ sp->string (sp, relative_date);
+ sp->map_key (sp, "tags");
+ sp->begin_list (sp);
for (tags = notmuch_message_get_tags (message);
notmuch_tags_valid (tags);
notmuch_tags_move_to_next (tags))
- {
- printf("%s%s", first ? "" : ",",
- json_quote_str (ctx_quote, notmuch_tags_get (tags)));
- first = 0;
- }
- printf("], ");
- talloc_free (ctx_quote);
+ sp->string (sp, notmuch_tags_get (tags));
+ sp->end (sp);
+
+ talloc_free (local);
}
/* Extract just the email address from the contents of a From:
}
void
-format_headers_json (sprinter_t *sp, GMimeMessage *message,
- notmuch_bool_t reply)
+format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
+ notmuch_bool_t reply)
{
+ /* Any changes to the JSON or S-Expression format should be
+ * reflected in the file devel/schemata. */
+
InternetAddressList *recipients;
const char *recipients_string;
+ const char *reply_to_string;
sp->begin_map (sp);
sp->string (sp, recipients_string);
}
+ recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
+ recipients_string = internet_address_list_to_string (recipients, 0);
+ if (recipients_string) {
+ sp->map_key (sp, "Bcc");
+ sp->string (sp, recipients_string);
+ }
+
+ reply_to_string = g_mime_message_get_reply_to (message);
+ if (reply_to_string) {
+ sp->map_key (sp, "Reply-To");
+ sp->string (sp, reply_to_string);
+ }
+
if (reply) {
sp->map_key (sp, "In-reply-to");
sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
g_object_unref(stream_filter);
}
-#ifdef GMIME_ATLEAST_26
+/* Get signature status string (GMime 2.6) */
static const char*
signature_status_to_string (GMimeSignatureStatus x)
{
}
return "unknown";
}
-#else
-static const char*
-signer_status_to_string (GMimeSignerStatus x)
-{
- switch (x) {
- case GMIME_SIGNER_STATUS_NONE:
- return "none";
- case GMIME_SIGNER_STATUS_GOOD:
- return "good";
- case GMIME_SIGNER_STATUS_BAD:
- return "bad";
- case GMIME_SIGNER_STATUS_ERROR:
- return "error";
- }
- return "unknown";
-}
-#endif
-#ifdef GMIME_ATLEAST_26
+/* Signature status sprinter (GMime 2.6) */
static void
-format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
+format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
{
+ /* Any changes to the JSON or S-Expression format should be
+ * reflected in the file devel/schemata. */
+
GMimeSignatureList *siglist = node->sig_list;
sp->begin_list (sp);
sp->end (sp);
}
-#else
-static void
-format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
-{
- const GMimeSignatureValidity* validity = node->sig_validity;
-
- sp->begin_list (sp);
-
- if (!validity) {
- sp->end (sp);
- return;
- }
-
- const GMimeSigner *signer = g_mime_signature_validity_get_signers (validity);
- while (signer) {
- sp->begin_map (sp);
-
- /* status */
- sp->map_key (sp, "status");
- sp->string (sp, signer_status_to_string (signer->status));
-
- if (signer->status == GMIME_SIGNER_STATUS_GOOD)
- {
- if (signer->fingerprint) {
- sp->map_key (sp, "fingerprint");
- sp->string (sp, signer->fingerprint);
- }
- /* these dates are seconds since the epoch; should we
- * provide a more human-readable format string? */
- if (signer->created) {
- sp->map_key (sp, "created");
- sp->integer (sp, signer->created);
- }
- if (signer->expires) {
- sp->map_key (sp, "expires");
- sp->integer (sp, signer->expires);
- }
- /* output user id only if validity is FULL or ULTIMATE. */
- /* note that gmime is using the term "trust" here, which
- * is WRONG. It's actually user id "validity". */
- if ((signer->name) && (signer->trust)) {
- if ((signer->trust == GMIME_SIGNER_TRUST_FULLY) || (signer->trust == GMIME_SIGNER_TRUST_ULTIMATE)) {
- sp->map_key (sp, "userid");
- sp->string (sp, signer->name);
- }
- }
- } else {
- if (signer->keyid) {
- sp->map_key (sp, "keyid");
- sp->string (sp, signer->keyid);
- }
- }
- if (signer->errors != GMIME_SIGNER_ERROR_NONE) {
- sp->map_key (sp, "errors");
- sp->integer (sp, signer->errors);
- }
-
- sp->end (sp);
- signer = signer->next;
- }
-
- sp->end (sp);
-}
-#endif
static notmuch_status_t
format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
if (disposition &&
- strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
+ strcasecmp (g_mime_content_disposition_get_disposition (disposition),
+ GMIME_DISPOSITION_ATTACHMENT) == 0)
part_type = "attachment";
else
part_type = "part";
return NOTMUCH_STATUS_SUCCESS;
}
+static void
+format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
+{
+ const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
+ const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
+ GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
+ GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
+ ssize_t content_length = g_mime_stream_length (stream);
+
+ if (content_charset != NULL) {
+ sp->map_key (sp, "content-charset");
+ sp->string (sp, content_charset);
+ }
+ 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);
+ }
+}
+
void
-format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,
- notmuch_bool_t first, notmuch_bool_t output_body)
+format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
+ notmuch_bool_t first, notmuch_bool_t output_body,
+ notmuch_bool_t include_html)
{
- /* Any changes to the JSON format should be reflected in the file
- * devel/schemata. */
+ /* Any changes to the JSON or S-Expression format should be
+ * reflected in the file devel/schemata. */
if (node->envelope_file) {
- printf ("{");
- format_message_json (ctx, node->envelope_file);
+ sp->begin_map (sp);
+ format_message_sprinter (sp, node->envelope_file);
- printf ("\"headers\": ");
- format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
+ sp->map_key (sp, "headers");
+ format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
if (output_body) {
- printf (", \"body\": [");
- format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE);
- printf ("]");
+ sp->map_key (sp, "body");
+ sp->begin_list (sp);
+ format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
+ sp->end (sp);
}
- printf ("}");
+ sp->end (sp);
return;
}
if (node->verify_attempted) {
sp->map_key (sp, "sigstatus");
- format_part_sigstatus_json (sp, node);
+ format_part_sigstatus_sprinter (sp, node);
}
sp->map_key (sp, "content-type");
/* 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.
- * For text/html parts, we do not include the content. If a
- * caller is interested in text/html parts, it should retrieve
- * them separately and they will not be decoded. Since this
- * makes charset decoding the responsibility on the caller, we
+ * 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
* report the charset for text/html parts.
*/
- if (g_mime_content_type_is_type (content_type, "text", "html")) {
- const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
-
- if (content_charset != NULL) {
- sp->map_key (sp, "content-charset");
- sp->string (sp, content_charset);
- }
- } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
+ if (g_mime_content_type_is_type (content_type, "text", "*") &&
+ (include_html ||
+ ! g_mime_content_type_is_type (content_type, "text", "html")))
+ {
GMimeStream *stream_memory = g_mime_stream_mem_new ();
GByteArray *part_content;
show_text_part_content (node->part, stream_memory, 0);
sp->map_key (sp, "content");
sp->string_len (sp, (char *) part_content->data, part_content->len);
g_object_unref (stream_memory);
+ } else {
+ format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
}
} else if (GMIME_IS_MULTIPART (node->part)) {
sp->map_key (sp, "content");
sp->begin_map (sp);
sp->map_key (sp, "headers");
- format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
+ format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
sp->map_key (sp, "body");
sp->begin_list (sp);
}
for (i = 0; i < node->nchildren; i++)
- format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE);
+ format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
/* Close content structures */
for (i = 0; i < nclose; i++)
}
static notmuch_status_t
-format_part_json_entry (const void *ctx, sprinter_t *sp,
- mime_node_t *node, unused (int indent),
- const notmuch_show_params_t *params)
+format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
+ mime_node_t *node, unused (int indent),
+ const notmuch_show_params_t *params)
{
- format_part_json (ctx, sp, node, TRUE, params->output_body);
+ format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
return NOTMUCH_STATUS_SUCCESS;
}
return NOTMUCH_STATUS_SUCCESS;
}
-static notmuch_status_t
-show_null_message (const notmuch_show_format_t *format)
-{
- /* Output a null message. Currently empty for all formats except Json */
- if (format->null_message)
- printf ("%s", format->null_message);
- return NOTMUCH_STATUS_SUCCESS;
-}
-
static notmuch_status_t
show_message (void *ctx,
const notmuch_show_format_t *format,
notmuch_message_t *message;
notmuch_bool_t match;
notmuch_bool_t excluded;
- int first_set = 1;
int next_indent;
notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
- if (format->message_set_start)
- fputs (format->message_set_start, stdout);
+ sp->begin_list (sp);
for (;
notmuch_messages_valid (messages);
notmuch_messages_move_to_next (messages))
{
- if (!first_set && format->message_set_sep)
- fputs (format->message_set_sep, stdout);
- first_set = 0;
-
- if (format->message_set_start)
- fputs (format->message_set_start, stdout);
+ sp->begin_list (sp);
message = notmuch_messages_get (messages);
res = status;
next_indent = indent + 1;
} else {
- status = show_null_message (format);
+ sp->null (sp);
}
- if (!status && format->message_set_sep)
- fputs (format->message_set_sep, stdout);
-
status = show_messages (ctx,
format, sp,
notmuch_message_get_replies (message),
notmuch_message_destroy (message);
- if (format->message_set_end)
- fputs (format->message_set_end, stdout);
+ sp->end (sp);
}
- if (format->message_set_end)
- fputs (format->message_set_end, stdout);
+ sp->end (sp);
return res;
}
{
notmuch_messages_t *messages;
notmuch_message_t *message;
+ notmuch_status_t status;
+ unsigned int count;
- if (notmuch_query_count_messages (query) != 1) {
- fprintf (stderr, "Error: search term did not match precisely one message.\n");
+ status = notmuch_query_count_messages_st (query, &count);
+ if (print_status_query ("notmuch show", query, status))
+ return 1;
+
+ if (count != 1) {
+ fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count);
return 1;
}
- messages = notmuch_query_search_messages (query);
+ status = notmuch_query_search_messages_st (query, &messages);
+ if (print_status_query ("notmuch show", query, status))
+ return 1;
+
message = notmuch_messages_get (messages);
if (message == NULL) {
notmuch_threads_t *threads;
notmuch_thread_t *thread;
notmuch_messages_t *messages;
- int first_toplevel = 1;
notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
- if (format->message_set_start)
- fputs (format->message_set_start, stdout);
+ status= notmuch_query_search_threads_st (query, &threads);
+ if (print_status_query ("notmuch show", query, status))
+ return 1;
+
+ sp->begin_list (sp);
- for (threads = notmuch_query_search_threads (query);
+ for ( ;
notmuch_threads_valid (threads);
notmuch_threads_move_to_next (threads))
{
INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
notmuch_thread_get_thread_id (thread));
- if (!first_toplevel && format->message_set_sep)
- fputs (format->message_set_sep, stdout);
- first_toplevel = 0;
-
status = show_messages (ctx, format, sp, messages, 0, params);
if (status && !res)
res = status;
}
- if (format->message_set_end)
- fputs (format->message_set_end, stdout);
+ sp->end (sp);
return res != NOTMUCH_STATUS_SUCCESS;
}
enum {
NOTMUCH_FORMAT_NOT_SPECIFIED,
NOTMUCH_FORMAT_JSON,
+ NOTMUCH_FORMAT_SEXP,
NOTMUCH_FORMAT_TEXT,
NOTMUCH_FORMAT_MBOX,
NOTMUCH_FORMAT_RAW
};
int
-notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
+notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
{
- notmuch_config_t *config;
notmuch_database_t *notmuch;
notmuch_query_t *query;
char *query_string;
.output_body = TRUE,
.crypto = {
.verify = FALSE,
- .decrypt = FALSE
- }
+ .decrypt = FALSE,
+ .gpgpath = NULL
+ },
+ .include_html = FALSE
};
int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
int exclude = EXCLUDE_TRUE;
{ NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
(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 } } },
+ { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
{ NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
(notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
{ "false", EXCLUDE_FALSE },
{ NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
{ NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
{ NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
+ { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 },
+ { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
{ 0, 0, 0, 0, 0 }
};
opt_index = parse_arguments (argc, argv, options, 1);
- if (opt_index < 0) {
- /* diagnostics already printed */
- return 1;
- }
+ if (opt_index < 0)
+ return EXIT_FAILURE;
+
+ notmuch_process_shared_options (argv[0]);
/* decryption implies verification */
if (params.crypto.decrypt)
case NOTMUCH_FORMAT_TEXT:
format = &format_text;
break;
+ case NOTMUCH_FORMAT_SEXP:
+ format = &format_sexp;
+ break;
case NOTMUCH_FORMAT_MBOX:
if (params.part > 0) {
fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
- return 1;
+ return EXIT_FAILURE;
}
format = &format_mbox;
break;
}
- /* Default is entire-thread = FALSE except for format=json. */
+ notmuch_exit_if_unsupported_format ();
+
+ /* Default is entire-thread = FALSE except for format=json and
+ * format=sexp. */
if (entire_thread == ENTIRE_THREAD_DEFAULT) {
- if (format == &format_json)
+ if (format == &format_json || format == &format_sexp)
entire_thread = ENTIRE_THREAD_TRUE;
else
entire_thread = ENTIRE_THREAD_FALSE;
fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
params.output_body = TRUE;
} else {
- if (format != &format_json)
- fprintf (stderr, "Warning: --body=false only implemented for format=json\n");
+ if (format != &format_json && format != &format_sexp)
+ fprintf (stderr,
+ "Warning: --body=false only implemented for format=json and format=sexp\n");
}
}
+ if (params.include_html &&
+ (format_sel != NOTMUCH_FORMAT_JSON && format_sel != NOTMUCH_FORMAT_SEXP)) {
+ fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
+ }
+
if (entire_thread == ENTIRE_THREAD_TRUE)
params.entire_thread = TRUE;
else
params.entire_thread = FALSE;
- config = notmuch_config_open (ctx, NULL, NULL);
- if (config == NULL)
- return 1;
-
- query_string = query_string_from_args (ctx, argc-opt_index, argv+opt_index);
+ query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
if (query_string == NULL) {
fprintf (stderr, "Out of memory\n");
- return 1;
+ return EXIT_FAILURE;
}
if (*query_string == '\0') {
fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
- return 1;
+ return EXIT_FAILURE;
}
+ params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
+
if (notmuch_database_open (notmuch_config_get_database_path (config),
NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
- return 1;
+ return EXIT_FAILURE;
+
+ notmuch_exit_if_unmatched_db_uuid (notmuch);
query = notmuch_query_create (notmuch, query_string);
if (query == NULL) {
fprintf (stderr, "Out of memory\n");
- return 1;
+ return EXIT_FAILURE;
}
/* Create structure printer. */
- sprinter = format->new_sprinter(ctx, stdout);
+ sprinter = format->new_sprinter(config, stdout);
/* If a single message is requested we do not use search_excludes. */
if (params.part >= 0)
- ret = do_show_single (ctx, query, format, sprinter, ¶ms);
+ ret = do_show_single (config, query, format, sprinter, ¶ms);
else {
/* We always apply set the exclude flag. The
* exclude=true|false option controls whether or not we return
params.omit_excluded = FALSE;
}
- ret = do_show (ctx, query, format, sprinter, ¶ms);
+ ret = do_show (config, query, format, sprinter, ¶ms);
}
notmuch_crypto_cleanup (¶ms.crypto);
notmuch_query_destroy (query);
notmuch_database_destroy (notmuch);
- return ret;
+ return ret ? EXIT_FAILURE : EXIT_SUCCESS;
}