]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-show.c
show: Allow formatters to return errors
[notmuch] / notmuch-show.c
index 6259d3023aa114b58eca9b26c2c81da42b0995d2..8a8c0fc53b13eac1d8ca7a2e2f3ad4f88018310e 100644 (file)
@@ -23,7 +23,7 @@
 static void
 format_headers_message_part_text (GMimeMessage *message);
 
-static void
+static notmuch_status_t
 format_part_text (const void *ctx, mime_node_t *node,
                  int indent, const notmuch_show_params_t *params);
 
@@ -34,7 +34,7 @@ static const notmuch_show_format_t format_text = {
     .message_set_end = ""
 };
 
-static void
+static notmuch_status_t
 format_part_json_entry (const void *ctx, mime_node_t *node,
                        int indent, const notmuch_show_params_t *params);
 
@@ -143,9 +143,10 @@ format_message_json (const void *ctx, notmuch_message_t *message)
     date = notmuch_message_get_date (message);
     relative_date = notmuch_time_relative_date (ctx, date);
 
-    printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
+    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);
 
@@ -297,7 +298,7 @@ format_headers_json (const void *ctx, GMimeMessage *message)
     InternetAddressList *recipients;
     const char *recipients_string;
 
-    printf ("%s: %s",
+    printf ("{%s: %s",
            json_quote_str (local, "Subject"),
            json_quote_str (local, g_mime_message_get_subject (message)));
     printf (", %s: %s",
@@ -315,7 +316,7 @@ format_headers_json (const void *ctx, GMimeMessage *message)
        printf (", %s: %s",
                json_quote_str (local, "Cc"),
                json_quote_str (local, recipients_string));
-    printf (", %s: %s",
+    printf (", %s: %s}",
            json_quote_str (local, "Date"),
            json_quote_str (local, g_mime_message_get_date_as_string (message)));
 
@@ -404,9 +405,11 @@ signer_status_to_string (GMimeSignerStatus x)
 
 #ifdef GMIME_ATLEAST_26
 static void
-format_part_sigstatus_json (GMimeSignatureList *siglist)
+format_part_sigstatus_json (mime_node_t *node)
 {
-    printf (", \"sigstatus\": [");
+    GMimeSignatureList *siglist = node->sig_list;
+
+    printf ("[");
 
     if (!siglist) {
        printf ("]");
@@ -470,9 +473,11 @@ format_part_sigstatus_json (GMimeSignatureList *siglist)
 }
 #else
 static void
-format_part_sigstatus_json (const GMimeSignatureValidity* validity)
+format_part_sigstatus_json (mime_node_t *node)
 {
-    printf (", \"sigstatus\": [");
+    const GMimeSignatureValidity* validity = node->sig_validity;
+
+    printf ("[");
 
     if (!validity) {
        printf ("]");
@@ -558,7 +563,7 @@ format_part_content_raw (GMimeObject *part)
        g_object_unref(stream_stdout);
 }
 
-static void
+static notmuch_status_t
 format_part_text (const void *ctx, mime_node_t *node,
                  int indent, const notmuch_show_params_t *params)
 {
@@ -575,11 +580,12 @@ format_part_text (const void *ctx, mime_node_t *node,
        notmuch_message_t *message = node->envelope_file;
 
        part_type = "message";
-       printf ("\f%s{ id:%s depth:%d match:%d filename:%s\n",
+       printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
                part_type,
                notmuch_message_get_message_id (message),
                indent,
-               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
+               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
+               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
                notmuch_message_get_filename (message));
     } else {
        GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (meta);
@@ -646,6 +652,8 @@ format_part_text (const void *ctx, mime_node_t *node,
        printf ("\fbody}\n");
 
     printf ("\f%s}\n", part_type);
+
+    return NOTMUCH_STATUS_SUCCESS;
 }
 
 static void
@@ -658,9 +666,8 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
        printf ("{");
        format_message_json (ctx, node->envelope_file);
 
-       printf ("\"headers\": {");
+       printf ("\"headers\": ");
        format_headers_json (ctx, GMIME_MESSAGE (node->part));
-       printf ("}");
 
        printf (", \"body\": [");
        format_part_json (ctx, mime_node_child (node, 0), first);
@@ -675,9 +682,10 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
     GMimeObject *meta = node->envelope_part ?
        GMIME_OBJECT (node->envelope_part) : node->part;
     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
-    GMimeStream *stream_memory = g_mime_stream_mem_new ();
     const char *cid = g_mime_object_get_content_id (meta);
-    GByteArray *part_content;
+    const char *filename = GMIME_IS_PART (node->part) ?
+       g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
+    const char *terminator = "";
     int i;
 
     if (!first)
@@ -685,37 +693,25 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
 
     printf ("{\"id\": %d", node->part_num);
 
-    if (node->decrypt_attempted) {
-       printf (", \"encstatus\": [{\"status\": ");
-       if (node->decrypt_success) {
-           printf ("\"good\"");
-       } else {
-           printf ("\"bad\"");
-       }
-       printf ("}]");
-    }
+    if (node->decrypt_attempted)
+       printf (", \"encstatus\": [{\"status\": \"%s\"}]",
+               node->decrypt_success ? "good" : "bad");
 
     if (node->verify_attempted) {
-#ifdef GMIME_ATLEAST_26
-       format_part_sigstatus_json (node->sig_list);
-#else
-       format_part_sigstatus_json (node->sig_validity);
-#endif
+       printf (", \"sigstatus\": ");
+       format_part_sigstatus_json (node);
     }
 
     printf (", \"content-type\": %s",
            json_quote_str (local, g_mime_content_type_to_string (content_type)));
 
-    if (cid != NULL)
-           printf(", \"content-id\": %s", json_quote_str (local, cid));
+    if (cid)
+       printf (", \"content-id\": %s", json_quote_str (local, cid));
 
-    if (GMIME_IS_PART (node->part)) {
-       const char *filename = g_mime_part_get_filename (GMIME_PART (node->part));
-       if (filename)
-           printf (", \"filename\": %s", json_quote_str (local, filename));
-    }
+    if (filename)
+       printf (", \"filename\": %s", json_quote_str (local, filename));
 
-    if (g_mime_content_type_is_type (content_type, "text", "*")) {
+    if (GMIME_IS_PART (node->part)) {
        /* 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.
@@ -730,53 +726,45 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
 
            if (content_charset != NULL)
                printf (", \"content-charset\": %s", json_quote_str (local, content_charset));
-       } else {
+       } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
+           GMimeStream *stream_memory = g_mime_stream_mem_new ();
+           GByteArray *part_content;
            show_text_part_content (node->part, stream_memory);
            part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
 
            printf (", \"content\": %s", json_quote_chararray (local, (char *) part_content->data, part_content->len));
+           g_object_unref (stream_memory);
        }
-    } else if (g_mime_content_type_is_type (content_type, "multipart", "*")) {
+    } else if (GMIME_IS_MULTIPART (node->part)) {
        printf (", \"content\": [");
-    } else if (g_mime_content_type_is_type (content_type, "message", "rfc822")) {
+       terminator = "]";
+    } else if (GMIME_IS_MESSAGE (node->part)) {
        printf (", \"content\": [{");
-    }
-
-    if (stream_memory)
-       g_object_unref (stream_memory);
-
-    if (GMIME_IS_MESSAGE (node->part)) {
-       printf ("\"headers\": {");
+       printf ("\"headers\": ");
        format_headers_json (local, GMIME_MESSAGE (node->part));
-       printf ("}");
 
        printf (", \"body\": [");
+       terminator = "]}]";
     }
 
+    talloc_free (local);
+
     for (i = 0; i < node->nchildren; i++)
        format_part_json (ctx, mime_node_child (node, i), i == 0);
 
-    if (GMIME_IS_MESSAGE (node->part))
-       printf ("]");
-
-    if (g_mime_content_type_is_type (content_type, "multipart", "*"))
-       printf ("]");
-    else if (g_mime_content_type_is_type (content_type, "message", "rfc822"))
-       printf ("}]");
-
-    printf ("}");
-
-    talloc_free (local);
+    printf ("%s}", terminator);
 }
 
-static void
+static notmuch_status_t
 format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent),
                        unused (const notmuch_show_params_t *params))
 {
     format_part_json (ctx, node, TRUE);
+
+    return NOTMUCH_STATUS_SUCCESS;
 }
 
-static void
+static notmuch_status_t
 show_message (void *ctx,
              const notmuch_show_format_t *format,
              notmuch_message_t *message,
@@ -786,14 +774,18 @@ show_message (void *ctx,
     if (format->part) {
        void *local = talloc_new (ctx);
        mime_node_t *root, *part;
-
-       if (mime_node_open (local, message, params->cryptoctx, params->decrypt,
-                           &root) == NOTMUCH_STATUS_SUCCESS &&
-           (part = mime_node_seek_dfs (root, (params->part < 0 ?
-                                              0 : params->part))))
-           format->part (local, part, indent, params);
+       notmuch_status_t status;
+
+       status = mime_node_open (local, message, params->cryptoctx,
+                                params->decrypt, &root);
+       if (status)
+           goto DONE;
+       part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
+       if (part)
+           status = format->part (local, part, indent, params);
+      DONE:
        talloc_free (local);
-       return;
+       return status;
     }
 
     if (params->part <= 0) {
@@ -817,9 +809,11 @@ show_message (void *ctx,
 
        fputs (format->message_end, stdout);
     }
+
+    return NOTMUCH_STATUS_SUCCESS;
 }
 
-static void
+static notmuch_status_t
 show_messages (void *ctx,
               const notmuch_show_format_t *format,
               notmuch_messages_t *messages,
@@ -830,6 +824,7 @@ show_messages (void *ctx,
     notmuch_bool_t match;
     int first_set = 1;
     int next_indent;
+    notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
 
     fputs (format->message_set_start, stdout);
 
@@ -850,17 +845,22 @@ show_messages (void *ctx,
        next_indent = indent;
 
        if (match || params->entire_thread) {
-           show_message (ctx, format, message, indent, params);
+           status = show_message (ctx, format, message, indent, params);
+           if (status && !res)
+               res = status;
            next_indent = indent + 1;
 
-           fputs (format->message_set_sep, stdout);
+           if (!status)
+               fputs (format->message_set_sep, stdout);
        }
 
-       show_messages (ctx,
-                      format,
-                      notmuch_message_get_replies (message),
-                      next_indent,
-                      params);
+       status = show_messages (ctx,
+                               format,
+                               notmuch_message_get_replies (message),
+                               next_indent,
+                               params);
+       if (status && !res)
+           res = status;
 
        notmuch_message_destroy (message);
 
@@ -868,6 +868,8 @@ show_messages (void *ctx,
     }
 
     fputs (format->message_set_end, stdout);
+
+    return res;
 }
 
 /* Formatted output of single message */
@@ -932,13 +934,13 @@ do_show_single (void *ctx,
 
        fclose (file);
 
+       return 0;
+
     } else {
 
-       show_message (ctx, format, message, 0, params);
+       return show_message (ctx, format, message, 0, params) != NOTMUCH_STATUS_SUCCESS;
 
     }
-
-    return 0;
 }
 
 /* Formatted output of threads */
@@ -952,6 +954,7 @@ do_show (void *ctx,
     notmuch_thread_t *thread;
     notmuch_messages_t *messages;
     int first_toplevel = 1;
+    notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
 
     fputs (format->message_set_start, stdout);
 
@@ -971,7 +974,9 @@ do_show (void *ctx,
            fputs (format->message_set_sep, stdout);
        first_toplevel = 0;
 
-       show_messages (ctx, format, messages, 0, params);
+       status = show_messages (ctx, format, messages, 0, params);
+       if (status && !res)
+           res = status;
 
        notmuch_thread_destroy (thread);
 
@@ -979,7 +984,7 @@ do_show (void *ctx,
 
     fputs (format->message_set_end, stdout);
 
-    return 0;
+    return res != NOTMUCH_STATUS_SUCCESS;
 }
 
 enum {
@@ -1002,6 +1007,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     notmuch_show_params_t params = { .part = -1 };
     int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
     notmuch_bool_t verify = FALSE;
+    notmuch_bool_t no_exclude = FALSE;
 
     notmuch_opt_desc_t options[] = {
        { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
@@ -1014,6 +1020,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        { NOTMUCH_OPT_BOOLEAN, &params.entire_thread, "entire-thread", 't', 0 },
        { NOTMUCH_OPT_BOOLEAN, &params.decrypt, "decrypt", 'd', 0 },
        { NOTMUCH_OPT_BOOLEAN, &verify, "verify", 'v', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'n', 0 },
        { 0, 0, 0, 0, 0 }
     };
 
@@ -1044,6 +1051,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
            fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
            return 1;
        }
+
        format = &format_mbox;
        break;
     case NOTMUCH_FORMAT_RAW:
@@ -1101,10 +1109,28 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        return 1;
     }
 
+    /* if format=mbox then we can not output excluded messages as
+     * there is no way to make the exclude flag available */
+    if (format_sel == NOTMUCH_FORMAT_MBOX)
+       notmuch_query_set_omit_excluded_messages (query, TRUE);
+
+    /* If a single message is requested we do not use search_excludes. */
     if (params.part >= 0)
        ret = do_show_single (ctx, query, format, &params);
-    else
+    else {
+       if (!no_exclude) {
+           const char **search_exclude_tags;
+           size_t search_exclude_tags_length;
+           unsigned int i;
+
+           search_exclude_tags = notmuch_config_get_search_exclude_tags
+               (config, &search_exclude_tags_length);
+           for (i = 0; i < search_exclude_tags_length; i++)
+               notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
+       }
        ret = do_show (ctx, query, format, &params);
+    }
+
 
     notmuch_query_destroy (query);
     notmuch_database_close (notmuch);