notmuch-index-message: Start generating correct thread_id values.
[notmuch] / notmuch-index-message.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 http://www.gnu.org/licenses/ .
16  *
17  * Author: Carl Worth <cworth@cworth.org>
18  */
19
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <errno.h>
24 #include <time.h>
25
26 #include <iostream>
27
28 #include <gmime/gmime.h>
29
30 #include <xapian.h>
31
32 using namespace std;
33
34 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
35
36 /* Xapian complains if we provide a term longer than this. */
37 #define NOTMUCH_MAX_TERM 245
38
39 /* These prefix values are specifically chosen to be compatible
40  * with sup, (http://sup.rubyforge.org), written by
41  * William Morgan <wmorgan-sup@masanjin.net>, and released
42  * under the GNU GPL v2.
43  */
44
45 typedef struct {
46     const char *name;
47     const char *prefix;
48 } prefix_t;
49
50 prefix_t NORMAL_PREFIX[] = {
51     { "subject", "S" },
52     { "body", "B" },
53     { "from_name", "FN" },
54     { "to_name", "TN" },
55     { "name", "N" },
56     { "attachment", "A" }
57 };
58
59 prefix_t BOOLEAN_PREFIX[] = {
60     { "type", "K" },
61     { "from_email", "FE" },
62     { "to_email", "TE" },
63     { "email", "E" },
64     { "date", "D" },
65     { "label", "L" },
66     { "source_id", "I" },
67     { "attachment_extension", "O" },
68     { "msgid", "Q" },
69     { "thread", "H" },
70     { "ref", "R" }
71 };
72
73 /* Similarly, these value numbers are also chosen to be sup
74  * compatible. */
75
76 typedef enum {
77     NOTMUCH_VALUE_MESSAGE_ID = 0,
78     NOTMUCH_VALUE_THREAD = 1,
79     NOTMUCH_VALUE_DATE = 2
80 } notmuch_value_t;
81
82 static const char *
83 find_prefix (const char *name)
84 {
85     unsigned int i;
86
87     for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
88         if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
89             return NORMAL_PREFIX[i].prefix;
90
91     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
92         if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
93             return BOOLEAN_PREFIX[i].prefix;
94
95     return "";
96 }
97
98 int TERM_COMBINED = 0;
99
100 static void
101 add_term (Xapian::Document doc,
102           const char *prefix_name,
103           const char *value)
104 {
105     const char *prefix;
106     char *term;
107
108     if (value == NULL)
109         return;
110
111     prefix = find_prefix (prefix_name);
112
113     term = g_strdup_printf ("%s%s", prefix, value);
114
115     if (strlen (term) <= NOTMUCH_MAX_TERM)
116         doc.add_term (term);
117
118     g_free (term);
119 }
120
121 static void
122 gen_terms (Xapian::TermGenerator term_gen,
123            const char *prefix_name,
124            const char *text)
125 {
126     const char *prefix;
127
128     if (text == NULL)
129         return;
130
131     prefix = find_prefix (prefix_name);
132
133     term_gen.index_text (text, 1, prefix);
134 }
135
136 static void
137 gen_terms_address_name (Xapian::TermGenerator term_gen,
138                         InternetAddress *address,
139                         const char *prefix_name)
140 {
141     const char *name;
142
143     name = internet_address_get_name (address);
144
145     if (name)
146         gen_terms (term_gen, prefix_name, name);
147 }
148
149 static void
150 gen_terms_address_names (Xapian::TermGenerator term_gen,
151                          InternetAddressList *addresses,
152                          const char *address_type)
153 {
154     int i;
155     InternetAddress *address;
156
157     for (i = 0; i < internet_address_list_length (addresses); i++) {
158         address = internet_address_list_get_address (addresses, i);
159         gen_terms_address_name (term_gen, address, address_type);
160         gen_terms_address_name (term_gen, address, "name");
161         gen_terms_address_name (term_gen, address, "body");
162     }
163 }
164
165 static void
166 add_term_address_addr (Xapian::Document doc,
167                        InternetAddress *address,
168                        const char *prefix_name)
169 {
170     InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address);
171     const char *addr;
172
173     addr = internet_address_mailbox_get_addr (mailbox);
174
175     if (addr)
176         add_term (doc, prefix_name, addr);
177 }
178
179 static void
180 add_terms_address_addrs (Xapian::Document doc,
181                          InternetAddressList *addresses,
182                          const char *address_type)
183 {
184     int i;
185     InternetAddress *address;
186
187     for (i = 0; i < internet_address_list_length (addresses); i++) {
188         address = internet_address_list_get_address (addresses, i);
189         add_term_address_addr (doc, address, address_type);
190         add_term_address_addr (doc, address, "email");
191     }
192 }
193
194 static const char *
195 skip_re_in_subject (const char *subject)
196 {
197     const char *s = subject;
198
199     while (*s) {
200         while (*s && isspace (*s))
201             s++;
202         if (strncasecmp (s, "re:", 3) == 0)
203             s += 3;
204         else
205             break;
206     }
207
208     return s;
209 }
210
211 Xapian::Document
212 find_message (Xapian::Database db, const char *message_id)
213 {
214     Xapian::PostingIterator i;
215     char *term;
216
217     term = g_strdup_printf ("%s%s", find_prefix ("msgid"), message_id);
218     i = db.postlist_begin (term);
219     if (i != db.postlist_end (term))
220         return db.get_document (*i);
221     else
222         return Xapian::Document ();
223 }
224
225 static char *
226 find_thread_id (Xapian::Database db, GPtrArray *parents)
227 {
228     Xapian::Document doc;
229     GHashTable *thread_ids;
230     GList *keys, *l;
231     GString *result = NULL;
232     unsigned int i;
233     string value_string;
234     const char *value;
235
236     thread_ids = g_hash_table_new (g_str_hash, g_str_equal);
237
238     for (i = 0; i < parents->len; i++) {
239         doc = find_message (db, (char *) g_ptr_array_index (parents, i));
240         value_string = doc.get_value (NOTMUCH_VALUE_THREAD);
241         value = value_string.c_str();
242         if (strlen (value))
243             g_hash_table_insert (thread_ids, strdup (value), NULL);
244     }
245
246     keys = g_hash_table_get_keys (thread_ids);
247     for (l = keys; l; l = l->next) {
248         char *id = (char *) l->data;
249         if (result == NULL) {
250             result = g_string_new (id);
251         } else {
252             g_string_append_printf (result, ",%s", id);
253         }
254         free (id);
255     }
256
257     if (result)
258         return g_string_free (result, FALSE);
259     else
260         return NULL;
261 }
262
263 /* Add a term for each message-id in the References header of the
264  * message. */
265 static void
266 parse_references (GPtrArray *array,
267                   const char *refs)
268 {
269     const char *end, *next;
270
271     if (refs == NULL)
272         return;
273
274     while (*refs) {
275         while (*refs && isspace (*refs))
276             refs++;
277         if (*refs == '<')
278             refs++;
279         end = refs;
280         while (*end && !isspace (*end))
281             end++;
282         next = end;
283         end--;
284         if (end > refs && *end == '>')
285             end--;
286         if (end > refs) {
287             g_ptr_array_add (array, g_strndup (refs, end - refs + 1));
288         }
289         refs = next;
290     }
291 }
292
293 /* Generate terms for the body of a message, given the filename of the
294  * message and the offset at which the headers of the message end,
295  * (and hence the body begins). */
296 static void
297 gen_terms_body (Xapian::TermGenerator term_gen,
298                 const char * filename,
299                 gint64 body_offset)
300 {
301     GIOChannel *channel;
302     GIOStatus gio_status;
303     GError *error = NULL;
304     char *p, *body_line = NULL, *prev_line = NULL;
305
306     channel = g_io_channel_new_file (filename, "r", &error);
307     if (channel == NULL) {
308         fprintf (stderr, "Error: %s\n", error->message);
309         exit (1);
310     }
311
312     gio_status = g_io_channel_seek_position (channel, body_offset,
313                                              G_SEEK_SET, &error);
314     if (gio_status != G_IO_STATUS_NORMAL) {
315         fprintf (stderr, "Error: %s\n", error->message);
316         exit (1);
317     }
318
319     while (1) {
320         if (body_line)
321             g_free (body_line);
322
323         gio_status = g_io_channel_read_line (channel, &body_line,
324                                              NULL, NULL, &error);
325         if (gio_status == G_IO_STATUS_EOF)
326             break;
327         if (gio_status != G_IO_STATUS_NORMAL) {
328             fprintf (stderr, "Error: %s\n", error->message);
329             exit (1);
330         }
331
332         if (strlen (body_line) == 0)
333             continue;
334
335         /* If the line looks like it might be introducing a quote,
336          * save it until we see if the next line begins a quote. */
337         p = body_line + strlen (body_line) - 1;
338         while (p > body_line and isspace (*p))
339             p--;
340         if (*p == ':') {
341             prev_line = body_line;
342             body_line = NULL;
343             continue;
344         }
345
346         /* Skip quoted lines, (and previous lines that introduced them) */
347         if (body_line[0] == '>') {
348             if (prev_line) {
349                 g_free (prev_line);
350                 prev_line = NULL;
351             }
352             continue;
353         }
354
355         /* Now that we're not looking at a quote we can add the prev_line */
356         if (prev_line) {
357             gen_terms (term_gen, "body", prev_line);
358             g_free (prev_line);
359             prev_line = NULL;
360         }
361
362         /* Skip signatures */
363         /* XXX: Should only do this if "near" the end of the message. */
364         if (strncmp (body_line, "-- ", 3) == 0 ||
365             strncmp (body_line, "----------", 10) == 0 ||
366             strncmp (body_line, "__________", 10) == 0)
367             break;
368
369         gen_terms (term_gen, "body", body_line);
370     }
371
372     if (body_line)
373         g_free (body_line);
374
375     g_io_channel_close (channel);
376 }
377
378 static void
379 index_file (Xapian::WritableDatabase db,
380             Xapian::TermGenerator term_gen,
381             const char *filename)
382 {
383     Xapian::Document doc;
384
385     GMimeStream *stream;
386     GMimeParser *parser;
387     GMimeMessage *message;
388     InternetAddressList *addresses;
389     GPtrArray *parents;
390
391     FILE *file;
392
393     const char *value, *from, *thread_id;
394
395     time_t time;
396     struct tm gm_time_tm;
397     char date_str[16]; /* YYYYMMDDHHMMSS + 1 for Y100k compatibility ;-) */
398     unsigned int i;
399
400     file = fopen (filename, "r");
401     if (! file) {
402         fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
403         exit (1);
404     }
405
406     stream = g_mime_stream_file_new (file);
407
408     parser = g_mime_parser_new_with_stream (stream);
409
410     message = g_mime_parser_construct_message (parser);
411
412     doc = Xapian::Document ();
413
414     doc.set_data (filename);
415
416     term_gen.set_stemmer (Xapian::Stem ("english"));
417
418     term_gen.set_document (doc);
419
420     from = g_mime_message_get_sender (message);
421     addresses = internet_address_list_parse_string (from);
422
423     gen_terms_address_names (term_gen, addresses, "from_name");
424
425     addresses = g_mime_message_get_all_recipients (message);
426     gen_terms_address_names (term_gen, addresses, "to_name");
427
428     value = g_mime_message_get_subject (message);
429     value = skip_re_in_subject (value);
430     gen_terms (term_gen, "subject", value);
431     gen_terms (term_gen, "body", value);
432
433     gen_terms_body (term_gen, filename,
434                     g_mime_parser_get_headers_end (parser));
435
436     parents = g_ptr_array_new ();
437
438     value = g_mime_object_get_header (GMIME_OBJECT (message), "references");
439     parse_references (parents, value);
440
441     value = g_mime_object_get_header (GMIME_OBJECT (message), "in-reply-to");
442     parse_references (parents, value);
443
444     for (i = 0; i < parents->len; i++)
445         add_term (doc, "ref", (char *) g_ptr_array_index (parents, i));
446
447     thread_id = find_thread_id (db, parents);
448
449     for (i = 0; i < parents->len; i++)
450         g_free (g_ptr_array_index (parents, i));
451     g_ptr_array_free (parents, TRUE);
452
453     from = g_mime_message_get_sender (message);
454     addresses = internet_address_list_parse_string (from);
455
456     add_terms_address_addrs (doc, addresses, "from_email");
457
458     add_terms_address_addrs (doc,
459                              g_mime_message_get_all_recipients (message),
460                              "to_email");
461
462     g_mime_message_get_date (message, &time, NULL);
463
464     gmtime_r (&time, &gm_time_tm);
465
466     if (strftime (date_str, sizeof (date_str),
467                   "%Y%m%d%H%M%S", &gm_time_tm) == 0) {
468         fprintf (stderr, "Internal error formatting time\n");
469         exit (1);
470     }
471
472     add_term (doc, "date", date_str);
473
474     add_term (doc, "label", "inbox");
475     add_term (doc, "label", "unread");
476     add_term (doc, "type", "mail");
477     add_term (doc, "source_id", "1");
478
479     value = g_mime_message_get_message_id (message);
480     add_term (doc, "msgid", value);
481     doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, value);
482
483     if (thread_id) {
484         add_term (doc, "thread", thread_id);
485         doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
486         free ((void *) thread_id);
487     } else {
488         /* If not referenced thread, use the message ID */
489         add_term (doc, "thread", value);
490         doc.add_value (NOTMUCH_VALUE_THREAD, value);
491     }
492
493     doc.add_value (NOTMUCH_VALUE_DATE, Xapian::sortable_serialise (time));
494
495     db.add_document (doc);
496
497     g_object_unref (message);
498     g_object_unref (parser);
499     g_object_unref (stream);
500 }
501
502 static void
503 usage (const char *argv0)
504 {
505     fprintf (stderr, "Usage: %s <path-to-xapian-database>\n", argv0);
506     fprintf (stderr, "\n");
507     fprintf (stderr, "Messages to be indexed are read from stdnin as absolute filenames\n");
508     fprintf (stderr, "one file per line.");
509 }
510
511 int
512 main (int argc, char **argv)
513 {
514     const char *database_path;
515     char *filename;
516     GIOChannel *channel;
517     GIOStatus gio_status;
518     GError *error = NULL;
519
520     if (argc < 2) {
521         usage (argv[0]);
522         exit (1);
523     }
524
525     database_path = argv[1];
526
527     g_mime_init (0);
528
529     try {
530         Xapian::WritableDatabase db;
531         Xapian::TermGenerator term_gen;
532
533         db = Xapian::WritableDatabase (database_path,
534                                        Xapian::DB_CREATE_OR_OPEN);
535
536         term_gen = Xapian::TermGenerator ();
537
538         channel = g_io_channel_unix_new (fileno (stdin));
539
540         while (1) {
541             gio_status = g_io_channel_read_line (channel, &filename,
542                                                  NULL, NULL, &error);
543             if (gio_status == G_IO_STATUS_EOF)
544                 break;
545             if (gio_status != G_IO_STATUS_NORMAL) {
546                 fprintf (stderr, "An error occurred reading from stdin: %s\n",
547                          error->message);
548                 exit (1);
549             }
550
551             g_strchomp (filename);
552             index_file (db, term_gen, filename);
553
554             g_free (filename);
555         }
556
557     } catch (const Xapian::Error &error) {
558         cerr << "A Xapian exception occurred: " << error.get_msg () << endl;
559         exit (1);
560     }
561
562     return 0;
563 }