e5ae2ba73d568027f1c661994e073aff8852a942
[notmuch] / lib / index.cc
1 /*
2  * Copyright © 2009 Carl Worth
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see https://www.gnu.org/licenses/ .
16  *
17  * Author: Carl Worth <cworth@cworth.org>
18  */
19
20 #include "notmuch-private.h"
21
22 #include <gmime/gmime.h>
23 #include <gmime/gmime-filter.h>
24
25 #include <xapian.h>
26
27
28 typedef struct {
29     int state;
30     int a;
31     int b;
32     int next_if_match;
33     int next_if_not_match;
34 } scanner_state_t;
35
36 /* Simple, linear state-transition diagram for the uuencode filter.
37  *
38  * If the character being processed is within the range of [a, b]
39  * for the current state then we transition next_if_match
40  * state. If not, we transition to the next_if_not_match state.
41  *
42  * The final two states are special in that they are the states in
43  * which we discard data. */
44 static const int first_uuencode_skipping_state = 11;
45 static const scanner_state_t uuencode_states[] = {
46     {0,  'b',  'b',  1,  0},
47     {1,  'e',  'e',  2,  0},
48     {2,  'g',  'g',  3,  0},
49     {3,  'i',  'i',  4,  0},
50     {4,  'n',  'n',  5,  0},
51     {5,  ' ',  ' ',  6,  0},
52     {6,  '0',  '7',  7,  0},
53     {7,  '0',  '7',  8,  0},
54     {8,  '0',  '7',  9,  0},
55     {9,  ' ',  ' ',  10, 0},
56     {10, '\n', '\n', 11, 10},
57     {11, 'M',  'M',  12, 0},
58     {12, ' ',  '`',  12, 11}
59 };
60
61 /* The following table is intended to implement this DFA (in 'dot'
62    format). Note that 2 and 3 are "hidden" states used to step through
63    the possible out edges of state 1.
64
65 digraph html_filter {
66        0 -> 1  [label="<"];
67        0 -> 0;
68        1 -> 4 [label="'"];
69        1 -> 5 [label="\""];
70        1 -> 0 [label=">"];
71        1 -> 1;
72        4 -> 1 [label="'"];
73        4 -> 4;
74        5 -> 1 [label="\""];
75        5 -> 5;
76 }
77 */
78 static const int first_html_skipping_state = 1;
79 static const scanner_state_t html_states[] = {
80     {0,  '<',  '<',  1,  0},
81     {1,  '\'', '\'', 4,  2},  /* scanning for quote or > */
82     {1,  '"',  '"',  5,  3},
83     {1,  '>',  '>',  0,  1},
84     {4,  '\'', '\'', 1,  4},  /* inside single quotes */
85     {5,  '"', '"',   1,  5},  /* inside double quotes */
86 };
87
88 /* Oh, how I wish that gobject didn't require so much noisy boilerplate!
89  * (Though I have at least eliminated some of the stock set...) */
90 typedef struct _NotmuchFilterDiscardNonTerm NotmuchFilterDiscardNonTerm;
91 typedef struct _NotmuchFilterDiscardNonTermClass NotmuchFilterDiscardNonTermClass;
92
93 /**
94  * NotmuchFilterDiscardNonTerm:
95  *
96  * @parent_object: parent #GMimeFilter
97  * @encode: encoding vs decoding
98  * @state: State of the parser
99  *
100  * A filter to discard uuencoded portions of an email.
101  *
102  * A uuencoded portion is identified as beginning with a line
103  * matching:
104  *
105  *      begin [0-7][0-7][0-7] .*
106  *
107  * After that detection, and beginning with the following line,
108  * characters will be discarded as long as the first character of each
109  * line begins with M and subsequent characters on the line are within
110  * the range of ASCII characters from ' ' to '`'.
111  *
112  * This is not a perfect UUencode filter. It's possible to have a
113  * message that will legitimately match that pattern, (so that some
114  * legitimate content is discarded). And for most UUencoded files, the
115  * final line of encoded data (the line not starting with M) will be
116  * indexed.
117  **/
118 struct _NotmuchFilterDiscardNonTerm {
119     GMimeFilter parent_object;
120     GMimeContentType *content_type;
121     int state;
122     int first_skipping_state;
123     const scanner_state_t *states;
124 };
125
126 struct _NotmuchFilterDiscardNonTermClass {
127     GMimeFilterClass parent_class;
128 };
129
130 static GMimeFilter *notmuch_filter_discard_non_term_new (GMimeContentType *content);
131
132 static void notmuch_filter_discard_non_term_finalize (GObject *object);
133
134 static GMimeFilter *filter_copy (GMimeFilter *filter);
135 static void filter_filter (GMimeFilter *filter, char *in, size_t len, size_t prespace,
136                            char **out, size_t *outlen, size_t *outprespace);
137 static void filter_complete (GMimeFilter *filter, char *in, size_t len, size_t prespace,
138                              char **out, size_t *outlen, size_t *outprespace);
139 static void filter_reset (GMimeFilter *filter);
140
141
142 static GMimeFilterClass *parent_class = NULL;
143
144 static void
145 notmuch_filter_discard_non_term_class_init (NotmuchFilterDiscardNonTermClass *klass)
146 {
147     GObjectClass *object_class = G_OBJECT_CLASS (klass);
148     GMimeFilterClass *filter_class = GMIME_FILTER_CLASS (klass);
149
150     parent_class = (GMimeFilterClass *) g_type_class_ref (GMIME_TYPE_FILTER);
151
152     object_class->finalize = notmuch_filter_discard_non_term_finalize;
153
154     filter_class->copy = filter_copy;
155     filter_class->filter = filter_filter;
156     filter_class->complete = filter_complete;
157     filter_class->reset = filter_reset;
158 }
159
160 static void
161 notmuch_filter_discard_non_term_finalize (GObject *object)
162 {
163     G_OBJECT_CLASS (parent_class)->finalize (object);
164 }
165
166 static GMimeFilter *
167 filter_copy (GMimeFilter *gmime_filter)
168 {
169     NotmuchFilterDiscardNonTerm *filter = (NotmuchFilterDiscardNonTerm *) gmime_filter;
170     return notmuch_filter_discard_non_term_new (filter->content_type);
171 }
172
173 static void
174 filter_filter (GMimeFilter *gmime_filter, char *inbuf, size_t inlen, size_t prespace,
175                char **outbuf, size_t *outlen, size_t *outprespace)
176 {
177     NotmuchFilterDiscardNonTerm *filter = (NotmuchFilterDiscardNonTerm *) gmime_filter;
178     const scanner_state_t *states = filter->states;
179     register const char *inptr = inbuf;
180     const char *inend = inbuf + inlen;
181     char *outptr;
182
183     (void) prespace;
184
185     int next;
186
187     g_mime_filter_set_size (gmime_filter, inlen, false);
188     outptr = gmime_filter->outbuf;
189
190     next = filter->state;
191     while (inptr < inend) {
192          /* Each state is defined by a contiguous set of rows of the
193          * state table marked by a common value for '.state'. The
194          * state numbers must be equal to the index of the first row
195          * in a given state; thus the loop condition here looks for a
196          * jump to a first row of a state, which is a real transition
197          * in the underlying DFA.
198          */
199         do {
200             if (*inptr >= states[next].a && *inptr <= states[next].b)  {
201                 next = states[next].next_if_match;
202             } else  {
203                 next = states[next].next_if_not_match;
204             }
205
206         } while (next != states[next].state);
207
208         if (filter->state < filter->first_skipping_state)
209             *outptr++ = *inptr;
210
211         filter->state = next;
212         inptr++;
213     }
214
215     *outlen = outptr - gmime_filter->outbuf;
216     *outprespace = gmime_filter->outpre;
217     *outbuf = gmime_filter->outbuf;
218 }
219
220 static void
221 filter_complete (GMimeFilter *filter, char *inbuf, size_t inlen, size_t prespace,
222                  char **outbuf, size_t *outlen, size_t *outprespace)
223 {
224     if (inbuf && inlen)
225         filter_filter (filter, inbuf, inlen, prespace, outbuf, outlen, outprespace);
226 }
227
228 static void
229 filter_reset (GMimeFilter *gmime_filter)
230 {
231     NotmuchFilterDiscardNonTerm *filter = (NotmuchFilterDiscardNonTerm *) gmime_filter;
232
233     filter->state = 0;
234 }
235
236 /**
237  * notmuch_filter_discard_non_term_new:
238  *
239  * Returns: a new #NotmuchFilterDiscardNonTerm filter.
240  **/
241 static GMimeFilter *
242 notmuch_filter_discard_non_term_new (GMimeContentType *content_type)
243 {
244     static GType type = 0;
245     NotmuchFilterDiscardNonTerm *filter;
246
247     if (!type) {
248         static const GTypeInfo info = {
249             sizeof (NotmuchFilterDiscardNonTermClass),
250             NULL, /* base_class_init */
251             NULL, /* base_class_finalize */
252             (GClassInitFunc) notmuch_filter_discard_non_term_class_init,
253             NULL, /* class_finalize */
254             NULL, /* class_data */
255             sizeof (NotmuchFilterDiscardNonTerm),
256             0,    /* n_preallocs */
257             NULL, /* instance_init */
258             NULL  /* value_table */
259         };
260
261         type = g_type_register_static (GMIME_TYPE_FILTER, "NotmuchFilterDiscardNonTerm", &info, (GTypeFlags) 0);
262     }
263
264     filter = (NotmuchFilterDiscardNonTerm *) g_object_new (type, NULL);
265     filter->content_type = content_type;
266     filter->state = 0;
267     if (g_mime_content_type_is_type (content_type, "text", "html")) {
268       filter->states = html_states;
269       filter->first_skipping_state = first_html_skipping_state;
270     } else {
271       filter->states = uuencode_states;
272       filter->first_skipping_state = first_uuencode_skipping_state;
273     }
274
275     return (GMimeFilter *) filter;
276 }
277
278 /* We're finally down to a single (NAME + address) email "mailbox". */
279 static void
280 _index_address_mailbox (notmuch_message_t *message,
281                         const char *prefix_name,
282                         InternetAddress *address)
283 {
284     InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
285     const char *name, *addr, *combined;
286     void *local = talloc_new (message);
287
288     name = internet_address_get_name (address);
289     addr = internet_address_mailbox_get_addr (mailbox);
290
291     /* Combine the name and address and index them as a phrase. */
292     if (name && addr)
293         combined = talloc_asprintf (local, "%s %s", name, addr);
294     else if (name)
295         combined = name;
296     else
297         combined = addr;
298
299     if (combined)
300         _notmuch_message_gen_terms (message, prefix_name, combined);
301
302     talloc_free (local);
303 }
304
305 static void
306 _index_address_list (notmuch_message_t *message,
307                      const char *prefix_name,
308                      InternetAddressList *addresses);
309
310 /* The outer loop over the InternetAddressList wasn't quite enough.
311  * There can actually be a tree here where a single member of the list
312  * is a "group" containing another list. Recurse please.
313  */
314 static void
315 _index_address_group (notmuch_message_t *message,
316                       const char *prefix_name,
317                       InternetAddress *address)
318 {
319     InternetAddressGroup *group;
320     InternetAddressList *list;
321
322     group = INTERNET_ADDRESS_GROUP (address);
323     list = internet_address_group_get_members (group);
324
325     if (! list)
326         return;
327
328     _index_address_list (message, prefix_name, list);
329 }
330
331 static void
332 _index_address_list (notmuch_message_t *message,
333                      const char *prefix_name,
334                      InternetAddressList *addresses)
335 {
336     int i;
337     InternetAddress *address;
338
339     if (addresses == NULL)
340         return;
341
342     for (i = 0; i < internet_address_list_length (addresses); i++) {
343         address = internet_address_list_get_address (addresses, i);
344         if (INTERNET_ADDRESS_IS_MAILBOX (address)) {
345             _index_address_mailbox (message, prefix_name, address);
346         } else if (INTERNET_ADDRESS_IS_GROUP (address)) {
347             _index_address_group (message, prefix_name, address);
348         } else {
349             INTERNAL_ERROR ("GMime InternetAddress is neither a mailbox nor a group.\n");
350         }
351     }
352 }
353
354 static void
355 _index_content_type (notmuch_message_t *message, GMimeObject *part)
356 {
357     GMimeContentType *content_type = g_mime_object_get_content_type (part);
358     if (content_type) {
359         char *mime_string = g_mime_content_type_to_string (content_type);
360         if (mime_string) {
361             _notmuch_message_gen_terms (message, "mimetype", mime_string);
362             g_free (mime_string);
363         }
364     }
365 }
366
367 /* Callback to generate terms for each mime part of a message. */
368 static void
369 _index_mime_part (notmuch_message_t *message,
370                   GMimeObject *part)
371 {
372     GMimeStream *stream, *filter;
373     GMimeFilter *discard_non_term_filter;
374     GMimeDataWrapper *wrapper;
375     GByteArray *byte_array;
376     GMimeContentDisposition *disposition;
377     GMimeContentType *content_type;
378     char *body;
379     const char *charset;
380
381     if (! part) {
382         _notmuch_database_log (_notmuch_message_database (message),
383                               "Warning: Not indexing empty mime part.\n");
384         return;
385     }
386
387     _index_content_type (message, part);
388
389     if (GMIME_IS_MULTIPART (part)) {
390         GMimeMultipart *multipart = GMIME_MULTIPART (part);
391         int i;
392
393         if (GMIME_IS_MULTIPART_SIGNED (multipart))
394           _notmuch_message_add_term (message, "tag", "signed");
395
396         if (GMIME_IS_MULTIPART_ENCRYPTED (multipart))
397           _notmuch_message_add_term (message, "tag", "encrypted");
398
399         for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {
400             if (GMIME_IS_MULTIPART_SIGNED (multipart)) {
401                 /* Don't index the signature, but index its content type. */
402                 if (i == GMIME_MULTIPART_SIGNED_SIGNATURE) {
403                     _index_content_type (message,
404                                          g_mime_multipart_get_part (multipart, i));
405                     continue;
406                 } else if (i != GMIME_MULTIPART_SIGNED_CONTENT) {
407                     _notmuch_database_log (_notmuch_message_database (message),
408                                            "Warning: Unexpected extra parts of multipart/signed. Indexing anyway.\n");
409                 }
410             }
411             if (GMIME_IS_MULTIPART_ENCRYPTED (multipart)) {
412                 /* Don't index encrypted parts, but index their content type. */
413                 _index_content_type (message,
414                                      g_mime_multipart_get_part (multipart, i));
415                 if ((i != GMIME_MULTIPART_ENCRYPTED_VERSION) &&
416                     (i != GMIME_MULTIPART_ENCRYPTED_CONTENT)) {
417                     _notmuch_database_log (_notmuch_message_database (message),
418                                            "Warning: Unexpected extra parts of multipart/encrypted.\n");
419                 }
420                 continue;
421             }
422             _index_mime_part (message,
423                               g_mime_multipart_get_part (multipart, i));
424         }
425         return;
426     }
427
428     if (GMIME_IS_MESSAGE_PART (part)) {
429         GMimeMessage *mime_message;
430
431         mime_message = g_mime_message_part_get_message (GMIME_MESSAGE_PART (part));
432
433         _index_mime_part (message, g_mime_message_get_mime_part (mime_message));
434
435         return;
436     }
437
438     if (! (GMIME_IS_PART (part))) {
439         _notmuch_database_log (_notmuch_message_database (message),
440                               "Warning: Not indexing unknown mime part: %s.\n",
441                               g_type_name (G_OBJECT_TYPE (part)));
442         return;
443     }
444
445     disposition = g_mime_object_get_content_disposition (part);
446     if (disposition &&
447         strcasecmp (g_mime_content_disposition_get_disposition (disposition),
448                     GMIME_DISPOSITION_ATTACHMENT) == 0)
449     {
450         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
451
452         _notmuch_message_add_term (message, "tag", "attachment");
453         _notmuch_message_gen_terms (message, "attachment", filename);
454
455         /* XXX: Would be nice to call out to something here to parse
456          * the attachment into text and then index that. */
457         return;
458     }
459
460     byte_array = g_byte_array_new ();
461
462     stream = g_mime_stream_mem_new_with_byte_array (byte_array);
463     g_mime_stream_mem_set_owner (GMIME_STREAM_MEM (stream), false);
464
465     filter = g_mime_stream_filter_new (stream);
466
467     content_type = g_mime_object_get_content_type (part);
468     discard_non_term_filter = notmuch_filter_discard_non_term_new (content_type);
469
470     g_mime_stream_filter_add (GMIME_STREAM_FILTER (filter),
471                               discard_non_term_filter);
472
473     charset = g_mime_object_get_content_type_parameter (part, "charset");
474     if (charset) {
475         GMimeFilter *charset_filter;
476         charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
477         /* This result can be NULL for things like "unknown-8bit".
478          * Don't set a NULL filter as that makes GMime print
479          * annoying assertion-failure messages on stderr. */
480         if (charset_filter) {
481             g_mime_stream_filter_add (GMIME_STREAM_FILTER (filter),
482                                       charset_filter);
483             g_object_unref (charset_filter);
484         }
485     }
486
487     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
488     if (wrapper)
489         g_mime_data_wrapper_write_to_stream (wrapper, filter);
490
491     g_object_unref (stream);
492     g_object_unref (filter);
493     g_object_unref (discard_non_term_filter);
494
495     g_byte_array_append (byte_array, (guint8 *) "\0", 1);
496     body = (char *) g_byte_array_free (byte_array, false);
497
498     if (body) {
499         _notmuch_message_gen_terms (message, NULL, body);
500
501         free (body);
502     }
503 }
504
505 notmuch_status_t
506 _notmuch_message_index_file (notmuch_message_t *message,
507                              notmuch_message_file_t *message_file)
508 {
509     GMimeMessage *mime_message;
510     InternetAddressList *addresses;
511     const char *subject;
512     notmuch_status_t status;
513
514     status = _notmuch_message_file_get_mime_message (message_file,
515                                                      &mime_message);
516     if (status)
517         return status;
518
519     addresses = g_mime_message_get_from (mime_message);
520     if (addresses) {
521         _index_address_list (message, "from", addresses);
522         g_mime_2_6_unref (addresses);
523     }
524
525     addresses = g_mime_message_get_all_recipients (mime_message);
526     if (addresses) {
527         _index_address_list (message, "to", addresses);
528         g_object_unref (addresses);
529     }
530
531     subject = g_mime_message_get_subject (mime_message);
532     _notmuch_message_gen_terms (message, "subject", subject);
533
534     _index_mime_part (message, g_mime_message_get_mime_part (mime_message));
535
536     return NOTMUCH_STATUS_SUCCESS;
537 }