git.notmuchmail.org Git - notmuch/blob - notmuch-show.c

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see https://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-client.h"
  22 #include "gmime-filter-reply.h"
  23 #include "sprinter.h"
  24
  25 static notmuch_status_t
  26 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
  27                   int indent, const notmuch_show_params_t *params);
  28
  29 static const notmuch_show_format_t format_text = {
  30     .new_sprinter = sprinter_text_create,
  31     .part = format_part_text,
  32 };
  33
  34 static notmuch_status_t
  35 format_part_sprinter_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,
  36                             int indent, const notmuch_show_params_t *params);
  37
  38 static const notmuch_show_format_t format_json = {
  39     .new_sprinter = sprinter_json_create,
  40     .part = format_part_sprinter_entry,
  41 };
  42
  43 static const notmuch_show_format_t format_sexp = {
  44     .new_sprinter = sprinter_sexp_create,
  45     .part = format_part_sprinter_entry,
  46 };
  47
  48 static notmuch_status_t
  49 format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node,
  50                   int indent, const notmuch_show_params_t *params);
  51
  52 static const notmuch_show_format_t format_mbox = {
  53     .new_sprinter = sprinter_text_create,
  54     .part = format_part_mbox,
  55 };
  56
  57 static notmuch_status_t
  58 format_part_raw (unused (const void *ctx), sprinter_t *sp, mime_node_t *node,
  59                  unused (int indent),
  60                  unused (const notmuch_show_params_t *params));
  61
  62 static const notmuch_show_format_t format_raw = {
  63     .new_sprinter = sprinter_text_create,
  64     .part = format_part_raw,
  65 };
  66
  67 static const char *
  68 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
  69 {
  70     notmuch_tags_t *tags;
  71     int first = 1;
  72     const char *tag;
  73     char *result;
  74
  75     result = talloc_strdup (ctx, "");
  76     if (result == NULL)
  77         return NULL;
  78
  79     for (tags = notmuch_message_get_tags (message);
  80          notmuch_tags_valid (tags);
  81          notmuch_tags_move_to_next (tags))
  82     {
  83         tag = notmuch_tags_get (tags);
  84
  85         result = talloc_asprintf_append (result, "%s%s",
  86                                          first ? "" : " ", tag);
  87         first = 0;
  88     }
  89
  90     return result;
  91 }
  92
  93 /* Get a nice, single-line summary of message. */
  94 static const char *
  95 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
  96 {
  97     const char *from;
  98     time_t date;
  99     const char *relative_date;
 100     const char *tags;
 101
 102     from = notmuch_message_get_header (message, "from");
 103
 104     date = notmuch_message_get_date (message);
 105     relative_date = notmuch_time_relative_date (ctx, date);
 106
 107     tags = _get_tags_as_string (ctx, message);
 108
 109     return talloc_asprintf (ctx, "%s (%s) (%s)",
 110                             from, relative_date, tags);
 111 }
 112
 113 static const char *_get_disposition(GMimeObject *meta)
 114 {
 115     GMimeContentDisposition *disposition;
 116
 117     disposition = g_mime_object_get_content_disposition (meta);
 118     if (!disposition)
 119         return NULL;
 120
 121     return g_mime_content_disposition_get_disposition (disposition);
 122 }
 123
 124 /* Emit a sequence of key/value pairs for the metadata of message.
 125  * The caller should begin a map before calling this. */
 126 static void
 127 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
 128 {
 129     /* Any changes to the JSON or S-Expression format should be
 130      * reflected in the file devel/schemata. */
 131
 132     void *local = talloc_new (NULL);
 133     notmuch_tags_t *tags;
 134     time_t date;
 135     const char *relative_date;
 136
 137     sp->map_key (sp, "id");
 138     sp->string (sp, notmuch_message_get_message_id (message));
 139
 140     sp->map_key (sp, "match");
 141     sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
 142
 143     sp->map_key (sp, "excluded");
 144     sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
 145
 146     sp->map_key (sp, "filename");
 147     if (notmuch_format_version >= 3) {
 148         notmuch_filenames_t *filenames;
 149
 150         sp->begin_list (sp);
 151         for (filenames = notmuch_message_get_filenames (message);
 152              notmuch_filenames_valid (filenames);
 153              notmuch_filenames_move_to_next (filenames)) {
 154             sp->string (sp, notmuch_filenames_get (filenames));
 155         }
 156         notmuch_filenames_destroy (filenames);
 157         sp->end (sp);
 158     } else {
 159         sp->string (sp, notmuch_message_get_filename (message));
 160     }
 161
 162     sp->map_key (sp, "timestamp");
 163     date = notmuch_message_get_date (message);
 164     sp->integer (sp, date);
 165
 166     sp->map_key (sp, "date_relative");
 167     relative_date = notmuch_time_relative_date (local, date);
 168     sp->string (sp, relative_date);
 169
 170     sp->map_key (sp, "tags");
 171     sp->begin_list (sp);
 172     for (tags = notmuch_message_get_tags (message);
 173          notmuch_tags_valid (tags);
 174          notmuch_tags_move_to_next (tags))
 175         sp->string (sp, notmuch_tags_get (tags));
 176     sp->end (sp);
 177
 178     talloc_free (local);
 179 }
 180
 181 /* Extract just the email address from the contents of a From:
 182  * header. */
 183 static const char *
 184 _extract_email_address (const void *ctx, const char *from)
 185 {
 186     InternetAddressList *addresses;
 187     InternetAddress *address;
 188     InternetAddressMailbox *mailbox;
 189     const char *email = "MAILER-DAEMON";
 190
 191     addresses = internet_address_list_parse_string (from);
 192
 193     /* Bail if there is no address here. */
 194     if (addresses == NULL || internet_address_list_length (addresses) < 1)
 195         goto DONE;
 196
 197     /* Otherwise, just use the first address. */
 198     address = internet_address_list_get_address (addresses, 0);
 199
 200     /* The From header should never contain an address group rather
 201      * than a mailbox. So bail if it does. */
 202     if (! INTERNET_ADDRESS_IS_MAILBOX (address))
 203         goto DONE;
 204
 205     mailbox = INTERNET_ADDRESS_MAILBOX (address);
 206     email = internet_address_mailbox_get_addr (mailbox);
 207     email = talloc_strdup (ctx, email);
 208
 209   DONE:
 210     if (addresses)
 211         g_object_unref (addresses);
 212
 213     return email;
 214    }
 215
 216 /* Return 1 if 'line' is an mbox From_ line---that is, a line
 217  * beginning with zero or more '>' characters followed by the
 218  * characters 'F', 'r', 'o', 'm', and space.
 219  *
 220  * Any characters at all may appear after that in the line.
 221  */
 222 static int
 223 _is_from_line (const char *line)
 224 {
 225     const char *s = line;
 226
 227     if (line == NULL)
 228         return 0;
 229
 230     while (*s == '>')
 231         s++;
 232
 233     if (STRNCMP_LITERAL (s, "From ") == 0)
 234         return 1;
 235     else
 236         return 0;
 237 }
 238
 239 void
 240 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
 241                          notmuch_bool_t reply)
 242 {
 243     /* Any changes to the JSON or S-Expression format should be
 244      * reflected in the file devel/schemata. */
 245
 246     InternetAddressList *recipients;
 247     const char *recipients_string;
 248     const char *reply_to_string;
 249
 250     sp->begin_map (sp);
 251
 252     sp->map_key (sp, "Subject");
 253     sp->string (sp, g_mime_message_get_subject (message));
 254
 255     sp->map_key (sp, "From");
 256     sp->string (sp, g_mime_message_get_sender (message));
 257
 258     recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
 259     recipients_string = internet_address_list_to_string (recipients, 0);
 260     if (recipients_string) {
 261         sp->map_key (sp, "To");
 262         sp->string (sp, recipients_string);
 263     }
 264
 265     recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
 266     recipients_string = internet_address_list_to_string (recipients, 0);
 267     if (recipients_string) {
 268         sp->map_key (sp, "Cc");
 269         sp->string (sp, recipients_string);
 270     }
 271
 272     recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
 273     recipients_string = internet_address_list_to_string (recipients, 0);
 274     if (recipients_string) {
 275         sp->map_key (sp, "Bcc");
 276         sp->string (sp, recipients_string);
 277     }
 278
 279     reply_to_string = g_mime_message_get_reply_to (message);
 280     if (reply_to_string) {
 281         sp->map_key (sp, "Reply-To");
 282         sp->string (sp, reply_to_string);
 283     }
 284
 285     if (reply) {
 286         sp->map_key (sp, "In-reply-to");
 287         sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
 288
 289         sp->map_key (sp, "References");
 290         sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
 291     } else {
 292         sp->map_key (sp, "Date");
 293         sp->string (sp, g_mime_message_get_date_as_string (message));
 294     }
 295
 296     sp->end (sp);
 297 }
 298
 299 /* Write a MIME text part out to the given stream.
 300  *
 301  * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
 302  * each output line.
 303  *
 304  * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
 305  * UTF-8) will be performed, so it is inappropriate to call this
 306  * function with a non-text part. Doing so will trigger an internal
 307  * error.
 308  */
 309 void
 310 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 311                         notmuch_show_text_part_flags flags)
 312 {
 313     GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
 314     GMimeStream *stream_filter = NULL;
 315     GMimeDataWrapper *wrapper;
 316     const char *charset;
 317
 318     if (! g_mime_content_type_is_type (content_type, "text", "*"))
 319         INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
 320                         g_mime_content_type_to_string (content_type));
 321
 322     if (stream_out == NULL)
 323         return;
 324
 325     stream_filter = g_mime_stream_filter_new (stream_out);
 326     g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
 327                              g_mime_filter_crlf_new (FALSE, FALSE));
 328
 329     charset = g_mime_object_get_content_type_parameter (part, "charset");
 330     if (charset) {
 331         GMimeFilter *charset_filter;
 332         charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
 333         /* This result can be NULL for things like "unknown-8bit".
 334          * Don't set a NULL filter as that makes GMime print
 335          * annoying assertion-failure messages on stderr. */
 336         if (charset_filter) {
 337             g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
 338                                       charset_filter);
 339             g_object_unref (charset_filter);
 340         }
 341
 342     }
 343
 344     if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
 345         GMimeFilter *reply_filter;
 346         reply_filter = g_mime_filter_reply_new (TRUE);
 347         if (reply_filter) {
 348             g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
 349                                       reply_filter);
 350             g_object_unref (reply_filter);
 351         }
 352     }
 353
 354     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
 355     if (wrapper && stream_filter)
 356         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
 357     if (stream_filter)
 358         g_object_unref(stream_filter);
 359 }
 360
 361 /* Get signature status string (GMime 2.6) */
 362 static const char*
 363 signature_status_to_string (GMimeSignatureStatus x)
 364 {
 365     switch (x) {
 366     case GMIME_SIGNATURE_STATUS_GOOD:
 367         return "good";
 368     case GMIME_SIGNATURE_STATUS_BAD:
 369         return "bad";
 370     case GMIME_SIGNATURE_STATUS_ERROR:
 371         return "error";
 372     }
 373     return "unknown";
 374 }
 375
 376 /* Signature status sprinter (GMime 2.6) */
 377 static void
 378 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
 379 {
 380     /* Any changes to the JSON or S-Expression format should be
 381      * reflected in the file devel/schemata. */
 382
 383     GMimeSignatureList *siglist = node->sig_list;
 384
 385     sp->begin_list (sp);
 386
 387     if (!siglist) {
 388         sp->end (sp);
 389         return;
 390     }
 391
 392     int i;
 393     for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
 394         GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
 395
 396         sp->begin_map (sp);
 397
 398         /* status */
 399         GMimeSignatureStatus status = g_mime_signature_get_status (signature);
 400         sp->map_key (sp, "status");
 401         sp->string (sp, signature_status_to_string (status));
 402
 403         GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
 404         if (status == GMIME_SIGNATURE_STATUS_GOOD) {
 405             if (certificate) {
 406                 sp->map_key (sp, "fingerprint");
 407                 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
 408             }
 409             /* these dates are seconds since the epoch; should we
 410              * provide a more human-readable format string? */
 411             time_t created = g_mime_signature_get_created (signature);
 412             if (created != -1) {
 413                 sp->map_key (sp, "created");
 414                 sp->integer (sp, created);
 415             }
 416             time_t expires = g_mime_signature_get_expires (signature);
 417             if (expires > 0) {
 418                 sp->map_key (sp, "expires");
 419                 sp->integer (sp, expires);
 420             }
 421             /* output user id only if validity is FULL or ULTIMATE. */
 422             /* note that gmime is using the term "trust" here, which
 423              * is WRONG.  It's actually user id "validity". */
 424             if (certificate) {
 425                 const char *name = g_mime_certificate_get_name (certificate);
 426                 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
 427                 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
 428                     sp->map_key (sp, "userid");
 429                     sp->string (sp, name);
 430                 }
 431             }
 432         } else if (certificate) {
 433             const char *key_id = g_mime_certificate_get_key_id (certificate);
 434             if (key_id) {
 435                 sp->map_key (sp, "keyid");
 436                 sp->string (sp, key_id);
 437             }
 438         }
 439
 440         GMimeSignatureError errors = g_mime_signature_get_errors (signature);
 441         if (errors != GMIME_SIGNATURE_ERROR_NONE) {
 442             sp->map_key (sp, "errors");
 443             sp->integer (sp, errors);
 444         }
 445
 446         sp->end (sp);
 447      }
 448
 449     sp->end (sp);
 450 }
 451
 452 static notmuch_status_t
 453 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
 454                   int indent, const notmuch_show_params_t *params)
 455 {
 456     /* The disposition and content-type metadata are associated with
 457      * the envelope for message parts */
 458     GMimeObject *meta = node->envelope_part ?
 459         GMIME_OBJECT (node->envelope_part) : node->part;
 460     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
 461     const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
 462     const char *part_type;
 463     int i;
 464
 465     if (node->envelope_file) {
 466         notmuch_message_t *message = node->envelope_file;
 467
 468         part_type = "message";
 469         printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
 470                 part_type,
 471                 notmuch_message_get_message_id (message),
 472                 indent,
 473                 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
 474                 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
 475                 notmuch_message_get_filename (message));
 476     } else {
 477         const char *disposition = _get_disposition (meta);
 478         const char *cid = g_mime_object_get_content_id (meta);
 479         const char *filename = leaf ?
 480             g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
 481
 482         if (disposition &&
 483             strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
 484             part_type = "attachment";
 485         else
 486             part_type = "part";
 487
 488         printf ("\f%s{ ID: %d", part_type, node->part_num);
 489         if (filename)
 490             printf (", Filename: %s", filename);
 491         if (cid)
 492             printf (", Content-id: %s", cid);
 493         printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
 494     }
 495
 496     if (GMIME_IS_MESSAGE (node->part)) {
 497         GMimeMessage *message = GMIME_MESSAGE (node->part);
 498         InternetAddressList *recipients;
 499         const char *recipients_string;
 500
 501         printf ("\fheader{\n");
 502         if (node->envelope_file)
 503             printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
 504         printf ("Subject: %s\n", g_mime_message_get_subject (message));
 505         printf ("From: %s\n", g_mime_message_get_sender (message));
 506         recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
 507         recipients_string = internet_address_list_to_string (recipients, 0);
 508         if (recipients_string)
 509             printf ("To: %s\n", recipients_string);
 510         recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
 511         recipients_string = internet_address_list_to_string (recipients, 0);
 512         if (recipients_string)
 513             printf ("Cc: %s\n", recipients_string);
 514         printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
 515         printf ("\fheader}\n");
 516
 517         printf ("\fbody{\n");
 518     }
 519
 520     if (leaf) {
 521         if (g_mime_content_type_is_type (content_type, "text", "*") &&
 522             !g_mime_content_type_is_type (content_type, "text", "html"))
 523         {
 524             GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
 525             g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
 526             show_text_part_content (node->part, stream_stdout, 0);
 527             g_object_unref(stream_stdout);
 528         } else {
 529             printf ("Non-text part: %s\n",
 530                     g_mime_content_type_to_string (content_type));
 531         }
 532     }
 533
 534     for (i = 0; i < node->nchildren; i++)
 535         format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
 536
 537     if (GMIME_IS_MESSAGE (node->part))
 538         printf ("\fbody}\n");
 539
 540     printf ("\f%s}\n", part_type);
 541
 542     return NOTMUCH_STATUS_SUCCESS;
 543 }
 544
 545 static void
 546 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
 547 {
 548     const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
 549     const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
 550     GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
 551     GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
 552     ssize_t content_length = g_mime_stream_length (stream);
 553
 554     if (content_charset != NULL) {
 555         sp->map_key (sp, "content-charset");
 556         sp->string (sp, content_charset);
 557     }
 558     if (cte != NULL) {
 559         sp->map_key (sp, "content-transfer-encoding");
 560         sp->string (sp, cte);
 561     }
 562     if (content_length >= 0) {
 563         sp->map_key (sp, "content-length");
 564         sp->integer (sp, content_length);
 565     }
 566 }
 567
 568 void
 569 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
 570                       notmuch_bool_t first, notmuch_bool_t output_body,
 571                       notmuch_bool_t include_html)
 572 {
 573     /* Any changes to the JSON or S-Expression format should be
 574      * reflected in the file devel/schemata. */
 575
 576     if (node->envelope_file) {
 577         sp->begin_map (sp);
 578         format_message_sprinter (sp, node->envelope_file);
 579
 580         sp->map_key (sp, "headers");
 581         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
 582
 583         if (output_body) {
 584             sp->map_key (sp, "body");
 585             sp->begin_list (sp);
 586             format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
 587             sp->end (sp);
 588         }
 589         sp->end (sp);
 590         return;
 591     }
 592
 593     /* The disposition and content-type metadata are associated with
 594      * the envelope for message parts */
 595     GMimeObject *meta = node->envelope_part ?
 596         GMIME_OBJECT (node->envelope_part) : node->part;
 597     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
 598     const char *cid = g_mime_object_get_content_id (meta);
 599     const char *filename = GMIME_IS_PART (node->part) ?
 600         g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
 601     int nclose = 0;
 602     int i;
 603
 604     sp->begin_map (sp);
 605
 606     sp->map_key (sp, "id");
 607     sp->integer (sp, node->part_num);
 608
 609     if (node->decrypt_attempted) {
 610         sp->map_key (sp, "encstatus");
 611         sp->begin_list (sp);
 612         sp->begin_map (sp);
 613         sp->map_key (sp, "status");
 614         sp->string (sp, node->decrypt_success ? "good" : "bad");
 615         sp->end (sp);
 616         sp->end (sp);
 617     }
 618
 619     if (node->verify_attempted) {
 620         sp->map_key (sp, "sigstatus");
 621         format_part_sigstatus_sprinter (sp, node);
 622     }
 623
 624     sp->map_key (sp, "content-type");
 625     sp->string (sp, g_mime_content_type_to_string (content_type));
 626
 627     if (cid) {
 628         sp->map_key (sp, "content-id");
 629         sp->string (sp, cid);
 630     }
 631
 632     if (filename) {
 633         sp->map_key (sp, "filename");
 634         sp->string (sp, filename);
 635     }
 636
 637     if (GMIME_IS_PART (node->part)) {
 638         /* For non-HTML text parts, we include the content in the
 639          * JSON. Since JSON must be Unicode, we handle charset
 640          * decoding here and do not report a charset to the caller.
 641          * For text/html parts, we do not include the content unless
 642          * the --include-html option has been passed. If a html part
 643          * is not included, it can be requested directly. This makes
 644          * charset decoding the responsibility on the caller so we
 645          * report the charset for text/html parts.
 646          */
 647         if (g_mime_content_type_is_type (content_type, "text", "*") &&
 648             (include_html ||
 649              ! g_mime_content_type_is_type (content_type, "text", "html")))
 650         {
 651             GMimeStream *stream_memory = g_mime_stream_mem_new ();
 652             GByteArray *part_content;
 653             show_text_part_content (node->part, stream_memory, 0);
 654             part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
 655             sp->map_key (sp, "content");
 656             sp->string_len (sp, (char *) part_content->data, part_content->len);
 657             g_object_unref (stream_memory);
 658         } else {
 659             format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
 660         }
 661     } else if (GMIME_IS_MULTIPART (node->part)) {
 662         sp->map_key (sp, "content");
 663         sp->begin_list (sp);
 664         nclose = 1;
 665     } else if (GMIME_IS_MESSAGE (node->part)) {
 666         sp->map_key (sp, "content");
 667         sp->begin_list (sp);
 668         sp->begin_map (sp);
 669
 670         sp->map_key (sp, "headers");
 671         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
 672
 673         sp->map_key (sp, "body");
 674         sp->begin_list (sp);
 675         nclose = 3;
 676     }
 677
 678     for (i = 0; i < node->nchildren; i++)
 679         format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
 680
 681     /* Close content structures */
 682     for (i = 0; i < nclose; i++)
 683         sp->end (sp);
 684     /* Close part map */
 685     sp->end (sp);
 686 }
 687
 688 static notmuch_status_t
 689 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
 690                             mime_node_t *node, unused (int indent),
 691                             const notmuch_show_params_t *params)
 692 {
 693     format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
 694
 695     return NOTMUCH_STATUS_SUCCESS;
 696 }
 697
 698 /* Print a message in "mboxrd" format as documented, for example,
 699  * here:
 700  *
 701  * http://qmail.org/qmail-manual-html/man5/mbox.html
 702  */
 703 static notmuch_status_t
 704 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
 705                   unused (int indent),
 706                   unused (const notmuch_show_params_t *params))
 707 {
 708     notmuch_message_t *message = node->envelope_file;
 709
 710     const char *filename;
 711     FILE *file;
 712     const char *from;
 713
 714     time_t date;
 715     struct tm date_gmtime;
 716     char date_asctime[26];
 717
 718     char *line = NULL;
 719     size_t line_size;
 720     ssize_t line_len;
 721
 722     if (!message)
 723         INTERNAL_ERROR ("format_part_mbox requires a root part");
 724
 725     filename = notmuch_message_get_filename (message);
 726     file = fopen (filename, "r");
 727     if (file == NULL) {
 728         fprintf (stderr, "Failed to open %s: %s\n",
 729                  filename, strerror (errno));
 730         return NOTMUCH_STATUS_FILE_ERROR;
 731     }
 732
 733     from = notmuch_message_get_header (message, "from");
 734     from = _extract_email_address (ctx, from);
 735
 736     date = notmuch_message_get_date (message);
 737     gmtime_r (&date, &date_gmtime);
 738     asctime_r (&date_gmtime, date_asctime);
 739
 740     printf ("From %s %s", from, date_asctime);
 741
 742     while ((line_len = getline (&line, &line_size, file)) != -1 ) {
 743         if (_is_from_line (line))
 744             putchar ('>');
 745         printf ("%s", line);
 746     }
 747
 748     printf ("\n");
 749
 750     fclose (file);
 751
 752     return NOTMUCH_STATUS_SUCCESS;
 753 }
 754
 755 static notmuch_status_t
 756 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
 757                  mime_node_t *node, unused (int indent),
 758                  unused (const notmuch_show_params_t *params))
 759 {
 760     if (node->envelope_file) {
 761         /* Special case the entire message to avoid MIME parsing. */
 762         const char *filename;
 763         FILE *file;
 764         size_t size;
 765         char buf[4096];
 766
 767         filename = notmuch_message_get_filename (node->envelope_file);
 768         if (filename == NULL) {
 769             fprintf (stderr, "Error: Cannot get message filename.\n");
 770             return NOTMUCH_STATUS_FILE_ERROR;
 771         }
 772
 773         file = fopen (filename, "r");
 774         if (file == NULL) {
 775             fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
 776             return NOTMUCH_STATUS_FILE_ERROR;
 777         }
 778
 779         while (!feof (file)) {
 780             size = fread (buf, 1, sizeof (buf), file);
 781             if (ferror (file)) {
 782                 fprintf (stderr, "Error: Read failed from %s\n", filename);
 783                 fclose (file);
 784                 return NOTMUCH_STATUS_FILE_ERROR;
 785             }
 786
 787             if (fwrite (buf, size, 1, stdout) != 1) {
 788                 fprintf (stderr, "Error: Write failed\n");
 789                 fclose (file);
 790                 return NOTMUCH_STATUS_FILE_ERROR;
 791             }
 792         }
 793
 794         fclose (file);
 795         return NOTMUCH_STATUS_SUCCESS;
 796     }
 797
 798     GMimeStream *stream_stdout;
 799     GMimeStream *stream_filter = NULL;
 800
 801     stream_stdout = g_mime_stream_file_new (stdout);
 802     g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
 803
 804     stream_filter = g_mime_stream_filter_new (stream_stdout);
 805
 806     if (GMIME_IS_PART (node->part)) {
 807         /* For leaf parts, we emit only the transfer-decoded
 808          * body. */
 809         GMimeDataWrapper *wrapper;
 810         wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
 811
 812         if (wrapper && stream_filter)
 813             g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
 814     } else {
 815         /* Write out the whole part.  For message parts (the root
 816          * part and embedded message parts), this will be the
 817          * message including its headers (but not the
 818          * encapsulating part's headers).  For multipart parts,
 819          * this will include the headers. */
 820         if (stream_filter)
 821             g_mime_object_write_to_stream (node->part, stream_filter);
 822     }
 823
 824     if (stream_filter)
 825         g_object_unref (stream_filter);
 826
 827     if (stream_stdout)
 828         g_object_unref(stream_stdout);
 829
 830     return NOTMUCH_STATUS_SUCCESS;
 831 }
 832
 833 static notmuch_status_t
 834 show_message (void *ctx,
 835               const notmuch_show_format_t *format,
 836               sprinter_t *sp,
 837               notmuch_message_t *message,
 838               int indent,
 839               notmuch_show_params_t *params)
 840 {
 841     void *local = talloc_new (ctx);
 842     mime_node_t *root, *part;
 843     notmuch_status_t status;
 844
 845     status = mime_node_open (local, message, &(params->crypto), &root);
 846     if (status)
 847         goto DONE;
 848     part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
 849     if (part)
 850         status = format->part (local, sp, part, indent, params);
 851   DONE:
 852     talloc_free (local);
 853     return status;
 854 }
 855
 856 static notmuch_status_t
 857 show_messages (void *ctx,
 858                const notmuch_show_format_t *format,
 859                sprinter_t *sp,
 860                notmuch_messages_t *messages,
 861                int indent,
 862                notmuch_show_params_t *params)
 863 {
 864     notmuch_message_t *message;
 865     notmuch_bool_t match;
 866     notmuch_bool_t excluded;
 867     int next_indent;
 868     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
 869
 870     sp->begin_list (sp);
 871
 872     for (;
 873          notmuch_messages_valid (messages);
 874          notmuch_messages_move_to_next (messages))
 875     {
 876         sp->begin_list (sp);
 877
 878         message = notmuch_messages_get (messages);
 879
 880         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
 881         excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
 882
 883         next_indent = indent;
 884
 885         if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
 886             status = show_message (ctx, format, sp, message, indent, params);
 887             if (status && !res)
 888                 res = status;
 889             next_indent = indent + 1;
 890         } else {
 891             sp->null (sp);
 892         }
 893
 894         status = show_messages (ctx,
 895                                 format, sp,
 896                                 notmuch_message_get_replies (message),
 897                                 next_indent,
 898                                 params);
 899         if (status && !res)
 900             res = status;
 901
 902         notmuch_message_destroy (message);
 903
 904         sp->end (sp);
 905     }
 906
 907     sp->end (sp);
 908
 909     return res;
 910 }
 911
 912 /* Formatted output of single message */
 913 static int
 914 do_show_single (void *ctx,
 915                 notmuch_query_t *query,
 916                 const notmuch_show_format_t *format,
 917                 sprinter_t *sp,
 918                 notmuch_show_params_t *params)
 919 {
 920     notmuch_messages_t *messages;
 921     notmuch_message_t *message;
 922     notmuch_status_t status;
 923     unsigned int count;
 924
 925     status = notmuch_query_count_messages_st (query, &count);
 926     if (print_status_query ("notmuch show", query, status))
 927         return 1;
 928
 929     if (count != 1) {
 930         fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count);
 931         return 1;
 932     }
 933
 934     status = notmuch_query_search_messages_st (query, &messages);
 935     if (print_status_query ("notmuch show", query, status))
 936         return 1;
 937
 938     message = notmuch_messages_get (messages);
 939
 940     if (message == NULL) {
 941         fprintf (stderr, "Error: Cannot find matching message.\n");
 942         return 1;
 943     }
 944
 945     notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 946
 947     return show_message (ctx, format, sp, message, 0, params)
 948         != NOTMUCH_STATUS_SUCCESS;
 949 }
 950
 951 /* Formatted output of threads */
 952 static int
 953 do_show (void *ctx,
 954          notmuch_query_t *query,
 955          const notmuch_show_format_t *format,
 956          sprinter_t *sp,
 957          notmuch_show_params_t *params)
 958 {
 959     notmuch_threads_t *threads;
 960     notmuch_thread_t *thread;
 961     notmuch_messages_t *messages;
 962     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
 963
 964     status= notmuch_query_search_threads_st (query, &threads);
 965     if (print_status_query ("notmuch show", query, status))
 966         return 1;
 967
 968     sp->begin_list (sp);
 969
 970     for ( ;
 971          notmuch_threads_valid (threads);
 972          notmuch_threads_move_to_next (threads))
 973     {
 974         thread = notmuch_threads_get (threads);
 975
 976         messages = notmuch_thread_get_toplevel_messages (thread);
 977
 978         if (messages == NULL)
 979             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
 980                             notmuch_thread_get_thread_id (thread));
 981
 982         status = show_messages (ctx, format, sp, messages, 0, params);
 983         if (status && !res)
 984             res = status;
 985
 986         notmuch_thread_destroy (thread);
 987
 988     }
 989
 990     sp->end (sp);
 991
 992     return res != NOTMUCH_STATUS_SUCCESS;
 993 }
 994
 995 enum {
 996     NOTMUCH_FORMAT_NOT_SPECIFIED,
 997     NOTMUCH_FORMAT_JSON,
 998     NOTMUCH_FORMAT_SEXP,
 999     NOTMUCH_FORMAT_TEXT,
1000     NOTMUCH_FORMAT_MBOX,
1001     NOTMUCH_FORMAT_RAW
1002 };
1003
1004 enum {
1005     ENTIRE_THREAD_DEFAULT,
1006     ENTIRE_THREAD_TRUE,
1007     ENTIRE_THREAD_FALSE,
1008 };
1009
1010 /* The following is to allow future options to be added more easily */
1011 enum {
1012     EXCLUDE_TRUE,
1013     EXCLUDE_FALSE,
1014 };
1015
1016 int
1017 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1018 {
1019     notmuch_database_t *notmuch;
1020     notmuch_query_t *query;
1021     char *query_string;
1022     int opt_index, ret;
1023     const notmuch_show_format_t *format = &format_text;
1024     sprinter_t *sprinter;
1025     notmuch_show_params_t params = {
1026         .part = -1,
1027         .omit_excluded = TRUE,
1028         .output_body = TRUE,
1029         .crypto = {
1030             .verify = FALSE,
1031             .decrypt = FALSE,
1032             .gpgpath = NULL
1033         },
1034         .include_html = FALSE
1035     };
1036     int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
1037     int exclude = EXCLUDE_TRUE;
1038     int entire_thread = ENTIRE_THREAD_DEFAULT;
1039
1040     notmuch_opt_desc_t options[] = {
1041         { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
1042           (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1043                                   { "text", NOTMUCH_FORMAT_TEXT },
1044                                   { "sexp", NOTMUCH_FORMAT_SEXP },
1045                                   { "mbox", NOTMUCH_FORMAT_MBOX },
1046                                   { "raw", NOTMUCH_FORMAT_RAW },
1047                                   { 0, 0 } } },
1048         { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
1049         { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1050           (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1051                                   { "false", EXCLUDE_FALSE },
1052                                   { 0, 0 } } },
1053         { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1054           (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1055                                   { "false", ENTIRE_THREAD_FALSE },
1056                                   { "", ENTIRE_THREAD_TRUE },
1057                                   { 0, 0 } } },
1058         { NOTMUCH_OPT_INT, &params.part, "part", 'p', 0 },
1059         { NOTMUCH_OPT_BOOLEAN, &params.crypto.decrypt, "decrypt", 'd', 0 },
1060         { NOTMUCH_OPT_BOOLEAN, &params.crypto.verify, "verify", 'v', 0 },
1061         { NOTMUCH_OPT_BOOLEAN, &params.output_body, "body", 'b', 0 },
1062         { NOTMUCH_OPT_BOOLEAN, &params.include_html, "include-html", 0, 0 },
1063         { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
1064         { 0, 0, 0, 0, 0 }
1065     };
1066
1067     opt_index = parse_arguments (argc, argv, options, 1);
1068     if (opt_index < 0)
1069         return EXIT_FAILURE;
1070
1071     notmuch_process_shared_options (argv[0]);
1072
1073     /* decryption implies verification */
1074     if (params.crypto.decrypt)
1075         params.crypto.verify = TRUE;
1076
1077     if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1078         /* if part was requested and format was not specified, use format=raw */
1079         if (params.part >= 0)
1080             format_sel = NOTMUCH_FORMAT_RAW;
1081         else
1082             format_sel = NOTMUCH_FORMAT_TEXT;
1083     }
1084
1085     switch (format_sel) {
1086     case NOTMUCH_FORMAT_JSON:
1087         format = &format_json;
1088         break;
1089     case NOTMUCH_FORMAT_TEXT:
1090         format = &format_text;
1091         break;
1092     case NOTMUCH_FORMAT_SEXP:
1093         format = &format_sexp;
1094         break;
1095     case NOTMUCH_FORMAT_MBOX:
1096         if (params.part > 0) {
1097             fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1098             return EXIT_FAILURE;
1099         }
1100
1101         format = &format_mbox;
1102         break;
1103     case NOTMUCH_FORMAT_RAW:
1104         format = &format_raw;
1105         /* If --format=raw specified without specifying part, we can only
1106          * output single message, so set part=0 */
1107         if (params.part < 0)
1108             params.part = 0;
1109         params.raw = TRUE;
1110         break;
1111     }
1112
1113     notmuch_exit_if_unsupported_format ();
1114
1115     /* Default is entire-thread = FALSE except for format=json and
1116      * format=sexp. */
1117     if (entire_thread == ENTIRE_THREAD_DEFAULT) {
1118         if (format == &format_json || format == &format_sexp)
1119             entire_thread = ENTIRE_THREAD_TRUE;
1120         else
1121             entire_thread = ENTIRE_THREAD_FALSE;
1122     }
1123
1124     if (!params.output_body) {
1125         if (params.part > 0) {
1126             fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1127             params.output_body = TRUE;
1128         } else {
1129             if (format != &format_json && format != &format_sexp)
1130                 fprintf (stderr,
1131                          "Warning: --body=false only implemented for format=json and format=sexp\n");
1132         }
1133     }
1134
1135     if (params.include_html &&
1136         (format_sel != NOTMUCH_FORMAT_JSON && format_sel != NOTMUCH_FORMAT_SEXP)) {
1137         fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1138     }
1139
1140     if (entire_thread == ENTIRE_THREAD_TRUE)
1141         params.entire_thread = TRUE;
1142     else
1143         params.entire_thread = FALSE;
1144
1145     query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1146     if (query_string == NULL) {
1147         fprintf (stderr, "Out of memory\n");
1148         return EXIT_FAILURE;
1149     }
1150
1151     if (*query_string == '\0') {
1152         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1153         return EXIT_FAILURE;
1154     }
1155
1156     params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1157
1158     if (notmuch_database_open (notmuch_config_get_database_path (config),
1159                                NOTMUCH_DATABASE_MODE_READ_ONLY, &notmuch))
1160         return EXIT_FAILURE;
1161
1162     notmuch_exit_if_unmatched_db_uuid (notmuch);
1163
1164     query = notmuch_query_create (notmuch, query_string);
1165     if (query == NULL) {
1166         fprintf (stderr, "Out of memory\n");
1167         return EXIT_FAILURE;
1168     }
1169
1170     /* Create structure printer. */
1171     sprinter = format->new_sprinter(config, stdout);
1172
1173     /* If a single message is requested we do not use search_excludes. */
1174     if (params.part >= 0)
1175         ret = do_show_single (config, query, format, sprinter, &params);
1176     else {
1177         /* We always apply set the exclude flag. The
1178          * exclude=true|false option controls whether or not we return
1179          * threads that only match in an excluded message */
1180         const char **search_exclude_tags;
1181         size_t search_exclude_tags_length;
1182         unsigned int i;
1183
1184         search_exclude_tags = notmuch_config_get_search_exclude_tags
1185             (config, &search_exclude_tags_length);
1186         for (i = 0; i < search_exclude_tags_length; i++)
1187             notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1188
1189         if (exclude == EXCLUDE_FALSE) {
1190             notmuch_query_set_omit_excluded (query, FALSE);
1191             params.omit_excluded = FALSE;
1192         }
1193
1194         ret = do_show (config, query, format, sprinter, &params);
1195     }
1196
1197     notmuch_crypto_cleanup (&params.crypto);
1198     notmuch_query_destroy (query);
1199     notmuch_database_destroy (notmuch);
1200
1201     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
1202 }