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 http://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-client.h"
  22
  23 typedef struct show_format {
  24     const char *message_set_start;
  25     const char *message_start;
  26     void (*message) (const void *ctx,
  27                      notmuch_message_t *message,
  28                      int indent);
  29     const char *header_start;
  30     void (*header) (const void *ctx,
  31                     notmuch_message_t *message);
  32     const char *header_end;
  33     const char *body_start;
  34     void (*part) (GMimeObject *part,
  35                   int *part_count);
  36     const char *body_end;
  37     const char *message_end;
  38     const char *message_set_sep;
  39     const char *message_set_end;
  40 } show_format_t;
  41
  42 static void
  43 format_message_text (unused (const void *ctx),
  44                      notmuch_message_t *message,
  45                      int indent);
  46 static void
  47 format_headers_text (const void *ctx,
  48                      notmuch_message_t *message);
  49 static void
  50 format_part_text (GMimeObject *part,
  51                   int *part_count);
  52 static const show_format_t format_text = {
  53     "",
  54         "\fmessage{ ", format_message_text,
  55             "\fheader{\n", format_headers_text, "\fheader}\n",
  56             "\fbody{\n", format_part_text, "\fbody}\n",
  57         "\fmessage}\n", "",
  58     ""
  59 };
  60
  61 static void
  62 format_message_json (const void *ctx,
  63                      notmuch_message_t *message,
  64                      unused (int indent));
  65 static void
  66 format_headers_json (const void *ctx,
  67                      notmuch_message_t *message);
  68 static void
  69 format_part_json (GMimeObject *part,
  70                   int *part_count);
  71 static const show_format_t format_json = {
  72     "[",
  73         "{", format_message_json,
  74             ", \"headers\": {", format_headers_json, "}",
  75             ", \"body\": [", format_part_json, "]",
  76         "}", ", ",
  77     "]"
  78 };
  79
  80 static const char *
  81 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
  82 {
  83     notmuch_tags_t *tags;
  84     int first = 1;
  85     const char *tag;
  86     char *result;
  87
  88     result = talloc_strdup (ctx, "");
  89     if (result == NULL)
  90         return NULL;
  91
  92     for (tags = notmuch_message_get_tags (message);
  93          notmuch_tags_valid (tags);
  94          notmuch_tags_move_to_next (tags))
  95     {
  96         tag = notmuch_tags_get (tags);
  97
  98         result = talloc_asprintf_append (result, "%s%s",
  99                                          first ? "" : " ", tag);
 100         first = 0;
 101     }
 102
 103     return result;
 104 }
 105
 106 /* Get a nice, single-line summary of message. */
 107 static const char *
 108 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
 109 {
 110     const char *from;
 111     time_t date;
 112     const char *relative_date;
 113     const char *tags;
 114
 115     from = notmuch_message_get_header (message, "from");
 116
 117     date = notmuch_message_get_date (message);
 118     relative_date = notmuch_time_relative_date (ctx, date);
 119
 120     tags = _get_tags_as_string (ctx, message);
 121
 122     return talloc_asprintf (ctx, "%s (%s) (%s)",
 123                             from, relative_date, tags);
 124 }
 125
 126 static void
 127 format_message_text (unused (const void *ctx), notmuch_message_t *message, int indent)
 128 {
 129     printf ("id:%s depth:%d match:%d filename:%s\n",
 130             notmuch_message_get_message_id (message),
 131             indent,
 132             notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
 133             notmuch_message_get_filename (message));
 134 }
 135
 136 static void
 137 format_message_json (const void *ctx, notmuch_message_t *message, unused (int indent))
 138 {
 139     void *ctx_quote = talloc_new (ctx);
 140
 141     printf ("\"id\": %s, \"match\": %s, \"filename\": %s",
 142             json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
 143             notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
 144             json_quote_str (ctx_quote, notmuch_message_get_filename (message)));
 145
 146     talloc_free (ctx_quote);
 147 }
 148
 149 static void
 150 format_headers_text (const void *ctx, notmuch_message_t *message)
 151 {
 152     const char *headers[] = {
 153         "Subject", "From", "To", "Cc", "Bcc", "Date"
 154     };
 155     const char *name, *value;
 156     unsigned int i;
 157
 158     printf ("%s\n", _get_one_line_summary (ctx, message));
 159
 160     for (i = 0; i < ARRAY_SIZE (headers); i++) {
 161         name = headers[i];
 162         value = notmuch_message_get_header (message, name);
 163         if (value && strlen (value))
 164             printf ("%s: %s\n", name, value);
 165     }
 166 }
 167
 168 static void
 169 format_headers_json (const void *ctx, notmuch_message_t *message)
 170 {
 171     const char *headers[] = {
 172         "Subject", "From", "To", "Cc", "Bcc", "Date"
 173     };
 174     const char *name, *value;
 175     unsigned int i;
 176     int first_header = 1;
 177     void *ctx_quote = talloc_new (ctx);
 178
 179     for (i = 0; i < ARRAY_SIZE (headers); i++) {
 180         name = headers[i];
 181         value = notmuch_message_get_header (message, name);
 182         if (value)
 183         {
 184             if (!first_header)
 185                 fputs (", ", stdout);
 186             first_header = 0;
 187
 188             printf ("%s: %s",
 189                     json_quote_str (ctx_quote, name),
 190                     json_quote_str (ctx_quote, value));
 191         }
 192     }
 193
 194     talloc_free (ctx_quote);
 195 }
 196
 197 static void
 198 show_part_content (GMimeObject *part, GMimeStream *stream_out)
 199 {
 200     GMimeStream *stream_filter = NULL;
 201     GMimeDataWrapper *wrapper;
 202     const char *charset;
 203
 204     charset = g_mime_object_get_content_type_parameter (part, "charset");
 205
 206     if (stream_out) {
 207         stream_filter = g_mime_stream_filter_new(stream_out);
 208         g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
 209                                  g_mime_filter_crlf_new(FALSE, FALSE));
 210         if (charset) {
 211           g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
 212                                    g_mime_filter_charset_new(charset, "UTF-8"));
 213         }
 214     }
 215
 216     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
 217     if (wrapper && stream_filter)
 218         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
 219     if (stream_filter)
 220         g_object_unref(stream_filter);
 221 }
 222
 223 static void
 224 format_part_text (GMimeObject *part, int *part_count)
 225 {
 226     GMimeContentDisposition *disposition;
 227     GMimeContentType *content_type;
 228     GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
 229
 230     g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
 231
 232     disposition = g_mime_object_get_content_disposition (part);
 233     if (disposition &&
 234         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
 235     {
 236         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
 237         content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
 238
 239         printf ("\fattachment{ ID: %d, Content-type: %s\n",
 240                 *part_count,
 241                 g_mime_content_type_to_string (content_type));
 242         printf ("Attachment: %s (%s)\n", filename,
 243                 g_mime_content_type_to_string (content_type));
 244
 245         if (g_mime_content_type_is_type (content_type, "text", "*") &&
 246             !g_mime_content_type_is_type (content_type, "text", "html"))
 247         {
 248             show_part_content (part, stream_stdout);
 249         }
 250
 251         printf ("\fattachment}\n");
 252
 253         if (stream_stdout)
 254             g_object_unref(stream_stdout);
 255
 256         return;
 257     }
 258
 259     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
 260
 261     printf ("\fpart{ ID: %d, Content-type: %s\n",
 262             *part_count,
 263             g_mime_content_type_to_string (content_type));
 264
 265     if (g_mime_content_type_is_type (content_type, "text", "*") &&
 266         !g_mime_content_type_is_type (content_type, "text", "html"))
 267     {
 268         show_part_content (part, stream_stdout);
 269     }
 270     else
 271     {
 272         printf ("Non-text part: %s\n",
 273                 g_mime_content_type_to_string (content_type));
 274     }
 275
 276     printf ("\fpart}\n");
 277
 278     if (stream_stdout)
 279         g_object_unref(stream_stdout);
 280 }
 281
 282 static void
 283 format_part_json (GMimeObject *part, int *part_count)
 284 {
 285     GMimeContentType *content_type;
 286     GMimeContentDisposition *disposition;
 287     void *ctx = talloc_new (NULL);
 288     GMimeStream *stream_memory = g_mime_stream_mem_new ();
 289     GByteArray *part_content;
 290
 291     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
 292
 293     if (*part_count > 1)
 294         fputs (", ", stdout);
 295
 296     printf ("{\"id\": %d, \"content-type\": %s",
 297             *part_count,
 298             json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
 299
 300     disposition = g_mime_object_get_content_disposition (part);
 301     if (disposition &&
 302         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
 303     {
 304         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
 305
 306         printf (", \"filename\": %s", json_quote_str (ctx, filename));
 307     }
 308
 309     if (g_mime_content_type_is_type (content_type, "text", "*") &&
 310         !g_mime_content_type_is_type (content_type, "text", "html"))
 311     {
 312         show_part_content (part, stream_memory);
 313         part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
 314
 315         printf (", \"content\": %s", json_quote_str (ctx, (char *) part_content->data));
 316     }
 317
 318     fputs ("}", stdout);
 319
 320     talloc_free (ctx);
 321     if (stream_memory)
 322         g_object_unref (stream_memory);
 323 }
 324
 325 static void
 326 show_message (void *ctx, const show_format_t *format, notmuch_message_t *message, int indent)
 327 {
 328     fputs (format->message_start, stdout);
 329     if (format->message)
 330         format->message(ctx, message, indent);
 331
 332     fputs (format->header_start, stdout);
 333     if (format->header)
 334         format->header(ctx, message);
 335     fputs (format->header_end, stdout);
 336
 337     fputs (format->body_start, stdout);
 338     if (format->part)
 339         show_message_body (notmuch_message_get_filename (message), format->part);
 340     fputs (format->body_end, stdout);
 341
 342     fputs (format->message_end, stdout);
 343 }
 344
 345
 346 static void
 347 show_messages (void *ctx, const show_format_t *format, notmuch_messages_t *messages, int indent,
 348                notmuch_bool_t entire_thread)
 349 {
 350     notmuch_message_t *message;
 351     notmuch_bool_t match;
 352     int first_set = 1;
 353     int next_indent;
 354
 355     fputs (format->message_set_start, stdout);
 356
 357     for (;
 358          notmuch_messages_valid (messages);
 359          notmuch_messages_move_to_next (messages))
 360     {
 361         if (!first_set)
 362             fputs (format->message_set_sep, stdout);
 363         first_set = 0;
 364
 365         fputs (format->message_set_start, stdout);
 366
 367         message = notmuch_messages_get (messages);
 368
 369         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
 370
 371         next_indent = indent;
 372
 373         if (match || entire_thread) {
 374             show_message (ctx, format, message, indent);
 375             next_indent = indent + 1;
 376
 377             fputs (format->message_set_sep, stdout);
 378         }
 379
 380         show_messages (ctx, format, notmuch_message_get_replies (message),
 381                        next_indent, entire_thread);
 382
 383         notmuch_message_destroy (message);
 384
 385         fputs (format->message_set_end, stdout);
 386     }
 387
 388     fputs (format->message_set_end, stdout);
 389 }
 390
 391 int
 392 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
 393 {
 394     notmuch_config_t *config;
 395     notmuch_database_t *notmuch;
 396     notmuch_query_t *query;
 397     notmuch_threads_t *threads;
 398     notmuch_thread_t *thread;
 399     notmuch_messages_t *messages;
 400     char *query_string;
 401     char *opt;
 402     const show_format_t *format = &format_text;
 403     int entire_thread = 0;
 404     int i;
 405     int first_toplevel = 1;
 406
 407     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
 408         if (strcmp (argv[i], "--") == 0) {
 409             i++;
 410             break;
 411         }
 412         if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
 413             opt = argv[i] + sizeof ("--format=") - 1;
 414             if (strcmp (opt, "text") == 0) {
 415                 format = &format_text;
 416             } else if (strcmp (opt, "json") == 0) {
 417                 format = &format_json;
 418                 entire_thread = 1;
 419             } else {
 420                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
 421                 return 1;
 422             }
 423         } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
 424             entire_thread = 1;
 425         } else {
 426             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
 427             return 1;
 428         }
 429     }
 430
 431     argc -= i;
 432     argv += i;
 433
 434     config = notmuch_config_open (ctx, NULL, NULL);
 435     if (config == NULL)
 436         return 1;
 437
 438     query_string = query_string_from_args (ctx, argc, argv);
 439     if (query_string == NULL) {
 440         fprintf (stderr, "Out of memory\n");
 441         return 1;
 442     }
 443
 444     if (*query_string == '\0') {
 445         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
 446         return 1;
 447     }
 448
 449     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
 450                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
 451     if (notmuch == NULL)
 452         return 1;
 453
 454     query = notmuch_query_create (notmuch, query_string);
 455     if (query == NULL) {
 456         fprintf (stderr, "Out of memory\n");
 457         return 1;
 458     }
 459
 460     fputs (format->message_set_start, stdout);
 461
 462     for (threads = notmuch_query_search_threads (query);
 463          notmuch_threads_valid (threads);
 464          notmuch_threads_move_to_next (threads))
 465     {
 466         thread = notmuch_threads_get (threads);
 467
 468         messages = notmuch_thread_get_toplevel_messages (thread);
 469
 470         if (messages == NULL)
 471             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
 472                             notmuch_thread_get_thread_id (thread));
 473
 474         if (!first_toplevel)
 475             fputs (format->message_set_sep, stdout);
 476         first_toplevel = 0;
 477
 478         show_messages (ctx, format, messages, 0, entire_thread);
 479
 480         notmuch_thread_destroy (thread);
 481
 482     }
 483
 484     fputs (format->message_set_end, stdout);
 485
 486     notmuch_query_destroy (query);
 487     notmuch_database_close (notmuch);
 488
 489     return 0;
 490 }