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
_log_xapian_exception(const char * where,notmuch_database_t * notmuch,const Xapian::Error error)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
_notmuch_database_mode(notmuch_database_t * notmuch)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 *
_notmuch_database_user_headers(notmuch_database_t * notmuch)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 *
notmuch_status_to_string(notmuch_status_t status)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 default:
315 case NOTMUCH_STATUS_LAST_STATUS:
316 return "Unknown error status value";
317 }
318 }
319
320 void
_notmuch_database_log(notmuch_database_t * notmuch,const char * format,...)321 _notmuch_database_log (notmuch_database_t *notmuch,
322 const char *format,
323 ...)
324 {
325 va_list va_args;
326
327 va_start (va_args, format);
328
329 if (notmuch->status_string)
330 talloc_free (notmuch->status_string);
331
332 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
333 va_end (va_args);
334 }
335
336 void
_notmuch_database_log_append(notmuch_database_t * notmuch,const char * format,...)337 _notmuch_database_log_append (notmuch_database_t *notmuch,
338 const char *format,
339 ...)
340 {
341 va_list va_args;
342
343 va_start (va_args, format);
344
345 if (notmuch->status_string)
346 notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
347 else
348 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
349
350 va_end (va_args);
351 }
352
353 static void
find_doc_ids_for_term(notmuch_database_t * notmuch,const char * term,Xapian::PostingIterator * begin,Xapian::PostingIterator * end)354 find_doc_ids_for_term (notmuch_database_t *notmuch,
355 const char *term,
356 Xapian::PostingIterator *begin,
357 Xapian::PostingIterator *end)
358 {
359 *begin = notmuch->xapian_db->postlist_begin (term);
360
361 *end = notmuch->xapian_db->postlist_end (term);
362 }
363
364 void
_notmuch_database_find_doc_ids(notmuch_database_t * notmuch,const char * prefix_name,const char * value,Xapian::PostingIterator * begin,Xapian::PostingIterator * end)365 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
366 const char *prefix_name,
367 const char *value,
368 Xapian::PostingIterator *begin,
369 Xapian::PostingIterator *end)
370 {
371 char *term;
372
373 term = talloc_asprintf (notmuch, "%s%s",
374 _find_prefix (prefix_name), value);
375
376 find_doc_ids_for_term (notmuch, term, begin, end);
377
378 talloc_free (term);
379 }
380
381 notmuch_private_status_t
_notmuch_database_find_unique_doc_id(notmuch_database_t * notmuch,const char * prefix_name,const char * value,unsigned int * doc_id)382 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
383 const char *prefix_name,
384 const char *value,
385 unsigned int *doc_id)
386 {
387 Xapian::PostingIterator i, end;
388
389 _notmuch_database_find_doc_ids (notmuch, prefix_name, value, &i, &end);
390
391 if (i == end) {
392 *doc_id = 0;
393 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
394 }
395
396 *doc_id = *i;
397
398 #if DEBUG_DATABASE_SANITY
399 i++;
400
401 if (i != end)
402 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
403 prefix_name, value);
404 #endif
405
406 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
407 }
408
409 static Xapian::Document
find_document_for_doc_id(notmuch_database_t * notmuch,unsigned doc_id)410 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
411 {
412 return notmuch->xapian_db->get_document (doc_id);
413 }
414
415 /* Generate a compressed version of 'message_id' of the form:
416 *
417 * notmuch-sha1-<sha1_sum_of_message_id>
418 */
419 char *
_notmuch_message_id_compressed(void * ctx,const char * message_id)420 _notmuch_message_id_compressed (void *ctx, const char *message_id)
421 {
422 char *sha1, *compressed;
423
424 sha1 = _notmuch_sha1_of_string (message_id);
425
426 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
427 free (sha1);
428
429 return compressed;
430 }
431
432 notmuch_status_t
notmuch_database_find_message(notmuch_database_t * notmuch,const char * message_id,notmuch_message_t ** message_ret)433 notmuch_database_find_message (notmuch_database_t *notmuch,
434 const char *message_id,
435 notmuch_message_t **message_ret)
436 {
437 notmuch_private_status_t status;
438 unsigned int doc_id;
439
440 if (message_ret == NULL)
441 return NOTMUCH_STATUS_NULL_POINTER;
442
443 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
444 message_id = _notmuch_message_id_compressed (notmuch, message_id);
445
446 try {
447 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
448 message_id, &doc_id);
449
450 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
451 *message_ret = NULL;
452 else {
453 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
454 NULL);
455 if (*message_ret == NULL)
456 return NOTMUCH_STATUS_OUT_OF_MEMORY;
457 }
458
459 return NOTMUCH_STATUS_SUCCESS;
460 } catch (const Xapian::Error &error) {
461 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
462 error.get_msg ().c_str ());
463 notmuch->exception_reported = true;
464 *message_ret = NULL;
465 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
466 }
467 }
468
469 notmuch_status_t
_notmuch_database_ensure_writable(notmuch_database_t * notmuch)470 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
471 {
472 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY) {
473 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
474 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
475 }
476
477 return NOTMUCH_STATUS_SUCCESS;
478 }
479
480 /* Allocate a revision number for the next change. */
481 unsigned long
_notmuch_database_new_revision(notmuch_database_t * notmuch)482 _notmuch_database_new_revision (notmuch_database_t *notmuch)
483 {
484 unsigned long new_revision = notmuch->revision + 1;
485
486 /* If we're in an atomic section, hold off on updating the
487 * committed revision number until we commit the atomic section.
488 */
489 if (notmuch->atomic_nesting)
490 notmuch->atomic_dirty = true;
491 else
492 notmuch->revision = new_revision;
493
494 return new_revision;
495 }
496
497 notmuch_status_t
notmuch_database_close(notmuch_database_t * notmuch)498 notmuch_database_close (notmuch_database_t *notmuch)
499 {
500 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
501
502 /* Many Xapian objects (and thus notmuch objects) hold references to
503 * the database, so merely deleting the database may not suffice to
504 * close it. Thus, we explicitly close it here. */
505 if (notmuch->open) {
506 try {
507 /* Close the database. This implicitly flushes
508 * outstanding changes. If there is an open (non-flushed)
509 * transaction, ALL pending changes will be discarded */
510 notmuch->xapian_db->close ();
511 } catch (const Xapian::Error &error) {
512 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
513 if (! notmuch->exception_reported) {
514 _notmuch_database_log (notmuch,
515 "Error: A Xapian exception occurred closing database: %s\n",
516 error.get_msg ().c_str ());
517 }
518 }
519 }
520 notmuch->open = false;
521 return status;
522 }
523
524 static int
unlink_cb(const char * path,unused (const struct stat * sb),unused (int type),unused (struct FTW * ftw))525 unlink_cb (const char *path,
526 unused (const struct stat *sb),
527 unused (int type),
528 unused (struct FTW *ftw))
529 {
530 return remove (path);
531 }
532
533 static int
rmtree(const char * path)534 rmtree (const char *path)
535 {
536 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
537 }
538
539 class NotmuchCompactor : public Xapian::Compactor
540 {
541 notmuch_compact_status_cb_t status_cb;
542 void *status_closure;
543
544 public:
NotmuchCompactor(notmuch_compact_status_cb_t cb,void * closure)545 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
546 status_cb (cb), status_closure (closure)
547 {
548 }
549
550 virtual void
set_status(const std::string & table,const std::string & status)551 set_status (const std::string &table, const std::string &status)
552 {
553 char *msg;
554
555 if (status_cb == NULL)
556 return;
557
558 if (status.length () == 0)
559 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str ());
560 else
561 msg = talloc_asprintf (NULL, " %s", status.c_str ());
562
563 if (msg == NULL) {
564 return;
565 }
566
567 status_cb (msg, status_closure);
568 talloc_free (msg);
569 }
570 };
571
572 /* Compacts the given database, optionally saving the original database
573 * in backup_path. Additionally, a callback function can be provided to
574 * give the user feedback on the progress of the (likely long-lived)
575 * compaction process.
576 *
577 * The backup path must point to a directory on the same volume as the
578 * original database. Passing a NULL backup_path will result in the
579 * uncompacted database being deleted after compaction has finished.
580 * Note that the database write lock will be held during the
581 * compaction process to protect data integrity.
582 */
583 notmuch_status_t
notmuch_database_compact(const char * path,const char * backup_path,notmuch_compact_status_cb_t status_cb,void * closure)584 notmuch_database_compact (const char *path,
585 const char *backup_path,
586 notmuch_compact_status_cb_t status_cb,
587 void *closure)
588 {
589 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
590 notmuch_database_t *notmuch = NULL;
591 char *message = NULL;
592
593 ret = notmuch_database_open_verbose (path,
594 NOTMUCH_DATABASE_MODE_READ_WRITE,
595 ¬much,
596 &message);
597 if (ret) {
598 if (status_cb) status_cb (message, closure);
599 return ret;
600 }
601
602 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
603
604 return notmuch_database_compact_db (notmuch,
605 backup_path,
606 status_cb,
607 closure);
608 }
609
610 notmuch_status_t
notmuch_database_compact_db(notmuch_database_t * notmuch,const char * backup_path,notmuch_compact_status_cb_t status_cb,void * closure)611 notmuch_database_compact_db (notmuch_database_t *notmuch,
612 const char *backup_path,
613 notmuch_compact_status_cb_t status_cb,
614 void *closure)
615 {
616 void *local;
617 const char *xapian_path, *compact_xapian_path;
618 const char *path;
619 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
620 struct stat statbuf;
621 bool keep_backup;
622 char *message;
623
624 ret = _notmuch_database_ensure_writable (notmuch);
625 if (ret)
626 return ret;
627
628 path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
629 if (! path)
630 return NOTMUCH_STATUS_PATH_ERROR;
631
632 local = talloc_new (NULL);
633 if (! local)
634 return NOTMUCH_STATUS_OUT_OF_MEMORY;
635
636 ret = _notmuch_choose_xapian_path (local, path, &xapian_path, &message);
637 if (ret)
638 goto DONE;
639
640 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
641 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
642 goto DONE;
643 }
644
645 if (backup_path == NULL) {
646 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
647 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
648 goto DONE;
649 }
650 keep_backup = false;
651 } else {
652 keep_backup = true;
653 }
654
655 if (stat (backup_path, &statbuf) != -1) {
656 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
657 ret = NOTMUCH_STATUS_FILE_ERROR;
658 goto DONE;
659 }
660 if (errno != ENOENT) {
661 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
662 strerror (errno));
663 ret = NOTMUCH_STATUS_FILE_ERROR;
664 goto DONE;
665 }
666
667 /* Unconditionally attempt to remove old work-in-progress database (if
668 * any). This is "protected" by database lock. If this fails due to write
669 * errors (etc), the following code will fail and provide error message.
670 */
671 (void) rmtree (compact_xapian_path);
672
673 try {
674 NotmuchCompactor compactor (status_cb, closure);
675 notmuch->xapian_db->compact (compact_xapian_path, Xapian::DBCOMPACT_NO_RENUMBER, 0,
676 compactor);
677 } catch (const Xapian::Error &error) {
678 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg ().c_str ());
679 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
680 goto DONE;
681 }
682
683 if (rename (xapian_path, backup_path)) {
684 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
685 xapian_path, backup_path, strerror (errno));
686 ret = NOTMUCH_STATUS_FILE_ERROR;
687 goto DONE;
688 }
689
690 if (rename (compact_xapian_path, xapian_path)) {
691 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
692 compact_xapian_path, xapian_path, strerror (errno));
693 ret = NOTMUCH_STATUS_FILE_ERROR;
694 goto DONE;
695 }
696
697 if (! keep_backup) {
698 if (rmtree (backup_path)) {
699 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
700 backup_path, strerror (errno));
701 ret = NOTMUCH_STATUS_FILE_ERROR;
702 goto DONE;
703 }
704 }
705
706 DONE:
707 if (notmuch) {
708 notmuch_status_t ret2;
709
710 const char *str = notmuch_database_status_string (notmuch);
711 if (status_cb && str)
712 status_cb (str, closure);
713
714 ret2 = notmuch_database_destroy (notmuch);
715
716 /* don't clobber previous error status */
717 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
718 ret = ret2;
719 }
720
721 talloc_free (local);
722
723 return ret;
724 }
725
726 notmuch_status_t
notmuch_database_destroy(notmuch_database_t * notmuch)727 notmuch_database_destroy (notmuch_database_t *notmuch)
728 {
729 notmuch_status_t status;
730 const char *talloc_report;
731
732 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
733 if (talloc_report && strcmp (talloc_report, "") != 0) {
734 FILE *report = fopen (talloc_report, "a");
735 if (report) {
736 talloc_report_full (notmuch, report);
737 }
738 }
739
740 status = notmuch_database_close (notmuch);
741
742 delete notmuch->term_gen;
743 notmuch->term_gen = NULL;
744 delete notmuch->query_parser;
745 notmuch->query_parser = NULL;
746 delete notmuch->xapian_db;
747 notmuch->xapian_db = NULL;
748 delete notmuch->value_range_processor;
749 notmuch->value_range_processor = NULL;
750 delete notmuch->date_range_processor;
751 notmuch->date_range_processor = NULL;
752 delete notmuch->last_mod_range_processor;
753 notmuch->last_mod_range_processor = NULL;
754
755 talloc_free (notmuch);
756
757 return status;
758 }
759
760 const char *
notmuch_database_get_path(notmuch_database_t * notmuch)761 notmuch_database_get_path (notmuch_database_t *notmuch)
762 {
763 return notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
764 }
765
766 unsigned int
notmuch_database_get_version(notmuch_database_t * notmuch)767 notmuch_database_get_version (notmuch_database_t *notmuch)
768 {
769 unsigned int version;
770 string version_string;
771 const char *str;
772 char *end;
773
774 try {
775 version_string = notmuch->xapian_db->get_metadata ("version");
776 } catch (const Xapian::Error &error) {
777 LOG_XAPIAN_EXCEPTION (notmuch, error);
778 return 0;
779 }
780
781 if (version_string.empty ())
782 return 0;
783
784 str = version_string.c_str ();
785 if (str == NULL || *str == '\0')
786 return 0;
787
788 version = strtoul (str, &end, 10);
789 if (*end != '\0')
790 INTERNAL_ERROR ("Malformed database version: %s", str);
791
792 return version;
793 }
794
795 notmuch_bool_t
notmuch_database_needs_upgrade(notmuch_database_t * notmuch)796 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
797 {
798 unsigned int version;
799
800 if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_WRITE)
801 return FALSE;
802
803 if (NOTMUCH_FEATURES_CURRENT & ~notmuch->features)
804 return TRUE;
805
806 version = notmuch_database_get_version (notmuch);
807
808 return (version > 0 && version < NOTMUCH_DATABASE_VERSION);
809 }
810
811 static volatile sig_atomic_t do_progress_notify = 0;
812
813 static void
handle_sigalrm(unused (int signal))814 handle_sigalrm (unused (int signal))
815 {
816 do_progress_notify = 1;
817 }
818
819 /* Upgrade the current database.
820 *
821 * After opening a database in read-write mode, the client should
822 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
823 * if so, upgrade with this function before making any modifications.
824 *
825 * The optional progress_notify callback can be used by the caller to
826 * provide progress indication to the user. If non-NULL it will be
827 * called periodically with 'count' as the number of messages upgraded
828 * so far and 'total' the overall number of messages that will be
829 * converted.
830 */
831 notmuch_status_t
notmuch_database_upgrade(notmuch_database_t * notmuch,void (* progress_notify)(void * closure,double progress),void * closure)832 notmuch_database_upgrade (notmuch_database_t *notmuch,
833 void (*progress_notify)(void *closure,
834 double progress),
835 void *closure)
836 {
837 void *local = talloc_new (NULL);
838 Xapian::TermIterator t, t_end;
839 Xapian::WritableDatabase *db;
840 struct sigaction action;
841 struct itimerval timerval;
842 bool timer_is_active = false;
843 enum _notmuch_features target_features, new_features;
844 notmuch_status_t status;
845 notmuch_private_status_t private_status;
846 notmuch_query_t *query = NULL;
847 unsigned int count = 0, total = 0;
848
849 status = _notmuch_database_ensure_writable (notmuch);
850 if (status)
851 return status;
852
853 db = notmuch->writable_xapian_db;
854
855 target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
856 new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
857
858 if (! notmuch_database_needs_upgrade (notmuch))
859 return NOTMUCH_STATUS_SUCCESS;
860
861 if (progress_notify) {
862 /* Set up our handler for SIGALRM */
863 memset (&action, 0, sizeof (struct sigaction));
864 action.sa_handler = handle_sigalrm;
865 sigemptyset (&action.sa_mask);
866 action.sa_flags = SA_RESTART;
867 sigaction (SIGALRM, &action, NULL);
868
869 /* Then start a timer to send SIGALRM once per second. */
870 timerval.it_interval.tv_sec = 1;
871 timerval.it_interval.tv_usec = 0;
872 timerval.it_value.tv_sec = 1;
873 timerval.it_value.tv_usec = 0;
874 setitimer (ITIMER_REAL, &timerval, NULL);
875
876 timer_is_active = true;
877 }
878
879 /* Figure out how much total work we need to do. */
880 if (new_features &
881 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
882 NOTMUCH_FEATURE_LAST_MOD)) {
883 query = notmuch_query_create (notmuch, "");
884 unsigned msg_count;
885
886 status = notmuch_query_count_messages (query, &msg_count);
887 if (status)
888 goto DONE;
889
890 total += msg_count;
891 notmuch_query_destroy (query);
892 query = NULL;
893 }
894 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
895 t_end = db->allterms_end ("XTIMESTAMP");
896 for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
897 ++total;
898 }
899 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
900 /* The ghost message upgrade converts all thread_id_*
901 * metadata values into ghost message documents. */
902 t_end = db->metadata_keys_end ("thread_id_");
903 for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
904 ++total;
905 }
906
907 /* Perform the upgrade in a transaction. */
908 db->begin_transaction (true);
909
910 /* Set the target features so we write out changes in the desired
911 * format. */
912 notmuch->features = target_features;
913
914 /* Perform per-message upgrades. */
915 if (new_features &
916 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
917 NOTMUCH_FEATURE_LAST_MOD)) {
918 notmuch_messages_t *messages;
919 notmuch_message_t *message;
920 char *filename;
921
922 query = notmuch_query_create (notmuch, "");
923
924 status = notmuch_query_search_messages (query, &messages);
925 if (status)
926 goto DONE;
927 for (;
928 notmuch_messages_valid (messages);
929 notmuch_messages_move_to_next (messages)) {
930 if (do_progress_notify) {
931 progress_notify (closure, (double) count / total);
932 do_progress_notify = 0;
933 }
934
935 message = notmuch_messages_get (messages);
936
937 /* Before version 1, each message document had its
938 * filename in the data field. Copy that into the new
939 * format by calling notmuch_message_add_filename.
940 */
941 if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
942 filename = _notmuch_message_talloc_copy_data (message);
943 if (filename && *filename != '\0') {
944 _notmuch_message_add_filename (message, filename);
945 _notmuch_message_clear_data (message);
946 }
947 talloc_free (filename);
948 }
949
950 /* Prior to version 2, the "folder:" prefix was
951 * probabilistic and stemmed. Change it to the current
952 * boolean prefix. Add "path:" prefixes while at it.
953 */
954 if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
955 _notmuch_message_upgrade_folder (message);
956
957 /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
958 * track modification revisions. Give all messages the
959 * next available revision; since we just started tracking
960 * revisions for this database, that will be 1.
961 */
962 if (new_features & NOTMUCH_FEATURE_LAST_MOD)
963 _notmuch_message_upgrade_last_mod (message);
964
965 _notmuch_message_sync (message);
966
967 notmuch_message_destroy (message);
968
969 count++;
970 }
971
972 notmuch_query_destroy (query);
973 query = NULL;
974 }
975
976 /* Perform per-directory upgrades. */
977
978 /* Before version 1 we stored directory timestamps in
979 * XTIMESTAMP documents instead of the current XDIRECTORY
980 * documents. So copy those as well. */
981 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
982 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
983
984 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
985 t != t_end;
986 t++) {
987 Xapian::PostingIterator p, p_end;
988 std::string term = *t;
989
990 p_end = notmuch->xapian_db->postlist_end (term);
991
992 for (p = notmuch->xapian_db->postlist_begin (term);
993 p != p_end;
994 p++) {
995 Xapian::Document document;
996 time_t mtime;
997 notmuch_directory_t *directory;
998
999 if (do_progress_notify) {
1000 progress_notify (closure, (double) count / total);
1001 do_progress_notify = 0;
1002 }
1003
1004 document = find_document_for_doc_id (notmuch, *p);
1005 mtime = Xapian::sortable_unserialise (
1006 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1007
1008 directory = _notmuch_directory_find_or_create (notmuch, term.c_str () + 10,
1009 NOTMUCH_FIND_CREATE, &status);
1010 notmuch_directory_set_mtime (directory, mtime);
1011 notmuch_directory_destroy (directory);
1012
1013 db->delete_document (*p);
1014 }
1015
1016 ++count;
1017 }
1018 }
1019
1020 /* Perform metadata upgrades. */
1021
1022 /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1023 * messages were stored as database metadata. Change these to
1024 * ghost messages.
1025 */
1026 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1027 notmuch_message_t *message;
1028 std::string message_id, thread_id;
1029
1030 t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1031 for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1032 t != t_end; ++t) {
1033 if (do_progress_notify) {
1034 progress_notify (closure, (double) count / total);
1035 do_progress_notify = 0;
1036 }
1037
1038 message_id = (*t).substr (
1039 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1040 thread_id = db->get_metadata (*t);
1041
1042 /* Create ghost message */
1043 message = _notmuch_message_create_for_message_id (
1044 notmuch, message_id.c_str (), &private_status);
1045 if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1046 /* Document already exists; ignore the stored thread ID */
1047 } else if (private_status ==
1048 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1049 private_status = _notmuch_message_initialize_ghost (
1050 message, thread_id.c_str ());
1051 if (! private_status)
1052 _notmuch_message_sync (message);
1053 }
1054
1055 if (private_status) {
1056 _notmuch_database_log (notmuch,
1057 "Upgrade failed while creating ghost messages.\n");
1058 status = COERCE_STATUS (private_status,
1059 "Unexpected status from _notmuch_message_initialize_ghost");
1060 goto DONE;
1061 }
1062
1063 /* Clear saved metadata thread ID */
1064 db->set_metadata (*t, "");
1065
1066 ++count;
1067 }
1068 }
1069
1070 status = NOTMUCH_STATUS_SUCCESS;
1071 db->set_metadata ("features", _notmuch_database_print_features (local, notmuch->features));
1072 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1073
1074 DONE:
1075 if (status == NOTMUCH_STATUS_SUCCESS)
1076 db->commit_transaction ();
1077 else
1078 db->cancel_transaction ();
1079
1080 if (timer_is_active) {
1081 /* Now stop the timer. */
1082 timerval.it_interval.tv_sec = 0;
1083 timerval.it_interval.tv_usec = 0;
1084 timerval.it_value.tv_sec = 0;
1085 timerval.it_value.tv_usec = 0;
1086 setitimer (ITIMER_REAL, &timerval, NULL);
1087
1088 /* And disable the signal handler. */
1089 action.sa_handler = SIG_IGN;
1090 sigaction (SIGALRM, &action, NULL);
1091 }
1092
1093 if (query)
1094 notmuch_query_destroy (query);
1095
1096 talloc_free (local);
1097 return status;
1098 }
1099
1100 notmuch_status_t
notmuch_database_begin_atomic(notmuch_database_t * notmuch)1101 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1102 {
1103 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1104 notmuch->atomic_nesting > 0)
1105 goto DONE;
1106
1107 if (notmuch_database_needs_upgrade (notmuch))
1108 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1109
1110 try {
1111 notmuch->writable_xapian_db->begin_transaction (false);
1112 } catch (const Xapian::Error &error) {
1113 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1114 error.get_msg ().c_str ());
1115 notmuch->exception_reported = true;
1116 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1117 }
1118
1119 DONE:
1120 notmuch->atomic_nesting++;
1121 return NOTMUCH_STATUS_SUCCESS;
1122 }
1123
1124 notmuch_status_t
notmuch_database_end_atomic(notmuch_database_t * notmuch)1125 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1126 {
1127 Xapian::WritableDatabase *db;
1128
1129 if (notmuch->atomic_nesting == 0)
1130 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1131
1132 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1133 notmuch->atomic_nesting > 1)
1134 goto DONE;
1135
1136 db = notmuch->writable_xapian_db;
1137 try {
1138 db->commit_transaction ();
1139 notmuch->transaction_count++;
1140
1141 /* Xapian never flushes on a non-flushed commit, even if the
1142 * flush threshold is 1. However, we rely on flushing to test
1143 * atomicity. On the other hand, we can't straight replace
1144 * XAPIAN_FLUSH_THRESHOLD with our autocommit counter, because
1145 * the former also applies outside notmuch atomic
1146 * commits. Hence the follow complicated test */
1147 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1148 if ((notmuch->transaction_threshold > 0 &&
1149 notmuch->transaction_count >= notmuch->transaction_threshold) ||
1150 (thresh && atoi (thresh) == 1)) {
1151 db->commit ();
1152 notmuch->transaction_count = 0;
1153 }
1154 } catch (const Xapian::Error &error) {
1155 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1156 error.get_msg ().c_str ());
1157 notmuch->exception_reported = true;
1158 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1159 }
1160
1161 if (notmuch->atomic_dirty) {
1162 ++notmuch->revision;
1163 notmuch->atomic_dirty = false;
1164 }
1165
1166 DONE:
1167 notmuch->atomic_nesting--;
1168 return NOTMUCH_STATUS_SUCCESS;
1169 }
1170
1171 unsigned long
notmuch_database_get_revision(notmuch_database_t * notmuch,const char ** uuid)1172 notmuch_database_get_revision (notmuch_database_t *notmuch,
1173 const char **uuid)
1174 {
1175 if (uuid)
1176 *uuid = notmuch->uuid;
1177 return notmuch->revision;
1178 }
1179
1180 /* We allow the user to use arbitrarily long paths for directories. But
1181 * we have a term-length limit. So if we exceed that, we'll use the
1182 * SHA-1 of the path for the database term.
1183 *
1184 * Note: This function may return the original value of 'path'. If it
1185 * does not, then the caller is responsible to free() the returned
1186 * value.
1187 */
1188 const char *
_notmuch_database_get_directory_db_path(const char * path)1189 _notmuch_database_get_directory_db_path (const char *path)
1190 {
1191 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1192
1193 if (term_len > NOTMUCH_TERM_MAX)
1194 return _notmuch_sha1_of_string (path);
1195 else
1196 return path;
1197 }
1198
1199 /* Given a path, split it into two parts: the directory part is all
1200 * components except for the last, and the basename is that last
1201 * component. Getting the return-value for either part is optional
1202 * (the caller can pass NULL).
1203 *
1204 * The original 'path' can represent either a regular file or a
1205 * directory---the splitting will be carried out in the same way in
1206 * either case. Trailing slashes on 'path' will be ignored, and any
1207 * cases of multiple '/' characters appearing in series will be
1208 * treated as a single '/'.
1209 *
1210 * Allocation (if any) will have 'ctx' as the talloc owner. But
1211 * pointers will be returned within the original path string whenever
1212 * possible.
1213 *
1214 * Note: If 'path' is non-empty and contains no non-trailing slash,
1215 * (that is, consists of a filename with no parent directory), then
1216 * the directory returned will be an empty string. However, if 'path'
1217 * is an empty string, then both directory and basename will be
1218 * returned as NULL.
1219 */
1220 notmuch_status_t
_notmuch_database_split_path(void * ctx,const char * path,const char ** directory,const char ** basename)1221 _notmuch_database_split_path (void *ctx,
1222 const char *path,
1223 const char **directory,
1224 const char **basename)
1225 {
1226 const char *slash;
1227
1228 if (path == NULL || *path == '\0') {
1229 if (directory)
1230 *directory = NULL;
1231 if (basename)
1232 *basename = NULL;
1233 return NOTMUCH_STATUS_SUCCESS;
1234 }
1235
1236 /* Find the last slash (not counting a trailing slash), if any. */
1237
1238 slash = path + strlen (path) - 1;
1239
1240 /* First, skip trailing slashes. */
1241 while (slash != path && *slash == '/')
1242 --slash;
1243
1244 /* Then, find a slash. */
1245 while (slash != path && *slash != '/') {
1246 if (basename)
1247 *basename = slash;
1248
1249 --slash;
1250 }
1251
1252 /* Finally, skip multiple slashes. */
1253 while (slash != path && *(slash - 1) == '/')
1254 --slash;
1255
1256 if (slash == path) {
1257 if (directory)
1258 *directory = talloc_strdup (ctx, "");
1259 if (basename)
1260 *basename = path;
1261 } else {
1262 if (directory)
1263 *directory = talloc_strndup (ctx, path, slash - path);
1264 }
1265
1266 return NOTMUCH_STATUS_SUCCESS;
1267 }
1268
1269 /* Find the document ID of the specified directory.
1270 *
1271 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1272 * created if one does not exist for 'path'. Otherwise, if the
1273 * directory document does not exist, this sets *directory_id to
1274 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1275 */
1276 notmuch_status_t
_notmuch_database_find_directory_id(notmuch_database_t * notmuch,const char * path,notmuch_find_flags_t flags,unsigned int * directory_id)1277 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1278 const char *path,
1279 notmuch_find_flags_t flags,
1280 unsigned int *directory_id)
1281 {
1282 notmuch_directory_t *directory;
1283 notmuch_status_t status;
1284
1285 if (path == NULL) {
1286 *directory_id = 0;
1287 return NOTMUCH_STATUS_SUCCESS;
1288 }
1289
1290 directory = _notmuch_directory_find_or_create (notmuch, path, flags, &status);
1291 if (status || ! directory) {
1292 *directory_id = -1;
1293 return status;
1294 }
1295
1296 *directory_id = _notmuch_directory_get_document_id (directory);
1297
1298 notmuch_directory_destroy (directory);
1299
1300 return NOTMUCH_STATUS_SUCCESS;
1301 }
1302
1303 const char *
_notmuch_database_get_directory_path(void * ctx,notmuch_database_t * notmuch,unsigned int doc_id)1304 _notmuch_database_get_directory_path (void *ctx,
1305 notmuch_database_t *notmuch,
1306 unsigned int doc_id)
1307 {
1308 Xapian::Document document;
1309
1310 document = find_document_for_doc_id (notmuch, doc_id);
1311
1312 return talloc_strdup (ctx, document.get_data ().c_str ());
1313 }
1314
1315 /* Given a legal 'filename' for the database, (either relative to
1316 * database path or absolute with initial components identical to
1317 * database path), return a new string (with 'ctx' as the talloc
1318 * owner) suitable for use as a direntry term value.
1319 *
1320 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1321 * will be created in the database as needed. Otherwise, if the
1322 * necessary directory documents do not exist, this sets
1323 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1324 */
1325 notmuch_status_t
_notmuch_database_filename_to_direntry(void * ctx,notmuch_database_t * notmuch,const char * filename,notmuch_find_flags_t flags,char ** direntry)1326 _notmuch_database_filename_to_direntry (void *ctx,
1327 notmuch_database_t *notmuch,
1328 const char *filename,
1329 notmuch_find_flags_t flags,
1330 char **direntry)
1331 {
1332 const char *relative, *directory, *basename;
1333 Xapian::docid directory_id;
1334 notmuch_status_t status;
1335
1336 relative = _notmuch_database_relative_path (notmuch, filename);
1337
1338 status = _notmuch_database_split_path (ctx, relative,
1339 &directory, &basename);
1340 if (status)
1341 return status;
1342
1343 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1344 &directory_id);
1345 if (status || directory_id == (unsigned int) -1) {
1346 *direntry = NULL;
1347 return status;
1348 }
1349
1350 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1351
1352 return NOTMUCH_STATUS_SUCCESS;
1353 }
1354
1355 /* Given a legal 'path' for the database, return the relative path.
1356 *
1357 * The return value will be a pointer to the original path contents,
1358 * and will be either the original string (if 'path' was relative) or
1359 * a portion of the string (if path was absolute and begins with the
1360 * database path).
1361 */
1362 const char *
_notmuch_database_relative_path(notmuch_database_t * notmuch,const char * path)1363 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1364 const char *path)
1365 {
1366 const char *db_path, *relative;
1367 unsigned int db_path_len;
1368
1369 db_path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_MAIL_ROOT);
1370 db_path_len = strlen (db_path);
1371
1372 relative = path;
1373
1374 if (*relative == '/') {
1375 while (*relative == '/' && *(relative + 1) == '/')
1376 relative++;
1377
1378 if (strncmp (relative, db_path, db_path_len) == 0) {
1379 relative += db_path_len;
1380 while (*relative == '/')
1381 relative++;
1382 }
1383 }
1384
1385 return relative;
1386 }
1387
1388 notmuch_status_t
notmuch_database_get_directory(notmuch_database_t * notmuch,const char * path,notmuch_directory_t ** directory)1389 notmuch_database_get_directory (notmuch_database_t *notmuch,
1390 const char *path,
1391 notmuch_directory_t **directory)
1392 {
1393 notmuch_status_t status;
1394
1395 if (directory == NULL)
1396 return NOTMUCH_STATUS_NULL_POINTER;
1397 *directory = NULL;
1398
1399 try {
1400 *directory = _notmuch_directory_find_or_create (notmuch, path,
1401 NOTMUCH_FIND_LOOKUP, &status);
1402 } catch (const Xapian::Error &error) {
1403 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1404 error.get_msg ().c_str ());
1405 notmuch->exception_reported = true;
1406 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1407 }
1408 return status;
1409 }
1410
1411 /* Allocate a document ID that satisfies the following criteria:
1412 *
1413 * 1. The ID does not exist for any document in the Xapian database
1414 *
1415 * 2. The ID was not previously returned from this function
1416 *
1417 * 3. The ID is the smallest integer satisfying (1) and (2)
1418 *
1419 * This function will trigger an internal error if these constraints
1420 * cannot all be satisfied, (that is, the pool of available document
1421 * IDs has been exhausted).
1422 */
1423 unsigned int
_notmuch_database_generate_doc_id(notmuch_database_t * notmuch)1424 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1425 {
1426 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1427
1428 notmuch->last_doc_id++;
1429
1430 if (notmuch->last_doc_id == 0)
1431 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1432
1433 return notmuch->last_doc_id;
1434 }
1435
1436 notmuch_status_t
notmuch_database_remove_message(notmuch_database_t * notmuch,const char * filename)1437 notmuch_database_remove_message (notmuch_database_t *notmuch,
1438 const char *filename)
1439 {
1440 notmuch_status_t status;
1441 notmuch_message_t *message;
1442
1443 status = notmuch_database_find_message_by_filename (notmuch, filename,
1444 &message);
1445
1446 if (status == NOTMUCH_STATUS_SUCCESS && message) {
1447 status = _notmuch_message_remove_filename (message, filename);
1448 if (status == NOTMUCH_STATUS_SUCCESS)
1449 _notmuch_message_delete (message);
1450 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1451 _notmuch_message_sync (message);
1452
1453 notmuch_message_destroy (message);
1454 }
1455
1456 return status;
1457 }
1458
1459 notmuch_status_t
notmuch_database_find_message_by_filename(notmuch_database_t * notmuch,const char * filename,notmuch_message_t ** message_ret)1460 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1461 const char *filename,
1462 notmuch_message_t **message_ret)
1463 {
1464 void *local;
1465 const char *prefix = _find_prefix ("file-direntry");
1466 char *direntry, *term;
1467 Xapian::PostingIterator i, end;
1468 notmuch_status_t status;
1469
1470 if (message_ret == NULL)
1471 return NOTMUCH_STATUS_NULL_POINTER;
1472
1473 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
1474 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1475
1476 /* return NULL on any failure */
1477 *message_ret = NULL;
1478
1479 local = talloc_new (notmuch);
1480
1481 try {
1482 status = _notmuch_database_filename_to_direntry (
1483 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
1484 if (status || ! direntry)
1485 goto DONE;
1486
1487 term = talloc_asprintf (local, "%s%s", prefix, direntry);
1488
1489 find_doc_ids_for_term (notmuch, term, &i, &end);
1490
1491 if (i != end) {
1492 notmuch_private_status_t private_status;
1493
1494 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1495 &private_status);
1496 if (*message_ret == NULL)
1497 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1498 }
1499 } catch (const Xapian::Error &error) {
1500 _notmuch_database_log (notmuch,
1501 "Error: A Xapian exception occurred finding message by filename: %s\n",
1502 error.get_msg ().c_str ());
1503 notmuch->exception_reported = true;
1504 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1505 }
1506
1507 DONE:
1508 talloc_free (local);
1509
1510 if (status && *message_ret) {
1511 notmuch_message_destroy (*message_ret);
1512 *message_ret = NULL;
1513 }
1514 return status;
1515 }
1516
1517 notmuch_string_list_t *
_notmuch_database_get_terms_with_prefix(void * ctx,Xapian::TermIterator & i,Xapian::TermIterator & end,const char * prefix)1518 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1519 Xapian::TermIterator &end,
1520 const char *prefix)
1521 {
1522 int prefix_len = strlen (prefix);
1523 notmuch_string_list_t *list;
1524
1525 list = _notmuch_string_list_create (ctx);
1526 if (unlikely (list == NULL))
1527 return NULL;
1528
1529 for (i.skip_to (prefix); i != end; i++) {
1530 /* Terminate loop at first term without desired prefix. */
1531 if (strncmp ((*i).c_str (), prefix, prefix_len))
1532 break;
1533
1534 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1535 }
1536
1537 return list;
1538 }
1539
1540 notmuch_tags_t *
notmuch_database_get_all_tags(notmuch_database_t * db)1541 notmuch_database_get_all_tags (notmuch_database_t *db)
1542 {
1543 Xapian::TermIterator i, end;
1544 notmuch_string_list_t *tags;
1545
1546 try {
1547 i = db->xapian_db->allterms_begin ();
1548 end = db->xapian_db->allterms_end ();
1549 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1550 _find_prefix ("tag"));
1551 _notmuch_string_list_sort (tags);
1552 return _notmuch_tags_create (db, tags);
1553 } catch (const Xapian::Error &error) {
1554 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
1555 error.get_msg ().c_str ());
1556 db->exception_reported = true;
1557 return NULL;
1558 }
1559 }
1560
1561 const char *
notmuch_database_status_string(const notmuch_database_t * notmuch)1562 notmuch_database_status_string (const notmuch_database_t *notmuch)
1563 {
1564 return notmuch->status_string;
1565 }
1566