lib/database: delete stemmer on destroy
[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 https://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #include "database-private.h"
22 #include "string-util.h"
23
24 #include <iostream>
25
26 #include <sys/time.h>
27 #include <sys/stat.h>
28 #include <signal.h>
29 #include <ftw.h>
30
31 #include <glib.h>               /* g_free, GPtrArray, GHashTable */
32 #include <glib-object.h>        /* g_type_init */
33
34 #include <gmime/gmime.h>        /* g_mime_init */
35
36 using namespace std;
37
38 typedef struct {
39     const char *name;
40     const char *prefix;
41     notmuch_field_flag_t flags;
42 } prefix_t;
43
44 #define NOTMUCH_DATABASE_VERSION 3
45
46 #define STRINGIFY(s) _SUB_STRINGIFY (s)
47 #define _SUB_STRINGIFY(s) #s
48
49 #define LOG_XAPIAN_EXCEPTION(message, error) _log_xapian_exception (__location__, message, error)
50
51 static void
52 _log_xapian_exception (const char *where, notmuch_database_t *notmuch,  const Xapian::Error error)
53 {
54     _notmuch_database_log (notmuch,
55                            "A Xapian exception occurred at %s: %s\n",
56                            where,
57                            error.get_msg ().c_str ());
58     notmuch->exception_reported = true;
59 }
60
61 notmuch_database_mode_t
62 _notmuch_database_mode (notmuch_database_t *notmuch)
63 {
64     if (notmuch->writable_xapian_db)
65         return NOTMUCH_DATABASE_MODE_READ_WRITE;
66     else
67         return NOTMUCH_DATABASE_MODE_READ_ONLY;
68 }
69
70 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
71  *
72  * We currently have three different types of documents (mail, ghost,
73  * and directory) and also some metadata.
74  *
75  * There are two kinds of prefixes used in notmuch. There are the
76  * human friendly 'prefix names' like "thread:", which are also used
77  * in the query parser, and the actual prefix terms in the database
78  * (e.g. "G"). The correspondence is maintained in the file scope data
79  * structure 'prefix_table'.
80  *
81  * Mail document
82  * -------------
83  * A mail document is associated with a particular email message. It
84  * is stored in one or more files on disk and is uniquely identified
85  * by its "id" field (which is generally the message ID). It is
86  * indexed with the following prefixed terms which the database uses
87  * to construct threads, etc.:
88  *
89  *    Single terms of given prefix:
90  *
91  *      type:   mail
92  *
93  *      id:     Unique ID of mail. This is from the Message-ID header
94  *              if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
95  *              If it's present and too long, then we use
96  *              "notmuch-sha1-<sha1_sum_of_message_id>".
97  *              If this header is not present, we use
98  *              "notmuch-sha1-<sha1_sum_of_entire_file>".
99  *
100  *      thread: The ID of the thread to which the mail belongs
101  *
102  *      replyto: The ID from the In-Reply-To header of the mail (if any).
103  *
104  *    Multiple terms of given prefix:
105  *
106  *      reference: All message IDs from In-Reply-To and References
107  *                 headers in the message.
108  *
109  *      tag:       Any tags associated with this message by the user.
110  *
111  *      file-direntry:  A colon-separated pair of values
112  *                      (INTEGER:STRING), where INTEGER is the
113  *                      document ID of a directory document, and
114  *                      STRING is the name of a file within that
115  *                      directory for this mail message.
116  *
117  *      property:       Has a property with key=value
118  *                 FIXME: if no = is present, should match on any value
119  *
120  *    A mail document also has four values:
121  *
122  *      TIMESTAMP:      The time_t value corresponding to the message's
123  *                      Date header.
124  *
125  *      MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
126  *
127  *      FROM:           The value of the "From" header
128  *
129  *      SUBJECT:        The value of the "Subject" header
130  *
131  *      LAST_MOD:       The revision number as of the last tag or
132  *                      filename change.
133  *
134  * The prefixed terms described above are also searchable without an
135  * explicit field name, but as of notmuch 0.29 this is due to
136  * query-parser setup, not extra terms in the database.  In addition,
137  * terms from the content of the message are added without a prefix
138  * for use by the user in searching. Note that the prefix name "body"
139  * is used to refer to the empty prefix string in the database.
140  *
141  * The path of the containing folder is added with the "folder" prefix
142  * (see _notmuch_message_add_folder_terms).  Sub-paths of the the path
143  * of the mail message are added with the "path" prefix.
144  *
145  * The data portion of a mail document is empty.
146  *
147  * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
148  * -----------------------------------------------
149  * A ghost mail document is like a mail document, but where we don't
150  * have the message content.  These are used to track thread reference
151  * information for messages we haven't received.
152  *
153  * A ghost mail document has type: ghost; id and thread fields that
154  * are identical to the mail document fields; and a MESSAGE_ID value.
155  *
156  * Directory document
157  * ------------------
158  * A directory document is used by a client of the notmuch library to
159  * maintain data necessary to allow for efficient polling of mail
160  * directories.
161  *
162  * All directory documents contain one term:
163  *
164  *      directory:      The directory path (relative to the database path)
165  *                      Or the SHA1 sum of the directory path (if the
166  *                      path itself is too long to fit in a Xapian
167  *                      term).
168  *
169  * And all directory documents for directories other than top-level
170  * directories also contain the following term:
171  *
172  *      directory-direntry: A colon-separated pair of values
173  *                          (INTEGER:STRING), where INTEGER is the
174  *                          document ID of the parent directory
175  *                          document, and STRING is the name of this
176  *                          directory within that parent.
177  *
178  * All directory documents have a single value:
179  *
180  *      TIMESTAMP:      The mtime of the directory (at last scan)
181  *
182  * The data portion of a directory document contains the path of the
183  * directory (relative to the database path).
184  *
185  * Database metadata
186  * -----------------
187  * Xapian allows us to store arbitrary name-value pairs as
188  * "metadata". We currently use the following metadata names with the
189  * given meanings:
190  *
191  *      version         The database schema version, (which is distinct
192  *                      from both the notmuch package version (see
193  *                      notmuch --version) and the libnotmuch library
194  *                      version. The version is stored as an base-10
195  *                      ASCII integer. The initial database version
196  *                      was 1, (though a schema existed before that
197  *                      were no "version" database value existed at
198  *                      all). Successive versions are allocated as
199  *                      changes are made to the database (such as by
200  *                      indexing new fields).
201  *
202  *      features        The set of features supported by this
203  *                      database. This consists of a set of
204  *                      '\n'-separated lines, where each is a feature
205  *                      name, a '\t', and compatibility flags.  If the
206  *                      compatibility flags contain 'w', then the
207  *                      opener must support this feature to safely
208  *                      write this database.  If the compatibility
209  *                      flags contain 'r', then the opener must
210  *                      support this feature to read this database.
211  *                      Introduced in database version 3.
212  *
213  *      last_thread_id  The last thread ID generated. This is stored
214  *                      as a 16-byte hexadecimal ASCII representation
215  *                      of a 64-bit unsigned integer. The first ID
216  *                      generated is 1 and the value will be
217  *                      incremented for each thread ID.
218  *
219  *      C*              metadata keys starting with C indicate
220  *                      configuration data. It can be managed with the
221  *                      n_database_*config* API.  There is a convention
222  *                      of hierarchical keys separated by '.' (e.g.
223  *                      query.notmuch stores the value for the named
224  *                      query 'notmuch'), but it is not enforced by the
225  *                      API.
226  *
227  * Obsolete metadata
228  * -----------------
229  *
230  * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
231  * Instead, the database has the following additional database
232  * metadata:
233  *
234  *      thread_id_*     A pre-allocated thread ID for a particular
235  *                      message. This is actually an arbitrarily large
236  *                      family of metadata name. Any particular name is
237  *                      formed by concatenating "thread_id_" with a message
238  *                      ID (or the SHA1 sum of a message ID if it is very
239  *                      long---see description of 'id' in the mail
240  *                      document). The value stored is a thread ID.
241  *
242  *                      These thread ID metadata values are stored
243  *                      whenever a message references a parent message
244  *                      that does not yet exist in the database. A
245  *                      thread ID will be allocated and stored, and if
246  *                      the message is later added, the stored thread
247  *                      ID will be used (and the metadata value will
248  *                      be cleared).
249  *
250  *                      Even before a message is added, it's
251  *                      pre-allocated thread ID is useful so that all
252  *                      descendant messages that reference this common
253  *                      parent can be recognized as belonging to the
254  *                      same thread.
255  */
256
257
258 notmuch_string_map_iterator_t *
259 _notmuch_database_user_headers (notmuch_database_t *notmuch)
260 {
261     return _notmuch_string_map_iterator_create (notmuch->user_header, "", false);
262 }
263
264 const char *
265 notmuch_status_to_string (notmuch_status_t status)
266 {
267     switch (status) {
268     case NOTMUCH_STATUS_SUCCESS:
269         return "No error occurred";
270     case NOTMUCH_STATUS_OUT_OF_MEMORY:
271         return "Out of memory";
272     case NOTMUCH_STATUS_READ_ONLY_DATABASE:
273         return "Attempt to write to a read-only database";
274     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
275         return "A Xapian exception occurred";
276     case NOTMUCH_STATUS_FILE_ERROR:
277         return "Something went wrong trying to read or write a file";
278     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
279         return "File is not an email";
280     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
281         return "Message ID is identical to a message in database";
282     case NOTMUCH_STATUS_NULL_POINTER:
283         return "Erroneous NULL pointer";
284     case NOTMUCH_STATUS_TAG_TOO_LONG:
285         return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
286     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
287         return "Unbalanced number of calls to notmuch_message_freeze/thaw";
288     case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
289         return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
290     case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
291         return "Unsupported operation";
292     case NOTMUCH_STATUS_UPGRADE_REQUIRED:
293         return "Operation requires a database upgrade";
294     case NOTMUCH_STATUS_PATH_ERROR:
295         return "Path supplied is illegal for this function";
296     case NOTMUCH_STATUS_IGNORED:
297         return "Argument was ignored";
298     case NOTMUCH_STATUS_ILLEGAL_ARGUMENT:
299         return "Illegal argument for function";
300     case NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL:
301         return "Crypto protocol missing, malformed, or unintelligible";
302     case NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION:
303         return "Crypto engine initialization failure";
304     case NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL:
305         return "Unknown crypto protocol";
306     case NOTMUCH_STATUS_NO_CONFIG:
307         return "No configuration file found";
308     case NOTMUCH_STATUS_NO_DATABASE:
309         return "No database found";
310     case NOTMUCH_STATUS_DATABASE_EXISTS:
311         return "Database exists, not recreated";
312     case NOTMUCH_STATUS_BAD_QUERY_SYNTAX:
313         return "Syntax error in query";
314     case NOTMUCH_STATUS_NO_MAIL_ROOT:
315         return "No mail root found";
316     default:
317     case NOTMUCH_STATUS_LAST_STATUS:
318         return "Unknown error status value";
319     }
320 }
321
322 void
323 _notmuch_database_log (notmuch_database_t *notmuch,
324                        const char *format,
325                        ...)
326 {
327     va_list va_args;
328
329     va_start (va_args, format);
330
331     if (notmuch->status_string)
332         talloc_free (notmuch->status_string);
333
334     notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
335     va_end (va_args);
336 }
337
338 void
339 _notmuch_database_log_append (notmuch_database_t *notmuch,
340                               const char *format,
341                               ...)
342 {
343     va_list va_args;
344
345     va_start (va_args, format);
346
347     if (notmuch->status_string)
348         notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
349     else
350         notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
351
352     va_end (va_args);
353 }
354
355 static void
356 find_doc_ids_for_term (notmuch_database_t *notmuch,
357                        const char *term,
358                        Xapian::PostingIterator *begin,
359                        Xapian::PostingIterator *end)
360 {
361     *begin = notmuch->xapian_db->postlist_begin (term);
362
363     *end = notmuch->xapian_db->postlist_end (term);
364 }
365
366 void
367 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
368                                 const char *prefix_name,
369                                 const char *value,
370                                 Xapian::PostingIterator *begin,
371                                 Xapian::PostingIterator *end)
372 {
373     char *term;
374
375     term = talloc_asprintf (notmuch, "%s%s",
376                             _find_prefix (prefix_name), value);
377
378     find_doc_ids_for_term (notmuch, term, begin, end);
379
380     talloc_free (term);
381 }
382
383 notmuch_private_status_t
384 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
385                                       const char *prefix_name,
386                                       const char *value,
387                                       unsigned int *doc_id)
388 {
389     Xapian::PostingIterator i, end;
390
391     _notmuch_database_find_doc_ids (notmuch, prefix_name, value, &i, &end);
392
393     if (i == end) {
394         *doc_id = 0;
395         return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
396     }
397
398     *doc_id = *i;
399
400 #if DEBUG_DATABASE_SANITY
401     i++;
402
403     if (i != end)
404         INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
405                         prefix_name, value);
406 #endif
407
408     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
409 }
410
411 static Xapian::Document
412 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
413 {
414     return notmuch->xapian_db->get_document (doc_id);
415 }
416
417 /* Generate a compressed version of 'message_id' of the form:
418  *
419  *      notmuch-sha1-<sha1_sum_of_message_id>
420  */
421 char *
422 _notmuch_message_id_compressed (void *ctx, const char *message_id)
423 {
424     char *sha1, *compressed;
425
426     sha1 = _notmuch_sha1_of_string (message_id);
427
428     compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
429     free (sha1);
430
431     return compressed;
432 }
433
434 notmuch_status_t
435 notmuch_database_find_message (notmuch_database_t *notmuch,
436                                const char *message_id,
437                                notmuch_message_t **message_ret)
438 {
439     notmuch_private_status_t status;
440     unsigned int doc_id;
441
442     if (message_ret == NULL)
443         return NOTMUCH_STATUS_NULL_POINTER;
444
445     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
446         message_id = _notmuch_message_id_compressed (notmuch, message_id);
447
448     try {
449         status = _notmuch_database_find_unique_doc_id (notmuch, "id",
450                                                        message_id, &doc_id);
451
452         if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
453             *message_ret = NULL;
454         else {
455             *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
456                                                     NULL);
457             if (*message_ret == NULL)
458                 return NOTMUCH_STATUS_OUT_OF_MEMORY;
459         }
460
461         return NOTMUCH_STATUS_SUCCESS;
462     } catch (const Xapian::Error &error) {
463         _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
464                                error.get_msg ().c_str ());
465         notmuch->exception_reported = true;
466         *message_ret = NULL;
467         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
468     }
469 }
470
471 notmuch_status_t
472 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
473 {
474     if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY) {
475         _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
476         return NOTMUCH_STATUS_READ_ONLY_DATABASE;
477     }
478
479     return NOTMUCH_STATUS_SUCCESS;
480 }
481
482 /* Allocate a revision number for the next change. */
483 unsigned long
484 _notmuch_database_new_revision (notmuch_database_t *notmuch)
485 {
486     unsigned long new_revision = notmuch->revision + 1;
487
488     /* If we're in an atomic section, hold off on updating the
489      * committed revision number until we commit the atomic section.
490      */
491     if (notmuch->atomic_nesting)
492         notmuch->atomic_dirty = true;
493     else
494         notmuch->revision = new_revision;
495
496     return new_revision;
497 }
498
499 notmuch_status_t
500 notmuch_database_close (notmuch_database_t *notmuch)
501 {
502     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
503
504     /* Many Xapian objects (and thus notmuch objects) hold references to
505      * the database, so merely deleting the database may not suffice to
506      * close it.  Thus, we explicitly close it here. */
507     if (notmuch->open) {
508         try {
509             /* Close the database.  This implicitly flushes
510              * outstanding changes. If there is an open (non-flushed)
511              * transaction, ALL pending changes will be discarded */
512             notmuch->xapian_db->close ();
513         } catch (const Xapian::Error &error) {
514             status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
515             if (! notmuch->exception_reported) {
516                 _notmuch_database_log (notmuch,
517                                        "Error: A Xapian exception occurred closing database: %s\n",
518                                        error.get_msg ().c_str ());
519             }
520         }
521     }
522     notmuch->open = false;
523     return status;
524 }
525
526 static int
527 unlink_cb (const char *path,
528            unused (const struct stat *sb),
529            unused (int type),
530            unused (struct FTW *ftw))
531 {
532     return remove (path);
533 }
534
535 static int
536 rmtree (const char *path)
537 {
538     return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
539 }
540
541 class NotmuchCompactor : public Xapian::Compactor
542 {
543     notmuch_compact_status_cb_t status_cb;
544     void *status_closure;
545
546 public:
547     NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
548         status_cb (cb), status_closure (closure)
549     {
550     }
551
552     virtual void
553     set_status (const std::string &table, const std::string &status)
554     {
555         char *msg;
556
557         if (status_cb == NULL)
558             return;
559
560         if (status.length () == 0)
561             msg = talloc_asprintf (NULL, "compacting table %s", table.c_str ());
562         else
563             msg = talloc_asprintf (NULL, "     %s", status.c_str ());
564
565         if (msg == NULL) {
566             return;
567         }
568
569         status_cb (msg, status_closure);
570         talloc_free (msg);
571     }
572 };
573
574 /* Compacts the given database, optionally saving the original database
575  * in backup_path. Additionally, a callback function can be provided to
576  * give the user feedback on the progress of the (likely long-lived)
577  * compaction process.
578  *
579  * The backup path must point to a directory on the same volume as the
580  * original database. Passing a NULL backup_path will result in the
581  * uncompacted database being deleted after compaction has finished.
582  * Note that the database write lock will be held during the
583  * compaction process to protect data integrity.
584  */
585 notmuch_status_t
586 notmuch_database_compact (const char *path,
587                           const char *backup_path,
588                           notmuch_compact_status_cb_t status_cb,
589                           void *closure)
590 {
591     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
592     notmuch_database_t *notmuch = NULL;
593     char *message = NULL;
594
595     ret = notmuch_database_open_with_config (path,
596                                              NOTMUCH_DATABASE_MODE_READ_WRITE,
597                                              "",
598                                              NULL,
599                                              &notmuch,
600                                              &message);
601     if (ret) {
602         if (status_cb) status_cb (message, closure);
603         return ret;
604     }
605
606     _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
607
608     return notmuch_database_compact_db (notmuch,
609                                         backup_path,
610                                         status_cb,
611                                         closure);
612 }
613
614 notmuch_status_t
615 notmuch_database_compact_db (notmuch_database_t *notmuch,
616                              const char *backup_path,
617                              notmuch_compact_status_cb_t status_cb,
618                              void *closure)
619 {
620     void *local;
621     const char *xapian_path, *compact_xapian_path;
622     const char *path;
623     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
624     struct stat statbuf;
625     bool keep_backup;
626     char *message;
627
628     ret = _notmuch_database_ensure_writable (notmuch);
629     if (ret)
630         return ret;
631
632     path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
633     if (! path)
634         return NOTMUCH_STATUS_PATH_ERROR;
635
636     local = talloc_new (NULL);
637     if (! local)
638         return NOTMUCH_STATUS_OUT_OF_MEMORY;
639
640     ret = _notmuch_choose_xapian_path (local, path, &xapian_path, &message);
641     if (ret)
642         goto DONE;
643
644     if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
645         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
646         goto DONE;
647     }
648
649     if (backup_path == NULL) {
650         if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
651             ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
652             goto DONE;
653         }
654         keep_backup = false;
655     } else {
656         keep_backup = true;
657     }
658
659     if (stat (backup_path, &statbuf) != -1) {
660         _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
661         ret = NOTMUCH_STATUS_FILE_ERROR;
662         goto DONE;
663     }
664     if (errno != ENOENT) {
665         _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
666                                strerror (errno));
667         ret = NOTMUCH_STATUS_FILE_ERROR;
668         goto DONE;
669     }
670
671     /* Unconditionally attempt to remove old work-in-progress database (if
672      * any). This is "protected" by database lock. If this fails due to write
673      * errors (etc), the following code will fail and provide error message.
674      */
675     (void) rmtree (compact_xapian_path);
676
677     try {
678         NotmuchCompactor compactor (status_cb, closure);
679         notmuch->xapian_db->compact (compact_xapian_path, Xapian::DBCOMPACT_NO_RENUMBER, 0,
680                                      compactor);
681     } catch (const Xapian::Error &error) {
682         _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg ().c_str ());
683         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
684         goto DONE;
685     }
686
687     if (rename (xapian_path, backup_path)) {
688         _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
689                                xapian_path, backup_path, strerror (errno));
690         ret = NOTMUCH_STATUS_FILE_ERROR;
691         goto DONE;
692     }
693
694     if (rename (compact_xapian_path, xapian_path)) {
695         _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
696                                compact_xapian_path, xapian_path, strerror (errno));
697         ret = NOTMUCH_STATUS_FILE_ERROR;
698         goto DONE;
699     }
700
701     if (! keep_backup) {
702         if (rmtree (backup_path)) {
703             _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
704                                    backup_path, strerror (errno));
705             ret = NOTMUCH_STATUS_FILE_ERROR;
706             goto DONE;
707         }
708     }
709
710   DONE:
711     if (notmuch) {
712         notmuch_status_t ret2;
713
714         const char *str = notmuch_database_status_string (notmuch);
715         if (status_cb && str)
716             status_cb (str, closure);
717
718         ret2 = notmuch_database_destroy (notmuch);
719
720         /* don't clobber previous error status */
721         if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
722             ret = ret2;
723     }
724
725     talloc_free (local);
726
727     return ret;
728 }
729
730 notmuch_status_t
731 notmuch_database_destroy (notmuch_database_t *notmuch)
732 {
733     notmuch_status_t status;
734     const char *talloc_report;
735
736     talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
737     if (talloc_report && strcmp (talloc_report, "") != 0) {
738         FILE *report = fopen (talloc_report, "a");
739         if (report) {
740             talloc_report_full (notmuch, report);
741         }
742     }
743
744     status = notmuch_database_close (notmuch);
745
746     delete notmuch->term_gen;
747     notmuch->term_gen = NULL;
748     delete notmuch->query_parser;
749     notmuch->query_parser = NULL;
750     delete notmuch->xapian_db;
751     notmuch->xapian_db = NULL;
752     delete notmuch->value_range_processor;
753     notmuch->value_range_processor = NULL;
754     delete notmuch->date_range_processor;
755     notmuch->date_range_processor = NULL;
756     delete notmuch->last_mod_range_processor;
757     notmuch->last_mod_range_processor = NULL;
758     delete notmuch->stemmer;
759     notmuch->stemmer = NULL;
760
761     talloc_free (notmuch);
762
763     return status;
764 }
765
766 const char *
767 notmuch_database_get_path (notmuch_database_t *notmuch)
768 {
769     return notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
770 }
771
772 unsigned int
773 notmuch_database_get_version (notmuch_database_t *notmuch)
774 {
775     unsigned int version;
776     string version_string;
777     const char *str;
778     char *end;
779
780     try {
781         version_string = notmuch->xapian_db->get_metadata ("version");
782     } catch (const Xapian::Error &error) {
783         LOG_XAPIAN_EXCEPTION (notmuch, error);
784         return 0;
785     }
786
787     if (version_string.empty ())
788         return 0;
789
790     str = version_string.c_str ();
791     if (str == NULL || *str == '\0')
792         return 0;
793
794     version = strtoul (str, &end, 10);
795     if (*end != '\0')
796         INTERNAL_ERROR ("Malformed database version: %s", str);
797
798     return version;
799 }
800
801 notmuch_bool_t
802 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
803 {
804     unsigned int version;
805
806     if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_WRITE)
807         return FALSE;
808
809     if (NOTMUCH_FEATURES_CURRENT & ~notmuch->features)
810         return TRUE;
811
812     version = notmuch_database_get_version (notmuch);
813
814     return (version > 0 && version < NOTMUCH_DATABASE_VERSION);
815 }
816
817 static volatile sig_atomic_t do_progress_notify = 0;
818
819 static void
820 handle_sigalrm (unused (int signal))
821 {
822     do_progress_notify = 1;
823 }
824
825 /* Upgrade the current database.
826  *
827  * After opening a database in read-write mode, the client should
828  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
829  * if so, upgrade with this function before making any modifications.
830  *
831  * The optional progress_notify callback can be used by the caller to
832  * provide progress indication to the user. If non-NULL it will be
833  * called periodically with 'count' as the number of messages upgraded
834  * so far and 'total' the overall number of messages that will be
835  * converted.
836  */
837 notmuch_status_t
838 notmuch_database_upgrade (notmuch_database_t *notmuch,
839                           void (*progress_notify)(void *closure,
840                                                   double progress),
841                           void *closure)
842 {
843     void *local = talloc_new (NULL);
844     Xapian::TermIterator t, t_end;
845     Xapian::WritableDatabase *db;
846     struct sigaction action;
847     struct itimerval timerval;
848     bool timer_is_active = false;
849     enum _notmuch_features target_features, new_features;
850     notmuch_status_t status;
851     notmuch_private_status_t private_status;
852     notmuch_query_t *query = NULL;
853     unsigned int count = 0, total = 0;
854
855     status = _notmuch_database_ensure_writable (notmuch);
856     if (status)
857         return status;
858
859     db = notmuch->writable_xapian_db;
860
861     target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
862     new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
863
864     if (! notmuch_database_needs_upgrade (notmuch))
865         return NOTMUCH_STATUS_SUCCESS;
866
867     if (progress_notify) {
868         /* Set up our handler for SIGALRM */
869         memset (&action, 0, sizeof (struct sigaction));
870         action.sa_handler = handle_sigalrm;
871         sigemptyset (&action.sa_mask);
872         action.sa_flags = SA_RESTART;
873         sigaction (SIGALRM, &action, NULL);
874
875         /* Then start a timer to send SIGALRM once per second. */
876         timerval.it_interval.tv_sec = 1;
877         timerval.it_interval.tv_usec = 0;
878         timerval.it_value.tv_sec = 1;
879         timerval.it_value.tv_usec = 0;
880         setitimer (ITIMER_REAL, &timerval, NULL);
881
882         timer_is_active = true;
883     }
884
885     /* Figure out how much total work we need to do. */
886     if (new_features &
887         (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
888          NOTMUCH_FEATURE_LAST_MOD)) {
889         query = notmuch_query_create (notmuch, "");
890         unsigned msg_count;
891
892         status = notmuch_query_count_messages (query, &msg_count);
893         if (status)
894             goto DONE;
895
896         total += msg_count;
897         notmuch_query_destroy (query);
898         query = NULL;
899     }
900     if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
901         t_end = db->allterms_end ("XTIMESTAMP");
902         for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
903             ++total;
904     }
905     if (new_features & NOTMUCH_FEATURE_GHOSTS) {
906         /* The ghost message upgrade converts all thread_id_*
907          * metadata values into ghost message documents. */
908         t_end = db->metadata_keys_end ("thread_id_");
909         for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
910             ++total;
911     }
912
913     /* Perform the upgrade in a transaction. */
914     db->begin_transaction (true);
915
916     /* Set the target features so we write out changes in the desired
917      * format. */
918     notmuch->features = target_features;
919
920     /* Perform per-message upgrades. */
921     if (new_features &
922         (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
923          NOTMUCH_FEATURE_LAST_MOD)) {
924         notmuch_messages_t *messages;
925         notmuch_message_t *message;
926         char *filename;
927
928         query = notmuch_query_create (notmuch, "");
929
930         status = notmuch_query_search_messages (query, &messages);
931         if (status)
932             goto DONE;
933         for (;
934              notmuch_messages_valid (messages);
935              notmuch_messages_move_to_next (messages)) {
936             if (do_progress_notify) {
937                 progress_notify (closure, (double) count / total);
938                 do_progress_notify = 0;
939             }
940
941             message = notmuch_messages_get (messages);
942
943             /* Before version 1, each message document had its
944              * filename in the data field. Copy that into the new
945              * format by calling notmuch_message_add_filename.
946              */
947             if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
948                 filename = _notmuch_message_talloc_copy_data (message);
949                 if (filename && *filename != '\0') {
950                     _notmuch_message_add_filename (message, filename);
951                     _notmuch_message_clear_data (message);
952                 }
953                 talloc_free (filename);
954             }
955
956             /* Prior to version 2, the "folder:" prefix was
957              * probabilistic and stemmed. Change it to the current
958              * boolean prefix. Add "path:" prefixes while at it.
959              */
960             if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
961                 _notmuch_message_upgrade_folder (message);
962
963             /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
964              * track modification revisions.  Give all messages the
965              * next available revision; since we just started tracking
966              * revisions for this database, that will be 1.
967              */
968             if (new_features & NOTMUCH_FEATURE_LAST_MOD)
969                 _notmuch_message_upgrade_last_mod (message);
970
971             _notmuch_message_sync (message);
972
973             notmuch_message_destroy (message);
974
975             count++;
976         }
977
978         notmuch_query_destroy (query);
979         query = NULL;
980     }
981
982     /* Perform per-directory upgrades. */
983
984     /* Before version 1 we stored directory timestamps in
985      * XTIMESTAMP documents instead of the current XDIRECTORY
986      * documents. So copy those as well. */
987     if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
988         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
989
990         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
991              t != t_end;
992              t++) {
993             Xapian::PostingIterator p, p_end;
994             std::string term = *t;
995
996             p_end = notmuch->xapian_db->postlist_end (term);
997
998             for (p = notmuch->xapian_db->postlist_begin (term);
999                  p != p_end;
1000                  p++) {
1001                 Xapian::Document document;
1002                 time_t mtime;
1003                 notmuch_directory_t *directory;
1004
1005                 if (do_progress_notify) {
1006                     progress_notify (closure, (double) count / total);
1007                     do_progress_notify = 0;
1008                 }
1009
1010                 document = find_document_for_doc_id (notmuch, *p);
1011                 mtime = Xapian::sortable_unserialise (
1012                     document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1013
1014                 directory = _notmuch_directory_find_or_create (notmuch, term.c_str () + 10,
1015                                                                NOTMUCH_FIND_CREATE, &status);
1016                 notmuch_directory_set_mtime (directory, mtime);
1017                 notmuch_directory_destroy (directory);
1018
1019                 db->delete_document (*p);
1020             }
1021
1022             ++count;
1023         }
1024     }
1025
1026     /* Perform metadata upgrades. */
1027
1028     /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1029      * messages were stored as database metadata. Change these to
1030      * ghost messages.
1031      */
1032     if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1033         notmuch_message_t *message;
1034         std::string message_id, thread_id;
1035
1036         t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1037         for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1038              t != t_end; ++t) {
1039             if (do_progress_notify) {
1040                 progress_notify (closure, (double) count / total);
1041                 do_progress_notify = 0;
1042             }
1043
1044             message_id = (*t).substr (
1045                 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1046             thread_id = db->get_metadata (*t);
1047
1048             /* Create ghost message */
1049             message = _notmuch_message_create_for_message_id (
1050                 notmuch, message_id.c_str (), &private_status);
1051             if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1052                 /* Document already exists; ignore the stored thread ID */
1053             } else if (private_status ==
1054                        NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1055                 private_status = _notmuch_message_initialize_ghost (
1056                     message, thread_id.c_str ());
1057                 if (! private_status)
1058                     _notmuch_message_sync (message);
1059             }
1060
1061             if (private_status) {
1062                 _notmuch_database_log (notmuch,
1063                                        "Upgrade failed while creating ghost messages.\n");
1064                 status = COERCE_STATUS (private_status,
1065                                         "Unexpected status from _notmuch_message_initialize_ghost");
1066                 goto DONE;
1067             }
1068
1069             /* Clear saved metadata thread ID */
1070             db->set_metadata (*t, "");
1071
1072             ++count;
1073         }
1074     }
1075
1076     status = NOTMUCH_STATUS_SUCCESS;
1077     db->set_metadata ("features", _notmuch_database_print_features (local, notmuch->features));
1078     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1079
1080   DONE:
1081     if (status == NOTMUCH_STATUS_SUCCESS)
1082         db->commit_transaction ();
1083     else
1084         db->cancel_transaction ();
1085
1086     if (timer_is_active) {
1087         /* Now stop the timer. */
1088         timerval.it_interval.tv_sec = 0;
1089         timerval.it_interval.tv_usec = 0;
1090         timerval.it_value.tv_sec = 0;
1091         timerval.it_value.tv_usec = 0;
1092         setitimer (ITIMER_REAL, &timerval, NULL);
1093
1094         /* And disable the signal handler. */
1095         action.sa_handler = SIG_IGN;
1096         sigaction (SIGALRM, &action, NULL);
1097     }
1098
1099     if (query)
1100         notmuch_query_destroy (query);
1101
1102     talloc_free (local);
1103     return status;
1104 }
1105
1106 notmuch_status_t
1107 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1108 {
1109     if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1110         notmuch->atomic_nesting > 0)
1111         goto DONE;
1112
1113     if (notmuch_database_needs_upgrade (notmuch))
1114         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1115
1116     try {
1117         notmuch->writable_xapian_db->begin_transaction (false);
1118     } catch (const Xapian::Error &error) {
1119         _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1120                                error.get_msg ().c_str ());
1121         notmuch->exception_reported = true;
1122         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1123     }
1124
1125   DONE:
1126     notmuch->atomic_nesting++;
1127     return NOTMUCH_STATUS_SUCCESS;
1128 }
1129
1130 notmuch_status_t
1131 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1132 {
1133     Xapian::WritableDatabase *db;
1134
1135     if (notmuch->atomic_nesting == 0)
1136         return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1137
1138     if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1139         notmuch->atomic_nesting > 1)
1140         goto DONE;
1141
1142     db = notmuch->writable_xapian_db;
1143     try {
1144         db->commit_transaction ();
1145         notmuch->transaction_count++;
1146
1147         /* Xapian never flushes on a non-flushed commit, even if the
1148          * flush threshold is 1.  However, we rely on flushing to test
1149          * atomicity. On the other hand, we can't straight replace
1150          * XAPIAN_FLUSH_THRESHOLD with our autocommit counter, because
1151          * the former also applies outside notmuch atomic
1152          * commits. Hence the follow complicated  test */
1153         const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1154         if ((notmuch->transaction_threshold > 0 &&
1155              notmuch->transaction_count >= notmuch->transaction_threshold) ||
1156             (thresh && atoi (thresh) == 1)) {
1157             db->commit ();
1158             notmuch->transaction_count = 0;
1159         }
1160     } catch (const Xapian::Error &error) {
1161         _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1162                                error.get_msg ().c_str ());
1163         notmuch->exception_reported = true;
1164         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1165     }
1166
1167     if (notmuch->atomic_dirty) {
1168         ++notmuch->revision;
1169         notmuch->atomic_dirty = false;
1170     }
1171
1172   DONE:
1173     notmuch->atomic_nesting--;
1174     return NOTMUCH_STATUS_SUCCESS;
1175 }
1176
1177 unsigned long
1178 notmuch_database_get_revision (notmuch_database_t *notmuch,
1179                                const char **uuid)
1180 {
1181     if (uuid)
1182         *uuid = notmuch->uuid;
1183     return notmuch->revision;
1184 }
1185
1186 /* We allow the user to use arbitrarily long paths for directories. But
1187  * we have a term-length limit. So if we exceed that, we'll use the
1188  * SHA-1 of the path for the database term.
1189  *
1190  * Note: This function may return the original value of 'path'. If it
1191  * does not, then the caller is responsible to free() the returned
1192  * value.
1193  */
1194 const char *
1195 _notmuch_database_get_directory_db_path (const char *path)
1196 {
1197     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1198
1199     if (term_len > NOTMUCH_TERM_MAX)
1200         return _notmuch_sha1_of_string (path);
1201     else
1202         return path;
1203 }
1204
1205 /* Given a path, split it into two parts: the directory part is all
1206  * components except for the last, and the basename is that last
1207  * component. Getting the return-value for either part is optional
1208  * (the caller can pass NULL).
1209  *
1210  * The original 'path' can represent either a regular file or a
1211  * directory---the splitting will be carried out in the same way in
1212  * either case. Trailing slashes on 'path' will be ignored, and any
1213  * cases of multiple '/' characters appearing in series will be
1214  * treated as a single '/'.
1215  *
1216  * Allocation (if any) will have 'ctx' as the talloc owner. But
1217  * pointers will be returned within the original path string whenever
1218  * possible.
1219  *
1220  * Note: If 'path' is non-empty and contains no non-trailing slash,
1221  * (that is, consists of a filename with no parent directory), then
1222  * the directory returned will be an empty string. However, if 'path'
1223  * is an empty string, then both directory and basename will be
1224  * returned as NULL.
1225  */
1226 notmuch_status_t
1227 _notmuch_database_split_path (void *ctx,
1228                               const char *path,
1229                               const char **directory,
1230                               const char **basename)
1231 {
1232     const char *slash;
1233
1234     if (path == NULL || *path == '\0') {
1235         if (directory)
1236             *directory = NULL;
1237         if (basename)
1238             *basename = NULL;
1239         return NOTMUCH_STATUS_SUCCESS;
1240     }
1241
1242     /* Find the last slash (not counting a trailing slash), if any. */
1243
1244     slash = path + strlen (path) - 1;
1245
1246     /* First, skip trailing slashes. */
1247     while (slash != path && *slash == '/')
1248         --slash;
1249
1250     /* Then, find a slash. */
1251     while (slash != path && *slash != '/') {
1252         if (basename)
1253             *basename = slash;
1254
1255         --slash;
1256     }
1257
1258     /* Finally, skip multiple slashes. */
1259     while (slash != path && *(slash - 1) == '/')
1260         --slash;
1261
1262     if (slash == path) {
1263         if (directory)
1264             *directory = talloc_strdup (ctx, "");
1265         if (basename)
1266             *basename = path;
1267     } else {
1268         if (directory)
1269             *directory = talloc_strndup (ctx, path, slash - path);
1270     }
1271
1272     return NOTMUCH_STATUS_SUCCESS;
1273 }
1274
1275 /* Find the document ID of the specified directory.
1276  *
1277  * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1278  * created if one does not exist for 'path'.  Otherwise, if the
1279  * directory document does not exist, this sets *directory_id to
1280  * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1281  */
1282 notmuch_status_t
1283 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1284                                      const char *path,
1285                                      notmuch_find_flags_t flags,
1286                                      unsigned int *directory_id)
1287 {
1288     notmuch_directory_t *directory;
1289     notmuch_status_t status;
1290
1291     if (path == NULL) {
1292         *directory_id = 0;
1293         return NOTMUCH_STATUS_SUCCESS;
1294     }
1295
1296     directory = _notmuch_directory_find_or_create (notmuch, path, flags, &status);
1297     if (status || ! directory) {
1298         *directory_id = -1;
1299         return status;
1300     }
1301
1302     *directory_id = _notmuch_directory_get_document_id (directory);
1303
1304     notmuch_directory_destroy (directory);
1305
1306     return NOTMUCH_STATUS_SUCCESS;
1307 }
1308
1309 const char *
1310 _notmuch_database_get_directory_path (void *ctx,
1311                                       notmuch_database_t *notmuch,
1312                                       unsigned int doc_id)
1313 {
1314     Xapian::Document document;
1315
1316     document = find_document_for_doc_id (notmuch, doc_id);
1317
1318     return talloc_strdup (ctx, document.get_data ().c_str ());
1319 }
1320
1321 /* Given a legal 'filename' for the database, (either relative to
1322  * database path or absolute with initial components identical to
1323  * database path), return a new string (with 'ctx' as the talloc
1324  * owner) suitable for use as a direntry term value.
1325  *
1326  * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1327  * will be created in the database as needed.  Otherwise, if the
1328  * necessary directory documents do not exist, this sets
1329  * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1330  */
1331 notmuch_status_t
1332 _notmuch_database_filename_to_direntry (void *ctx,
1333                                         notmuch_database_t *notmuch,
1334                                         const char *filename,
1335                                         notmuch_find_flags_t flags,
1336                                         char **direntry)
1337 {
1338     const char *relative, *directory, *basename;
1339     Xapian::docid directory_id;
1340     notmuch_status_t status;
1341
1342     relative = _notmuch_database_relative_path (notmuch, filename);
1343
1344     status = _notmuch_database_split_path (ctx, relative,
1345                                            &directory, &basename);
1346     if (status)
1347         return status;
1348
1349     status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1350                                                   &directory_id);
1351     if (status || directory_id == (unsigned int) -1) {
1352         *direntry = NULL;
1353         return status;
1354     }
1355
1356     *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1357
1358     return NOTMUCH_STATUS_SUCCESS;
1359 }
1360
1361 /* Given a legal 'path' for the database, return the relative path.
1362  *
1363  * The return value will be a pointer to the original path contents,
1364  * and will be either the original string (if 'path' was relative) or
1365  * a portion of the string (if path was absolute and begins with the
1366  * database path).
1367  */
1368 const char *
1369 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1370                                  const char *path)
1371 {
1372     const char *db_path, *relative;
1373     unsigned int db_path_len;
1374
1375     db_path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_MAIL_ROOT);
1376     db_path_len = strlen (db_path);
1377
1378     relative = path;
1379
1380     if (*relative == '/') {
1381         while (*relative == '/' && *(relative + 1) == '/')
1382             relative++;
1383
1384         if (strncmp (relative, db_path, db_path_len) == 0) {
1385             relative += db_path_len;
1386             while (*relative == '/')
1387                 relative++;
1388         }
1389     }
1390
1391     return relative;
1392 }
1393
1394 notmuch_status_t
1395 notmuch_database_get_directory (notmuch_database_t *notmuch,
1396                                 const char *path,
1397                                 notmuch_directory_t **directory)
1398 {
1399     notmuch_status_t status;
1400
1401     if (directory == NULL)
1402         return NOTMUCH_STATUS_NULL_POINTER;
1403     *directory = NULL;
1404
1405     try {
1406         *directory = _notmuch_directory_find_or_create (notmuch, path,
1407                                                         NOTMUCH_FIND_LOOKUP, &status);
1408     } catch (const Xapian::Error &error) {
1409         _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1410                                error.get_msg ().c_str ());
1411         notmuch->exception_reported = true;
1412         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1413     }
1414     return status;
1415 }
1416
1417 /* Allocate a document ID that satisfies the following criteria:
1418  *
1419  * 1. The ID does not exist for any document in the Xapian database
1420  *
1421  * 2. The ID was not previously returned from this function
1422  *
1423  * 3. The ID is the smallest integer satisfying (1) and (2)
1424  *
1425  * This function will trigger an internal error if these constraints
1426  * cannot all be satisfied, (that is, the pool of available document
1427  * IDs has been exhausted).
1428  */
1429 unsigned int
1430 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1431 {
1432     assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1433
1434     notmuch->last_doc_id++;
1435
1436     if (notmuch->last_doc_id == 0)
1437         INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1438
1439     return notmuch->last_doc_id;
1440 }
1441
1442 notmuch_status_t
1443 notmuch_database_remove_message (notmuch_database_t *notmuch,
1444                                  const char *filename)
1445 {
1446     notmuch_status_t status;
1447     notmuch_message_t *message;
1448
1449     status = notmuch_database_find_message_by_filename (notmuch, filename,
1450                                                         &message);
1451
1452     if (status == NOTMUCH_STATUS_SUCCESS && message) {
1453         status = _notmuch_message_remove_filename (message, filename);
1454         if (status == NOTMUCH_STATUS_SUCCESS)
1455             _notmuch_message_delete (message);
1456         else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1457             _notmuch_message_sync (message);
1458
1459         notmuch_message_destroy (message);
1460     }
1461
1462     return status;
1463 }
1464
1465 notmuch_status_t
1466 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1467                                            const char *filename,
1468                                            notmuch_message_t **message_ret)
1469 {
1470     void *local;
1471     const char *prefix = _find_prefix ("file-direntry");
1472     char *direntry, *term;
1473     Xapian::PostingIterator i, end;
1474     notmuch_status_t status;
1475
1476     if (message_ret == NULL)
1477         return NOTMUCH_STATUS_NULL_POINTER;
1478
1479     if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
1480         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1481
1482     /* return NULL on any failure */
1483     *message_ret = NULL;
1484
1485     local = talloc_new (notmuch);
1486
1487     try {
1488         status = _notmuch_database_filename_to_direntry (
1489             local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
1490         if (status || ! direntry)
1491             goto DONE;
1492
1493         term = talloc_asprintf (local, "%s%s", prefix, direntry);
1494
1495         find_doc_ids_for_term (notmuch, term, &i, &end);
1496
1497         if (i != end) {
1498             notmuch_private_status_t private_status;
1499
1500             *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1501                                                     &private_status);
1502             if (*message_ret == NULL)
1503                 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1504         }
1505     } catch (const Xapian::Error &error) {
1506         _notmuch_database_log (notmuch,
1507                                "Error: A Xapian exception occurred finding message by filename: %s\n",
1508                                error.get_msg ().c_str ());
1509         notmuch->exception_reported = true;
1510         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1511     }
1512
1513   DONE:
1514     talloc_free (local);
1515
1516     if (status && *message_ret) {
1517         notmuch_message_destroy (*message_ret);
1518         *message_ret = NULL;
1519     }
1520     return status;
1521 }
1522
1523 notmuch_string_list_t *
1524 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1525                                          Xapian::TermIterator &end,
1526                                          const char *prefix)
1527 {
1528     int prefix_len = strlen (prefix);
1529     notmuch_string_list_t *list;
1530
1531     list = _notmuch_string_list_create (ctx);
1532     if (unlikely (list == NULL))
1533         return NULL;
1534
1535     for (i.skip_to (prefix); i != end; i++) {
1536         /* Terminate loop at first term without desired prefix. */
1537         if (strncmp ((*i).c_str (), prefix, prefix_len))
1538             break;
1539
1540         _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1541     }
1542
1543     return list;
1544 }
1545
1546 notmuch_tags_t *
1547 notmuch_database_get_all_tags (notmuch_database_t *db)
1548 {
1549     Xapian::TermIterator i, end;
1550     notmuch_string_list_t *tags;
1551
1552     try {
1553         i = db->xapian_db->allterms_begin ();
1554         end = db->xapian_db->allterms_end ();
1555         tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1556                                                         _find_prefix ("tag"));
1557         _notmuch_string_list_sort (tags);
1558         return _notmuch_tags_create (db, tags);
1559     } catch (const Xapian::Error &error) {
1560         _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
1561                                error.get_msg ().c_str ());
1562         db->exception_reported = true;
1563         return NULL;
1564     }
1565 }
1566
1567 const char *
1568 notmuch_database_status_string (const notmuch_database_t *notmuch)
1569 {
1570     return notmuch->status_string;
1571 }