71edb662e02edb35fcdc3441ec2e92e33d3d2674
[notmuch] / notmuch-reply.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  * Copyright © 2009 Keith Packard
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see http://www.gnu.org/licenses/ .
18  *
19  * Authors: Carl Worth <cworth@cworth.org>
20  *          Keith Packard <keithp@keithp.com>
21  */
22
23 #include "notmuch-client.h"
24 #include "gmime-filter-reply.h"
25 #include "gmime-filter-headers.h"
26
27 static void
28 reply_part_content (GMimeObject *part)
29 {
30     GMimeStream *stream_stdout = NULL, *stream_filter = NULL;
31     GMimeDataWrapper *wrapper;
32     const char *charset;
33
34     charset = g_mime_object_get_content_type_parameter (part, "charset");
35     stream_stdout = g_mime_stream_file_new (stdout);
36     if (stream_stdout) {
37         g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
38         stream_filter = g_mime_stream_filter_new(stream_stdout);
39         if (charset) {
40           g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
41                                    g_mime_filter_charset_new(charset, "UTF-8"));
42         }
43     }
44     g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
45                              g_mime_filter_reply_new(TRUE));
46     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
47     if (wrapper && stream_filter)
48         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
49     if (stream_filter)
50         g_object_unref(stream_filter);
51     if (stream_stdout)
52         g_object_unref(stream_stdout);
53 }
54
55 static void
56 show_reply_headers (GMimeMessage *message)
57 {
58     GMimeStream *stream_stdout = NULL, *stream_filter = NULL;
59
60     stream_stdout = g_mime_stream_file_new (stdout);
61     if (stream_stdout) {
62         g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
63         stream_filter = g_mime_stream_filter_new(stream_stdout);
64         if (stream_filter) {
65                 g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
66                                          g_mime_filter_headers_new());
67                 g_mime_object_write_to_stream(GMIME_OBJECT(message), stream_filter);
68                 g_object_unref(stream_filter);
69         }
70         g_object_unref(stream_stdout);
71     }
72 }
73
74 static void
75 reply_part (GMimeObject *part, int *part_count, unused (int first))
76 {
77     GMimeContentDisposition *disposition;
78     GMimeContentType *content_type;
79
80     (void) part_count;
81     disposition = g_mime_object_get_content_disposition (part);
82     if (disposition &&
83         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
84     {
85         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
86         content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
87
88         if (g_mime_content_type_is_type (content_type, "text", "*") &&
89             !g_mime_content_type_is_type (content_type, "text", "html"))
90         {
91             reply_part_content (part);
92         }
93         else
94         {
95             printf ("Attachment: %s (%s)\n", filename,
96                     g_mime_content_type_to_string (content_type));
97         }
98
99         return;
100     }
101
102     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
103
104     if (g_mime_content_type_is_type (content_type, "text", "*") &&
105         !g_mime_content_type_is_type (content_type, "text", "html"))
106     {
107         reply_part_content (part);
108     }
109     else
110     {
111         printf ("Non-text part: %s\n",
112                 g_mime_content_type_to_string (content_type));
113     }
114 }
115
116 /* Is the given address configured as one of the user's "personal" or
117  * "other" addresses. */
118 static int
119 address_is_users (const char *address, notmuch_config_t *config)
120 {
121     const char *primary;
122     const char **other;
123     size_t i, other_len;
124
125     primary = notmuch_config_get_user_primary_email (config);
126     if (strcasecmp (primary, address) == 0)
127         return 1;
128
129     other = notmuch_config_get_user_other_email (config, &other_len);
130     for (i = 0; i < other_len; i++)
131         if (strcasecmp (other[i], address) == 0)
132             return 1;
133
134     return 0;
135 }
136
137 /* For each address in 'list' that is not configured as one of the
138  * user's addresses in 'config', add that address to 'message' as an
139  * address of 'type'.
140  *
141  * The first address encountered that *is* the user's address will be
142  * returned, (otherwise NULL is returned).
143  */
144 static const char *
145 add_recipients_for_address_list (GMimeMessage *message,
146                                  notmuch_config_t *config,
147                                  GMimeRecipientType type,
148                                  InternetAddressList *list)
149 {
150     InternetAddress *address;
151     int i;
152     const char *ret = NULL;
153
154     for (i = 0; i < internet_address_list_length (list); i++) {
155         address = internet_address_list_get_address (list, i);
156         if (INTERNET_ADDRESS_IS_GROUP (address)) {
157             InternetAddressGroup *group;
158             InternetAddressList *group_list;
159
160             group = INTERNET_ADDRESS_GROUP (address);
161             group_list = internet_address_group_get_members (group);
162             if (group_list == NULL)
163                 continue;
164
165             add_recipients_for_address_list (message, config,
166                                              type, group_list);
167         } else {
168             InternetAddressMailbox *mailbox;
169             const char *name;
170             const char *addr;
171
172             mailbox = INTERNET_ADDRESS_MAILBOX (address);
173
174             name = internet_address_get_name (address);
175             addr = internet_address_mailbox_get_addr (mailbox);
176
177             if (address_is_users (addr, config)) {
178                 if (ret == NULL)
179                     ret = addr;
180             } else {
181                 g_mime_message_add_recipient (message, type, name, addr);
182             }
183         }
184     }
185
186     return ret;
187 }
188
189 /* For each address in 'recipients' that is not configured as one of
190  * the user's addresses in 'config', add that address to 'message' as
191  * an address of 'type'.
192  *
193  * The first address encountered that *is* the user's address will be
194  * returned, (otherwise NULL is returned).
195  */
196 static const char *
197 add_recipients_for_string (GMimeMessage *message,
198                            notmuch_config_t *config,
199                            GMimeRecipientType type,
200                            const char *recipients)
201 {
202     InternetAddressList *list;
203
204     if (recipients == NULL)
205         return NULL;
206
207     list = internet_address_list_parse_string (recipients);
208     if (list == NULL)
209         return NULL;
210
211     return add_recipients_for_address_list (message, config, type, list);
212 }
213
214 /* Does the address in the Reply-To header of 'message' already appear
215  * in either the 'To' or 'Cc' header of the message?
216  */
217 static int
218 reply_to_header_is_redundant (notmuch_message_t *message)
219 {
220     const char *reply_to, *to, *cc, *addr;
221     InternetAddressList *list;
222     InternetAddress *address;
223     InternetAddressMailbox *mailbox;
224
225     reply_to = notmuch_message_get_header (message, "reply-to");
226     if (reply_to == NULL || *reply_to == '\0')
227         return 0;
228
229     list = internet_address_list_parse_string (reply_to);
230
231     if (internet_address_list_length (list) != 1)
232         return 0;
233
234     address = internet_address_list_get_address (list, 0);
235     if (INTERNET_ADDRESS_IS_GROUP (address))
236         return 0;
237
238     mailbox = INTERNET_ADDRESS_MAILBOX (address);
239     addr = internet_address_mailbox_get_addr (mailbox);
240
241     to = notmuch_message_get_header (message, "to");
242     cc = notmuch_message_get_header (message, "cc");
243
244     if ((to && strstr (to, addr) != 0) ||
245         (cc && strstr (cc, addr) != 0))
246     {
247         return 1;
248     }
249
250     return 0;
251 }
252
253 /* Augments the recipients of reply from the headers of message.
254  *
255  * If any of the user's addresses were found in these headers, the first
256  * of these returned, otherwise NULL is returned.
257  */
258 static const char *
259 add_recipients_from_message (GMimeMessage *reply,
260                              notmuch_config_t *config,
261                              notmuch_message_t *message)
262 {
263     struct {
264         const char *header;
265         const char *fallback;
266         GMimeRecipientType recipient_type;
267     } reply_to_map[] = {
268         { "reply-to", "from", GMIME_RECIPIENT_TYPE_TO  },
269         { "to",         NULL, GMIME_RECIPIENT_TYPE_TO  },
270         { "cc",         NULL, GMIME_RECIPIENT_TYPE_CC  },
271         { "bcc",        NULL, GMIME_RECIPIENT_TYPE_BCC }
272     };
273     const char *from_addr = NULL;
274     unsigned int i;
275
276     /* Some mailing lists munge the Reply-To header despite it being A Bad
277      * Thing, see http://www.unicom.com/pw/reply-to-harmful.html
278      *
279      * The munging is easy to detect, because it results in a
280      * redundant reply-to header, (with an address that already exists
281      * in either To or Cc). So in this case, we ignore the Reply-To
282      * field and use the From header. Thie ensures the original sender
283      * will get the reply even if not subscribed to the list. Note
284      * that the address in the Reply-To header will always appear in
285      * the reply.
286      */
287     if (reply_to_header_is_redundant (message)) {
288         reply_to_map[0].header = "from";
289         reply_to_map[0].fallback = NULL;
290     }
291
292     for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
293         const char *addr, *recipients;
294
295         recipients = notmuch_message_get_header (message,
296                                                  reply_to_map[i].header);
297         if ((recipients == NULL || recipients[0] == '\0') && reply_to_map[i].fallback)
298             recipients = notmuch_message_get_header (message,
299                                                      reply_to_map[i].fallback);
300
301         addr = add_recipients_for_string (reply, config,
302                                           reply_to_map[i].recipient_type,
303                                           recipients);
304         if (from_addr == NULL)
305             from_addr = addr;
306     }
307
308     return from_addr;
309 }
310
311 static const char *
312 guess_from_received_header (notmuch_config_t *config, notmuch_message_t *message)
313 {
314     const char *received,*primary,*by;
315     const char **other;
316     char *tohdr;
317     char *mta,*ptr,*token;
318     char *domain=NULL;
319     char *tld=NULL;
320     const char *delim=". \t";
321     size_t i,j,other_len;
322
323     const char *to_headers[] = {"Envelope-to", "X-Original-To"};
324
325     primary = notmuch_config_get_user_primary_email (config);
326     other = notmuch_config_get_user_other_email (config, &other_len);
327
328     /* sadly, there is no standard way to find out to which email
329      * address a mail was delivered - what is in the headers depends
330      * on the MTAs used along the way. So we are trying a number of
331      * heuristics which hopefully will answer this question.
332
333      * We only got here if none of the users email addresses are in
334      * the To: or Cc: header. From here we try the following in order:
335      * 1) check for an Envelope-to: header
336      * 2) check for an X-Original-To: header
337      * 3) check for a (for <email@add.res>) clause in Received: headers
338      * 4) check for the domain part of known email addresses in the
339      *    'by' part of Received headers
340      * If none of these work, we give up and return NULL
341      */
342     for (i = 0; i < sizeof(to_headers)/sizeof(*to_headers); i++) {
343         tohdr = xstrdup(notmuch_message_get_header (message, to_headers[i]));
344         if (tohdr && *tohdr) {
345             /* tohdr is potentialy a list of email addresses, so here we
346              * check if one of the email addresses is a substring of tohdr
347              */
348             if (strcasestr(tohdr, primary)) {
349                 free(tohdr);
350                 return primary;
351             }
352             for (j = 0; j < other_len; j++)
353                 if (strcasestr (tohdr, other[j])) {
354                     free(tohdr);
355                     return other[j];
356                 }
357             free(tohdr);
358         }
359     }
360
361     /* We get the concatenated Received: headers and search from the
362      * front (last Received: header added) and try to extract from
363      * them indications to which email address this message was
364      * delivered.
365      * The Received: header is special in our get_header function
366      * and is always concated.
367      */
368     received = notmuch_message_get_header (message, "received");
369     if (received == NULL)
370         return NULL;
371
372     /* First we look for a " for <email@add.res>" in the received
373      * header
374      */
375     ptr = strstr (received, " for ");
376     if (ptr) {
377         /* the text following is potentialy a list of email addresses,
378          * so again we check if one of the email addresses is a
379          * substring of ptr
380          */
381         if (strcasestr(ptr, primary)) {
382             return primary;
383         }
384         for (i = 0; i < other_len; i++)
385             if (strcasestr (ptr, other[i])) {
386                 return other[i];
387             }
388     }
389     /* Finally, we parse all the " by MTA ..." headers to guess the
390      * email address that this was originally delivered to.
391      * We extract just the MTA here by removing leading whitespace and
392      * assuming that the MTA name ends at the next whitespace.
393      * We test for *(by+4) to be non-'\0' to make sure there's
394      * something there at all - and then assume that the first
395      * whitespace delimited token that follows is the receiving
396      * system in this step of the receive chain
397      */
398     by = received;
399     while((by = strstr (by, " by ")) != NULL) {
400         by += 4;
401         if (*by == '\0')
402             break;
403         mta = xstrdup (by);
404         token = strtok(mta," \t");
405         if (token == NULL)
406             break;
407         /* Now extract the last two components of the MTA host name
408          * as domain and tld.
409          */
410         while ((ptr = strsep (&token, delim)) != NULL) {
411             if (*ptr == '\0')
412                 continue;
413             domain = tld;
414             tld = ptr;
415         }
416
417         if (domain) {
418             /* Recombine domain and tld and look for it among the configured
419              * email addresses.
420              * This time we have a known domain name and nothing else - so
421              * the test is the other way around: we check if this is a
422              * substring of one of the email addresses.
423              */
424             *(tld-1) = '.';
425
426             if (strcasestr(primary, domain)) {
427                 free(mta);
428             return primary;
429         }
430         for (i = 0; i < other_len; i++)
431             if (strcasestr (other[i],domain)) {
432                 free(mta);
433                 return other[i];
434             }
435         }
436         free (mta);
437     }
438
439     return NULL;
440 }
441
442 static int
443 notmuch_reply_format_default(void *ctx, notmuch_config_t *config, notmuch_query_t *query)
444 {
445     GMimeMessage *reply;
446     notmuch_messages_t *messages;
447     notmuch_message_t *message;
448     const char *subject, *from_addr = NULL;
449     const char *in_reply_to, *orig_references, *references;
450
451     for (messages = notmuch_query_search_messages (query);
452          notmuch_messages_valid (messages);
453          notmuch_messages_move_to_next (messages))
454     {
455         message = notmuch_messages_get (messages);
456
457         /* The 1 means we want headers in a "pretty" order. */
458         reply = g_mime_message_new (1);
459         if (reply == NULL) {
460             fprintf (stderr, "Out of memory\n");
461             return 1;
462         }
463
464         subject = notmuch_message_get_header (message, "subject");
465         if (subject) {
466             if (strncasecmp (subject, "Re:", 3))
467                 subject = talloc_asprintf (ctx, "Re: %s", subject);
468             g_mime_message_set_subject (reply, subject);
469         }
470
471         from_addr = add_recipients_from_message (reply, config, message);
472
473         if (from_addr == NULL)
474             from_addr = guess_from_received_header (config, message);
475
476         if (from_addr == NULL)
477             from_addr = notmuch_config_get_user_primary_email (config);
478
479         from_addr = talloc_asprintf (ctx, "%s <%s>",
480                                      notmuch_config_get_user_name (config),
481                                      from_addr);
482         g_mime_object_set_header (GMIME_OBJECT (reply),
483                                   "From", from_addr);
484
485         in_reply_to = talloc_asprintf (ctx, "<%s>",
486                              notmuch_message_get_message_id (message));
487
488         g_mime_object_set_header (GMIME_OBJECT (reply),
489                                   "In-Reply-To", in_reply_to);
490
491         orig_references = notmuch_message_get_header (message, "references");
492         references = talloc_asprintf (ctx, "%s%s%s",
493                                       orig_references ? orig_references : "",
494                                       orig_references ? " " : "",
495                                       in_reply_to);
496         g_mime_object_set_header (GMIME_OBJECT (reply),
497                                   "References", references);
498
499         show_reply_headers (reply);
500
501         g_object_unref (G_OBJECT (reply));
502         reply = NULL;
503
504         printf ("On %s, %s wrote:\n",
505                 notmuch_message_get_header (message, "date"),
506                 notmuch_message_get_header (message, "from"));
507
508         show_message_body (notmuch_message_get_filename (message),
509                            reply_part, NULL);
510
511         notmuch_message_destroy (message);
512     }
513     return 0;
514 }
515
516 /* This format is currently tuned for a git send-email --notmuch hook */
517 static int
518 notmuch_reply_format_headers_only(void *ctx, notmuch_config_t *config, notmuch_query_t *query)
519 {
520     GMimeMessage *reply;
521     notmuch_messages_t *messages;
522     notmuch_message_t *message;
523     const char *in_reply_to, *orig_references, *references;
524     char *reply_headers;
525
526     for (messages = notmuch_query_search_messages (query);
527          notmuch_messages_valid (messages);
528          notmuch_messages_move_to_next (messages))
529     {
530         message = notmuch_messages_get (messages);
531
532         /* The 0 means we do not want headers in a "pretty" order. */
533         reply = g_mime_message_new (0);
534         if (reply == NULL) {
535             fprintf (stderr, "Out of memory\n");
536             return 1;
537         }
538
539         in_reply_to = talloc_asprintf (ctx, "<%s>",
540                              notmuch_message_get_message_id (message));
541
542         g_mime_object_set_header (GMIME_OBJECT (reply),
543                                   "In-Reply-To", in_reply_to);
544
545
546         orig_references = notmuch_message_get_header (message, "references");
547
548         /* We print In-Reply-To followed by References because git format-patch treats them
549          * specially.  Git does not interpret the other headers specially
550          */
551         references = talloc_asprintf (ctx, "%s%s%s",
552                                       orig_references ? orig_references : "",
553                                       orig_references ? " " : "",
554                                       in_reply_to);
555         g_mime_object_set_header (GMIME_OBJECT (reply),
556                                   "References", references);
557
558         (void)add_recipients_from_message (reply, config, message);
559
560         reply_headers = g_mime_object_to_string (GMIME_OBJECT (reply));
561         printf ("%s", reply_headers);
562         free (reply_headers);
563
564         g_object_unref (G_OBJECT (reply));
565         reply = NULL;
566
567         notmuch_message_destroy (message);
568     }
569     return 0;
570 }
571
572 int
573 notmuch_reply_command (void *ctx, int argc, char *argv[])
574 {
575     notmuch_config_t *config;
576     notmuch_database_t *notmuch;
577     notmuch_query_t *query;
578     char *opt, *query_string;
579     int i, ret = 0;
580     int (*reply_format_func)(void *ctx, notmuch_config_t *config, notmuch_query_t *query);
581
582     reply_format_func = notmuch_reply_format_default;
583
584     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
585         if (strcmp (argv[i], "--") == 0) {
586             i++;
587             break;
588         }
589         if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
590             opt = argv[i] + sizeof ("--format=") - 1;
591             if (strcmp (opt, "default") == 0) {
592                 reply_format_func = notmuch_reply_format_default;
593             } else if (strcmp (opt, "headers-only") == 0) {
594                 reply_format_func = notmuch_reply_format_headers_only;
595             } else {
596                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
597                 return 1;
598             }
599         } else {
600             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
601             return 1;
602         }
603     }
604
605     argc -= i;
606     argv += i;
607
608     config = notmuch_config_open (ctx, NULL, NULL);
609     if (config == NULL)
610         return 1;
611
612     query_string = query_string_from_args (ctx, argc, argv);
613     if (query_string == NULL) {
614         fprintf (stderr, "Out of memory\n");
615         return 1;
616     }
617
618     if (*query_string == '\0') {
619         fprintf (stderr, "Error: notmuch reply requires at least one search term.\n");
620         return 1;
621     }
622
623     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
624                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
625     if (notmuch == NULL)
626         return 1;
627
628     query = notmuch_query_create (notmuch, query_string);
629     if (query == NULL) {
630         fprintf (stderr, "Out of memory\n");
631         return 1;
632     }
633
634     if (reply_format_func (ctx, config, query) != 0)
635         return 1;
636
637     notmuch_query_destroy (query);
638     notmuch_database_close (notmuch);
639
640     return ret;
641 }