notmuch-reply.c: Handle munged `Reply-To' headers.
[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
26 static void
27 reply_part_content (GMimeObject *part)
28 {
29     GMimeStream *stream_stdout = NULL, *stream_filter = NULL;
30     GMimeDataWrapper *wrapper;
31     const char *charset;
32
33     charset = g_mime_object_get_content_type_parameter (part, "charset");
34     stream_stdout = g_mime_stream_file_new (stdout);
35     if (stream_stdout) {
36         g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
37         stream_filter = g_mime_stream_filter_new(stream_stdout);
38         if (charset) {
39           g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
40                                    g_mime_filter_charset_new(charset, "UTF-8"));
41         }
42     }
43     g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
44                              g_mime_filter_reply_new(TRUE));
45     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
46     if (wrapper && stream_filter)
47         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
48     if (stream_filter)
49         g_object_unref(stream_filter);
50     if (stream_stdout)
51         g_object_unref(stream_stdout);
52 }
53
54 static void
55 reply_part (GMimeObject *part, int *part_count)
56 {
57     GMimeContentDisposition *disposition;
58     GMimeContentType *content_type;
59
60     (void) part_count;
61     disposition = g_mime_object_get_content_disposition (part);
62     if (disposition &&
63         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
64     {
65         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
66         content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
67
68         if (g_mime_content_type_is_type (content_type, "text", "*") &&
69             !g_mime_content_type_is_type (content_type, "text", "html"))
70         {
71             reply_part_content (part);
72         }
73         else
74         {
75             printf ("Attachment: %s (%s)\n", filename,
76                     g_mime_content_type_to_string (content_type));
77         }
78
79         return;
80     }
81
82     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
83
84     if (g_mime_content_type_is_type (content_type, "text", "*") &&
85         !g_mime_content_type_is_type (content_type, "text", "html"))
86     {
87         reply_part_content (part);
88     }
89     else
90     {
91         printf ("Non-text part: %s\n",
92                 g_mime_content_type_to_string (content_type));
93     }
94 }
95
96 /* Is the given address configured as one of the user's "personal" or
97  * "other" addresses. */
98 static int
99 address_is_users (const char *address, notmuch_config_t *config)
100 {
101     const char *primary;
102     char **other;
103     size_t i, other_len;
104
105     primary = notmuch_config_get_user_primary_email (config);
106     if (strcasecmp (primary, address) == 0)
107         return 1;
108
109     other = notmuch_config_get_user_other_email (config, &other_len);
110     for (i = 0; i < other_len; i++)
111         if (strcasecmp (other[i], address) == 0)
112             return 1;
113
114     return 0;
115 }
116
117 /* For each address in 'list' that is not configured as one of the
118  * user's addresses in 'config', add that address to 'message' as an
119  * address of 'type'.
120  *
121  * The first address encountered that *is* the user's address will be
122  * returned, (otherwise NULL is returned).
123  */
124 static const char *
125 add_recipients_for_address_list (GMimeMessage *message,
126                                  notmuch_config_t *config,
127                                  GMimeRecipientType type,
128                                  InternetAddressList *list)
129 {
130     InternetAddress *address;
131     int i;
132     const char *ret = NULL;
133
134     for (i = 0; i < internet_address_list_length (list); i++) {
135         address = internet_address_list_get_address (list, i);
136         if (INTERNET_ADDRESS_IS_GROUP (address)) {
137             InternetAddressGroup *group;
138             InternetAddressList *group_list;
139
140             group = INTERNET_ADDRESS_GROUP (address);
141             group_list = internet_address_group_get_members (group);
142             if (group_list == NULL)
143                 continue;
144
145             add_recipients_for_address_list (message, config,
146                                              type, group_list);
147         } else {
148             InternetAddressMailbox *mailbox;
149             const char *name;
150             const char *addr;
151
152             mailbox = INTERNET_ADDRESS_MAILBOX (address);
153
154             name = internet_address_get_name (address);
155             addr = internet_address_mailbox_get_addr (mailbox);
156
157             if (address_is_users (addr, config)) {
158                 if (ret == NULL)
159                     ret = addr;
160             } else {
161                 g_mime_message_add_recipient (message, type, name, addr);
162             }
163         }
164     }
165
166     return ret;
167 }
168
169 /* For each address in 'recipients' that is not configured as one of
170  * the user's addresses in 'config', add that address to 'message' as
171  * an address of 'type'.
172  *
173  * The first address encountered that *is* the user's address will be
174  * returned, (otherwise NULL is returned).
175  */
176 static const char *
177 add_recipients_for_string (GMimeMessage *message,
178                            notmuch_config_t *config,
179                            GMimeRecipientType type,
180                            const char *recipients)
181 {
182     InternetAddressList *list;
183
184     list = internet_address_list_parse_string (recipients);
185     if (list == NULL)
186         return NULL;
187
188     return add_recipients_for_address_list (message, config, type, list);
189 }
190
191 /* Some mailing lists munge the Reply-To header despite it being A Bad
192  * Thing, see http://www.unicom.com/pw/reply-to-harmful.html
193  *
194  * This function detects such munging so that reasonable headers can be
195  * generated anyway.  Returns 1 if munged, else 0.
196  *
197  * The current logic is fairly naive, Reply-To is diagnosed as munged if
198  * it contains exactly one address, and this address is also present in
199  * the To or Cc fields.
200  */
201 static int
202 mailing_list_munged_reply_to (notmuch_message_t *message)
203 {
204     const char *header, *addr;
205     InternetAddressList *list;
206     InternetAddress *address;
207     InternetAddressMailbox *mailbox;
208
209     header = notmuch_message_get_header (message, "reply-to");
210     list = internet_address_list_parse_string (header);
211     if (internet_address_list_length (list) != 1)
212         return 0;
213     address = internet_address_list_get_address (list, 0);
214     if (INTERNET_ADDRESS_IS_GROUP (address))
215         return 0;
216     mailbox = INTERNET_ADDRESS_MAILBOX (address);
217     addr = internet_address_mailbox_get_addr (mailbox);
218     /* Note that strcasestr() is a GNU extension, strstr() might be sufficient */
219     if (strcasestr (notmuch_message_get_header (message, "to"), addr) == 0 ||
220         strcasestr (notmuch_message_get_header (message, "cc"), addr) == 0)
221         return 1;
222     return 0; }
223
224 /* Augments the recipients of reply from the headers of message.
225  *
226  * If any of the user's addresses were found in these headers, the first
227  * of these returned, otherwise NULL is returned.
228  */
229 static const char *
230 add_recipients_from_message (GMimeMessage *reply,
231                              notmuch_config_t *config,
232                              notmuch_message_t *message)
233 {
234     struct {
235         const char *header;
236         const char *fallback;
237         GMimeRecipientType recipient_type;
238     } reply_to_map[] = {
239         { "reply-to", "from", GMIME_RECIPIENT_TYPE_TO  },
240         { "to",         NULL, GMIME_RECIPIENT_TYPE_TO  },
241         { "cc",         NULL, GMIME_RECIPIENT_TYPE_CC  },
242         { "bcc",        NULL, GMIME_RECIPIENT_TYPE_BCC }
243     };
244     const char *from_addr = NULL;
245     unsigned int i;
246
247     /* When we have detected Reply-To munging, we ignore the Reply-To
248      * field (because it appears in the To or Cc headers) and use the
249      * From header so that person will get pinged and will actually
250      * receive the response if not subscribed to the list.  Note that
251      * under no circumstances does this fail to reply to the address in
252      * the Reply-To header.
253      */
254     if (mailing_list_munged_reply_to (message)) {
255         reply_to_map[0].header = "from";
256         reply_to_map[0].fallback = NULL;
257     }
258
259     for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
260         const char *addr, *recipients;
261
262         recipients = notmuch_message_get_header (message,
263                                                  reply_to_map[i].header);
264         if ((recipients == NULL || recipients[0] == '\0') && reply_to_map[i].fallback)
265             recipients = notmuch_message_get_header (message,
266                                                      reply_to_map[i].fallback);
267
268         addr = add_recipients_for_string (reply, config,
269                                           reply_to_map[i].recipient_type,
270                                           recipients);
271         if (from_addr == NULL)
272             from_addr = addr;
273     }
274     return from_addr;
275 }
276
277 static int
278 notmuch_reply_format_default(void *ctx, notmuch_config_t *config, notmuch_query_t *query)
279 {
280     GMimeMessage *reply;
281     notmuch_messages_t *messages;
282     notmuch_message_t *message;
283     const char *subject, *from_addr = NULL;
284     const char *in_reply_to, *orig_references, *references;
285     char *reply_headers;
286
287     for (messages = notmuch_query_search_messages (query);
288          notmuch_messages_has_more (messages);
289          notmuch_messages_advance (messages))
290     {
291         message = notmuch_messages_get (messages);
292
293         /* The 1 means we want headers in a "pretty" order. */
294         reply = g_mime_message_new (1);
295         if (reply == NULL) {
296             fprintf (stderr, "Out of memory\n");
297             return 1;
298         }
299
300         subject = notmuch_message_get_header (message, "subject");
301
302         if (strncasecmp (subject, "Re:", 3))
303             subject = talloc_asprintf (ctx, "Re: %s", subject);
304         g_mime_message_set_subject (reply, subject);
305
306         from_addr = add_recipients_from_message (reply, config, message);
307
308         if (from_addr == NULL)
309             from_addr = notmuch_config_get_user_primary_email (config);
310
311         from_addr = talloc_asprintf (ctx, "%s <%s>",
312                                      notmuch_config_get_user_name (config),
313                                      from_addr);
314         g_mime_object_set_header (GMIME_OBJECT (reply),
315                                   "From", from_addr);
316
317         g_mime_object_set_header (GMIME_OBJECT (reply), "Bcc",
318                            notmuch_config_get_user_primary_email (config));
319
320         in_reply_to = talloc_asprintf (ctx, "<%s>",
321                              notmuch_message_get_message_id (message));
322
323         g_mime_object_set_header (GMIME_OBJECT (reply),
324                                   "In-Reply-To", in_reply_to);
325
326         orig_references = notmuch_message_get_header (message, "references");
327         references = talloc_asprintf (ctx, "%s%s%s",
328                                       orig_references ? orig_references : "",
329                                       orig_references ? " " : "",
330                                       in_reply_to);
331         g_mime_object_set_header (GMIME_OBJECT (reply),
332                                   "References", references);
333
334         reply_headers = g_mime_object_to_string (GMIME_OBJECT (reply));
335         printf ("%s", reply_headers);
336         free (reply_headers);
337
338         g_object_unref (G_OBJECT (reply));
339         reply = NULL;
340
341         printf ("On %s, %s wrote:\n",
342                 notmuch_message_get_header (message, "date"),
343                 notmuch_message_get_header (message, "from"));
344
345         show_message_body (notmuch_message_get_filename (message), reply_part);
346
347         notmuch_message_destroy (message);
348     }
349     return 0;
350 }
351
352 /* This format is currently tuned for a git send-email --notmuch hook */
353 static int
354 notmuch_reply_format_headers_only(void *ctx, notmuch_config_t *config, notmuch_query_t *query)
355 {
356     GMimeMessage *reply;
357     notmuch_messages_t *messages;
358     notmuch_message_t *message;
359     const char *in_reply_to, *orig_references, *references;
360     char *reply_headers;
361
362     for (messages = notmuch_query_search_messages (query);
363          notmuch_messages_has_more (messages);
364          notmuch_messages_advance (messages))
365     {
366         message = notmuch_messages_get (messages);
367
368         /* The 0 means we do not want headers in a "pretty" order. */
369         reply = g_mime_message_new (0);
370         if (reply == NULL) {
371             fprintf (stderr, "Out of memory\n");
372             return 1;
373         }
374
375         in_reply_to = talloc_asprintf (ctx, "<%s>",
376                              notmuch_message_get_message_id (message));
377
378         g_mime_object_set_header (GMIME_OBJECT (reply),
379                                   "In-Reply-To", in_reply_to);
380
381
382         orig_references = notmuch_message_get_header (message, "references");
383
384         /* We print In-Reply-To followed by References because git format-patch treats them
385          * specially.  Git does not interpret the other headers specially
386          */
387         references = talloc_asprintf (ctx, "%s%s%s",
388                                       orig_references ? orig_references : "",
389                                       orig_references ? " " : "",
390                                       in_reply_to);
391         g_mime_object_set_header (GMIME_OBJECT (reply),
392                                   "References", references);
393
394         (void)add_recipients_from_message (reply, config, message);
395
396         g_mime_object_set_header (GMIME_OBJECT (reply), "Bcc",
397                            notmuch_config_get_user_primary_email (config));
398
399         reply_headers = g_mime_object_to_string (GMIME_OBJECT (reply));
400         printf ("%s", reply_headers);
401         free (reply_headers);
402
403         g_object_unref (G_OBJECT (reply));
404         reply = NULL;
405
406         notmuch_message_destroy (message);
407     }
408     return 0;
409 }
410
411 int
412 notmuch_reply_command (void *ctx, int argc, char *argv[])
413 {
414     notmuch_config_t *config;
415     notmuch_database_t *notmuch;
416     notmuch_query_t *query;
417     char *opt, *query_string;
418     int i, ret = 0;
419     int (*reply_format_func)(void *ctx, notmuch_config_t *config, notmuch_query_t *query);
420
421     reply_format_func = notmuch_reply_format_default;
422
423     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
424         if (strcmp (argv[i], "--") == 0) {
425             i++;
426             break;
427         }
428         if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
429             opt = argv[i] + sizeof ("--format=") - 1;
430             if (strcmp (opt, "default") == 0) {
431                 reply_format_func = notmuch_reply_format_default;
432             } else if (strcmp (opt, "headers-only") == 0) {
433                 reply_format_func = notmuch_reply_format_headers_only;
434             } else {
435                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
436                 return 1;
437             }
438         } else {
439             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
440             return 1;
441         }
442     }
443
444     argc -= i;
445     argv += i;
446
447     config = notmuch_config_open (ctx, NULL, NULL);
448     if (config == NULL)
449         return 1;
450
451     query_string = query_string_from_args (ctx, argc, argv);
452     if (query_string == NULL) {
453         fprintf (stderr, "Out of memory\n");
454         return 1;
455     }
456
457     if (*query_string == '\0') {
458         fprintf (stderr, "Error: notmuch reply requires at least one search term.\n");
459         return 1;
460     }
461
462     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
463                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
464     if (notmuch == NULL)
465         return 1;
466
467     query = notmuch_query_create (notmuch, query_string);
468     if (query == NULL) {
469         fprintf (stderr, "Out of memory\n");
470         return 1;
471     }
472
473     if (reply_format_func (ctx, config, query) != 0)
474         return 1;
475
476     notmuch_query_destroy (query);
477     notmuch_database_close (notmuch);
478
479     return ret;
480 }