e73e210d1071658609f31fbceacbce0b35a13e4e
[notmuch] / database.cc
1 /* database.cc - The database interfaces of the notmuch mail library
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 "database-private.h"
22
23 #include <iostream>
24
25 #include <xapian.h>
26
27 #include <glib.h> /* g_strdup_printf, g_free, GPtrArray, GHashTable */
28
29 using namespace std;
30
31 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
32
33 /* Xapian complains if we provide a term longer than this. */
34 #define NOTMUCH_MAX_TERM 245
35
36 /* These prefix values are specifically chosen to be compatible
37  * with sup, (http://sup.rubyforge.org), written by
38  * William Morgan <wmorgan-sup@masanjin.net>, and released
39  * under the GNU GPL v2.
40  */
41
42 typedef struct {
43     const char *name;
44     const char *prefix;
45 } prefix_t;
46
47 prefix_t NORMAL_PREFIX[] = {
48     { "subject", "S" },
49     { "body", "B" },
50     { "from_name", "FN" },
51     { "to_name", "TN" },
52     { "name", "N" },
53     { "attachment", "A" }
54 };
55
56 prefix_t BOOLEAN_PREFIX[] = {
57     { "type", "K" },
58     { "from_email", "FE" },
59     { "to_email", "TE" },
60     { "email", "E" },
61     { "date", "D" },
62     { "label", "L" },
63     { "source_id", "I" },
64     { "attachment_extension", "O" },
65     { "msgid", "Q" },
66     { "thread", "H" },
67     { "ref", "R" }
68 };
69
70 static const char *
71 find_prefix (const char *name)
72 {
73     unsigned int i;
74
75     for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
76         if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
77             return NORMAL_PREFIX[i].prefix;
78
79     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
80         if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
81             return BOOLEAN_PREFIX[i].prefix;
82
83     return "";
84 }
85
86 /* "128 bits of thread-id ought to be enough for anybody" */
87 #define NOTMUCH_THREAD_ID_BITS   128
88 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
89 typedef struct _thread_id {
90     char str[NOTMUCH_THREAD_ID_DIGITS + 1];
91 } thread_id_t;
92
93 static void
94 thread_id_generate (thread_id_t *thread_id)
95 {
96     static int seeded = 0;
97     FILE *dev_random;
98     uint32_t value;
99     char *s;
100     int i;
101
102     if (! seeded) {
103         dev_random = fopen ("/dev/random", "r");
104         if (dev_random == NULL) {
105             srand (time (NULL));
106         } else {
107             fread ((void *) &value, sizeof (value), 1, dev_random);
108             srand (value);
109             fclose (dev_random);
110         }
111         seeded = 1;
112     }
113
114     s = thread_id->str;
115     for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
116         value = rand ();
117         sprintf (s, "%08x", value);
118         s += 8;
119     }
120 }
121
122 static void
123 add_term (Xapian::Document doc,
124           const char *prefix_name,
125           const char *value)
126 {
127     const char *prefix;
128     char *term;
129
130     if (value == NULL)
131         return;
132
133     prefix = find_prefix (prefix_name);
134
135     term = g_strdup_printf ("%s%s", prefix, value);
136
137     if (strlen (term) <= NOTMUCH_MAX_TERM)
138         doc.add_term (term);
139
140     g_free (term);
141 }
142
143 static void
144 find_messages_by_term (Xapian::Database *db,
145                        const char *prefix_name,
146                        const char *value,
147                        Xapian::PostingIterator *begin,
148                        Xapian::PostingIterator *end)
149 {
150     Xapian::PostingIterator i;
151     char *term;
152
153     term = g_strdup_printf ("%s%s", find_prefix (prefix_name), value);
154
155     *begin = db->postlist_begin (term);
156
157     if (end)
158         *end = db->postlist_end (term);
159
160     free (term);
161 }
162
163 Xapian::Document
164 find_message_by_docid (Xapian::Database *db, Xapian::docid docid)
165 {
166     return db->get_document (docid);
167 }
168
169 Xapian::Document
170 find_message_by_message_id (Xapian::Database *db, const char *message_id)
171 {
172     Xapian::PostingIterator i, end;
173
174     find_messages_by_term (db, "msgid", message_id, &i, &end);
175
176     if (i != end)
177         return find_message_by_docid (db, *i);
178     else
179         return Xapian::Document ();
180 }
181
182 static void
183 insert_thread_id (GHashTable *thread_ids, Xapian::Document doc)
184 {
185     string value_string;
186     const char *value, *id, *comma;
187
188     value_string = doc.get_value (NOTMUCH_VALUE_THREAD);
189     value = value_string.c_str();
190     if (strlen (value)) {
191         id = value;
192         while (*id) {
193             comma = strchr (id, ',');
194             if (comma == NULL)
195                 comma = id + strlen (id);
196             g_hash_table_insert (thread_ids,
197                                  strndup (id, comma - id), NULL);
198             id = comma;
199             if (*id)
200                 id++;
201         }
202     }
203 }
204
205 /* Return one or more thread_ids, (as a GPtrArray of strings), for the
206  * given message based on looking into the database for any messages
207  * referenced in parents, and also for any messages in the database
208  * referencing message_id.
209  *
210  * Caller should free all strings in the array and the array itself,
211  * (g_ptr_array_free) when done. */
212 static GPtrArray *
213 find_thread_ids (Xapian::Database *db,
214                  GPtrArray *parents,
215                  const char *message_id)
216 {
217     Xapian::PostingIterator child, children_end;
218     Xapian::Document doc;
219     GHashTable *thread_ids;
220     GList *keys, *l;
221     unsigned int i;
222     const char *parent_message_id;
223     GPtrArray *result;
224
225     thread_ids = g_hash_table_new_full (g_str_hash, g_str_equal,
226                                         free, NULL);
227
228     find_messages_by_term (db, "ref", message_id, &child, &children_end);
229     for ( ; child != children_end; child++) {
230         doc = find_message_by_docid (db, *child);
231         insert_thread_id (thread_ids, doc);
232     }
233
234     for (i = 0; i < parents->len; i++) {
235         parent_message_id = (char *) g_ptr_array_index (parents, i);
236         doc = find_message_by_message_id (db, parent_message_id);
237         insert_thread_id (thread_ids, doc);
238     }
239
240     result = g_ptr_array_new ();
241
242     keys = g_hash_table_get_keys (thread_ids);
243     for (l = keys; l; l = l->next) {
244         char *id = (char *) l->data;
245         g_ptr_array_add (result, id);
246     }
247     g_list_free (keys);
248
249     /* We're done with the hash table, but we've taken the pointers to
250      * the allocated strings and put them into our result array, so
251      * tell the hash not to free them on its way out. */
252     g_hash_table_steal_all (thread_ids);
253     g_hash_table_unref (thread_ids);
254
255     return result;
256 }
257
258 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
259  * a (potentially nested) parenthesized sequence with '\' used to
260  * escape any character (including parentheses).
261  *
262  * If the sequence to be skipped continues to the end of the string,
263  * then 'str' will be left pointing at the final terminating '\0'
264  * character.
265  */
266 static void
267 skip_space_and_comments (const char **str)
268 {
269     const char *s;
270
271     s = *str;
272     while (*s && (isspace (*s) || *s == '(')) {
273         while (*s && isspace (*s))
274             s++;
275         if (*s == '(') {
276             int nesting = 1;
277             s++;
278             while (*s && nesting) {
279                 if (*s == '(')
280                     nesting++;
281                 else if (*s == ')')
282                     nesting--;
283                 else if (*s == '\\')
284                     if (*(s+1))
285                         s++;
286                 s++;
287             }
288         }
289     }
290
291     *str = s;
292 }
293
294 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
295  * comments, and the '<' and '>' delimeters.
296  *
297  * If not NULL, then *next will be made to point to the first character
298  * not parsed, (possibly pointing to the final '\0' terminator.
299  *
300  * Returns a newly allocated string which the caller should free()
301  * when done with it.
302  *
303  * Returns NULL if there is any error parsing the message-id. */
304 static char *
305 parse_message_id (const char *message_id, const char **next)
306 {
307     const char *s, *end;
308     char *result;
309
310     if (message_id == NULL)
311         return NULL;
312
313     s = message_id;
314
315     skip_space_and_comments (&s);
316
317     /* Skip any unstructured text as well. */
318     while (*s && *s != '<')
319         s++;
320
321     if (*s == '<') {
322         s++;
323     } else {
324         if (next)
325             *next = s;
326         return NULL;
327     }
328
329     skip_space_and_comments (&s);
330
331     end = s;
332     while (*end && *end != '>')
333         end++;
334     if (next) {
335         if (*end)
336             *next = end + 1;
337         else
338             *next = end;
339     }
340
341     if (end > s && *end == '>')
342         end--;
343     if (end <= s)
344         return NULL;
345
346     result = strndup (s, end - s + 1);
347
348     /* Finally, collapse any whitespace that is within the message-id
349      * itself. */
350     {
351         char *r;
352         int len;
353
354         for (r = result, len = strlen (r); *r; r++, len--)
355             if (*r == ' ' || *r == '\t')
356                 memmove (r, r+1, len);
357     }
358
359     return result;
360 }
361
362 /* Parse a References header value, putting a copy of each referenced
363  * message-id into 'array'. */
364 static void
365 parse_references (GPtrArray *array,
366                   const char *refs)
367 {
368     char *ref;
369
370     if (refs == NULL)
371         return;
372
373     while (*refs) {
374         ref = parse_message_id (refs, &refs);
375
376         if (ref)
377             g_ptr_array_add (array, ref);
378     }
379 }
380
381 char *
382 notmuch_database_default_path (void)
383 {
384     if (getenv ("NOTMUCH_BASE"))
385         return strdup (getenv ("NOTMUCH_BASE"));
386
387     return g_strdup_printf ("%s/mail", getenv ("HOME"));
388 }
389
390 notmuch_database_t *
391 notmuch_database_create (const char *path)
392 {
393     notmuch_database_t *notmuch = NULL;
394     char *notmuch_path = NULL;
395     struct stat st;
396     int err;
397     char *local_path = NULL;
398
399     if (path == NULL)
400         path = local_path = notmuch_database_default_path ();
401
402     err = stat (path, &st);
403     if (err) {
404         fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
405                  path, strerror (errno));
406         goto DONE;
407     }
408
409     if (! S_ISDIR (st.st_mode)) {
410         fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
411                  path);
412         goto DONE;
413     }
414
415     notmuch_path = g_strdup_printf ("%s/%s", path, ".notmuch");
416
417     err = mkdir (notmuch_path, 0755);
418
419     if (err) {
420         fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
421                  notmuch_path, strerror (errno));
422         goto DONE;
423     }
424
425     notmuch = notmuch_database_open (path);
426
427   DONE:
428     if (notmuch_path)
429         free (notmuch_path);
430     if (local_path)
431         free (local_path);
432
433     return notmuch;
434 }
435
436 notmuch_database_t *
437 notmuch_database_open (const char *path)
438 {
439     notmuch_database_t *notmuch = NULL;
440     char *notmuch_path = NULL, *xapian_path = NULL;
441     struct stat st;
442     int err;
443     char *local_path = NULL;
444
445     if (path == NULL)
446         path = local_path = notmuch_database_default_path ();
447
448     notmuch_path = g_strdup_printf ("%s/%s", path, ".notmuch");
449
450     err = stat (notmuch_path, &st);
451     if (err) {
452         fprintf (stderr, "Error opening database at %s: %s\n",
453                  notmuch_path, strerror (errno));
454         goto DONE;
455     }
456
457     xapian_path = g_strdup_printf ("%s/%s", notmuch_path, "xapian");
458
459     notmuch = talloc (NULL, notmuch_database_t);
460     notmuch->path = talloc_strdup (notmuch, path);
461
462     try {
463         notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
464                                                            Xapian::DB_CREATE_OR_OPEN);
465         notmuch->query_parser = new Xapian::QueryParser;
466         notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
467         notmuch->query_parser->set_database (*notmuch->xapian_db);
468     } catch (const Xapian::Error &error) {
469         fprintf (stderr, "A Xapian exception occurred: %s\n",
470                  error.get_msg().c_str());
471     }
472     
473   DONE:
474     if (local_path)
475         free (local_path);
476     if (notmuch_path)
477         free (notmuch_path);
478     if (xapian_path)
479         free (xapian_path);
480
481     return notmuch;
482 }
483
484 void
485 notmuch_database_close (notmuch_database_t *notmuch)
486 {
487     delete notmuch->query_parser;
488     delete notmuch->xapian_db;
489     talloc_free (notmuch);
490 }
491
492 const char *
493 notmuch_database_get_path (notmuch_database_t *notmuch)
494 {
495     return notmuch->path;
496 }
497
498 notmuch_status_t
499 notmuch_database_add_message (notmuch_database_t *notmuch,
500                               const char *filename)
501 {
502     Xapian::WritableDatabase *db = notmuch->xapian_db;
503     Xapian::Document doc;
504     notmuch_message_file_t *message;
505
506     GPtrArray *parents, *thread_ids;
507
508     const char *refs, *in_reply_to, *date, *header;
509     const char *from, *to, *subject;
510     char *message_id;
511
512     time_t time_value;
513     unsigned int i;
514
515     message = notmuch_message_file_open (filename);
516
517     notmuch_message_file_restrict_headers (message,
518                                            "date",
519                                            "from",
520                                            "in-reply-to",
521                                            "message-id",
522                                            "references",
523                                            "subject",
524                                            (char *) NULL);
525
526     try {
527         doc.set_data (filename);
528
529         add_term (doc, "type", "mail");
530
531         parents = g_ptr_array_new ();
532
533         refs = notmuch_message_file_get_header (message, "references");
534         parse_references (parents, refs);
535
536         in_reply_to = notmuch_message_file_get_header (message, "in-reply-to");
537         parse_references (parents, in_reply_to);
538
539         for (i = 0; i < parents->len; i++)
540             add_term (doc, "ref", (char *) g_ptr_array_index (parents, i));
541
542         header = notmuch_message_file_get_header (message, "message-id");
543         if (header) {
544             message_id = parse_message_id (header, NULL);
545             /* So the header value isn't RFC-compliant, but it's
546              * better than no message-id at all. */
547             if (message_id == NULL)
548                 message_id = xstrdup (header);
549         } else {
550             /* XXX: Should generate a message_id here, (such as a SHA1
551              * sum of the message itself) */
552             message_id = NULL;
553         }
554
555         thread_ids = find_thread_ids (db, parents, message_id);
556
557         for (i = 0; i < parents->len; i++)
558             g_free (g_ptr_array_index (parents, i));
559         g_ptr_array_free (parents, TRUE);
560         if (message_id) {
561             add_term (doc, "msgid", message_id);
562             doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
563         }
564
565         if (thread_ids->len) {
566             unsigned int i;
567             GString *thread_id;
568             char *id;
569
570             for (i = 0; i < thread_ids->len; i++) {
571                 id = (char *) thread_ids->pdata[i];
572                 add_term (doc, "thread", id);
573                 if (i == 0)
574                     thread_id = g_string_new (id);
575                 else
576                     g_string_append_printf (thread_id, ",%s", id);
577
578                 free (id);
579             }
580             doc.add_value (NOTMUCH_VALUE_THREAD, thread_id->str);
581             g_string_free (thread_id, TRUE);
582         } else if (message_id) {
583             /* If not part of any existing thread, generate a new thread_id. */
584             thread_id_t thread_id;
585
586             thread_id_generate (&thread_id);
587             add_term (doc, "thread", thread_id.str);
588             doc.add_value (NOTMUCH_VALUE_THREAD, thread_id.str);
589         }
590
591         g_ptr_array_free (thread_ids, TRUE);
592
593         free (message_id);
594
595         date = notmuch_message_file_get_header (message, "date");
596         time_value = notmuch_parse_date (date, NULL);
597
598         doc.add_value (NOTMUCH_VALUE_DATE,
599                        Xapian::sortable_serialise (time_value));
600
601         from = notmuch_message_file_get_header (message, "from");
602         subject = notmuch_message_file_get_header (message, "subject");
603         to = notmuch_message_file_get_header (message, "to");
604
605         if (from == NULL &&
606             subject == NULL &&
607             to == NULL)
608         {
609             notmuch_message_file_close (message);
610             return NOTMUCH_STATUS_FILE_NOT_EMAIL;
611         } else {
612             db->add_document (doc);
613         }
614     } catch (const Xapian::Error &error) {
615         fprintf (stderr, "A Xapian exception occurred: %s.\n",
616                  error.get_msg().c_str());
617         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
618     }
619
620     notmuch_message_file_close (message);
621
622     return NOTMUCH_STATUS_SUCCESS;
623 }