lib: Implement versioning in the database and provide upgrade function.
[notmuch] / lib / 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 <sys/time.h>
26 #include <signal.h>
27 #include <xapian.h>
28
29 #include <glib.h> /* g_free, GPtrArray, GHashTable */
30
31 using namespace std;
32
33 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
34
35 typedef struct {
36     const char *name;
37     const char *prefix;
38 } prefix_t;
39
40 #define NOTMUCH_DATABASE_VERSION 1
41
42 #define STRINGIFY(s) _SUB_STRINGIFY(s)
43 #define _SUB_STRINGIFY(s) #s
44
45 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
46  *
47  * We currently have two different types of documents: mail and directory.
48  *
49  * Mail document
50  * -------------
51  * A mail document is associated with a particular email message file
52  * on disk. It is indexed with the following prefixed terms which the
53  * database uses to construct threads, etc.:
54  *
55  *    Single terms of given prefix:
56  *
57  *      type:   mail
58  *
59  *      id:     Unique ID of mail, (from Message-ID header or generated
60  *              as "notmuch-sha1-<sha1_sum_of_entire_file>.
61  *
62  *      thread: The ID of the thread to which the mail belongs
63  *
64  *      replyto: The ID from the In-Reply-To header of the mail (if any).
65  *
66  *    Multiple terms of given prefix:
67  *
68  *      reference: All message IDs from In-Reply-To and Re ferences
69  *                 headers in the message.
70  *
71  *      tag:       Any tags associated with this message by the user.
72  *
73  *      file-direntry:  A colon-separated pair of values
74  *                      (INTEGER:STRING), where INTEGER is the
75  *                      document ID of a directory document, and
76  *                      STRING is the name of a file within that
77  *                      directory for this mail message.
78  *
79  *    A mail document also has two values:
80  *
81  *      TIMESTAMP:      The time_t value corresponding to the message's
82  *                      Date header.
83  *
84  *      MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
85  *
86  * In addition, terms from the content of the message are added with
87  * "from", "to", "attachment", and "subject" prefixes for use by the
88  * user in searching. But the database doesn't really care itself
89  * about any of these.
90  *
91  * The data portion of a mail document is empty.
92  *
93  * Directory document
94  * ------------------
95  * A directory document is used by a client of the notmuch library to
96  * maintain data necessary to allow for efficient polling of mail
97  * directories.
98  *
99  * All directory documents contain one term:
100  *
101  *      directory:      The directory path (relative to the database path)
102  *                      Or the SHA1 sum of the directory path (if the
103  *                      path itself is too long to fit in a Xapian
104  *                      term).
105  *
106  * And all directory documents for directories other than top-level
107  * directories also contain the following term:
108  *
109  *      directory-direntry: A colon-separated pair of values
110  *                          (INTEGER:STRING), where INTEGER is the
111  *                          document ID of the parent directory
112  *                          document, and STRING is the name of this
113  *                          directory within that parent.
114  *
115  * All directory documents have a single value:
116  *
117  *      TIMESTAMP:      The mtime of the directory (at last scan)
118  *
119  * The data portion of a directory document contains the path of the
120  * directory (relative to the database path).
121  */
122
123 /* With these prefix values we follow the conventions published here:
124  *
125  * http://xapian.org/docs/omega/termprefixes.html
126  *
127  * as much as makes sense. Note that I took some liberty in matching
128  * the reserved prefix values to notmuch concepts, (for example, 'G'
129  * is documented as "newsGroup (or similar entity - e.g. a web forum
130  * name)", for which I think the thread is the closest analogue in
131  * notmuch. This in spite of the fact that we will eventually be
132  * storing mailing-list messages where 'G' for "mailing list name"
133  * might be even a closer analogue. I'm treating the single-character
134  * prefixes preferentially for core notmuch concepts (which will be
135  * nearly universal to all mail messages).
136  */
137
138 prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
139     { "type",                   "T" },
140     { "reference",              "XREFERENCE" },
141     { "replyto",                "XREPLYTO" },
142     { "directory",              "XDIRECTORY" },
143     { "file-direntry",          "XFDIRENTRY" },
144     { "directory-direntry",     "XDDIRENTRY" },
145 };
146
147 prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
148     { "thread",                 "G" },
149     { "tag",                    "K" },
150     { "id",                     "Q" }
151 };
152
153 prefix_t PROBABILISTIC_PREFIX[]= {
154     { "from",                   "XFROM" },
155     { "to",                     "XTO" },
156     { "attachment",             "XATTACHMENT" },
157     { "subject",                "XSUBJECT"}
158 };
159
160 int
161 _internal_error (const char *format, ...)
162 {
163     va_list va_args;
164
165     va_start (va_args, format);
166
167     fprintf (stderr, "Internal error: ");
168     vfprintf (stderr, format, va_args);
169
170     exit (1);
171
172     return 1;
173 }
174
175 const char *
176 _find_prefix (const char *name)
177 {
178     unsigned int i;
179
180     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
181         if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
182             return BOOLEAN_PREFIX_INTERNAL[i].prefix;
183     }
184
185     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
186         if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
187             return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
188     }
189
190     for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
191         if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
192             return PROBABILISTIC_PREFIX[i].prefix;
193     }
194
195     INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
196
197     return "";
198 }
199
200 const char *
201 notmuch_status_to_string (notmuch_status_t status)
202 {
203     switch (status) {
204     case NOTMUCH_STATUS_SUCCESS:
205         return "No error occurred";
206     case NOTMUCH_STATUS_OUT_OF_MEMORY:
207         return "Out of memory";
208     case NOTMUCH_STATUS_READ_ONLY_DATABASE:
209         return "Attempt to write to a read-only database";
210     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
211         return "A Xapian exception occurred";
212     case NOTMUCH_STATUS_FILE_ERROR:
213         return "Something went wrong trying to read or write a file";
214     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
215         return "File is not an email";
216     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
217         return "Message ID is identical to a message in database";
218     case NOTMUCH_STATUS_NULL_POINTER:
219         return "Erroneous NULL pointer";
220     case NOTMUCH_STATUS_TAG_TOO_LONG:
221         return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
222     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
223         return "Unbalanced number of calls to notmuch_message_freeze/thaw";
224     default:
225     case NOTMUCH_STATUS_LAST_STATUS:
226         return "Unknown error status value";
227     }
228 }
229
230 static void
231 find_doc_ids_for_term (notmuch_database_t *notmuch,
232                        const char *term,
233                        Xapian::PostingIterator *begin,
234                        Xapian::PostingIterator *end)
235 {
236     *begin = notmuch->xapian_db->postlist_begin (term);
237
238     *end = notmuch->xapian_db->postlist_end (term);
239 }
240
241 static void
242 find_doc_ids (notmuch_database_t *notmuch,
243               const char *prefix_name,
244               const char *value,
245               Xapian::PostingIterator *begin,
246               Xapian::PostingIterator *end)
247 {
248     char *term;
249
250     term = talloc_asprintf (notmuch, "%s%s",
251                             _find_prefix (prefix_name), value);
252
253     find_doc_ids_for_term (notmuch, term, begin, end);
254
255     talloc_free (term);
256 }
257
258 notmuch_private_status_t
259 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
260                                       const char *prefix_name,
261                                       const char *value,
262                                       unsigned int *doc_id)
263 {
264     Xapian::PostingIterator i, end;
265
266     find_doc_ids (notmuch, prefix_name, value, &i, &end);
267
268     if (i == end) {
269         *doc_id = 0;
270         return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
271     }
272
273     *doc_id = *i;
274
275 #if DEBUG_DATABASE_SANITY
276     i++;
277
278     if (i != end)
279         INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
280                         prefix_name, value);
281 #endif
282
283     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
284 }
285
286 static Xapian::Document
287 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
288 {
289     return notmuch->xapian_db->get_document (doc_id);
290 }
291
292 notmuch_message_t *
293 notmuch_database_find_message (notmuch_database_t *notmuch,
294                                const char *message_id)
295 {
296     notmuch_private_status_t status;
297     unsigned int doc_id;
298
299     status = _notmuch_database_find_unique_doc_id (notmuch, "id",
300                                                    message_id, &doc_id);
301
302     if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
303         return NULL;
304
305     return _notmuch_message_create (notmuch, notmuch, doc_id, NULL);
306 }
307
308 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
309  * a (potentially nested) parenthesized sequence with '\' used to
310  * escape any character (including parentheses).
311  *
312  * If the sequence to be skipped continues to the end of the string,
313  * then 'str' will be left pointing at the final terminating '\0'
314  * character.
315  */
316 static void
317 skip_space_and_comments (const char **str)
318 {
319     const char *s;
320
321     s = *str;
322     while (*s && (isspace (*s) || *s == '(')) {
323         while (*s && isspace (*s))
324             s++;
325         if (*s == '(') {
326             int nesting = 1;
327             s++;
328             while (*s && nesting) {
329                 if (*s == '(') {
330                     nesting++;
331                 } else if (*s == ')') {
332                     nesting--;
333                 } else if (*s == '\\') {
334                     if (*(s+1))
335                         s++;
336                 }
337                 s++;
338             }
339         }
340     }
341
342     *str = s;
343 }
344
345 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
346  * comments, and the '<' and '>' delimeters.
347  *
348  * If not NULL, then *next will be made to point to the first character
349  * not parsed, (possibly pointing to the final '\0' terminator.
350  *
351  * Returns a newly talloc'ed string belonging to 'ctx'.
352  *
353  * Returns NULL if there is any error parsing the message-id. */
354 static char *
355 _parse_message_id (void *ctx, const char *message_id, const char **next)
356 {
357     const char *s, *end;
358     char *result;
359
360     if (message_id == NULL || *message_id == '\0')
361         return NULL;
362
363     s = message_id;
364
365     skip_space_and_comments (&s);
366
367     /* Skip any unstructured text as well. */
368     while (*s && *s != '<')
369         s++;
370
371     if (*s == '<') {
372         s++;
373     } else {
374         if (next)
375             *next = s;
376         return NULL;
377     }
378
379     skip_space_and_comments (&s);
380
381     end = s;
382     while (*end && *end != '>')
383         end++;
384     if (next) {
385         if (*end)
386             *next = end + 1;
387         else
388             *next = end;
389     }
390
391     if (end > s && *end == '>')
392         end--;
393     if (end <= s)
394         return NULL;
395
396     result = talloc_strndup (ctx, s, end - s + 1);
397
398     /* Finally, collapse any whitespace that is within the message-id
399      * itself. */
400     {
401         char *r;
402         int len;
403
404         for (r = result, len = strlen (r); *r; r++, len--)
405             if (*r == ' ' || *r == '\t')
406                 memmove (r, r+1, len);
407     }
408
409     return result;
410 }
411
412 /* Parse a References header value, putting a (talloc'ed under 'ctx')
413  * copy of each referenced message-id into 'hash'.
414  *
415  * We explicitly avoid including any reference identical to
416  * 'message_id' in the result (to avoid mass confusion when a single
417  * message references itself cyclically---and yes, mail messages are
418  * not infrequent in the wild that do this---don't ask me why).
419 */
420 static void
421 parse_references (void *ctx,
422                   const char *message_id,
423                   GHashTable *hash,
424                   const char *refs)
425 {
426     char *ref;
427
428     if (refs == NULL || *refs == '\0')
429         return;
430
431     while (*refs) {
432         ref = _parse_message_id (ctx, refs, &refs);
433
434         if (ref && strcmp (ref, message_id))
435             g_hash_table_insert (hash, ref, NULL);
436     }
437 }
438
439 notmuch_database_t *
440 notmuch_database_create (const char *path)
441 {
442     notmuch_database_t *notmuch = NULL;
443     char *notmuch_path = NULL;
444     struct stat st;
445     int err;
446
447     if (path == NULL) {
448         fprintf (stderr, "Error: Cannot create a database for a NULL path.\n");
449         goto DONE;
450     }
451
452     err = stat (path, &st);
453     if (err) {
454         fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
455                  path, strerror (errno));
456         goto DONE;
457     }
458
459     if (! S_ISDIR (st.st_mode)) {
460         fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
461                  path);
462         goto DONE;
463     }
464
465     notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
466
467     err = mkdir (notmuch_path, 0755);
468
469     if (err) {
470         fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
471                  notmuch_path, strerror (errno));
472         goto DONE;
473     }
474
475     notmuch = notmuch_database_open (path,
476                                      NOTMUCH_DATABASE_MODE_READ_WRITE);
477     notmuch_database_upgrade (notmuch, NULL, NULL);
478
479   DONE:
480     if (notmuch_path)
481         talloc_free (notmuch_path);
482
483     return notmuch;
484 }
485
486 notmuch_status_t
487 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
488 {
489     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
490         fprintf (stderr, "Cannot write to a read-only database.\n");
491         return NOTMUCH_STATUS_READ_ONLY_DATABASE;
492     }
493
494     return NOTMUCH_STATUS_SUCCESS;
495 }
496
497 notmuch_database_t *
498 notmuch_database_open (const char *path,
499                        notmuch_database_mode_t mode)
500 {
501     notmuch_database_t *notmuch = NULL;
502     char *notmuch_path = NULL, *xapian_path = NULL;
503     struct stat st;
504     int err;
505     unsigned int i, version;
506
507     if (asprintf (&notmuch_path, "%s/%s", path, ".notmuch") == -1) {
508         notmuch_path = NULL;
509         fprintf (stderr, "Out of memory\n");
510         goto DONE;
511     }
512
513     err = stat (notmuch_path, &st);
514     if (err) {
515         fprintf (stderr, "Error opening database at %s: %s\n",
516                  notmuch_path, strerror (errno));
517         goto DONE;
518     }
519
520     if (asprintf (&xapian_path, "%s/%s", notmuch_path, "xapian") == -1) {
521         xapian_path = NULL;
522         fprintf (stderr, "Out of memory\n");
523         goto DONE;
524     }
525
526     notmuch = talloc (NULL, notmuch_database_t);
527     notmuch->exception_reported = FALSE;
528     notmuch->path = talloc_strdup (notmuch, path);
529
530     if (notmuch->path[strlen (notmuch->path) - 1] == '/')
531         notmuch->path[strlen (notmuch->path) - 1] = '\0';
532
533     notmuch->needs_upgrade = FALSE;
534     notmuch->mode = mode;
535     try {
536         if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
537             notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
538                                                                Xapian::DB_CREATE_OR_OPEN);
539             version = notmuch_database_get_version (notmuch);
540
541             if (version > NOTMUCH_DATABASE_VERSION) {
542                 fprintf (stderr,
543                          "Error: Notmuch database at %s\n"
544                          "       has a newer database format version (%u) than supported by this\n"
545                          "       version of notmuch (%u). Refusing to open this database in\n"
546                          "       read-write mode.\n",
547                          notmuch_path, version, NOTMUCH_DATABASE_VERSION);
548                 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
549                 notmuch_database_close (notmuch);
550                 notmuch = NULL;
551                 goto DONE;
552             }
553
554             if (version < NOTMUCH_DATABASE_VERSION)
555                 notmuch->needs_upgrade = TRUE;
556         } else {
557             notmuch->xapian_db = new Xapian::Database (xapian_path);
558             version = notmuch_database_get_version (notmuch);
559             if (version > NOTMUCH_DATABASE_VERSION)
560             {
561                 fprintf (stderr,
562                          "Warning: Notmuch database at %s\n"
563                          "         has a newer database format version (%u) than supported by this\n"
564                          "         version of notmuch (%u). Some operations may behave incorrectly,\n"
565                          "         (but the database will not be harmed since it is being opened\n"
566                          "         in read-only mode).\n",
567                          notmuch_path, version, NOTMUCH_DATABASE_VERSION);
568             }
569         }
570         notmuch->query_parser = new Xapian::QueryParser;
571         notmuch->term_gen = new Xapian::TermGenerator;
572         notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
573         notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
574
575         notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
576         notmuch->query_parser->set_database (*notmuch->xapian_db);
577         notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
578         notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
579         notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
580
581         for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
582             prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
583             notmuch->query_parser->add_boolean_prefix (prefix->name,
584                                                        prefix->prefix);
585         }
586
587         for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
588             prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
589             notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
590         }
591     } catch (const Xapian::Error &error) {
592         fprintf (stderr, "A Xapian exception occurred opening database: %s\n",
593                  error.get_msg().c_str());
594         notmuch = NULL;
595     }
596
597   DONE:
598     if (notmuch_path)
599         free (notmuch_path);
600     if (xapian_path)
601         free (xapian_path);
602
603     return notmuch;
604 }
605
606 void
607 notmuch_database_close (notmuch_database_t *notmuch)
608 {
609     try {
610         if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
611             (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
612     } catch (const Xapian::Error &error) {
613         if (! notmuch->exception_reported) {
614             fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
615                      error.get_msg().c_str());
616         }
617     }
618
619     delete notmuch->term_gen;
620     delete notmuch->query_parser;
621     delete notmuch->xapian_db;
622     delete notmuch->value_range_processor;
623     talloc_free (notmuch);
624 }
625
626 const char *
627 notmuch_database_get_path (notmuch_database_t *notmuch)
628 {
629     return notmuch->path;
630 }
631
632 unsigned int
633 notmuch_database_get_version (notmuch_database_t *notmuch)
634 {
635     unsigned int version;
636     string version_string;
637     const char *str;
638     char *end;
639
640     version_string = notmuch->xapian_db->get_metadata ("version");
641     if (version_string.empty ())
642         return 0;
643
644     str = version_string.c_str ();
645     if (str == NULL || *str == '\0')
646         return 0;
647
648     version = strtoul (str, &end, 10);
649     if (*end != '\0')
650         INTERNAL_ERROR ("Malformed database version: %s", str);
651
652     return version;
653 }
654
655 notmuch_bool_t
656 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
657 {
658     return notmuch->needs_upgrade;
659 }
660
661 static volatile sig_atomic_t do_progress_notify = 0;
662
663 static void
664 handle_sigalrm (unused (int signal))
665 {
666     do_progress_notify = 1;
667 }
668
669 /* Upgrade the current database.
670  *
671  * After opening a database in read-write mode, the client should
672  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
673  * if so, upgrade with this function before making any modifications.
674  *
675  * The optional progress_notify callback can be used by the caller to
676  * provide progress indication to the user. If non-NULL it will be
677  * called periodically with 'count' as the number of messages upgraded
678  * so far and 'total' the overall number of messages that will be
679  * converted.
680  */
681 notmuch_status_t
682 notmuch_database_upgrade (notmuch_database_t *notmuch,
683                           void (*progress_notify) (void *closure,
684                                                    unsigned int count,
685                                                    unsigned int total),
686                           void *closure)
687 {
688     Xapian::WritableDatabase *db;
689     struct sigaction action;
690     struct itimerval timerval;
691     notmuch_bool_t timer_is_active = FALSE;
692     unsigned int version;
693     notmuch_status_t status;
694
695     status = _notmuch_database_ensure_writable (notmuch);
696     if (status)
697         return status;
698
699     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
700
701     version = notmuch_database_get_version (notmuch);
702
703     if (version >= NOTMUCH_DATABASE_VERSION)
704         return NOTMUCH_STATUS_SUCCESS;
705
706     if (progress_notify) {
707         /* Setup our handler for SIGALRM */
708         memset (&action, 0, sizeof (struct sigaction));
709         action.sa_handler = handle_sigalrm;
710         sigemptyset (&action.sa_mask);
711         action.sa_flags = SA_RESTART;
712         sigaction (SIGALRM, &action, NULL);
713
714         /* Then start a timer to send SIGALRM once per second. */
715         timerval.it_interval.tv_sec = 1;
716         timerval.it_interval.tv_usec = 0;
717         timerval.it_value.tv_sec = 1;
718         timerval.it_value.tv_usec = 0;
719         setitimer (ITIMER_REAL, &timerval, NULL);
720
721         timer_is_active = TRUE;
722     }
723
724     /* Before version 1, each message document had its filename in the
725      * data field. Move that into the new format by calling
726      * notmuch_message_add_filename.
727      */
728     if (version < 1) {
729         unsigned int count = 0, total;
730         notmuch_query_t *query = notmuch_query_create (notmuch, "");
731         notmuch_messages_t *messages;
732         notmuch_message_t *message;
733
734         total = notmuch_query_count_messages (query);
735
736         for (messages = notmuch_query_search_messages (query);
737              notmuch_messages_has_more (messages);
738              notmuch_messages_advance (messages))
739         {
740             if (do_progress_notify)
741                 progress_notify (closure, count, total);
742
743             message = notmuch_messages_get (messages);
744
745             _notmuch_message_upgrade_filename_storage (message);
746
747             count++;
748         }
749     }
750
751     /* Also, before version 1 we stored directory timestamps in
752      * XTIMESTAMP documents instead of the current XDIRECTORY
753      * documents. So convert those as well. */
754     if (version < 1) {
755         Xapian::TermIterator t, t_end;
756
757         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
758
759         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
760              t != t_end;
761              t++)
762         {
763             Xapian::PostingIterator p, p_end;
764             std::string term = *t;
765
766             p_end = notmuch->xapian_db->postlist_end (term);
767
768             for (p = notmuch->xapian_db->postlist_begin (term);
769                  p != p_end;
770                  p++)
771             {
772                 Xapian::Document document;
773                 time_t mtime;
774                 notmuch_directory_t *directory;
775
776                 document = find_document_for_doc_id (notmuch, *p);
777                 mtime = Xapian::sortable_unserialise (
778                     document.get_value (NOTMUCH_VALUE_TIMESTAMP));
779
780                 directory = notmuch_database_get_directory (notmuch,
781                                                             term.c_str() + 10);
782                 notmuch_directory_set_mtime (directory, mtime);
783                 notmuch_directory_destroy (directory);
784             }
785         }
786     }
787
788     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
789     db->flush ();
790
791     if (timer_is_active) {
792         /* Now stop the timer. */
793         timerval.it_interval.tv_sec = 0;
794         timerval.it_interval.tv_usec = 0;
795         timerval.it_value.tv_sec = 0;
796         timerval.it_value.tv_usec = 0;
797         setitimer (ITIMER_REAL, &timerval, NULL);
798
799         /* And disable the signal handler. */
800         action.sa_handler = SIG_IGN;
801         sigaction (SIGALRM, &action, NULL);
802     }
803
804     return NOTMUCH_STATUS_SUCCESS;
805 }
806
807 /* We allow the user to use arbitrarily long paths for directories. But
808  * we have a term-length limit. So if we exceed that, we'll use the
809  * SHA-1 of the path for the database term.
810  *
811  * Note: This function may return the original value of 'path'. If it
812  * does not, then the caller is responsible to free() the returned
813  * value.
814  */
815 const char *
816 _notmuch_database_get_directory_db_path (const char *path)
817 {
818     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
819
820     if (term_len > NOTMUCH_TERM_MAX)
821         return notmuch_sha1_of_string (path);
822     else
823         return path;
824 }
825
826 /* Given a path, split it into two parts: the directory part is all
827  * components except for the last, and the basename is that last
828  * component. Getting the return-value for either part is optional
829  * (the caller can pass NULL).
830  *
831  * The original 'path' can represent either a regular file or a
832  * directory---the splitting will be carried out in the same way in
833  * either case. Trailing slashes on 'path' will be ignored, and any
834  * cases of multiple '/' characters appearing in series will be
835  * treated as a single '/'.
836  *
837  * Allocation (if any) will have 'ctx' as the talloc owner. But
838  * pointers will be returned within the original path string whenever
839  * possible.
840  *
841  * Note: If 'path' is non-empty and contains no non-trailing slash,
842  * (that is, consists of a filename with no parent directory), then
843  * the directory returned will be an empty string. However, if 'path'
844  * is an empty string, then both directory and basename will be
845  * returned as NULL.
846  */
847 notmuch_status_t
848 _notmuch_database_split_path (void *ctx,
849                               const char *path,
850                               const char **directory,
851                               const char **basename)
852 {
853     const char *slash;
854
855     if (path == NULL || *path == '\0') {
856         if (directory)
857             *directory = NULL;
858         if (basename)
859             *basename = NULL;
860         return NOTMUCH_STATUS_SUCCESS;
861     }
862
863     /* Find the last slash (not counting a trailing slash), if any. */
864
865     slash = path + strlen (path) - 1;
866
867     /* First, skip trailing slashes. */
868     while (slash != path) {
869         if (*slash != '/')
870             break;
871
872         --slash;
873     }
874
875     /* Then, find a slash. */
876     while (slash != path) {
877         if (*slash == '/')
878             break;
879
880         if (basename)
881             *basename = slash;
882
883         --slash;
884     }
885
886     /* Finally, skip multiple slashes. */
887     while (slash != path) {
888         if (*slash != '/')
889             break;
890
891         --slash;
892     }
893
894     if (slash == path) {
895         if (directory)
896             *directory = talloc_strdup (ctx, "");
897         if (basename)
898             *basename = path;
899     } else {
900         if (directory)
901             *directory = talloc_strndup (ctx, path, slash - path + 1);
902     }
903
904     return NOTMUCH_STATUS_SUCCESS;
905 }
906
907 notmuch_status_t
908 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
909                                      const char *path,
910                                      unsigned int *directory_id)
911 {
912     notmuch_directory_t *directory;
913     notmuch_status_t status;
914
915     if (path == NULL) {
916         *directory_id = 0;
917         return NOTMUCH_STATUS_SUCCESS;
918     }
919
920     directory = _notmuch_directory_create (notmuch, path, &status);
921     if (status) {
922         *directory_id = -1;
923         return status;
924     }
925
926     *directory_id = _notmuch_directory_get_document_id (directory);
927
928     notmuch_directory_destroy (directory);
929
930     return NOTMUCH_STATUS_SUCCESS;
931 }
932
933 const char *
934 _notmuch_database_get_directory_path (void *ctx,
935                                       notmuch_database_t *notmuch,
936                                       unsigned int doc_id)
937 {
938     Xapian::Document document;
939
940     document = find_document_for_doc_id (notmuch, doc_id);
941
942     return talloc_strdup (ctx, document.get_data ().c_str ());
943 }
944
945 /* Given a legal 'filename' for the database, (either relative to
946  * database path or absolute with initial components identical to
947  * database path), return a new string (with 'ctx' as the talloc
948  * owner) suitable for use as a direntry term value.
949  *
950  * The necessary directory documents will be created in the database
951  * as needed.
952  */
953 notmuch_status_t
954 _notmuch_database_filename_to_direntry (void *ctx,
955                                         notmuch_database_t *notmuch,
956                                         const char *filename,
957                                         char **direntry)
958 {
959     const char *relative, *directory, *basename;
960     Xapian::docid directory_id;
961     notmuch_status_t status;
962
963     relative = _notmuch_database_relative_path (notmuch, filename);
964
965     status = _notmuch_database_split_path (ctx, relative,
966                                            &directory, &basename);
967     if (status)
968         return status;
969
970     status = _notmuch_database_find_directory_id (notmuch, directory,
971                                                   &directory_id);
972     if (status)
973         return status;
974
975     *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
976
977     return NOTMUCH_STATUS_SUCCESS;
978 }
979
980 /* Given a legal 'path' for the database, return the relative path.
981  *
982  * The return value will be a pointer to the originl path contents,
983  * and will be either the original string (if 'path' was relative) or
984  * a portion of the string (if path was absolute and begins with the
985  * database path).
986  */
987 const char *
988 _notmuch_database_relative_path (notmuch_database_t *notmuch,
989                                  const char *path)
990 {
991     const char *db_path, *relative;
992     unsigned int db_path_len;
993
994     db_path = notmuch_database_get_path (notmuch);
995     db_path_len = strlen (db_path);
996
997     relative = path;
998
999     if (*relative == '/') {
1000         while (*relative == '/' && *(relative+1) == '/')
1001             relative++;
1002
1003         if (strncmp (relative, db_path, db_path_len) == 0)
1004         {
1005             relative += db_path_len;
1006             while (*relative == '/')
1007                 relative++;
1008         }
1009     }
1010
1011     return relative;
1012 }
1013
1014 notmuch_directory_t *
1015 notmuch_database_get_directory (notmuch_database_t *notmuch,
1016                                 const char *path)
1017 {
1018     notmuch_status_t status;
1019
1020     return _notmuch_directory_create (notmuch, path, &status);
1021 }
1022
1023 /* Find the thread ID to which the message with 'message_id' belongs.
1024  *
1025  * Returns NULL if no message with message ID 'message_id' is in the
1026  * database.
1027  *
1028  * Otherwise, returns a newly talloced string belonging to 'ctx'.
1029  */
1030 static const char *
1031 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1032                                   void *ctx,
1033                                   const char *message_id)
1034 {
1035     notmuch_message_t *message;
1036     const char *ret = NULL;
1037
1038     message = notmuch_database_find_message (notmuch, message_id);
1039     if (message == NULL)
1040         goto DONE;
1041
1042     ret = talloc_steal (ctx, notmuch_message_get_thread_id (message));
1043
1044   DONE:
1045     if (message)
1046         notmuch_message_destroy (message);
1047
1048     return ret;
1049 }
1050
1051 static notmuch_status_t
1052 _merge_threads (notmuch_database_t *notmuch,
1053                 const char *winner_thread_id,
1054                 const char *loser_thread_id)
1055 {
1056     Xapian::PostingIterator loser, loser_end;
1057     notmuch_message_t *message = NULL;
1058     notmuch_private_status_t private_status;
1059     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1060
1061     find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1062
1063     for ( ; loser != loser_end; loser++) {
1064         message = _notmuch_message_create (notmuch, notmuch,
1065                                            *loser, &private_status);
1066         if (message == NULL) {
1067             ret = COERCE_STATUS (private_status,
1068                                  "Cannot find document for doc_id from query");
1069             goto DONE;
1070         }
1071
1072         _notmuch_message_remove_term (message, "thread", loser_thread_id);
1073         _notmuch_message_add_term (message, "thread", winner_thread_id);
1074         _notmuch_message_sync (message);
1075
1076         notmuch_message_destroy (message);
1077         message = NULL;
1078     }
1079
1080   DONE:
1081     if (message)
1082         notmuch_message_destroy (message);
1083
1084     return ret;
1085 }
1086
1087 static void
1088 _my_talloc_free_for_g_hash (void *ptr)
1089 {
1090     talloc_free (ptr);
1091 }
1092
1093 static notmuch_status_t
1094 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1095                                            notmuch_message_t *message,
1096                                            notmuch_message_file_t *message_file,
1097                                            const char **thread_id)
1098 {
1099     GHashTable *parents = NULL;
1100     const char *refs, *in_reply_to, *in_reply_to_message_id;
1101     GList *l, *keys = NULL;
1102     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1103
1104     parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1105                                      _my_talloc_free_for_g_hash, NULL);
1106
1107     refs = notmuch_message_file_get_header (message_file, "references");
1108     parse_references (message, notmuch_message_get_message_id (message),
1109                       parents, refs);
1110
1111     in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1112     parse_references (message, notmuch_message_get_message_id (message),
1113                       parents, in_reply_to);
1114
1115     /* Carefully avoid adding any self-referential in-reply-to term. */
1116     in_reply_to_message_id = _parse_message_id (message, in_reply_to, NULL);
1117     if (in_reply_to_message_id &&
1118         strcmp (in_reply_to_message_id,
1119                 notmuch_message_get_message_id (message)))
1120     {
1121         _notmuch_message_add_term (message, "replyto",
1122                              _parse_message_id (message, in_reply_to, NULL));
1123     }
1124
1125     keys = g_hash_table_get_keys (parents);
1126     for (l = keys; l; l = l->next) {
1127         char *parent_message_id;
1128         const char *parent_thread_id;
1129
1130         parent_message_id = (char *) l->data;
1131         parent_thread_id = _resolve_message_id_to_thread_id (notmuch,
1132                                                              message,
1133                                                              parent_message_id);
1134
1135         if (parent_thread_id == NULL) {
1136             _notmuch_message_add_term (message, "reference",
1137                                        parent_message_id);
1138         } else {
1139             if (*thread_id == NULL) {
1140                 *thread_id = talloc_strdup (message, parent_thread_id);
1141                 _notmuch_message_add_term (message, "thread", *thread_id);
1142             } else if (strcmp (*thread_id, parent_thread_id)) {
1143                 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1144                 if (ret)
1145                     goto DONE;
1146             }
1147         }
1148     }
1149
1150   DONE:
1151     if (keys)
1152         g_list_free (keys);
1153     if (parents)
1154         g_hash_table_unref (parents);
1155
1156     return ret;
1157 }
1158
1159 static notmuch_status_t
1160 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1161                                             notmuch_message_t *message,
1162                                             const char **thread_id)
1163 {
1164     const char *message_id = notmuch_message_get_message_id (message);
1165     Xapian::PostingIterator child, children_end;
1166     notmuch_message_t *child_message = NULL;
1167     const char *child_thread_id;
1168     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1169     notmuch_private_status_t private_status;
1170
1171     find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1172
1173     for ( ; child != children_end; child++) {
1174
1175         child_message = _notmuch_message_create (message, notmuch,
1176                                                  *child, &private_status);
1177         if (child_message == NULL) {
1178             ret = COERCE_STATUS (private_status,
1179                                  "Cannot find document for doc_id from query");
1180             goto DONE;
1181         }
1182
1183         child_thread_id = notmuch_message_get_thread_id (child_message);
1184         if (*thread_id == NULL) {
1185             *thread_id = talloc_strdup (message, child_thread_id);
1186             _notmuch_message_add_term (message, "thread", *thread_id);
1187         } else if (strcmp (*thread_id, child_thread_id)) {
1188             _notmuch_message_remove_term (child_message, "reference",
1189                                           message_id);
1190             _notmuch_message_sync (child_message);
1191             ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1192             if (ret)
1193                 goto DONE;
1194         }
1195
1196         notmuch_message_destroy (child_message);
1197         child_message = NULL;
1198     }
1199
1200   DONE:
1201     if (child_message)
1202         notmuch_message_destroy (child_message);
1203
1204     return ret;
1205 }
1206
1207 /* Given a (mostly empty) 'message' and its corresponding
1208  * 'message_file' link it to existing threads in the database.
1209  *
1210  * We first look at 'message_file' and its link-relevant headers
1211  * (References and In-Reply-To) for message IDs. We also look in the
1212  * database for existing message that reference 'message'.
1213  *
1214  * The end result is to call _notmuch_message_ensure_thread_id which
1215  * generates a new thread ID if the message doesn't connect to any
1216  * existing threads.
1217  */
1218 static notmuch_status_t
1219 _notmuch_database_link_message (notmuch_database_t *notmuch,
1220                                 notmuch_message_t *message,
1221                                 notmuch_message_file_t *message_file)
1222 {
1223     notmuch_status_t status;
1224     const char *thread_id = NULL;
1225
1226     status = _notmuch_database_link_message_to_parents (notmuch, message,
1227                                                         message_file,
1228                                                         &thread_id);
1229     if (status)
1230         return status;
1231
1232     status = _notmuch_database_link_message_to_children (notmuch, message,
1233                                                          &thread_id);
1234     if (status)
1235         return status;
1236
1237     if (thread_id == NULL)
1238         _notmuch_message_ensure_thread_id (message);
1239
1240     return NOTMUCH_STATUS_SUCCESS;
1241 }
1242
1243 notmuch_status_t
1244 notmuch_database_add_message (notmuch_database_t *notmuch,
1245                               const char *filename,
1246                               notmuch_message_t **message_ret)
1247 {
1248     notmuch_message_file_t *message_file;
1249     notmuch_message_t *message = NULL;
1250     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1251     notmuch_private_status_t private_status;
1252
1253     const char *date, *header;
1254     const char *from, *to, *subject;
1255     char *message_id = NULL;
1256
1257     if (message_ret)
1258         *message_ret = NULL;
1259
1260     ret = _notmuch_database_ensure_writable (notmuch);
1261     if (ret)
1262         return ret;
1263
1264     message_file = notmuch_message_file_open (filename);
1265     if (message_file == NULL)
1266         return NOTMUCH_STATUS_FILE_ERROR;
1267
1268     notmuch_message_file_restrict_headers (message_file,
1269                                            "date",
1270                                            "from",
1271                                            "in-reply-to",
1272                                            "message-id",
1273                                            "references",
1274                                            "subject",
1275                                            "to",
1276                                            (char *) NULL);
1277
1278     try {
1279         /* Before we do any real work, (especially before doing a
1280          * potential SHA-1 computation on the entire file's contents),
1281          * let's make sure that what we're looking at looks like an
1282          * actual email message.
1283          */
1284         from = notmuch_message_file_get_header (message_file, "from");
1285         subject = notmuch_message_file_get_header (message_file, "subject");
1286         to = notmuch_message_file_get_header (message_file, "to");
1287
1288         if ((from == NULL || *from == '\0') &&
1289             (subject == NULL || *subject == '\0') &&
1290             (to == NULL || *to == '\0'))
1291         {
1292             ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1293             goto DONE;
1294         }
1295
1296         /* Now that we're sure it's mail, the first order of business
1297          * is to find a message ID (or else create one ourselves). */
1298
1299         header = notmuch_message_file_get_header (message_file, "message-id");
1300         if (header && *header != '\0') {
1301             message_id = _parse_message_id (message_file, header, NULL);
1302
1303             /* So the header value isn't RFC-compliant, but it's
1304              * better than no message-id at all. */
1305             if (message_id == NULL)
1306                 message_id = talloc_strdup (message_file, header);
1307
1308             /* Reject a Message ID that's too long. */
1309             if (message_id && strlen (message_id) + 1 > NOTMUCH_TERM_MAX) {
1310                 talloc_free (message_id);
1311                 message_id = NULL;
1312             }
1313         }
1314
1315         if (message_id == NULL ) {
1316             /* No message-id at all, let's generate one by taking a
1317              * hash over the file's contents. */
1318             char *sha1 = notmuch_sha1_of_file (filename);
1319
1320             /* If that failed too, something is really wrong. Give up. */
1321             if (sha1 == NULL) {
1322                 ret = NOTMUCH_STATUS_FILE_ERROR;
1323                 goto DONE;
1324             }
1325
1326             message_id = talloc_asprintf (message_file,
1327                                           "notmuch-sha1-%s", sha1);
1328             free (sha1);
1329         }
1330
1331         /* Now that we have a message ID, we get a message object,
1332          * (which may or may not reference an existing document in the
1333          * database). */
1334
1335         message = _notmuch_message_create_for_message_id (notmuch,
1336                                                           message_id,
1337                                                           &private_status);
1338
1339         talloc_free (message_id);
1340
1341         if (message == NULL) {
1342             ret = COERCE_STATUS (private_status,
1343                                  "Unexpected status value from _notmuch_message_create_for_message_id");
1344             goto DONE;
1345         }
1346
1347         _notmuch_message_add_filename (message, filename);
1348
1349         /* Is this a newly created message object? */
1350         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1351             _notmuch_message_add_term (message, "type", "mail");
1352
1353             ret = _notmuch_database_link_message (notmuch, message,
1354                                                   message_file);
1355             if (ret)
1356                 goto DONE;
1357
1358             date = notmuch_message_file_get_header (message_file, "date");
1359             _notmuch_message_set_date (message, date);
1360
1361             _notmuch_message_index_file (message, filename);
1362         } else {
1363             ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1364         }
1365
1366         _notmuch_message_sync (message);
1367     } catch (const Xapian::Error &error) {
1368         fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
1369                  error.get_description().c_str());
1370         notmuch->exception_reported = TRUE;
1371         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1372         goto DONE;
1373     }
1374
1375   DONE:
1376     if (message) {
1377         if (ret == NOTMUCH_STATUS_SUCCESS && message_ret)
1378             *message_ret = message;
1379         else
1380             notmuch_message_destroy (message);
1381     }
1382
1383     if (message_file)
1384         notmuch_message_file_close (message_file);
1385
1386     return ret;
1387 }
1388
1389 notmuch_status_t
1390 notmuch_database_remove_message (notmuch_database_t *notmuch,
1391                                  const char *filename)
1392 {
1393     Xapian::WritableDatabase *db;
1394     void *local = talloc_new (notmuch);
1395     const char *prefix = _find_prefix ("file-direntry");
1396     char *direntry, *term;
1397     Xapian::PostingIterator i, end;
1398     Xapian::Document document;
1399     notmuch_status_t status;
1400
1401     status = _notmuch_database_ensure_writable (notmuch);
1402     if (status)
1403         return status;
1404
1405     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1406
1407     status = _notmuch_database_filename_to_direntry (local, notmuch,
1408                                                      filename, &direntry);
1409     if (status)
1410         return status;
1411
1412     term = talloc_asprintf (notmuch, "%s%s", prefix, direntry);
1413
1414     find_doc_ids_for_term (notmuch, term, &i, &end);
1415
1416     for ( ; i != end; i++) {
1417         Xapian::TermIterator j;
1418
1419         document = find_document_for_doc_id (notmuch, *i);
1420
1421         document.remove_term (term);
1422
1423         j = document.termlist_begin ();
1424         j.skip_to (prefix);
1425
1426         /* Was this the last file-direntry in the message? */
1427         if (j == document.termlist_end () ||
1428             strncmp ((*j).c_str (), prefix, strlen (prefix)))
1429         {
1430             db->delete_document (document.get_docid ());
1431             status = NOTMUCH_STATUS_SUCCESS;
1432         } else {
1433             db->replace_document (document.get_docid (), document);
1434             status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1435         }
1436     }
1437
1438     talloc_free (local);
1439
1440     return status;
1441 }
1442
1443 notmuch_tags_t *
1444 _notmuch_convert_tags (void *ctx, Xapian::TermIterator &i,
1445                        Xapian::TermIterator &end)
1446 {
1447     const char *prefix = _find_prefix ("tag");
1448     notmuch_tags_t *tags;
1449     std::string tag;
1450
1451     /* Currently this iteration is written with the assumption that
1452      * "tag" has a single-character prefix. */
1453     assert (strlen (prefix) == 1);
1454
1455     tags = _notmuch_tags_create (ctx);
1456     if (unlikely (tags == NULL))
1457         return NULL;
1458
1459     i.skip_to (prefix);
1460
1461     while (i != end) {
1462         tag = *i;
1463
1464         if (tag.empty () || tag[0] != *prefix)
1465             break;
1466
1467         _notmuch_tags_add_tag (tags, tag.c_str () + 1);
1468
1469         i++;
1470     }
1471
1472     _notmuch_tags_prepare_iterator (tags);
1473
1474     return tags;
1475 }
1476
1477 notmuch_tags_t *
1478 notmuch_database_get_all_tags (notmuch_database_t *db)
1479 {
1480     Xapian::TermIterator i, end;
1481     i = db->xapian_db->allterms_begin();
1482     end = db->xapian_db->allterms_end();
1483     return _notmuch_convert_tags(db, i, end);
1484 }